Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: update README #826

Merged
merged 2 commits into from
Aug 4, 2023
Merged

docs: update README #826

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2c47af0
docs: update README about IEEE802154 and 6LoWPAN
thvdveld Aug 4, 2023
fdfec97
docs: update smoltcp version
thvdveld Aug 4, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 15 additions & 7 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,9 +38,8 @@ There are 3 supported mediums.
* Jumbo frames are **not** supported.
* IP
* Unicast, broadcast and multicast packets are supported.
* IEEE 802.15.4 + 6LoWPAN (experimental)
* Unicast, broadcast and multicast packets are supported.
* ONLY UDP packets are supported.
* IEEE 802.15.4
* Only support for data frames.

### IP layer

Expand All @@ -62,6 +61,14 @@ There are 3 supported mediums.
* ICMPv6 parameter problem message is **not** generated in response to an unknown IPv6
hop-by-hop option.

#### 6LoWPAN

* Implementation of [RFC6282](https://tools.ietf.org/rfc/rfc6282.txt).
* Fragmentation is supported, as defined in [RFC4944](https://tools.ietf.org/rfc/rfc4944.txt).
* UDP header compression is supported.
* Extension header compression is **not** supported (will be soon™).
* Uncompressed IP headers are supported.

### IP multicast

#### IGMP
Expand Down Expand Up @@ -137,15 +144,15 @@ To use the _smoltcp_ library in your project, add the following to `Cargo.toml`:

```toml
[dependencies]
smoltcp = "0.8.0"
smoltcp = "0.10.0"
```

The default configuration assumes a hosted environment, for ease of evaluation.
You probably want to disable default features and configure them one by one:

```toml
[dependencies]
smoltcp = { version = "0.8.0", default-features = false, features = ["log"] }
smoltcp = { version = "0.10.0", default-features = false, features = ["log"] }
```

## Feature flags
Expand Down Expand Up @@ -204,12 +211,13 @@ Enable the corresponding socket type.

These features are enabled by default.

### Features `proto-ipv4` and `proto-ipv6`
### Features `proto-ipv4`, `proto-ipv6` and `proto-sixlowpan`

Enable [IPv4] and [IPv6] respectively.
Enable [IPv4], [IPv6] and [6LoWPAN] respectively.

[IPv4]: https://tools.ietf.org/rfc/rfc791.txt
[IPv6]: https://tools.ietf.org/rfc/rfc8200.txt
[6LoWPAN]: https://tools.ietf.org/rfc/rfc6282.txt

## Configuration

Expand Down