Struct tinkerforge::energy_monitor_bricklet::EnergyMonitorBricklet

pub struct EnergyMonitorBricklet { /* fields omitted */ }

Measures Voltage, Current, Energy, Real/Apparent/Reactive Power, Power Factor and Frequency

Methods

impl EnergyMonitorBricklet

pub const DEVICE_IDENTIFIER: u16

pub const DEVICE_DISPLAY_NAME: &'static str

pub fn new<T: GetRequestSender>(
    uid: &str,
    req_sender: T
) -> EnergyMonitorBricklet

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

pub fn get_response_expected(
    &mut self,
    fun: EnergyMonitorBrickletFunction
) -> Result<bool, GetResponseExpectedError>

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 set_response_expected. 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 send and errors are silently ignored, because they cannot be detected.

See set_response_expected for the list of function ID constants available for this function.

pub fn set_response_expected(
    &mut self,
    fun: EnergyMonitorBrickletFunction,
    response_expected: bool
) -> Result<(), SetResponseExpectedError>

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 send and errors are silently ignored, because they cannot be detected.

pub fn set_response_expected_all(&mut self, response_expected: bool)

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

pub fn get_api_version(&self) -> [u8; 3]

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.

pub fn get_energy_data_callback_receiver(
    &self
) -> ConvertingCallbackReceiver<EnergyDataEvent>

This receiver is triggered periodically according to the configuration set by set_energy_data_callback_configuration.

The parameters are the same as get_energy_data.

pub fn get_energy_data(&self) -> ConvertingReceiver<EnergyData>

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.

pub fn reset_energy(&self) -> ConvertingReceiver<()>

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

pub fn get_waveform_low_level(&self) -> ConvertingReceiver<WaveformLowLevel>

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.

pub fn get_waveform(&self) -> Result<Vec<i16>, BrickletRecvTimeoutError>

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.

pub fn get_transformer_status(&self) -> ConvertingReceiver<TransformerStatus>

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

pub fn set_transformer_calibration(
    &self,
    voltage_ratio: u16,
    current_ratio: u16,
    phase_shift: i16
) -> ConvertingReceiver<()>

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.

pub fn get_transformer_calibration(
    &self
) -> ConvertingReceiver<TransformerCalibration>

Returns the transformer calibration as set by set_transformer_calibration.

pub fn calibrate_offset(&self) -> ConvertingReceiver<()>

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.

pub fn set_energy_data_callback_configuration(
    &self,
    period: u32,
    value_has_to_change: bool
) -> ConvertingReceiver<()>

The period is the period with which the get_energy_data_callback_receiver receiver is triggered periodically. A value of 0 turns the receiver off.

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

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

pub fn get_energy_data_callback_configuration(
    &self
) -> ConvertingReceiver<EnergyDataCallbackConfiguration>

Returns the receiver configuration as set by set_energy_data_callback_configuration.

pub fn get_spitfp_error_count(&self) -> ConvertingReceiver<SpitfpErrorCount>

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.

pub fn set_bootloader_mode(&self, mode: u8) -> ConvertingReceiver<u8>

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:

• ENERGY_MONITOR_BRICKLET_BOOTLOADER_MODE_BOOTLOADER
• ENERGY_MONITOR_BRICKLET_BOOTLOADER_MODE_FIRMWARE
• ENERGY_MONITOR_BRICKLET_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT
• ENERGY_MONITOR_BRICKLET_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT
• ENERGY_MONITOR_BRICKLET_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT
• ENERGY_MONITOR_BRICKLET_BOOTLOADER_STATUS_OK
• ENERGY_MONITOR_BRICKLET_BOOTLOADER_STATUS_INVALID_MODE
• ENERGY_MONITOR_BRICKLET_BOOTLOADER_STATUS_NO_CHANGE
• ENERGY_MONITOR_BRICKLET_BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT
• ENERGY_MONITOR_BRICKLET_BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT
• ENERGY_MONITOR_BRICKLET_BOOTLOADER_STATUS_CRC_MISMATCH

pub fn get_bootloader_mode(&self) -> ConvertingReceiver<u8>

Returns the current bootloader mode, see set_bootloader_mode.

Associated constants:

• ENERGY_MONITOR_BRICKLET_BOOTLOADER_MODE_BOOTLOADER
• ENERGY_MONITOR_BRICKLET_BOOTLOADER_MODE_FIRMWARE
• ENERGY_MONITOR_BRICKLET_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT
• ENERGY_MONITOR_BRICKLET_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT
• ENERGY_MONITOR_BRICKLET_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT

pub fn set_write_firmware_pointer(&self, pointer: u32) -> ConvertingReceiver<()>

Sets the firmware pointer for write_firmware. 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.

pub fn write_firmware(&self, data: [u8; 64]) -> ConvertingReceiver<u8>

Writes 64 Bytes of firmware at the position as written by set_write_firmware_pointer 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.

pub fn set_status_led_config(&self, config: u8) -> ConvertingReceiver<()>

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:

• ENERGY_MONITOR_BRICKLET_STATUS_LED_CONFIG_OFF
• ENERGY_MONITOR_BRICKLET_STATUS_LED_CONFIG_ON
• ENERGY_MONITOR_BRICKLET_STATUS_LED_CONFIG_SHOW_HEARTBEAT
• ENERGY_MONITOR_BRICKLET_STATUS_LED_CONFIG_SHOW_STATUS

pub fn get_status_led_config(&self) -> ConvertingReceiver<u8>

Returns the configuration as set by set_status_led_config

Associated constants:

• ENERGY_MONITOR_BRICKLET_STATUS_LED_CONFIG_OFF
• ENERGY_MONITOR_BRICKLET_STATUS_LED_CONFIG_ON
• ENERGY_MONITOR_BRICKLET_STATUS_LED_CONFIG_SHOW_HEARTBEAT
• ENERGY_MONITOR_BRICKLET_STATUS_LED_CONFIG_SHOW_STATUS

pub fn get_chip_temperature(&self) -> ConvertingReceiver<i16>

Returns the temperature in °C 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.

pub fn reset(&self) -> ConvertingReceiver<()>

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!

pub fn write_uid(&self, uid: u32) -> ConvertingReceiver<()>

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.

pub fn read_uid(&self) -> ConvertingReceiver<u32>

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

pub fn get_identity(&self) -> ConvertingReceiver<Identity>

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' or 'd'.

The device identifier numbers can be found here. |device_identifier_constant|

Trait Implementations

impl Clone for EnergyMonitorBricklet

fn clone(&self) -> EnergyMonitorBricklet

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.