diff --git a/README.md b/README.md index 9ff8d00..0859758 100644 --- a/README.md +++ b/README.md @@ -7,7 +7,7 @@ Rust implementation for the IEEE 802.15.4 protocol. We're just setting this up as an open source project and we're looking for funding to work on this implementation. -If you want to see this implementation finished like us, contact us: dion@tweedegolf.com. +If you want to see this implementation finished like us or know someone who does, contact us: dion@tweedegolf.com. Initial development paid for by [Rocsys](https://www.rocsys.com/). @@ -27,29 +27,36 @@ There's lots there already, but not enough is implemented to be useful to anyone 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 | | | +| Status | Feature | MVP | Notes | Effort estimation* | +| :----: | :---------------------- | :---: | :---------------------------------------------------------------- | :----------------- | +| ✅/🚧 | 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 | | +| ❌ | Data request support | ⦿ | | 4 days | +| ❌ | Acknowledgement support | ⦿ | Including retransmissions | 3 days | +| ❌ | MLME associate | ⦿ | | 4 days | +| ❌ | MLME disassociate | ⦿ | | 4 days | +| ❌ | MLME poll | ⦿ | Builds on the 'data request support' | 1 day | +| ❌ | MCPS data | ⦿ | Builds on the 'data request support' | 2 days | +| ❌ | MLME sync | | | 6 days | +| ❌ | PAN id conflict | | | 2 days | +| ❌ | MLME orphan | | Including coordinator realignment, builds on 'PAN id conflict' | 5 days | +| ❌ | MLME gts | | Including full gts handling | 4 days | +| ❌ | MLME beacon notify | | | 2 days | +| ❌ | MLME comm status | | | 1 day | +| ❌ | MCPS purge | | | 1 day | +| ❌ | MLME dps | | | 2 days | +| ❌ | MLME calibrate | | | 1 day | +| ❌ | MLME sounding | | | 1 day | +| ❌ | Promiscuous mode | | | 1 day | | 🚧/❌ | Frame security | | Parts implemented, but not enabled. Unclear how much work is left | -| 🚧 | Testing | | Lots being tested, but can be structured better | +| 🚧 | Testing | | Lots being tested, but can be structured better | | + +_* The estimation is rough. Past experience has tought us that often things turn out to be more complex than they seem at first._ +_If that keeps happening for everything, the real work could be 2x the estimation._