Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/plgd-dev/go-coap
Implementation of CoAP Server & Client in Go
https://github.com/plgd-dev/go-coap
blockwise-transfer coap coap-client coap-noresponse coap-protocol coap-server coap-tcp dtls iot multicast ocf pion-dtls udp
Last synced: about 1 month ago
JSON representation
Implementation of CoAP Server & Client in Go
- Host: GitHub
- URL: https://github.com/plgd-dev/go-coap
- Owner: plgd-dev
- License: apache-2.0
- Created: 2018-06-01T08:43:15.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2024-04-08T07:21:32.000Z (5 months ago)
- Last Synced: 2024-04-13T21:23:11.282Z (5 months ago)
- Topics: blockwise-transfer, coap, coap-client, coap-noresponse, coap-protocol, coap-server, coap-tcp, dtls, iot, multicast, ocf, pion-dtls, udp
- Language: Go
- Homepage: https://coap.technology
- Size: 1.34 MB
- Stars: 416
- Watchers: 15
- Forks: 111
- Open Issues: 22
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
- awesome-CoAP - Go-CoAP - The go-coap provides servers and clients for DTLS, TCP-TLS, UDP, TCP in golang language. (Libraries / Go)
README
# Go-CoAP
[](https://github.com/plgd-dev/go-coap/actions?query=workflow%3ATest)
[](https://sonarcloud.io/summary/new_code?id=plgd-dev_go-coap)
[](https://sonarcloud.io/summary/overall?id=plgd-dev_go-coap)
[](https://app.fossa.io/projects/git%2Bgithub.com%2Fplgd-dev%2Fgo-coap?ref=badge_shield)
[](https://opencollective.com/go-coap#sponsors)
[](https://github.com/plgd-dev/go-coap/graphs/contributors)
[](https://github.com/plgd-dev/go-coap/stargazers)
[](https://github.com/plgd-dev/go-coap/blob/master/LICENSE)
[](https://pkg.go.dev/github.com/plgd-dev/go-coap/v3?utm_source=godoc)
The Constrained Application Protocol (CoAP) is a specialized web transfer protocol for use with constrained nodes and constrained networks in the Internet of Things.
The protocol is designed for machine-to-machine (M2M) applications such as smart energy and building automation.
The go-coap provides servers and clients for DTLS, TCP-TLS, UDP, TCP in golang language.
## Features
* CoAP over UDP [RFC 7252][coap].
* CoAP over TCP/TLS [RFC 8232][coap-tcp]
* Observe resources in CoAP [RFC 7641][coap-observe]
* Block-wise transfers in CoAP [RFC 7959][coap-block-wise-transfers]
* request multiplexer
* multicast
* CoAP NoResponse option in CoAP [RFC 7967][coap-noresponse]
* CoAP over DTLS [pion/dtls][pion-dtls]
* Too many requests response code [RFC 8516][coap-429]
[coap]: http://tools.ietf.org/html/rfc7252
[coap-tcp]: https://tools.ietf.org/html/rfc8323
[coap-block-wise-transfers]: https://tools.ietf.org/html/rfc7959
[coap-observe]: https://tools.ietf.org/html/rfc7641
[coap-noresponse]: https://tools.ietf.org/html/rfc7967
[pion-dtls]: https://github.com/pion/dtls
[coap-429]: https://datatracker.ietf.org/doc/html/rfc8516
## Requirements
* Go 1.20 or higher
## Samples
### Simple
#### Server UDP/TCP
```go
// Server
// Middleware function, which will be called for each request.
func loggingMiddleware(next mux.Handler) mux.Handler {
return mux.HandlerFunc(func(w mux.ResponseWriter, r *mux.Message) {
log.Printf("ClientAddress %v, %v\n", w.Conn().RemoteAddr(), r.String())
next.ServeCOAP(w, r)
})
}
// See /examples/simple/server/main.go
func handleA(w mux.ResponseWriter, req *mux.Message) {
err := w.SetResponse(codes.GET, message.TextPlain, bytes.NewReader([]byte("hello world")))
if err != nil {
log.Printf("cannot set response: %v", err)
}
}
func main() {
r := mux.NewRouter()
r.Use(loggingMiddleware)
r.Handle("/a", mux.HandlerFunc(handleA))
r.Handle("/b", mux.HandlerFunc(handleB))
log.Fatal(coap.ListenAndServe("udp", ":5688", r))
// for tcp
// log.Fatal(coap.ListenAndServe("tcp", ":5688", r))
// for tcp-tls
// log.Fatal(coap.ListenAndServeTLS("tcp", ":5688", &tls.Config{...}, r))
// for udp-dtls
// log.Fatal(coap.ListenAndServeDTLS("udp", ":5688", &dtls.Config{...}, r))
}
```
#### Client
```go
// Client
// See /examples/simpler/client/main.go
func main() {
co, err := udp.Dial("localhost:5688")
// for tcp
// co, err := tcp.Dial("localhost:5688")
// for tcp-tls
// co, err := tcp.Dial("localhost:5688", tcp.WithTLS(&tls.Config{...}))
// for dtls
// co, err := dtls.Dial("localhost:5688", &dtls.Config{...}))
if err != nil {
log.Fatalf("Error dialing: %v", err)
}
ctx, cancel := context.WithTimeout(context.Background(), time.Second)
defer cancel()
resp, err := co.Get(ctx, "/a")
if err != nil {
log.Fatalf("Cannot get response: %v", err)
return
}
log.Printf("Response: %+v", resp)
}
```
### Observe / Notify
[Server](examples/observe/server/main.go) example.
[Client](examples/observe/client/main.go) example.
### Multicast
[Server](examples/mcast/server/main.go) example.
[Client](examples/mcast/client/main.go) example.
## License
Apache 2.0
[](https://app.fossa.io/projects/git%2Bgithub.com%2Fplgd-dev%2Fgo-coap?ref=badge_large)
Sponsors
[Become a sponsor](https://opencollective.com/go-coap#sponsor) and get your logo on our README on Github with a link to your site.
Backers
[Become a backer](https://opencollective.com/go-coap#backer) and get your image on our README on Github with a link to your site.
