API Namespaces#
The API is organised into the following namespaces.
AppData#
Methods: AppData.Load, AppData.Store
Notifications: AppData.Changed
Configuration#
Methods: Configuration.CreateAndDownloadBackup, Configuration.CreateBackup, Configuration.DeleteBackupFile, Configuration.DeleteMqttPolicy, Configuration.DeleteMqttServerConfiguration, Configuration.DeleteTcpServerConfiguration, Configuration.DeleteTunnelProxyServerConfiguration, Configuration.DeleteWebServerConfiguration, Configuration.DeleteWebSocketServerConfiguration, Configuration.DownloadBackupFile, Configuration.GetAvailableLanguages, Configuration.GetBackupFiles, Configuration.GetConfigurations, Configuration.GetMqttPolicies, Configuration.GetMqttServerConfigurations, Configuration.GetTimeZones, Configuration.RestoreBackupFile, Configuration.SetBackupConfiguration, Configuration.SetDebugServerEnabled, Configuration.SetLanguage, Configuration.SetLocation, Configuration.SetMqttPolicy, Configuration.SetMqttServerConfiguration, Configuration.SetServerName, Configuration.SetTcpServerConfiguration, Configuration.SetTimeZone, Configuration.SetTunnelProxyServerConfiguration, Configuration.SetWebServerConfiguration, Configuration.SetWebSocketServerConfiguration, Configuration.UploadAndRestoreBackup
Notifications: Configuration.BackupConfigurationChanged, Configuration.BackupFilesChanged, Configuration.BasicConfigurationChanged, Configuration.MqttPolicyChanged, Configuration.MqttPolicyRemoved, Configuration.MqttServerConfigurationChanged, Configuration.MqttServerConfigurationRemoved, Configuration.TcpServerConfigurationChanged, Configuration.TcpServerConfigurationRemoved, Configuration.TunnelProxyServerConfigurationChanged, Configuration.TunnelProxyServerConfigurationRemoved, Configuration.WebServerConfigurationChanged, Configuration.WebServerConfigurationRemoved, Configuration.WebSocketServerConfigurationChanged, Configuration.WebSocketServerConfigurationRemoved
Debug#
Methods: Debug.GetLoggingCategories, Debug.SetLoggingCategoryLevel
Notifications: Debug.LoggingCategoryLevelChanged
Integrations#
Methods: Integrations.AddThing, Integrations.BrowseThing, Integrations.ConfirmPairing, Integrations.ConnectIO, Integrations.DisconnectIO, Integrations.DiscoverThings, Integrations.EditThing, Integrations.ExecuteAction, Integrations.ExecuteBrowserItem, Integrations.ExecuteBrowserItemAction, Integrations.GetActionTypes, Integrations.GetBrowserItem, Integrations.GetEventTypes, Integrations.GetIOConnections, Integrations.GetPluginConfiguration, Integrations.GetPlugins, Integrations.GetStateTypes, Integrations.GetStateValue, Integrations.GetStateValues, Integrations.GetThingClasses, Integrations.GetThings, Integrations.GetVendors, Integrations.PairThing, Integrations.ReconfigureThing, Integrations.RemoveThing, Integrations.SetActionLogging, Integrations.SetEventLogging, Integrations.SetPluginConfiguration, Integrations.SetStateFilter, Integrations.SetStateLogging, Integrations.SetThingSettings
Notifications: Integrations.EventTriggered, Integrations.IOConnectionAdded, Integrations.IOConnectionRemoved, Integrations.PluginConfigurationChanged, Integrations.StateChanged, Integrations.ThingAdded, Integrations.ThingChanged, Integrations.ThingRemoved, Integrations.ThingSettingChanged
JSONRPC#
Methods: JSONRPC.Authenticate, JSONRPC.CreateUser, JSONRPC.Hello, JSONRPC.Introspect, JSONRPC.KeepAlive, JSONRPC.RequestPushButtonAuth, JSONRPC.SetNotificationStatus, JSONRPC.Version
Notifications: JSONRPC.PushButtonAuthFinished
Logging#
Methods: Logging.GetLogEntries
Notifications: Logging.LogEntryAdded
ModbusRtu#
Methods: ModbusRtu.AddModbusRtuMaster, ModbusRtu.GetModbusRtuMasters, ModbusRtu.GetSerialPorts, ModbusRtu.ReconfigureModbusRtuMaster, ModbusRtu.RemoveModbusRtuMaster
Notifications: ModbusRtu.ModbusRtuMasterAdded, ModbusRtu.ModbusRtuMasterChanged, ModbusRtu.ModbusRtuMasterRemoved, ModbusRtu.SerialPortAdded, ModbusRtu.SerialPortRemoved
NetworkManager#
Methods: NetworkManager.ConnectWifiNetwork, NetworkManager.CreateWiredConnection, NetworkManager.DisconnectInterface, NetworkManager.EnableNetworking, NetworkManager.EnableWirelessNetworking, NetworkManager.GetNetworkDevices, NetworkManager.GetNetworkStatus, NetworkManager.GetWirelessAccessPoints, NetworkManager.ScanWifiNetworks, NetworkManager.StartAccessPoint
Notifications: NetworkManager.NetworkStatusChanged, NetworkManager.WiredNetworkDeviceAdded, NetworkManager.WiredNetworkDeviceChanged, NetworkManager.WiredNetworkDeviceRemoved, NetworkManager.WirelessNetworkDeviceAdded, NetworkManager.WirelessNetworkDeviceChanged, NetworkManager.WirelessNetworkDeviceRemoved
Rules#
Methods: Rules.AddRule, Rules.DisableRule, Rules.EditRule, Rules.EnableRule, Rules.ExecuteActions, Rules.ExecuteExitActions, Rules.FindRules, Rules.GetRuleDetails, Rules.GetRules, Rules.RemoveRule
Notifications: Rules.RuleActiveChanged, Rules.RuleAdded, Rules.RuleConfigurationChanged, Rules.RuleRemoved
Scripts#
Methods: Scripts.AddScript, Scripts.EditScript, Scripts.GetScriptContent, Scripts.GetScripts, Scripts.RemoveScript
Notifications: Scripts.ScriptAdded, Scripts.ScriptChanged, Scripts.ScriptContentChanged, Scripts.ScriptLogMessage, Scripts.ScriptRemoved
System#
Methods: System.CheckForUpdates, System.EnableRepository, System.FactoryReset, System.GetCapabilities, System.GetPackages, System.GetRepositories, System.GetSystemInfo, System.GetTime, System.GetTimeZones, System.GetUpdateStatus, System.Reboot, System.RemovePackages, System.Restart, System.RollbackPackages, System.SetTime, System.Shutdown, System.UpdatePackages
Notifications: System.CapabilitiesChanged, System.PackageAdded, System.PackageChanged, System.PackageRemoved, System.RepositoryAdded, System.RepositoryChanged, System.RepositoryRemoved, System.TimeConfigurationChanged, System.UpdateStatusChanged
Transfers#
Methods: Transfers.CreateUpload, Transfers.StartDownload
Notifications: Transfers.DownloadAvailable
Users#
Methods: Users.ChangePassword, Users.ChangeUserPassword, Users.CreateUser, Users.GetTokens, Users.GetUserInfo, Users.GetUserTokens, Users.GetUsers, Users.RemoveToken, Users.RemoveUser, Users.SetUserInfo, Users.SetUserScopes
Notifications: Users.PushButtonAuthFinished, Users.UserAdded, Users.UserChanged, Users.UserRemoved
ZWave#
Methods: ZWave.AddNetwork, ZWave.AddNode, ZWave.CancelPendingOperation, ZWave.FactoryResetNetwork, ZWave.GetNetworks, ZWave.GetNodes, ZWave.GetSerialPorts, ZWave.IsZWaveAvailable, ZWave.RemoveFailedNode, ZWave.RemoveNetwork, ZWave.RemoveNode
Notifications: ZWave.NetworkAdded, ZWave.NetworkChanged, ZWave.NetworkRemoved, ZWave.NodeAdded, ZWave.NodeChanged, ZWave.NodeRemoved
Zigbee#
Methods: Zigbee.AddNetwork, Zigbee.CreateBinding, Zigbee.FactoryResetNetwork, Zigbee.GetAdapters, Zigbee.GetAvailableBackends, Zigbee.GetNetworks, Zigbee.GetNodes, Zigbee.RefreshBindings, Zigbee.RefreshNeighborTables, Zigbee.RemoveBinding, Zigbee.RemoveNetwork, Zigbee.RemoveNode, Zigbee.SetPermitJoin
Notifications: Zigbee.AdapterAdded, Zigbee.AdapterRemoved, Zigbee.NetworkAdded, Zigbee.NetworkChanged, Zigbee.NetworkRemoved, Zigbee.NodeAdded, Zigbee.NodeChanged, Zigbee.NodeRemoved