| Name | Icotest-DeviceServer JSON |
| Version |
1.1.9
JSON |
| download |
| home_page | None |
| Summary | Icotest Device Server API |
| upload_time | 2024-11-06 10:11:10 |
| maintainer | None |
| docs_url | None |
| author | David Atkins |
| requires_python | >=3.4 |
| license | Copyright © 2024 3ADesign Limited Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
| keywords |
openapi
openapi-generator
icotest-device-server
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# DeviceServer
DeviceServer API
This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
- API version: 1.1.9
- Package version: 1.1.9
- Build package: org.openapitools.codegen.languages.PythonLegacyClientCodegen
## Requirements.
Python 2.7 and 3.4+
## Installation & Usage
### pip install
If the python package is hosted on a repository, you can install directly using:
```sh
pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git
```
(you may need to run `pip` with root permission: `sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git`)
Then import the package:
```python
import DeviceServer
```
### Setuptools
Install via [Setuptools](http://pypi.python.org/pypi/setuptools).
```sh
python setup.py install --user
```
(or `sudo python setup.py install` to install the package for all users)
Then import the package:
```python
import DeviceServer
```
## Getting Started
Please follow the [installation procedure](#installation--usage) and then run the following:
```python
from __future__ import print_function
import time
import DeviceServer
from DeviceServer.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to http://localhost/DeviceServer
# See configuration.py for a list of all supported configuration parameters.
configuration = DeviceServer.Configuration(
host = "http://localhost/DeviceServer"
)
# Enter a context with an instance of the API client
with DeviceServer.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = DeviceServer.DevicesApi(api_client)
device_id = 'device_id_example' # str |
expander_index = 56 # int | expander index
expander_port_index = 56 # int | expander port index (optional)
try:
# GET attenuation state
api_response = api_instance.get_attenuator_state(device_id, expander_index, expander_port_index=expander_port_index)
pprint(api_response)
except ApiException as e:
print("Exception when calling DevicesApi->get_attenuator_state: %s\n" % e)
```
## Documentation for API Endpoints
All URIs are relative to *http://localhost/DeviceServer*
Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*DevicesApi* | [**get_attenuator_state**](docs/DevicesApi.md#get_attenuator_state) | **GET** /Devices/{device_id}/Attenuate | GET attenuation state
*DevicesApi* | [**get_channel_attenuation**](docs/DevicesApi.md#get_channel_attenuation) | **GET** /Devices/{device_id}/AttenuateChannel | GET attenuation channel state
*DevicesApi* | [**get_current**](docs/DevicesApi.md#get_current) | **GET** /Devices/{device_id}/Currents/{current_index} | GET current reading of device
*DevicesApi* | [**get_device_attenuation_configuration**](docs/DevicesApi.md#get_device_attenuation_configuration) | **GET** /Devices/{device_id}/AttenuatorConfig | GET attenuation device config
*DevicesApi* | [**get_device_device_id_buttons**](docs/DevicesApi.md#get_device_device_id_buttons) | **GET** /Devices/{device_id}/Buttons | GET all buttons for device
*DevicesApi* | [**get_device_device_id_leds**](docs/DevicesApi.md#get_device_device_id_leds) | **GET** /Devices/{device_id}/Leds | GET all leds for device
*DevicesApi* | [**get_device_device_id_ports**](docs/DevicesApi.md#get_device_device_id_ports) | **GET** /Devices/{device_id}/Ports | GET all ports for device
*DevicesApi* | [**get_device_device_id_temperature_ports**](docs/DevicesApi.md#get_device_device_id_temperature_ports) | **GET** /Devices/{device_id}/Temparatures | GET all temperature ports for device
*DevicesApi* | [**get_device_id_port_index**](docs/DevicesApi.md#get_device_id_port_index) | **GET** /Devices/{device_id}/Ports/{port_index} | GET status of port
*DevicesApi* | [**get_device_led**](docs/DevicesApi.md#get_device_led) | **GET** /Devices/{device_id}/Leds/{led_index} | GET state of LED
*DevicesApi* | [**get_device_port_current**](docs/DevicesApi.md#get_device_port_current) | **GET** /Devices/{device_id}/Ports/{port_index}/Currents | GET current reading of device Port
*DevicesApi* | [**get_device_port_module_led_state**](docs/DevicesApi.md#get_device_port_module_led_state) | **GET** /Devices/{device_id}/Ports/{port_index}/Modules/{module_index}/Leds | GET state of Port LED
*DevicesApi* | [**get_device_port_module_relay_state**](docs/DevicesApi.md#get_device_port_module_relay_state) | **GET** /Devices/{device_id}/Ports/{port_index}/Modules/{module_index}/Relays/{relay_index} | GET state of Port LED
*DevicesApi* | [**get_device_port_voltage**](docs/DevicesApi.md#get_device_port_voltage) | **GET** /Devices/{device_id}/Ports/{port_index}/Voltages | GET voltage reading of device Port
*DevicesApi* | [**get_device_rotation_angle**](docs/DevicesApi.md#get_device_rotation_angle) | **GET** /Devices/{device_id}/Rotation | GET Rotation Angle
*DevicesApi* | [**get_device_rotation_speed**](docs/DevicesApi.md#get_device_rotation_speed) | **GET** /Devices/{device_id}/Turntable/Speed | GET Turntable Speed
*DevicesApi* | [**get_device_uuid**](docs/DevicesApi.md#get_device_uuid) | **GET** /Serial/{device_serial}/Type/{device_type} | GET uuid from database
*DevicesApi* | [**get_devices**](docs/DevicesApi.md#get_devices) | **GET** /Devices | GET list of devices
*DevicesApi* | [**get_devices_button**](docs/DevicesApi.md#get_devices_button) | **GET** /Devices/{device_id}/Button | GET state of button
*DevicesApi* | [**get_devices_index**](docs/DevicesApi.md#get_devices_index) | **GET** /Devices/{device_id} | GET single device
*DevicesApi* | [**get_devices_temperature**](docs/DevicesApi.md#get_devices_temperature) | **GET** /Devices/{device_id}/Temperature | GET temperature reading
*DevicesApi* | [**get_fan_speed**](docs/DevicesApi.md#get_fan_speed) | **GET** /Devices/{device_id}/Fan/{fan_index}/Speed | GET device fan speed
*DevicesApi* | [**get_fan_target_temperature**](docs/DevicesApi.md#get_fan_target_temperature) | **GET** /Devices/{device_id}/Fan/{fan_index}/TargetTemperature | GET device fan target temperature
*DevicesApi* | [**get_fan_temperature**](docs/DevicesApi.md#get_fan_temperature) | **GET** /Devices/{device_id}/Fan/{fan_index}/Temperature | GET device fan temperature
*DevicesApi* | [**get_firmware_version**](docs/DevicesApi.md#get_firmware_version) | **GET** /Devices/{device_id}/Firmware | GET Device Firmware Version
*DevicesApi* | [**get_image**](docs/DevicesApi.md#get_image) | **GET** /Devices/{device_id}/Turntable/Image | GET Image
*DevicesApi* | [**get_image_names**](docs/DevicesApi.md#get_image_names) | **GET** /Devices/{device_id}/Turntable/ImageNames | GET Image Names
*DevicesApi* | [**get_message_from_rx_buffer**](docs/DevicesApi.md#get_message_from_rx_buffer) | **GET** /Devices/messages/rx | GET message from RX table
*DevicesApi* | [**get_message_from_tx_buffer**](docs/DevicesApi.md#get_message_from_tx_buffer) | **GET** /Devices/messages/tx | GET message from TX table
*DevicesApi* | [**get_port**](docs/DevicesApi.md#get_port) | **GET** /Port/{port_id} | GET status of port by id
*DevicesApi* | [**get_port_led_state**](docs/DevicesApi.md#get_port_led_state) | **GET** /Devices/{device_id}/Ports/{port_index}/Leds/{led_index} | GET state of Port LED
*DevicesApi* | [**get_port_setup_status**](docs/DevicesApi.md#get_port_setup_status) | **GET** /Devices/{device_id}/Ports/{port_index}/SetupStatus | GET status of port
*DevicesApi* | [**get_port_states**](docs/DevicesApi.md#get_port_states) | **GET** /PortStates/{port_id} | GET port states by port id
*DevicesApi* | [**get_ports**](docs/DevicesApi.md#get_ports) | **GET** /Ports | GET status of all ports
*DevicesApi* | [**get_relay_state**](docs/DevicesApi.md#get_relay_state) | **GET** /Devices/{device_id}/Relay | GET state of relay
*DevicesApi* | [**get_temperature_range**](docs/DevicesApi.md#get_temperature_range) | **GET** /Devices/{device_id}/Temperature/Range | GET Temperature Range
*DevicesApi* | [**get_temperature_thresholds**](docs/DevicesApi.md#get_temperature_thresholds) | **GET** /Devices/{device_id}/Temperature/Thresholds | GET Temperature Thresholds
*DevicesApi* | [**get_turntable_calibration_data**](docs/DevicesApi.md#get_turntable_calibration_data) | **GET** /Devices/{device_id}/TurntableCalibration | GET Turntable Calibration Values
*DevicesApi* | [**get_voltage**](docs/DevicesApi.md#get_voltage) | **GET** /Devices/{device_id}/Voltages/{voltage_index} | GET voltage reading of device
*DevicesApi* | [**put_attenuator_state**](docs/DevicesApi.md#put_attenuator_state) | **PUT** /Devices/{device_id}/Attenuate | PUT attenuation state
*DevicesApi* | [**put_auto_calibrate_turntable**](docs/DevicesApi.md#put_auto_calibrate_turntable) | **PUT** /Devices/{device_id}/TurntableCalibration | PUT Calibration
*DevicesApi* | [**put_channel_attenuation**](docs/DevicesApi.md#put_channel_attenuation) | **PUT** /Devices/{device_id}/AttenuateChannel | PUT attenuation state
*DevicesApi* | [**put_device**](docs/DevicesApi.md#put_device) | **PUT** /Devices/AddDevice | PUT Add device
*DevicesApi* | [**put_device_device_id_description**](docs/DevicesApi.md#put_device_device_id_description) | **PUT** /Device/{device_id}/Description | PUT a description for a Device
*DevicesApi* | [**put_device_device_id_name**](docs/DevicesApi.md#put_device_device_id_name) | **PUT** /Device/{device_id}/Name | PUT a name for a Device
*DevicesApi* | [**put_device_id_label**](docs/DevicesApi.md#put_device_id_label) | **PUT** /Device/{device_id}/Port/{port_index}/Label | PUT a Port label
*DevicesApi* | [**put_device_port_module_led_state**](docs/DevicesApi.md#put_device_port_module_led_state) | **PUT** /Devices/{device_id}/Ports/{port_index}/Modules/{module_index}/Leds | PUT state of Port LED
*DevicesApi* | [**put_device_port_module_relay_state**](docs/DevicesApi.md#put_device_port_module_relay_state) | **PUT** /Devices/{device_id}/Ports/{port_index}/Modules/{module_index}/Relays/{relay_index} | PUT state of Port Relay
*DevicesApi* | [**put_device_rotation_angle**](docs/DevicesApi.md#put_device_rotation_angle) | **PUT** /Devices/{device_id}/Rotation | PUT Rotation
*DevicesApi* | [**put_device_rotation_angle_continuous**](docs/DevicesApi.md#put_device_rotation_angle_continuous) | **PUT** /Devices/{device_id}/ContiniousRotation | PUT Continious Rotation
*DevicesApi* | [**put_device_rotation_speed**](docs/DevicesApi.md#put_device_rotation_speed) | **PUT** /Devices/{device_id}/Turntable/Speed | PUT Turntable Speed
*DevicesApi* | [**put_devices_led_index**](docs/DevicesApi.md#put_devices_led_index) | **PUT** /Devices/{device_id}/Leds/{led_index} | PUT state of LED
*DevicesApi* | [**put_devices_ports**](docs/DevicesApi.md#put_devices_ports) | **PUT** /Devices/{device_id}/Ports/{port_index} | PUT state of port
*DevicesApi* | [**put_halt_rotation**](docs/DevicesApi.md#put_halt_rotation) | **PUT** /Devices/{device_id}/HaltRotation | PUT Halt Rotation
*DevicesApi* | [**put_port_led_state**](docs/DevicesApi.md#put_port_led_state) | **PUT** /Devices/{device_id}/Ports/{port_index}/Leds/{led_index} | PUT state of Port LED
*DevicesApi* | [**put_port_port_id_label**](docs/DevicesApi.md#put_port_port_id_label) | **PUT** /Port/{port_id}/Label | PUT the label for a Port
*DevicesApi* | [**put_port_port_id_state_label**](docs/DevicesApi.md#put_port_port_id_state_label) | **PUT** /Port/{port_id}/StateLabel | PUT state label
*DevicesApi* | [**put_port_states_port_id**](docs/DevicesApi.md#put_port_states_port_id) | **PUT** /PortStates/{port_id} |
*DevicesApi* | [**put_ports_pulse**](docs/DevicesApi.md#put_ports_pulse) | **PUT** /Devices/{device_id}/Ports/{port_index}/Pulse | PUT port into state for period of time
*DevicesApi* | [**put_relay_state**](docs/DevicesApi.md#put_relay_state) | **PUT** /Devices/{device_id}/Relay |
*DevicesApi* | [**put_serial_test_message**](docs/DevicesApi.md#put_serial_test_message) | **PUT** /Devices/{device_id}/Ports/{port_index}/SerialMessage | Serial Message Test
*DevicesApi* | [**put_state_by_port_id**](docs/DevicesApi.md#put_state_by_port_id) | **PUT** /Port/{port_id} | PUT state of port
*DockerApi* | [**get_container_logs**](docs/DockerApi.md#get_container_logs) | **GET** /docker/container/logs | GET a docker container's logs
*DockerApi* | [**get_docker_container_names**](docs/DockerApi.md#get_docker_container_names) | **GET** /docker/containers | GET all docker containers
## Documentation For Models
- [AttenuationState](docs/AttenuationState.md)
- [ButtonState](docs/ButtonState.md)
- [ChannelAttenuationState](docs/ChannelAttenuationState.md)
- [ContainerNames](docs/ContainerNames.md)
- [DbButtonState](docs/DbButtonState.md)
- [DbDeviceButton](docs/DbDeviceButton.md)
- [DbDeviceLed](docs/DbDeviceLed.md)
- [DbDevicePort](docs/DbDevicePort.md)
- [DbDeviceTemperaturePort](docs/DbDeviceTemperaturePort.md)
- [DbLedState](docs/DbLedState.md)
- [DbPortState](docs/DbPortState.md)
- [DbUploadFirmwareState](docs/DbUploadFirmwareState.md)
- [Device](docs/Device.md)
- [DeviceButton](docs/DeviceButton.md)
- [DeviceLed](docs/DeviceLed.md)
- [DevicePort](docs/DevicePort.md)
- [DeviceRxBuffer](docs/DeviceRxBuffer.md)
- [DeviceTemperaturePort](docs/DeviceTemperaturePort.md)
- [DeviceTxBuffer](docs/DeviceTxBuffer.md)
- [FirmwareVersion](docs/FirmwareVersion.md)
- [HostConfig](docs/HostConfig.md)
- [LedState](docs/LedState.md)
- [PortState](docs/PortState.md)
- [RelayState](docs/RelayState.md)
- [TempRange](docs/TempRange.md)
- [Temperature](docs/Temperature.md)
## Documentation For Authorization
All endpoints do not require authorization.
## Author
david@3adesign.co.uk
Raw data
{
"_id": null,
"home_page": null,
"name": "Icotest-DeviceServer",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.4",
"maintainer_email": null,
"keywords": "OpenAPI, OpenAPI-Generator, Icotest-Device-Server",
"author": "David Atkins",
"author_email": "Gustav Rodel <gustav.rodel@3adesign.co.uk>, David Atkins <david@3adesign.co.uk>",
"download_url": "https://files.pythonhosted.org/packages/65/0f/f8bdde6907285387eff4d018f0603b96c282a8a294ebc2573aedca5b9625/icotest_deviceserver-1.1.9.tar.gz",
"platform": null,
"description": "# DeviceServer\nDeviceServer API\n\nThis Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:\n\n- API version: 1.1.9\n- Package version: 1.1.9\n- Build package: org.openapitools.codegen.languages.PythonLegacyClientCodegen\n\n## Requirements.\n\nPython 2.7 and 3.4+\n\n## Installation & Usage\n### pip install\n\nIf the python package is hosted on a repository, you can install directly using:\n\n```sh\npip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git\n```\n(you may need to run `pip` with root permission: `sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git`)\n\nThen import the package:\n```python\nimport DeviceServer\n```\n\n### Setuptools\n\nInstall via [Setuptools](http://pypi.python.org/pypi/setuptools).\n\n```sh\npython setup.py install --user\n```\n(or `sudo python setup.py install` to install the package for all users)\n\nThen import the package:\n```python\nimport DeviceServer\n```\n\n## Getting Started\n\nPlease follow the [installation procedure](#installation--usage) and then run the following:\n\n```python\nfrom __future__ import print_function\n\nimport time\nimport DeviceServer\nfrom DeviceServer.rest import ApiException\nfrom pprint import pprint\n\n# Defining the host is optional and defaults to http://localhost/DeviceServer\n# See configuration.py for a list of all supported configuration parameters.\nconfiguration = DeviceServer.Configuration(\n host = \"http://localhost/DeviceServer\"\n)\n\n\n\n# Enter a context with an instance of the API client\nwith DeviceServer.ApiClient(configuration) as api_client:\n # Create an instance of the API class\n api_instance = DeviceServer.DevicesApi(api_client)\n device_id = 'device_id_example' # str | \nexpander_index = 56 # int | expander index\nexpander_port_index = 56 # int | expander port index (optional)\n\n try:\n # GET attenuation state\n api_response = api_instance.get_attenuator_state(device_id, expander_index, expander_port_index=expander_port_index)\n pprint(api_response)\n except ApiException as e:\n print(\"Exception when calling DevicesApi->get_attenuator_state: %s\\n\" % e)\n \n```\n\n## Documentation for API Endpoints\n\nAll URIs are relative to *http://localhost/DeviceServer*\n\nClass | Method | HTTP request | Description\n------------ | ------------- | ------------- | -------------\n*DevicesApi* | [**get_attenuator_state**](docs/DevicesApi.md#get_attenuator_state) | **GET** /Devices/{device_id}/Attenuate | GET attenuation state\n*DevicesApi* | [**get_channel_attenuation**](docs/DevicesApi.md#get_channel_attenuation) | **GET** /Devices/{device_id}/AttenuateChannel | GET attenuation channel state\n*DevicesApi* | [**get_current**](docs/DevicesApi.md#get_current) | **GET** /Devices/{device_id}/Currents/{current_index} | GET current reading of device\n*DevicesApi* | [**get_device_attenuation_configuration**](docs/DevicesApi.md#get_device_attenuation_configuration) | **GET** /Devices/{device_id}/AttenuatorConfig | GET attenuation device config\n*DevicesApi* | [**get_device_device_id_buttons**](docs/DevicesApi.md#get_device_device_id_buttons) | **GET** /Devices/{device_id}/Buttons | GET all buttons for device\n*DevicesApi* | [**get_device_device_id_leds**](docs/DevicesApi.md#get_device_device_id_leds) | **GET** /Devices/{device_id}/Leds | GET all leds for device\n*DevicesApi* | [**get_device_device_id_ports**](docs/DevicesApi.md#get_device_device_id_ports) | **GET** /Devices/{device_id}/Ports | GET all ports for device\n*DevicesApi* | [**get_device_device_id_temperature_ports**](docs/DevicesApi.md#get_device_device_id_temperature_ports) | **GET** /Devices/{device_id}/Temparatures | GET all temperature ports for device\n*DevicesApi* | [**get_device_id_port_index**](docs/DevicesApi.md#get_device_id_port_index) | **GET** /Devices/{device_id}/Ports/{port_index} | GET status of port\n*DevicesApi* | [**get_device_led**](docs/DevicesApi.md#get_device_led) | **GET** /Devices/{device_id}/Leds/{led_index} | GET state of LED\n*DevicesApi* | [**get_device_port_current**](docs/DevicesApi.md#get_device_port_current) | **GET** /Devices/{device_id}/Ports/{port_index}/Currents | GET current reading of device Port\n*DevicesApi* | [**get_device_port_module_led_state**](docs/DevicesApi.md#get_device_port_module_led_state) | **GET** /Devices/{device_id}/Ports/{port_index}/Modules/{module_index}/Leds | GET state of Port LED\n*DevicesApi* | [**get_device_port_module_relay_state**](docs/DevicesApi.md#get_device_port_module_relay_state) | **GET** /Devices/{device_id}/Ports/{port_index}/Modules/{module_index}/Relays/{relay_index} | GET state of Port LED\n*DevicesApi* | [**get_device_port_voltage**](docs/DevicesApi.md#get_device_port_voltage) | **GET** /Devices/{device_id}/Ports/{port_index}/Voltages | GET voltage reading of device Port\n*DevicesApi* | [**get_device_rotation_angle**](docs/DevicesApi.md#get_device_rotation_angle) | **GET** /Devices/{device_id}/Rotation | GET Rotation Angle\n*DevicesApi* | [**get_device_rotation_speed**](docs/DevicesApi.md#get_device_rotation_speed) | **GET** /Devices/{device_id}/Turntable/Speed | GET Turntable Speed\n*DevicesApi* | [**get_device_uuid**](docs/DevicesApi.md#get_device_uuid) | **GET** /Serial/{device_serial}/Type/{device_type} | GET uuid from database\n*DevicesApi* | [**get_devices**](docs/DevicesApi.md#get_devices) | **GET** /Devices | GET list of devices\n*DevicesApi* | [**get_devices_button**](docs/DevicesApi.md#get_devices_button) | **GET** /Devices/{device_id}/Button | GET state of button\n*DevicesApi* | [**get_devices_index**](docs/DevicesApi.md#get_devices_index) | **GET** /Devices/{device_id} | GET single device\n*DevicesApi* | [**get_devices_temperature**](docs/DevicesApi.md#get_devices_temperature) | **GET** /Devices/{device_id}/Temperature | GET temperature reading\n*DevicesApi* | [**get_fan_speed**](docs/DevicesApi.md#get_fan_speed) | **GET** /Devices/{device_id}/Fan/{fan_index}/Speed | GET device fan speed\n*DevicesApi* | [**get_fan_target_temperature**](docs/DevicesApi.md#get_fan_target_temperature) | **GET** /Devices/{device_id}/Fan/{fan_index}/TargetTemperature | GET device fan target temperature\n*DevicesApi* | [**get_fan_temperature**](docs/DevicesApi.md#get_fan_temperature) | **GET** /Devices/{device_id}/Fan/{fan_index}/Temperature | GET device fan temperature\n*DevicesApi* | [**get_firmware_version**](docs/DevicesApi.md#get_firmware_version) | **GET** /Devices/{device_id}/Firmware | GET Device Firmware Version\n*DevicesApi* | [**get_image**](docs/DevicesApi.md#get_image) | **GET** /Devices/{device_id}/Turntable/Image | GET Image\n*DevicesApi* | [**get_image_names**](docs/DevicesApi.md#get_image_names) | **GET** /Devices/{device_id}/Turntable/ImageNames | GET Image Names\n*DevicesApi* | [**get_message_from_rx_buffer**](docs/DevicesApi.md#get_message_from_rx_buffer) | **GET** /Devices/messages/rx | GET message from RX table\n*DevicesApi* | [**get_message_from_tx_buffer**](docs/DevicesApi.md#get_message_from_tx_buffer) | **GET** /Devices/messages/tx | GET message from TX table\n*DevicesApi* | [**get_port**](docs/DevicesApi.md#get_port) | **GET** /Port/{port_id} | GET status of port by id\n*DevicesApi* | [**get_port_led_state**](docs/DevicesApi.md#get_port_led_state) | **GET** /Devices/{device_id}/Ports/{port_index}/Leds/{led_index} | GET state of Port LED\n*DevicesApi* | [**get_port_setup_status**](docs/DevicesApi.md#get_port_setup_status) | **GET** /Devices/{device_id}/Ports/{port_index}/SetupStatus | GET status of port\n*DevicesApi* | [**get_port_states**](docs/DevicesApi.md#get_port_states) | **GET** /PortStates/{port_id} | GET port states by port id\n*DevicesApi* | [**get_ports**](docs/DevicesApi.md#get_ports) | **GET** /Ports | GET status of all ports\n*DevicesApi* | [**get_relay_state**](docs/DevicesApi.md#get_relay_state) | **GET** /Devices/{device_id}/Relay | GET state of relay\n*DevicesApi* | [**get_temperature_range**](docs/DevicesApi.md#get_temperature_range) | **GET** /Devices/{device_id}/Temperature/Range | GET Temperature Range\n*DevicesApi* | [**get_temperature_thresholds**](docs/DevicesApi.md#get_temperature_thresholds) | **GET** /Devices/{device_id}/Temperature/Thresholds | GET Temperature Thresholds\n*DevicesApi* | [**get_turntable_calibration_data**](docs/DevicesApi.md#get_turntable_calibration_data) | **GET** /Devices/{device_id}/TurntableCalibration | GET Turntable Calibration Values\n*DevicesApi* | [**get_voltage**](docs/DevicesApi.md#get_voltage) | **GET** /Devices/{device_id}/Voltages/{voltage_index} | GET voltage reading of device\n*DevicesApi* | [**put_attenuator_state**](docs/DevicesApi.md#put_attenuator_state) | **PUT** /Devices/{device_id}/Attenuate | PUT attenuation state\n*DevicesApi* | [**put_auto_calibrate_turntable**](docs/DevicesApi.md#put_auto_calibrate_turntable) | **PUT** /Devices/{device_id}/TurntableCalibration | PUT Calibration\n*DevicesApi* | [**put_channel_attenuation**](docs/DevicesApi.md#put_channel_attenuation) | **PUT** /Devices/{device_id}/AttenuateChannel | PUT attenuation state\n*DevicesApi* | [**put_device**](docs/DevicesApi.md#put_device) | **PUT** /Devices/AddDevice | PUT Add device\n*DevicesApi* | [**put_device_device_id_description**](docs/DevicesApi.md#put_device_device_id_description) | **PUT** /Device/{device_id}/Description | PUT a description for a Device\n*DevicesApi* | [**put_device_device_id_name**](docs/DevicesApi.md#put_device_device_id_name) | **PUT** /Device/{device_id}/Name | PUT a name for a Device\n*DevicesApi* | [**put_device_id_label**](docs/DevicesApi.md#put_device_id_label) | **PUT** /Device/{device_id}/Port/{port_index}/Label | PUT a Port label\n*DevicesApi* | [**put_device_port_module_led_state**](docs/DevicesApi.md#put_device_port_module_led_state) | **PUT** /Devices/{device_id}/Ports/{port_index}/Modules/{module_index}/Leds | PUT state of Port LED\n*DevicesApi* | [**put_device_port_module_relay_state**](docs/DevicesApi.md#put_device_port_module_relay_state) | **PUT** /Devices/{device_id}/Ports/{port_index}/Modules/{module_index}/Relays/{relay_index} | PUT state of Port Relay\n*DevicesApi* | [**put_device_rotation_angle**](docs/DevicesApi.md#put_device_rotation_angle) | **PUT** /Devices/{device_id}/Rotation | PUT Rotation\n*DevicesApi* | [**put_device_rotation_angle_continuous**](docs/DevicesApi.md#put_device_rotation_angle_continuous) | **PUT** /Devices/{device_id}/ContiniousRotation | PUT Continious Rotation\n*DevicesApi* | [**put_device_rotation_speed**](docs/DevicesApi.md#put_device_rotation_speed) | **PUT** /Devices/{device_id}/Turntable/Speed | PUT Turntable Speed\n*DevicesApi* | [**put_devices_led_index**](docs/DevicesApi.md#put_devices_led_index) | **PUT** /Devices/{device_id}/Leds/{led_index} | PUT state of LED\n*DevicesApi* | [**put_devices_ports**](docs/DevicesApi.md#put_devices_ports) | **PUT** /Devices/{device_id}/Ports/{port_index} | PUT state of port\n*DevicesApi* | [**put_halt_rotation**](docs/DevicesApi.md#put_halt_rotation) | **PUT** /Devices/{device_id}/HaltRotation | PUT Halt Rotation\n*DevicesApi* | [**put_port_led_state**](docs/DevicesApi.md#put_port_led_state) | **PUT** /Devices/{device_id}/Ports/{port_index}/Leds/{led_index} | PUT state of Port LED\n*DevicesApi* | [**put_port_port_id_label**](docs/DevicesApi.md#put_port_port_id_label) | **PUT** /Port/{port_id}/Label | PUT the label for a Port\n*DevicesApi* | [**put_port_port_id_state_label**](docs/DevicesApi.md#put_port_port_id_state_label) | **PUT** /Port/{port_id}/StateLabel | PUT state label\n*DevicesApi* | [**put_port_states_port_id**](docs/DevicesApi.md#put_port_states_port_id) | **PUT** /PortStates/{port_id} | \n*DevicesApi* | [**put_ports_pulse**](docs/DevicesApi.md#put_ports_pulse) | **PUT** /Devices/{device_id}/Ports/{port_index}/Pulse | PUT port into state for period of time\n*DevicesApi* | [**put_relay_state**](docs/DevicesApi.md#put_relay_state) | **PUT** /Devices/{device_id}/Relay | \n*DevicesApi* | [**put_serial_test_message**](docs/DevicesApi.md#put_serial_test_message) | **PUT** /Devices/{device_id}/Ports/{port_index}/SerialMessage | Serial Message Test\n*DevicesApi* | [**put_state_by_port_id**](docs/DevicesApi.md#put_state_by_port_id) | **PUT** /Port/{port_id} | PUT state of port\n*DockerApi* | [**get_container_logs**](docs/DockerApi.md#get_container_logs) | **GET** /docker/container/logs | GET a docker container's logs\n*DockerApi* | [**get_docker_container_names**](docs/DockerApi.md#get_docker_container_names) | **GET** /docker/containers | GET all docker containers\n\n\n## Documentation For Models\n\n - [AttenuationState](docs/AttenuationState.md)\n - [ButtonState](docs/ButtonState.md)\n - [ChannelAttenuationState](docs/ChannelAttenuationState.md)\n - [ContainerNames](docs/ContainerNames.md)\n - [DbButtonState](docs/DbButtonState.md)\n - [DbDeviceButton](docs/DbDeviceButton.md)\n - [DbDeviceLed](docs/DbDeviceLed.md)\n - [DbDevicePort](docs/DbDevicePort.md)\n - [DbDeviceTemperaturePort](docs/DbDeviceTemperaturePort.md)\n - [DbLedState](docs/DbLedState.md)\n - [DbPortState](docs/DbPortState.md)\n - [DbUploadFirmwareState](docs/DbUploadFirmwareState.md)\n - [Device](docs/Device.md)\n - [DeviceButton](docs/DeviceButton.md)\n - [DeviceLed](docs/DeviceLed.md)\n - [DevicePort](docs/DevicePort.md)\n - [DeviceRxBuffer](docs/DeviceRxBuffer.md)\n - [DeviceTemperaturePort](docs/DeviceTemperaturePort.md)\n - [DeviceTxBuffer](docs/DeviceTxBuffer.md)\n - [FirmwareVersion](docs/FirmwareVersion.md)\n - [HostConfig](docs/HostConfig.md)\n - [LedState](docs/LedState.md)\n - [PortState](docs/PortState.md)\n - [RelayState](docs/RelayState.md)\n - [TempRange](docs/TempRange.md)\n - [Temperature](docs/Temperature.md)\n\n\n## Documentation For Authorization\n\n All endpoints do not require authorization.\n\n## Author\n\ndavid@3adesign.co.uk\n\n\n",
"bugtrack_url": null,
"license": "Copyright \u00a9 2024 3ADesign Limited Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \u201cSoftware\u201d), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED \u201cAS IS\u201d, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. ",
"summary": "Icotest Device Server API",
"version": "1.1.9",
"project_urls": null,
"split_keywords": [
"openapi",
" openapi-generator",
" icotest-device-server"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "27379a86a603c8c0e4fb6dee21713a14dc7918c8a46b3391257dfa42abc8bdda",
"md5": "ca36b078502bbfa4a46bdba8c94158aa",
"sha256": "45584d7474a315ad1a0ffdb6fc1030f9ef971c2df8a93ea47b2c47b83d8cf6a7"
},
"downloads": -1,
"filename": "Icotest_DeviceServer-1.1.9-py3-none-any.whl",
"has_sig": false,
"md5_digest": "ca36b078502bbfa4a46bdba8c94158aa",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.4",
"size": 86880,
"upload_time": "2024-11-06T10:11:09",
"upload_time_iso_8601": "2024-11-06T10:11:09.073662Z",
"url": "https://files.pythonhosted.org/packages/27/37/9a86a603c8c0e4fb6dee21713a14dc7918c8a46b3391257dfa42abc8bdda/Icotest_DeviceServer-1.1.9-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "650ff8bdde6907285387eff4d018f0603b96c282a8a294ebc2573aedca5b9625",
"md5": "d62e9eab91eb7843e019e6955be72a48",
"sha256": "1b937fc2cb8936c3692a9a211ab46b23c3d4783889d940f96c163aa4f9a14217"
},
"downloads": -1,
"filename": "icotest_deviceserver-1.1.9.tar.gz",
"has_sig": false,
"md5_digest": "d62e9eab91eb7843e019e6955be72a48",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.4",
"size": 66014,
"upload_time": "2024-11-06T10:11:10",
"upload_time_iso_8601": "2024-11-06T10:11:10.726389Z",
"url": "https://files.pythonhosted.org/packages/65/0f/f8bdde6907285387eff4d018f0603b96c282a8a294ebc2573aedca5b9625/icotest_deviceserver-1.1.9.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-11-06 10:11:10",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "icotest-deviceserver"
}
