Documentation

Overview

Measures reflectivity of a surface.

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

Index

Constants

View Source
const DeviceDisplayName = "Line Bricklet"
View Source
const DeviceIdentifier = 241

Variables

This section is empty.

Functions

This section is empty.

Types

type Function

type Function = uint8
const (
	FunctionGetReflectivity                  Function = 1
	FunctionSetReflectivityCallbackPeriod    Function = 2
	FunctionGetReflectivityCallbackPeriod    Function = 3
	FunctionSetReflectivityCallbackThreshold Function = 4
	FunctionGetReflectivityCallbackThreshold Function = 5
	FunctionSetDebouncePeriod                Function = 6
	FunctionGetDebouncePeriod                Function = 7
	FunctionGetIdentity                      Function = 255
	FunctionCallbackReflectivity             Function = 8
	FunctionCallbackReflectivityReached      Function = 9
)

type LineBricklet

type LineBricklet 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 (*LineBricklet) DeregisterReflectivityCallback

func (device *LineBricklet) DeregisterReflectivityCallback(registrationId uint64)

Remove a registered Reflectivity callback.

func (*LineBricklet) DeregisterReflectivityReachedCallback

func (device *LineBricklet) DeregisterReflectivityReachedCallback(registrationId uint64)

Remove a registered Reflectivity Reached callback.

func (*LineBricklet) GetAPIVersion

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

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

Returns the debounce period as set by SetDebouncePeriod.

func (*LineBricklet) GetIdentity

func (device *LineBricklet) 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 (*LineBricklet) GetReflectivity

func (device *LineBricklet) GetReflectivity() (reflectivity uint16, err error)

Returns the currently measured reflectivity. The reflectivity is a value between 0 (not reflective) and 4095 (very reflective).

Usually black has a low reflectivity while white has a high reflectivity.

If you want to get the reflectivity periodically, it is recommended to use the RegisterReflectivityCallback callback and set the period with SetReflectivityCallbackPeriod.

func (*LineBricklet) GetReflectivityCallbackPeriod

func (device *LineBricklet) GetReflectivityCallbackPeriod() (period uint32, err error)

Returns the period as set by SetReflectivityCallbackPeriod.

func (*LineBricklet) GetReflectivityCallbackThreshold

func (device *LineBricklet) GetReflectivityCallbackThreshold() (option ThresholdOption, min uint16, max uint16, err error)

Returns the threshold as set by SetReflectivityCallbackThreshold.

Associated constants:

* ThresholdOptionOff
* ThresholdOptionOutside
* ThresholdOptionInside
* ThresholdOptionSmaller
* ThresholdOptionGreater

func (*LineBricklet) GetResponseExpected

func (device *LineBricklet) 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 (*LineBricklet) RegisterReflectivityCallback

func (device *LineBricklet) RegisterReflectivityCallback(fn func(uint16)) uint64

This callback is triggered periodically with the period that is set by SetReflectivityCallbackPeriod. The parameter is the reflectivity of the sensor.

The RegisterReflectivityCallback callback is only triggered if the reflectivity has changed since the last triggering.

func (*LineBricklet) RegisterReflectivityReachedCallback

func (device *LineBricklet) RegisterReflectivityReachedCallback(fn func(uint16)) uint64

This callback is triggered when the threshold as set by SetReflectivityCallbackThreshold is reached. The parameter is the reflectivity of the sensor.

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

func (*LineBricklet) SetDebouncePeriod

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

Sets the period with which the threshold callback

* RegisterReflectivityReachedCallback

is triggered, if the threshold

* SetReflectivityCallbackThreshold

keeps being reached.

func (*LineBricklet) SetReflectivityCallbackPeriod

func (device *LineBricklet) SetReflectivityCallbackPeriod(period uint32) (err error)

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

The RegisterReflectivityCallback callback is only triggered if the reflectivity has changed since the last triggering.

func (*LineBricklet) SetReflectivityCallbackThreshold

func (device *LineBricklet) SetReflectivityCallbackThreshold(option ThresholdOption, min uint16, max uint16) (err error)

Sets the thresholds for the RegisterReflectivityReachedCallback callback.

The following options are possible:

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

Associated constants:

* ThresholdOptionOff
* ThresholdOptionOutside
* ThresholdOptionInside
* ThresholdOptionSmaller
* ThresholdOptionGreater

func (*LineBricklet) SetResponseExpected

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

func (device *LineBricklet) SetResponseExpectedAll(responseExpected bool)

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

type ThresholdOption

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