Skip to content

Commit 34bddd4

Browse files
authored
Update readme.md
1 parent 7bc59e9 commit 34bddd4

File tree

1 file changed

+49
-2
lines changed

1 file changed

+49
-2
lines changed

readme.md

Lines changed: 49 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -226,10 +226,12 @@ MQTT setup is pre-populated with OpenEnergyMonitor [emonPi default MQTT server c
226226

227227
MQTT can also be used to control the OpenEVSE, see RAPI MQTT below.
228228

229-
### RAPI
229+
### RAPI API (Not Recommended)
230230

231231
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.
232232

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+
233235
**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).**
234236

235237
#### RAPI via web interface
@@ -242,6 +244,8 @@ Enter RAPI commands directly into to web interface (dev mode must be enabled), R
242244

243245
#### RAPI over MQTT
244246

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+
245249
RAPI commands can be issued via MQTT messages. The RAPI command should be published to the following MQTT:
246250

247251
`<base-topic>/rapi/in/<$ rapi-command> payload`
@@ -264,6 +268,8 @@ e.g. `$OK`
264268

265269
#### RAPI over HTTP
266270

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+
267273
RAPI (rapid API) commands can also be issued directly via a single HTTP request.
268274

269275
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`
285291

286292
There is also an [OpenEVSE RAPI command python library](https://github.com/tiramiseb/python-openevse).
287293

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.
299+
300+
Enable Manual Override:
301+
302+
`curl 'http://openevse-xxx/override' --data-raw '{"state":"disabled"}' `
303+
304+
Disable Manual Override:
305+
306+
`curl 'http://openevse-xxx/override' -X 'DELETE'`
307+
308+
View Manual Override status:
309+
310+
http://openevse-xxx/override
311+
312+
#### Schedule timers API
313+
314+
Example
315+
316+
```
317+
curl 'http://openevse-xxx/schedule' \
318+
--data-raw '[{"id":1,"state":"active","days":["monday","tuesday","wednesday","thursday","friday","saturday","sunday"],"time":"07:00"},{"id":2,"state":"disable","days":["monday","tuesday","wednesday","thursday","friday","saturday","sunday"],"time":"10:00"}]'
319+
```
320+
321+
View schedule timers:
322+
323+
http://openevse-xxx/schedule
324+
325+
Remove shedule timers:
326+
327+
` curl 'http://192.168.0.104/schedule/1' -X 'DELETE'`
328+
` curl 'http://192.168.0.104/schedule/2' -X 'DELETE'`
329+
330+
331+
#### Status API
332+
333+
289334

290335
Current status of the OpenEVSE in JSON format is available via: `http://openevse-xxxx/status` e.g
291336

292337
```
293338
{"mode":"STA","wifi_client_connected":1,"eth_connected":0,"net_connected":1,"srssi":-73,"ipaddress":"192.168.1.43","emoncms_connected":1,"packets_sent":22307,"packets_success":22290,"mqtt_connected":1,"ohm_hour":"NotConnected","free_heap":203268,"comm_sent":335139,"comm_success":335139,"rapi_connected":1,"amp":0,"pilot":32,"temp1":282,"temp2":-2560,"temp3":-2560,"state":254,"elapsed":3473,"wattsec":22493407,"watthour":51536,"gfcicount":0,"nogndcount":0,"stuckcount":0,"divertmode":1,"solar":390,"grid_ie":0,"charge_rate":7,"divert_update":0,"ota_update":0,"time":"2020-05-12T17:53:48Z","offset":"+0000"}
294339
```
295340

341+
#### Config API
342+
296343
Current config of the OpenEVSE in JSON format is available via `http://openevse-xxxx/config` e.g
297344

298345
```

0 commit comments

Comments
 (0)