@automation-room-control/node-red-arc

Node-RED nodes for Automation Room Control (ARC). Use them to trigger ARC controls from flows and listen for game state, timer, and objective progress.

Requirements

• Node-RED 2.0+
• ARC Software reachable on the same network
• ARC connection node-red enabled in Settings -> Connections

Install

cd ~/.node-red
npm install @automation-room-control/node-red-arc

Restart Node-RED after install.

Quick Start

1. Add an ARC Config node. It defaults to arc.local; change the host only if you need an IP address.
2. Use Test connection in the config node.
3. Add ARC Control to run an ARC action from a Node-RED flow.
4. Add ARC Timer, ARC State, or ARC Objective when a flow needs to react to live ARC activity.
5. Deploy.

Nodes

| Node | What it does | | --- | --- | | ARC Config | Shared ARC connection settings. The port is fixed at 1183. | | ARC Control | Runs game actions, objective actions, hint actions, display messages, display commands, or variable actions. | | ARC Timer | Sends timer updates every N seconds or at selected thresholds. | | ARC State | Sends selected game state changes. | | ARC Objective | Sends simple objective triggers: all completed, selected objective completed, bypassed, or reset. | | ARC Session | Sends a message when a game ends, with the full game results as msg.payload. Filter by game and/or outcome. |

The editor loads metadata from ARC, so games, objectives, displays, hints, and variables are selected from dropdowns instead of typed manually. Saved IDs are preserved if ARC is offline while editing.

ARC Control

ARC Control is the main output node. Pick a game, choose a control type, then choose the action from ARC-backed dropdowns.

Supported control types:

• Game action: start, pause, resume, adjust time, request help, end, success, failure, or reset game.
• Objective action: complete, bypass, or reset.
• Hint action: send a configured objective hint, with an Allow repeat send checkbox when the flow should permit sending the same hint again.
• Display message.
• Display command: clear, refresh, pause, resume, skip, reset overlay, alert, ambient audio, volume, or audio reset.
• Variable action: set, adjust, toggle, or reset a game variable.

Reset game does the same thing as the Reset Game button on the live control page: it returns the session to its idle state, resets game variables, clears the room displays back to the timer view, and restores audio to the game's configured levels. Like the control page, the reset always runs - it does not wait for props to be back in their reset positions.

The top-level control type list is the package's set of ARC categories. The choices inside the ARC-backed categories, such as objectives, hints, displays, and variables, are loaded from ARC metadata and refresh without republishing the Node-RED package.

Set msg.gameId to override the configured game for one trigger. Most flows do not need any other fields.

For Hint action nodes, set msg.allowRepeatSend or msg.allow_repeat_send to override the configured repeat-send policy for one trigger. Existing flows that send msg.resend are still accepted for compatibility.

ARC Session

ARC Session sends a message when a game ends. Use it to log finished games, send notifications, post results to a Slack channel or a spreadsheet, or feed a leaderboard.

• Pick the Game to watch.
• Leave Outcomes unchecked to send a message for every game, or check one or more (success / failure / unknown) to filter.
• msg.payload is the game's results: outcome, when it started and ended, how long it ran, how much time was left, the hints used (broken down by hint type — text, image, video, audio, TTS, verbal), objective progress (total / completed / bypassed), the team's size, and the staff member who ran the session.
• The message also includes msg.gameId, msg.gameName, msg.sessionId, and a timestamp on msg.ts.
• Games run in Testing mode never trigger this node.
• To watch multiple games, drop one ARC Session node per game in your flow.

Notes

• ARC host defaults to arc.local.
• ARC always runs on port 1183; the node configuration does not expose a port field.
• The ARC WebSocket path is handled by the package.
• Low-level raw event streaming is intentionally not included in this first package surface. It can return later as a separate advanced node if needed.

Release Notes

See CHANGELOG.md.