use crate::{
byte_converter::*, converting_callback_receiver::ConvertingCallbackReceiver, converting_receiver::ConvertingReceiver, device::*,
ip_connection::GetRequestSender,
};
pub enum HallEffectV2BrickletFunction {
GetMagneticFluxDensity,
SetMagneticFluxDensityCallbackConfiguration,
GetMagneticFluxDensityCallbackConfiguration,
GetCounter,
SetCounterConfig,
GetCounterConfig,
SetCounterCallbackConfiguration,
GetCounterCallbackConfiguration,
GetSpitfpErrorCount,
SetBootloaderMode,
GetBootloaderMode,
SetWriteFirmwarePointer,
WriteFirmware,
SetStatusLedConfig,
GetStatusLedConfig,
GetChipTemperature,
Reset,
WriteUid,
ReadUid,
GetIdentity,
CallbackMagneticFluxDensity,
CallbackCounter,
}
impl From<HallEffectV2BrickletFunction> for u8 {
fn from(fun: HallEffectV2BrickletFunction) -> Self {
match fun {
HallEffectV2BrickletFunction::GetMagneticFluxDensity => 1,
HallEffectV2BrickletFunction::SetMagneticFluxDensityCallbackConfiguration => 2,
HallEffectV2BrickletFunction::GetMagneticFluxDensityCallbackConfiguration => 3,
HallEffectV2BrickletFunction::GetCounter => 5,
HallEffectV2BrickletFunction::SetCounterConfig => 6,
HallEffectV2BrickletFunction::GetCounterConfig => 7,
HallEffectV2BrickletFunction::SetCounterCallbackConfiguration => 8,
HallEffectV2BrickletFunction::GetCounterCallbackConfiguration => 9,
HallEffectV2BrickletFunction::GetSpitfpErrorCount => 234,
HallEffectV2BrickletFunction::SetBootloaderMode => 235,
HallEffectV2BrickletFunction::GetBootloaderMode => 236,
HallEffectV2BrickletFunction::SetWriteFirmwarePointer => 237,
HallEffectV2BrickletFunction::WriteFirmware => 238,
HallEffectV2BrickletFunction::SetStatusLedConfig => 239,
HallEffectV2BrickletFunction::GetStatusLedConfig => 240,
HallEffectV2BrickletFunction::GetChipTemperature => 242,
HallEffectV2BrickletFunction::Reset => 243,
HallEffectV2BrickletFunction::WriteUid => 248,
HallEffectV2BrickletFunction::ReadUid => 249,
HallEffectV2BrickletFunction::GetIdentity => 255,
HallEffectV2BrickletFunction::CallbackMagneticFluxDensity => 4,
HallEffectV2BrickletFunction::CallbackCounter => 10,
}
}
}
pub const HALL_EFFECT_V2_BRICKLET_THRESHOLD_OPTION_OFF: char = 'x';
pub const HALL_EFFECT_V2_BRICKLET_THRESHOLD_OPTION_OUTSIDE: char = 'o';
pub const HALL_EFFECT_V2_BRICKLET_THRESHOLD_OPTION_INSIDE: char = 'i';
pub const HALL_EFFECT_V2_BRICKLET_THRESHOLD_OPTION_SMALLER: char = '<';
pub const HALL_EFFECT_V2_BRICKLET_THRESHOLD_OPTION_GREATER: char = '>';
pub const HALL_EFFECT_V2_BRICKLET_BOOTLOADER_MODE_BOOTLOADER: u8 = 0;
pub const HALL_EFFECT_V2_BRICKLET_BOOTLOADER_MODE_FIRMWARE: u8 = 1;
pub const HALL_EFFECT_V2_BRICKLET_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT: u8 = 2;
pub const HALL_EFFECT_V2_BRICKLET_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT: u8 = 3;
pub const HALL_EFFECT_V2_BRICKLET_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT: u8 = 4;
pub const HALL_EFFECT_V2_BRICKLET_BOOTLOADER_STATUS_OK: u8 = 0;
pub const HALL_EFFECT_V2_BRICKLET_BOOTLOADER_STATUS_INVALID_MODE: u8 = 1;
pub const HALL_EFFECT_V2_BRICKLET_BOOTLOADER_STATUS_NO_CHANGE: u8 = 2;
pub const HALL_EFFECT_V2_BRICKLET_BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT: u8 = 3;
pub const HALL_EFFECT_V2_BRICKLET_BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT: u8 = 4;
pub const HALL_EFFECT_V2_BRICKLET_BOOTLOADER_STATUS_CRC_MISMATCH: u8 = 5;
pub const HALL_EFFECT_V2_BRICKLET_STATUS_LED_CONFIG_OFF: u8 = 0;
pub const HALL_EFFECT_V2_BRICKLET_STATUS_LED_CONFIG_ON: u8 = 1;
pub const HALL_EFFECT_V2_BRICKLET_STATUS_LED_CONFIG_SHOW_HEARTBEAT: u8 = 2;
pub const HALL_EFFECT_V2_BRICKLET_STATUS_LED_CONFIG_SHOW_STATUS: u8 = 3;
#[derive(Clone, Copy, Debug, Default, PartialEq, Eq, Hash)]
pub struct MagneticFluxDensityCallbackConfiguration {
pub period: u32,
pub value_has_to_change: bool,
pub option: char,
pub min: i16,
pub max: i16,
}
impl FromByteSlice for MagneticFluxDensityCallbackConfiguration {
fn bytes_expected() -> usize { 10 }
fn from_le_byte_slice(bytes: &[u8]) -> MagneticFluxDensityCallbackConfiguration {
MagneticFluxDensityCallbackConfiguration {
period: <u32>::from_le_byte_slice(&bytes[0..4]),
value_has_to_change: <bool>::from_le_byte_slice(&bytes[4..5]),
option: <char>::from_le_byte_slice(&bytes[5..6]),
min: <i16>::from_le_byte_slice(&bytes[6..8]),
max: <i16>::from_le_byte_slice(&bytes[8..10]),
}
}
}
#[derive(Clone, Copy, Debug, Default, PartialEq, Eq, Hash)]
pub struct CounterConfig {
pub high_threshold: i16,
pub low_threshold: i16,
pub debounce: u32,
}
impl FromByteSlice for CounterConfig {
fn bytes_expected() -> usize { 8 }
fn from_le_byte_slice(bytes: &[u8]) -> CounterConfig {
CounterConfig {
high_threshold: <i16>::from_le_byte_slice(&bytes[0..2]),
low_threshold: <i16>::from_le_byte_slice(&bytes[2..4]),
debounce: <u32>::from_le_byte_slice(&bytes[4..8]),
}
}
}
#[derive(Clone, Copy, Debug, Default, PartialEq, Eq, Hash)]
pub struct CounterCallbackConfiguration {
pub period: u32,
pub value_has_to_change: bool,
}
impl FromByteSlice for CounterCallbackConfiguration {
fn bytes_expected() -> usize { 5 }
fn from_le_byte_slice(bytes: &[u8]) -> CounterCallbackConfiguration {
CounterCallbackConfiguration {
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 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)]
pub struct HallEffectV2Bricklet {
device: Device,
}
impl HallEffectV2Bricklet {
pub const DEVICE_IDENTIFIER: u16 = 2132;
pub const DEVICE_DISPLAY_NAME: &'static str = "Hall Effect Bricklet 2.0";
pub fn new<T: GetRequestSender>(uid: &str, req_sender: T) -> HallEffectV2Bricklet {
let mut result = HallEffectV2Bricklet { device: Device::new([2, 0, 0], uid, req_sender, 0) };
result.device.response_expected[u8::from(HallEffectV2BrickletFunction::GetMagneticFluxDensity) as usize] =
ResponseExpectedFlag::AlwaysTrue;
result.device.response_expected[u8::from(HallEffectV2BrickletFunction::SetMagneticFluxDensityCallbackConfiguration) as usize] =
ResponseExpectedFlag::True;
result.device.response_expected[u8::from(HallEffectV2BrickletFunction::GetMagneticFluxDensityCallbackConfiguration) as usize] =
ResponseExpectedFlag::AlwaysTrue;
result.device.response_expected[u8::from(HallEffectV2BrickletFunction::GetCounter) as usize] = ResponseExpectedFlag::AlwaysTrue;
result.device.response_expected[u8::from(HallEffectV2BrickletFunction::SetCounterConfig) as usize] = ResponseExpectedFlag::False;
result.device.response_expected[u8::from(HallEffectV2BrickletFunction::GetCounterConfig) as usize] =
ResponseExpectedFlag::AlwaysTrue;
result.device.response_expected[u8::from(HallEffectV2BrickletFunction::SetCounterCallbackConfiguration) as usize] =
ResponseExpectedFlag::True;
result.device.response_expected[u8::from(HallEffectV2BrickletFunction::GetCounterCallbackConfiguration) as usize] =
ResponseExpectedFlag::AlwaysTrue;
result.device.response_expected[u8::from(HallEffectV2BrickletFunction::GetSpitfpErrorCount) as usize] =
ResponseExpectedFlag::AlwaysTrue;
result.device.response_expected[u8::from(HallEffectV2BrickletFunction::SetBootloaderMode) as usize] =
ResponseExpectedFlag::AlwaysTrue;
result.device.response_expected[u8::from(HallEffectV2BrickletFunction::GetBootloaderMode) as usize] =
ResponseExpectedFlag::AlwaysTrue;
result.device.response_expected[u8::from(HallEffectV2BrickletFunction::SetWriteFirmwarePointer) as usize] =
ResponseExpectedFlag::False;
result.device.response_expected[u8::from(HallEffectV2BrickletFunction::WriteFirmware) as usize] = ResponseExpectedFlag::AlwaysTrue;
result.device.response_expected[u8::from(HallEffectV2BrickletFunction::SetStatusLedConfig) as usize] = ResponseExpectedFlag::False;
result.device.response_expected[u8::from(HallEffectV2BrickletFunction::GetStatusLedConfig) as usize] =
ResponseExpectedFlag::AlwaysTrue;
result.device.response_expected[u8::from(HallEffectV2BrickletFunction::GetChipTemperature) as usize] =
ResponseExpectedFlag::AlwaysTrue;
result.device.response_expected[u8::from(HallEffectV2BrickletFunction::Reset) as usize] = ResponseExpectedFlag::False;
result.device.response_expected[u8::from(HallEffectV2BrickletFunction::WriteUid) as usize] = ResponseExpectedFlag::False;
result.device.response_expected[u8::from(HallEffectV2BrickletFunction::ReadUid) as usize] = ResponseExpectedFlag::AlwaysTrue;
result.device.response_expected[u8::from(HallEffectV2BrickletFunction::GetIdentity) as usize] = ResponseExpectedFlag::AlwaysTrue;
result
}
pub fn get_response_expected(&mut self, fun: HallEffectV2BrickletFunction) -> Result<bool, GetResponseExpectedError> {
self.device.get_response_expected(u8::from(fun))
}
pub fn set_response_expected(
&mut self,
fun: HallEffectV2BrickletFunction,
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_magnetic_flux_density_callback_receiver(&self) -> ConvertingCallbackReceiver<i16> {
self.device.get_callback_receiver(u8::from(HallEffectV2BrickletFunction::CallbackMagneticFluxDensity))
}
pub fn get_counter_callback_receiver(&self) -> ConvertingCallbackReceiver<u32> {
self.device.get_callback_receiver(u8::from(HallEffectV2BrickletFunction::CallbackCounter))
}
pub fn get_magnetic_flux_density(&self) -> ConvertingReceiver<i16> {
let payload = vec![0; 0];
self.device.get(u8::from(HallEffectV2BrickletFunction::GetMagneticFluxDensity), payload)
}
pub fn set_magnetic_flux_density_callback_configuration(
&self,
period: u32,
value_has_to_change: bool,
option: char,
min: i16,
max: i16,
) -> ConvertingReceiver<()> {
let mut payload = vec![0; 10];
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));
payload[5..6].copy_from_slice(&<char>::to_le_byte_vec(option));
payload[6..8].copy_from_slice(&<i16>::to_le_byte_vec(min));
payload[8..10].copy_from_slice(&<i16>::to_le_byte_vec(max));
self.device.set(u8::from(HallEffectV2BrickletFunction::SetMagneticFluxDensityCallbackConfiguration), payload)
}
pub fn get_magnetic_flux_density_callback_configuration(&self) -> ConvertingReceiver<MagneticFluxDensityCallbackConfiguration> {
let payload = vec![0; 0];
self.device.get(u8::from(HallEffectV2BrickletFunction::GetMagneticFluxDensityCallbackConfiguration), payload)
}
pub fn get_counter(&self, reset_counter: bool) -> ConvertingReceiver<u32> {
let mut payload = vec![0; 1];
payload[0..1].copy_from_slice(&<bool>::to_le_byte_vec(reset_counter));
self.device.get(u8::from(HallEffectV2BrickletFunction::GetCounter), payload)
}
pub fn set_counter_config(&self, high_threshold: i16, low_threshold: i16, debounce: u32) -> ConvertingReceiver<()> {
let mut payload = vec![0; 8];
payload[0..2].copy_from_slice(&<i16>::to_le_byte_vec(high_threshold));
payload[2..4].copy_from_slice(&<i16>::to_le_byte_vec(low_threshold));
payload[4..8].copy_from_slice(&<u32>::to_le_byte_vec(debounce));
self.device.set(u8::from(HallEffectV2BrickletFunction::SetCounterConfig), payload)
}
pub fn get_counter_config(&self) -> ConvertingReceiver<CounterConfig> {
let payload = vec![0; 0];
self.device.get(u8::from(HallEffectV2BrickletFunction::GetCounterConfig), payload)
}
pub fn set_counter_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(HallEffectV2BrickletFunction::SetCounterCallbackConfiguration), payload)
}
pub fn get_counter_callback_configuration(&self) -> ConvertingReceiver<CounterCallbackConfiguration> {
let payload = vec![0; 0];
self.device.get(u8::from(HallEffectV2BrickletFunction::GetCounterCallbackConfiguration), payload)
}
pub fn get_spitfp_error_count(&self) -> ConvertingReceiver<SpitfpErrorCount> {
let payload = vec![0; 0];
self.device.get(u8::from(HallEffectV2BrickletFunction::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(HallEffectV2BrickletFunction::SetBootloaderMode), payload)
}
pub fn get_bootloader_mode(&self) -> ConvertingReceiver<u8> {
let payload = vec![0; 0];
self.device.get(u8::from(HallEffectV2BrickletFunction::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(HallEffectV2BrickletFunction::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(HallEffectV2BrickletFunction::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(HallEffectV2BrickletFunction::SetStatusLedConfig), payload)
}
pub fn get_status_led_config(&self) -> ConvertingReceiver<u8> {
let payload = vec![0; 0];
self.device.get(u8::from(HallEffectV2BrickletFunction::GetStatusLedConfig), payload)
}
pub fn get_chip_temperature(&self) -> ConvertingReceiver<i16> {
let payload = vec![0; 0];
self.device.get(u8::from(HallEffectV2BrickletFunction::GetChipTemperature), payload)
}
pub fn reset(&self) -> ConvertingReceiver<()> {
let payload = vec![0; 0];
self.device.set(u8::from(HallEffectV2BrickletFunction::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(HallEffectV2BrickletFunction::WriteUid), payload)
}
pub fn read_uid(&self) -> ConvertingReceiver<u32> {
let payload = vec![0; 0];
self.device.get(u8::from(HallEffectV2BrickletFunction::ReadUid), payload)
}
pub fn get_identity(&self) -> ConvertingReceiver<Identity> {
let payload = vec![0; 0];
self.device.get(u8::from(HallEffectV2BrickletFunction::GetIdentity), payload)
}
}