Documentation
VICREO Timer
This module connects to the VICREO Timer HTTP API and listens to the live /api/events SSE stream.
Configuration
Configure the module with:
API host / IP: defaults to127.0.0.1, but can be any reachable VICREO Timer machine on your networkAPI port: defaults to3892Reconnect interval: how often the module retries if the app is unavailable
The VICREO Timer app must be running for the REST API and SSE stream to be available.
Actions
- Select a timer in the app
- Control the active timer: start, pause, reset, show, hide, duplicate, move, delete
- Send keypad input to the active timer
- Adjust the active timer by
+1 minuteor-1 minute - Recall countdown preset slots
1-10on the active timer - Save the current countdown duration back into preset slots
1-10on the active timer - Set message timer text
- Create timers and apply patch-style timer updates
- Reorder timers by ID list
- Pause all timers and reset all timers
- Show or hide the second screen
- Update display settings including blackout and colors
- Add log entries and clear logs
Variables
The module publishes variables for:
- Global state such as connection info, timer count, blackout, and second screen visibility
- The currently selected timer, sourced from the app state / SSE stream, including display value plus separate
hours,minutes, andseconds - Selected countdown preset times
1-10 - Timer slots
1-20, including timer id, title, display value, separatehours,minutes,seconds, running state, visibility, and related timer state
Selection Model
- The app's
selectedTimerIdfrom/api/stateand SSE is treated as the source of truth - Active timer actions always operate on the currently selected timer in the VICREO Timer app
- Timer slot presets are used to select timers in the app
Presets
Included preset categories:
Selected Timer: start, pause, reset, show, hide,+1 minute,-1 minuteSelected Timer: also includes recall preset1-10and save preset1-10for countdown timersSelected Timer Variables: display-only presets for the current selected timer,selected_timer_value,selected_timer_hours,selected_timer_minutes, andselected_timer_secondsSelected Timer Keypad: digits0-9,Backspace,Enter,EscapeTimer Select: select timer slotsTimer Variables: display-only presets for timer slot1-20hours,minutes, andsecondsGlobal: pause all, reset all, show second screen, hide second screen, blackout on, blackout off
More from VICREO
Broadcast Titles
VICREO
CommunityColorBox Control API
VICREO
CommunityDisplay
VICREO
CommunityListener
VICREO
Community