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 6214be9548
All checks were successful
Build & Deploy docs / build-deploy (push) Successful in 3m33s
Details
api : référence régénérée depuis une box 1.15.2 (namespace NymeaEnergy) 
introspect.json relevé sur une box nymea 1.15.2 avec le moteur ETM 1.15.2+etm70 :
34 méthodes NymeaEnergy.* apparaissent, rangées dans la partie métier.
EvDash disparaît : ce plugin n'est pas installé sur nos box.
GetOptimizerProtocol (protocole 1.1) manque encore : la box porte un moteur
antérieur ; il viendra au prochain relevé.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01Ry3vBrJT1tHdxAaXdCWi6L
2026-10-19 06:41:39 +02:00

1336 lines
26 KiB
Markdown
Raw Permalink Blame History

# Notifications
<!-- BEGIN GENERATED: __api_notifications__ -->
## AirConditioning
### AirConditioning.ZoneAdded
Emitted whenever a zone is added
**Parameters:**
| Field | Type | Notes |
| --- | --- | --- |
| `zone` | [ZoneInfo](types.md#zoneinfo) | |
---
### AirConditioning.ZoneChanged
Emitted whenever a zone changes
**Parameters:**
| Field | Type | Notes |
| --- | --- | --- |
| `zone` | [ZoneInfo](types.md#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](types.md#powerbalancelogentry) | |
| `sampleRate` | [SampleRate](types.md#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](types.md#samplerate) | |
| `thingPowerLogEntry` | [ThingPowerLogEntry](types.md#thingpowerlogentry) | |
---
## Integrations
### Integrations.EventTriggered
Emitted whenever an Event is triggered.
**Parameters:**
| Field | Type | Notes |
| --- | --- | --- |
| `event` | [Event](types.md#event) | |
---
### Integrations.IOConnectionAdded
Emitted whenever an IO connection has been added.
**Parameters:**
| Field | Type | Notes |
| --- | --- | --- |
| `ioConnection` | [IOConnection](types.md#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](types.md#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](types.md#thing) | |
---
### Integrations.ThingChanged
Emitted whenever the params or name of a thing are changed (by EditThing or ReconfigureThing).
**Parameters:**
| Field | Type | Notes |
| --- | --- | --- |
| `thing` | [Thing](types.md#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](types.md#logentry) | |
---
## NymeaEnergy
### NymeaEnergy.AcquisitionToleranceChanged
Emitted whenever the acquisition tolerance changes.
**Parameters:**
| Field | Type | Notes |
| --- | --- | --- |
| `acquisitionTolerance` | `Double` | |
---
### NymeaEnergy.BatteryLevelConsiderationChanged
Emitted whenever the battery level consideration changes.
**Parameters:**
| Field | Type | Notes |
| --- | --- | --- |
| `batteryLevelConsideration` | `Double` | |
---
### NymeaEnergy.ChargingInfoAdded
Emitted whenever a charging info is added.
**Parameters:**
| Field | Type | Notes |
| --- | --- | --- |
| `chargingInfo` | [ChargingInfo](types.md#charginginfo) | |
---
### NymeaEnergy.ChargingInfoChanged
Emitted whenever a charging info changes.
**Parameters:**
| Field | Type | Notes |
| --- | --- | --- |
| `chargingInfo` | [ChargingInfo](types.md#charginginfo) | |
---
### NymeaEnergy.ChargingInfoRemoved
Emitted whenever a charging info is removed.
**Parameters:**
| Field | Type | Notes |
| --- | --- | --- |
| `evChargerThingId` | `Uuid` | |
---
### NymeaEnergy.ChargingSchedulesChanged
Emitted whenever the planed charging schedules have changed.
**Parameters:**
| Field | Type | Notes |
| --- | --- | --- |
| `chargingSchedules` | [ChargingSchedule](types.md#chargingschedule)[] | |
| `degradedMode` | `Bool` | optional |
---
### NymeaEnergy.EnergyRatiosChanged
Emitted whenever the energy ratios (self-consumption / autonomy) change. A rate field is omitted (never null) when not available.
**Parameters:**
| Field | Type | Notes |
| --- | --- | --- |
| `measuredSince` | `Uint` | |
| `autonomyRate` | `Double` | optional |
| `selfConsumptionRate` | `Double` | optional |
| `periodStartedAt` | `Uint` | |
| `timeZone` | `String` | |
---
### NymeaEnergy.LoadConfigChanged
Emitted whenever the controllable load configuration changed.
**Parameters:**
| Field | Type | Notes |
| --- | --- | --- |
| `loadConfigs` | [LoadConfig](types.md#loadconfig)[] | |
---
### NymeaEnergy.LoadTelemetryChanged
Emitted whenever the arbitration runtime state changed significantly, and periodically (heartbeat) even when unchanged, so that a frozen arbitrator is detectable by a timestamp that stops advancing. Same payload as GetLoadTelemetry.
**Parameters:**
| Field | Type | Notes |
| --- | --- | --- |
| `degradedMode` | `Bool` | |
| `loads` | `{'allocatedW': 'Double', 'available': 'Bool', 'decision': {'code': 'String', 'o:level': 'String', 'params': 'Variant'}, 'levels': [{'counts': 'Variant', 'funding': 'String', 'level': 'String', 'targetW': 'Double'}], 'loadId': 'String', 'o:faultCode': 'String', 'o:lock': {'kind': 'String', 'remainingS': 'Int'}, 'o:measurement': {'o:powerW': 'Double', 'source': 'String'}, 'o:mechanism': {'kind': 'String', 'o:chargingEnabled': 'Bool', 'o:currentA': 'Double', 'o:estimatedPowerW': 'Double', 'o:maxPowerW': 'Double', 'o:maxStageW': 'Double', 'o:minPowerW': 'Double', 'o:percent': 'Double', 'o:phaseCount': 'Uint', 'o:pluggedIn': 'Bool', 'o:setpointW': 'Double', 'o:stageW': 'Double', 'o:stagesW': ['Double'], 'o:state': 'Int'}, 'o:temperatureC': 'Double'}`[] | |
| `budget` | `{'allocatedW': 'Double', 'evReservedW': 'Double', 'recreditedW': 'Double', 'remainingW': 'Double', 'surplusW': 'Double'}` | optional |
| `derogationEnded` | `{'cause': 'String', 'loadId': 'String', 'o:restoredMode': 'Int'}`[] | optional |
| `draw` | `{'committedW': 'Double'}` | optional |
| `timestamp` | `String` | optional |
---
### NymeaEnergy.LockOnUnplugChanged
Emitted whenever the lock on unplug setting changes.
**Parameters:**
| Field | Type | Notes |
| --- | --- | --- |
| `lockOnUnplug` | `Bool` | |
---
### NymeaEnergy.OptimizerStatusChanged
Emitted at each transition of the optimizer fallback machine: optimizerExpected, optimizerAlive or activeStrategy changed. Not emitted every cycle. Same payload as GetOptimizerStatus.
**Parameters:**
| Field | Type | Notes |
| --- | --- | --- |
| `activeStrategy` | `String` | |
| `capabilities` | `{'o:kinds': ['String'], 'o:maxHorizonH': 'Double', 'o:reasonCodes': 'Bool', 'o:resolutionS': 'Double', 'o:usesForecast': ['String']}` | optional |
| `consecutiveFailures` | `Int` | optional |
| `lastErrorCode` | `String` | optional |
| `lastPlanAt` | `String` | optional |
| `name` | `String` | optional |
| `protocolVersion` | `String` | optional |
| `optimizerAlive` | `Bool` | |
| `optimizerExpected` | `Bool` | |
| `tokenConfigured` | `Bool` | |
---
### NymeaEnergy.PhasePowerLimitChanged
Emitted whenever the phase power limit configuration changes.
**Parameters:**
| Field | Type | Notes |
| --- | --- | --- |
| `phasePowerLimit` | `Uint` | |
---
### NymeaEnergy.SpotMarketConfigurationChanged
Emitted whenever a spot market configuration has changed.
**Parameters:**
| Field | Type | Notes |
| --- | --- | --- |
| `available` | `Bool` | |
| `enabled` | `Bool` | |
| `providerId` | `Uuid` | optional |
---
### NymeaEnergy.SpotMarketScoreEntriesChanged
Emitted whenever the score entries of the current spot market provider changed. The weighting of the available score entries goes from 0 (worst) to 1.0 (best).
**Parameters:**
| Field | Type | Notes |
| --- | --- | --- |
| `spotMarketScoreEntries` | [ScoreEntry](types.md#scoreentry)[] | |
---
### NymeaEnergy.SpotMarketStatusChanged
Emitted whenever the spot market manager status changed.
**Parameters:**
| Field | Type | Notes |
| --- | --- | --- |
| `available` | `Bool` | |
| `enabled` | `Bool` | |
---
## 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](types.md#rule) | |
---
### Rules.RuleConfigurationChanged
Emitted whenever the configuration of a Rule changed.
**Parameters:**
| Field | Type | Notes |
| --- | --- | --- |
| `rule` | [Rule](types.md#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](types.md#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](types.md#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](types.md#tag) | |
---
### Tags.TagRemoved
Emitted whenever a tag is removed from the system.
**Parameters:**
| Field | Type | Notes |
| --- | --- | --- |
| `tag` | [Tag](types.md#tag) | |
---
### Tags.TagValueChanged
Emitted whenever a tag's value is changed in the system.
**Parameters:**
| Field | Type | Notes |
| --- | --- | --- |
| `tag` | [Tag](types.md#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](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` | |
---
## Debug
### Debug.LoggingCategoryLevelChanged
Emitted whenever a logging category has changed the logging level.
**Parameters:**
| Field | Type | Notes |
| --- | --- | --- |
| `level` | [LoggingLevel](types.md#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](types.md#modbusrtumaster) | |
---
### ModbusRtu.ModbusRtuMasterChanged
Emitted whenever a modbus RTU master has been changed in the system.
**Parameters:**
| Field | Type | Notes |
| --- | --- | --- |
| `modbusRtuMaster` | [ModbusRtuMaster](types.md#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](types.md#serialport) | |
---
### ModbusRtu.SerialPortRemoved
Emitted whenever a serial port has been removed from the system.
**Parameters:**
| Field | Type | Notes |
| --- | --- | --- |
| `serialPort` | [SerialPort](types.md#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](types.md#wirednetworkdevice) | |
---
### NetworkManager.WiredNetworkDeviceChanged
Emitted whenever the given WiredNetworkDevice has changed.
**Parameters:**
| Field | Type | Notes |
| --- | --- | --- |
| `wiredNetworkDevice` | [WiredNetworkDevice](types.md#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](types.md#wirelessnetworkdevice) | |
---
### NetworkManager.WirelessNetworkDeviceChanged
Emitted whenever the given WirelessNetworkDevice has changed.
**Parameters:**
| Field | Type | Notes |
| --- | --- | --- |
| `wirelessNetworkDevice` | [WirelessNetworkDevice](types.md#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](types.md#updatetype) | |
---
### System.PackageAdded
Emitted whenever a package is added to the list of packages.
**Parameters:**
| Field | Type | Notes |
| --- | --- | --- |
| `package` | [Package](types.md#package) | |
---
### System.PackageChanged
Emitted whenever a package in the list of packages changes.
**Parameters:**
| Field | Type | Notes |
| --- | --- | --- |
| `package` | [Package](types.md#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](types.md#repository) | |
---
### System.RepositoryChanged
Emitted whenever a repository in the list of repositories changes.
**Parameters:**
| Field | Type | Notes |
| --- | --- | --- |
| `repository` | [Repository](types.md#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](types.md#userinfo) | |
---
### Users.UserChanged
Emitted whenever a user is changed.
**Parameters:**
| Field | Type | Notes |
| --- | --- | --- |
| `userInfo` | [UserInfo](types.md#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](types.md#zwavenetwork) | |
---
### ZWave.NetworkChanged
Emitted whenever a Z-Wave network changes.
**Parameters:**
| Field | Type | Notes |
| --- | --- | --- |
| `network` | [ZWaveNetwork](types.md#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](types.md#zwavenode) | |
---
### ZWave.NodeChanged
Emitted whenever a Z-Wave node has changed.
**Parameters:**
| Field | Type | Notes |
| --- | --- | --- |
| `networkUuid` | `Uuid` | |
| `node` | [ZWaveNode](types.md#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](types.md#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](types.md#zigbeeadapter) | |
---
### Zigbee.NetworkAdded
Emitted whenever a new ZigBee network has been added.
**Parameters:**
| Field | Type | Notes |
| --- | --- | --- |
| `zigbeeNetwork` | [ZigbeeNetwork](types.md#zigbeenetwork) | |
---
### Zigbee.NetworkChanged
Emitted whenever a new ZigBee network has changed.
**Parameters:**
| Field | Type | Notes |
| --- | --- | --- |
| `zigbeeNetwork` | [ZigbeeNetwork](types.md#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](types.md#zigbeenode) | |
---
### Zigbee.NodeChanged
Emitted whenever a ZigBee node has changed.
**Parameters:**
| Field | 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'.
**Parameters:**
| Field | Type | Notes |
| --- | --- | --- |
| `networkUuid` | `Uuid` | |
| `zigbeeNode` | [ZigbeeNode](types.md#zigbeenode) | |
---
<!-- END GENERATED -->
Reference in New Issue View Git Blame Copy Permalink