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>
301 lines
5.0 KiB
Markdown
301 lines
5.0 KiB
Markdown
# ZWave
|
|
|
|
<!-- BEGIN GENERATED: __api_ZWave__ -->
|
|
## Méthodes
|
|
|
|
### ZWave.AddNetwork
|
|
|
|
<span class="badge perm-admin">ADMIN</span>
|
|
|
|
Add a new Z-Wave network with the given serial port.
|
|
|
|
**Paramètres :**
|
|
|
|
| Champ | Type | Notes |
|
|
| --- | --- | --- |
|
|
| `serialPort` | `String` | |
|
|
|
|
**Retour :**
|
|
|
|
| Champ | Type | Notes |
|
|
| --- | --- | --- |
|
|
| `networkUuid` | `Uuid` | optionnel |
|
|
| `zwaveError` | [ZWaveError](../types.md#zwaveerror) | |
|
|
|
|
---
|
|
|
|
### ZWave.AddNode
|
|
|
|
<span class="badge perm-admin">ADMIN</span>
|
|
|
|
Start the node inclusion procedure for the given Z-Wave network.
|
|
|
|
**Paramètres :**
|
|
|
|
| Champ | Type | Notes |
|
|
| --- | --- | --- |
|
|
| `networkUuid` | `Uuid` | |
|
|
|
|
**Retour :**
|
|
|
|
| Champ | Type | Notes |
|
|
| --- | --- | --- |
|
|
| `zwaveError` | [ZWaveError](../types.md#zwaveerror) | |
|
|
|
|
---
|
|
|
|
### ZWave.CancelPendingOperation
|
|
|
|
<span class="badge perm-admin">ADMIN</span>
|
|
|
|
Cancel any running node inclusion or removal procedure for the given Z-Wave network.
|
|
|
|
**Paramètres :**
|
|
|
|
| Champ | Type | Notes |
|
|
| --- | --- | --- |
|
|
| `networkUuid` | `Uuid` | |
|
|
|
|
**Retour :**
|
|
|
|
| Champ | Type | Notes |
|
|
| --- | --- | --- |
|
|
| `zwaveError` | [ZWaveError](../types.md#zwaveerror) | |
|
|
|
|
---
|
|
|
|
### ZWave.FactoryResetNetwork
|
|
|
|
<span class="badge perm-admin">ADMIN</span>
|
|
|
|
Factory reset the controller for the given Z-Wave network.
|
|
|
|
**Paramètres :**
|
|
|
|
| Champ | Type | Notes |
|
|
| --- | --- | --- |
|
|
| `networkUuid` | `Uuid` | |
|
|
|
|
**Retour :**
|
|
|
|
| Champ | Type | Notes |
|
|
| --- | --- | --- |
|
|
| `zwaveError` | [ZWaveError](../types.md#zwaveerror) | |
|
|
|
|
---
|
|
|
|
### ZWave.GetNetworks
|
|
|
|
<span class="badge perm-admin">ADMIN</span>
|
|
|
|
Get all the Z-Wave networks in the system.
|
|
|
|
**Paramètres :**
|
|
|
|
_Aucun paramètre._
|
|
|
|
**Retour :**
|
|
|
|
| Champ | Type | Notes |
|
|
| --- | --- | --- |
|
|
| `networks` | [ZWaveNetwork](../types.md#zwavenetwork)[] | |
|
|
|
|
---
|
|
|
|
### ZWave.GetNodes
|
|
|
|
<span class="badge perm-admin">ADMIN</span>
|
|
|
|
Get the list of nodes in a network
|
|
|
|
**Paramètres :**
|
|
|
|
| Champ | Type | Notes |
|
|
| --- | --- | --- |
|
|
| `networkUuid` | `Uuid` | |
|
|
|
|
**Retour :**
|
|
|
|
| Champ | Type | Notes |
|
|
| --- | --- | --- |
|
|
| `nodes` | [ZWaveNode](../types.md#zwavenode)[] | optionnel |
|
|
| `zwaveError` | [ZWaveError](../types.md#zwaveerror) | |
|
|
|
|
---
|
|
|
|
### ZWave.GetSerialPorts
|
|
|
|
<span class="badge perm-admin">ADMIN</span>
|
|
|
|
Get the list of available serial ports from the host system.
|
|
|
|
**Paramètres :**
|
|
|
|
_Aucun paramètre._
|
|
|
|
**Retour :**
|
|
|
|
| Champ | Type | Notes |
|
|
| --- | --- | --- |
|
|
| `serialPorts` | [SerialPorts](../types.md#serialports) | |
|
|
|
|
---
|
|
|
|
### ZWave.IsZWaveAvailable
|
|
|
|
<span class="badge perm-admin">ADMIN</span>
|
|
|
|
Query if the Z-Wave subsystem is available at all.
|
|
|
|
**Paramètres :**
|
|
|
|
_Aucun paramètre._
|
|
|
|
**Retour :**
|
|
|
|
| Champ | Type | Notes |
|
|
| --- | --- | --- |
|
|
| `available` | `Bool` | |
|
|
|
|
---
|
|
|
|
### ZWave.RemoveFailedNode
|
|
|
|
<span class="badge perm-admin">ADMIN</span>
|
|
|
|
Remove the given failed node from the given Z-Wave network. This will not work if node is not marked as failed.
|
|
|
|
**Paramètres :**
|
|
|
|
| Champ | Type | Notes |
|
|
| --- | --- | --- |
|
|
| `networkUuid` | `Uuid` | |
|
|
| `nodeId` | `Uint` | |
|
|
|
|
**Retour :**
|
|
|
|
| Champ | Type | Notes |
|
|
| --- | --- | --- |
|
|
| `zwaveError` | [ZWaveError](../types.md#zwaveerror) | |
|
|
|
|
---
|
|
|
|
### ZWave.RemoveNetwork
|
|
|
|
<span class="badge perm-admin">ADMIN</span>
|
|
|
|
Remove the given Z-Wave network from the system.
|
|
|
|
**Paramètres :**
|
|
|
|
| Champ | Type | Notes |
|
|
| --- | --- | --- |
|
|
| `networkUuid` | `Uuid` | |
|
|
|
|
**Retour :**
|
|
|
|
| Champ | Type | Notes |
|
|
| --- | --- | --- |
|
|
| `zwaveError` | [ZWaveError](../types.md#zwaveerror) | |
|
|
|
|
---
|
|
|
|
### ZWave.RemoveNode
|
|
|
|
<span class="badge perm-admin">ADMIN</span>
|
|
|
|
Start the node removal procedure for the given Z-Wave network.
|
|
|
|
**Paramètres :**
|
|
|
|
| Champ | Type | Notes |
|
|
| --- | --- | --- |
|
|
| `networkUuid` | `Uuid` | |
|
|
|
|
**Retour :**
|
|
|
|
| Champ | Type | Notes |
|
|
| --- | --- | --- |
|
|
| `zwaveError` | [ZWaveError](../types.md#zwaveerror) | |
|
|
|
|
---
|
|
|
|
## Notifications
|
|
|
|
### ZWave.NetworkAdded
|
|
|
|
Emitted whenever a new Z-Wave network has been added to the system.
|
|
|
|
**Paramètres :**
|
|
|
|
| Champ | Type | Notes |
|
|
| --- | --- | --- |
|
|
| `network` | [ZWaveNetwork](../types.md#zwavenetwork) | |
|
|
|
|
---
|
|
|
|
### ZWave.NetworkChanged
|
|
|
|
Emitted whenever a Z-Wave network changes.
|
|
|
|
**Paramètres :**
|
|
|
|
| Champ | Type | Notes |
|
|
| --- | --- | --- |
|
|
| `network` | [ZWaveNetwork](../types.md#zwavenetwork) | |
|
|
|
|
---
|
|
|
|
### ZWave.NetworkRemoved
|
|
|
|
Emitted whenever a Z-Wave network has been removed from the system.
|
|
|
|
**Paramètres :**
|
|
|
|
| Champ | Type | Notes |
|
|
| --- | --- | --- |
|
|
| `networkUuid` | `Uuid` | |
|
|
|
|
---
|
|
|
|
### ZWave.NodeAdded
|
|
|
|
Emitted whenever a Z-Wave node is added.
|
|
|
|
**Paramètres :**
|
|
|
|
| Champ | Type | Notes |
|
|
| --- | --- | --- |
|
|
| `networkUuid` | `Uuid` | |
|
|
| `node` | [ZWaveNode](../types.md#zwavenode) | |
|
|
|
|
---
|
|
|
|
### ZWave.NodeChanged
|
|
|
|
Emitted whenever a Z-Wave node has changed.
|
|
|
|
**Paramètres :**
|
|
|
|
| Champ | Type | Notes |
|
|
| --- | --- | --- |
|
|
| `networkUuid` | `Uuid` | |
|
|
| `node` | [ZWaveNode](../types.md#zwavenode) | |
|
|
|
|
---
|
|
|
|
### ZWave.NodeRemoved
|
|
|
|
Emitted whenever a Z-Wave node is removed.
|
|
|
|
**Paramètres :**
|
|
|
|
| Champ | Type | Notes |
|
|
| --- | --- | --- |
|
|
| `networkUuid` | `Uuid` | |
|
|
| `nodeId` | `Uint` | |
|
|
|
|
---
|
|
|
|
<!-- END GENERATED -->
|