IndustrialIO

class IndustrialIOClient
Canonical

kortex_api.autogen.client_stubs.IndustrialIOClientRpc

__init__(router, namespace=None)

Constructs a IndustrialIOClient with an initialized RouterClient and an optional namespace.

Parameters

  • router (RouterClient) – RouterClient used for the communication

  • namespace (string) – Optional namespace on which to initialize the IndustrialIOClient (defaults to None)

IsAlive(timeoutMs: int = 1000)

Returns True if the Service Server is detected online before timeoutMs is expired, False otherwise.

Parameters

timeoutMs (unsigned int) – The maximum time to wait for an answer from the server

Return type

bool

SetDigitalOutputConfiguration(digitaloutputconfiguration, deviceId=0, options=RouterClientSendOptions())
The CONFIGURE permission is necessary to call this RPC.

Configures a digital output channel.
The channel.identifier must be between 1 and 8.
An ERROR_INTERNAL will be thrown if the I/O board is not powered up.

Parameters
GetDigitalOutputConfiguration(digitalchannelidentifier, deviceId=0, options=RouterClientSendOptions())
The READ_ONLY permission is necessary to call this RPC.

Retrieves a digital output configuration for a specific channel.
The identifier must be between 1 and 8.
An ERROR_INTERNAL will be thrown if the I/O board is not powered up.

Parameters
Return type

DigitalOutputConfiguration

SetDigitalOutputHighState(digitalchannelidentifier, deviceId=0, options=RouterClientSendOptions())
The CONFIGURE permission is necessary to call this RPC.

Sets a digital output channel to a high state.
The identifier must be between 1 and 8.
An ERROR_INTERNAL will be thrown if the I/O board is not powered up.

Parameters
SetDigitalOutputLowState(digitalchannelidentifier, deviceId=0, options=RouterClientSendOptions())
The CONFIGURE permission is necessary to call this RPC.

Sets a digital output channel to a low state.
The identifier must be between 1 and 8.
An ERROR_INTERNAL will be thrown if the I/O board is not powered up.

Parameters
GetDigitalOutputInfo(digitalchannelidentifier, deviceId=0, options=RouterClientSendOptions())
The READ_ONLY permission is necessary to call this RPC.

Retrieves a digital output channel information.
The identifier must be between 1 and 8.
An ERROR_INTERNAL will be thrown if the I/O board is not powered up.

Parameters
Return type

DigitalOutputInfo

GetAllDigitalOutputInfo(deviceId = 0, options = RouterClientSendOptions())
The READ_ONLY permission is necessary to call this RPC.

Retrieves all digital output channel information.
An ERROR_INTERNAL will be thrown if the I/O board is not powered up.

Parameters

  • deviceId (int) – Device’s Id called by rpc (optional)

  • options (RouterClientSendOptions) – Router options for sending the message

Return type

DigitalOutputInfoList

SetDigitalInputConfiguration(digitalinputconfiguration, deviceId=0, options=RouterClientSendOptions())
The CONFIGURE permission is necessary to call this RPC.

Configures a digital input channel.
The channel.identifier must be between 1 and 8.
An ERROR_INTERNAL will be thrown if the I/O board is not powered up.

Parameters
GetDigitalInputConfiguration(digitalchannelidentifier, deviceId=0, options=RouterClientSendOptions())
The READ_ONLY permission is necessary to call this RPC.

Retrieves a digital input configuration for a specific channel.
The identifier must be between 1 and 8.
An ERROR_INTERNAL will be thrown if the I/O board is not powered up.

Parameters
Return type

DigitalInputConfiguration

GetDigitalInputInfo(digitalchannelidentifier, deviceId=0, options=RouterClientSendOptions())
The READ_ONLY permission is necessary to call this RPC.

Retrieves a digital input channel information.
The identifier must be between 1 and 8.
An ERROR_INTERNAL will be thrown if the I/O board is not powered up.

Parameters
Return type

DigitalInputInfo

GetAllDigitalInputInfo(deviceId = 0, options = RouterClientSendOptions())
The READ_ONLY permission is necessary to call this RPC.

Retrieves all digital input channel informaion.
An ERROR_INTERNAL will be thrown if the I/O board is not powered up.

Parameters

  • deviceId (int) – Device’s Id called by rpc (optional)

  • options (RouterClientSendOptions) – Router options for sending the message

Return type

DigitalInputInfoList

SetAnalogIOConfiguration(analogioconfiguration, deviceId=0, options=RouterClientSendOptions())
The CONFIGURE permission is necessary to call this RPC.

Configures an analog input/output channel.
An ERROR_INTERNAL will be thrown if the I/O board is not powered up.

Parameters
GetAnalogIOConfiguration(analogiochannelidentifier, deviceId=0, options=RouterClientSendOptions())
The READ_ONLY permission is necessary to call this RPC.

Retrieves an analog input/output configuration for a specific channel.
An ERROR_INTERNAL will be thrown if the I/O board is not powered up.

Parameters
Return type

AnalogIOConfiguration

SetAnalogValue(analogoutput, deviceId=0, options=RouterClientSendOptions())
The CONFIGURE permission is necessary to call this RPC.

Sets an analog value on a channel.
The dac_value is the value to set, either in V or mA.
An ERROR_INTERNAL will be thrown if the I/O board is not powered up.
An ERROR_INTERNAL will be thrown if the channel is not configured as an output also.
An ERROR_DEVICE, ENTITY_NOT_FOUND will be thrown if the dac_value is out of bounds. The exception message will contain the limits.

Parameters
GetAnalogIOInfo(analogiochannelidentifier, deviceId=0, options=RouterClientSendOptions())
The READ_ONLY permission is necessary to call this RPC.

Retrieves an analog input/output channel information.
An ERROR_INTERNAL will be thrown if the I/O board is not powered up.

Parameters
Return type

AnalogIOInfo

GetAllAnalogIOInfo(deviceId = 0, options = RouterClientSendOptions())
The READ_ONLY permission is necessary to call this RPC.

Retrieves all analog input/output channel information.
An ERROR_INTERNAL will be thrown if the I/O board is not powered up.

Parameters

  • deviceId (int) – Device’s Id called by rpc (optional)

  • options (RouterClientSendOptions) – Router options for sending the message

Return type

AnalogIOInfoList

ClearFaults(deviceId = 0, options = RouterClientSendOptions())
The CONFIGURE permission is necessary to call this RPC.

Clears digital and analog I/O faults.
An ERROR_INTERNAL will be thrown if the I/O board is not powered up.

Parameters

  • deviceId (int) – Device’s Id called by rpc (optional)

  • options (RouterClientSendOptions) – Router options for sending the message

Unsubscribe(notificationhandle, deviceId=0, options=RouterClientSendOptions())
The READ_ONLY permission is necessary to call this RPC.

Unsubscribes client from receiving notifications for the specified topic.
Parameters
OnNotificationDigitalOutputChangeTopic(callback, notificationoptions)
The READ_ONLY permission is necessary to call this RPC.

Subscribes to digital output change topic for notifications.
Parameters
Return type

NotificationHandle

OnNotificationDigitalInputChangeTopic(callback, notificationoptions)
The READ_ONLY permission is necessary to call this RPC.

Subscribes to digital input change topic for notifications.
Parameters
Return type

NotificationHandle

OnNotificationAnalogIOChangeTopic(callback, notificationoptions)
The READ_ONLY permission is necessary to call this RPC.

Subscribes to analog input/output change topic for notifications.
Parameters
Return type

NotificationHandle

OnNotificationWristAnalogIOChangeTopic(callback, notificationoptions)
The READ_ONLY permission is necessary to call this RPC.

Subscribes to wrist’s analog configuration change topic for notifications.
This notification is only emitted when the Industrial I/O Plugin changes the wrist’s configuration.
It’s not emitted when the analog value changes.

Parameters
Return type

NotificationHandle