OpenRoadCode
Public API reference for OpenRoadCode
Coordinate a radio domain controller, launcher, and panel state. More...
Public Member Functions | |
| tuple[RadioPreset,...] | presets (self) |
| Return configured presets as an immutable tuple. | |
| None | set_radio_ui (self, RadioUiIf|None radio_ui) |
| Attach a radio UI and wire all of its semantic requests. | |
| None | report_ready (self) |
| Publish a ready status message for this radio session. | |
| None | toggle_radio_app (self) |
| Toggle the external radio application. | |
| None | request_toggle_radio_application (self) |
| Request toggling the companion receiver application. | |
| None | request_radio_refresh (self) |
| Request the latest radio state and telemetry. | |
| RadioSessionState | toggle_radio (self) |
| Start or stop the receiver and return its resulting state. | |
| RadioSessionState | tune_preset (self, RadioPreset preset) |
| Tune a preset and return the resulting panel state. | |
| RadioSessionState | frequency_up (self) |
| Step frequency upward and return the resulting state. | |
| RadioSessionState | frequency_down (self) |
| Step frequency downward and return the resulting state. | |
| RadioSessionState | next_preset (self) |
| Tune the next preset and return the resulting state. | |
| RadioSessionState | previous_preset (self) |
| Tune the previous preset and return the resulting state. | |
| None | request_preset (self, int preset_index) |
| Handle a UI request for a zero-based preset index. | |
| None | request_play (self) |
| Handle a UI request to start radio playback. | |
| None | request_pause (self) |
| Handle a UI request to pause radio playback. | |
| None | request_next_station (self) |
| Handle a UI request for the next configured station. | |
| None | request_previous_station (self) |
| Handle a UI request for the previous configured station. | |
| None | request_tune_up (self) |
| Handle a UI request for one upward frequency step. | |
| None | request_tune_down (self) |
| Handle a UI request for one downward frequency step. | |
| RadioSessionState | refresh_state (self, bool include_telemetry=True, bool publish=True) |
| Read receiver telemetry, notify the listener, and return state. | |
Coordinate a radio domain controller, launcher, and panel state.