use crate::{
byte_converter::*,
converting_callback_receiver::ConvertingCallbackReceiver,
converting_receiver::{BrickletRecvTimeoutError, ConvertingReceiver},
device::*,
ip_connection::GetRequestSender,
low_level_traits::*,
};
pub enum EnergyMonitorBrickletFunction {
GetEnergyData,
ResetEnergy,
GetWaveformLowLevel,
GetTransformerStatus,
SetTransformerCalibration,
GetTransformerCalibration,
CalibrateOffset,
SetEnergyDataCallbackConfiguration,
GetEnergyDataCallbackConfiguration,
GetSpitfpErrorCount,
SetBootloaderMode,
GetBootloaderMode,
SetWriteFirmwarePointer,
WriteFirmware,
SetStatusLedConfig,
GetStatusLedConfig,
GetChipTemperature,
Reset,
WriteUid,
ReadUid,
GetIdentity,
CallbackEnergyData,
}
impl From<EnergyMonitorBrickletFunction> for u8 {
fn from(fun: EnergyMonitorBrickletFunction) -> Self {
match fun {
EnergyMonitorBrickletFunction::GetEnergyData => 1,
EnergyMonitorBrickletFunction::ResetEnergy => 2,
EnergyMonitorBrickletFunction::GetWaveformLowLevel => 3,
EnergyMonitorBrickletFunction::GetTransformerStatus => 4,
EnergyMonitorBrickletFunction::SetTransformerCalibration => 5,
EnergyMonitorBrickletFunction::GetTransformerCalibration => 6,
EnergyMonitorBrickletFunction::CalibrateOffset => 7,
EnergyMonitorBrickletFunction::SetEnergyDataCallbackConfiguration => 8,
EnergyMonitorBrickletFunction::GetEnergyDataCallbackConfiguration => 9,
EnergyMonitorBrickletFunction::GetSpitfpErrorCount => 234,
EnergyMonitorBrickletFunction::SetBootloaderMode => 235,
EnergyMonitorBrickletFunction::GetBootloaderMode => 236,
EnergyMonitorBrickletFunction::SetWriteFirmwarePointer => 237,
EnergyMonitorBrickletFunction::WriteFirmware => 238,
EnergyMonitorBrickletFunction::SetStatusLedConfig => 239,
EnergyMonitorBrickletFunction::GetStatusLedConfig => 240,
EnergyMonitorBrickletFunction::GetChipTemperature => 242,
EnergyMonitorBrickletFunction::Reset => 243,
EnergyMonitorBrickletFunction::WriteUid => 248,
EnergyMonitorBrickletFunction::ReadUid => 249,
EnergyMonitorBrickletFunction::GetIdentity => 255,
EnergyMonitorBrickletFunction::CallbackEnergyData => 10,
}
}
}
pub const ENERGY_MONITOR_BRICKLET_BOOTLOADER_MODE_BOOTLOADER: u8 = 0;
pub const ENERGY_MONITOR_BRICKLET_BOOTLOADER_MODE_FIRMWARE: u8 = 1;
pub const ENERGY_MONITOR_BRICKLET_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT: u8 = 2;
pub const ENERGY_MONITOR_BRICKLET_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT: u8 = 3;
pub const ENERGY_MONITOR_BRICKLET_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT: u8 = 4;
pub const ENERGY_MONITOR_BRICKLET_BOOTLOADER_STATUS_OK: u8 = 0;
pub const ENERGY_MONITOR_BRICKLET_BOOTLOADER_STATUS_INVALID_MODE: u8 = 1;
pub const ENERGY_MONITOR_BRICKLET_BOOTLOADER_STATUS_NO_CHANGE: u8 = 2;
pub const ENERGY_MONITOR_BRICKLET_BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT: u8 = 3;
pub const ENERGY_MONITOR_BRICKLET_BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT: u8 = 4;
pub const ENERGY_MONITOR_BRICKLET_BOOTLOADER_STATUS_CRC_MISMATCH: u8 = 5;
pub const ENERGY_MONITOR_BRICKLET_STATUS_LED_CONFIG_OFF: u8 = 0;
pub const ENERGY_MONITOR_BRICKLET_STATUS_LED_CONFIG_ON: u8 = 1;
pub const ENERGY_MONITOR_BRICKLET_STATUS_LED_CONFIG_SHOW_HEARTBEAT: u8 = 2;
pub const ENERGY_MONITOR_BRICKLET_STATUS_LED_CONFIG_SHOW_STATUS: u8 = 3;
#[derive(Clone, Copy, Debug, Default, PartialEq, Eq, Hash)]
pub struct EnergyData {
pub voltage: i32,
pub current: i32,
pub energy: i32,
pub real_power: i32,
pub apparent_power: i32,
pub reactive_power: i32,
pub power_factor: u16,
pub frequency: u16,
}
impl FromByteSlice for EnergyData {
fn bytes_expected() -> usize { 28 }
fn from_le_byte_slice(bytes: &[u8]) -> EnergyData {
EnergyData {
voltage: <i32>::from_le_byte_slice(&bytes[0..4]),
current: <i32>::from_le_byte_slice(&bytes[4..8]),
energy: <i32>::from_le_byte_slice(&bytes[8..12]),
real_power: <i32>::from_le_byte_slice(&bytes[12..16]),
apparent_power: <i32>::from_le_byte_slice(&bytes[16..20]),
reactive_power: <i32>::from_le_byte_slice(&bytes[20..24]),
power_factor: <u16>::from_le_byte_slice(&bytes[24..26]),
frequency: <u16>::from_le_byte_slice(&bytes[26..28]),
}
}
}
#[derive(Clone, Copy, Debug, Default, PartialEq, Eq, Hash)]
pub struct WaveformLowLevel {
pub waveform_chunk_offset: u16,
pub waveform_chunk_data: [i16; 30],
}
impl FromByteSlice for WaveformLowLevel {
fn bytes_expected() -> usize { 62 }
fn from_le_byte_slice(bytes: &[u8]) -> WaveformLowLevel {
WaveformLowLevel {
waveform_chunk_offset: <u16>::from_le_byte_slice(&bytes[0..2]),
waveform_chunk_data: <[i16; 30]>::from_le_byte_slice(&bytes[2..62]),
}
}
}
impl LowLevelRead<i16, WaveformResult> for WaveformLowLevel {
fn ll_message_length(&self) -> usize { 1536 }
fn ll_message_chunk_offset(&self) -> usize { self.waveform_chunk_offset as usize }
fn ll_message_chunk_data(&self) -> &[i16] { &self.waveform_chunk_data }
fn get_result(&self) -> WaveformResult { WaveformResult {} }
}
#[derive(Clone, Copy, Debug, Default, PartialEq, Eq, Hash)]
pub struct TransformerStatus {
pub voltage_transformer_connected: bool,
pub current_transformer_connected: bool,
}
impl FromByteSlice for TransformerStatus {
fn bytes_expected() -> usize { 2 }
fn from_le_byte_slice(bytes: &[u8]) -> TransformerStatus {
TransformerStatus {
voltage_transformer_connected: <bool>::from_le_byte_slice(&bytes[0..1]),
current_transformer_connected: <bool>::from_le_byte_slice(&bytes[1..2]),
}
}
}
#[derive(Clone, Copy, Debug, Default, PartialEq, Eq, Hash)]
pub struct TransformerCalibration {
pub voltage_ratio: u16,
pub current_ratio: u16,
pub phase_shift: i16,
}
impl FromByteSlice for TransformerCalibration {
fn bytes_expected() -> usize { 6 }
fn from_le_byte_slice(bytes: &[u8]) -> TransformerCalibration {
TransformerCalibration {
voltage_ratio: <u16>::from_le_byte_slice(&bytes[0..2]),
current_ratio: <u16>::from_le_byte_slice(&bytes[2..4]),
phase_shift: <i16>::from_le_byte_slice(&bytes[4..6]),
}
}
}
#[derive(Clone, Copy, Debug, Default, PartialEq, Eq, Hash)]
pub struct EnergyDataCallbackConfiguration {
pub period: u32,
pub value_has_to_change: bool,
}
impl FromByteSlice for EnergyDataCallbackConfiguration {
fn bytes_expected() -> usize { 5 }
fn from_le_byte_slice(bytes: &[u8]) -> EnergyDataCallbackConfiguration {
EnergyDataCallbackConfiguration {
period: <u32>::from_le_byte_slice(&bytes[0..4]),
value_has_to_change: <bool>::from_le_byte_slice(&bytes[4..5]),
}
}
}
#[derive(Clone, Copy, Debug, Default, PartialEq, Eq, Hash)]
pub struct EnergyDataEvent {
pub voltage: i32,
pub current: i32,
pub energy: i32,
pub real_power: i32,
pub apparent_power: i32,
pub reactive_power: i32,
pub power_factor: u16,
pub frequency: u16,
}
impl FromByteSlice for EnergyDataEvent {
fn bytes_expected() -> usize { 28 }
fn from_le_byte_slice(bytes: &[u8]) -> EnergyDataEvent {
EnergyDataEvent {
voltage: <i32>::from_le_byte_slice(&bytes[0..4]),
current: <i32>::from_le_byte_slice(&bytes[4..8]),
energy: <i32>::from_le_byte_slice(&bytes[8..12]),
real_power: <i32>::from_le_byte_slice(&bytes[12..16]),
apparent_power: <i32>::from_le_byte_slice(&bytes[16..20]),
reactive_power: <i32>::from_le_byte_slice(&bytes[20..24]),
power_factor: <u16>::from_le_byte_slice(&bytes[24..26]),
frequency: <u16>::from_le_byte_slice(&bytes[26..28]),
}
}
}
#[derive(Clone, Copy, Debug, Default, PartialEq, Eq, Hash)]
pub struct SpitfpErrorCount {
pub error_count_ack_checksum: u32,
pub error_count_message_checksum: u32,
pub error_count_frame: u32,
pub error_count_overflow: u32,
}
impl FromByteSlice for SpitfpErrorCount {
fn bytes_expected() -> usize { 16 }
fn from_le_byte_slice(bytes: &[u8]) -> SpitfpErrorCount {
SpitfpErrorCount {
error_count_ack_checksum: <u32>::from_le_byte_slice(&bytes[0..4]),
error_count_message_checksum: <u32>::from_le_byte_slice(&bytes[4..8]),
error_count_frame: <u32>::from_le_byte_slice(&bytes[8..12]),
error_count_overflow: <u32>::from_le_byte_slice(&bytes[12..16]),
}
}
}
#[derive(Clone, Debug, Default, PartialEq, Eq, Hash)]
pub struct Identity {
pub uid: String,
pub connected_uid: String,
pub position: char,
pub hardware_version: [u8; 3],
pub firmware_version: [u8; 3],
pub device_identifier: u16,
}
impl FromByteSlice for Identity {
fn bytes_expected() -> usize { 25 }
fn from_le_byte_slice(bytes: &[u8]) -> Identity {
Identity {
uid: <String>::from_le_byte_slice(&bytes[0..8]),
connected_uid: <String>::from_le_byte_slice(&bytes[8..16]),
position: <char>::from_le_byte_slice(&bytes[16..17]),
hardware_version: <[u8; 3]>::from_le_byte_slice(&bytes[17..20]),
firmware_version: <[u8; 3]>::from_le_byte_slice(&bytes[20..23]),
device_identifier: <u16>::from_le_byte_slice(&bytes[23..25]),
}
}
}
#[derive(Clone, Copy, Debug, Default, PartialEq, Eq, Hash)]
pub struct WaveformResult {}
#[derive(Clone)]
pub struct EnergyMonitorBricklet {
device: Device,
}
impl EnergyMonitorBricklet {
pub const DEVICE_IDENTIFIER: u16 = 2152;
pub const DEVICE_DISPLAY_NAME: &'static str = "Energy Monitor Bricklet";
pub fn new<T: GetRequestSender>(uid: &str, req_sender: T) -> EnergyMonitorBricklet {
let mut result = EnergyMonitorBricklet { device: Device::new([2, 0, 0], uid, req_sender, 1) };
result.device.response_expected[u8::from(EnergyMonitorBrickletFunction::GetEnergyData) as usize] = ResponseExpectedFlag::AlwaysTrue;
result.device.response_expected[u8::from(EnergyMonitorBrickletFunction::ResetEnergy) as usize] = ResponseExpectedFlag::False;
result.device.response_expected[u8::from(EnergyMonitorBrickletFunction::GetWaveformLowLevel) as usize] =
ResponseExpectedFlag::AlwaysTrue;
result.device.response_expected[u8::from(EnergyMonitorBrickletFunction::GetTransformerStatus) as usize] =
ResponseExpectedFlag::AlwaysTrue;
result.device.response_expected[u8::from(EnergyMonitorBrickletFunction::SetTransformerCalibration) as usize] =
ResponseExpectedFlag::False;
result.device.response_expected[u8::from(EnergyMonitorBrickletFunction::GetTransformerCalibration) as usize] =
ResponseExpectedFlag::AlwaysTrue;
result.device.response_expected[u8::from(EnergyMonitorBrickletFunction::CalibrateOffset) as usize] = ResponseExpectedFlag::False;
result.device.response_expected[u8::from(EnergyMonitorBrickletFunction::SetEnergyDataCallbackConfiguration) as usize] =
ResponseExpectedFlag::True;
result.device.response_expected[u8::from(EnergyMonitorBrickletFunction::GetEnergyDataCallbackConfiguration) as usize] =
ResponseExpectedFlag::AlwaysTrue;
result.device.response_expected[u8::from(EnergyMonitorBrickletFunction::GetSpitfpErrorCount) as usize] =
ResponseExpectedFlag::AlwaysTrue;
result.device.response_expected[u8::from(EnergyMonitorBrickletFunction::SetBootloaderMode) as usize] =
ResponseExpectedFlag::AlwaysTrue;
result.device.response_expected[u8::from(EnergyMonitorBrickletFunction::GetBootloaderMode) as usize] =
ResponseExpectedFlag::AlwaysTrue;
result.device.response_expected[u8::from(EnergyMonitorBrickletFunction::SetWriteFirmwarePointer) as usize] =
ResponseExpectedFlag::False;
result.device.response_expected[u8::from(EnergyMonitorBrickletFunction::WriteFirmware) as usize] = ResponseExpectedFlag::AlwaysTrue;
result.device.response_expected[u8::from(EnergyMonitorBrickletFunction::SetStatusLedConfig) as usize] = ResponseExpectedFlag::False;
result.device.response_expected[u8::from(EnergyMonitorBrickletFunction::GetStatusLedConfig) as usize] =
ResponseExpectedFlag::AlwaysTrue;
result.device.response_expected[u8::from(EnergyMonitorBrickletFunction::GetChipTemperature) as usize] =
ResponseExpectedFlag::AlwaysTrue;
result.device.response_expected[u8::from(EnergyMonitorBrickletFunction::Reset) as usize] = ResponseExpectedFlag::False;
result.device.response_expected[u8::from(EnergyMonitorBrickletFunction::WriteUid) as usize] = ResponseExpectedFlag::False;
result.device.response_expected[u8::from(EnergyMonitorBrickletFunction::ReadUid) as usize] = ResponseExpectedFlag::AlwaysTrue;
result.device.response_expected[u8::from(EnergyMonitorBrickletFunction::GetIdentity) as usize] = ResponseExpectedFlag::AlwaysTrue;
result
}
pub fn get_response_expected(&mut self, fun: EnergyMonitorBrickletFunction) -> Result<bool, GetResponseExpectedError> {
self.device.get_response_expected(u8::from(fun))
}
pub fn set_response_expected(
&mut self,
fun: EnergyMonitorBrickletFunction,
response_expected: bool,
) -> Result<(), SetResponseExpectedError> {
self.device.set_response_expected(u8::from(fun), response_expected)
}
pub fn set_response_expected_all(&mut self, response_expected: bool) { self.device.set_response_expected_all(response_expected) }
pub fn get_api_version(&self) -> [u8; 3] { self.device.api_version }
pub fn get_energy_data_callback_receiver(&self) -> ConvertingCallbackReceiver<EnergyDataEvent> {
self.device.get_callback_receiver(u8::from(EnergyMonitorBrickletFunction::CallbackEnergyData))
}
pub fn get_energy_data(&self) -> ConvertingReceiver<EnergyData> {
let payload = vec![0; 0];
self.device.get(u8::from(EnergyMonitorBrickletFunction::GetEnergyData), payload)
}
pub fn reset_energy(&self) -> ConvertingReceiver<()> {
let payload = vec![0; 0];
self.device.set(u8::from(EnergyMonitorBrickletFunction::ResetEnergy), payload)
}
pub fn get_waveform_low_level(&self) -> ConvertingReceiver<WaveformLowLevel> {
let payload = vec![0; 0];
self.device.get(u8::from(EnergyMonitorBrickletFunction::GetWaveformLowLevel), payload)
}
pub fn get_waveform(&self) -> Result<Vec<i16>, BrickletRecvTimeoutError> {
let ll_result = self.device.get_high_level(0, &mut || self.get_waveform_low_level().recv())?;
Ok(ll_result.0)
}
pub fn get_transformer_status(&self) -> ConvertingReceiver<TransformerStatus> {
let payload = vec![0; 0];
self.device.get(u8::from(EnergyMonitorBrickletFunction::GetTransformerStatus), payload)
}
pub fn set_transformer_calibration(&self, voltage_ratio: u16, current_ratio: u16, phase_shift: i16) -> ConvertingReceiver<()> {
let mut payload = vec![0; 6];
payload[0..2].copy_from_slice(&<u16>::to_le_byte_vec(voltage_ratio));
payload[2..4].copy_from_slice(&<u16>::to_le_byte_vec(current_ratio));
payload[4..6].copy_from_slice(&<i16>::to_le_byte_vec(phase_shift));
self.device.set(u8::from(EnergyMonitorBrickletFunction::SetTransformerCalibration), payload)
}
pub fn get_transformer_calibration(&self) -> ConvertingReceiver<TransformerCalibration> {
let payload = vec![0; 0];
self.device.get(u8::from(EnergyMonitorBrickletFunction::GetTransformerCalibration), payload)
}
pub fn calibrate_offset(&self) -> ConvertingReceiver<()> {
let payload = vec![0; 0];
self.device.set(u8::from(EnergyMonitorBrickletFunction::CalibrateOffset), payload)
}
pub fn set_energy_data_callback_configuration(&self, period: u32, value_has_to_change: bool) -> ConvertingReceiver<()> {
let mut payload = vec![0; 5];
payload[0..4].copy_from_slice(&<u32>::to_le_byte_vec(period));
payload[4..5].copy_from_slice(&<bool>::to_le_byte_vec(value_has_to_change));
self.device.set(u8::from(EnergyMonitorBrickletFunction::SetEnergyDataCallbackConfiguration), payload)
}
pub fn get_energy_data_callback_configuration(&self) -> ConvertingReceiver<EnergyDataCallbackConfiguration> {
let payload = vec![0; 0];
self.device.get(u8::from(EnergyMonitorBrickletFunction::GetEnergyDataCallbackConfiguration), payload)
}
pub fn get_spitfp_error_count(&self) -> ConvertingReceiver<SpitfpErrorCount> {
let payload = vec![0; 0];
self.device.get(u8::from(EnergyMonitorBrickletFunction::GetSpitfpErrorCount), payload)
}
pub fn set_bootloader_mode(&self, mode: u8) -> ConvertingReceiver<u8> {
let mut payload = vec![0; 1];
payload[0..1].copy_from_slice(&<u8>::to_le_byte_vec(mode));
self.device.get(u8::from(EnergyMonitorBrickletFunction::SetBootloaderMode), payload)
}
pub fn get_bootloader_mode(&self) -> ConvertingReceiver<u8> {
let payload = vec![0; 0];
self.device.get(u8::from(EnergyMonitorBrickletFunction::GetBootloaderMode), payload)
}
pub fn set_write_firmware_pointer(&self, pointer: u32) -> ConvertingReceiver<()> {
let mut payload = vec![0; 4];
payload[0..4].copy_from_slice(&<u32>::to_le_byte_vec(pointer));
self.device.set(u8::from(EnergyMonitorBrickletFunction::SetWriteFirmwarePointer), payload)
}
pub fn write_firmware(&self, data: [u8; 64]) -> ConvertingReceiver<u8> {
let mut payload = vec![0; 64];
payload[0..64].copy_from_slice(&<[u8; 64]>::to_le_byte_vec(data));
self.device.get(u8::from(EnergyMonitorBrickletFunction::WriteFirmware), payload)
}
pub fn set_status_led_config(&self, config: u8) -> ConvertingReceiver<()> {
let mut payload = vec![0; 1];
payload[0..1].copy_from_slice(&<u8>::to_le_byte_vec(config));
self.device.set(u8::from(EnergyMonitorBrickletFunction::SetStatusLedConfig), payload)
}
pub fn get_status_led_config(&self) -> ConvertingReceiver<u8> {
let payload = vec![0; 0];
self.device.get(u8::from(EnergyMonitorBrickletFunction::GetStatusLedConfig), payload)
}
pub fn get_chip_temperature(&self) -> ConvertingReceiver<i16> {
let payload = vec![0; 0];
self.device.get(u8::from(EnergyMonitorBrickletFunction::GetChipTemperature), payload)
}
pub fn reset(&self) -> ConvertingReceiver<()> {
let payload = vec![0; 0];
self.device.set(u8::from(EnergyMonitorBrickletFunction::Reset), payload)
}
pub fn write_uid(&self, uid: u32) -> ConvertingReceiver<()> {
let mut payload = vec![0; 4];
payload[0..4].copy_from_slice(&<u32>::to_le_byte_vec(uid));
self.device.set(u8::from(EnergyMonitorBrickletFunction::WriteUid), payload)
}
pub fn read_uid(&self) -> ConvertingReceiver<u32> {
let payload = vec![0; 0];
self.device.get(u8::from(EnergyMonitorBrickletFunction::ReadUid), payload)
}
pub fn get_identity(&self) -> ConvertingReceiver<Identity> {
let payload = vec![0; 0];
self.device.get(u8::from(EnergyMonitorBrickletFunction::GetIdentity), payload)
}
}