https://github.com/thvdveld/dot15d4
Implementation of the IEEE802.15.4 standard in Rust.
https://github.com/thvdveld/dot15d4
ieee802154 rust
Last synced: 7 months ago
JSON representation
Implementation of the IEEE802.15.4 standard in Rust.
- Host: GitHub
- URL: https://github.com/thvdveld/dot15d4
- Owner: thvdveld
- License: apache-2.0
- Created: 2024-02-22T11:48:04.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-10-17T13:29:15.000Z (8 months ago)
- Last Synced: 2024-10-19T10:34:27.353Z (8 months ago)
- Topics: ieee802154, rust
- Language: Rust
- Homepage:
- Size: 266 KB
- Stars: 1
- Watchers: 1
- Forks: 1
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE-APACHE
Awesome Lists containing this project
README
# dot15d4 [](https://codecov.io/gh/thvdveld/dot15d4) 
`dot15d4` is a IEEE 802.15.4 frame parsing library written in Rust.
It uses the same style of parsing and emitting as the [`smoltcp`](https://github.com/smoltcp-rs/smoltcp) library.
Another library that is similar to `dot15d4` is the [`ieee802154`](https://github.com/rust-iot/rust-ieee802.15.4) library.
However, `dot15d4` is more focused on implementing MAC layer functionality (unslotted CSMA and TSCH), and parsing frames.
## Usage
> [!NOTE]
> This library is still in development and is not yet published to crates.io.
Add this to your `Cargo.toml`:
```toml
[dependencies]
dot15d4 = "0.1.0"
```
### Configurable features
* `std`: Enables `std` only features
* `log`: Use the `log` crate for structured logging
* `defmt`: Use the `defmt` crate for structured logging
### Configurable environment variables
* `DOT15D4_MAC_MIN_BE` (default: 0): Minimum backoff exponent used in `CSMA`
* `DOT15D4_MAC_MAX_BE` (default: 8): Maximum backoff exponent used in `CSMA`
* `DOT15D4_MAC_UNIT_BACKOFF_DURATION` (default: 320us): The time of one backoff period
* `DOT15D4_MAC_MAX_FRAME_RETRIES` (default: 3): Maximum CCA/ACK rounds
* `DOT15D4_MAC_AIFS_PERIOD` (default: 1ms): The minimal time for the receiving end to go from transmitting to receiving mode when sending an ACK
* `DOT15D4_MAC_SIFS_PERIOD` (default: 1ms): The inter-frame spacing time for short frames
* `DOT15D4_MAC_LIFS_PERIOD` (default: 10ms): The inter-frame spacing time for long frames
For more information, see the [API documentation](https://docs.rs/dot15d4).
## dot15d4 as a binary
This repository also contains a binary that can be used to parse IEEE 802.15.4 frames.
### Usage
```sh
dot15d4 40ebcdabffff0100010001000100003f1188061a0e0000000000011c0001c800011b00
```
Output:
```txt
Frame Control
frame type: Enhanced Beacon
security: 0
frame pending: 0
ack request: 0
pan id compression: 1
sequence number suppression: 1
information elements present: 1
dst addressing mode: Short
src addressing mode: Extended
frame version: 2 (Ieee802154_2020)
Addressing
dst pan id: abcd
dst addr: ff:ff (broadcast)
src addr: 00:01:00:01:00:01:00:01
Information Elements
Header Information Elements
HeaderTermination1
Payload Information Elements
MLME
TschSynchronization
ASN: 14, join metric: 0
TschTimeslot
slot ID: 0
ChannelHopping
sequence ID: 0
TschSlotframeAndLink
#slot frames: 0
```
## Coverage
## 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.