Skip to content

A driver crate for the entire u-blox short range family in Rust

Notifications You must be signed in to change notification settings

BlackbirdHQ/ublox-short-range-rs

Repository files navigation

ublox-short-range

no_std driver crate for interfacing with the ublox short range family over serial

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


A driver crate for AT-command based serial ublox short range modules, built on top of atat. The driver aims to be compatible with the ublox short range modules:

  • odin_w2xx
  • nina_w1xx
  • nina_b1xx
  • anna_b1xx
  • nina_b2xx
  • nina_b3xx

Documentation

Design diagram:
design diagram

Relevant docs:

Relevant repos:

Tests

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

Features

  • device selection (must select one, and only one!):
    • odin_w2xx
    • nina_w1xx
    • nina_b1xx
    • anna_b1xx
    • nina_b2xx
    • nina_b3xx
  • socket-tcp: Enabled by default. Adds TCP socket capabilities, and implements [TcpStack] trait.
  • socket-udp: Enabled by default. Adds UDP socket capabilities, and implements [UdpStack] trait.
  • defmt-default: Disabled by default. Add log statements on trace (dev) or info (release) log levels to aid debugging.
  • defmt-trace: Disabled by default. Add log statements on trace log levels to aid debugging.
  • defmt-debug: Disabled by default. Add log statements on debug log levels to aid debugging.
  • defmt-info: Disabled by default. Add log statements on info log levels to aid debugging.
  • defmt-warn: Disabled by default. Add log statements on warn log levels to aid debugging.
  • defmt-error: Disabled by default. Add log statements on error log levels to aid debugging.

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.