current25_bricklet

package
v0.0.0-...-368b749 Latest Latest
Warning

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

 Go to latest Published: Feb 27, 2024 License: CC0-1.0 Imports: 5 Imported by: 0

Documentation

Overview

Measures AC/DC current between -25A and +25A‍.

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

Index

Constants

View Source 
const DeviceDisplayName = "Current25 Bricklet"
View Source 
const DeviceIdentifier = 24

Variables

This section is empty.

Functions

This section is empty.

Types

type Current25Bricklet 

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

func New 

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

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

func (*Current25Bricklet) Calibrate 

func (device *Current25Bricklet) Calibrate() (err error)

Calibrates the 0 value of the sensor. You have to call this function when there is no current present.

The zero point of the current sensor is depending on the exact properties of the analog-to-digital converter, the length of the Bricklet cable and the temperature. Thus, if you change the Brick or the environment in which the Bricklet is used, you might have to recalibrate.

The resulting calibration will be saved on the EEPROM of the Current Bricklet.

func (*Current25Bricklet) DeregisterAnalogValueCallback 

func (device *Current25Bricklet) DeregisterAnalogValueCallback(registrationId uint64)

Remove a registered Analog Value callback.

func (*Current25Bricklet) DeregisterAnalogValueReachedCallback 

func (device *Current25Bricklet) DeregisterAnalogValueReachedCallback(registrationId uint64)

Remove a registered Analog Value Reached callback.

func (*Current25Bricklet) DeregisterCurrentCallback 

func (device *Current25Bricklet) DeregisterCurrentCallback(registrationId uint64)

Remove a registered Current callback.

func (*Current25Bricklet) DeregisterCurrentReachedCallback 

func (device *Current25Bricklet) DeregisterCurrentReachedCallback(registrationId uint64)

Remove a registered Current Reached callback.

func (*Current25Bricklet) DeregisterOverCurrentCallback 

func (device *Current25Bricklet) DeregisterOverCurrentCallback(registrationId uint64)

Remove a registered Over Current callback.

func (*Current25Bricklet) GetAPIVersion 

func (device *Current25Bricklet) 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 (*Current25Bricklet) GetAnalogValue 

func (device *Current25Bricklet) GetAnalogValue() (value uint16, err error)

Returns the value as read by a 12-bit analog-to-digital converter.

Note 

The value returned by GetCurrent is averaged over several samples
to yield less noise, while GetAnalogValue gives back raw
unfiltered analog values. The only reason to use GetAnalogValue is,
if you need the full resolution of the analog-to-digital converter.

If you want the analog value periodically, it is recommended to use the RegisterAnalogValueCallback callback and set the period with SetAnalogValueCallbackPeriod.

func (*Current25Bricklet) GetAnalogValueCallbackPeriod 

func (device *Current25Bricklet) GetAnalogValueCallbackPeriod() (period uint32, err error)

Returns the period as set by SetAnalogValueCallbackPeriod.

func (*Current25Bricklet) GetAnalogValueCallbackThreshold 

func (device *Current25Bricklet) GetAnalogValueCallbackThreshold() (option ThresholdOption, min uint16, max uint16, err error)

Returns the threshold as set by SetAnalogValueCallbackThreshold.

Associated constants:

  • ThresholdOptionOff
  • ThresholdOptionOutside
  • ThresholdOptionInside
  • ThresholdOptionSmaller
  • ThresholdOptionGreater

func (*Current25Bricklet) GetCurrent 

func (device *Current25Bricklet) GetCurrent() (current int16, err error)

Returns the current of the sensor.

If you want to get the current periodically, it is recommended to use the RegisterCurrentCallback callback and set the period with SetCurrentCallbackPeriod.

func (*Current25Bricklet) GetCurrentCallbackPeriod 

func (device *Current25Bricklet) GetCurrentCallbackPeriod() (period uint32, err error)

Returns the period as set by SetCurrentCallbackPeriod.

func (*Current25Bricklet) GetCurrentCallbackThreshold 

func (device *Current25Bricklet) GetCurrentCallbackThreshold() (option ThresholdOption, min int16, max int16, err error)

Returns the threshold as set by SetCurrentCallbackThreshold.

Associated constants:

  • ThresholdOptionOff
  • ThresholdOptionOutside
  • ThresholdOptionInside
  • ThresholdOptionSmaller
  • ThresholdOptionGreater

func (*Current25Bricklet) GetDebouncePeriod 

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

Returns the debounce period as set by SetDebouncePeriod.

func (*Current25Bricklet) GetIdentity 

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

func (device *Current25Bricklet) 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 (*Current25Bricklet) IsOverCurrent 

func (device *Current25Bricklet) IsOverCurrent() (over bool, err error)

Returns *true* if more than 25A were measured.

Note 

To reset this value you have to power cycle the Bricklet.

func (*Current25Bricklet) RegisterAnalogValueCallback 

func (device *Current25Bricklet) RegisterAnalogValueCallback(fn func(uint16)) uint64

This callback is triggered periodically with the period that is set by SetAnalogValueCallbackPeriod. The parameter is the analog value of the sensor.

The RegisterAnalogValueCallback callback is only triggered if the current has changed since the last triggering.

func (*Current25Bricklet) RegisterAnalogValueReachedCallback 

func (device *Current25Bricklet) RegisterAnalogValueReachedCallback(fn func(uint16)) uint64

This callback is triggered when the threshold as set by SetAnalogValueCallbackThreshold is reached. The parameter is the analog value of the sensor.

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

func (*Current25Bricklet) RegisterCurrentCallback 

func (device *Current25Bricklet) RegisterCurrentCallback(fn func(int16)) uint64

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

The RegisterCurrentCallback callback is only triggered if the current has changed since the last triggering.

func (*Current25Bricklet) RegisterCurrentReachedCallback 

func (device *Current25Bricklet) RegisterCurrentReachedCallback(fn func(int16)) uint64

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

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

func (*Current25Bricklet) RegisterOverCurrentCallback 

func (device *Current25Bricklet) RegisterOverCurrentCallback(fn func()) uint64

This callback is triggered when an over current is measured (see IsOverCurrent).

func (*Current25Bricklet) SetAnalogValueCallbackPeriod 

func (device *Current25Bricklet) SetAnalogValueCallbackPeriod(period uint32) (err error)

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

The RegisterAnalogValueCallback callback is only triggered if the analog value has changed since the last triggering.

func (*Current25Bricklet) SetAnalogValueCallbackThreshold 

func (device *Current25Bricklet) SetAnalogValueCallbackThreshold(option ThresholdOption, min uint16, max uint16) (err error)

Sets the thresholds for the RegisterAnalogValueReachedCallback callback.

The following options are possible: 

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

Associated constants:

  • ThresholdOptionOff
  • ThresholdOptionOutside
  • ThresholdOptionInside
  • ThresholdOptionSmaller
  • ThresholdOptionGreater

func (*Current25Bricklet) SetCurrentCallbackPeriod 

func (device *Current25Bricklet) SetCurrentCallbackPeriod(period uint32) (err error)

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

The RegisterCurrentCallback callback is only triggered if the current has changed since the last triggering.

func (*Current25Bricklet) SetCurrentCallbackThreshold 

func (device *Current25Bricklet) SetCurrentCallbackThreshold(option ThresholdOption, min int16, max int16) (err error)

Sets the thresholds for the RegisterCurrentReachedCallback callback.

The following options are possible: 

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

Associated constants:

  • ThresholdOptionOff
  • ThresholdOptionOutside
  • ThresholdOptionInside
  • ThresholdOptionSmaller
  • ThresholdOptionGreater

func (*Current25Bricklet) SetDebouncePeriod 

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

Sets the period with which the threshold callbacks

* RegisterCurrentReachedCallback, * RegisterAnalogValueReachedCallback

are triggered, if the thresholds

* SetCurrentCallbackThreshold, * SetAnalogValueCallbackThreshold

keep being reached.

func (*Current25Bricklet) SetResponseExpected 

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

func (device *Current25Bricklet) SetResponseExpectedAll(responseExpected bool)

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

type Function 

type Function = uint8
const (
	FunctionGetCurrent                      Function = 1
	FunctionCalibrate                       Function = 2
	FunctionIsOverCurrent                   Function = 3
	FunctionGetAnalogValue                  Function = 4
	FunctionSetCurrentCallbackPeriod        Function = 5
	FunctionGetCurrentCallbackPeriod        Function = 6
	FunctionSetAnalogValueCallbackPeriod    Function = 7
	FunctionGetAnalogValueCallbackPeriod    Function = 8
	FunctionSetCurrentCallbackThreshold     Function = 9
	FunctionGetCurrentCallbackThreshold     Function = 10
	FunctionSetAnalogValueCallbackThreshold Function = 11
	FunctionGetAnalogValueCallbackThreshold Function = 12
	FunctionSetDebouncePeriod               Function = 13
	FunctionGetDebouncePeriod               Function = 14
	FunctionGetIdentity                     Function = 255
	FunctionCallbackCurrent                 Function = 15
	FunctionCallbackAnalogValue             Function = 16
	FunctionCallbackCurrentReached          Function = 17
	FunctionCallbackAnalogValueReached      Function = 18
	FunctionCallbackOverCurrent             Function = 19
)

type ThresholdOption 

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

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.