LabVIEW - Distance IR Bricklet¶

Simple¶

Download (Example Simple.vi)

Callback¶

Download (Example Callback.vi), Download (Example Callback - Distance Callback.vi)

Threshold¶

Download (Example Threshold.vi), Download (Example Threshold - DistanceReached Callback.vi)

Graph¶

Download (Example Graph.vi), Download (Example Graph - Distance Callback.vi)

Basic Functions¶

BrickletDistanceIR(uid, ipcon) → distanceIR¶

Input:	uid – Type: String ipcon – Type: .NET Refnum (IPConnection)
Output:	distanceIR – Type: .NET Refnum (BrickletDistanceIR)

Creates an object with the unique device ID uid. This object can then be used after the IP Connection is connected.

BrickletDistanceIR.GetDistance() → distance¶

Output:	distance – Type: Int32, Unit: 1 mm, Range: [0 to 216 - 1]

Returns the distance measured by the sensor. Possible distance ranges are 40 to 300, 100 to 800 and 200 to 1500, depending on the selected IR sensor.

If you want to get the distance periodically, it is recommended to use the DistanceCallback callback and set the period with SetDistanceCallbackPeriod().

Advanced Functions¶

BrickletDistanceIR.GetAnalogValue() → value¶

Output:	value – Type: Int32, Range: [0 to 212 - 1]

Returns the value as read by a 12-bit analog-to-digital converter.

Note

The value returned by GetDistance() is averaged over several samples to yield less noise, while GetAnalogValue() gives back raw unfiltered analog values. The only reason to use GetAnalogValue() is, if you need the full resolution of the analog-to-digital converter.

If you want the analog value periodically, it is recommended to use the AnalogValueCallback callback and set the period with SetAnalogValueCallbackPeriod().

BrickletDistanceIR.SetSamplingPoint(position, distance)¶

Input:	position – Type: Byte, Range: [0 to 127] distance – Type: Int32, Unit: 1/10 mm, Range: [0 to 216 - 1]

Sets a sampling point value to a specific position of the lookup table. The lookup table comprises 128 equidistant analog values with corresponding distances.

If you measure a distance of 50cm at the analog value 2048, you should call this function with (64, 5000). The utilized analog-to-digital converter has a resolution of 12 bit. With 128 sampling points on the whole range, this means that every sampling point has a size of 32 analog values. Thus the analog value 2048 has the corresponding sampling point 64 = 2048/32.

Sampling points are saved on the EEPROM of the Distance IR Bricklet and loaded again on startup.

Note

An easy way to calibrate the sampling points of the Distance IR Bricklet is implemented in the Brick Viewer. If you want to calibrate your Bricklet it is highly recommended to use this implementation.

BrickletDistanceIR.GetSamplingPoint(position) → distance¶

Input:	position – Type: Byte, Range: [0 to 127]
Output:	distance – Type: Int32, Unit: 1/10 mm, Range: [0 to 216 - 1]

Returns the distance to a sampling point position as set by SetSamplingPoint().

BrickletDistanceIR.GetIdentity() → uid, connectedUid, position, hardwareVersion, firmwareVersion, deviceIdentifier¶

Output:

uid – Type: String, Length: up to 8 connectedUid – Type: String, Length: up to 8 position – Type: Char, Range: ["a" to "h", "z"] hardwareVersion – Type: Byte[3] 0: major – Type: Byte, Range: [0 to 255] 1: minor – Type: Byte, Range: [0 to 255] 2: revision – Type: Byte, Range: [0 to 255] firmwareVersion – Type: Byte[3] 0: major – Type: Byte, Range: [0 to 255] 1: minor – Type: Byte, Range: [0 to 255] 2: revision – Type: Byte, Range: [0 to 255] deviceIdentifier – Type: Int32, Range: [0 to 216 - 1]

Returns the UID, the UID where the Bricklet is connected to, the position, the hardware and firmware version as well as the device identifier.

The position can be 'a', 'b', 'c', 'd', 'e', 'f', 'g' or 'h' (Bricklet Port). A Bricklet connected to an Isolator Bricklet is always at position 'z'.

The device identifier numbers can be found here. There is also a constant for the device identifier of this Bricklet.

Callback Configuration Functions¶

BrickletDistanceIR.SetDistanceCallbackPeriod(period)¶

Input:	period – Type: Int64, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0

Sets the period with which the DistanceCallback callback is triggered periodically. A value of 0 turns the callback off.

The DistanceCallback callback is only triggered if the distance has changed since the last triggering.

BrickletDistanceIR.GetDistanceCallbackPeriod() → period¶

Output:	period – Type: Int64, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0

Returns the period as set by SetDistanceCallbackPeriod().

BrickletDistanceIR.SetAnalogValueCallbackPeriod(period)¶

Input:	period – Type: Int64, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0

Sets the period with which the AnalogValueCallback callback is triggered periodically. A value of 0 turns the callback off.

The AnalogValueCallback callback is only triggered if the analog value has changed since the last triggering.

BrickletDistanceIR.GetAnalogValueCallbackPeriod() → period¶

Output:	period – Type: Int64, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0

Returns the period as set by SetAnalogValueCallbackPeriod().

BrickletDistanceIR.SetDistanceCallbackThreshold(option, min, max)¶

Input:	option – Type: Char, Range: See constants, Default: "x" min – Type: Int32, Unit: 1 mm, Range: [0 to 216 - 1], Default: 0 max – Type: Int32, Unit: 1 mm, Range: [0 to 216 - 1], Default: 0

Sets the thresholds for the DistanceReachedCallback callback.

The following options are possible:

Option	Description
'x'	Callback is turned off
'o'	Callback is triggered when the distance is outside the min and max values
'i'	Callback is triggered when the distance is inside the min and max values
'<'	Callback is triggered when the distance is smaller than the min value (max is ignored)
'>'	Callback is triggered when the distance is greater than the min value (max is ignored)

The following constants are available for this function:

For option:

• BrickletDistanceIR.THRESHOLD_OPTION_OFF = "x"
• BrickletDistanceIR.THRESHOLD_OPTION_OUTSIDE = "o"
• BrickletDistanceIR.THRESHOLD_OPTION_INSIDE = "i"
• BrickletDistanceIR.THRESHOLD_OPTION_SMALLER = "<"
• BrickletDistanceIR.THRESHOLD_OPTION_GREATER = ">"

BrickletDistanceIR.GetDistanceCallbackThreshold() → option, min, max¶

Output:	option – Type: Char, Range: See constants, Default: "x" min – Type: Int32, Unit: 1 mm, Range: [0 to 216 - 1], Default: 0 max – Type: Int32, Unit: 1 mm, Range: [0 to 216 - 1], Default: 0

Returns the threshold as set by SetDistanceCallbackThreshold().

The following constants are available for this function:

For option:

• BrickletDistanceIR.THRESHOLD_OPTION_OFF = "x"
• BrickletDistanceIR.THRESHOLD_OPTION_OUTSIDE = "o"
• BrickletDistanceIR.THRESHOLD_OPTION_INSIDE = "i"
• BrickletDistanceIR.THRESHOLD_OPTION_SMALLER = "<"
• BrickletDistanceIR.THRESHOLD_OPTION_GREATER = ">"

BrickletDistanceIR.SetAnalogValueCallbackThreshold(option, min, max)¶

Input:	option – Type: Char, Range: See constants, Default: "x" min – Type: Int32, Range: [0 to 216 - 1], Default: 0 max – Type: Int32, Range: [0 to 216 - 1], Default: 0

Sets the thresholds for the AnalogValueReachedCallback callback.

The following options are possible:

Option	Description
'x'	Callback is turned off
'o'	Callback is triggered when the analog value is outside the min and max values
'i'	Callback is triggered when the analog value is inside the min and max values
'<'	Callback is triggered when the analog value is smaller than the min value (max is ignored)
'>'	Callback is triggered when the analog value is greater than the min value (max is ignored)

The following constants are available for this function:

For option:

• BrickletDistanceIR.THRESHOLD_OPTION_OFF = "x"
• BrickletDistanceIR.THRESHOLD_OPTION_OUTSIDE = "o"
• BrickletDistanceIR.THRESHOLD_OPTION_INSIDE = "i"
• BrickletDistanceIR.THRESHOLD_OPTION_SMALLER = "<"
• BrickletDistanceIR.THRESHOLD_OPTION_GREATER = ">"

BrickletDistanceIR.GetAnalogValueCallbackThreshold() → option, min, max¶

Output:	option – Type: Char, Range: See constants, Default: "x" min – Type: Int32, Range: [0 to 216 - 1], Default: 0 max – Type: Int32, Range: [0 to 216 - 1], Default: 0

Returns the threshold as set by SetAnalogValueCallbackThreshold().

The following constants are available for this function:

For option:

• BrickletDistanceIR.THRESHOLD_OPTION_OFF = "x"
• BrickletDistanceIR.THRESHOLD_OPTION_OUTSIDE = "o"
• BrickletDistanceIR.THRESHOLD_OPTION_INSIDE = "i"
• BrickletDistanceIR.THRESHOLD_OPTION_SMALLER = "<"
• BrickletDistanceIR.THRESHOLD_OPTION_GREATER = ">"

BrickletDistanceIR.SetDebouncePeriod(debounce)¶

Input:	debounce – Type: Int64, Unit: 1 ms, Range: [0 to 232 - 1], Default: 100

Sets the period with which the threshold callbacks

• DistanceReachedCallback,
• AnalogValueReachedCallback

are triggered, if the thresholds

• SetDistanceCallbackThreshold(),
• SetAnalogValueCallbackThreshold()

keep being reached.

BrickletDistanceIR.GetDebouncePeriod() → debounce¶

Output:	debounce – Type: Int64, Unit: 1 ms, Range: [0 to 232 - 1], Default: 100

Returns the debounce period as set by SetDebouncePeriod().

Callbacks¶

Callbacks can be registered to receive time critical or recurring data from the device. The registration is done by assigning a function to a callback property of the device object. The available callback property and their type of parameters are described below.

event BrickletDistanceIR.DistanceCallback → sender, distance¶

Callback Output:	sender – Type: .NET Refnum (BrickletDistanceIR) distance – Type: Int32, Unit: 1 mm, Range: [0 to 216 - 1]

This callback is triggered periodically with the period that is set by SetDistanceCallbackPeriod(). The parameter is the distance of the sensor.

The DistanceCallback callback is only triggered if the distance has changed since the last triggering.

event BrickletDistanceIR.AnalogValueCallback → sender, value¶

Callback Output:	sender – Type: .NET Refnum (BrickletDistanceIR) value – Type: Int32, Range: [0 to 212 - 1]

This callback is triggered periodically with the period that is set by SetAnalogValueCallbackPeriod(). The parameter is the analog value of the sensor.

The AnalogValueCallback callback is only triggered if the analog value has changed since the last triggering.

event BrickletDistanceIR.DistanceReachedCallback → sender, distance¶

Callback Output:	sender – Type: .NET Refnum (BrickletDistanceIR) distance – Type: Int32, Unit: 1 mm, Range: [0 to 216 - 1]

This callback is triggered when the threshold as set by SetDistanceCallbackThreshold() is reached. The parameter is the distance of the sensor.

If the threshold keeps being reached, the callback is triggered periodically with the period as set by SetDebouncePeriod().

event BrickletDistanceIR.AnalogValueReachedCallback → sender, value¶

Callback Output:	sender – Type: .NET Refnum (BrickletDistanceIR) value – Type: Int32, Range: [0 to 212 - 1]

This callback is triggered when the threshold as set by SetAnalogValueCallbackThreshold() is reached. The parameter is the analog value of the sensor.

If the threshold keeps being reached, the callback is triggered periodically with the period as set by SetDebouncePeriod().

Virtual Functions¶

Virtual functions don't communicate with the device itself, but operate only on the API bindings device object. They can be called without the corresponding IP Connection object being connected.

BrickletDistanceIR.GetAPIVersion() → apiVersion¶

Output:	apiVersion – Type: Byte[3] 0: major – Type: Byte, Range: [0 to 255] 1: minor – Type: Byte, Range: [0 to 255] 2: revision – Type: Byte, Range: [0 to 255]

Returns the version of the API definition implemented by this API bindings. This is neither the release version of this API bindings nor does it tell you anything about the represented Brick or Bricklet.

BrickletDistanceIR.GetResponseExpected(functionId) → responseExpected¶

Input:	functionId – Type: Byte, Range: See constants
Output:	responseExpected – Type: Boolean

Returns the response expected flag for the function specified by the function ID parameter. It is true if the function is expected to send a response, false otherwise.

For getter functions this is enabled by default and cannot be disabled, because those functions will always send a response. For callback configuration functions it is enabled by default too, but can be disabled by SetResponseExpected(). For setter functions it is disabled by default and can be enabled.

Enabling the response expected flag for a setter function allows to detect timeouts and other error conditions calls of this setter as well. The device will then send a response for this purpose. If this flag is disabled for a setter function then no response is sent and errors are silently ignored, because they cannot be detected.

The following constants are available for this function:

For functionId:

• BrickletDistanceIR.FUNCTION_SET_SAMPLING_POINT = 3
• BrickletDistanceIR.FUNCTION_SET_DISTANCE_CALLBACK_PERIOD = 5
• BrickletDistanceIR.FUNCTION_SET_ANALOG_VALUE_CALLBACK_PERIOD = 7
• BrickletDistanceIR.FUNCTION_SET_DISTANCE_CALLBACK_THRESHOLD = 9
• BrickletDistanceIR.FUNCTION_SET_ANALOG_VALUE_CALLBACK_THRESHOLD = 11
• BrickletDistanceIR.FUNCTION_SET_DEBOUNCE_PERIOD = 13

BrickletDistanceIR.SetResponseExpected(functionId, responseExpected)¶

Input:	functionId – Type: Byte, Range: See constants responseExpected – Type: Boolean

Changes the response expected flag of the function specified by the function ID parameter. This flag can only be changed for setter (default value: false) and callback configuration functions (default value: true). For getter functions it is always enabled.

Enabling the response expected flag for a setter function allows to detect timeouts and other error conditions calls of this setter as well. The device will then send a response for this purpose. If this flag is disabled for a setter function then no response is sent and errors are silently ignored, because they cannot be detected.

The following constants are available for this function:

For functionId:

• BrickletDistanceIR.FUNCTION_SET_SAMPLING_POINT = 3
• BrickletDistanceIR.FUNCTION_SET_DISTANCE_CALLBACK_PERIOD = 5
• BrickletDistanceIR.FUNCTION_SET_ANALOG_VALUE_CALLBACK_PERIOD = 7
• BrickletDistanceIR.FUNCTION_SET_DISTANCE_CALLBACK_THRESHOLD = 9
• BrickletDistanceIR.FUNCTION_SET_ANALOG_VALUE_CALLBACK_THRESHOLD = 11
• BrickletDistanceIR.FUNCTION_SET_DEBOUNCE_PERIOD = 13

BrickletDistanceIR.SetResponseExpectedAll(responseExpected)¶

Input:	responseExpected – Type: Boolean

Changes the response expected flag for all setter and callback configuration functions of this device at once.

Constants¶

BrickletDistanceIR.DEVICE_IDENTIFIER¶

This constant is used to identify a Distance IR Bricklet.

The GetIdentity() function and the IPConnection.EnumerateCallback callback of the IP Connection have a deviceIdentifier parameter to specify the Brick's or Bricklet's type.

BrickletDistanceIR.DEVICE_DISPLAY_NAME¶

This constant represents the human readable name of a Distance IR Bricklet.