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
/* * File: src/serial/mod.rs * Date: 30.09.2018 * Author: MarkAtk * * MIT License * * Copyright (c) 2018 MarkAtk * * Permission is hereby granted, free of charge, to any person obtaining a copy of * this software and associated documentation files (the "Software"), to deal in * the Software without restriction, including without limitation the rights to * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies * of the Software, and to permit persons to whom the Software is furnished to do * so, subject to the following conditions: * * The above copyright notice and this permission notice shall be included in all * copies or substantial portions of the Software. * * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE * SOFTWARE. */ use std::boxed::Box; use std::io; use std::str; use std::time::Duration; use serialport; use crate::utils; pub mod settings; /// A serial port connection. /// /// This struct handles the complete communication with a serial device regardless of the platform. pub struct Serial { port: Box<dyn serialport::SerialPort>, read_buffer: Vec<u8> } impl Serial { /// Open a new connection with default settings. /// /// The port name is platform specific, e.g. starts with `COM` on Windows and `/dev/tty` or similar on UNIX systems. /// /// Default settings are: /// - Baud rate: 9600 /// - Timeout: 1000 (ms) /// - Data bits: 8 /// - Parity: None, /// - Stop bits: 1, /// - Flow control: None /// /// # Example /// /// ``` /// use serial_unit_testing::serial::Serial; /// /// fn main() -> Result<(), std::io::Error> { /// let mut serial = Serial::open("/dev/ttyACM0")?; /// serial.write("Hello World!")?; /// /// Ok(()) /// } /// /// ``` pub fn open(port_name: &str) -> Result<Serial, io::Error> { let settings: settings::Settings = Default::default(); Serial::open_with_settings(port_name, &settings) } /// Open a new connection with given settings. /// /// The port name is platform specific, e.g. starts with `COM` on Windows and `/dev/tty` or similar on UNIX systems. /// /// # Example /// /// ``` /// use serial_unit_testing::serial::Serial; /// use serial_unit_testing::serial::settings::Settings; /// /// fn main() -> Result<(), std::io::Error> { /// let mut settings = Settings::default(); /// settings.baud_rate = 115200; /// /// let mut serial = Serial::open_with_settings("/dev/ttyACM0", &settings)?; /// serial.write("Hello World!")?; /// /// Ok(()) /// } /// /// ``` pub fn open_with_settings(port_name: &str, settings: &settings::Settings) -> Result<Serial, io::Error> { match serialport::open_with_settings(&port_name, &settings.to_serial_port_settings()) { Ok(port) => { Ok(Serial { port, read_buffer: vec![0; 1000] }) }, Err(e) => Err(io::Error::new(io::ErrorKind::Other, e)) } } /// Write text to the serial port. /// /// This is the same as using `Serial::write_format` with `TextFormat::Text` as format specifier. pub fn write(&mut self, text: &str) -> Result<(), io::Error> { self.port.write(text.as_bytes())?; Ok(()) } /// Write data in the given format. /// /// For a list of supported formats see `TextFormat`. `TextFormat::Text` is the same as using `Serial::write`. /// /// # Example /// /// ``` /// use serial_unit_testing::serial::Serial; /// use serial_unit_testing::utils::TextFormat; /// /// fn main() -> Result<(), std::io::Error> { /// let mut serial = Serial::open("/dev/ttyACM0")?; /// serial.write_format("0a5f", TextFormat::Hex)?; /// /// Ok(()) /// } /// /// ``` pub fn write_format(&mut self, text: &str, text_format: utils::TextFormat) -> Result<(), io::Error> { let bytes = match text_format { utils::TextFormat::Binary => utils::bytes_from_binary_string(text).unwrap(), utils::TextFormat::Octal => utils::bytes_from_octal_string(text).unwrap(), utils::TextFormat::Decimal => utils::bytes_from_decimal_string(text).unwrap(), utils::TextFormat::Hex => utils::bytes_from_hex_string(text).unwrap(), _ => { let mut bytes = Vec::new(); bytes.extend_from_slice(text.as_bytes()); bytes } }; self.port.write(bytes.as_slice())?; Ok(()) } /// Read any amount of data. /// /// At least one byte of data must be read to return data. The method fails when no data could be read in the timeout duration. /// /// # Example /// /// ``` /// use serial_unit_testing::serial::Serial; /// /// fn main() -> Result<(), std::io::Error> { /// let mut serial = Serial::open("/dev/ttyACM0")?; /// let data = serial.read().unwrap(); /// /// Ok(()) /// } /// ``` pub fn read(&mut self) -> Result<&[u8], io::Error> { let length = self.port.read(&mut self.read_buffer)?; Ok(&self.read_buffer[..length]) } /// Read a string. /// /// At least one character must be read to return successfully. The method fails when no characters could be read in the timeout duration. pub fn read_str(&mut self) -> Result<String, io::Error> { self.read_str_with_format(utils::TextFormat::Text) } /// Read a string with minimum length. /// /// At least the amount of characters given by `min_length` must be read to return successfully. The method fails when no characters could be read in the timeout duration. pub fn read_min_str(&mut self, min_length: usize) -> Result<String, io::Error> { self.read_min_str_with_format(min_length, utils::TextFormat::Text) } /// Read a string as given format. /// /// The bytes received will be formatted into the given string format. /// /// At least one character must be read to return successfully. The method fails when no characters could be read in the timeout duration. pub fn read_str_with_format(&mut self, format: utils::TextFormat) -> Result<String, io::Error> { let data = self.read()?; let result = utils::radix_string(data, &format); Ok(result) } /// Read a string as given format. /// /// The bytes received will be formatted into the given string format. /// /// At least the amount of characters (not bytes) given by `min_length` must be read to return successfully. /// The method fails when no characters could be read in the timeout duration. pub fn read_min_str_with_format(&mut self, min_length: usize, format: utils::TextFormat) -> Result<String, io::Error> { let mut response = String::new(); loop { match self.read() { Ok(bytes) => { let new_text = utils::radix_string(bytes, &format); response.push_str(new_text.as_str()); if response.len() >= min_length { break; } }, Err(ref e) if e.kind() == io::ErrorKind::TimedOut => { if response.len() == 0 { return Err(io::Error::new(io::ErrorKind::TimedOut, "Connection timed out")); } break; }, Err(e) => return Err(e) } } Ok(response) } /// Read any amount of data in given timeout duration. /// /// This function can be used to use a different timeout for a single read. Otherwise see the timeout property of serial. /// /// At least one byte of data must be read to return data. The method fails when no data could be read in the timeout duration. pub fn read_with_timeout(&mut self, timeout: Duration) -> Result<&[u8], io::Error> { // remember old timeout let old_timeout = self.port.timeout(); self.port.set_timeout(timeout)?; let length = self.port.read(&mut self.read_buffer)?; self.port.set_timeout(old_timeout)?; Ok(&self.read_buffer[..length]) } /// Read a string in given timeout duration. /// /// This function can be used to use a different timeout for a single read. Otherwise see the timeout property of serial. /// /// At least one character must be read to return successfully. The method fails when no data could be read in the timeout duration. pub fn read_str_with_timeout(&mut self, timeout: Duration) -> Result<String, io::Error> { // remember old timeout let old_timeout = self.port.timeout(); self.port.set_timeout(timeout)?; let length = self.port.read(&mut self.read_buffer)?; self.port.set_timeout(old_timeout)?; Ok(str::from_utf8(&self.read_buffer[..length]).unwrap().to_string()) } /// Read a string as given format in given timeout duration. /// /// The bytes received will be formatted into the given string format. /// This function can be used to use a different timeout for a single read. Otherwise see the timeout property of serial. /// /// At least one character must be read to return successfully. The method fails when no characters could be read in the timeout duration. pub fn read_str_with_format_and_timeout(&mut self, format: utils::TextFormat, timeout: Duration) -> Result<String, io::Error> { // remember old timeout let old_timeout = self.port.timeout(); self.port.set_timeout(timeout)?; let length = self.port.read(&mut self.read_buffer)?; let data = &self.read_buffer[..length]; self.port.set_timeout(old_timeout)?; let result = utils::radix_string(data, &format); Ok(result) } /// Send text to the serial and check if the response matches the desired response. /// /// The check will return early if the beginning of the responses does not match. /// /// Returns whether the actual response matches the desired response and the actual response. Fails with an timeout error or internal serial error. /// /// # Example /// /// ``` /// use serial_unit_testing::serial::Serial; /// /// fn main() -> Result<(), std::io::Error> { /// let mut serial = Serial::open("/dev/ttyACM0")?; /// let (result, actual_response) = serial.check("hello", "world")?; /// /// Ok(()) /// } /// ``` pub fn check(&mut self, text: &str, desired_response: &str) -> Result<(bool, String), io::Error> { let settings: CheckSettings = Default::default(); self.check_with_settings(text, desired_response, &settings) } /// Check if a response matches the desired response. /// /// The check will return early if the beginning of the responses does not match. /// /// Returns whether the actual response matches the desired response and the actual response. Fails with an timeout error or internal serial error. pub fn check_read(&mut self, desired_response: &str) -> Result<(bool, String), io::Error> { let settings: CheckSettings = Default::default(); self.check_read_with_settings(desired_response, &settings) } /// Send text to the serial and check if the response matches the desired response with given settings. /// /// The check will return early if the beginning of the responses does not match. /// /// Returns whether the actual response matches the desired response and the actual response. Fails with an timeout error or internal serial error. pub fn check_with_settings(&mut self, text: &str, desired_response: &str, settings: &CheckSettings) -> Result<(bool, String), io::Error> { self.write_format(text, settings.input_format)?; self.check_read_with_settings(desired_response, settings) } /// Check if a response matches desired response with given settings. /// /// The check will return early if the beginning of the responses does not match. /// /// Returns whether the actual response matches the desired response and the actual response. Fails with an timeout error or internal serial error. pub fn check_read_with_settings(&mut self, desired_response: &str, settings: &CheckSettings) -> Result<(bool, String), io::Error> { let mut response = String::new(); loop { match self.read() { Ok(bytes) => { let mut new_text = utils::radix_string(bytes, &settings.output_format); if settings.ignore_case { new_text = new_text.to_lowercase(); } response.push_str(new_text.as_str()); if desired_response == response { break; } if desired_response.starts_with(response.as_str()) == false { break; } }, Err(ref e) if e.kind() == io::ErrorKind::TimedOut => { if response.len() == 0 { return Err(io::Error::new(io::ErrorKind::TimedOut, "Connection timed out")); } break; }, Err(e) => return Err(e) } } Ok((desired_response == response, response)) } } /// Settings for running tests on a serial port. pub struct CheckSettings { /// Ignore response case mode. pub ignore_case: bool, /// Format of the data written to the serial port. pub input_format: utils::TextFormat, /// Format of the data received by the serial port. pub output_format: utils::TextFormat } impl Default for CheckSettings { fn default() -> CheckSettings { CheckSettings { ignore_case: false, input_format: utils::TextFormat::Text, output_format: utils::TextFormat::Text } } }