Documentation

Overview

Push button with built-in RGB LED‍.

See also the documentation here: https://www.tinkerforge.com/en/doc/Software/Bricklets/RGBLEDButton_Bricklet_Go.html.

Index

Constants

View Source
const DeviceDisplayName = "RGB LED Button Bricklet"
View Source
const DeviceIdentifier = 282

Variables

This section is empty.

Functions

This section is empty.

Types

type BootloaderMode

type BootloaderMode = uint8
const (
	BootloaderModeBootloader                    BootloaderMode = 0
	BootloaderModeFirmware                      BootloaderMode = 1
	BootloaderModeBootloaderWaitForReboot       BootloaderMode = 2
	BootloaderModeFirmwareWaitForReboot         BootloaderMode = 3
	BootloaderModeFirmwareWaitForEraseAndReboot BootloaderMode = 4
)

type BootloaderStatus

type BootloaderStatus = uint8
const (
	BootloaderStatusOK                        BootloaderStatus = 0
	BootloaderStatusInvalidMode               BootloaderStatus = 1
	BootloaderStatusNoChange                  BootloaderStatus = 2
	BootloaderStatusEntryFunctionNotPresent   BootloaderStatus = 3
	BootloaderStatusDeviceIdentifierIncorrect BootloaderStatus = 4
	BootloaderStatusCRCMismatch               BootloaderStatus = 5
)

type ButtonState

type ButtonState = uint8
const (
	ButtonStatePressed  ButtonState = 0
	ButtonStateReleased ButtonState = 1
)

type Function

type Function = uint8
const (
	FunctionSetColor                   Function = 1
	FunctionGetColor                   Function = 2
	FunctionGetButtonState             Function = 3
	FunctionSetColorCalibration        Function = 5
	FunctionGetColorCalibration        Function = 6
	FunctionGetSPITFPErrorCount        Function = 234
	FunctionSetBootloaderMode          Function = 235
	FunctionGetBootloaderMode          Function = 236
	FunctionSetWriteFirmwarePointer    Function = 237
	FunctionWriteFirmware              Function = 238
	FunctionSetStatusLEDConfig         Function = 239
	FunctionGetStatusLEDConfig         Function = 240
	FunctionGetChipTemperature         Function = 242
	FunctionReset                      Function = 243
	FunctionWriteUID                   Function = 248
	FunctionReadUID                    Function = 249
	FunctionGetIdentity                Function = 255
	FunctionCallbackButtonStateChanged Function = 4
)

type RGBLEDButtonBricklet

type RGBLEDButtonBricklet struct {
	// contains filtered or unexported fields
}

func New

Creates an object with the unique device ID `uid`. This object can then be used after the IP Connection `ipcon` is connected.

func (*RGBLEDButtonBricklet) DeregisterButtonStateChangedCallback

func (device *RGBLEDButtonBricklet) DeregisterButtonStateChangedCallback(registrationId uint64)

Remove a registered Button State Changed callback.

func (*RGBLEDButtonBricklet) GetAPIVersion

func (device *RGBLEDButtonBricklet) GetAPIVersion() [3]uint8

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 (*RGBLEDButtonBricklet) GetBootloaderMode

func (device *RGBLEDButtonBricklet) GetBootloaderMode() (mode BootloaderMode, err error)

Returns the current bootloader mode, see SetBootloaderMode.

Associated constants:

* BootloaderModeBootloader
* BootloaderModeFirmware
* BootloaderModeBootloaderWaitForReboot
* BootloaderModeFirmwareWaitForReboot
* BootloaderModeFirmwareWaitForEraseAndReboot

func (*RGBLEDButtonBricklet) GetButtonState

func (device *RGBLEDButtonBricklet) GetButtonState() (state ButtonState, err error)

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

Associated constants:

* ButtonStatePressed
* ButtonStateReleased

func (*RGBLEDButtonBricklet) GetChipTemperature

func (device *RGBLEDButtonBricklet) GetChipTemperature() (temperature int16, err error)

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.

func (*RGBLEDButtonBricklet) GetColor

func (device *RGBLEDButtonBricklet) GetColor() (red uint8, green uint8, blue uint8, err error)

Returns the LED color as set by SetColor.

func (*RGBLEDButtonBricklet) GetColorCalibration

func (device *RGBLEDButtonBricklet) GetColorCalibration() (red uint8, green uint8, blue uint8, err error)

Returns the color calibration as set by SetColorCalibration.

func (*RGBLEDButtonBricklet) GetIdentity

func (device *RGBLEDButtonBricklet) 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', 'd', 'e', 'f', 'g' or 'h' (Bricklet Port). A Bricklet connected to an `Isolator Bricklet <isolator_bricklet>` is always at position 'z'.

The device identifier numbers can be found `here <device_identifier>`. |device_identifier_constant|

func (*RGBLEDButtonBricklet) GetResponseExpected

func (device *RGBLEDButtonBricklet) GetResponseExpected(functionID Function) (bool, 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 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 sent and errors are silently ignored, because they cannot be detected.

See SetResponseExpected for the list of function ID constants available for this function.

func (*RGBLEDButtonBricklet) GetSPITFPErrorCount

func (device *RGBLEDButtonBricklet) 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 (*RGBLEDButtonBricklet) GetStatusLEDConfig

func (device *RGBLEDButtonBricklet) GetStatusLEDConfig() (config StatusLEDConfig, err error)

Returns the configuration as set by SetStatusLEDConfig

Associated constants:

* StatusLEDConfigOff
* StatusLEDConfigOn
* StatusLEDConfigShowHeartbeat
* StatusLEDConfigShowStatus

func (*RGBLEDButtonBricklet) ReadUID

func (device *RGBLEDButtonBricklet) ReadUID() (uid uint32, err error)

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

func (*RGBLEDButtonBricklet) RegisterButtonStateChangedCallback

func (device *RGBLEDButtonBricklet) RegisterButtonStateChangedCallback(fn func(ButtonState)) uint64

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.

func (*RGBLEDButtonBricklet) Reset

func (device *RGBLEDButtonBricklet) 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 (*RGBLEDButtonBricklet) SetBootloaderMode

func (device *RGBLEDButtonBricklet) 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.

Associated constants:

* BootloaderModeBootloader
* BootloaderModeFirmware
* BootloaderModeBootloaderWaitForReboot
* BootloaderModeFirmwareWaitForReboot
* BootloaderModeFirmwareWaitForEraseAndReboot
* BootloaderStatusOK
* BootloaderStatusInvalidMode
* BootloaderStatusNoChange
* BootloaderStatusEntryFunctionNotPresent
* BootloaderStatusDeviceIdentifierIncorrect
* BootloaderStatusCRCMismatch

func (*RGBLEDButtonBricklet) SetColor

func (device *RGBLEDButtonBricklet) SetColor(red uint8, green uint8, blue uint8) (err error)

Sets the color of the LED.

func (*RGBLEDButtonBricklet) SetColorCalibration

func (device *RGBLEDButtonBricklet) SetColorCalibration(red uint8, green uint8, blue uint8) (err error)

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.

func (*RGBLEDButtonBricklet) SetResponseExpected

func (device *RGBLEDButtonBricklet) SetResponseExpected(functionID Function, responseExpected bool) 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 sent and errors are silently ignored, because they cannot be detected.

func (*RGBLEDButtonBricklet) SetResponseExpectedAll

func (device *RGBLEDButtonBricklet) SetResponseExpectedAll(responseExpected bool)

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

func (*RGBLEDButtonBricklet) SetStatusLEDConfig

func (device *RGBLEDButtonBricklet) 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.

Associated constants:

* StatusLEDConfigOff
* StatusLEDConfigOn
* StatusLEDConfigShowHeartbeat
* StatusLEDConfigShowStatus

func (*RGBLEDButtonBricklet) SetWriteFirmwarePointer

func (device *RGBLEDButtonBricklet) SetWriteFirmwarePointer(pointer uint32) (err error)

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

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

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

func (device *RGBLEDButtonBricklet) 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.

type StatusLEDConfig

type StatusLEDConfig = uint8
const (
	StatusLEDConfigOff           StatusLEDConfig = 0
	StatusLEDConfigOn            StatusLEDConfig = 1
	StatusLEDConfigShowHeartbeat StatusLEDConfig = 2
	StatusLEDConfigShowStatus    StatusLEDConfig = 3
)