ETM-Schurig/powersync-docs
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
powersync-docs/docs/api/systeme/configuration.md
Patrick Schurig 325409dd3f feat(i18n): prose traduite DE/EN et référence régénérée en anglais 
82 pages .de.md et 82 .en.md. La volumétrie explique la forme : 95 % du volume
est GÉNÉRÉ (74 013 mots contre 3 506 rédigés, mesuré sur 107 pages). On ne
traduisait donc pas 77 500 mots — on traduit la prose, et le vocabulaire des
générateurs fait le reste.

Prose traduite à la main : accueil, installation (4), fonctionnalités (4),
tarifs, référence, dépannage, FAQ, intégrations (2), api/index, et les 6 fiches
appareils qui portent une vraie prose + compatibilite.md. Les blocs générés ne
sont JAMAIS recopiés dans une traduction : le script de pose les reprend
verbatim du fichier français via des placeholders, pour qu'une traduction ne
puisse pas désynchroniser un bloc généré.

Les 49 fiches légères n'ont rien à traduire : leur tagline vient d'amont et est
DÉJÀ en anglais (« Connects nymea to powerfox. »). Constat, pas renoncement.

Localisation ≠ traduction, et tarifs.md en est l'exemple à connaître : la
version FR parle de Tempo et du signal RTE, la DE de §14a EnWG et de SMARD,
l'EN des deux. Ce ne sont pas des traductions l'une de l'autre, et c'est
volontaire — les signaux tarifaires sont nationaux. Aucune des deux n'est
annoncée comme livrée : les deux sont Roadmap, et les pages le disent.

Référence régénérée : en-têtes et libellés en anglais (Field/Type/Notes,
Supported models, Settings, Read-only, Brand / Model…). Conséquence assumée et
signalée : les pages FR en ligne changent aussi.

README.md (il était VIDE) : la règle du 95 % généré en tête, la frontière de
décision du multi-langue avec sa mesure, pourquoi SCAFFOLD existe, et le piège
--strict/navigation.instant.

TODO : multi-langue clos, et trois points ouverts qui en restent — les tagline
vivent dans les meta.json de 5 autres dépôts (forme à ajouter : tagline_de /
tagline_en), les stubs traduits restent des stubs (la dette éditoriale a triplé
en surface, pas en fond), api/types.md n'a pas besoin de variante. Le P1
openmeteo est corrigé sur constat : il EST dans PORTING_STATUS depuis, et une
ligne commentée contradictoire y traîne encore.

Vérifié : mkdocs build --strict vert sur les trois langues, 322 pages HTML,
contenu traduit relu dans le HTML produit, et les deux générateurs rendent
« Doc à jour » en --check.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
2026-10-13 06:39:20 +02:00

796 lines
18 KiB
Markdown
Raw Blame History

# Configuration
<!-- BEGIN GENERATED: __api_Configuration__ -->
## Methods
### Configuration.CreateAndDownloadBackup
<span class="badge perm-admin">ADMIN</span>
Create a backup of the current configuration and generate a download entry for the dedicated transfer connection.
**Parameters:**
_No parameters._
**Returns:**
| Field | Type | Notes |
| --- | --- | --- |
| `configurationError` | [ConfigurationError](../types.md#configurationerror) | |
| `downloadId` | `String` | |
| `fileName` | `String` | |
| `size` | `Int` | |
---
### Configuration.CreateBackup
<span class="badge perm-admin">ADMIN</span>
Create a backup of the current configuration. It will be stored in the configured destination directory. Also the maxCout configuration will be considered.
**Parameters:**
_No parameters._
**Returns:**
| Field | Type | Notes |
| --- | --- | --- |
| `configurationError` | [ConfigurationError](../types.md#configurationerror) | |
---
### Configuration.DeleteBackupFile
<span class="badge perm-admin">ADMIN</span>
Delete an existing configuration backup file.
**Parameters:**
| Field | Type | Notes |
| --- | --- | --- |
| `fileName` | `String` | |
**Returns:**
| Field | Type | Notes |
| --- | --- | --- |
| `configurationError` | [ConfigurationError](../types.md#configurationerror) | |
---
### Configuration.DeleteMqttPolicy
<span class="badge perm-admin">ADMIN</span>
Delete a MQTT policy from the broker.
**Parameters:**
| Field | Type | Notes |
| --- | --- | --- |
| `clientId` | `String` | |
**Returns:**
| Field | Type | Notes |
| --- | --- | --- |
| `configurationError` | [ConfigurationError](../types.md#configurationerror) | |
---
### Configuration.DeleteMqttServerConfiguration
<span class="badge perm-admin">ADMIN</span>
Delete a MQTT Server interface of the server.
**Parameters:**
| Field | Type | Notes |
| --- | --- | --- |
| `id` | `String` | |
**Returns:**
| Field | Type | Notes |
| --- | --- | --- |
| `configurationError` | [ConfigurationError](../types.md#configurationerror) | |
---
### Configuration.DeleteTcpServerConfiguration
<span class="badge perm-admin">ADMIN</span>
Delete a TCP interface of the server. Note: if you are deleting the configuration for the interface you are currently connected to, the connection will be dropped.
**Parameters:**
| Field | Type | Notes |
| --- | --- | --- |
| `id` | `String` | |
**Returns:**
| Field | Type | Notes |
| --- | --- | --- |
| `configurationError` | [ConfigurationError](../types.md#configurationerror) | |
---
### Configuration.DeleteTunnelProxyServerConfiguration
<span class="badge perm-admin">ADMIN</span>
Delete a Tunnel Proxy Server interface of the server. Note: if you are deleting the configuration for the interface you are currently connected to, the connection will be dropped.
**Parameters:**
| Field | Type | Notes |
| --- | --- | --- |
| `id` | `String` | |
**Returns:**
| Field | Type | Notes |
| --- | --- | --- |
| `configurationError` | [ConfigurationError](../types.md#configurationerror) | |
---
### Configuration.DeleteWebServerConfiguration
<span class="badge perm-admin">ADMIN</span>
Delete a WebServer interface of the server.
**Parameters:**
| Field | Type | Notes |
| --- | --- | --- |
| `id` | `String` | |
**Returns:**
| Field | Type | Notes |
| --- | --- | --- |
| `configurationError` | [ConfigurationError](../types.md#configurationerror) | |
---
### Configuration.DeleteWebSocketServerConfiguration
<span class="badge perm-admin">ADMIN</span>
Delete a WebSocket Server interface of the server. Note: if you are deleting the configuration for the interface you are currently connected to, the connection will be dropped.
**Parameters:**
| Field | Type | Notes |
| --- | --- | --- |
| `id` | `String` | |
**Returns:**
| Field | Type | Notes |
| --- | --- | --- |
| `configurationError` | [ConfigurationError](../types.md#configurationerror) | |
---
### Configuration.DownloadBackupFile
<span class="badge perm-admin">ADMIN</span>
Generate a download entry for an existing configuration backup file.
**Parameters:**
| Field | Type | Notes |
| --- | --- | --- |
| `fileName` | `String` | |
**Returns:**
| Field | Type | Notes |
| --- | --- | --- |
| `configurationError` | [ConfigurationError](../types.md#configurationerror) | |
| `downloadId` | `String` | optional |
| `fileName` | `String` | optional |
| `size` | `Int` | optional |
---
### Configuration.GetAvailableLanguages
<span class="badge perm-none">PUBLIC</span>
Returns a list of locale codes available for the server. i.e. en_US, de_AT
**Parameters:**
_No parameters._
**Returns:**
| Field | Type | Notes |
| --- | --- | --- |
| `languages` | `String`[] | |
---
### Configuration.GetBackupFiles
<span class="badge perm-admin">ADMIN</span>
Get the list of configuration backup files from the configured destination directory.
**Parameters:**
_No parameters._
**Returns:**
| Field | Type | Notes |
| --- | --- | --- |
| `backupFiles` | [BackupFile](../types.md#backupfile)[] | |
---
### Configuration.GetConfigurations
<span class="badge perm-none">PUBLIC</span>
Get all configuration parameters of the server.
**Parameters:**
_No parameters._
**Returns:**
| Field | Type | Notes |
| --- | --- | --- |
| `backupConfigurations` | `{'autoBackupEnabled': 'Bool', 'autoBackupInterval': 'Int', 'destinationDirectory': 'String', 'maxCount': 'Uint'}` | |
| `basicConfiguration` | `{'d:language': 'String', 'd:location': {'latitude': 'Double', 'longitude': 'Double', 'name': 'String'}, 'd:serverTime': 'Uint', 'd:timeZone': 'String', 'debugServerEnabled': 'Bool', 'serverName': 'String', 'serverUuid': 'Uuid'}` | |
| `mqttServerConfigurations` | [ServerConfiguration](../types.md#serverconfiguration)[] | |
| `tcpServerConfigurations` | [ServerConfiguration](../types.md#serverconfiguration)[] | |
| `tunnelProxyServerConfigurations` | [TunnelProxyServerConfiguration](../types.md#tunnelproxyserverconfiguration)[] | |
| `webServerConfigurations` | [WebServerConfiguration](../types.md#webserverconfiguration)[] | |
| `webSocketServerConfigurations` | [ServerConfiguration](../types.md#serverconfiguration)[] | |
---
### Configuration.GetMqttPolicies
<span class="badge perm-admin">ADMIN</span>
Get all MQTT broker policies.
**Parameters:**
_No parameters._
**Returns:**
| Field | Type | Notes |
| --- | --- | --- |
| `mqttPolicies` | [MqttPolicy](../types.md#mqttpolicy)[] | |
---
### Configuration.GetMqttServerConfigurations
<span class="badge perm-admin">ADMIN</span>
Get all MQTT Server configurations.
**Parameters:**
_No parameters._
**Returns:**
| Field | Type | Notes |
| --- | --- | --- |
| `mqttServerConfigurations` | [ServerConfiguration](../types.md#serverconfiguration)[] | |
---
### Configuration.GetTimeZones
<span class="badge perm-none">PUBLIC</span>
Get the list of available timezones.
**Parameters:**
_No parameters._
**Returns:**
| Field | Type | Notes |
| --- | --- | --- |
| `timeZones` | `String`[] | |
---
### Configuration.RestoreBackupFile
<span class="badge perm-admin">ADMIN</span>
Restore an existing configuration backup file. Clients should warn the user before calling this method because the current configuration data will be wiped, the server will restart immediately afterwards and it will come back up using the restored backup.
**Parameters:**
| Field | Type | Notes |
| --- | --- | --- |
| `fileName` | `String` | |
**Returns:**
| Field | Type | Notes |
| --- | --- | --- |
| `configurationError` | [ConfigurationError](../types.md#configurationerror) | |
---
### Configuration.SetBackupConfiguration
<span class="badge perm-admin">ADMIN</span>
Set the backup configuration. The destination directory is the location where the archives will be saved, the maxCount is the number of backups which will be kept. If maxCount is 0, all backups will be kept. The autoBackupEnabled property controls periodic configuration backups and autoBackupInterval defines the interval in hours.
**Parameters:**
| Field | Type | Notes |
| --- | --- | --- |
| `autoBackupEnabled` | `Bool` | |
| `autoBackupInterval` | `Int` | |
| `destinationDirectory` | `String` | |
| `maxCount` | `Uint` | |
**Returns:**
| Field | Type | Notes |
| --- | --- | --- |
| `configurationError` | [ConfigurationError](../types.md#configurationerror) | |
---
### Configuration.SetDebugServerEnabled
<span class="badge perm-admin">ADMIN</span>
Enable or disable the debug server.
**Parameters:**
| Field | Type | Notes |
| --- | --- | --- |
| `enabled` | `String` | |
**Returns:**
| Field | Type | Notes |
| --- | --- | --- |
| `configurationError` | [ConfigurationError](../types.md#configurationerror) | |
---
### Configuration.SetLanguage
<span class="badge perm-admin">ADMIN</span>
Sets the server language to the given language. See also: "GetAvailableLanguages"
**Parameters:**
| Field | Type | Notes |
| --- | --- | --- |
| `language` | `String` | |
**Returns:**
| Field | Type | Notes |
| --- | --- | --- |
| `configurationError` | [ConfigurationError](../types.md#configurationerror) | |
---
### Configuration.SetLocation
<span class="badge perm-admin">ADMIN</span>
Sets the server location.
**Parameters:**
| Field | Type | Notes |
| --- | --- | --- |
| `location` | `{'latitude': 'Double', 'longitude': 'Double', 'name': 'String'}` | |
**Returns:**
| Field | Type | Notes |
| --- | --- | --- |
| `configurationError` | [ConfigurationError](../types.md#configurationerror) | |
---
### Configuration.SetMqttPolicy
<span class="badge perm-admin">ADMIN</span>
Configure a MQTT broker policy. If the ID is an existing one, the existing policy will be modified, otherwise a new one will be added.
**Parameters:**
| Field | Type | Notes |
| --- | --- | --- |
| `policy` | [MqttPolicy](../types.md#mqttpolicy) | |
**Returns:**
| Field | Type | Notes |
| --- | --- | --- |
| `configurationError` | [ConfigurationError](../types.md#configurationerror) | |
---
### Configuration.SetMqttServerConfiguration
<span class="badge perm-admin">ADMIN</span>
Configure a MQTT Server interface on the MQTT broker. If the ID is an existing one, the existing config will be modified, otherwise a new one will be added. Setting authenticationEnabled to true will require MQTT clients to use credentials set in the MQTT broker policies.
**Parameters:**
| Field | Type | Notes |
| --- | --- | --- |
| `configuration` | [ServerConfiguration](../types.md#serverconfiguration) | |
**Returns:**
| Field | Type | Notes |
| --- | --- | --- |
| `configurationError` | [ConfigurationError](../types.md#configurationerror) | |
---
### Configuration.SetServerName
<span class="badge perm-admin">ADMIN</span>
Set the name of the server. Default is nymea.
**Parameters:**
| Field | Type | Notes |
| --- | --- | --- |
| `serverName` | `String` | |
**Returns:**
| Field | Type | Notes |
| --- | --- | --- |
| `configurationError` | [ConfigurationError](../types.md#configurationerror) | |
---
### Configuration.SetTcpServerConfiguration
<span class="badge perm-admin">ADMIN</span>
Configure a TCP interface of the server. If the ID is an existing one, the existing config will be modified, otherwise a new one will be added. Note: if you are changing the configuration for the interface you are currently connected to, the connection will be dropped.
**Parameters:**
| Field | Type | Notes |
| --- | --- | --- |
| `configuration` | [ServerConfiguration](../types.md#serverconfiguration) | |
**Returns:**
| Field | Type | Notes |
| --- | --- | --- |
| `configurationError` | [ConfigurationError](../types.md#configurationerror) | |
---
### Configuration.SetTimeZone
<span class="badge perm-admin">ADMIN</span>
Set the time zone of the server. See also: "GetTimeZones"
**Parameters:**
| Field | Type | Notes |
| --- | --- | --- |
| `timeZone` | `String` | |
**Returns:**
| Field | Type | Notes |
| --- | --- | --- |
| `configurationError` | [ConfigurationError](../types.md#configurationerror) | |
---
### Configuration.SetTunnelProxyServerConfiguration
<span class="badge perm-admin">ADMIN</span>
Configure a Tunnel Proxy Server interface of the server. If the ID is an existing one, the existing config will be modified, otherwise a new one will be added. Note: if you are changing the configuration for the interface you are currently connected to, the connection will be dropped.
**Parameters:**
| Field | Type | Notes |
| --- | --- | --- |
| `configuration` | [TunnelProxyServerConfiguration](../types.md#tunnelproxyserverconfiguration) | |
**Returns:**
| Field | Type | Notes |
| --- | --- | --- |
| `configurationError` | [ConfigurationError](../types.md#configurationerror) | |
---
### Configuration.SetWebServerConfiguration
<span class="badge perm-admin">ADMIN</span>
Configure a WebServer interface of the server. If the ID is an existing one, the existing config will be modified, otherwise a new one will be added.
**Parameters:**
| Field | Type | Notes |
| --- | --- | --- |
| `configuration` | [WebServerConfiguration](../types.md#webserverconfiguration) | |
**Returns:**
| Field | Type | Notes |
| --- | --- | --- |
| `configurationError` | [ConfigurationError](../types.md#configurationerror) | |
---
### Configuration.SetWebSocketServerConfiguration
<span class="badge perm-admin">ADMIN</span>
Configure a WebSocket Server interface of the server. If the ID is an existing one, the existing config will be modified, otherwise a new one will be added. Note: if you are changing the configuration for the interface you are currently connected to, the connection will be dropped.
**Parameters:**
| Field | Type | Notes |
| --- | --- | --- |
| `configuration` | [ServerConfiguration](../types.md#serverconfiguration) | |
**Returns:**
| Field | Type | Notes |
| --- | --- | --- |
| `configurationError` | [ConfigurationError](../types.md#configurationerror) | |
---
### Configuration.UploadAndRestoreBackup
<span class="badge perm-admin">ADMIN</span>
Create an upload session for a configuration backup archive. The uploaded file will be stored temporarily under /tmp, the current configuration will be wiped after the upload finishes and the server will restart immediately using the restored backup. Clients should warn the user before calling this method because all current configuration data will be lost.
**Parameters:**
| Field | Type | Notes |
| --- | --- | --- |
| `fileName` | `String` | |
| `size` | `Int` | |
**Returns:**
| Field | Type | Notes |
| --- | --- | --- |
| `configurationError` | [ConfigurationError](../types.md#configurationerror) | |
| `fileName` | `String` | optional |
| `size` | `Int` | optional |
| `transferId` | `String` | optional |
| `transferToken` | `String` | optional |
---
## Notifications
### Configuration.BackupConfigurationChanged
Emitted whenever the backup configuration changes.
**Parameters:**
| Field | Type | Notes |
| --- | --- | --- |
| `autoBackupEnabled` | `Bool` | |
| `autoBackupInterval` | `Int` | |
| `destinationDirectory` | `String` | |
| `maxCount` | `Uint` | |
---
### Configuration.BackupFilesChanged
Emitted whenever the list of backup files changes.
**Parameters:**
| Field | Type | Notes |
| --- | --- | --- |
| `backupFiles` | [BackupFile](../types.md#backupfile)[] | |
---
### Configuration.BasicConfigurationChanged
Emitted whenever the basic configuration of this server changes.
**Parameters:**
| Field | Type | Notes |
| --- | --- | --- |
| `basicConfiguration` | `{'d:language': 'String', 'd:location': {'latitude': 'Double', 'longitude': 'Double', 'name': 'String'}, 'd:serverTime': 'Uint', 'd:timeZone': 'String', 'debugServerEnabled': 'Bool', 'serverName': 'String', 'serverUuid': 'Uuid'}` | |
---
### Configuration.MqttPolicyChanged
Emitted whenever a MQTT broker policy is changed.
**Parameters:**
| Field | Type | Notes |
| --- | --- | --- |
| `policy` | [MqttPolicy](../types.md#mqttpolicy) | |
---
### Configuration.MqttPolicyRemoved
Emitted whenever a MQTT broker policy is removed.
**Parameters:**
| Field | Type | Notes |
| --- | --- | --- |
| `clientId` | `String` | |
---
### Configuration.MqttServerConfigurationChanged
Emitted whenever the MQTT broker configuration is changed.
**Parameters:**
| Field | Type | Notes |
| --- | --- | --- |
| `mqttServerConfiguration` | [ServerConfiguration](../types.md#serverconfiguration) | |
---
### Configuration.MqttServerConfigurationRemoved
Emitted whenever a MQTT server configuration is removed.
**Parameters:**
| Field | Type | Notes |
| --- | --- | --- |
| `id` | `String` | |
---
### Configuration.TcpServerConfigurationChanged
Emitted whenever the TCP server configuration changes.
**Parameters:**
| Field | Type | Notes |
| --- | --- | --- |
| `tcpServerConfiguration` | [ServerConfiguration](../types.md#serverconfiguration) | |
---
### Configuration.TcpServerConfigurationRemoved
Emitted whenever a TCP server configuration is removed.
**Parameters:**
| Field | Type | Notes |
| --- | --- | --- |
| `id` | `String` | |
---
### Configuration.TunnelProxyServerConfigurationChanged
Emitted whenever the tunnel proxy server configuration changes.
**Parameters:**
| Field | Type | Notes |
| --- | --- | --- |
| `tunnelProxyServerConfiguration` | [TunnelProxyServerConfiguration](../types.md#tunnelproxyserverconfiguration) | |
---
### Configuration.TunnelProxyServerConfigurationRemoved
Emitted whenever a tunnel proxy server configuration is removed.
**Parameters:**
| Field | Type | Notes |
| --- | --- | --- |
| `id` | `String` | |
---
### Configuration.WebServerConfigurationChanged
Emitted whenever the web server configuration changes.
**Parameters:**
| Field | Type | Notes |
| --- | --- | --- |
| `webServerConfiguration` | [WebServerConfiguration](../types.md#webserverconfiguration) | |
---
### Configuration.WebServerConfigurationRemoved
Emitted whenever a Web server configuration is removed.
**Parameters:**
| Field | Type | Notes |
| --- | --- | --- |
| `id` | `String` | |
---
### Configuration.WebSocketServerConfigurationChanged
Emitted whenever the web socket server configuration changes.
**Parameters:**
| Field | Type | Notes |
| --- | --- | --- |
| `webSocketServerConfiguration` | [ServerConfiguration](../types.md#serverconfiguration) | |
---
### Configuration.WebSocketServerConfigurationRemoved
Emitted whenever a WebSocket server configuration is removed.
**Parameters:**
| Field | Type | Notes |
| --- | --- | --- |
| `id` | `String` | |
---
<!-- END GENERATED -->
Reference in New Issue View Git Blame Copy Permalink