use crate::{
byte_converter::*, converting_callback_receiver::ConvertingCallbackReceiver, converting_receiver::ConvertingReceiver, device::*,
ip_connection::GetRequestSender,
};
pub enum HatBrickFunction {
SetSleepMode,
GetSleepMode,
SetBrickletPower,
GetBrickletPower,
GetVoltages,
SetVoltagesCallbackConfiguration,
GetVoltagesCallbackConfiguration,
GetSpitfpErrorCount,
SetBootloaderMode,
GetBootloaderMode,
SetWriteFirmwarePointer,
WriteFirmware,
SetStatusLedConfig,
GetStatusLedConfig,
GetChipTemperature,
Reset,
WriteUid,
ReadUid,
GetIdentity,
CallbackVoltages,
}
impl From<HatBrickFunction> for u8 {
fn from(fun: HatBrickFunction) -> Self {
match fun {
HatBrickFunction::SetSleepMode => 1,
HatBrickFunction::GetSleepMode => 2,
HatBrickFunction::SetBrickletPower => 3,
HatBrickFunction::GetBrickletPower => 4,
HatBrickFunction::GetVoltages => 5,
HatBrickFunction::SetVoltagesCallbackConfiguration => 6,
HatBrickFunction::GetVoltagesCallbackConfiguration => 7,
HatBrickFunction::GetSpitfpErrorCount => 234,
HatBrickFunction::SetBootloaderMode => 235,
HatBrickFunction::GetBootloaderMode => 236,
HatBrickFunction::SetWriteFirmwarePointer => 237,
HatBrickFunction::WriteFirmware => 238,
HatBrickFunction::SetStatusLedConfig => 239,
HatBrickFunction::GetStatusLedConfig => 240,
HatBrickFunction::GetChipTemperature => 242,
HatBrickFunction::Reset => 243,
HatBrickFunction::WriteUid => 248,
HatBrickFunction::ReadUid => 249,
HatBrickFunction::GetIdentity => 255,
HatBrickFunction::CallbackVoltages => 8,
}
}
}
pub const HAT_BRICK_BOOTLOADER_MODE_BOOTLOADER: u8 = 0;
pub const HAT_BRICK_BOOTLOADER_MODE_FIRMWARE: u8 = 1;
pub const HAT_BRICK_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT: u8 = 2;
pub const HAT_BRICK_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT: u8 = 3;
pub const HAT_BRICK_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT: u8 = 4;
pub const HAT_BRICK_BOOTLOADER_STATUS_OK: u8 = 0;
pub const HAT_BRICK_BOOTLOADER_STATUS_INVALID_MODE: u8 = 1;
pub const HAT_BRICK_BOOTLOADER_STATUS_NO_CHANGE: u8 = 2;
pub const HAT_BRICK_BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT: u8 = 3;
pub const HAT_BRICK_BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT: u8 = 4;
pub const HAT_BRICK_BOOTLOADER_STATUS_CRC_MISMATCH: u8 = 5;
pub const HAT_BRICK_STATUS_LED_CONFIG_OFF: u8 = 0;
pub const HAT_BRICK_STATUS_LED_CONFIG_ON: u8 = 1;
pub const HAT_BRICK_STATUS_LED_CONFIG_SHOW_HEARTBEAT: u8 = 2;
pub const HAT_BRICK_STATUS_LED_CONFIG_SHOW_STATUS: u8 = 3;
#[derive(Clone, Copy, Debug, Default, PartialEq, Eq, Hash)]
pub struct SleepMode {
pub power_off_delay: u32,
pub power_off_duration: u32,
pub raspberry_pi_off: bool,
pub bricklets_off: bool,
pub enable_sleep_indicator: bool,
}
impl FromByteSlice for SleepMode {
fn bytes_expected() -> usize { 11 }
fn from_le_byte_slice(bytes: &[u8]) -> SleepMode {
SleepMode {
power_off_delay: <u32>::from_le_byte_slice(&bytes[0..4]),
power_off_duration: <u32>::from_le_byte_slice(&bytes[4..8]),
raspberry_pi_off: <bool>::from_le_byte_slice(&bytes[8..9]),
bricklets_off: <bool>::from_le_byte_slice(&bytes[9..10]),
enable_sleep_indicator: <bool>::from_le_byte_slice(&bytes[10..11]),
}
}
}
#[derive(Clone, Copy, Debug, Default, PartialEq, Eq, Hash)]
pub struct Voltages {
pub voltage_usb: u16,
pub voltage_dc: u16,
}
impl FromByteSlice for Voltages {
fn bytes_expected() -> usize { 4 }
fn from_le_byte_slice(bytes: &[u8]) -> Voltages {
Voltages { voltage_usb: <u16>::from_le_byte_slice(&bytes[0..2]), voltage_dc: <u16>::from_le_byte_slice(&bytes[2..4]) }
}
}
#[derive(Clone, Copy, Debug, Default, PartialEq, Eq, Hash)]
pub struct VoltagesCallbackConfiguration {
pub period: u32,
pub value_has_to_change: bool,
}
impl FromByteSlice for VoltagesCallbackConfiguration {
fn bytes_expected() -> usize { 5 }
fn from_le_byte_slice(bytes: &[u8]) -> VoltagesCallbackConfiguration {
VoltagesCallbackConfiguration {
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 VoltagesEvent {
pub voltage_usb: u16,
pub voltage_dc: u16,
}
impl FromByteSlice for VoltagesEvent {
fn bytes_expected() -> usize { 4 }
fn from_le_byte_slice(bytes: &[u8]) -> VoltagesEvent {
VoltagesEvent { voltage_usb: <u16>::from_le_byte_slice(&bytes[0..2]), voltage_dc: <u16>::from_le_byte_slice(&bytes[2..4]) }
}
}
#[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 HatBrick {
device: Device,
}
impl HatBrick {
pub const DEVICE_IDENTIFIER: u16 = 111;
pub const DEVICE_DISPLAY_NAME: &'static str = "HAT Brick";
pub fn new<T: GetRequestSender>(uid: &str, req_sender: T) -> HatBrick {
let mut result = HatBrick { device: Device::new([2, 0, 1], uid, req_sender, 0) };
result.device.response_expected[u8::from(HatBrickFunction::SetSleepMode) as usize] = ResponseExpectedFlag::False;
result.device.response_expected[u8::from(HatBrickFunction::GetSleepMode) as usize] = ResponseExpectedFlag::AlwaysTrue;
result.device.response_expected[u8::from(HatBrickFunction::SetBrickletPower) as usize] = ResponseExpectedFlag::False;
result.device.response_expected[u8::from(HatBrickFunction::GetBrickletPower) as usize] = ResponseExpectedFlag::AlwaysTrue;
result.device.response_expected[u8::from(HatBrickFunction::GetVoltages) as usize] = ResponseExpectedFlag::AlwaysTrue;
result.device.response_expected[u8::from(HatBrickFunction::SetVoltagesCallbackConfiguration) as usize] = ResponseExpectedFlag::True;
result.device.response_expected[u8::from(HatBrickFunction::GetVoltagesCallbackConfiguration) as usize] =
ResponseExpectedFlag::AlwaysTrue;
result.device.response_expected[u8::from(HatBrickFunction::GetSpitfpErrorCount) as usize] = ResponseExpectedFlag::AlwaysTrue;
result.device.response_expected[u8::from(HatBrickFunction::SetBootloaderMode) as usize] = ResponseExpectedFlag::AlwaysTrue;
result.device.response_expected[u8::from(HatBrickFunction::GetBootloaderMode) as usize] = ResponseExpectedFlag::AlwaysTrue;
result.device.response_expected[u8::from(HatBrickFunction::SetWriteFirmwarePointer) as usize] = ResponseExpectedFlag::False;
result.device.response_expected[u8::from(HatBrickFunction::WriteFirmware) as usize] = ResponseExpectedFlag::AlwaysTrue;
result.device.response_expected[u8::from(HatBrickFunction::SetStatusLedConfig) as usize] = ResponseExpectedFlag::False;
result.device.response_expected[u8::from(HatBrickFunction::GetStatusLedConfig) as usize] = ResponseExpectedFlag::AlwaysTrue;
result.device.response_expected[u8::from(HatBrickFunction::GetChipTemperature) as usize] = ResponseExpectedFlag::AlwaysTrue;
result.device.response_expected[u8::from(HatBrickFunction::Reset) as usize] = ResponseExpectedFlag::False;
result.device.response_expected[u8::from(HatBrickFunction::WriteUid) as usize] = ResponseExpectedFlag::False;
result.device.response_expected[u8::from(HatBrickFunction::ReadUid) as usize] = ResponseExpectedFlag::AlwaysTrue;
result.device.response_expected[u8::from(HatBrickFunction::GetIdentity) as usize] = ResponseExpectedFlag::AlwaysTrue;
result
}
pub fn get_response_expected(&mut self, fun: HatBrickFunction) -> Result<bool, GetResponseExpectedError> {
self.device.get_response_expected(u8::from(fun))
}
pub fn set_response_expected(&mut self, fun: HatBrickFunction, 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_voltages_callback_receiver(&self) -> ConvertingCallbackReceiver<VoltagesEvent> {
self.device.get_callback_receiver(u8::from(HatBrickFunction::CallbackVoltages))
}
pub fn set_sleep_mode(
&self,
power_off_delay: u32,
power_off_duration: u32,
raspberry_pi_off: bool,
bricklets_off: bool,
enable_sleep_indicator: bool,
) -> ConvertingReceiver<()> {
let mut payload = vec![0; 11];
payload[0..4].copy_from_slice(&<u32>::to_le_byte_vec(power_off_delay));
payload[4..8].copy_from_slice(&<u32>::to_le_byte_vec(power_off_duration));
payload[8..9].copy_from_slice(&<bool>::to_le_byte_vec(raspberry_pi_off));
payload[9..10].copy_from_slice(&<bool>::to_le_byte_vec(bricklets_off));
payload[10..11].copy_from_slice(&<bool>::to_le_byte_vec(enable_sleep_indicator));
self.device.set(u8::from(HatBrickFunction::SetSleepMode), payload)
}
pub fn get_sleep_mode(&self) -> ConvertingReceiver<SleepMode> {
let payload = vec![0; 0];
self.device.get(u8::from(HatBrickFunction::GetSleepMode), payload)
}
pub fn set_bricklet_power(&self, bricklet_power: bool) -> ConvertingReceiver<()> {
let mut payload = vec![0; 1];
payload[0..1].copy_from_slice(&<bool>::to_le_byte_vec(bricklet_power));
self.device.set(u8::from(HatBrickFunction::SetBrickletPower), payload)
}
pub fn get_bricklet_power(&self) -> ConvertingReceiver<bool> {
let payload = vec![0; 0];
self.device.get(u8::from(HatBrickFunction::GetBrickletPower), payload)
}
pub fn get_voltages(&self) -> ConvertingReceiver<Voltages> {
let payload = vec![0; 0];
self.device.get(u8::from(HatBrickFunction::GetVoltages), payload)
}
pub fn set_voltages_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(HatBrickFunction::SetVoltagesCallbackConfiguration), payload)
}
pub fn get_voltages_callback_configuration(&self) -> ConvertingReceiver<VoltagesCallbackConfiguration> {
let payload = vec![0; 0];
self.device.get(u8::from(HatBrickFunction::GetVoltagesCallbackConfiguration), payload)
}
pub fn get_spitfp_error_count(&self) -> ConvertingReceiver<SpitfpErrorCount> {
let payload = vec![0; 0];
self.device.get(u8::from(HatBrickFunction::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(HatBrickFunction::SetBootloaderMode), payload)
}
pub fn get_bootloader_mode(&self) -> ConvertingReceiver<u8> {
let payload = vec![0; 0];
self.device.get(u8::from(HatBrickFunction::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(HatBrickFunction::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(HatBrickFunction::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(HatBrickFunction::SetStatusLedConfig), payload)
}
pub fn get_status_led_config(&self) -> ConvertingReceiver<u8> {
let payload = vec![0; 0];
self.device.get(u8::from(HatBrickFunction::GetStatusLedConfig), payload)
}
pub fn get_chip_temperature(&self) -> ConvertingReceiver<i16> {
let payload = vec![0; 0];
self.device.get(u8::from(HatBrickFunction::GetChipTemperature), payload)
}
pub fn reset(&self) -> ConvertingReceiver<()> {
let payload = vec![0; 0];
self.device.set(u8::from(HatBrickFunction::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(HatBrickFunction::WriteUid), payload)
}
pub fn read_uid(&self) -> ConvertingReceiver<u32> {
let payload = vec![0; 0];
self.device.get(u8::from(HatBrickFunction::ReadUid), payload)
}
pub fn get_identity(&self) -> ConvertingReceiver<Identity> {
let payload = vec![0; 0];
self.device.get(u8::from(HatBrickFunction::GetIdentity), payload)
}
}