A module for OpenShock Desktop that relays shock, vibrate, and sound commands from the OpenShock cloud to locally-connected hubs over a serial (USB) connection — letting you use OpenShock without putting your hub on Wi-Fi.
LocalRelay registers as a desktop module and:
- Authenticates with the OpenShock API using a token with the
Devices_Authpermission. - Subscribes to the OpenShock live control stream for your account.
- Forwards incoming commands to a physical OpenShock hub connected over a serial port.
The module adds two tabs to OpenShock Desktop:
- Hub — pair the relay with a hub registered to your account.
- Serial — pick the serial port for the connected hub and monitor the link.
- Windows, Linux, or macOS with OpenShock Desktop installed.
- .NET 10 runtime (bundled with OpenShock Desktop).
- An OpenShock hub flashed with firmware that supports serial control, connected via USB.
- An OpenShock account and an API token with the
Devices_Authpermission.
- Grab the latest
OpenShock.LocalRelay.module.zipfrom the Releases page. - Drop it into your OpenShock Desktop modules folder (or install it via the Desktop app's module manager).
- Restart OpenShock Desktop.
- Open the Local Relay module, pair your hub on the Hub tab, then select its port on the Serial tab.
dotnet restore LocalRelay.slnx
dotnet publish LocalRelay/LocalRelay.csproj --configuration Release -o publishThe packed module ends up at publish/OpenShock.LocalRelay.module.zip.
During local development, copy-module-dll.cmd can copy the built assemblies into your OpenShock Desktop module directory for quick iteration.
See LICENSE.