Abstract Server class and a default implementation

.gitignore

@@ -13,3 +13,4 @@ venv
 dist/
 build/
 %LOCALAPPDATA%
+temp_java/

README.rst

@@ -35,9 +35,11 @@ Add to your pyproject.toml:
     [tool.mypy]
     plugins = ['pydantic.mypy']
 
-Example
+Examples
 ---------
 
+Use S2 classes in your code:
+
 .. code-block:: python
 
     from s2python.common import PowerRange, CommodityQuantity
@@ -54,6 +56,28 @@ Example
     json_str = '{"start_of_range": 4.0, "end_of_range": 5.0, "commodity_quantity": "ELECTRIC.POWER.L1"}'
     PowerRange.from_json(json_str)
 
+Run an example CEM server with websocket and http server:
+
+.. code-block:: bash
+
+    python -m examples.example_s2_server --host localhost --http-port 8000 --ws-port 8080 --pairing-token ca14fda4
+
+
+This will start both a http and a websocket server instances. It also allows to set a hardcoded pairing token.
+
+Run an example RM client that pairs with the CEM server, authenticates and starts sending S2 messages that describe an FRBC device:
+
+.. code-block:: bash
+
+    python -m examples.example_pairing_frbc_rm --pairing_endpoint http://localhost:8000/requestPairing --pairing_token ca14fda4
+
+In case you want to run the example of a client that does not need to pair with the CEM server, you can add the --dev-mode flag. This will disable the pairing/authentication check and allows you to send messages to the CEM server without pairing. The CEM server still needs to be running.
+
+.. code-block:: bash
+
+    python -m examples.example_frbc_rm --endpoint ws://localhost:8080
+
+
 Development
 -------------
 

examples/example_frbc_rm.py

@@ -30,7 +30,7 @@
     FRBCStorageStatus,
     FRBCActuatorStatus,
 )
-from s2python.s2_connection import S2Connection, AssetDetails
+from s2python.communication.s2_connection import S2Connection, AssetDetails
 from s2python.s2_control_type import FRBCControlType, NoControlControlType
 from s2python.message import S2Message
 
@@ -92,7 +92,9 @@ def activate(self, conn: S2Connection) -> None:
                     )
                 ],
                 storage=FRBCStorageDescription(
-                    fill_level_range=NumberRange(start_of_range=0.0, end_of_range=100.0),
+                    fill_level_range=NumberRange(
+                        start_of_range=0.0, end_of_range=100.0
+                    ),
                     fill_level_label="%",
                     diagnostic_label="Imaginary battery",
                     provides_fill_level_target_profile=True,
@@ -110,11 +112,15 @@ def activate(self, conn: S2Connection) -> None:
                 elements=[
                     FRBCFillLevelTargetProfileElement(
                         duration=Duration.from_milliseconds(30_000),
-                        fill_level_range=NumberRange(start_of_range=20.0, end_of_range=30.0),
+                        fill_level_range=NumberRange(
+                            start_of_range=20.0, end_of_range=30.0
+                        ),
                     ),
                     FRBCFillLevelTargetProfileElement(
                         duration=Duration.from_milliseconds(300_000),
-                        fill_level_range=NumberRange(start_of_range=40.0, end_of_range=50.0),
+                        fill_level_range=NumberRange(
+                            start_of_range=40.0, end_of_range=50.0
+                        ),
                     ),
                 ],
             )
@@ -161,27 +167,40 @@ def start_s2_session(url, client_node_id=str(uuid.uuid4())):
             resource_id=client_node_id,
             name="Some asset",
             instruction_processing_delay=Duration.from_milliseconds(20),
-            roles=[Role(role=RoleType.ENERGY_CONSUMER, commodity=Commodity.ELECTRICITY)],
+            roles=[
+                Role(role=RoleType.ENERGY_CONSUMER, commodity=Commodity.ELECTRICITY)
+            ],
             currency=Currency.EUR,
             provides_forecast=False,
             provides_power_measurements=[CommodityQuantity.ELECTRIC_POWER_L1],
         ),
         reconnect=True,
         verify_certificate=False,
     )
-    signal.signal(signal.SIGINT, partial(stop, s2_conn))
-    signal.signal(signal.SIGTERM, partial(stop, s2_conn))
 
-    s2_conn.start_as_rm()
+    # Create signal handlers
+    def sigint_handler(signum, frame):
+        stop(s2_conn, signum, frame)
+
+    def sigterm_handler(signum, frame):
+        stop(s2_conn, signum, frame)
+
+    # Register signal handlers
+    signal.signal(signal.SIGINT, sigint_handler)
+    signal.signal(signal.SIGTERM, sigterm_handler)
+
+    s2_conn.start()
 
 
 if __name__ == "__main__":
-    parser = argparse.ArgumentParser(description="A simple S2 reseource manager example.")
+    parser = argparse.ArgumentParser(
+        description="A simple S2 reseource manager example."
+    )
     parser.add_argument(
-        "endpoint",
+        "--endpoint",
         type=str,
         help="WebSocket endpoint uri for the server (CEM) e.g. "
-        "ws://localhost:8080/backend/rm/s2python-frbc/cem/dummy_model/ws",
+        "ws://localhost:8080/",
     )
     args = parser.parse_args()
 

src/s2python/communication/examples/example_frbc_rm.py → examples/example_pairing_frbc_rm.py

@@ -1,11 +1,18 @@
 import argparse
-from functools import partial
 import logging
-import sys
-import uuid
-import signal
+import threading
 import datetime
-from typing import Any, Callable, Optional
+import uuid
+from typing import Callable
+
+from s2python.authorization.default_client import S2DefaultClient
+from s2python.generated.gen_s2_pairing import (
+    S2NodeDescription,
+    Deployment,
+    PairingToken,
+    S2Role,
+    Protocols,
+)
 
 from s2python.common import (
     EnergyManagementRole,
@@ -35,18 +42,12 @@
 from s2python.message import S2Message
 
 logger = logging.getLogger("s2python")
-logger.addHandler(logging.StreamHandler(sys.stdout))
-logger.setLevel(logging.DEBUG)
 
 
 class MyFRBCControlType(FRBCControlType):
-    def handle_instruction(
-        self, conn: S2Connection, msg: S2Message, send_okay: Callable[[], None]
-    ) -> None:
+    def handle_instruction(self, conn: S2Connection, msg: S2Message, send_okay: Callable[[], None]) -> None:
         if not isinstance(msg, FRBCInstruction):
-            raise RuntimeError(
-                f"Expected an FRBCInstruction but received a message of type {type(msg)}."
-            )
+            raise RuntimeError(f"Expected an FRBCInstruction but received a message of type {type(msg)}.")
         print(f"I have received the message {msg} from {conn}")
 
     def activate(self, conn: S2Connection) -> None:
@@ -67,12 +68,8 @@ def activate(self, conn: S2Connection) -> None:
                                 id=operation_mode_id,
                                 elements=[
                                     FRBCOperationModeElement(
-                                        fill_level_range=NumberRange(
-                                            start_of_range=0.0, end_of_range=100.0
-                                        ),
-                                        fill_rate=NumberRange(
-                                            start_of_range=-5.0, end_of_range=5.0
-                                        ),
+                                        fill_level_range=NumberRange(start_of_range=0.0, end_of_range=100.0),
+                                        fill_rate=NumberRange(start_of_range=-5.0, end_of_range=5.0),
                                         power_ranges=[
                                             PowerRange(
                                                 start_of_range=-200.0,
@@ -92,9 +89,7 @@ def activate(self, conn: S2Connection) -> None:
                     )
                 ],
                 storage=FRBCStorageDescription(
-                    fill_level_range=NumberRange(
-                        start_of_range=0.0, end_of_range=100.0
-                    ),
+                    fill_level_range=NumberRange(start_of_range=0.0, end_of_range=100.0),
                     fill_level_label="%",
                     diagnostic_label="Imaginary battery",
                     provides_fill_level_target_profile=True,
@@ -112,15 +107,11 @@ def activate(self, conn: S2Connection) -> None:
                 elements=[
                     FRBCFillLevelTargetProfileElement(
                         duration=Duration.from_milliseconds(30_000),
-                        fill_level_range=NumberRange(
-                            start_of_range=20.0, end_of_range=30.0
-                        ),
+                        fill_level_range=NumberRange(start_of_range=20.0, end_of_range=30.0),
                     ),
                     FRBCFillLevelTargetProfileElement(
                         duration=Duration.from_milliseconds(300_000),
-                        fill_level_range=NumberRange(
-                            start_of_range=40.0, end_of_range=50.0
-                        ),
+                        fill_level_range=NumberRange(start_of_range=40.0, end_of_range=50.0),
                     ),
                 ],
             )
@@ -153,52 +144,84 @@ def deactivate(self, conn: S2Connection) -> None:
         print("The control type NoControl is now deactivated.")
 
 
-def stop(
-    s2_connection: S2Connection, signal_num: int, _current_stack_frame: Any
-) -> None:
-    print(f"Received signal {signal_num}. Will stop S2 connection.")
-    s2_connection.stop()
-
-
-def start_s2_session(
-    url: str,
-    client_node_id: uuid.UUID = uuid.uuid4(),
-    bearer_token: Optional[str] = None,
-) -> None:
-    s2_conn = S2Connection(
-        url=url,
-        role=EnergyManagementRole.RM,
-        control_types=[MyFRBCControlType(), MyNoControlControlType()],
-        asset_details=AssetDetails(
-            resource_id=client_node_id,
-            name="Some asset",
-            instruction_processing_delay=Duration.from_milliseconds(20),
-            roles=[
-                Role(role=RoleType.ENERGY_CONSUMER, commodity=Commodity.ELECTRICITY)
-            ],
-            currency=Currency.EUR,
-            provides_forecast=False,
-            provides_power_measurements=[CommodityQuantity.ELECTRIC_POWER_L1],
-        ),
-        reconnect=True,
-        verify_certificate=False,
-        bearer_token=bearer_token,
-    )
-    signal.signal(signal.SIGINT, partial(stop, s2_conn))
-    signal.signal(signal.SIGTERM, partial(stop, s2_conn))
-
-    s2_conn.start_as_rm()
+if __name__ == "__main__":
+    # Configuration
+    parser = argparse.ArgumentParser(description="S2 pairing example for FRBC RM")
+    parser.add_argument("--pairing_endpoint", type=str, required=True)
+    parser.add_argument("--pairing_token", type=str, required=True)
 
+    args = parser.parse_args()
 
-if __name__ == "__main__":
-    parser = argparse.ArgumentParser(
-        description="A simple S2 reseource manager example."
+    pairing_endpoint = args.pairing_endpoint
+    pairing_token = args.pairing_token
+
+    # --- Client Setup ---
+    # Create node description
+    node_description = S2NodeDescription(
+        brand="TNO",
+        logoUri="https://www.tno.nl/publish/pages/5604/tno-logo-1484x835_003_.jpg",
+        type="demo frbc example",
+        modelName="S2 pairing example stub",
+        userDefinedName="TNO S2 pairing example for frbc",
+        role=S2Role.RM,
+        deployment=Deployment.LAN,
     )
-    parser.add_argument(
-        "endpoint",
-        type=str,
-        help="WebSocket endpoint uri for the server (CEM) e.g. ws://localhost:8080/websocket/s2/my-first-websocket-rm",
+
+    # Create a client to perform the pairing
+    client = S2DefaultClient(
+        pairing_uri=pairing_endpoint,
+        token=PairingToken(token=pairing_token),
+        node_description=node_description,
+        verify_certificate=False,
+        supported_protocols=[Protocols.WebSocketSecure],
     )
-    args = parser.parse_args()
 
-    start_s2_session(args.endpoint)
+    try:
+        # Request pairing
+        logger.info("Initiating pairing with endpoint: %s", pairing_endpoint)
+        pairing_response = client.request_pairing()
+        logger.info("Pairing request successful, requesting connection...")
+
+        # Request connection details
+        connection_details = client.request_connection()
+        logger.info("Connection request successful")
+
+        # Solve challenge
+        challenge_result = client.solve_challenge()
+        logger.info("Challenge solved successfully")
+
+        s2_connection = S2Connection(
+            url=connection_details.connectionUri, # type: ignore
+            role=EnergyManagementRole.RM,
+            control_types=[MyFRBCControlType(), MyNoControlControlType()],
+            asset_details=AssetDetails(
+                resource_id=client.client_node_id,
+                name="Some asset",
+                instruction_processing_delay=Duration.from_milliseconds(20),
+                roles=[Role(role=RoleType.ENERGY_CONSUMER, commodity=Commodity.ELECTRICITY)],
+                currency=Currency.EUR,
+                provides_forecast=False,
+                provides_power_measurements=[CommodityQuantity.ELECTRIC_POWER_L1],
+            ),
+            reconnect=True,
+            verify_certificate=False,
+            bearer_token=challenge_result,
+        )
+
+        # Start S2 session with the connection details
+        logger.info("Starting S2 session...")
+        s2_connection.start_as_rm()
+        logger.info("S2 session is running. Press Ctrl+C to exit.")
+
+        # Keep the main thread alive to allow the WebSocket connection to run.
+        event = threading.Event()
+        event.wait()
+
+    except KeyboardInterrupt:
+        logger.info("Program interrupted by user.")
+    except Exception as e:
+        logger.error("Error during pairing process: %s", e, exc_info=True)
+        raise e
+    finally:
+        client.close_connection()
+        logger.info("Connection closed.")