12 Commits

Author SHA1 Message Date
Adrian Zürcher
a92995d766 removie unused websocket 2025-04-29 17:16:36 +02:00
Adrian Zürcher
348a6f7622 move client context to correct place 2025-04-29 17:15:20 +02:00
Adrian Zürcher
83cbcdaa42 updated 2025-04-29 09:16:27 +02:00
Adrian Zürcher
2839b615c3 implement new json_data model 2025-04-29 08:34:51 +02:00
Adrian Zürcher
f5e66af3d8 add new ip ping for udp device
add new function start and stop bus
2025-04-22 18:01:22 +02:00
Adrian Zürcher
274e6acf0e update logger 2025-04-22 17:59:07 +02:00
Adrian Zuercher
c21d9b0dd0 fix wrong logging from error to debug 2025-04-21 09:59:07 +02:00
Adrian Zuercher
7b201f6e63 insert routes to main and driver 2025-04-21 09:56:30 +02:00
Adrian Zuercher
b777716aa7 add auth for future https srever and cfgHandler to load configuration 2025-04-21 09:55:11 +02:00
Adrian Zuercher
2273a6140f major change of server slim it down 2025-04-21 09:53:45 +02:00
Adrian Zuercher
11c8340be5 add .gitignore file and exclude .log and .cfg 2025-04-21 09:52:24 +02:00
Adrian Zuercher
56188a6ad0 major change of server slim it down 2025-04-21 09:50:34 +02:00
26 changed files with 726 additions and 370 deletions

2
.gitignore vendored Normal file
View File

@@ -0,0 +1,2 @@
*.cfg
*.log

View File

@@ -1,2 +1,45 @@
# ArtNet Driver # 🎛️ ArtNet Driver
Tecamino artNet driver DMX-Communication
**Tecamino ArtNet Driver** — A lightweight driver for DMX communication using the ArtNet protocol over TCP/IP.
This tool allows you to send DMX values to an ArtNet-compatible device, enabling remote lighting control and stage automation.
---
## 🚀 Features
- 🔌 Sends DMX data over the ArtNet protocol (UDP)
- 📁 Configurable working and config directories
- 🐞 Optional debug logging for development and troubleshooting
- ⚙️ Easy to run with CLI flags
---
## 🧰 Command Line Arguments
| Flag | Default | Description |
|-------------------|-------------|--------------------------------------|
| `--port` | `8110` | Port on which the server listens |
| `--cfg` | `./cfg` | Path to the configuration directory |
| `--workingDirectory` | `"."` | Working directory for runtime files |
| `--debug` | `false` | Enable verbose debug logging |
---
## 🏁 Getting Started
### 🔧 Run the Driver
```bash
go run main.go --port=8110 --cfg=./cfg --workingDirectory=. --debug=true
```
### 🔧 Build the App
To compile the Go code into a runnable binary:
#### On Linux or macOS:
```bash
go build -o artnet-driver
```

23
auth/auth.go Normal file
View File

@@ -0,0 +1,23 @@
package auth
import (
"errors"
"github.com/gin-gonic/gin"
)
func GetIDFromAuth(c *gin.Context) (string, error) {
auth := c.GetHeader("Authorization")
if len(auth) > 7 && auth[:7] == "Bearer " {
return auth[7:], nil
}
return "", errors.New("authorization token missing")
}
func GetIDFromQuery(c *gin.Context) (string, error) {
auth, exists := c.GetQuery("id")
if !exists {
return "", errors.New("id missing")
}
return auth, nil
}

62
cfg/cfg.go Normal file
View File

@@ -0,0 +1,62 @@
package cfg
import (
"os"
"path"
"gopkg.in/yaml.v3"
)
type Cfg struct {
Name string
Dir string
}
// Initializes new config handler
// dir is config directory from working dir on
// name is filename, file extention is automatically added '.cfg'
// file is in yaml format
// if file exists it will read its content in to the driver
func NewCfgHandler(dir, name string) *Cfg {
return &Cfg{
Dir: dir,
Name: name,
}
}
func (c *Cfg) SaveCfg(data any) error {
if _, err := os.Stat(c.Dir); err != nil {
if err := os.MkdirAll(c.Dir, 0666); err != nil {
return err
}
}
f, err := os.Create(path.Join(c.Dir, c.Name) + ".cfg")
if err != nil {
return err
}
defer f.Close()
encoder := yaml.NewEncoder(f)
encoder.SetIndent(2)
if err := encoder.Encode(data); err != nil {
return err
}
encoder.Close()
return nil
}
func (c *Cfg) LoadCfg(data any) error {
p := path.Join(c.Dir, c.Name) + ".cfg"
if _, err := os.Stat(p); err != nil {
return nil
}
b, err := os.ReadFile(p)
if err != nil {
return err
}
return yaml.Unmarshal(b, data)
}

66
client/client.go Normal file
View File

@@ -0,0 +1,66 @@
package client
import (
"context"
"fmt"
"github.com/coder/websocket"
"github.com/coder/websocket/wsjson"
json_data "github.com/tecamino/tecamino-json_data"
json_dataModels "github.com/tecamino/tecamino-json_data/models"
"github.com/tecamino/tecamino-logger/logging"
)
type Client struct {
conn *websocket.Conn
ctx context.Context
cancel context.CancelFunc
log *logging.Logger
}
// Initialize new websocket server
func NewClient(log *logging.Logger) *Client {
c := Client{
log: log,
}
c.ctx, c.cancel = context.WithCancel(context.Background())
return &c
}
func (c *Client) Connect(ip, id string, port uint) (err error) {
c.conn, _, err = websocket.Dial(c.ctx, fmt.Sprintf("ws://%s:%d/ws?id=%s", ip, port, id), nil)
return
}
func (c *Client) Disconnect() {
c.cancel()
}
func (c *Client) Subscribe(id string) error {
req := json_data.NewRequest()
req.AddDriverSubscription(".*", id, 0, true, false, false)
if err := wsjson.Write(c.ctx, c.conn, req); err != nil {
return err
}
return nil
}
func (c *Client) ReadJsonData() (response json_dataModels.Response, err error) {
err = wsjson.Read(c.ctx, c.conn, &response)
if err != nil {
code := websocket.CloseStatus(err)
switch code {
case websocket.StatusNormalClosure,
websocket.StatusGoingAway,
websocket.StatusNoStatusRcvd:
c.log.Info("webSocket.readJsonData", fmt.Sprintf("WebSocket closed: %v (code: %v)\n", err, code))
return
default:
c.log.Error("webSocket.readJsonData", fmt.Sprintf("WebSocket read error: %v (code: %v)\n", err, code))
return
}
}
return
}

View File

@@ -1,29 +1,111 @@
package driver package driver
import "artNet/models" import (
"artNet/cfg"
"artNet/client"
"artNet/models"
"fmt"
"path"
"github.com/tecamino/tecamino-logger/logging"
)
type ArtNetDriver struct { type ArtNetDriver struct {
Bus []*models.Bus Name string `yaml:"driver" json:"driver"`
Buses map[string]*models.Bus `yaml:"buses,omitempty" json:"buses,omitempty"`
cfgHandler *cfg.Cfg `yaml:"-" json:"-"`
Conn *client.Client `yaml:"-" json:"-"`
Subscriptions models.Subscriptions `yaml:"-" json:"-"`
Log *logging.Logger `yaml:"-" json:"-"`
} }
// initialize new Art-Net driver // initialize new Art-Net driver
func NewDriver() *ArtNetDriver { // cfgDir config directory
return &ArtNetDriver{} // name name of driver
func NewDriver(cfgDir, name string, debug bool) (*ArtNetDriver, error) {
if cfgDir == "" {
cfgDir = "./cfg"
}
logger, err := logging.NewLogger(path.Join(cfgDir, name+".log"), &logging.Config{
MaxSize: 1,
MaxBackup: 3,
MaxAge: 28,
Debug: debug,
TerminalOut: true,
})
if err != nil {
panic(err)
}
logger.Debug("artNet.NewDriver", "initialize "+name+" driver")
d := ArtNetDriver{
Name: name,
Buses: make(map[string]*models.Bus),
cfgHandler: cfg.NewCfgHandler(cfgDir, name),
Log: logger,
}
if err := d.LoadCfg(); err != nil {
logger.Error("artNet.NewDriver.LoadCfg", "error load driver configuration: "+err.Error())
return nil, err
}
return &d, nil
} }
// adds new Art-Net interface to driver port 0 = 6454 (default art-net) // loads driver config
func (d *ArtNetDriver) NewInterface(ip string, port int) *models.Bus { func (d *ArtNetDriver) LoadCfg() error {
i := models.NewBus(ip, port) d.Log.Debug("artNet.LoadCfg", "load driver configuration")
d.Bus = append(d.Bus, i) if err := d.cfgHandler.LoadCfg(d); err != nil {
return i return err
}
for _, b := range d.Buses {
d.NewBus(b.Name, b.Ip, *b.Port)
}
return nil
} }
// dmxData[46] = byte(255) // Channel 1: Red // adds new Art-Net bus/interface to driver port 0 = 6454 (default art-net)
// dmxData[47] = byte(255) // Channel 2: Green func (d *ArtNetDriver) NewBus(name, ip string, port int) *models.Bus {
// dmxData[48] = byte(255) // Channel 3: Blue b := models.NewBus(name, ip, port)
// dmxData[49] = byte(255) // Channel 4: White d.Buses[name] = b
// dmxData[50] = byte(255) // Channel 5: Amber return b
// dmxData[51] = byte(255) // Channel 6: UV Lila }
// dmxData[52] = byte(255) // Channel 7: 0-9 10-255 strobo
// dmxData[53] = byte(255) // Channel 8: 0-5 stop 6-127 static position 128-255 Motorgeschwindigkeit func (d *ArtNetDriver) SetValue(bus string, address uint, value uint8) error {
// dmxData[54] = byte(255) // Channel 9: 0-50 coincitence 51 -100 two color 101-150 all color if _, ok := d.Buses[bus]; !ok {
return fmt.Errorf("no bus '%s' found", bus)
}
d.Buses[bus].Data.SetValue(address, value)
return d.Buses[bus].SendData()
}
func (d *ArtNetDriver) Connect(ip, id string, port uint) error {
d.Conn = client.NewClient(d.Log)
if err := d.Conn.Connect(ip, id, port); err != nil {
return err
}
defer d.Conn.Disconnect()
if err := d.Conn.Subscribe(id); err != nil {
return err
}
for {
respond, err := d.Conn.ReadJsonData()
if err != nil {
return err
}
d.Subscribe(respond.Subscribe...)
for _, pub := range respond.Publish {
if sub, ok := d.Subscriptions[pub.Uuid]; ok {
if err := d.SetValue(sub.Bus, sub.Address, uint8(pub.Value.(float64))); err != nil {
d.Log.Info("artNet.Connect", err.Error())
}
}
}
}
}

158
driver/bus.go Normal file
View File

@@ -0,0 +1,158 @@
package driver
import (
"artNet/auth"
"artNet/models"
"fmt"
"net"
"net/http"
"github.com/gin-gonic/gin"
json_data "github.com/tecamino/tecamino-json_data"
json_dataModels "github.com/tecamino/tecamino-json_data/models"
)
// sends a list of all buses in the driver
func (d *ArtNetDriver) GetAllBuses(c *gin.Context) {
var data any
if len(d.Buses) == 0 {
data = "no buses avaiable"
} else {
data = *d
}
c.JSON(200, gin.H{
"buses": data,
})
}
func (d *ArtNetDriver) CreateBus(c *gin.Context) {
_, err := auth.GetIDFromQuery(c)
if err != nil {
r := json_data.NewResponse()
r.SendError(err.Error())
c.JSON(http.StatusBadRequest, r)
return
}
busPayload := models.Bus{}
if err := busPayload.ParsePayload(c); err != nil {
return
}
if addr := net.ParseIP(busPayload.Ip); addr == nil {
r := json_data.NewResponse()
r.SendError("wrong ip '" + busPayload.Ip + "'")
c.JSON(http.StatusBadRequest, r)
return
}
if _, ok := d.Buses[busPayload.Name]; ok {
r := json_data.NewResponse()
r.SendError("bus " + busPayload.Name + " exists already")
c.JSON(http.StatusOK, r)
return
}
bus := d.NewBus(busPayload.Name, busPayload.Ip, busPayload.GetPort())
r := json_data.NewResponse()
r.SendMessage(fmt.Sprintf("bus '%s' successfully created with ip: %s and on port: %d", bus.Name, bus.Ip, bus.GetPort()))
c.JSON(http.StatusOK, r)
d.cfgHandler.SaveCfg(*d)
}
func (d *ArtNetDriver) RemoveBus(c *gin.Context) {
_, err := auth.GetIDFromQuery(c)
if err != nil {
r := json_data.NewResponse()
r.SendError("id: " + err.Error())
c.JSON(http.StatusBadRequest, r)
return
}
busPayload := models.Bus{}
if err := busPayload.ParsePayload(c); err != nil {
return
}
if _, ok := d.Buses[busPayload.Name]; !ok {
r := json_dataModels.NewResponse()
r.SendMessage("bus " + busPayload.Name + " not found")
c.JSON(http.StatusOK, r)
return
} else {
delete(d.Buses, busPayload.Name)
}
r := json_dataModels.NewResponse()
r.SendMessage(fmt.Sprintf("bus '%s' successfully removed", busPayload.Name))
c.JSON(http.StatusOK, r)
d.cfgHandler.SaveCfg(*d)
}
func (d *ArtNetDriver) Start(c *gin.Context) {
_, err := auth.GetIDFromQuery(c)
if err != nil {
r := json_data.NewResponse()
r.SendError("id: " + err.Error())
c.JSON(http.StatusBadRequest, r)
return
}
busPayload := models.Bus{}
if busPayload.ParsePayload(c); err != nil {
return
}
d.Buses[busPayload.Name].Start(d.Log)
r := json_dataModels.NewResponse()
r.SendMessage(fmt.Sprintf("bus '%s' running", busPayload.Name))
c.JSON(http.StatusOK, r)
d.cfgHandler.SaveCfg(*d)
}
func (d *ArtNetDriver) Stop(c *gin.Context) {
_, err := auth.GetIDFromQuery(c)
if err != nil {
r := json_data.NewResponse()
r.SendError("id: " + err.Error())
c.JSON(http.StatusBadRequest, r)
return
}
busPayload := models.Bus{}
if err := busPayload.ParsePayload(c); err != nil {
return
}
d.Buses[busPayload.Name].Stop()
r := json_dataModels.NewResponse()
r.SendMessage(fmt.Sprintf("bus '%s' stopped", busPayload.Name))
c.JSON(http.StatusOK, r)
d.cfgHandler.SaveCfg(*d)
}
func (d *ArtNetDriver) Status(c *gin.Context) {
_, err := auth.GetIDFromQuery(c)
if err != nil {
r := json_data.NewResponse()
r.SendError("id: " + err.Error())
c.JSON(http.StatusBadRequest, r)
return
}
busPayload := models.Bus{}
if err := busPayload.ParsePayload(c); err != nil {
return
}
r := json_dataModels.NewResponse()
state := "stopped"
if d.Buses[busPayload.Name].Status() {
state = "running"
}
r.SendMessage(fmt.Sprintf("bus '%s' %s", busPayload.Name, state))
c.JSON(http.StatusOK, r)
}

20
driver/subscribe.go Normal file
View File

@@ -0,0 +1,20 @@
package driver
import (
"artNet/models"
json_dataModels "github.com/tecamino/tecamino-json_data/models"
)
func (d *ArtNetDriver) Subscribe(subs ...json_dataModels.Subscribe) {
if d.Subscriptions == nil {
d.Subscriptions = models.NewSubscriptions()
}
for _, sub := range subs {
if drv, ok := (*sub.Drivers)[sub.Driver]; ok {
d.Subscriptions.AddSubscription(sub.Uuid, drv)
d.SetValue(drv.Bus, drv.Address, uint8(sub.Value.(float64)))
}
}
}

7
go.mod
View File

@@ -7,8 +7,11 @@ toolchain go1.23.8
require ( require (
github.com/coder/websocket v1.8.13 github.com/coder/websocket v1.8.13
github.com/gin-gonic/gin v1.10.0 github.com/gin-gonic/gin v1.10.0
github.com/google/uuid v1.6.0
github.com/tatsushid/go-fastping v0.0.0-20160109021039-d7bb493dee3e github.com/tatsushid/go-fastping v0.0.0-20160109021039-d7bb493dee3e
github.com/tecamino/tecamino-logger v0.1.1 github.com/tecamino/tecamino-json_data v0.0.11
github.com/tecamino/tecamino-logger v0.2.0
gopkg.in/yaml.v3 v3.0.1
) )
require ( require (
@@ -39,5 +42,5 @@ require (
golang.org/x/sys v0.20.0 // indirect golang.org/x/sys v0.20.0 // indirect
golang.org/x/text v0.15.0 // indirect golang.org/x/text v0.15.0 // indirect
google.golang.org/protobuf v1.34.1 // indirect google.golang.org/protobuf v1.34.1 // indirect
gopkg.in/yaml.v3 v3.0.1 // indirect gopkg.in/natefinch/lumberjack.v2 v2.2.1 // indirect
) )

10
go.sum
View File

@@ -30,6 +30,8 @@ github.com/goccy/go-json v0.10.2/go.mod h1:6MelG93GURQebXPDq3khkgXZkazVtN9CRI+MG
github.com/google/go-cmp v0.5.5 h1:Khx7svrCpmxxtHBq5j2mp/xVjsi8hQMfNLvJFAlrGgU= github.com/google/go-cmp v0.5.5 h1:Khx7svrCpmxxtHBq5j2mp/xVjsi8hQMfNLvJFAlrGgU=
github.com/google/go-cmp v0.5.5/go.mod h1:v8dTdLbMG2kIc/vJvl+f65V22dbkXbowE6jgT/gNBxE= github.com/google/go-cmp v0.5.5/go.mod h1:v8dTdLbMG2kIc/vJvl+f65V22dbkXbowE6jgT/gNBxE=
github.com/google/gofuzz v1.0.0/go.mod h1:dBl0BpW6vV/+mYPU4Po3pmUjxk6FQPldtuIdl/M65Eg= github.com/google/gofuzz v1.0.0/go.mod h1:dBl0BpW6vV/+mYPU4Po3pmUjxk6FQPldtuIdl/M65Eg=
github.com/google/uuid v1.6.0 h1:NIvaJDMOsjHA8n1jAhLSgzrAzy1Hgr+hNrb57e+94F0=
github.com/google/uuid v1.6.0/go.mod h1:TIyPZe4MgqvfeYDBFedMoGGpEw/LqOeaOT+nhxU+yHo=
github.com/json-iterator/go v1.1.12 h1:PV8peI4a0ysnczrg+LtxykD8LfKY9ML6u2jnxaEnrnM= github.com/json-iterator/go v1.1.12 h1:PV8peI4a0ysnczrg+LtxykD8LfKY9ML6u2jnxaEnrnM=
github.com/json-iterator/go v1.1.12/go.mod h1:e30LSqwooZae/UwlEbR2852Gd8hjQvJoHmT4TnhNGBo= github.com/json-iterator/go v1.1.12/go.mod h1:e30LSqwooZae/UwlEbR2852Gd8hjQvJoHmT4TnhNGBo=
github.com/klauspost/cpuid/v2 v2.0.9/go.mod h1:FInQzS24/EEf25PyTYn52gqo7WaD8xa0213Md/qVLRg= github.com/klauspost/cpuid/v2 v2.0.9/go.mod h1:FInQzS24/EEf25PyTYn52gqo7WaD8xa0213Md/qVLRg=
@@ -63,8 +65,10 @@ github.com/stretchr/testify v1.9.0 h1:HtqpIVDClZ4nwg75+f6Lvsy/wHu+3BoSGCbBAcpTsT
github.com/stretchr/testify v1.9.0/go.mod h1:r2ic/lqez/lEtzL7wO/rwa5dbSLXVDPFyf8C91i36aY= github.com/stretchr/testify v1.9.0/go.mod h1:r2ic/lqez/lEtzL7wO/rwa5dbSLXVDPFyf8C91i36aY=
github.com/tatsushid/go-fastping v0.0.0-20160109021039-d7bb493dee3e h1:nt2877sKfojlHCTOBXbpWjBkuWKritFaGIfgQwbQUls= github.com/tatsushid/go-fastping v0.0.0-20160109021039-d7bb493dee3e h1:nt2877sKfojlHCTOBXbpWjBkuWKritFaGIfgQwbQUls=
github.com/tatsushid/go-fastping v0.0.0-20160109021039-d7bb493dee3e/go.mod h1:B4+Kq1u5FlULTjFSM707Q6e/cOHFv0z/6QRoxubDIQ8= github.com/tatsushid/go-fastping v0.0.0-20160109021039-d7bb493dee3e/go.mod h1:B4+Kq1u5FlULTjFSM707Q6e/cOHFv0z/6QRoxubDIQ8=
github.com/tecamino/tecamino-logger v0.1.1 h1:bK0SEQpbjui42OsnM6JCDThaGMBoqwVj/Op6ESqDwV4= github.com/tecamino/tecamino-json_data v0.0.11 h1:WVcF0tj+ElM9hRM1PccbSnY8DHJnLPauqzY0o0ib9O0=
github.com/tecamino/tecamino-logger v0.1.1/go.mod h1:sGysmiFGIdr4vLJRAI+fJgsa7EoRRuxvRrKW7GnGQkw= github.com/tecamino/tecamino-json_data v0.0.11/go.mod h1:LLlyD7Wwqplb2BP4PeO86EokEcTRidlW5MwgPd1T2JY=
github.com/tecamino/tecamino-logger v0.2.0 h1:NPH/Gg9qRhmVoW8b39i1eXu/LEftHc74nyISpcRG+XU=
github.com/tecamino/tecamino-logger v0.2.0/go.mod h1:0M1E9Uei/qw3e3WA1x3lBo1eP3H5oeYE7GjYrMahnj8=
github.com/twitchyliquid64/golang-asm v0.15.1 h1:SU5vSMR7hnwNxj24w34ZyCi/FmDZTkS4MhqMhdFk5YI= github.com/twitchyliquid64/golang-asm v0.15.1 h1:SU5vSMR7hnwNxj24w34ZyCi/FmDZTkS4MhqMhdFk5YI=
github.com/twitchyliquid64/golang-asm v0.15.1/go.mod h1:a1lVb/DtPvCB8fslRZhAngC2+aY1QWCk3Cedj/Gdt08= github.com/twitchyliquid64/golang-asm v0.15.1/go.mod h1:a1lVb/DtPvCB8fslRZhAngC2+aY1QWCk3Cedj/Gdt08=
github.com/ugorji/go/codec v1.2.12 h1:9LC83zGrHhuUA9l16C9AHXAqEV/2wBQ4nkvumAE65EE= github.com/ugorji/go/codec v1.2.12 h1:9LC83zGrHhuUA9l16C9AHXAqEV/2wBQ4nkvumAE65EE=
@@ -94,6 +98,8 @@ google.golang.org/protobuf v1.34.1 h1:9ddQBjfCyZPOHPUiPxpYESBLc+T8P3E+Vo4IbKZgFW
google.golang.org/protobuf v1.34.1/go.mod h1:c6P6GXX6sHbq/GpV6MGZEdwhWPcYBgnhAHhKbcUYpos= google.golang.org/protobuf v1.34.1/go.mod h1:c6P6GXX6sHbq/GpV6MGZEdwhWPcYBgnhAHhKbcUYpos=
gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405 h1:yhCVgyC4o1eVCa2tZl7eS0r+SDo693bJlVdllGtEeKM= gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405 h1:yhCVgyC4o1eVCa2tZl7eS0r+SDo693bJlVdllGtEeKM=
gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0= gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
gopkg.in/natefinch/lumberjack.v2 v2.2.1 h1:bBRl1b0OH9s/DuPhuXpNl+VtCaJXFZ5/uEFST95x9zc=
gopkg.in/natefinch/lumberjack.v2 v2.2.1/go.mod h1:YD8tP3GAjkrDg1eZH7EGmyESg/lsYskCTPBJVb9jqSc=
gopkg.in/yaml.v3 v3.0.0-20200313102051-9f266ea9e77c/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM= gopkg.in/yaml.v3 v3.0.0-20200313102051-9f266ea9e77c/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=
gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA= gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA=
gopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM= gopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=

101
main.go
View File

@@ -3,71 +3,66 @@ package main
import ( import (
"artNet/driver" "artNet/driver"
"artNet/server" "artNet/server"
"flag"
"fmt" "fmt"
"math" "os"
"time" "time"
"github.com/gin-gonic/gin"
) )
const DriverName string = "ArtNetDriver"
func main() { func main() {
// cli flags
cfgDir := flag.String("cfg", "./cfg", "config directory")
workingDir := flag.String("workingDirectory", ".", "current working directory")
serverIp := flag.String("serverIp", "127.0.0.1", "ip address of server")
serverPort := flag.Uint("serverPort", 8100, "port of server")
wsPort := flag.Uint("port", 8200, "websocket port")
debug := flag.Bool("debug", false, "debug logging")
flag.Parse()
bus := driver.NewDriver().NewInterface("2.0.0.1", 0) //change working directory only if value is given
d, _ := bus.AddDevice(47, 9) if *workingDir != "." && *workingDir != "" {
os.Chdir(*workingDir)
}
var i uint8 //initialize new ArtNet driver
artNetDriver, err := driver.NewDriver(*cfgDir, DriverName, *debug)
if err != nil {
artNetDriver.Log.Error("main", "error initialize new artnet driver "+err.Error())
panic(err)
}
//initialize new server
artNetDriver.Log.Debug("main", "initialize new server instance")
s := server.NewServer() s := server.NewServer()
s.ServeHttp(8120) //set routes
artNetDriver.Log.Debug("main", "setting routes")
s.Routes.GET("/buses/all", artNetDriver.GetAllBuses)
s.Routes.POST("/buses/create", artNetDriver.CreateBus)
s.Routes.POST("/buses/remove", artNetDriver.RemoveBus)
s.Routes.POST("/buses/start", artNetDriver.Start)
s.Routes.POST("/buses/status", artNetDriver.Status)
s.Routes.POST("/buses/stop", artNetDriver.Stop)
s.Routes.GET("/", func(c *gin.Context) {
c.String(200, "ArtNet Driver WebSocket Server is running!")
})
go func() {
if err := s.ServeHttp(*wsPort); err != nil {
artNetDriver.Log.Error("main", err.Error())
}
}()
artNetDriver.Log.Info("main", fmt.Sprintf("connect to server ws://%s:%d with id %s", *serverIp, serverPort, DriverName))
// connect to server
for { for {
if i == math.MaxUint8 { artNetDriver.Log.Error("main", artNetDriver.Connect(*serverIp, DriverName, *serverPort))
i = 0 time.Sleep(10 * time.Second)
}
err := d.SetChannelValue(0, i)
if err != nil {
fmt.Println(err)
}
err = d.SetChannelValue(1, i)
if err != nil {
fmt.Println(err)
}
err = d.SetChannelValue(2, i)
if err != nil {
fmt.Println(err)
}
err = d.SetChannelValue(3, i)
if err != nil {
fmt.Println(err)
}
err = d.SetChannelValue(4, i)
if err != nil {
fmt.Println(err)
}
err = d.SetChannelValue(5, i)
if err != nil {
fmt.Println(err)
}
err = d.SetChannelValue(6, i)
if err != nil {
fmt.Println(err)
}
err = d.SetChannelValue(7, i)
if err != nil {
fmt.Println(err)
}
err = d.SetChannelValue(8, i)
if err != nil {
fmt.Println(err)
}
if err := bus.SendData(); err != nil {
fmt.Println(12, err)
panic(err)
}
time.Sleep(100 * time.Microsecond)
i += 1
i = 0
} }
} }

View File

@@ -1,11 +1,17 @@
package models package models
import ( import (
"context"
"errors"
"fmt" "fmt"
"net" "net"
"net/http"
"time" "time"
"github.com/gin-gonic/gin"
"github.com/tatsushid/go-fastping" "github.com/tatsushid/go-fastping"
json_data "github.com/tecamino/tecamino-json_data"
"github.com/tecamino/tecamino-logger/logging"
) )
// Art-Net constants // Art-Net constants
@@ -15,43 +21,47 @@ const (
// Art-Net Interface // Art-Net Interface
type Bus struct { type Bus struct {
ip string `yaml:"ip"` Name string `yaml:"name" json:"name"`
port int `yaml:"port"` Ip string `yaml:"ip" json:"ip"`
Devices []*Device `yaml:"devices"` Port *int `yaml:"port" json:"port,omitempty"`
Data *DMX Data *DMX `yaml:"-" json:"-"`
Watchdog context.CancelFunc `yaml:"-" json:"-"`
Reachable bool `yaml:"-" json:"-"`
} }
// adds new Art-Net interface to driver port 0 = 6454 (default art-net) // adds new Art-Net interface to driver port 0 = 6454 (default art-net)
func NewBus(ip string, port int) *Bus { func NewBus(name, ip string, port int) *Bus {
if port == 0 { if port == 0 {
port = artPort port = artPort
} }
i := Bus{ i := Bus{
ip: ip, Name: name,
port: port, Ip: ip,
Port: &port,
Data: NewDMXUniverse(), Data: NewDMXUniverse(),
} }
return &i return &i
} }
// adds new dmx device to interface // get bus port from pointer
func (i *Bus) AddDevice(address uint, channels uint) (*Device, error) { func (b *Bus) GetPort() int {
d := NewDevice(address, channels, i.Data) if b.Port == nil {
i.Devices = append(i.Devices, d) return artPort
return d, nil }
return *b.Port
} }
// start polling dmx data in milliseconds 0 = aprox. 44Hertz // start polling dmx data in milliseconds 0 = aprox. 44Hertz
func (i *Bus) Poll(interval time.Duration) error { func (b *Bus) Poll(interval time.Duration) error {
if interval == 0 { if interval == 0 {
interval = 23 interval = 23
} }
// Send packet over UDP // Send packet over UDP
conn, err := net.DialUDP("udp", nil, &net.UDPAddr{ conn, err := net.DialUDP("udp", nil, &net.UDPAddr{
IP: net.ParseIP(i.ip), IP: net.ParseIP(b.Ip),
Port: i.port, Port: *b.Port,
}) })
if err != nil { if err != nil {
@@ -63,7 +73,7 @@ func (i *Bus) Poll(interval time.Duration) error {
for { for {
go func() { go func() {
for { for {
if reached, _ := isUDPReachable(i.ip); !reached { if reached, _ := isUDPReachable(b.Ip); !reached {
if errCount > 20 { if errCount > 20 {
break break
} else { } else {
@@ -77,7 +87,7 @@ func (i *Bus) Poll(interval time.Duration) error {
} }
}() }()
_, err = conn.Write(NewArtNetPackage(i.Data)) _, err = conn.Write(NewArtNetPackage(b.Data))
if err != nil { if err != nil {
return err return err
} }
@@ -89,12 +99,60 @@ func (i *Bus) Poll(interval time.Duration) error {
} }
} }
// start polling dmx data in milliseconds 0 = aprox. 44Hertz // start bus
func (i *Bus) SendData() error { func (b *Bus) Start(log *logging.Logger) {
var ctx context.Context
ctx, b.Watchdog = context.WithCancel(context.Background())
go func() {
var interval time.Duration = 10 * time.Second
log.Info("bus.Start", fmt.Sprintf("device:%s ip:%s watchdog stopped", b.Name, b.Ip))
for {
select {
case <-ctx.Done():
log.Info("bus.Start", fmt.Sprintf("device:%s ip:%s watchdog stopped", b.Name, b.Ip))
b.Reachable = false
return
default:
b.Reachable = false
if reached, err := isUDPReachable(b.Ip); err != nil {
log.Error("bus.Start", err)
interval = 5 * time.Second
} else if !reached {
log.Error("bus.Start", fmt.Sprintf("device:%s ip:%s not reached", b.Name, b.Ip))
interval = 5 * time.Second
} else {
b.Reachable = true
log.Info("bus.Start", fmt.Sprintf("device:%s ip:%s watchdog running", b.Name, b.Ip))
interval = 30 * time.Second
}
time.Sleep(interval)
}
}
}()
}
// stop bus
func (b *Bus) Stop() {
if b.Watchdog != nil {
b.Watchdog()
}
}
// status bus
func (b *Bus) Status() bool {
return b.Watchdog != nil
}
// send dmx data
func (b *Bus) SendData() error {
if !b.Reachable {
return nil
}
// Send packet over UDP // Send packet over UDP
conn, err := net.DialUDP("udp", nil, &net.UDPAddr{ conn, err := net.DialUDP("udp", nil, &net.UDPAddr{
IP: net.ParseIP(i.ip), IP: net.ParseIP(b.Ip),
Port: i.port, Port: *b.Port,
}) })
if err != nil { if err != nil {
@@ -102,28 +160,28 @@ func (i *Bus) SendData() error {
} }
defer conn.Close() defer conn.Close()
errChan := make(chan error) _, err = conn.Write(NewArtNetPackage(b.Data))
go func() {
if reached, _ := isUDPReachable(i.ip); !reached {
errChan <- fmt.Errorf("device not reachable")
return
}
errChan <- nil
}()
err = <-errChan
if err != nil {
return err
}
_, err = conn.Write(NewArtNetPackage(i.Data))
return err return err
} }
const ( func (b *Bus) ParsePayload(c *gin.Context) error {
protocolICMP = 1
) if err := c.BindJSON(b); err != nil {
r := json_data.NewResponse()
r.SendError("json: " + err.Error())
c.JSON(http.StatusBadRequest, r)
return err
}
if b.Name == "" {
r := json_data.NewResponse()
r.SendError("bus name missing")
c.JSON(http.StatusBadRequest, r)
return errors.New("bus name missing")
}
return nil
}
func isUDPReachable(ip string) (recieved bool, err error) { func isUDPReachable(ip string) (recieved bool, err error) {
p := fastping.NewPinger() p := fastping.NewPinger()
@@ -132,10 +190,11 @@ func isUDPReachable(ip string) (recieved bool, err error) {
return return
} }
p.AddIPAddr(ra) p.AddIPAddr(ra)
p.OnRecv = func(addr *net.IPAddr, rtt time.Duration) { p.OnRecv = func(addr *net.IPAddr, rtt time.Duration) {
recieved = true recieved = true
return
} }
p.OnIdle = func() {} p.OnIdle = func() {}
err = p.Run() err = p.Run()

View File

@@ -1,25 +0,0 @@
package models
import "fmt"
type Device struct {
startAddress uint
length uint
channels *DMX
}
func NewDevice(startAddress uint, channels uint, dmx *DMX) *Device {
return &Device{
startAddress: startAddress,
length: channels,
channels: dmx,
}
}
func (d *Device) SetChannelValue(channel uint, value uint8) error {
if d.length == channel {
return fmt.Errorf("channel out of range %d", channel)
}
d.channels.SetValue(d.startAddress+channel, value)
return nil
}

View File

@@ -1,5 +0,0 @@
package models
type Get struct {
Bus uint `json:"bus"`
}

View File

@@ -1,22 +0,0 @@
package models
type JsonData struct {
Set *[]Set `json:"set,omitempty"`
}
func NewRequest() *JsonData {
return &JsonData{}
}
func (r *JsonData) AddSet(bus, address uint, value uint8) {
if r.Set == nil {
r.Set = &[]Set{}
}
*r.Set = append(*r.Set, Set{
Bus: bus,
Address: address,
Value: value,
})
}

View File

@@ -1,7 +1,7 @@
package models package models
type Set struct { type Set struct {
Bus uint `json:"bus"` Bus string `json:"bus"`
Address uint `json:"address"` Address uint `json:"address"`
Value uint8 `json:"value"` Value uint8 `json:"value"`
} }

25
models/subscriptions.go Normal file
View File

@@ -0,0 +1,25 @@
package models
import (
"github.com/google/uuid"
json_dataModels "github.com/tecamino/tecamino-json_data/models"
)
type Subscriptions map[uuid.UUID]Subscription
type Subscription struct {
Bus string
Address uint
}
func NewSubscriptions() Subscriptions {
return make(Subscriptions)
}
func (s *Subscriptions) AddSubscription(uid uuid.UUID, drv *json_dataModels.Driver) {
sub := Subscription{
Bus: drv.Bus,
Address: drv.Address,
}
(*s)[uid] = sub
}

View File

@@ -1,18 +0,0 @@
package server
import (
"github.com/gin-gonic/gin"
)
func (s *Server) AllBuses(c *gin.Context) {
var data any
if s.Driver.Bus == nil {
data = "no buses avaiable"
} else {
data = s.Driver.Bus
}
c.JSON(200, gin.H{
"buses": data,
})
}

View File

@@ -1,25 +0,0 @@
package server
import (
"net/http"
"artNet/models"
"github.com/gin-gonic/gin"
)
func (s *Server) JsonRequest(c *gin.Context) {
var payload models.JsonData
if err := c.BindJSON(&payload); err != nil {
c.JSON(http.StatusBadRequest, gin.H{"error": err.Error()})
return
}
c.JSON(200, gin.H{
"name": payload,
})
return
}

44
server/models/clients.go Normal file
View File

@@ -0,0 +1,44 @@
package models
// type Clients map[string]Client
// type Client struct {
// Connected *bool `json:"connected"`
// SndConn *websocket.Conn `json:"-"` //sending connection
// RvcConn *websocket.Conn `json:"-"` // revieving connection
// }
// func NewClients() Clients {
// return make(Clients)
// }
// // Connect a recieving websocket connection
// func (c *Clients) ConnectRecievingWsConnection(id string, ctx *gin.Context) (*websocket.Conn, error) {
// conn, err := websocket.Accept(ctx.Writer, ctx.Request, &websocket.AcceptOptions{
// OriginPatterns: []string{"*"},
// })
// if err != nil {
// return nil, fmt.Errorf("error accept websocket client: %s", err)
// }
// b := true
// (*c)[id] = Client{
// Connected: &b,
// RvcConn: conn,
// }
// return conn, nil
// }
// func (c *Clients) RemoveClient(id string) {
// delete(*c, id)
// }
// func (c *Clients) GetClientPointer(id string) *bool {
// return (*c)[id].Connected
// }
// func (c *Clients) DisconnectRecievingWsConnection(id string, code websocket.StatusCode, reason string) {
// *(*c)[id].Connected = false
// (*c)[id].RvcConn.Close(code, reason)
// }

View File

@@ -1,7 +0,0 @@
package models
type Response struct {
StatusCode int `json:"statusCode"`
Message string `json:"message,omitempty"`
Data string `json:"dat,omitempty"`
}

View File

@@ -1,26 +0,0 @@
package models
import "github.com/coder/websocket"
type Subscribers map[*websocket.Conn]*bool
func InitSubsrcibers() Subscribers {
return make(Subscribers)
}
func (s *Subscribers) Connect(conn *websocket.Conn) {
b := true
(*s)[conn] = &b
}
func (s *Subscribers) DeleteSubsrcibers(conn *websocket.Conn) {
delete(*s, conn)
}
func (s *Subscribers) GetPointer(conn *websocket.Conn) *bool {
return (*s)[conn]
}
func (s *Subscribers) Disconnect(conn *websocket.Conn) {
*(*s)[conn] = false
}

View File

@@ -1,16 +0,0 @@
package server
import (
"github.com/gin-gonic/gin"
)
func (s *Server) AddRoutes() {
s.engine.GET("/ws", s.handleWebSocket)
s.engine.GET("/allBuses", s.AllBuses)
s.engine.GET("/", func(c *gin.Context) {
c.String(200, "WebSocket Broadcast Server is running!")
})
}

View File

@@ -1,48 +1,38 @@
package server package server
import ( import (
"fmt"
"sync"
"artNet/cert" "artNet/cert"
"artNet/driver" "fmt"
serverModels "artNet/server/models"
"github.com/gin-gonic/gin" "github.com/gin-gonic/gin"
"github.com/tecamino/tecamino-logger/logging"
) )
type Server struct { type Server struct {
engine *gin.Engine Routes *gin.Engine
sync.RWMutex
Subscribers serverModels.Subscribers
Logger *logging.Logger
Driver *driver.ArtNetDriver
} }
type Send struct {
Set []Set `json:"subscribe"`
}
type Set struct {
Path string `json:"path"`
OnChange bool `json:"onChange"`
Depth int `json:"depth"`
Driver string `json:"driver"`
}
// Initialize new websocket server
func NewServer() *Server { func NewServer() *Server {
s := Server{ return &Server{
engine: gin.Default(), Routes: gin.Default(),
Subscribers: serverModels.InitSubsrcibers(),
} }
s.AddRoutes()
s.Driver = driver.NewDriver()
return &s
} }
func (s *Server) ServeHttp(port uint) error { func (s *Server) ServeHttp(port uint) error {
if err := s.engine.Run(fmt.Sprintf(":%d", port)); err != nil { return s.Routes.Run(fmt.Sprintf(":%d", port))
return fmt.Errorf("failed to run http server: %v", err)
}
return nil
} }
func (s *Server) ServeHttps(port uint, cert cert.Cert) error { func (s *Server) ServeHttps(port uint, cert cert.Cert) error {
cert.GenerateSelfSignedCert() return s.Routes.RunTLS(fmt.Sprintf(":%d", port), cert.CertFile, cert.KeyFile)
if err := s.engine.RunTLS(fmt.Sprintf(":%d", port), cert.CertFile, cert.KeyFile); err != nil {
return fmt.Errorf("failed to run https server: %v", err)
}
return nil
} }

View File

@@ -1,13 +0,0 @@
package server
import (
"artNet/models"
"fmt"
)
func (s *Server) Set(get models.Get) error {
if len(s.Driver.Bus) <= int(get.Bus) {
return fmt.Errorf("no bus number '%d' found", get.Bus)
}
return nil
}

View File

@@ -1,65 +0,0 @@
package server
import (
"context"
"fmt"
"log"
"time"
"artNet/models"
"github.com/coder/websocket"
"github.com/coder/websocket/wsjson"
"github.com/gin-gonic/gin"
)
const (
OnCreate = "onCreate"
OnChange = "onChange"
OnDelete = "onDelete"
)
func (s *Server) handleWebSocket(c *gin.Context) {
conn, err := websocket.Accept(c.Writer, c.Request, &websocket.AcceptOptions{
OriginPatterns: []string{"*"},
})
if err != nil {
log.Println("Upgrade error:", err)
return
}
defer conn.Close(websocket.StatusInternalError, "Internal error")
ctx, cancel := context.WithTimeout(c.Request.Context(), 10*time.Minute)
defer cancel()
s.Subscribers.Connect(conn)
//Read loop
for {
var request models.JsonData
err := wsjson.Read(ctx, conn, &request)
if err != nil {
fmt.Println(s.Subscribers[conn])
log.Println("WebSocket read error:", err)
s.Subscribers.Disconnect(conn)
fmt.Println(s.Subscribers[conn])
break
}
// Set
// if request.Set != nil {
// for _, set := range *request.Set {
// err = s.Unsubscribe(unsub, conn)
// if err != nil {
// fmt.Println(err)
// break
// }
// }
// }
if err != nil {
break
}
}
}