Modbus - RGB LED Bricklet¶

This is the description of the Modbus protocol for the RGB LED Bricklet. General information and technical specifications for the RGB LED Bricklet are summarized in its hardware description.

API¶

A general description of the Modbus protocol structure can be found here.

BrickletRGBLED.set_rgb_value¶

Function ID:	1
Request:	r – Type: uint8, Range: [0 to 255], Default: 0 g – Type: uint8, Range: [0 to 255], Default: 0 b – Type: uint8, Range: [0 to 255], Default: 0
Response:	no response

Sets the r, g and b values for the LED.

BrickletRGBLED.get_rgb_value¶

Function ID:	2
Request:	empty payload
Response:	r – Type: uint8, Range: [0 to 255], Default: 0 g – Type: uint8, Range: [0 to 255], Default: 0 b – Type: uint8, Range: [0 to 255], Default: 0

Returns the r, g and b values of the LED as set by set_rgb_value.

BrickletRGBLED.get_identity¶

Function ID:	255
Request:	empty payload
Response:	uid – Type: char[8] connected_uid – Type: char[8] position – Type: char, Range: ['a' to 'h', 'z'] hardware_version – Type: uint8[3] 0: major – Type: uint8, Range: [0 to 255] 1: minor – Type: uint8, Range: [0 to 255] 2: revision – Type: uint8, Range: [0 to 255] firmware_version – Type: uint8[3] 0: major – Type: uint8, Range: [0 to 255] 1: minor – Type: uint8, Range: [0 to 255] 2: revision – Type: uint8, Range: [0 to 255] device_identifier – Type: uint16, Range: [0 to 2¹⁶ - 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.