Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/soypat/seqs
seqs: the hottest, most idiomatic userspace TCP/IP implementation on the internet. lwip in go basically
https://github.com/soypat/seqs
embedded embedded-systems ethernet go golang heapless ip operating-systems tcp tcp-ip tinygo udp userspace-networking
Last synced: 3 months ago
JSON representation
seqs: the hottest, most idiomatic userspace TCP/IP implementation on the internet. lwip in go basically
- Host: GitHub
- URL: https://github.com/soypat/seqs
- Owner: soypat
- License: bsd-3-clause
- Created: 2023-11-12T13:50:16.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-07-21T15:33:53.000Z (7 months ago)
- Last Synced: 2024-07-22T13:27:53.547Z (6 months ago)
- Topics: embedded, embedded-systems, ethernet, go, golang, heapless, ip, operating-systems, tcp, tcp-ip, tinygo, udp, userspace-networking
- Language: Go
- Homepage:
- Size: 386 KB
- Stars: 33
- Watchers: 3
- Forks: 4
- Open Issues: 11
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-tinygo - seqs - Networking library for use on microcontrollers. Basically a more featureful LWIP. (Embedded Systems / Protocol implementations)
README
# seqs
[](https://pkg.go.dev/github.com/soypat/seqs)
[](https://goreportcard.com/report/github.com/soypat/seqs)
[](https://codecov.io/gh/soypat/seqs)
[](https://github.com/soypat/seqs/actions/workflows/go.yml)
[](https://sourcegraph.com/github.com/soypat/seqs?badge)
`seqs` is what is commonly referred to as a userspace IP implementation. It handles:
* Ethernet protocol
* IP packet marshalling to sub-protocols:
* ARP requests and responses
* UDP packet handling
* DHCP client requests and DHCP server
* TCP connections over IP with support for multiple listeners on same port. These implement [net.Conn](https://pkg.go.dev/net#Conn) and [net.Listener](https://pkg.go.dev/net#Listener) interfaces. See [`stacks/tcpconn.go`](./stacks/tcpconn.go)
* HTTP: Algorithm to reuse heap memory between requests and avoid allocations. See `httpx` package
* NTP client for resolving time offset to a NTP server
### Example of use
```go
// stack works by having access to Ethernet packet sending
// and processing. NIC is our physical link to the internet.
var NIC NetworkInterfaceCard = getNIC()
stack := stacks.NewPortStack(stacks.PortStackConfig{
MAC: MAC,
MaxOpenPortsTCP: 1,
MaxOpenPortsUDP: 1,
MTU: 2048,
})
// stack.RecvEth should be called on receiving an ethernet packet. It should NOT block.
NIC.SetRecvEthHandle(stack.RecvEth)
// Static IP setting.
ip := netip.AddrFrom4([4]byte{192, 168, 1, 45})
stack.SetAddr(ip)
// Or can request an address via DHCP.
dhcpClient := stacks.NewDHCPClient(stack, dhcp.DefaultClientPort)
err = dhcpClient.BeginRequest(stacks.DHCPRequestConfig{
RequestedAddr: netip.AddrFrom4([4]byte{192, 168, 1, 69}),
Xid: 0x12345678,
Hostname: "tinygo-pico",
})
if err != nil {
panic(err)
}
fmt.Println("Start DHCP...")
for !dhcpClient.Done() {
doNICPoll(NIC)
time.Sleep(time.Second / 10)
}
offeredIP := dhcpClient.Offer()
fmt.Println("got offer:", offeredIP)
stack.SetAddr(offeredIP)
```
How to use `seqs`
```sh
go mod download github.com/soypat/seqs@latest
```
#### History - Precursors to seqs
Before `seqs` there was:
* [`ether-swtch`](https://github.com/soypat/ether-swtch) - First known instance of a (barely) working TCP/IP stack in Go working on embedded systems, circa June 2021. Could blink an Arduino UNO's LED via HTTP (!). Famously bad design, code, performance, readability.
* [`dgrams`](https://github.com/soypat/dgrams) - Library prepared for Pico W's wifi chip. Already shows similarities with `seqs`. Circa May 2023.