Documentation
Complete documentation for TMRemote - orchestrating displays, A/V devices, LED controllers, and desktop automation. Select a topic to get started.
Extensible plugin architecture — add your own devices
Getting Started
README
Introduction and quick start guide. Start here if you're new to TMRemote.
Installation
Download, installation, and first-run setup instructions.
Features Overview
Complete feature list with descriptions of all capabilities.
User Guides
Automation & Triggers
Event-driven automation with action triggers. CLI, REST API, and shell mode.
Matrix Setup
Configure your OREI BK-808 HDMI matrix connection.
API & SDK
REST API & SDK
TMRemote HTTP REST API endpoints and Services SDK for plugin development.
Matrix HTTP API
Direct OREI BK-808 matrix control via HTTP JSON API.
Matrix Protocol Docs
OREI BK-808 API protocol details, commands, and integration guide.
Plugins
Devialet Plugin
Control Devialet Phantom speakers via IP Control API. Volume, sources, playback.
OREI Matrix Plugin
Control OREI BK-808 HDMI matrix switchers via serial or network.
Command Line
TMRemote CLI
Unified CLI for displays, matrix, scenarios, and plugins.
MatrixSwitcher CLI
Standalone HDMI matrix control tool.
Additional Resources
RS232 vs HTTP API
Comparison of OREI control methods - serial vs network.
BK-808 Manual (PDF)
Official OREI BK-808 hardware user manual.
Quick Reference
Common CLI Commands
| Command | Description |
|---|---|
TMRemote help | Show all available commands |
TMRemote status | Show current system status |
TMRemote profiles | List all saved monitor profiles |
TMRemote profile apply "Name" | Apply a monitor profile |
TMRemote scenarios | List all saved scenarios |
TMRemote scenario run "Name" | Run a scenario |
TMRemote route 2 1 | Route matrix input 2 to output 1 |
TMRemote plugins | List installed plugins |
REST API Endpoints
| Endpoint | Method | Description |
|---|---|---|
/api/profiles | GET | List all profiles |
/api/profiles/{name}/load | POST | Load a profile |
/api/scenarios | GET | List all scenarios |
/api/scenarios/{name}/run | POST | Run a scenario |
/api/matrix/route | POST | Route matrix input to output |
/api/status | GET | Get current system status |
/api/devialet/devices | GET | List connected Devialet devices |
/api/devialet/devices/{id}/volume | POST | Set Devialet volume |
Configuration Paths
| Item | Location |
|---|---|
| Application Data | %APPDATA%\MonitorSwitcher\ |
| Monitor Profiles | %APPDATA%\MonitorSwitcher\Profiles\ |
| Scenarios | %APPDATA%\MonitorSwitcher\Scenarios\ |
| Settings | %APPDATA%\MonitorSwitcher\settings.json |
Support
Get Help
- tmremote@halrad.com - Email support
- GitHub Repository - Issues and source code