refactor: move more OCPP command sending code to charge point class
[e-mobility-charging-stations-simulator.git] / tests / ocpp-server / server.py
index a753f261598a9cba79de73832a0d6f062da5cc4e..6fd83a1199749d2b330bf53c881124eaf54758bc 100644 (file)
@@ -11,6 +11,7 @@ from ocpp.v201.enums import (
     Action,
     AuthorizationStatusType,
     ClearCacheStatusType,
+    GenericDeviceModelStatusType,
     RegistrationStatusType,
     ReportBaseType,
     TransactionEventType,
@@ -34,6 +35,8 @@ class RepeatTimer(Timer):
 
 # Define a ChargePoint class inheriting from the OCPP 2.0.1 ChargePoint class.
 class ChargePoint(ocpp.v201.ChargePoint):
+    _command_timer: RepeatTimer
+
     # Message handlers to receive OCPP messages.
     @on(Action.BootNotification)
     async def on_boot_notification(self, charging_station, reason, **kwargs):
@@ -96,12 +99,16 @@ class ChargePoint(ocpp.v201.ChargePoint):
         return ocpp.v201.call_result.MeterValues()
 
     @on(Action.GetBaseReport)
-    async def on_get_base_report(self, request_id: int, report_base: ReportBaseType, **kwargs):
+    async def on_get_base_report(
+        self, request_id: int, report_base: ReportBaseType, **kwargs
+    ):
         logging.info("Received %s", Action.GetBaseReport)
-        return ocpp.v201.call_result.GetBaseReport(status="Accepted")
+        return ocpp.v201.call_result.GetBaseReport(
+            status=GenericDeviceModelStatusType.accepted
+        )
 
     # Request handlers to emit OCPP messages.
-    async def send_clear_cache(self):
+    async def _send_clear_cache(self):
         request = ocpp.v201.call.ClearCache()
         response = await self.call(request)
 
@@ -110,68 +117,50 @@ class ChargePoint(ocpp.v201.ChargePoint):
         else:
             logging.info("%s failed", Action.ClearCache)
 
-    async def send_get_base_report(self):
-        logging.info("Executing send_get_base_report...")
+    async def _send_get_base_report(self):
         request = ocpp.v201.call.GetBaseReport(
-            reportBase=ReportBaseType.ConfigurationInventory
-        )  # Use correct ReportBaseType
-        try:
-            response = await self.call(request)
-            logging.info("Send GetBaseReport")
-
-            if (
-                response.status == "Accepted"
-            ):  # Adjust depending on the structure of your response
-                logging.info("Send GetBaseReport successful")
-            else:
-                logging.info("Send GetBaseReport failed")
-        except Exception as e:
-            logging.error(f"Send GetBaseReport failed: {str(e)}")
-        logging.info("send_get_base_report done.")
-
-
-# Define argument parser
-parser = argparse.ArgumentParser(description="OCPP Charge Point Simulator")
-parser.add_argument("--request", type=str, help="OCPP 2 Command Name")
-parser.add_argument("--delay", type=int, help="Delay in seconds")
-parser.add_argument("--period", type=int, help="Period in seconds")
-
-args = parser.parse_args()
-
-
-# Function to send OCPP command
-async def send_ocpp_command(cp, command_name, delay=None, period=None):
-    # If delay is not None, sleep for delay seconds
-    if delay:
-        await asyncio.sleep(delay)
-
-    # If period is not None, send command repeatedly with period interval
-    if period:
-        async def send_command_repeatedly():
-            while True:
-                command_name = await charge_point.receive_command()
-                try:
-                    match command_name:
-                        case Action.ClearCache:
-                            logging.info("ClearCache parser working")
-                            await charge_point.send_clear_cache()
-                        case 'GetBaseReport':
-                            logging.info("GetBaseReport parser working")
-                            await charge_point.send_get_base_report()
-                        case _:
-                            logging.warning(f"Unsupported command {command_name}")
-                except Exception as e:
-                    logging.exception(f"Failure while processing command {command_name}")
-                finally:
-                    await asyncio.sleep(period)
-
-        timer = RepeatTimer(period, send_command_repeatedly)
-        await timer.start()
-        await timer.wait_closed()  # Wait for timer to finish before exiting
+            request_id=1, report_base=ReportBaseType.full_inventory
+        )
+        response = await self.call(request)
 
-    else:
-        if command_name == "GetBaseReport":
-            await cp.send_get_base_report()
+        if response.status == GenericDeviceModelStatusType.accepted:
+            logging.info("%s successful", Action.GetBaseReport)
+        else:
+            logging.info("%s failed", Action.GetBaseReport)
+
+    async def _send_command(self, command_name: Action):
+        logging.debug("Sending OCPP command: %s", command_name)
+        match command_name:
+            case Action.ClearCache:
+                await self._send_clear_cache()
+            case Action.GetBaseReport:
+                await self._send_get_base_report()
+            case _:
+                logging.info(f"Not supported command {command_name}")
+
+    async def send_command(self, command_name: Action, delay=None, period=None):
+        if not delay and not period:
+            raise ValueError("Either delay or period must be set")
+        try:
+            if delay and delay > 0:
+                await asyncio.sleep(delay)
+                await self._send_command(command_name)
+            if period and period > 0 and not self._command_timer:
+                self._command_timer = RepeatTimer(
+                    period,
+                    self._send_command,
+                    [command_name],
+                )
+                self._command_timer.start()
+        except ConnectionClosed:
+            self.handle_connection_closed()
+
+    def handle_connection_closed(self):
+        logging.info("ChargePoint %s closed connection", self.id)
+        if self._command_timer:
+            self._command_timer.cancel()
+        ChargePoints.remove(self)
+        logging.debug("Connected ChargePoint(s): %d", len(ChargePoints))
 
 
 # Function to handle new WebSocket connections.
@@ -201,18 +190,18 @@ async def on_connect(websocket, path):
     ChargePoints.add(cp)
     try:
         await cp.start()
-        # Check if request argument is specified
-        if args.request:
-            asyncio.create_task(send_ocpp_command(cp, args.request, args.delay, args.period))
-
     except ConnectionClosed:
-        logging.info("ChargePoint %s closed connection", cp.id)
-        ChargePoints.remove(cp)
-        logging.debug("Connected ChargePoint(s): %d", len(ChargePoints))
+        cp.handle_connection_closed()
 
 
 # Main function to start the WebSocket server.
 async def main():
+    # Define argument parser
+    parser = argparse.ArgumentParser(description="OCPP2 Charge Point Simulator")
+    parser.add_argument("--command", type=str, help="OCPP2 Command Name")
+    parser.add_argument("--delay", type=int, help="Delay in seconds")
+    parser.add_argument("--period", type=int, help="Period in seconds")
+
     # Create the WebSocket server and specify the handler for new connections.
     server = await websockets.serve(
         on_connect,
@@ -222,6 +211,14 @@ async def main():
     )
     logging.info("WebSocket Server Started")
 
+    args = parser.parse_args()
+
+    if args.command:
+        for cp in ChargePoints:
+            await asyncio.create_task(
+                cp.send_command(cp, args.command, args.delay, args.period)
+            )
+
     # Wait for the server to close (runs indefinitely).
     await server.wait_closed()