README.md

sACN in go

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

go get gitlab.com/patopest/go-sacn

• Receiver

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

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 directory for more examples.

Development

• Run an example to test your code

go run examples/receiver/receiver.go

• Tests

go test ./...

References

Similar projects

• sACN-Monitor: An app to view data from all sACN universes, built using this library.
• Hundemeier's go-sacn: Only supports Data packets
• go-artnet
• Open Lighting Architecure (OLA) framework (C implementations of control protocols).

Documentation

• sACN (ANSI E1.31) specification.
• DMX (ANSI E1.11) specification