use crate::{
byte_converter::*,
converting_receiver::{BrickletRecvTimeoutError, ConvertingReceiver},
device::*,
ip_connection::GetRequestSender,
low_level_traits::*,
};
pub enum OneWireBrickletFunction {
SearchBusLowLevel,
ResetBus,
Write,
Read,
WriteCommand,
SetCommunicationLedConfig,
GetCommunicationLedConfig,
GetSpitfpErrorCount,
SetBootloaderMode,
GetBootloaderMode,
SetWriteFirmwarePointer,
WriteFirmware,
SetStatusLedConfig,
GetStatusLedConfig,
GetChipTemperature,
Reset,
WriteUid,
ReadUid,
GetIdentity,
}
impl From<OneWireBrickletFunction> for u8 {
fn from(fun: OneWireBrickletFunction) -> Self {
match fun {
OneWireBrickletFunction::SearchBusLowLevel => 1,
OneWireBrickletFunction::ResetBus => 2,
OneWireBrickletFunction::Write => 3,
OneWireBrickletFunction::Read => 4,
OneWireBrickletFunction::WriteCommand => 5,
OneWireBrickletFunction::SetCommunicationLedConfig => 6,
OneWireBrickletFunction::GetCommunicationLedConfig => 7,
OneWireBrickletFunction::GetSpitfpErrorCount => 234,
OneWireBrickletFunction::SetBootloaderMode => 235,
OneWireBrickletFunction::GetBootloaderMode => 236,
OneWireBrickletFunction::SetWriteFirmwarePointer => 237,
OneWireBrickletFunction::WriteFirmware => 238,
OneWireBrickletFunction::SetStatusLedConfig => 239,
OneWireBrickletFunction::GetStatusLedConfig => 240,
OneWireBrickletFunction::GetChipTemperature => 242,
OneWireBrickletFunction::Reset => 243,
OneWireBrickletFunction::WriteUid => 248,
OneWireBrickletFunction::ReadUid => 249,
OneWireBrickletFunction::GetIdentity => 255,
}
}
}
pub const ONE_WIRE_BRICKLET_STATUS_OK: u8 = 0;
pub const ONE_WIRE_BRICKLET_STATUS_BUSY: u8 = 1;
pub const ONE_WIRE_BRICKLET_STATUS_NO_PRESENCE: u8 = 2;
pub const ONE_WIRE_BRICKLET_STATUS_TIMEOUT: u8 = 3;
pub const ONE_WIRE_BRICKLET_STATUS_ERROR: u8 = 4;
pub const ONE_WIRE_BRICKLET_COMMUNICATION_LED_CONFIG_OFF: u8 = 0;
pub const ONE_WIRE_BRICKLET_COMMUNICATION_LED_CONFIG_ON: u8 = 1;
pub const ONE_WIRE_BRICKLET_COMMUNICATION_LED_CONFIG_SHOW_HEARTBEAT: u8 = 2;
pub const ONE_WIRE_BRICKLET_COMMUNICATION_LED_CONFIG_SHOW_COMMUNICATION: u8 = 3;
pub const ONE_WIRE_BRICKLET_BOOTLOADER_MODE_BOOTLOADER: u8 = 0;
pub const ONE_WIRE_BRICKLET_BOOTLOADER_MODE_FIRMWARE: u8 = 1;
pub const ONE_WIRE_BRICKLET_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT: u8 = 2;
pub const ONE_WIRE_BRICKLET_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT: u8 = 3;
pub const ONE_WIRE_BRICKLET_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT: u8 = 4;
pub const ONE_WIRE_BRICKLET_BOOTLOADER_STATUS_OK: u8 = 0;
pub const ONE_WIRE_BRICKLET_BOOTLOADER_STATUS_INVALID_MODE: u8 = 1;
pub const ONE_WIRE_BRICKLET_BOOTLOADER_STATUS_NO_CHANGE: u8 = 2;
pub const ONE_WIRE_BRICKLET_BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT: u8 = 3;
pub const ONE_WIRE_BRICKLET_BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT: u8 = 4;
pub const ONE_WIRE_BRICKLET_BOOTLOADER_STATUS_CRC_MISMATCH: u8 = 5;
pub const ONE_WIRE_BRICKLET_STATUS_LED_CONFIG_OFF: u8 = 0;
pub const ONE_WIRE_BRICKLET_STATUS_LED_CONFIG_ON: u8 = 1;
pub const ONE_WIRE_BRICKLET_STATUS_LED_CONFIG_SHOW_HEARTBEAT: u8 = 2;
pub const ONE_WIRE_BRICKLET_STATUS_LED_CONFIG_SHOW_STATUS: u8 = 3;
#[derive(Clone, Copy, Debug, Default, PartialEq, Eq, Hash)]
pub struct SearchBusLowLevel {
pub identifier_length: u16,
pub identifier_chunk_offset: u16,
pub identifier_chunk_data: [u64; 7],
pub status: u8,
}
impl FromByteSlice for SearchBusLowLevel {
fn bytes_expected() -> usize { 61 }
fn from_le_byte_slice(bytes: &[u8]) -> SearchBusLowLevel {
SearchBusLowLevel {
identifier_length: <u16>::from_le_byte_slice(&bytes[0..2]),
identifier_chunk_offset: <u16>::from_le_byte_slice(&bytes[2..4]),
identifier_chunk_data: <[u64; 7]>::from_le_byte_slice(&bytes[4..60]),
status: <u8>::from_le_byte_slice(&bytes[60..61]),
}
}
}
impl LowLevelRead<u64, SearchBusResult> for SearchBusLowLevel {
fn ll_message_length(&self) -> usize { self.identifier_length as usize }
fn ll_message_chunk_offset(&self) -> usize { self.identifier_chunk_offset as usize }
fn ll_message_chunk_data(&self) -> &[u64] { &self.identifier_chunk_data }
fn get_result(&self) -> SearchBusResult { SearchBusResult { status: self.status } }
}
#[derive(Clone, Copy, Debug, Default, PartialEq, Eq, Hash)]
pub struct Read {
pub data: u8,
pub status: u8,
}
impl FromByteSlice for Read {
fn bytes_expected() -> usize { 2 }
fn from_le_byte_slice(bytes: &[u8]) -> Read {
Read { data: <u8>::from_le_byte_slice(&bytes[0..1]), status: <u8>::from_le_byte_slice(&bytes[1..2]) }
}
}
#[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 SearchBusResult {
pub status: u8,
}
#[derive(Clone)]
pub struct OneWireBricklet {
device: Device,
}
impl OneWireBricklet {
pub const DEVICE_IDENTIFIER: u16 = 2123;
pub const DEVICE_DISPLAY_NAME: &'static str = "One Wire Bricklet";
pub fn new<T: GetRequestSender>(uid: &str, req_sender: T) -> OneWireBricklet {
let mut result = OneWireBricklet { device: Device::new([2, 0, 0], uid, req_sender, 1) };
result.device.response_expected[u8::from(OneWireBrickletFunction::SearchBusLowLevel) as usize] = ResponseExpectedFlag::AlwaysTrue;
result.device.response_expected[u8::from(OneWireBrickletFunction::ResetBus) as usize] = ResponseExpectedFlag::AlwaysTrue;
result.device.response_expected[u8::from(OneWireBrickletFunction::Write) as usize] = ResponseExpectedFlag::AlwaysTrue;
result.device.response_expected[u8::from(OneWireBrickletFunction::Read) as usize] = ResponseExpectedFlag::AlwaysTrue;
result.device.response_expected[u8::from(OneWireBrickletFunction::WriteCommand) as usize] = ResponseExpectedFlag::AlwaysTrue;
result.device.response_expected[u8::from(OneWireBrickletFunction::SetCommunicationLedConfig) as usize] =
ResponseExpectedFlag::False;
result.device.response_expected[u8::from(OneWireBrickletFunction::GetCommunicationLedConfig) as usize] =
ResponseExpectedFlag::AlwaysTrue;
result.device.response_expected[u8::from(OneWireBrickletFunction::GetSpitfpErrorCount) as usize] = ResponseExpectedFlag::AlwaysTrue;
result.device.response_expected[u8::from(OneWireBrickletFunction::SetBootloaderMode) as usize] = ResponseExpectedFlag::AlwaysTrue;
result.device.response_expected[u8::from(OneWireBrickletFunction::GetBootloaderMode) as usize] = ResponseExpectedFlag::AlwaysTrue;
result.device.response_expected[u8::from(OneWireBrickletFunction::SetWriteFirmwarePointer) as usize] = ResponseExpectedFlag::False;
result.device.response_expected[u8::from(OneWireBrickletFunction::WriteFirmware) as usize] = ResponseExpectedFlag::AlwaysTrue;
result.device.response_expected[u8::from(OneWireBrickletFunction::SetStatusLedConfig) as usize] = ResponseExpectedFlag::False;
result.device.response_expected[u8::from(OneWireBrickletFunction::GetStatusLedConfig) as usize] = ResponseExpectedFlag::AlwaysTrue;
result.device.response_expected[u8::from(OneWireBrickletFunction::GetChipTemperature) as usize] = ResponseExpectedFlag::AlwaysTrue;
result.device.response_expected[u8::from(OneWireBrickletFunction::Reset) as usize] = ResponseExpectedFlag::False;
result.device.response_expected[u8::from(OneWireBrickletFunction::WriteUid) as usize] = ResponseExpectedFlag::False;
result.device.response_expected[u8::from(OneWireBrickletFunction::ReadUid) as usize] = ResponseExpectedFlag::AlwaysTrue;
result.device.response_expected[u8::from(OneWireBrickletFunction::GetIdentity) as usize] = ResponseExpectedFlag::AlwaysTrue;
result
}
pub fn get_response_expected(&mut self, fun: OneWireBrickletFunction) -> Result<bool, GetResponseExpectedError> {
self.device.get_response_expected(u8::from(fun))
}
pub fn set_response_expected(&mut self, fun: OneWireBrickletFunction, 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 search_bus_low_level(&self) -> ConvertingReceiver<SearchBusLowLevel> {
let payload = vec![0; 0];
self.device.get(u8::from(OneWireBrickletFunction::SearchBusLowLevel), payload)
}
pub fn search_bus(&self) -> Result<(Vec<u64>, u8), BrickletRecvTimeoutError> {
let ll_result = self.device.get_high_level(0, &mut || self.search_bus_low_level().recv())?;
Ok((ll_result.0, ll_result.1.status))
}
pub fn reset_bus(&self) -> ConvertingReceiver<u8> {
let payload = vec![0; 0];
self.device.get(u8::from(OneWireBrickletFunction::ResetBus), payload)
}
pub fn write(&self, data: u8) -> ConvertingReceiver<u8> {
let mut payload = vec![0; 1];
payload[0..1].copy_from_slice(&<u8>::to_le_byte_vec(data));
self.device.get(u8::from(OneWireBrickletFunction::Write), payload)
}
pub fn read(&self) -> ConvertingReceiver<Read> {
let payload = vec![0; 0];
self.device.get(u8::from(OneWireBrickletFunction::Read), payload)
}
pub fn write_command(&self, identifier: u64, command: u8) -> ConvertingReceiver<u8> {
let mut payload = vec![0; 9];
payload[0..8].copy_from_slice(&<u64>::to_le_byte_vec(identifier));
payload[8..9].copy_from_slice(&<u8>::to_le_byte_vec(command));
self.device.get(u8::from(OneWireBrickletFunction::WriteCommand), payload)
}
pub fn set_communication_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(OneWireBrickletFunction::SetCommunicationLedConfig), payload)
}
pub fn get_communication_led_config(&self) -> ConvertingReceiver<u8> {
let payload = vec![0; 0];
self.device.get(u8::from(OneWireBrickletFunction::GetCommunicationLedConfig), payload)
}
pub fn get_spitfp_error_count(&self) -> ConvertingReceiver<SpitfpErrorCount> {
let payload = vec![0; 0];
self.device.get(u8::from(OneWireBrickletFunction::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(OneWireBrickletFunction::SetBootloaderMode), payload)
}
pub fn get_bootloader_mode(&self) -> ConvertingReceiver<u8> {
let payload = vec![0; 0];
self.device.get(u8::from(OneWireBrickletFunction::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(OneWireBrickletFunction::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(OneWireBrickletFunction::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(OneWireBrickletFunction::SetStatusLedConfig), payload)
}
pub fn get_status_led_config(&self) -> ConvertingReceiver<u8> {
let payload = vec![0; 0];
self.device.get(u8::from(OneWireBrickletFunction::GetStatusLedConfig), payload)
}
pub fn get_chip_temperature(&self) -> ConvertingReceiver<i16> {
let payload = vec![0; 0];
self.device.get(u8::from(OneWireBrickletFunction::GetChipTemperature), payload)
}
pub fn reset(&self) -> ConvertingReceiver<()> {
let payload = vec![0; 0];
self.device.set(u8::from(OneWireBrickletFunction::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(OneWireBrickletFunction::WriteUid), payload)
}
pub fn read_uid(&self) -> ConvertingReceiver<u32> {
let payload = vec![0; 0];
self.device.get(u8::from(OneWireBrickletFunction::ReadUid), payload)
}
pub fn get_identity(&self) -> ConvertingReceiver<Identity> {
let payload = vec![0; 0];
self.device.get(u8::from(OneWireBrickletFunction::GetIdentity), payload)
}
}