Skip to content

Commit

Permalink
Expand readme with current status
Browse files Browse the repository at this point in the history
  • Loading branch information
@diondokter
diondokter committed Feb 14, 2025
1 parent d279b13 commit 446f820
Showing 1 changed file with 33 additions and 4 deletions.
37 changes: 33 additions & 4 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@
[![crates.io](https://img.shields.io/crates/v/lr-wpan-rs.svg)](https://crates.io/crates/lr-wpan-rs) [![Documentation](https://docs.rs/lr-wpan-rs/badge.svg)](https://docs.rs/lr-wpan-rs)

Initial development paid for by [Rocsys](https://www.rocsys.com/).

Rust implementation for the IEEE 802.15.4 protocol.

We're just setting this up as an open source project and we're looking funding to work on this implementation.
Expand All @@ -13,13 +15,40 @@ If you want to see this implementation finished like us, contact us: dion@tweede

- Provide a full IEEE 802.15.4-2011 implementation, using the protocol-defined interface layers
- Eventually maybe upgrade to the most recent spec (which can do more, but is also more complex)
- Follow the spec relatively closely
- Be hardware agnostic, so it can run on any radio that implements the phy and can run on any microcontroller that's capable enough
- Use async to its fullest extend, 'real-time' scheduling is left to the radio driver
- Everything fully in stable Rust, preferrably without using unsafe

## Current state

- Not enough is implemented to be useful to anyone yet
- More cleanup and review is needed. Initial development was focussed on getting an MVP out of the door.

Initial development paid for by [Rocsys](https://www.rocsys.com/).
There's lots there already, but no enough is implemented to be useful to anyone yet.
Rows with a bullet in the MVP column are required for a reasonable minimum implementation.
The list is probably not exhaustive.

| Status | Feature | MVP | Notes |
| :----: | :---------------------- | :---: | :---------------------------------------------------------------- |
| ✅/🚧 | Phy trait | ⦿ | Radio abstraction in good shape, but might need some more changes |
| ✅ | Phy PIB | ⦿ | |
| ✅ | Mac PIB | ⦿ | |
| ✅ | SAP message definitions | ⦿ | |
| ✅ | MLME reset | ⦿ | |
| ✅ | MLME set | ⦿ | |
| ✅ | MLME get | ⦿ | |
| ✅ | MLME start | ⦿ | |
| 🚧 | MLME scan | ⦿ | Active and passive implemented, ED and orphan scans still todo |
| ❌ | MLME associate | ⦿ | |
| ❌ | MLME disassociate | ⦿ | |
| ❌ | MLME sync | ⦿ | |
| ❌ | MLME poll | ⦿ | |
| ❌ | MCPS data | ⦿ | |
| ❌ | MLME orphan | | |
| ❌ | MLME gts | | |
| ❌ | MLME dps | | |
| ❌ | MLME comm status | | |
| ❌ | MLME calibrate | | |
| ❌ | MLME beacon notify | | |
| ❌ | MLME sounding | | |
| ❌ | MCPS purge | | |
| 🚧/❌ | Frame security | | Parts implemented, but not enabled. Unclear how much work is left |
| 🚧 | Testing | | Lots being tested, but can be structured better |

0 comments on commit 446f820

Please sign in to comment.