ambient_light_v2_bricklet

func (*AmbientLightV2Bricklet) DeregisterIlluminanceCallback ¶

func (device *AmbientLightV2Bricklet) DeregisterIlluminanceCallback(registrationId uint64)

Remove a registered Illuminance callback.

func (*AmbientLightV2Bricklet) DeregisterIlluminanceReachedCallback ¶

func (device *AmbientLightV2Bricklet) DeregisterIlluminanceReachedCallback(registrationId uint64)

Remove a registered Illuminance Reached callback.

func (*AmbientLightV2Bricklet) GetAPIVersion ¶

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

func (device *AmbientLightV2Bricklet) 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 (*AmbientLightV2Bricklet) GetDebouncePeriod ¶

func (device *AmbientLightV2Bricklet) GetDebouncePeriod() (debounce uint32, err error)

Returns the debounce period as set by SetDebouncePeriod.

func (*AmbientLightV2Bricklet) GetIdentity ¶

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

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

.. versionchanged:: 2.0.2$nbsp;(Plugin)

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 light conditions.

If you want to get the illuminance periodically, it is recommended to use the RegisterIlluminanceCallback callback and set the period with SetIlluminanceCallbackPeriod.

func (*AmbientLightV2Bricklet) GetIlluminanceCallbackPeriod ¶

func (device *AmbientLightV2Bricklet) GetIlluminanceCallbackPeriod() (period uint32, err error)

Returns the period as set by SetIlluminanceCallbackPeriod.

func (*AmbientLightV2Bricklet) GetIlluminanceCallbackThreshold ¶

func (device *AmbientLightV2Bricklet) GetIlluminanceCallbackThreshold() (option ThresholdOption, min uint32, max uint32, err error)

Returns the threshold as set by SetIlluminanceCallbackThreshold.

Associated constants:

• ThresholdOptionOff
• ThresholdOptionOutside
• ThresholdOptionInside
• ThresholdOptionSmaller
• ThresholdOptionGreater

func (*AmbientLightV2Bricklet) GetResponseExpected ¶

func (device *AmbientLightV2Bricklet) 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 (*AmbientLightV2Bricklet) RegisterIlluminanceCallback ¶

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

This callback is triggered periodically with the period that is set by SetIlluminanceCallbackPeriod. The parameter is the illuminance of the ambient light sensor.

The RegisterIlluminanceCallback callback is only triggered if the illuminance has changed since the last triggering.

func (*AmbientLightV2Bricklet) RegisterIlluminanceReachedCallback ¶

func (device *AmbientLightV2Bricklet) RegisterIlluminanceReachedCallback(fn func(uint32)) uint64

This callback is triggered when the threshold as set by SetIlluminanceCallbackThreshold is reached. The parameter is the illuminance of the ambient light sensor.

If the threshold keeps being reached, the callback is triggered periodically with the period as set by SetDebouncePeriod.

func (*AmbientLightV2Bricklet) SetConfiguration ¶

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

.. versionadded:: 2.0.2$nbsp;(Plugin)

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.

.. versionchanged:: 2.0.2$nbsp;(Plugin)

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.

.. versionchanged:: 2.0.2$nbsp;(Plugin)

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 (*AmbientLightV2Bricklet) SetDebouncePeriod ¶

func (device *AmbientLightV2Bricklet) SetDebouncePeriod(debounce uint32) (err error)

Sets the period with which the threshold callbacks

* RegisterIlluminanceReachedCallback,

are triggered, if the thresholds

* SetIlluminanceCallbackThreshold,

keep being reached.

func (*AmbientLightV2Bricklet) SetIlluminanceCallbackPeriod ¶

func (device *AmbientLightV2Bricklet) SetIlluminanceCallbackPeriod(period uint32) (err error)

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

The RegisterIlluminanceCallback callback is only triggered if the illuminance has changed since the last triggering.

func (*AmbientLightV2Bricklet) SetIlluminanceCallbackThreshold ¶

func (device *AmbientLightV2Bricklet) SetIlluminanceCallbackThreshold(option ThresholdOption, min uint32, max uint32) (err error)

Sets the thresholds for the RegisterIlluminanceReachedCallback callback.

The following options are possible:

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

Associated constants:

• ThresholdOptionOff
• ThresholdOptionOutside
• ThresholdOptionInside
• ThresholdOptionSmaller
• ThresholdOptionGreater

func (*AmbientLightV2Bricklet) SetResponseExpected ¶

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

func (device *AmbientLightV2Bricklet) SetResponseExpectedAll(responseExpected bool)

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