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
//! 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> = Queue(heapless::i::Queue::u8()); //! static mut URC_QUEUE: UrcQueue<consts::U256, consts::U10> = Queue(heapless::i::Queue::u8()); //! static mut COM_QUEUE: ComQueue = 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(warnings)] #![allow(clippy::multiple_crate_versions)] #![allow(clippy::missing_errors_doc)] #![allow(clippy::unused_unit)] #![allow(clippy::use_self)] #![allow(clippy::clippy::too_many_lines)] #![allow(clippy::module_name_repetitions)] #![allow(clippy::used_underscore_binding)] #![cfg_attr(all(not(test), not(feature = "std")), no_std)] mod builder; mod client; mod digest; mod error; pub mod helpers; mod ingress_manager; mod queues; mod traits; mod urc_matcher; #[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 builder::ClientBuilder; pub use client::{Client, Mode}; pub use digest::{DefaultDigester, DigestResult, Digester}; pub use error::Error; pub use ingress_manager::IngressManager; pub use queues::{ComQueue, Queues, ResQueue, UrcQueue}; pub use traits::{AtatClient, AtatCmd, AtatResp, AtatUrc}; pub use urc_matcher::{DefaultUrcMatcher, UrcMatcher, UrcMatcherResult}; /// 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 { /// Reset to initial state, including clearing the buffer, /// usually as a result of a command timeout Reset, /// Force the ingress manager into receive state ForceReceiveState, } /// 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, cmd_cooldown: u32, } impl Default for Config { fn default() -> Self { Self { mode: Mode::Blocking, cmd_cooldown: 20, } } } impl Config { #[must_use] pub fn new(mode: Mode) -> Self { Self { mode, ..Self::default() } } #[must_use] pub const fn cmd_cooldown(mut self, ms: u32) -> Self { self.cmd_cooldown = ms; self } }