TMSiSDK.device.devices.apex.apex_device.ApexDevice.set_device_sampling_config

TMSiSDK.device.devices.apex.apex_device.ApexDevice.set_device_sampling_config#

ApexDevice.set_device_sampling_config(sampling_frequency=ApexBaseSampleRate.Decimal, live_impedance=ApexLiveImpedance.On, impedance_limit=0) → TMSiDevSamplingCfg#

Sets the sampling configuration of the device.

Parameters:

  • sampling_frequency (ApexBaseSampleRate, optional) – sample rate to set, defaults to ApexBaseSampleRate.Decimal

  • live_impedance (ApexLiveImpedance, optional) – enable or disable live impedance, defaults to ApexLiveImpedance.On

  • impedance_limit (int, optional) – kOhms value of the impedance limit, defaults to 0

Raises:

  • TMSiError – TMSiErrorCode.device_error if set sampling configuration fails.

  • TMSiError – TMSiErrorCode.device_not_connected if not connected.

Returns:

the new sampling configuration

Return type:

TMSiDevSamplingCfg

Contents