ETM-Schurig/powersync-docs
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
powersync-docs/docs/api/notifications.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

21 KiB
Raw Blame History

Notifications

AirConditioning

AirConditioning.ZoneAdded

Emitted whenever a zone is added

Parameters:

Field Type Notes
zone ZoneInfo

AirConditioning.ZoneChanged

Emitted whenever a zone changes

Parameters:

Field Type Notes
zone ZoneInfo

AirConditioning.ZoneRemoved

Emitted whenever a zone is removed

Parameters:

Field Type Notes
zoneId Uuid

AppData

AppData.Changed

Emitted whenever the app data is changed on the server.

Parameters:

Field Type Notes
appId String
key String
group String optional
value String

Energy

Energy.PowerBalanceChanged

Emitted whenever the energy balance changes. That is, when the current consumption, production or acquisition changes. Typically they will all change at the same time.

Parameters:

Field Type Notes
currentPowerAcquisition Double
currentPowerConsumption Double
currentPowerProduction Double
currentPowerStorage Double
totalAcquisition Double
totalConsumption Double
totalProduction Double
totalReturn Double

Energy.PowerBalanceLogEntryAdded

Emitted whenever an entry is added to the power balance log.

Parameters:

Field Type Notes
powerBalanceLogEntry PowerBalanceLogEntry
sampleRate SampleRate

Energy.RootMeterChanged

Emitted whenever the root meter id changes. If the root meter has been unset, the params will be empty.

Parameters:

Field Type Notes
rootMeterThingId Uuid optional

Energy.ThingPowerLogEntryAdded

Emitted whenever an entry is added to the thing power log.

Parameters:

Field Type Notes
sampleRate SampleRate
thingPowerLogEntry ThingPowerLogEntry

EvDash

EvDash.EnabledChanged

Emitted whenever the EV Dash service has been enabled or disabled.

Parameters:

Field Type Notes
enabled Bool

EvDash.UserAdded

Emitted whenever a new username has been added for the dashboard.

Parameters:

Field Type Notes
username String

EvDash.UserRemoved

Emitted whenever a username has been removed from the dashboard.

Parameters:

Field Type Notes
username String

Integrations

Integrations.EventTriggered

Emitted whenever an Event is triggered.

Parameters:

Field Type Notes
event Event

Integrations.IOConnectionAdded

Emitted whenever an IO connection has been added.

Parameters:

Field Type Notes
ioConnection IOConnection

Integrations.IOConnectionRemoved

Emitted whenever an IO connection has been removed.

Parameters:

Field Type Notes
ioConnectionId Uuid

Integrations.PluginConfigurationChanged

Emitted whenever a plugin's configuration is changed.

Parameters:

Field Type Notes
configuration ParamList
pluginId Uuid

Integrations.StateChanged

Emitted whenever a state of a thing changes.

Parameters:

Field Type Notes
maxValue Variant
minValue Variant
possibleValues Variant[]
stateTypeId Uuid
thingId Uuid
value Variant

Integrations.ThingAdded

Emitted whenever a thing was added.

Parameters:

Field Type Notes
thing Thing

Integrations.ThingChanged

Emitted whenever the params or name of a thing are changed (by EditThing or ReconfigureThing).

Parameters:

Field Type Notes
thing Thing

Integrations.ThingRemoved

Emitted whenever a thing was removed.

Parameters:

Field Type Notes
thingId Uuid

Integrations.ThingSettingChanged

Emitted whenever the setting of a thing is changed.

Parameters:

Field Type Notes
paramTypeId Uuid
thingId Uuid
value Variant

JSONRPC

JSONRPC.PushButtonAuthFinished

Emitted when a push button authentication reaches final state. NOTE: This notification is special. It will only be emitted to connections that did actively request a push button authentication, but also it will be emitted regardless of the notification settings.

Parameters:

Field Type Notes
token String optional
success Bool
transactionId Int

Logging

Logging.LogEntryAdded

Emitted when a log entry is added. This will only be emitted for discrete series, not for resampled entries

Parameters:

Field Type Notes
logEntry LogEntry

Rules

Rules.RuleActiveChanged

Emitted whenever the active state of a Rule changed.

Parameters:

Field Type Notes
active Bool
ruleId Uuid

Rules.RuleAdded

Emitted whenever a Rule was added.

Parameters:

Field Type Notes
rule Rule

Rules.RuleConfigurationChanged

Emitted whenever the configuration of a Rule changed.

Parameters:

Field Type Notes
rule Rule

Rules.RuleRemoved

Emitted whenever a Rule was removed.

Parameters:

Field Type Notes
ruleId Uuid

Scripts

Scripts.ScriptAdded

Emitted when a script has been added to the system.

Parameters:

Field Type Notes
script Script

Scripts.ScriptChanged

Emitted when a script has been changed in the system (e.g. renamed).

Parameters:

Field Type Notes
name String
scriptId Uuid

Scripts.ScriptContentChanged

Emitted when a script's content has been changed in the system.

Parameters:

Field Type Notes
scriptId Uuid

Scripts.ScriptLogMessage

Emitted when a script produces a console message.

Parameters:

Field Type Notes
message String
scriptId Uuid
type ScriptMessageType

Scripts.ScriptRemoved

Emitted when a script has been removed from the system.

Parameters:

Field Type Notes
id Uuid

Tags

Tags.TagAdded

Emitted whenever a tag is added to the system.

Parameters:

Field Type Notes
tag Tag

Tags.TagRemoved

Emitted whenever a tag is removed from the system.

Parameters:

Field Type Notes
tag Tag

Tags.TagValueChanged

Emitted whenever a tag's value is changed in the system.

Parameters:

Field Type Notes
tag Tag

Configuration

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[]

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

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

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

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

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

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

Configuration.WebSocketServerConfigurationRemoved

Emitted whenever a WebSocket server configuration is removed.

Parameters:

Field Type Notes
id String

Debug

Debug.LoggingCategoryLevelChanged

Emitted whenever a logging category has changed the logging level.

Parameters:

Field Type Notes
level LoggingLevel
name String

ModbusRtu

ModbusRtu.ModbusRtuMasterAdded

Emitted whenever a new modbus RTU master has been added to the system.

Parameters:

Field Type Notes
modbusRtuMaster ModbusRtuMaster

ModbusRtu.ModbusRtuMasterChanged

Emitted whenever a modbus RTU master has been changed in the system.

Parameters:

Field Type Notes
modbusRtuMaster ModbusRtuMaster

ModbusRtu.ModbusRtuMasterRemoved

Emitted whenever a modbus RTU master has been removed from the system.

Parameters:

Field Type Notes
modbusUuid Uuid

ModbusRtu.SerialPortAdded

Emitted whenever a serial port has been added to the system.

Parameters:

Field Type Notes
serialPort SerialPort

ModbusRtu.SerialPortRemoved

Emitted whenever a serial port has been removed from the system.

Parameters:

Field Type Notes
serialPort SerialPort

NetworkManager

NetworkManager.NetworkStatusChanged

Emitted whenever a status of a NetworkManager changes.

Parameters:

Field Type Notes
status {'networkingEnabled': 'Bool', 'state': '$ref:NetworkManagerState', 'wirelessNetworkingEnabled': 'Bool'}

NetworkManager.WiredNetworkDeviceAdded

Emitted whenever a new WiredNetworkDevice was added.

Parameters:

Field Type Notes
wiredNetworkDevice WiredNetworkDevice

NetworkManager.WiredNetworkDeviceChanged

Emitted whenever the given WiredNetworkDevice has changed.

Parameters:

Field Type Notes
wiredNetworkDevice WiredNetworkDevice

NetworkManager.WiredNetworkDeviceRemoved

Emitted whenever a WiredNetworkDevice was removed.

Parameters:

Field Type Notes
interface String

NetworkManager.WirelessNetworkDeviceAdded

Emitted whenever a new WirelessNetworkDevice was added.

Parameters:

Field Type Notes
wirelessNetworkDevice WirelessNetworkDevice

NetworkManager.WirelessNetworkDeviceChanged

Emitted whenever the given WirelessNetworkDevice has changed.

Parameters:

Field Type Notes
wirelessNetworkDevice WirelessNetworkDevice

NetworkManager.WirelessNetworkDeviceRemoved

Emitted whenever a WirelessNetworkDevice was removed.

Parameters:

Field Type Notes
interface String

System

System.CapabilitiesChanged

Emitted whenever the system capabilities change.

Parameters:

Field Type Notes
powerManagement Bool
updateManagement Bool
updateManagementType UpdateType

System.PackageAdded

Emitted whenever a package is added to the list of packages.

Parameters:

Field Type Notes
package Package

System.PackageChanged

Emitted whenever a package in the list of packages changes.

Parameters:

Field Type Notes
package Package

System.PackageRemoved

Emitted whenever a package is removed from the list of packages.

Parameters:

Field Type Notes
packageId String

System.RepositoryAdded

Emitted whenever a repository is added to the list of repositories.

Parameters:

Field Type Notes
repository Repository

System.RepositoryChanged

Emitted whenever a repository in the list of repositories changes.

Parameters:

Field Type Notes
repository Repository

System.RepositoryRemoved

Emitted whenever a repository is removed from the list of repositories.

Parameters:

Field Type Notes
repositoryId String

System.TimeConfigurationChanged

Emitted whenever the time configuration is changed

Parameters:

Field Type Notes
automaticTime Bool
automaticTimeAvailable Bool
time Uint
timeZone String

System.UpdateStatusChanged

Emitted whenever the update status changes.

Parameters:

Field Type Notes
busy Bool
updateProgress Int optional
updateRunning Bool

Transfers

Transfers.DownloadAvailable

Emitted when a completed upload can be downloaded on the dedicated transfer connection.

Parameters:

Field Type Notes
downloadId String
fileName String
size Int

Users

Users.PushButtonAuthFinished

Emitted when a push button authentication reaches final state. NOTE: This notification is special. It will only be emitted to connections that did actively request a push button authentication, but also it will be emitted regardless of the notification settings.

Parameters:

Field Type Notes
token String optional
success Bool
transactionId Int

Users.UserAdded

Emitted when a user is added to the system.

Parameters:

Field Type Notes
userInfo UserInfo

Users.UserChanged

Emitted whenever a user is changed.

Parameters:

Field Type Notes
userInfo UserInfo

Users.UserRemoved

Emitted when a user is removed from the system.

Parameters:

Field Type Notes
username String

ZWave

ZWave.NetworkAdded

Emitted whenever a new Z-Wave network has been added to the system.

Parameters:

Field Type Notes
network ZWaveNetwork

ZWave.NetworkChanged

Emitted whenever a Z-Wave network changes.

Parameters:

Field Type Notes
network ZWaveNetwork

ZWave.NetworkRemoved

Emitted whenever a Z-Wave network has been removed from the system.

Parameters:

Field Type Notes
networkUuid Uuid

ZWave.NodeAdded

Emitted whenever a Z-Wave node is added.

Parameters:

Field Type Notes
networkUuid Uuid
node ZWaveNode

ZWave.NodeChanged

Emitted whenever a Z-Wave node has changed.

Parameters:

Field Type Notes
networkUuid Uuid
node ZWaveNode

ZWave.NodeRemoved

Emitted whenever a Z-Wave node is removed.

Parameters:

Field Type Notes
networkUuid Uuid
nodeId Uint

Zigbee

Zigbee.AdapterAdded

Emitted whenever a new ZigBee adapter or serial port has been detected in the system.

Parameters:

Field Type Notes
adapter ZigbeeAdapter

Zigbee.AdapterRemoved

Emitted whenever a ZigBee adapter or serial port has been removed from the system (i.e. unplugged).

Parameters:

Field Type Notes
adapter ZigbeeAdapter

Zigbee.NetworkAdded

Emitted whenever a new ZigBee network has been added.

Parameters:

Field Type Notes
zigbeeNetwork ZigbeeNetwork

Zigbee.NetworkChanged

Emitted whenever a new ZigBee network has changed.

Parameters:

Field Type Notes
zigbeeNetwork ZigbeeNetwork

Zigbee.NetworkRemoved

Emitted whenever a new ZigBee network has been removed.

Parameters:

Field Type Notes
networkUuid Uuid

Zigbee.NodeAdded

Emitted whenever a new ZigBee node has joined the network with the given 'networkUuid'.

Parameters:

Field Type Notes
networkUuid Uuid
zigbeeNode ZigbeeNode

Zigbee.NodeChanged

Emitted whenever a ZigBee node has changed.

Parameters:

Field Type Notes
networkUuid Uuid
zigbeeNode ZigbeeNode

Zigbee.NodeRemoved

Emitted whenever a ZigBee node has removed from the network with the given 'networkUuid'.

Parameters:

Field Type Notes
networkUuid Uuid
zigbeeNode ZigbeeNode