get_busy_snapshot
Retrieve the active BUSY timer profile and remaining time, so you can schedule display messages or other operations based on the current timer state.
Instructions
Retrieve the current BUSY timer snapshot from the Busy Bar device.
This tool queries GET /api/busy/snapshot via `BusyApi.get_busy_snapshot()` to
return the current BUSY timer state including active profile and timing details.
Returns a BusySnapshot object containing:
- snapshot (BusySnapshotSnapshot): The busy snapshot data — varies by type:
- BusySnapshotSimple: started (bool), remaining_ms (int)
- BusySnapshotInterval: started, remaining_ms, interval_index, intervals_count
- BusySnapshotInfinite: started (bool)
- BusySnapshotNotStarted: fields not applicable
- snapshot_timestamp_ms (int): Timestamp of the snapshot in milliseconds since epoch
Use case:
Check what BUSY timer profile is currently active and how much time remains
before scheduling display messages or other operations around the timer.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||