DeviceServer

DeviceServer API

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

• API version: 1.2.2
• Package version: 1.2.2
• Generator version: 7.11.0
• Build package: org.openapitools.codegen.languages.PythonClientCodegen

Requirements.

Python 3.8+

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

Setuptools

Install via Setuptools.

python setup.py install --user

(or sudo python setup.py install to install the package for all users)

Then import the package:

import DeviceServer

Tests

Execute pytest to run the tests.

Getting Started

Please follow the installation procedure and then run the following:

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.AttenuatorApi(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)
        print("The response of AttenuatorApi->get_attenuator_state:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling AttenuatorApi->get_attenuator_state: %s\n" % e)

Documentation for API Endpoints

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

Documentation For Models

• AttenuationState
• ChannelAttenuationState
• DbButtonState
• DbDeviceButton
• DbDeviceLed
• DbDevicePort
• DbDeviceTemperaturePort
• DbLedState
• DbPortState
• DbUploadFirmwareState
• Device
• DeviceButton
• DeviceLed
• DevicePort
• DeviceRxBuffer
• DeviceTemperaturePort
• DeviceTxBuffer
• FirmwareVersion
• HostConfig
• LedState
• PortState
• PostVerifyUserAccessRequest
• PutDeviceDeviceIdDescription200Response
• PutDeviceDeviceIdName200Response
• RelayState
• TempRange
• Temperature

Documentation For Authorization

Authentication schemes defined for the API:

bearerAuthHeader

• Type: Bearer authentication

Author

david@3adesign.co.uk