Commit | Line | Data |
---|---|---|
b794f42e | 1 | import argparse |
fa16d389 S |
2 | import asyncio |
3 | import logging | |
fa16d389 | 4 | from datetime import datetime, timezone |
aea49501 | 5 | from threading import Timer |
fa16d389 | 6 | |
a89844d4 | 7 | import ocpp.v201 |
1a0d2c47 | 8 | import websockets |
fa16d389 | 9 | from ocpp.routing import on |
d4aa9700 JB |
10 | from ocpp.v201.enums import ( |
11 | Action, | |
12 | AuthorizationStatusType, | |
13 | ClearCacheStatusType, | |
e3861e41 | 14 | GenericDeviceModelStatusType, |
d4aa9700 | 15 | RegistrationStatusType, |
f937c172 | 16 | ReportBaseType, |
b794f42e | 17 | TransactionEventType, |
d4aa9700 | 18 | ) |
a5c2d21f | 19 | from websockets import ConnectionClosed |
fa16d389 S |
20 | |
21 | # Setting up the logging configuration to display debug level messages. | |
22 | logging.basicConfig(level=logging.DEBUG) | |
23 | ||
a5c2d21f JB |
24 | ChargePoints = set() |
25 | ||
1a0d2c47 | 26 | |
aea49501 | 27 | class RepeatTimer(Timer): |
d4aa9700 | 28 | """Class that inherits from the Timer class. It will run a |
aea49501 JB |
29 | function at regular intervals.""" |
30 | ||
31 | def run(self): | |
32 | while not self.finished.wait(self.interval): | |
33 | self.function(*self.args, **self.kwargs) | |
34 | ||
35 | ||
fa16d389 | 36 | # Define a ChargePoint class inheriting from the OCPP 2.0.1 ChargePoint class. |
a89844d4 | 37 | class ChargePoint(ocpp.v201.ChargePoint): |
aea49501 | 38 | # Message handlers to receive OCPP messages. |
339f65ad | 39 | @on(Action.BootNotification) |
d6488e8d | 40 | async def on_boot_notification(self, charging_station, reason, **kwargs): |
7628b7e6 | 41 | logging.info("Received %s", Action.BootNotification) |
d6488e8d | 42 | # Create and return a BootNotification response with the current time, |
5dd22b9f | 43 | # an interval of 60 seconds, and an accepted status. |
339f65ad | 44 | return ocpp.v201.call_result.BootNotification( |
d6488e8d | 45 | current_time=datetime.now(timezone.utc).isoformat(), |
115f3b17 | 46 | interval=60, |
d4aa9700 | 47 | status=RegistrationStatusType.accepted, |
d6488e8d | 48 | ) |
1a0d2c47 | 49 | |
115f3b17 | 50 | @on(Action.Heartbeat) |
5dd22b9f | 51 | async def on_heartbeat(self, **kwargs): |
7628b7e6 | 52 | logging.info("Received %s", Action.Heartbeat) |
d4aa9700 JB |
53 | return ocpp.v201.call_result.Heartbeat( |
54 | current_time=datetime.now(timezone.utc).isoformat() | |
55 | ) | |
115f3b17 | 56 | |
65c0600c | 57 | @on(Action.StatusNotification) |
d4aa9700 JB |
58 | async def on_status_notification( |
59 | self, timestamp, evse_id: int, connector_id: int, connector_status, **kwargs | |
60 | ): | |
7628b7e6 | 61 | logging.info("Received %s", Action.StatusNotification) |
65c0600c JB |
62 | return ocpp.v201.call_result.StatusNotification() |
63 | ||
5dd22b9f JB |
64 | @on(Action.Authorize) |
65 | async def on_authorize(self, id_token, **kwargs): | |
7628b7e6 | 66 | logging.info("Received %s", Action.Authorize) |
5dd22b9f | 67 | return ocpp.v201.call_result.Authorize( |
d4aa9700 | 68 | id_token_info={"status": AuthorizationStatusType.accepted} |
8430af0a | 69 | ) |
5dd22b9f | 70 | |
22c4f1fc | 71 | @on(Action.TransactionEvent) |
d4aa9700 JB |
72 | async def on_transaction_event( |
73 | self, | |
74 | event_type: TransactionEventType, | |
75 | timestamp, | |
76 | trigger_reason, | |
77 | seq_no: int, | |
78 | transaction_info, | |
79 | **kwargs, | |
80 | ): | |
22c4f1fc JB |
81 | match event_type: |
82 | case TransactionEventType.started: | |
7628b7e6 | 83 | logging.info("Received %s Started", Action.TransactionEvent) |
22c4f1fc | 84 | return ocpp.v201.call_result.TransactionEvent( |
d4aa9700 | 85 | id_token_info={"status": AuthorizationStatusType.accepted} |
8430af0a | 86 | ) |
22c4f1fc | 87 | case TransactionEventType.updated: |
7628b7e6 | 88 | logging.info("Received %s Updated", Action.TransactionEvent) |
d4aa9700 | 89 | return ocpp.v201.call_result.TransactionEvent(total_cost=10) |
22c4f1fc | 90 | case TransactionEventType.ended: |
7628b7e6 | 91 | logging.info("Received %s Ended", Action.TransactionEvent) |
22c4f1fc JB |
92 | return ocpp.v201.call_result.TransactionEvent() |
93 | ||
5dd22b9f | 94 | @on(Action.MeterValues) |
c7f80bf9 | 95 | async def on_meter_values(self, evse_id: int, meter_value, **kwargs): |
7628b7e6 | 96 | logging.info("Received %s", Action.MeterValues) |
5dd22b9f JB |
97 | return ocpp.v201.call_result.MeterValues() |
98 | ||
f937c172 | 99 | @on(Action.GetBaseReport) |
1f71f83f | 100 | async def on_get_base_report( |
101 | self, request_id: int, report_base: ReportBaseType, **kwargs | |
102 | ): | |
7c945b4a | 103 | logging.info("Received %s", Action.GetBaseReport) |
b2254601 | 104 | return ocpp.v201.call_result.GetBaseReport( |
e3861e41 | 105 | status=GenericDeviceModelStatusType.accepted |
1f71f83f | 106 | ) |
f937c172 | 107 | |
d6488e8d | 108 | # Request handlers to emit OCPP messages. |
a89844d4 JB |
109 | async def send_clear_cache(self): |
110 | request = ocpp.v201.call.ClearCache() | |
111 | response = await self.call(request) | |
112 | ||
113 | if response.status == ClearCacheStatusType.accepted: | |
7628b7e6 | 114 | logging.info("%s successful", Action.ClearCache) |
a89844d4 | 115 | else: |
7628b7e6 | 116 | logging.info("%s failed", Action.ClearCache) |
1a0d2c47 | 117 | |
f937c172 | 118 | async def send_get_base_report(self): |
b794f42e | 119 | request = ocpp.v201.call.GetBaseReport( |
e3861e41 | 120 | request_id=1, report_base=ReportBaseType.full_inventory |
299eb3fa S |
121 | ) |
122 | response = await self.call(request) | |
b794f42e | 123 | |
e3861e41 | 124 | if response.status == GenericDeviceModelStatusType.accepted: |
299eb3fa S |
125 | logging.info("%s successful", Action.GetBaseReport) |
126 | else: | |
891ae31d | 127 | logging.info("%s failed", Action.GetBaseReport) |
b2254601 | 128 | |
e3861e41 JB |
129 | async def send_command(self, command_name: Action): |
130 | logging.debug("Sending OCPP command: %s", command_name) | |
299eb3fa S |
131 | match command_name: |
132 | case Action.ClearCache: | |
e3861e41 | 133 | await self.send_clear_cache() |
299eb3fa | 134 | case Action.GetBaseReport: |
e3861e41 JB |
135 | await self.send_get_base_report() |
136 | case _: | |
137 | logging.info(f"Not supported command {command_name}") | |
299eb3fa | 138 | |
f937c172 | 139 | |
e3861e41 JB |
140 | # Function to send OCPP command |
141 | async def send_ocpp_command(cp, command_name, delay=None, period=None): | |
142 | try: | |
143 | if delay: | |
144 | await asyncio.sleep(delay) | |
145 | cp.send_command(command_name) | |
146 | if period: | |
147 | command_timer = RepeatTimer( | |
148 | period, | |
149 | cp.send_command, | |
150 | [command_name], | |
151 | ) | |
152 | command_timer.start() | |
153 | except ConnectionClosed: | |
154 | logging.info("ChargePoint %s closed connection", cp.id) | |
155 | ChargePoints.remove(cp) | |
156 | logging.debug("Connected ChargePoint(s): %d", len(ChargePoints)) | |
f937c172 | 157 | |
fa16d389 S |
158 | |
159 | # Function to handle new WebSocket connections. | |
299eb3fa | 160 | async def on_connect(websocket, path): |
d4aa9700 | 161 | """For every new charge point that connects, create a ChargePoint instance and start |
d6488e8d JB |
162 | listening for messages.""" |
163 | try: | |
d4aa9700 | 164 | requested_protocols = websocket.request_headers["Sec-WebSocket-Protocol"] |
d6488e8d JB |
165 | except KeyError: |
166 | logging.info("Client hasn't requested any Subprotocol. Closing Connection") | |
167 | return await websocket.close() | |
1a0d2c47 | 168 | |
d6488e8d JB |
169 | if websocket.subprotocol: |
170 | logging.info("Protocols Matched: %s", websocket.subprotocol) | |
171 | else: | |
d4aa9700 JB |
172 | logging.warning( |
173 | "Protocols Mismatched | Expected Subprotocols: %s," | |
174 | " but client supports %s | Closing connection", | |
175 | websocket.available_subprotocols, | |
176 | requested_protocols, | |
177 | ) | |
d6488e8d | 178 | return await websocket.close() |
1a0d2c47 | 179 | |
d4aa9700 | 180 | charge_point_id = path.strip("/") |
d6488e8d | 181 | cp = ChargePoint(charge_point_id, websocket) |
1a0d2c47 | 182 | |
a5c2d21f | 183 | ChargePoints.add(cp) |
7628b7e6 JB |
184 | try: |
185 | await cp.start() | |
186 | except ConnectionClosed: | |
187 | logging.info("ChargePoint %s closed connection", cp.id) | |
188 | ChargePoints.remove(cp) | |
950b6c5a | 189 | logging.debug("Connected ChargePoint(s): %d", len(ChargePoints)) |
1a0d2c47 | 190 | |
b738a0fc | 191 | |
fa16d389 S |
192 | # Main function to start the WebSocket server. |
193 | async def main(): | |
b2254601 | 194 | # Define argument parser |
299eb3fa S |
195 | parser = argparse.ArgumentParser(description="OCPP2 Charge Point Simulator") |
196 | parser.add_argument("--command", type=str, help="OCPP2 Command Name") | |
b2254601 S |
197 | parser.add_argument("--delay", type=int, help="Delay in seconds") |
198 | parser.add_argument("--period", type=int, help="Period in seconds") | |
199 | ||
d6488e8d JB |
200 | # Create the WebSocket server and specify the handler for new connections. |
201 | server = await websockets.serve( | |
299eb3fa | 202 | on_connect, |
d4aa9700 | 203 | "127.0.0.1", # Listen on loopback. |
d6488e8d | 204 | 9000, # Port number. |
d4aa9700 | 205 | subprotocols=["ocpp2.0", "ocpp2.0.1"], # Specify OCPP 2.0.1 subprotocols. |
d6488e8d JB |
206 | ) |
207 | logging.info("WebSocket Server Started") | |
f937c172 | 208 | |
299eb3fa S |
209 | args = parser.parse_args() |
210 | ||
211 | if args.command: | |
212 | for cp in ChargePoints: | |
e3861e41 | 213 | await asyncio.create_task( |
299eb3fa | 214 | send_ocpp_command(cp, args.command, args.delay, args.period) |
b738a0fc | 215 | ) |
299eb3fa | 216 | |
d6488e8d JB |
217 | # Wait for the server to close (runs indefinitely). |
218 | await server.wait_closed() | |
1a0d2c47 | 219 | |
fa16d389 S |
220 | |
221 | # Entry point of the script. | |
d4aa9700 | 222 | if __name__ == "__main__": |
d6488e8d JB |
223 | # Run the main function to start the server. |
224 | asyncio.run(main()) |