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

package uv_light_bricklet

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

Measures UV light.

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

Index

Package Files

uv_light_bricklet.go

Constants

const DeviceDisplayName = "UV Light Bricklet"
const DeviceIdentifier = 265

type Function Uses

type Function = uint8
const (
    FunctionGetUVLight                  Function = 1
    FunctionSetUVLightCallbackPeriod    Function = 2
    FunctionGetUVLightCallbackPeriod    Function = 3
    FunctionSetUVLightCallbackThreshold Function = 4
    FunctionGetUVLightCallbackThreshold Function = 5
    FunctionSetDebouncePeriod           Function = 6
    FunctionGetDebouncePeriod           Function = 7
    FunctionGetIdentity                 Function = 255
    FunctionCallbackUVLight             Function = 8
    FunctionCallbackUVLightReached      Function = 9
)

type ThresholdOption Uses

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

type UVLightBricklet Uses

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

func New Uses

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

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

func (*UVLightBricklet) DeregisterUVLightCallback Uses

func (device *UVLightBricklet) DeregisterUVLightCallback(registrationId uint64)

Remove a registered UV Light callback.

func (*UVLightBricklet) DeregisterUVLightReachedCallback Uses

func (device *UVLightBricklet) DeregisterUVLightReachedCallback(registrationId uint64)

Remove a registered UV Light Reached callback.

func (*UVLightBricklet) GetAPIVersion Uses

func (device *UVLightBricklet) 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 (*UVLightBricklet) GetDebouncePeriod Uses

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

Returns the debounce period as set by SetDebouncePeriod.

func (*UVLightBricklet) GetIdentity Uses

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

func (device *UVLightBricklet) 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 (*UVLightBricklet) GetUVLight Uses

func (device *UVLightBricklet) GetUVLight() (uvLight uint32, err error)

Returns the UV light intensity of the sensor, the intensity is given in 1/10 mW/m². The sensor has already weighted the intensity with the erythemal action spectrum to get the skin-affecting irradiation.

To get UV index you just have to divide the value by 250. For example, a UV light intensity of 500 is equivalent to an UV index of 2.

If you want to get the intensity periodically, it is recommended to use the RegisterUVLightCallback callback and set the period with SetUVLightCallbackPeriod.

func (*UVLightBricklet) GetUVLightCallbackPeriod Uses

func (device *UVLightBricklet) GetUVLightCallbackPeriod() (period uint32, err error)

Returns the period as set by SetUVLightCallbackPeriod.

func (*UVLightBricklet) GetUVLightCallbackThreshold Uses

func (device *UVLightBricklet) GetUVLightCallbackThreshold() (option ThresholdOption, min uint32, max uint32, err error)

Returns the threshold as set by SetUVLightCallbackThreshold.

Associated constants:

* ThresholdOptionOff
* ThresholdOptionOutside
* ThresholdOptionInside
* ThresholdOptionSmaller
* ThresholdOptionGreater

func (*UVLightBricklet) RegisterUVLightCallback Uses

func (device *UVLightBricklet) RegisterUVLightCallback(fn func(uint32)) uint64

This callback is triggered periodically with the period that is set by SetUVLightCallbackPeriod. The parameter is the UV Light intensity of the sensor.

The RegisterUVLightCallback callback is only triggered if the intensity has changed since the last triggering.

func (*UVLightBricklet) RegisterUVLightReachedCallback Uses

func (device *UVLightBricklet) RegisterUVLightReachedCallback(fn func(uint32)) uint64

This callback is triggered when the threshold as set by SetUVLightCallbackThreshold is reached. The parameter is the UV Light intensity of the sensor.

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

func (*UVLightBricklet) SetDebouncePeriod Uses

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

Sets the period in ms with which the threshold callbacks

* RegisterUVLightReachedCallback,

are triggered, if the thresholds

* SetUVLightCallbackThreshold,

keep being reached.

The default value is 100.

func (*UVLightBricklet) SetResponseExpected Uses

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

func (device *UVLightBricklet) SetResponseExpectedAll(responseExpected bool)

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

func (*UVLightBricklet) SetUVLightCallbackPeriod Uses

func (device *UVLightBricklet) SetUVLightCallbackPeriod(period uint32) (err error)

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

The RegisterUVLightCallback callback is only triggered if the intensity has changed since the last triggering.

The default value is 0.

func (*UVLightBricklet) SetUVLightCallbackThreshold Uses

func (device *UVLightBricklet) SetUVLightCallbackThreshold(option ThresholdOption, min uint32, max uint32) (err error)

Sets the thresholds for the RegisterUVLightReachedCallback callback.

The following options are possible:

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

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

Associated constants:

* ThresholdOptionOff
* ThresholdOptionOutside
* ThresholdOptionInside
* ThresholdOptionSmaller
* ThresholdOptionGreater

Package uv_light_bricklet imports 4 packages (graph). Updated 2019-09-18. Refresh now. Tools for package owners.