#serde #AT

no-std serde_at

serde serializer/deserializer for AT commands

14 unstable releases (3 breaking)

0.4.3 Jul 24, 2020
0.4.2 Jul 24, 2020
0.4.1 Jun 26, 2020
0.3.0 Mar 13, 2020
0.1.7 Feb 12, 2020

#31 in No standard library

Download history 75/week @ 2020-04-10 12/week @ 2020-04-17 12/week @ 2020-04-24 5/week @ 2020-05-01 1/week @ 2020-05-08 31/week @ 2020-05-15 13/week @ 2020-05-22 11/week @ 2020-05-29 22/week @ 2020-06-05 2/week @ 2020-06-12 51/week @ 2020-06-26 55/week @ 2020-07-03 106/week @ 2020-07-10 18/week @ 2020-07-17 73/week @ 2020-07-24

112 downloads per month
Used in 2 crates

MIT/Apache

45KB
1.5K SLoC

ATAT

Test Code coverage Crates.io Version Crates.io Downloads chat No Std

ATAT

#![no_std] crate for parsing AT commands

A driver support crate for AT-command based serial modules, using the embedded-hal traits.

AT Best practices

This crate attempts to work from these AT best practices:

  • The DTE shall flush the AT channel (i.e. check if there are data waiting to be read) before sending a new AT command
  • The DTE shall detect/process complete lines (see the S3, S4 and V0/V1 settings), so they can be processed with a function that handles responses
  • The DTE shall handle the case of unexpected spaces or line endings
  • The DTE shall handle all the URCs: it can simply ignore them (not suggested) or, better, take a proper action
  • The DTE shall know what answer is expected and shall wait until it is received (i.e. final result code only or informationtext response + final result code)
  • The final result code marks the end of an AT command and can be OK, ERROR or ABORTED: when the final result is an error, be sure to handle it before continuing with the next AT command
  • The information text response format is command specific. The DTE will need explicit handling for each one. It is suggested to consult the u-blox AT Commands Manual [1]
  • It is suggested not to strictly parse information text responses but to checkif they contain interesting keywords and/or parameters
  • The DTE shall know if the issued AT command can be aborted or not
  • Some AT commands could output the final result code after some seconds, in this case check on AT manual for the suggested estimated response time. If the timeout expires then a decision should be taken accordingly: e.g. if the command can be aborted then try to abort it, etc ...
  • It is very useful, for debugging an application, to log all the command lines sent to the DCE and what is received from it
  • Create a state machine for the AT parser (i.e. idle, waiting_response, data_mode)
  • The DTE shall wait some time (the recommended value is at least 20 ms) after the reception of an AT command final response or URC before issuing a new AT commandto give the module the opportunity to transmit the buffered URCs. Otherwise the collision of the URCs with the subsequent AT command is still possible
  • The DTE shall be aware that, when using a serial port without HW flow control, the first character is used to wake up the module from power saving

Documentation

Tests

The crate is covered by tests. These tests can be run by cargo test --tests --all-features, and are run by the CI on every push.

Examples

The crate has examples for usage with cortex-m-rt and cortex-m-rtic crates.

The samples can be built using cargo build --example cortex-m-rt --target thumbv7em-none-eabihf and cargo build --example rtic --target thumbv7em-none-eabihf.

Furthermore I have used the crate to build initial WIP drivers for uBlox cellular modules (ublox-cellular-rs) and uBlox short-range modules (ublox-short-range-rs)

Releasing to crates.io

This workspace uses cargo-release to do workspace releases to crates.io. It can be installed through cargo with cargo install cargo-release. The steps involved in a new release are:

  1. Run cargo release --dry-run -- major|minor|patch, and verify the output
  2. Run cargo release -- major|minor|patch, to release

About

  • Minimum rustc version 1.31
  • Tested and built using nightly toolchain, but should work fine for stable as well

Supported Crates

The following dependent crates provide platform-agnostic device drivers built on embedded-hal which also implement this crate's traits:

Device Name Description Crate + Docs
ublox-short-range-rs Driver crate for U-Blox host-based short range devices (wifi and BT) with AT-command interface
ublox-cellular-rs Driver crate for U-Blox host-based cellular devices with AT-command interface
espresso AT based driver crate for ESP8266 WiFi modules

Features

  • logging: Disabled by default. Add log statements on various log levels to aid debugging.
  • derive: Enabled by default. Re-exports atat_derive to allow deriving Atat__ traits.

Chat / Getting Help

If you have questions on the development of AT-AT or want to write a driver based on it, feel free to join our matrix room at #atat:matrix.org!

License

Licensed under either of

at your option.

Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.

Dependencies

~1MB
~21K SLoC