Documentation ¶
Overview ¶
Measures DC voltage between 0V and 42V.
See also the documentation here: https://www.tinkerforge.com/en/doc/Software/Bricklets/AnalogInV3_Bricklet_Go.html.
Index ¶
- Constants
- type AnalogInV3Bricklet
- func (device *AnalogInV3Bricklet) DeregisterVoltageCallback(registrationId uint64)
- func (device *AnalogInV3Bricklet) GetAPIVersion() [3]uint8
- func (device *AnalogInV3Bricklet) GetBootloaderMode() (mode BootloaderMode, err error)
- func (device *AnalogInV3Bricklet) GetCalibration() (offset int16, multiplier uint16, divisor uint16, err error)
- func (device *AnalogInV3Bricklet) GetChipTemperature() (temperature int16, err error)
- func (device *AnalogInV3Bricklet) GetIdentity() (uid string, connectedUid string, position rune, hardwareVersion [3]uint8, ...)
- func (device *AnalogInV3Bricklet) GetOversampling() (oversampling Oversampling, err error)
- func (device *AnalogInV3Bricklet) GetResponseExpected(functionID Function) (bool, error)
- func (device *AnalogInV3Bricklet) GetSPITFPErrorCount() (errorCountAckChecksum uint32, errorCountMessageChecksum uint32, ...)
- func (device *AnalogInV3Bricklet) GetStatusLEDConfig() (config StatusLEDConfig, err error)
- func (device *AnalogInV3Bricklet) GetVoltage() (voltage uint16, err error)
- func (device *AnalogInV3Bricklet) GetVoltageCallbackConfiguration() (period uint32, valueHasToChange bool, option ThresholdOption, min uint16, ...)
- func (device *AnalogInV3Bricklet) ReadUID() (uid uint32, err error)
- func (device *AnalogInV3Bricklet) RegisterVoltageCallback(fn func(uint16)) uint64
- func (device *AnalogInV3Bricklet) Reset() (err error)
- func (device *AnalogInV3Bricklet) SetBootloaderMode(mode BootloaderMode) (status BootloaderStatus, err error)
- func (device *AnalogInV3Bricklet) SetCalibration(offset int16, multiplier uint16, divisor uint16) (err error)
- func (device *AnalogInV3Bricklet) SetOversampling(oversampling Oversampling) (err error)
- func (device *AnalogInV3Bricklet) SetResponseExpected(functionID Function, responseExpected bool) error
- func (device *AnalogInV3Bricklet) SetResponseExpectedAll(responseExpected bool)
- func (device *AnalogInV3Bricklet) SetStatusLEDConfig(config StatusLEDConfig) (err error)
- func (device *AnalogInV3Bricklet) SetVoltageCallbackConfiguration(period uint32, valueHasToChange bool, option ThresholdOption, min uint16, ...) (err error)
- func (device *AnalogInV3Bricklet) SetWriteFirmwarePointer(pointer uint32) (err error)
- func (device *AnalogInV3Bricklet) WriteFirmware(data [64]uint8) (status uint8, err error)
- func (device *AnalogInV3Bricklet) WriteUID(uid uint32) (err error)
- type BootloaderMode
- type BootloaderStatus
- type Function
- type Oversampling
- type StatusLEDConfig
- type ThresholdOption
Constants ¶
const DeviceDisplayName = "Analog In Bricklet 3.0"
const DeviceIdentifier = 295
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type AnalogInV3Bricklet ¶
type AnalogInV3Bricklet struct {
// contains filtered or unexported fields
}
func New ¶
func New(uid string, ipcon *ipconnection.IPConnection) (AnalogInV3Bricklet, error)
Creates an object with the unique device ID `uid`. This object can then be used after the IP Connection `ipcon` is connected.
func (*AnalogInV3Bricklet) DeregisterVoltageCallback ¶
func (device *AnalogInV3Bricklet) DeregisterVoltageCallback(registrationId uint64)
Remove a registered Voltage callback.
func (*AnalogInV3Bricklet) GetAPIVersion ¶
func (device *AnalogInV3Bricklet) 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 (*AnalogInV3Bricklet) GetBootloaderMode ¶
func (device *AnalogInV3Bricklet) GetBootloaderMode() (mode BootloaderMode, err error)
Returns the current bootloader mode, see SetBootloaderMode.
Associated constants:
- BootloaderModeBootloader
- BootloaderModeFirmware
- BootloaderModeBootloaderWaitForReboot
- BootloaderModeFirmwareWaitForReboot
- BootloaderModeFirmwareWaitForEraseAndReboot
func (*AnalogInV3Bricklet) GetCalibration ¶
func (device *AnalogInV3Bricklet) GetCalibration() (offset int16, multiplier uint16, divisor uint16, err error)
Returns the calibration as set by SetCalibration.
func (*AnalogInV3Bricklet) GetChipTemperature ¶
func (device *AnalogInV3Bricklet) 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 (*AnalogInV3Bricklet) GetIdentity ¶
func (device *AnalogInV3Bricklet) 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 (*AnalogInV3Bricklet) GetOversampling ¶
func (device *AnalogInV3Bricklet) GetOversampling() (oversampling Oversampling, err error)
Returns the oversampling value as set by SetOversampling.
Associated constants:
- Oversampling32
- Oversampling64
- Oversampling128
- Oversampling256
- Oversampling512
- Oversampling1024
- Oversampling2048
- Oversampling4096
- Oversampling8192
- Oversampling16384
func (*AnalogInV3Bricklet) GetResponseExpected ¶
func (device *AnalogInV3Bricklet) 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 (*AnalogInV3Bricklet) GetSPITFPErrorCount ¶
func (device *AnalogInV3Bricklet) 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 (*AnalogInV3Bricklet) GetStatusLEDConfig ¶
func (device *AnalogInV3Bricklet) GetStatusLEDConfig() (config StatusLEDConfig, err error)
Returns the configuration as set by SetStatusLEDConfig
Associated constants:
- StatusLEDConfigOff
- StatusLEDConfigOn
- StatusLEDConfigShowHeartbeat
- StatusLEDConfigShowStatus
func (*AnalogInV3Bricklet) GetVoltage ¶
func (device *AnalogInV3Bricklet) GetVoltage() (voltage uint16, err error)
Returns the measured voltage. The resolution is approximately 10mV to 1mV depending on the oversampling configuration (SetOversampling).
If you want to get the value periodically, it is recommended to use the RegisterVoltageCallback callback. You can set the callback configuration with SetVoltageCallbackConfiguration.
func (*AnalogInV3Bricklet) GetVoltageCallbackConfiguration ¶
func (device *AnalogInV3Bricklet) GetVoltageCallbackConfiguration() (period uint32, valueHasToChange bool, option ThresholdOption, min uint16, max uint16, err error)
Returns the callback configuration as set by SetVoltageCallbackConfiguration.
Associated constants:
- ThresholdOptionOff
- ThresholdOptionOutside
- ThresholdOptionInside
- ThresholdOptionSmaller
- ThresholdOptionGreater
func (*AnalogInV3Bricklet) ReadUID ¶
func (device *AnalogInV3Bricklet) ReadUID() (uid uint32, err error)
Returns the current UID as an integer. Encode as Base58 to get the usual string version.
func (*AnalogInV3Bricklet) RegisterVoltageCallback ¶
func (device *AnalogInV3Bricklet) RegisterVoltageCallback(fn func(uint16)) uint64
This callback is triggered periodically according to the configuration set by SetVoltageCallbackConfiguration.
The parameter is the same as GetVoltage.
func (*AnalogInV3Bricklet) Reset ¶
func (device *AnalogInV3Bricklet) 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 (*AnalogInV3Bricklet) SetBootloaderMode ¶
func (device *AnalogInV3Bricklet) 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 (*AnalogInV3Bricklet) SetCalibration ¶
func (device *AnalogInV3Bricklet) SetCalibration(offset int16, multiplier uint16, divisor uint16) (err error)
Sets a calibration for the measured voltage value. The formula for the calibration is as follows::
Calibrated Value = (Value + Offset) * Multiplier / Divisor
We recommend that you use the Brick Viewer to calibrate the Bricklet. The calibration will be saved internally and only has to be done once.
func (*AnalogInV3Bricklet) SetOversampling ¶
func (device *AnalogInV3Bricklet) SetOversampling(oversampling Oversampling) (err error)
Sets the oversampling between 32x and 16384x. The Bricklet takes one 12bit sample every 17.5µs. Thus an oversampling of 32x is equivalent to an integration time of 0.56ms and a oversampling of 16384x is equivalent to an integration time of 286ms.
The oversampling uses the moving average principle. A new value is always calculated once per millisecond.
With increased oversampling the noise decreases. With decreased oversampling the reaction time increases (changes in voltage will be measured faster).
Associated constants:
- Oversampling32
- Oversampling64
- Oversampling128
- Oversampling256
- Oversampling512
- Oversampling1024
- Oversampling2048
- Oversampling4096
- Oversampling8192
- Oversampling16384
func (*AnalogInV3Bricklet) SetResponseExpected ¶
func (device *AnalogInV3Bricklet) 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 (*AnalogInV3Bricklet) SetResponseExpectedAll ¶
func (device *AnalogInV3Bricklet) SetResponseExpectedAll(responseExpected bool)
Changes the response expected flag for all setter and callback configuration functions of this device at once.
func (*AnalogInV3Bricklet) SetStatusLEDConfig ¶
func (device *AnalogInV3Bricklet) 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 (*AnalogInV3Bricklet) SetVoltageCallbackConfiguration ¶
func (device *AnalogInV3Bricklet) SetVoltageCallbackConfiguration(period uint32, valueHasToChange bool, option ThresholdOption, min uint16, max uint16) (err error)
The period is the period with which the RegisterVoltageCallback 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 RegisterVoltageCallback 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 (*AnalogInV3Bricklet) SetWriteFirmwarePointer ¶
func (device *AnalogInV3Bricklet) 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 (*AnalogInV3Bricklet) WriteFirmware ¶
func (device *AnalogInV3Bricklet) 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 (*AnalogInV3Bricklet) WriteUID ¶
func (device *AnalogInV3Bricklet) 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 BootloaderMode ¶
type BootloaderMode = uint8
const ( BootloaderModeBootloader BootloaderMode = 0 BootloaderModeFirmware BootloaderMode = 1 BootloaderModeBootloaderWaitForReboot BootloaderMode = 2 BootloaderModeFirmwareWaitForReboot BootloaderMode = 3 BootloaderModeFirmwareWaitForEraseAndReboot BootloaderMode = 4 )
type BootloaderStatus ¶
type BootloaderStatus = uint8
const ( BootloaderStatusOK BootloaderStatus = 0 BootloaderStatusInvalidMode BootloaderStatus = 1 BootloaderStatusNoChange BootloaderStatus = 2 BootloaderStatusEntryFunctionNotPresent BootloaderStatus = 3 BootloaderStatusDeviceIdentifierIncorrect BootloaderStatus = 4 BootloaderStatusCRCMismatch BootloaderStatus = 5 )
type Function ¶
type Function = uint8
const ( FunctionGetVoltage Function = 1 FunctionSetVoltageCallbackConfiguration Function = 2 FunctionGetVoltageCallbackConfiguration Function = 3 FunctionSetOversampling Function = 5 FunctionGetOversampling Function = 6 FunctionSetCalibration Function = 7 FunctionGetCalibration Function = 8 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 FunctionCallbackVoltage Function = 4 )
type Oversampling ¶
type Oversampling = uint8
const ( Oversampling32 Oversampling = 0 Oversampling64 Oversampling = 1 Oversampling128 Oversampling = 2 Oversampling256 Oversampling = 3 Oversampling512 Oversampling = 4 Oversampling1024 Oversampling = 5 Oversampling2048 Oversampling = 6 Oversampling4096 Oversampling = 7 Oversampling8192 Oversampling = 8 Oversampling16384 Oversampling = 9 )
type StatusLEDConfig ¶
type StatusLEDConfig = uint8
const ( StatusLEDConfigOff StatusLEDConfig = 0 StatusLEDConfigOn StatusLEDConfig = 1 StatusLEDConfigShowHeartbeat StatusLEDConfig = 2 StatusLEDConfigShowStatus StatusLEDConfig = 3 )
type ThresholdOption ¶
type ThresholdOption = rune
const ( ThresholdOptionOff ThresholdOption = 'x' ThresholdOptionOutside ThresholdOption = 'o' ThresholdOptionInside ThresholdOption = 'i' ThresholdOptionSmaller ThresholdOption = '<' ThresholdOptionGreater ThresholdOption = '>' )