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>
180 lines
3.7 KiB
Markdown
180 lines
3.7 KiB
Markdown
# ModbusRtu
|
|
|
|
<!-- BEGIN GENERATED: __api_ModbusRtu__ -->
|
|
## Méthodes
|
|
|
|
### ModbusRtu.AddModbusRtuMaster
|
|
|
|
<span class="badge perm-admin">ADMIN</span>
|
|
|
|
Add a new modbus RTU master with the given configuration. The timeout value is in milli seconds and the minimum value is 10 ms.
|
|
|
|
**Paramètres :**
|
|
|
|
| Champ | Type | Notes |
|
|
| --- | --- | --- |
|
|
| `baudrate` | `Uint` | |
|
|
| `dataBits` | [SerialPortDataBits](../types.md#serialportdatabits) | |
|
|
| `numberOfRetries` | `Uint` | |
|
|
| `parity` | [SerialPortParity](../types.md#serialportparity) | |
|
|
| `serialPort` | `String` | |
|
|
| `stopBits` | [SerialPortStopBits](../types.md#serialportstopbits) | |
|
|
| `timeout` | `Uint` | |
|
|
|
|
**Retour :**
|
|
|
|
| Champ | Type | Notes |
|
|
| --- | --- | --- |
|
|
| `modbusError` | [ModbusRtuError](../types.md#modbusrtuerror) | |
|
|
| `modbusUuid` | `Uuid` | optionnel |
|
|
|
|
---
|
|
|
|
### ModbusRtu.GetModbusRtuMasters
|
|
|
|
<span class="badge perm-admin">ADMIN</span>
|
|
|
|
Get the list of configured modbus RTU masters.
|
|
|
|
**Paramètres :**
|
|
|
|
_Aucun paramètre._
|
|
|
|
**Retour :**
|
|
|
|
| Champ | Type | Notes |
|
|
| --- | --- | --- |
|
|
| `modbusError` | [ModbusRtuError](../types.md#modbusrtuerror) | |
|
|
| `modbusRtuMasters` | [ModbusRtuMaster](../types.md#modbusrtumaster)[] | optionnel |
|
|
|
|
---
|
|
|
|
### ModbusRtu.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) | |
|
|
|
|
---
|
|
|
|
### ModbusRtu.ReconfigureModbusRtuMaster
|
|
|
|
<span class="badge perm-admin">ADMIN</span>
|
|
|
|
Reconfigure the modbus RTU master with the given UUID and configuration.
|
|
|
|
**Paramètres :**
|
|
|
|
| Champ | Type | Notes |
|
|
| --- | --- | --- |
|
|
| `baudrate` | `Uint` | |
|
|
| `dataBits` | [SerialPortDataBits](../types.md#serialportdatabits) | |
|
|
| `modbusUuid` | `Uuid` | |
|
|
| `numberOfRetries` | `Uint` | |
|
|
| `parity` | [SerialPortParity](../types.md#serialportparity) | |
|
|
| `serialPort` | `String` | |
|
|
| `stopBits` | [SerialPortStopBits](../types.md#serialportstopbits) | |
|
|
| `timeout` | `Uint` | |
|
|
|
|
**Retour :**
|
|
|
|
| Champ | Type | Notes |
|
|
| --- | --- | --- |
|
|
| `modbusError` | [ModbusRtuError](../types.md#modbusrtuerror) | |
|
|
|
|
---
|
|
|
|
### ModbusRtu.RemoveModbusRtuMaster
|
|
|
|
<span class="badge perm-admin">ADMIN</span>
|
|
|
|
Remove the modbus RTU master with the given modbus UUID.
|
|
|
|
**Paramètres :**
|
|
|
|
| Champ | Type | Notes |
|
|
| --- | --- | --- |
|
|
| `modbusUuid` | `Uuid` | |
|
|
|
|
**Retour :**
|
|
|
|
| Champ | Type | Notes |
|
|
| --- | --- | --- |
|
|
| `modbusError` | [ModbusRtuError](../types.md#modbusrtuerror) | |
|
|
|
|
---
|
|
|
|
## Notifications
|
|
|
|
### ModbusRtu.ModbusRtuMasterAdded
|
|
|
|
Emitted whenever a new modbus RTU master has been added to the system.
|
|
|
|
**Paramètres :**
|
|
|
|
| Champ | Type | Notes |
|
|
| --- | --- | --- |
|
|
| `modbusRtuMaster` | [ModbusRtuMaster](../types.md#modbusrtumaster) | |
|
|
|
|
---
|
|
|
|
### ModbusRtu.ModbusRtuMasterChanged
|
|
|
|
Emitted whenever a modbus RTU master has been changed in the system.
|
|
|
|
**Paramètres :**
|
|
|
|
| Champ | Type | Notes |
|
|
| --- | --- | --- |
|
|
| `modbusRtuMaster` | [ModbusRtuMaster](../types.md#modbusrtumaster) | |
|
|
|
|
---
|
|
|
|
### ModbusRtu.ModbusRtuMasterRemoved
|
|
|
|
Emitted whenever a modbus RTU master has been removed from the system.
|
|
|
|
**Paramètres :**
|
|
|
|
| Champ | Type | Notes |
|
|
| --- | --- | --- |
|
|
| `modbusUuid` | `Uuid` | |
|
|
|
|
---
|
|
|
|
### ModbusRtu.SerialPortAdded
|
|
|
|
Emitted whenever a serial port has been added to the system.
|
|
|
|
**Paramètres :**
|
|
|
|
| Champ | Type | Notes |
|
|
| --- | --- | --- |
|
|
| `serialPort` | [SerialPort](../types.md#serialport) | |
|
|
|
|
---
|
|
|
|
### ModbusRtu.SerialPortRemoved
|
|
|
|
Emitted whenever a serial port has been removed from the system.
|
|
|
|
**Paramètres :**
|
|
|
|
| Champ | Type | Notes |
|
|
| --- | --- | --- |
|
|
| `serialPort` | [SerialPort](../types.md#serialport) | |
|
|
|
|
---
|
|
|
|
<!-- END GENERATED -->
|