ambient_light_v3_bricklet

package
v0.0.0-...-368b749 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Feb 27, 2024 License: CC0-1.0 Imports: 5 Imported by: 1

Documentation

Overview

Measures ambient light up to 64000lux.

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

Index

Constants

View Source 
const DeviceDisplayName = "Ambient Light Bricklet 3.0"
View Source 
const DeviceIdentifier = 2131

Variables

This section is empty.

Functions

This section is empty.

Types

type AmbientLightV3Bricklet 

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

func New 

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

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

func (*AmbientLightV3Bricklet) DeregisterIlluminanceCallback 

func (device *AmbientLightV3Bricklet) DeregisterIlluminanceCallback(registrationId uint64)

Remove a registered Illuminance callback.

func (*AmbientLightV3Bricklet) GetAPIVersion 

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

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

Returns the current bootloader mode, see SetBootloaderMode.

Associated constants:

  • BootloaderModeBootloader
  • BootloaderModeFirmware
  • BootloaderModeBootloaderWaitForReboot
  • BootloaderModeFirmwareWaitForReboot
  • BootloaderModeFirmwareWaitForEraseAndReboot

func (*AmbientLightV3Bricklet) GetChipTemperature 

func (device *AmbientLightV3Bricklet) 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 (*AmbientLightV3Bricklet) GetConfiguration 

func (device *AmbientLightV3Bricklet) GetConfiguration() (illuminanceRange IlluminanceRange, integrationTime IntegrationTime, err error)

Returns the configuration as set by SetConfiguration.

Associated constants:

  • IlluminanceRangeUnlimited
  • IlluminanceRange64000Lux
  • IlluminanceRange32000Lux
  • IlluminanceRange16000Lux
  • IlluminanceRange8000Lux
  • IlluminanceRange1300Lux
  • IlluminanceRange600Lux
  • IntegrationTime50ms
  • IntegrationTime100ms
  • IntegrationTime150ms
  • IntegrationTime200ms
  • IntegrationTime250ms
  • IntegrationTime300ms
  • IntegrationTime350ms
  • IntegrationTime400ms

func (*AmbientLightV3Bricklet) GetIdentity 

func (device *AmbientLightV3Bricklet) 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 (*AmbientLightV3Bricklet) GetIlluminance 

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

Returns the illuminance of the ambient light sensor. The measurement range goes up to about 100000lux, but above 64000lux the precision starts to drop. The illuminance is given in lux/100, i.e. a value of 450000 means that an illuminance of 4500lux is measured.

An illuminance of 0lux indicates an error condition where the sensor cannot perform a reasonable measurement. This can happen with very dim or very bright light conditions. In bright light conditions this might indicate that the sensor is saturated and the configuration should be modified (SetConfiguration) to better match the conditions.

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 (*AmbientLightV3Bricklet) GetIlluminanceCallbackConfiguration 

func (device *AmbientLightV3Bricklet) 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 (*AmbientLightV3Bricklet) GetResponseExpected 

func (device *AmbientLightV3Bricklet) 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 (*AmbientLightV3Bricklet) GetSPITFPErrorCount 

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

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

Returns the configuration as set by SetStatusLEDConfig

Associated constants:

  • StatusLEDConfigOff
  • StatusLEDConfigOn
  • StatusLEDConfigShowHeartbeat
  • StatusLEDConfigShowStatus

func (*AmbientLightV3Bricklet) ReadUID 

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

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

func (*AmbientLightV3Bricklet) RegisterIlluminanceCallback 

func (device *AmbientLightV3Bricklet) 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 (*AmbientLightV3Bricklet) Reset 

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

func (device *AmbientLightV3Bricklet) 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 (*AmbientLightV3Bricklet) SetConfiguration 

func (device *AmbientLightV3Bricklet) SetConfiguration(illuminanceRange IlluminanceRange, integrationTime IntegrationTime) (err error)

Sets the configuration. It is possible to configure an illuminance range between 0-600lux and 0-64000lux and an integration time between 50ms and 400ms.

The unlimited illuminance range allows to measure up to about 100000lux, but above 64000lux the precision starts to drop.

A smaller illuminance range increases the resolution of the data. A longer integration time will result in less noise on the data.

If the actual measure illuminance is out-of-range then the current illuminance range maximum +0.01lux is reported by GetIlluminance and the RegisterIlluminanceCallback callback. For example, 800001 for the 0-8000lux range.

With a long integration time the sensor might be saturated before the measured value reaches the maximum of the selected illuminance range. In this case 0lux is reported by GetIlluminance and the RegisterIlluminanceCallback callback.

If the measurement is out-of-range or the sensor is saturated then you should configure the next higher illuminance range. If the highest range is already in use, then start to reduce the integration time.

Associated constants:

  • IlluminanceRangeUnlimited
  • IlluminanceRange64000Lux
  • IlluminanceRange32000Lux
  • IlluminanceRange16000Lux
  • IlluminanceRange8000Lux
  • IlluminanceRange1300Lux
  • IlluminanceRange600Lux
  • IntegrationTime50ms
  • IntegrationTime100ms
  • IntegrationTime150ms
  • IntegrationTime200ms
  • IntegrationTime250ms
  • IntegrationTime300ms
  • IntegrationTime350ms
  • IntegrationTime400ms

func (*AmbientLightV3Bricklet) SetIlluminanceCallbackConfiguration 

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

The period 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.

Associated constants:

  • ThresholdOptionOff
  • ThresholdOptionOutside
  • ThresholdOptionInside
  • ThresholdOptionSmaller
  • ThresholdOptionGreater

func (*AmbientLightV3Bricklet) SetResponseExpected 

func (device *AmbientLightV3Bricklet) 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 (*AmbientLightV3Bricklet) SetResponseExpectedAll 

func (device *AmbientLightV3Bricklet) SetResponseExpectedAll(responseExpected bool)

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

func (*AmbientLightV3Bricklet) SetStatusLEDConfig 

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

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

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

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

type Function = uint8
const (
	FunctionGetIlluminance                      Function = 1
	FunctionSetIlluminanceCallbackConfiguration Function = 2
	FunctionGetIlluminanceCallbackConfiguration Function = 3
	FunctionSetConfiguration                    Function = 5
	FunctionGetConfiguration                    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
	FunctionCallbackIlluminance                 Function = 4
)

type IlluminanceRange 

type IlluminanceRange = uint8
const (
	IlluminanceRangeUnlimited IlluminanceRange = 6
	IlluminanceRange64000Lux  IlluminanceRange = 0
	IlluminanceRange32000Lux  IlluminanceRange = 1
	IlluminanceRange16000Lux  IlluminanceRange = 2
	IlluminanceRange8000Lux   IlluminanceRange = 3
	IlluminanceRange1300Lux   IlluminanceRange = 4
	IlluminanceRange600Lux    IlluminanceRange = 5
)

type IntegrationTime 

type IntegrationTime = uint8
const (
	IntegrationTime50ms  IntegrationTime = 0
	IntegrationTime100ms IntegrationTime = 1
	IntegrationTime150ms IntegrationTime = 2
	IntegrationTime200ms IntegrationTime = 3
	IntegrationTime250ms IntegrationTime = 4
	IntegrationTime300ms IntegrationTime = 5
	IntegrationTime350ms IntegrationTime = 6
	IntegrationTime400ms IntegrationTime = 7
)

type StatusLEDConfig 

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

type ThresholdOption 

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

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.