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

package load_cell_v2_bricklet

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

Measures weight with a load cell.

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

Index

Package Files

load_cell_v2_bricklet.go

Constants

const DeviceDisplayName = "Load Cell Bricklet 2.0"
const DeviceIdentifier = 2104

type BootloaderMode Uses

type BootloaderMode = uint8
const (
    BootloaderModeBootloader                    BootloaderMode = 0
    BootloaderModeFirmware                      BootloaderMode = 1
    BootloaderModeBootloaderWaitForReboot       BootloaderMode = 2
    BootloaderModeFirmwareWaitForReboot         BootloaderMode = 3
    BootloaderModeFirmwareWaitForEraseAndReboot BootloaderMode = 4
)

type BootloaderStatus Uses

type BootloaderStatus = uint8
const (
    BootloaderStatusOK                        BootloaderStatus = 0
    BootloaderStatusInvalidMode               BootloaderStatus = 1
    BootloaderStatusNoChange                  BootloaderStatus = 2
    BootloaderStatusEntryFunctionNotPresent   BootloaderStatus = 3
    BootloaderStatusDeviceIdentifierIncorrect BootloaderStatus = 4
    BootloaderStatusCRCMismatch               BootloaderStatus = 5
)

type Function Uses

type Function = uint8
const (
    FunctionGetWeight                      Function = 1
    FunctionSetWeightCallbackConfiguration Function = 2
    FunctionGetWeightCallbackConfiguration Function = 3
    FunctionSetMovingAverage               Function = 5
    FunctionGetMovingAverage               Function = 6
    FunctionSetInfoLEDConfig               Function = 7
    FunctionGetInfoLEDConfig               Function = 8
    FunctionCalibrate                      Function = 9
    FunctionTare                           Function = 10
    FunctionSetConfiguration               Function = 11
    FunctionGetConfiguration               Function = 12
    FunctionGetSPITFPErrorCount            Function = 234
    FunctionSetBootloaderMode              Function = 235
    FunctionGetBootloaderMode              Function = 236
    FunctionSetWriteFirmwarePointer        Function = 237
    FunctionWriteFirmware                  Function = 238
    FunctionSetStatusLEDConfig             Function = 239
    FunctionGetStatusLEDConfig             Function = 240
    FunctionGetChipTemperature             Function = 242
    FunctionReset                          Function = 243
    FunctionWriteUID                       Function = 248
    FunctionReadUID                        Function = 249
    FunctionGetIdentity                    Function = 255
    FunctionCallbackWeight                 Function = 4
)

type Gain Uses

type Gain = uint8
const (
    Gain128x Gain = 0
    Gain64x  Gain = 1
    Gain32x  Gain = 2
)

type InfoLEDConfig Uses

type InfoLEDConfig = uint8
const (
    InfoLEDConfigOff           InfoLEDConfig = 0
    InfoLEDConfigOn            InfoLEDConfig = 1
    InfoLEDConfigShowHeartbeat InfoLEDConfig = 2
)

type LoadCellV2Bricklet Uses

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

func New Uses

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

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

func (*LoadCellV2Bricklet) Calibrate Uses

func (device *LoadCellV2Bricklet) Calibrate(weight uint32) (err error)

To calibrate your Load Cell Bricklet 2.0 you have to

* empty the scale and call this function with 0 and * add a known weight to the scale and call this function with the weight.

The calibration is saved in the flash of the Bricklet and only needs to be done once.

We recommend to use the Brick Viewer for calibration, you don't need to call this function in your source code.

func (*LoadCellV2Bricklet) DeregisterWeightCallback Uses

func (device *LoadCellV2Bricklet) DeregisterWeightCallback(registrationId uint64)

Remove a registered Weight callback.

func (*LoadCellV2Bricklet) GetAPIVersion Uses

func (device *LoadCellV2Bricklet) 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 (*LoadCellV2Bricklet) GetBootloaderMode Uses

func (device *LoadCellV2Bricklet) GetBootloaderMode() (mode BootloaderMode, err error)

Returns the current bootloader mode, see SetBootloaderMode.

Associated constants:

* BootloaderModeBootloader
* BootloaderModeFirmware
* BootloaderModeBootloaderWaitForReboot
* BootloaderModeFirmwareWaitForReboot
* BootloaderModeFirmwareWaitForEraseAndReboot

func (*LoadCellV2Bricklet) GetChipTemperature Uses

func (device *LoadCellV2Bricklet) GetChipTemperature() (temperature int16, err error)

Returns the temperature as measured inside the microcontroller. The value returned is not the ambient temperature!

The temperature is only proportional to the real temperature and it has bad accuracy. Practically it is only useful as an indicator for temperature changes.

func (*LoadCellV2Bricklet) GetConfiguration Uses

func (device *LoadCellV2Bricklet) GetConfiguration() (rate Rate, gain Gain, err error)

Returns the configuration as set by SetConfiguration.

Associated constants:

* Rate10Hz
* Rate80Hz
* Gain128x
* Gain64x
* Gain32x

func (*LoadCellV2Bricklet) GetIdentity Uses

func (device *LoadCellV2Bricklet) 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). The Raspberry Pi HAT (Zero) Brick is always at position 'i' and the Bricklet connected to an `Isolator Bricklet <isolator_bricklet>` is always as position 'z'.

The device identifier numbers can be found `here <device_identifier>`. |device_identifier_constant|

func (*LoadCellV2Bricklet) GetInfoLEDConfig Uses

func (device *LoadCellV2Bricklet) GetInfoLEDConfig() (config InfoLEDConfig, err error)

Returns the LED configuration as set by SetInfoLEDConfig

Associated constants:

* InfoLEDConfigOff
* InfoLEDConfigOn
* InfoLEDConfigShowHeartbeat

func (*LoadCellV2Bricklet) GetMovingAverage Uses

func (device *LoadCellV2Bricklet) GetMovingAverage() (average uint16, err error)

Returns the length moving average as set by SetMovingAverage.

func (*LoadCellV2Bricklet) GetResponseExpected Uses

func (device *LoadCellV2Bricklet) 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 (*LoadCellV2Bricklet) GetSPITFPErrorCount Uses

func (device *LoadCellV2Bricklet) GetSPITFPErrorCount() (errorCountAckChecksum uint32, errorCountMessageChecksum uint32, errorCountFrame uint32, errorCountOverflow uint32, err error)

Returns the error count for the communication between Brick and Bricklet.

The errors are divided into

* ACK checksum errors, * message checksum errors, * framing errors and * overflow errors.

The errors counts are for errors that occur on the Bricklet side. All Bricks have a similar function that returns the errors on the Brick side.

func (*LoadCellV2Bricklet) GetStatusLEDConfig Uses

func (device *LoadCellV2Bricklet) GetStatusLEDConfig() (config StatusLEDConfig, err error)

Returns the configuration as set by SetStatusLEDConfig

Associated constants:

* StatusLEDConfigOff
* StatusLEDConfigOn
* StatusLEDConfigShowHeartbeat
* StatusLEDConfigShowStatus

func (*LoadCellV2Bricklet) GetWeight Uses

func (device *LoadCellV2Bricklet) GetWeight() (weight int32, err error)

Returns the currently measured weight.

If you want to get the value periodically, it is recommended to use the RegisterWeightCallback callback. You can set the callback configuration with SetWeightCallbackConfiguration.

func (*LoadCellV2Bricklet) GetWeightCallbackConfiguration Uses

func (device *LoadCellV2Bricklet) GetWeightCallbackConfiguration() (period uint32, valueHasToChange bool, option ThresholdOption, min int32, max int32, err error)

Returns the callback configuration as set by SetWeightCallbackConfiguration.

Associated constants:

* ThresholdOptionOff
* ThresholdOptionOutside
* ThresholdOptionInside
* ThresholdOptionSmaller
* ThresholdOptionGreater

func (*LoadCellV2Bricklet) ReadUID Uses

func (device *LoadCellV2Bricklet) ReadUID() (uid uint32, err error)

Returns the current UID as an integer. Encode as Base58 to get the usual string version.

func (*LoadCellV2Bricklet) RegisterWeightCallback Uses

func (device *LoadCellV2Bricklet) RegisterWeightCallback(fn func(int32)) uint64

This callback is triggered periodically according to the configuration set by SetWeightCallbackConfiguration.

The parameter is the same as GetWeight.

func (*LoadCellV2Bricklet) Reset Uses

func (device *LoadCellV2Bricklet) Reset() (err error)

Calling this function will reset the Bricklet. All configurations will be lost.

After a reset you have to create new device objects, calling functions on the existing ones will result in undefined behavior!

func (*LoadCellV2Bricklet) SetBootloaderMode Uses

func (device *LoadCellV2Bricklet) SetBootloaderMode(mode BootloaderMode) (status BootloaderStatus, err error)

Sets the bootloader mode and returns the status after the requested mode change was instigated.

You can change from bootloader mode to firmware mode and vice versa. A change from bootloader mode to firmware mode will only take place if the entry function, device identifier and CRC are present and correct.

This function is used by Brick Viewer during flashing. It should not be necessary to call it in a normal user program.

Associated constants:

* BootloaderModeBootloader
* BootloaderModeFirmware
* BootloaderModeBootloaderWaitForReboot
* BootloaderModeFirmwareWaitForReboot
* BootloaderModeFirmwareWaitForEraseAndReboot
* BootloaderStatusOK
* BootloaderStatusInvalidMode
* BootloaderStatusNoChange
* BootloaderStatusEntryFunctionNotPresent
* BootloaderStatusDeviceIdentifierIncorrect
* BootloaderStatusCRCMismatch

func (*LoadCellV2Bricklet) SetConfiguration Uses

func (device *LoadCellV2Bricklet) SetConfiguration(rate Rate, gain Gain) (err error)

The measurement rate and gain are configurable.

The rate can be either 10Hz or 80Hz. A faster rate will produce more noise. It is additionally possible to add a moving average (see SetMovingAverage) to the measurements.

The gain can be 128x, 64x or 32x. It represents a measurement range of ±20mV, ±40mV and ±80mV respectively. The Load Cell Bricklet uses an excitation voltage of 5V and most load cells use an output of 2mV/V. That means the voltage range is ±15mV for most load cells (i.e. gain of 128x is best). If you don't know what all of this means you should keep it at 128x, it will most likely be correct.

Associated constants:

* Rate10Hz
* Rate80Hz
* Gain128x
* Gain64x
* Gain32x

func (*LoadCellV2Bricklet) SetInfoLEDConfig Uses

func (device *LoadCellV2Bricklet) SetInfoLEDConfig(config InfoLEDConfig) (err error)

Configures the info LED to be either turned off, turned on, or blink in heartbeat mode.

Associated constants:

* InfoLEDConfigOff
* InfoLEDConfigOn
* InfoLEDConfigShowHeartbeat

func (*LoadCellV2Bricklet) SetMovingAverage Uses

func (device *LoadCellV2Bricklet) SetMovingAverage(average uint16) (err error)

Sets the length of a https://en.wikipedia.org/wiki/Moving_average for the weight value.

Setting the length to 1 will turn the averaging off. With less averaging, there is more noise on the data.

func (*LoadCellV2Bricklet) SetResponseExpected Uses

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

func (device *LoadCellV2Bricklet) SetResponseExpectedAll(responseExpected bool)

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

func (*LoadCellV2Bricklet) SetStatusLEDConfig Uses

func (device *LoadCellV2Bricklet) SetStatusLEDConfig(config StatusLEDConfig) (err error)

Sets the status LED configuration. By default the LED shows communication traffic between Brick and Bricklet, it flickers once for every 10 received data packets.

You can also turn the LED permanently on/off or show a heartbeat.

If the Bricklet is in bootloader mode, the LED is will show heartbeat by default.

Associated constants:

* StatusLEDConfigOff
* StatusLEDConfigOn
* StatusLEDConfigShowHeartbeat
* StatusLEDConfigShowStatus

func (*LoadCellV2Bricklet) SetWeightCallbackConfiguration Uses

func (device *LoadCellV2Bricklet) SetWeightCallbackConfiguration(period uint32, valueHasToChange bool, option ThresholdOption, min int32, max int32) (err error)

The period is the period with which the RegisterWeightCallback callback is triggered periodically. A value of 0 turns the callback off.

If the `value has to change`-parameter is set to true, the callback is only triggered after the value has changed. If the value didn't change within the period, the callback is triggered immediately on change.

If it is set to false, the callback is continuously triggered with the period, independent of the value.

It is furthermore possible to constrain the callback with thresholds.

The `option`-parameter together with min/max sets a threshold for the RegisterWeightCallback callback.

The following options are possible:

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

If the option is set to 'x' (threshold turned off) the callback is triggered with the fixed period.

Associated constants:

* ThresholdOptionOff
* ThresholdOptionOutside
* ThresholdOptionInside
* ThresholdOptionSmaller
* ThresholdOptionGreater

func (*LoadCellV2Bricklet) SetWriteFirmwarePointer Uses

func (device *LoadCellV2Bricklet) SetWriteFirmwarePointer(pointer uint32) (err error)

Sets the firmware pointer for WriteFirmware. The pointer has to be increased by chunks of size 64. The data is written to flash every 4 chunks (which equals to one page of size 256).

This function is used by Brick Viewer during flashing. It should not be necessary to call it in a normal user program.

func (*LoadCellV2Bricklet) Tare Uses

func (device *LoadCellV2Bricklet) Tare() (err error)

Sets the currently measured weight as tare weight.

func (*LoadCellV2Bricklet) WriteFirmware Uses

func (device *LoadCellV2Bricklet) WriteFirmware(data [64]uint8) (status uint8, err error)

Writes 64 Bytes of firmware at the position as written by SetWriteFirmwarePointer before. The firmware is written to flash every 4 chunks.

You can only write firmware in bootloader mode.

This function is used by Brick Viewer during flashing. It should not be necessary to call it in a normal user program.

func (*LoadCellV2Bricklet) WriteUID Uses

func (device *LoadCellV2Bricklet) WriteUID(uid uint32) (err error)

Writes a new UID into flash. If you want to set a new UID you have to decode the Base58 encoded UID string into an integer first.

We recommend that you use Brick Viewer to change the UID.

type Rate Uses

type Rate = uint8
const (
    Rate10Hz Rate = 0
    Rate80Hz Rate = 1
)

type StatusLEDConfig Uses

type StatusLEDConfig = uint8
const (
    StatusLEDConfigOff           StatusLEDConfig = 0
    StatusLEDConfigOn            StatusLEDConfig = 1
    StatusLEDConfigShowHeartbeat StatusLEDConfig = 2
    StatusLEDConfigShowStatus    StatusLEDConfig = 3
)

type ThresholdOption Uses

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

Package load_cell_v2_bricklet imports 5 packages (graph). Updated 2020-07-21. Refresh now. Tools for package owners.