Channel

Channel related API functions.

Modules

Functions

GHS.ghs_get_channel_type(slot_id: str, channel_index: int) → tuple[str, int | None][source]

Determine the type of a channel.

Read - This method can be called by multiple connected clients at same time.

Parameters

  • slot_id – The slot containing the recorder

  • channel_index – The zero-based index of the channel

Returns

  • GHSReturnValue - API return values

  • GHSChannelType - Type of the channel

GHS.ghs_get_channel_name(slot_id: str, channel_index: int) → tuple[str, int | None][source]

Determine the name of a channel.

The channel name is UTF-8 encoded

Read - This method can be called by multiple connected clients at same time.

Parameters

  • slot_id – The slot containing the recorder

  • channel_index – The zero-based index of the channel

Returns

  • GHSReturnValue - API return values

  • channel_name - The name of the channel

GHS.ghs_set_channel_name(slot_id: str, channel_index: int, channel_name: str) → str[source]

Set the name for a channel.

The channel name is UTF-8 encoded

ReadWrite - This method will only process requests from the connected client with the most privileges order (Privileges order: 1- Perception, 2- GenDaq, 3- Other)

Parameters

  • slot_id – The slot containing the recorder

  • channel_index – The zero-based index of the channel

  • channel_name – The name of the channel

Returns

  • GHSReturnValue - API return values

GHS.ghs_get_channel_storage_enabled(slot_id: str, channel_index: int) → tuple[str, str | None][source]

Determine if storage is enabled or disabled for a channel.

Read - This method can be called by multiple connected clients at same time.

Parameters

  • slot_id – The slot containing the recorder

  • channel_index – The zero-based index of the channel

Returns

  • GHSReturnValue - API return values

  • GHSEnableDisable - The storage enabled status for the channel

GHS.ghs_set_channel_storage_enabled(slot_id: str, channel_index: int, enabled: str | int) → str[source]

Enable or disable storage for a channel.

The system needs to be idle before calling this function.

ReadWrite - This method will only process requests from the connected client with the most privileges order (Privileges order: 1- Perception, 2- GenDaq, 3- Other)

Parameters

  • slot_id – The slot containing the recorder

  • channel_index – The zero-based index of the channel

  • enabled – The desired storage enabled status for the channel

Returns

  • GHSReturnValue - API return values

GHS.ghs_cmd_zeroing(slot_id: str, channel_index: int, ezeroing: str | int) → str[source]

Perform zeroing in a channel.

The system needs to be idle before calling this function.

Read - This method can be called by multiple connected clients at same time.

Parameters

  • slot_id – The slot containing the recorder

  • channel_index – The zero-based index of the channel

  • ezeroing – Zero / Unzero the specific channel

Returns

  • GHSReturnValue - API return values

Accepted values:

  • slot_id - e.g. ‘A’ for the first slot

  • enabled - “Enable”, “Disable”

  • ezeroing - “Enable”, “Disable”