TCP/IP - Analog Out Bricklet

This is the API description for the TCP/IP protocol of the Analog Out Bricklet. General information on what this device does and the technical specifications can be found here.

A tutorial on how to test the Analog Out Bricklet and get the first examples running can be found here.

API

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

Basic Functions

AnalogOut.set_voltage

Function ID:

1

Request:

• voltage – uint16

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).

AnalogOut.get_voltage

Function ID:

2

Request:

empty payload

Response:

• voltage – uint16

Returns the voltage as set by set_voltage.

AnalogOut.set_mode

Function ID:

3

Request:

• mode – uint8

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.

AnalogOut.get_mode

Function ID:

4

Request:

empty payload

Response:

• mode – uint8

Returns the mode as set by set_mode.

Advanced Functions

AnalogOut.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 identifiers can be found here.

New in version 2.0.0 (Plugin).

Constants

AnalogOut.DEVICE_IDENTIFIER

Value:220

This constant is used to identify a AnalogOut Bricklet.

The get_identity function and the CALLBACK_ENUMERATE callback of the IP Connection have a device_identifier parameter to specify the Brick’s or Bricklet’s type.