https://github.com/factbirdhq/ublox-short-range-rs

A driver crate for the entire u-blox short range family in Rust
https://github.com/factbirdhq/ublox-short-range-rs

crates-io embedded-rust ublox ublox-devices ublox-wifi wifi

Last synced: 28 days ago
JSON representation

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

• Host: GitHub
• URL: https://github.com/factbirdhq/ublox-short-range-rs
• Owner: FactbirdHQ
• Created: 2020-01-08T12:40:09.000Z (almost 5 years ago)
• Default Branch: master
• Last Pushed: 2024-10-29T12:08:49.000Z (2 months ago)
• Last Synced: 2024-10-29T14:33:10.950Z (2 months ago)
• Topics: crates-io, embedded-rust, ublox, ublox-devices, ublox-wifi, wifi
• Language: Rust
• Homepage:
• Size: 503 KB
• Stars: 6
• Watchers: 6
• Forks: 2
• Open Issues: 5
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# ublox-short-range

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

![No Std][no-std-badge]

![Test][test]

[![Code coverage][codecov-badge]][codecov]

[![Crates.io Version][crates-io-badge]][crates-io]

[![Crates.io Downloads][crates-io-download-badge]][crates-io-download]

---

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

[atat]: https://crates.io/crates/atat

## Documentation

Relevant docs:

- https://www.u-blox.com/en/docs/UBX-14044127

- https://www.u-blox.com/en/docs/UBX-14044126

- https://www.u-blox.com/en/docs/UBX-16024251

Relevant repos:

- https://github.com/u-blox/ubxlib

## 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

- Apache License, Version 2.0 ([LICENSE-APACHE](LICENSE-APACHE) or

  http://www.apache.org/licenses/LICENSE-2.0)

- MIT license ([LICENSE-MIT](LICENSE-MIT) or http://opensource.org/licenses/MIT)

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.

[no-std-badge]: https://img.shields.io/badge/no__std-yes-blue

[test]: https://github.com/BlackbirdHQ/ublox-short-range-rs/workflows/Test/badge.svg

[codecov-badge]: https://codecov.io/gh/BlackbirdHQ/ublox-short-range-rs/branch/master/graph/badge.svg

[codecov]: https://codecov.io/gh/BlackbirdHQ/ublox-short-range-rs

[crates-io]: https://crates.io/crates/ublox-short-range-rs

[crates-io-badge]: https://img.shields.io/crates/v/ublox-short-range-rs.svg?maxAge=3600

[crates-io-download]: https://crates.io/crates/ublox-short-range-rs

[crates-io-download-badge]: https://img.shields.io/crates/d/ublox-short-range-rs.svg?maxAge=3600