Icotest-DeviceServer 1.0.5

Icotest Device Server API

DeviceServer

DeviceServer API

This Python package is automatically generated by the OpenAPI Generator project:

• API version: 1.0.5
• Package version: 1.0.5
• Build package: org.openapitools.codegen.languages.PythonClientCodegen

Requirements.

Python 3.4+

Installation & Usage

pip install

If the python package is hosted on a repository, you can install directly using:

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:

import DeviceServer

Getting Started

Please follow the installation procedure and then run the following:

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 | UUID of device
current_index = 56 # int | Index of Current port

    try:
        # GET current reading of device
        api_response = api_instance.get_current(device_id, current_index)
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling DevicesApi->get_current: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to http://localhost/DeviceServer

Class	Method	HTTP request	Description
DevicesApi	get_current	GET /Devices/{device_id}/Currents/{current_index}	GET current reading of device
DevicesApi	get_device_device_id_ports	GET /Devices/{device_id}/Ports	GET all ports for device
DevicesApi	get_device_id_port_index	GET /Devices/{device_id}/Ports/{port_index}	GET status of port
DevicesApi	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	GET /Devices/{device_id}/Ports/{port_index}/Modules/{module_index}/Leds	GET state of Port LED
DevicesApi	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	GET /Devices/{device_id}/Ports/{port_index}/Voltages	GET voltage reading of device Port
DevicesApi	get_devices	GET /Devices	GET list of devices
DevicesApi	get_devices_button	GET /Devices/{device_id}/Button	GET state of button
DevicesApi	get_devices_index	GET /Devices/{device_id}	GET single device
DevicesApi	get_devices_led_index	GET /Devices/{device_id}/Leds/{led_index}	GET state of LED
DevicesApi	get_devices_status	GET /Devices/{device_id}/Status/{component_index}	GET status of the device
DevicesApi	get_devices_temperature	GET /Devices/{device_id}/Temperature	GET temperature of Device
DevicesApi	get_fan_speed	GET /Devices/{device_id}/Fan/{fan_index}/Speed	GET device fan speed
DevicesApi	get_fan_target_temperature	GET /Devices/{device_id}/Fan/{fan_index}/TargetTemperature	GET device fan target temperature
DevicesApi	get_fan_temperature	GET /Devices/{device_id}/Fan/{fan_index}/Temperature	GET device fan temperature
DevicesApi	get_host_config	GET /Host/Config	Your GET endpoint
DevicesApi	get_port	GET /Port/{port_id}	GET status of port by id
DevicesApi	get_port_led_state	GET /Devices/{device_id}/Ports/{port_index}/Leds/{led_index}	GET state of Port LED
DevicesApi	get_port_states	GET /PortStates/{port_id}	Your GET endpoint
DevicesApi	get_port_status	GET /Devices/{device_id}/Ports/{port_index}/Status	GET status of the device port
DevicesApi	get_port_temperature	GET /Devices/{device_id}/Ports/{port_index}/Temperature	GET temperature of device Port
DevicesApi	get_ports	GET /Ports	GET status of all ports
DevicesApi	get_relay_state	GET /Devices/{device_id}/Relay	GET device relay state
DevicesApi	get_temperature_range	GET /Devices/{device_id}/Temperature/Range	Your GET endpoint
DevicesApi	get_temperature_thresholds	GET /Devices/{device_id}/Temperature/Thresholds	Your GET endpoint
DevicesApi	get_voltage	GET /Devices/{device_id}/Voltages/{voltage_index}	GET voltage reading of device
DevicesApi	put_device_device_id_description	PUT /Device/{device_id}/Description
DevicesApi	put_device_device_id_name	PUT /Device/{device_id}/Name
DevicesApi	put_device_id_label	PUT /Device/{device_id}/Port/{port_index}/Label
DevicesApi	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	PUT /Devices/{device_id}/Ports/{port_index}/Modules/{module_index}/Relays/{relay_index}	PUT state of Port LED
DevicesApi	put_devices_led_index	PUT /Devices/{device_id}/Leds/{led_index}	PUT state of LED
DevicesApi	put_devices_ports	PUT /Devices/{device_id}/Ports/{port_index}	PUT state of port
DevicesApi	put_devices_ports_pulse	PUT /Devices/{device_id}/Ports/{port_index}/Pulse	PUT port into state for period of time
DevicesApi	put_devices_status	PUT /Devices/{device_id}/Status/{component_index}	PUT status of the device
DevicesApi	put_host_config	PUT /Host/Config
DevicesApi	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	PUT /Port/{port_id}/Label
DevicesApi	put_port_states_port_id	PUT /PortStates/{port_id}
DevicesApi	put_port_status	PUT /Devices/{device_id}/Ports/{port_index}/Status	PUT status of the device
DevicesApi	put_ports_pulse	PUT /Ports/{port_index}/Pulse	PUT port into state for period of time
DevicesApi	put_relay_state	PUT /Devices/{device_id}/Relay	PUT device relay state
DevicesApi	put_serial_test_message	PUT /Devices/{device_id}/Ports/{port_index}/SerialMessage	Serial Message Test
DevicesApi	put_socket_refresh	PUT /Devices/{device_id}/Socket/Refresh
DevicesApi	put_state_by_port_id	PUT /Port/{port_id}	PUT state of port

Documentation For Models

• DbDevicePort
• DbPortState
• Device
• DevicePort
• HostConfig
• InlineResponse200
• InlineResponse2001
• InlineResponse2002
• InlineResponse2003
• InlineResponse2004
• InlineResponse2005
• InlineResponse2006
• PortState
• TempRange
• Temperature

Documentation For Authorization

All endpoints do not require authorization.

Author

[e-mail]