openHAB - Motorized Linear Poti Bricklet

This is the description of the openHAB API bindings for the Motorized Linear Poti Bricklet. General information and technical specifications for the Motorized Linear Poti Bricklet are summarized in its hardware description.

An installation guide for the openHAB API bindings is part of their general description.

Thing

UID:
  • tinkerforge:brickletmotorizedlinearpoti:[UID]
Required firmware version:
  • 2.0.0
Firmware update supported:
  • yes
Channels:
Actions:
Parameters:
  • Status LED Config – Type: Choice, Default: Show Status
  • The status LED configuration. By default the LED shows communication traffic between Brick and Bricklet, it flickers once for every 10 received data packets. You can also turn the LED permanently on/off or show a heartbeat. If the Bricklet is in bootloader mode, the LED is will show heartbeat by default.
  • Options: Off, On, Show Heartbeat, Show Status

Channels

Position

The position of the linear potentiometer. The value is between 0 (slider down) and 100 (slider up).

Type:
  • Number:Dimensionless
UID:
  • tinkerforge:brickletmotorizedlinearpoti:[UID]:BrickletMotorizedLinearPotiPosition
Read only:
  • Yes
Range:
  • 0 to 100 (Step 1)
Parameters:
  • Update Interval – Type: integer, Default: 1000, Unit: ms, Min: 0, Max: 4294967295
  • Specifies the update interval in milliseconds. A value of 0 disables automatic updates.
Motor Position

The motor position of the potentiometer. The motorized potentiometer will immediately start to approach the position. Depending on the chosen drive mode, the position will either be reached as fast as possible or in a slow but smooth motion.

The position has to be between 0 (slider down) and 100 (slider up).

Type:
  • Number:Dimensionless
UID:
  • tinkerforge:brickletmotorizedlinearpoti:[UID]:BrickletMotorizedLinearPotiMotorPosition
Read only:
  • No
Range:
  • 0 to 100 (Step 1)
Parameters:
  • Smooth Drive Mode – Type: boolean, Default: false
  • Depending on the chosen drive mode, the position will either be reached as fast as possible or in a slow but smooth motion.

  • Hold Position – Type: boolean, Default: false
  • If you enable the hold position flag, the position will automatically be retained. If a user changes the position of the potentiometer, it will automatically drive back to the original set point. If the hold position flag disabled, the potentiometer can be changed again by the user as soon as the set point was reached once.
Position Reached

This channel is triggered if a new position as set by the Motor Position Channel is reached.

Type:
  • Trigger (system.trigger)
UID:
  • tinkerforge:brickletmotorizedlinearpoti:[UID]:BrickletMotorizedLinearPotiPositionReached
Read only:
  • No

Actions

Actions can be used in rules by creating an action object. All actions return a Map<String, Object>. Returned values can be accessed by name, sometimes the type deduction needs some hints, as shown below:

val actions = getActions("tinkerforge", "tinkerforge:brickletmotorizedlinearpoti:[UID]")
val hwVersion = actions.brickletMotorizedLinearPotiGetIdentity().get("hardwareVersion") as short[]
logInfo("Example", "Hardware version: " + hwVersion.get(0) + "." + hwVersion.get(1) + "." + hwVersion.get(2))

Basic Actions

brickletMotorizedLinearPotiGetPosition()
Return Map:
  • position – Type: int, Range: [0 to 100]

Returns the position of the linear potentiometer. The value is between 0 (slider down) and 100 (slider up).

If you want to get the value periodically, it is recommended to use the Position channel. You can set the channel configuration with the configuration of Position.

brickletMotorizedLinearPotiSetMotorPosition(int position, int driveMode, boolean holdPosition)
Parameters:
  • position – Type: int, Range: [0 to 100]
  • driveMode – Type: int, Range: See constants
  • holdPosition – Type: boolean

Sets the position of the potentiometer. The motorized potentiometer will immediately start to approach the position. Depending on the chosen drive mode, the position will either be reached as fast as possible or in a slow but smooth motion.

The position has to be between 0 (slider down) and 100 (slider up).

If you set the hold position parameter to true, the position will automatically be retained. If a user changes the position of the potentiometer, it will automatically drive back to the original set point.

If the hold position parameter is set to false, the potentiometer can be changed again by the user as soon as the set point was reached once.

The following constants are available for this function:

For driveMode:

  • val DRIVE_MODE_FAST = 0
  • val DRIVE_MODE_SMOOTH = 1
brickletMotorizedLinearPotiGetMotorPosition()
Return Map:
  • position – Type: int, Range: [0 to 100]
  • driveMode – Type: int, Range: See constants
  • holdPosition – Type: boolean
  • positionReached – Type: boolean

Returns the last motor position as set by Motor Position. This is not the current position (use Position to get the current position). This is the last used set point and configuration.

The position reached parameter is true if the position has been reached at one point. The position may have been changed again in the meantime by the user.

The following constants are available for this function:

For driveMode:

  • val DRIVE_MODE_FAST = 0
  • val DRIVE_MODE_SMOOTH = 1

Advanced Actions

brickletMotorizedLinearPotiGetChipTemperature()
Return Map:
  • temperature – Type: int, Unit: 1 °C, Range: [-215 to 215 - 1]

Returns the temperature as measured inside the microcontroller. The value returned is not the ambient temperature!

The temperature is only proportional to the real temperature and it has bad accuracy. Practically it is only useful as an indicator for temperature changes.

brickletMotorizedLinearPotiGetStatusLEDConfig()
Return Map:
  • config – Type: int, Range: See constants, Default: 3

Returns the configuration as set by the thing configuration

The following constants are available for this function:

For config:

  • val STATUS_LED_CONFIG_OFF = 0
  • val STATUS_LED_CONFIG_ON = 1
  • val STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
  • val STATUS_LED_CONFIG_SHOW_STATUS = 3
brickletMotorizedLinearPotiGetSPITFPErrorCount()
Return Map:
  • errorCountAckChecksum – Type: long, Range: [0 to 232 - 1]
  • errorCountMessageChecksum – Type: long, Range: [0 to 232 - 1]
  • errorCountFrame – Type: long, Range: [0 to 232 - 1]
  • errorCountOverflow – Type: long, Range: [0 to 232 - 1]

Returns the error count for the communication between Brick and Bricklet.

The errors are divided into

  • ACK checksum errors,
  • message checksum errors,
  • framing errors and
  • overflow errors.

The errors counts are for errors that occur on the Bricklet side. All Bricks have a similar function that returns the errors on the Brick side.

brickletMotorizedLinearPotiGetIdentity()
Return Map:
  • uid – Type: String, Length: up to 8
  • connectedUid – Type: String, Length: up to 8
  • position – Type: char, Range: ['a' to 'h', 'z']
  • hardwareVersion – Type: short[], Length: 3
    • 0: major – Type: short, Range: [0 to 255]
    • 1: minor – Type: short, Range: [0 to 255]
    • 2: revision – Type: short, Range: [0 to 255]
  • firmwareVersion – Type: short[], Length: 3
    • 0: major – Type: short, Range: [0 to 255]
    • 1: minor – Type: short, Range: [0 to 255]
    • 2: revision – Type: short, Range: [0 to 255]
  • deviceIdentifier – Type: int, 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 as position 'z'.

The device identifier numbers can be found here

Internal Actions

brickletMotorizedLinearPotiReadUID()
Return Map:
  • uid – Type: long, Range: [0 to 232 - 1]

Returns the current UID as an integer. Encode as Base58 to get the usual string version.