TCP/IP - Analog Out Bricklet

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

API

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

Basic Functions

BrickletAnalogOut.set_voltage
Function ID:
  • 1
Request:
  • voltage – Type: uint16, Range: [0 to 216 - 1]
Response:
  • no response

Sets the voltage in mV. The possible range is 0V to 5V (0-5000). Calling this function will set the mode to 0 (see set_mode).

The default value is 0 (with mode 1).

BrickletAnalogOut.get_voltage
Function ID:
  • 2
Request:
  • empty payload
Response:
  • voltage – Type: uint16, Range: [0 to 216 - 1]

Returns the voltage as set by set_voltage.

BrickletAnalogOut.set_mode
Function ID:
  • 3
Request:
  • mode – Type: uint8, Range: See meanings
Response:
  • no response

Sets the mode of the analog value. Possible modes:

  • 0: Normal Mode (Analog value as set by set_voltage is applied)
  • 1: 1k Ohm resistor to ground
  • 2: 100k Ohm resistor to ground
  • 3: 500k Ohm resistor to ground

Setting the mode to 0 will result in an output voltage of 0. You can jump to a higher output voltage directly by calling set_voltage.

The default mode is 1.

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

For mode:

  • 0 = Analog Value
  • 1 = 1k To Ground
  • 2 = 100k To Ground
  • 3 = 500k To Ground
BrickletAnalogOut.get_mode
Function ID:
  • 4
Request:
  • empty payload
Response:
  • mode – Type: uint8, Range: See meanings

Returns the mode as set by set_mode.

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

For mode:

  • 0 = Analog Value
  • 1 = 1k To Ground
  • 2 = 100k To Ground
  • 3 = 500k To Ground

Advanced Functions

BrickletAnalogOut.get_identity
Function ID:
  • 255
Request:
  • empty payload
Response:
  • uid – Type: char[8]
  • connected_uid – Type: char[8]
  • position – Type: char
  • hardware_version – Type: uint8[3], Range: [0 to 255]
  • firmware_version – Type: uint8[3], Range: [0 to 255]
  • device_identifier – Type: uint16, 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' or 'd'.

The device identifier numbers can be found here