# sndwrks

> sndwrks is a live entertainment command center platform providing a physical server and web-based software for show control, OSC routing, haze monitoring, macros, and inter-department communication.

sndwrks local is the core product: a rack-mounted server with a browser-based UI that sits at the center of your show network. It routes OSC and sACN messages between departments, monitors atmospheric haze levels, fires complex macros, and logs show events — all controllable via a comprehensive OSC API.

- [Welcome](https://docs.sndwrks.com/): Overview of the sndwrks documentation, linking to Products, Guides, and Reference sections.

## Products

- [Overview](https://docs.sndwrks.com/products/overview): Top-level products landing page introducing sndwrks local.
- [sndwrks local](https://docs.sndwrks.com/products/sndwrks-local/home): Introduction to the sndwrks local server product and links to hardware and software documentation.
- [Server Hardware: Getting Started](https://docs.sndwrks.com/products/sndwrks-local/server-hardware/getting-started): Home page for all server hardware documentation, linking to overview and quick setup.
- [Server Hardware: What is it?](https://docs.sndwrks.com/products/sndwrks-local/server-hardware/what-is-it): Describes the physical sndwrks server, its role as the show network hub, port types (power, network, peripherals), and redundancy recommendations.
- [Server Hardware: Quick Setup](https://docs.sndwrks.com/products/sndwrks-local/server-hardware/quick-setup): Step-by-step unboxing, inspection, and power-on instructions for both the server and server smol hardware variants.
- [Software: Getting Started](https://docs.sndwrks.com/products/sndwrks-local/software/getting-started): Index page for the sndwrks local web app documentation, linking to all major software feature pages.
- [Software: What is it?](https://docs.sndwrks.com/products/sndwrks-local/software/what-is-it): High-level description of the sndwrks local web app — a browser-based mission control for routing, haze watch, macros, and show monitoring.
- [Software: Quick Setup](https://docs.sndwrks.com/products/sndwrks-local/software/quick-setup): Guide to getting the server online for the first time: finding the IP, opening the web app, configuring networking, and adding devices.
- [Software: Overview](https://docs.sndwrks.com/products/sndwrks-local/software/overview): Describes the show-floor home page and how to pin macro shortcut buttons for one-tap firing.
- [Software: Devices](https://docs.sndwrks.com/products/sndwrks-local/software/devices): Explains how to add and manage network devices (consoles, processors, sensors, etc.) that the server communicates with; devices are the foundation for routing, macros, and haze watch.
- [Software: Router](https://docs.sndwrks.com/products/sndwrks-local/software/router): Documents the message router and sACN router, including crosspoint configuration, filters, universe mapping, and message history audit trail.
- [Software: Macros](https://docs.sndwrks.com/products/sndwrks-local/software/macros): Covers the node-based macro system with triggers (OSC, sACN, wall clock, server event), commands (OSC, TCP, UDP, HTTP, email, device integrations), and transformers (delay, rate limit).
- [Software: Haze Watch](https://docs.sndwrks.com/products/sndwrks-local/software/haze-watch): Describes the haze monitoring system that reads PM2.5, temperature, humidity, and CO₂ from sensors and fires OSC commands via configurable triggers when particulate levels cross thresholds.
- [Software: Chat](https://docs.sndwrks.com/products/sndwrks-local/software/chat): Simple show-floor team chat with notification preferences; currently in preview.
- [Software: Utility](https://docs.sndwrks.com/products/sndwrks-local/software/utility): Provides a built-in network scanner, show event log, and syslog viewer for troubleshooting.
- [Software: Settings](https://docs.sndwrks.com/products/sndwrks-local/software/settings): All server configuration including power/reset controls, show info, e-stop, network settings, router ports, sACN, syslog, chat notifications, and backup/restore.

## Guides

- [Using Code to Send OSC](https://docs.sndwrks.com/guides/using-code-to-send-osc): Walkthrough for sending OSC messages programmatically using Python (python-osc) and Node.js (osc.js), including reusable CLI scripts and a practical macOS login-item automation example.
- [UDP vs TCP](https://docs.sndwrks.com/guides/udp-vs-tcp): Explains the difference between UDP and TCP transport protocols in the context of show control, with guidance on when to use each for cue triggers versus continuous data streams.

## Reference

- [OSC API V1](https://docs.sndwrks.com/reference/osc-api-v1): Complete reference for all OSC commands accepted by the sndwrks local server, covering global controls (confetti, ping, e-stop), devices, router crosspoints, event logging, haze watch triggers, macros, and chat messaging.
- [AI Statement](https://docs.sndwrks.com/reference/ai-statement): Describes how sndwrks uses AI (primarily Claude) to assist with documentation generation and proofreading, with notes on human review practices.