Shell - RGB LED Button Bricklet¶

Simple Button¶

Download (example-simple-button.sh)

1#!/bin/sh
2# Connects to localhost:4223 by default, use --host and --port to change this
3
4uid=XYZ # Change XYZ to the UID of your RGB LED Button Bricklet
5
6# Get current button state
7tinkerforge call rgb-led-button-bricklet $uid get-button-state

Simple Color¶

Download (example-simple-color.sh)

1#!/bin/sh
2# Connects to localhost:4223 by default, use --host and --port to change this
3
4uid=XYZ # Change XYZ to the UID of your RGB LED Button Bricklet
5
6# Set light blue color
7tinkerforge call rgb-led-button-bricklet $uid set-color 0 170 234

Callback¶

Download (example-callback.sh)

 1#!/bin/sh
 2# Connects to localhost:4223 by default, use --host and --port to change this
 3
 4uid=XYZ # Change XYZ to the UID of your RGB LED Button Bricklet
 5
 6# Handle incoming button state changed callbacks
 7tinkerforge dispatch rgb-led-button-bricklet $uid button-state-changed &
 8
 9echo "Press key to exit"; read dummy
10
11kill -- -$$ # Stop callback dispatch in background

Command Structure¶

The common options of the call and dispatch commands are documented here. The specific command structure is shown below.

tinkerforge call rgb-led-button-bricklet [<option>..] <uid> <function> [<argument>..]¶

Parameters:	<uid> – Type: String <function> – Type: String

The call command is used to call a function of the RGB LED Button Bricklet. It can take several options:

• --help shows help for the specific call command and exits

• --list-functions shows a list of known functions of the RGB LED Button Bricklet and exits

tinkerforge dispatch rgb-led-button-bricklet [<option>..] <uid> <callback>¶

Parameters:	<uid> – Type: String <callback> – Type: String

The dispatch command is used to dispatch a callback of the RGB LED Button Bricklet. It can take several options:

• --help shows help for the specific dispatch command and exits

• --list-callbacks shows a list of known callbacks of the RGB LED Button Bricklet and exits

tinkerforge call rgb-led-button-bricklet <uid> <function> [<option>..] [<argument>..]¶

Parameters:	<uid> – Type: String <function> – Type: String

The <function> to be called can take different options depending of its kind. All functions can take the following options:

• --help shows help for the specific function and exits

Getter functions can take the following options:

• --execute <command> shell command line to execute for each incoming response (see section about output formatting for details)

Setter functions can take the following options:

• --expect-response requests response and waits for it

The --expect-response option for setter functions allows to detect timeouts and other error conditions calls of setters as well. The device will then send a response for this purpose. If this option is not given for a setter function then no response is sent and errors are silently ignored, because they cannot be detected.

tinkerforge dispatch rgb-led-button-bricklet <uid> <callback> [<option>..]¶

Parameters:	<uid> – Type: String <callback> – Type: String

The <callback> to be dispatched can take several options:

• --help shows help for the specific callback and exits

• --execute <command> shell command line to execute for each incoming response (see section about output formatting for details)

Basic Functions¶

tinkerforge call rgb-led-button-bricklet <uid> set-color <red> <green> <blue>¶

Parameters:	<red> – Type: Int, Range: [0 to 255], Default: 0 <green> – Type: Int, Range: [0 to 255], Default: 0 <blue> – Type: Int, Range: [0 to 255], Default: 0
Output:	no output

Sets the color of the LED.

tinkerforge call rgb-led-button-bricklet <uid> get-color¶

Output:	red – Type: Int, Range: [0 to 255], Default: 0 green – Type: Int, Range: [0 to 255], Default: 0 blue – Type: Int, Range: [0 to 255], Default: 0

Returns the LED color as set by set-color.

tinkerforge call rgb-led-button-bricklet <uid> get-button-state¶

Output:	state – Type: Int, Range: See symbols

Returns the current state of the button (either pressed or released).

The following symbols are available for this function:

For state:

• button-state-pressed = 0

• button-state-released = 1

tinkerforge call rgb-led-button-bricklet <uid> get-color-calibration¶

Output:	red – Type: Int, Unit: 1 %, Range: [0 to 100], Default: 100 green – Type: Int, Unit: 1 %, Range: [0 to 100], Default: 100 blue – Type: Int, Unit: 1 %, Range: [0 to 100], Default: 55

Returns the color calibration as set by set-color-calibration.

Advanced Functions¶

tinkerforge call rgb-led-button-bricklet <uid> set-color-calibration <red> <green> <blue>¶

Parameters:	<red> – Type: Int, Unit: 1 %, Range: [0 to 100], Default: 100 <green> – Type: Int, Unit: 1 %, Range: [0 to 100], Default: 100 <blue> – Type: Int, Unit: 1 %, Range: [0 to 100], Default: 55
Output:	no output

Sets a color calibration. Some colors appear brighter then others, so a calibration may be necessary for uniform colors.

The calibration is saved in flash. You don't need to call this function on every startup.

tinkerforge call rgb-led-button-bricklet <uid> get-spitfp-error-count¶

Output:	error-count-ack-checksum – Type: Int, Range: [0 to 232 - 1] error-count-message-checksum – Type: Int, Range: [0 to 232 - 1] error-count-frame – Type: Int, Range: [0 to 232 - 1] error-count-overflow – Type: Int, 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.

tinkerforge call rgb-led-button-bricklet <uid> set-status-led-config <config>¶

Parameters:	<config> – Type: Int, Range: See symbols, Default: 3
Output:	no output

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

The following symbols are available for this function:

For <config>:

• status-led-config-off = 0

• status-led-config-on = 1

• status-led-config-show-heartbeat = 2

• status-led-config-show-status = 3

tinkerforge call rgb-led-button-bricklet <uid> get-status-led-config¶

Output:	config – Type: Int, Range: See symbols, Default: 3

Returns the configuration as set by set-status-led-config

The following symbols are available for this function:

For config:

• status-led-config-off = 0

• status-led-config-on = 1

• status-led-config-show-heartbeat = 2

• status-led-config-show-status = 3

tinkerforge call rgb-led-button-bricklet <uid> get-chip-temperature¶

Output:	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.

tinkerforge call rgb-led-button-bricklet <uid> reset¶

Output:	no output

Calling this function will reset the Bricklet. All configurations will be lost.

After a reset you have to create new device objects, calling functions on the existing ones will result in undefined behavior!

tinkerforge call rgb-led-button-bricklet <uid> get-identity¶

Output:

uid – Type: String, Length: up to 8 connected-uid – Type: String, Length: up to 8 position – Type: Char, Range: [a to h, z] hardware-version – Type: Int Array, Length: 3 0: major – Type: Int, Range: [0 to 255] 1: minor – Type: Int, Range: [0 to 255] 2: revision – Type: Int, Range: [0 to 255] firmware-version – Type: Int Array, Length: 3 0: major – Type: Int, Range: [0 to 255] 1: minor – Type: Int, Range: [0 to 255] 2: revision – Type: Int, Range: [0 to 255] device-identifier – 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 at position 'z'.

The device identifier numbers can be found here. 

Callbacks¶

Callbacks can be used to receive time critical or recurring data from the device:

tinkerforge dispatch rgb-led-button-bricklet <uid> example

The available callbacks are described below.

tinkerforge dispatch rgb-led-button-bricklet <uid> button-state-changed¶

Output:	state – Type: Int, Range: See symbols

This callback is triggered every time the button state changes from pressed to released or from released to pressed.

The parameter is the current state of the button.

The following symbols are available for this function:

For state:

• button-state-pressed = 0

• button-state-released = 1

Internal Functions¶

Internal functions are used for maintenance tasks such as flashing a new firmware of changing the UID of a Bricklet. These task should be performed using Brick Viewer instead of using the internal functions directly.

tinkerforge call rgb-led-button-bricklet <uid> set-bootloader-mode <mode>¶

Parameters:	<mode> – Type: Int, Range: See symbols
Output:	status – Type: Int, Range: See symbols

Sets the bootloader mode and returns the status after the requested mode change was instigated.

You can change from bootloader mode to firmware mode and vice versa. A change from bootloader mode to firmware mode will only take place if the entry function, device identifier and CRC are present and correct.

This function is used by Brick Viewer during flashing. It should not be necessary to call it in a normal user program.

The following symbols are available for this function:

For <mode>:

• bootloader-mode-bootloader = 0

• bootloader-mode-firmware = 1

• bootloader-mode-bootloader-wait-for-reboot = 2

• bootloader-mode-firmware-wait-for-reboot = 3

• bootloader-mode-firmware-wait-for-erase-and-reboot = 4

For status:

• bootloader-status-ok = 0

• bootloader-status-invalid-mode = 1

• bootloader-status-no-change = 2

• bootloader-status-entry-function-not-present = 3

• bootloader-status-device-identifier-incorrect = 4

• bootloader-status-crc-mismatch = 5

tinkerforge call rgb-led-button-bricklet <uid> get-bootloader-mode¶

Output:	mode – Type: Int, Range: See symbols

Returns the current bootloader mode, see set-bootloader-mode.

The following symbols are available for this function:

For mode:

• bootloader-mode-bootloader = 0

• bootloader-mode-firmware = 1

• bootloader-mode-bootloader-wait-for-reboot = 2

• bootloader-mode-firmware-wait-for-reboot = 3

• bootloader-mode-firmware-wait-for-erase-and-reboot = 4

tinkerforge call rgb-led-button-bricklet <uid> set-write-firmware-pointer <pointer>¶

Parameters:	<pointer> – Type: Int, Unit: 1 B, Range: [0 to 232 - 1]
Output:	no output

Sets the firmware pointer for write-firmware. The pointer has to be increased by chunks of size 64. The data is written to flash every 4 chunks (which equals to one page of size 256).

This function is used by Brick Viewer during flashing. It should not be necessary to call it in a normal user program.

tinkerforge call rgb-led-button-bricklet <uid> write-firmware <data>¶

Parameters:	<data> – Type: Int Array, Length: 64, Range: [0 to 255]
Output:	status – Type: Int, Range: [0 to 255]

Writes 64 Bytes of firmware at the position as written by set-write-firmware-pointer before. The firmware is written to flash every 4 chunks.

You can only write firmware in bootloader mode.

This function is used by Brick Viewer during flashing. It should not be necessary to call it in a normal user program.

tinkerforge call rgb-led-button-bricklet <uid> write-uid <uid>¶

Parameters:	<uid> – Type: Int, Range: [0 to 232 - 1]
Output:	no output

Writes a new UID into flash. If you want to set a new UID you have to decode the Base58 encoded UID string into an integer first.

We recommend that you use Brick Viewer to change the UID.

tinkerforge call rgb-led-button-bricklet <uid> read-uid¶

Output:	uid – Type: Int, Range: [0 to 232 - 1]

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