energy_monitor_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 Voltage, Current, Energy, Real/Apparent/Reactive Power, Power Factor and Frequency.

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

Index

Constants

View Source 
const DeviceDisplayName = "Energy Monitor Bricklet"
View Source 
const DeviceIdentifier = 2152

Variables

This section is empty.

Functions

This section is empty.

Types

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 EnergyMonitorBricklet 

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

func New 

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

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

func (*EnergyMonitorBricklet) CalibrateOffset 

func (device *EnergyMonitorBricklet) CalibrateOffset() (err error)

Calling this function will start an offset calibration. The offset calibration will integrate the voltage and current waveform over a longer time period to find the 0 transition point in the sine wave.

The Bricklet comes with a factory-calibrated offset value, you should not have to call this function.

If you want to re-calibrate the offset we recommend that you connect a load that has a smooth sinusoidal voltage and current waveform. Alternatively you can also short both inputs.

The calibration is saved in non-volatile memory, you only have to set it once.

func (*EnergyMonitorBricklet) DeregisterEnergyDataCallback 

func (device *EnergyMonitorBricklet) DeregisterEnergyDataCallback(registrationId uint64)

Remove a registered Energy Data callback.

func (*EnergyMonitorBricklet) GetAPIVersion 

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

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

Returns the current bootloader mode, see SetBootloaderMode.

Associated constants:

  • BootloaderModeBootloader
  • BootloaderModeFirmware
  • BootloaderModeBootloaderWaitForReboot
  • BootloaderModeFirmwareWaitForReboot
  • BootloaderModeFirmwareWaitForEraseAndReboot

func (*EnergyMonitorBricklet) GetChipTemperature 

func (device *EnergyMonitorBricklet) 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 (*EnergyMonitorBricklet) GetEnergyData 

func (device *EnergyMonitorBricklet) GetEnergyData() (voltage int32, current int32, energy int32, realPower int32, apparentPower int32, reactivePower int32, powerFactor uint16, frequency uint16, err error)

Returns all of the measurements that are done by the Energy Monitor Bricklet.

* Voltage RMS * Current RMS * Energy (integrated over time) * Real Power * Apparent Power * Reactive Power * Power Factor * Frequency (AC Frequency of the mains voltage)

The frequency is recalculated every 6 seconds.

All other values are integrated over 10 zero-crossings of the voltage sine wave. With a standard AC mains voltage frequency of 50Hz this results in a 5 measurements per second (or an integration time of 200ms per measurement).

If no voltage transformer is connected, the Bricklet will use the current waveform to calculate the frequency and it will use an integration time of 10 zero-crossings of the current waveform.

func (*EnergyMonitorBricklet) GetEnergyDataCallbackConfiguration 

func (device *EnergyMonitorBricklet) GetEnergyDataCallbackConfiguration() (period uint32, valueHasToChange bool, err error)

Returns the callback configuration as set by SetEnergyDataCallbackConfiguration.

func (*EnergyMonitorBricklet) GetIdentity 

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

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

func (device *EnergyMonitorBricklet) 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 (*EnergyMonitorBricklet) GetStatusLEDConfig 

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

Returns the configuration as set by SetStatusLEDConfig

Associated constants:

  • StatusLEDConfigOff
  • StatusLEDConfigOn
  • StatusLEDConfigShowHeartbeat
  • StatusLEDConfigShowStatus

func (*EnergyMonitorBricklet) GetTransformerCalibration 

func (device *EnergyMonitorBricklet) GetTransformerCalibration() (voltageRatio uint16, currentRatio uint16, phaseShift int16, err error)

Returns the transformer calibration as set by SetTransformerCalibration.

func (*EnergyMonitorBricklet) GetTransformerStatus 

func (device *EnergyMonitorBricklet) GetTransformerStatus() (voltageTransformerConnected bool, currentTransformerConnected bool, err error)

Returns *true* if a voltage/current transformer is connected to the Bricklet.

func (*EnergyMonitorBricklet) GetWaveform 

func (device *EnergyMonitorBricklet) GetWaveform() (waveform []int16, err error)

Returns a snapshot of the voltage and current waveform. The values in the returned array alternate between voltage and current. The data from one getter call contains 768 data points for voltage and current, which correspond to about 3 full sine waves.

The voltage is given with a resolution of 100mV and the current is given with a resolution of 10mA.

This data is meant to be used for a non-realtime graphical representation of the voltage and current waveforms.

func (*EnergyMonitorBricklet) GetWaveformLowLevel 

func (device *EnergyMonitorBricklet) GetWaveformLowLevel() (waveformChunkOffset uint16, waveformChunkData [30]int16, err error)

Returns a snapshot of the voltage and current waveform. The values in the returned array alternate between voltage and current. The data from one getter call contains 768 data points for voltage and current, which correspond to about 3 full sine waves.

The voltage is given with a resolution of 100mV and the current is given with a resolution of 10mA.

This data is meant to be used for a non-realtime graphical representation of the voltage and current waveforms.

func (*EnergyMonitorBricklet) ReadUID 

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

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

func (*EnergyMonitorBricklet) RegisterEnergyDataCallback 

func (device *EnergyMonitorBricklet) RegisterEnergyDataCallback(fn func(int32, int32, int32, int32, int32, int32, uint16, uint16)) uint64

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

The parameters are the same as GetEnergyData.

func (*EnergyMonitorBricklet) Reset 

func (device *EnergyMonitorBricklet) 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 (*EnergyMonitorBricklet) ResetEnergy 

func (device *EnergyMonitorBricklet) ResetEnergy() (err error)

Sets the energy value (see GetEnergyData) back to 0Wh.

func (*EnergyMonitorBricklet) SetBootloaderMode 

func (device *EnergyMonitorBricklet) 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 (*EnergyMonitorBricklet) SetEnergyDataCallbackConfiguration 

func (device *EnergyMonitorBricklet) SetEnergyDataCallbackConfiguration(period uint32, valueHasToChange bool) (err error)

The period is the period with which the RegisterEnergyDataCallback 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.

func (*EnergyMonitorBricklet) SetResponseExpected 

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

func (device *EnergyMonitorBricklet) SetResponseExpectedAll(responseExpected bool)

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

func (*EnergyMonitorBricklet) SetStatusLEDConfig 

func (device *EnergyMonitorBricklet) 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 (*EnergyMonitorBricklet) SetTransformerCalibration 

func (device *EnergyMonitorBricklet) SetTransformerCalibration(voltageRatio uint16, currentRatio uint16, phaseShift int16) (err error)

Sets the transformer ratio for the voltage and current transformer in 1/100 form.

Example: If your mains voltage is 230V, you use 9V voltage transformer and a 1V:30A current clamp your voltage ratio is 230/9 = 25.56 and your current ratio is 30/1 = 30.

In this case you have to set the values 2556 and 3000 for voltage ratio and current ratio.

The calibration is saved in non-volatile memory, you only have to set it once.

Set the phase shift to 0. It is for future use and currently not supported by the Bricklet.

func (*EnergyMonitorBricklet) SetWriteFirmwarePointer 

func (device *EnergyMonitorBricklet) 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 (*EnergyMonitorBricklet) WriteFirmware 

func (device *EnergyMonitorBricklet) 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 (*EnergyMonitorBricklet) WriteUID 

func (device *EnergyMonitorBricklet) 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 Function 

type Function = uint8
const (
	FunctionGetEnergyData                      Function = 1
	FunctionResetEnergy                        Function = 2
	FunctionGetWaveformLowLevel                Function = 3
	FunctionGetTransformerStatus               Function = 4
	FunctionSetTransformerCalibration          Function = 5
	FunctionGetTransformerCalibration          Function = 6
	FunctionCalibrateOffset                    Function = 7
	FunctionSetEnergyDataCallbackConfiguration Function = 8
	FunctionGetEnergyDataCallbackConfiguration Function = 9
	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
	FunctionCallbackEnergyData                 Function = 10
)

type StatusLEDConfig 

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

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.