You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: readme.md
+49-2Lines changed: 49 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -226,10 +226,12 @@ MQTT setup is pre-populated with OpenEnergyMonitor [emonPi default MQTT server c
226
226
227
227
MQTT can also be used to control the OpenEVSE, see RAPI MQTT below.
228
228
229
-
### RAPI
229
+
### RAPI API (Not Recommended)
230
230
231
231
RAPI commands can be used to control and check the status of all OpenEVSE functions. RAPI commands can be issued via the direct serial, web-interface, HTTP and MQTT. We recommend using RAPI over MQTT.
232
232
233
+
**IMPORTANT: It is no longer recommended to use RAPI API if EVSE also had a WiFi module fitted, since use of the RAPI API will conflict with the WiFi module, instead the HTTP API should be used to control the WiFi module instead of the controller via RAPI. User RAPI API will be disabled in future releases**
234
+
233
235
**A full list of RAPI commands can be found in the [OpenEVSE plus source code](https://github.com/OpenEVSE/open_evse/blob/stable/firmware/open_evse/src/rapi_proc.h).**
234
236
235
237
#### RAPI via web interface
@@ -242,6 +244,8 @@ Enter RAPI commands directly into to web interface (dev mode must be enabled), R
242
244
243
245
#### RAPI over MQTT
244
246
247
+
**IMPORTANT: It is no longer recommended to use RAPI API if EVSE also had a WiFi module fitted, since use of the RAPI API will conflict with the WiFi module, instead the HTTP API should be used to control the WiFi module instead of the controller via RAPI. User RAPI API will be disabled in future releases**
248
+
245
249
RAPI commands can be issued via MQTT messages. The RAPI command should be published to the following MQTT:
246
250
247
251
`<base-topic>/rapi/in/<$ rapi-command> payload`
@@ -264,6 +268,8 @@ e.g. `$OK`
264
268
265
269
#### RAPI over HTTP
266
270
271
+
**IMPORTANT: It is no longer recommended to use RAPI API if EVSE also had a WiFi module fitted, since use of the RAPI API will conflict with the WiFi module, instead the HTTP API should be used to control the WiFi module instead of the controller via RAPI. User RAPI API will be disabled in future releases**
272
+
267
273
RAPI (rapid API) commands can also be issued directly via a single HTTP request.
268
274
269
275
Using RAPI commands should be avoided if possible. WiFi server API is preferable. If RAPI must be used, avoid fast polling.
@@ -285,14 +291,55 @@ To enable (start / resume a charge) issue RAPI command `$FE`
285
291
286
292
There is also an [OpenEVSE RAPI command python library](https://github.com/tiramiseb/python-openevse).
287
293
288
-
### HTTP API
294
+
### HTTP API (Recommended)
295
+
296
+
#### Manual Override API
297
+
298
+
Manual override can be used to override a charging timer or to immediately start a charge if the EVSE is in sleeping state.
0 commit comments