ondosense-connect-api 0.42.5

Autogenerated Python classes to be used with ondosense-connect or other tools

ondosense-connect-api

This package provides Command and Parameter classes to be used with ondosense-connect.

Usage Examples

Get a Distance Measurement

from ondosense.connect.rs485.sensor import SerialSensor

with (SerialSensor('COM1') as sensor):
    sensor.autoset_amplifier_gains()

    measurement = sensor.get_measurement()

    print(measurement.distance.distance_in_m)

Setting Parameter Values

When setting multiple parameters you can make use of the fluent interface and concatenate multiple set_parameter() calls:

from ondosense.connect.rs485.sensor import SerialSensor
import ondosense.connect.parameters as p

with SerialSensor('COM1') as sensor:
    (
        sensor
        .set_parameter(p.MinDistanceInMm(500))
        .set_parameter(p.MaxDistanceInMm(3000))
    )

Getting Parameter Values

The response of a get_parameter() call is a Parameter type instance.

To get the parameters value, you can either access the value property or cast the Parameter to int:

from ondosense.connect.rs485.sensor import SerialSensor
import ondosense.connect.parameters as p

with SerialSensor('COM1') as sensor:
    print(sensor.get_parameter(p.MinDistanceInMm))

    print(sensor.get_parameter(p.MinDistanceInMm).value)

    print(int(sensor.get_parameter(p.MinDistanceInMm)))

Advanced Use Cases

For more advanced use cases like doing burst measurements, saving measurements, using different result data selectors and so on, please see the documentation of the ondosense-connect package.

API Overview

Command Overview

GetMetaData

This command gets the IMU data from the sensor. These are X. Y, Z axis accelerations and a temperature reading.

from ondosense.connect.rs485.sensor import SerialSensor
import ondosense.connect.commands as commands

with SerialSensor('COM1') as sensor:
    cmd = commands.GetMetaData()

    sensor.execute_command(cmd)

    print(cmd.response_data)

# response_data is a dict containing these keys:
# - acceleration_x_milli_g (Type: int)
# - acceleration_y_milli_g (Type: int)
# - acceleration_z_milli_g (Type: int)
# - temperature_imu_centi_degree_c (Type: int)
# - temperature_internal_degree_c (Type: int)
# - temperature_raw_data (Type: int)
# - temperature_external_centi_degree_c (Type: int)

BackgroundSubtraction

This commands sets the current spectrum as background.

from ondosense.connect.rs485.sensor import SerialSensor
import ondosense.connect.commands as commands

with SerialSensor('COM1') as sensor:
    cmd = commands.BackgroundSubtraction()

    sensor.execute_command(cmd)

    print(cmd.response_data)

RemoveBackgroundSubtraction

This commands removes a previously captured background.

from ondosense.connect.rs485.sensor import SerialSensor
import ondosense.connect.commands as commands

with SerialSensor('COM1') as sensor:
    cmd = commands.RemoveBackgroundSubtraction()

    sensor.execute_command(cmd)

    print(cmd.response_data)

SetIqDataSubtraction

This command sets the IQ background data.

from ondosense.connect.rs485.sensor import SerialSensor
import ondosense.connect.commands as commands

with SerialSensor('COM1') as sensor:
    cmd = commands.SetIqDataSubtraction({
        "number_of_iq_sets": <value>,
    })

    sensor.execute_command(cmd)

    print(cmd.response_data)

ReadIqDataSubtraction

This commands read the IQ background data.

from ondosense.connect.rs485.sensor import SerialSensor
import ondosense.connect.commands as commands

with SerialSensor('COM1') as sensor:
    cmd = commands.ReadIqDataSubtraction()

    sensor.execute_command(cmd)

    print(cmd.response_data)

# response_data is a dict containing these keys:
# - number_of_iq_background_data (Type: int)

RestartHighPrecisionMode

This command resets the Displacement Mode measurement.

from ondosense.connect.rs485.sensor import SerialSensor
import ondosense.connect.commands as commands

with SerialSensor('COM1') as sensor:
    cmd = commands.RestartHighPrecisionMode()

    sensor.execute_command(cmd)

    print(cmd.response_data)

WriteBackgroundSubtraction

This command writes a given data set to the background data.

from ondosense.connect.rs485.sensor import SerialSensor
import ondosense.connect.commands as commands

with SerialSensor('COM1') as sensor:
    cmd = commands.WriteBackgroundSubtraction({
        "amplitude": <value>,
        "magnitudes": <value>,
    })

    sensor.execute_command(cmd)

    print(cmd.response_data)

GetRadarProfiles

This command returns all available RADAR profiles.

from ondosense.connect.rs485.sensor import SerialSensor
import ondosense.connect.commands as commands

with SerialSensor('COM1') as sensor:
    cmd = commands.GetRadarProfiles()

    sensor.execute_command(cmd)

    print(cmd.response_data)

# response_data is a dict containing these keys:
# - count (Type: int)
# - profiles (Type: int)

Parameter Overview

MinDistanceInMm

Lower limit of the sensors measurement range. Use this parameter to limit detection of targets to a desired range.

Parameter Info

ID (dec)	ID (hex)	Unit	Readable	Writable
68	0x44	mm	✓	✓

Usage Example

from ondosense.connect.rs485.sensor import SerialSensor
import ondosense.connect.parameters as parameters

with SerialSensor('COM1') as sensor:
    # Set parameter value
    sensor.set_parameter(parameters.MinDistanceInMm(<value>))

    # Get parameter value
    parameter_response = sensor.get_parameter(parameters.MinDistanceInMm)

    # Use the 'value' property of the parameter_response
    print(parameter_response.value)

    # or cast the parameter_response to "int"
    print(int(parameter_response))

MaxDistanceInMm

Upper limit of the sensors measurement range. Use this parameter to limit detection of targets to a desired range.

Parameter Info

ID (dec)	ID (hex)	Unit	Readable	Writable
69	0x45	mm	✓	✓

Usage Example

from ondosense.connect.rs485.sensor import SerialSensor
import ondosense.connect.parameters as parameters

with SerialSensor('COM1') as sensor:
    # Set parameter value
    sensor.set_parameter(parameters.MaxDistanceInMm(<value>))

    # Get parameter value
    parameter_response = sensor.get_parameter(parameters.MaxDistanceInMm)

    # Use the 'value' property of the parameter_response
    print(parameter_response.value)

    # or cast the parameter_response to "int"
    print(int(parameter_response))

DistanceOffsetInMm

Use this parameter to specify a constant which will be added to the measured distance.

Parameter Info

ID (dec)	ID (hex)	Unit	Readable	Writable
237	0xed	mm	✓	✓

Usage Example

from ondosense.connect.rs485.sensor import SerialSensor
import ondosense.connect.parameters as parameters

with SerialSensor('COM1') as sensor:
    # Set parameter value
    sensor.set_parameter(parameters.DistanceOffsetInMm(<value>))

    # Get parameter value
    parameter_response = sensor.get_parameter(parameters.DistanceOffsetInMm)

    # Use the 'value' property of the parameter_response
    print(parameter_response.value)

    # or cast the parameter_response to "int"
    print(int(parameter_response))

NumberSpectrumIntegrations

Use this parameter to configure the number of spectrum integrations. This will smooth out bumps in the measured distance. Setting this parameter to 0 disables the smoothing

Parameter Info

ID (dec)	ID (hex)	Unit	Readable	Writable
71	0x47		✓	✓

Usage Example

from ondosense.connect.rs485.sensor import SerialSensor
import ondosense.connect.parameters as parameters

with SerialSensor('COM1') as sensor:
    # Set parameter value
    sensor.set_parameter(parameters.NumberSpectrumIntegrations(<value>))

    # Get parameter value
    parameter_response = sensor.get_parameter(parameters.NumberSpectrumIntegrations)

    # Use the 'value' property of the parameter_response
    print(parameter_response.value)

    # or cast the parameter_response to "int"
    print(int(parameter_response))

RadarProfileSelector

Use this parameter to select a RADAR profile suited your application. Note: Some sensors only provide one RADAR profile, so changing it is not possible.

Parameter Info

ID (dec)	ID (hex)	Unit	Readable	Writable
72	0x48		✓	✓

Usage Example

from ondosense.connect.rs485.sensor import SerialSensor
import ondosense.connect.parameters as parameters

with SerialSensor('COM1') as sensor:
    # Set parameter value
    sensor.set_parameter(parameters.RadarProfileSelector(<value>))

    # Get parameter value
    parameter_response = sensor.get_parameter(parameters.RadarProfileSelector)

    # Use the 'value' property of the parameter_response
    print(parameter_response.value)

    # or cast the parameter_response to "int"
    print(int(parameter_response))

PaGainQ

This parameter controls the pre-amplifier gain for the Q signal. 0 is highest amplification, 255 is lowest.

Parameter Info

ID (dec)	ID (hex)	Unit	Readable	Writable
112	0x70		✓	✓

Usage Example

from ondosense.connect.rs485.sensor import SerialSensor
import ondosense.connect.parameters as parameters

with SerialSensor('COM1') as sensor:
    # Set parameter value
    sensor.set_parameter(parameters.PaGainQ(<value>))

    # Get parameter value
    parameter_response = sensor.get_parameter(parameters.PaGainQ)

    # Use the 'value' property of the parameter_response
    print(parameter_response.value)

    # or cast the parameter_response to "int"
    print(int(parameter_response))

PaGainI

This parameter controls the pre-amplifier gain for the I signal. 0 is highest amplification, 255 is lowest.

Parameter Info

ID (dec)	ID (hex)	Unit	Readable	Writable
113	0x71		✓	✓

Usage Example

from ondosense.connect.rs485.sensor import SerialSensor
import ondosense.connect.parameters as parameters

with SerialSensor('COM1') as sensor:
    # Set parameter value
    sensor.set_parameter(parameters.PaGainI(<value>))

    # Get parameter value
    parameter_response = sensor.get_parameter(parameters.PaGainI)

    # Use the 'value' property of the parameter_response
    print(parameter_response.value)

    # or cast the parameter_response to "int"
    print(int(parameter_response))

AaGainQ

This parameter controls the main amplifier gain for the Q signal. 255 is highest amplification, 0 is lowest.

Parameter Info

ID (dec)	ID (hex)	Unit	Readable	Writable
114	0x72		✓	✓

Usage Example

from ondosense.connect.rs485.sensor import SerialSensor
import ondosense.connect.parameters as parameters

with SerialSensor('COM1') as sensor:
    # Set parameter value
    sensor.set_parameter(parameters.AaGainQ(<value>))

    # Get parameter value
    parameter_response = sensor.get_parameter(parameters.AaGainQ)

    # Use the 'value' property of the parameter_response
    print(parameter_response.value)

    # or cast the parameter_response to "int"
    print(int(parameter_response))

AaGainI

This parameter controls the main amplifier gain for the I signal. 255 is highest amplification, 0 is lowest.

Parameter Info

ID (dec)	ID (hex)	Unit	Readable	Writable
115	0x73		✓	✓

Usage Example

from ondosense.connect.rs485.sensor import SerialSensor
import ondosense.connect.parameters as parameters

with SerialSensor('COM1') as sensor:
    # Set parameter value
    sensor.set_parameter(parameters.AaGainI(<value>))

    # Get parameter value
    parameter_response = sensor.get_parameter(parameters.AaGainI)

    # Use the 'value' property of the parameter_response
    print(parameter_response.value)

    # or cast the parameter_response to "int"
    print(int(parameter_response))

ThresholdOffset

This parameter sets the amplitude threshold value for a peak to be considered a valid target.

Parameter Info

ID (dec)	ID (hex)	Unit	Readable	Writable
130	0x82		✓	✓

Usage Example

from ondosense.connect.rs485.sensor import SerialSensor
import ondosense.connect.parameters as parameters

with SerialSensor('COM1') as sensor:
    # Set parameter value
    sensor.set_parameter(parameters.ThresholdOffset(<value>))

    # Get parameter value
    parameter_response = sensor.get_parameter(parameters.ThresholdOffset)

    # Use the 'value' property of the parameter_response
    print(parameter_response.value)

    # or cast the parameter_response to "int"
    print(int(parameter_response))

HighPrecisionDistanceThreshold

This parameter sets the number of wave lengths allowed between two consecutive high precision distance measurements before the target will be considered lost.

Parameter Info

ID (dec)	ID (hex)	Unit	Readable	Writable
131	0x83		✓	✓

Usage Example

from ondosense.connect.rs485.sensor import SerialSensor
import ondosense.connect.parameters as parameters

with SerialSensor('COM1') as sensor:
    # Set parameter value
    sensor.set_parameter(parameters.HighPrecisionDistanceThreshold(<value>))

    # Get parameter value
    parameter_response = sensor.get_parameter(parameters.HighPrecisionDistanceThreshold)

    # Use the 'value' property of the parameter_response
    print(parameter_response.value)

    # or cast the parameter_response to "int"
    print(int(parameter_response))

HighPrecisionTimeoutInUs

This parameter sets the duration before the high precision mode resets itself after a target lost event has been detected.

Parameter Info

ID (dec)	ID (hex)	Unit	Readable	Writable
132	0x84	us	✓	✓

Usage Example

from ondosense.connect.rs485.sensor import SerialSensor
import ondosense.connect.parameters as parameters

with SerialSensor('COM1') as sensor:
    # Set parameter value
    sensor.set_parameter(parameters.HighPrecisionTimeoutInUs(<value>))

    # Get parameter value
    parameter_response = sensor.get_parameter(parameters.HighPrecisionTimeoutInUs)

    # Use the 'value' property of the parameter_response
    print(parameter_response.value)

    # or cast the parameter_response to "int"
    print(int(parameter_response))

RxDelayInUs

This parameter sets the sensor's delay between end of reception and start of transmission over the RS485 interface.

Parameter Info

ID (dec)	ID (hex)	Unit	Readable	Writable
144	0x90	us	✓	✓

Usage Example

from ondosense.connect.rs485.sensor import SerialSensor
import ondosense.connect.parameters as parameters

with SerialSensor('COM1') as sensor:
    # Set parameter value
    sensor.set_parameter(parameters.RxDelayInUs(<value>))

    # Get parameter value
    parameter_response = sensor.get_parameter(parameters.RxDelayInUs)

    # Use the 'value' property of the parameter_response
    print(parameter_response.value)

    # or cast the parameter_response to "int"
    print(int(parameter_response))

Sensitivity

This parameter sets the sensitivity for the CFAR algorithm.

Parameter Info

ID (dec)	ID (hex)	Unit	Readable	Writable
145	0x91		✓	✓

Usage Example

from ondosense.connect.rs485.sensor import SerialSensor
import ondosense.connect.parameters as parameters

with SerialSensor('COM1') as sensor:
    # Set parameter value
    sensor.set_parameter(parameters.Sensitivity(<value>))

    # Get parameter value
    parameter_response = sensor.get_parameter(parameters.Sensitivity)

    # Use the 'value' property of the parameter_response
    print(parameter_response.value)

    # or cast the parameter_response to "int"
    print(int(parameter_response))

PeakSortingMethod

This parameter sets the peak sorting algorithm used to determine a peak.

Parameter Info

ID (dec)	ID (hex)	Unit	Readable	Writable
146	0x92		✓	✓

Usage Example

from ondosense.connect.rs485.sensor import SerialSensor
import ondosense.connect.parameters as parameters

with SerialSensor('COM1') as sensor:
    # Set parameter value
    sensor.set_parameter(parameters.PeakSortingMethod(<value>))

    # Get parameter value
    parameter_response = sensor.get_parameter(parameters.PeakSortingMethod)

    # Use the 'value' property of the parameter_response
    print(parameter_response.value)

    # or cast the parameter_response to "int"
    print(int(parameter_response))

PeakIndex

This parameter selects the peak index to be used for the distance calculation. The result depends on the chosen peak sorting algorithm.

Parameter Info

ID (dec)	ID (hex)	Unit	Readable	Writable
147	0x93		✓	✓

Usage Example

from ondosense.connect.rs485.sensor import SerialSensor
import ondosense.connect.parameters as parameters

with SerialSensor('COM1') as sensor:
    # Set parameter value
    sensor.set_parameter(parameters.PeakIndex(<value>))

    # Get parameter value
    parameter_response = sensor.get_parameter(parameters.PeakIndex)

    # Use the 'value' property of the parameter_response
    print(parameter_response.value)

    # or cast the parameter_response to "int"
    print(int(parameter_response))

PacketSizeInByte

This parameter sets the packet size used for transmission over the RS485 interface.

Parameter Info

ID (dec)	ID (hex)	Unit	Readable	Writable
148	0x94	Byte	✓	✓

Usage Example

from ondosense.connect.rs485.sensor import SerialSensor
import ondosense.connect.parameters as parameters

with SerialSensor('COM1') as sensor:
    # Set parameter value
    sensor.set_parameter(parameters.PacketSizeInByte(<value>))

    # Get parameter value
    parameter_response = sensor.get_parameter(parameters.PacketSizeInByte)

    # Use the 'value' property of the parameter_response
    print(parameter_response.value)

    # or cast the parameter_response to "int"
    print(int(parameter_response))

PacketDelayInUs

This parameter sets the delay between consecutively sent packages over the RS485 interface.

Parameter Info

ID (dec)	ID (hex)	Unit	Readable	Writable
149	0x95	us	✓	✓

Usage Example

from ondosense.connect.rs485.sensor import SerialSensor
import ondosense.connect.parameters as parameters

with SerialSensor('COM1') as sensor:
    # Set parameter value
    sensor.set_parameter(parameters.PacketDelayInUs(<value>))

    # Get parameter value
    parameter_response = sensor.get_parameter(parameters.PacketDelayInUs)

    # Use the 'value' property of the parameter_response
    print(parameter_response.value)

    # or cast the parameter_response to "int"
    print(int(parameter_response))

ExponentialMovingAverageTimeInMs

The averaging time affects the time frame over which the exponential averaging is applied and specifies that 95% of the output distance come from the new distance value.

Parameter Info

ID (dec)	ID (hex)	Unit	Readable	Writable
150	0x96	ms	✓	✓

Usage Example

from ondosense.connect.rs485.sensor import SerialSensor
import ondosense.connect.parameters as parameters

with SerialSensor('COM1') as sensor:
    # Set parameter value
    sensor.set_parameter(parameters.ExponentialMovingAverageTimeInMs(<value>))

    # Get parameter value
    parameter_response = sensor.get_parameter(parameters.ExponentialMovingAverageTimeInMs)

    # Use the 'value' property of the parameter_response
    print(parameter_response.value)

    # or cast the parameter_response to "int"
    print(int(parameter_response))

OutlierMaxTimeInMs

This parameter sets the time after which a new distance measurement will be considered valid even if an implausible jump occurred.

Parameter Info

ID (dec)	ID (hex)	Unit	Readable	Writable
151	0x97	ms	✓	✓

Usage Example

from ondosense.connect.rs485.sensor import SerialSensor
import ondosense.connect.parameters as parameters

with SerialSensor('COM1') as sensor:
    # Set parameter value
    sensor.set_parameter(parameters.OutlierMaxTimeInMs(<value>))

    # Get parameter value
    parameter_response = sensor.get_parameter(parameters.OutlierMaxTimeInMs)

    # Use the 'value' property of the parameter_response
    print(parameter_response.value)

    # or cast the parameter_response to "int"
    print(int(parameter_response))

OutlierMaxDistanceInUm

This parameters sets the maximum expected difference between two distance consecutive measurements in your application. This ensures that only plausible changes in distance are accepted.

Parameter Info

ID (dec)	ID (hex)	Unit	Readable	Writable
152	0x98	um	✓	✓

Usage Example

from ondosense.connect.rs485.sensor import SerialSensor
import ondosense.connect.parameters as parameters

with SerialSensor('COM1') as sensor:
    # Set parameter value
    sensor.set_parameter(parameters.OutlierMaxDistanceInUm(<value>))

    # Get parameter value
    parameter_response = sensor.get_parameter(parameters.OutlierMaxDistanceInUm)

    # Use the 'value' property of the parameter_response
    print(parameter_response.value)

    # or cast the parameter_response to "int"
    print(int(parameter_response))

OutlierMaxSpeedInUmS

This parameters sets the maximum expected difference between two consecutive velocity measurements in your application. This ensures that only plausible changes in velocity are accepted.

Parameter Info

ID (dec)	ID (hex)	Unit	Readable	Writable
153	0x99	um/s	✓	✓

Usage Example

from ondosense.connect.rs485.sensor import SerialSensor
import ondosense.connect.parameters as parameters

with SerialSensor('COM1') as sensor:
    # Set parameter value
    sensor.set_parameter(parameters.OutlierMaxSpeedInUmS(<value>))

    # Get parameter value
    parameter_response = sensor.get_parameter(parameters.OutlierMaxSpeedInUmS)

    # Use the 'value' property of the parameter_response
    print(parameter_response.value)

    # or cast the parameter_response to "int"
    print(int(parameter_response))

AnalogOutputMinDistanceInMm

This parameter sets the distance at which the analog output should have its lowest output.

Parameter Info

ID (dec)	ID (hex)	Unit	Readable	Writable
176	0xb0	mm	✓	✓

Usage Example

from ondosense.connect.rs485.sensor import SerialSensor
import ondosense.connect.parameters as parameters

with SerialSensor('COM1') as sensor:
    # Set parameter value
    sensor.set_parameter(parameters.AnalogOutputMinDistanceInMm(<value>))

    # Get parameter value
    parameter_response = sensor.get_parameter(parameters.AnalogOutputMinDistanceInMm)

    # Use the 'value' property of the parameter_response
    print(parameter_response.value)

    # or cast the parameter_response to "int"
    print(int(parameter_response))

AnalogOutputMaxDistanceInMm

This parameter sets the distance at which the analog output should have its highest output.

Parameter Info

ID (dec)	ID (hex)	Unit	Readable	Writable
177	0xb1	mm	✓	✓

Usage Example

from ondosense.connect.rs485.sensor import SerialSensor
import ondosense.connect.parameters as parameters

with SerialSensor('COM1') as sensor:
    # Set parameter value
    sensor.set_parameter(parameters.AnalogOutputMaxDistanceInMm(<value>))

    # Get parameter value
    parameter_response = sensor.get_parameter(parameters.AnalogOutputMaxDistanceInMm)

    # Use the 'value' property of the parameter_response
    print(parameter_response.value)

    # or cast the parameter_response to "int"
    print(int(parameter_response))

Sw1Polarity

This parameter defines if switching output 1 should be active low or active high. 0 corresponds to active low. 1 corresponds to active high.

Parameter Info

ID (dec)	ID (hex)	Unit	Readable	Writable
208	0xd0		✓	✓

Usage Example

from ondosense.connect.rs485.sensor import SerialSensor
import ondosense.connect.parameters as parameters

with SerialSensor('COM1') as sensor:
    # Set parameter value
    sensor.set_parameter(parameters.Sw1Polarity(<value>))

    # Get parameter value
    parameter_response = sensor.get_parameter(parameters.Sw1Polarity)

    # Use the 'value' property of the parameter_response
    print(parameter_response.value)

    # or cast the parameter_response to "int"
    print(int(parameter_response))

Sw2Polarity

This parameter defines if switching output 2 should be active low or active high. 0 corresponds to active low. 1 corresponds to active high.

Parameter Info

ID (dec)	ID (hex)	Unit	Readable	Writable
209	0xd1		✓	✓

Usage Example

from ondosense.connect.rs485.sensor import SerialSensor
import ondosense.connect.parameters as parameters

with SerialSensor('COM1') as sensor:
    # Set parameter value
    sensor.set_parameter(parameters.Sw2Polarity(<value>))

    # Get parameter value
    parameter_response = sensor.get_parameter(parameters.Sw2Polarity)

    # Use the 'value' property of the parameter_response
    print(parameter_response.value)

    # or cast the parameter_response to "int"
    print(int(parameter_response))

Sw3Polarity

This parameter defines if switching output 3 should be active low or active high. 0 corresponds to active low. 1 corresponds to active high.

Parameter Info

ID (dec)	ID (hex)	Unit	Readable	Writable
210	0xd2		✓	✓

Usage Example

from ondosense.connect.rs485.sensor import SerialSensor
import ondosense.connect.parameters as parameters

with SerialSensor('COM1') as sensor:
    # Set parameter value
    sensor.set_parameter(parameters.Sw3Polarity(<value>))

    # Get parameter value
    parameter_response = sensor.get_parameter(parameters.Sw3Polarity)

    # Use the 'value' property of the parameter_response
    print(parameter_response.value)

    # or cast the parameter_response to "int"
    print(int(parameter_response))

Sw4Polarity

This parameter defines if switching output 4 should be active low or active high. 0 corresponds to active low. 1 corresponds to active high.

Parameter Info

ID (dec)	ID (hex)	Unit	Readable	Writable
211	0xd3		✓	✓

Usage Example

from ondosense.connect.rs485.sensor import SerialSensor
import ondosense.connect.parameters as parameters

with SerialSensor('COM1') as sensor:
    # Set parameter value
    sensor.set_parameter(parameters.Sw4Polarity(<value>))

    # Get parameter value
    parameter_response = sensor.get_parameter(parameters.Sw4Polarity)

    # Use the 'value' property of the parameter_response
    print(parameter_response.value)

    # or cast the parameter_response to "int"
    print(int(parameter_response))

Sw1ValueActivateInUm

This parameter sets the activation distance of switching output 1.

Parameter Info

ID (dec)	ID (hex)	Unit	Readable	Writable
212	0xd4	um	✓	✓

Usage Example

from ondosense.connect.rs485.sensor import SerialSensor
import ondosense.connect.parameters as parameters

with SerialSensor('COM1') as sensor:
    # Set parameter value
    sensor.set_parameter(parameters.Sw1ValueActivateInUm(<value>))

    # Get parameter value
    parameter_response = sensor.get_parameter(parameters.Sw1ValueActivateInUm)

    # Use the 'value' property of the parameter_response
    print(parameter_response.value)

    # or cast the parameter_response to "int"
    print(int(parameter_response))

Sw2ValueActivateInUm

This parameter sets the activation distance of switching output 2.

Parameter Info

ID (dec)	ID (hex)	Unit	Readable	Writable
213	0xd5	um	✓	✓

Usage Example

from ondosense.connect.rs485.sensor import SerialSensor
import ondosense.connect.parameters as parameters

with SerialSensor('COM1') as sensor:
    # Set parameter value
    sensor.set_parameter(parameters.Sw2ValueActivateInUm(<value>))

    # Get parameter value
    parameter_response = sensor.get_parameter(parameters.Sw2ValueActivateInUm)

    # Use the 'value' property of the parameter_response
    print(parameter_response.value)

    # or cast the parameter_response to "int"
    print(int(parameter_response))

Sw3ValueActivateInUm

This parameter sets the activation distance of switching output 3.

Parameter Info

ID (dec)	ID (hex)	Unit	Readable	Writable
214	0xd6	um	✓	✓

Usage Example

from ondosense.connect.rs485.sensor import SerialSensor
import ondosense.connect.parameters as parameters

with SerialSensor('COM1') as sensor:
    # Set parameter value
    sensor.set_parameter(parameters.Sw3ValueActivateInUm(<value>))

    # Get parameter value
    parameter_response = sensor.get_parameter(parameters.Sw3ValueActivateInUm)

    # Use the 'value' property of the parameter_response
    print(parameter_response.value)

    # or cast the parameter_response to "int"
    print(int(parameter_response))

Sw4ValueActivateInUm

This parameter sets the activation distance of switching output 4.

Parameter Info

ID (dec)	ID (hex)	Unit	Readable	Writable
215	0xd7	um	✓	✓

Usage Example

from ondosense.connect.rs485.sensor import SerialSensor
import ondosense.connect.parameters as parameters

with SerialSensor('COM1') as sensor:
    # Set parameter value
    sensor.set_parameter(parameters.Sw4ValueActivateInUm(<value>))

    # Get parameter value
    parameter_response = sensor.get_parameter(parameters.Sw4ValueActivateInUm)

    # Use the 'value' property of the parameter_response
    print(parameter_response.value)

    # or cast the parameter_response to "int"
    print(int(parameter_response))

Sw1ValueDeactivateInUm

This parameter sets the deactivation distance of switching output 1.

Parameter Info

ID (dec)	ID (hex)	Unit	Readable	Writable
216	0xd8	um	✓	✓

Usage Example

from ondosense.connect.rs485.sensor import SerialSensor
import ondosense.connect.parameters as parameters

with SerialSensor('COM1') as sensor:
    # Set parameter value
    sensor.set_parameter(parameters.Sw1ValueDeactivateInUm(<value>))

    # Get parameter value
    parameter_response = sensor.get_parameter(parameters.Sw1ValueDeactivateInUm)

    # Use the 'value' property of the parameter_response
    print(parameter_response.value)

    # or cast the parameter_response to "int"
    print(int(parameter_response))

Sw2ValueDeactivateInUm

This parameter sets the deactivation distance of switching output 2.

Parameter Info

ID (dec)	ID (hex)	Unit	Readable	Writable
217	0xd9	um	✓	✓

Usage Example

from ondosense.connect.rs485.sensor import SerialSensor
import ondosense.connect.parameters as parameters

with SerialSensor('COM1') as sensor:
    # Set parameter value
    sensor.set_parameter(parameters.Sw2ValueDeactivateInUm(<value>))

    # Get parameter value
    parameter_response = sensor.get_parameter(parameters.Sw2ValueDeactivateInUm)

    # Use the 'value' property of the parameter_response
    print(parameter_response.value)

    # or cast the parameter_response to "int"
    print(int(parameter_response))

Sw3ValueDeactivateInUm

This parameter sets the deactivation distance of switching output 3.

Parameter Info

ID (dec)	ID (hex)	Unit	Readable	Writable
218	0xda	um	✓	✓

Usage Example

from ondosense.connect.rs485.sensor import SerialSensor
import ondosense.connect.parameters as parameters

with SerialSensor('COM1') as sensor:
    # Set parameter value
    sensor.set_parameter(parameters.Sw3ValueDeactivateInUm(<value>))

    # Get parameter value
    parameter_response = sensor.get_parameter(parameters.Sw3ValueDeactivateInUm)

    # Use the 'value' property of the parameter_response
    print(parameter_response.value)

    # or cast the parameter_response to "int"
    print(int(parameter_response))

Sw4ValueDeactivateInUm

This parameter sets the deactivation distance of switching output 4.

Parameter Info

ID (dec)	ID (hex)	Unit	Readable	Writable
219	0xdb	um	✓	✓

Usage Example

from ondosense.connect.rs485.sensor import SerialSensor
import ondosense.connect.parameters as parameters

with SerialSensor('COM1') as sensor:
    # Set parameter value
    sensor.set_parameter(parameters.Sw4ValueDeactivateInUm(<value>))

    # Get parameter value
    parameter_response = sensor.get_parameter(parameters.Sw4ValueDeactivateInUm)

    # Use the 'value' property of the parameter_response
    print(parameter_response.value)

    # or cast the parameter_response to "int"
    print(int(parameter_response))

Sw1HysteresisWidthInUm

This parameter sets the hysteresis for switching output 1.

Parameter Info

ID (dec)	ID (hex)	Unit	Readable	Writable
220	0xdc	um	✓	✓

Usage Example

from ondosense.connect.rs485.sensor import SerialSensor
import ondosense.connect.parameters as parameters

with SerialSensor('COM1') as sensor:
    # Set parameter value
    sensor.set_parameter(parameters.Sw1HysteresisWidthInUm(<value>))

    # Get parameter value
    parameter_response = sensor.get_parameter(parameters.Sw1HysteresisWidthInUm)

    # Use the 'value' property of the parameter_response
    print(parameter_response.value)

    # or cast the parameter_response to "int"
    print(int(parameter_response))

Sw2HysteresisWidthInUm

This parameter sets the hysteresis for switching output 2.

Parameter Info

ID (dec)	ID (hex)	Unit	Readable	Writable
228	0xe4	um	✓	✓

Usage Example

from ondosense.connect.rs485.sensor import SerialSensor
import ondosense.connect.parameters as parameters

with SerialSensor('COM1') as sensor:
    # Set parameter value
    sensor.set_parameter(parameters.Sw2HysteresisWidthInUm(<value>))

    # Get parameter value
    parameter_response = sensor.get_parameter(parameters.Sw2HysteresisWidthInUm)

    # Use the 'value' property of the parameter_response
    print(parameter_response.value)

    # or cast the parameter_response to "int"
    print(int(parameter_response))

Sw3HysteresisWidthInUm

This parameter sets the hysteresis for switching output 3.

Parameter Info

ID (dec)	ID (hex)	Unit	Readable	Writable
229	0xe5	um	✓	✓

Usage Example

from ondosense.connect.rs485.sensor import SerialSensor
import ondosense.connect.parameters as parameters

with SerialSensor('COM1') as sensor:
    # Set parameter value
    sensor.set_parameter(parameters.Sw3HysteresisWidthInUm(<value>))

    # Get parameter value
    parameter_response = sensor.get_parameter(parameters.Sw3HysteresisWidthInUm)

    # Use the 'value' property of the parameter_response
    print(parameter_response.value)

    # or cast the parameter_response to "int"
    print(int(parameter_response))

Sw4HysteresisWidthInUm

This parameter sets the hysteresis for switching output 4.

Parameter Info

ID (dec)	ID (hex)	Unit	Readable	Writable
230	0xe6	um	✓	✓

Usage Example

from ondosense.connect.rs485.sensor import SerialSensor
import ondosense.connect.parameters as parameters

with SerialSensor('COM1') as sensor:
    # Set parameter value
    sensor.set_parameter(parameters.Sw4HysteresisWidthInUm(<value>))

    # Get parameter value
    parameter_response = sensor.get_parameter(parameters.Sw4HysteresisWidthInUm)

    # Use the 'value' property of the parameter_response
    print(parameter_response.value)

    # or cast the parameter_response to "int"
    print(int(parameter_response))

Sw1ResponseDelayTimeInUs

This parameter sets the delay between internal state change to active and the actual state change of switching output 1 to active. This can avoid unintended output state changes.

Parameter Info

ID (dec)	ID (hex)	Unit	Readable	Writable
221	0xdd	us	✓	✓

Usage Example

from ondosense.connect.rs485.sensor import SerialSensor
import ondosense.connect.parameters as parameters

with SerialSensor('COM1') as sensor:
    # Set parameter value
    sensor.set_parameter(parameters.Sw1ResponseDelayTimeInUs(<value>))

    # Get parameter value
    parameter_response = sensor.get_parameter(parameters.Sw1ResponseDelayTimeInUs)

    # Use the 'value' property of the parameter_response
    print(parameter_response.value)

    # or cast the parameter_response to "int"
    print(int(parameter_response))

Sw2ResponseDelayTimeInUs

This parameter sets the delay between internal state change to active and the actual state change of switching output 2 to active. This can avoid unintended output state changes.

Parameter Info

ID (dec)	ID (hex)	Unit	Readable	Writable
231	0xe7	us	✓	✓

Usage Example

from ondosense.connect.rs485.sensor import SerialSensor
import ondosense.connect.parameters as parameters

with SerialSensor('COM1') as sensor:
    # Set parameter value
    sensor.set_parameter(parameters.Sw2ResponseDelayTimeInUs(<value>))

    # Get parameter value
    parameter_response = sensor.get_parameter(parameters.Sw2ResponseDelayTimeInUs)

    # Use the 'value' property of the parameter_response
    print(parameter_response.value)

    # or cast the parameter_response to "int"
    print(int(parameter_response))

Sw3ResponseDelayTimeInUs

This parameter sets the delay between internal state change to active and the actual state change of switching output 3 to active. This can avoid unintended output state changes.

Parameter Info

ID (dec)	ID (hex)	Unit	Readable	Writable
232	0xe8	us	✓	✓

Usage Example

from ondosense.connect.rs485.sensor import SerialSensor
import ondosense.connect.parameters as parameters

with SerialSensor('COM1') as sensor:
    # Set parameter value
    sensor.set_parameter(parameters.Sw3ResponseDelayTimeInUs(<value>))

    # Get parameter value
    parameter_response = sensor.get_parameter(parameters.Sw3ResponseDelayTimeInUs)

    # Use the 'value' property of the parameter_response
    print(parameter_response.value)

    # or cast the parameter_response to "int"
    print(int(parameter_response))

Sw4ResponseDelayTimeInUs

This parameter sets the delay between internal state change to active and the actual state change of switching output 4 to active. This can avoid unintended output state changes.

Parameter Info

ID (dec)	ID (hex)	Unit	Readable	Writable
233	0xe9	us	✓	✓

Usage Example

from ondosense.connect.rs485.sensor import SerialSensor
import ondosense.connect.parameters as parameters

with SerialSensor('COM1') as sensor:
    # Set parameter value
    sensor.set_parameter(parameters.Sw4ResponseDelayTimeInUs(<value>))

    # Get parameter value
    parameter_response = sensor.get_parameter(parameters.Sw4ResponseDelayTimeInUs)

    # Use the 'value' property of the parameter_response
    print(parameter_response.value)

    # or cast the parameter_response to "int"
    print(int(parameter_response))

Sw1ResponseReleaseTimeInUs

This parameter sets the delay between internal state change to inactive and the actual state change of switching output 1 to inactive. This can avoid unintended output state changes.

Parameter Info

ID (dec)	ID (hex)	Unit	Readable	Writable
222	0xde	us	✓	✓

Usage Example

from ondosense.connect.rs485.sensor import SerialSensor
import ondosense.connect.parameters as parameters

with SerialSensor('COM1') as sensor:
    # Set parameter value
    sensor.set_parameter(parameters.Sw1ResponseReleaseTimeInUs(<value>))

    # Get parameter value
    parameter_response = sensor.get_parameter(parameters.Sw1ResponseReleaseTimeInUs)

    # Use the 'value' property of the parameter_response
    print(parameter_response.value)

    # or cast the parameter_response to "int"
    print(int(parameter_response))

Sw2ResponseReleaseTimeInUs

This parameter sets the delay between internal state change to inactive and the actual state change of switching output 2 to inactive. This can avoid unintended output state changes.

Parameter Info

ID (dec)	ID (hex)	Unit	Readable	Writable
234	0xea	us	✓	✓

Usage Example

from ondosense.connect.rs485.sensor import SerialSensor
import ondosense.connect.parameters as parameters

with SerialSensor('COM1') as sensor:
    # Set parameter value
    sensor.set_parameter(parameters.Sw2ResponseReleaseTimeInUs(<value>))

    # Get parameter value
    parameter_response = sensor.get_parameter(parameters.Sw2ResponseReleaseTimeInUs)

    # Use the 'value' property of the parameter_response
    print(parameter_response.value)

    # or cast the parameter_response to "int"
    print(int(parameter_response))

Sw3ResponseReleaseTimeInUs

This parameter sets the delay between internal state change to inactive and the actual state change of switching output 3 to inactive. This can avoid unintended output state changes.

Parameter Info

ID (dec)	ID (hex)	Unit	Readable	Writable
235	0xeb	us	✓	✓

Usage Example

from ondosense.connect.rs485.sensor import SerialSensor
import ondosense.connect.parameters as parameters

with SerialSensor('COM1') as sensor:
    # Set parameter value
    sensor.set_parameter(parameters.Sw3ResponseReleaseTimeInUs(<value>))

    # Get parameter value
    parameter_response = sensor.get_parameter(parameters.Sw3ResponseReleaseTimeInUs)

    # Use the 'value' property of the parameter_response
    print(parameter_response.value)

    # or cast the parameter_response to "int"
    print(int(parameter_response))

Sw4ResponseReleaseTimeInUs

This parameter sets the delay between internal state change to inactive and the actual state change of switching output 4 to inactive. This can avoid unintended output state changes.

Parameter Info

ID (dec)	ID (hex)	Unit	Readable	Writable
236	0xec	us	✓	✓

Usage Example

from ondosense.connect.rs485.sensor import SerialSensor
import ondosense.connect.parameters as parameters

with SerialSensor('COM1') as sensor:
    # Set parameter value
    sensor.set_parameter(parameters.Sw4ResponseReleaseTimeInUs(<value>))

    # Get parameter value
    parameter_response = sensor.get_parameter(parameters.Sw4ResponseReleaseTimeInUs)

    # Use the 'value' property of the parameter_response
    print(parameter_response.value)

    # or cast the parameter_response to "int"
    print(int(parameter_response))

Sw1SelectionIo

This parameter controls if the switching output 1 should be enabled (0) or disabled (1).

Parameter Info

ID (dec)	ID (hex)	Unit	Readable	Writable
223	0xdf		✓	✓

Usage Example

from ondosense.connect.rs485.sensor import SerialSensor
import ondosense.connect.parameters as parameters

with SerialSensor('COM1') as sensor:
    # Set parameter value
    sensor.set_parameter(parameters.Sw1SelectionIo(<value>))

    # Get parameter value
    parameter_response = sensor.get_parameter(parameters.Sw1SelectionIo)

    # Use the 'value' property of the parameter_response
    print(parameter_response.value)

    # or cast the parameter_response to "int"
    print(int(parameter_response))

Sw2SelectionIo

This parameter controls if the switching output 2 should be enabled (0) or disabled (1).

Parameter Info

ID (dec)	ID (hex)	Unit	Readable	Writable
224	0xe0		✓	✓

Usage Example

from ondosense.connect.rs485.sensor import SerialSensor
import ondosense.connect.parameters as parameters

with SerialSensor('COM1') as sensor:
    # Set parameter value
    sensor.set_parameter(parameters.Sw2SelectionIo(<value>))

    # Get parameter value
    parameter_response = sensor.get_parameter(parameters.Sw2SelectionIo)

    # Use the 'value' property of the parameter_response
    print(parameter_response.value)

    # or cast the parameter_response to "int"
    print(int(parameter_response))

Sw3SelectionIo

This parameter controls if the switching output 3 should be enabled (0) or disabled (1).

Parameter Info

ID (dec)	ID (hex)	Unit	Readable	Writable
225	0xe1		✓	✓

Usage Example

from ondosense.connect.rs485.sensor import SerialSensor
import ondosense.connect.parameters as parameters

with SerialSensor('COM1') as sensor:
    # Set parameter value
    sensor.set_parameter(parameters.Sw3SelectionIo(<value>))

    # Get parameter value
    parameter_response = sensor.get_parameter(parameters.Sw3SelectionIo)

    # Use the 'value' property of the parameter_response
    print(parameter_response.value)

    # or cast the parameter_response to "int"
    print(int(parameter_response))

Sw4SelectionIo

This parameter controls if the switching output 4 should be enabled (0) or disabled (1).

Parameter Info

ID (dec)	ID (hex)	Unit	Readable	Writable
226	0xe2		✓	✓

Usage Example

from ondosense.connect.rs485.sensor import SerialSensor
import ondosense.connect.parameters as parameters

with SerialSensor('COM1') as sensor:
    # Set parameter value
    sensor.set_parameter(parameters.Sw4SelectionIo(<value>))

    # Get parameter value
    parameter_response = sensor.get_parameter(parameters.Sw4SelectionIo)

    # Use the 'value' property of the parameter_response
    print(parameter_response.value)

    # or cast the parameter_response to "int"
    print(int(parameter_response))

Sw1ErrorMode

This parameter defines the behavior of the switching output 1 when a target lost event occurs.

Parameter Info

ID (dec)	ID (hex)	Unit	Readable	Writable
238	0xee		✓	✓

Usage Example

from ondosense.connect.rs485.sensor import SerialSensor
import ondosense.connect.parameters as parameters

with SerialSensor('COM1') as sensor:
    # Set parameter value
    sensor.set_parameter(parameters.Sw1ErrorMode(<value>))

    # Get parameter value
    parameter_response = sensor.get_parameter(parameters.Sw1ErrorMode)

    # Use the 'value' property of the parameter_response
    print(parameter_response.value)

    # or cast the parameter_response to "int"
    print(int(parameter_response))

Sw2ErrorMode

This parameter defines the behavior of the switching output 2 when a target lost event occurs.

Parameter Info

ID (dec)	ID (hex)	Unit	Readable	Writable
239	0xef		✓	✓

Usage Example

from ondosense.connect.rs485.sensor import SerialSensor
import ondosense.connect.parameters as parameters

with SerialSensor('COM1') as sensor:
    # Set parameter value
    sensor.set_parameter(parameters.Sw2ErrorMode(<value>))

    # Get parameter value
    parameter_response = sensor.get_parameter(parameters.Sw2ErrorMode)

    # Use the 'value' property of the parameter_response
    print(parameter_response.value)

    # or cast the parameter_response to "int"
    print(int(parameter_response))

Sw3ErrorMode

This parameter defines the behavior of the switching output 3 when a target lost event occurs.

Parameter Info

ID (dec)	ID (hex)	Unit	Readable	Writable
21	0x15		✓	✓

Usage Example

from ondosense.connect.rs485.sensor import SerialSensor
import ondosense.connect.parameters as parameters

with SerialSensor('COM1') as sensor:
    # Set parameter value
    sensor.set_parameter(parameters.Sw3ErrorMode(<value>))

    # Get parameter value
    parameter_response = sensor.get_parameter(parameters.Sw3ErrorMode)

    # Use the 'value' property of the parameter_response
    print(parameter_response.value)

    # or cast the parameter_response to "int"
    print(int(parameter_response))

Sw4ErrorMode

This parameter defines the behavior of the switching output 4 when a target lost event occurs.

Parameter Info

ID (dec)	ID (hex)	Unit	Readable	Writable
22	0x16		✓	✓

Usage Example

from ondosense.connect.rs485.sensor import SerialSensor
import ondosense.connect.parameters as parameters

with SerialSensor('COM1') as sensor:
    # Set parameter value
    sensor.set_parameter(parameters.Sw4ErrorMode(<value>))

    # Get parameter value
    parameter_response = sensor.get_parameter(parameters.Sw4ErrorMode)

    # Use the 'value' property of the parameter_response
    print(parameter_response.value)

    # or cast the parameter_response to "int"
    print(int(parameter_response))

AnalogOutputErrorMode

This parameter defines the behavior of the analog output when a target lost event occurs.

Parameter Info

ID (dec)	ID (hex)	Unit	Readable	Writable
178	0xb2		✓	✓

Usage Example

from ondosense.connect.rs485.sensor import SerialSensor
import ondosense.connect.parameters as parameters

with SerialSensor('COM1') as sensor:
    # Set parameter value
    sensor.set_parameter(parameters.AnalogOutputErrorMode(<value>))

    # Get parameter value
    parameter_response = sensor.get_parameter(parameters.AnalogOutputErrorMode)

    # Use the 'value' property of the parameter_response
    print(parameter_response.value)

    # or cast the parameter_response to "int"
    print(int(parameter_response))

ConfigSource

This parameter sets the accepted configuration source of the sensor. This is only relevant for our ProfiNet sensor variants.

Parameter Info

ID (dec)	ID (hex)	Unit	Readable	Writable
179	0xb3		✓	✓

Usage Example

from ondosense.connect.rs485.sensor import SerialSensor
import ondosense.connect.parameters as parameters

with SerialSensor('COM1') as sensor:
    # Set parameter value
    sensor.set_parameter(parameters.ConfigSource(<value>))

    # Get parameter value
    parameter_response = sensor.get_parameter(parameters.ConfigSource)

    # Use the 'value' property of the parameter_response
    print(parameter_response.value)

    # or cast the parameter_response to "int"
    print(int(parameter_response))

NumberRamps

This parameter specifies the number of ramps used in the radar profile. This parameter is configured automatically through the selected radar profile.

Parameter Info

ID (dec)	ID (hex)	Unit	Readable	Writable
181	0xb5		✓	✗

Usage Example

from ondosense.connect.rs485.sensor import SerialSensor
import ondosense.connect.parameters as parameters

with SerialSensor('COM1') as sensor:
    # Get parameter value
    parameter_response = sensor.get_parameter(parameters.NumberRamps)

    # Use the 'value' property of the parameter_response
    print(parameter_response.value)

    # or cast the parameter_response to "int"
    print(int(parameter_response))

SerializedRamp

This parameter specifies which ramp is output as IQ data and spectrum via the interface when multiple ramps are defined. If only a single ramp is used, this parameter is set to zero.

Parameter Info

ID (dec)	ID (hex)	Unit	Readable	Writable
182	0xb6		✓	✓

Usage Example

from ondosense.connect.rs485.sensor import SerialSensor
import ondosense.connect.parameters as parameters

with SerialSensor('COM1') as sensor:
    # Set parameter value
    sensor.set_parameter(parameters.SerializedRamp(<value>))

    # Get parameter value
    parameter_response = sensor.get_parameter(parameters.SerializedRamp)

    # Use the 'value' property of the parameter_response
    print(parameter_response.value)

    # or cast the parameter_response to "int"
    print(int(parameter_response))

AnalogOutputType

This parameter configures the mode (current or voltage) of the analog output mode.

Parameter Info

ID (dec)	ID (hex)	Unit	Readable	Writable
180	0xb4		✓	✓

Usage Example

from ondosense.connect.rs485.sensor import SerialSensor
import ondosense.connect.parameters as parameters

with SerialSensor('COM1') as sensor:
    # Set parameter value
    sensor.set_parameter(parameters.AnalogOutputType(<value>))

    # Get parameter value
    parameter_response = sensor.get_parameter(parameters.AnalogOutputType)

    # Use the 'value' property of the parameter_response
    print(parameter_response.value)

    # or cast the parameter_response to "int"
    print(int(parameter_response))

AoCalibrationEnable

Set to magic word AO Calibration enable to set the sensor into the analog output calibration mode

Parameter Info

ID (dec)	ID (hex)	Unit	Readable	Writable
183	0xb7		✓	✓

Usage Example

from ondosense.connect.rs485.sensor import SerialSensor
import ondosense.connect.parameters as parameters

with SerialSensor('COM1') as sensor:
    # Set parameter value
    sensor.set_parameter(parameters.AoCalibrationEnable(<value>))

    # Get parameter value
    parameter_response = sensor.get_parameter(parameters.AoCalibrationEnable)

    # Use the 'value' property of the parameter_response
    print(parameter_response.value)

    # or cast the parameter_response to "int"
    print(int(parameter_response))

SensorSerialNumber

The parameter provides the sensor serial number.

Parameter Info

ID (dec)	ID (hex)	Unit	Readable	Writable
240	0xf0		✓	✗

Usage Example

from ondosense.connect.rs485.sensor import SerialSensor
import ondosense.connect.parameters as parameters

with SerialSensor('COM1') as sensor:
    # Get parameter value
    parameter_response = sensor.get_parameter(parameters.SensorSerialNumber)

    # Use the 'value' property of the parameter_response
    print(parameter_response.value)

    # or cast the parameter_response to "int"
    print(int(parameter_response))

HasBackgroundData

This parameter is 1 if the sensor has saved background data and 0 if not.

Parameter Info

ID (dec)	ID (hex)	Unit	Readable	Writable
83	0x53		✓	✗

Usage Example

from ondosense.connect.rs485.sensor import SerialSensor
import ondosense.connect.parameters as parameters

with SerialSensor('COM1') as sensor:
    # Get parameter value
    parameter_response = sensor.get_parameter(parameters.HasBackgroundData)

    # Use the 'value' property of the parameter_response
    print(parameter_response.value)

    # or cast the parameter_response to "int"
    print(int(parameter_response))

SensorType

This parameter provides information about the sensor type / family.

Parameter Info

ID (dec)	ID (hex)	Unit	Readable	Writable
82	0x52		✓	✗

Usage Example

from ondosense.connect.rs485.sensor import SerialSensor
import ondosense.connect.parameters as parameters

with SerialSensor('COM1') as sensor:
    # Get parameter value
    parameter_response = sensor.get_parameter(parameters.SensorType)

    # Use the 'value' property of the parameter_response
    print(parameter_response.value)

    # or cast the parameter_response to "int"
    print(int(parameter_response))

ExactSensorType

This parameter provides information about the exact sensor variant.

Parameter Info

ID (dec)	ID (hex)	Unit	Readable	Writable
87	0x57		✓	✗

Usage Example

from ondosense.connect.rs485.sensor import SerialSensor
import ondosense.connect.parameters as parameters

with SerialSensor('COM1') as sensor:
    # Get parameter value
    parameter_response = sensor.get_parameter(parameters.ExactSensorType)

    # Use the 'value' property of the parameter_response
    print(parameter_response.value)

    # or cast the parameter_response to "int"
    print(int(parameter_response))

BootloaderVersion

This parameter provides the bootloader version.

Parameter Info

ID (dec)	ID (hex)	Unit	Readable	Writable
84	0x54		✓	✗

Usage Example

from ondosense.connect.rs485.sensor import SerialSensor
import ondosense.connect.parameters as parameters

with SerialSensor('COM1') as sensor:
    # Get parameter value
    parameter_response = sensor.get_parameter(parameters.BootloaderVersion)

    # Use the 'value' property of the parameter_response
    print(parameter_response.value)

    # or cast the parameter_response to "int"
    print(int(parameter_response))

SoftwareVersion

This parameter provides the firmware version.

Parameter Info

ID (dec)	ID (hex)	Unit	Readable	Writable
81	0x51		✓	✗

Usage Example

from ondosense.connect.rs485.sensor import SerialSensor
import ondosense.connect.parameters as parameters

with SerialSensor('COM1') as sensor:
    # Get parameter value
    parameter_response = sensor.get_parameter(parameters.SoftwareVersion)

    # Use the 'value' property of the parameter_response
    print(parameter_response.value)

    # or cast the parameter_response to "int"
    print(int(parameter_response))

SwitchCount

This parameter provides the number of available switching outputs of the sensor.

Parameter Info

ID (dec)	ID (hex)	Unit	Readable	Writable
201	0xc9		✓	✗

Usage Example

from ondosense.connect.rs485.sensor import SerialSensor
import ondosense.connect.parameters as parameters

with SerialSensor('COM1') as sensor:
    # Get parameter value
    parameter_response = sensor.get_parameter(parameters.SwitchCount)

    # Use the 'value' property of the parameter_response
    print(parameter_response.value)

    # or cast the parameter_response to "int"
    print(int(parameter_response))

TimeSinceStartupInS

The parameter provides the time since last startup in seconds.

Parameter Info

ID (dec)	ID (hex)	Unit	Readable	Writable
250	0xfa	s	✓	✗

Usage Example

from ondosense.connect.rs485.sensor import SerialSensor
import ondosense.connect.parameters as parameters

with SerialSensor('COM1') as sensor:
    # Get parameter value
    parameter_response = sensor.get_parameter(parameters.TimeSinceStartupInS)

    # Use the 'value' property of the parameter_response
    print(parameter_response.value)

    # or cast the parameter_response to "int"
    print(int(parameter_response))

ProductLine

The parameter provides the product line of this sensor.

Parameter Info

ID (dec)	ID (hex)	Unit	Readable	Writable
253	0xfd		✓	✗

Usage Example

from ondosense.connect.rs485.sensor import SerialSensor
import ondosense.connect.parameters as parameters

with SerialSensor('COM1') as sensor:
    # Get parameter value
    parameter_response = sensor.get_parameter(parameters.ProductLine)

    # Use the 'value' property of the parameter_response
    print(parameter_response.value)

    # or cast the parameter_response to "int"
    print(int(parameter_response))

MeasurementFrequencyInHz

This parameter provides the actual measurement rate.

Parameter Info

ID (dec)	ID (hex)	Unit	Readable	Writable
67	0x43	Hz	✓	✗

Usage Example

from ondosense.connect.rs485.sensor import SerialSensor
import ondosense.connect.parameters as parameters

with SerialSensor('COM1') as sensor:
    # Get parameter value
    parameter_response = sensor.get_parameter(parameters.MeasurementFrequencyInHz)

    # Use the 'value' property of the parameter_response
    print(parameter_response.value)

    # or cast the parameter_response to "int"
    print(int(parameter_response))