Skip to content

Commit

Permalink
Add capabilities to module documentation
Browse files Browse the repository at this point in the history
Signed-off-by: Cornelius Claussen <[email protected]>
  • Loading branch information
corneliusclaussen committed Dec 11, 2023
1 parent bbbb13b commit 552c42b
Show file tree
Hide file tree
Showing 3 changed files with 27 additions and 19 deletions.
19 changes: 0 additions & 19 deletions modules/EvseSlac/design.rst

This file was deleted.

24 changes: 24 additions & 0 deletions modules/EvseSlac/doc.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
===================
EvseSlac
===================

This is an implementation of the ISO 15118-3 EVSE side SLAC protocol.
The general flow of operation will be like this:

- start of operation begins with a control pilot transition from state
A, E or F to Bx, Cx or Dx. This is indicated by the EvseManager by calling
the commands enter_bcd/leave_bcd.
- Once started, it waits for a CM_SLAC_PARM_REQ from the EV side to start the SLAC session.
- In case of success, SLAC finishes with a CM_SLAC_MATCH_RES, which sends a new NMK to the EV side.
The EV then joins the logical network and the two modems are paired. A dlink_ready(true) is published
to signal to the EvseManager that the low level PLC link is ready for communication.

If not run as root user, this modules requires the capability CAP_NET_RAW.

====
Todo
====

- make use of the enable flag in the reset command or drop it, if not needed
- handle CM_VALIDATE.REQ message
- implement PLC chip resetting after unplug or failed SLAC sessions (especially for QCA chips)
3 changes: 3 additions & 0 deletions modules/Setup/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,9 @@
# Setup module API documentation
This module is responsible for setup tasks that might need privileged access, for example wifi configuration.

If not run as root user, set at least the following capabilities in your EVerest config file: CAP_NET_ADMIN, CAP_NET_RAW, CAP_DAC_OVERRIDE.
They will be passed on to the child processes such as wpa_cli etc.

## Periodically published variables
### everest_api/setup/var/supported_setup_features
This variable is published periodically and contains a JSON object with the supported features in the following form:
Expand Down

0 comments on commit 552c42b

Please sign in to comment.