go-api-bindings: github.com/Tinkerforge/go-api-bindings/color_v2_bricklet Index | Files

package color_v2_bricklet

import "github.com/Tinkerforge/go-api-bindings/color_v2_bricklet"

Measures color (RGB value), illuminance and color temperature.

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

Index

Package Files

color_v2_bricklet.go

Constants

const DeviceDisplayName = "Color Bricklet 2.0"
const DeviceIdentifier = 2128

type BootloaderMode Uses

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

type BootloaderStatus Uses

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

type ColorV2Bricklet Uses

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

func New Uses

func New(uid string, ipcon *ipconnection.IPConnection) (ColorV2Bricklet, error)

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

func (*ColorV2Bricklet) DeregisterColorCallback Uses

func (device *ColorV2Bricklet) DeregisterColorCallback(registrationId uint64)

Remove a registered Color callback.

func (*ColorV2Bricklet) DeregisterColorTemperatureCallback Uses

func (device *ColorV2Bricklet) DeregisterColorTemperatureCallback(registrationId uint64)

Remove a registered Color Temperature callback.

func (*ColorV2Bricklet) DeregisterIlluminanceCallback Uses

func (device *ColorV2Bricklet) DeregisterIlluminanceCallback(registrationId uint64)

Remove a registered Illuminance callback.

func (*ColorV2Bricklet) GetAPIVersion Uses

func (device *ColorV2Bricklet) 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 (*ColorV2Bricklet) GetBootloaderMode Uses

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

Returns the current bootloader mode, see SetBootloaderMode.

Associated constants:

* BootloaderModeBootloader
* BootloaderModeFirmware
* BootloaderModeBootloaderWaitForReboot
* BootloaderModeFirmwareWaitForReboot
* BootloaderModeFirmwareWaitForEraseAndReboot

func (*ColorV2Bricklet) GetChipTemperature Uses

func (device *ColorV2Bricklet) 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 (*ColorV2Bricklet) GetColor Uses

func (device *ColorV2Bricklet) GetColor() (r uint16, g uint16, b uint16, c uint16, err error)

Returns the measured color of the sensor. The values have a range of 0 to 65535.

The red (r), green (g), blue (b) and clear (c) colors are measured with four different photodiodes that are responsive at different wavelengths:

.. image:: /Images/Bricklets/bricklet_color_wavelength_chart_600.jpg

:scale: 100 %
:alt: Chart Responsivity / Wavelength
:align: center
:target: ../../_images/Bricklets/bricklet_color_wavelength_chart_600.jpg

If you want to get the color periodically, it is recommended to use the RegisterColorCallback callback and set the period with SetColorCallbackConfiguration.

func (*ColorV2Bricklet) GetColorCallbackConfiguration Uses

func (device *ColorV2Bricklet) GetColorCallbackConfiguration() (period uint32, valueHasToChange bool, err error)

Returns the callback configuration as set by SetColorCallbackConfiguration.

func (*ColorV2Bricklet) GetColorTemperature Uses

func (device *ColorV2Bricklet) GetColorTemperature() (colorTemperature uint16, err error)

Returns the color temperature in Kelvin.

To get a correct color temperature measurement make sure that the color values themselves are not saturated. The color value (R, G or B) is saturated if it is equal to the maximum value of 65535. In that case you have to reduce the gain, see SetConfiguration.

If you want to get the value periodically, it is recommended to use the RegisterColorTemperatureCallback callback. You can set the callback configuration with SetColorTemperatureCallbackConfiguration.

func (*ColorV2Bricklet) GetColorTemperatureCallbackConfiguration Uses

func (device *ColorV2Bricklet) GetColorTemperatureCallbackConfiguration() (period uint32, valueHasToChange bool, option ThresholdOption, min uint16, max uint16, err error)

Returns the callback configuration as set by SetColorTemperatureCallbackConfiguration.

Associated constants:

* ThresholdOptionOff
* ThresholdOptionOutside
* ThresholdOptionInside
* ThresholdOptionSmaller
* ThresholdOptionGreater

func (*ColorV2Bricklet) GetConfiguration Uses

func (device *ColorV2Bricklet) GetConfiguration() (gain Gain, integrationTime IntegrationTime, err error)

Returns the configuration as set by SetConfiguration.

Associated constants:

* Gain1x
* Gain4x
* Gain16x
* Gain60x
* IntegrationTime2ms
* IntegrationTime24ms
* IntegrationTime101ms
* IntegrationTime154ms
* IntegrationTime700ms

func (*ColorV2Bricklet) GetIdentity Uses

func (device *ColorV2Bricklet) 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 <device_identifier>`. |device_identifier_constant|

func (*ColorV2Bricklet) GetIlluminance Uses

func (device *ColorV2Bricklet) GetIlluminance() (illuminance uint32, err error)

Returns the illuminance affected by the gain and integration time as set by SetConfiguration. To get the illuminance in Lux apply this formula::

lux = illuminance * 700 / gain / integration_time

To get a correct illuminance measurement make sure that the color values themselves are not saturated. The color value (R, G or B) is saturated if it is equal to the maximum value of 65535. In that case you have to reduce the gain, see SetConfiguration.

If you want to get the value periodically, it is recommended to use the RegisterIlluminanceCallback callback. You can set the callback configuration with SetIlluminanceCallbackConfiguration.

func (*ColorV2Bricklet) GetIlluminanceCallbackConfiguration Uses

func (device *ColorV2Bricklet) GetIlluminanceCallbackConfiguration() (period uint32, valueHasToChange bool, option ThresholdOption, min uint32, max uint32, err error)

Returns the callback configuration as set by SetIlluminanceCallbackConfiguration.

Associated constants:

* ThresholdOptionOff
* ThresholdOptionOutside
* ThresholdOptionInside
* ThresholdOptionSmaller
* ThresholdOptionGreater

func (*ColorV2Bricklet) GetLight Uses

func (device *ColorV2Bricklet) GetLight() (enable bool, err error)

Returns the value as set by SetLight.

func (*ColorV2Bricklet) GetResponseExpected Uses

func (device *ColorV2Bricklet) 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 send and errors are silently ignored, because they cannot be detected.

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

func (*ColorV2Bricklet) GetSPITFPErrorCount Uses

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

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

Returns the configuration as set by SetStatusLEDConfig

Associated constants:

* StatusLEDConfigOff
* StatusLEDConfigOn
* StatusLEDConfigShowHeartbeat
* StatusLEDConfigShowStatus

func (*ColorV2Bricklet) ReadUID Uses

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

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

func (*ColorV2Bricklet) RegisterColorCallback Uses

func (device *ColorV2Bricklet) RegisterColorCallback(fn func(uint16, uint16, uint16, uint16)) uint64

This callback is triggered periodically with the period that is set by SetColorCallbackConfiguration. The parameter is the color of the sensor as RGBC.

The RegisterColorCallback callback is only triggered if the color has changed since the last triggering.

func (*ColorV2Bricklet) RegisterColorTemperatureCallback Uses

func (device *ColorV2Bricklet) RegisterColorTemperatureCallback(fn func(uint16)) uint64

This callback is triggered periodically according to the configuration set by SetColorTemperatureCallbackConfiguration.

The parameter is the same as GetColorTemperature.

func (*ColorV2Bricklet) RegisterIlluminanceCallback Uses

func (device *ColorV2Bricklet) RegisterIlluminanceCallback(fn func(uint32)) uint64

This callback is triggered periodically according to the configuration set by SetIlluminanceCallbackConfiguration.

The parameter is the same as GetIlluminance.

func (*ColorV2Bricklet) Reset Uses

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

func (device *ColorV2Bricklet) 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 (*ColorV2Bricklet) SetColorCallbackConfiguration Uses

func (device *ColorV2Bricklet) SetColorCallbackConfiguration(period uint32, valueHasToChange bool) (err error)

The period in ms is the period with which the RegisterColorCallback callback is triggered periodically. A value of 0 turns the callback off.

If the `value has to change`-parameter is set to true, the callback is only triggered after the value has changed. If the value didn't change within the period, the callback is triggered immediately on change.

If it is set to false, the callback is continuously triggered with the period, independent of the value.

The default value is (0, false).

func (*ColorV2Bricklet) SetColorTemperatureCallbackConfiguration Uses

func (device *ColorV2Bricklet) SetColorTemperatureCallbackConfiguration(period uint32, valueHasToChange bool, option ThresholdOption, min uint16, max uint16) (err error)

The period in ms is the period with which the RegisterColorTemperatureCallback callback is triggered periodically. A value of 0 turns the callback off.

If the `value has to change`-parameter is set to true, the callback is only triggered after the value has changed. If the value didn't change within the period, the callback is triggered immediately on change.

If it is set to false, the callback is continuously triggered with the period, independent of the value.

It is furthermore possible to constrain the callback with thresholds.

The `option`-parameter together with min/max sets a threshold for the RegisterColorTemperatureCallback callback.

The following options are possible:

Option| Description
--- | ---
'x'|    Threshold is turned off
'o'|    Threshold is triggered when the value is *outside* the min and max values
'i'|    Threshold is triggered when the value is *inside* or equal to the min and max values
'<'|    Threshold is triggered when the value is smaller than the min value (max is ignored)
'>'|    Threshold is triggered when the value is greater than the min value (max is ignored)

If the option is set to 'x' (threshold turned off) the callback is triggered with the fixed period.

The default value is (0, false, 'x', 0, 0).

Associated constants:

* ThresholdOptionOff
* ThresholdOptionOutside
* ThresholdOptionInside
* ThresholdOptionSmaller
* ThresholdOptionGreater

func (*ColorV2Bricklet) SetConfiguration Uses

func (device *ColorV2Bricklet) SetConfiguration(gain Gain, integrationTime IntegrationTime) (err error)

Sets the configuration of the sensor. Gain and integration time can be configured this way.

For configuring the gain:

* 0: 1x Gain * 1: 4x Gain * 2: 16x Gain * 3: 60x Gain

For configuring the integration time:

* 0: 2.4ms * 1: 24ms * 2: 101ms * 3: 154ms * 4: 700ms

Increasing the gain enables the sensor to detect a color from a higher distance.

The integration time provides a trade-off between conversion time and accuracy. With a longer integration time the values read will be more accurate but it will take longer to get the conversion results.

The default values are 60x gain and 154ms integration time.

Associated constants:

* Gain1x
* Gain4x
* Gain16x
* Gain60x
* IntegrationTime2ms
* IntegrationTime24ms
* IntegrationTime101ms
* IntegrationTime154ms
* IntegrationTime700ms

func (*ColorV2Bricklet) SetIlluminanceCallbackConfiguration Uses

func (device *ColorV2Bricklet) SetIlluminanceCallbackConfiguration(period uint32, valueHasToChange bool, option ThresholdOption, min uint32, max uint32) (err error)

The period in ms is the period with which the RegisterIlluminanceCallback callback is triggered periodically. A value of 0 turns the callback off.

If the `value has to change`-parameter is set to true, the callback is only triggered after the value has changed. If the value didn't change within the period, the callback is triggered immediately on change.

If it is set to false, the callback is continuously triggered with the period, independent of the value.

It is furthermore possible to constrain the callback with thresholds.

The `option`-parameter together with min/max sets a threshold for the RegisterIlluminanceCallback callback.

The following options are possible:

Option| Description
--- | ---
'x'|    Threshold is turned off
'o'|    Threshold is triggered when the value is *outside* the min and max values
'i'|    Threshold is triggered when the value is *inside* or equal to the min and max values
'<'|    Threshold is triggered when the value is smaller than the min value (max is ignored)
'>'|    Threshold is triggered when the value is greater than the min value (max is ignored)

If the option is set to 'x' (threshold turned off) the callback is triggered with the fixed period.

The default value is (0, false, 'x', 0, 0).

Associated constants:

* ThresholdOptionOff
* ThresholdOptionOutside
* ThresholdOptionInside
* ThresholdOptionSmaller
* ThresholdOptionGreater

func (*ColorV2Bricklet) SetLight Uses

func (device *ColorV2Bricklet) SetLight(enable bool) (err error)

Turns the white LED on the Bricklet on/off.

func (*ColorV2Bricklet) SetResponseExpected Uses

func (device *ColorV2Bricklet) 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 send and errors are silently ignored, because they cannot be detected.

func (*ColorV2Bricklet) SetResponseExpectedAll Uses

func (device *ColorV2Bricklet) SetResponseExpectedAll(responseExpected bool)

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

func (*ColorV2Bricklet) SetStatusLEDConfig Uses

func (device *ColorV2Bricklet) 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 (*ColorV2Bricklet) SetWriteFirmwarePointer Uses

func (device *ColorV2Bricklet) 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 (*ColorV2Bricklet) WriteFirmware Uses

func (device *ColorV2Bricklet) 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 (*ColorV2Bricklet) WriteUID Uses

func (device *ColorV2Bricklet) 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 Function Uses

type Function = uint8
const (
    FunctionGetColor                                 Function = 1
    FunctionSetColorCallbackConfiguration            Function = 2
    FunctionGetColorCallbackConfiguration            Function = 3
    FunctionGetIlluminance                           Function = 5
    FunctionSetIlluminanceCallbackConfiguration      Function = 6
    FunctionGetIlluminanceCallbackConfiguration      Function = 7
    FunctionGetColorTemperature                      Function = 9
    FunctionSetColorTemperatureCallbackConfiguration Function = 10
    FunctionGetColorTemperatureCallbackConfiguration Function = 11
    FunctionSetLight                                 Function = 13
    FunctionGetLight                                 Function = 14
    FunctionSetConfiguration                         Function = 15
    FunctionGetConfiguration                         Function = 16
    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
    FunctionCallbackColor                            Function = 4
    FunctionCallbackIlluminance                      Function = 8
    FunctionCallbackColorTemperature                 Function = 12
)

type Gain Uses

type Gain = uint8
const (
    Gain1x  Gain = 0
    Gain4x  Gain = 1
    Gain16x Gain = 2
    Gain60x Gain = 3
)

type IntegrationTime Uses

type IntegrationTime = uint8
const (
    IntegrationTime2ms   IntegrationTime = 0
    IntegrationTime24ms  IntegrationTime = 1
    IntegrationTime101ms IntegrationTime = 2
    IntegrationTime154ms IntegrationTime = 3
    IntegrationTime700ms IntegrationTime = 4
)

type StatusLEDConfig Uses

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

type ThresholdOption Uses

type ThresholdOption = rune
const (
    ThresholdOptionOff     ThresholdOption = 'x'
    ThresholdOptionOutside ThresholdOption = 'o'
    ThresholdOptionInside  ThresholdOption = 'i'
    ThresholdOptionSmaller ThresholdOption = '<'
    ThresholdOptionGreater ThresholdOption = '>'
)

Package color_v2_bricklet imports 4 packages (graph). Updated 2019-08-23. Refresh now. Tools for package owners.