Patrick Schurig
b26274595c
Some checks failed
Build & Deploy docs / build-deploy (push) Failing after 10m17s
- Nouveau générateur scripts/gen_api_reference.py : 19 namespaces → docs/api/metier/ (10) + docs/api/systeme/ (9) + notifications.md + types.md (96 types · 55 enums · 4 flags) + SUMMARY.md literate-nav - Badges permissionScope (perm-none/control/configure/admin) dans extra.css - Guide docs/integrations/jsonrpc-api.md (connexion TCP/WS, auth, conventions énergie) - mkdocs.yml : Référence API dans la nav, REST→JsonRPC renommé - mkdocs build --strict : 0 warnings · --check idempotent Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
142 lines
2.1 KiB
Markdown
142 lines
2.1 KiB
Markdown
# EvDash
|
|
|
|
<!-- BEGIN GENERATED: __api_EvDash__ -->
|
|
## Méthodes
|
|
|
|
### EvDash.AddUser
|
|
|
|
<span class="badge perm-admin">ADMIN</span>
|
|
|
|
Add a new user with the given username and password.
|
|
|
|
**Paramètres :**
|
|
|
|
| Champ | Type | Notes |
|
|
| --- | --- | --- |
|
|
| `password` | `String` | |
|
|
| `username` | `String` | |
|
|
|
|
**Retour :**
|
|
|
|
| Champ | Type | Notes |
|
|
| --- | --- | --- |
|
|
| `evDashError` | [EvDashError](../types.md#evdasherror) | |
|
|
|
|
---
|
|
|
|
### EvDash.GetEnabled
|
|
|
|
<span class="badge perm-admin">ADMIN</span>
|
|
|
|
Get the enabled status of EV Dash service.
|
|
|
|
**Paramètres :**
|
|
|
|
_Aucun paramètre._
|
|
|
|
**Retour :**
|
|
|
|
| Champ | Type | Notes |
|
|
| --- | --- | --- |
|
|
| `enabled` | `Bool` | |
|
|
|
|
---
|
|
|
|
### EvDash.GetUsers
|
|
|
|
<span class="badge perm-admin">ADMIN</span>
|
|
|
|
Get the list of available users names.
|
|
|
|
**Paramètres :**
|
|
|
|
_Aucun paramètre._
|
|
|
|
**Retour :**
|
|
|
|
| Champ | Type | Notes |
|
|
| --- | --- | --- |
|
|
| `usernames` | `StringList` | |
|
|
|
|
---
|
|
|
|
### EvDash.RemoveUser
|
|
|
|
<span class="badge perm-admin">ADMIN</span>
|
|
|
|
Remove the user with the given username.
|
|
|
|
**Paramètres :**
|
|
|
|
| Champ | Type | Notes |
|
|
| --- | --- | --- |
|
|
| `username` | `String` | |
|
|
|
|
**Retour :**
|
|
|
|
| Champ | Type | Notes |
|
|
| --- | --- | --- |
|
|
| `evDashError` | [EvDashError](../types.md#evdasherror) | |
|
|
|
|
---
|
|
|
|
### EvDash.SetEnabled
|
|
|
|
<span class="badge perm-admin">ADMIN</span>
|
|
|
|
Enable/Disable the EV Dash service.
|
|
|
|
**Paramètres :**
|
|
|
|
| Champ | Type | Notes |
|
|
| --- | --- | --- |
|
|
| `enabled` | `Bool` | |
|
|
|
|
**Retour :**
|
|
|
|
| Champ | Type | Notes |
|
|
| --- | --- | --- |
|
|
| `evDashError` | [EvDashError](../types.md#evdasherror) | |
|
|
|
|
---
|
|
|
|
## Notifications
|
|
|
|
### EvDash.EnabledChanged
|
|
|
|
Emitted whenever the EV Dash service has been enabled or disabled.
|
|
|
|
**Paramètres :**
|
|
|
|
| Champ | Type | Notes |
|
|
| --- | --- | --- |
|
|
| `enabled` | `Bool` | |
|
|
|
|
---
|
|
|
|
### EvDash.UserAdded
|
|
|
|
Emitted whenever a new username has been added for the dashboard.
|
|
|
|
**Paramètres :**
|
|
|
|
| Champ | Type | Notes |
|
|
| --- | --- | --- |
|
|
| `username` | `String` | |
|
|
|
|
---
|
|
|
|
### EvDash.UserRemoved
|
|
|
|
Emitted whenever a username has been removed from the dashboard.
|
|
|
|
**Paramètres :**
|
|
|
|
| Champ | Type | Notes |
|
|
| --- | --- | --- |
|
|
| `username` | `String` | |
|
|
|
|
---
|
|
|
|
<!-- END GENERATED -->
|