TCP/IP - Rotary Poti Bricklet

This is the description of the TCP/IP protocol for the Rotary Poti Bricklet. General information and technical specifications for the Rotary Poti Bricklet are summarized in its hardware description.

API

A general description of the TCP/IP protocol structure can be found here.

Basic Functions

BrickletRotaryPoti.get_position
Function ID:

1

Request:

empty payload

Response:
  • position -- int16

Returns the position of the rotary potentiometer. The value is in degree and between -150° (turned left) and 150° (turned right).

If you want to get the position periodically, it is recommended to use the CALLBACK_POSITION callback and set the period with set_position_callback_period.

Advanced Functions

BrickletRotaryPoti.get_analog_value
Function ID:

2

Request:

empty payload

Response:
  • value -- uint16

Returns the value as read by a 12-bit analog-to-digital converter. The value is between 0 and 4095.

Note

The value returned by get_position is averaged over several samples to yield less noise, while get_analog_value gives back raw unfiltered analog values. The only reason to use get_analog_value 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 CALLBACK_ANALOG_VALUE callback and set the period with set_analog_value_callback_period.

BrickletRotaryPoti.get_identity
Function ID:

255

Request:

empty payload

Response:
  • uid -- char[8]
  • connected_uid -- char[8]
  • position -- char
  • hardware_version -- uint8[3]
  • firmware_version -- uint8[3]
  • device_identifier -- uint16

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' or 'd'.

The device identifier numbers can be found here

Callback Configuration Functions

BrickletRotaryPoti.set_position_callback_period
Function ID:

3

Request:
  • period -- uint32
Response:

no response

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

The CALLBACK_POSITION callback is only triggered if the position has changed since the last triggering.

The default value is 0.

BrickletRotaryPoti.get_position_callback_period
Function ID:

4

Request:

empty payload

Response:
  • period -- uint32

Returns the period as set by set_position_callback_period.

BrickletRotaryPoti.set_analog_value_callback_period
Function ID:

5

Request:
  • period -- uint32
Response:

no response

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

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

The default value is 0.

BrickletRotaryPoti.get_analog_value_callback_period
Function ID:

6

Request:

empty payload

Response:
  • period -- uint32

Returns the period as set by set_analog_value_callback_period.

BrickletRotaryPoti.set_position_callback_threshold
Function ID:

7

Request:
  • option -- char
  • min -- int16
  • max -- int16
Response:

no response

Sets the thresholds for the CALLBACK_POSITION_REACHED callback.

The following options are possible:

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

The default value is ('x', 0, 0).

The following meanings are defined for the parameters of this function:

  • x: off, for option
  • o: outside, for option
  • i: inside, for option
  • <: smaller, for option
  • >: greater, for option
BrickletRotaryPoti.get_position_callback_threshold
Function ID:

8

Request:

empty payload

Response:
  • option -- char
  • min -- int16
  • max -- int16

Returns the threshold as set by set_position_callback_threshold.

The following meanings are defined for the parameters of this function:

  • x: off, for option
  • o: outside, for option
  • i: inside, for option
  • <: smaller, for option
  • >: greater, for option
BrickletRotaryPoti.set_analog_value_callback_threshold
Function ID:

9

Request:
  • option -- char
  • min -- uint16
  • max -- uint16
Response:

no response

Sets the thresholds for the CALLBACK_ANALOG_VALUE_REACHED 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 default value is ('x', 0, 0).

The following meanings are defined for the parameters of this function:

  • x: off, for option
  • o: outside, for option
  • i: inside, for option
  • <: smaller, for option
  • >: greater, for option
BrickletRotaryPoti.get_analog_value_callback_threshold
Function ID:

10

Request:

empty payload

Response:
  • option -- char
  • min -- uint16
  • max -- uint16

Returns the threshold as set by set_analog_value_callback_threshold.

The following meanings are defined for the parameters of this function:

  • x: off, for option
  • o: outside, for option
  • i: inside, for option
  • <: smaller, for option
  • >: greater, for option
BrickletRotaryPoti.set_debounce_period
Function ID:

11

Request:
  • debounce -- uint32
Response:

no response

Sets the period in ms with which the threshold callbacks

are triggered, if the thresholds

keep being reached.

The default value is 100.

BrickletRotaryPoti.get_debounce_period
Function ID:

12

Request:

empty payload

Response:
  • debounce -- uint32

Returns the debounce period as set by set_debounce_period.

Callbacks

BrickletRotaryPoti.CALLBACK_POSITION
Function ID:

13

Response:
  • position -- int16

This callback is triggered periodically with the period that is set by set_position_callback_period. The response value is the position of the rotary potentiometer.

The CALLBACK_POSITION callback is only triggered if the position has changed since the last triggering.

BrickletRotaryPoti.CALLBACK_ANALOG_VALUE
Function ID:

14

Response:
  • value -- uint16

This callback is triggered periodically with the period that is set by set_analog_value_callback_period. The response value is the analog value of the rotary potentiometer.

The CALLBACK_ANALOG_VALUE callback is only triggered if the position has changed since the last triggering.

BrickletRotaryPoti.CALLBACK_POSITION_REACHED
Function ID:

15

Response:
  • position -- int16

This callback is triggered when the threshold as set by set_position_callback_threshold is reached. The response value is the position of the rotary potentiometer.

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

BrickletRotaryPoti.CALLBACK_ANALOG_VALUE_REACHED
Function ID:

16

Response:
  • value -- uint16

This callback is triggered when the threshold as set by set_analog_value_callback_threshold is reached. The response value is the analog value of the rotary potentiometer.

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