temperature_bricklet

package
Version: v0.0.0-...-8a98e63 Latest Latest
Warning

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

Go to latest
Published: May 11, 2022 License: CC0-1.0 Imports: 5 Imported by: 0

Documentation

Overview

Measures ambient temperature with 0.5°C accuracy.

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

Index

Constants

View Source
const DeviceDisplayName = "Temperature Bricklet"
View Source
const DeviceIdentifier = 216

Variables

This section is empty.

Functions

This section is empty.

Types

type Function

type Function = uint8
const (
	FunctionGetTemperature                  Function = 1
	FunctionSetTemperatureCallbackPeriod    Function = 2
	FunctionGetTemperatureCallbackPeriod    Function = 3
	FunctionSetTemperatureCallbackThreshold Function = 4
	FunctionGetTemperatureCallbackThreshold Function = 5
	FunctionSetDebouncePeriod               Function = 6
	FunctionGetDebouncePeriod               Function = 7
	FunctionSetI2CMode                      Function = 10
	FunctionGetI2CMode                      Function = 11
	FunctionGetIdentity                     Function = 255
	FunctionCallbackTemperature             Function = 8
	FunctionCallbackTemperatureReached      Function = 9
)

type I2CMode

type I2CMode = uint8
const (
	I2CModeFast I2CMode = 0
	I2CModeSlow I2CMode = 1
)

type TemperatureBricklet

type TemperatureBricklet 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 (*TemperatureBricklet) DeregisterTemperatureCallback

func (device *TemperatureBricklet) DeregisterTemperatureCallback(registrationId uint64)

Remove a registered Temperature callback.

func (*TemperatureBricklet) DeregisterTemperatureReachedCallback

func (device *TemperatureBricklet) DeregisterTemperatureReachedCallback(registrationId uint64)

Remove a registered Temperature Reached callback.

func (*TemperatureBricklet) GetAPIVersion

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

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

Returns the debounce period as set by SetDebouncePeriod.

func (*TemperatureBricklet) GetI2CMode

func (device *TemperatureBricklet) GetI2CMode() (mode I2CMode, err error)

Returns the I2C mode as set by SetI2CMode.

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

Associated constants:

* I2CModeFast
* I2CModeSlow

func (*TemperatureBricklet) GetIdentity

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

func (device *TemperatureBricklet) 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 (*TemperatureBricklet) GetTemperature

func (device *TemperatureBricklet) GetTemperature() (temperature int16, err error)

Returns the temperature of the sensor.

If you want to get the temperature periodically, it is recommended to use the RegisterTemperatureCallback callback and set the period with SetTemperatureCallbackPeriod.

func (*TemperatureBricklet) GetTemperatureCallbackPeriod

func (device *TemperatureBricklet) GetTemperatureCallbackPeriod() (period uint32, err error)

Returns the period as set by SetTemperatureCallbackPeriod.

func (*TemperatureBricklet) GetTemperatureCallbackThreshold

func (device *TemperatureBricklet) GetTemperatureCallbackThreshold() (option ThresholdOption, min int16, max int16, err error)

Returns the threshold as set by SetTemperatureCallbackThreshold.

Associated constants:

* ThresholdOptionOff
* ThresholdOptionOutside
* ThresholdOptionInside
* ThresholdOptionSmaller
* ThresholdOptionGreater

func (*TemperatureBricklet) RegisterTemperatureCallback

func (device *TemperatureBricklet) RegisterTemperatureCallback(fn func(int16)) uint64

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

The RegisterTemperatureCallback callback is only triggered if the temperature has changed since the last triggering.

func (*TemperatureBricklet) RegisterTemperatureReachedCallback

func (device *TemperatureBricklet) RegisterTemperatureReachedCallback(fn func(int16)) uint64

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

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

func (*TemperatureBricklet) SetDebouncePeriod

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

Sets the period with which the threshold callback

* RegisterTemperatureReachedCallback

is triggered, if the threshold

* SetTemperatureCallbackThreshold

keeps being reached.

func (*TemperatureBricklet) SetI2CMode

func (device *TemperatureBricklet) SetI2CMode(mode I2CMode) (err error)

Sets the I2C mode. Possible modes are:

* 0: Fast (400kHz) * 1: Slow (100kHz)

If you have problems with obvious outliers in the Temperature Bricklet measurements, they may be caused by EMI issues. In this case it may be helpful to lower the I2C speed.

It is however not recommended to lower the I2C speed in applications where a high throughput needs to be achieved.

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

Associated constants:

* I2CModeFast
* I2CModeSlow

func (*TemperatureBricklet) SetResponseExpected

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

func (device *TemperatureBricklet) SetResponseExpectedAll(responseExpected bool)

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

func (*TemperatureBricklet) SetTemperatureCallbackPeriod

func (device *TemperatureBricklet) SetTemperatureCallbackPeriod(period uint32) (err error)

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

The RegisterTemperatureCallback callback is only triggered if the temperature has changed since the last triggering.

func (*TemperatureBricklet) SetTemperatureCallbackThreshold

func (device *TemperatureBricklet) SetTemperatureCallbackThreshold(option ThresholdOption, min int16, max int16) (err error)

Sets the thresholds for the RegisterTemperatureReachedCallback callback.

The following options are possible:

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

Associated constants:

* ThresholdOptionOff
* ThresholdOptionOutside
* ThresholdOptionInside
* ThresholdOptionSmaller
* ThresholdOptionGreater

type ThresholdOption

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

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL