Add WebSocket integration and space state notifications #413
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…xt and remove duplicate function definition - Updated logger naming to include interface class name for better traceability. - Relocated `get_reserved_parameter_names` function
- Introduced `WebsocketEventInterface` and `WebsocketEventHandler` for managing WebSocket events. - Added `websockets` dependency in `pyproject.toml` and `uv.lock` for WebSocket functionality. - Created `WebsocketPluginIntegration` for plugin lifecycle management of WebSocket routers. - Updated Bolt request handling to include WebSocket event type. - Enhanced plugin lifecycle to initialize and finalize WebSocket routes seamlessly.
- Introduced `/ws/space/state` WebSocket endpoint to broadcast space state changes to clients. - Enabled real-time space state updates via new `inform_websocket_clients_of_space_state_change` helper. - Updated space state open/close logic to notify connected WebSocket clients.
- Deleted `space state ws.py` as it is no longer used or required in the project.
Contributor
Author
|
This small script allows a connection to the import asyncio
import json
from asyncio import CancelledError
import websockets
HOST = "smib-pi:80"
async def listen():
uri = f"ws://{HOST}/ws/space/state"
async with websockets.connect(uri) as websocket:
print("Connected to WebSocket")
while True:
try:
message = await websocket.recv()
data = json.loads(message)
print("Received:", data)
except websockets.ConnectionClosed:
print("Connection closed")
break
try:
asyncio.run(listen())
except (CancelledError, KeyboardInterrupt):
print("WebSocket listener stopped") |
…-the-httpevent-interfacehandlerservice
…-the-httpevent-interfacehandlerservice
…pport - Added WebSocket details, including real-time updates and endpoint usage. - Clarified Traefik reverse proxy routes with examples for all SMIB services.
Contributor
There was a problem hiding this comment.
Pull Request Overview
Adds first-class WebSocket support and real-time space state notifications. Key updates integrate a WebSocket event interface/handler, expose a new /ws endpoint, and unify event typing across HTTP/Scheduled/WebSocket flows.
- Introduces WebsocketEventInterface and WebsocketEventHandler to register and dispatch WebSocket events via Bolt.
- Adds /ws/space/state to push real-time space state to connected clients and a helper to broadcast updates.
- Aligns event types via BoltEventType and standardizes router finalization naming.
Reviewed Changes
Copilot reviewed 17 out of 20 changed files in this pull request and generated 5 comments.
Show a summary per file
| File | Description |
|---|---|
| src/smib/plugins/integrations/websocket_plugin_integration.py | New plugin integration to register and remove WebSocket routes and include routers into FastAPI. |
| src/smib/plugins/integrations/http_plugin_integration.py | Logger improvement and method rename to finalise_router_setup for consistency. |
| src/smib/events/interfaces/websocket_event_interface.py | Adds decorator and routing for WebSocket endpoints with Bolt dispatch wiring. |
| src/smib/events/interfaces/scheduled_event_interface.py | Switches scheduled events to use BoltEventType/BoltRequestMode constants. |
| src/smib/events/interfaces/http/init.py | Refactors to shared parameter extraction, type fixes, and unified event typing. |
| src/smib/events/interfaces/init.py | New shared helpers for reserved names and parameter extraction. |
| src/smib/events/handlers/websocket_event_handler.py | New handler to transform WebSocket connections into Bolt requests. |
| src/smib/events/handlers/scheduled_event_handler.py | Uses BoltEventType for scheduled event payloads. |
| src/smib/events/handlers/http_event_handler.py | Minor typing/cleanup and unified event typing. |
| src/smib/events/handlers/init.py | Adds WEBSOCKET mode and removes unused Clock import. |
| src/smib/events/init.py | Centralizes BoltEventType definitions. |
| src/smib/main.py | Wires WebSocket interface/handler/integration into the app and plugin lifecycle. |
| src/plugins/space/spacestate/listeners/websocket.py | New WebSocket listener and broadcast helper for space state. |
| src/plugins/space/spacestate/common.py | Notifies WebSocket clients when the space state changes. |
| pyproject.toml | Adds websockets dependency. |
| README.md | Documents WebSocket capability and routing layout. |
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
Co-authored-by: Copilot <[email protected]>
Co-authored-by: Copilot <[email protected]>
Co-authored-by: Copilot <[email protected]>
… inclusion logic - Enhanced `extract_parameter_and_value` and `find_annotation_in_signature` for better type handling and annotations. - Modified `APIRouter` initialization to exclude schema for individual routers. - Adjusted router finalization to include schema in FastAPI app.
…-the-httpevent-interfacehandlerservice
…-the-httpevent-interfacehandlerservice
…-the-httpevent-interfacehandlerservice
Contributor
Author
|
I will update the README once the websocket PR is merged. Format changes a bit and can't be bothered with the merge conflicts |
sjefferson99
approved these changes
Oct 20, 2025
Member
sjefferson99
left a comment
There was a problem hiding this comment.
Container builds, examples script correctly provides state changes in real time as expected.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
This pull request introduces WebSocket support and integrates real-time space state notifications and updates. Key changes include:
/ws/space/stateWebSocket endpoint for broadcasting space state changes.inform_websocket_clients_of_space_state_changehelper for real-time updates.WebsocketEventInterfaceandWebsocketEventHandlerfor WebSocket event management.