Skip to content
Merged
Changes from all commits
Commits
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
15 changes: 15 additions & 0 deletions embassy-net/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,21 @@ memory management designed to work well for embedded systems, aiming for a more
See the [`smoltcp`](https://github.com/smoltcp-rs/smoltcp) README for a detailed list of implemented and
unimplemented features of the network protocols.

## Scope

Embassy-net aims to provide an equivalent to an OS network stack, which includes a DHCP client, TCP, UDP, ICMP, and
other OS sockets, and VLAN support. Higher-level protocols such as HTTP, and DHCP server are out of scope for this
project. For implementations of these protocols, see [`edge-net`](https://crates.io/crates/edge-net). See
[`nstpc`](https://crates.io/crates/sntpc) for an ntp client.

## PTP

Packet-time protocol support is partially in scope for this project; specifically providing timestamps for UDP and raw
socket ethernet requests. Clock calibration and other functions are not in-scope for this project and should be implemented
with another trait.

Implementation of this protocol is ongoing.

## Hardware support

- [`esp-wifi`](https://github.com/esp-rs/esp-wifi) for WiFi support on bare-metal ESP32 chips. Maintained by Espressif.
Expand Down