0.54
{
    "methods": {
        "Actions.ExecuteAction": {
            "description": "Execute a single action.",
            "params": {
                "actionTypeId": "Uuid",
                "deviceId": "Uuid",
                "o:params": [
                    "$ref:Param"
                ]
            },
            "returns": {
                "deviceError": "$ref:DeviceError"
            }
        },
        "Actions.GetActionType": {
            "description": "Get the ActionType for the given ActionTypeId",
            "params": {
                "actionTypeId": "Uuid"
            },
            "returns": {
                "deviceError": "$ref:DeviceError",
                "o:actionType": {
                    "id": "Uuid",
                    "index": "Int",
                    "name": "Uuid",
                    "paramTypes": [
                        "$ref:ParamType"
                    ]
                }
            }
        },
        "Configuration.DeleteTcpServerConfiguration": {
            "description": "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.",
            "params": {
                "id": "String"
            },
            "returns": {
                "configurationError": "$ref:ConfigurationError"
            }
        },
        "Configuration.DeleteWebServerConfiguration": {
            "description": "Delete a WebServer interface of the server.",
            "params": {
                "id": "String"
            },
            "returns": {
                "configurationError": "$ref:ConfigurationError"
            }
        },
        "Configuration.DeleteWebSocketServerConfiguration": {
            "description": "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.",
            "params": {
                "id": "String"
            },
            "returns": {
                "configurationError": "$ref:ConfigurationError"
            }
        },
        "Configuration.GetAvailableLanguages": {
            "description": "Returns a list of locale codes available for the server. i.e. en_US, de_AT",
            "params": {
            },
            "returns": {
                "languages": [
                    "String"
                ]
            }
        },
        "Configuration.GetConfigurations": {
            "description": "Get all configuration parameters of the server.",
            "params": {
            },
            "returns": {
                "basicConfiguration": {
                    "language": "String",
                    "serverName": "String",
                    "serverTime": "Uint",
                    "serverUuid": "Uuid",
                    "timeZone": "String"
                },
                "cloud": {
                    "enabled": "Bool"
                },
                "tcpServerConfigurations": [
                    "$ref:ServerConfiguration"
                ],
                "webServerConfigurations": [
                    "$ref:WebServerConfiguration"
                ],
                "webSocketServerConfigurations": [
                    "$ref:ServerConfiguration"
                ]
            }
        },
        "Configuration.GetTimeZones": {
            "description": "Get the list of available timezones.",
            "params": {
            },
            "returns": {
                "timeZones": [
                    "String"
                ]
            }
        },
        "Configuration.SetCloudEnabled": {
            "description": "Sets whether the cloud connection is enabled or disabled in the settings.",
            "params": {
                "enabled": "Bool"
            },
            "returns": {
                "configurationError": "$ref:ConfigurationError"
            }
        },
        "Configuration.SetLanguage": {
            "description": "Sets the server language to the given language. See also: \"GetAvailableLanguages\"",
            "params": {
                "language": "String"
            },
            "returns": {
                "configurationError": "$ref:ConfigurationError"
            }
        },
        "Configuration.SetServerName": {
            "description": "Set the name of the server. Default is guhIO.",
            "params": {
                "serverName": "String"
            },
            "returns": {
                "configurationError": "$ref:ConfigurationError"
            }
        },
        "Configuration.SetTcpServerConfiguration": {
            "description": "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.",
            "params": {
                "configuration": "$ref:ServerConfiguration"
            },
            "returns": {
                "configurationError": "$ref:ConfigurationError"
            }
        },
        "Configuration.SetTimeZone": {
            "description": "Set the time zone of the server. See also: \"GetTimeZones\"",
            "params": {
                "timeZone": "String"
            },
            "returns": {
                "configurationError": "$ref:ConfigurationError"
            }
        },
        "Configuration.SetWebServerConfiguration": {
            "description": "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.",
            "params": {
                "configuration": "$ref:WebServerConfiguration"
            },
            "returns": {
                "configurationError": "$ref:ConfigurationError"
            }
        },
        "Configuration.SetWebSocketServerConfiguration": {
            "description": "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.",
            "params": {
                "configuration": "$ref:ServerConfiguration"
            },
            "returns": {
                "configurationError": "$ref:ConfigurationError"
            }
        },
        "Devices.AddConfiguredDevice": {
            "description": "Add a configured device with a setupMethod of SetupMethodJustAdd. For devices with a setupMethod different than SetupMethodJustAdd, use PairDevice. Use deviceDescriptorId or deviceParams, depending on the createMethod of the device class. CreateMethodJustAdd takes the parameters you want to have with that device. CreateMethodDiscovery requires the use of a deviceDescriptorId.",
            "params": {
                "deviceClassId": "Uuid",
                "name": "String",
                "o:deviceDescriptorId": "Uuid",
                "o:deviceParams": [
                    "$ref:Param"
                ]
            },
            "returns": {
                "deviceError": "$ref:DeviceError",
                "o:deviceId": "Uuid"
            }
        },
        "Devices.ConfirmPairing": {
            "description": "Confirm an ongoing pairing. In case of SetupMethodEnterPin also provide the pin in the params.",
            "params": {
                "o:secret": "String",
                "pairingTransactionId": "Uuid"
            },
            "returns": {
                "deviceError": "$ref:DeviceError",
                "o:deviceId": "Uuid"
            }
        },
        "Devices.EditDevice": {
            "description": "Edit the name of a device. This method does not change the configuration of the device.",
            "params": {
                "deviceId": "Uuid",
                "name": "String"
            },
            "returns": {
                "deviceError": "$ref:DeviceError"
            }
        },
        "Devices.GetActionTypes": {
            "description": "Get action types for a specified deviceClassId.",
            "params": {
                "deviceClassId": "Uuid"
            },
            "returns": {
                "actionTypes": [
                    "$ref:ActionType"
                ]
            }
        },
        "Devices.GetConfiguredDevices": {
            "description": "Returns a list of configured devices, optionally filtered by deviceId.",
            "params": {
                "o:deviceId": "Uuid"
            },
            "returns": {
                "devices": [
                    "$ref:Device"
                ]
            }
        },
        "Devices.GetDiscoveredDevices": {
            "description": "Performs a device discovery and returns the results. This function may take a while to return.",
            "params": {
                "deviceClassId": "Uuid",
                "o:discoveryParams": [
                    "$ref:Param"
                ]
            },
            "returns": {
                "deviceError": "$ref:DeviceError",
                "o:deviceDescriptors": [
                    "$ref:DeviceDescriptor"
                ]
            }
        },
        "Devices.GetEventTypes": {
            "description": "Get event types for a specified deviceClassId.",
            "params": {
                "deviceClassId": "Uuid"
            },
            "returns": {
                "eventTypes": [
                    "$ref:EventType"
                ]
            }
        },
        "Devices.GetPluginConfiguration": {
            "description": "Get a plugin's params.",
            "params": {
                "pluginId": "Uuid"
            },
            "returns": {
                "deviceError": "$ref:DeviceError",
                "o:configuration": [
                    "$ref:Param"
                ]
            }
        },
        "Devices.GetPlugins": {
            "description": "Returns a list of loaded plugins.",
            "params": {
            },
            "returns": {
                "plugins": [
                    "$ref:Plugin"
                ]
            }
        },
        "Devices.GetStateTypes": {
            "description": "Get state types for a specified deviceClassId.",
            "params": {
                "deviceClassId": "Uuid"
            },
            "returns": {
                "stateTypes": [
                    "$ref:StateType"
                ]
            }
        },
        "Devices.GetStateValue": {
            "description": "Get the value of the given device and the given stateType",
            "params": {
                "deviceId": "Uuid",
                "stateTypeId": "Uuid"
            },
            "returns": {
                "deviceError": "$ref:DeviceError",
                "o:value": "Variant"
            }
        },
        "Devices.GetStateValues": {
            "description": "Get all the state values of the given device.",
            "params": {
                "deviceId": "Uuid"
            },
            "returns": {
                "deviceError": "$ref:DeviceError",
                "o:values": [
                    {
                        "stateTypeId": "Uuid",
                        "value": "Variant"
                    }
                ]
            }
        },
        "Devices.GetSupportedDevices": {
            "description": "Returns a list of supported Device classes, optionally filtered by vendorId.",
            "params": {
                "o:vendorId": "Uuid"
            },
            "returns": {
                "deviceClasses": [
                    "$ref:DeviceClass"
                ]
            }
        },
        "Devices.GetSupportedVendors": {
            "description": "Returns a list of supported Vendors.",
            "params": {
            },
            "returns": {
                "vendors": [
                    "$ref:Vendor"
                ]
            }
        },
        "Devices.PairDevice": {
            "description": "Pair a device. Use this for DeviceClasses with a setupMethod different than SetupMethodJustAdd. Use deviceDescriptorId or deviceParams, depending on the createMethod of the device class. CreateMethodJustAdd takes the parameters you want to have with that device. CreateMethodDiscovery requires the use of a deviceDescriptorId. If success is true, the return values will contain a pairingTransactionId, a displayMessage and the setupMethod. Depending on the setupMethod you should either proceed with AddConfiguredDevice or PairDevice.",
            "params": {
                "deviceClassId": "Uuid",
                "name": "String",
                "o:deviceDescriptorId": "Uuid",
                "o:deviceParams": [
                    "$ref:Param"
                ]
            },
            "returns": {
                "deviceError": "$ref:DeviceError",
                "o:displayMessage": "String",
                "o:pairingTransactionId": "Uuid",
                "o:setupMethod": "$ref:SetupMethod"
            }
        },
        "Devices.ReconfigureDevice": {
            "description": "Edit the parameter configuration of the device. The device params will be set to the passed parameters and the setup device will be called. If the device is discoverable, you can perform a GetDiscoveredDevices before calling this method and pass the new DeviceDescriptor (rediscover). Only writable parameters can be changed. By default, every Param is writable.",
            "params": {
                "deviceId": "Uuid",
                "o:deviceDescriptorId": "Uuid",
                "o:deviceParams": [
                    "$ref:Param"
                ]
            },
            "returns": {
                "deviceError": "$ref:DeviceError"
            }
        },
        "Devices.RemoveConfiguredDevice": {
            "description": "Remove a device from the system.",
            "params": {
                "deviceId": "Uuid",
                "o:removePolicy": "$ref:RemovePolicy",
                "o:removePolicyList": [
                    {
                        "policy": "$ref:RemovePolicy",
                        "ruleId": "Uuid"
                    }
                ]
            },
            "returns": {
                "deviceError": "$ref:DeviceError",
                "o:ruleIds": [
                    "Uuid"
                ]
            }
        },
        "Devices.SetPluginConfiguration": {
            "description": "Set a plugin's params.",
            "params": {
                "configuration": [
                    "$ref:Param"
                ],
                "pluginId": "Uuid"
            },
            "returns": {
                "deviceError": "$ref:DeviceError"
            }
        },
        "Events.GetEventType": {
            "description": "Get the EventType for the given eventTypeId.",
            "params": {
                "eventTypeId": "Uuid"
            },
            "returns": {
                "deviceError": "$ref:DeviceError",
                "o:eventType": "$ref:EventType"
            }
        },
        "JSONRPC.Authenticate": {
            "description": "Authenticate a client to the api via user & password challenge. Provide a device name which allows the user to identify the client and revoke the token in case the device is lost or stolen. This will return a new token to be used to authorize a client at the API.",
            "params": {
                "deviceName": "String",
                "password": "String",
                "username": "String"
            },
            "returns": {
                "o:token": "String",
                "success": "Bool"
            }
        },
        "JSONRPC.CreateUser": {
            "description": "Create a new user in the API. Currently this is only allowed to be called once when a new guh instance is set up. Call Authenticate after this to obtain a device token for this user.",
            "params": {
                "password": "String",
                "username": "String"
            },
            "returns": {
                "error": "$ref:UserError"
            }
        },
        "JSONRPC.Hello": {
            "description": "Upon first connection, guh will automatically send a welcome message containing information about the setup. If this message is lost for whatever reason (connections with multiple hops might drop this if guh sends it too early), the exact same message can be retrieved multiple times by calling this Hello method. Note that the contents might change if the system changed its state in the meantime, e.g. initialSetupRequired might turn false if the initial setup has been performed in the meantime.",
            "params": {
            },
            "returns": {
                "authenticationRequired": "Bool",
                "id": "Int",
                "initialSetupRequired": "Bool",
                "language": "String",
                "name": "String",
                "protocol version": "String",
                "pushButtonAuthAvailable": "Bool",
                "server": "String",
                "uuid": "Uuid",
                "version": "String"
            }
        },
        "JSONRPC.Introspect": {
            "description": "Introspect this API.",
            "params": {
            },
            "returns": {
                "methods": "Object",
                "types": "Object"
            }
        },
        "JSONRPC.IsCloudConnected": {
            "description": "Check whether the cloud is currently connected.",
            "params": {
            },
            "returns": {
                "connected": "Bool"
            }
        },
        "JSONRPC.KeepAlive": {
            "description": "Keep alive a remote connection. The sessionId is the MQTT topic which has been used to establish the session. It will return false if no ongoing session with the given ID can be found.",
            "params": {
                "sessionId": "String"
            },
            "returns": {
                "success": "Bool"
            }
        },
        "JSONRPC.RemoveToken": {
            "description": "Revoke access for a given token.",
            "params": {
                "tokenId": "Uuid"
            },
            "returns": {
                "error": "$ref:UserError"
            }
        },
        "JSONRPC.RequestPushButtonAuth": {
            "description": "Authenticate a client to the api via Push Button method. Provide a device name which allows the user to identify the client and revoke the token in case the device is lost or stolen. If push button hardware is available, this will return with success and start listening for push button presses. When the push button is pressed, the PushButtonAuthFinished notification will be sent to the requesting client. The procedure will be cancelled when the connection is interrupted. If another client requests push button authentication while a procedure is still going on, the second call will take over and the first one will be notified by the PushButtonAuthFinished signal about the error. The application should make it clear to the user to not press the button when the procedure fails as this can happen for 2 reasons: a) a second user is trying to auth at the same time and only the currently active user should press the button or b) it might indicate an attacker trying to take over and snooping in for tokens.",
            "params": {
                "deviceName": "String"
            },
            "returns": {
                "success": "Bool",
                "transactionId": "Int"
            }
        },
        "JSONRPC.SetNotificationStatus": {
            "description": "Enable/Disable notifications for this connections.",
            "params": {
                "enabled": "Bool"
            },
            "returns": {
                "enabled": "Bool"
            }
        },
        "JSONRPC.SetupRemoteAccess": {
            "description": "Setup the remote connection by providing AWS token information. This requires the cloud to be connected.",
            "params": {
                "idToken": "String",
                "userId": "String"
            },
            "returns": {
                "message": "String",
                "status": "Int"
            }
        },
        "JSONRPC.Tokens": {
            "description": "Return a list of TokenInfo objects of all the tokens for the current user.",
            "params": {
            },
            "returns": {
                "tokenInfoList": [
                    "$ref:TokenInfo"
                ]
            }
        },
        "JSONRPC.Version": {
            "description": "Version of this Guh/JSONRPC interface.",
            "params": {
            },
            "returns": {
                "protocol version": "String",
                "version": "String"
            }
        },
        "Logging.GetLogEntries": {
            "description": "Get the LogEntries matching the given filter. Each list element of a given filter will be connected with OR to each other. Each of the given filters will be connected with AND to each other.",
            "params": {
                "o:deviceIds": [
                    "Uuid"
                ],
                "o:eventTypes": [
                    "$ref:LoggingEventType"
                ],
                "o:loggingLevels": [
                    "$ref:LoggingLevel"
                ],
                "o:loggingSources": [
                    "$ref:LoggingSource"
                ],
                "o:timeFilters": [
                    {
                        "o:endDate": "Int",
                        "o:startDate": "Int"
                    }
                ],
                "o:typeIds": [
                    "Uuid"
                ],
                "o:values": [
                    "Variant"
                ]
            },
            "returns": {
                "loggingError": "$ref:LoggingError",
                "o:logEntries": [
                    "$ref:LogEntry"
                ]
            }
        },
        "NetworkManager.ConnectWifiNetwork": {
            "description": "Connect to the wifi network with the given ssid and password.",
            "params": {
                "interface": "String",
                "o:password": "String",
                "ssid": "String"
            },
            "returns": {
                "networkManagerError": "$ref:NetworkManagerError"
            }
        },
        "NetworkManager.DisconnectInterface": {
            "description": "Disconnect the given network interface. The interface will remain disconnected until the user connect it again.",
            "params": {
                "interface": "String"
            },
            "returns": {
                "networkManagerError": "$ref:NetworkManagerError"
            }
        },
        "NetworkManager.EnableNetworking": {
            "description": "Enable or disable networking in the NetworkManager.",
            "params": {
                "enable": "Bool"
            },
            "returns": {
                "networkManagerError": "$ref:NetworkManagerError"
            }
        },
        "NetworkManager.EnableWirelessNetworking": {
            "description": "Enable or disable wireless networking in the NetworkManager.",
            "params": {
                "enable": "Bool"
            },
            "returns": {
                "networkManagerError": "$ref:NetworkManagerError"
            }
        },
        "NetworkManager.GetNetworkDevices": {
            "description": "Get the list of current network devices.",
            "params": {
            },
            "returns": {
                "networkManagerError": "$ref:NetworkManagerError",
                "wiredNetworkDevices": [
                    "$ref:WiredNetworkDevice"
                ],
                "wirelessNetworkDevices": [
                    "$ref:WirelessNetworkDevice"
                ]
            }
        },
        "NetworkManager.GetNetworkStatus": {
            "description": "Get the current network manager status.",
            "params": {
            },
            "returns": {
                "networkManagerError": "$ref:NetworkManagerError",
                "o:status": {
                    "networkingEnabled": "Bool",
                    "state": "$ref:NetworkManagerState",
                    "wirelessNetworkingEnabled": "Bool"
                }
            }
        },
        "NetworkManager.GetWirelessAccessPoints": {
            "description": "Get the current list of wireless network access points for the given interface. The interface has to be a WirelessNetworkDevice.",
            "params": {
                "interface": "String"
            },
            "returns": {
                "networkManagerError": "$ref:NetworkManagerError",
                "o:wirelessAccessPoints": [
                    "$ref:WirelessAccessPoint"
                ]
            }
        },
        "NetworkManager.ScanWifiNetworks": {
            "description": "Start a wifi scan for searching new networks.",
            "params": {
                "interface": "String"
            },
            "returns": {
                "networkManagerError": "$ref:NetworkManagerError"
            }
        },
        "Rules.AddRule": {
            "description": "Add a rule. You can describe rules by one or many EventDesciptors and a StateEvaluator. Note that only one of either eventDescriptor or eventDescriptorList may be passed at a time. A rule can be created but left disabled, meaning it won't actually be executed until set to enabled. If not given, enabled defaults to true.",
            "params": {
                "actions": [
                    "$ref:RuleAction"
                ],
                "name": "String",
                "o:enabled": "Bool",
                "o:eventDescriptors": [
                    "$ref:EventDescriptor"
                ],
                "o:executable": "Bool",
                "o:exitActions": [
                    "$ref:RuleAction"
                ],
                "o:stateEvaluator": "$ref:StateEvaluator",
                "o:timeDescriptor": "$ref:TimeDescriptor"
            },
            "returns": {
                "o:ruleId": "Uuid",
                "ruleError": "$ref:RuleError"
            }
        },
        "Rules.DisableRule": {
            "description": "Disable a rule. The rule won't be triggered by it's events or state changes while it is disabled. If successfull, the notification \"Rule.RuleConfigurationChanged\" will be emitted.",
            "params": {
                "ruleId": "Uuid"
            },
            "returns": {
                "ruleError": "$ref:RuleError"
            }
        },
        "Rules.EditRule": {
            "description": "Edit the parameters of a rule. The configuration of the rule with the given ruleId will be replaced with the new given configuration. In ordert to enable or disable a Rule, please use the methods \"Rules.EnableRule\" and \"Rules.DisableRule\". If successfull, the notification \"Rule.RuleConfigurationChanged\" will be emitted.",
            "params": {
                "actions": [
                    "$ref:RuleAction"
                ],
                "name": "String",
                "o:enabled": "Bool",
                "o:eventDescriptors": [
                    "$ref:EventDescriptor"
                ],
                "o:executable": "Bool",
                "o:exitActions": [
                    "$ref:RuleAction"
                ],
                "o:stateEvaluator": "$ref:StateEvaluator",
                "o:timeDescriptor": "$ref:TimeDescriptor",
                "ruleId": "Uuid"
            },
            "returns": {
                "o:rule": "$ref:Rule",
                "ruleError": "$ref:RuleError"
            }
        },
        "Rules.EnableRule": {
            "description": "Enabled a rule that has previously been disabled.If successfull, the notification \"Rule.RuleConfigurationChanged\" will be emitted.",
            "params": {
                "ruleId": "Uuid"
            },
            "returns": {
                "ruleError": "$ref:RuleError"
            }
        },
        "Rules.ExecuteActions": {
            "description": "Execute the action list of the rule with the given ruleId.",
            "params": {
                "ruleId": "Uuid"
            },
            "returns": {
                "ruleError": "$ref:RuleError"
            }
        },
        "Rules.ExecuteExitActions": {
            "description": "Execute the exit action list of the rule with the given ruleId.",
            "params": {
                "ruleId": "Uuid"
            },
            "returns": {
                "ruleError": "$ref:RuleError"
            }
        },
        "Rules.FindRules": {
            "description": "Find a list of rules containing any of the given parameters.",
            "params": {
                "deviceId": "Uuid"
            },
            "returns": {
                "ruleIds": [
                    "Uuid"
                ]
            }
        },
        "Rules.GetRuleDetails": {
            "description": "Get details for the rule identified by ruleId",
            "params": {
                "ruleId": "Uuid"
            },
            "returns": {
                "o:rule": "$ref:Rule",
                "ruleError": "$ref:RuleError"
            }
        },
        "Rules.GetRules": {
            "description": "Get the descriptions of all configured rules. If you need more information about a specific rule use the method Rules.GetRuleDetails.",
            "params": {
            },
            "returns": {
                "ruleDescriptions": [
                    "$ref:RuleDescription"
                ]
            }
        },
        "Rules.RemoveRule": {
            "description": "Remove a rule",
            "params": {
                "ruleId": "Uuid"
            },
            "returns": {
                "ruleError": "$ref:RuleError"
            }
        },
        "States.GetStateType": {
            "description": "Get the StateType for the given stateTypeId.",
            "params": {
                "stateTypeId": "Uuid"
            },
            "returns": {
                "deviceError": "$ref:DeviceError",
                "o:stateType": "$ref:StateType"
            }
        }
    },
    "notifications": {
        "Configuration.BasicConfigurationChanged": {
            "description": "Emitted whenever the basic configuration of this server changes.",
            "params": {
                "serverName": "String",
                "serverTime": "Uint",
                "serverUuid": "Uuid",
                "timeZone": "String"
            }
        },
        "Configuration.CloudConfigurationChanged": {
            "description": "Emitted whenever the cloud configuration is changed.",
            "params": {
                "enabled": "Bool"
            }
        },
        "Configuration.LanguageChanged": {
            "description": "Emitted whenever the language of the server changed. The Plugins, Vendors and DeviceClasses have to be reloaded to get the translated data.",
            "params": {
                "language": "String"
            }
        },
        "Configuration.TcpServerConfigurationChanged": {
            "description": "Emitted whenever the TCP server configuration changes.",
            "params": {
                "host": "String",
                "port": "Uint"
            }
        },
        "Configuration.WebServerConfigurationChanged": {
            "description": "Emitted whenever the web server configuration changes.",
            "params": {
                "host": "String",
                "port": "Uint"
            }
        },
        "Configuration.WebSocketServerConfigurationChanged": {
            "description": "Emitted whenever the web socket server configuration changes.",
            "params": {
                "host": "String",
                "port": "Uint"
            }
        },
        "Devices.DeviceAdded": {
            "description": "Emitted whenever a Device was added.",
            "params": {
                "device": "$ref:Device"
            }
        },
        "Devices.DeviceChanged": {
            "description": "Emitted whenever the params or name of a Device changed (by EditDevice or ReconfigureDevice).",
            "params": {
                "device": "$ref:Device"
            }
        },
        "Devices.DeviceRemoved": {
            "description": "Emitted whenever a Device was removed.",
            "params": {
                "deviceId": "Uuid"
            }
        },
        "Devices.StateChanged": {
            "description": "Emitted whenever a State of a device changes.",
            "params": {
                "deviceId": "Uuid",
                "stateTypeId": "Uuid",
                "value": "Variant"
            }
        },
        "Events.EventTriggered": {
            "description": "Emitted whenever an Event is triggered.",
            "params": {
                "event": "$ref:Event"
            }
        },
        "JSONRPC.CloudConnectedChanged": {
            "description": "Emitted whenever the cloud connection status changes.",
            "params": {
                "connected": "Bool"
            }
        },
        "JSONRPC.PushButtonAuthFinished": {
            "description": "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. ",
            "params": {
                "o:token": "String",
                "status": "$ref:UserError",
                "transactionId": "Int"
            }
        },
        "Logging.LogDatabaseUpdated": {
            "description": "Emitted whenever the database was updated. The database will be updated when a log entry was deleted. A log entry will be deleted when the corresponding device or a rule will be removed, or when the oldest entry of the database was deleted to keep to database in the size limits.",
            "params": {
            }
        },
        "Logging.LogEntryAdded": {
            "description": "Emitted whenever an entry is appended to the logging system. ",
            "params": {
                "logEntry": "$ref:LogEntry"
            }
        },
        "NetworkManager.NetworkStatusChanged": {
            "description": "Emitted whenever a status of a NetworkManager changes.",
            "params": {
                "status": {
                    "networkingEnabled": "Bool",
                    "state": "$ref:NetworkManagerState",
                    "wirelessNetworkingEnabled": "Bool"
                }
            }
        },
        "NetworkManager.WiredNetworkDeviceAdded": {
            "description": "Emitted whenever a new WiredNetworkDevice was added.",
            "params": {
                "wiredNetworkDevice": "$ref:WiredNetworkDevice"
            }
        },
        "NetworkManager.WiredNetworkDeviceChanged": {
            "description": "Emitted whenever the given WiredNetworkDevice has changed.",
            "params": {
                "wiredNetworkDevice": "$ref:WiredNetworkDevice"
            }
        },
        "NetworkManager.WiredNetworkDeviceRemoved": {
            "description": "Emitted whenever a WiredNetworkDevice was removed.",
            "params": {
                "interface": "String"
            }
        },
        "NetworkManager.WirelessNetworkDeviceAdded": {
            "description": "Emitted whenever a new WirelessNetworkDevice was added.",
            "params": {
                "wirelessNetworkDevice": "$ref:WirelessNetworkDevice"
            }
        },
        "NetworkManager.WirelessNetworkDeviceChanged": {
            "description": "Emitted whenever the given WirelessNetworkDevice has changed.",
            "params": {
                "wirelessNetworkDevice": "$ref:WirelessNetworkDevice"
            }
        },
        "NetworkManager.WirelessNetworkDeviceRemoved": {
            "description": "Emitted whenever a WirelessNetworkDevice was removed.",
            "params": {
                "interface": "String"
            }
        },
        "Rules.RuleActiveChanged": {
            "description": "Emitted whenever the active state of a Rule changed.",
            "params": {
                "active": "Bool",
                "ruleId": "Uuid"
            }
        },
        "Rules.RuleAdded": {
            "description": "Emitted whenever a Rule was added.",
            "params": {
                "rule": "$ref:Rule"
            }
        },
        "Rules.RuleConfigurationChanged": {
            "description": "Emitted whenever the configuration of a Rule changed.",
            "params": {
                "rule": "$ref:Rule"
            }
        },
        "Rules.RuleRemoved": {
            "description": "Emitted whenever a Rule was removed.",
            "params": {
                "ruleId": "Uuid"
            }
        }
    },
    "types": {
        "Action": {
            "actionTypeId": "Uuid",
            "deviceId": "Uuid",
            "o:params": [
                "$ref:Param"
            ]
        },
        "ActionType": {
            "id": "Uuid",
            "index": "Int",
            "name": "Uuid",
            "paramTypes": [
                "$ref:ParamType"
            ]
        },
        "BasicTag": [
            "BasicTagService",
            "BasicTagDevice",
            "BasicTagSensor",
            "BasicTagActuator",
            "BasicTagLighting",
            "BasicTagEnergy",
            "BasicTagMultimedia",
            "BasicTagWeather",
            "BasicTagGateway",
            "BasicTagHeating",
            "BasicTagCooling",
            "BasicTagNotification",
            "BasicTagSecurity",
            "BasicTagTime",
            "BasicTagShading",
            "BasicTagAppliance",
            "BasicTagCamera",
            "BasicTagLock"
        ],
        "BasicType": [
            "Uuid",
            "String",
            "Int",
            "Uint",
            "Double",
            "Bool",
            "Variant",
            "Color",
            "Time",
            "Object"
        ],
        "CalendarItem": {
            "duration": "Uint",
            "o:datetime": "Uint",
            "o:repeating": "$ref:RepeatingOption",
            "o:startTime": "Time"
        },
        "ConfigurationError": [
            "ConfigurationErrorNoError",
            "ConfigurationErrorInvalidTimeZone",
            "ConfigurationErrorInvalidStationName",
            "ConfigurationErrorInvalidId",
            "ConfigurationErrorInvalidPort",
            "ConfigurationErrorInvalidHostAddress",
            "ConfigurationErrorBluetoothHardwareNotAvailable",
            "ConfigurationErrorInvalidCertificate"
        ],
        "CreateMethod": [
            "CreateMethodUser",
            "CreateMethodAuto",
            "CreateMethodDiscovery"
        ],
        "Device": {
            "deviceClassId": "Uuid",
            "id": "Uuid",
            "name": "String",
            "o:parentId": "Uuid",
            "params": [
                "$ref:Param"
            ],
            "setupComplete": "Bool",
            "states": [
                {
                    "stateTypeId": "Uuid",
                    "value": "Variant"
                }
            ]
        },
        "DeviceClass": {
            "actionTypes": [
                "$ref:ActionType"
            ],
            "basicTags": [
                "$ref:BasicTag"
            ],
            "createMethods": [
                "$ref:CreateMethod"
            ],
            "deviceIcon": "$ref:DeviceIcon",
            "discoveryParamTypes": [
                "$ref:ParamType"
            ],
            "eventTypes": [
                "$ref:EventType"
            ],
            "id": "Uuid",
            "interfaces": [
                "String"
            ],
            "name": "String",
            "o:criticalStateTypeId": "Uuid",
            "o:primaryActionTypeId": "Uuid",
            "o:primaryStateTypeId": "Uuid",
            "paramTypes": [
                "$ref:ParamType"
            ],
            "pluginId": "Uuid",
            "setupMethod": "$ref:SetupMethod",
            "stateTypes": [
                "$ref:StateType"
            ],
            "vendorId": "Uuid"
        },
        "DeviceDescriptor": {
            "description": "String",
            "id": "Uuid",
            "title": "String"
        },
        "DeviceError": [
            "DeviceErrorNoError",
            "DeviceErrorPluginNotFound",
            "DeviceErrorVendorNotFound",
            "DeviceErrorDeviceNotFound",
            "DeviceErrorDeviceClassNotFound",
            "DeviceErrorActionTypeNotFound",
            "DeviceErrorStateTypeNotFound",
            "DeviceErrorEventTypeNotFound",
            "DeviceErrorDeviceDescriptorNotFound",
            "DeviceErrorMissingParameter",
            "DeviceErrorInvalidParameter",
            "DeviceErrorSetupFailed",
            "DeviceErrorDuplicateUuid",
            "DeviceErrorCreationMethodNotSupported",
            "DeviceErrorSetupMethodNotSupported",
            "DeviceErrorHardwareNotAvailable",
            "DeviceErrorHardwareFailure",
            "DeviceErrorAuthentificationFailure",
            "DeviceErrorAsync",
            "DeviceErrorDeviceInUse",
            "DeviceErrorDeviceInRule",
            "DeviceErrorDeviceIsChild",
            "DeviceErrorPairingTransactionIdNotFound",
            "DeviceErrorParameterNotWritable"
        ],
        "DeviceIcon": [
            "DeviceIconNone",
            "DeviceIconBed",
            "DeviceIconBlinds",
            "DeviceIconCeilingLamp",
            "DeviceIconCouch",
            "DeviceIconDeskLamp",
            "DeviceIconDesk",
            "DeviceIconHifi",
            "DeviceIconPower",
            "DeviceIconEnergy",
            "DeviceIconRadio",
            "DeviceIconSmartPhone",
            "DeviceIconSocket",
            "DeviceIconStandardLamp",
            "DeviceIconSun",
            "DeviceIconTablet",
            "DeviceIconThermometer",
            "DeviceIconTune",
            "DeviceIconTv",
            "DeviceIconBattery",
            "DeviceIconDishwasher",
            "DeviceIconWashingMachine",
            "DeviceIconLaundryDryer",
            "DeviceIconIrHeater",
            "DeviceIconRadiator",
            "DeviceIconSwitch",
            "DeviceIconMotionDetectors",
            "DeviceIconWeather",
            "DeviceIconTime",
            "DeviceIconLightBulb",
            "DeviceIconGateway",
            "DeviceIconMail",
            "DeviceIconNetwork",
            "DeviceIconCloud",
            "DeviceIconGarage",
            "DeviceIconRollerShutter"
        ],
        "Event": {
            "deviceId": "Uuid",
            "eventTypeId": "Uuid",
            "o:params": [
                "$ref:Param"
            ]
        },
        "EventDescriptor": {
            "deviceId": "Uuid",
            "eventTypeId": "Uuid",
            "o:paramDescriptors": [
                "$ref:ParamDescriptor"
            ]
        },
        "EventType": {
            "id": "Uuid",
            "index": "Int",
            "name": "String",
            "o:graphRelevant": "Bool",
            "o:ruleRelevant": "Bool",
            "paramTypes": [
                "$ref:ParamType"
            ]
        },
        "InputType": [
            "InputTypeNone",
            "InputTypeTextLine",
            "InputTypeTextArea",
            "InputTypePassword",
            "InputTypeSearch",
            "InputTypeMail",
            "InputTypeIPv4Address",
            "InputTypeIPv6Address",
            "InputTypeUrl",
            "InputTypeMacAddress"
        ],
        "LogEntry": {
            "loggingLevel": "$ref:LoggingLevel",
            "o:active": "Bool",
            "o:deviceId": "Uuid",
            "o:errorCode": "String",
            "o:eventType": "$ref:LoggingEventType",
            "o:typeId": "Uuid",
            "o:value": "String",
            "source": "$ref:LoggingSource",
            "timestamp": "Int"
        },
        "LoggingError": [
            "LoggingErrorNoError",
            "LoggingErrorLogEntryNotFound",
            "LoggingErrorInvalidFilterParameter"
        ],
        "LoggingEventType": [
            "LoggingEventTypeTrigger",
            "LoggingEventTypeActiveChange",
            "LoggingEventTypeEnabledChange",
            "LoggingEventTypeActionsExecuted",
            "LoggingEventTypeExitActionsExecuted"
        ],
        "LoggingLevel": [
            "LoggingLevelInfo",
            "LoggingLevelAlert"
        ],
        "LoggingSource": [
            "LoggingSourceSystem",
            "LoggingSourceEvents",
            "LoggingSourceActions",
            "LoggingSourceStates",
            "LoggingSourceRules"
        ],
        "NetworkDeviceState": [
            "NetworkDeviceStateUnknown",
            "NetworkDeviceStateUnmanaged",
            "NetworkDeviceStateUnavailable",
            "NetworkDeviceStateDisconnected",
            "NetworkDeviceStatePrepare",
            "NetworkDeviceStateConfig",
            "NetworkDeviceStateNeedAuth",
            "NetworkDeviceStateIpConfig",
            "NetworkDeviceStateIpCheck",
            "NetworkDeviceStateSecondaries",
            "NetworkDeviceStateActivated",
            "NetworkDeviceStateDeactivating",
            "NetworkDeviceStateFailed"
        ],
        "NetworkManagerError": [
            "NetworkManagerErrorNoError",
            "NetworkManagerErrorUnknownError",
            "NetworkManagerErrorWirelessNotAvailable",
            "NetworkManagerErrorAccessPointNotFound",
            "NetworkManagerErrorNetworkInterfaceNotFound",
            "NetworkManagerErrorInvalidNetworkDeviceType",
            "NetworkManagerErrorWirelessNetworkingDisabled",
            "NetworkManagerErrorWirelessConnectionFailed",
            "NetworkManagerErrorNetworkingDisabled",
            "NetworkManagerErrorNetworkManagerNotAvailable"
        ],
        "NetworkManagerState": [
            "NetworkManagerStateUnknown",
            "NetworkManagerStateAsleep",
            "NetworkManagerStateDisconnected",
            "NetworkManagerStateDisconnecting",
            "NetworkManagerStateConnecting",
            "NetworkManagerStateConnectedLocal",
            "NetworkManagerStateConnectedSite",
            "NetworkManagerStateConnectedGlobal"
        ],
        "Param": {
            "paramTypeId": "Uuid",
            "value": "$ref:BasicType"
        },
        "ParamDescriptor": {
            "operator": "$ref:ValueOperator",
            "paramTypeId": "Uuid",
            "value": "$ref:BasicType"
        },
        "ParamType": {
            "id": "Uuid",
            "index": "Int",
            "name": "String",
            "o:allowedValues": [
                "Variant"
            ],
            "o:defaultValue": "Variant",
            "o:inputType": "$ref:InputType",
            "o:maxValue": "Variant",
            "o:minValue": "Variant",
            "o:readOnly": "Bool",
            "o:unit": "$ref:Unit",
            "type": "$ref:BasicType"
        },
        "Plugin": {
            "id": "Uuid",
            "name": "String",
            "paramTypes": [
                "$ref:ParamType"
            ]
        },
        "RemovePolicy": [
            "RemovePolicyCascade",
            "RemovePolicyUpdate"
        ],
        "RepeatingMode": [
            "RepeatingModeNone",
            "RepeatingModeHourly",
            "RepeatingModeDaily",
            "RepeatingModeWeekly",
            "RepeatingModeMonthly",
            "RepeatingModeYearly"
        ],
        "RepeatingOption": {
            "mode": "$ref:RepeatingMode",
            "o:monthDays": [
                "Int"
            ],
            "o:weekDays": [
                "Int"
            ]
        },
        "Rule": {
            "actions": [
                "$ref:RuleAction"
            ],
            "active": "Bool",
            "enabled": "Bool",
            "eventDescriptors": [
                "$ref:EventDescriptor"
            ],
            "executable": "Bool",
            "exitActions": [
                "$ref:RuleAction"
            ],
            "id": "Uuid",
            "name": "String",
            "stateEvaluator": "$ref:StateEvaluator",
            "timeDescriptor": "$ref:TimeDescriptor"
        },
        "RuleAction": {
            "actionTypeId": "Uuid",
            "deviceId": "Uuid",
            "o:ruleActionParams": [
                "$ref:RuleActionParam"
            ]
        },
        "RuleActionParam": {
            "o:eventParamTypeId": "Uuid",
            "o:eventTypeId": "Uuid",
            "o:value": "$ref:BasicType",
            "paramTypeId": "Uuid"
        },
        "RuleDescription": {
            "active": "Bool",
            "enabled": "Bool",
            "executable": "Bool",
            "id": "Uuid",
            "name": "String"
        },
        "RuleError": [
            "RuleErrorNoError",
            "RuleErrorInvalidRuleId",
            "RuleErrorRuleNotFound",
            "RuleErrorDeviceNotFound",
            "RuleErrorEventTypeNotFound",
            "RuleErrorStateTypeNotFound",
            "RuleErrorActionTypeNotFound",
            "RuleErrorInvalidParameter",
            "RuleErrorInvalidRuleFormat",
            "RuleErrorMissingParameter",
            "RuleErrorInvalidRuleActionParameter",
            "RuleErrorInvalidStateEvaluatorValue",
            "RuleErrorTypesNotMatching",
            "RuleErrorNotExecutable",
            "RuleErrorInvalidTimeDescriptor",
            "RuleErrorInvalidRepeatingOption",
            "RuleErrorInvalidCalendarItem",
            "RuleErrorInvalidTimeEventItem",
            "RuleErrorContainsEventBasesAction",
            "RuleErrorNoExitActions"
        ],
        "ServerConfiguration": {
            "address": "String",
            "authenticationEnabled": "Bool",
            "id": "String",
            "port": "Uint",
            "sslEnabled": "Bool"
        },
        "SetupMethod": [
            "SetupMethodJustAdd",
            "SetupMethodDisplayPin",
            "SetupMethodEnterPin",
            "SetupMethodPushButton"
        ],
        "State": {
            "deviceId": "Uuid",
            "stateTypeId": "Uuid",
            "value": "Variant"
        },
        "StateDescriptor": {
            "deviceId": "Uuid",
            "operator": "$ref:ValueOperator",
            "stateTypeId": "Uuid",
            "value": "Variant"
        },
        "StateEvaluator": {
            "o:childEvaluators": [
                "$ref:StateEvaluator"
            ],
            "o:operator": "$ref:StateOperator",
            "o:stateDescriptor": "$ref:StateDescriptor"
        },
        "StateOperator": [
            "StateOperatorAnd",
            "StateOperatorOr"
        ],
        "StateType": {
            "defaultValue": "Variant",
            "id": "Uuid",
            "index": "Int",
            "name": "String",
            "o:graphRelevant": "Bool",
            "o:maxValue": "Variant",
            "o:minValue": "Variant",
            "o:possibleValues": [
                "Variant"
            ],
            "o:ruleRelevant": "Bool",
            "o:unit": "$ref:Unit",
            "type": "$ref:BasicType"
        },
        "TimeDescriptor": {
            "o:calendarItems": [
                "$ref:CalendarItem"
            ],
            "o:timeEventItems": [
                "$ref:TimeEventItem"
            ]
        },
        "TimeEventItem": {
            "o:datetime": "Uint",
            "o:repeating": "$ref:RepeatingOption",
            "o:time": "Time"
        },
        "TokenInfo": {
            "creationTime": "Uint",
            "deviceName": "String",
            "id": "Uuid",
            "userName": "String"
        },
        "Unit": [
            "UnitNone",
            "UnitSeconds",
            "UnitMinutes",
            "UnitHours",
            "UnitUnixTime",
            "UnitMeterPerSecond",
            "UnitKiloMeterPerHour",
            "UnitDegree",
            "UnitRadiant",
            "UnitDegreeCelsius",
            "UnitDegreeKelvin",
            "UnitMired",
            "UnitMilliBar",
            "UnitBar",
            "UnitPascal",
            "UnitHectoPascal",
            "UnitAtmosphere",
            "UnitLumen",
            "UnitLux",
            "UnitCandela",
            "UnitMilliMeter",
            "UnitCentiMeter",
            "UnitMeter",
            "UnitKiloMeter",
            "UnitGram",
            "UnitKiloGram",
            "UnitDezibel",
            "UnitBpm",
            "UnitKiloByte",
            "UnitMegaByte",
            "UnitGigaByte",
            "UnitTeraByte",
            "UnitMilliWatt",
            "UnitWatt",
            "UnitKiloWatt",
            "UnitKiloWattHour",
            "UnitEuroPerMegaWattHour",
            "UnitEuroCentPerKiloWattHour",
            "UnitPercentage",
            "UnitPartsPerMillion",
            "UnitEuro",
            "UnitDollar",
            "UnitHerz",
            "UnitAmpere",
            "UnitMilliAmpere",
            "UnitVolt",
            "UnitMilliVolt",
            "UnitVoltAmpere",
            "UnitVoltAmpereReactive",
            "UnitAmpereHour"
        ],
        "UserError": [
            "UserErrorNoError",
            "UserErrorBackendError",
            "UserErrorInvalidUserId",
            "UserErrorDuplicateUserId",
            "UserErrorBadPassword",
            "UserErrorTokenNotFound",
            "UserErrorPermissionDenied"
        ],
        "ValueOperator": [
            "ValueOperatorEquals",
            "ValueOperatorNotEquals",
            "ValueOperatorLess",
            "ValueOperatorGreater",
            "ValueOperatorLessOrEqual",
            "ValueOperatorGreaterOrEqual"
        ],
        "Vendor": {
            "id": "Uuid",
            "name": "String"
        },
        "WebServerConfiguration": {
            "address": "String",
            "authenticationEnabled": "Bool",
            "id": "String",
            "port": "Uint",
            "sslEnabled": "Bool"
        },
        "WiredNetworkDevice": {
            "bitRate": "String",
            "interface": "String",
            "macAddress": "String",
            "pluggedIn": "Bool",
            "state": "$ref:NetworkDeviceState"
        },
        "WirelessAccessPoint": {
            "frequency": "Double",
            "macAddress": "String",
            "protected": "Bool",
            "signalStrength": "Int",
            "ssid": "String"
        },
        "WirelessNetworkDevice": {
            "bitRate": "String",
            "interface": "String",
            "macAddress": "String",
            "o:currentAccessPoint": "$ref:WirelessAccessPoint",
            "state": "$ref:NetworkDeviceState"
        }
    }
}
