Notifications¶

AirConditioning¶

AirConditioning.ZoneAdded¶

Emitted whenever a zone is added

Paramètres :

Champ	Type	Notes
`zone`	ZoneInfo

AirConditioning.ZoneChanged¶

Emitted whenever a zone changes

Paramètres :

Champ	Type	Notes
`zone`	ZoneInfo

AirConditioning.ZoneRemoved¶

Emitted whenever a zone is removed

Paramètres :

Champ	Type	Notes
`zoneId`	`Uuid`

AppData¶

AppData.Changed¶

Emitted whenever the app data is changed on the server.

Paramètres :

Champ	Type	Notes
`appId`	`String`
`key`	`String`
`group`	`String`	optionnel
`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.

Paramètres :

Champ	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.

Paramètres :

Champ	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.

Paramètres :

Champ	Type	Notes
`rootMeterThingId`	`Uuid`	optionnel

Energy.ThingPowerLogEntryAdded¶

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

Paramètres :

Champ	Type	Notes
`sampleRate`	SampleRate
`thingPowerLogEntry`	ThingPowerLogEntry

EvDash¶

EvDash.EnabledChanged¶

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

Paramètres :

Champ	Type	Notes
`enabled`	`Bool`

EvDash.UserAdded¶

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

Paramètres :

Champ	Type	Notes
`username`	`String`

EvDash.UserRemoved¶

Emitted whenever a username has been removed from the dashboard.

Paramètres :

Champ	Type	Notes
`username`	`String`

Integrations¶

Integrations.EventTriggered¶

Emitted whenever an Event is triggered.

Paramètres :

Champ	Type	Notes
`event`	Event

Integrations.IOConnectionAdded¶

Emitted whenever an IO connection has been added.

Paramètres :

Champ	Type	Notes
`ioConnection`	IOConnection

Integrations.IOConnectionRemoved¶

Emitted whenever an IO connection has been removed.

Paramètres :

Champ	Type	Notes
`ioConnectionId`	`Uuid`

Integrations.PluginConfigurationChanged¶

Emitted whenever a plugin's configuration is changed.

Paramètres :

Champ	Type	Notes
`configuration`	ParamList
`pluginId`	`Uuid`

Integrations.StateChanged¶

Emitted whenever a state of a thing changes.

Paramètres :

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

Integrations.ThingAdded¶

Emitted whenever a thing was added.

Paramètres :

Champ	Type	Notes
`thing`	Thing

Integrations.ThingChanged¶

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

Paramètres :

Champ	Type	Notes
`thing`	Thing

Integrations.ThingRemoved¶

Emitted whenever a thing was removed.

Paramètres :

Champ	Type	Notes
`thingId`	`Uuid`

Integrations.ThingSettingChanged¶

Emitted whenever the setting of a thing is changed.

Paramètres :

Champ	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.

Paramètres :

Champ	Type	Notes
`token`	`String`	optionnel
`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

Paramètres :

Champ	Type	Notes
`logEntry`	LogEntry

Rules¶

Rules.RuleActiveChanged¶

Emitted whenever the active state of a Rule changed.

Paramètres :

Champ	Type	Notes
`active`	`Bool`
`ruleId`	`Uuid`

Rules.RuleAdded¶

Emitted whenever a Rule was added.

Paramètres :

Champ	Type	Notes
`rule`	Rule

Rules.RuleConfigurationChanged¶

Emitted whenever the configuration of a Rule changed.

Paramètres :

Champ	Type	Notes
`rule`	Rule

Rules.RuleRemoved¶

Emitted whenever a Rule was removed.

Paramètres :

Champ	Type	Notes
`ruleId`	`Uuid`

Scripts¶

Scripts.ScriptAdded¶

Emitted when a script has been added to the system.

Paramètres :

Champ	Type	Notes
`script`	Script

Scripts.ScriptChanged¶

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

Paramètres :

Champ	Type	Notes
`name`	`String`
`scriptId`	`Uuid`

Scripts.ScriptContentChanged¶

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

Paramètres :

Champ	Type	Notes
`scriptId`	`Uuid`

Scripts.ScriptLogMessage¶

Emitted when a script produces a console message.

Paramètres :

Champ	Type	Notes
`message`	`String`
`scriptId`	`Uuid`
`type`	ScriptMessageType

Scripts.ScriptRemoved¶

Emitted when a script has been removed from the system.

Paramètres :

Champ	Type	Notes
`id`	`Uuid`

Tags¶

Tags.TagAdded¶

Emitted whenever a tag is added to the system.

Paramètres :

Champ	Type	Notes
`tag`	Tag

Tags.TagRemoved¶

Emitted whenever a tag is removed from the system.

Paramètres :

Champ	Type	Notes
`tag`	Tag

Tags.TagValueChanged¶

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

Paramètres :

Champ	Type	Notes
`tag`	Tag

Configuration¶

Configuration.BackupConfigurationChanged¶

Emitted whenever the backup configuration changes.

Paramètres :

Champ	Type	Notes
`autoBackupEnabled`	`Bool`
`autoBackupInterval`	`Int`
`destinationDirectory`	`String`
`maxCount`	`Uint`

Configuration.BackupFilesChanged¶

Emitted whenever the list of backup files changes.

Paramètres :

Champ	Type	Notes
`backupFiles`	BackupFile[]

Configuration.BasicConfigurationChanged¶

Emitted whenever the basic configuration of this server changes.

Paramètres :

Champ	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.

Paramètres :

Champ	Type	Notes
`policy`	MqttPolicy

Configuration.MqttPolicyRemoved¶

Emitted whenever a MQTT broker policy is removed.

Paramètres :

Champ	Type	Notes
`clientId`	`String`

Configuration.MqttServerConfigurationChanged¶

Emitted whenever the MQTT broker configuration is changed.

Paramètres :

Champ	Type	Notes
`mqttServerConfiguration`	ServerConfiguration

Configuration.MqttServerConfigurationRemoved¶

Emitted whenever a MQTT server configuration is removed.

Paramètres :

Champ	Type	Notes
`id`	`String`

Configuration.TcpServerConfigurationChanged¶

Emitted whenever the TCP server configuration changes.

Paramètres :

Champ	Type	Notes
`tcpServerConfiguration`	ServerConfiguration

Configuration.TcpServerConfigurationRemoved¶

Emitted whenever a TCP server configuration is removed.

Paramètres :

Champ	Type	Notes
`id`	`String`

Configuration.TunnelProxyServerConfigurationChanged¶

Emitted whenever the tunnel proxy server configuration changes.

Paramètres :

Champ	Type	Notes
`tunnelProxyServerConfiguration`	TunnelProxyServerConfiguration

Configuration.TunnelProxyServerConfigurationRemoved¶

Emitted whenever a tunnel proxy server configuration is removed.

Paramètres :

Champ	Type	Notes
`id`	`String`

Configuration.WebServerConfigurationChanged¶

Emitted whenever the web server configuration changes.

Paramètres :

Champ	Type	Notes
`webServerConfiguration`	WebServerConfiguration

Configuration.WebServerConfigurationRemoved¶

Emitted whenever a Web server configuration is removed.

Paramètres :

Champ	Type	Notes
`id`	`String`

Configuration.WebSocketServerConfigurationChanged¶

Emitted whenever the web socket server configuration changes.

Paramètres :

Champ	Type	Notes
`webSocketServerConfiguration`	ServerConfiguration

Configuration.WebSocketServerConfigurationRemoved¶

Emitted whenever a WebSocket server configuration is removed.

Paramètres :

Champ	Type	Notes
`id`	`String`

Debug¶

Debug.LoggingCategoryLevelChanged¶

Emitted whenever a logging category has changed the logging level.

Paramètres :

Champ	Type	Notes
`level`	LoggingLevel
`name`	`String`

ModbusRtu¶

ModbusRtu.ModbusRtuMasterAdded¶

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

Paramètres :

Champ	Type	Notes
`modbusRtuMaster`	ModbusRtuMaster

ModbusRtu.ModbusRtuMasterChanged¶

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

Paramètres :

Champ	Type	Notes
`modbusRtuMaster`	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

ModbusRtu.SerialPortRemoved¶

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

Paramètres :

Champ	Type	Notes
`serialPort`	SerialPort

NetworkManager¶

NetworkManager.NetworkStatusChanged¶

Emitted whenever a status of a NetworkManager changes.

Paramètres :

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

NetworkManager.WiredNetworkDeviceAdded¶

Emitted whenever a new WiredNetworkDevice was added.

Paramètres :

Champ	Type	Notes
`wiredNetworkDevice`	WiredNetworkDevice

NetworkManager.WiredNetworkDeviceChanged¶

Emitted whenever the given WiredNetworkDevice has changed.

Paramètres :

Champ	Type	Notes
`wiredNetworkDevice`	WiredNetworkDevice

NetworkManager.WiredNetworkDeviceRemoved¶

Emitted whenever a WiredNetworkDevice was removed.

Paramètres :

Champ	Type	Notes
`interface`	`String`

NetworkManager.WirelessNetworkDeviceAdded¶

Emitted whenever a new WirelessNetworkDevice was added.

Paramètres :

Champ	Type	Notes
`wirelessNetworkDevice`	WirelessNetworkDevice

NetworkManager.WirelessNetworkDeviceChanged¶

Emitted whenever the given WirelessNetworkDevice has changed.

Paramètres :

Champ	Type	Notes
`wirelessNetworkDevice`	WirelessNetworkDevice

NetworkManager.WirelessNetworkDeviceRemoved¶

Emitted whenever a WirelessNetworkDevice was removed.

Paramètres :

Champ	Type	Notes
`interface`	`String`

System¶

System.CapabilitiesChanged¶

Emitted whenever the system capabilities change.

Paramètres :

Champ	Type	Notes
`powerManagement`	`Bool`
`updateManagement`	`Bool`
`updateManagementType`	UpdateType

System.PackageAdded¶

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

Paramètres :

Champ	Type	Notes
`package`	Package

System.PackageChanged¶

Emitted whenever a package in the list of packages changes.

Paramètres :

Champ	Type	Notes
`package`	Package

System.PackageRemoved¶

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

Paramètres :

Champ	Type	Notes
`packageId`	`String`

System.RepositoryAdded¶

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

Paramètres :

Champ	Type	Notes
`repository`	Repository

System.RepositoryChanged¶

Emitted whenever a repository in the list of repositories changes.

Paramètres :

Champ	Type	Notes
`repository`	Repository

System.RepositoryRemoved¶

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

Paramètres :

Champ	Type	Notes
`repositoryId`	`String`

System.TimeConfigurationChanged¶

Emitted whenever the time configuration is changed

Paramètres :

Champ	Type	Notes
`automaticTime`	`Bool`
`automaticTimeAvailable`	`Bool`
`time`	`Uint`
`timeZone`	`String`

System.UpdateStatusChanged¶

Emitted whenever the update status changes.

Paramètres :

Champ	Type	Notes
`busy`	`Bool`
`updateProgress`	`Int`	optionnel
`updateRunning`	`Bool`

Transfers¶

Transfers.DownloadAvailable¶

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

Paramètres :

Champ	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.

Paramètres :

Champ	Type	Notes
`token`	`String`	optionnel
`success`	`Bool`
`transactionId`	`Int`

Users.UserAdded¶

Emitted when a user is added to the system.

Paramètres :

Champ	Type	Notes
`userInfo`	UserInfo

Users.UserChanged¶

Emitted whenever a user is changed.

Paramètres :

Champ	Type	Notes
`userInfo`	UserInfo

Users.UserRemoved¶

Emitted when a user is removed from the system.

Paramètres :

Champ	Type	Notes
`username`	`String`

ZWave¶

ZWave.NetworkAdded¶

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

Paramètres :

Champ	Type	Notes
`network`	ZWaveNetwork

ZWave.NetworkChanged¶

Emitted whenever a Z-Wave network changes.

Paramètres :

Champ	Type	Notes
`network`	ZWaveNetwork

ZWave.NetworkRemoved¶

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

Paramètres :

Champ	Type	Notes
`networkUuid`	`Uuid`

ZWave.NodeAdded¶

Emitted whenever a Z-Wave node is added.

Paramètres :

Champ	Type	Notes
`networkUuid`	`Uuid`
`node`	ZWaveNode

ZWave.NodeChanged¶

Emitted whenever a Z-Wave node has changed.

Paramètres :

Champ	Type	Notes
`networkUuid`	`Uuid`
`node`	ZWaveNode

ZWave.NodeRemoved¶

Emitted whenever a Z-Wave node is removed.

Paramètres :

Champ	Type	Notes
`networkUuid`	`Uuid`
`nodeId`	`Uint`

Zigbee¶

Zigbee.AdapterAdded¶

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

Paramètres :

Champ	Type	Notes
`adapter`	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

Zigbee.NetworkAdded¶

Emitted whenever a new ZigBee network has been added.

Paramètres :

Champ	Type	Notes
`zigbeeNetwork`	ZigbeeNetwork

Zigbee.NetworkChanged¶

Emitted whenever a new ZigBee network has changed.

Paramètres :

Champ	Type	Notes
`zigbeeNetwork`	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

Zigbee.NodeChanged¶

Emitted whenever a ZigBee node has changed.

Paramètres :

Champ	Type	Notes
`networkUuid`	`Uuid`
`zigbeeNode`	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