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
//! A helper crate to abstract away the state management and string parsing of //! AT command communication. //! //! It works by creating structs for each AT command, that each implements //! [`AtatCmd`]. With corresponding response structs that each implements //! [`AtatResp`]. //! //! This can be simplified alot using the [`atat_derive`] crate! //! //! [`AtatCmd`]: trait.AtatCmd.html [`AtatResp`]: trait.AtatResp.html //! [`atat_derive`]: <https://crates.io/crates/atat_derive> //! //! # Examples //! //! ### Command and response example without `atat_derive`: //! ``` //! use atat::{AtatCmd, AtatResp, Error}; //! use core::fmt::Write; //! use heapless::{consts, String, Vec}; //! //! pub struct SetGreetingText<'a> { //! pub text: &'a str, //! } //! //! pub struct GetGreetingText; //! //! pub struct NoResponse; //! //! impl AtatResp for NoResponse {}; //! //! pub struct GreetingText { //! pub text: String<consts::U64>, //! }; //! //! impl AtatResp for GreetingText {}; //! //! impl<'a> AtatCmd for SetGreetingText<'a> { //! type CommandLen = consts::U64; //! type Response = NoResponse; //! //! fn as_bytes(&self) -> Vec<u8, Self::CommandLen> { //! let mut buf: Vec<u8, Self::CommandLen> = Vec::new(); //! write!(buf, "AT+CSGT={}", self.text); //! buf //! } //! //! fn parse(&self, resp: &[u8]) -> Result<Self::Response, Error> { //! Ok(NoResponse) //! } //! } //! //! impl AtatCmd for GetGreetingText { //! type CommandLen = consts::U8; //! type Response = GreetingText; //! //! fn as_bytes(&self) -> Vec<u8, Self::CommandLen> { //! Vec::from_slice(b"AT+CSGT?").unwrap() //! } //! //! fn parse(&self, resp: &[u8]) -> Result<Self::Response, Error> { //! // Parse resp into `GreetingText` //! Ok(GreetingText { //! text: String::from(core::str::from_utf8(resp).unwrap()), //! }) //! } //! } //! ``` //! //! ### Same example with `atat_derive`: //! ``` //! use atat::atat_derive::{AtatCmd, AtatResp}; //! use heapless::{consts, String}; //! //! #[derive(Clone, AtatCmd)] //! #[at_cmd("+CSGT", NoResponse)] //! pub struct SetGreetingText<'a> { //! #[at_arg(position = 0, len = 32)] //! pub text: &'a str, //! } //! //! #[derive(Clone, AtatCmd)] //! #[at_cmd("+CSGT?", GreetingText)] //! pub struct GetGreetingText; //! //! #[derive(Clone, AtatResp)] //! pub struct NoResponse; //! //! #[derive(Clone, AtatResp)] //! pub struct GreetingText { //! #[at_arg(position = 0)] //! pub text: String<consts::U64>, //! }; //! ``` //! //! ### Basic usage example (More available in examples folder): //! ```ignore //! //! use cortex_m::asm; //! use hal::{ //! gpio::{ //! gpioa::{PA2, PA3}, //! Alternate, Floating, Input, AF7, //! }, //! pac::{interrupt, Peripherals, USART2}, //! prelude::*, //! serial::{Config, Event::Rxne, Rx, Serial}, //! timer::{Event, Timer}, //! }; //! //! use atat::{atat_derive::{AtatResp, AtatCmd}}; //! //! use heapless::{consts, spsc::Queue, String}; //! //! use crate::rt::entry; //! static mut INGRESS: Option<atat::IngressManager> = None; //! static mut RX: Option<Rx<USART2>> = None; //! //! //! #[derive(Clone, AtatResp)] //! pub struct NoResponse; //! //! #[derive(Clone, AtatCmd)] //! #[at_cmd("", NoResponse, timeout_ms = 1000)] //! pub struct AT; //! //! #[entry] //! fn main() -> ! { //! let p = Peripherals::take().unwrap(); //! //! let mut flash = p.FLASH.constrain(); //! let mut rcc = p.RCC.constrain(); //! let mut pwr = p.PWR.constrain(&mut rcc.apb1r1); //! //! let mut gpioa = p.GPIOA.split(&mut rcc.ahb2); //! //! let clocks = rcc.cfgr.freeze(&mut flash.acr, &mut pwr); //! //! let tx = gpioa.pa2.into_af7(&mut gpioa.moder, &mut gpioa.afrl); //! let rx = gpioa.pa3.into_af7(&mut gpioa.moder, &mut gpioa.afrl); //! //! let mut timer = Timer::tim7(p.TIM7, 1.hz(), clocks, &mut rcc.apb1r1); //! let at_timer = Timer::tim6(p.TIM6, 100.hz(), clocks, &mut rcc.apb1r1); //! //! let mut serial = Serial::usart2( //! p.USART2, //! (tx, rx), //! Config::default().baudrate(115_200.bps()), //! clocks, //! &mut rcc.apb1r1, //! ); //! //! serial.listen(Rxne); //! //! static mut RES_QUEUE: ResQueue<consts::U256, consts::U5> = Queue(heapless::i::Queue::u8()); //! static mut URC_QUEUE: UrcQueue<consts::U256, consts::U10> = Queue(heapless::i::Queue::u8()); //! static mut COM_QUEUE: ComQueue<consts::U3> = Queue(heapless::i::Queue::u8()); //! //! let queues = Queues { //! res_queue: unsafe { RES_QUEUE.split() }, //! urc_queue: unsafe { URC_QUEUE.split() }, //! com_queue: unsafe { COM_QUEUE.split() }, //! }; //! //! let (tx, rx) = serial.split(); //! let (mut client, ingress) = //! ClientBuilder::new(tx, timer, atat::Config::new(atat::Mode::Timeout)).build(queues); //! //! unsafe { INGRESS = Some(ingress) }; //! unsafe { RX = Some(rx) }; //! //! // configure NVIC interrupts //! unsafe { cortex_m::peripheral::NVIC::unmask(hal::stm32::Interrupt::TIM7) }; //! timer.listen(Event::TimeOut); //! //! // if all goes well you should reach this breakpoint //! asm::bkpt(); //! //! loop { //! asm::wfi(); //! //! match client.send(&AT) { //! Ok(response) => { //! // Do something with response here //! } //! Err(e) => {} //! } //! } //! } //! //! #[interrupt] //! fn TIM7() { //! let ingress = unsafe { INGRESS.as_mut().unwrap() }; //! ingress.parse_at(); //! } //! //! #[interrupt] //! fn USART2() { //! let ingress = unsafe { INGRESS.as_mut().unwrap() }; //! let rx = unsafe { RX.as_mut().unwrap() }; //! if let Ok(d) = nb::block!(rx.read()) { //! ingress.write(&[d]); //! } //! } //! ``` //! # Optional Cargo Features //! //! - **`derive`** *(enabled by default)* - Re-exports [`atat_derive`] to allow //! deriving `Atat__` traits. //! - **`log-logging`** *(disabled by default)* - Enable log statements on //! various log levels to aid debugging. Powered by `log`. //! - **`defmt-default`** *(disabled by default)* - Enable log statements at //! INFO, or TRACE, level and up, to aid debugging. Powered by `defmt`. //! - **`defmt-trace`** *(disabled by default)* - Enable log statements at TRACE //! level and up, to aid debugging. Powered by `defmt`. //! - **`defmt-debug`** *(disabled by default)* - Enable log statements at DEBUG //! level and up, to aid debugging. Powered by `defmt`. //! - **`defmt-info`** *(disabled by default)* - Enable log statements at INFO //! level and up, to aid debugging. Powered by `defmt`. //! - **`defmt-warn`** *(disabled by default)* - Enable log statements at WARN //! level and up, to aid debugging. Powered by `defmt`. //! - **`defmt-error`** *(disabled by default)* - Enable log statements at ERROR //! level and up, to aid debugging. Powered by `defmt`. #![deny(rust_2018_compatibility)] #![deny(rust_2018_idioms)] #![deny(warnings)] #![allow(clippy::multiple_crate_versions)] #![allow(clippy::missing_errors_doc)] #![allow(clippy::unused_unit)] #![allow(clippy::clippy::used_underscore_binding)] #![allow(clippy::too_many_lines)] #![allow(clippy::unused_unit)] #![allow(clippy::used_underscore_binding)] #![cfg_attr(not(test), no_std)] mod client; mod error; mod ingress_manager; mod queues; mod traits; #[cfg(feature = "derive")] pub use atat_derive; #[cfg(feature = "derive")] pub mod derive; #[cfg(feature = "derive")] pub use self::derive::AtatLen; #[cfg(feature = "derive")] pub use serde_at; #[cfg(feature = "derive")] pub use typenum; #[cfg(feature = "derive")] pub use heapless; pub use self::client::Client; pub use self::error::Error; pub use self::ingress_manager::{ get_line, IngressManager, NoopUrcMatcher, UrcMatcher, UrcMatcherResult, }; pub use self::queues::{ComQueue, ResQueue, UrcQueue}; pub use self::traits::{AtatClient, AtatCmd, AtatResp, AtatUrc}; use heapless::ArrayLength; use queues::{ ComConsumer, ComItem, ComProducer, ResConsumer, ResItem, ResProducer, UrcConsumer, UrcItem, UrcProducer, }; pub mod prelude { //! The prelude is a collection of all the traits in this crate //! //! The traits have been renamed to avoid collisions with other items when //! performing a glob import. pub use crate::AtatClient as _atat_AtatClient; pub use crate::AtatCmd as _atat_AtatCmd; pub use crate::AtatResp as _atat_AtatResp; pub use crate::AtatUrc as _atat_AtatUrc; #[cfg(feature = "derive")] pub use crate::AtatLen as _atat_AtatLen; } #[cfg(all( feature = "log-logging", not(any( feature = "defmt-default", feature = "defmt-trace", feature = "defmt-debug", feature = "defmt-info", feature = "defmt-warn", feature = "defmt-error" )) ))] #[macro_export] macro_rules! atat_log { ($level:ident, $($arg:tt)+) => { log::$level!($($arg)+); } } #[cfg(all( any( feature = "defmt-default", feature = "defmt-trace", feature = "defmt-debug", feature = "defmt-info", feature = "defmt-warn", feature = "defmt-error" ), not(feature = "log-logging") ))] #[macro_export] macro_rules! atat_log { ($level:ident, $($arg:tt)+) => { defmt::$level!($($arg)+); } } #[cfg(any( all( any( feature = "defmt-default", feature = "defmt-trace", feature = "defmt-debug", feature = "defmt-info", feature = "defmt-warn", feature = "defmt-error" ), feature = "log-logging" ), not(any( any( feature = "defmt-default", feature = "defmt-trace", feature = "defmt-debug", feature = "defmt-info", feature = "defmt-warn", feature = "defmt-error" ), feature = "log-logging" )) ))] #[macro_export] macro_rules! atat_log { ($level:ident, $($arg:tt)+) => { (); }; } /// Whether the AT client should block while waiting responses or return early. #[derive(Debug, Copy, Clone, Hash, PartialEq, Eq)] pub enum Mode { /// The function call will wait as long as necessary to complete the operation Blocking, /// The function call will not wait at all to complete the operation, and only do what it can. NonBlocking, /// The function call will wait only up the max timeout of each command to complete the operation. Timeout, } /// Commands that can be sent from the client to the ingress manager, for /// configuration after initial setup. This is also used for stuff like clearing /// the receive buffer on command timeouts. #[derive(Debug, Copy, Clone, Hash, PartialEq, Eq)] pub enum Command { /// Clear the rx buffer, usually as a result of a command timeout ClearBuffer, /// Force the ingress manager into the given state ForceState(ingress_manager::State), /// Change the line termination character, must be called af setting `ATS3=` SetLineTerm(u8), /// Change the format character, must be called af setting `ATS4=` SetFormat(u8), /// Enable or disable AT echo, must be called after setting `ATE` SetEcho(bool), } /// Configuration of both the ingress manager, and the AT client. Some of these /// parameters can be changed on the fly, through issuing a [`Command`] from the /// client. /// /// [`Command`]: enum.Command.html #[derive(Debug, Copy, Clone, Hash, PartialEq, Eq)] pub struct Config { mode: Mode, line_term_char: u8, format_char: u8, at_echo_enabled: bool, cmd_cooldown: u32, } impl Default for Config { fn default() -> Self { Self { mode: Mode::Blocking, line_term_char: b'\r', format_char: b'\n', at_echo_enabled: true, cmd_cooldown: 20, } } } impl Config { #[must_use] pub fn new(mode: Mode) -> Self { Self { mode, ..Self::default() } } #[must_use] pub const fn with_line_term(mut self, c: u8) -> Self { self.line_term_char = c; self } #[must_use] pub const fn with_format_char(mut self, c: u8) -> Self { self.format_char = c; self } #[must_use] pub const fn with_at_echo(mut self, e: bool) -> Self { self.at_echo_enabled = e; self } #[must_use] pub const fn cmd_cooldown(mut self, ms: u32) -> Self { self.cmd_cooldown = ms; self } } type ClientParser<Tx, T, U, BufLen, ComCapacity, ResCapacity, UrcCapacity> = ( Client<Tx, T, BufLen, ComCapacity, ResCapacity, UrcCapacity>, IngressManager<BufLen, U, ComCapacity, ResCapacity, UrcCapacity>, ); pub struct Queues<BufLen, ComCapacity, ResCapacity, UrcCapacity> where BufLen: ArrayLength<u8>, ComCapacity: ArrayLength<ComItem>, ResCapacity: ArrayLength<ResItem<BufLen>>, UrcCapacity: ArrayLength<UrcItem<BufLen>>, { pub res_queue: ( ResProducer<BufLen, ResCapacity>, ResConsumer<BufLen, ResCapacity>, ), pub urc_queue: ( UrcProducer<BufLen, UrcCapacity>, UrcConsumer<BufLen, UrcCapacity>, ), pub com_queue: (ComProducer<ComCapacity>, ComConsumer<ComCapacity>), } /// Builder to set up a [`Client`] and [`IngressManager`] pair. /// /// Create a new builder through the [`new`] method. /// /// [`Client`]: struct.Client.html /// [`IngressManager`]: struct.IngressManager.html /// [`new`]: #method.new pub struct ClientBuilder<Tx, T, U, BufLen, ComCapacity, ResCapacity, UrcCapacity> { serial_tx: Tx, timer: T, config: Config, custom_urc_matcher: Option<U>, #[doc(hidden)] _internal: core::marker::PhantomData<(BufLen, ComCapacity, ResCapacity, UrcCapacity)>, } impl<Tx, T, U, BufLen, ComCapacity, ResCapacity, UrcCapacity> ClientBuilder<Tx, T, U, BufLen, ComCapacity, ResCapacity, UrcCapacity> where Tx: embedded_hal::serial::Write<u8>, T: embedded_hal::timer::CountDown, T::Time: From<u32>, U: UrcMatcher<BufLen>, BufLen: ArrayLength<u8>, ComCapacity: ArrayLength<ComItem>, ResCapacity: ArrayLength<ResItem<BufLen>>, UrcCapacity: ArrayLength<UrcItem<BufLen>>, { /// Create a builder for new Atat client instance. /// /// The `serial_tx` type must implement the `embedded_hal` /// [`serial::Write<u8>`][serialwrite] trait while the timer must implement /// the [`timer::CountDown`][timercountdown] trait. /// /// [serialwrite]: ../embedded_hal/serial/trait.Write.html /// [timercountdown]: ../embedded_hal/timer/trait.CountDown.html pub fn new(serial_tx: Tx, timer: T, config: Config) -> Self { Self { serial_tx, timer, config, custom_urc_matcher: None, #[doc(hidden)] _internal: core::marker::PhantomData, } } /// Use a custom [`UrcMatcher`] implementation. /// /// [`UrcMatcher`]: trait.UrcMatcher.html pub fn with_custom_urc_matcher(mut self, matcher: U) -> Self { self.custom_urc_matcher = Some(matcher); self } /// Set up and return a [`Client`] and [`IngressManager`] pair. /// /// [`Client`]: struct.Client.html /// [`IngressManager`]: struct.IngressManager.html pub fn build( self, queues: Queues<BufLen, ComCapacity, ResCapacity, UrcCapacity>, ) -> ClientParser<Tx, T, U, BufLen, ComCapacity, ResCapacity, UrcCapacity> { let parser = IngressManager::with_custom_urc_matcher( queues.res_queue.0, queues.urc_queue.0, queues.com_queue.1, self.config, self.custom_urc_matcher, ); let client = Client::new( self.serial_tx, queues.res_queue.1, queues.urc_queue.1, queues.com_queue.0, self.timer, self.config, ); (client, parser) } }