1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982
pub use tokio;
pub use serial;
pub use async_channel;
use async_channel::{Receiver, Sender};
use serial::{BaudRate, CharSize, FlowControl, Parity, SerialPort, StopBits, SystemPort};
use serialport::available_ports;
use std::io::{Read, Write};
use std::time::{Duration, Instant};
use tokio::time::sleep;
#[derive(Debug, Clone)]
pub enum SerialInterfaceError {
CannotListPorts,
StopToChangeSettings,
DisconnectToChangeSettings,
CannotReadPort(Option<String>),
WrongReadArguments,
CannotOpenPort(String),
PortNotOpened,
SlaveModeNeedModbusID,
PortAlreadyOpen,
PortNeededToOpenPort,
SilenceMissing,
PathMissing,
NoPortToClose,
CannotSendMessage,
WrongMode,
CannotWritePort,
StopModeBeforeChange,
WaitingForResponse,
CannotSetTimeout,
}
/// Represents the status of the SerialInterface, indicating its current operation or state.
#[derive(Debug, Clone)]
pub enum Status {
Read,
Receipt,
Write,
WaitingResponse,
None,
}
/// Defines the operating modes of the SerialInterface.
#[derive(Debug, Clone, PartialEq)]
pub enum Mode {
/// Operating as a master in a master-slave configuration.
Master,
/// Operating as a slave in a master-slave configuration.
Slave,
/// Listening on the serial line without interfering.
Sniff,
/// Stopped or inactive state.
Stop,
}
#[derive(Debug, Clone)]
pub enum SerialMessage {
// Settings / Flow control (handled when Mode = Stop)
/// Request: Lists available serial ports.
/// Handled in 'Stop' mode. Response: Triggers `AvailablePorts` message with port list.
ListPorts,
/// Response: Provides a list of available serial ports.
/// Type: Vec<String> representing port names.
AvailablePorts(Vec<String>),
/// Request: Sets the serial port to be used.
/// Type: String representing the port path.
/// Handled in 'Stop' mode. Affects settings for subsequent `Connect` commands.
SetPort(String),
/// Request: Sets the baud rate for the serial communication.
/// Type: BaudRate.
/// Handled in 'Stop' mode. Updates baud rate settings for the serial interface.
SetBauds(BaudRate),
/// Request: Sets the character size for the serial communication.
/// Type: CharSize.
/// Handled in 'Stop' mode. Updates character size settings for the serial interface.
SetCharSize(CharSize),
/// Request: Sets the parity for the serial communication.
/// Type: Parity.
/// Handled in 'Stop' mode. Updates parity settings for the serial interface.
SetParity(Parity),
/// Request: Sets the stop bits for the serial communication.
/// Type: StopBits.
/// Handled in 'Stop' mode. Updates stop bits settings for the serial interface.
SetStopBits(StopBits),
/// Request: Sets the flow control for the serial communication.
/// Type: FlowControl.
/// Handled in 'Stop' mode. Updates flow control settings for the serial interface.
SetFlowControl(FlowControl),
/// Request: Sets the timeout for the serial communication.
/// Type: Duration.
/// Handled in all modes. Updates timeout settings for the serial interface.
SetTimeout(Duration),
/// Request: Establishes a connection using the current serial port settings.
/// Handled in 'Stop' mode. Response: `Connected(true)` on success, or an `Error` message on failure.
Connect,
/// Request: Disconnects the current serial connection.
/// Handled in all modes. Response: `Connected(false)` after disconnection.
Disconnect,
// Data messages (handled when mode != Stop)
/// Request: Sends data over the serial connection.
/// Type: Vec<u8> representing the data to be sent.
/// Handled when mode is not 'Stop'. Response: `DataSent` with the sent data upon successful transmission.
Send(Vec<u8>),
/// Response: Indicates that data has been sent over the serial connection.
/// Type: Vec<u8> representing the sent data.
DataSent(Vec<u8>),
/// Response: Indicates received data over the serial connection.
/// Type: Vec<u8> representing the received data.
Receive(Vec<u8>),
// General messages (always handled)
/// Request: Retrieves the current status of the serial interface.
/// Response: `Status` with the current status of the interface.
GetStatus,
/// Response: Indicates the current status of the serial interface.
/// Type: Status enum.
Status(Status),
/// Request: Retrieves the current connection status of the serial interface.
/// Response: `Connected` indicating whether the interface is connected.
GetConnectionStatus,
/// Response: Indicates the current connection status of the serial interface.
/// Type: bool indicating connection status.
Connected(bool),
/// Request: Sets the operating mode of the SerialInterface.
/// Type: Mode enum.
/// Changes the operating mode of the interface.
SetMode(Mode),
/// Response: Indicates the current operating mode of the SerialInterface.
/// Type: Mode enum.
Mode(Mode),
/// Response: Represents an error within the SerialInterface.
/// Type: SIError enum.
Error(SIError),
/// Request: Ping message for connection testing.
/// Response: Generates a `Pong` message in response.
Ping,
/// Response: Pong message as a response to a Ping.
Pong,
}
type SIError = SerialInterfaceError;
/// Represents a serial interface with various modes and functionalities.
/// It handles serial communication, including reading, writing, and managing port settings.
/// It operates in different modes such as Master, Slave, and Sniff.
pub struct SerialInterface {
path: Option<String>,
mode: Mode,
status: Status,
modbus_id: Option<u8>,
baud_rate: BaudRate,
char_size: CharSize,
parity: Parity,
stop_bits: StopBits,
flow_control: FlowControl,
port: Option<SystemPort>,
silence: Option<Duration>,
timeout: Duration,
receiver: Option<Receiver<SerialMessage>>,
sender: Option<Sender<SerialMessage>>,
last_byte_time: Option<Instant>,
}
impl SerialInterface {
/// Creates a new instance of the SerialInterface with default settings.
/// Returns a SerialInterface object encapsulated in a Result, with an error if initialization fails.
pub fn new() -> Result<Self, SIError> {
Ok(SerialInterface {
path: None,
mode: Mode::Stop,
status: Status::None,
modbus_id: None,
baud_rate: BaudRate::Baud115200,
char_size: CharSize::Bits8,
parity: Parity::ParityNone,
stop_bits: StopBits::Stop2,
flow_control: FlowControl::FlowNone,
port: None,
silence: Some(Duration::from_nanos(800)), // FIXME: what policy for init silence here?
timeout: Duration::from_nanos(10000), // FIXME: what policy for init timeout here?
receiver: None,
sender: None,
last_byte_time: None,
})
}
/// Sets the path for the serial interface.
/// Returns the modified instance of the SerialInterface for method chaining.
pub fn path(mut self, path: String) -> Self {
self.path = Some(path);
self
}
/// Sets the baud rate for the serial interface.
/// Returns the modified instance of the SerialInterface for method chaining.
pub fn bauds(mut self, bauds: BaudRate) -> Self {
self.baud_rate = bauds;
// TODO: if self.silence is none => automatic choice
self
}
/// Sets the character size for the serial interface.
/// Returns the modified instance of the SerialInterface for method chaining.
pub fn char_size(mut self, size: CharSize) -> Self {
self.char_size = size;
self
}
/// Sets the parity for the serial interface.
/// Returns the modified instance of the SerialInterface for method chaining.
pub fn parity(mut self, parity: Parity) -> Self {
self.parity = parity;
self
}
/// Sets the parity for the serial interface.
/// Returns the modified instance of the SerialInterface for method chaining.
pub fn stop_bits(mut self, stop_bits: StopBits) -> Self {
self.stop_bits = stop_bits;
self
}
/// Sets the flow control for the serial interface.
/// Returns the modified instance of the SerialInterface for method chaining.
pub fn flow_control(mut self, flow_control: FlowControl) -> Self {
self.flow_control = flow_control;
self
}
/// Sets the operating mode of the SerialInterface.
/// The mode can be changed only when the current mode is 'Stop'.
/// Returns a Result with the modified instance or an error if the mode cannot be changed.
pub fn mode(mut self, mode: Mode) -> Result<Self, SIError> {
if let Mode::Stop = &self.mode {
self.mode = mode;
Ok(self)
} else {
Err(SIError::StopToChangeSettings)
}
}
/// Sets the Modbus ID for the serial interface.
/// Returns the modified instance of the SerialInterface for method chaining.
pub fn modbus_id(mut self, modbus_id: u8) -> Self {
self.modbus_id = Some(modbus_id);
self
}
/// Sets the silence interval for the serial interface. Silence interval used to detect
/// end of modbus frame.
/// Returns the modified instance of the SerialInterface for method chaining.
pub fn silence(mut self, silence: Duration) -> Self {
self.silence = Some(silence);
self
}
/// Sets the receiver channel for the serial interface.
/// Returns the modified instance of the SerialInterface for method chaining.
pub fn receiver(mut self, receiver: Receiver<SerialMessage>) -> Self {
self.receiver = Some(receiver);
self
}
/// Sets the sender channel for the serial interface.
/// Returns the modified instance of the SerialInterface for method chaining.
pub fn sender(mut self, sender: Sender<SerialMessage>) -> Self {
self.sender = Some(sender);
self
}
/// Sets the operating mode of the SerialInterface.
/// Can only be set when the current mode is 'Stop'.
/// Returns a Result with () or an error if the mode cannot be changed.
pub fn set_mode(&mut self, m: Mode) -> Result<(), SIError> {
if let Mode::Stop = &self.mode {
if self.modbus_id.is_none() {
if let Mode::Slave = m {
return Err(SIError::SlaveModeNeedModbusID);
}
} else if self.port.is_some() {
return Err(SIError::DisconnectToChangeSettings);
}
self.mode = m;
log::info!("SerialInterface::switch mode to {:?}", &self.mode);
Ok(())
} else {
Err(SIError::StopToChangeSettings)
}
}
/// Retrieves the current operating mode of the SerialInterface.
pub fn get_mode(&self) -> &Mode {
&self.mode
}
/// Retrieves the current status of the SerialInterface.
pub fn get_state(&self) -> &Status {
&self.status
}
/// Lists available serial ports.
/// Returns a Result containing a list of port names or an error if ports cannot be listed.
pub fn list_ports() -> Result<Vec<String>, SIError> {
// TODO: get rid of serialport crate dependency
if let Ok(ports) = available_ports() {
Ok(ports.iter().map(|p| p.port_name.clone()).collect())
} else {
Err(SerialInterfaceError::CannotListPorts)
}
// Ok(vec!["/dev/ttyXR0".to_string(), "/dev/ttyXR1".to_string()])
}
/// CLear data from the read buffer.
fn clear_read_buffer(&mut self) -> Result<(), SIError> {
let port_open = self.port.is_some();
if port_open {
let mut buffer = [0u8; 24];
loop {
let read = self.port.as_mut().unwrap().read(&mut buffer);
let ret = match read {
Ok(r) => {
log::info!("SerialInterface::buffer clear {:?}", buffer.to_vec());
r
}
Err(e) => {
let str_err = e.to_string();
if str_err == *"Operation timed out" {
0
} else {
return Err(SIError::CannotReadPort(Some(str_err)));
}
}
};
if ret == 0 {
break;
};
}
Ok(())
} else {
Err(SIError::PortNotOpened)
}
}
/// Read 1 bytes of data, return None if no data in buffer.
fn read_byte(&mut self) -> Result<Option<u8>, SIError> {
let port_open = self.port.is_some();
if port_open {
let mut buffer = [0u8; 1];
let read = self.port.as_mut().unwrap().read(&mut buffer);
let l = match read {
Ok(r) => r,
Err(e) => {
let str_err = e.to_string();
if str_err == *"Operation timed out" {
0
} else {
return Err(SIError::CannotReadPort(Some(str_err)));
}
}
};
if l > 0 {
let rcv_time = Instant::now();
let from_last = self
.last_byte_time
.map(|last_byte| rcv_time.duration_since(last_byte));
log::debug!(
"SerialInterface::read_byte({:?}, from last: {:?})",
buffer,
from_last
);
self.last_byte_time = Some(rcv_time);
Ok(Some(buffer[0]))
} else {
Ok(None)
}
} else {
Err(SIError::PortNotOpened)
}
}
/// Generalist read() implementation, polling serial buffer, while not data been received on serial buffer,
/// checking received messages on self.receiver , if Send() received, return.
/// Error if none of size/silence/timeout passed.
#[allow(unused)]
async fn read_until_size_or_silence_or_timeout_or_message(
&mut self,
size: Option<usize>,
silence: Option<&Duration>,
timeout: Option<&Duration>,
) -> Result<Option<SerialMessage>, SIError> {
self.clear_read_buffer()?;
let mut buffer: Vec<u8> = Vec::new();
let start = Instant::now();
let mut last_data = Instant::now();
if !(size.is_some() || timeout.is_some() || silence.is_some()) {
return Err(SIError::WrongReadArguments);
}
loop {
let result = self.read_byte()?;
// receive data
if let Some(data) = result {
// log::debug!("Start receive data: {}", data);
self.status = Status::Receipt;
buffer.push(data);
// reset the silence counter
last_data = Instant::now();
// check for size reach
if let Some(size) = &size {
if &buffer.len() == size {
let result = self
.send_message(SerialMessage::Receive(buffer.clone()))
.await;
self.status = Status::None;
return if let Err(e) = result {
Err(e)
} else {
Ok(None)
};
}
}
} else if let Some(silence) = silence {
// we not yet start receive
if buffer.is_empty() {
// Wait to receive first data
if let Some(msg) = self.read_message().await? {
return Ok(Some(msg));
}
last_data = Instant::now();
} else {
// receiving and waiting for silence
let from_last_data = &Instant::now().duration_since(last_data);
// log::debug!("Duration from last data: {:?}", from_last_data);
if from_last_data > silence {
log::debug!("silence reached, data received: {:?}", buffer.to_vec());
let result = self
.send_message(SerialMessage::Receive(buffer.clone()))
.await;
self.status = Status::None;
return if let Err(e) = result {
Err(e)
} else {
Ok(None)
};
}
}
}
// check timeout
if let Some(timeout) = timeout {
if &Instant::now().duration_since(start) > timeout {
if !buffer.is_empty() {
let result = self
.send_message(SerialMessage::Receive(buffer.clone()))
.await;
self.status = Status::None;
return if let Err(e) = result {
Err(e)
} else {
Ok(None)
};
}
return Ok(None);
}
}
}
}
/// Read <s> bytes of data, blocking until get the <s> number of bytes.
#[allow(unused)]
async fn read_size(&mut self, s: usize) -> Result<Option<SerialMessage>, SIError> {
self.read_until_size_or_silence_or_timeout_or_message(Some(s), None, None)
.await
}
/// Should be use to listen to a Request response in Master.
#[allow(unused)]
async fn read_until_size_or_silence(
&mut self,
size: usize,
silence: &Duration,
) -> Result<Option<SerialMessage>, SIError> {
self.read_until_size_or_silence_or_timeout_or_message(Some(size), Some(silence), None)
.await
}
/// Should be use to listen in Slave/Sniffing , when you don't know the size of the incoming Request.
#[allow(unused)]
async fn read_until_silence(
&mut self,
silence: &Duration,
) -> Result<Option<SerialMessage>, SIError> {
self.read_until_size_or_silence_or_timeout_or_message(None, Some(silence), None)
.await
}
#[allow(unused)]
async fn read_until_silence_or_timeout(
&mut self,
silence: &Duration,
timeout: &Duration,
) -> Result<Option<SerialMessage>, SIError> {
self.read_until_size_or_silence_or_timeout_or_message(None, Some(silence), Some(timeout))
.await
}
/// Open the serial port.
pub fn open(&mut self) -> Result<(), SIError> {
if self.port.is_some() || self.mode != Mode::Stop {
Err(SIError::PortAlreadyOpen)
// TODO => SlaveModeNeedModbusID move this Mode::Slave
// } else if self.modbus_id.is_none() {
// Err(SIError::SlaveModeNeedModbusID)
// } else if self.mode != Mode::Master && self.silence.is_none() {
// Err(SIError::SilenceMissing)
} else if self.path.is_none() {
Err(SIError::PathMissing)
} else {
let mut port = serial::open(&self.path.as_ref().unwrap())
.map_err(|e| SIError::CannotOpenPort(e.to_string()))?;
let settings = serial::PortSettings {
baud_rate: self.baud_rate,
char_size: self.char_size,
parity: self.parity,
stop_bits: self.stop_bits,
flow_control: self.flow_control,
};
port.configure(&settings).unwrap();
port.set_timeout(Duration::from_nanos(10))
.map_err(|_| SIError::CannotSetTimeout)?;
self.port = Some(port);
Ok(())
}
}
/// Close the serial port.
pub fn close(&mut self) -> Result<(), SIError> {
if let Some(port) = self.port.take() {
drop(port);
Ok(())
} else {
Err(SIError::NoPortToClose)
}
}
/// Try to send a message trough self.sender
async fn send_message(&mut self, msg: SerialMessage) -> Result<(), SIError> {
if let Some(sender) = self.sender.clone() {
log::debug!("SerialInterface::Send {:?}", &msg);
sender
.send(msg)
.await
.map_err(|_| SIError::CannotSendMessage)?;
Ok(())
} else {
Err(SIError::CannotSendMessage)
}
}
/// Poll self.receiver channel and handle if there is one message. Return the message if it should be
/// handled externally. Two kind messages can be returned:
/// - SerialMessage::SetMode()
/// - SerialMessage::Send()
async fn read_message(&mut self) -> Result<Option<SerialMessage>, SIError> {
if let Some(receiver) = self.receiver.clone() {
if let Ok(message) = receiver.try_recv() {
log::info!("SerialInterface::Receive {:?}", &message);
// general case, message to handle in any situation
match &message {
SerialMessage::GetConnectionStatus => {
if let Some(_port) = &self.port {
self.send_message(SerialMessage::Connected(true)).await?;
} else {
self.send_message(SerialMessage::Connected(false)).await?;
}
return Ok(None);
}
SerialMessage::GetStatus => {
self.send_message(SerialMessage::Status(self.status.clone()))
.await?;
return Ok(None);
}
// If ask for change mode, we return message to caller in order it can handle it.
SerialMessage::SetMode(mode) => {
return Ok(Some(SerialMessage::SetMode(mode.clone())));
}
SerialMessage::SetTimeout(timeout) => {
self.timeout = *timeout;
return Ok(None);
}
SerialMessage::Ping => {
self.send_message(SerialMessage::Pong).await?;
return Ok(None);
}
_ => {}
}
// Stop case: Settings / Flow control
if self.mode == Mode::Stop {
match message {
SerialMessage::ListPorts => {
self.send_message(SerialMessage::AvailablePorts(
SerialInterface::list_ports()?,
))
.await?;
return Ok(None);
}
SerialMessage::SetPort(port) => {
self.path = Some(port);
return Ok(None);
}
SerialMessage::SetBauds(bauds) => {
self.baud_rate = bauds;
// TODO: update silence?
return Ok(None);
}
SerialMessage::SetCharSize(char_size) => {
self.char_size = char_size;
return Ok(None);
}
SerialMessage::SetParity(parity) => {
self.parity = parity;
return Ok(None);
}
SerialMessage::SetStopBits(stop_bits) => {
self.stop_bits = stop_bits;
return Ok(None);
}
SerialMessage::SetFlowControl(flow_control) => {
self.flow_control = flow_control;
return Ok(None);
}
SerialMessage::Connect => {
if let Err(e) = self.open() {
self.send_message(SerialMessage::Connected(false)).await?;
self.send_message(SerialMessage::Error(e)).await?;
} else {
self.send_message(SerialMessage::Connected(true)).await?;
}
return Ok(None);
}
SerialMessage::Disconnect => {
let result = self.close();
self.send_message(SerialMessage::Connected(false)).await?;
if let Err(e) = result {
self.send_message(SerialMessage::Error(e)).await?;
}
}
_ => {}
}
} else if let SerialMessage::Send(data) = message {
return Ok(Some(SerialMessage::Send(data)));
}
}
}
Ok(None)
}
/// Write data to the serial line.
async fn write(&mut self, data: Vec<u8>) -> Result<(), SIError> {
log::info!("write({:?})", data.clone());
let port_open = self.port.is_some();
if port_open {
let buffer = &data[0..data.len()];
self.port
.as_mut()
.unwrap()
.write(buffer)
.map_err(|_| SIError::CannotWritePort)?;
self.send_message(SerialMessage::DataSent(data)).await?;
Ok(())
} else {
Err(SIError::PortNotOpened)
}
}
/// Sniffing feature: listen on serial line and send a SerialMessage::Receive() via mpsc channel for every serial
/// request received, for every loop iteration, check if a SerialMessage is arrived via mpsc channel.
/// If receive a SerialMessage::Send(), pause listen in order to send message then resume listening.
/// Stop listening if receive SerialMessage::SetMode(Stop). Almost SerialMessage are handled silently by self.read_message().
pub async fn listen(&mut self) -> Result<Option<Mode>, SIError> {
loop {
if let Some(silence) = &self.silence.clone() {
log::debug!("silence={:?}", silence);
self.status = Status::Read;
if let Some(msg) = self.read_until_silence(silence).await? {
match msg {
SerialMessage::Send(data) => {
self.status = Status::Write;
let write = self.write(data).await;
self.status = Status::None;
if let Err(e) = write {
self.send_message(SerialMessage::Error(e)).await?;
}
}
SerialMessage::SetMode(mode) => {
if mode != Mode::Stop && mode != Mode::Sniff {
self.send_message(SerialMessage::Error(
SIError::StopModeBeforeChange,
))
.await?;
} else if let Mode::Stop = mode {
self.status = Status::None;
return Ok(Some(mode));
}
}
_ => {}
}
} else {
self.status = Status::None;
return Ok(None);
}
} else {
return Err(SIError::SilenceMissing);
}
}
}
/// Master feature: write a request, then wait for response, when response received, stop listening.
/// Returns early if receive SerialMessage::SetMode(Mode::Stop)). Does not accept SerialMessage::Send() as
/// we already waiting for a response. Almost SerialMessage are handled silently by self.read_message().
pub async fn write_read(
&mut self,
data: Vec<u8>,
timeout: &Duration,
) -> Result<Option<SerialMessage>, SIError> {
if let Some(silence) = &self.silence.clone() {
self.status = Status::Write;
if let Err(e) = self.write(data).await {
self.status = Status::None;
return Err(e);
} else {
self.status = Status::WaitingResponse;
}
loop {
if let Some(msg) = self.read_until_silence_or_timeout(silence, timeout).await? {
match msg {
SerialMessage::Send(_data) => {
// we already waiting for response cannot send request now.
self.send_message(SerialMessage::Error(SIError::WaitingForResponse))
.await?;
continue;
}
SerialMessage::SetMode(mode) => {
if mode == Mode::Stop {
self.status = Status::None;
return Ok(Some(SerialMessage::SetMode(Mode::Stop)));
} else if mode == Mode::Slave || mode == Mode::Sniff {
self.send_message(SerialMessage::Error(
SIError::StopModeBeforeChange,
))
.await?;
continue;
}
}
_ => {
continue;
}
}
} else {
// Stop after silence or timeout, return
self.status = Status::None;
return Ok(None);
}
}
} else {
Err(SIError::SilenceMissing)
}
}
/// Slave feature: listen the line until request receive, then stop listening. Returns early if receive
/// SerialMessage::SetMode(Mode::Stop) or SerialMessage::Send(). Almost SerialMessage are handled silently
/// by self.read_message().
pub async fn wait_for_request(&mut self) -> Result<Option<SerialMessage>, SIError> {
if let Some(silence) = self.silence {
loop {
self.status = Status::Read;
let result = self.read_until_silence(&silence).await;
self.status = Status::None;
let read: Option<SerialMessage> = match result {
Ok(r) => r,
Err(e) => {
return Err(e);
}
};
if let Some(msg) = read {
match msg {
SerialMessage::Send(data) => {
return Ok(Some(SerialMessage::Send(data.clone())));
}
SerialMessage::SetMode(mode) => {
if mode == Mode::Stop {
return Ok(Some(SerialMessage::SetMode(Mode::Stop)));
} else {
self.send_message(SerialMessage::Error(
SIError::StopModeBeforeChange,
))
.await?;
continue;
}
}
_ => {
continue;
}
}
} else {
return Ok(None);
}
}
} else {
Err(SIError::SilenceMissing)
}
}
/// Master loop
async fn run_master(&mut self) -> Result<Option<Mode>, SIError> {
loop {
match self.read_message().await {
Ok(msg) => {
if let Some(msg) = msg {
match msg {
SerialMessage::SetMode(mode) => {
if mode == Mode::Stop {
return Ok(Some(Mode::Stop));
}
}
SerialMessage::Send(data) => {
match self.write_read(data, &self.timeout.clone()).await {
Ok(msg) => {
if let Some(SerialMessage::SetMode(Mode::Stop)) = msg {
return Ok(Some(Mode::Stop));
}
}
Err(e) => {
log::error!("{:?}", e);
}
}
}
_ => {
continue;
}
}
}
}
Err(e) => {
log::error!("{:?}", e);
}
}
}
}
/// Slave loop
async fn run_slave(&mut self) -> Result<Option<Mode>, SIError> {
loop {
match self.wait_for_request().await {
Ok(msg) => {
if let Some(SerialMessage::SetMode(Mode::Stop)) = msg {
return Ok(Some(Mode::Stop));
}
}
Err(e) => {
log::error!("{:?}", e);
}
}
}
}
/// Sniff loop
async fn run_sniff(&mut self) -> Result<Option<Mode>, SIError> {
loop {
match self.listen().await {
Ok(msg) => {
if let Some(Mode::Stop) = msg {
return Ok(Some(Mode::Stop));
}
}
Err(e) => {
log::error!("SerialInterface::run_sniff():{:?}", e.clone());
return Err(e);
}
}
}
}
/// Main loop
pub async fn start(&mut self) {
log::info!("SerialInterface::run()");
loop {
sleep(Duration::from_nanos(1)).await;
match &self.mode {
Mode::Stop => {
let result = self.read_message().await;
match result {
Ok(msg) => {
if let Some(SerialMessage::SetMode(mode)) = msg {
log::info!("SerialInterface::switch mode to {:?}", &mode);
self.mode = mode;
}
}
Err(e) => {
log::error!("Mode Stop: {:?}", e);
}
}
}
Mode::Master => {
let result = self.run_master().await;
match result {
Ok(msg) => {
if let Some(Mode::Stop) = msg {
log::info!("SerialInterface::switch mode to Mode::Stop");
self.mode = Mode::Stop;
}
}
Err(e) => {
log::error!("{:?}", e);
log::info!("SerialInterface::switch mode to Mode::Stop");
self.mode = Mode::Stop;
}
}
}
Mode::Slave => {
let result = self.run_slave().await;
match result {
Ok(msg) => {
if let Some(Mode::Stop) = msg {
log::info!("SerialInterface::switch mode to Mode::Stop");
self.mode = Mode::Stop;
}
}
Err(e) => {
log::error!("{:?}", e);
log::info!("SerialInterface::switch mode to Mode::Stop");
self.mode = Mode::Stop;
}
}
}
Mode::Sniff => {
let result = self.run_sniff().await;
match result {
Ok(msg) => {
if let Some(Mode::Stop) = msg {
log::info!("SerialInterface::switch mode to Mode::Stop");
self.mode = Mode::Stop;
}
}
Err(e) => {
log::error!("{:?}", e);
log::info!("SerialInterface::switch mode to Mode::Stop");
self.mode = Mode::Stop;
}
}
}
}
}
}
}