Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/patopesto/go-sacn
A library for sACN (ANSI E1.31) DMX in Go - Mirror of https://gitlab.com/patopest/go-sacn
https://github.com/patopesto/go-sacn
dmx dmx512 e131 golang sacn streaming-acn
Last synced: 3 days ago
JSON representation
A library for sACN (ANSI E1.31) DMX in Go - Mirror of https://gitlab.com/patopest/go-sacn
- Host: GitHub
- URL: https://github.com/patopesto/go-sacn
- Owner: patopesto
- License: mit
- Created: 2024-03-09T00:03:17.000Z (8 months ago)
- Default Branch: master
- Last Pushed: 2024-10-31T05:50:50.000Z (14 days ago)
- Last Synced: 2024-10-31T06:24:43.323Z (14 days ago)
- Topics: dmx, dmx512, e131, golang, sacn, streaming-acn
- Language: Go
- Homepage:
- Size: 33.2 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# sACN in go
[](https://pkg.go.dev/gitlab.com/patopest/go-sacn)
[](https://goreportcard.com/report/gitlab.com/patopest/go-sacn)
[](https://opensource.org/licenses/MIT)
A library for sACN (ANSI E1.31) in `Go`.
Fully supports and complies to the specification:
- All Packet types (Data, Sync and Discovery).
- Receiver with callbacks and stream termination detection.
- Transmitter sending discovery packets.
## Usage
```shell
go get gitlab.com/patopest/go-sacn
```
- Receiver
```go
package main
import (
"fmt"
"time"
"net"
"gitlab.com/patopest/go-sacn"
"gitlab.com/patopest/go-sacn/packet"
)
func main() {
fmt.Println("hello")
itf, _ := net.InterfaceByName("en0") // change based on your machine
receiver := sacn.NewReceiver(itf)
receiver.JoinUniverse(1)
receiver.RegisterPacketCallback(packet.PacketTypeData, dataPacketCallback)
receiver.Start()
for {
time.Sleep(1)
}
}
func dataPacketCallback(p packet.SACNPacket, source string) {
d, ok := p.(*packet.DataPacket)
if ok == false {
return
}
fmt.Printf("Received Data Packet for universe %d from %s\n", d.Universe, source)
}
```
- Transmitter
```go
package main
import (
"log"
"time"
"gitlab.com/patopest/go-sacn"
"gitlab.com/patopest/go-sacn/packet"
)
func main() {
log.Println("Hello")
opts := sacn.SenderOptions{ // Default for all packets sent by Sender if not provided in the packet itself.
SourceName: "go-sacn test source"
}
sender, err := sacn.NewSender("192.168.1.200", &opts) // Create sender with binding to interface
if err != nil {
log.Fatal(err)
}
// Initialise universe
var uni uint16 = 123
universe, err := sender.StartUniverse(uni)
if err != nil {
log.Fatal(err)
}
sender.SetMulticast(uni, true)
// Create new packet and fill it up with data
p := packet.NewDataPacket()
p.SetData([]uint8{1, 2, 3, 4})
sender.Send(uni, p) // send the packet
sender.StopUniverse(uni) // To stop the universe and advertise termination to receivers
time.Sleep(1 * time.Second)
sender.Close() // Close sender and all universes
}
```
See [examples](./examples) directory for more examples.
## Development
- Run an example to test your code
```shell
go run examples/receiver/receiver.go
```
- Tests
```shell
go test ./...
```
## References
### Similar projects
- [sACN-Monitor](https://gitlab.com/patopest/sacn-monitor): An app to view data from all sACN universes, built using this library.
- Hundemeier's [go-sacn](https://github.com/Hundemeier/go-sacn): Only supports Data packets
- [go-artnet](https://github.com/jsimonetti/go-artnet)
- Open Lighting Architecure (OLA) [framework](https://github.com/OpenLightingProject/ola) (C implementations of control protocols).
### Documentation
- sACN (ANSI E1.31) [specification](https://tsp.esta.org/tsp/documents/docs/ANSI_E1-31-2018.pdf).
- DMX (ANSI E1.11) [specification](https://tsp.esta.org/tsp/documents/docs/ANSI-ESTA_E1-11_2008R2018.pdf)