pakutz79/powersync-docs
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
powersync-docs/docs/api/systeme/zigbee.md
Patrick Schurig b26274595c
Some checks failed
Build & Deploy docs / build-deploy (push) Failing after 10m17s
Details
feat: référence API JsonRPC générée depuis introspect.json 
- 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>
2026-06-04 08:15:37 +02:00

383 lines
8.9 KiB
Markdown
Raw Blame History

# Zigbee
<!-- BEGIN GENERATED: __api_Zigbee__ -->
## Méthodes
### Zigbee.AddNetwork
<span class="badge perm-admin">ADMIN</span>
Create a new ZigBee network for the given 'serialPort', 'baudRate' and 'backend'. The serial ports can be fetched from the available adapters. See 'GetAdapters' for more information. The available backends can be fetched using the 'GetAvailableBackends' method.
**Paramètres :**
| Champ | Type | Notes |
| --- | --- | --- |
| `backend` | `String` | |
| `baudRate` | `Uint` | |
| `channelMask` | `Uint` | optionnel |
| `serialPort` | `String` | |
**Retour :**
| Champ | Type | Notes |
| --- | --- | --- |
| `networkUuid` | `Uuid` | optionnel |
| `zigbeeError` | [ZigbeeError](../types.md#zigbeeerror) | |
---
### Zigbee.CreateBinding
<span class="badge perm-admin">ADMIN</span>
Create a binding. Use destinationAddress and destinationEndpointId to create a node to node binding, or use destinationGroupAddress to create a group binding.
**Paramètres :**
| Champ | Type | Notes |
| --- | --- | --- |
| `clusterId` | `Uint` | |
| `networkUuid` | `Uuid` | |
| `destinationAddress` | `String` | optionnel |
| `destinationEndpointId` | `Uint` | optionnel |
| `destinationGroupAddress` | `Uint` | optionnel |
| `sourceAddress` | `String` | |
| `sourceEndpointId` | `Uint` | |
**Retour :**
| Champ | Type | Notes |
| --- | --- | --- |
| `zigbeeError` | [ZigbeeError](../types.md#zigbeeerror) | |
---
### Zigbee.FactoryResetNetwork
<span class="badge perm-admin">ADMIN</span>
Factory reset the network with the given 'networkUuid'. The network does not have to be online for this procedure, and all associated nodes and things will be removed permanently.
**Paramètres :**
| Champ | Type | Notes |
| --- | --- | --- |
| `networkUuid` | `Uuid` | |
**Retour :**
| Champ | Type | Notes |
| --- | --- | --- |
| `zigbeeError` | [ZigbeeError](../types.md#zigbeeerror) | |
---
### Zigbee.GetAdapters
<span class="badge perm-admin">ADMIN</span>
Get the list of available ZigBee adapters and serial ports in order to set up the ZigBee network on the desired interface. The 'serialPort' property can be used as unique identifier for an adapter. If an adapter hardware has been recognized as a well known ZigBee adapter, the 'hardwareRecognized' property will be true and the 'baudRate' and 'backend' configurations can be used as they where given, otherwise the user might set the backend and baud rate manually. The available backends can be fetched using the GetAvailableBackends method.
**Paramètres :**
_Aucun paramètre._
**Retour :**
| Champ | Type | Notes |
| --- | --- | --- |
| `adapters` | [ZigbeeAdapters](../types.md#zigbeeadapters) | |
---
### Zigbee.GetAvailableBackends
<span class="badge perm-admin">ADMIN</span>
Get the list of available ZigBee backends.
**Paramètres :**
_Aucun paramètre._
**Retour :**
| Champ | Type | Notes |
| --- | --- | --- |
| `backends` | `String`[] | |
---
### Zigbee.GetNetworks
<span class="badge perm-admin">ADMIN</span>
Returns the list of configured ZigBee networks in the system.
**Paramètres :**
_Aucun paramètre._
**Retour :**
| Champ | Type | Notes |
| --- | --- | --- |
| `zigbeeNetworks` | [ZigbeeNetwork](../types.md#zigbeenetwork)[] | |
---
### Zigbee.GetNodes
<span class="badge perm-admin">ADMIN</span>
Returns the list of ZigBee nodes from the network the given 'networkUuid' in the system.
**Paramètres :**
| Champ | Type | Notes |
| --- | --- | --- |
| `networkUuid` | `Uuid` | |
**Retour :**
| Champ | Type | Notes |
| --- | --- | --- |
| `zigbeeNodes` | [ZigbeeNode](../types.md#zigbeenode)[] | optionnel |
| `zigbeeError` | [ZigbeeError](../types.md#zigbeeerror) | |
---
### Zigbee.RefreshBindings
<span class="badge perm-admin">ADMIN</span>
Refresh the binding table for the given node.
**Paramètres :**
| Champ | Type | Notes |
| --- | --- | --- |
| `ieeeAddress` | `String` | |
| `networkUuid` | `Uuid` | |
**Retour :**
| Champ | Type | Notes |
| --- | --- | --- |
| `zigbeeError` | [ZigbeeError](../types.md#zigbeeerror) | |
---
### Zigbee.RefreshNeighborTables
<span class="badge perm-admin">ADMIN</span>
Refresh the neighbor table for all nodes. Note that calling this may cause a lot of traffic in the ZigBee network.
**Paramètres :**
| Champ | Type | Notes |
| --- | --- | --- |
| `networkUuid` | `Uuid` | |
**Retour :**
| Champ | Type | Notes |
| --- | --- | --- |
| `zigbeeError` | [ZigbeeError](../types.md#zigbeeerror) | |
---
### Zigbee.RemoveBinding
<span class="badge perm-admin">ADMIN</span>
Remove a binding.
**Paramètres :**
| Champ | Type | Notes |
| --- | --- | --- |
| `clusterId` | `Uint` | |
| `networkUuid` | `Uuid` | |
| `destinationAddress` | `String` | optionnel |
| `destinationEndpointId` | `Uint` | optionnel |
| `destinationGroupAddress` | `Uint` | optionnel |
| `sourceAddress` | `String` | |
| `sourceEndpointId` | `Uint` | |
**Retour :**
| Champ | Type | Notes |
| --- | --- | --- |
| `zigbeeError` | [ZigbeeError](../types.md#zigbeeerror) | |
---
### Zigbee.RemoveNetwork
<span class="badge perm-admin">ADMIN</span>
Remove the ZigBee network with the given network uuid.
**Paramètres :**
| Champ | Type | Notes |
| --- | --- | --- |
| `networkUuid` | `Uuid` | |
**Retour :**
| Champ | Type | Notes |
| --- | --- | --- |
| `zigbeeError` | [ZigbeeError](../types.md#zigbeeerror) | |
---
### Zigbee.RemoveNode
<span class="badge perm-admin">ADMIN</span>
Remove a ZigBee node with the given 'ieeeAddress' from the network with the given 'networkUuid'. If there is a thing configured for this node, also the thing will be removed from the system. The coordinator node cannot be removed.
**Paramètres :**
| Champ | Type | Notes |
| --- | --- | --- |
| `ieeeAddress` | `String` | |
| `networkUuid` | `Uuid` | |
**Retour :**
| Champ | Type | Notes |
| --- | --- | --- |
| `zigbeeError` | [ZigbeeError](../types.md#zigbeeerror) | |
---
### Zigbee.SetPermitJoin
<span class="badge perm-admin">ADMIN</span>
Allow or deny nodes to join the network with the given 'networkUuid' for a specific 'duration' in seconds. The duration value has to be between 0 and 255 seconds. The 'permitJoinDuration' property of ZigBee network object indicates how long permit has been enabled and the 'permitJoiningRemaining' indicates the rest of the time. Those values can be used to show a countdown or progressbar. This method can be recalled for resetting the timeout. If the duration is set to 0 seconds, joining will be disabled immediatly for the entire network. The 'shortAddress' is optional and defaults to the broadcast address 0xfffc for all routers in the network. If the short address matches the address of a router node in the network, only that specific router will be able to allow new nodes to join the network. A new node will join to the router with the best link quality index (LQI).
**Paramètres :**
| Champ | Type | Notes |
| --- | --- | --- |
| `duration` | `Uint` | |
| `networkUuid` | `Uuid` | |
| `shortAddress` | `Uint` | optionnel |
**Retour :**
| Champ | Type | Notes |
| --- | --- | --- |
| `zigbeeError` | [ZigbeeError](../types.md#zigbeeerror) | |
---
## Notifications
### Zigbee.AdapterAdded
Emitted whenever a new ZigBee adapter or serial port has been detected in the system.
**Paramètres :**
| Champ | Type | Notes |
| --- | --- | --- |
| `adapter` | [ZigbeeAdapter](../types.md#zigbeeadapter) | |
---
### Zigbee.AdapterRemoved
Emitted whenever a ZigBee adapter or serial port has been removed from the system (i.e. unplugged).
**Paramètres :**
| Champ | Type | Notes |
| --- | --- | --- |
| `adapter` | [ZigbeeAdapter](../types.md#zigbeeadapter) | |
---
### Zigbee.NetworkAdded
Emitted whenever a new ZigBee network has been added.
**Paramètres :**
| Champ | Type | Notes |
| --- | --- | --- |
| `zigbeeNetwork` | [ZigbeeNetwork](../types.md#zigbeenetwork) | |
---
### Zigbee.NetworkChanged
Emitted whenever a new ZigBee network has changed.
**Paramètres :**
| Champ | Type | Notes |
| --- | --- | --- |
| `zigbeeNetwork` | [ZigbeeNetwork](../types.md#zigbeenetwork) | |
---
### Zigbee.NetworkRemoved
Emitted whenever a new ZigBee network has been removed.
**Paramètres :**
| Champ | Type | Notes |
| --- | --- | --- |
| `networkUuid` | `Uuid` | |
---
### Zigbee.NodeAdded
Emitted whenever a new ZigBee node has joined the network with the given 'networkUuid'.
**Paramètres :**
| Champ | Type | Notes |
| --- | --- | --- |
| `networkUuid` | `Uuid` | |
| `zigbeeNode` | [ZigbeeNode](../types.md#zigbeenode) | |
---
### Zigbee.NodeChanged
Emitted whenever a ZigBee node has changed.
**Paramètres :**
| Champ | Type | Notes |
| --- | --- | --- |
| `networkUuid` | `Uuid` | |
| `zigbeeNode` | [ZigbeeNode](../types.md#zigbeenode) | |
---
### Zigbee.NodeRemoved
Emitted whenever a ZigBee node has removed from the network with the given 'networkUuid'.
**Paramètres :**
| Champ | Type | Notes |
| --- | --- | --- |
| `networkUuid` | `Uuid` | |
| `zigbeeNode` | [ZigbeeNode](../types.md#zigbeenode) | |
---
<!-- END GENERATED -->
Reference in New Issue View Git Blame Copy Permalink