Merge branch 'main' into development

Author: anselanza

.github/workflows/release.yml

@@ -1,10 +1,12 @@
 [package]
 name = "tether-artnet-controller"
-version = "0.2.0"
+version = "0.8.4"
 edition = "2021"
 repository = "https://github.com/RandomStudio/tether-artnet-controller"
+homepage = "https://github.com/RandomStudio/tether-artnet-controller"
 authors = ["Stephen Buchanan"]
-description= "A remote control software lighting desk"
+description = "A remote control software lighting desk"
+license = "MIT"
 
 [package.metadata.wix]
 upgrade-guid = "8E5F37FF-2FE0-464D-B307-5F64A0466ACF"
@@ -15,7 +17,7 @@ eula = false
 # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
 
 [dependencies]
-tether-agent = "0.12.1"
+tether-agent = "0.14"
 artnet_protocol = "0.4.1"
 tween = "2.0.0"
 rand = "0.8.5"
@@ -25,27 +27,14 @@ log = "0.4.18"
 serde = { version = "1.0", features = ["derive"] }
 serde_json = "1.0.91"
 rmp-serde = "1.1.1"
-eframe = "0.22.0"
-egui = { version = "0.22.0", features = ["persistence"] }
+egui = { version = "0.26.2", features = ["persistence"] }
 anyhow = "1.0.75"
 rfd = "0.12.1"
+eframe = "0.26.2"
+ctrlc = "3.4.2"
+indexmap = { version = "2.2.5", features = ["serde"] }
 
 # The profile that 'cargo dist' will build with
 [profile.dist]
 inherits = "release"
 lto = "thin"
-
-# Config for 'cargo dist'
-[workspace.metadata.dist]
-# The preferred cargo-dist version to use in CI (Cargo.toml SemVer syntax)
-cargo-dist-version = "0.8.0"
-# CI backends to support
-ci = ["github"]
-# The installers to generate for each app
-installers = ["shell", "msi"]
-# Target platforms to build apps for (Rust target-triple syntax)
-targets = ["aarch64-apple-darwin", "x86_64-apple-darwin", "x86_64-unknown-linux-gnu", "x86_64-pc-windows-msvc"]
-# Publish jobs to run in CI
-pr-run-mode = "plan"
-
-

Cargo.lock

@@ -1,27 +1,51 @@
 # Tether ArtNet Controller
 
-A reasonably generic ArtNet control system with the following features:
-- Software-based "Lighting Desk" for manually manipulating light fixtures
-- Controllable via a MIDI controller
-- Controllable via Tether "remote commands" including animations
+Sometimes you don't need pixel-mapping, you just need to control some DMX fixtures. **This application works like a lighting desk, but better.**
+
+Runs on Mac, Linux and even Windows.
+
+![screenshot](./screenshot.png)
+
+This application lets you achieve the following:
+
+- fiddle with some sliders to figure out what each channel is doing, without even needing to set up "fixtures" or "mapping" first
+- set up a Project with Fixtures, complete with easy-to-access documentation about what each channel does
+- define Macros which are labelled shortcuts to the channel(s) you care about most for each kind of Fixture
+- set up Scenes which apply Macros to the entire system, either immediately or over time (animated transition)
+
+In addition, the main features above (Macros, Scenes, Animations) can be controlled in multiple ways:
+
+- using a friendly GUI interface
+- using a MIDI controller
+- using Tether messaging
+
+Use this application for your lighting design in GUI mode, then run with `--headless` to launch as a server which can be controlled remotely via third-party applications. Nice!
 
 ## CLI
 
+Get all the available options by appending `--help`
+
 Example: start with connected interface:
+
 ```
-cargo run --release -- --artnet.interface 10.0.0.100 --artnet.destination 10.0.0.99
+tether-artnet-controller myproject.json --artnet.interface 10.0.0.100 --artnet.destination 10.0.0.99
 ```
 
 Example: start with local testing for ArtnetView:
+
 ```
-cargo run -- --artnet.interface 10.112.10.187 --artnet.destination 10.112.10.187 --loglevel debug
+tether-artnet-controller --artnet.interface 10.112.10.187 --artnet.destination 10.112.10.187 --loglevel debug
 ```
 
-## Remote control
+## Test Tether control using Tether Egui
+
 If you have Tether Egui installed (`cargo install tether-egui`) then the easiest way to test Tether remote control is to launch Tether Egui with the example project file included, i.e.:
 `tether-egui tether-egui-testing.json`
 
+---
+
 ## TODO
+
 - [x] Add labels for which channels are already "taken"/assigned in master slider list
 - [x] Add indications of "range values" for channels where this applies (under fixture section)
 - [x] Allow macros to be (temporarily) disabled so Fixture>Mapping values can be adjusted directly without being overridden
@@ -32,9 +56,15 @@ If you have Tether Egui installed (`cargo install tether-egui`) then the easiest
 - [x] Provide simple/advanced views (e.g. "macros only" vs "the kitchen sink")
 - [x] Scenes should be triggered by Tether messages
 - [x] Hit a button to save the current state of all macros to a new Scene
-- [ ] Project JSON should save ArtNet configuration (but can override via CLI args)
-- [ ] Colour conversions should be possible manually, e.g. RGB -> CMY
-- [ ] With macros, add some visual indicators of state, e.g. Colour, Brightness and Pan/Tilt 
-- [ ] At the moment, macros simply get "inactive" when something further downstream is applied (fixture controls, individual channels); it would be nice to propagate any live changes applied back "up" to the macro values as well.
-- [ ] Add 16-bit control, at least for macros (single slider adjusts the two channels as split between first and second 8-bit digits)
+- [x] Project JSON should save ArtNet configuration (but can override via CLI args)
+- [x] Colour conversions should be possible manually, e.g. RGB -> CMY
+- [x] With macros, add some visual indicators of state, e.g. Colour, Brightness and Pan/Tilt
+- [x] Allow the app to launch just fine without Tether
+- [x] If no ArtNet provided in Project (and no settings provided from CLI), then do NOT connect, but allow editing / manual connect
+- [x] Allow Tether settings to be saved with project as well
+- [ ] Add amber Macros for some fixtures (and include these in scenes)
+- [ ] Keep project files sorted, e.g. by fixtures
+- [x] Allow the app to launch without any project file at all
+- [x] Add 16-bit control, at least for macros (single slider adjusts the two channels as split between first and second 8-bit digits)
 - [ ] ArtNet on separate thread, with more precise timing; this might require some messaging back and forth and/or mutex
+- [ ] It should be possible to add Macros from "Advanced Mode" into the available macros for the fixtures (and therefore the scenes). This would be part of a fixture-editing UI?

Cargo.toml

@@ -0,0 +1,43 @@
+use std::{
+    fs::{self, File},
+    io::{self, Write},
+};
+
+fn main() {
+    println!("cargo:rerun-if-changed=src/project.rs");
+
+    let entries = fs::read_dir("./fixtures")
+        .expect("failed to list fixture files")
+        .map(|res| res.map(|x| x.path()))
+        .collect::<Result<Vec<_>, io::Error>>()
+        .unwrap();
+
+    let mut entire_string = String::new();
+    entire_string.push_str("[\n");
+
+    for (index, fixture_path) in entries.iter().enumerate() {
+        println!("Fixture file: {:?}", fixture_path);
+        if fixture_path.is_file() {
+            match fs::read_to_string(fixture_path) {
+                Ok(d) => {
+                    entire_string.push_str(&d);
+                    if index < (entries.len() - 1) {
+                        entire_string.push(',');
+                    }
+                }
+                Err(e) => {
+                    panic!(
+                        "Something went wrong reading the contents of the fixture file: {}",
+                        e
+                    );
+                }
+            }
+        }
+    }
+
+    entire_string.push_str("\n]");
+
+    let mut f = File::create("src/all_fixtures.json").expect("failed to create output file");
+    f.write_all(entire_string.as_bytes())
+        .expect("failed to write");
+}

README.md

@@ -0,0 +1,20 @@
+[workspace]
+members = ["cargo:."]
+
+# Config for 'dist'
+[dist]
+# The preferred dist version to use in CI (Cargo.toml SemVer syntax)
+cargo-dist-version = "0.27.0"
+# CI backends to support
+ci = "github"
+# The installers to generate for each app
+installers = ["homebrew", "msi"]
+# A GitHub repo to push Homebrew formulas to
+tap = "RandomStudio/homebrew-tap"
+# Target platforms to build apps for (Rust target-triple syntax)
+targets = ["aarch64-apple-darwin", "x86_64-apple-darwin", "x86_64-unknown-linux-gnu", "x86_64-pc-windows-msvc"]
+# Publish jobs to run in CI
+publish-jobs = ["homebrew"]
+
+[dist.dependencies.apt]
+libgtk-3-dev = "*"