Merge branch 'main' into issue39-ocpp2
[e-mobility-charging-stations-simulator.git] / tests / ocpp-server / server.py
index 27f09c40af311cb419a962881751ef3e3c7180a5..3001ebd843cb7b787bef94b34da24752f0c28ff4 100644 (file)
@@ -1,3 +1,4 @@
+import argparse
 import asyncio
 import logging
 from datetime import datetime, timezone
@@ -11,6 +12,7 @@ from ocpp.v201.enums import (
     AuthorizationStatusType,
     ClearCacheStatusType,
     RegistrationStatusType,
+    ReportBaseType,
     TransactionEventType,
 )
 from websockets import ConnectionClosed
@@ -32,25 +34,10 @@ class RepeatTimer(Timer):
 
 # Define a ChargePoint class inheriting from the OCPP 2.0.1 ChargePoint class.
 class ChargePoint(ocpp.v201.ChargePoint):
-    def __init__(self, charge_point_id, connection):
-        super().__init__(self, charge_point_id, connection)
-        self._ws_ping_timer = RepeatTimer(60, self.web_socket_ping)
-        self._ws_ping_timer.start()
-
-    def stop(self):
-        self._ws_ping_timer.cancel()
-
-    def web_socket_ping(self):
-        try:
-            self._connection.ping()
-        except ConnectionClosed:
-            ChargePoints.remove(self)
-            self.stop()
-
     # Message handlers to receive OCPP messages.
     @on(Action.BootNotification)
     async def on_boot_notification(self, charging_station, reason, **kwargs):
-        logging.info("Received BootNotification")
+        logging.info("Received %s", Action.BootNotification)
         # Create and return a BootNotification response with the current time,
         # an interval of 60 seconds, and an accepted status.
         return ocpp.v201.call_result.BootNotification(
@@ -61,7 +48,7 @@ class ChargePoint(ocpp.v201.ChargePoint):
 
     @on(Action.Heartbeat)
     async def on_heartbeat(self, **kwargs):
-        logging.info("Received Heartbeat")
+        logging.info("Received %s", Action.Heartbeat)
         return ocpp.v201.call_result.Heartbeat(
             current_time=datetime.now(timezone.utc).isoformat()
         )
@@ -70,12 +57,12 @@ class ChargePoint(ocpp.v201.ChargePoint):
     async def on_status_notification(
         self, timestamp, evse_id: int, connector_id: int, connector_status, **kwargs
     ):
-        logging.info("Received StatusNotification")
+        logging.info("Received %s", Action.StatusNotification)
         return ocpp.v201.call_result.StatusNotification()
 
     @on(Action.Authorize)
     async def on_authorize(self, id_token, **kwargs):
-        logging.info("Received Authorize")
+        logging.info("Received %s", Action.Authorize)
         return ocpp.v201.call_result.Authorize(
             id_token_info={"status": AuthorizationStatusType.accepted}
         )
@@ -92,31 +79,76 @@ class ChargePoint(ocpp.v201.ChargePoint):
     ):
         match event_type:
             case TransactionEventType.started:
-                logging.info("Received TransactionEvent Started")
+                logging.info("Received %s Started", Action.TransactionEvent)
                 return ocpp.v201.call_result.TransactionEvent(
                     id_token_info={"status": AuthorizationStatusType.accepted}
                 )
             case TransactionEventType.updated:
-                logging.info("Received TransactionEvent Updated")
+                logging.info("Received %s Updated", Action.TransactionEvent)
                 return ocpp.v201.call_result.TransactionEvent(total_cost=10)
             case TransactionEventType.ended:
-                logging.info("Received TransactionEvent Ended")
+                logging.info("Received %s Ended", Action.TransactionEvent)
                 return ocpp.v201.call_result.TransactionEvent()
 
     @on(Action.MeterValues)
     async def on_meter_values(self, evse_id: int, meter_value, **kwargs):
-        logging.info("Received MeterValues")
+        logging.info("Received %s", Action.MeterValues)
         return ocpp.v201.call_result.MeterValues()
 
+    @on(Action.GetBaseReport)
+    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(
+            id_token_info={"status": ReportBaseType.accepted}
+        )
+
     # Request handlers to emit OCPP messages.
     async def send_clear_cache(self):
         request = ocpp.v201.call.ClearCache()
         response = await self.call(request)
 
         if response.status == ClearCacheStatusType.accepted:
-            logging.info("Cache clearing successful")
+            logging.info("%s successful", Action.ClearCache)
         else:
-            logging.info("Cache clearing failed")
+            logging.info("%s failed", Action.ClearCache)
+
+    async def send_get_base_report(self):
+        request = ocpp.v201.call.GetBaseReport(
+            reportBase=ReportBaseType.ConfigurationInventory
+        )
+        response = await self.call(request)
+
+        if response.status == ReportBaseType.accepted:
+            logging.info("%s successful", Action.GetBaseReport)
+        else:
+            logging.info("%s failed", Action.GetBaseReport)
+
+
+# Function to send OCPP command
+async def send_ocpp_command(cp, command_name, delay=None, period=None):
+    try:
+        match command_name:
+            case Action.ClearCache:
+                logging.info("%s Send:", Action.ClearCache)
+                await cp.send_clear_cache()
+            case Action.GetBaseReport:
+                logging.info("%s Send:", Action.GetBaseReport)
+                await cp.send_get_base_report()
+    except Exception:
+        logging.exception(
+            f"Not supported or Failure while processing command {command_name}"
+        )
+
+    if delay:
+        await asyncio.sleep(delay)
+
+    if period:
+        my_timer = RepeatTimer(
+            period, asyncio.create_task, [cp.send_ocpp_command(command_name)]
+        )
+        my_timer.start()
 
 
 # Function to handle new WebSocket connections.
@@ -142,14 +174,25 @@ async def on_connect(websocket, path):
 
     charge_point_id = path.strip("/")
     cp = ChargePoint(charge_point_id, websocket)
+
     ChargePoints.add(cp)
+    try:
+        await cp.start()
 
-    # Start the ChargePoint instance to listen for incoming messages.
-    await cp.start()
+    except ConnectionClosed:
+        logging.info("ChargePoint %s closed connection", cp.id)
+        ChargePoints.remove(cp)
+        logging.debug("Connected ChargePoint(s): %d", len(ChargePoints))
 
 
 # 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,
@@ -158,6 +201,15 @@ async def main():
         subprotocols=["ocpp2.0", "ocpp2.0.1"],  # Specify OCPP 2.0.1 subprotocols.
     )
     logging.info("WebSocket Server Started")
+
+    args = parser.parse_args()
+
+    if args.command:
+        for cp in ChargePoints:
+            asyncio.create_task(
+                send_ocpp_command(cp, args.command, args.delay, args.period)
+            )
+
     # Wait for the server to close (runs indefinitely).
     await server.wait_closed()