Add pause-satellite

CHANGELOG.md

@@ -4,6 +4,7 @@
 
 - Add `version` to info artifacts
 - Use Python package version in Wyoming JSON header
+- Add `pause-satellite` message
 
 ## 1.5.0
 

README.md

@@ -214,6 +214,17 @@ Play audio stream.
 
 * `played` - response when audio finishes playing
 
+### Voice Satellite
+
+Control of one or more remote voice satellites connected to a central server.
+
+* `run-satellite` - informs satellite that server is ready to run pipelines
+* `pause-satellite` - informs satellite that server is not ready anymore to run pipelines
+* `satellite-connected` - satellite has connected to the server
+* `satellite-disconnected` - satellite has been disconnected from the server
+* `streaming-started` - satellite has started streaming audio to the server
+* `streaming-stopped` - satellite has stopped streaming audio to the server
+
 
 ## Event Flow
 

tests/test_event.py

@@ -13,7 +13,6 @@
     read_event,
     write_event,
 )
-from wyoming.info import Satellite, Attribution
 
 PAYLOAD = b"test\npayload"
 DATA = {"test": "data"}

wyoming/satellite.py

@@ -4,6 +4,7 @@
 from .event import Event, Eventable
 
 _RUN_SATELLITE_TYPE = "run-satellite"
+_PAUSE_SATELLITE_TYPE = "pause-satellite"
 _STREAMING_STARTED_TYPE = "streaming-started"
 _STREAMING_STOPPED_TYPE = "streaming-stopped"
 _SATELLITE_CONNECTED_TYPE = "satellite-connected"
@@ -12,7 +13,7 @@
 
 @dataclass
 class RunSatellite(Eventable):
-    """Tell satellite to start running."""
+    """Informs the satellite that the server is ready to run a pipeline."""
 
     @staticmethod
     def is_type(event_type: str) -> bool:
@@ -26,6 +27,22 @@ def from_event(event: Event) -> "RunSatellite":
         return RunSatellite()
 
 
+@dataclass
+class PauseSatellite(Eventable):
+    """Informs the satellite that the server is not ready to run a pipeline."""
+
+    @staticmethod
+    def is_type(event_type: str) -> bool:
+        return event_type == _PAUSE_SATELLITE_TYPE
+
+    def event(self) -> Event:
+        return Event(type=_PAUSE_SATELLITE_TYPE)
+
+    @staticmethod
+    def from_event(event: Event) -> "PauseSatellite":
+        return PauseSatellite()
+
+
 @dataclass
 class StreamingStarted(Eventable):
     """Satellite has started streaming audio to server."""