thermocouple_bricklet

package
Version: v0.0.0-...-d0a6af2 Latest Latest
Warning

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

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

Documentation

Overview

Measures temperature with thermocouples.

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

Index

Constants

View Source
const DeviceDisplayName = "Thermocouple Bricklet"
View Source
const DeviceIdentifier = 266

Variables

This section is empty.

Functions

This section is empty.

Types

type Averaging

type Averaging = uint8
const (
	Averaging1  Averaging = 1
	Averaging2  Averaging = 2
	Averaging4  Averaging = 4
	Averaging8  Averaging = 8
	Averaging16 Averaging = 16
)

type FilterOption

type FilterOption = uint8
const (
	FilterOption50Hz FilterOption = 0
	FilterOption60Hz FilterOption = 1
)

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
	FunctionSetConfiguration                Function = 10
	FunctionGetConfiguration                Function = 11
	FunctionGetErrorState                   Function = 12
	FunctionGetIdentity                     Function = 255
	FunctionCallbackTemperature             Function = 8
	FunctionCallbackTemperatureReached      Function = 9
	FunctionCallbackErrorState              Function = 13
)

type ThermocoupleBricklet

type ThermocoupleBricklet 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 (*ThermocoupleBricklet) DeregisterErrorStateCallback

func (device *ThermocoupleBricklet) DeregisterErrorStateCallback(registrationId uint64)

Remove a registered Error State callback.

func (*ThermocoupleBricklet) DeregisterTemperatureCallback

func (device *ThermocoupleBricklet) DeregisterTemperatureCallback(registrationId uint64)

Remove a registered Temperature callback.

func (*ThermocoupleBricklet) DeregisterTemperatureReachedCallback

func (device *ThermocoupleBricklet) DeregisterTemperatureReachedCallback(registrationId uint64)

Remove a registered Temperature Reached callback.

func (*ThermocoupleBricklet) GetAPIVersion

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

func (device *ThermocoupleBricklet) GetConfiguration() (averaging Averaging, thermocoupleType Type, filter FilterOption, err error)

Returns the configuration as set by SetConfiguration.

Associated constants:

  • Averaging1
  • Averaging2
  • Averaging4
  • Averaging8
  • Averaging16
  • TypeB
  • TypeE
  • TypeJ
  • TypeK
  • TypeN
  • TypeR
  • TypeS
  • TypeT
  • TypeG8
  • TypeG32
  • FilterOption50Hz
  • FilterOption60Hz

func (*ThermocoupleBricklet) GetDebouncePeriod

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

Returns the debounce period as set by SetDebouncePeriod.

func (*ThermocoupleBricklet) GetErrorState

func (device *ThermocoupleBricklet) GetErrorState() (overUnder bool, openCircuit bool, err error)

Returns the current error state. There are two possible errors:

* Over/Under Voltage and * Open Circuit.

Over/Under Voltage happens for voltages below 0V or above 3.3V. In this case it is very likely that your thermocouple is defective. An Open Circuit error indicates that there is no thermocouple connected.

You can use the RegisterErrorStateCallback callback to automatically get triggered when the error state changes.

func (*ThermocoupleBricklet) GetIdentity

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

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

func (device *ThermocoupleBricklet) GetTemperature() (temperature int32, err error)

Returns the temperature of the thermocouple.

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

func (*ThermocoupleBricklet) GetTemperatureCallbackPeriod

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

Returns the period as set by SetTemperatureCallbackPeriod.

func (*ThermocoupleBricklet) GetTemperatureCallbackThreshold

func (device *ThermocoupleBricklet) GetTemperatureCallbackThreshold() (option ThresholdOption, min int32, max int32, err error)

Returns the threshold as set by SetTemperatureCallbackThreshold.

Associated constants:

  • ThresholdOptionOff
  • ThresholdOptionOutside
  • ThresholdOptionInside
  • ThresholdOptionSmaller
  • ThresholdOptionGreater

func (*ThermocoupleBricklet) RegisterErrorStateCallback

func (device *ThermocoupleBricklet) RegisterErrorStateCallback(fn func(bool, bool)) uint64

This Callback is triggered every time the error state changes (see GetErrorState).

func (*ThermocoupleBricklet) RegisterTemperatureCallback

func (device *ThermocoupleBricklet) RegisterTemperatureCallback(fn func(int32)) uint64

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

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

func (*ThermocoupleBricklet) RegisterTemperatureReachedCallback

func (device *ThermocoupleBricklet) RegisterTemperatureReachedCallback(fn func(int32)) uint64

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

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

func (*ThermocoupleBricklet) SetConfiguration

func (device *ThermocoupleBricklet) SetConfiguration(averaging Averaging, thermocoupleType Type, filter FilterOption) (err error)

You can configure averaging size, thermocouple type and frequency filtering.

Available averaging sizes are 1, 2, 4, 8 and 16 samples.

As thermocouple type you can use B, E, J, K, N, R, S and T. If you have a different thermocouple or a custom thermocouple you can also use G8 and G32. With these types the returned value will not be in °C/100, it will be calculated by the following formulas:

* G8: “value = 8 * 1.6 * 2^17 * Vin“ * G32: “value = 32 * 1.6 * 2^17 * Vin“

where Vin is the thermocouple input voltage.

The frequency filter can be either configured to 50Hz or to 60Hz. You should configure it according to your utility frequency.

The conversion time depends on the averaging and filter configuration, it can be calculated as follows:

* 60Hz: “time = 82 + (samples - 1) * 16.67“ * 50Hz: “time = 98 + (samples - 1) * 20“

Associated constants:

  • Averaging1
  • Averaging2
  • Averaging4
  • Averaging8
  • Averaging16
  • TypeB
  • TypeE
  • TypeJ
  • TypeK
  • TypeN
  • TypeR
  • TypeS
  • TypeT
  • TypeG8
  • TypeG32
  • FilterOption50Hz
  • FilterOption60Hz

func (*ThermocoupleBricklet) SetDebouncePeriod

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

Sets the period with which the threshold callback

* RegisterTemperatureReachedCallback

is triggered, if the threshold

* SetTemperatureCallbackThreshold

keeps being reached.

func (*ThermocoupleBricklet) SetResponseExpected

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

func (device *ThermocoupleBricklet) SetResponseExpectedAll(responseExpected bool)

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

func (*ThermocoupleBricklet) SetTemperatureCallbackPeriod

func (device *ThermocoupleBricklet) 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 (*ThermocoupleBricklet) SetTemperatureCallbackThreshold

func (device *ThermocoupleBricklet) SetTemperatureCallbackThreshold(option ThresholdOption, min int32, max int32) (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 = '>'
)

type Type

type Type = uint8
const (
	TypeB   Type = 0
	TypeE   Type = 1
	TypeJ   Type = 2
	TypeK   Type = 3
	TypeN   Type = 4
	TypeR   Type = 5
	TypeS   Type = 6
	TypeT   Type = 7
	TypeG8  Type = 8
	TypeG32 Type = 9
)

Jump to

Keyboard shortcuts

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