jwetzell/artnet-go
1
0
Fork 0
mirror of https://github.com/jwetzell/artnet-go.git synced 2026-08-12 18:43:41 +00:00
Code Issues Packages Projects Releases Wiki Activity

some untested implementations for moore artnet packet types

Browse Source
This commit is contained in:
Joel Wetzell
2026-05-25 19:05:49 -05:00
parent 207a18d18e
commit 225fb8b79a
6 changed files with 460 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files
artnet.go
+50
View File
@@ -85,6 +85,56 @@ func Decode(bytes []byte) (ArtNetPacket, error) {
}
return &artTimeCode, nil
case OpDataRequest:
artDataRequest := ArtDataRequest{}
err := artDataRequest.UnmarshalBinary(bytes)
if err != nil {
return nil, err
}
return &artDataRequest, nil
case OpDiagData:
artDiagData := ArtDiagData{}
err := artDiagData.UnmarshalBinary(bytes)
if err != nil {
return nil, err
}
return &artDiagData, nil
case OpCommand:
artCommand := ArtCommand{}
err := artCommand.UnmarshalBinary(bytes)
if err != nil {
return nil, err
}
return &artCommand, nil
case OpTrigger:
artTrigger := ArtTrigger{}
err := artTrigger.UnmarshalBinary(bytes)
if err != nil {
return nil, err
}
return &artTrigger, nil
case OpSync:
artSync := ArtSync{}
err := artSync.UnmarshalBinary(bytes)
if err != nil {
return nil, err
}
return &artSync, nil
default:
return nil, fmt.Errorf("unhandled opcode: %#x", opCode)
}
command.go
+88
View File
@@ -0,0 +1,88 @@
package artnet
import (
"encoding/binary"
"errors"
"slices"
)
type ArtCommand struct {
ID [8]uint8
OpCode uint16
ProtVerHi uint8
ProtVerLo uint8
EstaManHi uint8
EstaManLo uint8
LengthHi uint8
LengthLo uint8
Data []uint8
}
func (ap *ArtCommand) GetOpCode() uint16 {
return ap.OpCode
}
func (ap *ArtCommand) GetProtVer() uint16 {
return uint16(ap.ProtVerHi)<<8 + uint16(ap.ProtVerLo)
}
func (ap *ArtCommand) GetID() [8]uint8 {
return ap.ID
}
func (ap *ArtCommand) SetData(data string) error {
if len(data) > 512 {
return errors.New("data length must be less than or equal to 512 bytes")
}
ap.Data = make([]uint8, len(data))
copy(ap.Data, data)
ap.LengthHi = uint8(len(data) >> 8)
ap.LengthLo = uint8(len(data) & 0xff)
return nil
}
func (ap *ArtCommand) UnmarshalBinary(data []byte) error {
if len(data) < 16 {
return errors.New("ArtCommand packet must be at least 16 bytes long")
}
copy(ap.ID[:], data[0:8])
if !slices.Equal(ArtNetID[:], ap.ID[:]) {
return errors.New("ID does not match Art-Net ID")
}
ap.OpCode = binary.LittleEndian.Uint16(data[8:10])
ap.ProtVerHi = data[10]
ap.ProtVerLo = data[11]
offset := 12
ap.EstaManHi = data[offset]
ap.EstaManLo = data[offset+1]
ap.LengthHi = data[offset+2]
ap.LengthLo = data[offset+3]
dataLength := int(ap.LengthHi)<<8 + int(ap.LengthLo)
if len(data[offset+4:]) < dataLength {
return errors.New("[]byte length not long enough to contain data length specified in packet")
}
ap.Data = make([]uint8, dataLength)
copy(ap.Data, data[offset+4:offset+4+dataLength])
return nil
}
func (ap *ArtCommand) MarshalBinary() ([]byte, error) {
data := make([]byte, 8+8)
copy(data[0:8], ap.ID[:])
binary.LittleEndian.PutUint16(data[8:10], ap.OpCode)
data[10] = ap.ProtVerHi
data[11] = ap.ProtVerLo
data[12] = ap.EstaManHi
data[13] = ap.EstaManLo
data[14] = ap.LengthHi
data[15] = ap.LengthLo
data = append(data, ap.Data...)
return data, nil
}
data_request.go
+91
View File
@@ -0,0 +1,91 @@
package artnet
import (
"encoding/binary"
"errors"
"slices"
)
type DataRequest uint16
const (
DrPoll = 0x0000
DrUrlProduct = 0x0001
DrUrlUserGuide = 0x0002
DrUrlSupport = 0x0003
DrUrlPersUdr = 0x0004
DrUrlPersGdtf = 0x0005
)
type ArtDataRequest struct {
ID [8]uint8
OpCode uint16
ProtVerHi uint8
ProtVerLo uint8
EstaManHi uint8
EstaManLo uint8
OemHi uint8
OemLo uint8
RequestHi uint8
RequestLo uint8
spare [22]byte
}
func (ap *ArtDataRequest) GetOpCode() uint16 {
return ap.OpCode
}
func (ap *ArtDataRequest) GetProtVer() uint16 {
return uint16(ap.ProtVerHi)<<8 + uint16(ap.ProtVerLo)
}
func (ap *ArtDataRequest) GetID() [8]uint8 {
return ap.ID
}
func (ap *ArtDataRequest) GetDataRequestType() DataRequest {
return DataRequest(uint16(ap.RequestHi)<<8 + uint16(ap.RequestLo))
}
func (ap *ArtDataRequest) UnmarshalBinary(data []byte) error {
if len(data) < 40 {
return errors.New("ArtDataRequest packet must be at least 40 bytes long")
}
copy(ap.ID[:], data[0:8])
if !slices.Equal(ArtNetID[:], ap.ID[:]) {
return errors.New("ID does not match Art-Net ID")
}
ap.OpCode = binary.LittleEndian.Uint16(data[8:10])
ap.ProtVerHi = data[10]
ap.ProtVerLo = data[11]
offset := 12
ap.EstaManHi = data[offset]
ap.EstaManLo = data[offset+1]
ap.OemHi = data[offset+2]
ap.OemLo = data[offset+3]
ap.RequestHi = data[offset+4]
ap.RequestLo = data[offset+5]
copy(ap.spare[:], data[offset+6:offset+28])
return nil
}
func (ap *ArtDataRequest) MarshalBinary() ([]byte, error) {
data := make([]byte, 8+32)
copy(data[0:8], ap.ID[:])
binary.LittleEndian.PutUint16(data[8:10], ap.OpCode)
data[10] = ap.ProtVerHi
data[11] = ap.ProtVerLo
data[12] = ap.EstaManHi
data[13] = ap.EstaManLo
data[14] = ap.OemHi
data[15] = ap.OemLo
data[16] = ap.RequestHi
data[17] = ap.RequestLo
copy(data[18:40], ap.spare[:])
return data, nil
}
diag_data.go
+93
View File
@@ -0,0 +1,93 @@
package artnet
import (
"encoding/binary"
"errors"
"slices"
)
type DiagPriority uint8
const (
DpLow DiagPriority = 0x10
DpMed DiagPriority = 0x40
DpHigh DiagPriority = 0x80
DpCritical DiagPriority = 0xe0
DpVolatile DiagPriority = 0xf0
)
type ArtDiagData struct {
ID [8]uint8
OpCode uint16
ProtVerHi uint8
ProtVerLo uint8
filler1 uint8
DiagPriority DiagPriority
LogicalPort uint8
filler3 uint8
LengthHi uint8
LengthLo uint8
Data []uint8
}
func (ap *ArtDiagData) GetOpCode() uint16 {
return ap.OpCode
}
func (ap *ArtDiagData) GetProtVer() uint16 {
return uint16(ap.ProtVerHi)<<8 + uint16(ap.ProtVerLo)
}
func (ap *ArtDiagData) GetID() [8]uint8 {
return ap.ID
}
func (ap *ArtDiagData) UnmarshalBinary(data []byte) error {
if len(data) < 18 {
return errors.New("ArtDiagData packet must be at least 18 bytes long")
}
copy(ap.ID[:], data[0:8])
if !slices.Equal(ArtNetID[:], ap.ID[:]) {
return errors.New("ID does not match Art-Net ID")
}
ap.OpCode = binary.LittleEndian.Uint16(data[8:10])
ap.ProtVerHi = data[10]
ap.ProtVerLo = data[11]
offset := 12
ap.filler1 = data[offset]
ap.DiagPriority = DiagPriority(data[offset+1])
ap.LogicalPort = data[offset+2]
ap.filler3 = data[offset+3]
ap.LengthHi = data[offset+4]
ap.LengthLo = data[offset+5]
dataLength := int(ap.LengthHi)<<8 + int(ap.LengthLo)
if len(data[offset+6:]) < dataLength {
return errors.New("[]byte length not long enough to contain data length specified in packet")
}
ap.Data = make([]uint8, dataLength)
copy(ap.Data, data[offset+6:offset+6+dataLength])
return nil
}
func (ap *ArtDiagData) MarshalBinary() ([]byte, error) {
data := make([]byte, 8+10)
copy(data[0:8], ap.ID[:])
binary.LittleEndian.PutUint16(data[8:10], ap.OpCode)
data[10] = ap.ProtVerHi
data[11] = ap.ProtVerLo
data[12] = ap.filler1
data[13] = uint8(ap.DiagPriority)
data[14] = ap.LogicalPort
data[15] = ap.filler3
data[16] = ap.LengthHi
data[17] = ap.LengthLo
data = append(data, ap.Data...)
return data, nil
}
sync.go
+61
View File
@@ -0,0 +1,61 @@
package artnet
import (
"encoding/binary"
"errors"
"slices"
)
type ArtSync struct {
ID [8]uint8
OpCode uint16
ProtVerHi uint8
ProtVerLo uint8
Aux1 uint8
Aux2 uint8
}
func (ap *ArtSync) GetOpCode() uint16 {
return ap.OpCode
}
func (ap *ArtSync) GetProtVer() uint16 {
return uint16(ap.ProtVerHi)<<8 + uint16(ap.ProtVerLo)
}
func (ap *ArtSync) GetID() [8]uint8 {
return ap.ID
}
func (ap *ArtSync) UnmarshalBinary(data []byte) error {
if len(data) < 14 {
return errors.New("ArtSync packet must be at least 14 bytes long")
}
copy(ap.ID[:], data[0:8])
if !slices.Equal(ArtNetID[:], ap.ID[:]) {
return errors.New("ID does not match Art-Net ID")
}
ap.OpCode = binary.LittleEndian.Uint16(data[8:10])
ap.ProtVerHi = data[10]
ap.ProtVerLo = data[11]
offset := 12
ap.Aux1 = data[offset]
ap.Aux2 = data[offset+1]
return nil
}
func (ap *ArtSync) MarshalBinary() ([]byte, error) {
data := make([]byte, 8+6)
copy(data[0:8], ap.ID[:])
binary.LittleEndian.PutUint16(data[8:10], ap.OpCode)
data[10] = ap.ProtVerHi
data[11] = ap.ProtVerLo
data[12] = ap.Aux1
data[13] = ap.Aux2
return data, nil
}
trigger.go
+77
View File
@@ -0,0 +1,77 @@
package artnet
import (
"encoding/binary"
"errors"
"slices"
)
type ArtTrigger struct {
ID [8]uint8
OpCode uint16
ProtVerHi uint8
ProtVerLo uint8
filler1 uint8
filler2 uint8
OemHi uint8
OemLo uint8
Key uint8
SubKey uint8
Data []uint8
}
func (ap *ArtTrigger) GetOpCode() uint16 {
return ap.OpCode
}
func (ap *ArtTrigger) GetProtVer() uint16 {
return uint16(ap.ProtVerHi)<<8 + uint16(ap.ProtVerLo)
}
func (ap *ArtTrigger) GetID() [8]uint8 {
return ap.ID
}
func (ap *ArtTrigger) UnmarshalBinary(data []byte) error {
if len(data) < 18 {
return errors.New("ArtTrigger packet must be at least 18 bytes long")
}
copy(ap.ID[:], data[0:8])
if !slices.Equal(ArtNetID[:], ap.ID[:]) {
return errors.New("ID does not match Art-Net ID")
}
ap.OpCode = binary.LittleEndian.Uint16(data[8:10])
ap.ProtVerHi = data[10]
ap.ProtVerLo = data[11]
offset := 12
ap.filler1 = data[offset]
ap.filler2 = data[offset+1]
ap.OemHi = data[offset+2]
ap.OemLo = data[offset+3]
ap.Key = data[offset+4]
ap.SubKey = data[offset+5]
ap.Data = make([]uint8, len(data[offset+6:]))
copy(ap.Data, data[offset+6:])
return nil
}
func (ap *ArtTrigger) MarshalBinary() ([]byte, error) {
data := make([]byte, 8+10)
copy(data[0:8], ap.ID[:])
binary.LittleEndian.PutUint16(data[8:10], ap.OpCode)
data[10] = ap.ProtVerHi
data[11] = ap.ProtVerLo
data[12] = ap.filler1
data[13] = ap.filler2
data[14] = ap.OemHi
data[15] = ap.OemLo
data[16] = ap.Key
data[17] = ap.SubKey
data = append(data, ap.Data...)
return data, nil
}