Files
tecamino-driver-artNet/README.md
2025-04-21 09:56:30 +02:00

45 lines
1.2 KiB
Markdown

# 🎛️ ArtNet Driver
**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
```