Go - RGB LED Bricklet 2.0

This is the description of the Go API bindings for the RGB LED Bricklet 2.0. General information and technical specifications for the RGB LED Bricklet 2.0 are summarized in its hardware description.

An installation guide for the Go API bindings is part of their general description. Additional documentation can be found on godoc.org.

Examples

The example code below is Public Domain (CC0 1.0).

Simple

Download (example_simple.go)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
package main

import (
    "fmt"
    "github.com/Tinkerforge/go-api-bindings/ipconnection"
    "github.com/Tinkerforge/go-api-bindings/rgb_led_v2_bricklet"
)

const ADDR string = "localhost:4223"
const UID string = "XYZ" // Change XYZ to the UID of your RGB LED Bricklet 2.0.

func main() {
    ipcon := ipconnection.New()
    defer ipcon.Close()
    rl, _ := rgb_led_v2_bricklet.New(UID, &ipcon) // Create device object.

    ipcon.Connect(ADDR) // Connect to brickd.
    defer ipcon.Disconnect()
    // Don't use device before ipcon is connected.

    // Set light blue color
    rl.SetRGBValue(0, 170, 234)

    fmt.Print("Press enter to exit.")
    fmt.Scanln()
}

API

The RGB LED Bricklet 2.0 API is defined in the package github.com/Tinkerforge/go-api-bindings/rgb_led_v2_bricklet

Nearly every function of the Go bindings can return an BrickletError, implementing the error interface. The error can have one of the following values:

  • BrickletErrorSuccess = 0
  • BrickletErrorInvalidParameter = 1
  • BrickletErrorFunctionNotSupported = 2
  • BrickletErrorUnknownError = 3

which correspond to the values returned from Bricks and Bricklets.

All functions listed below are thread-safe.

Basic Functions

func NewRGBLEDV2Bricklet(uid string, ipcon *IPConnection)(device RGBLEDV2Bricklet, err error)

Creates a new RGBLEDV2Bricklet object with the unique device ID uid and adds it to the IPConnection ipcon:

This device object can be used after the IPConnection has been connected (see examples above).

func (*RGBLEDV2Bricklet)SetRGBValue(r uint8, g uint8, b uint8)(err error)

Sets the r, g and b values for the LED. Each value can be between 0 and 255.

func (*RGBLEDV2Bricklet)GetRGBValue()(r uint8, g uint8, b uint8, err error)

Returns the r, g and b values of the LED as set by (*RGBLEDV2Bricklet) SetRGBValue.

Advanced Functions

func (*RGBLEDV2Bricklet)GetAPIVersion()(apiVersion [3]uint8, err error)

Returns the version of the API definition (major, minor, revision) implemented by this API bindings. This is neither the release version of this API bindings nor does it tell you anything about the represented Brick or Bricklet.

func (*RGBLEDV2Bricklet)GetResponseExpected(functionId uint8)(responseExpected bool, err error)

Returns the response expected flag for the function specified by the function ID parameter. It is true if the function is expected to send a response, false otherwise.

For getter functions this is enabled by default and cannot be disabled, because those functions will always send a response. For callback configuration functions it is enabled by default too, but can be disabled by (*RGBLEDV2Bricklet) SetResponseExpected. For setter functions it is disabled by default and can be enabled.

Enabling the response expected flag for a setter function allows to detect timeouts and other error conditions calls of this setter as well. The device will then send a response for this purpose. If this flag is disabled for a setter function then no response is send and errors are silently ignored, because they cannot be detected.

See (*RGBLEDV2Bricklet) SetResponseExpected for the list of function ID constants available for this function.

func (*RGBLEDV2Bricklet)SetResponseExpected(functionId uint8, responseExpected bool)(err error)

Changes the response expected flag of the function specified by the function ID parameter. This flag can only be changed for setter (default value: false) and callback configuration functions (default value: true). For getter functions it is always enabled.

Enabling the response expected flag for a setter function allows to detect timeouts and other error conditions calls of this setter as well. The device will then send a response for this purpose. If this flag is disabled for a setter function then no response is send and errors are silently ignored, because they cannot be detected.

The following function ID constants are available for this function:

  • FunctionSetRGBValue = 1
  • FunctionSetWriteFirmwarePointer = 237
  • FunctionSetStatusLEDConfig = 239
  • FunctionReset = 243
  • FunctionWriteUID = 248
func (*RGBLEDV2Bricklet)SetResponseExpectedAll(responseExpected bool)(err error)

Changes the response expected flag for all setter and callback configuration functions of this device at once.

func (*RGBLEDV2Bricklet)GetSPITFPErrorCount()(errorCountAckChecksum uint32, errorCountMessageChecksum uint32, errorCountFrame uint32, errorCountOverflow uint32, err error)

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.

func (*RGBLEDV2Bricklet)SetBootloaderMode(mode BootloaderMode)(status BootloaderStatus, err error)

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 constants are available for this function:

  • BootloaderModeBootloader = 0
  • BootloaderModeFirmware = 1
  • BootloaderModeBootloaderWaitForReboot = 2
  • BootloaderModeFirmwareWaitForReboot = 3
  • BootloaderModeFirmwareWaitForEraseAndReboot = 4
  • BootloaderStatusOK = 0
  • BootloaderStatusInvalidMode = 1
  • BootloaderStatusNoChange = 2
  • BootloaderStatusEntryFunctionNotPresent = 3
  • BootloaderStatusDeviceIdentifierIncorrect = 4
  • BootloaderStatusCRCMismatch = 5
func (*RGBLEDV2Bricklet)GetBootloaderMode()(mode BootloaderMode, err error)

Returns the current bootloader mode, see (*RGBLEDV2Bricklet) SetBootloaderMode.

The following constants are available for this function:

  • BootloaderModeBootloader = 0
  • BootloaderModeFirmware = 1
  • BootloaderModeBootloaderWaitForReboot = 2
  • BootloaderModeFirmwareWaitForReboot = 3
  • BootloaderModeFirmwareWaitForEraseAndReboot = 4
func (*RGBLEDV2Bricklet)SetWriteFirmwarePointer(pointer uint32)(err error)

Sets the firmware pointer for (*RGBLEDV2Bricklet) WriteFirmware. 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.

func (*RGBLEDV2Bricklet)WriteFirmware(data [64]uint8)(status uint8, err error)

Writes 64 Bytes of firmware at the position as written by (*RGBLEDV2Bricklet) SetWriteFirmwarePointer 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.

func (*RGBLEDV2Bricklet)SetStatusLEDConfig(config StatusLEDConfig)(err error)

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 constants are available for this function:

  • StatusLEDConfigOff = 0
  • StatusLEDConfigOn = 1
  • StatusLEDConfigShowHeartbeat = 2
  • StatusLEDConfigShowStatus = 3
func (*RGBLEDV2Bricklet)GetStatusLEDConfig()(config StatusLEDConfig, err error)

Returns the configuration as set by (*RGBLEDV2Bricklet) SetStatusLEDConfig

The following constants are available for this function:

  • StatusLEDConfigOff = 0
  • StatusLEDConfigOn = 1
  • StatusLEDConfigShowHeartbeat = 2
  • StatusLEDConfigShowStatus = 3
func (*RGBLEDV2Bricklet)GetChipTemperature()(temperature int16, err error)

Returns the temperature in °C 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.

func (*RGBLEDV2Bricklet)Reset()(err error)

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!

func (*RGBLEDV2Bricklet)WriteUID(uid uint32)(err error)

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.

func (*RGBLEDV2Bricklet)ReadUID()(uid uint32, err error)

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

func (*RGBLEDV2Bricklet)GetIdentity()(uid string, connectedUid string, position rune, hardwareVersion [3]uint8, firmwareVersion [3]uint8, deviceIdentifier uint16, err error)

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. There is also a constant for the device identifier of this Bricklet.

Constants

rgb_led_v2_bricklet.DeviceIdentifier

This constant is used to identify a RGB LED Bricklet 2.0.

The (*RGBLEDV2Bricklet) GetIdentity function and the (*IPConnection) RegisterEnumerateCallback callback of the IPConnection have a deviceIdentifier parameter to specify the Brick's or Bricklet's type.

rgb_led_v2_bricklet.DeviceDisplayName

This constant represents the human readable name of a RGB LED Bricklet 2.0.