DeviceIO

DeviceIO service implementation.

DeviceIO

Bases: ONVIFService

0.0.1 2.0

DeviceIO service client.

Property	Details
First introduced	ONVIF 2.0 (November 2010)
Binding name	`DeviceIOBinding` (`ver10/deviceio.wsdl`)
Operations	deviceio.wsdl
Spec	DeviceIO

GetServiceCapabilities

GetServiceCapabilities()

Returns the capabilities of the device IO service.

The result is returned in a typed answer.

GetRelayOutputOptions

GetRelayOutputOptions(RelayOutputToken=None)

Request the available settings and ranges for one or all relay outputs.

A device that has one or more RelayOutputs should support this command.

Two examples that illustrate usage:

1) Device supports range PT1S to PT120S:

<tmd:RelayOutputOptions token='44'>
  <tmd:Mode>Monostable</tmd:Mode>
  <tmd:DelayTimes>1 120</tmd:DelayTimes>
</tmd:RelayOutputOptions>

2) Device supports values PT0.5S, PT1S, PT2s and PT1M:

<tmd:RelayOutputOptions token='123'>
  <tmd:Mode>Monostable</tmd:Mode>
  <tmd:DelayTimes>0.5 1 2 60</tmd:DelayTimes>
  <tmd:Discrete>True</tmd:Discrete>
</tmd:RelayOutputOptions>

GetAudioSources

GetAudioSources()

List all available audio sources for the device.

The device that has one or more audio sources shall support the listing of available audio inputs through the GetAudioSources command.

GetAudioOutputs

GetAudioOutputs()

List all available audio outputs of a device.

A device that has one or more physical audio outputs shall support listing of available audio outputs through the GetAudioOutputs command.

GetVideoSources

GetVideoSources()

List all available video sources for the device.

The device that has one or more video inputs shall support the listing of available video sources through the GetVideoSources command.

GetVideoOutputs

GetVideoOutputs()

List all available video outputs of a device.

A device that has one or more physical video outputs shall support listing of available video outputs through the GetVideoOutputs command.

GetVideoSourceConfiguration

GetVideoSourceConfiguration(VideoSourceToken)

Get the video source configurations of a VideoSource.

A device with one or more video sources shall support the GetVideoSourceConfigurations command.

This method is deprecated.

GetVideoOutputConfiguration

GetVideoOutputConfiguration(VideoOutputToken)

Get the configuration of a Video Output.

A device that has one or more Video Outputs shall support the retrieval of the VideoOutputConfiguration through this command.

GetAudioSourceConfiguration

GetAudioSourceConfiguration(AudioSourceToken)

List the configuration of an Audio Input.

A device with one or more audio inputs shall support the GetAudioSourceConfiguration command.

This method is deprecated.

GetAudioOutputConfiguration

GetAudioOutputConfiguration(AudioOutputToken)

Request the current configuration of a physical Audio output.

A device that has one or more AudioOutputs shall support the retrieval of the AudioOutputConfiguration through this command.

This method is deprecated.

SetVideoSourceConfiguration

SetVideoSourceConfiguration(
    Configuration, ForcePersistence
)

Modify a video input configuration.

A device that has one or more video sources shall support the setting of the VideoSourceConfiguration through this command.

This method is deprecated.

SetVideoOutputConfiguration

SetVideoOutputConfiguration(
    Configuration, ForcePersistence
)

Modify a video output configuration.

A device that has one or more video outputs shall support the setting of its video output configuration through this command.

SetAudioSourceConfiguration

SetAudioSourceConfiguration(
    Configuration, ForcePersistence
)

Modify an audio source configuration.

A device that has a one or more audio sources shall support the setting of the AudioSourceConfiguration through this command.

This method is deprecated.

SetAudioOutputConfiguration

SetAudioOutputConfiguration(
    Configuration, ForcePersistence
)

Modify an audio output configuration.

A device that has one or more audio outputs shall support the setting of the AudioOutputConfiguration through this command.

This method is deprecated.

GetVideoSourceConfigurationOptions

GetVideoSourceConfigurationOptions(VideoSourceToken)

Request the VideoSourceConfigurationOptions of a VideoSource.

A device with one or more video sources shall support this command.

This method is deprecated.

GetVideoOutputConfigurationOptions

GetVideoOutputConfigurationOptions(VideoOutputToken)

Request the VideoOutputConfigurationOptions of a VideoOutput.

A device that has one or more video outputs shall support the retrieval of VideoOutputConfigurationOptions through this command.

GetAudioSourceConfigurationOptions

GetAudioSourceConfigurationOptions(AudioSourceToken)

Request the AudioSourceConfigurationOptions of an AudioSource.

A device with one or more AudioSources shall support this command.

This method is deprecated.

GetAudioOutputConfigurationOptions

GetAudioOutputConfigurationOptions(AudioOutputToken)

Request the available settings and ranges for a physical Audio output.

A device that has one or more AudioOutputs shall support this command.

This method is deprecated.

GetRelayOutputs

GetRelayOutputs()

This operation gets a list of all available relay outputs and their settings.

SetRelayOutputSettings

SetRelayOutputSettings(
    RelayOutput, RelayOutputToken, Properties
)

This operation sets the settings of a relay output.

The relay can work in two relay modes:

Bistable - After setting the state, the relay remains in this state.
Monostable - After setting the state, the relay returns to its idle state after the specified time. The physical idle state of a relay output can be configured by setting the IdleState to 'open' or 'closed' (inversion of the relay behaviour).

Idle State 'open' means that the relay is open when the relay state is set to 'inactive' through the trigger command (see Section 8.5.3) and closed when the state is set to 'active' through the same command.

Idle State 'closed' means, that the relay is closed when the relay state is set to 'inactive' through the trigger command (see Section 8.5.3) and open when the state is set to 'active' through the same command.

SetRelayOutputState

SetRelayOutputState(RelayOutputToken, LogicalState)

Modify the relay state.

GetDigitalInputs

GetDigitalInputs()

This operation gets a list of all available digital inputs.

GetDigitalInputConfigurationOptions

GetDigitalInputConfigurationOptions(Token=None)

This operation lists what configuration is available for digital inputs.

SetDigitalInputConfigurations

SetDigitalInputConfigurations(DigitalInputs)

Modify a digital input configuration.

GetSerialPorts

GetSerialPorts()

This operation gets a list of all available serial ports.

GetSerialPortConfiguration

GetSerialPortConfiguration(SerialPortToken)

This operation gets the configuration of a serial port.

SetSerialPortConfiguration

SetSerialPortConfiguration(
    SerialPortConfiguration, ForcePersistance
)

Modify a serial port configuration.

GetSerialPortConfigurationOptions

GetSerialPortConfigurationOptions(SerialPortToken)

This operation lists what configuration is available for serial ports.

SendReceiveSerialCommand

SendReceiveSerialCommand(
    Token=None,
    SerialData=None,
    TimeOut=None,
    DataLength=None,
    Delimiter=None,
)

This operation transmitting arbitrary data to the connected serial device and then receiving its response data.