class TMSiSDK.device.devices.apex.apex_structures.apex_info.ApexInfo(dongle_serial_number=0, serial_number=0, id=65535, dr_interface=DeviceInterfaceType.none, pairing_status=PairingStatus.no_pairing_needed)#

Bases: object

Class to handle the information of the Apex.

__init__(dongle_serial_number=0, serial_number=0, id=65535, dr_interface=DeviceInterfaceType.none, pairing_status=PairingStatus.no_pairing_needed)#

Initialize the information of Apex.

Parameters:

  • dongle_serial_number (int, optional) – serial number of the dongle, defaults to 0

  • serial_number (int, optional) – serial number of the device, defaults to 0

  • id (int, optional) – id of the Apex, defaults to ApexConst.TMSI_DEVICE_ID_NONE

  • dr_interface (_type_, optional) – interface with the Apex, defaults to DeviceInterfaceType.none

  • pairing_status (PairingStatus, optional) – pairing status, defaults to PairingStatus.no_pairing_needed

Methods

__init__([dongle_serial_number, ...])

Initialize the information of Apex.

get_dongle_serial_number()

Get the serial number of the dongle.

get_dr_interface()

Get interface type of the Apex.

get_dr_serial_number()

Get the serial number of the Apex.

get_id()

Get id of the Apex.

get_name()

Get the name of the Apex

get_num_channels()

Get the number of channels.

get_num_impedance_channels()

Get the number of impedance channels.

get_pairing_status()

Get the pairing status.

get_state()

Get the state of the Apex.

set_device_info_report(device_info_report)

Set the device info report.

set_dongle_id(dongle_id)

Set the id of the dongle.

set_dongle_serial_number(dongle_serial_number)

Set the serial number of the dongle.

set_dr_interface(dr_interface)

Set the interface of the Apex.

set_dr_serial_number(dr_serial_number)

Set the serial number of the Apex.

set_id(id)

Set the id of the Apex.

set_pairing_status(pairing_status)

Set the pairing status.

set_state(state)

Set the state of the device.
get_dongle_serial_number()#

Get the serial number of the dongle.

Returns:

serial number of the dongle.

Return type:

int

get_dr_interface()#

Get interface type of the Apex.

Returns:

interface type of the Apex.

Return type:

DeviceInterfaceType

get_dr_serial_number()#

Get the serial number of the Apex.

Returns:

serial number of the Apex.

Return type:

int

get_id()#

Get id of the Apex.

Returns:

id

Return type:

int

get_name()#

Get the name of the Apex

Returns:

name

Return type:

str

get_num_channels()#

Get the number of channels.

Returns:

number of channels.

Return type:

int

get_num_impedance_channels()#

Get the number of impedance channels.

Returns:

number of impedance channels.

Return type:

int

get_pairing_status()#

Get the pairing status.

Returns:

pairing status.

Return type:

PairingStatus

get_state()#

Get the state of the Apex.

Returns:

state of the Apex.

Return type:

DeviceState

set_device_info_report(device_info_report)#

Set the device info report.

Parameters:

device_info_report (TMSiDevInfoReport) – info report from the Apex.

set_dongle_id(dongle_id)#

Set the id of the dongle.

Parameters:

dongle_id (int) – dongle id.

set_dongle_serial_number(dongle_serial_number)#

Set the serial number of the dongle.

Parameters:

dongle_serial_number (int) – serial number of the dongle.

set_dr_interface(dr_interface)#

Set the interface of the Apex.

Parameters:

dr_interface (DeviceInterface) – interface of the Apex.

set_dr_serial_number(dr_serial_number)#

Set the serial number of the Apex.

Parameters:

dr_serial_number (int) – serial number.

set_id(id)#

Set the id of the Apex.

Parameters:

id (int) – id of the Apex.

set_pairing_status(pairing_status)#

Set the pairing status.

Parameters:

pairing_status (PairingStatus) – pairing status.

set_state(state)#

Set the state of the device.

Parameters:

state (DeviceState) – state of the device.

Contents