diff --git a/docs/data/somfy_europe.json b/docs/data/somfy_europe.json index a48f11f9..854f0a93 100644 --- a/docs/data/somfy_europe.json +++ b/docs/data/somfy_europe.json @@ -434,7 +434,6 @@ "IntrusionEventSensor", "IntrusionSensor", "Invalid", - "JSWCamera", "KizOThermBridge", "KizOThermV2Bridge", "LockUnlockDoorLockWithUnknownPosition", @@ -5418,22 +5417,22 @@ "formFactor": false, "states": [ { - "name": "core:AvailableActionsState", - "description": "List of action ids available", + "name": "core:ActionEventState", + "description": "Contains the id of triggered button action (stateless information, makes sense only punctually at a certain time, does not indicate a stable or continuous status).", "valuePrototypes": [ { - "type": "ARRAY", - "description": "array value" + "type": "STRING", + "description": "string value" } ] }, { - "name": "core:ButtonActionsEventState", - "description": "Contains the id of triggered button action (stateless information, makes sense only punctually at a certain time, does not indicate a stable or continuous status).", + "name": "core:AvailableActionsState", + "description": "List of action ids available", "valuePrototypes": [ { - "type": "STRING", - "description": "string value" + "type": "ARRAY", + "description": "array value" } ] } @@ -139569,253 +139568,6 @@ ] } ], - "JSW": [ - { - "typeId": 0, - "subsystemId": 0, - "localPairing": false, - "uiClass": "Camera", - "uiWidget": "JSWCamera", - "uiProfiles": [ - "Specific" - ], - "uiClassifiers": [], - "controllableName": "jsw:CameraController", - "controllableType": "ACTUATOR", - "protocolType": "JSW", - "commands": [ - { - "commandName": "downloadRecordedFile", - "nparams": 1, - "description": "Allow to get an URL to download a recorded file\np1: event time of a recorded file, obtained from listRecordedFiles command\n(The URL is returned asynchronously in a DownloadRecordedFileEvent)\n", - "parameters": [ - { - "optional": false, - "sensitive": false, - "valuePrototypes": [ - { - "type": "INT", - "minValue": 0, - "description": "integer value >= 0" - } - ] - } - ] - }, - { - "commandName": "listRecordedFiles", - "nparams": 2, - "description": "List recorded files in a given time period\np1: start_Time -> unix time format (UTC)\np2: end_Time -> unix time format (UTC) - optional field (defaults to now)\n(The list is returned asynchronously in a ListRecordedFilesEvent)\n", - "parameters": [ - { - "optional": false, - "sensitive": false, - "valuePrototypes": [ - { - "type": "INT", - "minValue": 0, - "description": "integer value >= 0" - } - ] - }, - { - "optional": true, - "sensitive": false, - "valuePrototypes": [ - { - "type": "INT", - "minValue": 0, - "description": "integer value >= 0" - } - ] - } - ] - }, - { - "commandName": "connect", - "nparams": 0, - "description": "Open a new session on the camera and return a session token\n(The token is returned asynchronously in a JSWConnectTokenObtainedEvent)\n" - }, - { - "commandName": "deleteRecordedFile", - "nparams": 1, - "description": "Delete an recorded file\np1: event time of a recorded file, obtained from returning value of listRecordedFiles command\n", - "parameters": [ - { - "optional": false, - "sensitive": false, - "valuePrototypes": [ - { - "type": "INT", - "minValue": 0, - "description": "integer value >= 0" - } - ] - } - ] - }, - { - "commandName": "disconnect", - "nparams": 1, - "description": "Close a camera session\np1: token obtained by \"connect\" command\n(The session token is invalidated after using this command)\n", - "parameters": [ - { - "optional": false, - "sensitive": false, - "valuePrototypes": [ - { - "type": "STRING", - "description": "string value" - } - ] - } - ] - }, - { - "commandName": "getSessionStatus", - "nparams": 1, - "description": "Refresh the camera status state\np1:token obtained by \"connect\" command\n", - "parameters": [ - { - "optional": false, - "sensitive": false, - "valuePrototypes": [ - { - "type": "STRING", - "description": "string value" - } - ] - } - ] - }, - { - "commandName": "playJSWRecordedFile", - "nparams": 2, - "description": "Play a recorded file\np1: event time of a recorded file, obtained from listRecordedFiles command\np2: token obtained by \"connect\" command\n", - "parameters": [ - { - "optional": false, - "sensitive": false, - "valuePrototypes": [ - { - "type": "INT", - "minValue": 0, - "description": "integer value >= 0" - } - ] - }, - { - "optional": false, - "sensitive": false, - "valuePrototypes": [ - { - "type": "STRING", - "description": "string value" - } - ] - } - ] - }, - { - "commandName": "setPassword", - "nparams": 2, - "description": "Change the current password\np1:old password\np2:new password\n", - "parameters": [ - { - "optional": false, - "sensitive": true, - "valuePrototypes": [ - { - "type": "STRING", - "description": "string value" - } - ] - }, - { - "optional": false, - "sensitive": true, - "valuePrototypes": [ - { - "type": "STRING", - "description": "string value" - } - ] - } - ] - }, - { - "commandName": "startJSWLiveVideo", - "nparams": 1, - "description": "Start a live video and get an URL for live streaming\np1: token obtained by \"connect\" command\n", - "parameters": [ - { - "optional": false, - "sensitive": false, - "valuePrototypes": [ - { - "type": "STRING", - "description": "string value" - } - ] - } - ] - }, - { - "commandName": "startJSWRecording", - "nparams": 0, - "description": "Start recording a video. Uses a temporary session for 1 minute.\n" - }, - { - "commandName": "stopJSWLiveVideo", - "nparams": 1, - "description": "Stop live video streaming\np1: token obtained by \"connect\" command, same token that was used for startJSWLiveVideoCommand\n", - "parameters": [ - { - "optional": false, - "sensitive": false, - "valuePrototypes": [ - { - "type": "STRING", - "description": "string value" - } - ] - } - ] - }, - { - "commandName": "stopJSWPlayRecordedFile", - "nparams": 1, - "description": "Stop playing a recorded file\np1: token obtained by \"connect\" command, same token that was used for playJSWRecordedFileCommand\n", - "parameters": [ - { - "optional": false, - "sensitive": false, - "valuePrototypes": [ - { - "type": "STRING", - "description": "string value" - } - ] - } - ] - } - ], - "states": [ - { - "name": "FreeMemoryState", - "type": "ContinuousState", - "eventBased": false, - "persistent": false - }, - { - "name": "TotalMemoryState", - "type": "ContinuousState", - "eventBased": false, - "persistent": false - } - ] - } - ], "OPENDOORS": [ { "typeId": 16777472, @@ -199216,6 +198968,11 @@ } ] }, + { + "commandName": "closeCommissioning", + "nparams": 0, + "description": "Close the commissioning window.\n" + }, { "commandName": "discover", "nparams": 0, @@ -199263,6 +199020,25 @@ "nparams": 0, "description": "Join an existing setup\n" }, + { + "commandName": "openCommissioning", + "nparams": 1, + "description": "Open the commissioning window to let the device be discovered by other controllers.\nDuration in seconds for which the commissioning window will be open.\n", + "parameters": [ + { + "optional": false, + "sensitive": false, + "valuePrototypes": [ + { + "type": "INT", + "minValue": 1, + "maxValue": 65535, + "description": "integer value between 1 and 65535" + } + ] + } + ] + }, { "commandName": "pair", "nparams": 3, @@ -199439,9 +199215,29 @@ "persistent": false }, { - "name": "ErrorEventState", - "type": "DiscreteState", - "eventBased": true, + "name": "CommissioningWindowCloseTimestampState", + "type": "DataState", + "eventBased": false, + "persistent": false, + "valuePrototypes": [ + { + "type": "INT", + "minValue": 1, + "maxValue": 65535, + "description": "integer value between 1 and 65535" + } + ] + }, + { + "name": "CommissioningWindowOpenState", + "type": "DataState", + "eventBased": false, + "persistent": false + }, + { + "name": "CredentialsState", + "type": "DataState", + "eventBased": false, "persistent": false }, { @@ -199824,12 +199620,6 @@ "eventBased": false, "persistent": false }, - { - "name": "ErrorEventState", - "type": "DiscreteState", - "eventBased": true, - "persistent": false - }, { "name": "ErrorState", "type": "DataState", @@ -200614,12 +200404,6 @@ } ] }, - { - "name": "ErrorEventState", - "type": "DiscreteState", - "eventBased": true, - "persistent": false - }, { "name": "ErrorState", "type": "DataState", @@ -201264,12 +201048,6 @@ "eventBased": false, "persistent": false }, - { - "name": "ErrorEventState", - "type": "DiscreteState", - "eventBased": true, - "persistent": false - }, { "name": "ErrorState", "type": "DataState", @@ -201969,12 +201747,6 @@ "eventBased": false, "persistent": false }, - { - "name": "ErrorEventState", - "type": "DiscreteState", - "eventBased": true, - "persistent": false - }, { "name": "ErrorState", "type": "DataState", @@ -202564,12 +202336,6 @@ } ] }, - { - "name": "ErrorEventState", - "type": "DiscreteState", - "eventBased": true, - "persistent": false - }, { "name": "ErrorState", "type": "DataState", @@ -203152,12 +202918,6 @@ } ] }, - { - "name": "ErrorEventState", - "type": "DiscreteState", - "eventBased": true, - "persistent": false - }, { "name": "ErrorState", "type": "DataState", @@ -203688,12 +203448,6 @@ } ] }, - { - "name": "ErrorEventState", - "type": "DiscreteState", - "eventBased": true, - "persistent": false - }, { "name": "ErrorState", "type": "DataState", @@ -204256,12 +204010,6 @@ } ] }, - { - "name": "ErrorEventState", - "type": "DiscreteState", - "eventBased": true, - "persistent": false - }, { "name": "ErrorState", "type": "DataState", @@ -204802,12 +204550,6 @@ } ] }, - { - "name": "ErrorEventState", - "type": "DiscreteState", - "eventBased": true, - "persistent": false - }, { "name": "ErrorState", "type": "DataState", @@ -205316,12 +205058,6 @@ } ] }, - { - "name": "ErrorEventState", - "type": "DiscreteState", - "eventBased": true, - "persistent": false - }, { "name": "ErrorState", "type": "DataState", @@ -205867,12 +205603,6 @@ } ] }, - { - "name": "ErrorEventState", - "type": "DiscreteState", - "eventBased": true, - "persistent": false - }, { "name": "ErrorState", "type": "DataState", @@ -206467,12 +206197,6 @@ } ] }, - { - "name": "ErrorEventState", - "type": "DiscreteState", - "eventBased": true, - "persistent": false - }, { "name": "ErrorState", "type": "DataState", @@ -207157,12 +206881,6 @@ "eventBased": false, "persistent": false }, - { - "name": "ErrorEventState", - "type": "DiscreteState", - "eventBased": true, - "persistent": false - }, { "name": "ErrorState", "type": "DataState", @@ -207682,12 +207400,6 @@ "eventBased": false, "persistent": false }, - { - "name": "ErrorEventState", - "type": "DiscreteState", - "eventBased": true, - "persistent": false - }, { "name": "ErrorState", "type": "DataState", @@ -208176,12 +207888,6 @@ } ] }, - { - "name": "ErrorEventState", - "type": "DiscreteState", - "eventBased": true, - "persistent": false - }, { "name": "ErrorState", "type": "DataState", @@ -208562,12 +208268,6 @@ "eventBased": false, "persistent": false }, - { - "name": "ErrorEventState", - "type": "DiscreteState", - "eventBased": true, - "persistent": false - }, { "name": "ErrorState", "type": "DataState", @@ -208933,12 +208633,6 @@ "eventBased": false, "persistent": false }, - { - "name": "ErrorEventState", - "type": "DiscreteState", - "eventBased": true, - "persistent": false - }, { "name": "ErrorState", "type": "DataState", @@ -209307,12 +209001,6 @@ "eventBased": false, "persistent": false }, - { - "name": "ErrorEventState", - "type": "DiscreteState", - "eventBased": true, - "persistent": false - }, { "name": "ErrorState", "type": "DataState", @@ -209687,12 +209375,6 @@ "eventBased": false, "persistent": false }, - { - "name": "ErrorEventState", - "type": "DiscreteState", - "eventBased": true, - "persistent": false - }, { "name": "ErrorState", "type": "DataState", @@ -210052,12 +209734,6 @@ "eventBased": false, "persistent": false }, - { - "name": "ErrorEventState", - "type": "DiscreteState", - "eventBased": true, - "persistent": false - }, { "name": "ErrorState", "type": "DataState", @@ -210583,12 +210259,6 @@ } ] }, - { - "name": "ErrorEventState", - "type": "DiscreteState", - "eventBased": true, - "persistent": false - }, { "name": "ErrorState", "type": "DataState", @@ -211169,12 +210839,6 @@ } ] }, - { - "name": "ErrorEventState", - "type": "DiscreteState", - "eventBased": true, - "persistent": false - }, { "name": "ErrorState", "type": "DataState", @@ -211698,12 +211362,6 @@ "eventBased": false, "persistent": false }, - { - "name": "ErrorEventState", - "type": "DiscreteState", - "eventBased": true, - "persistent": false - }, { "name": "ErrorState", "type": "DataState", @@ -212189,12 +211847,6 @@ "eventBased": false, "persistent": false }, - { - "name": "ErrorEventState", - "type": "DiscreteState", - "eventBased": true, - "persistent": false - }, { "name": "ErrorState", "type": "DataState", @@ -212591,12 +212243,6 @@ "eventBased": false, "persistent": false }, - { - "name": "ErrorEventState", - "type": "DiscreteState", - "eventBased": true, - "persistent": false - }, { "name": "ErrorState", "type": "DataState", @@ -212622,7 +212268,7 @@ "persistent": false }, { - "name": "IntrusionDetectionEventState", + "name": "IntrusionEventState", "type": "DiscreteState", "eventBased": true, "persistent": false @@ -213096,12 +212742,6 @@ "eventBased": false, "persistent": false }, - { - "name": "ErrorEventState", - "type": "DiscreteState", - "eventBased": true, - "persistent": false - }, { "name": "ErrorState", "type": "DataState", @@ -213133,7 +212773,7 @@ "persistent": false }, { - "name": "IntrusionDetectionEventState", + "name": "IntrusionEventState", "type": "DiscreteState", "eventBased": true, "persistent": false @@ -213251,7 +212891,7 @@ "persistent": false }, { - "name": "SmokeDetectionEventState", + "name": "SmokeEventState", "type": "DiscreteState", "eventBased": true, "persistent": false @@ -213282,13 +212922,7 @@ "name": "WaterLeakEventState", "type": "DiscreteState", "eventBased": true, - "persistent": false, - "valuePrototypes": [ - { - "type": "STRING", - "description": "string value" - } - ] + "persistent": false }, { "name": "WaterLeakState", @@ -213612,12 +213246,6 @@ "eventBased": false, "persistent": false }, - { - "name": "ErrorEventState", - "type": "DiscreteState", - "eventBased": true, - "persistent": false - }, { "name": "ErrorState", "type": "DataState", @@ -214280,12 +213908,6 @@ "eventBased": false, "persistent": false }, - { - "name": "ErrorEventState", - "type": "DiscreteState", - "eventBased": true, - "persistent": false - }, { "name": "ErrorState", "type": "DataState", @@ -215231,12 +214853,6 @@ "eventBased": false, "persistent": false }, - { - "name": "ErrorEventState", - "type": "DiscreteState", - "eventBased": true, - "persistent": false - }, { "name": "ErrorState", "type": "DataState", @@ -215911,12 +215527,6 @@ "eventBased": false, "persistent": false }, - { - "name": "ErrorEventState", - "type": "DiscreteState", - "eventBased": true, - "persistent": false - }, { "name": "ErrorState", "type": "DataState", @@ -216453,12 +216063,6 @@ } ] }, - { - "name": "ErrorEventState", - "type": "DiscreteState", - "eventBased": true, - "persistent": false - }, { "name": "ErrorState", "type": "DataState", @@ -217124,12 +216728,6 @@ "eventBased": false, "persistent": false }, - { - "name": "ErrorEventState", - "type": "DiscreteState", - "eventBased": true, - "persistent": false - }, { "name": "ErrorState", "type": "DataState", @@ -217178,12 +216776,6 @@ "eventBased": false, "persistent": false }, - { - "name": "MediaElementsEventState", - "type": "DataState", - "eventBased": true, - "persistent": false - }, { "name": "MuteState", "type": "DataState", @@ -217787,12 +217379,6 @@ "eventBased": false, "persistent": false }, - { - "name": "ErrorEventState", - "type": "DiscreteState", - "eventBased": true, - "persistent": false - }, { "name": "ErrorState", "type": "DataState", @@ -218459,12 +218045,6 @@ "eventBased": false, "persistent": false }, - { - "name": "ErrorEventState", - "type": "DiscreteState", - "eventBased": true, - "persistent": false - }, { "name": "ErrorState", "type": "DataState", @@ -218961,12 +218541,6 @@ } ] }, - { - "name": "ErrorEventState", - "type": "DiscreteState", - "eventBased": true, - "persistent": false - }, { "name": "ErrorState", "type": "DataState", @@ -219288,6 +218862,18 @@ } ], "states": [ + { + "name": "ActionEventState", + "type": "DataState", + "eventBased": true, + "persistent": false, + "valuePrototypes": [ + { + "type": "STRING", + "description": "string value" + } + ] + }, { "name": "ActionState", "type": "DataState", @@ -219336,24 +218922,6 @@ "eventBased": false, "persistent": false }, - { - "name": "ButtonActionsEventState", - "type": "DataState", - "eventBased": true, - "persistent": false, - "valuePrototypes": [ - { - "type": "STRING", - "description": "string value" - } - ] - }, - { - "name": "ErrorEventState", - "type": "DiscreteState", - "eventBased": true, - "persistent": false - }, { "name": "ErrorState", "type": "DataState", @@ -219745,12 +219313,6 @@ } ] }, - { - "name": "ErrorEventState", - "type": "DiscreteState", - "eventBased": true, - "persistent": false - }, { "name": "ErrorState", "type": "DataState", @@ -220132,12 +219694,6 @@ "eventBased": false, "persistent": false }, - { - "name": "ErrorEventState", - "type": "DiscreteState", - "eventBased": true, - "persistent": false - }, { "name": "ErrorState", "type": "DataState", @@ -220491,12 +220047,6 @@ "eventBased": false, "persistent": false }, - { - "name": "ErrorEventState", - "type": "DiscreteState", - "eventBased": true, - "persistent": false - }, { "name": "ErrorState", "type": "DataState", @@ -220866,12 +220416,6 @@ "eventBased": false, "persistent": false }, - { - "name": "ErrorEventState", - "type": "DiscreteState", - "eventBased": true, - "persistent": false - }, { "name": "ErrorState", "type": "DataState", @@ -221255,6 +220799,18 @@ } ], "states": [ + { + "name": "ActionEventState", + "type": "DataState", + "eventBased": true, + "persistent": false, + "valuePrototypes": [ + { + "type": "STRING", + "description": "string value" + } + ] + }, { "name": "ActionState", "type": "DataState", @@ -221303,24 +220859,6 @@ "eventBased": false, "persistent": false }, - { - "name": "ButtonActionsEventState", - "type": "DataState", - "eventBased": true, - "persistent": false, - "valuePrototypes": [ - { - "type": "STRING", - "description": "string value" - } - ] - }, - { - "name": "ErrorEventState", - "type": "DiscreteState", - "eventBased": true, - "persistent": false - }, { "name": "ErrorState", "type": "DataState", @@ -221691,12 +221229,6 @@ } ] }, - { - "name": "ErrorEventState", - "type": "DiscreteState", - "eventBased": true, - "persistent": false - }, { "name": "ErrorState", "type": "DataState", @@ -222057,12 +221589,6 @@ "eventBased": false, "persistent": false }, - { - "name": "ErrorEventState", - "type": "DiscreteState", - "eventBased": true, - "persistent": false - }, { "name": "ErrorState", "type": "DataState", @@ -222414,12 +221940,6 @@ "eventBased": false, "persistent": false }, - { - "name": "ErrorEventState", - "type": "DiscreteState", - "eventBased": true, - "persistent": false - }, { "name": "ErrorState", "type": "DataState", @@ -222538,13 +222058,7 @@ "name": "WaterLeakEventState", "type": "DiscreteState", "eventBased": true, - "persistent": false, - "valuePrototypes": [ - { - "type": "STRING", - "description": "string value" - } - ] + "persistent": false }, { "name": "WaterLeakState", @@ -222791,12 +222305,6 @@ "eventBased": false, "persistent": false }, - { - "name": "ErrorEventState", - "type": "DiscreteState", - "eventBased": true, - "persistent": false - }, { "name": "ErrorState", "type": "DataState", @@ -222906,7 +222414,7 @@ "persistent": false }, { - "name": "SmokeDetectionEventState", + "name": "SmokeEventState", "type": "DiscreteState", "eventBased": true, "persistent": false @@ -223201,6 +222709,11 @@ } ] }, + { + "commandName": "closeCommissioning", + "nparams": 0, + "description": "Close the commissioning window.\n" + }, { "commandName": "discover", "nparams": 0, @@ -223248,6 +222761,25 @@ "nparams": 0, "description": "Join an existing setup\n" }, + { + "commandName": "openCommissioning", + "nparams": 1, + "description": "Open the commissioning window to let the device be discovered by other controllers.\nDuration in seconds for which the commissioning window will be open.\n", + "parameters": [ + { + "optional": false, + "sensitive": false, + "valuePrototypes": [ + { + "type": "INT", + "minValue": 1, + "maxValue": 65535, + "description": "integer value between 1 and 65535" + } + ] + } + ] + }, { "commandName": "pair", "nparams": 3, @@ -223424,9 +222956,29 @@ "persistent": false }, { - "name": "ErrorEventState", - "type": "DiscreteState", - "eventBased": true, + "name": "CommissioningWindowCloseTimestampState", + "type": "DataState", + "eventBased": false, + "persistent": false, + "valuePrototypes": [ + { + "type": "INT", + "minValue": 1, + "maxValue": 65535, + "description": "integer value between 1 and 65535" + } + ] + }, + { + "name": "CommissioningWindowOpenState", + "type": "DataState", + "eventBased": false, + "persistent": false + }, + { + "name": "CredentialsState", + "type": "DataState", + "eventBased": false, "persistent": false }, { @@ -223809,12 +223361,6 @@ "eventBased": false, "persistent": false }, - { - "name": "ErrorEventState", - "type": "DiscreteState", - "eventBased": true, - "persistent": false - }, { "name": "ErrorState", "type": "DataState", @@ -224599,12 +224145,6 @@ } ] }, - { - "name": "ErrorEventState", - "type": "DiscreteState", - "eventBased": true, - "persistent": false - }, { "name": "ErrorState", "type": "DataState", @@ -225249,12 +224789,6 @@ "eventBased": false, "persistent": false }, - { - "name": "ErrorEventState", - "type": "DiscreteState", - "eventBased": true, - "persistent": false - }, { "name": "ErrorState", "type": "DataState", @@ -225954,12 +225488,6 @@ "eventBased": false, "persistent": false }, - { - "name": "ErrorEventState", - "type": "DiscreteState", - "eventBased": true, - "persistent": false - }, { "name": "ErrorState", "type": "DataState", @@ -226549,12 +226077,6 @@ } ] }, - { - "name": "ErrorEventState", - "type": "DiscreteState", - "eventBased": true, - "persistent": false - }, { "name": "ErrorState", "type": "DataState", @@ -227137,12 +226659,6 @@ } ] }, - { - "name": "ErrorEventState", - "type": "DiscreteState", - "eventBased": true, - "persistent": false - }, { "name": "ErrorState", "type": "DataState", @@ -227673,12 +227189,6 @@ } ] }, - { - "name": "ErrorEventState", - "type": "DiscreteState", - "eventBased": true, - "persistent": false - }, { "name": "ErrorState", "type": "DataState", @@ -228241,12 +227751,6 @@ } ] }, - { - "name": "ErrorEventState", - "type": "DiscreteState", - "eventBased": true, - "persistent": false - }, { "name": "ErrorState", "type": "DataState", @@ -228787,12 +228291,6 @@ } ] }, - { - "name": "ErrorEventState", - "type": "DiscreteState", - "eventBased": true, - "persistent": false - }, { "name": "ErrorState", "type": "DataState", @@ -229301,12 +228799,6 @@ } ] }, - { - "name": "ErrorEventState", - "type": "DiscreteState", - "eventBased": true, - "persistent": false - }, { "name": "ErrorState", "type": "DataState", @@ -229852,12 +229344,6 @@ } ] }, - { - "name": "ErrorEventState", - "type": "DiscreteState", - "eventBased": true, - "persistent": false - }, { "name": "ErrorState", "type": "DataState", @@ -230452,12 +229938,6 @@ } ] }, - { - "name": "ErrorEventState", - "type": "DiscreteState", - "eventBased": true, - "persistent": false - }, { "name": "ErrorState", "type": "DataState", @@ -231142,12 +230622,6 @@ "eventBased": false, "persistent": false }, - { - "name": "ErrorEventState", - "type": "DiscreteState", - "eventBased": true, - "persistent": false - }, { "name": "ErrorState", "type": "DataState", @@ -231667,12 +231141,6 @@ "eventBased": false, "persistent": false }, - { - "name": "ErrorEventState", - "type": "DiscreteState", - "eventBased": true, - "persistent": false - }, { "name": "ErrorState", "type": "DataState", @@ -232161,12 +231629,6 @@ } ] }, - { - "name": "ErrorEventState", - "type": "DiscreteState", - "eventBased": true, - "persistent": false - }, { "name": "ErrorState", "type": "DataState", @@ -232547,12 +232009,6 @@ "eventBased": false, "persistent": false }, - { - "name": "ErrorEventState", - "type": "DiscreteState", - "eventBased": true, - "persistent": false - }, { "name": "ErrorState", "type": "DataState", @@ -232918,12 +232374,6 @@ "eventBased": false, "persistent": false }, - { - "name": "ErrorEventState", - "type": "DiscreteState", - "eventBased": true, - "persistent": false - }, { "name": "ErrorState", "type": "DataState", @@ -233292,12 +232742,6 @@ "eventBased": false, "persistent": false }, - { - "name": "ErrorEventState", - "type": "DiscreteState", - "eventBased": true, - "persistent": false - }, { "name": "ErrorState", "type": "DataState", @@ -233672,12 +233116,6 @@ "eventBased": false, "persistent": false }, - { - "name": "ErrorEventState", - "type": "DiscreteState", - "eventBased": true, - "persistent": false - }, { "name": "ErrorState", "type": "DataState", @@ -234037,12 +233475,6 @@ "eventBased": false, "persistent": false }, - { - "name": "ErrorEventState", - "type": "DiscreteState", - "eventBased": true, - "persistent": false - }, { "name": "ErrorState", "type": "DataState", @@ -234568,12 +234000,6 @@ } ] }, - { - "name": "ErrorEventState", - "type": "DiscreteState", - "eventBased": true, - "persistent": false - }, { "name": "ErrorState", "type": "DataState", @@ -235154,12 +234580,6 @@ } ] }, - { - "name": "ErrorEventState", - "type": "DiscreteState", - "eventBased": true, - "persistent": false - }, { "name": "ErrorState", "type": "DataState", @@ -235683,12 +235103,6 @@ "eventBased": false, "persistent": false }, - { - "name": "ErrorEventState", - "type": "DiscreteState", - "eventBased": true, - "persistent": false - }, { "name": "ErrorState", "type": "DataState", @@ -236174,12 +235588,6 @@ "eventBased": false, "persistent": false }, - { - "name": "ErrorEventState", - "type": "DiscreteState", - "eventBased": true, - "persistent": false - }, { "name": "ErrorState", "type": "DataState", @@ -236576,12 +235984,6 @@ "eventBased": false, "persistent": false }, - { - "name": "ErrorEventState", - "type": "DiscreteState", - "eventBased": true, - "persistent": false - }, { "name": "ErrorState", "type": "DataState", @@ -236607,7 +236009,7 @@ "persistent": false }, { - "name": "IntrusionDetectionEventState", + "name": "IntrusionEventState", "type": "DiscreteState", "eventBased": true, "persistent": false @@ -237081,12 +236483,6 @@ "eventBased": false, "persistent": false }, - { - "name": "ErrorEventState", - "type": "DiscreteState", - "eventBased": true, - "persistent": false - }, { "name": "ErrorState", "type": "DataState", @@ -237118,7 +236514,7 @@ "persistent": false }, { - "name": "IntrusionDetectionEventState", + "name": "IntrusionEventState", "type": "DiscreteState", "eventBased": true, "persistent": false @@ -237236,7 +236632,7 @@ "persistent": false }, { - "name": "SmokeDetectionEventState", + "name": "SmokeEventState", "type": "DiscreteState", "eventBased": true, "persistent": false @@ -237267,13 +236663,7 @@ "name": "WaterLeakEventState", "type": "DiscreteState", "eventBased": true, - "persistent": false, - "valuePrototypes": [ - { - "type": "STRING", - "description": "string value" - } - ] + "persistent": false }, { "name": "WaterLeakState", @@ -237597,12 +236987,6 @@ "eventBased": false, "persistent": false }, - { - "name": "ErrorEventState", - "type": "DiscreteState", - "eventBased": true, - "persistent": false - }, { "name": "ErrorState", "type": "DataState", @@ -238265,12 +237649,6 @@ "eventBased": false, "persistent": false }, - { - "name": "ErrorEventState", - "type": "DiscreteState", - "eventBased": true, - "persistent": false - }, { "name": "ErrorState", "type": "DataState", @@ -239216,12 +238594,6 @@ "eventBased": false, "persistent": false }, - { - "name": "ErrorEventState", - "type": "DiscreteState", - "eventBased": true, - "persistent": false - }, { "name": "ErrorState", "type": "DataState", @@ -239896,12 +239268,6 @@ "eventBased": false, "persistent": false }, - { - "name": "ErrorEventState", - "type": "DiscreteState", - "eventBased": true, - "persistent": false - }, { "name": "ErrorState", "type": "DataState", @@ -240438,12 +239804,6 @@ } ] }, - { - "name": "ErrorEventState", - "type": "DiscreteState", - "eventBased": true, - "persistent": false - }, { "name": "ErrorState", "type": "DataState", @@ -241109,12 +240469,6 @@ "eventBased": false, "persistent": false }, - { - "name": "ErrorEventState", - "type": "DiscreteState", - "eventBased": true, - "persistent": false - }, { "name": "ErrorState", "type": "DataState", @@ -241163,12 +240517,6 @@ "eventBased": false, "persistent": false }, - { - "name": "MediaElementsEventState", - "type": "DataState", - "eventBased": true, - "persistent": false - }, { "name": "MuteState", "type": "DataState", @@ -241772,12 +241120,6 @@ "eventBased": false, "persistent": false }, - { - "name": "ErrorEventState", - "type": "DiscreteState", - "eventBased": true, - "persistent": false - }, { "name": "ErrorState", "type": "DataState", @@ -242444,12 +241786,6 @@ "eventBased": false, "persistent": false }, - { - "name": "ErrorEventState", - "type": "DiscreteState", - "eventBased": true, - "persistent": false - }, { "name": "ErrorState", "type": "DataState", @@ -242946,12 +242282,6 @@ } ] }, - { - "name": "ErrorEventState", - "type": "DiscreteState", - "eventBased": true, - "persistent": false - }, { "name": "ErrorState", "type": "DataState", @@ -243273,6 +242603,18 @@ } ], "states": [ + { + "name": "ActionEventState", + "type": "DataState", + "eventBased": true, + "persistent": false, + "valuePrototypes": [ + { + "type": "STRING", + "description": "string value" + } + ] + }, { "name": "ActionState", "type": "DataState", @@ -243321,24 +242663,6 @@ "eventBased": false, "persistent": false }, - { - "name": "ButtonActionsEventState", - "type": "DataState", - "eventBased": true, - "persistent": false, - "valuePrototypes": [ - { - "type": "STRING", - "description": "string value" - } - ] - }, - { - "name": "ErrorEventState", - "type": "DiscreteState", - "eventBased": true, - "persistent": false - }, { "name": "ErrorState", "type": "DataState", @@ -243730,12 +243054,6 @@ } ] }, - { - "name": "ErrorEventState", - "type": "DiscreteState", - "eventBased": true, - "persistent": false - }, { "name": "ErrorState", "type": "DataState", @@ -244117,12 +243435,6 @@ "eventBased": false, "persistent": false }, - { - "name": "ErrorEventState", - "type": "DiscreteState", - "eventBased": true, - "persistent": false - }, { "name": "ErrorState", "type": "DataState", @@ -244476,12 +243788,6 @@ "eventBased": false, "persistent": false }, - { - "name": "ErrorEventState", - "type": "DiscreteState", - "eventBased": true, - "persistent": false - }, { "name": "ErrorState", "type": "DataState", @@ -244851,12 +244157,6 @@ "eventBased": false, "persistent": false }, - { - "name": "ErrorEventState", - "type": "DiscreteState", - "eventBased": true, - "persistent": false - }, { "name": "ErrorState", "type": "DataState", @@ -245240,6 +244540,18 @@ } ], "states": [ + { + "name": "ActionEventState", + "type": "DataState", + "eventBased": true, + "persistent": false, + "valuePrototypes": [ + { + "type": "STRING", + "description": "string value" + } + ] + }, { "name": "ActionState", "type": "DataState", @@ -245288,24 +244600,6 @@ "eventBased": false, "persistent": false }, - { - "name": "ButtonActionsEventState", - "type": "DataState", - "eventBased": true, - "persistent": false, - "valuePrototypes": [ - { - "type": "STRING", - "description": "string value" - } - ] - }, - { - "name": "ErrorEventState", - "type": "DiscreteState", - "eventBased": true, - "persistent": false - }, { "name": "ErrorState", "type": "DataState", @@ -245676,12 +244970,6 @@ } ] }, - { - "name": "ErrorEventState", - "type": "DiscreteState", - "eventBased": true, - "persistent": false - }, { "name": "ErrorState", "type": "DataState", @@ -246042,12 +245330,6 @@ "eventBased": false, "persistent": false }, - { - "name": "ErrorEventState", - "type": "DiscreteState", - "eventBased": true, - "persistent": false - }, { "name": "ErrorState", "type": "DataState", @@ -246399,12 +245681,6 @@ "eventBased": false, "persistent": false }, - { - "name": "ErrorEventState", - "type": "DiscreteState", - "eventBased": true, - "persistent": false - }, { "name": "ErrorState", "type": "DataState", @@ -246523,13 +245799,7 @@ "name": "WaterLeakEventState", "type": "DiscreteState", "eventBased": true, - "persistent": false, - "valuePrototypes": [ - { - "type": "STRING", - "description": "string value" - } - ] + "persistent": false }, { "name": "WaterLeakState", @@ -246776,12 +246046,6 @@ "eventBased": false, "persistent": false }, - { - "name": "ErrorEventState", - "type": "DiscreteState", - "eventBased": true, - "persistent": false - }, { "name": "ErrorState", "type": "DataState", @@ -246891,7 +246155,7 @@ "persistent": false }, { - "name": "SmokeDetectionEventState", + "name": "SmokeEventState", "type": "DiscreteState", "eventBased": true, "persistent": false @@ -277116,76 +276380,6 @@ "qualifiedName": "io:WindowOpenerVeluxIOComponent", "type": "ACTUATOR" }, - "jsw:CameraController": { - "commands": [ - { - "commandName": "downloadRecordedFile", - "nparams": 1 - }, - { - "commandName": "listRecordedFiles", - "nparams": 2 - }, - { - "commandName": "connect", - "nparams": 0 - }, - { - "commandName": "deleteRecordedFile", - "nparams": 1 - }, - { - "commandName": "disconnect", - "nparams": 1 - }, - { - "commandName": "getSessionStatus", - "nparams": 1 - }, - { - "commandName": "playJSWRecordedFile", - "nparams": 2 - }, - { - "commandName": "setPassword", - "nparams": 2 - }, - { - "commandName": "startJSWLiveVideo", - "nparams": 1 - }, - { - "commandName": "startJSWRecording", - "nparams": 0 - }, - { - "commandName": "stopJSWLiveVideo", - "nparams": 1 - }, - { - "commandName": "stopJSWPlayRecordedFile", - "nparams": 1 - } - ], - "states": [ - { - "type": "ContinuousState", - "qualifiedName": "core:FreeMemoryState" - }, - { - "type": "ContinuousState", - "qualifiedName": "core:TotalMemoryState" - } - ], - "dataProperties": [], - "widgetName": "JSWCamera", - "uiProfiles": [ - "Specific" - ], - "uiClass": "Camera", - "qualifiedName": "jsw:CameraController", - "type": "ACTUATOR" - }, "modbus:DeDietrichGatewayComponent": { "commands": [ { @@ -284797,29 +283991,6 @@ "type": "ContinuousState", "qualifiedName": "core:CO2ConcentrationState" }, - { - "eventBased": true, - "type": "DiscreteState", - "values": [ - "accessLimitation", - "internal", - "obstacleProtection", - "transportBusy", - "deviceNoAnswer", - "cancelled", - "deprecated", - "interrupted", - "thermalProtection", - "maintenanceRequired", - "alreadyUpToDate", - "notSupported", - "hardwareError", - "accessDenied", - "updateError", - "resourceAlreadyExist" - ], - "qualifiedName": "core:ErrorEventState" - }, { "type": "DataState", "qualifiedName": "core:ErrorState" @@ -285020,29 +284191,6 @@ "type": "ContinuousState", "qualifiedName": "core:ClosureState" }, - { - "eventBased": true, - "type": "DiscreteState", - "values": [ - "accessLimitation", - "internal", - "obstacleProtection", - "transportBusy", - "deviceNoAnswer", - "cancelled", - "deprecated", - "interrupted", - "thermalProtection", - "maintenanceRequired", - "alreadyUpToDate", - "notSupported", - "hardwareError", - "accessDenied", - "updateError", - "resourceAlreadyExist" - ], - "qualifiedName": "core:ErrorEventState" - }, { "type": "DataState", "qualifiedName": "core:ErrorState" @@ -285268,29 +284416,6 @@ "type": "ContinuousState", "qualifiedName": "core:BatteryLevelState" }, - { - "eventBased": true, - "type": "DiscreteState", - "values": [ - "accessLimitation", - "internal", - "obstacleProtection", - "transportBusy", - "deviceNoAnswer", - "cancelled", - "deprecated", - "interrupted", - "thermalProtection", - "maintenanceRequired", - "alreadyUpToDate", - "notSupported", - "hardwareError", - "accessDenied", - "updateError", - "resourceAlreadyExist" - ], - "qualifiedName": "core:ErrorEventState" - }, { "type": "DataState", "qualifiedName": "core:ErrorState" @@ -285315,10 +284440,10 @@ "eventBased": true, "type": "DiscreteState", "values": [ - "panic", - "intrusion" + "false", + "true" ], - "qualifiedName": "core:IntrusionDetectionEventState" + "qualifiedName": "core:IntrusionEventState" }, { "type": "DiscreteState", @@ -285397,9 +284522,10 @@ "eventBased": true, "type": "DiscreteState", "values": [ - "smoke" + "false", + "true" ], - "qualifiedName": "core:SmokeDetectionEventState" + "qualifiedName": "core:SmokeEventState" }, { "eventBased": true, @@ -285422,7 +284548,8 @@ "eventBased": true, "type": "DiscreteState", "values": [ - "waterLeak" + "false", + "true" ], "qualifiedName": "core:WaterLeakEventState" }, @@ -285510,29 +284637,6 @@ "type": "ContinuousState", "qualifiedName": "core:BatteryLevelState" }, - { - "eventBased": true, - "type": "DiscreteState", - "values": [ - "accessLimitation", - "internal", - "obstacleProtection", - "transportBusy", - "deviceNoAnswer", - "cancelled", - "deprecated", - "interrupted", - "thermalProtection", - "maintenanceRequired", - "alreadyUpToDate", - "notSupported", - "hardwareError", - "accessDenied", - "updateError", - "resourceAlreadyExist" - ], - "qualifiedName": "core:ErrorEventState" - }, { "type": "DataState", "qualifiedName": "core:ErrorState" @@ -285777,29 +284881,6 @@ "type": "ContinuousState", "qualifiedName": "core:BatteryLevelState" }, - { - "eventBased": true, - "type": "DiscreteState", - "values": [ - "accessLimitation", - "internal", - "obstacleProtection", - "transportBusy", - "deviceNoAnswer", - "cancelled", - "deprecated", - "interrupted", - "thermalProtection", - "maintenanceRequired", - "alreadyUpToDate", - "notSupported", - "hardwareError", - "accessDenied", - "updateError", - "resourceAlreadyExist" - ], - "qualifiedName": "core:ErrorEventState" - }, { "type": "DataState", "qualifiedName": "core:ErrorState" @@ -285832,11 +284913,6 @@ "type": "DataState", "qualifiedName": "core:MediaElementState" }, - { - "eventBased": true, - "type": "DataState", - "qualifiedName": "core:MediaElementsEventState" - }, { "type": "DataState", "qualifiedName": "core:MuteState" @@ -286068,29 +285144,6 @@ "type": "ContinuousState", "qualifiedName": "core:DeploymentState" }, - { - "eventBased": true, - "type": "DiscreteState", - "values": [ - "accessLimitation", - "internal", - "obstacleProtection", - "transportBusy", - "deviceNoAnswer", - "cancelled", - "deprecated", - "interrupted", - "thermalProtection", - "maintenanceRequired", - "alreadyUpToDate", - "notSupported", - "hardwareError", - "accessDenied", - "updateError", - "resourceAlreadyExist" - ], - "qualifiedName": "core:ErrorEventState" - }, { "type": "DataState", "qualifiedName": "core:ErrorState" @@ -286291,29 +285344,6 @@ "type": "ContinuousState", "qualifiedName": "core:ClosureState" }, - { - "eventBased": true, - "type": "DiscreteState", - "values": [ - "accessLimitation", - "internal", - "obstacleProtection", - "transportBusy", - "deviceNoAnswer", - "cancelled", - "deprecated", - "interrupted", - "thermalProtection", - "maintenanceRequired", - "alreadyUpToDate", - "notSupported", - "hardwareError", - "accessDenied", - "updateError", - "resourceAlreadyExist" - ], - "qualifiedName": "core:ErrorEventState" - }, { "type": "DataState", "qualifiedName": "core:ErrorState" @@ -286430,6 +285460,10 @@ "commandName": "associateCandidate", "nparams": 1 }, + { + "commandName": "closeCommissioning", + "nparams": 0 + }, { "commandName": "discover", "nparams": 0 @@ -286450,6 +285484,10 @@ "commandName": "joinSetup", "nparams": 0 }, + { + "commandName": "openCommissioning", + "nparams": 1 + }, { "commandName": "pair", "nparams": 0 @@ -286523,27 +285561,16 @@ "qualifiedName": "core:CandidatesState" }, { - "eventBased": true, - "type": "DiscreteState", - "values": [ - "accessLimitation", - "internal", - "obstacleProtection", - "transportBusy", - "deviceNoAnswer", - "cancelled", - "deprecated", - "interrupted", - "thermalProtection", - "maintenanceRequired", - "alreadyUpToDate", - "notSupported", - "hardwareError", - "accessDenied", - "updateError", - "resourceAlreadyExist" - ], - "qualifiedName": "core:ErrorEventState" + "type": "DataState", + "qualifiedName": "core:CommissioningWindowCloseTimestampState" + }, + { + "type": "DataState", + "qualifiedName": "core:CommissioningWindowOpenState" + }, + { + "type": "DataState", + "qualifiedName": "core:CredentialsState" }, { "type": "DataState", @@ -286697,29 +285724,6 @@ "type": "ContinuousState", "qualifiedName": "core:CO2ConcentrationState" }, - { - "eventBased": true, - "type": "DiscreteState", - "values": [ - "accessLimitation", - "internal", - "obstacleProtection", - "transportBusy", - "deviceNoAnswer", - "cancelled", - "deprecated", - "interrupted", - "thermalProtection", - "maintenanceRequired", - "alreadyUpToDate", - "notSupported", - "hardwareError", - "accessDenied", - "updateError", - "resourceAlreadyExist" - ], - "qualifiedName": "core:ErrorEventState" - }, { "type": "DataState", "qualifiedName": "core:ErrorState" @@ -286892,29 +285896,6 @@ "type": "ContinuousState", "qualifiedName": "core:BatteryLevelState" }, - { - "eventBased": true, - "type": "DiscreteState", - "values": [ - "accessLimitation", - "internal", - "obstacleProtection", - "transportBusy", - "deviceNoAnswer", - "cancelled", - "deprecated", - "interrupted", - "thermalProtection", - "maintenanceRequired", - "alreadyUpToDate", - "notSupported", - "hardwareError", - "accessDenied", - "updateError", - "resourceAlreadyExist" - ], - "qualifiedName": "core:ErrorEventState" - }, { "type": "DataState", "qualifiedName": "core:ErrorState" @@ -287106,29 +286087,6 @@ "type": "ContinuousState", "qualifiedName": "core:ClosureState" }, - { - "eventBased": true, - "type": "DiscreteState", - "values": [ - "accessLimitation", - "internal", - "obstacleProtection", - "transportBusy", - "deviceNoAnswer", - "cancelled", - "deprecated", - "interrupted", - "thermalProtection", - "maintenanceRequired", - "alreadyUpToDate", - "notSupported", - "hardwareError", - "accessDenied", - "updateError", - "resourceAlreadyExist" - ], - "qualifiedName": "core:ErrorEventState" - }, { "type": "DataState", "qualifiedName": "core:ErrorState" @@ -287349,29 +286307,6 @@ "type": "ContinuousState", "qualifiedName": "core:BatteryLevelState" }, - { - "eventBased": true, - "type": "DiscreteState", - "values": [ - "accessLimitation", - "internal", - "obstacleProtection", - "transportBusy", - "deviceNoAnswer", - "cancelled", - "deprecated", - "interrupted", - "thermalProtection", - "maintenanceRequired", - "alreadyUpToDate", - "notSupported", - "hardwareError", - "accessDenied", - "updateError", - "resourceAlreadyExist" - ], - "qualifiedName": "core:ErrorEventState" - }, { "type": "DataState", "qualifiedName": "core:ErrorState" @@ -287588,29 +286523,6 @@ "type": "ContinuousState", "qualifiedName": "core:ElectricPowerConsumptionState" }, - { - "eventBased": true, - "type": "DiscreteState", - "values": [ - "accessLimitation", - "internal", - "obstacleProtection", - "transportBusy", - "deviceNoAnswer", - "cancelled", - "deprecated", - "interrupted", - "thermalProtection", - "maintenanceRequired", - "alreadyUpToDate", - "notSupported", - "hardwareError", - "accessDenied", - "updateError", - "resourceAlreadyExist" - ], - "qualifiedName": "core:ErrorEventState" - }, { "type": "DataState", "qualifiedName": "core:ErrorState" @@ -287797,29 +286709,6 @@ "type": "ContinuousState", "qualifiedName": "core:ClosureState" }, - { - "eventBased": true, - "type": "DiscreteState", - "values": [ - "accessLimitation", - "internal", - "obstacleProtection", - "transportBusy", - "deviceNoAnswer", - "cancelled", - "deprecated", - "interrupted", - "thermalProtection", - "maintenanceRequired", - "alreadyUpToDate", - "notSupported", - "hardwareError", - "accessDenied", - "updateError", - "resourceAlreadyExist" - ], - "qualifiedName": "core:ErrorEventState" - }, { "type": "DataState", "qualifiedName": "core:ErrorState" @@ -287989,29 +286878,6 @@ "type": "ContinuousState", "qualifiedName": "core:BatteryLevelState" }, - { - "eventBased": true, - "type": "DiscreteState", - "values": [ - "accessLimitation", - "internal", - "obstacleProtection", - "transportBusy", - "deviceNoAnswer", - "cancelled", - "deprecated", - "interrupted", - "thermalProtection", - "maintenanceRequired", - "alreadyUpToDate", - "notSupported", - "hardwareError", - "accessDenied", - "updateError", - "resourceAlreadyExist" - ], - "qualifiedName": "core:ErrorEventState" - }, { "type": "DataState", "qualifiedName": "core:ErrorState" @@ -288204,29 +287070,6 @@ "type": "ContinuousState", "qualifiedName": "core:ClosureState" }, - { - "eventBased": true, - "type": "DiscreteState", - "values": [ - "accessLimitation", - "internal", - "obstacleProtection", - "transportBusy", - "deviceNoAnswer", - "cancelled", - "deprecated", - "interrupted", - "thermalProtection", - "maintenanceRequired", - "alreadyUpToDate", - "notSupported", - "hardwareError", - "accessDenied", - "updateError", - "resourceAlreadyExist" - ], - "qualifiedName": "core:ErrorEventState" - }, { "type": "DataState", "qualifiedName": "core:ErrorState" @@ -288412,29 +287255,6 @@ "type": "ContinuousState", "qualifiedName": "core:BatteryLevelState" }, - { - "eventBased": true, - "type": "DiscreteState", - "values": [ - "accessLimitation", - "internal", - "obstacleProtection", - "transportBusy", - "deviceNoAnswer", - "cancelled", - "deprecated", - "interrupted", - "thermalProtection", - "maintenanceRequired", - "alreadyUpToDate", - "notSupported", - "hardwareError", - "accessDenied", - "updateError", - "resourceAlreadyExist" - ], - "qualifiedName": "core:ErrorEventState" - }, { "type": "DataState", "qualifiedName": "core:ErrorState" @@ -288676,29 +287496,6 @@ "type": "ContinuousState", "qualifiedName": "core:ElectricPowerConsumptionState" }, - { - "eventBased": true, - "type": "DiscreteState", - "values": [ - "accessLimitation", - "internal", - "obstacleProtection", - "transportBusy", - "deviceNoAnswer", - "cancelled", - "deprecated", - "interrupted", - "thermalProtection", - "maintenanceRequired", - "alreadyUpToDate", - "notSupported", - "hardwareError", - "accessDenied", - "updateError", - "resourceAlreadyExist" - ], - "qualifiedName": "core:ErrorEventState" - }, { "type": "DataState", "qualifiedName": "core:ErrorState" @@ -288915,29 +287712,6 @@ "type": "ContinuousState", "qualifiedName": "core:BatteryLevelState" }, - { - "eventBased": true, - "type": "DiscreteState", - "values": [ - "accessLimitation", - "internal", - "obstacleProtection", - "transportBusy", - "deviceNoAnswer", - "cancelled", - "deprecated", - "interrupted", - "thermalProtection", - "maintenanceRequired", - "alreadyUpToDate", - "notSupported", - "hardwareError", - "accessDenied", - "updateError", - "resourceAlreadyExist" - ], - "qualifiedName": "core:ErrorEventState" - }, { "type": "DataState", "qualifiedName": "core:ErrorState" @@ -289150,29 +287924,6 @@ "type": "ContinuousState", "qualifiedName": "core:BatteryLevelState" }, - { - "eventBased": true, - "type": "DiscreteState", - "values": [ - "accessLimitation", - "internal", - "obstacleProtection", - "transportBusy", - "deviceNoAnswer", - "cancelled", - "deprecated", - "interrupted", - "thermalProtection", - "maintenanceRequired", - "alreadyUpToDate", - "notSupported", - "hardwareError", - "accessDenied", - "updateError", - "resourceAlreadyExist" - ], - "qualifiedName": "core:ErrorEventState" - }, { "type": "DataState", "qualifiedName": "core:ErrorState" @@ -289469,29 +288220,6 @@ "type": "ContinuousState", "qualifiedName": "core:BatteryLevelState" }, - { - "eventBased": true, - "type": "DiscreteState", - "values": [ - "accessLimitation", - "internal", - "obstacleProtection", - "transportBusy", - "deviceNoAnswer", - "cancelled", - "deprecated", - "interrupted", - "thermalProtection", - "maintenanceRequired", - "alreadyUpToDate", - "notSupported", - "hardwareError", - "accessDenied", - "updateError", - "resourceAlreadyExist" - ], - "qualifiedName": "core:ErrorEventState" - }, { "type": "DataState", "qualifiedName": "core:ErrorState" @@ -289728,29 +288456,6 @@ "type": "ContinuousState", "qualifiedName": "core:BatteryLevelState" }, - { - "eventBased": true, - "type": "DiscreteState", - "values": [ - "accessLimitation", - "internal", - "obstacleProtection", - "transportBusy", - "deviceNoAnswer", - "cancelled", - "deprecated", - "interrupted", - "thermalProtection", - "maintenanceRequired", - "alreadyUpToDate", - "notSupported", - "hardwareError", - "accessDenied", - "updateError", - "resourceAlreadyExist" - ], - "qualifiedName": "core:ErrorEventState" - }, { "type": "DataState", "qualifiedName": "core:ErrorState" @@ -289771,10 +288476,10 @@ "eventBased": true, "type": "DiscreteState", "values": [ - "panic", - "intrusion" + "false", + "true" ], - "qualifiedName": "core:IntrusionDetectionEventState" + "qualifiedName": "core:IntrusionEventState" }, { "type": "DiscreteState", @@ -290003,29 +288708,6 @@ "type": "ContinuousState", "qualifiedName": "core:ElectricPowerConsumptionState" }, - { - "eventBased": true, - "type": "DiscreteState", - "values": [ - "accessLimitation", - "internal", - "obstacleProtection", - "transportBusy", - "deviceNoAnswer", - "cancelled", - "deprecated", - "interrupted", - "thermalProtection", - "maintenanceRequired", - "alreadyUpToDate", - "notSupported", - "hardwareError", - "accessDenied", - "updateError", - "resourceAlreadyExist" - ], - "qualifiedName": "core:ErrorEventState" - }, { "type": "DataState", "qualifiedName": "core:ErrorState" @@ -290204,29 +288886,6 @@ "type": "ContinuousState", "qualifiedName": "core:BatteryLevelState" }, - { - "eventBased": true, - "type": "DiscreteState", - "values": [ - "accessLimitation", - "internal", - "obstacleProtection", - "transportBusy", - "deviceNoAnswer", - "cancelled", - "deprecated", - "interrupted", - "thermalProtection", - "maintenanceRequired", - "alreadyUpToDate", - "notSupported", - "hardwareError", - "accessDenied", - "updateError", - "resourceAlreadyExist" - ], - "qualifiedName": "core:ErrorEventState" - }, { "type": "DataState", "qualifiedName": "core:ErrorState" @@ -290383,29 +289042,6 @@ "type": "ContinuousState", "qualifiedName": "core:BatteryLevelState" }, - { - "eventBased": true, - "type": "DiscreteState", - "values": [ - "accessLimitation", - "internal", - "obstacleProtection", - "transportBusy", - "deviceNoAnswer", - "cancelled", - "deprecated", - "interrupted", - "thermalProtection", - "maintenanceRequired", - "alreadyUpToDate", - "notSupported", - "hardwareError", - "accessDenied", - "updateError", - "resourceAlreadyExist" - ], - "qualifiedName": "core:ErrorEventState" - }, { "type": "DataState", "qualifiedName": "core:ErrorState" @@ -290563,29 +289199,6 @@ "type": "ContinuousState", "qualifiedName": "core:BatteryLevelState" }, - { - "eventBased": true, - "type": "DiscreteState", - "values": [ - "accessLimitation", - "internal", - "obstacleProtection", - "transportBusy", - "deviceNoAnswer", - "cancelled", - "deprecated", - "interrupted", - "thermalProtection", - "maintenanceRequired", - "alreadyUpToDate", - "notSupported", - "hardwareError", - "accessDenied", - "updateError", - "resourceAlreadyExist" - ], - "qualifiedName": "core:ErrorEventState" - }, { "type": "DataState", "qualifiedName": "core:ErrorState" @@ -290787,29 +289400,6 @@ "type": "ContinuousState", "qualifiedName": "core:ElectricPowerConsumptionState" }, - { - "eventBased": true, - "type": "DiscreteState", - "values": [ - "accessLimitation", - "internal", - "obstacleProtection", - "transportBusy", - "deviceNoAnswer", - "cancelled", - "deprecated", - "interrupted", - "thermalProtection", - "maintenanceRequired", - "alreadyUpToDate", - "notSupported", - "hardwareError", - "accessDenied", - "updateError", - "resourceAlreadyExist" - ], - "qualifiedName": "core:ErrorEventState" - }, { "type": "DataState", "qualifiedName": "core:ErrorState" @@ -291096,29 +289686,6 @@ "type": "DataState", "qualifiedName": "core:CycleStageSequenceState" }, - { - "eventBased": true, - "type": "DiscreteState", - "values": [ - "accessLimitation", - "internal", - "obstacleProtection", - "transportBusy", - "deviceNoAnswer", - "cancelled", - "deprecated", - "interrupted", - "thermalProtection", - "maintenanceRequired", - "alreadyUpToDate", - "notSupported", - "hardwareError", - "accessDenied", - "updateError", - "resourceAlreadyExist" - ], - "qualifiedName": "core:ErrorEventState" - }, { "type": "DataState", "qualifiedName": "core:ErrorState" @@ -291492,29 +290059,6 @@ "type": "ContinuousState", "qualifiedName": "core:ClosureState" }, - { - "eventBased": true, - "type": "DiscreteState", - "values": [ - "accessLimitation", - "internal", - "obstacleProtection", - "transportBusy", - "deviceNoAnswer", - "cancelled", - "deprecated", - "interrupted", - "thermalProtection", - "maintenanceRequired", - "alreadyUpToDate", - "notSupported", - "hardwareError", - "accessDenied", - "updateError", - "resourceAlreadyExist" - ], - "qualifiedName": "core:ErrorEventState" - }, { "type": "DataState", "qualifiedName": "core:ErrorState" @@ -291701,29 +290245,6 @@ "type": "ContinuousState", "qualifiedName": "core:BatteryLevelState" }, - { - "eventBased": true, - "type": "DiscreteState", - "values": [ - "accessLimitation", - "internal", - "obstacleProtection", - "transportBusy", - "deviceNoAnswer", - "cancelled", - "deprecated", - "interrupted", - "thermalProtection", - "maintenanceRequired", - "alreadyUpToDate", - "notSupported", - "hardwareError", - "accessDenied", - "updateError", - "resourceAlreadyExist" - ], - "qualifiedName": "core:ErrorEventState" - }, { "type": "DataState", "qualifiedName": "core:ErrorState" @@ -291888,29 +290409,6 @@ "type": "ContinuousState", "qualifiedName": "core:BatteryLevelState" }, - { - "eventBased": true, - "type": "DiscreteState", - "values": [ - "accessLimitation", - "internal", - "obstacleProtection", - "transportBusy", - "deviceNoAnswer", - "cancelled", - "deprecated", - "interrupted", - "thermalProtection", - "maintenanceRequired", - "alreadyUpToDate", - "notSupported", - "hardwareError", - "accessDenied", - "updateError", - "resourceAlreadyExist" - ], - "qualifiedName": "core:ErrorEventState" - }, { "type": "DataState", "qualifiedName": "core:ErrorState" @@ -292037,6 +290535,11 @@ } ], "states": [ + { + "eventBased": true, + "type": "DataState", + "qualifiedName": "core:ActionEventState" + }, { "type": "DataState", "qualifiedName": "core:ActionState" @@ -292071,34 +290574,6 @@ "type": "ContinuousState", "qualifiedName": "core:BatteryLevelState" }, - { - "eventBased": true, - "type": "DataState", - "qualifiedName": "core:ButtonActionsEventState" - }, - { - "eventBased": true, - "type": "DiscreteState", - "values": [ - "accessLimitation", - "internal", - "obstacleProtection", - "transportBusy", - "deviceNoAnswer", - "cancelled", - "deprecated", - "interrupted", - "thermalProtection", - "maintenanceRequired", - "alreadyUpToDate", - "notSupported", - "hardwareError", - "accessDenied", - "updateError", - "resourceAlreadyExist" - ], - "qualifiedName": "core:ErrorEventState" - }, { "type": "DataState", "qualifiedName": "core:ErrorState" @@ -292313,29 +290788,6 @@ "type": "ContinuousState", "qualifiedName": "core:ClosureState" }, - { - "eventBased": true, - "type": "DiscreteState", - "values": [ - "accessLimitation", - "internal", - "obstacleProtection", - "transportBusy", - "deviceNoAnswer", - "cancelled", - "deprecated", - "interrupted", - "thermalProtection", - "maintenanceRequired", - "alreadyUpToDate", - "notSupported", - "hardwareError", - "accessDenied", - "updateError", - "resourceAlreadyExist" - ], - "qualifiedName": "core:ErrorEventState" - }, { "type": "DataState", "qualifiedName": "core:ErrorState" @@ -292521,29 +290973,6 @@ "type": "ContinuousState", "qualifiedName": "core:BatteryLevelState" }, - { - "eventBased": true, - "type": "DiscreteState", - "values": [ - "accessLimitation", - "internal", - "obstacleProtection", - "transportBusy", - "deviceNoAnswer", - "cancelled", - "deprecated", - "interrupted", - "thermalProtection", - "maintenanceRequired", - "alreadyUpToDate", - "notSupported", - "hardwareError", - "accessDenied", - "updateError", - "resourceAlreadyExist" - ], - "qualifiedName": "core:ErrorEventState" - }, { "type": "DataState", "qualifiedName": "core:ErrorState" @@ -292620,9 +291049,10 @@ "eventBased": true, "type": "DiscreteState", "values": [ - "smoke" + "false", + "true" ], - "qualifiedName": "core:SmokeDetectionEventState" + "qualifiedName": "core:SmokeEventState" }, { "eventBased": true, @@ -292687,6 +291117,11 @@ } ], "states": [ + { + "eventBased": true, + "type": "DataState", + "qualifiedName": "core:ActionEventState" + }, { "type": "DataState", "qualifiedName": "core:ActionState" @@ -292721,34 +291156,6 @@ "type": "ContinuousState", "qualifiedName": "core:BatteryLevelState" }, - { - "eventBased": true, - "type": "DataState", - "qualifiedName": "core:ButtonActionsEventState" - }, - { - "eventBased": true, - "type": "DiscreteState", - "values": [ - "accessLimitation", - "internal", - "obstacleProtection", - "transportBusy", - "deviceNoAnswer", - "cancelled", - "deprecated", - "interrupted", - "thermalProtection", - "maintenanceRequired", - "alreadyUpToDate", - "notSupported", - "hardwareError", - "accessDenied", - "updateError", - "resourceAlreadyExist" - ], - "qualifiedName": "core:ErrorEventState" - }, { "type": "DataState", "qualifiedName": "core:ErrorState" @@ -292898,29 +291305,6 @@ "type": "ContinuousState", "qualifiedName": "core:BatteryLevelState" }, - { - "eventBased": true, - "type": "DiscreteState", - "values": [ - "accessLimitation", - "internal", - "obstacleProtection", - "transportBusy", - "deviceNoAnswer", - "cancelled", - "deprecated", - "interrupted", - "thermalProtection", - "maintenanceRequired", - "alreadyUpToDate", - "notSupported", - "hardwareError", - "accessDenied", - "updateError", - "resourceAlreadyExist" - ], - "qualifiedName": "core:ErrorEventState" - }, { "type": "DataState", "qualifiedName": "core:ErrorState" @@ -293125,29 +291509,6 @@ "type": "ContinuousState", "qualifiedName": "core:BatteryLevelState" }, - { - "eventBased": true, - "type": "DiscreteState", - "values": [ - "accessLimitation", - "internal", - "obstacleProtection", - "transportBusy", - "deviceNoAnswer", - "cancelled", - "deprecated", - "interrupted", - "thermalProtection", - "maintenanceRequired", - "alreadyUpToDate", - "notSupported", - "hardwareError", - "accessDenied", - "updateError", - "resourceAlreadyExist" - ], - "qualifiedName": "core:ErrorEventState" - }, { "type": "DataState", "qualifiedName": "core:ErrorState" @@ -293396,29 +291757,6 @@ "type": "ContinuousState", "qualifiedName": "core:BatteryLevelState" }, - { - "eventBased": true, - "type": "DiscreteState", - "values": [ - "accessLimitation", - "internal", - "obstacleProtection", - "transportBusy", - "deviceNoAnswer", - "cancelled", - "deprecated", - "interrupted", - "thermalProtection", - "maintenanceRequired", - "alreadyUpToDate", - "notSupported", - "hardwareError", - "accessDenied", - "updateError", - "resourceAlreadyExist" - ], - "qualifiedName": "core:ErrorEventState" - }, { "type": "DataState", "qualifiedName": "core:ErrorState" @@ -293677,29 +292015,6 @@ "type": "ContinuousState", "qualifiedName": "core:ClosureState" }, - { - "eventBased": true, - "type": "DiscreteState", - "values": [ - "accessLimitation", - "internal", - "obstacleProtection", - "transportBusy", - "deviceNoAnswer", - "cancelled", - "deprecated", - "interrupted", - "thermalProtection", - "maintenanceRequired", - "alreadyUpToDate", - "notSupported", - "hardwareError", - "accessDenied", - "updateError", - "resourceAlreadyExist" - ], - "qualifiedName": "core:ErrorEventState" - }, { "type": "DataState", "qualifiedName": "core:ErrorState" @@ -293930,29 +292245,6 @@ "type": "ContinuousState", "qualifiedName": "core:BatteryLevelState" }, - { - "eventBased": true, - "type": "DiscreteState", - "values": [ - "accessLimitation", - "internal", - "obstacleProtection", - "transportBusy", - "deviceNoAnswer", - "cancelled", - "deprecated", - "interrupted", - "thermalProtection", - "maintenanceRequired", - "alreadyUpToDate", - "notSupported", - "hardwareError", - "accessDenied", - "updateError", - "resourceAlreadyExist" - ], - "qualifiedName": "core:ErrorEventState" - }, { "type": "DataState", "qualifiedName": "core:ErrorState" @@ -294244,29 +292536,6 @@ "type": "DataState", "qualifiedName": "core:CycleStageSequenceState" }, - { - "eventBased": true, - "type": "DiscreteState", - "values": [ - "accessLimitation", - "internal", - "obstacleProtection", - "transportBusy", - "deviceNoAnswer", - "cancelled", - "deprecated", - "interrupted", - "thermalProtection", - "maintenanceRequired", - "alreadyUpToDate", - "notSupported", - "hardwareError", - "accessDenied", - "updateError", - "resourceAlreadyExist" - ], - "qualifiedName": "core:ErrorEventState" - }, { "type": "DataState", "qualifiedName": "core:ErrorState" @@ -294541,29 +292810,6 @@ "type": "ContinuousState", "qualifiedName": "core:BatteryLevelState" }, - { - "eventBased": true, - "type": "DiscreteState", - "values": [ - "accessLimitation", - "internal", - "obstacleProtection", - "transportBusy", - "deviceNoAnswer", - "cancelled", - "deprecated", - "interrupted", - "thermalProtection", - "maintenanceRequired", - "alreadyUpToDate", - "notSupported", - "hardwareError", - "accessDenied", - "updateError", - "resourceAlreadyExist" - ], - "qualifiedName": "core:ErrorEventState" - }, { "type": "DataState", "qualifiedName": "core:ErrorState" @@ -294648,7 +292894,8 @@ "eventBased": true, "type": "DiscreteState", "values": [ - "waterLeak" + "false", + "true" ], "qualifiedName": "core:WaterLeakEventState" }, @@ -294728,29 +292975,6 @@ "type": "ContinuousState", "qualifiedName": "core:BatteryLevelState" }, - { - "eventBased": true, - "type": "DiscreteState", - "values": [ - "accessLimitation", - "internal", - "obstacleProtection", - "transportBusy", - "deviceNoAnswer", - "cancelled", - "deprecated", - "interrupted", - "thermalProtection", - "maintenanceRequired", - "alreadyUpToDate", - "notSupported", - "hardwareError", - "accessDenied", - "updateError", - "resourceAlreadyExist" - ], - "qualifiedName": "core:ErrorEventState" - }, { "type": "DataState", "qualifiedName": "core:ErrorState" @@ -294907,29 +293131,6 @@ "type": "ContinuousState", "qualifiedName": "core:BatteryLevelState" }, - { - "eventBased": true, - "type": "DiscreteState", - "values": [ - "accessLimitation", - "internal", - "obstacleProtection", - "transportBusy", - "deviceNoAnswer", - "cancelled", - "deprecated", - "interrupted", - "thermalProtection", - "maintenanceRequired", - "alreadyUpToDate", - "notSupported", - "hardwareError", - "accessDenied", - "updateError", - "resourceAlreadyExist" - ], - "qualifiedName": "core:ErrorEventState" - }, { "type": "DataState", "qualifiedName": "core:ErrorState" @@ -295140,29 +293341,6 @@ "type": "ContinuousState", "qualifiedName": "core:BatteryLevelState" }, - { - "eventBased": true, - "type": "DiscreteState", - "values": [ - "accessLimitation", - "internal", - "obstacleProtection", - "transportBusy", - "deviceNoAnswer", - "cancelled", - "deprecated", - "interrupted", - "thermalProtection", - "maintenanceRequired", - "alreadyUpToDate", - "notSupported", - "hardwareError", - "accessDenied", - "updateError", - "resourceAlreadyExist" - ], - "qualifiedName": "core:ErrorEventState" - }, { "type": "DataState", "qualifiedName": "core:ErrorState" @@ -295373,29 +293551,6 @@ "type": "ContinuousState", "qualifiedName": "core:ClosureState" }, - { - "eventBased": true, - "type": "DiscreteState", - "values": [ - "accessLimitation", - "internal", - "obstacleProtection", - "transportBusy", - "deviceNoAnswer", - "cancelled", - "deprecated", - "interrupted", - "thermalProtection", - "maintenanceRequired", - "alreadyUpToDate", - "notSupported", - "hardwareError", - "accessDenied", - "updateError", - "resourceAlreadyExist" - ], - "qualifiedName": "core:ErrorEventState" - }, { "type": "DataState", "qualifiedName": "core:ErrorState" diff --git a/docs/device-types.md b/docs/device-types.md index 2feb7db0..f374d4a9 100644 --- a/docs/device-types.md +++ b/docs/device-types.md @@ -10,7 +10,7 @@ This page lists all known device types from the Overkiz API, grouped by protocol !!! note This page is auto-generated from the Overkiz API. Run `uv run utils/generate_device_catalog.py` to regenerate. -**35 protocols**, **577 unique device types** documented below. +**35 protocols**, **661 unique device types** documented below. ## Protocols @@ -33,8 +33,8 @@ This page lists all known device types from the Overkiz API, grouped by protocol - [MYFOX](#myfox) (9 types) - [NEST](#nest) (4 types) - [NETATMO](#netatmo) (36 types) -- [OGCP](#ogcp) (50 types) -- [OGP](#ogp) (50 types) +- [OGCP](#ogcp) (92 types) +- [OGP](#ogp) (92 types) - [OPENDOORS](#opendoors) (1 types) - [OVP](#ovp) (26 types) - [PROFALUX_868](#profalux_868) (5 types) @@ -7497,7 +7497,7 @@ This page lists all known device types from the Overkiz API, grouped by protocol ??? note "Camera/JSWCamera (ACTUATOR) — 12 commands, 2 states" - **Type IDs:** `0` | **Servers:** `rexel`, `somfy_europe` | **Controllable:** `jsw:CameraController` | **Profiles:** `Specific` + **Type IDs:** `0` | **Servers:** `rexel` | **Controllable:** `jsw:CameraController` | **Profiles:** `Specific` **Commands** @@ -10786,11 +10786,11 @@ This page lists all known device types from the Overkiz API, grouped by protocol ## OGCP -50 device types. +92 device types. ??? note "AirSensor/DynamicAirSensor (SENSOR) — 7 commands, 26 states" - **Type IDs:** `304` | **Servers:** `rexel`, `somfy_europe` | **Controllable:** `ogp:AirSensor` | **Profiles:** `CO2Concentration` + **Type IDs:** `304` | **Servers:** `rexel` | **Controllable:** `ogp:AirSensor` | **Profiles:** `CO2Concentration` **Commands** @@ -10835,6 +10835,52 @@ This page lists all known device types from the Overkiz API, grouped by protocol | `SignalQualityState` | ContinuousState | | | | `StatusState` | DiscreteState | available, unavailable | | +??? note "AirSensor/DynamicAirSensor (SENSOR) — 7 commands, 25 states" + + **Type IDs:** `304` | **Servers:** `somfy_europe` | **Controllable:** `ogp:AirSensor` | **Profiles:** `CO2Concentration` + + **Commands** + + | Command | Parameters | Notes | + |---------|-----------|-------| + | `executeManufacturerProcedure` | STRING; OBJECT (optional) | execute manufacturer procedure command. p1: the procedure name p2: the params associated Example: p1 = "dead_man_up" p2 = {"duration": 42} | + | `identify` | | Ask the device to identify itself by doing a slight movement or blink or beep | + | `readManufacturerData` | ARRAY | Read manufacturer data values from given names. Example: ["setting1","setting2"]. | + | `sendPrivate` | OBJECT | send a private command | + | `setName` | STRING | Change the device internal name. Name length may be subject to restrictions depending on the device and underlying protocol. | + | `update` | | Update the gateway software. The update may have to be downloaded first, which can take a while. | + | `writeManufacturerData` | OBJECT | Write manufacturer data values. Example: { "setting1": true, "setting2": 42, "setting3": "overkiz", "setting4": "Dk8PDr1WD0sfAAAAAAAAAAAAAAAAAAAA", "setting5": [ "valueA", "valueB", "valueC" ], "setting6": { "value": 15, "definition": 158 } } | + + **States** + + | State | Type | Range / Values | Notes | + |-------|------|----------------|-------| + | `ActivePartitionState` | DataState | | | + | `AirQualityIndexLevelState` | DiscreteState | good, moderate, unhealthyForSensitiveGroups, unhealthy, veryUnhealthy, hazardous | | + | `AvailabilityState` | DiscreteState | available, unavailable | | + | `BatteryDiscreteLevelState` | DiscreteState | good, medium, low, critical | | + | `BatteryLevelState` | ContinuousState | | | + | `CO2ConcentrationState` | ContinuousState | | | + | `ErrorState` | DataState | | | + | `ErrorsState` | DataState | | | + | `FirmwareHashState` | DataState | | | + | `FirmwareRevisionState` | DataState | | | + | `NameState` | DataState | | | + | `NewFirmwareAvailableState` | DataState | | | + | `Private10State` | DataState | | | + | `Private1State` | DataState | | | + | `Private2State` | DataState | | | + | `Private3State` | DataState | | | + | `Private4State` | DataState | | | + | `Private5State` | DataState | | | + | `Private6State` | DataState | | | + | `Private7State` | DataState | | | + | `Private8State` | DataState | | | + | `Private9State` | DataState | | | + | `RemovableState` | DataState | | | + | `SignalQualityState` | ContinuousState | | | + | `StatusState` | DiscreteState | available, unavailable | | + ??? note "Alarm/DynamicAlarm (ACTUATOR) — 13 commands, 33 states" **Type IDs:** `282` | **Servers:** `rexel` | **Controllable:** `ogp:Alarm` | **Profiles:** `SmokeDetector`, `IntrusionDetector`, `StatefulAlarm`, `Alarm` @@ -10867,13 +10913,13 @@ This page lists all known device types from the Overkiz API, grouped by protocol | `AvailableModesState` | DataState | | | | `BatteryDiscreteLevelState` | DiscreteState | good, medium, low, critical | | | `BatteryLevelState` | ContinuousState | | | - | `ErrorEventState` | DiscreteState | accessLimitation, internal, obstacleProtection, transportBusy, deviceNoAnswer, cancelled, deprecated, interrupted, thermalProtection, maintenanceRequired, alreadyUpToDate, notSupported, hardwareError, accessDenied, updateError, resourceAlreadyExist | | + | `ErrorEventState` | DiscreteState | | | | `ErrorState` | DataState | | | | `ErrorsState` | DataState | | | | `FirmwareHashState` | DataState | | | | `FirmwareRevisionState` | DataState | | | | `GroupMembersState` | DataState | | | - | `IntrusionDetectionEventState` | DiscreteState | panic, intrusion | | + | `IntrusionDetectionEventState` | DiscreteState | | | | `IntrusionState` | DiscreteState | detected, notDetected | | | `ModeState` | DataState | | | | `NameState` | DataState | | | @@ -10891,11 +10937,11 @@ This page lists all known device types from the Overkiz API, grouped by protocol | `Private9State` | DataState | | | | `RemovableState` | DataState | | | | `SignalQualityState` | ContinuousState | | | - | `SmokeDetectionEventState` | DiscreteState | smoke | | + | `SmokeDetectionEventState` | DiscreteState | | | | `SmokeState` | DiscreteState | detected, notDetected | | | `StatusState` | DiscreteState | available, unavailable | | -??? note "Alarm/DynamicAlarm (ACTUATOR) — 13 commands, 35 states" +??? note "Alarm/DynamicAlarm (ACTUATOR) — 13 commands, 34 states" **Type IDs:** `282` | **Servers:** `somfy_europe` | **Controllable:** `ogp:Alarm` | **Profiles:** `SmokeDetector`, `waterLeakSensor`, `IntrusionDetector`, `StatefulAlarm`, `Alarm` @@ -10927,13 +10973,12 @@ This page lists all known device types from the Overkiz API, grouped by protocol | `AvailableModesState` | DataState | | | | `BatteryDiscreteLevelState` | DiscreteState | good, medium, low, critical | | | `BatteryLevelState` | ContinuousState | | | - | `ErrorEventState` | DiscreteState | accessLimitation, internal, obstacleProtection, transportBusy, deviceNoAnswer, cancelled, deprecated, interrupted, thermalProtection, maintenanceRequired, alreadyUpToDate, notSupported, hardwareError, accessDenied, updateError, resourceAlreadyExist | | | `ErrorState` | DataState | | | | `ErrorsState` | DataState | | | | `FirmwareHashState` | DataState | | | | `FirmwareRevisionState` | DataState | | | | `GroupMembersState` | DataState | | | - | `IntrusionDetectionEventState` | DiscreteState | panic, intrusion | | + | `IntrusionEventState` | DiscreteState | false, true | | | `IntrusionState` | DiscreteState | detected, notDetected | | | `ModeState` | DataState | | | | `NameState` | DataState | | | @@ -10951,15 +10996,15 @@ This page lists all known device types from the Overkiz API, grouped by protocol | `Private9State` | DataState | | | | `RemovableState` | DataState | | | | `SignalQualityState` | ContinuousState | | | - | `SmokeDetectionEventState` | DiscreteState | smoke | | + | `SmokeEventState` | DiscreteState | false, true | | | `SmokeState` | DiscreteState | detected, notDetected | | | `StatusState` | DiscreteState | available, unavailable | | - | `WaterLeakEventState` | DiscreteState | waterLeak | | + | `WaterLeakEventState` | DiscreteState | false, true | | | `WaterLeakState` | DiscreteState | detected, notDetected | | ??? note "Awning/DynamicAwning (ACTUATOR) — 17 commands, 30 states" - **Type IDs:** `277` | **Servers:** `rexel`, `somfy_europe` | **Controllable:** `ogp:Awning` | **Profiles:** `StatefulDeployableAwning`, `StatefulDeployable`, `Deployable`, `StatefulDeployUndeploy`, `DeployUndeploy` + **Type IDs:** `277` | **Servers:** `rexel` | **Controllable:** `ogp:Awning` | **Profiles:** `StatefulDeployableAwning`, `StatefulDeployable`, `Deployable`, `StatefulDeployUndeploy`, `DeployUndeploy` **Commands** @@ -11018,19 +11063,29 @@ This page lists all known device types from the Overkiz API, grouped by protocol | `StatusState` | DiscreteState | available, unavailable | | | `UnavailableFeaturesState` | DataState | | | -??? note "CarbonDioxideSensor/DynamicCarbonDioxideSensor (SENSOR) — 7 commands, 25 states" +??? note "Awning/DynamicAwning (ACTUATOR) — 17 commands, 29 states" - **Type IDs:** `291` | **Servers:** `rexel`, `somfy_europe` | **Controllable:** `ogp:CarbonDioxideSensor` | **Profiles:** `CO2Concentration` + **Type IDs:** `277` | **Servers:** `somfy_europe` | **Controllable:** `ogp:Awning` | **Profiles:** `StatefulDeployableAwning`, `StatefulDeployable`, `Deployable`, `StatefulDeployUndeploy`, `DeployUndeploy` **Commands** | Command | Parameters | Notes | |---------|-----------|-------| + | `deploy` | | Fully deploy the device | | `executeManufacturerProcedure` | STRING; OBJECT (optional) | execute manufacturer procedure command. p1: the procedure name p2: the params associated Example: p1 = "dead_man_up" p2 = {"duration": 42} | + | `goToAlias` | STRING | Send alias command linked with the ID. | | `identify` | | Ask the device to identify itself by doing a slight movement or blink or beep | | `readManufacturerData` | ARRAY | Read manufacturer data values from given names. Example: ["setting1","setting2"]. | + | `rollOut` | | Roll out the device (unfold - deploy - less compact position) | + | `rollUp` | | Roll up the device (fold - most compact position) | + | `saveAlias` | STRING | Allow to send an order for the product to save the current state of the alias. | | `sendPrivate` | OBJECT | send a private command | + | `setDeployment` | INT [0..100] | Device deployment level (100%=fully deployed, 0%=fully undeployed) | | `setName` | STRING | Change the device internal name. Name length may be subject to restrictions depending on the device and underlying protocol. | + | `setNodeDefinition` | STRING; STRING (optional); STRING (optional) | Fill the node definition (some transitions can be forbidden) p1: type (mandatory) p2: subType (mandatory if definition is set) p3: definition | + | `setRollingOut` | INT [0..100] | set the device rolling out percentage | + | `stop` | | Stop the current actuator behavior (movement, sound or timer) | + | `undeploy` | | Fully undeploy the device | | `update` | | Update the gateway software. The update may have to be downloaded first, which can take a while. | | `writeManufacturerData` | OBJECT | Write manufacturer data values. Example: { "setting1": true, "setting2": 42, "setting3": "overkiz", "setting4": "Dk8PDr1WD0sfAAAAAAAAAAAAAAAAAAAA", "setting5": [ "valueA", "valueB", "valueC" ], "setting6": { "value": 15, "definition": 158 } } | @@ -11042,8 +11097,8 @@ This page lists all known device types from the Overkiz API, grouped by protocol | `AvailabilityState` | DiscreteState | available, unavailable | | | `BatteryDiscreteLevelState` | DiscreteState | good, medium, low, critical | | | `BatteryLevelState` | ContinuousState | | | - | `CO2ConcentrationState` | ContinuousState | | | - | `ErrorEventState` | DiscreteState | accessLimitation, internal, obstacleProtection, transportBusy, deviceNoAnswer, cancelled, deprecated, interrupted, thermalProtection, maintenanceRequired, alreadyUpToDate, notSupported, hardwareError, accessDenied, updateError, resourceAlreadyExist | | + | `DeployedUndeployedState` | DiscreteState | deployed, undeployed | | + | `DeploymentState` | ContinuousState | [0..100] | | | `ErrorState` | DataState | | | | `ErrorsState` | DataState | | | | `FirmwareHashState` | DataState | | | @@ -11060,29 +11115,27 @@ This page lists all known device types from the Overkiz API, grouped by protocol | `Private7State` | DataState | | | | `Private8State` | DataState | | | | `Private9State` | DataState | | | + | `ReachedAliasesState` | DataState | | | | `RemovableState` | DataState | | | + | `RolledUpState` | DataState | | | + | `RollingOutState` | ContinuousState | | | | `SignalQualityState` | ContinuousState | | | | `StatusState` | DiscreteState | available, unavailable | | + | `UnavailableFeaturesState` | DataState | | | -??? note "CircuitBreaker/DynamicCircuitBreaker (ACTUATOR) — 13 commands, 25 states" +??? note "CarbonDioxideSensor/DynamicCarbonDioxideSensor (SENSOR) — 7 commands, 25 states" - **Type IDs:** `286` | **Servers:** `rexel`, `somfy_europe` | **Controllable:** `ogp:CircuitBreaker` | **Profiles:** `StatefulSwitchablePlug`, `StatefulSwitchable`, `Switchable`, `Cyclic` + **Type IDs:** `291` | **Servers:** `rexel` | **Controllable:** `ogp:CarbonDioxideSensor` | **Profiles:** `CO2Concentration` **Commands** | Command | Parameters | Notes | |---------|-----------|-------| - | `cycle` | | Do a cycle of supported motion kinematics or modes | | `executeManufacturerProcedure` | STRING; OBJECT (optional) | execute manufacturer procedure command. p1: the procedure name p2: the params associated Example: p1 = "dead_man_up" p2 = {"duration": 42} | | `identify` | | Ask the device to identify itself by doing a slight movement or blink or beep | - | `off` | | Turn off the device | - | `on` | | Turn on the device | | `readManufacturerData` | ARRAY | Read manufacturer data values from given names. Example: ["setting1","setting2"]. | | `sendPrivate` | OBJECT | send a private command | | `setName` | STRING | Change the device internal name. Name length may be subject to restrictions depending on the device and underlying protocol. | - | `setNodeDefinition` | STRING; STRING (optional); STRING (optional) | Fill the node definition (some transitions can be forbidden) p1: type (mandatory) p2: subType (mandatory if definition is set) p3: definition | - | `setOnOff` | STRING: off, on | Turn the device on or off | - | `toggle` | | Toggle on/off status | | `update` | | Update the gateway software. The update may have to be downloaded first, which can take a while. | | `writeManufacturerData` | OBJECT | Write manufacturer data values. Example: { "setting1": true, "setting2": 42, "setting3": "overkiz", "setting4": "Dk8PDr1WD0sfAAAAAAAAAAAAAAAAAAAA", "setting5": [ "valueA", "valueB", "valueC" ], "setting6": { "value": 15, "definition": 158 } } | @@ -11094,6 +11147,7 @@ This page lists all known device types from the Overkiz API, grouped by protocol | `AvailabilityState` | DiscreteState | available, unavailable | | | `BatteryDiscreteLevelState` | DiscreteState | good, medium, low, critical | | | `BatteryLevelState` | ContinuousState | | | + | `CO2ConcentrationState` | ContinuousState | | | | `ErrorEventState` | DiscreteState | accessLimitation, internal, obstacleProtection, transportBusy, deviceNoAnswer, cancelled, deprecated, interrupted, thermalProtection, maintenanceRequired, alreadyUpToDate, notSupported, hardwareError, accessDenied, updateError, resourceAlreadyExist | | | `ErrorState` | DataState | | | | `ErrorsState` | DataState | | | @@ -11101,7 +11155,6 @@ This page lists all known device types from the Overkiz API, grouped by protocol | `FirmwareRevisionState` | DataState | | | | `NameState` | DataState | | | | `NewFirmwareAvailableState` | DataState | | | - | `OnOffState` | DiscreteState | on, off | | | `Private10State` | DataState | | | | `Private1State` | DataState | | | | `Private2State` | DataState | | | @@ -11116,9 +11169,9 @@ This page lists all known device types from the Overkiz API, grouped by protocol | `SignalQualityState` | ContinuousState | | | | `StatusState` | DiscreteState | available, unavailable | | -??? note "ContactSensor/DynamicOpeningSensor (SENSOR) — 7 commands, 26 states" +??? note "CarbonDioxideSensor/DynamicCarbonDioxideSensor (SENSOR) — 7 commands, 24 states" - **Type IDs:** `272` | **Servers:** `rexel`, `somfy_europe` | **Controllable:** `ogp:OpeningSensor` | **Profiles:** `WindowOpeningStatus`, `OpeningStatus` + **Type IDs:** `291` | **Servers:** `somfy_europe` | **Controllable:** `ogp:CarbonDioxideSensor` | **Profiles:** `CO2Concentration` **Commands** @@ -11140,15 +11193,13 @@ This page lists all known device types from the Overkiz API, grouped by protocol | `AvailabilityState` | DiscreteState | available, unavailable | | | `BatteryDiscreteLevelState` | DiscreteState | good, medium, low, critical | | | `BatteryLevelState` | ContinuousState | | | - | `ErrorEventState` | DiscreteState | accessLimitation, internal, obstacleProtection, transportBusy, deviceNoAnswer, cancelled, deprecated, interrupted, thermalProtection, maintenanceRequired, alreadyUpToDate, notSupported, hardwareError, accessDenied, updateError, resourceAlreadyExist | | + | `CO2ConcentrationState` | ContinuousState | | | | `ErrorState` | DataState | | | | `ErrorsState` | DataState | | | | `FirmwareHashState` | DataState | | | | `FirmwareRevisionState` | DataState | | | | `NameState` | DataState | | | | `NewFirmwareAvailableState` | DataState | | | - | `OpenClosedState` | DiscreteState | open, closed | | - | `OpenState` | DataState | | | | `Private10State` | DataState | | | | `Private1State` | DataState | | | | `Private2State` | DataState | | | @@ -11163,26 +11214,25 @@ This page lists all known device types from the Overkiz API, grouped by protocol | `SignalQualityState` | ContinuousState | | | | `StatusState` | DiscreteState | available, unavailable | | -??? note "Curtain/DynamicCurtain (ACTUATOR) — 14 commands, 28 states" +??? note "CircuitBreaker/DynamicCircuitBreaker (ACTUATOR) — 13 commands, 25 states" - **Type IDs:** `271` | **Servers:** `rexel`, `somfy_europe` | **Controllable:** `ogp:Curtain` | **Profiles:** `StatefulCloseableCurtain`, `StatefulCloseable`, `Closeable`, `StatefulOpenClose`, `OpenClose` + **Type IDs:** `286` | **Servers:** `rexel` | **Controllable:** `ogp:CircuitBreaker` | **Profiles:** `StatefulSwitchablePlug`, `StatefulSwitchable`, `Switchable`, `Cyclic` **Commands** | Command | Parameters | Notes | |---------|-----------|-------| - | `close` | | Fully close the device | + | `cycle` | | Do a cycle of supported motion kinematics or modes | | `executeManufacturerProcedure` | STRING; OBJECT (optional) | execute manufacturer procedure command. p1: the procedure name p2: the params associated Example: p1 = "dead_man_up" p2 = {"duration": 42} | - | `goToAlias` | STRING | Send alias command linked with the ID. | | `identify` | | Ask the device to identify itself by doing a slight movement or blink or beep | - | `open` | | Fully open the device | + | `off` | | Turn off the device | + | `on` | | Turn on the device | | `readManufacturerData` | ARRAY | Read manufacturer data values from given names. Example: ["setting1","setting2"]. | - | `saveAlias` | STRING | Allow to send an order for the product to save the current state of the alias. | | `sendPrivate` | OBJECT | send a private command | - | `setClosure` | INT [0..100] | Closure level (100%=fully close, 0%=open) | | `setName` | STRING | Change the device internal name. Name length may be subject to restrictions depending on the device and underlying protocol. | | `setNodeDefinition` | STRING; STRING (optional); STRING (optional) | Fill the node definition (some transitions can be forbidden) p1: type (mandatory) p2: subType (mandatory if definition is set) p3: definition | - | `stop` | | Stop the current actuator behavior (movement, sound or timer) | + | `setOnOff` | STRING: off, on | Turn the device on or off | + | `toggle` | | Toggle on/off status | | `update` | | Update the gateway software. The update may have to be downloaded first, which can take a while. | | `writeManufacturerData` | OBJECT | Write manufacturer data values. Example: { "setting1": true, "setting2": 42, "setting3": "overkiz", "setting4": "Dk8PDr1WD0sfAAAAAAAAAAAAAAAAAAAA", "setting5": [ "valueA", "valueB", "valueC" ], "setting6": { "value": 15, "definition": 158 } } | @@ -11194,7 +11244,6 @@ This page lists all known device types from the Overkiz API, grouped by protocol | `AvailabilityState` | DiscreteState | available, unavailable | | | `BatteryDiscreteLevelState` | DiscreteState | good, medium, low, critical | | | `BatteryLevelState` | ContinuousState | | | - | `ClosureState` | ContinuousState | [0..100] | | | `ErrorEventState` | DiscreteState | accessLimitation, internal, obstacleProtection, transportBusy, deviceNoAnswer, cancelled, deprecated, interrupted, thermalProtection, maintenanceRequired, alreadyUpToDate, notSupported, hardwareError, accessDenied, updateError, resourceAlreadyExist | | | `ErrorState` | DataState | | | | `ErrorsState` | DataState | | | @@ -11202,7 +11251,7 @@ This page lists all known device types from the Overkiz API, grouped by protocol | `FirmwareRevisionState` | DataState | | | | `NameState` | DataState | | | | `NewFirmwareAvailableState` | DataState | | | - | `OpenClosedState` | DiscreteState | open, closed | | + | `OnOffState` | DiscreteState | on, off | | | `Private10State` | DataState | | | | `Private1State` | DataState | | | | `Private2State` | DataState | | | @@ -11213,25 +11262,29 @@ This page lists all known device types from the Overkiz API, grouped by protocol | `Private7State` | DataState | | | | `Private8State` | DataState | | | | `Private9State` | DataState | | | - | `ReachedAliasesState` | DataState | | | | `RemovableState` | DataState | | | | `SignalQualityState` | ContinuousState | | | | `StatusState` | DiscreteState | available, unavailable | | - | `UnavailableFeaturesState` | DataState | | | -??? note "ElectricitySensor/DynamicElectricityConsumptionSensor (SENSOR) — 7 commands, 26 states" +??? note "CircuitBreaker/DynamicCircuitBreaker (ACTUATOR) — 13 commands, 24 states" - **Type IDs:** `293` | **Servers:** `rexel`, `somfy_europe` | **Controllable:** `ogp:ElectricityConsumptionSensor` | **Profiles:** `ElectricEnergyAndPower`, `ElectricPowerMeter`, `ElectricEnergyConsumption` + **Type IDs:** `286` | **Servers:** `somfy_europe` | **Controllable:** `ogp:CircuitBreaker` | **Profiles:** `StatefulSwitchablePlug`, `StatefulSwitchable`, `Switchable`, `Cyclic` **Commands** | Command | Parameters | Notes | |---------|-----------|-------| + | `cycle` | | Do a cycle of supported motion kinematics or modes | | `executeManufacturerProcedure` | STRING; OBJECT (optional) | execute manufacturer procedure command. p1: the procedure name p2: the params associated Example: p1 = "dead_man_up" p2 = {"duration": 42} | | `identify` | | Ask the device to identify itself by doing a slight movement or blink or beep | + | `off` | | Turn off the device | + | `on` | | Turn on the device | | `readManufacturerData` | ARRAY | Read manufacturer data values from given names. Example: ["setting1","setting2"]. | | `sendPrivate` | OBJECT | send a private command | | `setName` | STRING | Change the device internal name. Name length may be subject to restrictions depending on the device and underlying protocol. | + | `setNodeDefinition` | STRING; STRING (optional); STRING (optional) | Fill the node definition (some transitions can be forbidden) p1: type (mandatory) p2: subType (mandatory if definition is set) p3: definition | + | `setOnOff` | STRING: off, on | Turn the device on or off | + | `toggle` | | Toggle on/off status | | `update` | | Update the gateway software. The update may have to be downloaded first, which can take a while. | | `writeManufacturerData` | OBJECT | Write manufacturer data values. Example: { "setting1": true, "setting2": 42, "setting3": "overkiz", "setting4": "Dk8PDr1WD0sfAAAAAAAAAAAAAAAAAAAA", "setting5": [ "valueA", "valueB", "valueC" ], "setting6": { "value": 15, "definition": 158 } } | @@ -11243,15 +11296,13 @@ This page lists all known device types from the Overkiz API, grouped by protocol | `AvailabilityState` | DiscreteState | available, unavailable | | | `BatteryDiscreteLevelState` | DiscreteState | good, medium, low, critical | | | `BatteryLevelState` | ContinuousState | | | - | `ElectricEnergyConsumptionState` | ContinuousState | | | - | `ElectricPowerConsumptionState` | ContinuousState | | | - | `ErrorEventState` | DiscreteState | accessLimitation, internal, obstacleProtection, transportBusy, deviceNoAnswer, cancelled, deprecated, interrupted, thermalProtection, maintenanceRequired, alreadyUpToDate, notSupported, hardwareError, accessDenied, updateError, resourceAlreadyExist | | | `ErrorState` | DataState | | | | `ErrorsState` | DataState | | | | `FirmwareHashState` | DataState | | | | `FirmwareRevisionState` | DataState | | | | `NameState` | DataState | | | | `NewFirmwareAvailableState` | DataState | | | + | `OnOffState` | DiscreteState | on, off | | | `Private10State` | DataState | | | | `Private1State` | DataState | | | | `Private2State` | DataState | | | @@ -11266,27 +11317,19 @@ This page lists all known device types from the Overkiz API, grouped by protocol | `SignalQualityState` | ContinuousState | | | | `StatusState` | DiscreteState | available, unavailable | | -??? note "GarageDoor/DynamicGarageDoor (ACTUATOR) — 15 commands, 28 states" +??? note "ContactSensor/DynamicOpeningSensor (SENSOR) — 7 commands, 26 states" - **Type IDs:** `266` | **Servers:** `rexel`, `somfy_europe` | **Controllable:** `ogp:GarageDoor` | **Profiles:** `StatefulCloseableGarageOpener`, `StatefulCloseable`, `Closeable`, `StatefulOpenClose`, `OpenClose`, `Cyclic` + **Type IDs:** `272` | **Servers:** `rexel` | **Controllable:** `ogp:OpeningSensor` | **Profiles:** `WindowOpeningStatus`, `OpeningStatus` **Commands** | Command | Parameters | Notes | |---------|-----------|-------| - | `close` | | Fully close the device | - | `cycle` | | Do a cycle of supported motion kinematics or modes | | `executeManufacturerProcedure` | STRING; OBJECT (optional) | execute manufacturer procedure command. p1: the procedure name p2: the params associated Example: p1 = "dead_man_up" p2 = {"duration": 42} | - | `goToAlias` | STRING | Send alias command linked with the ID. | | `identify` | | Ask the device to identify itself by doing a slight movement or blink or beep | - | `open` | | Fully open the device | | `readManufacturerData` | ARRAY | Read manufacturer data values from given names. Example: ["setting1","setting2"]. | - | `saveAlias` | STRING | Allow to send an order for the product to save the current state of the alias. | | `sendPrivate` | OBJECT | send a private command | - | `setClosure` | INT [0..100] | Closure level (100%=fully close, 0%=open) | | `setName` | STRING | Change the device internal name. Name length may be subject to restrictions depending on the device and underlying protocol. | - | `setNodeDefinition` | STRING; STRING (optional); STRING (optional) | Fill the node definition (some transitions can be forbidden) p1: type (mandatory) p2: subType (mandatory if definition is set) p3: definition | - | `stop` | | Stop the current actuator behavior (movement, sound or timer) | | `update` | | Update the gateway software. The update may have to be downloaded first, which can take a while. | | `writeManufacturerData` | OBJECT | Write manufacturer data values. Example: { "setting1": true, "setting2": 42, "setting3": "overkiz", "setting4": "Dk8PDr1WD0sfAAAAAAAAAAAAAAAAAAAA", "setting5": [ "valueA", "valueB", "valueC" ], "setting6": { "value": 15, "definition": 158 } } | @@ -11298,7 +11341,6 @@ This page lists all known device types from the Overkiz API, grouped by protocol | `AvailabilityState` | DiscreteState | available, unavailable | | | `BatteryDiscreteLevelState` | DiscreteState | good, medium, low, critical | | | `BatteryLevelState` | ContinuousState | | | - | `ClosureState` | ContinuousState | [0..100] | | | `ErrorEventState` | DiscreteState | accessLimitation, internal, obstacleProtection, transportBusy, deviceNoAnswer, cancelled, deprecated, interrupted, thermalProtection, maintenanceRequired, alreadyUpToDate, notSupported, hardwareError, accessDenied, updateError, resourceAlreadyExist | | | `ErrorState` | DataState | | | | `ErrorsState` | DataState | | | @@ -11307,6 +11349,7 @@ This page lists all known device types from the Overkiz API, grouped by protocol | `NameState` | DataState | | | | `NewFirmwareAvailableState` | DataState | | | | `OpenClosedState` | DiscreteState | open, closed | | + | `OpenState` | DataState | | | | `Private10State` | DataState | | | | `Private1State` | DataState | | | | `Private2State` | DataState | | | @@ -11317,15 +11360,13 @@ This page lists all known device types from the Overkiz API, grouped by protocol | `Private7State` | DataState | | | | `Private8State` | DataState | | | | `Private9State` | DataState | | | - | `ReachedAliasesState` | DataState | | | | `RemovableState` | DataState | | | | `SignalQualityState` | ContinuousState | | | | `StatusState` | DiscreteState | available, unavailable | | - | `UnavailableFeaturesState` | DataState | | | -??? note "GasSensor/DynamicGasMeasurementSensor (SENSOR) — 7 commands, 26 states" +??? note "ContactSensor/DynamicOpeningSensor (SENSOR) — 7 commands, 25 states" - **Type IDs:** `296` | **Servers:** `rexel`, `somfy_europe` | **Controllable:** `ogp:GasMeasurementSensor` | **Profiles:** `GasConsumption` + **Type IDs:** `272` | **Servers:** `somfy_europe` | **Controllable:** `ogp:OpeningSensor` | **Profiles:** `WindowOpeningStatus`, `OpeningStatus` **Commands** @@ -11347,15 +11388,14 @@ This page lists all known device types from the Overkiz API, grouped by protocol | `AvailabilityState` | DiscreteState | available, unavailable | | | `BatteryDiscreteLevelState` | DiscreteState | good, medium, low, critical | | | `BatteryLevelState` | ContinuousState | | | - | `ErrorEventState` | DiscreteState | accessLimitation, internal, obstacleProtection, transportBusy, deviceNoAnswer, cancelled, deprecated, interrupted, thermalProtection, maintenanceRequired, alreadyUpToDate, notSupported, hardwareError, accessDenied, updateError, resourceAlreadyExist | | | `ErrorState` | DataState | | | | `ErrorsState` | DataState | | | | `FirmwareHashState` | DataState | | | | `FirmwareRevisionState` | DataState | | | - | `GasConsumptionState` | ContinuousState | | | - | `GasFlowState` | ContinuousState | | | | `NameState` | DataState | | | | `NewFirmwareAvailableState` | DataState | | | + | `OpenClosedState` | DiscreteState | open, closed | | + | `OpenState` | DataState | | | | `Private10State` | DataState | | | | `Private1State` | DataState | | | | `Private2State` | DataState | | | @@ -11370,16 +11410,15 @@ This page lists all known device types from the Overkiz API, grouped by protocol | `SignalQualityState` | ContinuousState | | | | `StatusState` | DiscreteState | available, unavailable | | -??? note "Gate/DynamicGate (ACTUATOR) — 15 commands, 28 states" +??? note "Curtain/DynamicCurtain (ACTUATOR) — 14 commands, 28 states" - **Type IDs:** `265` | **Servers:** `rexel`, `somfy_europe` | **Controllable:** `ogp:Gate` | **Profiles:** `StatefulCloseableGateOpener`, `StatefulCloseable`, `Closeable`, `StatefulOpenClose`, `OpenClose`, `Cyclic` + **Type IDs:** `271` | **Servers:** `rexel` | **Controllable:** `ogp:Curtain` | **Profiles:** `StatefulCloseableCurtain`, `StatefulCloseable`, `Closeable`, `StatefulOpenClose`, `OpenClose` **Commands** | Command | Parameters | Notes | |---------|-----------|-------| | `close` | | Fully close the device | - | `cycle` | | Do a cycle of supported motion kinematics or modes | | `executeManufacturerProcedure` | STRING; OBJECT (optional) | execute manufacturer procedure command. p1: the procedure name p2: the params associated Example: p1 = "dead_man_up" p2 = {"duration": 42} | | `goToAlias` | STRING | Send alias command linked with the ID. | | `identify` | | Ask the device to identify itself by doing a slight movement or blink or beep | @@ -11427,51 +11466,26 @@ This page lists all known device types from the Overkiz API, grouped by protocol | `StatusState` | DiscreteState | available, unavailable | | | `UnavailableFeaturesState` | DataState | | | -??? note "Generic/Untyped (ACTUATOR) — 3 commands, 4 states" - - **Type IDs:** `16` | **Servers:** `rexel`, `somfy_europe` | **Controllable:** `ogp:Untyped` | **Profiles:** `Specific` - - **Commands** - - | Command | Parameters | Notes | - |---------|-----------|-------| - | `identify` | | Ask the device to identify itself by doing a slight movement or blink or beep | - | `setName` | STRING | Change the device internal name. Name length may be subject to restrictions depending on the device and underlying protocol. | - | `setNodeDefinition` | STRING; STRING (optional); STRING (optional) | Fill the node definition (some transitions can be forbidden) p1: type (mandatory) p2: subType (mandatory if definition is set) p3: definition | - - **States** - - | State | Type | Range / Values | Notes | - |-------|------|----------------|-------| - | `AvailabilityState` | DiscreteState | available, unavailable | | - | `NameState` | DataState | | | - | `RemovableState` | DataState | | | - | `StatusState` | DiscreteState | available, unavailable | | - -??? note "HeatingSystem/DynamicThermostat (ACTUATOR) — 18 commands, 40 states" +??? note "Curtain/DynamicCurtain (ACTUATOR) — 14 commands, 27 states" - **Type IDs:** `259` | **Servers:** `rexel`, `somfy_europe` | **Controllable:** `ogp:Thermostat` | **Profiles:** `StatefulThermostatWithSensor`, `StatefulThermostat`, `Thermostat`, `RelativeHumidity`, `StatefulSwitchable`, `Switchable`, `StatefulAirFan`, `AirFan` + **Type IDs:** `271` | **Servers:** `somfy_europe` | **Controllable:** `ogp:Curtain` | **Profiles:** `StatefulCloseableCurtain`, `StatefulCloseable`, `Closeable`, `StatefulOpenClose`, `OpenClose` **Commands** | Command | Parameters | Notes | |---------|-----------|-------| + | `close` | | Fully close the device | | `executeManufacturerProcedure` | STRING; OBJECT (optional) | execute manufacturer procedure command. p1: the procedure name p2: the params associated Example: p1 = "dead_man_up" p2 = {"duration": 42} | | `goToAlias` | STRING | Send alias command linked with the ID. | | `identify` | | Ask the device to identify itself by doing a slight movement or blink or beep | - | `off` | | Turn off the device | - | `on` | | Turn on the device | + | `open` | | Fully open the device | | `readManufacturerData` | ARRAY | Read manufacturer data values from given names. Example: ["setting1","setting2"]. | | `saveAlias` | STRING | Allow to send an order for the product to save the current state of the alias. | | `sendPrivate` | OBJECT | send a private command | - | `setFanSpeed` | STRING: low, medium, high, auto, 1 | Set the fan speed (%) | - | `setFanSpeedLevel` | INT [0..100] | Set the device fan speed level (%) | - | `setMode` | STRING | Set the active mode. | + | `setClosure` | INT [0..100] | Closure level (100%=fully close, 0%=open) | | `setName` | STRING | Change the device internal name. Name length may be subject to restrictions depending on the device and underlying protocol. | | `setNodeDefinition` | STRING; STRING (optional); STRING (optional) | Fill the node definition (some transitions can be forbidden) p1: type (mandatory) p2: subType (mandatory if definition is set) p3: definition | - | `setOnOff` | STRING: off, on | Turn the device on or off | - | `setTargetTemperature` | FLOAT | Set the new air temperature to reach | - | `setTimezone` | STRING | Set the device timezone, according to TZ database names. | + | `stop` | | Stop the current actuator behavior (movement, sound or timer) | | `update` | | Update the gateway software. The update may have to be downloaded first, which can take a while. | | `writeManufacturerData` | OBJECT | Write manufacturer data values. Example: { "setting1": true, "setting2": 42, "setting3": "overkiz", "setting4": "Dk8PDr1WD0sfAAAAAAAAAAAAAAAAAAAA", "setting5": [ "valueA", "valueB", "valueC" ], "setting6": { "value": 15, "definition": 158 } } | @@ -11481,21 +11495,16 @@ This page lists all known device types from the Overkiz API, grouped by protocol |-------|------|----------------|-------| | `ActivePartitionState` | DataState | | | | `AvailabilityState` | DiscreteState | available, unavailable | | - | `AvailableModesState` | DataState | | | - | `AvailableTargetTemperaturesState` | DataState | | | | `BatteryDiscreteLevelState` | DiscreteState | good, medium, low, critical | | | `BatteryLevelState` | ContinuousState | | | - | `ErrorEventState` | DiscreteState | accessLimitation, internal, obstacleProtection, transportBusy, deviceNoAnswer, cancelled, deprecated, interrupted, thermalProtection, maintenanceRequired, alreadyUpToDate, notSupported, hardwareError, accessDenied, updateError, resourceAlreadyExist | | + | `ClosureState` | ContinuousState | [0..100] | | | `ErrorState` | DataState | | | | `ErrorsState` | DataState | | | - | `FanSpeedLevelState` | ContinuousState | [0..100] | | - | `FanSpeedState` | DiscreteState | low, medium, high, 1, 2, 3, 4, 5, 6, 7, 8, 9 | | | `FirmwareHashState` | DataState | | | | `FirmwareRevisionState` | DataState | | | - | `ModeState` | DataState | | | | `NameState` | DataState | | | | `NewFirmwareAvailableState` | DataState | | | - | `OnOffState` | DiscreteState | on, off | | + | `OpenClosedState` | DiscreteState | open, closed | | | `Private10State` | DataState | | | | `Private1State` | DataState | | | | `Private2State` | DataState | | | @@ -11507,45 +11516,24 @@ This page lists all known device types from the Overkiz API, grouped by protocol | `Private8State` | DataState | | | | `Private9State` | DataState | | | | `ReachedAliasesState` | DataState | | | - | `RecommendedTargetTemperatureState` | ContinuousState | | | - | `RelativeHumidityState` | ContinuousState | [0.0..100.0] | | | `RemovableState` | DataState | | | | `SignalQualityState` | ContinuousState | | | | `StatusState` | DiscreteState | available, unavailable | | - | `TargetTemperatureCurrentLowerBoundState` | ContinuousState | | | - | `TargetTemperatureCurrentUpperBoundState` | ContinuousState | | | - | `TargetTemperatureReachedState` | DataState | | | - | `TargetTemperatureState` | ContinuousState | [12.0..30.0] | | - | `TemperatureState` | ContinuousState | [-100.0..100.0] | | - | `TimezoneState` | DataState | | | | `UnavailableFeaturesState` | DataState | | | -??? note "HeatingSystem/DynamicHvacCentralUnit (ACTUATOR) — 20 commands, 41 states" +??? note "ElectricitySensor/DynamicElectricityConsumptionSensor (SENSOR) — 7 commands, 26 states" - **Type IDs:** `269` | **Servers:** `rexel`, `somfy_europe` | **Controllable:** `ogp:HvacCentralUnit` | **Profiles:** `StatefulThermostatWithSensor`, `StatefulThermostat`, `Thermostat`, `RelativeHumidity`, `StatefulSwitchable`, `Switchable`, `StatefulAirFan`, `AirFan` + **Type IDs:** `293` | **Servers:** `rexel` | **Controllable:** `ogp:ElectricityConsumptionSensor` | **Profiles:** `ElectricEnergyAndPower`, `ElectricPowerMeter`, `ElectricEnergyConsumption` **Commands** | Command | Parameters | Notes | |---------|-----------|-------| - | `addGroupMember` | STRING | Add member to the group p1 : Id of the member to add to the group. | | `executeManufacturerProcedure` | STRING; OBJECT (optional) | execute manufacturer procedure command. p1: the procedure name p2: the params associated Example: p1 = "dead_man_up" p2 = {"duration": 42} | - | `goToAlias` | STRING | Send alias command linked with the ID. | | `identify` | | Ask the device to identify itself by doing a slight movement or blink or beep | - | `off` | | Turn off the device | - | `on` | | Turn on the device | | `readManufacturerData` | ARRAY | Read manufacturer data values from given names. Example: ["setting1","setting2"]. | - | `removeGroupMember` | STRING | Remove a member of the group. p1 : Id of the member to remove to the group. | - | `saveAlias` | STRING | Allow to send an order for the product to save the current state of the alias. | | `sendPrivate` | OBJECT | send a private command | - | `setFanSpeed` | STRING: low, medium, high, auto, 1 | Set the fan speed (%) | - | `setFanSpeedLevel` | INT [0..100] | Set the device fan speed level (%) | - | `setMode` | STRING | Set the active mode. | | `setName` | STRING | Change the device internal name. Name length may be subject to restrictions depending on the device and underlying protocol. | - | `setNodeDefinition` | STRING; STRING (optional); STRING (optional) | Fill the node definition (some transitions can be forbidden) p1: type (mandatory) p2: subType (mandatory if definition is set) p3: definition | - | `setOnOff` | STRING: off, on | Turn the device on or off | - | `setTargetTemperature` | FLOAT | Set the new air temperature to reach | - | `setTimezone` | STRING | Set the device timezone, according to TZ database names. | | `update` | | Update the gateway software. The update may have to be downloaded first, which can take a while. | | `writeManufacturerData` | OBJECT | Write manufacturer data values. Example: { "setting1": true, "setting2": 42, "setting3": "overkiz", "setting4": "Dk8PDr1WD0sfAAAAAAAAAAAAAAAAAAAA", "setting5": [ "valueA", "valueB", "valueC" ], "setting6": { "value": 15, "definition": 158 } } | @@ -11555,22 +11543,17 @@ This page lists all known device types from the Overkiz API, grouped by protocol |-------|------|----------------|-------| | `ActivePartitionState` | DataState | | | | `AvailabilityState` | DiscreteState | available, unavailable | | - | `AvailableModesState` | DataState | | | - | `AvailableTargetTemperaturesState` | DataState | | | | `BatteryDiscreteLevelState` | DiscreteState | good, medium, low, critical | | | `BatteryLevelState` | ContinuousState | | | + | `ElectricEnergyConsumptionState` | ContinuousState | | | + | `ElectricPowerConsumptionState` | ContinuousState | | | | `ErrorEventState` | DiscreteState | accessLimitation, internal, obstacleProtection, transportBusy, deviceNoAnswer, cancelled, deprecated, interrupted, thermalProtection, maintenanceRequired, alreadyUpToDate, notSupported, hardwareError, accessDenied, updateError, resourceAlreadyExist | | | `ErrorState` | DataState | | | | `ErrorsState` | DataState | | | - | `FanSpeedLevelState` | ContinuousState | [0..100] | | - | `FanSpeedState` | DiscreteState | low, medium, high, 1, 2, 3, 4, 5, 6, 7, 8, 9 | | | `FirmwareHashState` | DataState | | | | `FirmwareRevisionState` | DataState | | | - | `GroupMembersState` | DataState | | | - | `ModeState` | DataState | | | | `NameState` | DataState | | | | `NewFirmwareAvailableState` | DataState | | | - | `OnOffState` | DiscreteState | on, off | | | `Private10State` | DataState | | | | `Private1State` | DataState | | | | `Private2State` | DataState | | | @@ -11581,43 +11564,23 @@ This page lists all known device types from the Overkiz API, grouped by protocol | `Private7State` | DataState | | | | `Private8State` | DataState | | | | `Private9State` | DataState | | | - | `ReachedAliasesState` | DataState | | | - | `RecommendedTargetTemperatureState` | ContinuousState | | | - | `RelativeHumidityState` | ContinuousState | [0.0..100.0] | | | `RemovableState` | DataState | | | | `SignalQualityState` | ContinuousState | | | | `StatusState` | DiscreteState | available, unavailable | | - | `TargetTemperatureCurrentLowerBoundState` | ContinuousState | | | - | `TargetTemperatureCurrentUpperBoundState` | ContinuousState | | | - | `TargetTemperatureReachedState` | DataState | | | - | `TargetTemperatureState` | ContinuousState | [12.0..30.0] | | - | `TemperatureState` | ContinuousState | [-100.0..100.0] | | - | `TimezoneState` | DataState | | | - | `UnavailableFeaturesState` | DataState | | | -??? note "HeatingSystem/DynamicHeater (ACTUATOR) — 17 commands, 41 states" +??? note "ElectricitySensor/DynamicElectricityConsumptionSensor (SENSOR) — 7 commands, 25 states" - **Type IDs:** `278` | **Servers:** `rexel`, `somfy_europe` | **Controllable:** `ogp:Heater` | **Profiles:** `StatefulThermostatWithSensor`, `StatefulThermostat`, `Thermostat`, `RelativeHumidity`, `ElectricPowerMeter`, `StatefulSwitchable`, `Switchable`, `StatefulDimmable`, `Dimmable` + **Type IDs:** `293` | **Servers:** `somfy_europe` | **Controllable:** `ogp:ElectricityConsumptionSensor` | **Profiles:** `ElectricEnergyAndPower`, `ElectricPowerMeter`, `ElectricEnergyConsumption` **Commands** | Command | Parameters | Notes | |---------|-----------|-------| | `executeManufacturerProcedure` | STRING; OBJECT (optional) | execute manufacturer procedure command. p1: the procedure name p2: the params associated Example: p1 = "dead_man_up" p2 = {"duration": 42} | - | `goToAlias` | STRING | Send alias command linked with the ID. | | `identify` | | Ask the device to identify itself by doing a slight movement or blink or beep | - | `off` | | Turn off the device | - | `on` | | Turn on the device | | `readManufacturerData` | ARRAY | Read manufacturer data values from given names. Example: ["setting1","setting2"]. | - | `saveAlias` | STRING | Allow to send an order for the product to save the current state of the alias. | | `sendPrivate` | OBJECT | send a private command | - | `setIntensity` | INT [0..100] | Light intensity level (100%=maximum intensity, 0%=off) | - | `setMode` | STRING | Set the active mode. | | `setName` | STRING | Change the device internal name. Name length may be subject to restrictions depending on the device and underlying protocol. | - | `setNodeDefinition` | STRING; STRING (optional); STRING (optional) | Fill the node definition (some transitions can be forbidden) p1: type (mandatory) p2: subType (mandatory if definition is set) p3: definition | - | `setOnOff` | STRING: off, on | Turn the device on or off | - | `setTargetTemperature` | FLOAT | Set the new air temperature to reach | - | `setTimezone` | STRING | Set the device timezone, according to TZ database names. | | `update` | | Update the gateway software. The update may have to be downloaded first, which can take a while. | | `writeManufacturerData` | OBJECT | Write manufacturer data values. Example: { "setting1": true, "setting2": 42, "setting3": "overkiz", "setting4": "Dk8PDr1WD0sfAAAAAAAAAAAAAAAAAAAA", "setting5": [ "valueA", "valueB", "valueC" ], "setting6": { "value": 15, "definition": 158 } } | @@ -11627,22 +11590,16 @@ This page lists all known device types from the Overkiz API, grouped by protocol |-------|------|----------------|-------| | `ActivePartitionState` | DataState | | | | `AvailabilityState` | DiscreteState | available, unavailable | | - | `AvailableModesState` | DataState | | | - | `AvailableTargetTemperaturesState` | DataState | | | | `BatteryDiscreteLevelState` | DiscreteState | good, medium, low, critical | | | `BatteryLevelState` | ContinuousState | | | + | `ElectricEnergyConsumptionState` | ContinuousState | | | | `ElectricPowerConsumptionState` | ContinuousState | | | - | `ErrorEventState` | DiscreteState | accessLimitation, internal, obstacleProtection, transportBusy, deviceNoAnswer, cancelled, deprecated, interrupted, thermalProtection, maintenanceRequired, alreadyUpToDate, notSupported, hardwareError, accessDenied, updateError, resourceAlreadyExist | | | `ErrorState` | DataState | | | | `ErrorsState` | DataState | | | | `FirmwareHashState` | DataState | | | | `FirmwareRevisionState` | DataState | | | - | `IntensityState` | ContinuousState | | | - | `LightIntensityState` | ContinuousState | [0..100] | | - | `ModeState` | DataState | | | | `NameState` | DataState | | | | `NewFirmwareAvailableState` | DataState | | | - | `OnOffState` | DiscreteState | on, off | | | `Private10State` | DataState | | | | `Private1State` | DataState | | | | `Private2State` | DataState | | | @@ -11653,44 +11610,31 @@ This page lists all known device types from the Overkiz API, grouped by protocol | `Private7State` | DataState | | | | `Private8State` | DataState | | | | `Private9State` | DataState | | | - | `ReachedAliasesState` | DataState | | | - | `RecommendedTargetTemperatureState` | ContinuousState | | | - | `RelativeHumidityState` | ContinuousState | [0.0..100.0] | | | `RemovableState` | DataState | | | | `SignalQualityState` | ContinuousState | | | | `StatusState` | DiscreteState | available, unavailable | | - | `TargetTemperatureCurrentLowerBoundState` | ContinuousState | | | - | `TargetTemperatureCurrentUpperBoundState` | ContinuousState | | | - | `TargetTemperatureReachedState` | DataState | | | - | `TargetTemperatureState` | ContinuousState | [12.0..30.0] | | - | `TemperatureState` | ContinuousState | [-100.0..100.0] | | - | `TimezoneState` | DataState | | | - | `UnavailableFeaturesState` | DataState | | | -??? note "HeatingSystem/DynamicHvacZone (ACTUATOR) — 18 commands, 43 states" +??? note "GarageDoor/DynamicGarageDoor (ACTUATOR) — 15 commands, 28 states" - **Type IDs:** `289` | **Servers:** `rexel`, `somfy_europe` | **Controllable:** `ogp:HvacZone` | **Profiles:** `StatefulThermostatWithSensor`, `StatefulThermostat`, `Thermostat`, `StatefulSwitchable`, `Switchable`, `StatefulAirFan`, `AirFan` + **Type IDs:** `266` | **Servers:** `rexel` | **Controllable:** `ogp:GarageDoor` | **Profiles:** `StatefulCloseableGarageOpener`, `StatefulCloseable`, `Closeable`, `StatefulOpenClose`, `OpenClose`, `Cyclic` **Commands** | Command | Parameters | Notes | |---------|-----------|-------| - | `activateOption` | STRING | Activate an option | - | `cancelHolidayMode` | | Deactivate holidays mode | - | `configureHolidayMode` | INT; INT | Configure holiday mode p1 : start date (timestamp in millisecond) p2 : end date (timestamp in millisecond) | - | `deactivateOption` | STRING | Deactivate an option | - | `executeManufacturerProcedure` | STRING; OBJECT (optional) | execute manufacturer procedure command. p1: the procedure name p2: the params associated Example: p1 = "dead_man_up" p2 = {"duration": 42} | + | `close` | | Fully close the device | + | `cycle` | | Do a cycle of supported motion kinematics or modes | + | `executeManufacturerProcedure` | STRING; OBJECT (optional) | execute manufacturer procedure command. p1: the procedure name p2: the params associated Example: p1 = "dead_man_up" p2 = {"duration": 42} | + | `goToAlias` | STRING | Send alias command linked with the ID. | | `identify` | | Ask the device to identify itself by doing a slight movement or blink or beep | - | `off` | | Turn off the device | - | `on` | | Turn on the device | + | `open` | | Fully open the device | | `readManufacturerData` | ARRAY | Read manufacturer data values from given names. Example: ["setting1","setting2"]. | + | `saveAlias` | STRING | Allow to send an order for the product to save the current state of the alias. | | `sendPrivate` | OBJECT | send a private command | - | `setFanSpeed` | STRING: low, medium, high, auto, 1 | Set the fan speed (%) | - | `setFanSpeedLevel` | INT [0..100] | Set the device fan speed level (%) | - | `setMode` | STRING | Set the active mode. | + | `setClosure` | INT [0..100] | Closure level (100%=fully close, 0%=open) | | `setName` | STRING | Change the device internal name. Name length may be subject to restrictions depending on the device and underlying protocol. | - | `setOnOff` | STRING: off, on | Turn the device on or off | - | `setTargetTemperature` | FLOAT | Set the new air temperature to reach | + | `setNodeDefinition` | STRING; STRING (optional); STRING (optional) | Fill the node definition (some transitions can be forbidden) p1: type (mandatory) p2: subType (mandatory if definition is set) p3: definition | + | `stop` | | Stop the current actuator behavior (movement, sound or timer) | | `update` | | Update the gateway software. The update may have to be downloaded first, which can take a while. | | `writeManufacturerData` | OBJECT | Write manufacturer data values. Example: { "setting1": true, "setting2": 42, "setting3": "overkiz", "setting4": "Dk8PDr1WD0sfAAAAAAAAAAAAAAAAAAAA", "setting5": [ "valueA", "valueB", "valueC" ], "setting6": { "value": 15, "definition": 158 } } | @@ -11698,28 +11642,19 @@ This page lists all known device types from the Overkiz API, grouped by protocol | State | Type | Range / Values | Notes | |-------|------|----------------|-------| - | `ActivatedOptionsState` | DataState | | | | `ActivePartitionState` | DataState | | | | `AvailabilityState` | DiscreteState | available, unavailable | | - | `AvailableModesState` | DataState | | | - | `AvailableOptionsState` | DataState | | | - | `AvailableTargetTemperaturesState` | DataState | | | | `BatteryDiscreteLevelState` | DiscreteState | good, medium, low, critical | | | `BatteryLevelState` | ContinuousState | | | + | `ClosureState` | ContinuousState | [0..100] | | | `ErrorEventState` | DiscreteState | accessLimitation, internal, obstacleProtection, transportBusy, deviceNoAnswer, cancelled, deprecated, interrupted, thermalProtection, maintenanceRequired, alreadyUpToDate, notSupported, hardwareError, accessDenied, updateError, resourceAlreadyExist | | | `ErrorState` | DataState | | | | `ErrorsState` | DataState | | | - | `FanSpeedLevelState` | ContinuousState | [0..100] | | - | `FanSpeedState` | DiscreteState | low, medium, high, 1, 2, 3, 4, 5, 6, 7, 8, 9 | | | `FirmwareHashState` | DataState | | | | `FirmwareRevisionState` | DataState | | | - | `HolidayModeConfiguredState` | DataState | | | - | `HolidayModeEndDateTimeState` | DataState | | | - | `HolidayModeStartDateTimeState` | DataState | | | - | `ModeState` | DataState | | | | `NameState` | DataState | | | | `NewFirmwareAvailableState` | DataState | | | - | `OnOffState` | DiscreteState | on, off | | + | `OpenClosedState` | DiscreteState | open, closed | | | `Private10State` | DataState | | | | `Private1State` | DataState | | | | `Private2State` | DataState | | | @@ -11730,31 +11665,33 @@ This page lists all known device types from the Overkiz API, grouped by protocol | `Private7State` | DataState | | | | `Private8State` | DataState | | | | `Private9State` | DataState | | | - | `RecommendedOptionsState` | DataState | | | - | `RecommendedTargetTemperatureState` | ContinuousState | | | + | `ReachedAliasesState` | DataState | | | | `RemovableState` | DataState | | | | `SignalQualityState` | ContinuousState | | | | `StatusState` | DiscreteState | available, unavailable | | - | `TargetTemperatureCurrentLowerBoundState` | ContinuousState | | | - | `TargetTemperatureCurrentUpperBoundState` | ContinuousState | | | - | `TargetTemperatureReachedState` | DataState | | | - | `TargetTemperatureState` | ContinuousState | [12.0..30.0] | | - | `TemperatureState` | ContinuousState | [-100.0..100.0] | | | `UnavailableFeaturesState` | DataState | | | -??? note "HumiditySensor/DynamicHumiditySensor (SENSOR) — 7 commands, 25 states" +??? note "GarageDoor/DynamicGarageDoor (ACTUATOR) — 15 commands, 27 states" - **Type IDs:** `276` | **Servers:** `rexel`, `somfy_europe` | **Controllable:** `ogp:HumiditySensor` | **Profiles:** `RelativeHumidity` + **Type IDs:** `266` | **Servers:** `somfy_europe` | **Controllable:** `ogp:GarageDoor` | **Profiles:** `StatefulCloseableGarageOpener`, `StatefulCloseable`, `Closeable`, `StatefulOpenClose`, `OpenClose`, `Cyclic` **Commands** | Command | Parameters | Notes | |---------|-----------|-------| + | `close` | | Fully close the device | + | `cycle` | | Do a cycle of supported motion kinematics or modes | | `executeManufacturerProcedure` | STRING; OBJECT (optional) | execute manufacturer procedure command. p1: the procedure name p2: the params associated Example: p1 = "dead_man_up" p2 = {"duration": 42} | + | `goToAlias` | STRING | Send alias command linked with the ID. | | `identify` | | Ask the device to identify itself by doing a slight movement or blink or beep | + | `open` | | Fully open the device | | `readManufacturerData` | ARRAY | Read manufacturer data values from given names. Example: ["setting1","setting2"]. | + | `saveAlias` | STRING | Allow to send an order for the product to save the current state of the alias. | | `sendPrivate` | OBJECT | send a private command | + | `setClosure` | INT [0..100] | Closure level (100%=fully close, 0%=open) | | `setName` | STRING | Change the device internal name. Name length may be subject to restrictions depending on the device and underlying protocol. | + | `setNodeDefinition` | STRING; STRING (optional); STRING (optional) | Fill the node definition (some transitions can be forbidden) p1: type (mandatory) p2: subType (mandatory if definition is set) p3: definition | + | `stop` | | Stop the current actuator behavior (movement, sound or timer) | | `update` | | Update the gateway software. The update may have to be downloaded first, which can take a while. | | `writeManufacturerData` | OBJECT | Write manufacturer data values. Example: { "setting1": true, "setting2": 42, "setting3": "overkiz", "setting4": "Dk8PDr1WD0sfAAAAAAAAAAAAAAAAAAAA", "setting5": [ "valueA", "valueB", "valueC" ], "setting6": { "value": 15, "definition": 158 } } | @@ -11766,13 +11703,14 @@ This page lists all known device types from the Overkiz API, grouped by protocol | `AvailabilityState` | DiscreteState | available, unavailable | | | `BatteryDiscreteLevelState` | DiscreteState | good, medium, low, critical | | | `BatteryLevelState` | ContinuousState | | | - | `ErrorEventState` | DiscreteState | accessLimitation, internal, obstacleProtection, transportBusy, deviceNoAnswer, cancelled, deprecated, interrupted, thermalProtection, maintenanceRequired, alreadyUpToDate, notSupported, hardwareError, accessDenied, updateError, resourceAlreadyExist | | + | `ClosureState` | ContinuousState | [0..100] | | | `ErrorState` | DataState | | | | `ErrorsState` | DataState | | | | `FirmwareHashState` | DataState | | | | `FirmwareRevisionState` | DataState | | | | `NameState` | DataState | | | | `NewFirmwareAvailableState` | DataState | | | + | `OpenClosedState` | DiscreteState | open, closed | | | `Private10State` | DataState | | | | `Private1State` | DataState | | | | `Private2State` | DataState | | | @@ -11783,14 +11721,15 @@ This page lists all known device types from the Overkiz API, grouped by protocol | `Private7State` | DataState | | | | `Private8State` | DataState | | | | `Private9State` | DataState | | | - | `RelativeHumidityState` | ContinuousState | [0.0..100.0] | | + | `ReachedAliasesState` | DataState | | | | `RemovableState` | DataState | | | | `SignalQualityState` | ContinuousState | | | | `StatusState` | DiscreteState | available, unavailable | | + | `UnavailableFeaturesState` | DataState | | | -??? note "IntrusionSensor/DynamicIntrusionSensor (SENSOR) — 8 commands, 27 states" +??? note "GasSensor/DynamicGasMeasurementSensor (SENSOR) — 7 commands, 26 states" - **Type IDs:** `281` | **Servers:** `rexel`, `somfy_europe` | **Controllable:** `ogp:IntrusionSensor` | **Profiles:** `IntrusionDetector` + **Type IDs:** `296` | **Servers:** `rexel` | **Controllable:** `ogp:GasMeasurementSensor` | **Profiles:** `GasConsumption` **Commands** @@ -11801,7 +11740,6 @@ This page lists all known device types from the Overkiz API, grouped by protocol | `readManufacturerData` | ARRAY | Read manufacturer data values from given names. Example: ["setting1","setting2"]. | | `sendPrivate` | OBJECT | send a private command | | `setName` | STRING | Change the device internal name. Name length may be subject to restrictions depending on the device and underlying protocol. | - | `setNodeDefinition` | STRING; STRING (optional); STRING (optional) | Fill the node definition (some transitions can be forbidden) p1: type (mandatory) p2: subType (mandatory if definition is set) p3: definition | | `update` | | Update the gateway software. The update may have to be downloaded first, which can take a while. | | `writeManufacturerData` | OBJECT | Write manufacturer data values. Example: { "setting1": true, "setting2": 42, "setting3": "overkiz", "setting4": "Dk8PDr1WD0sfAAAAAAAAAAAAAAAAAAAA", "setting5": [ "valueA", "valueB", "valueC" ], "setting6": { "value": 15, "definition": 158 } } | @@ -11818,11 +11756,10 @@ This page lists all known device types from the Overkiz API, grouped by protocol | `ErrorsState` | DataState | | | | `FirmwareHashState` | DataState | | | | `FirmwareRevisionState` | DataState | | | - | `IntrusionDetectionEventState` | DiscreteState | panic, intrusion | | - | `IntrusionState` | DiscreteState | detected, notDetected | | + | `GasConsumptionState` | ContinuousState | | | + | `GasFlowState` | ContinuousState | | | | `NameState` | DataState | | | | `NewFirmwareAvailableState` | DataState | | | - | `PanicEventState` | DataState | | | | `Private10State` | DataState | | | | `Private1State` | DataState | | | | `Private2State` | DataState | | | @@ -11837,32 +11774,19 @@ This page lists all known device types from the Overkiz API, grouped by protocol | `SignalQualityState` | ContinuousState | | | | `StatusState` | DiscreteState | available, unavailable | | -??? note "Light/DynamicLight (ACTUATOR) — 20 commands, 32 states" +??? note "GasSensor/DynamicGasMeasurementSensor (SENSOR) — 7 commands, 25 states" - **Type IDs:** `257` | **Servers:** `rexel`, `somfy_europe` | **Controllable:** `ogp:Light` | **Profiles:** `StatefulLightDimmer`, `ElectricPowerMeter`, `StatefulSwitchable`, `Switchable`, `StatefulDimmable`, `Dimmable`, `Cyclic` + **Type IDs:** `296` | **Servers:** `somfy_europe` | **Controllable:** `ogp:GasMeasurementSensor` | **Profiles:** `GasConsumption` **Commands** | Command | Parameters | Notes | |---------|-----------|-------| - | `cycle` | | Do a cycle of supported motion kinematics or modes | - | `dimDown` | | Decrease the light intensity step by step | - | `dimUp` | | Increase the light intensity step by step | | `executeManufacturerProcedure` | STRING; OBJECT (optional) | execute manufacturer procedure command. p1: the procedure name p2: the params associated Example: p1 = "dead_man_up" p2 = {"duration": 42} | - | `goToAlias` | STRING | Send alias command linked with the ID. | | `identify` | | Ask the device to identify itself by doing a slight movement or blink or beep | - | `off` | | Turn off the device | - | `on` | | Turn on the device | | `readManufacturerData` | ARRAY | Read manufacturer data values from given names. Example: ["setting1","setting2"]. | - | `saveAlias` | STRING | Allow to send an order for the product to save the current state of the alias. | | `sendPrivate` | OBJECT | send a private command | - | `setColorTemperature` | INT [1000..10000] | Set the perceived white temperature for this lamp (°K) | - | `setIntensity` | INT [0..100] | Light intensity level (100%=maximum intensity, 0%=off) | | `setName` | STRING | Change the device internal name. Name length may be subject to restrictions depending on the device and underlying protocol. | - | `setNodeDefinition` | STRING; STRING (optional); STRING (optional) | Fill the node definition (some transitions can be forbidden) p1: type (mandatory) p2: subType (mandatory if definition is set) p3: definition | - | `setOnOff` | STRING: off, on | Turn the device on or off | - | `setRGB` | INT [0..255]; INT [0..255]; INT [0..255] | Set the Red,Green,Blue components of the lamp color | - | `toggle` | | Toggle on/off status | | `update` | | Update the gateway software. The update may have to be downloaded first, which can take a while. | | `writeManufacturerData` | OBJECT | Write manufacturer data values. Example: { "setting1": true, "setting2": 42, "setting3": "overkiz", "setting4": "Dk8PDr1WD0sfAAAAAAAAAAAAAAAAAAAA", "setting5": [ "valueA", "valueB", "valueC" ], "setting6": { "value": 15, "definition": 158 } } | @@ -11874,19 +11798,14 @@ This page lists all known device types from the Overkiz API, grouped by protocol | `AvailabilityState` | DiscreteState | available, unavailable | | | `BatteryDiscreteLevelState` | DiscreteState | good, medium, low, critical | | | `BatteryLevelState` | ContinuousState | | | - | `ColorModeState` | DiscreteState | cieXYZ, hueAndStaturation, temperature, rgb | | - | `ColorTemperatureState` | ContinuousState | | | - | `ElectricPowerConsumptionState` | ContinuousState | | | - | `ErrorEventState` | DiscreteState | accessLimitation, internal, obstacleProtection, transportBusy, deviceNoAnswer, cancelled, deprecated, interrupted, thermalProtection, maintenanceRequired, alreadyUpToDate, notSupported, hardwareError, accessDenied, updateError, resourceAlreadyExist | | | `ErrorState` | DataState | | | | `ErrorsState` | DataState | | | | `FirmwareHashState` | DataState | | | | `FirmwareRevisionState` | DataState | | | - | `IntensityState` | ContinuousState | | | - | `LightIntensityState` | ContinuousState | [0..100] | | + | `GasConsumptionState` | ContinuousState | | | + | `GasFlowState` | ContinuousState | | | | `NameState` | DataState | | | | `NewFirmwareAvailableState` | DataState | | | - | `OnOffState` | DiscreteState | on, off | | | `Private10State` | DataState | | | | `Private1State` | DataState | | | | `Private2State` | DataState | | | @@ -11897,25 +11816,31 @@ This page lists all known device types from the Overkiz API, grouped by protocol | `Private7State` | DataState | | | | `Private8State` | DataState | | | | `Private9State` | DataState | | | - | `RGBColorState` | DataState | | | - | `ReachedAliasesState` | DataState | | | | `RemovableState` | DataState | | | | `SignalQualityState` | ContinuousState | | | | `StatusState` | DiscreteState | available, unavailable | | -??? note "LightSensor/DynamicLightSensor (SENSOR) — 7 commands, 26 states" +??? note "Gate/DynamicGate (ACTUATOR) — 15 commands, 28 states" - **Type IDs:** `273` | **Servers:** `rexel`, `somfy_europe` | **Controllable:** `ogp:LightSensor` | **Profiles:** `Luminance` + **Type IDs:** `265` | **Servers:** `rexel` | **Controllable:** `ogp:Gate` | **Profiles:** `StatefulCloseableGateOpener`, `StatefulCloseable`, `Closeable`, `StatefulOpenClose`, `OpenClose`, `Cyclic` **Commands** | Command | Parameters | Notes | |---------|-----------|-------| + | `close` | | Fully close the device | + | `cycle` | | Do a cycle of supported motion kinematics or modes | | `executeManufacturerProcedure` | STRING; OBJECT (optional) | execute manufacturer procedure command. p1: the procedure name p2: the params associated Example: p1 = "dead_man_up" p2 = {"duration": 42} | + | `goToAlias` | STRING | Send alias command linked with the ID. | | `identify` | | Ask the device to identify itself by doing a slight movement or blink or beep | + | `open` | | Fully open the device | | `readManufacturerData` | ARRAY | Read manufacturer data values from given names. Example: ["setting1","setting2"]. | + | `saveAlias` | STRING | Allow to send an order for the product to save the current state of the alias. | | `sendPrivate` | OBJECT | send a private command | + | `setClosure` | INT [0..100] | Closure level (100%=fully close, 0%=open) | | `setName` | STRING | Change the device internal name. Name length may be subject to restrictions depending on the device and underlying protocol. | + | `setNodeDefinition` | STRING; STRING (optional); STRING (optional) | Fill the node definition (some transitions can be forbidden) p1: type (mandatory) p2: subType (mandatory if definition is set) p3: definition | + | `stop` | | Stop the current actuator behavior (movement, sound or timer) | | `update` | | Update the gateway software. The update may have to be downloaded first, which can take a while. | | `writeManufacturerData` | OBJECT | Write manufacturer data values. Example: { "setting1": true, "setting2": 42, "setting3": "overkiz", "setting4": "Dk8PDr1WD0sfAAAAAAAAAAAAAAAAAAAA", "setting5": [ "valueA", "valueB", "valueC" ], "setting6": { "value": 15, "definition": 158 } } | @@ -11927,15 +11852,15 @@ This page lists all known device types from the Overkiz API, grouped by protocol | `AvailabilityState` | DiscreteState | available, unavailable | | | `BatteryDiscreteLevelState` | DiscreteState | good, medium, low, critical | | | `BatteryLevelState` | ContinuousState | | | + | `ClosureState` | ContinuousState | [0..100] | | | `ErrorEventState` | DiscreteState | accessLimitation, internal, obstacleProtection, transportBusy, deviceNoAnswer, cancelled, deprecated, interrupted, thermalProtection, maintenanceRequired, alreadyUpToDate, notSupported, hardwareError, accessDenied, updateError, resourceAlreadyExist | | | `ErrorState` | DataState | | | | `ErrorsState` | DataState | | | | `FirmwareHashState` | DataState | | | | `FirmwareRevisionState` | DataState | | | - | `IlluminanceState` | ContinuousState | | | - | `LuminanceState` | ContinuousState | | | | `NameState` | DataState | | | | `NewFirmwareAvailableState` | DataState | | | + | `OpenClosedState` | DiscreteState | open, closed | | | `Private10State` | DataState | | | | `Private1State` | DataState | | | | `Private2State` | DataState | | | @@ -11946,45 +11871,33 @@ This page lists all known device types from the Overkiz API, grouped by protocol | `Private7State` | DataState | | | | `Private8State` | DataState | | | | `Private9State` | DataState | | | + | `ReachedAliasesState` | DataState | | | | `RemovableState` | DataState | | | | `SignalQualityState` | ContinuousState | | | | `StatusState` | DiscreteState | available, unavailable | | + | `UnavailableFeaturesState` | DataState | | | -??? note "MusicPlayer/DynamicAudioPlayer (ACTUATOR) — 29 commands, 39 states" +??? note "Gate/DynamicGate (ACTUATOR) — 15 commands, 27 states" - **Type IDs:** `288` | **Servers:** `rexel`, `somfy_europe` | **Controllable:** `ogp:AudioPlayer` | **Profiles:** `StoppableMusicPlayer`, `MusicPlayer`, `StatefulStartStop`, `StartStop`, `VolumeControl`, `StatefulSwitchable`, `Switchable` + **Type IDs:** `265` | **Servers:** `somfy_europe` | **Controllable:** `ogp:Gate` | **Profiles:** `StatefulCloseableGateOpener`, `StatefulCloseable`, `Closeable`, `StatefulOpenClose`, `OpenClose`, `Cyclic` **Commands** | Command | Parameters | Notes | |---------|-----------|-------| - | `activateOption` | STRING | Activate an option | - | `addGroupMember` | STRING | Add member to the group p1 : Id of the member to add to the group. | - | `deactivateOption` | STRING | Deactivate an option | + | `close` | | Fully close the device | + | `cycle` | | Do a cycle of supported motion kinematics or modes | | `executeManufacturerProcedure` | STRING; OBJECT (optional) | execute manufacturer procedure command. p1: the procedure name p2: the params associated Example: p1 = "dead_man_up" p2 = {"duration": 42} | - | `fastBackward` | INT | Go to a backward position for a specified time. p1 : Amount of time in sec. | - | `fastForward` | INT | Go to a forward position for a specified time. p1 : Amount of time in sec. | - | `getMediaElements` | | Get the list of all media available. | + | `goToAlias` | STRING | Send alias command linked with the ID. | | `identify` | | Ask the device to identify itself by doing a slight movement or blink or beep | - | `mute` | | Mute the device | - | `next` | | Play next track | - | `off` | | Turn off the device | - | `on` | | Turn on the device | - | `pause` | | Pause current action | - | `play` | | Play media | - | `previous` | | Play previous track | + | `open` | | Fully open the device | | `readManufacturerData` | ARRAY | Read manufacturer data values from given names. Example: ["setting1","setting2"]. | - | `removeGroupMember` | STRING | Remove a member of the group. p1 : Id of the member to remove to the group. | - | `resume` | | Resume paused action. | + | `saveAlias` | STRING | Allow to send an order for the product to save the current state of the alias. | | `sendPrivate` | OBJECT | send a private command | - | `setMediaElement` | STRING | Set the media element as current. p1 : Id of the media element to set. | + | `setClosure` | INT [0..100] | Closure level (100%=fully close, 0%=open) | | `setName` | STRING | Change the device internal name. Name length may be subject to restrictions depending on the device and underlying protocol. | - | `setOnOff` | STRING: off, on | Turn the device on or off | - | `setTimelinePosition` | INT | Go to a position on the timeline. p1 : Position time in sec. | - | `setVolume` | INT [0..100] | Set the device output volume | - | `start` | | Start the default actuator behavior (movement, sound or timer) | + | `setNodeDefinition` | STRING; STRING (optional); STRING (optional) | Fill the node definition (some transitions can be forbidden) p1: type (mandatory) p2: subType (mandatory if definition is set) p3: definition | | `stop` | | Stop the current actuator behavior (movement, sound or timer) | - | `unmute` | | Unmute the device | | `update` | | Update the gateway software. The update may have to be downloaded first, which can take a while. | | `writeManufacturerData` | OBJECT | Write manufacturer data values. Example: { "setting1": true, "setting2": 42, "setting3": "overkiz", "setting4": "Dk8PDr1WD0sfAAAAAAAAAAAAAAAAAAAA", "setting5": [ "valueA", "valueB", "valueC" ], "setting6": { "value": 15, "definition": 158 } } | @@ -11992,27 +11905,18 @@ This page lists all known device types from the Overkiz API, grouped by protocol | State | Type | Range / Values | Notes | |-------|------|----------------|-------| - | `ActivatedOptionsState` | DataState | | | | `ActivePartitionState` | DataState | | | | `AvailabilityState` | DiscreteState | available, unavailable | | - | `AvailableOptionsState` | DataState | | | | `BatteryDiscreteLevelState` | DiscreteState | good, medium, low, critical | | | `BatteryLevelState` | ContinuousState | | | - | `ErrorEventState` | DiscreteState | accessLimitation, internal, obstacleProtection, transportBusy, deviceNoAnswer, cancelled, deprecated, interrupted, thermalProtection, maintenanceRequired, alreadyUpToDate, notSupported, hardwareError, accessDenied, updateError, resourceAlreadyExist | | + | `ClosureState` | ContinuousState | [0..100] | | | `ErrorState` | DataState | | | | `ErrorsState` | DataState | | | | `FirmwareHashState` | DataState | | | | `FirmwareRevisionState` | DataState | | | - | `GroupMembersState` | DataState | | | - | `HasNextState` | DataState | | | - | `HasPreviousState` | DataState | | | - | `MediaElementState` | DataState | | | - | `MediaElementsEventState` | DataState | | | - | `MuteState` | DataState | | | | `NameState` | DataState | | | | `NewFirmwareAvailableState` | DataState | | | - | `OnOffState` | DiscreteState | on, off | | - | `PausedState` | DataState | | | + | `OpenClosedState` | DiscreteState | open, closed | | | `Private10State` | DataState | | | | `Private1State` | DataState | | | | `Private2State` | DataState | | | @@ -12023,28 +11927,57 @@ This page lists all known device types from the Overkiz API, grouped by protocol | `Private7State` | DataState | | | | `Private8State` | DataState | | | | `Private9State` | DataState | | | - | `RecommendedOptionsState` | DataState | | | + | `ReachedAliasesState` | DataState | | | | `RemovableState` | DataState | | | | `SignalQualityState` | ContinuousState | | | - | `StartedStoppedState` | DiscreteState | started, stopped | | | `StatusState` | DiscreteState | available, unavailable | | - | `TimelineDurationState` | DataState | | | - | `TimelinePositionState` | DataState | | | - | `VolumeLevelState` | DataState | | | + | `UnavailableFeaturesState` | DataState | | | -??? note "NoiseSensor/DynamicAmbientNoiseSensor (SENSOR) — 7 commands, 25 states" +??? note "Generic/Untyped (ACTUATOR) — 3 commands, 4 states" + + **Type IDs:** `16` | **Servers:** `rexel`, `somfy_europe` | **Controllable:** `ogp:Untyped` | **Profiles:** `Specific` + + **Commands** + + | Command | Parameters | Notes | + |---------|-----------|-------| + | `identify` | | Ask the device to identify itself by doing a slight movement or blink or beep | + | `setName` | STRING | Change the device internal name. Name length may be subject to restrictions depending on the device and underlying protocol. | + | `setNodeDefinition` | STRING; STRING (optional); STRING (optional) | Fill the node definition (some transitions can be forbidden) p1: type (mandatory) p2: subType (mandatory if definition is set) p3: definition | + + **States** + + | State | Type | Range / Values | Notes | + |-------|------|----------------|-------| + | `AvailabilityState` | DiscreteState | available, unavailable | | + | `NameState` | DataState | | | + | `RemovableState` | DataState | | | + | `StatusState` | DiscreteState | available, unavailable | | + +??? note "HeatingSystem/DynamicThermostat (ACTUATOR) — 18 commands, 40 states" - **Type IDs:** `305` | **Servers:** `rexel`, `somfy_europe` | **Controllable:** `ogp:AmbientNoiseSensor` | **Profiles:** `AmbientNoiseSensor` + **Type IDs:** `259` | **Servers:** `rexel` | **Controllable:** `ogp:Thermostat` | **Profiles:** `StatefulThermostatWithSensor`, `StatefulThermostat`, `Thermostat`, `RelativeHumidity`, `StatefulSwitchable`, `Switchable`, `StatefulAirFan`, `AirFan` **Commands** | Command | Parameters | Notes | |---------|-----------|-------| | `executeManufacturerProcedure` | STRING; OBJECT (optional) | execute manufacturer procedure command. p1: the procedure name p2: the params associated Example: p1 = "dead_man_up" p2 = {"duration": 42} | + | `goToAlias` | STRING | Send alias command linked with the ID. | | `identify` | | Ask the device to identify itself by doing a slight movement or blink or beep | + | `off` | | Turn off the device | + | `on` | | Turn on the device | | `readManufacturerData` | ARRAY | Read manufacturer data values from given names. Example: ["setting1","setting2"]. | + | `saveAlias` | STRING | Allow to send an order for the product to save the current state of the alias. | | `sendPrivate` | OBJECT | send a private command | + | `setFanSpeed` | STRING: low, medium, high, auto, 1 | Set the fan speed (%) | + | `setFanSpeedLevel` | INT [0..100] | Set the device fan speed level (%) | + | `setMode` | STRING | Set the active mode. | | `setName` | STRING | Change the device internal name. Name length may be subject to restrictions depending on the device and underlying protocol. | + | `setNodeDefinition` | STRING; STRING (optional); STRING (optional) | Fill the node definition (some transitions can be forbidden) p1: type (mandatory) p2: subType (mandatory if definition is set) p3: definition | + | `setOnOff` | STRING: off, on | Turn the device on or off | + | `setTargetTemperature` | FLOAT | Set the new air temperature to reach | + | `setTimezone` | STRING | Set the device timezone, according to TZ database names. | | `update` | | Update the gateway software. The update may have to be downloaded first, which can take a while. | | `writeManufacturerData` | OBJECT | Write manufacturer data values. Example: { "setting1": true, "setting2": 42, "setting3": "overkiz", "setting4": "Dk8PDr1WD0sfAAAAAAAAAAAAAAAAAAAA", "setting5": [ "valueA", "valueB", "valueC" ], "setting6": { "value": 15, "definition": 158 } } | @@ -12053,17 +11986,22 @@ This page lists all known device types from the Overkiz API, grouped by protocol | State | Type | Range / Values | Notes | |-------|------|----------------|-------| | `ActivePartitionState` | DataState | | | - | `AmbientNoiseState` | ContinuousState | | | | `AvailabilityState` | DiscreteState | available, unavailable | | + | `AvailableModesState` | DataState | | | + | `AvailableTargetTemperaturesState` | DataState | | | | `BatteryDiscreteLevelState` | DiscreteState | good, medium, low, critical | | | `BatteryLevelState` | ContinuousState | | | | `ErrorEventState` | DiscreteState | accessLimitation, internal, obstacleProtection, transportBusy, deviceNoAnswer, cancelled, deprecated, interrupted, thermalProtection, maintenanceRequired, alreadyUpToDate, notSupported, hardwareError, accessDenied, updateError, resourceAlreadyExist | | | `ErrorState` | DataState | | | | `ErrorsState` | DataState | | | + | `FanSpeedLevelState` | ContinuousState | [0..100] | | + | `FanSpeedState` | DiscreteState | low, medium, high, 1, 2, 3, 4, 5, 6, 7, 8, 9 | | | `FirmwareHashState` | DataState | | | | `FirmwareRevisionState` | DataState | | | + | `ModeState` | DataState | | | | `NameState` | DataState | | | | `NewFirmwareAvailableState` | DataState | | | + | `OnOffState` | DiscreteState | on, off | | | `Private10State` | DataState | | | | `Private1State` | DataState | | | | `Private2State` | DataState | | | @@ -12074,23 +12012,46 @@ This page lists all known device types from the Overkiz API, grouped by protocol | `Private7State` | DataState | | | | `Private8State` | DataState | | | | `Private9State` | DataState | | | + | `ReachedAliasesState` | DataState | | | + | `RecommendedTargetTemperatureState` | ContinuousState | | | + | `RelativeHumidityState` | ContinuousState | [0.0..100.0] | | | `RemovableState` | DataState | | | | `SignalQualityState` | ContinuousState | | | | `StatusState` | DiscreteState | available, unavailable | | + | `TargetTemperatureCurrentLowerBoundState` | ContinuousState | | | + | `TargetTemperatureCurrentUpperBoundState` | ContinuousState | | | + | `TargetTemperatureReachedState` | DataState | | | + | `TargetTemperatureState` | ContinuousState | [12.0..30.0] | | + | `TemperatureState` | ContinuousState | [-100.0..100.0] | | + | `TimezoneState` | DataState | | | + | `UnavailableFeaturesState` | DataState | | | -??? note "OccupancySensor/DynamicOccupancySensor (SENSOR) — 7 commands, 25 states" +??? note "HeatingSystem/DynamicHvacCentralUnit (ACTUATOR) — 20 commands, 41 states" - **Type IDs:** `280` | **Servers:** `rexel`, `somfy_europe` | **Controllable:** `ogp:OccupancySensor` | **Profiles:** `OccupancyDetector` + **Type IDs:** `269` | **Servers:** `rexel` | **Controllable:** `ogp:HvacCentralUnit` | **Profiles:** `StatefulThermostatWithSensor`, `StatefulThermostat`, `Thermostat`, `RelativeHumidity`, `StatefulSwitchable`, `Switchable`, `StatefulAirFan`, `AirFan` **Commands** | Command | Parameters | Notes | |---------|-----------|-------| + | `addGroupMember` | STRING | Add member to the group p1 : Id of the member to add to the group. | | `executeManufacturerProcedure` | STRING; OBJECT (optional) | execute manufacturer procedure command. p1: the procedure name p2: the params associated Example: p1 = "dead_man_up" p2 = {"duration": 42} | + | `goToAlias` | STRING | Send alias command linked with the ID. | | `identify` | | Ask the device to identify itself by doing a slight movement or blink or beep | + | `off` | | Turn off the device | + | `on` | | Turn on the device | | `readManufacturerData` | ARRAY | Read manufacturer data values from given names. Example: ["setting1","setting2"]. | + | `removeGroupMember` | STRING | Remove a member of the group. p1 : Id of the member to remove to the group. | + | `saveAlias` | STRING | Allow to send an order for the product to save the current state of the alias. | | `sendPrivate` | OBJECT | send a private command | + | `setFanSpeed` | STRING: low, medium, high, auto, 1 | Set the fan speed (%) | + | `setFanSpeedLevel` | INT [0..100] | Set the device fan speed level (%) | + | `setMode` | STRING | Set the active mode. | | `setName` | STRING | Change the device internal name. Name length may be subject to restrictions depending on the device and underlying protocol. | + | `setNodeDefinition` | STRING; STRING (optional); STRING (optional) | Fill the node definition (some transitions can be forbidden) p1: type (mandatory) p2: subType (mandatory if definition is set) p3: definition | + | `setOnOff` | STRING: off, on | Turn the device on or off | + | `setTargetTemperature` | FLOAT | Set the new air temperature to reach | + | `setTimezone` | STRING | Set the device timezone, according to TZ database names. | | `update` | | Update the gateway software. The update may have to be downloaded first, which can take a while. | | `writeManufacturerData` | OBJECT | Write manufacturer data values. Example: { "setting1": true, "setting2": 42, "setting3": "overkiz", "setting4": "Dk8PDr1WD0sfAAAAAAAAAAAAAAAAAAAA", "setting5": [ "valueA", "valueB", "valueC" ], "setting6": { "value": 15, "definition": 158 } } | @@ -12100,16 +12061,22 @@ This page lists all known device types from the Overkiz API, grouped by protocol |-------|------|----------------|-------| | `ActivePartitionState` | DataState | | | | `AvailabilityState` | DiscreteState | available, unavailable | | + | `AvailableModesState` | DataState | | | + | `AvailableTargetTemperaturesState` | DataState | | | | `BatteryDiscreteLevelState` | DiscreteState | good, medium, low, critical | | | `BatteryLevelState` | ContinuousState | | | | `ErrorEventState` | DiscreteState | accessLimitation, internal, obstacleProtection, transportBusy, deviceNoAnswer, cancelled, deprecated, interrupted, thermalProtection, maintenanceRequired, alreadyUpToDate, notSupported, hardwareError, accessDenied, updateError, resourceAlreadyExist | | | `ErrorState` | DataState | | | | `ErrorsState` | DataState | | | + | `FanSpeedLevelState` | ContinuousState | [0..100] | | + | `FanSpeedState` | DiscreteState | low, medium, high, 1, 2, 3, 4, 5, 6, 7, 8, 9 | | | `FirmwareHashState` | DataState | | | | `FirmwareRevisionState` | DataState | | | + | `GroupMembersState` | DataState | | | + | `ModeState` | DataState | | | | `NameState` | DataState | | | | `NewFirmwareAvailableState` | DataState | | | - | `OccupancyState` | DiscreteState | personInside, noPersonInside | | + | `OnOffState` | DiscreteState | on, off | | | `Private10State` | DataState | | | | `Private1State` | DataState | | | | `Private2State` | DataState | | | @@ -12120,19 +12087,28 @@ This page lists all known device types from the Overkiz API, grouped by protocol | `Private7State` | DataState | | | | `Private8State` | DataState | | | | `Private9State` | DataState | | | + | `ReachedAliasesState` | DataState | | | + | `RecommendedTargetTemperatureState` | ContinuousState | | | + | `RelativeHumidityState` | ContinuousState | [0.0..100.0] | | | `RemovableState` | DataState | | | | `SignalQualityState` | ContinuousState | | | | `StatusState` | DiscreteState | available, unavailable | | + | `TargetTemperatureCurrentLowerBoundState` | ContinuousState | | | + | `TargetTemperatureCurrentUpperBoundState` | ContinuousState | | | + | `TargetTemperatureReachedState` | DataState | | | + | `TargetTemperatureState` | ContinuousState | [12.0..30.0] | | + | `TemperatureState` | ContinuousState | [-100.0..100.0] | | + | `TimezoneState` | DataState | | | + | `UnavailableFeaturesState` | DataState | | | -??? note "OnOff/DynamicOutlet (ACTUATOR) — 16 commands, 29 states" +??? note "HeatingSystem/DynamicHeater (ACTUATOR) — 17 commands, 41 states" - **Type IDs:** `261` | **Servers:** `rexel`, `somfy_europe` | **Controllable:** `ogp:Outlet` | **Profiles:** `StatefulSwitchablePlug`, `ElectricPowerMeter`, `StatefulSwitchable`, `Switchable`, `StatefulDimmable`, `Dimmable`, `Cyclic` + **Type IDs:** `278` | **Servers:** `rexel` | **Controllable:** `ogp:Heater` | **Profiles:** `StatefulThermostatWithSensor`, `StatefulThermostat`, `Thermostat`, `RelativeHumidity`, `ElectricPowerMeter`, `StatefulSwitchable`, `Switchable`, `StatefulDimmable`, `Dimmable` **Commands** | Command | Parameters | Notes | |---------|-----------|-------| - | `cycle` | | Do a cycle of supported motion kinematics or modes | | `executeManufacturerProcedure` | STRING; OBJECT (optional) | execute manufacturer procedure command. p1: the procedure name p2: the params associated Example: p1 = "dead_man_up" p2 = {"duration": 42} | | `goToAlias` | STRING | Send alias command linked with the ID. | | `identify` | | Ask the device to identify itself by doing a slight movement or blink or beep | @@ -12142,10 +12118,12 @@ This page lists all known device types from the Overkiz API, grouped by protocol | `saveAlias` | STRING | Allow to send an order for the product to save the current state of the alias. | | `sendPrivate` | OBJECT | send a private command | | `setIntensity` | INT [0..100] | Light intensity level (100%=maximum intensity, 0%=off) | + | `setMode` | STRING | Set the active mode. | | `setName` | STRING | Change the device internal name. Name length may be subject to restrictions depending on the device and underlying protocol. | | `setNodeDefinition` | STRING; STRING (optional); STRING (optional) | Fill the node definition (some transitions can be forbidden) p1: type (mandatory) p2: subType (mandatory if definition is set) p3: definition | | `setOnOff` | STRING: off, on | Turn the device on or off | - | `toggle` | | Toggle on/off status | + | `setTargetTemperature` | FLOAT | Set the new air temperature to reach | + | `setTimezone` | STRING | Set the device timezone, according to TZ database names. | | `update` | | Update the gateway software. The update may have to be downloaded first, which can take a while. | | `writeManufacturerData` | OBJECT | Write manufacturer data values. Example: { "setting1": true, "setting2": 42, "setting3": "overkiz", "setting4": "Dk8PDr1WD0sfAAAAAAAAAAAAAAAAAAAA", "setting5": [ "valueA", "valueB", "valueC" ], "setting6": { "value": 15, "definition": 158 } } | @@ -12155,6 +12133,8 @@ This page lists all known device types from the Overkiz API, grouped by protocol |-------|------|----------------|-------| | `ActivePartitionState` | DataState | | | | `AvailabilityState` | DiscreteState | available, unavailable | | + | `AvailableModesState` | DataState | | | + | `AvailableTargetTemperaturesState` | DataState | | | | `BatteryDiscreteLevelState` | DiscreteState | good, medium, low, critical | | | `BatteryLevelState` | ContinuousState | | | | `ElectricPowerConsumptionState` | ContinuousState | | | @@ -12165,6 +12145,7 @@ This page lists all known device types from the Overkiz API, grouped by protocol | `FirmwareRevisionState` | DataState | | | | `IntensityState` | ContinuousState | | | | `LightIntensityState` | ContinuousState | [0..100] | | + | `ModeState` | DataState | | | | `NameState` | DataState | | | | `NewFirmwareAvailableState` | DataState | | | | `OnOffState` | DiscreteState | on, off | | @@ -12179,43 +12160,43 @@ This page lists all known device types from the Overkiz API, grouped by protocol | `Private8State` | DataState | | | | `Private9State` | DataState | | | | `ReachedAliasesState` | DataState | | | + | `RecommendedTargetTemperatureState` | ContinuousState | | | + | `RelativeHumidityState` | ContinuousState | [0.0..100.0] | | | `RemovableState` | DataState | | | | `SignalQualityState` | ContinuousState | | | | `StatusState` | DiscreteState | available, unavailable | | + | `TargetTemperatureCurrentLowerBoundState` | ContinuousState | | | + | `TargetTemperatureCurrentUpperBoundState` | ContinuousState | | | + | `TargetTemperatureReachedState` | DataState | | | + | `TargetTemperatureState` | ContinuousState | [12.0..30.0] | | + | `TemperatureState` | ContinuousState | [-100.0..100.0] | | + | `TimezoneState` | DataState | | | + | `UnavailableFeaturesState` | DataState | | | -??? note "Oven/DynamicOven (ACTUATOR) — 27 commands, 69 states" +??? note "HeatingSystem/DynamicHvacZone (ACTUATOR) — 18 commands, 43 states" - **Type IDs:** `284` | **Servers:** `rexel`, `somfy_europe` | **Controllable:** `ogp:Oven` | **Profiles:** `StatefulStartStopOven`, `StatefulStartStop`, `StartStop`, `StatefulThermostatWithSensor`, `StatefulLockWithOpeningStatus`, `StatefulThermostat`, `Thermostat`, `StatefulSwitchable`, `Switchable`, `StatefulLock`, `LockStatus`, `Lock`, `StatefulDimmable`, `Dimmable` + **Type IDs:** `289` | **Servers:** `rexel` | **Controllable:** `ogp:HvacZone` | **Profiles:** `StatefulThermostatWithSensor`, `StatefulThermostat`, `Thermostat`, `StatefulSwitchable`, `Switchable`, `StatefulAirFan`, `AirFan` **Commands** | Command | Parameters | Notes | |---------|-----------|-------| | `activateOption` | STRING | Activate an option | - | `deactivateOption` | STRING | Deactivate an option | + | `cancelHolidayMode` | | Deactivate holidays mode | + | `configureHolidayMode` | INT; INT | Configure holiday mode p1 : start date (timestamp in millisecond) p2 : end date (timestamp in millisecond) | + | `deactivateOption` | STRING | Deactivate an option | | `executeManufacturerProcedure` | STRING; OBJECT (optional) | execute manufacturer procedure command. p1: the procedure name p2: the params associated Example: p1 = "dead_man_up" p2 = {"duration": 42} | | `identify` | | Ask the device to identify itself by doing a slight movement or blink or beep | - | `lock` | | Lock the device | | `off` | | Turn off the device | | `on` | | Turn on the device | - | `pause` | | Pause current action | | `readManufacturerData` | ARRAY | Read manufacturer data values from given names. Example: ["setting1","setting2"]. | - | `resume` | | Resume paused action. | | `sendPrivate` | OBJECT | send a private command | - | `setIntensity` | INT [0..100] | Light intensity level (100%=maximum intensity, 0%=off) | + | `setFanSpeed` | STRING: low, medium, high, auto, 1 | Set the fan speed (%) | + | `setFanSpeedLevel` | INT [0..100] | Set the device fan speed level (%) | | `setMode` | STRING | Set the active mode. | | `setName` | STRING | Change the device internal name. Name length may be subject to restrictions depending on the device and underlying protocol. | | `setOnOff` | STRING: off, on | Turn the device on or off | - | `setRecipe` | STRING | Select/Activate a given recipe. | - | `setTargetHumidity` | INT [0..100] | Set the target humidity. | - | `setTargetPower` | INT | Set the target power. | | `setTargetTemperature` | FLOAT | Set the new air temperature to reach | - | `setTargetTime` | INT | Set a target action duration. | - | `setTargetWeight` | INT | Indicate a target element weight. | - | `setTimezone` | STRING | Set the device timezone, according to TZ database names. | - | `start` | | Start the default actuator behavior (movement, sound or timer) | - | `stop` | | Stop the current actuator behavior (movement, sound or timer) | - | `unlock` | | Unlock the device | | `update` | | Update the gateway software. The update may have to be downloaded first, which can take a while. | | `writeManufacturerData` | OBJECT | Write manufacturer data values. Example: { "setting1": true, "setting2": 42, "setting3": "overkiz", "setting4": "Dk8PDr1WD0sfAAAAAAAAAAAAAAAAAAAA", "setting5": [ "valueA", "valueB", "valueC" ], "setting6": { "value": 15, "definition": 158 } } | @@ -12228,28 +12209,23 @@ This page lists all known device types from the Overkiz API, grouped by protocol | `AvailabilityState` | DiscreteState | available, unavailable | | | `AvailableModesState` | DataState | | | | `AvailableOptionsState` | DataState | | | - | `AvailableRecipesState` | DataState | | | | `AvailableTargetTemperaturesState` | DataState | | | | `BatteryDiscreteLevelState` | DiscreteState | good, medium, low, critical | | | `BatteryLevelState` | ContinuousState | | | - | `CurrentCycleStageState` | DataState | | | - | `CurrentSoilingState` | ContinuousState | | | - | `CycleStageSequenceState` | DataState | | | | `ErrorEventState` | DiscreteState | accessLimitation, internal, obstacleProtection, transportBusy, deviceNoAnswer, cancelled, deprecated, interrupted, thermalProtection, maintenanceRequired, alreadyUpToDate, notSupported, hardwareError, accessDenied, updateError, resourceAlreadyExist | | | `ErrorState` | DataState | | | | `ErrorsState` | DataState | | | + | `FanSpeedLevelState` | ContinuousState | [0..100] | | + | `FanSpeedState` | DiscreteState | low, medium, high, 1, 2, 3, 4, 5, 6, 7, 8, 9 | | | `FirmwareHashState` | DataState | | | | `FirmwareRevisionState` | DataState | | | - | `IntensityState` | ContinuousState | | | - | `LightIntensityState` | ContinuousState | [0..100] | | - | `LockedUnlockedState` | DiscreteState | locked, unlocked | | + | `HolidayModeConfiguredState` | DataState | | | + | `HolidayModeEndDateTimeState` | DataState | | | + | `HolidayModeStartDateTimeState` | DataState | | | | `ModeState` | DataState | | | | `NameState` | DataState | | | | `NewFirmwareAvailableState` | DataState | | | | `OnOffState` | DiscreteState | on, off | | - | `OpenClosedState` | DiscreteState | open, closed | | - | `OpenState` | DataState | | | - | `PausedState` | DataState | | | | `Private10State` | DataState | | | | `Private1State` | DataState | | | | `Private2State` | DataState | | | @@ -12260,63 +12236,42 @@ This page lists all known device types from the Overkiz API, grouped by protocol | `Private7State` | DataState | | | | `Private8State` | DataState | | | | `Private9State` | DataState | | | - | `RecipeState` | DataState | | | | `RecommendedOptionsState` | DataState | | | - | `RecommendedTargetHumidityState` | ContinuousState | | | - | `RecommendedTargetPowerState` | ContinuousState | | | | `RecommendedTargetTemperatureState` | ContinuousState | | | - | `RecommendedTargetTimeState` | ContinuousState | | | - | `RecommendedTargetWeightState` | ContinuousState | | | - | `RemainingTimeState` | ContinuousState | | | | `RemovableState` | DataState | | | - | `RunningTimerState` | DataState | | | | `SignalQualityState` | ContinuousState | | | - | `StartedStoppedState` | DiscreteState | started, stopped | | | `StatusState` | DiscreteState | available, unavailable | | - | `TargetHumidityCurrentLowerBoundState` | ContinuousState | | | - | `TargetHumidityCurrentUpperBoundState` | ContinuousState | | | - | `TargetHumidityState` | ContinuousState | | | - | `TargetPowerCurrentLowerBoundState` | ContinuousState | | | - | `TargetPowerCurrentUpperBoundState` | ContinuousState | | | - | `TargetPowerState` | ContinuousState | | | | `TargetTemperatureCurrentLowerBoundState` | ContinuousState | | | | `TargetTemperatureCurrentUpperBoundState` | ContinuousState | | | | `TargetTemperatureReachedState` | DataState | | | | `TargetTemperatureState` | ContinuousState | [12.0..30.0] | | - | `TargetTimeCurrentLowerBoundState` | ContinuousState | | | - | `TargetTimeCurrentUpperBoundState` | ContinuousState | | | - | `TargetTimeState` | ContinuousState | | | - | `TargetWeightCurrentLowerBoundState` | ContinuousState | | | - | `TargetWeightCurrentUpperBoundState` | ContinuousState | | | - | `TargetWeightState` | ContinuousState | | | | `TemperatureState` | ContinuousState | [-100.0..100.0] | | - | `TimezoneState` | DataState | | | | `UnavailableFeaturesState` | DataState | | | -??? note "Pergola/DynamicPergola (ACTUATOR) — 18 commands, 31 states" +??? note "HeatingSystem/DynamicThermostat (ACTUATOR) — 18 commands, 39 states" - **Type IDs:** `287` | **Servers:** `rexel`, `somfy_europe` | **Controllable:** `ogp:Pergola` | **Profiles:** `StatefulOrientablePlusCloseablePergola`, `StatefulOrientablePlusCloseable`, `OrientablePlusCloseable`, `StatefulCloseable`, `Closeable`, `StatefulOpenClose`, `OpenClose` + **Type IDs:** `259` | **Servers:** `somfy_europe` | **Controllable:** `ogp:Thermostat` | **Profiles:** `StatefulThermostatWithSensor`, `StatefulThermostat`, `Thermostat`, `RelativeHumidity`, `StatefulSwitchable`, `Switchable`, `StatefulAirFan`, `AirFan` **Commands** | Command | Parameters | Notes | |---------|-----------|-------| - | `close` | | Fully close the device | | `executeManufacturerProcedure` | STRING; OBJECT (optional) | execute manufacturer procedure command. p1: the procedure name p2: the params associated Example: p1 = "dead_man_up" p2 = {"duration": 42} | | `goToAlias` | STRING | Send alias command linked with the ID. | | `identify` | | Ask the device to identify itself by doing a slight movement or blink or beep | - | `open` | | Fully open the device | + | `off` | | Turn off the device | + | `on` | | Turn on the device | | `readManufacturerData` | ARRAY | Read manufacturer data values from given names. Example: ["setting1","setting2"]. | - | `right` | | Right the device (go to minimum tilt position - open) | | `saveAlias` | STRING | Allow to send an order for the product to save the current state of the alias. | | `sendPrivate` | OBJECT | send a private command | - | `setClosure` | INT [0..100] | Closure level (100%=fully close, 0%=open) | + | `setFanSpeed` | STRING: low, medium, high, auto, 1 | Set the fan speed (%) | + | `setFanSpeedLevel` | INT [0..100] | Set the device fan speed level (%) | + | `setMode` | STRING | Set the active mode. | | `setName` | STRING | Change the device internal name. Name length may be subject to restrictions depending on the device and underlying protocol. | | `setNodeDefinition` | STRING; STRING (optional); STRING (optional) | Fill the node definition (some transitions can be forbidden) p1: type (mandatory) p2: subType (mandatory if definition is set) p3: definition | - | `setOrientation` | INT [0..100] | Set the relative orientation (0-100%) of the device slats | - | `setTilt` | INT [0..100] | set the device tilt percentage | - | `stop` | | Stop the current actuator behavior (movement, sound or timer) | - | `tilt` | | Go to maximum tilt position (closed) | + | `setOnOff` | STRING: off, on | Turn the device on or off | + | `setTargetTemperature` | FLOAT | Set the new air temperature to reach | + | `setTimezone` | STRING | Set the device timezone, according to TZ database names. | | `update` | | Update the gateway software. The update may have to be downloaded first, which can take a while. | | `writeManufacturerData` | OBJECT | Write manufacturer data values. Example: { "setting1": true, "setting2": 42, "setting3": "overkiz", "setting4": "Dk8PDr1WD0sfAAAAAAAAAAAAAAAAAAAA", "setting5": [ "valueA", "valueB", "valueC" ], "setting6": { "value": 15, "definition": 158 } } | @@ -12326,17 +12281,20 @@ This page lists all known device types from the Overkiz API, grouped by protocol |-------|------|----------------|-------| | `ActivePartitionState` | DataState | | | | `AvailabilityState` | DiscreteState | available, unavailable | | + | `AvailableModesState` | DataState | | | + | `AvailableTargetTemperaturesState` | DataState | | | | `BatteryDiscreteLevelState` | DiscreteState | good, medium, low, critical | | | `BatteryLevelState` | ContinuousState | | | - | `ClosureState` | ContinuousState | [0..100] | | - | `ErrorEventState` | DiscreteState | accessLimitation, internal, obstacleProtection, transportBusy, deviceNoAnswer, cancelled, deprecated, interrupted, thermalProtection, maintenanceRequired, alreadyUpToDate, notSupported, hardwareError, accessDenied, updateError, resourceAlreadyExist | | | `ErrorState` | DataState | | | | `ErrorsState` | DataState | | | + | `FanSpeedLevelState` | ContinuousState | [0..100] | | + | `FanSpeedState` | DiscreteState | low, medium, high, 1, 2, 3, 4, 5, 6, 7, 8, 9 | | | `FirmwareHashState` | DataState | | | | `FirmwareRevisionState` | DataState | | | + | `ModeState` | DataState | | | | `NameState` | DataState | | | | `NewFirmwareAvailableState` | DataState | | | - | `OpenClosedState` | DiscreteState | open, closed | | + | `OnOffState` | DiscreteState | on, off | | | `Private10State` | DataState | | | | `Private1State` | DataState | | | | `Private2State` | DataState | | | @@ -12348,35 +12306,45 @@ This page lists all known device types from the Overkiz API, grouped by protocol | `Private8State` | DataState | | | | `Private9State` | DataState | | | | `ReachedAliasesState` | DataState | | | + | `RecommendedTargetTemperatureState` | ContinuousState | | | + | `RelativeHumidityState` | ContinuousState | [0.0..100.0] | | | `RemovableState` | DataState | | | | `SignalQualityState` | ContinuousState | | | - | `SlateOrientationState` | ContinuousState | [0..100] | | | `StatusState` | DiscreteState | available, unavailable | | - | `TiltState` | ContinuousState | | | - | `TiltedState` | DiscreteState | true, false | | + | `TargetTemperatureCurrentLowerBoundState` | ContinuousState | | | + | `TargetTemperatureCurrentUpperBoundState` | ContinuousState | | | + | `TargetTemperatureReachedState` | DataState | | | + | `TargetTemperatureState` | ContinuousState | [12.0..30.0] | | + | `TemperatureState` | ContinuousState | [-100.0..100.0] | | + | `TimezoneState` | DataState | | | | `UnavailableFeaturesState` | DataState | | | -??? note "ProtocolGateway/DynamicBridge (ACTUATOR) — 15 commands, 26 states" +??? note "HeatingSystem/DynamicHvacCentralUnit (ACTUATOR) — 20 commands, 40 states" - **Type IDs:** `1` | **Servers:** `rexel`, `somfy_europe` | **Controllable:** `ogp:Bridge` | **Profiles:** `Specific` + **Type IDs:** `269` | **Servers:** `somfy_europe` | **Controllable:** `ogp:HvacCentralUnit` | **Profiles:** `StatefulThermostatWithSensor`, `StatefulThermostat`, `Thermostat`, `RelativeHumidity`, `StatefulSwitchable`, `Switchable`, `StatefulAirFan`, `AirFan` **Commands** | Command | Parameters | Notes | |---------|-----------|-------| - | `associateCandidate` | STRING | Pair given candidate | - | `discover` | | Start a new discovery procedure. | + | `addGroupMember` | STRING | Add member to the group p1 : Id of the member to add to the group. | | `executeManufacturerProcedure` | STRING; OBJECT (optional) | execute manufacturer procedure command. p1: the procedure name p2: the params associated Example: p1 = "dead_man_up" p2 = {"duration": 42} | - | `getCandidates` | | Discover all candidates available for association. | + | `goToAlias` | STRING | Send alias command linked with the ID. | | `identify` | | Ask the device to identify itself by doing a slight movement or blink or beep | - | `joinSetup` | | Join an existing setup | - | `pair` | STRING; STRING (optional); STRING (optional) | Execute the pairing procedure p1: type (mandatory) p2: subType (mandatory if definition is set) p3: definition | + | `off` | | Turn off the device | + | `on` | | Turn on the device | | `readManufacturerData` | ARRAY | Read manufacturer data values from given names. Example: ["setting1","setting2"]. | - | `reset` | | Bring back into initial condition. | + | `removeGroupMember` | STRING | Remove a member of the group. p1 : Id of the member to remove to the group. | + | `saveAlias` | STRING | Allow to send an order for the product to save the current state of the alias. | | `sendPrivate` | OBJECT | send a private command | - | `setAuthentication` | OBJECT | Set authentication properties of a node | + | `setFanSpeed` | STRING: low, medium, high, auto, 1 | Set the fan speed (%) | + | `setFanSpeedLevel` | INT [0..100] | Set the device fan speed level (%) | + | `setMode` | STRING | Set the active mode. | | `setName` | STRING | Change the device internal name. Name length may be subject to restrictions depending on the device and underlying protocol. | - | `shareSetup` | | Share the current setup with another controller | + | `setNodeDefinition` | STRING; STRING (optional); STRING (optional) | Fill the node definition (some transitions can be forbidden) p1: type (mandatory) p2: subType (mandatory if definition is set) p3: definition | + | `setOnOff` | STRING: off, on | Turn the device on or off | + | `setTargetTemperature` | FLOAT | Set the new air temperature to reach | + | `setTimezone` | STRING | Set the device timezone, according to TZ database names. | | `update` | | Update the gateway software. The update may have to be downloaded first, which can take a while. | | `writeManufacturerData` | OBJECT | Write manufacturer data values. Example: { "setting1": true, "setting2": 42, "setting3": "overkiz", "setting4": "Dk8PDr1WD0sfAAAAAAAAAAAAAAAAAAAA", "setting5": [ "valueA", "valueB", "valueC" ], "setting6": { "value": 15, "definition": 158 } } | @@ -12385,18 +12353,22 @@ This page lists all known device types from the Overkiz API, grouped by protocol | State | Type | Range / Values | Notes | |-------|------|----------------|-------| | `ActivePartitionState` | DataState | | | - | `AuthenticationExpiredState` | DataState | | | | `AvailabilityState` | DiscreteState | available, unavailable | | + | `AvailableModesState` | DataState | | | + | `AvailableTargetTemperaturesState` | DataState | | | | `BatteryDiscreteLevelState` | DiscreteState | good, medium, low, critical | | | `BatteryLevelState` | ContinuousState | | | - | `CandidatesState` | DataState | | | - | `ErrorEventState` | DiscreteState | accessLimitation, internal, obstacleProtection, transportBusy, deviceNoAnswer, cancelled, deprecated, interrupted, thermalProtection, maintenanceRequired, alreadyUpToDate, notSupported, hardwareError, accessDenied, updateError, resourceAlreadyExist | | | `ErrorState` | DataState | | | | `ErrorsState` | DataState | | | + | `FanSpeedLevelState` | ContinuousState | [0..100] | | + | `FanSpeedState` | DiscreteState | low, medium, high, 1, 2, 3, 4, 5, 6, 7, 8, 9 | | | `FirmwareHashState` | DataState | | | | `FirmwareRevisionState` | DataState | | | + | `GroupMembersState` | DataState | | | + | `ModeState` | DataState | | | | `NameState` | DataState | | | | `NewFirmwareAvailableState` | DataState | | | + | `OnOffState` | DiscreteState | on, off | | | `Private10State` | DataState | | | | `Private1State` | DataState | | | | `Private2State` | DataState | | | @@ -12407,25 +12379,42 @@ This page lists all known device types from the Overkiz API, grouped by protocol | `Private7State` | DataState | | | | `Private8State` | DataState | | | | `Private9State` | DataState | | | + | `ReachedAliasesState` | DataState | | | + | `RecommendedTargetTemperatureState` | ContinuousState | | | + | `RelativeHumidityState` | ContinuousState | [0.0..100.0] | | | `RemovableState` | DataState | | | | `SignalQualityState` | ContinuousState | | | | `StatusState` | DiscreteState | available, unavailable | | + | `TargetTemperatureCurrentLowerBoundState` | ContinuousState | | | + | `TargetTemperatureCurrentUpperBoundState` | ContinuousState | | | + | `TargetTemperatureReachedState` | DataState | | | + | `TargetTemperatureState` | ContinuousState | [12.0..30.0] | | + | `TemperatureState` | ContinuousState | [-100.0..100.0] | | + | `TimezoneState` | DataState | | | + | `UnavailableFeaturesState` | DataState | | | -??? note "ProtocolGateway/DynamicGateway (ACTUATOR) — 10 commands, 35 states" +??? note "HeatingSystem/DynamicHeater (ACTUATOR) — 17 commands, 40 states" - **Type IDs:** `2` | **Servers:** `rexel`, `somfy_europe` | **Controllable:** `ogp:Gateway` | **Profiles:** `Specific` + **Type IDs:** `278` | **Servers:** `somfy_europe` | **Controllable:** `ogp:Heater` | **Profiles:** `StatefulThermostatWithSensor`, `StatefulThermostat`, `Thermostat`, `RelativeHumidity`, `ElectricPowerMeter`, `StatefulSwitchable`, `Switchable`, `StatefulDimmable`, `Dimmable` **Commands** | Command | Parameters | Notes | |---------|-----------|-------| | `executeManufacturerProcedure` | STRING; OBJECT (optional) | execute manufacturer procedure command. p1: the procedure name p2: the params associated Example: p1 = "dead_man_up" p2 = {"duration": 42} | + | `goToAlias` | STRING | Send alias command linked with the ID. | | `identify` | | Ask the device to identify itself by doing a slight movement or blink or beep | + | `off` | | Turn off the device | + | `on` | | Turn on the device | | `readManufacturerData` | ARRAY | Read manufacturer data values from given names. Example: ["setting1","setting2"]. | - | `reboot` | | Reboot the device | - | `reset` | | Bring back into initial condition. | + | `saveAlias` | STRING | Allow to send an order for the product to save the current state of the alias. | | `sendPrivate` | OBJECT | send a private command | + | `setIntensity` | INT [0..100] | Light intensity level (100%=maximum intensity, 0%=off) | + | `setMode` | STRING | Set the active mode. | | `setName` | STRING | Change the device internal name. Name length may be subject to restrictions depending on the device and underlying protocol. | + | `setNodeDefinition` | STRING; STRING (optional); STRING (optional) | Fill the node definition (some transitions can be forbidden) p1: type (mandatory) p2: subType (mandatory if definition is set) p3: definition | + | `setOnOff` | STRING: off, on | Turn the device on or off | + | `setTargetTemperature` | FLOAT | Set the new air temperature to reach | | `setTimezone` | STRING | Set the device timezone, according to TZ database names. | | `update` | | Update the gateway software. The update may have to be downloaded first, which can take a while. | | `writeManufacturerData` | OBJECT | Write manufacturer data values. Example: { "setting1": true, "setting2": 42, "setting3": "overkiz", "setting4": "Dk8PDr1WD0sfAAAAAAAAAAAAAAAAAAAA", "setting5": [ "valueA", "valueB", "valueC" ], "setting6": { "value": 15, "definition": 158 } } | @@ -12435,25 +12424,22 @@ This page lists all known device types from the Overkiz API, grouped by protocol | State | Type | Range / Values | Notes | |-------|------|----------------|-------| | `ActivePartitionState` | DataState | | | - | `ApnState` | DataState | | | | `AvailabilityState` | DiscreteState | available, unavailable | | + | `AvailableModesState` | DataState | | | + | `AvailableTargetTemperaturesState` | DataState | | | | `BatteryDiscreteLevelState` | DiscreteState | good, medium, low, critical | | | `BatteryLevelState` | ContinuousState | | | - | `ErrorEventState` | DiscreteState | accessLimitation, internal, obstacleProtection, transportBusy, deviceNoAnswer, cancelled, deprecated, interrupted, thermalProtection, maintenanceRequired, alreadyUpToDate, notSupported, hardwareError, accessDenied, updateError, resourceAlreadyExist | | + | `ElectricPowerConsumptionState` | ContinuousState | | | | `ErrorState` | DataState | | | | `ErrorsState` | DataState | | | | `FirmwareHashState` | DataState | | | | `FirmwareRevisionState` | DataState | | | - | `IccidState` | DataState | | | - | `ImsiState` | DataState | | | - | `LocalAccessProofState` | DataState | | | - | `LocalIPv4AddressState` | DataState | | | - | `MobileOperatorState` | DataState | | | + | `IntensityState` | ContinuousState | | | + | `LightIntensityState` | ContinuousState | [0..100] | | + | `ModeState` | DataState | | | | `NameState` | DataState | | | - | `NetworkGatewayState` | DataState | | | - | `NetworkMacState` | DataState | | | - | `NetworkMaskState` | DataState | | | | `NewFirmwareAvailableState` | DataState | | | + | `OnOffState` | DiscreteState | on, off | | | `Private10State` | DataState | | | | `Private1State` | DataState | | | | `Private2State` | DataState | | | @@ -12464,25 +12450,44 @@ This page lists all known device types from the Overkiz API, grouped by protocol | `Private7State` | DataState | | | | `Private8State` | DataState | | | | `Private9State` | DataState | | | + | `ReachedAliasesState` | DataState | | | + | `RecommendedTargetTemperatureState` | ContinuousState | | | + | `RelativeHumidityState` | ContinuousState | [0.0..100.0] | | | `RemovableState` | DataState | | | - | `SSIDState` | DataState | | | | `SignalQualityState` | ContinuousState | | | | `StatusState` | DiscreteState | available, unavailable | | + | `TargetTemperatureCurrentLowerBoundState` | ContinuousState | | | + | `TargetTemperatureCurrentUpperBoundState` | ContinuousState | | | + | `TargetTemperatureReachedState` | DataState | | | + | `TargetTemperatureState` | ContinuousState | [12.0..30.0] | | + | `TemperatureState` | ContinuousState | [-100.0..100.0] | | | `TimezoneState` | DataState | | | + | `UnavailableFeaturesState` | DataState | | | -??? note "RainSensor/DynamicRainSensor (SENSOR) — 7 commands, 25 states" +??? note "HeatingSystem/DynamicHvacZone (ACTUATOR) — 18 commands, 42 states" - **Type IDs:** `275` | **Servers:** `rexel`, `somfy_europe` | **Controllable:** `ogp:RainSensor` | **Profiles:** `RainDetector` + **Type IDs:** `289` | **Servers:** `somfy_europe` | **Controllable:** `ogp:HvacZone` | **Profiles:** `StatefulThermostatWithSensor`, `StatefulThermostat`, `Thermostat`, `StatefulSwitchable`, `Switchable`, `StatefulAirFan`, `AirFan` **Commands** | Command | Parameters | Notes | |---------|-----------|-------| + | `activateOption` | STRING | Activate an option | + | `cancelHolidayMode` | | Deactivate holidays mode | + | `configureHolidayMode` | INT; INT | Configure holiday mode p1 : start date (timestamp in millisecond) p2 : end date (timestamp in millisecond) | + | `deactivateOption` | STRING | Deactivate an option | | `executeManufacturerProcedure` | STRING; OBJECT (optional) | execute manufacturer procedure command. p1: the procedure name p2: the params associated Example: p1 = "dead_man_up" p2 = {"duration": 42} | | `identify` | | Ask the device to identify itself by doing a slight movement or blink or beep | + | `off` | | Turn off the device | + | `on` | | Turn on the device | | `readManufacturerData` | ARRAY | Read manufacturer data values from given names. Example: ["setting1","setting2"]. | | `sendPrivate` | OBJECT | send a private command | + | `setFanSpeed` | STRING: low, medium, high, auto, 1 | Set the fan speed (%) | + | `setFanSpeedLevel` | INT [0..100] | Set the device fan speed level (%) | + | `setMode` | STRING | Set the active mode. | | `setName` | STRING | Change the device internal name. Name length may be subject to restrictions depending on the device and underlying protocol. | + | `setOnOff` | STRING: off, on | Turn the device on or off | + | `setTargetTemperature` | FLOAT | Set the new air temperature to reach | | `update` | | Update the gateway software. The update may have to be downloaded first, which can take a while. | | `writeManufacturerData` | OBJECT | Write manufacturer data values. Example: { "setting1": true, "setting2": 42, "setting3": "overkiz", "setting4": "Dk8PDr1WD0sfAAAAAAAAAAAAAAAAAAAA", "setting5": [ "valueA", "valueB", "valueC" ], "setting6": { "value": 15, "definition": 158 } } | @@ -12490,17 +12495,27 @@ This page lists all known device types from the Overkiz API, grouped by protocol | State | Type | Range / Values | Notes | |-------|------|----------------|-------| + | `ActivatedOptionsState` | DataState | | | | `ActivePartitionState` | DataState | | | | `AvailabilityState` | DiscreteState | available, unavailable | | + | `AvailableModesState` | DataState | | | + | `AvailableOptionsState` | DataState | | | + | `AvailableTargetTemperaturesState` | DataState | | | | `BatteryDiscreteLevelState` | DiscreteState | good, medium, low, critical | | | `BatteryLevelState` | ContinuousState | | | - | `ErrorEventState` | DiscreteState | accessLimitation, internal, obstacleProtection, transportBusy, deviceNoAnswer, cancelled, deprecated, interrupted, thermalProtection, maintenanceRequired, alreadyUpToDate, notSupported, hardwareError, accessDenied, updateError, resourceAlreadyExist | | | `ErrorState` | DataState | | | | `ErrorsState` | DataState | | | + | `FanSpeedLevelState` | ContinuousState | [0..100] | | + | `FanSpeedState` | DiscreteState | low, medium, high, 1, 2, 3, 4, 5, 6, 7, 8, 9 | | | `FirmwareHashState` | DataState | | | | `FirmwareRevisionState` | DataState | | | + | `HolidayModeConfiguredState` | DataState | | | + | `HolidayModeEndDateTimeState` | DataState | | | + | `HolidayModeStartDateTimeState` | DataState | | | + | `ModeState` | DataState | | | | `NameState` | DataState | | | | `NewFirmwareAvailableState` | DataState | | | + | `OnOffState` | DiscreteState | on, off | | | `Private10State` | DataState | | | | `Private1State` | DataState | | | | `Private2State` | DataState | | | @@ -12511,24 +12526,29 @@ This page lists all known device types from the Overkiz API, grouped by protocol | `Private7State` | DataState | | | | `Private8State` | DataState | | | | `Private9State` | DataState | | | - | `RainState` | DiscreteState | detected, notDetected | | + | `RecommendedOptionsState` | DataState | | | + | `RecommendedTargetTemperatureState` | ContinuousState | | | | `RemovableState` | DataState | | | | `SignalQualityState` | ContinuousState | | | | `StatusState` | DiscreteState | available, unavailable | | + | `TargetTemperatureCurrentLowerBoundState` | ContinuousState | | | + | `TargetTemperatureCurrentUpperBoundState` | ContinuousState | | | + | `TargetTemperatureReachedState` | DataState | | | + | `TargetTemperatureState` | ContinuousState | [12.0..30.0] | | + | `TemperatureState` | ContinuousState | [-100.0..100.0] | | + | `UnavailableFeaturesState` | DataState | | | -??? note "Scene/DynamicScene (ACTUATOR) — 9 commands, 25 states" +??? note "HumiditySensor/DynamicHumiditySensor (SENSOR) — 7 commands, 25 states" - **Type IDs:** `294` | **Servers:** `rexel`, `somfy_europe` | **Controllable:** `ogp:Scene` | **Profiles:** `Specific` + **Type IDs:** `276` | **Servers:** `rexel` | **Controllable:** `ogp:HumiditySensor` | **Profiles:** `RelativeHumidity` **Commands** | Command | Parameters | Notes | |---------|-----------|-------| | `executeManufacturerProcedure` | STRING; OBJECT (optional) | execute manufacturer procedure command. p1: the procedure name p2: the params associated Example: p1 = "dead_man_up" p2 = {"duration": 42} | - | `goToAlias` | STRING | Send alias command linked with the ID. | | `identify` | | Ask the device to identify itself by doing a slight movement or blink or beep | | `readManufacturerData` | ARRAY | Read manufacturer data values from given names. Example: ["setting1","setting2"]. | - | `saveAlias` | STRING | Allow to send an order for the product to save the current state of the alias. | | `sendPrivate` | OBJECT | send a private command | | `setName` | STRING | Change the device internal name. Name length may be subject to restrictions depending on the device and underlying protocol. | | `update` | | Update the gateway software. The update may have to be downloaded first, which can take a while. | @@ -12559,14 +12579,14 @@ This page lists all known device types from the Overkiz API, grouped by protocol | `Private7State` | DataState | | | | `Private8State` | DataState | | | | `Private9State` | DataState | | | - | `ReachedAliasesState` | DataState | | | + | `RelativeHumidityState` | ContinuousState | [0.0..100.0] | | | `RemovableState` | DataState | | | | `SignalQualityState` | ContinuousState | | | | `StatusState` | DiscreteState | available, unavailable | | -??? note "SceneLauncherController/DynamicSceneLauncherController (REMOTE_CONTROLLER) — 7 commands, 25 states" +??? note "HumiditySensor/DynamicHumiditySensor (SENSOR) — 7 commands, 24 states" - **Type IDs:** `292` | **Servers:** `rexel` | **Controllable:** `ogp:SceneLauncherController` | **Profiles:** `ScenarioTrigger` + **Type IDs:** `276` | **Servers:** `somfy_europe` | **Controllable:** `ogp:HumiditySensor` | **Profiles:** `RelativeHumidity` **Commands** @@ -12588,12 +12608,10 @@ This page lists all known device types from the Overkiz API, grouped by protocol | `AvailabilityState` | DiscreteState | available, unavailable | | | `BatteryDiscreteLevelState` | DiscreteState | good, medium, low, critical | | | `BatteryLevelState` | ContinuousState | | | - | `ErrorEventState` | DiscreteState | accessLimitation, internal, obstacleProtection, transportBusy, deviceNoAnswer, cancelled, deprecated, interrupted, thermalProtection, maintenanceRequired, alreadyUpToDate, notSupported, hardwareError, accessDenied, updateError, resourceAlreadyExist | | | `ErrorState` | DataState | | | | `ErrorsState` | DataState | | | | `FirmwareHashState` | DataState | | | | `FirmwareRevisionState` | DataState | | | - | `LaunchStatusState` | DiscreteState | launched, standby | | | `NameState` | DataState | | | | `NewFirmwareAvailableState` | DataState | | | | `Private10State` | DataState | | | @@ -12606,13 +12624,14 @@ This page lists all known device types from the Overkiz API, grouped by protocol | `Private7State` | DataState | | | | `Private8State` | DataState | | | | `Private9State` | DataState | | | + | `RelativeHumidityState` | ContinuousState | [0.0..100.0] | | | `RemovableState` | DataState | | | | `SignalQualityState` | ContinuousState | | | | `StatusState` | DiscreteState | available, unavailable | | -??? note "SceneLauncherController/DynamicSceneLauncherController (REMOTE_CONTROLLER) — 7 commands, 28 states" +??? note "IntrusionSensor/DynamicIntrusionSensor (SENSOR) — 8 commands, 27 states" - **Type IDs:** `292` | **Servers:** `somfy_europe` | **Controllable:** `ogp:SceneLauncherController` | **Profiles:** `Switch`, `SwitchEvent`, `ScenarioTrigger` + **Type IDs:** `281` | **Servers:** `rexel` | **Controllable:** `ogp:IntrusionSensor` | **Profiles:** `IntrusionDetector` **Commands** @@ -12623,6 +12642,7 @@ This page lists all known device types from the Overkiz API, grouped by protocol | `readManufacturerData` | ARRAY | Read manufacturer data values from given names. Example: ["setting1","setting2"]. | | `sendPrivate` | OBJECT | send a private command | | `setName` | STRING | Change the device internal name. Name length may be subject to restrictions depending on the device and underlying protocol. | + | `setNodeDefinition` | STRING; STRING (optional); STRING (optional) | Fill the node definition (some transitions can be forbidden) p1: type (mandatory) p2: subType (mandatory if definition is set) p3: definition | | `update` | | Update the gateway software. The update may have to be downloaded first, which can take a while. | | `writeManufacturerData` | OBJECT | Write manufacturer data values. Example: { "setting1": true, "setting2": 42, "setting3": "overkiz", "setting4": "Dk8PDr1WD0sfAAAAAAAAAAAAAAAAAAAA", "setting5": [ "valueA", "valueB", "valueC" ], "setting6": { "value": 15, "definition": 158 } } | @@ -12630,21 +12650,20 @@ This page lists all known device types from the Overkiz API, grouped by protocol | State | Type | Range / Values | Notes | |-------|------|----------------|-------| - | `ActionState` | DataState | | | | `ActivePartitionState` | DataState | | | | `AvailabilityState` | DiscreteState | available, unavailable | | - | `AvailableActionsState` | DataState | | | | `BatteryDiscreteLevelState` | DiscreteState | good, medium, low, critical | | | `BatteryLevelState` | ContinuousState | | | - | `ButtonActionsEventState` | DataState | | | | `ErrorEventState` | DiscreteState | accessLimitation, internal, obstacleProtection, transportBusy, deviceNoAnswer, cancelled, deprecated, interrupted, thermalProtection, maintenanceRequired, alreadyUpToDate, notSupported, hardwareError, accessDenied, updateError, resourceAlreadyExist | | | `ErrorState` | DataState | | | | `ErrorsState` | DataState | | | | `FirmwareHashState` | DataState | | | | `FirmwareRevisionState` | DataState | | | - | `LaunchStatusState` | DiscreteState | launched, standby | | + | `IntrusionDetectionEventState` | DiscreteState | panic, intrusion | | + | `IntrusionState` | DiscreteState | detected, notDetected | | | `NameState` | DataState | | | | `NewFirmwareAvailableState` | DataState | | | + | `PanicEventState` | DataState | | | | `Private10State` | DataState | | | | `Private1State` | DataState | | | | `Private2State` | DataState | | | @@ -12659,26 +12678,20 @@ This page lists all known device types from the Overkiz API, grouped by protocol | `SignalQualityState` | ContinuousState | | | | `StatusState` | DiscreteState | available, unavailable | | -??? note "Screen/DynamicScreen (ACTUATOR) — 14 commands, 28 states" +??? note "IntrusionSensor/DynamicIntrusionSensor (SENSOR) — 8 commands, 26 states" - **Type IDs:** `263` | **Servers:** `rexel`, `somfy_europe` | **Controllable:** `ogp:Blind` | **Profiles:** `StatefulCloseableBlind`, `StatefulCloseable`, `Closeable`, `StatefulOpenClose`, `OpenClose` + **Type IDs:** `281` | **Servers:** `somfy_europe` | **Controllable:** `ogp:IntrusionSensor` | **Profiles:** `IntrusionDetector` **Commands** | Command | Parameters | Notes | |---------|-----------|-------| - | `close` | | Fully close the device | | `executeManufacturerProcedure` | STRING; OBJECT (optional) | execute manufacturer procedure command. p1: the procedure name p2: the params associated Example: p1 = "dead_man_up" p2 = {"duration": 42} | - | `goToAlias` | STRING | Send alias command linked with the ID. | | `identify` | | Ask the device to identify itself by doing a slight movement or blink or beep | - | `open` | | Fully open the device | | `readManufacturerData` | ARRAY | Read manufacturer data values from given names. Example: ["setting1","setting2"]. | - | `saveAlias` | STRING | Allow to send an order for the product to save the current state of the alias. | | `sendPrivate` | OBJECT | send a private command | - | `setClosure` | INT [0..100] | Closure level (100%=fully close, 0%=open) | | `setName` | STRING | Change the device internal name. Name length may be subject to restrictions depending on the device and underlying protocol. | | `setNodeDefinition` | STRING; STRING (optional); STRING (optional) | Fill the node definition (some transitions can be forbidden) p1: type (mandatory) p2: subType (mandatory if definition is set) p3: definition | - | `stop` | | Stop the current actuator behavior (movement, sound or timer) | | `update` | | Update the gateway software. The update may have to be downloaded first, which can take a while. | | `writeManufacturerData` | OBJECT | Write manufacturer data values. Example: { "setting1": true, "setting2": 42, "setting3": "overkiz", "setting4": "Dk8PDr1WD0sfAAAAAAAAAAAAAAAAAAAA", "setting5": [ "valueA", "valueB", "valueC" ], "setting6": { "value": 15, "definition": 158 } } | @@ -12690,15 +12703,15 @@ This page lists all known device types from the Overkiz API, grouped by protocol | `AvailabilityState` | DiscreteState | available, unavailable | | | `BatteryDiscreteLevelState` | DiscreteState | good, medium, low, critical | | | `BatteryLevelState` | ContinuousState | | | - | `ClosureState` | ContinuousState | [0..100] | | - | `ErrorEventState` | DiscreteState | accessLimitation, internal, obstacleProtection, transportBusy, deviceNoAnswer, cancelled, deprecated, interrupted, thermalProtection, maintenanceRequired, alreadyUpToDate, notSupported, hardwareError, accessDenied, updateError, resourceAlreadyExist | | | `ErrorState` | DataState | | | | `ErrorsState` | DataState | | | | `FirmwareHashState` | DataState | | | | `FirmwareRevisionState` | DataState | | | + | `IntrusionEventState` | DiscreteState | | | + | `IntrusionState` | DiscreteState | detected, notDetected | | | `NameState` | DataState | | | | `NewFirmwareAvailableState` | DataState | | | - | `OpenClosedState` | DiscreteState | open, closed | | + | `PanicEventState` | DataState | | | | `Private10State` | DataState | | | | `Private1State` | DataState | | | | `Private2State` | DataState | | | @@ -12709,61 +12722,60 @@ This page lists all known device types from the Overkiz API, grouped by protocol | `Private7State` | DataState | | | | `Private8State` | DataState | | | | `Private9State` | DataState | | | - | `ReachedAliasesState` | DataState | | | | `RemovableState` | DataState | | | | `SignalQualityState` | ContinuousState | | | | `StatusState` | DiscreteState | available, unavailable | | - | `UnavailableFeaturesState` | DataState | | | -??? note "Shutter/DynamicShutter (ACTUATOR) — 17 commands, 35 states" +??? note "Light/DynamicLight (ACTUATOR) — 20 commands, 32 states" - **Type IDs:** `262` | **Servers:** `rexel`, `somfy_europe` | **Controllable:** `ogp:Shutter` | **Profiles:** `StatefulCloseableShutter`, `StatefulCloseable`, `Closeable`, `StatefulOpenClose`, `OpenClose`, `Cyclic` + **Type IDs:** `257` | **Servers:** `rexel` | **Controllable:** `ogp:Light` | **Profiles:** `StatefulLightDimmer`, `ElectricPowerMeter`, `StatefulSwitchable`, `Switchable`, `StatefulDimmable`, `Dimmable`, `Cyclic` **Commands** | Command | Parameters | Notes | |---------|-----------|-------| - | `activateOption` | STRING | Activate an option | - | `close` | | Fully close the device | | `cycle` | | Do a cycle of supported motion kinematics or modes | - | `deactivateOption` | STRING | Deactivate an option | + | `dimDown` | | Decrease the light intensity step by step | + | `dimUp` | | Increase the light intensity step by step | | `executeManufacturerProcedure` | STRING; OBJECT (optional) | execute manufacturer procedure command. p1: the procedure name p2: the params associated Example: p1 = "dead_man_up" p2 = {"duration": 42} | | `goToAlias` | STRING | Send alias command linked with the ID. | | `identify` | | Ask the device to identify itself by doing a slight movement or blink or beep | - | `open` | | Fully open the device | + | `off` | | Turn off the device | + | `on` | | Turn on the device | | `readManufacturerData` | ARRAY | Read manufacturer data values from given names. Example: ["setting1","setting2"]. | | `saveAlias` | STRING | Allow to send an order for the product to save the current state of the alias. | | `sendPrivate` | OBJECT | send a private command | - | `setClosure` | INT [0..100] | Closure level (100%=fully close, 0%=open) | + | `setColorTemperature` | INT [1000..10000] | Set the perceived white temperature for this lamp (°K) | + | `setIntensity` | INT [0..100] | Light intensity level (100%=maximum intensity, 0%=off) | | `setName` | STRING | Change the device internal name. Name length may be subject to restrictions depending on the device and underlying protocol. | | `setNodeDefinition` | STRING; STRING (optional); STRING (optional) | Fill the node definition (some transitions can be forbidden) p1: type (mandatory) p2: subType (mandatory if definition is set) p3: definition | - | `stop` | | Stop the current actuator behavior (movement, sound or timer) | - | `update` | | Update the gateway software. The update may have to be downloaded first, which can take a while. | - | `writeManufacturerData` | OBJECT | Write manufacturer data values. Example: { "setting1": true, "setting2": 42, "setting3": "overkiz", "setting4": "Dk8PDr1WD0sfAAAAAAAAAAAAAAAAAAAA", "setting5": [ "valueA", "valueB", "valueC" ], "setting6": { "value": 15, "definition": 158 } } | + | `setOnOff` | STRING: off, on | Turn the device on or off | + | `setRGB` | INT [0..255]; INT [0..255]; INT [0..255] | Set the Red,Green,Blue components of the lamp color | + | `toggle` | | Toggle on/off status | + | `update` | | Update the gateway software. The update may have to be downloaded first, which can take a while. | + | `writeManufacturerData` | OBJECT | Write manufacturer data values. Example: { "setting1": true, "setting2": 42, "setting3": "overkiz", "setting4": "Dk8PDr1WD0sfAAAAAAAAAAAAAAAAAAAA", "setting5": [ "valueA", "valueB", "valueC" ], "setting6": { "value": 15, "definition": 158 } } | **States** | State | Type | Range / Values | Notes | |-------|------|----------------|-------| - | `AccessLimitationState` | DataState | | | - | `ActivatedOptionsState` | DataState | | | | `ActivePartitionState` | DataState | | | | `AvailabilityState` | DiscreteState | available, unavailable | | - | `AvailableOptionsState` | DataState | | | | `BatteryDiscreteLevelState` | DiscreteState | good, medium, low, critical | | | `BatteryLevelState` | ContinuousState | | | - | `ClosureState` | ContinuousState | [0..100] | | + | `ColorModeState` | DiscreteState | cieXYZ, hueAndStaturation, temperature, rgb | | + | `ColorTemperatureState` | ContinuousState | | | + | `ElectricPowerConsumptionState` | ContinuousState | | | | `ErrorEventState` | DiscreteState | accessLimitation, internal, obstacleProtection, transportBusy, deviceNoAnswer, cancelled, deprecated, interrupted, thermalProtection, maintenanceRequired, alreadyUpToDate, notSupported, hardwareError, accessDenied, updateError, resourceAlreadyExist | | | `ErrorState` | DataState | | | | `ErrorsState` | DataState | | | | `FirmwareHashState` | DataState | | | | `FirmwareRevisionState` | DataState | | | - | `LimitationSourcesState` | DataState | | | - | `LimitationTimeState` | DataState | | | + | `IntensityState` | ContinuousState | | | + | `LightIntensityState` | ContinuousState | [0..100] | | | `NameState` | DataState | | | | `NewFirmwareAvailableState` | DataState | | | - | `OpenClosedState` | DiscreteState | open, closed | | - | `PermissiveLimitationState` | DataState | | | + | `OnOffState` | DiscreteState | on, off | | | `Private10State` | DataState | | | | `Private1State` | DataState | | | | `Private2State` | DataState | | | @@ -12774,26 +12786,38 @@ This page lists all known device types from the Overkiz API, grouped by protocol | `Private7State` | DataState | | | | `Private8State` | DataState | | | | `Private9State` | DataState | | | + | `RGBColorState` | DataState | | | | `ReachedAliasesState` | DataState | | | - | `RecommendedOptionsState` | DataState | | | | `RemovableState` | DataState | | | | `SignalQualityState` | ContinuousState | | | | `StatusState` | DiscreteState | available, unavailable | | - | `UnavailableFeaturesState` | DataState | | | -??? note "SmokeSensor/DynamicSmokeSensor (SENSOR) — 7 commands, 26 states" +??? note "Light/DynamicLight (ACTUATOR) — 20 commands, 31 states" - **Type IDs:** `307` | **Servers:** `somfy_europe` | **Controllable:** `ogp:SmokeSensor` | **Profiles:** `SmokeDetector` + **Type IDs:** `257` | **Servers:** `somfy_europe` | **Controllable:** `ogp:Light` | **Profiles:** `StatefulLightDimmer`, `ElectricPowerMeter`, `StatefulSwitchable`, `Switchable`, `StatefulDimmable`, `Dimmable`, `Cyclic` **Commands** | Command | Parameters | Notes | |---------|-----------|-------| + | `cycle` | | Do a cycle of supported motion kinematics or modes | + | `dimDown` | | Decrease the light intensity step by step | + | `dimUp` | | Increase the light intensity step by step | | `executeManufacturerProcedure` | STRING; OBJECT (optional) | execute manufacturer procedure command. p1: the procedure name p2: the params associated Example: p1 = "dead_man_up" p2 = {"duration": 42} | + | `goToAlias` | STRING | Send alias command linked with the ID. | | `identify` | | Ask the device to identify itself by doing a slight movement or blink or beep | + | `off` | | Turn off the device | + | `on` | | Turn on the device | | `readManufacturerData` | ARRAY | Read manufacturer data values from given names. Example: ["setting1","setting2"]. | + | `saveAlias` | STRING | Allow to send an order for the product to save the current state of the alias. | | `sendPrivate` | OBJECT | send a private command | + | `setColorTemperature` | INT [1000..10000] | Set the perceived white temperature for this lamp (°K) | + | `setIntensity` | INT [0..100] | Light intensity level (100%=maximum intensity, 0%=off) | | `setName` | STRING | Change the device internal name. Name length may be subject to restrictions depending on the device and underlying protocol. | + | `setNodeDefinition` | STRING; STRING (optional); STRING (optional) | Fill the node definition (some transitions can be forbidden) p1: type (mandatory) p2: subType (mandatory if definition is set) p3: definition | + | `setOnOff` | STRING: off, on | Turn the device on or off | + | `setRGB` | INT [0..255]; INT [0..255]; INT [0..255] | Set the Red,Green,Blue components of the lamp color | + | `toggle` | | Toggle on/off status | | `update` | | Update the gateway software. The update may have to be downloaded first, which can take a while. | | `writeManufacturerData` | OBJECT | Write manufacturer data values. Example: { "setting1": true, "setting2": 42, "setting3": "overkiz", "setting4": "Dk8PDr1WD0sfAAAAAAAAAAAAAAAAAAAA", "setting5": [ "valueA", "valueB", "valueC" ], "setting6": { "value": 15, "definition": 158 } } | @@ -12805,13 +12829,18 @@ This page lists all known device types from the Overkiz API, grouped by protocol | `AvailabilityState` | DiscreteState | available, unavailable | | | `BatteryDiscreteLevelState` | DiscreteState | good, medium, low, critical | | | `BatteryLevelState` | ContinuousState | | | - | `ErrorEventState` | DiscreteState | accessLimitation, internal, obstacleProtection, transportBusy, deviceNoAnswer, cancelled, deprecated, interrupted, thermalProtection, maintenanceRequired, alreadyUpToDate, notSupported, hardwareError, accessDenied, updateError, resourceAlreadyExist | | + | `ColorModeState` | DiscreteState | cieXYZ, hueAndStaturation, temperature, rgb | | + | `ColorTemperatureState` | ContinuousState | | | + | `ElectricPowerConsumptionState` | ContinuousState | | | | `ErrorState` | DataState | | | | `ErrorsState` | DataState | | | | `FirmwareHashState` | DataState | | | | `FirmwareRevisionState` | DataState | | | + | `IntensityState` | ContinuousState | | | + | `LightIntensityState` | ContinuousState | [0..100] | | | `NameState` | DataState | | | | `NewFirmwareAvailableState` | DataState | | | + | `OnOffState` | DiscreteState | on, off | | | `Private10State` | DataState | | | | `Private1State` | DataState | | | | `Private2State` | DataState | | | @@ -12822,15 +12851,15 @@ This page lists all known device types from the Overkiz API, grouped by protocol | `Private7State` | DataState | | | | `Private8State` | DataState | | | | `Private9State` | DataState | | | + | `RGBColorState` | DataState | | | + | `ReachedAliasesState` | DataState | | | | `RemovableState` | DataState | | | | `SignalQualityState` | ContinuousState | | | - | `SmokeDetectionEventState` | DiscreteState | smoke | | - | `SmokeState` | DiscreteState | detected, notDetected | | | `StatusState` | DiscreteState | available, unavailable | | -??? note "Switch/DynamicSwitch (ACTUATOR) — 8 commands, 27 states" +??? note "LightSensor/DynamicLightSensor (SENSOR) — 7 commands, 26 states" - **Type IDs:** `297` | **Servers:** `rexel`, `somfy_europe` | **Controllable:** `ogp:Switch` | **Profiles:** `SwitchEvent`, `Switch` + **Type IDs:** `273` | **Servers:** `rexel` | **Controllable:** `ogp:LightSensor` | **Profiles:** `Luminance` **Commands** @@ -12841,7 +12870,6 @@ This page lists all known device types from the Overkiz API, grouped by protocol | `readManufacturerData` | ARRAY | Read manufacturer data values from given names. Example: ["setting1","setting2"]. | | `sendPrivate` | OBJECT | send a private command | | `setName` | STRING | Change the device internal name. Name length may be subject to restrictions depending on the device and underlying protocol. | - | `setNodeDefinition` | STRING; STRING (optional); STRING (optional) | Fill the node definition (some transitions can be forbidden) p1: type (mandatory) p2: subType (mandatory if definition is set) p3: definition | | `update` | | Update the gateway software. The update may have to be downloaded first, which can take a while. | | `writeManufacturerData` | OBJECT | Write manufacturer data values. Example: { "setting1": true, "setting2": 42, "setting3": "overkiz", "setting4": "Dk8PDr1WD0sfAAAAAAAAAAAAAAAAAAAA", "setting5": [ "valueA", "valueB", "valueC" ], "setting6": { "value": 15, "definition": 158 } } | @@ -12849,18 +12877,17 @@ This page lists all known device types from the Overkiz API, grouped by protocol | State | Type | Range / Values | Notes | |-------|------|----------------|-------| - | `ActionState` | DataState | | | | `ActivePartitionState` | DataState | | | | `AvailabilityState` | DiscreteState | available, unavailable | | - | `AvailableActionsState` | DataState | | | | `BatteryDiscreteLevelState` | DiscreteState | good, medium, low, critical | | | `BatteryLevelState` | ContinuousState | | | - | `ButtonActionsEventState` | DataState | | | | `ErrorEventState` | DiscreteState | accessLimitation, internal, obstacleProtection, transportBusy, deviceNoAnswer, cancelled, deprecated, interrupted, thermalProtection, maintenanceRequired, alreadyUpToDate, notSupported, hardwareError, accessDenied, updateError, resourceAlreadyExist | | | `ErrorState` | DataState | | | | `ErrorsState` | DataState | | | | `FirmwareHashState` | DataState | | | | `FirmwareRevisionState` | DataState | | | + | `IlluminanceState` | ContinuousState | | | + | `LuminanceState` | ContinuousState | | | | `NameState` | DataState | | | | `NewFirmwareAvailableState` | DataState | | | | `Private10State` | DataState | | | @@ -12877,9 +12904,9 @@ This page lists all known device types from the Overkiz API, grouped by protocol | `SignalQualityState` | ContinuousState | | | | `StatusState` | DiscreteState | available, unavailable | | -??? note "TemperatureSensor/DynamicTemperatureSensor (SENSOR) — 7 commands, 25 states" +??? note "LightSensor/DynamicLightSensor (SENSOR) — 7 commands, 25 states" - **Type IDs:** `270` | **Servers:** `rexel`, `somfy_europe` | **Controllable:** `ogp:TemperatureSensor` | **Profiles:** `Temperature` + **Type IDs:** `273` | **Servers:** `somfy_europe` | **Controllable:** `ogp:LightSensor` | **Profiles:** `Luminance` **Commands** @@ -12901,11 +12928,12 @@ This page lists all known device types from the Overkiz API, grouped by protocol | `AvailabilityState` | DiscreteState | available, unavailable | | | `BatteryDiscreteLevelState` | DiscreteState | good, medium, low, critical | | | `BatteryLevelState` | ContinuousState | | | - | `ErrorEventState` | DiscreteState | accessLimitation, internal, obstacleProtection, transportBusy, deviceNoAnswer, cancelled, deprecated, interrupted, thermalProtection, maintenanceRequired, alreadyUpToDate, notSupported, hardwareError, accessDenied, updateError, resourceAlreadyExist | | | `ErrorState` | DataState | | | | `ErrorsState` | DataState | | | | `FirmwareHashState` | DataState | | | | `FirmwareRevisionState` | DataState | | | + | `IlluminanceState` | ContinuousState | | | + | `LuminanceState` | ContinuousState | | | | `NameState` | DataState | | | | `NewFirmwareAvailableState` | DataState | | | | `Private10State` | DataState | | | @@ -12921,24 +12949,42 @@ This page lists all known device types from the Overkiz API, grouped by protocol | `RemovableState` | DataState | | | | `SignalQualityState` | ContinuousState | | | | `StatusState` | DiscreteState | available, unavailable | | - | `TemperatureState` | ContinuousState | [-100.0..100.0] | | -??? note "ThirdPartyGateway/DynamicThirdPartyGateway (ACTUATOR) — 10 commands, 26 states" +??? note "MusicPlayer/DynamicAudioPlayer (ACTUATOR) — 29 commands, 39 states" - **Type IDs:** `283` | **Servers:** `rexel`, `somfy_europe` | **Controllable:** `ogp:ThirdPartyGateway` | **Profiles:** `Specific` + **Type IDs:** `288` | **Servers:** `rexel` | **Controllable:** `ogp:AudioPlayer` | **Profiles:** `StoppableMusicPlayer`, `MusicPlayer`, `StatefulStartStop`, `StartStop`, `VolumeControl`, `StatefulSwitchable`, `Switchable` **Commands** | Command | Parameters | Notes | |---------|-----------|-------| + | `activateOption` | STRING | Activate an option | | `addGroupMember` | STRING | Add member to the group p1 : Id of the member to add to the group. | + | `deactivateOption` | STRING | Deactivate an option | | `executeManufacturerProcedure` | STRING; OBJECT (optional) | execute manufacturer procedure command. p1: the procedure name p2: the params associated Example: p1 = "dead_man_up" p2 = {"duration": 42} | + | `fastBackward` | INT | Go to a backward position for a specified time. p1 : Amount of time in sec. | + | `fastForward` | INT | Go to a forward position for a specified time. p1 : Amount of time in sec. | + | `getMediaElements` | | Get the list of all media available. | | `identify` | | Ask the device to identify itself by doing a slight movement or blink or beep | + | `mute` | | Mute the device | + | `next` | | Play next track | + | `off` | | Turn off the device | + | `on` | | Turn on the device | + | `pause` | | Pause current action | + | `play` | | Play media | + | `previous` | | Play previous track | | `readManufacturerData` | ARRAY | Read manufacturer data values from given names. Example: ["setting1","setting2"]. | | `removeGroupMember` | STRING | Remove a member of the group. p1 : Id of the member to remove to the group. | + | `resume` | | Resume paused action. | | `sendPrivate` | OBJECT | send a private command | - | `setAuthentication` | OBJECT | Set authentication properties of a node | + | `setMediaElement` | STRING | Set the media element as current. p1 : Id of the media element to set. | | `setName` | STRING | Change the device internal name. Name length may be subject to restrictions depending on the device and underlying protocol. | + | `setOnOff` | STRING: off, on | Turn the device on or off | + | `setTimelinePosition` | INT | Go to a position on the timeline. p1 : Position time in sec. | + | `setVolume` | INT [0..100] | Set the device output volume | + | `start` | | Start the default actuator behavior (movement, sound or timer) | + | `stop` | | Stop the current actuator behavior (movement, sound or timer) | + | `unmute` | | Unmute the device | | `update` | | Update the gateway software. The update may have to be downloaded first, which can take a while. | | `writeManufacturerData` | OBJECT | Write manufacturer data values. Example: { "setting1": true, "setting2": 42, "setting3": "overkiz", "setting4": "Dk8PDr1WD0sfAAAAAAAAAAAAAAAAAAAA", "setting5": [ "valueA", "valueB", "valueC" ], "setting6": { "value": 15, "definition": 158 } } | @@ -12946,9 +12992,10 @@ This page lists all known device types from the Overkiz API, grouped by protocol | State | Type | Range / Values | Notes | |-------|------|----------------|-------| + | `ActivatedOptionsState` | DataState | | | | `ActivePartitionState` | DataState | | | - | `AuthenticationExpiredState` | DataState | | | | `AvailabilityState` | DiscreteState | available, unavailable | | + | `AvailableOptionsState` | DataState | | | | `BatteryDiscreteLevelState` | DiscreteState | good, medium, low, critical | | | `BatteryLevelState` | ContinuousState | | | | `ErrorEventState` | DiscreteState | accessLimitation, internal, obstacleProtection, transportBusy, deviceNoAnswer, cancelled, deprecated, interrupted, thermalProtection, maintenanceRequired, alreadyUpToDate, notSupported, hardwareError, accessDenied, updateError, resourceAlreadyExist | | @@ -12957,8 +13004,15 @@ This page lists all known device types from the Overkiz API, grouped by protocol | `FirmwareHashState` | DataState | | | | `FirmwareRevisionState` | DataState | | | | `GroupMembersState` | DataState | | | + | `HasNextState` | DataState | | | + | `HasPreviousState` | DataState | | | + | `MediaElementState` | DataState | | | + | `MediaElementsEventState` | DataState | | | + | `MuteState` | DataState | | | | `NameState` | DataState | | | | `NewFirmwareAvailableState` | DataState | | | + | `OnOffState` | DiscreteState | on, off | | + | `PausedState` | DataState | | | | `Private10State` | DataState | | | | `Private1State` | DataState | | | | `Private2State` | DataState | | | @@ -12969,36 +13023,50 @@ This page lists all known device types from the Overkiz API, grouped by protocol | `Private7State` | DataState | | | | `Private8State` | DataState | | | | `Private9State` | DataState | | | + | `RecommendedOptionsState` | DataState | | | | `RemovableState` | DataState | | | | `SignalQualityState` | ContinuousState | | | + | `StartedStoppedState` | DiscreteState | started, stopped | | | `StatusState` | DiscreteState | available, unavailable | | + | `TimelineDurationState` | DataState | | | + | `TimelinePositionState` | DataState | | | + | `VolumeLevelState` | DataState | | | -??? note "VenetianBlind/DynamicVenetianBlind (ACTUATOR) — 20 commands, 31 states" +??? note "MusicPlayer/DynamicAudioPlayer (ACTUATOR) — 29 commands, 37 states" - **Type IDs:** `264` | **Servers:** `rexel`, `somfy_europe` | **Controllable:** `ogp:VenetianBlind` | **Profiles:** `StatefulOrientableShutter`, `StatefulOrientablePlusCloseable`, `OrientablePlusCloseable`, `StatefulOpenClose`, `OpenClose`, `StatefulCloseable`, `Closeable` + **Type IDs:** `288` | **Servers:** `somfy_europe` | **Controllable:** `ogp:AudioPlayer` | **Profiles:** `StoppableMusicPlayer`, `MusicPlayer`, `StatefulStartStop`, `StartStop`, `VolumeControl`, `StatefulSwitchable`, `Switchable` **Commands** | Command | Parameters | Notes | |---------|-----------|-------| - | `close` | | Fully close the device | + | `activateOption` | STRING | Activate an option | + | `addGroupMember` | STRING | Add member to the group p1 : Id of the member to add to the group. | + | `deactivateOption` | STRING | Deactivate an option | | `executeManufacturerProcedure` | STRING; OBJECT (optional) | execute manufacturer procedure command. p1: the procedure name p2: the params associated Example: p1 = "dead_man_up" p2 = {"duration": 42} | - | `goToAlias` | STRING | Send alias command linked with the ID. | + | `fastBackward` | INT | Go to a backward position for a specified time. p1 : Amount of time in sec. | + | `fastForward` | INT | Go to a forward position for a specified time. p1 : Amount of time in sec. | + | `getMediaElements` | | Get the list of all media available. | | `identify` | | Ask the device to identify itself by doing a slight movement or blink or beep | - | `open` | | Fully open the device | + | `mute` | | Mute the device | + | `next` | | Play next track | + | `off` | | Turn off the device | + | `on` | | Turn on the device | + | `pause` | | Pause current action | + | `play` | | Play media | + | `previous` | | Play previous track | | `readManufacturerData` | ARRAY | Read manufacturer data values from given names. Example: ["setting1","setting2"]. | - | `right` | | Right the device (go to minimum tilt position - open) | - | `saveAlias` | STRING | Allow to send an order for the product to save the current state of the alias. | + | `removeGroupMember` | STRING | Remove a member of the group. p1 : Id of the member to remove to the group. | + | `resume` | | Resume paused action. | | `sendPrivate` | OBJECT | send a private command | - | `setClosure` | INT [0..100] | Closure level (100%=fully close, 0%=open) | + | `setMediaElement` | STRING | Set the media element as current. p1 : Id of the media element to set. | | `setName` | STRING | Change the device internal name. Name length may be subject to restrictions depending on the device and underlying protocol. | - | `setNodeDefinition` | STRING; STRING (optional); STRING (optional) | Fill the node definition (some transitions can be forbidden) p1: type (mandatory) p2: subType (mandatory if definition is set) p3: definition | - | `setOrientation` | INT [0..100] | Set the relative orientation (0-100%) of the device slats | - | `setTilt` | INT [0..100] | set the device tilt percentage | + | `setOnOff` | STRING: off, on | Turn the device on or off | + | `setTimelinePosition` | INT | Go to a position on the timeline. p1 : Position time in sec. | + | `setVolume` | INT [0..100] | Set the device output volume | + | `start` | | Start the default actuator behavior (movement, sound or timer) | | `stop` | | Stop the current actuator behavior (movement, sound or timer) | - | `tilt` | | Go to maximum tilt position (closed) | - | `tiltDown` | | Lower the slats to a horizontal position step by step (which will let in more light) | - | `tiltUp` | | Straighten the slats to a vertical position step by step (which will let in less light) | + | `unmute` | | Unmute the device | | `update` | | Update the gateway software. The update may have to be downloaded first, which can take a while. | | `writeManufacturerData` | OBJECT | Write manufacturer data values. Example: { "setting1": true, "setting2": 42, "setting3": "overkiz", "setting4": "Dk8PDr1WD0sfAAAAAAAAAAAAAAAAAAAA", "setting5": [ "valueA", "valueB", "valueC" ], "setting6": { "value": 15, "definition": 158 } } | @@ -13006,19 +13074,25 @@ This page lists all known device types from the Overkiz API, grouped by protocol | State | Type | Range / Values | Notes | |-------|------|----------------|-------| + | `ActivatedOptionsState` | DataState | | | | `ActivePartitionState` | DataState | | | | `AvailabilityState` | DiscreteState | available, unavailable | | + | `AvailableOptionsState` | DataState | | | | `BatteryDiscreteLevelState` | DiscreteState | good, medium, low, critical | | | `BatteryLevelState` | ContinuousState | | | - | `ClosureState` | ContinuousState | [0..100] | | - | `ErrorEventState` | DiscreteState | accessLimitation, internal, obstacleProtection, transportBusy, deviceNoAnswer, cancelled, deprecated, interrupted, thermalProtection, maintenanceRequired, alreadyUpToDate, notSupported, hardwareError, accessDenied, updateError, resourceAlreadyExist | | | `ErrorState` | DataState | | | | `ErrorsState` | DataState | | | | `FirmwareHashState` | DataState | | | | `FirmwareRevisionState` | DataState | | | + | `GroupMembersState` | DataState | | | + | `HasNextState` | DataState | | | + | `HasPreviousState` | DataState | | | + | `MediaElementState` | DataState | | | + | `MuteState` | DataState | | | | `NameState` | DataState | | | | `NewFirmwareAvailableState` | DataState | | | - | `OpenClosedState` | DiscreteState | open, closed | | + | `OnOffState` | DiscreteState | on, off | | + | `PausedState` | DataState | | | | `Private10State` | DataState | | | | `Private1State` | DataState | | | | `Private2State` | DataState | | | @@ -13029,38 +13103,28 @@ This page lists all known device types from the Overkiz API, grouped by protocol | `Private7State` | DataState | | | | `Private8State` | DataState | | | | `Private9State` | DataState | | | - | `ReachedAliasesState` | DataState | | | + | `RecommendedOptionsState` | DataState | | | | `RemovableState` | DataState | | | | `SignalQualityState` | ContinuousState | | | - | `SlateOrientationState` | ContinuousState | [0..100] | | + | `StartedStoppedState` | DiscreteState | started, stopped | | | `StatusState` | DiscreteState | available, unavailable | | - | `TiltState` | ContinuousState | | | - | `TiltedState` | DiscreteState | true, false | | - | `UnavailableFeaturesState` | DataState | | | + | `TimelineDurationState` | DataState | | | + | `TimelinePositionState` | DataState | | | + | `VolumeLevelState` | DataState | | | -??? note "VentilationSystem/DynamicVentilation (ACTUATOR) — 17 commands, 32 states" +??? note "NoiseSensor/DynamicAmbientNoiseSensor (SENSOR) — 7 commands, 25 states" - **Type IDs:** `260` | **Servers:** `rexel`, `somfy_europe` | **Controllable:** `ogp:Ventilation` | **Profiles:** `StatefulSwitchableVentilation`, `Temperature`, `StatefulSwitchable`, `Switchable`, `StatefulAirFan`, `AirFan` + **Type IDs:** `305` | **Servers:** `rexel` | **Controllable:** `ogp:AmbientNoiseSensor` | **Profiles:** `AmbientNoiseSensor` **Commands** | Command | Parameters | Notes | |---------|-----------|-------| | `executeManufacturerProcedure` | STRING; OBJECT (optional) | execute manufacturer procedure command. p1: the procedure name p2: the params associated Example: p1 = "dead_man_up" p2 = {"duration": 42} | - | `goToAlias` | STRING | Send alias command linked with the ID. | | `identify` | | Ask the device to identify itself by doing a slight movement or blink or beep | - | `off` | | Turn off the device | - | `on` | | Turn on the device | | `readManufacturerData` | ARRAY | Read manufacturer data values from given names. Example: ["setting1","setting2"]. | - | `saveAlias` | STRING | Allow to send an order for the product to save the current state of the alias. | | `sendPrivate` | OBJECT | send a private command | - | `setFanSpeed` | STRING: low, medium, high, auto, 1 | Set the fan speed (%) | - | `setFanSpeedLevel` | INT [0..100] | Set the device fan speed level (%) | - | `setMode` | STRING | Set the active mode. | | `setName` | STRING | Change the device internal name. Name length may be subject to restrictions depending on the device and underlying protocol. | - | `setNodeDefinition` | STRING; STRING (optional); STRING (optional) | Fill the node definition (some transitions can be forbidden) p1: type (mandatory) p2: subType (mandatory if definition is set) p3: definition | - | `setOnOff` | STRING: off, on | Turn the device on or off | - | `toggle` | | Toggle on/off status | | `update` | | Update the gateway software. The update may have to be downloaded first, which can take a while. | | `writeManufacturerData` | OBJECT | Write manufacturer data values. Example: { "setting1": true, "setting2": 42, "setting3": "overkiz", "setting4": "Dk8PDr1WD0sfAAAAAAAAAAAAAAAAAAAA", "setting5": [ "valueA", "valueB", "valueC" ], "setting6": { "value": 15, "definition": 158 } } | @@ -13069,21 +13133,17 @@ This page lists all known device types from the Overkiz API, grouped by protocol | State | Type | Range / Values | Notes | |-------|------|----------------|-------| | `ActivePartitionState` | DataState | | | + | `AmbientNoiseState` | ContinuousState | | | | `AvailabilityState` | DiscreteState | available, unavailable | | - | `AvailableModesState` | DataState | | | | `BatteryDiscreteLevelState` | DiscreteState | good, medium, low, critical | | | `BatteryLevelState` | ContinuousState | | | | `ErrorEventState` | DiscreteState | accessLimitation, internal, obstacleProtection, transportBusy, deviceNoAnswer, cancelled, deprecated, interrupted, thermalProtection, maintenanceRequired, alreadyUpToDate, notSupported, hardwareError, accessDenied, updateError, resourceAlreadyExist | | | `ErrorState` | DataState | | | | `ErrorsState` | DataState | | | - | `FanSpeedLevelState` | ContinuousState | [0..100] | | - | `FanSpeedState` | DiscreteState | low, medium, high, 1, 2, 3, 4, 5, 6, 7, 8, 9 | | | `FirmwareHashState` | DataState | | | | `FirmwareRevisionState` | DataState | | | - | `ModeState` | DataState | | | | `NameState` | DataState | | | | `NewFirmwareAvailableState` | DataState | | | - | `OnOffState` | DiscreteState | on, off | | | `Private10State` | DataState | | | | `Private1State` | DataState | | | | `Private2State` | DataState | | | @@ -13094,37 +13154,23 @@ This page lists all known device types from the Overkiz API, grouped by protocol | `Private7State` | DataState | | | | `Private8State` | DataState | | | | `Private9State` | DataState | | | - | `ReachedAliasesState` | DataState | | | | `RemovableState` | DataState | | | | `SignalQualityState` | ContinuousState | | | | `StatusState` | DiscreteState | available, unavailable | | - | `TemperatureState` | ContinuousState | [-100.0..100.0] | | - | `UnavailableFeaturesState` | DataState | | | -??? note "VentilationSystem/DynamicAirVent (ACTUATOR) — 18 commands, 33 states" +??? note "NoiseSensor/DynamicAmbientNoiseSensor (SENSOR) — 7 commands, 24 states" - **Type IDs:** `268` | **Servers:** `rexel`, `somfy_europe` | **Controllable:** `ogp:AirVent` | **Profiles:** `StatefulCloseableAirVent`, `StatefulOrientableSlats`, `OrientableSlats`, `StatefulBasicCloseable`, `BasicCloseable`, `StatefulBasicOpenClose`, `BasicOpenClose` + **Type IDs:** `305` | **Servers:** `somfy_europe` | **Controllable:** `ogp:AmbientNoiseSensor` | **Profiles:** `AmbientNoiseSensor` **Commands** | Command | Parameters | Notes | |---------|-----------|-------| - | `close` | | Fully close the device | | `executeManufacturerProcedure` | STRING; OBJECT (optional) | execute manufacturer procedure command. p1: the procedure name p2: the params associated Example: p1 = "dead_man_up" p2 = {"duration": 42} | - | `goToAlias` | STRING | Send alias command linked with the ID. | | `identify` | | Ask the device to identify itself by doing a slight movement or blink or beep | - | `open` | | Fully open the device | | `readManufacturerData` | ARRAY | Read manufacturer data values from given names. Example: ["setting1","setting2"]. | - | `right` | | Right the device (go to minimum tilt position - open) | - | `saveAlias` | STRING | Allow to send an order for the product to save the current state of the alias. | | `sendPrivate` | OBJECT | send a private command | - | `setClosure` | INT [0..100] | Closure level (100%=fully close, 0%=open) | - | `setMode` | STRING | Set the active mode. | | `setName` | STRING | Change the device internal name. Name length may be subject to restrictions depending on the device and underlying protocol. | - | `setNodeDefinition` | STRING; STRING (optional); STRING (optional) | Fill the node definition (some transitions can be forbidden) p1: type (mandatory) p2: subType (mandatory if definition is set) p3: definition | - | `setOrientation` | INT [0..100] | Set the relative orientation (0-100%) of the device slats | - | `setTilt` | INT [0..100] | set the device tilt percentage | - | `tilt` | | Go to maximum tilt position (closed) | | `update` | | Update the gateway software. The update may have to be downloaded first, which can take a while. | | `writeManufacturerData` | OBJECT | Write manufacturer data values. Example: { "setting1": true, "setting2": 42, "setting3": "overkiz", "setting4": "Dk8PDr1WD0sfAAAAAAAAAAAAAAAAAAAA", "setting5": [ "valueA", "valueB", "valueC" ], "setting6": { "value": 15, "definition": 158 } } | @@ -13133,20 +13179,16 @@ This page lists all known device types from the Overkiz API, grouped by protocol | State | Type | Range / Values | Notes | |-------|------|----------------|-------| | `ActivePartitionState` | DataState | | | + | `AmbientNoiseState` | ContinuousState | | | | `AvailabilityState` | DiscreteState | available, unavailable | | - | `AvailableModesState` | DataState | | | | `BatteryDiscreteLevelState` | DiscreteState | good, medium, low, critical | | | `BatteryLevelState` | ContinuousState | | | - | `ClosureState` | ContinuousState | [0..100] | | - | `ErrorEventState` | DiscreteState | accessLimitation, internal, obstacleProtection, transportBusy, deviceNoAnswer, cancelled, deprecated, interrupted, thermalProtection, maintenanceRequired, alreadyUpToDate, notSupported, hardwareError, accessDenied, updateError, resourceAlreadyExist | | | `ErrorState` | DataState | | | | `ErrorsState` | DataState | | | | `FirmwareHashState` | DataState | | | | `FirmwareRevisionState` | DataState | | | - | `ModeState` | DataState | | | | `NameState` | DataState | | | | `NewFirmwareAvailableState` | DataState | | | - | `OpenClosedState` | DiscreteState | open, closed | | | `Private10State` | DataState | | | | `Private1State` | DataState | | | | `Private2State` | DataState | | | @@ -13157,44 +13199,23 @@ This page lists all known device types from the Overkiz API, grouped by protocol | `Private7State` | DataState | | | | `Private8State` | DataState | | | | `Private9State` | DataState | | | - | `ReachedAliasesState` | DataState | | | | `RemovableState` | DataState | | | | `SignalQualityState` | ContinuousState | | | - | `SlateOrientationState` | ContinuousState | [0..100] | | | `StatusState` | DiscreteState | available, unavailable | | - | `TiltState` | ContinuousState | | | - | `TiltedState` | DiscreteState | true, false | | - | `UnavailableFeaturesState` | DataState | | | -??? note "WashingMachine/DynamicWashingMachine (ACTUATOR) — 23 commands, 56 states" +??? note "OccupancySensor/DynamicOccupancySensor (SENSOR) — 7 commands, 25 states" - **Type IDs:** `285` | **Servers:** `rexel`, `somfy_europe` | **Controllable:** `ogp:WashingMachine` | **Profiles:** `StatefulStartStopWashingMachine`, `StatefulStartStop`, `StartStop`, `StatefulLockWithOpeningStatus`, `StatefulThermostat`, `Thermostat`, `StatefulSwitchable`, `Switchable`, `StatefulLock`, `LockStatus`, `Lock` + **Type IDs:** `280` | **Servers:** `rexel` | **Controllable:** `ogp:OccupancySensor` | **Profiles:** `OccupancyDetector` **Commands** | Command | Parameters | Notes | |---------|-----------|-------| - | `activateOption` | STRING | Activate an option | - | `deactivateOption` | STRING | Deactivate an option | | `executeManufacturerProcedure` | STRING; OBJECT (optional) | execute manufacturer procedure command. p1: the procedure name p2: the params associated Example: p1 = "dead_man_up" p2 = {"duration": 42} | | `identify` | | Ask the device to identify itself by doing a slight movement or blink or beep | - | `lock` | | Lock the device | - | `off` | | Turn off the device | - | `on` | | Turn on the device | - | `pause` | | Pause current action | | `readManufacturerData` | ARRAY | Read manufacturer data values from given names. Example: ["setting1","setting2"]. | - | `resume` | | Resume paused action. | | `sendPrivate` | OBJECT | send a private command | - | `setMode` | STRING | Set the active mode. | | `setName` | STRING | Change the device internal name. Name length may be subject to restrictions depending on the device and underlying protocol. | - | `setOnOff` | STRING: off, on | Turn the device on or off | - | `setTargetSpinSpeed` | INT | Set the target spin speed. | - | `setTargetTemperature` | FLOAT | Set the new air temperature to reach | - | `setTargetTime` | INT | Set a target action duration. | - | `setTimezone` | STRING | Set the device timezone, according to TZ database names. | - | `start` | | Start the default actuator behavior (movement, sound or timer) | - | `stop` | | Stop the current actuator behavior (movement, sound or timer) | - | `unlock` | | Unlock the device | | `update` | | Update the gateway software. The update may have to be downloaded first, which can take a while. | | `writeManufacturerData` | OBJECT | Write manufacturer data values. Example: { "setting1": true, "setting2": 42, "setting3": "overkiz", "setting4": "Dk8PDr1WD0sfAAAAAAAAAAAAAAAAAAAA", "setting5": [ "valueA", "valueB", "valueC" ], "setting6": { "value": 15, "definition": 158 } } | @@ -13202,30 +13223,18 @@ This page lists all known device types from the Overkiz API, grouped by protocol | State | Type | Range / Values | Notes | |-------|------|----------------|-------| - | `ActivatedOptionsState` | DataState | | | | `ActivePartitionState` | DataState | | | | `AvailabilityState` | DiscreteState | available, unavailable | | - | `AvailableModesState` | DataState | | | - | `AvailableOptionsState` | DataState | | | - | `AvailableTargetSpinSpeedsState` | DataState | | | - | `AvailableTargetTemperaturesState` | DataState | | | | `BatteryDiscreteLevelState` | DiscreteState | good, medium, low, critical | | | `BatteryLevelState` | ContinuousState | | | - | `CurrentCycleStageState` | DataState | | | - | `CycleStageSequenceState` | DataState | | | | `ErrorEventState` | DiscreteState | accessLimitation, internal, obstacleProtection, transportBusy, deviceNoAnswer, cancelled, deprecated, interrupted, thermalProtection, maintenanceRequired, alreadyUpToDate, notSupported, hardwareError, accessDenied, updateError, resourceAlreadyExist | | | `ErrorState` | DataState | | | | `ErrorsState` | DataState | | | | `FirmwareHashState` | DataState | | | | `FirmwareRevisionState` | DataState | | | - | `LockedUnlockedState` | DiscreteState | locked, unlocked | | - | `ModeState` | DataState | | | | `NameState` | DataState | | | | `NewFirmwareAvailableState` | DataState | | | - | `OnOffState` | DiscreteState | on, off | | - | `OpenClosedState` | DiscreteState | open, closed | | - | `OpenState` | DataState | | | - | `PausedState` | DataState | | | + | `OccupancyState` | DiscreteState | personInside, noPersonInside | | | `Private10State` | DataState | | | | `Private1State` | DataState | | | | `Private2State` | DataState | | | @@ -13236,51 +13245,77 @@ This page lists all known device types from the Overkiz API, grouped by protocol | `Private7State` | DataState | | | | `Private8State` | DataState | | | | `Private9State` | DataState | | | - | `RecommendedOptionsState` | DataState | | | - | `RecommendedTargetSpinSpeedState` | ContinuousState | | | - | `RecommendedTargetTemperatureState` | ContinuousState | | | - | `RecommendedTargetTimeState` | ContinuousState | | | - | `RemainingTimeState` | ContinuousState | | | | `RemovableState` | DataState | | | - | `RunningTimerState` | DataState | | | | `SignalQualityState` | ContinuousState | | | - | `StartedStoppedState` | DiscreteState | started, stopped | | | `StatusState` | DiscreteState | available, unavailable | | - | `TargetSpinSpeedCurrentLowerBoundState` | ContinuousState | | | - | `TargetSpinSpeedCurrentUpperBoundState` | ContinuousState | | | - | `TargetSpinSpeedState` | ContinuousState | | | - | `TargetTemperatureCurrentLowerBoundState` | ContinuousState | | | - | `TargetTemperatureCurrentUpperBoundState` | ContinuousState | | | - | `TargetTemperatureReachedState` | DataState | | | - | `TargetTemperatureState` | ContinuousState | [12.0..30.0] | | - | `TargetTimeCurrentLowerBoundState` | ContinuousState | | | - | `TargetTimeCurrentUpperBoundState` | ContinuousState | | | - | `TargetTimeState` | ContinuousState | | | - | `TimezoneState` | DataState | | | - | `UnavailableFeaturesState` | DataState | | | -??? note "WaterHeatingSystem/DynamicDomesticHotWaterProduction (ACTUATOR) — 16 commands, 41 states" +??? note "OccupancySensor/DynamicOccupancySensor (SENSOR) — 7 commands, 24 states" - **Type IDs:** `290` | **Servers:** `rexel`, `somfy_europe` | **Controllable:** `ogp:DomesticHotWater` | **Profiles:** `StatefulThermostatWithSensor`, `StatefulThermostat`, `Thermostat`, `StatefulSwitchable`, `Switchable` + **Type IDs:** `280` | **Servers:** `somfy_europe` | **Controllable:** `ogp:OccupancySensor` | **Profiles:** `OccupancyDetector` **Commands** | Command | Parameters | Notes | |---------|-----------|-------| - | `activateOption` | STRING | Activate an option | - | `cancelHolidayMode` | | Deactivate holidays mode | - | `configureHolidayMode` | INT; INT | Configure holiday mode p1 : start date (timestamp in millisecond) p2 : end date (timestamp in millisecond) | - | `deactivateOption` | STRING | Deactivate an option | | `executeManufacturerProcedure` | STRING; OBJECT (optional) | execute manufacturer procedure command. p1: the procedure name p2: the params associated Example: p1 = "dead_man_up" p2 = {"duration": 42} | | `identify` | | Ask the device to identify itself by doing a slight movement or blink or beep | - | `off` | | Turn off the device | - | `on` | | Turn on the device | | `readManufacturerData` | ARRAY | Read manufacturer data values from given names. Example: ["setting1","setting2"]. | | `sendPrivate` | OBJECT | send a private command | - | `setMode` | STRING | Set the active mode. | | `setName` | STRING | Change the device internal name. Name length may be subject to restrictions depending on the device and underlying protocol. | + | `update` | | Update the gateway software. The update may have to be downloaded first, which can take a while. | + | `writeManufacturerData` | OBJECT | Write manufacturer data values. Example: { "setting1": true, "setting2": 42, "setting3": "overkiz", "setting4": "Dk8PDr1WD0sfAAAAAAAAAAAAAAAAAAAA", "setting5": [ "valueA", "valueB", "valueC" ], "setting6": { "value": 15, "definition": 158 } } | + + **States** + + | State | Type | Range / Values | Notes | + |-------|------|----------------|-------| + | `ActivePartitionState` | DataState | | | + | `AvailabilityState` | DiscreteState | available, unavailable | | + | `BatteryDiscreteLevelState` | DiscreteState | good, medium, low, critical | | + | `BatteryLevelState` | ContinuousState | | | + | `ErrorState` | DataState | | | + | `ErrorsState` | DataState | | | + | `FirmwareHashState` | DataState | | | + | `FirmwareRevisionState` | DataState | | | + | `NameState` | DataState | | | + | `NewFirmwareAvailableState` | DataState | | | + | `OccupancyState` | DiscreteState | personInside, noPersonInside | | + | `Private10State` | DataState | | | + | `Private1State` | DataState | | | + | `Private2State` | DataState | | | + | `Private3State` | DataState | | | + | `Private4State` | DataState | | | + | `Private5State` | DataState | | | + | `Private6State` | DataState | | | + | `Private7State` | DataState | | | + | `Private8State` | DataState | | | + | `Private9State` | DataState | | | + | `RemovableState` | DataState | | | + | `SignalQualityState` | ContinuousState | | | + | `StatusState` | DiscreteState | available, unavailable | | + +??? note "OnOff/DynamicOutlet (ACTUATOR) — 16 commands, 29 states" + + **Type IDs:** `261` | **Servers:** `rexel` | **Controllable:** `ogp:Outlet` | **Profiles:** `StatefulSwitchablePlug`, `ElectricPowerMeter`, `StatefulSwitchable`, `Switchable`, `StatefulDimmable`, `Dimmable`, `Cyclic` + + **Commands** + + | Command | Parameters | Notes | + |---------|-----------|-------| + | `cycle` | | Do a cycle of supported motion kinematics or modes | + | `executeManufacturerProcedure` | STRING; OBJECT (optional) | execute manufacturer procedure command. p1: the procedure name p2: the params associated Example: p1 = "dead_man_up" p2 = {"duration": 42} | + | `goToAlias` | STRING | Send alias command linked with the ID. | + | `identify` | | Ask the device to identify itself by doing a slight movement or blink or beep | + | `off` | | Turn off the device | + | `on` | | Turn on the device | + | `readManufacturerData` | ARRAY | Read manufacturer data values from given names. Example: ["setting1","setting2"]. | + | `saveAlias` | STRING | Allow to send an order for the product to save the current state of the alias. | + | `sendPrivate` | OBJECT | send a private command | + | `setIntensity` | INT [0..100] | Light intensity level (100%=maximum intensity, 0%=off) | + | `setName` | STRING | Change the device internal name. Name length may be subject to restrictions depending on the device and underlying protocol. | + | `setNodeDefinition` | STRING; STRING (optional); STRING (optional) | Fill the node definition (some transitions can be forbidden) p1: type (mandatory) p2: subType (mandatory if definition is set) p3: definition | | `setOnOff` | STRING: off, on | Turn the device on or off | - | `setTargetTemperature` | FLOAT | Set the new air temperature to reach | + | `toggle` | | Toggle on/off status | | `update` | | Update the gateway software. The update may have to be downloaded first, which can take a while. | | `writeManufacturerData` | OBJECT | Write manufacturer data values. Example: { "setting1": true, "setting2": 42, "setting3": "overkiz", "setting4": "Dk8PDr1WD0sfAAAAAAAAAAAAAAAAAAAA", "setting5": [ "valueA", "valueB", "valueC" ], "setting6": { "value": 15, "definition": 158 } } | @@ -13288,23 +13323,18 @@ This page lists all known device types from the Overkiz API, grouped by protocol | State | Type | Range / Values | Notes | |-------|------|----------------|-------| - | `ActivatedOptionsState` | DataState | | | | `ActivePartitionState` | DataState | | | | `AvailabilityState` | DiscreteState | available, unavailable | | - | `AvailableModesState` | DataState | | | - | `AvailableOptionsState` | DataState | | | - | `AvailableTargetTemperaturesState` | DataState | | | | `BatteryDiscreteLevelState` | DiscreteState | good, medium, low, critical | | | `BatteryLevelState` | ContinuousState | | | + | `ElectricPowerConsumptionState` | ContinuousState | | | | `ErrorEventState` | DiscreteState | accessLimitation, internal, obstacleProtection, transportBusy, deviceNoAnswer, cancelled, deprecated, interrupted, thermalProtection, maintenanceRequired, alreadyUpToDate, notSupported, hardwareError, accessDenied, updateError, resourceAlreadyExist | | | `ErrorState` | DataState | | | | `ErrorsState` | DataState | | | | `FirmwareHashState` | DataState | | | | `FirmwareRevisionState` | DataState | | | - | `HolidayModeConfiguredState` | DataState | | | - | `HolidayModeEndDateTimeState` | DataState | | | - | `HolidayModeStartDateTimeState` | DataState | | | - | `ModeState` | DataState | | | + | `IntensityState` | ContinuousState | | | + | `LightIntensityState` | ContinuousState | [0..100] | | | `NameState` | DataState | | | | `NewFirmwareAvailableState` | DataState | | | | `OnOffState` | DiscreteState | on, off | | @@ -13318,31 +13348,33 @@ This page lists all known device types from the Overkiz API, grouped by protocol | `Private7State` | DataState | | | | `Private8State` | DataState | | | | `Private9State` | DataState | | | - | `RecommendedOptionsState` | DataState | | | - | `RecommendedTargetTemperatureState` | ContinuousState | | | + | `ReachedAliasesState` | DataState | | | | `RemovableState` | DataState | | | | `SignalQualityState` | ContinuousState | | | | `StatusState` | DiscreteState | available, unavailable | | - | `TargetTemperatureCurrentLowerBoundState` | ContinuousState | | | - | `TargetTemperatureCurrentUpperBoundState` | ContinuousState | | | - | `TargetTemperatureReachedState` | DataState | | | - | `TargetTemperatureState` | ContinuousState | [12.0..30.0] | | - | `TemperatureState` | ContinuousState | [-100.0..100.0] | | - | `UnavailableFeaturesState` | DataState | | | -??? note "WaterSensor/DynamicWaterMeasurementSensor (SENSOR) — 7 commands, 26 states" +??? note "OnOff/DynamicOutlet (ACTUATOR) — 16 commands, 28 states" - **Type IDs:** `295` | **Servers:** `rexel`, `somfy_europe` | **Controllable:** `ogp:WaterMeasurementSensor` | **Profiles:** `WaterConsumption` + **Type IDs:** `261` | **Servers:** `somfy_europe` | **Controllable:** `ogp:Outlet` | **Profiles:** `StatefulSwitchablePlug`, `ElectricPowerMeter`, `StatefulSwitchable`, `Switchable`, `StatefulDimmable`, `Dimmable`, `Cyclic` **Commands** | Command | Parameters | Notes | |---------|-----------|-------| + | `cycle` | | Do a cycle of supported motion kinematics or modes | | `executeManufacturerProcedure` | STRING; OBJECT (optional) | execute manufacturer procedure command. p1: the procedure name p2: the params associated Example: p1 = "dead_man_up" p2 = {"duration": 42} | + | `goToAlias` | STRING | Send alias command linked with the ID. | | `identify` | | Ask the device to identify itself by doing a slight movement or blink or beep | + | `off` | | Turn off the device | + | `on` | | Turn on the device | | `readManufacturerData` | ARRAY | Read manufacturer data values from given names. Example: ["setting1","setting2"]. | + | `saveAlias` | STRING | Allow to send an order for the product to save the current state of the alias. | | `sendPrivate` | OBJECT | send a private command | + | `setIntensity` | INT [0..100] | Light intensity level (100%=maximum intensity, 0%=off) | | `setName` | STRING | Change the device internal name. Name length may be subject to restrictions depending on the device and underlying protocol. | + | `setNodeDefinition` | STRING; STRING (optional); STRING (optional) | Fill the node definition (some transitions can be forbidden) p1: type (mandatory) p2: subType (mandatory if definition is set) p3: definition | + | `setOnOff` | STRING: off, on | Turn the device on or off | + | `toggle` | | Toggle on/off status | | `update` | | Update the gateway software. The update may have to be downloaded first, which can take a while. | | `writeManufacturerData` | OBJECT | Write manufacturer data values. Example: { "setting1": true, "setting2": 42, "setting3": "overkiz", "setting4": "Dk8PDr1WD0sfAAAAAAAAAAAAAAAAAAAA", "setting5": [ "valueA", "valueB", "valueC" ], "setting6": { "value": 15, "definition": 158 } } | @@ -13354,13 +13386,16 @@ This page lists all known device types from the Overkiz API, grouped by protocol | `AvailabilityState` | DiscreteState | available, unavailable | | | `BatteryDiscreteLevelState` | DiscreteState | good, medium, low, critical | | | `BatteryLevelState` | ContinuousState | | | - | `ErrorEventState` | DiscreteState | accessLimitation, internal, obstacleProtection, transportBusy, deviceNoAnswer, cancelled, deprecated, interrupted, thermalProtection, maintenanceRequired, alreadyUpToDate, notSupported, hardwareError, accessDenied, updateError, resourceAlreadyExist | | + | `ElectricPowerConsumptionState` | ContinuousState | | | | `ErrorState` | DataState | | | | `ErrorsState` | DataState | | | | `FirmwareHashState` | DataState | | | | `FirmwareRevisionState` | DataState | | | + | `IntensityState` | ContinuousState | | | + | `LightIntensityState` | ContinuousState | [0..100] | | | `NameState` | DataState | | | | `NewFirmwareAvailableState` | DataState | | | + | `OnOffState` | DiscreteState | on, off | | | `Private10State` | DataState | | | | `Private1State` | DataState | | | | `Private2State` | DataState | | | @@ -13371,25 +13406,44 @@ This page lists all known device types from the Overkiz API, grouped by protocol | `Private7State` | DataState | | | | `Private8State` | DataState | | | | `Private9State` | DataState | | | + | `ReachedAliasesState` | DataState | | | | `RemovableState` | DataState | | | | `SignalQualityState` | ContinuousState | | | | `StatusState` | DiscreteState | available, unavailable | | - | `WaterConsumptionState` | ContinuousState | | | - | `WaterFlowState` | ContinuousState | | | -??? note "WeatherSensor/DynamicWeatherStation (SENSOR) — 7 commands, 34 states" +??? note "Oven/DynamicOven (ACTUATOR) — 27 commands, 69 states" - **Type IDs:** `279` | **Servers:** `rexel`, `somfy_europe` | **Controllable:** `ogp:WeatherStation` | **Profiles:** `WindSpeedAndDirection`, `WindSpeed`, `WindDirection`, `Temperature`, `RelativeHumidity`, `RainDetector`, `Luminance` + **Type IDs:** `284` | **Servers:** `rexel` | **Controllable:** `ogp:Oven` | **Profiles:** `StatefulStartStopOven`, `StatefulStartStop`, `StartStop`, `StatefulThermostatWithSensor`, `StatefulLockWithOpeningStatus`, `StatefulThermostat`, `Thermostat`, `StatefulSwitchable`, `Switchable`, `StatefulLock`, `LockStatus`, `Lock`, `StatefulDimmable`, `Dimmable` **Commands** | Command | Parameters | Notes | |---------|-----------|-------| + | `activateOption` | STRING | Activate an option | + | `deactivateOption` | STRING | Deactivate an option | | `executeManufacturerProcedure` | STRING; OBJECT (optional) | execute manufacturer procedure command. p1: the procedure name p2: the params associated Example: p1 = "dead_man_up" p2 = {"duration": 42} | | `identify` | | Ask the device to identify itself by doing a slight movement or blink or beep | + | `lock` | | Lock the device | + | `off` | | Turn off the device | + | `on` | | Turn on the device | + | `pause` | | Pause current action | | `readManufacturerData` | ARRAY | Read manufacturer data values from given names. Example: ["setting1","setting2"]. | + | `resume` | | Resume paused action. | | `sendPrivate` | OBJECT | send a private command | + | `setIntensity` | INT [0..100] | Light intensity level (100%=maximum intensity, 0%=off) | + | `setMode` | STRING | Set the active mode. | | `setName` | STRING | Change the device internal name. Name length may be subject to restrictions depending on the device and underlying protocol. | + | `setOnOff` | STRING: off, on | Turn the device on or off | + | `setRecipe` | STRING | Select/Activate a given recipe. | + | `setTargetHumidity` | INT [0..100] | Set the target humidity. | + | `setTargetPower` | INT | Set the target power. | + | `setTargetTemperature` | FLOAT | Set the new air temperature to reach | + | `setTargetTime` | INT | Set a target action duration. | + | `setTargetWeight` | INT | Indicate a target element weight. | + | `setTimezone` | STRING | Set the device timezone, according to TZ database names. | + | `start` | | Start the default actuator behavior (movement, sound or timer) | + | `stop` | | Stop the current actuator behavior (movement, sound or timer) | + | `unlock` | | Unlock the device | | `update` | | Update the gateway software. The update may have to be downloaded first, which can take a while. | | `writeManufacturerData` | OBJECT | Write manufacturer data values. Example: { "setting1": true, "setting2": 42, "setting3": "overkiz", "setting4": "Dk8PDr1WD0sfAAAAAAAAAAAAAAAAAAAA", "setting5": [ "valueA", "valueB", "valueC" ], "setting6": { "value": 15, "definition": 158 } } | @@ -13397,21 +13451,33 @@ This page lists all known device types from the Overkiz API, grouped by protocol | State | Type | Range / Values | Notes | |-------|------|----------------|-------| + | `ActivatedOptionsState` | DataState | | | | `ActivePartitionState` | DataState | | | | `AvailabilityState` | DiscreteState | available, unavailable | | + | `AvailableModesState` | DataState | | | + | `AvailableOptionsState` | DataState | | | + | `AvailableRecipesState` | DataState | | | + | `AvailableTargetTemperaturesState` | DataState | | | | `BatteryDiscreteLevelState` | DiscreteState | good, medium, low, critical | | | `BatteryLevelState` | ContinuousState | | | + | `CurrentCycleStageState` | DataState | | | + | `CurrentSoilingState` | ContinuousState | | | + | `CycleStageSequenceState` | DataState | | | | `ErrorEventState` | DiscreteState | accessLimitation, internal, obstacleProtection, transportBusy, deviceNoAnswer, cancelled, deprecated, interrupted, thermalProtection, maintenanceRequired, alreadyUpToDate, notSupported, hardwareError, accessDenied, updateError, resourceAlreadyExist | | | `ErrorState` | DataState | | | | `ErrorsState` | DataState | | | | `FirmwareHashState` | DataState | | | | `FirmwareRevisionState` | DataState | | | - | `FrostState` | DiscreteState | true, false | | - | `IceState` | DiscreteState | true, false | | - | `IlluminanceState` | ContinuousState | | | - | `LuminanceState` | ContinuousState | | | + | `IntensityState` | ContinuousState | | | + | `LightIntensityState` | ContinuousState | [0..100] | | + | `LockedUnlockedState` | DiscreteState | locked, unlocked | | + | `ModeState` | DataState | | | | `NameState` | DataState | | | | `NewFirmwareAvailableState` | DataState | | | + | `OnOffState` | DiscreteState | on, off | | + | `OpenClosedState` | DiscreteState | open, closed | | + | `OpenState` | DataState | | | + | `PausedState` | DataState | | | | `Private10State` | DataState | | | | `Private1State` | DataState | | | | `Private2State` | DataState | | | @@ -13422,29 +13488,72 @@ This page lists all known device types from the Overkiz API, grouped by protocol | `Private7State` | DataState | | | | `Private8State` | DataState | | | | `Private9State` | DataState | | | - | `RainState` | DiscreteState | detected, notDetected | | - | `RelativeHumidityState` | ContinuousState | [0.0..100.0] | | + | `RecipeState` | DataState | | | + | `RecommendedOptionsState` | DataState | | | + | `RecommendedTargetHumidityState` | ContinuousState | | | + | `RecommendedTargetPowerState` | ContinuousState | | | + | `RecommendedTargetTemperatureState` | ContinuousState | | | + | `RecommendedTargetTimeState` | ContinuousState | | | + | `RecommendedTargetWeightState` | ContinuousState | | | + | `RemainingTimeState` | ContinuousState | | | | `RemovableState` | DataState | | | + | `RunningTimerState` | DataState | | | | `SignalQualityState` | ContinuousState | | | - | `SnowState` | DiscreteState | true, false | | + | `StartedStoppedState` | DiscreteState | started, stopped | | | `StatusState` | DiscreteState | available, unavailable | | + | `TargetHumidityCurrentLowerBoundState` | ContinuousState | | | + | `TargetHumidityCurrentUpperBoundState` | ContinuousState | | | + | `TargetHumidityState` | ContinuousState | | | + | `TargetPowerCurrentLowerBoundState` | ContinuousState | | | + | `TargetPowerCurrentUpperBoundState` | ContinuousState | | | + | `TargetPowerState` | ContinuousState | | | + | `TargetTemperatureCurrentLowerBoundState` | ContinuousState | | | + | `TargetTemperatureCurrentUpperBoundState` | ContinuousState | | | + | `TargetTemperatureReachedState` | DataState | | | + | `TargetTemperatureState` | ContinuousState | [12.0..30.0] | | + | `TargetTimeCurrentLowerBoundState` | ContinuousState | | | + | `TargetTimeCurrentUpperBoundState` | ContinuousState | | | + | `TargetTimeState` | ContinuousState | | | + | `TargetWeightCurrentLowerBoundState` | ContinuousState | | | + | `TargetWeightCurrentUpperBoundState` | ContinuousState | | | + | `TargetWeightState` | ContinuousState | | | | `TemperatureState` | ContinuousState | [-100.0..100.0] | | - | `WindDirectionState` | ContinuousState | [0..360] | | - | `WindSpeedState` | ContinuousState | | | + | `TimezoneState` | DataState | | | + | `UnavailableFeaturesState` | DataState | | | -??? note "WindSensor/DynamicWindSensor (SENSOR) — 7 commands, 26 states" +??? note "Oven/DynamicOven (ACTUATOR) — 27 commands, 68 states" - **Type IDs:** `274` | **Servers:** `rexel`, `somfy_europe` | **Controllable:** `ogp:WindSensor` | **Profiles:** `WindSpeedAndDirection`, `WindSpeed`, `WindDirection` + **Type IDs:** `284` | **Servers:** `somfy_europe` | **Controllable:** `ogp:Oven` | **Profiles:** `StatefulStartStopOven`, `StatefulStartStop`, `StartStop`, `StatefulThermostatWithSensor`, `StatefulLockWithOpeningStatus`, `StatefulThermostat`, `Thermostat`, `StatefulSwitchable`, `Switchable`, `StatefulLock`, `LockStatus`, `Lock`, `StatefulDimmable`, `Dimmable` **Commands** | Command | Parameters | Notes | |---------|-----------|-------| + | `activateOption` | STRING | Activate an option | + | `deactivateOption` | STRING | Deactivate an option | | `executeManufacturerProcedure` | STRING; OBJECT (optional) | execute manufacturer procedure command. p1: the procedure name p2: the params associated Example: p1 = "dead_man_up" p2 = {"duration": 42} | | `identify` | | Ask the device to identify itself by doing a slight movement or blink or beep | + | `lock` | | Lock the device | + | `off` | | Turn off the device | + | `on` | | Turn on the device | + | `pause` | | Pause current action | | `readManufacturerData` | ARRAY | Read manufacturer data values from given names. Example: ["setting1","setting2"]. | + | `resume` | | Resume paused action. | | `sendPrivate` | OBJECT | send a private command | + | `setIntensity` | INT [0..100] | Light intensity level (100%=maximum intensity, 0%=off) | + | `setMode` | STRING | Set the active mode. | | `setName` | STRING | Change the device internal name. Name length may be subject to restrictions depending on the device and underlying protocol. | + | `setOnOff` | STRING: off, on | Turn the device on or off | + | `setRecipe` | STRING | Select/Activate a given recipe. | + | `setTargetHumidity` | INT [0..100] | Set the target humidity. | + | `setTargetPower` | INT | Set the target power. | + | `setTargetTemperature` | FLOAT | Set the new air temperature to reach | + | `setTargetTime` | INT | Set a target action duration. | + | `setTargetWeight` | INT | Indicate a target element weight. | + | `setTimezone` | STRING | Set the device timezone, according to TZ database names. | + | `start` | | Start the default actuator behavior (movement, sound or timer) | + | `stop` | | Stop the current actuator behavior (movement, sound or timer) | + | `unlock` | | Unlock the device | | `update` | | Update the gateway software. The update may have to be downloaded first, which can take a while. | | `writeManufacturerData` | OBJECT | Write manufacturer data values. Example: { "setting1": true, "setting2": 42, "setting3": "overkiz", "setting4": "Dk8PDr1WD0sfAAAAAAAAAAAAAAAAAAAA", "setting5": [ "valueA", "valueB", "valueC" ], "setting6": { "value": 15, "definition": 158 } } | @@ -13452,17 +13561,32 @@ This page lists all known device types from the Overkiz API, grouped by protocol | State | Type | Range / Values | Notes | |-------|------|----------------|-------| + | `ActivatedOptionsState` | DataState | | | | `ActivePartitionState` | DataState | | | | `AvailabilityState` | DiscreteState | available, unavailable | | + | `AvailableModesState` | DataState | | | + | `AvailableOptionsState` | DataState | | | + | `AvailableRecipesState` | DataState | | | + | `AvailableTargetTemperaturesState` | DataState | | | | `BatteryDiscreteLevelState` | DiscreteState | good, medium, low, critical | | | `BatteryLevelState` | ContinuousState | | | - | `ErrorEventState` | DiscreteState | accessLimitation, internal, obstacleProtection, transportBusy, deviceNoAnswer, cancelled, deprecated, interrupted, thermalProtection, maintenanceRequired, alreadyUpToDate, notSupported, hardwareError, accessDenied, updateError, resourceAlreadyExist | | + | `CurrentCycleStageState` | DataState | | | + | `CurrentSoilingState` | ContinuousState | | | + | `CycleStageSequenceState` | DataState | | | | `ErrorState` | DataState | | | | `ErrorsState` | DataState | | | | `FirmwareHashState` | DataState | | | | `FirmwareRevisionState` | DataState | | | + | `IntensityState` | ContinuousState | | | + | `LightIntensityState` | ContinuousState | [0..100] | | + | `LockedUnlockedState` | DiscreteState | locked, unlocked | | + | `ModeState` | DataState | | | | `NameState` | DataState | | | | `NewFirmwareAvailableState` | DataState | | | + | `OnOffState` | DiscreteState | on, off | | + | `OpenClosedState` | DiscreteState | open, closed | | + | `OpenState` | DataState | | | + | `PausedState` | DataState | | | | `Private10State` | DataState | | | | `Private1State` | DataState | | | | `Private2State` | DataState | | | @@ -13473,36 +13597,4771 @@ This page lists all known device types from the Overkiz API, grouped by protocol | `Private7State` | DataState | | | | `Private8State` | DataState | | | | `Private9State` | DataState | | | + | `RecipeState` | DataState | | | + | `RecommendedOptionsState` | DataState | | | + | `RecommendedTargetHumidityState` | ContinuousState | | | + | `RecommendedTargetPowerState` | ContinuousState | | | + | `RecommendedTargetTemperatureState` | ContinuousState | | | + | `RecommendedTargetTimeState` | ContinuousState | | | + | `RecommendedTargetWeightState` | ContinuousState | | | + | `RemainingTimeState` | ContinuousState | | | | `RemovableState` | DataState | | | + | `RunningTimerState` | DataState | | | | `SignalQualityState` | ContinuousState | | | + | `StartedStoppedState` | DiscreteState | started, stopped | | | `StatusState` | DiscreteState | available, unavailable | | - | `WindDirectionState` | ContinuousState | [0..360] | | - | `WindSpeedState` | ContinuousState | | | + | `TargetHumidityCurrentLowerBoundState` | ContinuousState | | | + | `TargetHumidityCurrentUpperBoundState` | ContinuousState | | | + | `TargetHumidityState` | ContinuousState | | | + | `TargetPowerCurrentLowerBoundState` | ContinuousState | | | + | `TargetPowerCurrentUpperBoundState` | ContinuousState | | | + | `TargetPowerState` | ContinuousState | | | + | `TargetTemperatureCurrentLowerBoundState` | ContinuousState | | | + | `TargetTemperatureCurrentUpperBoundState` | ContinuousState | | | + | `TargetTemperatureReachedState` | DataState | | | + | `TargetTemperatureState` | ContinuousState | [12.0..30.0] | | + | `TargetTimeCurrentLowerBoundState` | ContinuousState | | | + | `TargetTimeCurrentUpperBoundState` | ContinuousState | | | + | `TargetTimeState` | ContinuousState | | | + | `TargetWeightCurrentLowerBoundState` | ContinuousState | | | + | `TargetWeightCurrentUpperBoundState` | ContinuousState | | | + | `TargetWeightState` | ContinuousState | | | + | `TemperatureState` | ContinuousState | [-100.0..100.0] | | + | `TimezoneState` | DataState | | | + | `UnavailableFeaturesState` | DataState | | | -??? note "Window/DynamicWindow (ACTUATOR) — 18 commands, 31 states" +??? note "Pergola/DynamicPergola (ACTUATOR) — 18 commands, 31 states" - **Type IDs:** `267` | **Servers:** `rexel`, `somfy_europe` | **Controllable:** `ogp:Window` | **Profiles:** `StatefulWindowLockWithOpeningStatus`, `StatefulLockWithOpeningStatus`, `StatefulOpenClose`, `OpenClose`, `StatefulCloseable`, `Closeable`, `StatefulLock`, `LockStatus`, `Lock`, `Cyclic` + **Type IDs:** `287` | **Servers:** `rexel` | **Controllable:** `ogp:Pergola` | **Profiles:** `StatefulOrientablePlusCloseablePergola`, `StatefulOrientablePlusCloseable`, `OrientablePlusCloseable`, `StatefulCloseable`, `Closeable`, `StatefulOpenClose`, `OpenClose` **Commands** | Command | Parameters | Notes | |---------|-----------|-------| | `close` | | Fully close the device | - | `cycle` | | Do a cycle of supported motion kinematics or modes | | `executeManufacturerProcedure` | STRING; OBJECT (optional) | execute manufacturer procedure command. p1: the procedure name p2: the params associated Example: p1 = "dead_man_up" p2 = {"duration": 42} | | `goToAlias` | STRING | Send alias command linked with the ID. | | `identify` | | Ask the device to identify itself by doing a slight movement or blink or beep | - | `lock` | | Lock the device | | `open` | | Fully open the device | | `readManufacturerData` | ARRAY | Read manufacturer data values from given names. Example: ["setting1","setting2"]. | + | `right` | | Right the device (go to minimum tilt position - open) | | `saveAlias` | STRING | Allow to send an order for the product to save the current state of the alias. | | `sendPrivate` | OBJECT | send a private command | - | `setAuthentication` | OBJECT | Set authentication properties of a node | | `setClosure` | INT [0..100] | Closure level (100%=fully close, 0%=open) | | `setName` | STRING | Change the device internal name. Name length may be subject to restrictions depending on the device and underlying protocol. | | `setNodeDefinition` | STRING; STRING (optional); STRING (optional) | Fill the node definition (some transitions can be forbidden) p1: type (mandatory) p2: subType (mandatory if definition is set) p3: definition | + | `setOrientation` | INT [0..100] | Set the relative orientation (0-100%) of the device slats | + | `setTilt` | INT [0..100] | set the device tilt percentage | | `stop` | | Stop the current actuator behavior (movement, sound or timer) | - | `unlock` | | Unlock the device | + | `tilt` | | Go to maximum tilt position (closed) | + | `update` | | Update the gateway software. The update may have to be downloaded first, which can take a while. | + | `writeManufacturerData` | OBJECT | Write manufacturer data values. Example: { "setting1": true, "setting2": 42, "setting3": "overkiz", "setting4": "Dk8PDr1WD0sfAAAAAAAAAAAAAAAAAAAA", "setting5": [ "valueA", "valueB", "valueC" ], "setting6": { "value": 15, "definition": 158 } } | + + **States** + + | State | Type | Range / Values | Notes | + |-------|------|----------------|-------| + | `ActivePartitionState` | DataState | | | + | `AvailabilityState` | DiscreteState | available, unavailable | | + | `BatteryDiscreteLevelState` | DiscreteState | good, medium, low, critical | | + | `BatteryLevelState` | ContinuousState | | | + | `ClosureState` | ContinuousState | [0..100] | | + | `ErrorEventState` | DiscreteState | accessLimitation, internal, obstacleProtection, transportBusy, deviceNoAnswer, cancelled, deprecated, interrupted, thermalProtection, maintenanceRequired, alreadyUpToDate, notSupported, hardwareError, accessDenied, updateError, resourceAlreadyExist | | + | `ErrorState` | DataState | | | + | `ErrorsState` | DataState | | | + | `FirmwareHashState` | DataState | | | + | `FirmwareRevisionState` | DataState | | | + | `NameState` | DataState | | | + | `NewFirmwareAvailableState` | DataState | | | + | `OpenClosedState` | DiscreteState | open, closed | | + | `Private10State` | DataState | | | + | `Private1State` | DataState | | | + | `Private2State` | DataState | | | + | `Private3State` | DataState | | | + | `Private4State` | DataState | | | + | `Private5State` | DataState | | | + | `Private6State` | DataState | | | + | `Private7State` | DataState | | | + | `Private8State` | DataState | | | + | `Private9State` | DataState | | | + | `ReachedAliasesState` | DataState | | | + | `RemovableState` | DataState | | | + | `SignalQualityState` | ContinuousState | | | + | `SlateOrientationState` | ContinuousState | [0..100] | | + | `StatusState` | DiscreteState | available, unavailable | | + | `TiltState` | ContinuousState | | | + | `TiltedState` | DiscreteState | true, false | | + | `UnavailableFeaturesState` | DataState | | | + +??? note "Pergola/DynamicPergola (ACTUATOR) — 18 commands, 30 states" + + **Type IDs:** `287` | **Servers:** `somfy_europe` | **Controllable:** `ogp:Pergola` | **Profiles:** `StatefulOrientablePlusCloseablePergola`, `StatefulOrientablePlusCloseable`, `OrientablePlusCloseable`, `StatefulCloseable`, `Closeable`, `StatefulOpenClose`, `OpenClose` + + **Commands** + + | Command | Parameters | Notes | + |---------|-----------|-------| + | `close` | | Fully close the device | + | `executeManufacturerProcedure` | STRING; OBJECT (optional) | execute manufacturer procedure command. p1: the procedure name p2: the params associated Example: p1 = "dead_man_up" p2 = {"duration": 42} | + | `goToAlias` | STRING | Send alias command linked with the ID. | + | `identify` | | Ask the device to identify itself by doing a slight movement or blink or beep | + | `open` | | Fully open the device | + | `readManufacturerData` | ARRAY | Read manufacturer data values from given names. Example: ["setting1","setting2"]. | + | `right` | | Right the device (go to minimum tilt position - open) | + | `saveAlias` | STRING | Allow to send an order for the product to save the current state of the alias. | + | `sendPrivate` | OBJECT | send a private command | + | `setClosure` | INT [0..100] | Closure level (100%=fully close, 0%=open) | + | `setName` | STRING | Change the device internal name. Name length may be subject to restrictions depending on the device and underlying protocol. | + | `setNodeDefinition` | STRING; STRING (optional); STRING (optional) | Fill the node definition (some transitions can be forbidden) p1: type (mandatory) p2: subType (mandatory if definition is set) p3: definition | + | `setOrientation` | INT [0..100] | Set the relative orientation (0-100%) of the device slats | + | `setTilt` | INT [0..100] | set the device tilt percentage | + | `stop` | | Stop the current actuator behavior (movement, sound or timer) | + | `tilt` | | Go to maximum tilt position (closed) | + | `update` | | Update the gateway software. The update may have to be downloaded first, which can take a while. | + | `writeManufacturerData` | OBJECT | Write manufacturer data values. Example: { "setting1": true, "setting2": 42, "setting3": "overkiz", "setting4": "Dk8PDr1WD0sfAAAAAAAAAAAAAAAAAAAA", "setting5": [ "valueA", "valueB", "valueC" ], "setting6": { "value": 15, "definition": 158 } } | + + **States** + + | State | Type | Range / Values | Notes | + |-------|------|----------------|-------| + | `ActivePartitionState` | DataState | | | + | `AvailabilityState` | DiscreteState | available, unavailable | | + | `BatteryDiscreteLevelState` | DiscreteState | good, medium, low, critical | | + | `BatteryLevelState` | ContinuousState | | | + | `ClosureState` | ContinuousState | [0..100] | | + | `ErrorState` | DataState | | | + | `ErrorsState` | DataState | | | + | `FirmwareHashState` | DataState | | | + | `FirmwareRevisionState` | DataState | | | + | `NameState` | DataState | | | + | `NewFirmwareAvailableState` | DataState | | | + | `OpenClosedState` | DiscreteState | open, closed | | + | `Private10State` | DataState | | | + | `Private1State` | DataState | | | + | `Private2State` | DataState | | | + | `Private3State` | DataState | | | + | `Private4State` | DataState | | | + | `Private5State` | DataState | | | + | `Private6State` | DataState | | | + | `Private7State` | DataState | | | + | `Private8State` | DataState | | | + | `Private9State` | DataState | | | + | `ReachedAliasesState` | DataState | | | + | `RemovableState` | DataState | | | + | `SignalQualityState` | ContinuousState | | | + | `SlateOrientationState` | ContinuousState | [0..100] | | + | `StatusState` | DiscreteState | available, unavailable | | + | `TiltState` | ContinuousState | | | + | `TiltedState` | DiscreteState | true, false | | + | `UnavailableFeaturesState` | DataState | | | + +??? note "ProtocolGateway/DynamicBridge (ACTUATOR) — 15 commands, 26 states" + + **Type IDs:** `1` | **Servers:** `rexel` | **Controllable:** `ogp:Bridge` | **Profiles:** `Specific` + + **Commands** + + | Command | Parameters | Notes | + |---------|-----------|-------| + | `associateCandidate` | STRING | Pair given candidate | + | `discover` | | Start a new discovery procedure. | + | `executeManufacturerProcedure` | STRING; OBJECT (optional) | execute manufacturer procedure command. p1: the procedure name p2: the params associated Example: p1 = "dead_man_up" p2 = {"duration": 42} | + | `getCandidates` | | Discover all candidates available for association. | + | `identify` | | Ask the device to identify itself by doing a slight movement or blink or beep | + | `joinSetup` | | Join an existing setup | + | `pair` | STRING; STRING (optional); STRING (optional) | Execute the pairing procedure p1: type (mandatory) p2: subType (mandatory if definition is set) p3: definition | + | `readManufacturerData` | ARRAY | Read manufacturer data values from given names. Example: ["setting1","setting2"]. | + | `reset` | | Bring back into initial condition. | + | `sendPrivate` | OBJECT | send a private command | + | `setAuthentication` | OBJECT | Set authentication properties of a node | + | `setName` | STRING | Change the device internal name. Name length may be subject to restrictions depending on the device and underlying protocol. | + | `shareSetup` | | Share the current setup with another controller | + | `update` | | Update the gateway software. The update may have to be downloaded first, which can take a while. | + | `writeManufacturerData` | OBJECT | Write manufacturer data values. Example: { "setting1": true, "setting2": 42, "setting3": "overkiz", "setting4": "Dk8PDr1WD0sfAAAAAAAAAAAAAAAAAAAA", "setting5": [ "valueA", "valueB", "valueC" ], "setting6": { "value": 15, "definition": 158 } } | + + **States** + + | State | Type | Range / Values | Notes | + |-------|------|----------------|-------| + | `ActivePartitionState` | DataState | | | + | `AuthenticationExpiredState` | DataState | | | + | `AvailabilityState` | DiscreteState | available, unavailable | | + | `BatteryDiscreteLevelState` | DiscreteState | good, medium, low, critical | | + | `BatteryLevelState` | ContinuousState | | | + | `CandidatesState` | DataState | | | + | `ErrorEventState` | DiscreteState | | | + | `ErrorState` | DataState | | | + | `ErrorsState` | DataState | | | + | `FirmwareHashState` | DataState | | | + | `FirmwareRevisionState` | DataState | | | + | `NameState` | DataState | | | + | `NewFirmwareAvailableState` | DataState | | | + | `Private10State` | DataState | | | + | `Private1State` | DataState | | | + | `Private2State` | DataState | | | + | `Private3State` | DataState | | | + | `Private4State` | DataState | | | + | `Private5State` | DataState | | | + | `Private6State` | DataState | | | + | `Private7State` | DataState | | | + | `Private8State` | DataState | | | + | `Private9State` | DataState | | | + | `RemovableState` | DataState | | | + | `SignalQualityState` | ContinuousState | | | + | `StatusState` | DiscreteState | available, unavailable | | + +??? note "ProtocolGateway/DynamicGateway (ACTUATOR) — 10 commands, 35 states" + + **Type IDs:** `2` | **Servers:** `rexel` | **Controllable:** `ogp:Gateway` | **Profiles:** `Specific` + + **Commands** + + | Command | Parameters | Notes | + |---------|-----------|-------| + | `executeManufacturerProcedure` | STRING; OBJECT (optional) | execute manufacturer procedure command. p1: the procedure name p2: the params associated Example: p1 = "dead_man_up" p2 = {"duration": 42} | + | `identify` | | Ask the device to identify itself by doing a slight movement or blink or beep | + | `readManufacturerData` | ARRAY | Read manufacturer data values from given names. Example: ["setting1","setting2"]. | + | `reboot` | | Reboot the device | + | `reset` | | Bring back into initial condition. | + | `sendPrivate` | OBJECT | send a private command | + | `setName` | STRING | Change the device internal name. Name length may be subject to restrictions depending on the device and underlying protocol. | + | `setTimezone` | STRING | Set the device timezone, according to TZ database names. | + | `update` | | Update the gateway software. The update may have to be downloaded first, which can take a while. | + | `writeManufacturerData` | OBJECT | Write manufacturer data values. Example: { "setting1": true, "setting2": 42, "setting3": "overkiz", "setting4": "Dk8PDr1WD0sfAAAAAAAAAAAAAAAAAAAA", "setting5": [ "valueA", "valueB", "valueC" ], "setting6": { "value": 15, "definition": 158 } } | + + **States** + + | State | Type | Range / Values | Notes | + |-------|------|----------------|-------| + | `ActivePartitionState` | DataState | | | + | `ApnState` | DataState | | | + | `AvailabilityState` | DiscreteState | available, unavailable | | + | `BatteryDiscreteLevelState` | DiscreteState | good, medium, low, critical | | + | `BatteryLevelState` | ContinuousState | | | + | `ErrorEventState` | DiscreteState | accessLimitation, internal, obstacleProtection, transportBusy, deviceNoAnswer, cancelled, deprecated, interrupted, thermalProtection, maintenanceRequired, alreadyUpToDate, notSupported, hardwareError, accessDenied, updateError, resourceAlreadyExist | | + | `ErrorState` | DataState | | | + | `ErrorsState` | DataState | | | + | `FirmwareHashState` | DataState | | | + | `FirmwareRevisionState` | DataState | | | + | `IccidState` | DataState | | | + | `ImsiState` | DataState | | | + | `LocalAccessProofState` | DataState | | | + | `LocalIPv4AddressState` | DataState | | | + | `MobileOperatorState` | DataState | | | + | `NameState` | DataState | | | + | `NetworkGatewayState` | DataState | | | + | `NetworkMacState` | DataState | | | + | `NetworkMaskState` | DataState | | | + | `NewFirmwareAvailableState` | DataState | | | + | `Private10State` | DataState | | | + | `Private1State` | DataState | | | + | `Private2State` | DataState | | | + | `Private3State` | DataState | | | + | `Private4State` | DataState | | | + | `Private5State` | DataState | | | + | `Private6State` | DataState | | | + | `Private7State` | DataState | | | + | `Private8State` | DataState | | | + | `Private9State` | DataState | | | + | `RemovableState` | DataState | | | + | `SSIDState` | DataState | | | + | `SignalQualityState` | ContinuousState | | | + | `StatusState` | DiscreteState | available, unavailable | | + | `TimezoneState` | DataState | | | + +??? note "ProtocolGateway/DynamicBridge (ACTUATOR) — 17 commands, 28 states" + + **Type IDs:** `1` | **Servers:** `somfy_europe` | **Controllable:** `ogp:Bridge` | **Profiles:** `Specific` + + **Commands** + + | Command | Parameters | Notes | + |---------|-----------|-------| + | `associateCandidate` | STRING | Pair given candidate | + | `closeCommissioning` | | Close the commissioning window. | + | `discover` | | Start a new discovery procedure. | + | `executeManufacturerProcedure` | STRING; OBJECT (optional) | execute manufacturer procedure command. p1: the procedure name p2: the params associated Example: p1 = "dead_man_up" p2 = {"duration": 42} | + | `getCandidates` | | Discover all candidates available for association. | + | `identify` | | Ask the device to identify itself by doing a slight movement or blink or beep | + | `joinSetup` | | Join an existing setup | + | `openCommissioning` | INT [1..65535] | Open the commissioning window to let the device be discovered by other controllers. Duration in seconds for which the commissioning window will be open. | + | `pair` | STRING; STRING (optional); STRING (optional) | Execute the pairing procedure p1: type (mandatory) p2: subType (mandatory if definition is set) p3: definition | + | `readManufacturerData` | ARRAY | Read manufacturer data values from given names. Example: ["setting1","setting2"]. | + | `reset` | | Bring back into initial condition. | + | `sendPrivate` | OBJECT | send a private command | + | `setAuthentication` | OBJECT | Set authentication properties of a node | + | `setName` | STRING | Change the device internal name. Name length may be subject to restrictions depending on the device and underlying protocol. | + | `shareSetup` | | Share the current setup with another controller | + | `update` | | Update the gateway software. The update may have to be downloaded first, which can take a while. | + | `writeManufacturerData` | OBJECT | Write manufacturer data values. Example: { "setting1": true, "setting2": 42, "setting3": "overkiz", "setting4": "Dk8PDr1WD0sfAAAAAAAAAAAAAAAAAAAA", "setting5": [ "valueA", "valueB", "valueC" ], "setting6": { "value": 15, "definition": 158 } } | + + **States** + + | State | Type | Range / Values | Notes | + |-------|------|----------------|-------| + | `ActivePartitionState` | DataState | | | + | `AuthenticationExpiredState` | DataState | | | + | `AvailabilityState` | DiscreteState | available, unavailable | | + | `BatteryDiscreteLevelState` | DiscreteState | good, medium, low, critical | | + | `BatteryLevelState` | ContinuousState | | | + | `CandidatesState` | DataState | | | + | `CommissioningWindowCloseTimestampState` | DataState | [1..65535] | | + | `CommissioningWindowOpenState` | DataState | | | + | `CredentialsState` | DataState | | | + | `ErrorState` | DataState | | | + | `ErrorsState` | DataState | | | + | `FirmwareHashState` | DataState | | | + | `FirmwareRevisionState` | DataState | | | + | `NameState` | DataState | | | + | `NewFirmwareAvailableState` | DataState | | | + | `Private10State` | DataState | | | + | `Private1State` | DataState | | | + | `Private2State` | DataState | | | + | `Private3State` | DataState | | | + | `Private4State` | DataState | | | + | `Private5State` | DataState | | | + | `Private6State` | DataState | | | + | `Private7State` | DataState | | | + | `Private8State` | DataState | | | + | `Private9State` | DataState | | | + | `RemovableState` | DataState | | | + | `SignalQualityState` | ContinuousState | | | + | `StatusState` | DiscreteState | available, unavailable | | + +??? note "ProtocolGateway/DynamicGateway (ACTUATOR) — 10 commands, 34 states" + + **Type IDs:** `2` | **Servers:** `somfy_europe` | **Controllable:** `ogp:Gateway` | **Profiles:** `Specific` + + **Commands** + + | Command | Parameters | Notes | + |---------|-----------|-------| + | `executeManufacturerProcedure` | STRING; OBJECT (optional) | execute manufacturer procedure command. p1: the procedure name p2: the params associated Example: p1 = "dead_man_up" p2 = {"duration": 42} | + | `identify` | | Ask the device to identify itself by doing a slight movement or blink or beep | + | `readManufacturerData` | ARRAY | Read manufacturer data values from given names. Example: ["setting1","setting2"]. | + | `reboot` | | Reboot the device | + | `reset` | | Bring back into initial condition. | + | `sendPrivate` | OBJECT | send a private command | + | `setName` | STRING | Change the device internal name. Name length may be subject to restrictions depending on the device and underlying protocol. | + | `setTimezone` | STRING | Set the device timezone, according to TZ database names. | + | `update` | | Update the gateway software. The update may have to be downloaded first, which can take a while. | + | `writeManufacturerData` | OBJECT | Write manufacturer data values. Example: { "setting1": true, "setting2": 42, "setting3": "overkiz", "setting4": "Dk8PDr1WD0sfAAAAAAAAAAAAAAAAAAAA", "setting5": [ "valueA", "valueB", "valueC" ], "setting6": { "value": 15, "definition": 158 } } | + + **States** + + | State | Type | Range / Values | Notes | + |-------|------|----------------|-------| + | `ActivePartitionState` | DataState | | | + | `ApnState` | DataState | | | + | `AvailabilityState` | DiscreteState | available, unavailable | | + | `BatteryDiscreteLevelState` | DiscreteState | good, medium, low, critical | | + | `BatteryLevelState` | ContinuousState | | | + | `ErrorState` | DataState | | | + | `ErrorsState` | DataState | | | + | `FirmwareHashState` | DataState | | | + | `FirmwareRevisionState` | DataState | | | + | `IccidState` | DataState | | | + | `ImsiState` | DataState | | | + | `LocalAccessProofState` | DataState | | | + | `LocalIPv4AddressState` | DataState | | | + | `MobileOperatorState` | DataState | | | + | `NameState` | DataState | | | + | `NetworkGatewayState` | DataState | | | + | `NetworkMacState` | DataState | | | + | `NetworkMaskState` | DataState | | | + | `NewFirmwareAvailableState` | DataState | | | + | `Private10State` | DataState | | | + | `Private1State` | DataState | | | + | `Private2State` | DataState | | | + | `Private3State` | DataState | | | + | `Private4State` | DataState | | | + | `Private5State` | DataState | | | + | `Private6State` | DataState | | | + | `Private7State` | DataState | | | + | `Private8State` | DataState | | | + | `Private9State` | DataState | | | + | `RemovableState` | DataState | | | + | `SSIDState` | DataState | | | + | `SignalQualityState` | ContinuousState | | | + | `StatusState` | DiscreteState | available, unavailable | | + | `TimezoneState` | DataState | | | + +??? note "RainSensor/DynamicRainSensor (SENSOR) — 7 commands, 25 states" + + **Type IDs:** `275` | **Servers:** `rexel` | **Controllable:** `ogp:RainSensor` | **Profiles:** `RainDetector` + + **Commands** + + | Command | Parameters | Notes | + |---------|-----------|-------| + | `executeManufacturerProcedure` | STRING; OBJECT (optional) | execute manufacturer procedure command. p1: the procedure name p2: the params associated Example: p1 = "dead_man_up" p2 = {"duration": 42} | + | `identify` | | Ask the device to identify itself by doing a slight movement or blink or beep | + | `readManufacturerData` | ARRAY | Read manufacturer data values from given names. Example: ["setting1","setting2"]. | + | `sendPrivate` | OBJECT | send a private command | + | `setName` | STRING | Change the device internal name. Name length may be subject to restrictions depending on the device and underlying protocol. | + | `update` | | Update the gateway software. The update may have to be downloaded first, which can take a while. | + | `writeManufacturerData` | OBJECT | Write manufacturer data values. Example: { "setting1": true, "setting2": 42, "setting3": "overkiz", "setting4": "Dk8PDr1WD0sfAAAAAAAAAAAAAAAAAAAA", "setting5": [ "valueA", "valueB", "valueC" ], "setting6": { "value": 15, "definition": 158 } } | + + **States** + + | State | Type | Range / Values | Notes | + |-------|------|----------------|-------| + | `ActivePartitionState` | DataState | | | + | `AvailabilityState` | DiscreteState | available, unavailable | | + | `BatteryDiscreteLevelState` | DiscreteState | good, medium, low, critical | | + | `BatteryLevelState` | ContinuousState | | | + | `ErrorEventState` | DiscreteState | accessLimitation, internal, obstacleProtection, transportBusy, deviceNoAnswer, cancelled, deprecated, interrupted, thermalProtection, maintenanceRequired, alreadyUpToDate, notSupported, hardwareError, accessDenied, updateError, resourceAlreadyExist | | + | `ErrorState` | DataState | | | + | `ErrorsState` | DataState | | | + | `FirmwareHashState` | DataState | | | + | `FirmwareRevisionState` | DataState | | | + | `NameState` | DataState | | | + | `NewFirmwareAvailableState` | DataState | | | + | `Private10State` | DataState | | | + | `Private1State` | DataState | | | + | `Private2State` | DataState | | | + | `Private3State` | DataState | | | + | `Private4State` | DataState | | | + | `Private5State` | DataState | | | + | `Private6State` | DataState | | | + | `Private7State` | DataState | | | + | `Private8State` | DataState | | | + | `Private9State` | DataState | | | + | `RainState` | DiscreteState | detected, notDetected | | + | `RemovableState` | DataState | | | + | `SignalQualityState` | ContinuousState | | | + | `StatusState` | DiscreteState | available, unavailable | | + +??? note "RainSensor/DynamicRainSensor (SENSOR) — 7 commands, 24 states" + + **Type IDs:** `275` | **Servers:** `somfy_europe` | **Controllable:** `ogp:RainSensor` | **Profiles:** `RainDetector` + + **Commands** + + | Command | Parameters | Notes | + |---------|-----------|-------| + | `executeManufacturerProcedure` | STRING; OBJECT (optional) | execute manufacturer procedure command. p1: the procedure name p2: the params associated Example: p1 = "dead_man_up" p2 = {"duration": 42} | + | `identify` | | Ask the device to identify itself by doing a slight movement or blink or beep | + | `readManufacturerData` | ARRAY | Read manufacturer data values from given names. Example: ["setting1","setting2"]. | + | `sendPrivate` | OBJECT | send a private command | + | `setName` | STRING | Change the device internal name. Name length may be subject to restrictions depending on the device and underlying protocol. | + | `update` | | Update the gateway software. The update may have to be downloaded first, which can take a while. | + | `writeManufacturerData` | OBJECT | Write manufacturer data values. Example: { "setting1": true, "setting2": 42, "setting3": "overkiz", "setting4": "Dk8PDr1WD0sfAAAAAAAAAAAAAAAAAAAA", "setting5": [ "valueA", "valueB", "valueC" ], "setting6": { "value": 15, "definition": 158 } } | + + **States** + + | State | Type | Range / Values | Notes | + |-------|------|----------------|-------| + | `ActivePartitionState` | DataState | | | + | `AvailabilityState` | DiscreteState | available, unavailable | | + | `BatteryDiscreteLevelState` | DiscreteState | good, medium, low, critical | | + | `BatteryLevelState` | ContinuousState | | | + | `ErrorState` | DataState | | | + | `ErrorsState` | DataState | | | + | `FirmwareHashState` | DataState | | | + | `FirmwareRevisionState` | DataState | | | + | `NameState` | DataState | | | + | `NewFirmwareAvailableState` | DataState | | | + | `Private10State` | DataState | | | + | `Private1State` | DataState | | | + | `Private2State` | DataState | | | + | `Private3State` | DataState | | | + | `Private4State` | DataState | | | + | `Private5State` | DataState | | | + | `Private6State` | DataState | | | + | `Private7State` | DataState | | | + | `Private8State` | DataState | | | + | `Private9State` | DataState | | | + | `RainState` | DiscreteState | detected, notDetected | | + | `RemovableState` | DataState | | | + | `SignalQualityState` | ContinuousState | | | + | `StatusState` | DiscreteState | available, unavailable | | + +??? note "Scene/DynamicScene (ACTUATOR) — 9 commands, 25 states" + + **Type IDs:** `294` | **Servers:** `rexel` | **Controllable:** `ogp:Scene` | **Profiles:** `Specific` + + **Commands** + + | Command | Parameters | Notes | + |---------|-----------|-------| + | `executeManufacturerProcedure` | STRING; OBJECT (optional) | execute manufacturer procedure command. p1: the procedure name p2: the params associated Example: p1 = "dead_man_up" p2 = {"duration": 42} | + | `goToAlias` | STRING | Send alias command linked with the ID. | + | `identify` | | Ask the device to identify itself by doing a slight movement or blink or beep | + | `readManufacturerData` | ARRAY | Read manufacturer data values from given names. Example: ["setting1","setting2"]. | + | `saveAlias` | STRING | Allow to send an order for the product to save the current state of the alias. | + | `sendPrivate` | OBJECT | send a private command | + | `setName` | STRING | Change the device internal name. Name length may be subject to restrictions depending on the device and underlying protocol. | + | `update` | | Update the gateway software. The update may have to be downloaded first, which can take a while. | + | `writeManufacturerData` | OBJECT | Write manufacturer data values. Example: { "setting1": true, "setting2": 42, "setting3": "overkiz", "setting4": "Dk8PDr1WD0sfAAAAAAAAAAAAAAAAAAAA", "setting5": [ "valueA", "valueB", "valueC" ], "setting6": { "value": 15, "definition": 158 } } | + + **States** + + | State | Type | Range / Values | Notes | + |-------|------|----------------|-------| + | `ActivePartitionState` | DataState | | | + | `AvailabilityState` | DiscreteState | available, unavailable | | + | `BatteryDiscreteLevelState` | DiscreteState | good, medium, low, critical | | + | `BatteryLevelState` | ContinuousState | | | + | `ErrorEventState` | DiscreteState | accessLimitation, internal, obstacleProtection, transportBusy, deviceNoAnswer, cancelled, deprecated, interrupted, thermalProtection, maintenanceRequired, alreadyUpToDate, notSupported, hardwareError, accessDenied, updateError, resourceAlreadyExist | | + | `ErrorState` | DataState | | | + | `ErrorsState` | DataState | | | + | `FirmwareHashState` | DataState | | | + | `FirmwareRevisionState` | DataState | | | + | `NameState` | DataState | | | + | `NewFirmwareAvailableState` | DataState | | | + | `Private10State` | DataState | | | + | `Private1State` | DataState | | | + | `Private2State` | DataState | | | + | `Private3State` | DataState | | | + | `Private4State` | DataState | | | + | `Private5State` | DataState | | | + | `Private6State` | DataState | | | + | `Private7State` | DataState | | | + | `Private8State` | DataState | | | + | `Private9State` | DataState | | | + | `ReachedAliasesState` | DataState | | | + | `RemovableState` | DataState | | | + | `SignalQualityState` | ContinuousState | | | + | `StatusState` | DiscreteState | available, unavailable | | + +??? note "Scene/DynamicScene (ACTUATOR) — 9 commands, 24 states" + + **Type IDs:** `294` | **Servers:** `somfy_europe` | **Controllable:** `ogp:Scene` | **Profiles:** `Specific` + + **Commands** + + | Command | Parameters | Notes | + |---------|-----------|-------| + | `executeManufacturerProcedure` | STRING; OBJECT (optional) | execute manufacturer procedure command. p1: the procedure name p2: the params associated Example: p1 = "dead_man_up" p2 = {"duration": 42} | + | `goToAlias` | STRING | Send alias command linked with the ID. | + | `identify` | | Ask the device to identify itself by doing a slight movement or blink or beep | + | `readManufacturerData` | ARRAY | Read manufacturer data values from given names. Example: ["setting1","setting2"]. | + | `saveAlias` | STRING | Allow to send an order for the product to save the current state of the alias. | + | `sendPrivate` | OBJECT | send a private command | + | `setName` | STRING | Change the device internal name. Name length may be subject to restrictions depending on the device and underlying protocol. | + | `update` | | Update the gateway software. The update may have to be downloaded first, which can take a while. | + | `writeManufacturerData` | OBJECT | Write manufacturer data values. Example: { "setting1": true, "setting2": 42, "setting3": "overkiz", "setting4": "Dk8PDr1WD0sfAAAAAAAAAAAAAAAAAAAA", "setting5": [ "valueA", "valueB", "valueC" ], "setting6": { "value": 15, "definition": 158 } } | + + **States** + + | State | Type | Range / Values | Notes | + |-------|------|----------------|-------| + | `ActivePartitionState` | DataState | | | + | `AvailabilityState` | DiscreteState | available, unavailable | | + | `BatteryDiscreteLevelState` | DiscreteState | good, medium, low, critical | | + | `BatteryLevelState` | ContinuousState | | | + | `ErrorState` | DataState | | | + | `ErrorsState` | DataState | | | + | `FirmwareHashState` | DataState | | | + | `FirmwareRevisionState` | DataState | | | + | `NameState` | DataState | | | + | `NewFirmwareAvailableState` | DataState | | | + | `Private10State` | DataState | | | + | `Private1State` | DataState | | | + | `Private2State` | DataState | | | + | `Private3State` | DataState | | | + | `Private4State` | DataState | | | + | `Private5State` | DataState | | | + | `Private6State` | DataState | | | + | `Private7State` | DataState | | | + | `Private8State` | DataState | | | + | `Private9State` | DataState | | | + | `ReachedAliasesState` | DataState | | | + | `RemovableState` | DataState | | | + | `SignalQualityState` | ContinuousState | | | + | `StatusState` | DiscreteState | available, unavailable | | + +??? note "SceneLauncherController/DynamicSceneLauncherController (REMOTE_CONTROLLER) — 7 commands, 25 states" + + **Type IDs:** `292` | **Servers:** `rexel` | **Controllable:** `ogp:SceneLauncherController` | **Profiles:** `ScenarioTrigger` + + **Commands** + + | Command | Parameters | Notes | + |---------|-----------|-------| + | `executeManufacturerProcedure` | STRING; OBJECT (optional) | execute manufacturer procedure command. p1: the procedure name p2: the params associated Example: p1 = "dead_man_up" p2 = {"duration": 42} | + | `identify` | | Ask the device to identify itself by doing a slight movement or blink or beep | + | `readManufacturerData` | ARRAY | Read manufacturer data values from given names. Example: ["setting1","setting2"]. | + | `sendPrivate` | OBJECT | send a private command | + | `setName` | STRING | Change the device internal name. Name length may be subject to restrictions depending on the device and underlying protocol. | + | `update` | | Update the gateway software. The update may have to be downloaded first, which can take a while. | + | `writeManufacturerData` | OBJECT | Write manufacturer data values. Example: { "setting1": true, "setting2": 42, "setting3": "overkiz", "setting4": "Dk8PDr1WD0sfAAAAAAAAAAAAAAAAAAAA", "setting5": [ "valueA", "valueB", "valueC" ], "setting6": { "value": 15, "definition": 158 } } | + + **States** + + | State | Type | Range / Values | Notes | + |-------|------|----------------|-------| + | `ActivePartitionState` | DataState | | | + | `AvailabilityState` | DiscreteState | available, unavailable | | + | `BatteryDiscreteLevelState` | DiscreteState | good, medium, low, critical | | + | `BatteryLevelState` | ContinuousState | | | + | `ErrorEventState` | DiscreteState | | | + | `ErrorState` | DataState | | | + | `ErrorsState` | DataState | | | + | `FirmwareHashState` | DataState | | | + | `FirmwareRevisionState` | DataState | | | + | `LaunchStatusState` | DiscreteState | launched, standby | | + | `NameState` | DataState | | | + | `NewFirmwareAvailableState` | DataState | | | + | `Private10State` | DataState | | | + | `Private1State` | DataState | | | + | `Private2State` | DataState | | | + | `Private3State` | DataState | | | + | `Private4State` | DataState | | | + | `Private5State` | DataState | | | + | `Private6State` | DataState | | | + | `Private7State` | DataState | | | + | `Private8State` | DataState | | | + | `Private9State` | DataState | | | + | `RemovableState` | DataState | | | + | `SignalQualityState` | ContinuousState | | | + | `StatusState` | DiscreteState | available, unavailable | | + +??? note "SceneLauncherController/DynamicSceneLauncherController (REMOTE_CONTROLLER) — 7 commands, 27 states" + + **Type IDs:** `292` | **Servers:** `somfy_europe` | **Controllable:** `ogp:SceneLauncherController` | **Profiles:** `Switch`, `SwitchEvent`, `ScenarioTrigger` + + **Commands** + + | Command | Parameters | Notes | + |---------|-----------|-------| + | `executeManufacturerProcedure` | STRING; OBJECT (optional) | execute manufacturer procedure command. p1: the procedure name p2: the params associated Example: p1 = "dead_man_up" p2 = {"duration": 42} | + | `identify` | | Ask the device to identify itself by doing a slight movement or blink or beep | + | `readManufacturerData` | ARRAY | Read manufacturer data values from given names. Example: ["setting1","setting2"]. | + | `sendPrivate` | OBJECT | send a private command | + | `setName` | STRING | Change the device internal name. Name length may be subject to restrictions depending on the device and underlying protocol. | + | `update` | | Update the gateway software. The update may have to be downloaded first, which can take a while. | + | `writeManufacturerData` | OBJECT | Write manufacturer data values. Example: { "setting1": true, "setting2": 42, "setting3": "overkiz", "setting4": "Dk8PDr1WD0sfAAAAAAAAAAAAAAAAAAAA", "setting5": [ "valueA", "valueB", "valueC" ], "setting6": { "value": 15, "definition": 158 } } | + + **States** + + | State | Type | Range / Values | Notes | + |-------|------|----------------|-------| + | `ActionEventState` | DataState | | | + | `ActionState` | DataState | | | + | `ActivePartitionState` | DataState | | | + | `AvailabilityState` | DiscreteState | available, unavailable | | + | `AvailableActionsState` | DataState | | | + | `BatteryDiscreteLevelState` | DiscreteState | good, medium, low, critical | | + | `BatteryLevelState` | ContinuousState | | | + | `ErrorState` | DataState | | | + | `ErrorsState` | DataState | | | + | `FirmwareHashState` | DataState | | | + | `FirmwareRevisionState` | DataState | | | + | `LaunchStatusState` | DiscreteState | launched, standby | | + | `NameState` | DataState | | | + | `NewFirmwareAvailableState` | DataState | | | + | `Private10State` | DataState | | | + | `Private1State` | DataState | | | + | `Private2State` | DataState | | | + | `Private3State` | DataState | | | + | `Private4State` | DataState | | | + | `Private5State` | DataState | | | + | `Private6State` | DataState | | | + | `Private7State` | DataState | | | + | `Private8State` | DataState | | | + | `Private9State` | DataState | | | + | `RemovableState` | DataState | | | + | `SignalQualityState` | ContinuousState | | | + | `StatusState` | DiscreteState | available, unavailable | | + +??? note "Screen/DynamicScreen (ACTUATOR) — 14 commands, 28 states" + + **Type IDs:** `263` | **Servers:** `rexel` | **Controllable:** `ogp:Blind` | **Profiles:** `StatefulCloseableBlind`, `StatefulCloseable`, `Closeable`, `StatefulOpenClose`, `OpenClose` + + **Commands** + + | Command | Parameters | Notes | + |---------|-----------|-------| + | `close` | | Fully close the device | + | `executeManufacturerProcedure` | STRING; OBJECT (optional) | execute manufacturer procedure command. p1: the procedure name p2: the params associated Example: p1 = "dead_man_up" p2 = {"duration": 42} | + | `goToAlias` | STRING | Send alias command linked with the ID. | + | `identify` | | Ask the device to identify itself by doing a slight movement or blink or beep | + | `open` | | Fully open the device | + | `readManufacturerData` | ARRAY | Read manufacturer data values from given names. Example: ["setting1","setting2"]. | + | `saveAlias` | STRING | Allow to send an order for the product to save the current state of the alias. | + | `sendPrivate` | OBJECT | send a private command | + | `setClosure` | INT [0..100] | Closure level (100%=fully close, 0%=open) | + | `setName` | STRING | Change the device internal name. Name length may be subject to restrictions depending on the device and underlying protocol. | + | `setNodeDefinition` | STRING; STRING (optional); STRING (optional) | Fill the node definition (some transitions can be forbidden) p1: type (mandatory) p2: subType (mandatory if definition is set) p3: definition | + | `stop` | | Stop the current actuator behavior (movement, sound or timer) | + | `update` | | Update the gateway software. The update may have to be downloaded first, which can take a while. | + | `writeManufacturerData` | OBJECT | Write manufacturer data values. Example: { "setting1": true, "setting2": 42, "setting3": "overkiz", "setting4": "Dk8PDr1WD0sfAAAAAAAAAAAAAAAAAAAA", "setting5": [ "valueA", "valueB", "valueC" ], "setting6": { "value": 15, "definition": 158 } } | + + **States** + + | State | Type | Range / Values | Notes | + |-------|------|----------------|-------| + | `ActivePartitionState` | DataState | | | + | `AvailabilityState` | DiscreteState | available, unavailable | | + | `BatteryDiscreteLevelState` | DiscreteState | good, medium, low, critical | | + | `BatteryLevelState` | ContinuousState | | | + | `ClosureState` | ContinuousState | [0..100] | | + | `ErrorEventState` | DiscreteState | accessLimitation, internal, obstacleProtection, transportBusy, deviceNoAnswer, cancelled, deprecated, interrupted, thermalProtection, maintenanceRequired, alreadyUpToDate, notSupported, hardwareError, accessDenied, updateError, resourceAlreadyExist | | + | `ErrorState` | DataState | | | + | `ErrorsState` | DataState | | | + | `FirmwareHashState` | DataState | | | + | `FirmwareRevisionState` | DataState | | | + | `NameState` | DataState | | | + | `NewFirmwareAvailableState` | DataState | | | + | `OpenClosedState` | DiscreteState | open, closed | | + | `Private10State` | DataState | | | + | `Private1State` | DataState | | | + | `Private2State` | DataState | | | + | `Private3State` | DataState | | | + | `Private4State` | DataState | | | + | `Private5State` | DataState | | | + | `Private6State` | DataState | | | + | `Private7State` | DataState | | | + | `Private8State` | DataState | | | + | `Private9State` | DataState | | | + | `ReachedAliasesState` | DataState | | | + | `RemovableState` | DataState | | | + | `SignalQualityState` | ContinuousState | | | + | `StatusState` | DiscreteState | available, unavailable | | + | `UnavailableFeaturesState` | DataState | | | + +??? note "Screen/DynamicScreen (ACTUATOR) — 14 commands, 27 states" + + **Type IDs:** `263` | **Servers:** `somfy_europe` | **Controllable:** `ogp:Blind` | **Profiles:** `StatefulCloseableBlind`, `StatefulCloseable`, `Closeable`, `StatefulOpenClose`, `OpenClose` + + **Commands** + + | Command | Parameters | Notes | + |---------|-----------|-------| + | `close` | | Fully close the device | + | `executeManufacturerProcedure` | STRING; OBJECT (optional) | execute manufacturer procedure command. p1: the procedure name p2: the params associated Example: p1 = "dead_man_up" p2 = {"duration": 42} | + | `goToAlias` | STRING | Send alias command linked with the ID. | + | `identify` | | Ask the device to identify itself by doing a slight movement or blink or beep | + | `open` | | Fully open the device | + | `readManufacturerData` | ARRAY | Read manufacturer data values from given names. Example: ["setting1","setting2"]. | + | `saveAlias` | STRING | Allow to send an order for the product to save the current state of the alias. | + | `sendPrivate` | OBJECT | send a private command | + | `setClosure` | INT [0..100] | Closure level (100%=fully close, 0%=open) | + | `setName` | STRING | Change the device internal name. Name length may be subject to restrictions depending on the device and underlying protocol. | + | `setNodeDefinition` | STRING; STRING (optional); STRING (optional) | Fill the node definition (some transitions can be forbidden) p1: type (mandatory) p2: subType (mandatory if definition is set) p3: definition | + | `stop` | | Stop the current actuator behavior (movement, sound or timer) | + | `update` | | Update the gateway software. The update may have to be downloaded first, which can take a while. | + | `writeManufacturerData` | OBJECT | Write manufacturer data values. Example: { "setting1": true, "setting2": 42, "setting3": "overkiz", "setting4": "Dk8PDr1WD0sfAAAAAAAAAAAAAAAAAAAA", "setting5": [ "valueA", "valueB", "valueC" ], "setting6": { "value": 15, "definition": 158 } } | + + **States** + + | State | Type | Range / Values | Notes | + |-------|------|----------------|-------| + | `ActivePartitionState` | DataState | | | + | `AvailabilityState` | DiscreteState | available, unavailable | | + | `BatteryDiscreteLevelState` | DiscreteState | good, medium, low, critical | | + | `BatteryLevelState` | ContinuousState | | | + | `ClosureState` | ContinuousState | [0..100] | | + | `ErrorState` | DataState | | | + | `ErrorsState` | DataState | | | + | `FirmwareHashState` | DataState | | | + | `FirmwareRevisionState` | DataState | | | + | `NameState` | DataState | | | + | `NewFirmwareAvailableState` | DataState | | | + | `OpenClosedState` | DiscreteState | open, closed | | + | `Private10State` | DataState | | | + | `Private1State` | DataState | | | + | `Private2State` | DataState | | | + | `Private3State` | DataState | | | + | `Private4State` | DataState | | | + | `Private5State` | DataState | | | + | `Private6State` | DataState | | | + | `Private7State` | DataState | | | + | `Private8State` | DataState | | | + | `Private9State` | DataState | | | + | `ReachedAliasesState` | DataState | | | + | `RemovableState` | DataState | | | + | `SignalQualityState` | ContinuousState | | | + | `StatusState` | DiscreteState | available, unavailable | | + | `UnavailableFeaturesState` | DataState | | | + +??? note "Shutter/DynamicShutter (ACTUATOR) — 17 commands, 35 states" + + **Type IDs:** `262` | **Servers:** `rexel` | **Controllable:** `ogp:Shutter` | **Profiles:** `StatefulCloseableShutter`, `StatefulCloseable`, `Closeable`, `StatefulOpenClose`, `OpenClose`, `Cyclic` + + **Commands** + + | Command | Parameters | Notes | + |---------|-----------|-------| + | `activateOption` | STRING | Activate an option | + | `close` | | Fully close the device | + | `cycle` | | Do a cycle of supported motion kinematics or modes | + | `deactivateOption` | STRING | Deactivate an option | + | `executeManufacturerProcedure` | STRING; OBJECT (optional) | execute manufacturer procedure command. p1: the procedure name p2: the params associated Example: p1 = "dead_man_up" p2 = {"duration": 42} | + | `goToAlias` | STRING | Send alias command linked with the ID. | + | `identify` | | Ask the device to identify itself by doing a slight movement or blink or beep | + | `open` | | Fully open the device | + | `readManufacturerData` | ARRAY | Read manufacturer data values from given names. Example: ["setting1","setting2"]. | + | `saveAlias` | STRING | Allow to send an order for the product to save the current state of the alias. | + | `sendPrivate` | OBJECT | send a private command | + | `setClosure` | INT [0..100] | Closure level (100%=fully close, 0%=open) | + | `setName` | STRING | Change the device internal name. Name length may be subject to restrictions depending on the device and underlying protocol. | + | `setNodeDefinition` | STRING; STRING (optional); STRING (optional) | Fill the node definition (some transitions can be forbidden) p1: type (mandatory) p2: subType (mandatory if definition is set) p3: definition | + | `stop` | | Stop the current actuator behavior (movement, sound or timer) | + | `update` | | Update the gateway software. The update may have to be downloaded first, which can take a while. | + | `writeManufacturerData` | OBJECT | Write manufacturer data values. Example: { "setting1": true, "setting2": 42, "setting3": "overkiz", "setting4": "Dk8PDr1WD0sfAAAAAAAAAAAAAAAAAAAA", "setting5": [ "valueA", "valueB", "valueC" ], "setting6": { "value": 15, "definition": 158 } } | + + **States** + + | State | Type | Range / Values | Notes | + |-------|------|----------------|-------| + | `AccessLimitationState` | DataState | | | + | `ActivatedOptionsState` | DataState | | | + | `ActivePartitionState` | DataState | | | + | `AvailabilityState` | DiscreteState | available, unavailable | | + | `AvailableOptionsState` | DataState | | | + | `BatteryDiscreteLevelState` | DiscreteState | good, medium, low, critical | | + | `BatteryLevelState` | ContinuousState | | | + | `ClosureState` | ContinuousState | [0..100] | | + | `ErrorEventState` | DiscreteState | accessLimitation, internal, obstacleProtection, transportBusy, deviceNoAnswer, cancelled, deprecated, interrupted, thermalProtection, maintenanceRequired, alreadyUpToDate, notSupported, hardwareError, accessDenied, updateError, resourceAlreadyExist | | + | `ErrorState` | DataState | | | + | `ErrorsState` | DataState | | | + | `FirmwareHashState` | DataState | | | + | `FirmwareRevisionState` | DataState | | | + | `LimitationSourcesState` | DataState | | | + | `LimitationTimeState` | DataState | | | + | `NameState` | DataState | | | + | `NewFirmwareAvailableState` | DataState | | | + | `OpenClosedState` | DiscreteState | open, closed | | + | `PermissiveLimitationState` | DataState | | | + | `Private10State` | DataState | | | + | `Private1State` | DataState | | | + | `Private2State` | DataState | | | + | `Private3State` | DataState | | | + | `Private4State` | DataState | | | + | `Private5State` | DataState | | | + | `Private6State` | DataState | | | + | `Private7State` | DataState | | | + | `Private8State` | DataState | | | + | `Private9State` | DataState | | | + | `ReachedAliasesState` | DataState | | | + | `RecommendedOptionsState` | DataState | | | + | `RemovableState` | DataState | | | + | `SignalQualityState` | ContinuousState | | | + | `StatusState` | DiscreteState | available, unavailable | | + | `UnavailableFeaturesState` | DataState | | | + +??? note "Shutter/DynamicShutter (ACTUATOR) — 17 commands, 34 states" + + **Type IDs:** `262` | **Servers:** `somfy_europe` | **Controllable:** `ogp:Shutter` | **Profiles:** `StatefulCloseableShutter`, `StatefulCloseable`, `Closeable`, `StatefulOpenClose`, `OpenClose`, `Cyclic` + + **Commands** + + | Command | Parameters | Notes | + |---------|-----------|-------| + | `activateOption` | STRING | Activate an option | + | `close` | | Fully close the device | + | `cycle` | | Do a cycle of supported motion kinematics or modes | + | `deactivateOption` | STRING | Deactivate an option | + | `executeManufacturerProcedure` | STRING; OBJECT (optional) | execute manufacturer procedure command. p1: the procedure name p2: the params associated Example: p1 = "dead_man_up" p2 = {"duration": 42} | + | `goToAlias` | STRING | Send alias command linked with the ID. | + | `identify` | | Ask the device to identify itself by doing a slight movement or blink or beep | + | `open` | | Fully open the device | + | `readManufacturerData` | ARRAY | Read manufacturer data values from given names. Example: ["setting1","setting2"]. | + | `saveAlias` | STRING | Allow to send an order for the product to save the current state of the alias. | + | `sendPrivate` | OBJECT | send a private command | + | `setClosure` | INT [0..100] | Closure level (100%=fully close, 0%=open) | + | `setName` | STRING | Change the device internal name. Name length may be subject to restrictions depending on the device and underlying protocol. | + | `setNodeDefinition` | STRING; STRING (optional); STRING (optional) | Fill the node definition (some transitions can be forbidden) p1: type (mandatory) p2: subType (mandatory if definition is set) p3: definition | + | `stop` | | Stop the current actuator behavior (movement, sound or timer) | + | `update` | | Update the gateway software. The update may have to be downloaded first, which can take a while. | + | `writeManufacturerData` | OBJECT | Write manufacturer data values. Example: { "setting1": true, "setting2": 42, "setting3": "overkiz", "setting4": "Dk8PDr1WD0sfAAAAAAAAAAAAAAAAAAAA", "setting5": [ "valueA", "valueB", "valueC" ], "setting6": { "value": 15, "definition": 158 } } | + + **States** + + | State | Type | Range / Values | Notes | + |-------|------|----------------|-------| + | `AccessLimitationState` | DataState | | | + | `ActivatedOptionsState` | DataState | | | + | `ActivePartitionState` | DataState | | | + | `AvailabilityState` | DiscreteState | available, unavailable | | + | `AvailableOptionsState` | DataState | | | + | `BatteryDiscreteLevelState` | DiscreteState | good, medium, low, critical | | + | `BatteryLevelState` | ContinuousState | | | + | `ClosureState` | ContinuousState | [0..100] | | + | `ErrorState` | DataState | | | + | `ErrorsState` | DataState | | | + | `FirmwareHashState` | DataState | | | + | `FirmwareRevisionState` | DataState | | | + | `LimitationSourcesState` | DataState | | | + | `LimitationTimeState` | DataState | | | + | `NameState` | DataState | | | + | `NewFirmwareAvailableState` | DataState | | | + | `OpenClosedState` | DiscreteState | open, closed | | + | `PermissiveLimitationState` | DataState | | | + | `Private10State` | DataState | | | + | `Private1State` | DataState | | | + | `Private2State` | DataState | | | + | `Private3State` | DataState | | | + | `Private4State` | DataState | | | + | `Private5State` | DataState | | | + | `Private6State` | DataState | | | + | `Private7State` | DataState | | | + | `Private8State` | DataState | | | + | `Private9State` | DataState | | | + | `ReachedAliasesState` | DataState | | | + | `RecommendedOptionsState` | DataState | | | + | `RemovableState` | DataState | | | + | `SignalQualityState` | ContinuousState | | | + | `StatusState` | DiscreteState | available, unavailable | | + | `UnavailableFeaturesState` | DataState | | | + +??? note "SmokeSensor/DynamicSmokeSensor (SENSOR) — 7 commands, 25 states" + + **Type IDs:** `307` | **Servers:** `somfy_europe` | **Controllable:** `ogp:SmokeSensor` | **Profiles:** `SmokeDetector` + + **Commands** + + | Command | Parameters | Notes | + |---------|-----------|-------| + | `executeManufacturerProcedure` | STRING; OBJECT (optional) | execute manufacturer procedure command. p1: the procedure name p2: the params associated Example: p1 = "dead_man_up" p2 = {"duration": 42} | + | `identify` | | Ask the device to identify itself by doing a slight movement or blink or beep | + | `readManufacturerData` | ARRAY | Read manufacturer data values from given names. Example: ["setting1","setting2"]. | + | `sendPrivate` | OBJECT | send a private command | + | `setName` | STRING | Change the device internal name. Name length may be subject to restrictions depending on the device and underlying protocol. | + | `update` | | Update the gateway software. The update may have to be downloaded first, which can take a while. | + | `writeManufacturerData` | OBJECT | Write manufacturer data values. Example: { "setting1": true, "setting2": 42, "setting3": "overkiz", "setting4": "Dk8PDr1WD0sfAAAAAAAAAAAAAAAAAAAA", "setting5": [ "valueA", "valueB", "valueC" ], "setting6": { "value": 15, "definition": 158 } } | + + **States** + + | State | Type | Range / Values | Notes | + |-------|------|----------------|-------| + | `ActivePartitionState` | DataState | | | + | `AvailabilityState` | DiscreteState | available, unavailable | | + | `BatteryDiscreteLevelState` | DiscreteState | good, medium, low, critical | | + | `BatteryLevelState` | ContinuousState | | | + | `ErrorState` | DataState | | | + | `ErrorsState` | DataState | | | + | `FirmwareHashState` | DataState | | | + | `FirmwareRevisionState` | DataState | | | + | `NameState` | DataState | | | + | `NewFirmwareAvailableState` | DataState | | | + | `Private10State` | DataState | | | + | `Private1State` | DataState | | | + | `Private2State` | DataState | | | + | `Private3State` | DataState | | | + | `Private4State` | DataState | | | + | `Private5State` | DataState | | | + | `Private6State` | DataState | | | + | `Private7State` | DataState | | | + | `Private8State` | DataState | | | + | `Private9State` | DataState | | | + | `RemovableState` | DataState | | | + | `SignalQualityState` | ContinuousState | | | + | `SmokeEventState` | DiscreteState | false, true | | + | `SmokeState` | DiscreteState | detected, notDetected | | + | `StatusState` | DiscreteState | available, unavailable | | + +??? note "Switch/DynamicSwitch (ACTUATOR) — 8 commands, 27 states" + + **Type IDs:** `297` | **Servers:** `rexel` | **Controllable:** `ogp:Switch` | **Profiles:** `SwitchEvent`, `Switch` + + **Commands** + + | Command | Parameters | Notes | + |---------|-----------|-------| + | `executeManufacturerProcedure` | STRING; OBJECT (optional) | execute manufacturer procedure command. p1: the procedure name p2: the params associated Example: p1 = "dead_man_up" p2 = {"duration": 42} | + | `identify` | | Ask the device to identify itself by doing a slight movement or blink or beep | + | `readManufacturerData` | ARRAY | Read manufacturer data values from given names. Example: ["setting1","setting2"]. | + | `sendPrivate` | OBJECT | send a private command | + | `setName` | STRING | Change the device internal name. Name length may be subject to restrictions depending on the device and underlying protocol. | + | `setNodeDefinition` | STRING; STRING (optional); STRING (optional) | Fill the node definition (some transitions can be forbidden) p1: type (mandatory) p2: subType (mandatory if definition is set) p3: definition | + | `update` | | Update the gateway software. The update may have to be downloaded first, which can take a while. | + | `writeManufacturerData` | OBJECT | Write manufacturer data values. Example: { "setting1": true, "setting2": 42, "setting3": "overkiz", "setting4": "Dk8PDr1WD0sfAAAAAAAAAAAAAAAAAAAA", "setting5": [ "valueA", "valueB", "valueC" ], "setting6": { "value": 15, "definition": 158 } } | + + **States** + + | State | Type | Range / Values | Notes | + |-------|------|----------------|-------| + | `ActionState` | DataState | | | + | `ActivePartitionState` | DataState | | | + | `AvailabilityState` | DiscreteState | available, unavailable | | + | `AvailableActionsState` | DataState | | | + | `BatteryDiscreteLevelState` | DiscreteState | good, medium, low, critical | | + | `BatteryLevelState` | ContinuousState | | | + | `ButtonActionsEventState` | DataState | | | + | `ErrorEventState` | DiscreteState | accessLimitation, internal, obstacleProtection, transportBusy, deviceNoAnswer, cancelled, deprecated, interrupted, thermalProtection, maintenanceRequired, alreadyUpToDate, notSupported, hardwareError, accessDenied, updateError, resourceAlreadyExist | | + | `ErrorState` | DataState | | | + | `ErrorsState` | DataState | | | + | `FirmwareHashState` | DataState | | | + | `FirmwareRevisionState` | DataState | | | + | `NameState` | DataState | | | + | `NewFirmwareAvailableState` | DataState | | | + | `Private10State` | DataState | | | + | `Private1State` | DataState | | | + | `Private2State` | DataState | | | + | `Private3State` | DataState | | | + | `Private4State` | DataState | | | + | `Private5State` | DataState | | | + | `Private6State` | DataState | | | + | `Private7State` | DataState | | | + | `Private8State` | DataState | | | + | `Private9State` | DataState | | | + | `RemovableState` | DataState | | | + | `SignalQualityState` | ContinuousState | | | + | `StatusState` | DiscreteState | available, unavailable | | + +??? note "Switch/DynamicSwitch (ACTUATOR) — 8 commands, 26 states" + + **Type IDs:** `297` | **Servers:** `somfy_europe` | **Controllable:** `ogp:Switch` | **Profiles:** `SwitchEvent`, `Switch` + + **Commands** + + | Command | Parameters | Notes | + |---------|-----------|-------| + | `executeManufacturerProcedure` | STRING; OBJECT (optional) | execute manufacturer procedure command. p1: the procedure name p2: the params associated Example: p1 = "dead_man_up" p2 = {"duration": 42} | + | `identify` | | Ask the device to identify itself by doing a slight movement or blink or beep | + | `readManufacturerData` | ARRAY | Read manufacturer data values from given names. Example: ["setting1","setting2"]. | + | `sendPrivate` | OBJECT | send a private command | + | `setName` | STRING | Change the device internal name. Name length may be subject to restrictions depending on the device and underlying protocol. | + | `setNodeDefinition` | STRING; STRING (optional); STRING (optional) | Fill the node definition (some transitions can be forbidden) p1: type (mandatory) p2: subType (mandatory if definition is set) p3: definition | + | `update` | | Update the gateway software. The update may have to be downloaded first, which can take a while. | + | `writeManufacturerData` | OBJECT | Write manufacturer data values. Example: { "setting1": true, "setting2": 42, "setting3": "overkiz", "setting4": "Dk8PDr1WD0sfAAAAAAAAAAAAAAAAAAAA", "setting5": [ "valueA", "valueB", "valueC" ], "setting6": { "value": 15, "definition": 158 } } | + + **States** + + | State | Type | Range / Values | Notes | + |-------|------|----------------|-------| + | `ActionEventState` | DataState | | | + | `ActionState` | DataState | | | + | `ActivePartitionState` | DataState | | | + | `AvailabilityState` | DiscreteState | available, unavailable | | + | `AvailableActionsState` | DataState | | | + | `BatteryDiscreteLevelState` | DiscreteState | good, medium, low, critical | | + | `BatteryLevelState` | ContinuousState | | | + | `ErrorState` | DataState | | | + | `ErrorsState` | DataState | | | + | `FirmwareHashState` | DataState | | | + | `FirmwareRevisionState` | DataState | | | + | `NameState` | DataState | | | + | `NewFirmwareAvailableState` | DataState | | | + | `Private10State` | DataState | | | + | `Private1State` | DataState | | | + | `Private2State` | DataState | | | + | `Private3State` | DataState | | | + | `Private4State` | DataState | | | + | `Private5State` | DataState | | | + | `Private6State` | DataState | | | + | `Private7State` | DataState | | | + | `Private8State` | DataState | | | + | `Private9State` | DataState | | | + | `RemovableState` | DataState | | | + | `SignalQualityState` | ContinuousState | | | + | `StatusState` | DiscreteState | available, unavailable | | + +??? note "TemperatureSensor/DynamicTemperatureSensor (SENSOR) — 7 commands, 25 states" + + **Type IDs:** `270` | **Servers:** `rexel` | **Controllable:** `ogp:TemperatureSensor` | **Profiles:** `Temperature` + + **Commands** + + | Command | Parameters | Notes | + |---------|-----------|-------| + | `executeManufacturerProcedure` | STRING; OBJECT (optional) | execute manufacturer procedure command. p1: the procedure name p2: the params associated Example: p1 = "dead_man_up" p2 = {"duration": 42} | + | `identify` | | Ask the device to identify itself by doing a slight movement or blink or beep | + | `readManufacturerData` | ARRAY | Read manufacturer data values from given names. Example: ["setting1","setting2"]. | + | `sendPrivate` | OBJECT | send a private command | + | `setName` | STRING | Change the device internal name. Name length may be subject to restrictions depending on the device and underlying protocol. | + | `update` | | Update the gateway software. The update may have to be downloaded first, which can take a while. | + | `writeManufacturerData` | OBJECT | Write manufacturer data values. Example: { "setting1": true, "setting2": 42, "setting3": "overkiz", "setting4": "Dk8PDr1WD0sfAAAAAAAAAAAAAAAAAAAA", "setting5": [ "valueA", "valueB", "valueC" ], "setting6": { "value": 15, "definition": 158 } } | + + **States** + + | State | Type | Range / Values | Notes | + |-------|------|----------------|-------| + | `ActivePartitionState` | DataState | | | + | `AvailabilityState` | DiscreteState | available, unavailable | | + | `BatteryDiscreteLevelState` | DiscreteState | good, medium, low, critical | | + | `BatteryLevelState` | ContinuousState | | | + | `ErrorEventState` | DiscreteState | accessLimitation, internal, obstacleProtection, transportBusy, deviceNoAnswer, cancelled, deprecated, interrupted, thermalProtection, maintenanceRequired, alreadyUpToDate, notSupported, hardwareError, accessDenied, updateError, resourceAlreadyExist | | + | `ErrorState` | DataState | | | + | `ErrorsState` | DataState | | | + | `FirmwareHashState` | DataState | | | + | `FirmwareRevisionState` | DataState | | | + | `NameState` | DataState | | | + | `NewFirmwareAvailableState` | DataState | | | + | `Private10State` | DataState | | | + | `Private1State` | DataState | | | + | `Private2State` | DataState | | | + | `Private3State` | DataState | | | + | `Private4State` | DataState | | | + | `Private5State` | DataState | | | + | `Private6State` | DataState | | | + | `Private7State` | DataState | | | + | `Private8State` | DataState | | | + | `Private9State` | DataState | | | + | `RemovableState` | DataState | | | + | `SignalQualityState` | ContinuousState | | | + | `StatusState` | DiscreteState | available, unavailable | | + | `TemperatureState` | ContinuousState | [-100.0..100.0] | | + +??? note "TemperatureSensor/DynamicTemperatureSensor (SENSOR) — 7 commands, 24 states" + + **Type IDs:** `270` | **Servers:** `somfy_europe` | **Controllable:** `ogp:TemperatureSensor` | **Profiles:** `Temperature` + + **Commands** + + | Command | Parameters | Notes | + |---------|-----------|-------| + | `executeManufacturerProcedure` | STRING; OBJECT (optional) | execute manufacturer procedure command. p1: the procedure name p2: the params associated Example: p1 = "dead_man_up" p2 = {"duration": 42} | + | `identify` | | Ask the device to identify itself by doing a slight movement or blink or beep | + | `readManufacturerData` | ARRAY | Read manufacturer data values from given names. Example: ["setting1","setting2"]. | + | `sendPrivate` | OBJECT | send a private command | + | `setName` | STRING | Change the device internal name. Name length may be subject to restrictions depending on the device and underlying protocol. | + | `update` | | Update the gateway software. The update may have to be downloaded first, which can take a while. | + | `writeManufacturerData` | OBJECT | Write manufacturer data values. Example: { "setting1": true, "setting2": 42, "setting3": "overkiz", "setting4": "Dk8PDr1WD0sfAAAAAAAAAAAAAAAAAAAA", "setting5": [ "valueA", "valueB", "valueC" ], "setting6": { "value": 15, "definition": 158 } } | + + **States** + + | State | Type | Range / Values | Notes | + |-------|------|----------------|-------| + | `ActivePartitionState` | DataState | | | + | `AvailabilityState` | DiscreteState | available, unavailable | | + | `BatteryDiscreteLevelState` | DiscreteState | good, medium, low, critical | | + | `BatteryLevelState` | ContinuousState | | | + | `ErrorState` | DataState | | | + | `ErrorsState` | DataState | | | + | `FirmwareHashState` | DataState | | | + | `FirmwareRevisionState` | DataState | | | + | `NameState` | DataState | | | + | `NewFirmwareAvailableState` | DataState | | | + | `Private10State` | DataState | | | + | `Private1State` | DataState | | | + | `Private2State` | DataState | | | + | `Private3State` | DataState | | | + | `Private4State` | DataState | | | + | `Private5State` | DataState | | | + | `Private6State` | DataState | | | + | `Private7State` | DataState | | | + | `Private8State` | DataState | | | + | `Private9State` | DataState | | | + | `RemovableState` | DataState | | | + | `SignalQualityState` | ContinuousState | | | + | `StatusState` | DiscreteState | available, unavailable | | + | `TemperatureState` | ContinuousState | [-100.0..100.0] | | + +??? note "ThirdPartyGateway/DynamicThirdPartyGateway (ACTUATOR) — 10 commands, 26 states" + + **Type IDs:** `283` | **Servers:** `rexel` | **Controllable:** `ogp:ThirdPartyGateway` | **Profiles:** `Specific` + + **Commands** + + | Command | Parameters | Notes | + |---------|-----------|-------| + | `addGroupMember` | STRING | Add member to the group p1 : Id of the member to add to the group. | + | `executeManufacturerProcedure` | STRING; OBJECT (optional) | execute manufacturer procedure command. p1: the procedure name p2: the params associated Example: p1 = "dead_man_up" p2 = {"duration": 42} | + | `identify` | | Ask the device to identify itself by doing a slight movement or blink or beep | + | `readManufacturerData` | ARRAY | Read manufacturer data values from given names. Example: ["setting1","setting2"]. | + | `removeGroupMember` | STRING | Remove a member of the group. p1 : Id of the member to remove to the group. | + | `sendPrivate` | OBJECT | send a private command | + | `setAuthentication` | OBJECT | Set authentication properties of a node | + | `setName` | STRING | Change the device internal name. Name length may be subject to restrictions depending on the device and underlying protocol. | + | `update` | | Update the gateway software. The update may have to be downloaded first, which can take a while. | + | `writeManufacturerData` | OBJECT | Write manufacturer data values. Example: { "setting1": true, "setting2": 42, "setting3": "overkiz", "setting4": "Dk8PDr1WD0sfAAAAAAAAAAAAAAAAAAAA", "setting5": [ "valueA", "valueB", "valueC" ], "setting6": { "value": 15, "definition": 158 } } | + + **States** + + | State | Type | Range / Values | Notes | + |-------|------|----------------|-------| + | `ActivePartitionState` | DataState | | | + | `AuthenticationExpiredState` | DataState | | | + | `AvailabilityState` | DiscreteState | available, unavailable | | + | `BatteryDiscreteLevelState` | DiscreteState | good, medium, low, critical | | + | `BatteryLevelState` | ContinuousState | | | + | `ErrorEventState` | DiscreteState | accessLimitation, internal, obstacleProtection, transportBusy, deviceNoAnswer, cancelled, deprecated, interrupted, thermalProtection, maintenanceRequired, alreadyUpToDate, notSupported, hardwareError, accessDenied, updateError, resourceAlreadyExist | | + | `ErrorState` | DataState | | | + | `ErrorsState` | DataState | | | + | `FirmwareHashState` | DataState | | | + | `FirmwareRevisionState` | DataState | | | + | `GroupMembersState` | DataState | | | + | `NameState` | DataState | | | + | `NewFirmwareAvailableState` | DataState | | | + | `Private10State` | DataState | | | + | `Private1State` | DataState | | | + | `Private2State` | DataState | | | + | `Private3State` | DataState | | | + | `Private4State` | DataState | | | + | `Private5State` | DataState | | | + | `Private6State` | DataState | | | + | `Private7State` | DataState | | | + | `Private8State` | DataState | | | + | `Private9State` | DataState | | | + | `RemovableState` | DataState | | | + | `SignalQualityState` | ContinuousState | | | + | `StatusState` | DiscreteState | available, unavailable | | + +??? note "ThirdPartyGateway/DynamicThirdPartyGateway (ACTUATOR) — 10 commands, 25 states" + + **Type IDs:** `283` | **Servers:** `somfy_europe` | **Controllable:** `ogp:ThirdPartyGateway` | **Profiles:** `Specific` + + **Commands** + + | Command | Parameters | Notes | + |---------|-----------|-------| + | `addGroupMember` | STRING | Add member to the group p1 : Id of the member to add to the group. | + | `executeManufacturerProcedure` | STRING; OBJECT (optional) | execute manufacturer procedure command. p1: the procedure name p2: the params associated Example: p1 = "dead_man_up" p2 = {"duration": 42} | + | `identify` | | Ask the device to identify itself by doing a slight movement or blink or beep | + | `readManufacturerData` | ARRAY | Read manufacturer data values from given names. Example: ["setting1","setting2"]. | + | `removeGroupMember` | STRING | Remove a member of the group. p1 : Id of the member to remove to the group. | + | `sendPrivate` | OBJECT | send a private command | + | `setAuthentication` | OBJECT | Set authentication properties of a node | + | `setName` | STRING | Change the device internal name. Name length may be subject to restrictions depending on the device and underlying protocol. | + | `update` | | Update the gateway software. The update may have to be downloaded first, which can take a while. | + | `writeManufacturerData` | OBJECT | Write manufacturer data values. Example: { "setting1": true, "setting2": 42, "setting3": "overkiz", "setting4": "Dk8PDr1WD0sfAAAAAAAAAAAAAAAAAAAA", "setting5": [ "valueA", "valueB", "valueC" ], "setting6": { "value": 15, "definition": 158 } } | + + **States** + + | State | Type | Range / Values | Notes | + |-------|------|----------------|-------| + | `ActivePartitionState` | DataState | | | + | `AuthenticationExpiredState` | DataState | | | + | `AvailabilityState` | DiscreteState | available, unavailable | | + | `BatteryDiscreteLevelState` | DiscreteState | good, medium, low, critical | | + | `BatteryLevelState` | ContinuousState | | | + | `ErrorState` | DataState | | | + | `ErrorsState` | DataState | | | + | `FirmwareHashState` | DataState | | | + | `FirmwareRevisionState` | DataState | | | + | `GroupMembersState` | DataState | | | + | `NameState` | DataState | | | + | `NewFirmwareAvailableState` | DataState | | | + | `Private10State` | DataState | | | + | `Private1State` | DataState | | | + | `Private2State` | DataState | | | + | `Private3State` | DataState | | | + | `Private4State` | DataState | | | + | `Private5State` | DataState | | | + | `Private6State` | DataState | | | + | `Private7State` | DataState | | | + | `Private8State` | DataState | | | + | `Private9State` | DataState | | | + | `RemovableState` | DataState | | | + | `SignalQualityState` | ContinuousState | | | + | `StatusState` | DiscreteState | available, unavailable | | + +??? note "VenetianBlind/DynamicVenetianBlind (ACTUATOR) — 20 commands, 31 states" + + **Type IDs:** `264` | **Servers:** `rexel` | **Controllable:** `ogp:VenetianBlind` | **Profiles:** `StatefulOrientableShutter`, `StatefulOrientablePlusCloseable`, `OrientablePlusCloseable`, `StatefulOpenClose`, `OpenClose`, `StatefulCloseable`, `Closeable` + + **Commands** + + | Command | Parameters | Notes | + |---------|-----------|-------| + | `close` | | Fully close the device | + | `executeManufacturerProcedure` | STRING; OBJECT (optional) | execute manufacturer procedure command. p1: the procedure name p2: the params associated Example: p1 = "dead_man_up" p2 = {"duration": 42} | + | `goToAlias` | STRING | Send alias command linked with the ID. | + | `identify` | | Ask the device to identify itself by doing a slight movement or blink or beep | + | `open` | | Fully open the device | + | `readManufacturerData` | ARRAY | Read manufacturer data values from given names. Example: ["setting1","setting2"]. | + | `right` | | Right the device (go to minimum tilt position - open) | + | `saveAlias` | STRING | Allow to send an order for the product to save the current state of the alias. | + | `sendPrivate` | OBJECT | send a private command | + | `setClosure` | INT [0..100] | Closure level (100%=fully close, 0%=open) | + | `setName` | STRING | Change the device internal name. Name length may be subject to restrictions depending on the device and underlying protocol. | + | `setNodeDefinition` | STRING; STRING (optional); STRING (optional) | Fill the node definition (some transitions can be forbidden) p1: type (mandatory) p2: subType (mandatory if definition is set) p3: definition | + | `setOrientation` | INT [0..100] | Set the relative orientation (0-100%) of the device slats | + | `setTilt` | INT [0..100] | set the device tilt percentage | + | `stop` | | Stop the current actuator behavior (movement, sound or timer) | + | `tilt` | | Go to maximum tilt position (closed) | + | `tiltDown` | | Lower the slats to a horizontal position step by step (which will let in more light) | + | `tiltUp` | | Straighten the slats to a vertical position step by step (which will let in less light) | + | `update` | | Update the gateway software. The update may have to be downloaded first, which can take a while. | + | `writeManufacturerData` | OBJECT | Write manufacturer data values. Example: { "setting1": true, "setting2": 42, "setting3": "overkiz", "setting4": "Dk8PDr1WD0sfAAAAAAAAAAAAAAAAAAAA", "setting5": [ "valueA", "valueB", "valueC" ], "setting6": { "value": 15, "definition": 158 } } | + + **States** + + | State | Type | Range / Values | Notes | + |-------|------|----------------|-------| + | `ActivePartitionState` | DataState | | | + | `AvailabilityState` | DiscreteState | available, unavailable | | + | `BatteryDiscreteLevelState` | DiscreteState | good, medium, low, critical | | + | `BatteryLevelState` | ContinuousState | | | + | `ClosureState` | ContinuousState | [0..100] | | + | `ErrorEventState` | DiscreteState | accessLimitation, internal, obstacleProtection, transportBusy, deviceNoAnswer, cancelled, deprecated, interrupted, thermalProtection, maintenanceRequired, alreadyUpToDate, notSupported, hardwareError, accessDenied, updateError, resourceAlreadyExist | | + | `ErrorState` | DataState | | | + | `ErrorsState` | DataState | | | + | `FirmwareHashState` | DataState | | | + | `FirmwareRevisionState` | DataState | | | + | `NameState` | DataState | | | + | `NewFirmwareAvailableState` | DataState | | | + | `OpenClosedState` | DiscreteState | open, closed | | + | `Private10State` | DataState | | | + | `Private1State` | DataState | | | + | `Private2State` | DataState | | | + | `Private3State` | DataState | | | + | `Private4State` | DataState | | | + | `Private5State` | DataState | | | + | `Private6State` | DataState | | | + | `Private7State` | DataState | | | + | `Private8State` | DataState | | | + | `Private9State` | DataState | | | + | `ReachedAliasesState` | DataState | | | + | `RemovableState` | DataState | | | + | `SignalQualityState` | ContinuousState | | | + | `SlateOrientationState` | ContinuousState | [0..100] | | + | `StatusState` | DiscreteState | available, unavailable | | + | `TiltState` | ContinuousState | | | + | `TiltedState` | DiscreteState | true, false | | + | `UnavailableFeaturesState` | DataState | | | + +??? note "VenetianBlind/DynamicVenetianBlind (ACTUATOR) — 20 commands, 30 states" + + **Type IDs:** `264` | **Servers:** `somfy_europe` | **Controllable:** `ogp:VenetianBlind` | **Profiles:** `StatefulOrientableShutter`, `StatefulOrientablePlusCloseable`, `OrientablePlusCloseable`, `StatefulOpenClose`, `OpenClose`, `StatefulCloseable`, `Closeable` + + **Commands** + + | Command | Parameters | Notes | + |---------|-----------|-------| + | `close` | | Fully close the device | + | `executeManufacturerProcedure` | STRING; OBJECT (optional) | execute manufacturer procedure command. p1: the procedure name p2: the params associated Example: p1 = "dead_man_up" p2 = {"duration": 42} | + | `goToAlias` | STRING | Send alias command linked with the ID. | + | `identify` | | Ask the device to identify itself by doing a slight movement or blink or beep | + | `open` | | Fully open the device | + | `readManufacturerData` | ARRAY | Read manufacturer data values from given names. Example: ["setting1","setting2"]. | + | `right` | | Right the device (go to minimum tilt position - open) | + | `saveAlias` | STRING | Allow to send an order for the product to save the current state of the alias. | + | `sendPrivate` | OBJECT | send a private command | + | `setClosure` | INT [0..100] | Closure level (100%=fully close, 0%=open) | + | `setName` | STRING | Change the device internal name. Name length may be subject to restrictions depending on the device and underlying protocol. | + | `setNodeDefinition` | STRING; STRING (optional); STRING (optional) | Fill the node definition (some transitions can be forbidden) p1: type (mandatory) p2: subType (mandatory if definition is set) p3: definition | + | `setOrientation` | INT [0..100] | Set the relative orientation (0-100%) of the device slats | + | `setTilt` | INT [0..100] | set the device tilt percentage | + | `stop` | | Stop the current actuator behavior (movement, sound or timer) | + | `tilt` | | Go to maximum tilt position (closed) | + | `tiltDown` | | Lower the slats to a horizontal position step by step (which will let in more light) | + | `tiltUp` | | Straighten the slats to a vertical position step by step (which will let in less light) | + | `update` | | Update the gateway software. The update may have to be downloaded first, which can take a while. | + | `writeManufacturerData` | OBJECT | Write manufacturer data values. Example: { "setting1": true, "setting2": 42, "setting3": "overkiz", "setting4": "Dk8PDr1WD0sfAAAAAAAAAAAAAAAAAAAA", "setting5": [ "valueA", "valueB", "valueC" ], "setting6": { "value": 15, "definition": 158 } } | + + **States** + + | State | Type | Range / Values | Notes | + |-------|------|----------------|-------| + | `ActivePartitionState` | DataState | | | + | `AvailabilityState` | DiscreteState | available, unavailable | | + | `BatteryDiscreteLevelState` | DiscreteState | good, medium, low, critical | | + | `BatteryLevelState` | ContinuousState | | | + | `ClosureState` | ContinuousState | [0..100] | | + | `ErrorState` | DataState | | | + | `ErrorsState` | DataState | | | + | `FirmwareHashState` | DataState | | | + | `FirmwareRevisionState` | DataState | | | + | `NameState` | DataState | | | + | `NewFirmwareAvailableState` | DataState | | | + | `OpenClosedState` | DiscreteState | open, closed | | + | `Private10State` | DataState | | | + | `Private1State` | DataState | | | + | `Private2State` | DataState | | | + | `Private3State` | DataState | | | + | `Private4State` | DataState | | | + | `Private5State` | DataState | | | + | `Private6State` | DataState | | | + | `Private7State` | DataState | | | + | `Private8State` | DataState | | | + | `Private9State` | DataState | | | + | `ReachedAliasesState` | DataState | | | + | `RemovableState` | DataState | | | + | `SignalQualityState` | ContinuousState | | | + | `SlateOrientationState` | ContinuousState | [0..100] | | + | `StatusState` | DiscreteState | available, unavailable | | + | `TiltState` | ContinuousState | | | + | `TiltedState` | DiscreteState | true, false | | + | `UnavailableFeaturesState` | DataState | | | + +??? note "VentilationSystem/DynamicVentilation (ACTUATOR) — 17 commands, 32 states" + + **Type IDs:** `260` | **Servers:** `rexel` | **Controllable:** `ogp:Ventilation` | **Profiles:** `StatefulSwitchableVentilation`, `Temperature`, `StatefulSwitchable`, `Switchable`, `StatefulAirFan`, `AirFan` + + **Commands** + + | Command | Parameters | Notes | + |---------|-----------|-------| + | `executeManufacturerProcedure` | STRING; OBJECT (optional) | execute manufacturer procedure command. p1: the procedure name p2: the params associated Example: p1 = "dead_man_up" p2 = {"duration": 42} | + | `goToAlias` | STRING | Send alias command linked with the ID. | + | `identify` | | Ask the device to identify itself by doing a slight movement or blink or beep | + | `off` | | Turn off the device | + | `on` | | Turn on the device | + | `readManufacturerData` | ARRAY | Read manufacturer data values from given names. Example: ["setting1","setting2"]. | + | `saveAlias` | STRING | Allow to send an order for the product to save the current state of the alias. | + | `sendPrivate` | OBJECT | send a private command | + | `setFanSpeed` | STRING: low, medium, high, auto, 1 | Set the fan speed (%) | + | `setFanSpeedLevel` | INT [0..100] | Set the device fan speed level (%) | + | `setMode` | STRING | Set the active mode. | + | `setName` | STRING | Change the device internal name. Name length may be subject to restrictions depending on the device and underlying protocol. | + | `setNodeDefinition` | STRING; STRING (optional); STRING (optional) | Fill the node definition (some transitions can be forbidden) p1: type (mandatory) p2: subType (mandatory if definition is set) p3: definition | + | `setOnOff` | STRING: off, on | Turn the device on or off | + | `toggle` | | Toggle on/off status | + | `update` | | Update the gateway software. The update may have to be downloaded first, which can take a while. | + | `writeManufacturerData` | OBJECT | Write manufacturer data values. Example: { "setting1": true, "setting2": 42, "setting3": "overkiz", "setting4": "Dk8PDr1WD0sfAAAAAAAAAAAAAAAAAAAA", "setting5": [ "valueA", "valueB", "valueC" ], "setting6": { "value": 15, "definition": 158 } } | + + **States** + + | State | Type | Range / Values | Notes | + |-------|------|----------------|-------| + | `ActivePartitionState` | DataState | | | + | `AvailabilityState` | DiscreteState | available, unavailable | | + | `AvailableModesState` | DataState | | | + | `BatteryDiscreteLevelState` | DiscreteState | good, medium, low, critical | | + | `BatteryLevelState` | ContinuousState | | | + | `ErrorEventState` | DiscreteState | accessLimitation, internal, obstacleProtection, transportBusy, deviceNoAnswer, cancelled, deprecated, interrupted, thermalProtection, maintenanceRequired, alreadyUpToDate, notSupported, hardwareError, accessDenied, updateError, resourceAlreadyExist | | + | `ErrorState` | DataState | | | + | `ErrorsState` | DataState | | | + | `FanSpeedLevelState` | ContinuousState | [0..100] | | + | `FanSpeedState` | DiscreteState | low, medium, high, 1, 2, 3, 4, 5, 6, 7, 8, 9 | | + | `FirmwareHashState` | DataState | | | + | `FirmwareRevisionState` | DataState | | | + | `ModeState` | DataState | | | + | `NameState` | DataState | | | + | `NewFirmwareAvailableState` | DataState | | | + | `OnOffState` | DiscreteState | on, off | | + | `Private10State` | DataState | | | + | `Private1State` | DataState | | | + | `Private2State` | DataState | | | + | `Private3State` | DataState | | | + | `Private4State` | DataState | | | + | `Private5State` | DataState | | | + | `Private6State` | DataState | | | + | `Private7State` | DataState | | | + | `Private8State` | DataState | | | + | `Private9State` | DataState | | | + | `ReachedAliasesState` | DataState | | | + | `RemovableState` | DataState | | | + | `SignalQualityState` | ContinuousState | | | + | `StatusState` | DiscreteState | available, unavailable | | + | `TemperatureState` | ContinuousState | [-100.0..100.0] | | + | `UnavailableFeaturesState` | DataState | | | + +??? note "VentilationSystem/DynamicAirVent (ACTUATOR) — 18 commands, 33 states" + + **Type IDs:** `268` | **Servers:** `rexel` | **Controllable:** `ogp:AirVent` | **Profiles:** `StatefulCloseableAirVent`, `StatefulOrientableSlats`, `OrientableSlats`, `StatefulBasicCloseable`, `BasicCloseable`, `StatefulBasicOpenClose`, `BasicOpenClose` + + **Commands** + + | Command | Parameters | Notes | + |---------|-----------|-------| + | `close` | | Fully close the device | + | `executeManufacturerProcedure` | STRING; OBJECT (optional) | execute manufacturer procedure command. p1: the procedure name p2: the params associated Example: p1 = "dead_man_up" p2 = {"duration": 42} | + | `goToAlias` | STRING | Send alias command linked with the ID. | + | `identify` | | Ask the device to identify itself by doing a slight movement or blink or beep | + | `open` | | Fully open the device | + | `readManufacturerData` | ARRAY | Read manufacturer data values from given names. Example: ["setting1","setting2"]. | + | `right` | | Right the device (go to minimum tilt position - open) | + | `saveAlias` | STRING | Allow to send an order for the product to save the current state of the alias. | + | `sendPrivate` | OBJECT | send a private command | + | `setClosure` | INT [0..100] | Closure level (100%=fully close, 0%=open) | + | `setMode` | STRING | Set the active mode. | + | `setName` | STRING | Change the device internal name. Name length may be subject to restrictions depending on the device and underlying protocol. | + | `setNodeDefinition` | STRING; STRING (optional); STRING (optional) | Fill the node definition (some transitions can be forbidden) p1: type (mandatory) p2: subType (mandatory if definition is set) p3: definition | + | `setOrientation` | INT [0..100] | Set the relative orientation (0-100%) of the device slats | + | `setTilt` | INT [0..100] | set the device tilt percentage | + | `tilt` | | Go to maximum tilt position (closed) | + | `update` | | Update the gateway software. The update may have to be downloaded first, which can take a while. | + | `writeManufacturerData` | OBJECT | Write manufacturer data values. Example: { "setting1": true, "setting2": 42, "setting3": "overkiz", "setting4": "Dk8PDr1WD0sfAAAAAAAAAAAAAAAAAAAA", "setting5": [ "valueA", "valueB", "valueC" ], "setting6": { "value": 15, "definition": 158 } } | + + **States** + + | State | Type | Range / Values | Notes | + |-------|------|----------------|-------| + | `ActivePartitionState` | DataState | | | + | `AvailabilityState` | DiscreteState | available, unavailable | | + | `AvailableModesState` | DataState | | | + | `BatteryDiscreteLevelState` | DiscreteState | good, medium, low, critical | | + | `BatteryLevelState` | ContinuousState | | | + | `ClosureState` | ContinuousState | [0..100] | | + | `ErrorEventState` | DiscreteState | accessLimitation, internal, obstacleProtection, transportBusy, deviceNoAnswer, cancelled, deprecated, interrupted, thermalProtection, maintenanceRequired, alreadyUpToDate, notSupported, hardwareError, accessDenied, updateError, resourceAlreadyExist | | + | `ErrorState` | DataState | | | + | `ErrorsState` | DataState | | | + | `FirmwareHashState` | DataState | | | + | `FirmwareRevisionState` | DataState | | | + | `ModeState` | DataState | | | + | `NameState` | DataState | | | + | `NewFirmwareAvailableState` | DataState | | | + | `OpenClosedState` | DiscreteState | open, closed | | + | `Private10State` | DataState | | | + | `Private1State` | DataState | | | + | `Private2State` | DataState | | | + | `Private3State` | DataState | | | + | `Private4State` | DataState | | | + | `Private5State` | DataState | | | + | `Private6State` | DataState | | | + | `Private7State` | DataState | | | + | `Private8State` | DataState | | | + | `Private9State` | DataState | | | + | `ReachedAliasesState` | DataState | | | + | `RemovableState` | DataState | | | + | `SignalQualityState` | ContinuousState | | | + | `SlateOrientationState` | ContinuousState | [0..100] | | + | `StatusState` | DiscreteState | available, unavailable | | + | `TiltState` | ContinuousState | | | + | `TiltedState` | DiscreteState | true, false | | + | `UnavailableFeaturesState` | DataState | | | + +??? note "VentilationSystem/DynamicVentilation (ACTUATOR) — 17 commands, 31 states" + + **Type IDs:** `260` | **Servers:** `somfy_europe` | **Controllable:** `ogp:Ventilation` | **Profiles:** `StatefulSwitchableVentilation`, `Temperature`, `StatefulSwitchable`, `Switchable`, `StatefulAirFan`, `AirFan` + + **Commands** + + | Command | Parameters | Notes | + |---------|-----------|-------| + | `executeManufacturerProcedure` | STRING; OBJECT (optional) | execute manufacturer procedure command. p1: the procedure name p2: the params associated Example: p1 = "dead_man_up" p2 = {"duration": 42} | + | `goToAlias` | STRING | Send alias command linked with the ID. | + | `identify` | | Ask the device to identify itself by doing a slight movement or blink or beep | + | `off` | | Turn off the device | + | `on` | | Turn on the device | + | `readManufacturerData` | ARRAY | Read manufacturer data values from given names. Example: ["setting1","setting2"]. | + | `saveAlias` | STRING | Allow to send an order for the product to save the current state of the alias. | + | `sendPrivate` | OBJECT | send a private command | + | `setFanSpeed` | STRING: low, medium, high, auto, 1 | Set the fan speed (%) | + | `setFanSpeedLevel` | INT [0..100] | Set the device fan speed level (%) | + | `setMode` | STRING | Set the active mode. | + | `setName` | STRING | Change the device internal name. Name length may be subject to restrictions depending on the device and underlying protocol. | + | `setNodeDefinition` | STRING; STRING (optional); STRING (optional) | Fill the node definition (some transitions can be forbidden) p1: type (mandatory) p2: subType (mandatory if definition is set) p3: definition | + | `setOnOff` | STRING: off, on | Turn the device on or off | + | `toggle` | | Toggle on/off status | + | `update` | | Update the gateway software. The update may have to be downloaded first, which can take a while. | + | `writeManufacturerData` | OBJECT | Write manufacturer data values. Example: { "setting1": true, "setting2": 42, "setting3": "overkiz", "setting4": "Dk8PDr1WD0sfAAAAAAAAAAAAAAAAAAAA", "setting5": [ "valueA", "valueB", "valueC" ], "setting6": { "value": 15, "definition": 158 } } | + + **States** + + | State | Type | Range / Values | Notes | + |-------|------|----------------|-------| + | `ActivePartitionState` | DataState | | | + | `AvailabilityState` | DiscreteState | available, unavailable | | + | `AvailableModesState` | DataState | | | + | `BatteryDiscreteLevelState` | DiscreteState | good, medium, low, critical | | + | `BatteryLevelState` | ContinuousState | | | + | `ErrorState` | DataState | | | + | `ErrorsState` | DataState | | | + | `FanSpeedLevelState` | ContinuousState | [0..100] | | + | `FanSpeedState` | DiscreteState | low, medium, high, 1, 2, 3, 4, 5, 6, 7, 8, 9 | | + | `FirmwareHashState` | DataState | | | + | `FirmwareRevisionState` | DataState | | | + | `ModeState` | DataState | | | + | `NameState` | DataState | | | + | `NewFirmwareAvailableState` | DataState | | | + | `OnOffState` | DiscreteState | on, off | | + | `Private10State` | DataState | | | + | `Private1State` | DataState | | | + | `Private2State` | DataState | | | + | `Private3State` | DataState | | | + | `Private4State` | DataState | | | + | `Private5State` | DataState | | | + | `Private6State` | DataState | | | + | `Private7State` | DataState | | | + | `Private8State` | DataState | | | + | `Private9State` | DataState | | | + | `ReachedAliasesState` | DataState | | | + | `RemovableState` | DataState | | | + | `SignalQualityState` | ContinuousState | | | + | `StatusState` | DiscreteState | available, unavailable | | + | `TemperatureState` | ContinuousState | [-100.0..100.0] | | + | `UnavailableFeaturesState` | DataState | | | + +??? note "VentilationSystem/DynamicAirVent (ACTUATOR) — 18 commands, 32 states" + + **Type IDs:** `268` | **Servers:** `somfy_europe` | **Controllable:** `ogp:AirVent` | **Profiles:** `StatefulCloseableAirVent`, `StatefulOrientableSlats`, `OrientableSlats`, `StatefulBasicCloseable`, `BasicCloseable`, `StatefulBasicOpenClose`, `BasicOpenClose` + + **Commands** + + | Command | Parameters | Notes | + |---------|-----------|-------| + | `close` | | Fully close the device | + | `executeManufacturerProcedure` | STRING; OBJECT (optional) | execute manufacturer procedure command. p1: the procedure name p2: the params associated Example: p1 = "dead_man_up" p2 = {"duration": 42} | + | `goToAlias` | STRING | Send alias command linked with the ID. | + | `identify` | | Ask the device to identify itself by doing a slight movement or blink or beep | + | `open` | | Fully open the device | + | `readManufacturerData` | ARRAY | Read manufacturer data values from given names. Example: ["setting1","setting2"]. | + | `right` | | Right the device (go to minimum tilt position - open) | + | `saveAlias` | STRING | Allow to send an order for the product to save the current state of the alias. | + | `sendPrivate` | OBJECT | send a private command | + | `setClosure` | INT [0..100] | Closure level (100%=fully close, 0%=open) | + | `setMode` | STRING | Set the active mode. | + | `setName` | STRING | Change the device internal name. Name length may be subject to restrictions depending on the device and underlying protocol. | + | `setNodeDefinition` | STRING; STRING (optional); STRING (optional) | Fill the node definition (some transitions can be forbidden) p1: type (mandatory) p2: subType (mandatory if definition is set) p3: definition | + | `setOrientation` | INT [0..100] | Set the relative orientation (0-100%) of the device slats | + | `setTilt` | INT [0..100] | set the device tilt percentage | + | `tilt` | | Go to maximum tilt position (closed) | + | `update` | | Update the gateway software. The update may have to be downloaded first, which can take a while. | + | `writeManufacturerData` | OBJECT | Write manufacturer data values. Example: { "setting1": true, "setting2": 42, "setting3": "overkiz", "setting4": "Dk8PDr1WD0sfAAAAAAAAAAAAAAAAAAAA", "setting5": [ "valueA", "valueB", "valueC" ], "setting6": { "value": 15, "definition": 158 } } | + + **States** + + | State | Type | Range / Values | Notes | + |-------|------|----------------|-------| + | `ActivePartitionState` | DataState | | | + | `AvailabilityState` | DiscreteState | available, unavailable | | + | `AvailableModesState` | DataState | | | + | `BatteryDiscreteLevelState` | DiscreteState | good, medium, low, critical | | + | `BatteryLevelState` | ContinuousState | | | + | `ClosureState` | ContinuousState | [0..100] | | + | `ErrorState` | DataState | | | + | `ErrorsState` | DataState | | | + | `FirmwareHashState` | DataState | | | + | `FirmwareRevisionState` | DataState | | | + | `ModeState` | DataState | | | + | `NameState` | DataState | | | + | `NewFirmwareAvailableState` | DataState | | | + | `OpenClosedState` | DiscreteState | open, closed | | + | `Private10State` | DataState | | | + | `Private1State` | DataState | | | + | `Private2State` | DataState | | | + | `Private3State` | DataState | | | + | `Private4State` | DataState | | | + | `Private5State` | DataState | | | + | `Private6State` | DataState | | | + | `Private7State` | DataState | | | + | `Private8State` | DataState | | | + | `Private9State` | DataState | | | + | `ReachedAliasesState` | DataState | | | + | `RemovableState` | DataState | | | + | `SignalQualityState` | ContinuousState | | | + | `SlateOrientationState` | ContinuousState | [0..100] | | + | `StatusState` | DiscreteState | available, unavailable | | + | `TiltState` | ContinuousState | | | + | `TiltedState` | DiscreteState | true, false | | + | `UnavailableFeaturesState` | DataState | | | + +??? note "WashingMachine/DynamicWashingMachine (ACTUATOR) — 23 commands, 56 states" + + **Type IDs:** `285` | **Servers:** `rexel` | **Controllable:** `ogp:WashingMachine` | **Profiles:** `StatefulStartStopWashingMachine`, `StatefulStartStop`, `StartStop`, `StatefulLockWithOpeningStatus`, `StatefulThermostat`, `Thermostat`, `StatefulSwitchable`, `Switchable`, `StatefulLock`, `LockStatus`, `Lock` + + **Commands** + + | Command | Parameters | Notes | + |---------|-----------|-------| + | `activateOption` | STRING | Activate an option | + | `deactivateOption` | STRING | Deactivate an option | + | `executeManufacturerProcedure` | STRING; OBJECT (optional) | execute manufacturer procedure command. p1: the procedure name p2: the params associated Example: p1 = "dead_man_up" p2 = {"duration": 42} | + | `identify` | | Ask the device to identify itself by doing a slight movement or blink or beep | + | `lock` | | Lock the device | + | `off` | | Turn off the device | + | `on` | | Turn on the device | + | `pause` | | Pause current action | + | `readManufacturerData` | ARRAY | Read manufacturer data values from given names. Example: ["setting1","setting2"]. | + | `resume` | | Resume paused action. | + | `sendPrivate` | OBJECT | send a private command | + | `setMode` | STRING | Set the active mode. | + | `setName` | STRING | Change the device internal name. Name length may be subject to restrictions depending on the device and underlying protocol. | + | `setOnOff` | STRING: off, on | Turn the device on or off | + | `setTargetSpinSpeed` | INT | Set the target spin speed. | + | `setTargetTemperature` | FLOAT | Set the new air temperature to reach | + | `setTargetTime` | INT | Set a target action duration. | + | `setTimezone` | STRING | Set the device timezone, according to TZ database names. | + | `start` | | Start the default actuator behavior (movement, sound or timer) | + | `stop` | | Stop the current actuator behavior (movement, sound or timer) | + | `unlock` | | Unlock the device | + | `update` | | Update the gateway software. The update may have to be downloaded first, which can take a while. | + | `writeManufacturerData` | OBJECT | Write manufacturer data values. Example: { "setting1": true, "setting2": 42, "setting3": "overkiz", "setting4": "Dk8PDr1WD0sfAAAAAAAAAAAAAAAAAAAA", "setting5": [ "valueA", "valueB", "valueC" ], "setting6": { "value": 15, "definition": 158 } } | + + **States** + + | State | Type | Range / Values | Notes | + |-------|------|----------------|-------| + | `ActivatedOptionsState` | DataState | | | + | `ActivePartitionState` | DataState | | | + | `AvailabilityState` | DiscreteState | available, unavailable | | + | `AvailableModesState` | DataState | | | + | `AvailableOptionsState` | DataState | | | + | `AvailableTargetSpinSpeedsState` | DataState | | | + | `AvailableTargetTemperaturesState` | DataState | | | + | `BatteryDiscreteLevelState` | DiscreteState | good, medium, low, critical | | + | `BatteryLevelState` | ContinuousState | | | + | `CurrentCycleStageState` | DataState | | | + | `CycleStageSequenceState` | DataState | | | + | `ErrorEventState` | DiscreteState | accessLimitation, internal, obstacleProtection, transportBusy, deviceNoAnswer, cancelled, deprecated, interrupted, thermalProtection, maintenanceRequired, alreadyUpToDate, notSupported, hardwareError, accessDenied, updateError, resourceAlreadyExist | | + | `ErrorState` | DataState | | | + | `ErrorsState` | DataState | | | + | `FirmwareHashState` | DataState | | | + | `FirmwareRevisionState` | DataState | | | + | `LockedUnlockedState` | DiscreteState | locked, unlocked | | + | `ModeState` | DataState | | | + | `NameState` | DataState | | | + | `NewFirmwareAvailableState` | DataState | | | + | `OnOffState` | DiscreteState | on, off | | + | `OpenClosedState` | DiscreteState | open, closed | | + | `OpenState` | DataState | | | + | `PausedState` | DataState | | | + | `Private10State` | DataState | | | + | `Private1State` | DataState | | | + | `Private2State` | DataState | | | + | `Private3State` | DataState | | | + | `Private4State` | DataState | | | + | `Private5State` | DataState | | | + | `Private6State` | DataState | | | + | `Private7State` | DataState | | | + | `Private8State` | DataState | | | + | `Private9State` | DataState | | | + | `RecommendedOptionsState` | DataState | | | + | `RecommendedTargetSpinSpeedState` | ContinuousState | | | + | `RecommendedTargetTemperatureState` | ContinuousState | | | + | `RecommendedTargetTimeState` | ContinuousState | | | + | `RemainingTimeState` | ContinuousState | | | + | `RemovableState` | DataState | | | + | `RunningTimerState` | DataState | | | + | `SignalQualityState` | ContinuousState | | | + | `StartedStoppedState` | DiscreteState | started, stopped | | + | `StatusState` | DiscreteState | available, unavailable | | + | `TargetSpinSpeedCurrentLowerBoundState` | ContinuousState | | | + | `TargetSpinSpeedCurrentUpperBoundState` | ContinuousState | | | + | `TargetSpinSpeedState` | ContinuousState | | | + | `TargetTemperatureCurrentLowerBoundState` | ContinuousState | | | + | `TargetTemperatureCurrentUpperBoundState` | ContinuousState | | | + | `TargetTemperatureReachedState` | DataState | | | + | `TargetTemperatureState` | ContinuousState | [12.0..30.0] | | + | `TargetTimeCurrentLowerBoundState` | ContinuousState | | | + | `TargetTimeCurrentUpperBoundState` | ContinuousState | | | + | `TargetTimeState` | ContinuousState | | | + | `TimezoneState` | DataState | | | + | `UnavailableFeaturesState` | DataState | | | + +??? note "WashingMachine/DynamicWashingMachine (ACTUATOR) — 23 commands, 55 states" + + **Type IDs:** `285` | **Servers:** `somfy_europe` | **Controllable:** `ogp:WashingMachine` | **Profiles:** `StatefulStartStopWashingMachine`, `StatefulStartStop`, `StartStop`, `StatefulLockWithOpeningStatus`, `StatefulThermostat`, `Thermostat`, `StatefulSwitchable`, `Switchable`, `StatefulLock`, `LockStatus`, `Lock` + + **Commands** + + | Command | Parameters | Notes | + |---------|-----------|-------| + | `activateOption` | STRING | Activate an option | + | `deactivateOption` | STRING | Deactivate an option | + | `executeManufacturerProcedure` | STRING; OBJECT (optional) | execute manufacturer procedure command. p1: the procedure name p2: the params associated Example: p1 = "dead_man_up" p2 = {"duration": 42} | + | `identify` | | Ask the device to identify itself by doing a slight movement or blink or beep | + | `lock` | | Lock the device | + | `off` | | Turn off the device | + | `on` | | Turn on the device | + | `pause` | | Pause current action | + | `readManufacturerData` | ARRAY | Read manufacturer data values from given names. Example: ["setting1","setting2"]. | + | `resume` | | Resume paused action. | + | `sendPrivate` | OBJECT | send a private command | + | `setMode` | STRING | Set the active mode. | + | `setName` | STRING | Change the device internal name. Name length may be subject to restrictions depending on the device and underlying protocol. | + | `setOnOff` | STRING: off, on | Turn the device on or off | + | `setTargetSpinSpeed` | INT | Set the target spin speed. | + | `setTargetTemperature` | FLOAT | Set the new air temperature to reach | + | `setTargetTime` | INT | Set a target action duration. | + | `setTimezone` | STRING | Set the device timezone, according to TZ database names. | + | `start` | | Start the default actuator behavior (movement, sound or timer) | + | `stop` | | Stop the current actuator behavior (movement, sound or timer) | + | `unlock` | | Unlock the device | + | `update` | | Update the gateway software. The update may have to be downloaded first, which can take a while. | + | `writeManufacturerData` | OBJECT | Write manufacturer data values. Example: { "setting1": true, "setting2": 42, "setting3": "overkiz", "setting4": "Dk8PDr1WD0sfAAAAAAAAAAAAAAAAAAAA", "setting5": [ "valueA", "valueB", "valueC" ], "setting6": { "value": 15, "definition": 158 } } | + + **States** + + | State | Type | Range / Values | Notes | + |-------|------|----------------|-------| + | `ActivatedOptionsState` | DataState | | | + | `ActivePartitionState` | DataState | | | + | `AvailabilityState` | DiscreteState | available, unavailable | | + | `AvailableModesState` | DataState | | | + | `AvailableOptionsState` | DataState | | | + | `AvailableTargetSpinSpeedsState` | DataState | | | + | `AvailableTargetTemperaturesState` | DataState | | | + | `BatteryDiscreteLevelState` | DiscreteState | good, medium, low, critical | | + | `BatteryLevelState` | ContinuousState | | | + | `CurrentCycleStageState` | DataState | | | + | `CycleStageSequenceState` | DataState | | | + | `ErrorState` | DataState | | | + | `ErrorsState` | DataState | | | + | `FirmwareHashState` | DataState | | | + | `FirmwareRevisionState` | DataState | | | + | `LockedUnlockedState` | DiscreteState | locked, unlocked | | + | `ModeState` | DataState | | | + | `NameState` | DataState | | | + | `NewFirmwareAvailableState` | DataState | | | + | `OnOffState` | DiscreteState | on, off | | + | `OpenClosedState` | DiscreteState | open, closed | | + | `OpenState` | DataState | | | + | `PausedState` | DataState | | | + | `Private10State` | DataState | | | + | `Private1State` | DataState | | | + | `Private2State` | DataState | | | + | `Private3State` | DataState | | | + | `Private4State` | DataState | | | + | `Private5State` | DataState | | | + | `Private6State` | DataState | | | + | `Private7State` | DataState | | | + | `Private8State` | DataState | | | + | `Private9State` | DataState | | | + | `RecommendedOptionsState` | DataState | | | + | `RecommendedTargetSpinSpeedState` | ContinuousState | | | + | `RecommendedTargetTemperatureState` | ContinuousState | | | + | `RecommendedTargetTimeState` | ContinuousState | | | + | `RemainingTimeState` | ContinuousState | | | + | `RemovableState` | DataState | | | + | `RunningTimerState` | DataState | | | + | `SignalQualityState` | ContinuousState | | | + | `StartedStoppedState` | DiscreteState | started, stopped | | + | `StatusState` | DiscreteState | available, unavailable | | + | `TargetSpinSpeedCurrentLowerBoundState` | ContinuousState | | | + | `TargetSpinSpeedCurrentUpperBoundState` | ContinuousState | | | + | `TargetSpinSpeedState` | ContinuousState | | | + | `TargetTemperatureCurrentLowerBoundState` | ContinuousState | | | + | `TargetTemperatureCurrentUpperBoundState` | ContinuousState | | | + | `TargetTemperatureReachedState` | DataState | | | + | `TargetTemperatureState` | ContinuousState | [12.0..30.0] | | + | `TargetTimeCurrentLowerBoundState` | ContinuousState | | | + | `TargetTimeCurrentUpperBoundState` | ContinuousState | | | + | `TargetTimeState` | ContinuousState | | | + | `TimezoneState` | DataState | | | + | `UnavailableFeaturesState` | DataState | | | + +??? note "WaterHeatingSystem/DynamicDomesticHotWaterProduction (ACTUATOR) — 16 commands, 41 states" + + **Type IDs:** `290` | **Servers:** `rexel` | **Controllable:** `ogp:DomesticHotWater` | **Profiles:** `StatefulThermostatWithSensor`, `StatefulThermostat`, `Thermostat`, `StatefulSwitchable`, `Switchable` + + **Commands** + + | Command | Parameters | Notes | + |---------|-----------|-------| + | `activateOption` | STRING | Activate an option | + | `cancelHolidayMode` | | Deactivate holidays mode | + | `configureHolidayMode` | INT; INT | Configure holiday mode p1 : start date (timestamp in millisecond) p2 : end date (timestamp in millisecond) | + | `deactivateOption` | STRING | Deactivate an option | + | `executeManufacturerProcedure` | STRING; OBJECT (optional) | execute manufacturer procedure command. p1: the procedure name p2: the params associated Example: p1 = "dead_man_up" p2 = {"duration": 42} | + | `identify` | | Ask the device to identify itself by doing a slight movement or blink or beep | + | `off` | | Turn off the device | + | `on` | | Turn on the device | + | `readManufacturerData` | ARRAY | Read manufacturer data values from given names. Example: ["setting1","setting2"]. | + | `sendPrivate` | OBJECT | send a private command | + | `setMode` | STRING | Set the active mode. | + | `setName` | STRING | Change the device internal name. Name length may be subject to restrictions depending on the device and underlying protocol. | + | `setOnOff` | STRING: off, on | Turn the device on or off | + | `setTargetTemperature` | FLOAT | Set the new air temperature to reach | + | `update` | | Update the gateway software. The update may have to be downloaded first, which can take a while. | + | `writeManufacturerData` | OBJECT | Write manufacturer data values. Example: { "setting1": true, "setting2": 42, "setting3": "overkiz", "setting4": "Dk8PDr1WD0sfAAAAAAAAAAAAAAAAAAAA", "setting5": [ "valueA", "valueB", "valueC" ], "setting6": { "value": 15, "definition": 158 } } | + + **States** + + | State | Type | Range / Values | Notes | + |-------|------|----------------|-------| + | `ActivatedOptionsState` | DataState | | | + | `ActivePartitionState` | DataState | | | + | `AvailabilityState` | DiscreteState | available, unavailable | | + | `AvailableModesState` | DataState | | | + | `AvailableOptionsState` | DataState | | | + | `AvailableTargetTemperaturesState` | DataState | | | + | `BatteryDiscreteLevelState` | DiscreteState | good, medium, low, critical | | + | `BatteryLevelState` | ContinuousState | | | + | `ErrorEventState` | DiscreteState | accessLimitation, internal, obstacleProtection, transportBusy, deviceNoAnswer, cancelled, deprecated, interrupted, thermalProtection, maintenanceRequired, alreadyUpToDate, notSupported, hardwareError, accessDenied, updateError, resourceAlreadyExist | | + | `ErrorState` | DataState | | | + | `ErrorsState` | DataState | | | + | `FirmwareHashState` | DataState | | | + | `FirmwareRevisionState` | DataState | | | + | `HolidayModeConfiguredState` | DataState | | | + | `HolidayModeEndDateTimeState` | DataState | | | + | `HolidayModeStartDateTimeState` | DataState | | | + | `ModeState` | DataState | | | + | `NameState` | DataState | | | + | `NewFirmwareAvailableState` | DataState | | | + | `OnOffState` | DiscreteState | on, off | | + | `Private10State` | DataState | | | + | `Private1State` | DataState | | | + | `Private2State` | DataState | | | + | `Private3State` | DataState | | | + | `Private4State` | DataState | | | + | `Private5State` | DataState | | | + | `Private6State` | DataState | | | + | `Private7State` | DataState | | | + | `Private8State` | DataState | | | + | `Private9State` | DataState | | | + | `RecommendedOptionsState` | DataState | | | + | `RecommendedTargetTemperatureState` | ContinuousState | | | + | `RemovableState` | DataState | | | + | `SignalQualityState` | ContinuousState | | | + | `StatusState` | DiscreteState | available, unavailable | | + | `TargetTemperatureCurrentLowerBoundState` | ContinuousState | | | + | `TargetTemperatureCurrentUpperBoundState` | ContinuousState | | | + | `TargetTemperatureReachedState` | DataState | | | + | `TargetTemperatureState` | ContinuousState | [12.0..30.0] | | + | `TemperatureState` | ContinuousState | [-100.0..100.0] | | + | `UnavailableFeaturesState` | DataState | | | + +??? note "WaterHeatingSystem/DynamicDomesticHotWaterProduction (ACTUATOR) — 16 commands, 40 states" + + **Type IDs:** `290` | **Servers:** `somfy_europe` | **Controllable:** `ogp:DomesticHotWater` | **Profiles:** `StatefulThermostatWithSensor`, `StatefulThermostat`, `Thermostat`, `StatefulSwitchable`, `Switchable` + + **Commands** + + | Command | Parameters | Notes | + |---------|-----------|-------| + | `activateOption` | STRING | Activate an option | + | `cancelHolidayMode` | | Deactivate holidays mode | + | `configureHolidayMode` | INT; INT | Configure holiday mode p1 : start date (timestamp in millisecond) p2 : end date (timestamp in millisecond) | + | `deactivateOption` | STRING | Deactivate an option | + | `executeManufacturerProcedure` | STRING; OBJECT (optional) | execute manufacturer procedure command. p1: the procedure name p2: the params associated Example: p1 = "dead_man_up" p2 = {"duration": 42} | + | `identify` | | Ask the device to identify itself by doing a slight movement or blink or beep | + | `off` | | Turn off the device | + | `on` | | Turn on the device | + | `readManufacturerData` | ARRAY | Read manufacturer data values from given names. Example: ["setting1","setting2"]. | + | `sendPrivate` | OBJECT | send a private command | + | `setMode` | STRING | Set the active mode. | + | `setName` | STRING | Change the device internal name. Name length may be subject to restrictions depending on the device and underlying protocol. | + | `setOnOff` | STRING: off, on | Turn the device on or off | + | `setTargetTemperature` | FLOAT | Set the new air temperature to reach | + | `update` | | Update the gateway software. The update may have to be downloaded first, which can take a while. | + | `writeManufacturerData` | OBJECT | Write manufacturer data values. Example: { "setting1": true, "setting2": 42, "setting3": "overkiz", "setting4": "Dk8PDr1WD0sfAAAAAAAAAAAAAAAAAAAA", "setting5": [ "valueA", "valueB", "valueC" ], "setting6": { "value": 15, "definition": 158 } } | + + **States** + + | State | Type | Range / Values | Notes | + |-------|------|----------------|-------| + | `ActivatedOptionsState` | DataState | | | + | `ActivePartitionState` | DataState | | | + | `AvailabilityState` | DiscreteState | available, unavailable | | + | `AvailableModesState` | DataState | | | + | `AvailableOptionsState` | DataState | | | + | `AvailableTargetTemperaturesState` | DataState | | | + | `BatteryDiscreteLevelState` | DiscreteState | good, medium, low, critical | | + | `BatteryLevelState` | ContinuousState | | | + | `ErrorState` | DataState | | | + | `ErrorsState` | DataState | | | + | `FirmwareHashState` | DataState | | | + | `FirmwareRevisionState` | DataState | | | + | `HolidayModeConfiguredState` | DataState | | | + | `HolidayModeEndDateTimeState` | DataState | | | + | `HolidayModeStartDateTimeState` | DataState | | | + | `ModeState` | DataState | | | + | `NameState` | DataState | | | + | `NewFirmwareAvailableState` | DataState | | | + | `OnOffState` | DiscreteState | on, off | | + | `Private10State` | DataState | | | + | `Private1State` | DataState | | | + | `Private2State` | DataState | | | + | `Private3State` | DataState | | | + | `Private4State` | DataState | | | + | `Private5State` | DataState | | | + | `Private6State` | DataState | | | + | `Private7State` | DataState | | | + | `Private8State` | DataState | | | + | `Private9State` | DataState | | | + | `RecommendedOptionsState` | DataState | | | + | `RecommendedTargetTemperatureState` | ContinuousState | | | + | `RemovableState` | DataState | | | + | `SignalQualityState` | ContinuousState | | | + | `StatusState` | DiscreteState | available, unavailable | | + | `TargetTemperatureCurrentLowerBoundState` | ContinuousState | | | + | `TargetTemperatureCurrentUpperBoundState` | ContinuousState | | | + | `TargetTemperatureReachedState` | DataState | | | + | `TargetTemperatureState` | ContinuousState | [12.0..30.0] | | + | `TemperatureState` | ContinuousState | [-100.0..100.0] | | + | `UnavailableFeaturesState` | DataState | | | + +??? note "WaterSensor/DynamicWaterMeasurementSensor (SENSOR) — 7 commands, 26 states" + + **Type IDs:** `295` | **Servers:** `rexel` | **Controllable:** `ogp:WaterMeasurementSensor` | **Profiles:** `WaterConsumption` + + **Commands** + + | Command | Parameters | Notes | + |---------|-----------|-------| + | `executeManufacturerProcedure` | STRING; OBJECT (optional) | execute manufacturer procedure command. p1: the procedure name p2: the params associated Example: p1 = "dead_man_up" p2 = {"duration": 42} | + | `identify` | | Ask the device to identify itself by doing a slight movement or blink or beep | + | `readManufacturerData` | ARRAY | Read manufacturer data values from given names. Example: ["setting1","setting2"]. | + | `sendPrivate` | OBJECT | send a private command | + | `setName` | STRING | Change the device internal name. Name length may be subject to restrictions depending on the device and underlying protocol. | + | `update` | | Update the gateway software. The update may have to be downloaded first, which can take a while. | + | `writeManufacturerData` | OBJECT | Write manufacturer data values. Example: { "setting1": true, "setting2": 42, "setting3": "overkiz", "setting4": "Dk8PDr1WD0sfAAAAAAAAAAAAAAAAAAAA", "setting5": [ "valueA", "valueB", "valueC" ], "setting6": { "value": 15, "definition": 158 } } | + + **States** + + | State | Type | Range / Values | Notes | + |-------|------|----------------|-------| + | `ActivePartitionState` | DataState | | | + | `AvailabilityState` | DiscreteState | available, unavailable | | + | `BatteryDiscreteLevelState` | DiscreteState | good, medium, low, critical | | + | `BatteryLevelState` | ContinuousState | | | + | `ErrorEventState` | DiscreteState | accessLimitation, internal, obstacleProtection, transportBusy, deviceNoAnswer, cancelled, deprecated, interrupted, thermalProtection, maintenanceRequired, alreadyUpToDate, notSupported, hardwareError, accessDenied, updateError, resourceAlreadyExist | | + | `ErrorState` | DataState | | | + | `ErrorsState` | DataState | | | + | `FirmwareHashState` | DataState | | | + | `FirmwareRevisionState` | DataState | | | + | `NameState` | DataState | | | + | `NewFirmwareAvailableState` | DataState | | | + | `Private10State` | DataState | | | + | `Private1State` | DataState | | | + | `Private2State` | DataState | | | + | `Private3State` | DataState | | | + | `Private4State` | DataState | | | + | `Private5State` | DataState | | | + | `Private6State` | DataState | | | + | `Private7State` | DataState | | | + | `Private8State` | DataState | | | + | `Private9State` | DataState | | | + | `RemovableState` | DataState | | | + | `SignalQualityState` | ContinuousState | | | + | `StatusState` | DiscreteState | available, unavailable | | + | `WaterConsumptionState` | ContinuousState | | | + | `WaterFlowState` | ContinuousState | | | + +??? note "WaterSensor/DynamicWaterMeasurementSensor (SENSOR) — 7 commands, 25 states" + + **Type IDs:** `295` | **Servers:** `somfy_europe` | **Controllable:** `ogp:WaterMeasurementSensor` | **Profiles:** `WaterConsumption` + + **Commands** + + | Command | Parameters | Notes | + |---------|-----------|-------| + | `executeManufacturerProcedure` | STRING; OBJECT (optional) | execute manufacturer procedure command. p1: the procedure name p2: the params associated Example: p1 = "dead_man_up" p2 = {"duration": 42} | + | `identify` | | Ask the device to identify itself by doing a slight movement or blink or beep | + | `readManufacturerData` | ARRAY | Read manufacturer data values from given names. Example: ["setting1","setting2"]. | + | `sendPrivate` | OBJECT | send a private command | + | `setName` | STRING | Change the device internal name. Name length may be subject to restrictions depending on the device and underlying protocol. | + | `update` | | Update the gateway software. The update may have to be downloaded first, which can take a while. | + | `writeManufacturerData` | OBJECT | Write manufacturer data values. Example: { "setting1": true, "setting2": 42, "setting3": "overkiz", "setting4": "Dk8PDr1WD0sfAAAAAAAAAAAAAAAAAAAA", "setting5": [ "valueA", "valueB", "valueC" ], "setting6": { "value": 15, "definition": 158 } } | + + **States** + + | State | Type | Range / Values | Notes | + |-------|------|----------------|-------| + | `ActivePartitionState` | DataState | | | + | `AvailabilityState` | DiscreteState | available, unavailable | | + | `BatteryDiscreteLevelState` | DiscreteState | good, medium, low, critical | | + | `BatteryLevelState` | ContinuousState | | | + | `ErrorState` | DataState | | | + | `ErrorsState` | DataState | | | + | `FirmwareHashState` | DataState | | | + | `FirmwareRevisionState` | DataState | | | + | `NameState` | DataState | | | + | `NewFirmwareAvailableState` | DataState | | | + | `Private10State` | DataState | | | + | `Private1State` | DataState | | | + | `Private2State` | DataState | | | + | `Private3State` | DataState | | | + | `Private4State` | DataState | | | + | `Private5State` | DataState | | | + | `Private6State` | DataState | | | + | `Private7State` | DataState | | | + | `Private8State` | DataState | | | + | `Private9State` | DataState | | | + | `RemovableState` | DataState | | | + | `SignalQualityState` | ContinuousState | | | + | `StatusState` | DiscreteState | available, unavailable | | + | `WaterConsumptionState` | ContinuousState | | | + | `WaterFlowState` | ContinuousState | | | + +??? note "WeatherSensor/DynamicWeatherStation (SENSOR) — 7 commands, 34 states" + + **Type IDs:** `279` | **Servers:** `rexel` | **Controllable:** `ogp:WeatherStation` | **Profiles:** `WindSpeedAndDirection`, `WindSpeed`, `WindDirection`, `Temperature`, `RelativeHumidity`, `RainDetector`, `Luminance` + + **Commands** + + | Command | Parameters | Notes | + |---------|-----------|-------| + | `executeManufacturerProcedure` | STRING; OBJECT (optional) | execute manufacturer procedure command. p1: the procedure name p2: the params associated Example: p1 = "dead_man_up" p2 = {"duration": 42} | + | `identify` | | Ask the device to identify itself by doing a slight movement or blink or beep | + | `readManufacturerData` | ARRAY | Read manufacturer data values from given names. Example: ["setting1","setting2"]. | + | `sendPrivate` | OBJECT | send a private command | + | `setName` | STRING | Change the device internal name. Name length may be subject to restrictions depending on the device and underlying protocol. | + | `update` | | Update the gateway software. The update may have to be downloaded first, which can take a while. | + | `writeManufacturerData` | OBJECT | Write manufacturer data values. Example: { "setting1": true, "setting2": 42, "setting3": "overkiz", "setting4": "Dk8PDr1WD0sfAAAAAAAAAAAAAAAAAAAA", "setting5": [ "valueA", "valueB", "valueC" ], "setting6": { "value": 15, "definition": 158 } } | + + **States** + + | State | Type | Range / Values | Notes | + |-------|------|----------------|-------| + | `ActivePartitionState` | DataState | | | + | `AvailabilityState` | DiscreteState | available, unavailable | | + | `BatteryDiscreteLevelState` | DiscreteState | good, medium, low, critical | | + | `BatteryLevelState` | ContinuousState | | | + | `ErrorEventState` | DiscreteState | accessLimitation, internal, obstacleProtection, transportBusy, deviceNoAnswer, cancelled, deprecated, interrupted, thermalProtection, maintenanceRequired, alreadyUpToDate, notSupported, hardwareError, accessDenied, updateError, resourceAlreadyExist | | + | `ErrorState` | DataState | | | + | `ErrorsState` | DataState | | | + | `FirmwareHashState` | DataState | | | + | `FirmwareRevisionState` | DataState | | | + | `FrostState` | DiscreteState | true, false | | + | `IceState` | DiscreteState | true, false | | + | `IlluminanceState` | ContinuousState | | | + | `LuminanceState` | ContinuousState | | | + | `NameState` | DataState | | | + | `NewFirmwareAvailableState` | DataState | | | + | `Private10State` | DataState | | | + | `Private1State` | DataState | | | + | `Private2State` | DataState | | | + | `Private3State` | DataState | | | + | `Private4State` | DataState | | | + | `Private5State` | DataState | | | + | `Private6State` | DataState | | | + | `Private7State` | DataState | | | + | `Private8State` | DataState | | | + | `Private9State` | DataState | | | + | `RainState` | DiscreteState | detected, notDetected | | + | `RelativeHumidityState` | ContinuousState | [0.0..100.0] | | + | `RemovableState` | DataState | | | + | `SignalQualityState` | ContinuousState | | | + | `SnowState` | DiscreteState | true, false | | + | `StatusState` | DiscreteState | available, unavailable | | + | `TemperatureState` | ContinuousState | [-100.0..100.0] | | + | `WindDirectionState` | ContinuousState | [0..360] | | + | `WindSpeedState` | ContinuousState | | | + +??? note "WeatherSensor/DynamicWeatherStation (SENSOR) — 7 commands, 33 states" + + **Type IDs:** `279` | **Servers:** `somfy_europe` | **Controllable:** `ogp:WeatherStation` | **Profiles:** `WindSpeedAndDirection`, `WindSpeed`, `WindDirection`, `Temperature`, `RelativeHumidity`, `RainDetector`, `Luminance` + + **Commands** + + | Command | Parameters | Notes | + |---------|-----------|-------| + | `executeManufacturerProcedure` | STRING; OBJECT (optional) | execute manufacturer procedure command. p1: the procedure name p2: the params associated Example: p1 = "dead_man_up" p2 = {"duration": 42} | + | `identify` | | Ask the device to identify itself by doing a slight movement or blink or beep | + | `readManufacturerData` | ARRAY | Read manufacturer data values from given names. Example: ["setting1","setting2"]. | + | `sendPrivate` | OBJECT | send a private command | + | `setName` | STRING | Change the device internal name. Name length may be subject to restrictions depending on the device and underlying protocol. | + | `update` | | Update the gateway software. The update may have to be downloaded first, which can take a while. | + | `writeManufacturerData` | OBJECT | Write manufacturer data values. Example: { "setting1": true, "setting2": 42, "setting3": "overkiz", "setting4": "Dk8PDr1WD0sfAAAAAAAAAAAAAAAAAAAA", "setting5": [ "valueA", "valueB", "valueC" ], "setting6": { "value": 15, "definition": 158 } } | + + **States** + + | State | Type | Range / Values | Notes | + |-------|------|----------------|-------| + | `ActivePartitionState` | DataState | | | + | `AvailabilityState` | DiscreteState | available, unavailable | | + | `BatteryDiscreteLevelState` | DiscreteState | good, medium, low, critical | | + | `BatteryLevelState` | ContinuousState | | | + | `ErrorState` | DataState | | | + | `ErrorsState` | DataState | | | + | `FirmwareHashState` | DataState | | | + | `FirmwareRevisionState` | DataState | | | + | `FrostState` | DiscreteState | true, false | | + | `IceState` | DiscreteState | true, false | | + | `IlluminanceState` | ContinuousState | | | + | `LuminanceState` | ContinuousState | | | + | `NameState` | DataState | | | + | `NewFirmwareAvailableState` | DataState | | | + | `Private10State` | DataState | | | + | `Private1State` | DataState | | | + | `Private2State` | DataState | | | + | `Private3State` | DataState | | | + | `Private4State` | DataState | | | + | `Private5State` | DataState | | | + | `Private6State` | DataState | | | + | `Private7State` | DataState | | | + | `Private8State` | DataState | | | + | `Private9State` | DataState | | | + | `RainState` | DiscreteState | detected, notDetected | | + | `RelativeHumidityState` | ContinuousState | [0.0..100.0] | | + | `RemovableState` | DataState | | | + | `SignalQualityState` | ContinuousState | | | + | `SnowState` | DiscreteState | true, false | | + | `StatusState` | DiscreteState | available, unavailable | | + | `TemperatureState` | ContinuousState | [-100.0..100.0] | | + | `WindDirectionState` | ContinuousState | [0..360] | | + | `WindSpeedState` | ContinuousState | | | + +??? note "WindSensor/DynamicWindSensor (SENSOR) — 7 commands, 26 states" + + **Type IDs:** `274` | **Servers:** `rexel` | **Controllable:** `ogp:WindSensor` | **Profiles:** `WindSpeedAndDirection`, `WindSpeed`, `WindDirection` + + **Commands** + + | Command | Parameters | Notes | + |---------|-----------|-------| + | `executeManufacturerProcedure` | STRING; OBJECT (optional) | execute manufacturer procedure command. p1: the procedure name p2: the params associated Example: p1 = "dead_man_up" p2 = {"duration": 42} | + | `identify` | | Ask the device to identify itself by doing a slight movement or blink or beep | + | `readManufacturerData` | ARRAY | Read manufacturer data values from given names. Example: ["setting1","setting2"]. | + | `sendPrivate` | OBJECT | send a private command | + | `setName` | STRING | Change the device internal name. Name length may be subject to restrictions depending on the device and underlying protocol. | + | `update` | | Update the gateway software. The update may have to be downloaded first, which can take a while. | + | `writeManufacturerData` | OBJECT | Write manufacturer data values. Example: { "setting1": true, "setting2": 42, "setting3": "overkiz", "setting4": "Dk8PDr1WD0sfAAAAAAAAAAAAAAAAAAAA", "setting5": [ "valueA", "valueB", "valueC" ], "setting6": { "value": 15, "definition": 158 } } | + + **States** + + | State | Type | Range / Values | Notes | + |-------|------|----------------|-------| + | `ActivePartitionState` | DataState | | | + | `AvailabilityState` | DiscreteState | available, unavailable | | + | `BatteryDiscreteLevelState` | DiscreteState | good, medium, low, critical | | + | `BatteryLevelState` | ContinuousState | | | + | `ErrorEventState` | DiscreteState | accessLimitation, internal, obstacleProtection, transportBusy, deviceNoAnswer, cancelled, deprecated, interrupted, thermalProtection, maintenanceRequired, alreadyUpToDate, notSupported, hardwareError, accessDenied, updateError, resourceAlreadyExist | | + | `ErrorState` | DataState | | | + | `ErrorsState` | DataState | | | + | `FirmwareHashState` | DataState | | | + | `FirmwareRevisionState` | DataState | | | + | `NameState` | DataState | | | + | `NewFirmwareAvailableState` | DataState | | | + | `Private10State` | DataState | | | + | `Private1State` | DataState | | | + | `Private2State` | DataState | | | + | `Private3State` | DataState | | | + | `Private4State` | DataState | | | + | `Private5State` | DataState | | | + | `Private6State` | DataState | | | + | `Private7State` | DataState | | | + | `Private8State` | DataState | | | + | `Private9State` | DataState | | | + | `RemovableState` | DataState | | | + | `SignalQualityState` | ContinuousState | | | + | `StatusState` | DiscreteState | available, unavailable | | + | `WindDirectionState` | ContinuousState | [0..360] | | + | `WindSpeedState` | ContinuousState | | | + +??? note "WindSensor/DynamicWindSensor (SENSOR) — 7 commands, 25 states" + + **Type IDs:** `274` | **Servers:** `somfy_europe` | **Controllable:** `ogp:WindSensor` | **Profiles:** `WindSpeedAndDirection`, `WindSpeed`, `WindDirection` + + **Commands** + + | Command | Parameters | Notes | + |---------|-----------|-------| + | `executeManufacturerProcedure` | STRING; OBJECT (optional) | execute manufacturer procedure command. p1: the procedure name p2: the params associated Example: p1 = "dead_man_up" p2 = {"duration": 42} | + | `identify` | | Ask the device to identify itself by doing a slight movement or blink or beep | + | `readManufacturerData` | ARRAY | Read manufacturer data values from given names. Example: ["setting1","setting2"]. | + | `sendPrivate` | OBJECT | send a private command | + | `setName` | STRING | Change the device internal name. Name length may be subject to restrictions depending on the device and underlying protocol. | + | `update` | | Update the gateway software. The update may have to be downloaded first, which can take a while. | + | `writeManufacturerData` | OBJECT | Write manufacturer data values. Example: { "setting1": true, "setting2": 42, "setting3": "overkiz", "setting4": "Dk8PDr1WD0sfAAAAAAAAAAAAAAAAAAAA", "setting5": [ "valueA", "valueB", "valueC" ], "setting6": { "value": 15, "definition": 158 } } | + + **States** + + | State | Type | Range / Values | Notes | + |-------|------|----------------|-------| + | `ActivePartitionState` | DataState | | | + | `AvailabilityState` | DiscreteState | available, unavailable | | + | `BatteryDiscreteLevelState` | DiscreteState | good, medium, low, critical | | + | `BatteryLevelState` | ContinuousState | | | + | `ErrorState` | DataState | | | + | `ErrorsState` | DataState | | | + | `FirmwareHashState` | DataState | | | + | `FirmwareRevisionState` | DataState | | | + | `NameState` | DataState | | | + | `NewFirmwareAvailableState` | DataState | | | + | `Private10State` | DataState | | | + | `Private1State` | DataState | | | + | `Private2State` | DataState | | | + | `Private3State` | DataState | | | + | `Private4State` | DataState | | | + | `Private5State` | DataState | | | + | `Private6State` | DataState | | | + | `Private7State` | DataState | | | + | `Private8State` | DataState | | | + | `Private9State` | DataState | | | + | `RemovableState` | DataState | | | + | `SignalQualityState` | ContinuousState | | | + | `StatusState` | DiscreteState | available, unavailable | | + | `WindDirectionState` | ContinuousState | [0..360] | | + | `WindSpeedState` | ContinuousState | | | + +??? note "Window/DynamicWindow (ACTUATOR) — 18 commands, 31 states" + + **Type IDs:** `267` | **Servers:** `rexel` | **Controllable:** `ogp:Window` | **Profiles:** `StatefulWindowLockWithOpeningStatus`, `StatefulLockWithOpeningStatus`, `StatefulOpenClose`, `OpenClose`, `StatefulCloseable`, `Closeable`, `StatefulLock`, `LockStatus`, `Lock`, `Cyclic` + + **Commands** + + | Command | Parameters | Notes | + |---------|-----------|-------| + | `close` | | Fully close the device | + | `cycle` | | Do a cycle of supported motion kinematics or modes | + | `executeManufacturerProcedure` | STRING; OBJECT (optional) | execute manufacturer procedure command. p1: the procedure name p2: the params associated Example: p1 = "dead_man_up" p2 = {"duration": 42} | + | `goToAlias` | STRING | Send alias command linked with the ID. | + | `identify` | | Ask the device to identify itself by doing a slight movement or blink or beep | + | `lock` | | Lock the device | + | `open` | | Fully open the device | + | `readManufacturerData` | ARRAY | Read manufacturer data values from given names. Example: ["setting1","setting2"]. | + | `saveAlias` | STRING | Allow to send an order for the product to save the current state of the alias. | + | `sendPrivate` | OBJECT | send a private command | + | `setAuthentication` | OBJECT | Set authentication properties of a node | + | `setClosure` | INT [0..100] | Closure level (100%=fully close, 0%=open) | + | `setName` | STRING | Change the device internal name. Name length may be subject to restrictions depending on the device and underlying protocol. | + | `setNodeDefinition` | STRING; STRING (optional); STRING (optional) | Fill the node definition (some transitions can be forbidden) p1: type (mandatory) p2: subType (mandatory if definition is set) p3: definition | + | `stop` | | Stop the current actuator behavior (movement, sound or timer) | + | `unlock` | | Unlock the device | + | `update` | | Update the gateway software. The update may have to be downloaded first, which can take a while. | + | `writeManufacturerData` | OBJECT | Write manufacturer data values. Example: { "setting1": true, "setting2": 42, "setting3": "overkiz", "setting4": "Dk8PDr1WD0sfAAAAAAAAAAAAAAAAAAAA", "setting5": [ "valueA", "valueB", "valueC" ], "setting6": { "value": 15, "definition": 158 } } | + + **States** + + | State | Type | Range / Values | Notes | + |-------|------|----------------|-------| + | `ActivePartitionState` | DataState | | | + | `AuthenticationExpiredState` | DataState | | | + | `AvailabilityState` | DiscreteState | available, unavailable | | + | `BatteryDiscreteLevelState` | DiscreteState | good, medium, low, critical | | + | `BatteryLevelState` | ContinuousState | | | + | `ClosureState` | ContinuousState | [0..100] | | + | `ErrorEventState` | DiscreteState | accessLimitation, internal, obstacleProtection, transportBusy, deviceNoAnswer, cancelled, deprecated, interrupted, thermalProtection, maintenanceRequired, alreadyUpToDate, notSupported, hardwareError, accessDenied, updateError, resourceAlreadyExist | | + | `ErrorState` | DataState | | | + | `ErrorsState` | DataState | | | + | `FirmwareHashState` | DataState | | | + | `FirmwareRevisionState` | DataState | | | + | `LockedUnlockedState` | DiscreteState | locked, unlocked | | + | `NameState` | DataState | | | + | `NewFirmwareAvailableState` | DataState | | | + | `OpenClosedState` | DiscreteState | open, closed | | + | `Private10State` | DataState | | | + | `Private1State` | DataState | | | + | `Private2State` | DataState | | | + | `Private3State` | DataState | | | + | `Private4State` | DataState | | | + | `Private5State` | DataState | | | + | `Private6State` | DataState | | | + | `Private7State` | DataState | | | + | `Private8State` | DataState | | | + | `Private9State` | DataState | | | + | `ReachedAliasesState` | DataState | | | + | `RemovableState` | DataState | | | + | `SSIDState` | DataState | | | + | `SignalQualityState` | ContinuousState | | | + | `StatusState` | DiscreteState | available, unavailable | | + | `UnavailableFeaturesState` | DataState | | | + +??? note "Window/DynamicWindow (ACTUATOR) — 18 commands, 30 states" + + **Type IDs:** `267` | **Servers:** `somfy_europe` | **Controllable:** `ogp:Window` | **Profiles:** `StatefulWindowLockWithOpeningStatus`, `StatefulLockWithOpeningStatus`, `StatefulOpenClose`, `OpenClose`, `StatefulCloseable`, `Closeable`, `StatefulLock`, `LockStatus`, `Lock`, `Cyclic` + + **Commands** + + | Command | Parameters | Notes | + |---------|-----------|-------| + | `close` | | Fully close the device | + | `cycle` | | Do a cycle of supported motion kinematics or modes | + | `executeManufacturerProcedure` | STRING; OBJECT (optional) | execute manufacturer procedure command. p1: the procedure name p2: the params associated Example: p1 = "dead_man_up" p2 = {"duration": 42} | + | `goToAlias` | STRING | Send alias command linked with the ID. | + | `identify` | | Ask the device to identify itself by doing a slight movement or blink or beep | + | `lock` | | Lock the device | + | `open` | | Fully open the device | + | `readManufacturerData` | ARRAY | Read manufacturer data values from given names. Example: ["setting1","setting2"]. | + | `saveAlias` | STRING | Allow to send an order for the product to save the current state of the alias. | + | `sendPrivate` | OBJECT | send a private command | + | `setAuthentication` | OBJECT | Set authentication properties of a node | + | `setClosure` | INT [0..100] | Closure level (100%=fully close, 0%=open) | + | `setName` | STRING | Change the device internal name. Name length may be subject to restrictions depending on the device and underlying protocol. | + | `setNodeDefinition` | STRING; STRING (optional); STRING (optional) | Fill the node definition (some transitions can be forbidden) p1: type (mandatory) p2: subType (mandatory if definition is set) p3: definition | + | `stop` | | Stop the current actuator behavior (movement, sound or timer) | + | `unlock` | | Unlock the device | + | `update` | | Update the gateway software. The update may have to be downloaded first, which can take a while. | + | `writeManufacturerData` | OBJECT | Write manufacturer data values. Example: { "setting1": true, "setting2": 42, "setting3": "overkiz", "setting4": "Dk8PDr1WD0sfAAAAAAAAAAAAAAAAAAAA", "setting5": [ "valueA", "valueB", "valueC" ], "setting6": { "value": 15, "definition": 158 } } | + + **States** + + | State | Type | Range / Values | Notes | + |-------|------|----------------|-------| + | `ActivePartitionState` | DataState | | | + | `AuthenticationExpiredState` | DataState | | | + | `AvailabilityState` | DiscreteState | available, unavailable | | + | `BatteryDiscreteLevelState` | DiscreteState | good, medium, low, critical | | + | `BatteryLevelState` | ContinuousState | | | + | `ClosureState` | ContinuousState | [0..100] | | + | `ErrorState` | DataState | | | + | `ErrorsState` | DataState | | | + | `FirmwareHashState` | DataState | | | + | `FirmwareRevisionState` | DataState | | | + | `LockedUnlockedState` | DiscreteState | locked, unlocked | | + | `NameState` | DataState | | | + | `NewFirmwareAvailableState` | DataState | | | + | `OpenClosedState` | DiscreteState | open, closed | | + | `Private10State` | DataState | | | + | `Private1State` | DataState | | | + | `Private2State` | DataState | | | + | `Private3State` | DataState | | | + | `Private4State` | DataState | | | + | `Private5State` | DataState | | | + | `Private6State` | DataState | | | + | `Private7State` | DataState | | | + | `Private8State` | DataState | | | + | `Private9State` | DataState | | | + | `ReachedAliasesState` | DataState | | | + | `RemovableState` | DataState | | | + | `SSIDState` | DataState | | | + | `SignalQualityState` | ContinuousState | | | + | `StatusState` | DiscreteState | available, unavailable | | + | `UnavailableFeaturesState` | DataState | | | + +??? note "unknown/Invalid (ACTUATOR) — 0 commands, 0 states" + + **Type IDs:** `0` | **Servers:** `rexel`, `somfy_europe` | **Controllable:** `ogp:Invalid` | **Profiles:** `Specific` + +??? note "waterLeakSensor/DynamicWaterLeakSensor (SENSOR) — 7 commands, 25 states" + + **Type IDs:** `306` | **Servers:** `somfy_europe` | **Controllable:** `ogp:WaterLeakSensor` | **Profiles:** `waterLeakSensor` + + **Commands** + + | Command | Parameters | Notes | + |---------|-----------|-------| + | `executeManufacturerProcedure` | STRING; OBJECT (optional) | execute manufacturer procedure command. p1: the procedure name p2: the params associated Example: p1 = "dead_man_up" p2 = {"duration": 42} | + | `identify` | | Ask the device to identify itself by doing a slight movement or blink or beep | + | `readManufacturerData` | ARRAY | Read manufacturer data values from given names. Example: ["setting1","setting2"]. | + | `sendPrivate` | OBJECT | send a private command | + | `setName` | STRING | Change the device internal name. Name length may be subject to restrictions depending on the device and underlying protocol. | + | `update` | | Update the gateway software. The update may have to be downloaded first, which can take a while. | + | `writeManufacturerData` | OBJECT | Write manufacturer data values. Example: { "setting1": true, "setting2": 42, "setting3": "overkiz", "setting4": "Dk8PDr1WD0sfAAAAAAAAAAAAAAAAAAAA", "setting5": [ "valueA", "valueB", "valueC" ], "setting6": { "value": 15, "definition": 158 } } | + + **States** + + | State | Type | Range / Values | Notes | + |-------|------|----------------|-------| + | `ActivePartitionState` | DataState | | | + | `AvailabilityState` | DiscreteState | available, unavailable | | + | `BatteryDiscreteLevelState` | DiscreteState | good, medium, low, critical | | + | `BatteryLevelState` | ContinuousState | | | + | `ErrorState` | DataState | | | + | `ErrorsState` | DataState | | | + | `FirmwareHashState` | DataState | | | + | `FirmwareRevisionState` | DataState | | | + | `NameState` | DataState | | | + | `NewFirmwareAvailableState` | DataState | | | + | `Private10State` | DataState | | | + | `Private1State` | DataState | | | + | `Private2State` | DataState | | | + | `Private3State` | DataState | | | + | `Private4State` | DataState | | | + | `Private5State` | DataState | | | + | `Private6State` | DataState | | | + | `Private7State` | DataState | | | + | `Private8State` | DataState | | | + | `Private9State` | DataState | | | + | `RemovableState` | DataState | | | + | `SignalQualityState` | ContinuousState | | | + | `StatusState` | DiscreteState | available, unavailable | | + | `WaterLeakEventState` | DiscreteState | false, true | | + | `WaterLeakState` | DiscreteState | detected, notDetected | | + + +## OGP + +92 device types. + +??? note "AirSensor/DynamicAirSensor (SENSOR) — 7 commands, 26 states" + + **Type IDs:** `304` | **Servers:** `rexel` | **Controllable:** `ogp:AirSensor` | **Profiles:** `CO2Concentration` + + **Commands** + + | Command | Parameters | Notes | + |---------|-----------|-------| + | `executeManufacturerProcedure` | STRING; OBJECT (optional) | execute manufacturer procedure command. p1: the procedure name p2: the params associated Example: p1 = "dead_man_up" p2 = {"duration": 42} | + | `identify` | | Ask the device to identify itself by doing a slight movement or blink or beep | + | `readManufacturerData` | ARRAY | Read manufacturer data values from given names. Example: ["setting1","setting2"]. | + | `sendPrivate` | OBJECT | send a private command | + | `setName` | STRING | Change the device internal name. Name length may be subject to restrictions depending on the device and underlying protocol. | + | `update` | | Update the gateway software. The update may have to be downloaded first, which can take a while. | + | `writeManufacturerData` | OBJECT | Write manufacturer data values. Example: { "setting1": true, "setting2": 42, "setting3": "overkiz", "setting4": "Dk8PDr1WD0sfAAAAAAAAAAAAAAAAAAAA", "setting5": [ "valueA", "valueB", "valueC" ], "setting6": { "value": 15, "definition": 158 } } | + + **States** + + | State | Type | Range / Values | Notes | + |-------|------|----------------|-------| + | `ActivePartitionState` | DataState | | | + | `AirQualityIndexLevelState` | DiscreteState | good, moderate, unhealthyForSensitiveGroups, unhealthy, veryUnhealthy, hazardous | | + | `AvailabilityState` | DiscreteState | available, unavailable | | + | `BatteryDiscreteLevelState` | DiscreteState | good, medium, low, critical | | + | `BatteryLevelState` | ContinuousState | | | + | `CO2ConcentrationState` | ContinuousState | | | + | `ErrorEventState` | DiscreteState | accessLimitation, internal, obstacleProtection, transportBusy, deviceNoAnswer, cancelled, deprecated, interrupted, thermalProtection, maintenanceRequired, alreadyUpToDate, notSupported, hardwareError, accessDenied, updateError, resourceAlreadyExist | | + | `ErrorState` | DataState | | | + | `ErrorsState` | DataState | | | + | `FirmwareHashState` | DataState | | | + | `FirmwareRevisionState` | DataState | | | + | `NameState` | DataState | | | + | `NewFirmwareAvailableState` | DataState | | | + | `Private10State` | DataState | | | + | `Private1State` | DataState | | | + | `Private2State` | DataState | | | + | `Private3State` | DataState | | | + | `Private4State` | DataState | | | + | `Private5State` | DataState | | | + | `Private6State` | DataState | | | + | `Private7State` | DataState | | | + | `Private8State` | DataState | | | + | `Private9State` | DataState | | | + | `RemovableState` | DataState | | | + | `SignalQualityState` | ContinuousState | | | + | `StatusState` | DiscreteState | available, unavailable | | + +??? note "AirSensor/DynamicAirSensor (SENSOR) — 7 commands, 25 states" + + **Type IDs:** `304` | **Servers:** `somfy_europe` | **Controllable:** `ogp:AirSensor` | **Profiles:** `CO2Concentration` + + **Commands** + + | Command | Parameters | Notes | + |---------|-----------|-------| + | `executeManufacturerProcedure` | STRING; OBJECT (optional) | execute manufacturer procedure command. p1: the procedure name p2: the params associated Example: p1 = "dead_man_up" p2 = {"duration": 42} | + | `identify` | | Ask the device to identify itself by doing a slight movement or blink or beep | + | `readManufacturerData` | ARRAY | Read manufacturer data values from given names. Example: ["setting1","setting2"]. | + | `sendPrivate` | OBJECT | send a private command | + | `setName` | STRING | Change the device internal name. Name length may be subject to restrictions depending on the device and underlying protocol. | + | `update` | | Update the gateway software. The update may have to be downloaded first, which can take a while. | + | `writeManufacturerData` | OBJECT | Write manufacturer data values. Example: { "setting1": true, "setting2": 42, "setting3": "overkiz", "setting4": "Dk8PDr1WD0sfAAAAAAAAAAAAAAAAAAAA", "setting5": [ "valueA", "valueB", "valueC" ], "setting6": { "value": 15, "definition": 158 } } | + + **States** + + | State | Type | Range / Values | Notes | + |-------|------|----------------|-------| + | `ActivePartitionState` | DataState | | | + | `AirQualityIndexLevelState` | DiscreteState | good, moderate, unhealthyForSensitiveGroups, unhealthy, veryUnhealthy, hazardous | | + | `AvailabilityState` | DiscreteState | available, unavailable | | + | `BatteryDiscreteLevelState` | DiscreteState | good, medium, low, critical | | + | `BatteryLevelState` | ContinuousState | | | + | `CO2ConcentrationState` | ContinuousState | | | + | `ErrorState` | DataState | | | + | `ErrorsState` | DataState | | | + | `FirmwareHashState` | DataState | | | + | `FirmwareRevisionState` | DataState | | | + | `NameState` | DataState | | | + | `NewFirmwareAvailableState` | DataState | | | + | `Private10State` | DataState | | | + | `Private1State` | DataState | | | + | `Private2State` | DataState | | | + | `Private3State` | DataState | | | + | `Private4State` | DataState | | | + | `Private5State` | DataState | | | + | `Private6State` | DataState | | | + | `Private7State` | DataState | | | + | `Private8State` | DataState | | | + | `Private9State` | DataState | | | + | `RemovableState` | DataState | | | + | `SignalQualityState` | ContinuousState | | | + | `StatusState` | DiscreteState | available, unavailable | | + +??? note "Alarm/DynamicAlarm (ACTUATOR) — 13 commands, 33 states" + + **Type IDs:** `282` | **Servers:** `rexel` | **Controllable:** `ogp:Alarm` | **Profiles:** `SmokeDetector`, `IntrusionDetector`, `StatefulAlarm`, `Alarm` + + **Commands** + + | Command | Parameters | Notes | + |---------|-----------|-------| + | `addGroupMember` | STRING | Add member to the group p1 : Id of the member to add to the group. | + | `arm` | | Arm the system | + | `disarm` | | Disarm the system | + | `executeManufacturerProcedure` | STRING; OBJECT (optional) | execute manufacturer procedure command. p1: the procedure name p2: the params associated Example: p1 = "dead_man_up" p2 = {"duration": 42} | + | `identify` | | Ask the device to identify itself by doing a slight movement or blink or beep | + | `readManufacturerData` | ARRAY | Read manufacturer data values from given names. Example: ["setting1","setting2"]. | + | `removeGroupMember` | STRING | Remove a member of the group. p1 : Id of the member to remove to the group. | + | `sendPrivate` | OBJECT | send a private command | + | `setMode` | STRING | Set the active mode. | + | `setName` | STRING | Change the device internal name. Name length may be subject to restrictions depending on the device and underlying protocol. | + | `setNodeDefinition` | STRING; STRING (optional); STRING (optional) | Fill the node definition (some transitions can be forbidden) p1: type (mandatory) p2: subType (mandatory if definition is set) p3: definition | + | `update` | | Update the gateway software. The update may have to be downloaded first, which can take a while. | + | `writeManufacturerData` | OBJECT | Write manufacturer data values. Example: { "setting1": true, "setting2": 42, "setting3": "overkiz", "setting4": "Dk8PDr1WD0sfAAAAAAAAAAAAAAAAAAAA", "setting5": [ "valueA", "valueB", "valueC" ], "setting6": { "value": 15, "definition": 158 } } | + + **States** + + | State | Type | Range / Values | Notes | + |-------|------|----------------|-------| + | `ActivePartitionState` | DataState | | | + | `ArmedState` | DataState | | | + | `AvailabilityState` | DiscreteState | available, unavailable | | + | `AvailableModesState` | DataState | | | + | `BatteryDiscreteLevelState` | DiscreteState | good, medium, low, critical | | + | `BatteryLevelState` | ContinuousState | | | + | `ErrorEventState` | DiscreteState | | | + | `ErrorState` | DataState | | | + | `ErrorsState` | DataState | | | + | `FirmwareHashState` | DataState | | | + | `FirmwareRevisionState` | DataState | | | + | `GroupMembersState` | DataState | | | + | `IntrusionDetectionEventState` | DiscreteState | | | + | `IntrusionState` | DiscreteState | detected, notDetected | | + | `ModeState` | DataState | | | + | `NameState` | DataState | | | + | `NewFirmwareAvailableState` | DataState | | | + | `PanicEventState` | DataState | | | + | `Private10State` | DataState | | | + | `Private1State` | DataState | | | + | `Private2State` | DataState | | | + | `Private3State` | DataState | | | + | `Private4State` | DataState | | | + | `Private5State` | DataState | | | + | `Private6State` | DataState | | | + | `Private7State` | DataState | | | + | `Private8State` | DataState | | | + | `Private9State` | DataState | | | + | `RemovableState` | DataState | | | + | `SignalQualityState` | ContinuousState | | | + | `SmokeDetectionEventState` | DiscreteState | | | + | `SmokeState` | DiscreteState | detected, notDetected | | + | `StatusState` | DiscreteState | available, unavailable | | + +??? note "Alarm/DynamicAlarm (ACTUATOR) — 13 commands, 34 states" + + **Type IDs:** `282` | **Servers:** `somfy_europe` | **Controllable:** `ogp:Alarm` | **Profiles:** `SmokeDetector`, `waterLeakSensor`, `IntrusionDetector`, `StatefulAlarm`, `Alarm` + + **Commands** + + | Command | Parameters | Notes | + |---------|-----------|-------| + | `addGroupMember` | STRING | Add member to the group p1 : Id of the member to add to the group. | + | `arm` | | Arm the system | + | `disarm` | | Disarm the system | + | `executeManufacturerProcedure` | STRING; OBJECT (optional) | execute manufacturer procedure command. p1: the procedure name p2: the params associated Example: p1 = "dead_man_up" p2 = {"duration": 42} | + | `identify` | | Ask the device to identify itself by doing a slight movement or blink or beep | + | `readManufacturerData` | ARRAY | Read manufacturer data values from given names. Example: ["setting1","setting2"]. | + | `removeGroupMember` | STRING | Remove a member of the group. p1 : Id of the member to remove to the group. | + | `sendPrivate` | OBJECT | send a private command | + | `setMode` | STRING | Set the active mode. | + | `setName` | STRING | Change the device internal name. Name length may be subject to restrictions depending on the device and underlying protocol. | + | `setNodeDefinition` | STRING; STRING (optional); STRING (optional) | Fill the node definition (some transitions can be forbidden) p1: type (mandatory) p2: subType (mandatory if definition is set) p3: definition | + | `update` | | Update the gateway software. The update may have to be downloaded first, which can take a while. | + | `writeManufacturerData` | OBJECT | Write manufacturer data values. Example: { "setting1": true, "setting2": 42, "setting3": "overkiz", "setting4": "Dk8PDr1WD0sfAAAAAAAAAAAAAAAAAAAA", "setting5": [ "valueA", "valueB", "valueC" ], "setting6": { "value": 15, "definition": 158 } } | + + **States** + + | State | Type | Range / Values | Notes | + |-------|------|----------------|-------| + | `ActivePartitionState` | DataState | | | + | `ArmedState` | DataState | | | + | `AvailabilityState` | DiscreteState | available, unavailable | | + | `AvailableModesState` | DataState | | | + | `BatteryDiscreteLevelState` | DiscreteState | good, medium, low, critical | | + | `BatteryLevelState` | ContinuousState | | | + | `ErrorState` | DataState | | | + | `ErrorsState` | DataState | | | + | `FirmwareHashState` | DataState | | | + | `FirmwareRevisionState` | DataState | | | + | `GroupMembersState` | DataState | | | + | `IntrusionEventState` | DiscreteState | false, true | | + | `IntrusionState` | DiscreteState | detected, notDetected | | + | `ModeState` | DataState | | | + | `NameState` | DataState | | | + | `NewFirmwareAvailableState` | DataState | | | + | `PanicEventState` | DataState | | | + | `Private10State` | DataState | | | + | `Private1State` | DataState | | | + | `Private2State` | DataState | | | + | `Private3State` | DataState | | | + | `Private4State` | DataState | | | + | `Private5State` | DataState | | | + | `Private6State` | DataState | | | + | `Private7State` | DataState | | | + | `Private8State` | DataState | | | + | `Private9State` | DataState | | | + | `RemovableState` | DataState | | | + | `SignalQualityState` | ContinuousState | | | + | `SmokeEventState` | DiscreteState | false, true | | + | `SmokeState` | DiscreteState | detected, notDetected | | + | `StatusState` | DiscreteState | available, unavailable | | + | `WaterLeakEventState` | DiscreteState | false, true | | + | `WaterLeakState` | DiscreteState | detected, notDetected | | + +??? note "Awning/DynamicAwning (ACTUATOR) — 17 commands, 30 states" + + **Type IDs:** `277` | **Servers:** `rexel` | **Controllable:** `ogp:Awning` | **Profiles:** `StatefulDeployableAwning`, `StatefulDeployable`, `Deployable`, `StatefulDeployUndeploy`, `DeployUndeploy` + + **Commands** + + | Command | Parameters | Notes | + |---------|-----------|-------| + | `deploy` | | Fully deploy the device | + | `executeManufacturerProcedure` | STRING; OBJECT (optional) | execute manufacturer procedure command. p1: the procedure name p2: the params associated Example: p1 = "dead_man_up" p2 = {"duration": 42} | + | `goToAlias` | STRING | Send alias command linked with the ID. | + | `identify` | | Ask the device to identify itself by doing a slight movement or blink or beep | + | `readManufacturerData` | ARRAY | Read manufacturer data values from given names. Example: ["setting1","setting2"]. | + | `rollOut` | | Roll out the device (unfold - deploy - less compact position) | + | `rollUp` | | Roll up the device (fold - most compact position) | + | `saveAlias` | STRING | Allow to send an order for the product to save the current state of the alias. | + | `sendPrivate` | OBJECT | send a private command | + | `setDeployment` | INT [0..100] | Device deployment level (100%=fully deployed, 0%=fully undeployed) | + | `setName` | STRING | Change the device internal name. Name length may be subject to restrictions depending on the device and underlying protocol. | + | `setNodeDefinition` | STRING; STRING (optional); STRING (optional) | Fill the node definition (some transitions can be forbidden) p1: type (mandatory) p2: subType (mandatory if definition is set) p3: definition | + | `setRollingOut` | INT [0..100] | set the device rolling out percentage | + | `stop` | | Stop the current actuator behavior (movement, sound or timer) | + | `undeploy` | | Fully undeploy the device | + | `update` | | Update the gateway software. The update may have to be downloaded first, which can take a while. | + | `writeManufacturerData` | OBJECT | Write manufacturer data values. Example: { "setting1": true, "setting2": 42, "setting3": "overkiz", "setting4": "Dk8PDr1WD0sfAAAAAAAAAAAAAAAAAAAA", "setting5": [ "valueA", "valueB", "valueC" ], "setting6": { "value": 15, "definition": 158 } } | + + **States** + + | State | Type | Range / Values | Notes | + |-------|------|----------------|-------| + | `ActivePartitionState` | DataState | | | + | `AvailabilityState` | DiscreteState | available, unavailable | | + | `BatteryDiscreteLevelState` | DiscreteState | good, medium, low, critical | | + | `BatteryLevelState` | ContinuousState | | | + | `DeployedUndeployedState` | DiscreteState | deployed, undeployed | | + | `DeploymentState` | ContinuousState | [0..100] | | + | `ErrorEventState` | DiscreteState | accessLimitation, internal, obstacleProtection, transportBusy, deviceNoAnswer, cancelled, deprecated, interrupted, thermalProtection, maintenanceRequired, alreadyUpToDate, notSupported, hardwareError, accessDenied, updateError, resourceAlreadyExist | | + | `ErrorState` | DataState | | | + | `ErrorsState` | DataState | | | + | `FirmwareHashState` | DataState | | | + | `FirmwareRevisionState` | DataState | | | + | `NameState` | DataState | | | + | `NewFirmwareAvailableState` | DataState | | | + | `Private10State` | DataState | | | + | `Private1State` | DataState | | | + | `Private2State` | DataState | | | + | `Private3State` | DataState | | | + | `Private4State` | DataState | | | + | `Private5State` | DataState | | | + | `Private6State` | DataState | | | + | `Private7State` | DataState | | | + | `Private8State` | DataState | | | + | `Private9State` | DataState | | | + | `ReachedAliasesState` | DataState | | | + | `RemovableState` | DataState | | | + | `RolledUpState` | DataState | | | + | `RollingOutState` | ContinuousState | | | + | `SignalQualityState` | ContinuousState | | | + | `StatusState` | DiscreteState | available, unavailable | | + | `UnavailableFeaturesState` | DataState | | | + +??? note "Awning/DynamicAwning (ACTUATOR) — 17 commands, 29 states" + + **Type IDs:** `277` | **Servers:** `somfy_europe` | **Controllable:** `ogp:Awning` | **Profiles:** `StatefulDeployableAwning`, `StatefulDeployable`, `Deployable`, `StatefulDeployUndeploy`, `DeployUndeploy` + + **Commands** + + | Command | Parameters | Notes | + |---------|-----------|-------| + | `deploy` | | Fully deploy the device | + | `executeManufacturerProcedure` | STRING; OBJECT (optional) | execute manufacturer procedure command. p1: the procedure name p2: the params associated Example: p1 = "dead_man_up" p2 = {"duration": 42} | + | `goToAlias` | STRING | Send alias command linked with the ID. | + | `identify` | | Ask the device to identify itself by doing a slight movement or blink or beep | + | `readManufacturerData` | ARRAY | Read manufacturer data values from given names. Example: ["setting1","setting2"]. | + | `rollOut` | | Roll out the device (unfold - deploy - less compact position) | + | `rollUp` | | Roll up the device (fold - most compact position) | + | `saveAlias` | STRING | Allow to send an order for the product to save the current state of the alias. | + | `sendPrivate` | OBJECT | send a private command | + | `setDeployment` | INT [0..100] | Device deployment level (100%=fully deployed, 0%=fully undeployed) | + | `setName` | STRING | Change the device internal name. Name length may be subject to restrictions depending on the device and underlying protocol. | + | `setNodeDefinition` | STRING; STRING (optional); STRING (optional) | Fill the node definition (some transitions can be forbidden) p1: type (mandatory) p2: subType (mandatory if definition is set) p3: definition | + | `setRollingOut` | INT [0..100] | set the device rolling out percentage | + | `stop` | | Stop the current actuator behavior (movement, sound or timer) | + | `undeploy` | | Fully undeploy the device | + | `update` | | Update the gateway software. The update may have to be downloaded first, which can take a while. | + | `writeManufacturerData` | OBJECT | Write manufacturer data values. Example: { "setting1": true, "setting2": 42, "setting3": "overkiz", "setting4": "Dk8PDr1WD0sfAAAAAAAAAAAAAAAAAAAA", "setting5": [ "valueA", "valueB", "valueC" ], "setting6": { "value": 15, "definition": 158 } } | + + **States** + + | State | Type | Range / Values | Notes | + |-------|------|----------------|-------| + | `ActivePartitionState` | DataState | | | + | `AvailabilityState` | DiscreteState | available, unavailable | | + | `BatteryDiscreteLevelState` | DiscreteState | good, medium, low, critical | | + | `BatteryLevelState` | ContinuousState | | | + | `DeployedUndeployedState` | DiscreteState | deployed, undeployed | | + | `DeploymentState` | ContinuousState | [0..100] | | + | `ErrorState` | DataState | | | + | `ErrorsState` | DataState | | | + | `FirmwareHashState` | DataState | | | + | `FirmwareRevisionState` | DataState | | | + | `NameState` | DataState | | | + | `NewFirmwareAvailableState` | DataState | | | + | `Private10State` | DataState | | | + | `Private1State` | DataState | | | + | `Private2State` | DataState | | | + | `Private3State` | DataState | | | + | `Private4State` | DataState | | | + | `Private5State` | DataState | | | + | `Private6State` | DataState | | | + | `Private7State` | DataState | | | + | `Private8State` | DataState | | | + | `Private9State` | DataState | | | + | `ReachedAliasesState` | DataState | | | + | `RemovableState` | DataState | | | + | `RolledUpState` | DataState | | | + | `RollingOutState` | ContinuousState | | | + | `SignalQualityState` | ContinuousState | | | + | `StatusState` | DiscreteState | available, unavailable | | + | `UnavailableFeaturesState` | DataState | | | + +??? note "CarbonDioxideSensor/DynamicCarbonDioxideSensor (SENSOR) — 7 commands, 25 states" + + **Type IDs:** `291` | **Servers:** `rexel` | **Controllable:** `ogp:CarbonDioxideSensor` | **Profiles:** `CO2Concentration` + + **Commands** + + | Command | Parameters | Notes | + |---------|-----------|-------| + | `executeManufacturerProcedure` | STRING; OBJECT (optional) | execute manufacturer procedure command. p1: the procedure name p2: the params associated Example: p1 = "dead_man_up" p2 = {"duration": 42} | + | `identify` | | Ask the device to identify itself by doing a slight movement or blink or beep | + | `readManufacturerData` | ARRAY | Read manufacturer data values from given names. Example: ["setting1","setting2"]. | + | `sendPrivate` | OBJECT | send a private command | + | `setName` | STRING | Change the device internal name. Name length may be subject to restrictions depending on the device and underlying protocol. | + | `update` | | Update the gateway software. The update may have to be downloaded first, which can take a while. | + | `writeManufacturerData` | OBJECT | Write manufacturer data values. Example: { "setting1": true, "setting2": 42, "setting3": "overkiz", "setting4": "Dk8PDr1WD0sfAAAAAAAAAAAAAAAAAAAA", "setting5": [ "valueA", "valueB", "valueC" ], "setting6": { "value": 15, "definition": 158 } } | + + **States** + + | State | Type | Range / Values | Notes | + |-------|------|----------------|-------| + | `ActivePartitionState` | DataState | | | + | `AvailabilityState` | DiscreteState | available, unavailable | | + | `BatteryDiscreteLevelState` | DiscreteState | good, medium, low, critical | | + | `BatteryLevelState` | ContinuousState | | | + | `CO2ConcentrationState` | ContinuousState | | | + | `ErrorEventState` | DiscreteState | accessLimitation, internal, obstacleProtection, transportBusy, deviceNoAnswer, cancelled, deprecated, interrupted, thermalProtection, maintenanceRequired, alreadyUpToDate, notSupported, hardwareError, accessDenied, updateError, resourceAlreadyExist | | + | `ErrorState` | DataState | | | + | `ErrorsState` | DataState | | | + | `FirmwareHashState` | DataState | | | + | `FirmwareRevisionState` | DataState | | | + | `NameState` | DataState | | | + | `NewFirmwareAvailableState` | DataState | | | + | `Private10State` | DataState | | | + | `Private1State` | DataState | | | + | `Private2State` | DataState | | | + | `Private3State` | DataState | | | + | `Private4State` | DataState | | | + | `Private5State` | DataState | | | + | `Private6State` | DataState | | | + | `Private7State` | DataState | | | + | `Private8State` | DataState | | | + | `Private9State` | DataState | | | + | `RemovableState` | DataState | | | + | `SignalQualityState` | ContinuousState | | | + | `StatusState` | DiscreteState | available, unavailable | | + +??? note "CarbonDioxideSensor/DynamicCarbonDioxideSensor (SENSOR) — 7 commands, 24 states" + + **Type IDs:** `291` | **Servers:** `somfy_europe` | **Controllable:** `ogp:CarbonDioxideSensor` | **Profiles:** `CO2Concentration` + + **Commands** + + | Command | Parameters | Notes | + |---------|-----------|-------| + | `executeManufacturerProcedure` | STRING; OBJECT (optional) | execute manufacturer procedure command. p1: the procedure name p2: the params associated Example: p1 = "dead_man_up" p2 = {"duration": 42} | + | `identify` | | Ask the device to identify itself by doing a slight movement or blink or beep | + | `readManufacturerData` | ARRAY | Read manufacturer data values from given names. Example: ["setting1","setting2"]. | + | `sendPrivate` | OBJECT | send a private command | + | `setName` | STRING | Change the device internal name. Name length may be subject to restrictions depending on the device and underlying protocol. | + | `update` | | Update the gateway software. The update may have to be downloaded first, which can take a while. | + | `writeManufacturerData` | OBJECT | Write manufacturer data values. Example: { "setting1": true, "setting2": 42, "setting3": "overkiz", "setting4": "Dk8PDr1WD0sfAAAAAAAAAAAAAAAAAAAA", "setting5": [ "valueA", "valueB", "valueC" ], "setting6": { "value": 15, "definition": 158 } } | + + **States** + + | State | Type | Range / Values | Notes | + |-------|------|----------------|-------| + | `ActivePartitionState` | DataState | | | + | `AvailabilityState` | DiscreteState | available, unavailable | | + | `BatteryDiscreteLevelState` | DiscreteState | good, medium, low, critical | | + | `BatteryLevelState` | ContinuousState | | | + | `CO2ConcentrationState` | ContinuousState | | | + | `ErrorState` | DataState | | | + | `ErrorsState` | DataState | | | + | `FirmwareHashState` | DataState | | | + | `FirmwareRevisionState` | DataState | | | + | `NameState` | DataState | | | + | `NewFirmwareAvailableState` | DataState | | | + | `Private10State` | DataState | | | + | `Private1State` | DataState | | | + | `Private2State` | DataState | | | + | `Private3State` | DataState | | | + | `Private4State` | DataState | | | + | `Private5State` | DataState | | | + | `Private6State` | DataState | | | + | `Private7State` | DataState | | | + | `Private8State` | DataState | | | + | `Private9State` | DataState | | | + | `RemovableState` | DataState | | | + | `SignalQualityState` | ContinuousState | | | + | `StatusState` | DiscreteState | available, unavailable | | + +??? note "CircuitBreaker/DynamicCircuitBreaker (ACTUATOR) — 13 commands, 25 states" + + **Type IDs:** `286` | **Servers:** `rexel` | **Controllable:** `ogp:CircuitBreaker` | **Profiles:** `StatefulSwitchablePlug`, `StatefulSwitchable`, `Switchable`, `Cyclic` + + **Commands** + + | Command | Parameters | Notes | + |---------|-----------|-------| + | `cycle` | | Do a cycle of supported motion kinematics or modes | + | `executeManufacturerProcedure` | STRING; OBJECT (optional) | execute manufacturer procedure command. p1: the procedure name p2: the params associated Example: p1 = "dead_man_up" p2 = {"duration": 42} | + | `identify` | | Ask the device to identify itself by doing a slight movement or blink or beep | + | `off` | | Turn off the device | + | `on` | | Turn on the device | + | `readManufacturerData` | ARRAY | Read manufacturer data values from given names. Example: ["setting1","setting2"]. | + | `sendPrivate` | OBJECT | send a private command | + | `setName` | STRING | Change the device internal name. Name length may be subject to restrictions depending on the device and underlying protocol. | + | `setNodeDefinition` | STRING; STRING (optional); STRING (optional) | Fill the node definition (some transitions can be forbidden) p1: type (mandatory) p2: subType (mandatory if definition is set) p3: definition | + | `setOnOff` | STRING: off, on | Turn the device on or off | + | `toggle` | | Toggle on/off status | + | `update` | | Update the gateway software. The update may have to be downloaded first, which can take a while. | + | `writeManufacturerData` | OBJECT | Write manufacturer data values. Example: { "setting1": true, "setting2": 42, "setting3": "overkiz", "setting4": "Dk8PDr1WD0sfAAAAAAAAAAAAAAAAAAAA", "setting5": [ "valueA", "valueB", "valueC" ], "setting6": { "value": 15, "definition": 158 } } | + + **States** + + | State | Type | Range / Values | Notes | + |-------|------|----------------|-------| + | `ActivePartitionState` | DataState | | | + | `AvailabilityState` | DiscreteState | available, unavailable | | + | `BatteryDiscreteLevelState` | DiscreteState | good, medium, low, critical | | + | `BatteryLevelState` | ContinuousState | | | + | `ErrorEventState` | DiscreteState | accessLimitation, internal, obstacleProtection, transportBusy, deviceNoAnswer, cancelled, deprecated, interrupted, thermalProtection, maintenanceRequired, alreadyUpToDate, notSupported, hardwareError, accessDenied, updateError, resourceAlreadyExist | | + | `ErrorState` | DataState | | | + | `ErrorsState` | DataState | | | + | `FirmwareHashState` | DataState | | | + | `FirmwareRevisionState` | DataState | | | + | `NameState` | DataState | | | + | `NewFirmwareAvailableState` | DataState | | | + | `OnOffState` | DiscreteState | on, off | | + | `Private10State` | DataState | | | + | `Private1State` | DataState | | | + | `Private2State` | DataState | | | + | `Private3State` | DataState | | | + | `Private4State` | DataState | | | + | `Private5State` | DataState | | | + | `Private6State` | DataState | | | + | `Private7State` | DataState | | | + | `Private8State` | DataState | | | + | `Private9State` | DataState | | | + | `RemovableState` | DataState | | | + | `SignalQualityState` | ContinuousState | | | + | `StatusState` | DiscreteState | available, unavailable | | + +??? note "CircuitBreaker/DynamicCircuitBreaker (ACTUATOR) — 13 commands, 24 states" + + **Type IDs:** `286` | **Servers:** `somfy_europe` | **Controllable:** `ogp:CircuitBreaker` | **Profiles:** `StatefulSwitchablePlug`, `StatefulSwitchable`, `Switchable`, `Cyclic` + + **Commands** + + | Command | Parameters | Notes | + |---------|-----------|-------| + | `cycle` | | Do a cycle of supported motion kinematics or modes | + | `executeManufacturerProcedure` | STRING; OBJECT (optional) | execute manufacturer procedure command. p1: the procedure name p2: the params associated Example: p1 = "dead_man_up" p2 = {"duration": 42} | + | `identify` | | Ask the device to identify itself by doing a slight movement or blink or beep | + | `off` | | Turn off the device | + | `on` | | Turn on the device | + | `readManufacturerData` | ARRAY | Read manufacturer data values from given names. Example: ["setting1","setting2"]. | + | `sendPrivate` | OBJECT | send a private command | + | `setName` | STRING | Change the device internal name. Name length may be subject to restrictions depending on the device and underlying protocol. | + | `setNodeDefinition` | STRING; STRING (optional); STRING (optional) | Fill the node definition (some transitions can be forbidden) p1: type (mandatory) p2: subType (mandatory if definition is set) p3: definition | + | `setOnOff` | STRING: off, on | Turn the device on or off | + | `toggle` | | Toggle on/off status | + | `update` | | Update the gateway software. The update may have to be downloaded first, which can take a while. | + | `writeManufacturerData` | OBJECT | Write manufacturer data values. Example: { "setting1": true, "setting2": 42, "setting3": "overkiz", "setting4": "Dk8PDr1WD0sfAAAAAAAAAAAAAAAAAAAA", "setting5": [ "valueA", "valueB", "valueC" ], "setting6": { "value": 15, "definition": 158 } } | + + **States** + + | State | Type | Range / Values | Notes | + |-------|------|----------------|-------| + | `ActivePartitionState` | DataState | | | + | `AvailabilityState` | DiscreteState | available, unavailable | | + | `BatteryDiscreteLevelState` | DiscreteState | good, medium, low, critical | | + | `BatteryLevelState` | ContinuousState | | | + | `ErrorState` | DataState | | | + | `ErrorsState` | DataState | | | + | `FirmwareHashState` | DataState | | | + | `FirmwareRevisionState` | DataState | | | + | `NameState` | DataState | | | + | `NewFirmwareAvailableState` | DataState | | | + | `OnOffState` | DiscreteState | on, off | | + | `Private10State` | DataState | | | + | `Private1State` | DataState | | | + | `Private2State` | DataState | | | + | `Private3State` | DataState | | | + | `Private4State` | DataState | | | + | `Private5State` | DataState | | | + | `Private6State` | DataState | | | + | `Private7State` | DataState | | | + | `Private8State` | DataState | | | + | `Private9State` | DataState | | | + | `RemovableState` | DataState | | | + | `SignalQualityState` | ContinuousState | | | + | `StatusState` | DiscreteState | available, unavailable | | + +??? note "ContactSensor/DynamicOpeningSensor (SENSOR) — 7 commands, 26 states" + + **Type IDs:** `272` | **Servers:** `rexel` | **Controllable:** `ogp:OpeningSensor` | **Profiles:** `WindowOpeningStatus`, `OpeningStatus` + + **Commands** + + | Command | Parameters | Notes | + |---------|-----------|-------| + | `executeManufacturerProcedure` | STRING; OBJECT (optional) | execute manufacturer procedure command. p1: the procedure name p2: the params associated Example: p1 = "dead_man_up" p2 = {"duration": 42} | + | `identify` | | Ask the device to identify itself by doing a slight movement or blink or beep | + | `readManufacturerData` | ARRAY | Read manufacturer data values from given names. Example: ["setting1","setting2"]. | + | `sendPrivate` | OBJECT | send a private command | + | `setName` | STRING | Change the device internal name. Name length may be subject to restrictions depending on the device and underlying protocol. | + | `update` | | Update the gateway software. The update may have to be downloaded first, which can take a while. | + | `writeManufacturerData` | OBJECT | Write manufacturer data values. Example: { "setting1": true, "setting2": 42, "setting3": "overkiz", "setting4": "Dk8PDr1WD0sfAAAAAAAAAAAAAAAAAAAA", "setting5": [ "valueA", "valueB", "valueC" ], "setting6": { "value": 15, "definition": 158 } } | + + **States** + + | State | Type | Range / Values | Notes | + |-------|------|----------------|-------| + | `ActivePartitionState` | DataState | | | + | `AvailabilityState` | DiscreteState | available, unavailable | | + | `BatteryDiscreteLevelState` | DiscreteState | good, medium, low, critical | | + | `BatteryLevelState` | ContinuousState | | | + | `ErrorEventState` | DiscreteState | accessLimitation, internal, obstacleProtection, transportBusy, deviceNoAnswer, cancelled, deprecated, interrupted, thermalProtection, maintenanceRequired, alreadyUpToDate, notSupported, hardwareError, accessDenied, updateError, resourceAlreadyExist | | + | `ErrorState` | DataState | | | + | `ErrorsState` | DataState | | | + | `FirmwareHashState` | DataState | | | + | `FirmwareRevisionState` | DataState | | | + | `NameState` | DataState | | | + | `NewFirmwareAvailableState` | DataState | | | + | `OpenClosedState` | DiscreteState | open, closed | | + | `OpenState` | DataState | | | + | `Private10State` | DataState | | | + | `Private1State` | DataState | | | + | `Private2State` | DataState | | | + | `Private3State` | DataState | | | + | `Private4State` | DataState | | | + | `Private5State` | DataState | | | + | `Private6State` | DataState | | | + | `Private7State` | DataState | | | + | `Private8State` | DataState | | | + | `Private9State` | DataState | | | + | `RemovableState` | DataState | | | + | `SignalQualityState` | ContinuousState | | | + | `StatusState` | DiscreteState | available, unavailable | | + +??? note "ContactSensor/DynamicOpeningSensor (SENSOR) — 7 commands, 25 states" + + **Type IDs:** `272` | **Servers:** `somfy_europe` | **Controllable:** `ogp:OpeningSensor` | **Profiles:** `WindowOpeningStatus`, `OpeningStatus` + + **Commands** + + | Command | Parameters | Notes | + |---------|-----------|-------| + | `executeManufacturerProcedure` | STRING; OBJECT (optional) | execute manufacturer procedure command. p1: the procedure name p2: the params associated Example: p1 = "dead_man_up" p2 = {"duration": 42} | + | `identify` | | Ask the device to identify itself by doing a slight movement or blink or beep | + | `readManufacturerData` | ARRAY | Read manufacturer data values from given names. Example: ["setting1","setting2"]. | + | `sendPrivate` | OBJECT | send a private command | + | `setName` | STRING | Change the device internal name. Name length may be subject to restrictions depending on the device and underlying protocol. | + | `update` | | Update the gateway software. The update may have to be downloaded first, which can take a while. | + | `writeManufacturerData` | OBJECT | Write manufacturer data values. Example: { "setting1": true, "setting2": 42, "setting3": "overkiz", "setting4": "Dk8PDr1WD0sfAAAAAAAAAAAAAAAAAAAA", "setting5": [ "valueA", "valueB", "valueC" ], "setting6": { "value": 15, "definition": 158 } } | + + **States** + + | State | Type | Range / Values | Notes | + |-------|------|----------------|-------| + | `ActivePartitionState` | DataState | | | + | `AvailabilityState` | DiscreteState | available, unavailable | | + | `BatteryDiscreteLevelState` | DiscreteState | good, medium, low, critical | | + | `BatteryLevelState` | ContinuousState | | | + | `ErrorState` | DataState | | | + | `ErrorsState` | DataState | | | + | `FirmwareHashState` | DataState | | | + | `FirmwareRevisionState` | DataState | | | + | `NameState` | DataState | | | + | `NewFirmwareAvailableState` | DataState | | | + | `OpenClosedState` | DiscreteState | open, closed | | + | `OpenState` | DataState | | | + | `Private10State` | DataState | | | + | `Private1State` | DataState | | | + | `Private2State` | DataState | | | + | `Private3State` | DataState | | | + | `Private4State` | DataState | | | + | `Private5State` | DataState | | | + | `Private6State` | DataState | | | + | `Private7State` | DataState | | | + | `Private8State` | DataState | | | + | `Private9State` | DataState | | | + | `RemovableState` | DataState | | | + | `SignalQualityState` | ContinuousState | | | + | `StatusState` | DiscreteState | available, unavailable | | + +??? note "Curtain/DynamicCurtain (ACTUATOR) — 14 commands, 28 states" + + **Type IDs:** `271` | **Servers:** `rexel` | **Controllable:** `ogp:Curtain` | **Profiles:** `StatefulCloseableCurtain`, `StatefulCloseable`, `Closeable`, `StatefulOpenClose`, `OpenClose` + + **Commands** + + | Command | Parameters | Notes | + |---------|-----------|-------| + | `close` | | Fully close the device | + | `executeManufacturerProcedure` | STRING; OBJECT (optional) | execute manufacturer procedure command. p1: the procedure name p2: the params associated Example: p1 = "dead_man_up" p2 = {"duration": 42} | + | `goToAlias` | STRING | Send alias command linked with the ID. | + | `identify` | | Ask the device to identify itself by doing a slight movement or blink or beep | + | `open` | | Fully open the device | + | `readManufacturerData` | ARRAY | Read manufacturer data values from given names. Example: ["setting1","setting2"]. | + | `saveAlias` | STRING | Allow to send an order for the product to save the current state of the alias. | + | `sendPrivate` | OBJECT | send a private command | + | `setClosure` | INT [0..100] | Closure level (100%=fully close, 0%=open) | + | `setName` | STRING | Change the device internal name. Name length may be subject to restrictions depending on the device and underlying protocol. | + | `setNodeDefinition` | STRING; STRING (optional); STRING (optional) | Fill the node definition (some transitions can be forbidden) p1: type (mandatory) p2: subType (mandatory if definition is set) p3: definition | + | `stop` | | Stop the current actuator behavior (movement, sound or timer) | + | `update` | | Update the gateway software. The update may have to be downloaded first, which can take a while. | + | `writeManufacturerData` | OBJECT | Write manufacturer data values. Example: { "setting1": true, "setting2": 42, "setting3": "overkiz", "setting4": "Dk8PDr1WD0sfAAAAAAAAAAAAAAAAAAAA", "setting5": [ "valueA", "valueB", "valueC" ], "setting6": { "value": 15, "definition": 158 } } | + + **States** + + | State | Type | Range / Values | Notes | + |-------|------|----------------|-------| + | `ActivePartitionState` | DataState | | | + | `AvailabilityState` | DiscreteState | available, unavailable | | + | `BatteryDiscreteLevelState` | DiscreteState | good, medium, low, critical | | + | `BatteryLevelState` | ContinuousState | | | + | `ClosureState` | ContinuousState | [0..100] | | + | `ErrorEventState` | DiscreteState | accessLimitation, internal, obstacleProtection, transportBusy, deviceNoAnswer, cancelled, deprecated, interrupted, thermalProtection, maintenanceRequired, alreadyUpToDate, notSupported, hardwareError, accessDenied, updateError, resourceAlreadyExist | | + | `ErrorState` | DataState | | | + | `ErrorsState` | DataState | | | + | `FirmwareHashState` | DataState | | | + | `FirmwareRevisionState` | DataState | | | + | `NameState` | DataState | | | + | `NewFirmwareAvailableState` | DataState | | | + | `OpenClosedState` | DiscreteState | open, closed | | + | `Private10State` | DataState | | | + | `Private1State` | DataState | | | + | `Private2State` | DataState | | | + | `Private3State` | DataState | | | + | `Private4State` | DataState | | | + | `Private5State` | DataState | | | + | `Private6State` | DataState | | | + | `Private7State` | DataState | | | + | `Private8State` | DataState | | | + | `Private9State` | DataState | | | + | `ReachedAliasesState` | DataState | | | + | `RemovableState` | DataState | | | + | `SignalQualityState` | ContinuousState | | | + | `StatusState` | DiscreteState | available, unavailable | | + | `UnavailableFeaturesState` | DataState | | | + +??? note "Curtain/DynamicCurtain (ACTUATOR) — 14 commands, 27 states" + + **Type IDs:** `271` | **Servers:** `somfy_europe` | **Controllable:** `ogp:Curtain` | **Profiles:** `StatefulCloseableCurtain`, `StatefulCloseable`, `Closeable`, `StatefulOpenClose`, `OpenClose` + + **Commands** + + | Command | Parameters | Notes | + |---------|-----------|-------| + | `close` | | Fully close the device | + | `executeManufacturerProcedure` | STRING; OBJECT (optional) | execute manufacturer procedure command. p1: the procedure name p2: the params associated Example: p1 = "dead_man_up" p2 = {"duration": 42} | + | `goToAlias` | STRING | Send alias command linked with the ID. | + | `identify` | | Ask the device to identify itself by doing a slight movement or blink or beep | + | `open` | | Fully open the device | + | `readManufacturerData` | ARRAY | Read manufacturer data values from given names. Example: ["setting1","setting2"]. | + | `saveAlias` | STRING | Allow to send an order for the product to save the current state of the alias. | + | `sendPrivate` | OBJECT | send a private command | + | `setClosure` | INT [0..100] | Closure level (100%=fully close, 0%=open) | + | `setName` | STRING | Change the device internal name. Name length may be subject to restrictions depending on the device and underlying protocol. | + | `setNodeDefinition` | STRING; STRING (optional); STRING (optional) | Fill the node definition (some transitions can be forbidden) p1: type (mandatory) p2: subType (mandatory if definition is set) p3: definition | + | `stop` | | Stop the current actuator behavior (movement, sound or timer) | + | `update` | | Update the gateway software. The update may have to be downloaded first, which can take a while. | + | `writeManufacturerData` | OBJECT | Write manufacturer data values. Example: { "setting1": true, "setting2": 42, "setting3": "overkiz", "setting4": "Dk8PDr1WD0sfAAAAAAAAAAAAAAAAAAAA", "setting5": [ "valueA", "valueB", "valueC" ], "setting6": { "value": 15, "definition": 158 } } | + + **States** + + | State | Type | Range / Values | Notes | + |-------|------|----------------|-------| + | `ActivePartitionState` | DataState | | | + | `AvailabilityState` | DiscreteState | available, unavailable | | + | `BatteryDiscreteLevelState` | DiscreteState | good, medium, low, critical | | + | `BatteryLevelState` | ContinuousState | | | + | `ClosureState` | ContinuousState | [0..100] | | + | `ErrorState` | DataState | | | + | `ErrorsState` | DataState | | | + | `FirmwareHashState` | DataState | | | + | `FirmwareRevisionState` | DataState | | | + | `NameState` | DataState | | | + | `NewFirmwareAvailableState` | DataState | | | + | `OpenClosedState` | DiscreteState | open, closed | | + | `Private10State` | DataState | | | + | `Private1State` | DataState | | | + | `Private2State` | DataState | | | + | `Private3State` | DataState | | | + | `Private4State` | DataState | | | + | `Private5State` | DataState | | | + | `Private6State` | DataState | | | + | `Private7State` | DataState | | | + | `Private8State` | DataState | | | + | `Private9State` | DataState | | | + | `ReachedAliasesState` | DataState | | | + | `RemovableState` | DataState | | | + | `SignalQualityState` | ContinuousState | | | + | `StatusState` | DiscreteState | available, unavailable | | + | `UnavailableFeaturesState` | DataState | | | + +??? note "ElectricitySensor/DynamicElectricityConsumptionSensor (SENSOR) — 7 commands, 26 states" + + **Type IDs:** `293` | **Servers:** `rexel` | **Controllable:** `ogp:ElectricityConsumptionSensor` | **Profiles:** `ElectricEnergyAndPower`, `ElectricPowerMeter`, `ElectricEnergyConsumption` + + **Commands** + + | Command | Parameters | Notes | + |---------|-----------|-------| + | `executeManufacturerProcedure` | STRING; OBJECT (optional) | execute manufacturer procedure command. p1: the procedure name p2: the params associated Example: p1 = "dead_man_up" p2 = {"duration": 42} | + | `identify` | | Ask the device to identify itself by doing a slight movement or blink or beep | + | `readManufacturerData` | ARRAY | Read manufacturer data values from given names. Example: ["setting1","setting2"]. | + | `sendPrivate` | OBJECT | send a private command | + | `setName` | STRING | Change the device internal name. Name length may be subject to restrictions depending on the device and underlying protocol. | + | `update` | | Update the gateway software. The update may have to be downloaded first, which can take a while. | + | `writeManufacturerData` | OBJECT | Write manufacturer data values. Example: { "setting1": true, "setting2": 42, "setting3": "overkiz", "setting4": "Dk8PDr1WD0sfAAAAAAAAAAAAAAAAAAAA", "setting5": [ "valueA", "valueB", "valueC" ], "setting6": { "value": 15, "definition": 158 } } | + + **States** + + | State | Type | Range / Values | Notes | + |-------|------|----------------|-------| + | `ActivePartitionState` | DataState | | | + | `AvailabilityState` | DiscreteState | available, unavailable | | + | `BatteryDiscreteLevelState` | DiscreteState | good, medium, low, critical | | + | `BatteryLevelState` | ContinuousState | | | + | `ElectricEnergyConsumptionState` | ContinuousState | | | + | `ElectricPowerConsumptionState` | ContinuousState | | | + | `ErrorEventState` | DiscreteState | accessLimitation, internal, obstacleProtection, transportBusy, deviceNoAnswer, cancelled, deprecated, interrupted, thermalProtection, maintenanceRequired, alreadyUpToDate, notSupported, hardwareError, accessDenied, updateError, resourceAlreadyExist | | + | `ErrorState` | DataState | | | + | `ErrorsState` | DataState | | | + | `FirmwareHashState` | DataState | | | + | `FirmwareRevisionState` | DataState | | | + | `NameState` | DataState | | | + | `NewFirmwareAvailableState` | DataState | | | + | `Private10State` | DataState | | | + | `Private1State` | DataState | | | + | `Private2State` | DataState | | | + | `Private3State` | DataState | | | + | `Private4State` | DataState | | | + | `Private5State` | DataState | | | + | `Private6State` | DataState | | | + | `Private7State` | DataState | | | + | `Private8State` | DataState | | | + | `Private9State` | DataState | | | + | `RemovableState` | DataState | | | + | `SignalQualityState` | ContinuousState | | | + | `StatusState` | DiscreteState | available, unavailable | | + +??? note "ElectricitySensor/DynamicElectricityConsumptionSensor (SENSOR) — 7 commands, 25 states" + + **Type IDs:** `293` | **Servers:** `somfy_europe` | **Controllable:** `ogp:ElectricityConsumptionSensor` | **Profiles:** `ElectricEnergyAndPower`, `ElectricPowerMeter`, `ElectricEnergyConsumption` + + **Commands** + + | Command | Parameters | Notes | + |---------|-----------|-------| + | `executeManufacturerProcedure` | STRING; OBJECT (optional) | execute manufacturer procedure command. p1: the procedure name p2: the params associated Example: p1 = "dead_man_up" p2 = {"duration": 42} | + | `identify` | | Ask the device to identify itself by doing a slight movement or blink or beep | + | `readManufacturerData` | ARRAY | Read manufacturer data values from given names. Example: ["setting1","setting2"]. | + | `sendPrivate` | OBJECT | send a private command | + | `setName` | STRING | Change the device internal name. Name length may be subject to restrictions depending on the device and underlying protocol. | + | `update` | | Update the gateway software. The update may have to be downloaded first, which can take a while. | + | `writeManufacturerData` | OBJECT | Write manufacturer data values. Example: { "setting1": true, "setting2": 42, "setting3": "overkiz", "setting4": "Dk8PDr1WD0sfAAAAAAAAAAAAAAAAAAAA", "setting5": [ "valueA", "valueB", "valueC" ], "setting6": { "value": 15, "definition": 158 } } | + + **States** + + | State | Type | Range / Values | Notes | + |-------|------|----------------|-------| + | `ActivePartitionState` | DataState | | | + | `AvailabilityState` | DiscreteState | available, unavailable | | + | `BatteryDiscreteLevelState` | DiscreteState | good, medium, low, critical | | + | `BatteryLevelState` | ContinuousState | | | + | `ElectricEnergyConsumptionState` | ContinuousState | | | + | `ElectricPowerConsumptionState` | ContinuousState | | | + | `ErrorState` | DataState | | | + | `ErrorsState` | DataState | | | + | `FirmwareHashState` | DataState | | | + | `FirmwareRevisionState` | DataState | | | + | `NameState` | DataState | | | + | `NewFirmwareAvailableState` | DataState | | | + | `Private10State` | DataState | | | + | `Private1State` | DataState | | | + | `Private2State` | DataState | | | + | `Private3State` | DataState | | | + | `Private4State` | DataState | | | + | `Private5State` | DataState | | | + | `Private6State` | DataState | | | + | `Private7State` | DataState | | | + | `Private8State` | DataState | | | + | `Private9State` | DataState | | | + | `RemovableState` | DataState | | | + | `SignalQualityState` | ContinuousState | | | + | `StatusState` | DiscreteState | available, unavailable | | + +??? note "GarageDoor/DynamicGarageDoor (ACTUATOR) — 15 commands, 28 states" + + **Type IDs:** `266` | **Servers:** `rexel` | **Controllable:** `ogp:GarageDoor` | **Profiles:** `StatefulCloseableGarageOpener`, `StatefulCloseable`, `Closeable`, `StatefulOpenClose`, `OpenClose`, `Cyclic` + + **Commands** + + | Command | Parameters | Notes | + |---------|-----------|-------| + | `close` | | Fully close the device | + | `cycle` | | Do a cycle of supported motion kinematics or modes | + | `executeManufacturerProcedure` | STRING; OBJECT (optional) | execute manufacturer procedure command. p1: the procedure name p2: the params associated Example: p1 = "dead_man_up" p2 = {"duration": 42} | + | `goToAlias` | STRING | Send alias command linked with the ID. | + | `identify` | | Ask the device to identify itself by doing a slight movement or blink or beep | + | `open` | | Fully open the device | + | `readManufacturerData` | ARRAY | Read manufacturer data values from given names. Example: ["setting1","setting2"]. | + | `saveAlias` | STRING | Allow to send an order for the product to save the current state of the alias. | + | `sendPrivate` | OBJECT | send a private command | + | `setClosure` | INT [0..100] | Closure level (100%=fully close, 0%=open) | + | `setName` | STRING | Change the device internal name. Name length may be subject to restrictions depending on the device and underlying protocol. | + | `setNodeDefinition` | STRING; STRING (optional); STRING (optional) | Fill the node definition (some transitions can be forbidden) p1: type (mandatory) p2: subType (mandatory if definition is set) p3: definition | + | `stop` | | Stop the current actuator behavior (movement, sound or timer) | + | `update` | | Update the gateway software. The update may have to be downloaded first, which can take a while. | + | `writeManufacturerData` | OBJECT | Write manufacturer data values. Example: { "setting1": true, "setting2": 42, "setting3": "overkiz", "setting4": "Dk8PDr1WD0sfAAAAAAAAAAAAAAAAAAAA", "setting5": [ "valueA", "valueB", "valueC" ], "setting6": { "value": 15, "definition": 158 } } | + + **States** + + | State | Type | Range / Values | Notes | + |-------|------|----------------|-------| + | `ActivePartitionState` | DataState | | | + | `AvailabilityState` | DiscreteState | available, unavailable | | + | `BatteryDiscreteLevelState` | DiscreteState | good, medium, low, critical | | + | `BatteryLevelState` | ContinuousState | | | + | `ClosureState` | ContinuousState | [0..100] | | + | `ErrorEventState` | DiscreteState | accessLimitation, internal, obstacleProtection, transportBusy, deviceNoAnswer, cancelled, deprecated, interrupted, thermalProtection, maintenanceRequired, alreadyUpToDate, notSupported, hardwareError, accessDenied, updateError, resourceAlreadyExist | | + | `ErrorState` | DataState | | | + | `ErrorsState` | DataState | | | + | `FirmwareHashState` | DataState | | | + | `FirmwareRevisionState` | DataState | | | + | `NameState` | DataState | | | + | `NewFirmwareAvailableState` | DataState | | | + | `OpenClosedState` | DiscreteState | open, closed | | + | `Private10State` | DataState | | | + | `Private1State` | DataState | | | + | `Private2State` | DataState | | | + | `Private3State` | DataState | | | + | `Private4State` | DataState | | | + | `Private5State` | DataState | | | + | `Private6State` | DataState | | | + | `Private7State` | DataState | | | + | `Private8State` | DataState | | | + | `Private9State` | DataState | | | + | `ReachedAliasesState` | DataState | | | + | `RemovableState` | DataState | | | + | `SignalQualityState` | ContinuousState | | | + | `StatusState` | DiscreteState | available, unavailable | | + | `UnavailableFeaturesState` | DataState | | | + +??? note "GarageDoor/DynamicGarageDoor (ACTUATOR) — 15 commands, 27 states" + + **Type IDs:** `266` | **Servers:** `somfy_europe` | **Controllable:** `ogp:GarageDoor` | **Profiles:** `StatefulCloseableGarageOpener`, `StatefulCloseable`, `Closeable`, `StatefulOpenClose`, `OpenClose`, `Cyclic` + + **Commands** + + | Command | Parameters | Notes | + |---------|-----------|-------| + | `close` | | Fully close the device | + | `cycle` | | Do a cycle of supported motion kinematics or modes | + | `executeManufacturerProcedure` | STRING; OBJECT (optional) | execute manufacturer procedure command. p1: the procedure name p2: the params associated Example: p1 = "dead_man_up" p2 = {"duration": 42} | + | `goToAlias` | STRING | Send alias command linked with the ID. | + | `identify` | | Ask the device to identify itself by doing a slight movement or blink or beep | + | `open` | | Fully open the device | + | `readManufacturerData` | ARRAY | Read manufacturer data values from given names. Example: ["setting1","setting2"]. | + | `saveAlias` | STRING | Allow to send an order for the product to save the current state of the alias. | + | `sendPrivate` | OBJECT | send a private command | + | `setClosure` | INT [0..100] | Closure level (100%=fully close, 0%=open) | + | `setName` | STRING | Change the device internal name. Name length may be subject to restrictions depending on the device and underlying protocol. | + | `setNodeDefinition` | STRING; STRING (optional); STRING (optional) | Fill the node definition (some transitions can be forbidden) p1: type (mandatory) p2: subType (mandatory if definition is set) p3: definition | + | `stop` | | Stop the current actuator behavior (movement, sound or timer) | + | `update` | | Update the gateway software. The update may have to be downloaded first, which can take a while. | + | `writeManufacturerData` | OBJECT | Write manufacturer data values. Example: { "setting1": true, "setting2": 42, "setting3": "overkiz", "setting4": "Dk8PDr1WD0sfAAAAAAAAAAAAAAAAAAAA", "setting5": [ "valueA", "valueB", "valueC" ], "setting6": { "value": 15, "definition": 158 } } | + + **States** + + | State | Type | Range / Values | Notes | + |-------|------|----------------|-------| + | `ActivePartitionState` | DataState | | | + | `AvailabilityState` | DiscreteState | available, unavailable | | + | `BatteryDiscreteLevelState` | DiscreteState | good, medium, low, critical | | + | `BatteryLevelState` | ContinuousState | | | + | `ClosureState` | ContinuousState | [0..100] | | + | `ErrorState` | DataState | | | + | `ErrorsState` | DataState | | | + | `FirmwareHashState` | DataState | | | + | `FirmwareRevisionState` | DataState | | | + | `NameState` | DataState | | | + | `NewFirmwareAvailableState` | DataState | | | + | `OpenClosedState` | DiscreteState | open, closed | | + | `Private10State` | DataState | | | + | `Private1State` | DataState | | | + | `Private2State` | DataState | | | + | `Private3State` | DataState | | | + | `Private4State` | DataState | | | + | `Private5State` | DataState | | | + | `Private6State` | DataState | | | + | `Private7State` | DataState | | | + | `Private8State` | DataState | | | + | `Private9State` | DataState | | | + | `ReachedAliasesState` | DataState | | | + | `RemovableState` | DataState | | | + | `SignalQualityState` | ContinuousState | | | + | `StatusState` | DiscreteState | available, unavailable | | + | `UnavailableFeaturesState` | DataState | | | + +??? note "GasSensor/DynamicGasMeasurementSensor (SENSOR) — 7 commands, 26 states" + + **Type IDs:** `296` | **Servers:** `rexel` | **Controllable:** `ogp:GasMeasurementSensor` | **Profiles:** `GasConsumption` + + **Commands** + + | Command | Parameters | Notes | + |---------|-----------|-------| + | `executeManufacturerProcedure` | STRING; OBJECT (optional) | execute manufacturer procedure command. p1: the procedure name p2: the params associated Example: p1 = "dead_man_up" p2 = {"duration": 42} | + | `identify` | | Ask the device to identify itself by doing a slight movement or blink or beep | + | `readManufacturerData` | ARRAY | Read manufacturer data values from given names. Example: ["setting1","setting2"]. | + | `sendPrivate` | OBJECT | send a private command | + | `setName` | STRING | Change the device internal name. Name length may be subject to restrictions depending on the device and underlying protocol. | + | `update` | | Update the gateway software. The update may have to be downloaded first, which can take a while. | + | `writeManufacturerData` | OBJECT | Write manufacturer data values. Example: { "setting1": true, "setting2": 42, "setting3": "overkiz", "setting4": "Dk8PDr1WD0sfAAAAAAAAAAAAAAAAAAAA", "setting5": [ "valueA", "valueB", "valueC" ], "setting6": { "value": 15, "definition": 158 } } | + + **States** + + | State | Type | Range / Values | Notes | + |-------|------|----------------|-------| + | `ActivePartitionState` | DataState | | | + | `AvailabilityState` | DiscreteState | available, unavailable | | + | `BatteryDiscreteLevelState` | DiscreteState | good, medium, low, critical | | + | `BatteryLevelState` | ContinuousState | | | + | `ErrorEventState` | DiscreteState | accessLimitation, internal, obstacleProtection, transportBusy, deviceNoAnswer, cancelled, deprecated, interrupted, thermalProtection, maintenanceRequired, alreadyUpToDate, notSupported, hardwareError, accessDenied, updateError, resourceAlreadyExist | | + | `ErrorState` | DataState | | | + | `ErrorsState` | DataState | | | + | `FirmwareHashState` | DataState | | | + | `FirmwareRevisionState` | DataState | | | + | `GasConsumptionState` | ContinuousState | | | + | `GasFlowState` | ContinuousState | | | + | `NameState` | DataState | | | + | `NewFirmwareAvailableState` | DataState | | | + | `Private10State` | DataState | | | + | `Private1State` | DataState | | | + | `Private2State` | DataState | | | + | `Private3State` | DataState | | | + | `Private4State` | DataState | | | + | `Private5State` | DataState | | | + | `Private6State` | DataState | | | + | `Private7State` | DataState | | | + | `Private8State` | DataState | | | + | `Private9State` | DataState | | | + | `RemovableState` | DataState | | | + | `SignalQualityState` | ContinuousState | | | + | `StatusState` | DiscreteState | available, unavailable | | + +??? note "GasSensor/DynamicGasMeasurementSensor (SENSOR) — 7 commands, 25 states" + + **Type IDs:** `296` | **Servers:** `somfy_europe` | **Controllable:** `ogp:GasMeasurementSensor` | **Profiles:** `GasConsumption` + + **Commands** + + | Command | Parameters | Notes | + |---------|-----------|-------| + | `executeManufacturerProcedure` | STRING; OBJECT (optional) | execute manufacturer procedure command. p1: the procedure name p2: the params associated Example: p1 = "dead_man_up" p2 = {"duration": 42} | + | `identify` | | Ask the device to identify itself by doing a slight movement or blink or beep | + | `readManufacturerData` | ARRAY | Read manufacturer data values from given names. Example: ["setting1","setting2"]. | + | `sendPrivate` | OBJECT | send a private command | + | `setName` | STRING | Change the device internal name. Name length may be subject to restrictions depending on the device and underlying protocol. | + | `update` | | Update the gateway software. The update may have to be downloaded first, which can take a while. | + | `writeManufacturerData` | OBJECT | Write manufacturer data values. Example: { "setting1": true, "setting2": 42, "setting3": "overkiz", "setting4": "Dk8PDr1WD0sfAAAAAAAAAAAAAAAAAAAA", "setting5": [ "valueA", "valueB", "valueC" ], "setting6": { "value": 15, "definition": 158 } } | + + **States** + + | State | Type | Range / Values | Notes | + |-------|------|----------------|-------| + | `ActivePartitionState` | DataState | | | + | `AvailabilityState` | DiscreteState | available, unavailable | | + | `BatteryDiscreteLevelState` | DiscreteState | good, medium, low, critical | | + | `BatteryLevelState` | ContinuousState | | | + | `ErrorState` | DataState | | | + | `ErrorsState` | DataState | | | + | `FirmwareHashState` | DataState | | | + | `FirmwareRevisionState` | DataState | | | + | `GasConsumptionState` | ContinuousState | | | + | `GasFlowState` | ContinuousState | | | + | `NameState` | DataState | | | + | `NewFirmwareAvailableState` | DataState | | | + | `Private10State` | DataState | | | + | `Private1State` | DataState | | | + | `Private2State` | DataState | | | + | `Private3State` | DataState | | | + | `Private4State` | DataState | | | + | `Private5State` | DataState | | | + | `Private6State` | DataState | | | + | `Private7State` | DataState | | | + | `Private8State` | DataState | | | + | `Private9State` | DataState | | | + | `RemovableState` | DataState | | | + | `SignalQualityState` | ContinuousState | | | + | `StatusState` | DiscreteState | available, unavailable | | + +??? note "Gate/DynamicGate (ACTUATOR) — 15 commands, 28 states" + + **Type IDs:** `265` | **Servers:** `rexel` | **Controllable:** `ogp:Gate` | **Profiles:** `StatefulCloseableGateOpener`, `StatefulCloseable`, `Closeable`, `StatefulOpenClose`, `OpenClose`, `Cyclic` + + **Commands** + + | Command | Parameters | Notes | + |---------|-----------|-------| + | `close` | | Fully close the device | + | `cycle` | | Do a cycle of supported motion kinematics or modes | + | `executeManufacturerProcedure` | STRING; OBJECT (optional) | execute manufacturer procedure command. p1: the procedure name p2: the params associated Example: p1 = "dead_man_up" p2 = {"duration": 42} | + | `goToAlias` | STRING | Send alias command linked with the ID. | + | `identify` | | Ask the device to identify itself by doing a slight movement or blink or beep | + | `open` | | Fully open the device | + | `readManufacturerData` | ARRAY | Read manufacturer data values from given names. Example: ["setting1","setting2"]. | + | `saveAlias` | STRING | Allow to send an order for the product to save the current state of the alias. | + | `sendPrivate` | OBJECT | send a private command | + | `setClosure` | INT [0..100] | Closure level (100%=fully close, 0%=open) | + | `setName` | STRING | Change the device internal name. Name length may be subject to restrictions depending on the device and underlying protocol. | + | `setNodeDefinition` | STRING; STRING (optional); STRING (optional) | Fill the node definition (some transitions can be forbidden) p1: type (mandatory) p2: subType (mandatory if definition is set) p3: definition | + | `stop` | | Stop the current actuator behavior (movement, sound or timer) | + | `update` | | Update the gateway software. The update may have to be downloaded first, which can take a while. | + | `writeManufacturerData` | OBJECT | Write manufacturer data values. Example: { "setting1": true, "setting2": 42, "setting3": "overkiz", "setting4": "Dk8PDr1WD0sfAAAAAAAAAAAAAAAAAAAA", "setting5": [ "valueA", "valueB", "valueC" ], "setting6": { "value": 15, "definition": 158 } } | + + **States** + + | State | Type | Range / Values | Notes | + |-------|------|----------------|-------| + | `ActivePartitionState` | DataState | | | + | `AvailabilityState` | DiscreteState | available, unavailable | | + | `BatteryDiscreteLevelState` | DiscreteState | good, medium, low, critical | | + | `BatteryLevelState` | ContinuousState | | | + | `ClosureState` | ContinuousState | [0..100] | | + | `ErrorEventState` | DiscreteState | accessLimitation, internal, obstacleProtection, transportBusy, deviceNoAnswer, cancelled, deprecated, interrupted, thermalProtection, maintenanceRequired, alreadyUpToDate, notSupported, hardwareError, accessDenied, updateError, resourceAlreadyExist | | + | `ErrorState` | DataState | | | + | `ErrorsState` | DataState | | | + | `FirmwareHashState` | DataState | | | + | `FirmwareRevisionState` | DataState | | | + | `NameState` | DataState | | | + | `NewFirmwareAvailableState` | DataState | | | + | `OpenClosedState` | DiscreteState | open, closed | | + | `Private10State` | DataState | | | + | `Private1State` | DataState | | | + | `Private2State` | DataState | | | + | `Private3State` | DataState | | | + | `Private4State` | DataState | | | + | `Private5State` | DataState | | | + | `Private6State` | DataState | | | + | `Private7State` | DataState | | | + | `Private8State` | DataState | | | + | `Private9State` | DataState | | | + | `ReachedAliasesState` | DataState | | | + | `RemovableState` | DataState | | | + | `SignalQualityState` | ContinuousState | | | + | `StatusState` | DiscreteState | available, unavailable | | + | `UnavailableFeaturesState` | DataState | | | + +??? note "Gate/DynamicGate (ACTUATOR) — 15 commands, 27 states" + + **Type IDs:** `265` | **Servers:** `somfy_europe` | **Controllable:** `ogp:Gate` | **Profiles:** `StatefulCloseableGateOpener`, `StatefulCloseable`, `Closeable`, `StatefulOpenClose`, `OpenClose`, `Cyclic` + + **Commands** + + | Command | Parameters | Notes | + |---------|-----------|-------| + | `close` | | Fully close the device | + | `cycle` | | Do a cycle of supported motion kinematics or modes | + | `executeManufacturerProcedure` | STRING; OBJECT (optional) | execute manufacturer procedure command. p1: the procedure name p2: the params associated Example: p1 = "dead_man_up" p2 = {"duration": 42} | + | `goToAlias` | STRING | Send alias command linked with the ID. | + | `identify` | | Ask the device to identify itself by doing a slight movement or blink or beep | + | `open` | | Fully open the device | + | `readManufacturerData` | ARRAY | Read manufacturer data values from given names. Example: ["setting1","setting2"]. | + | `saveAlias` | STRING | Allow to send an order for the product to save the current state of the alias. | + | `sendPrivate` | OBJECT | send a private command | + | `setClosure` | INT [0..100] | Closure level (100%=fully close, 0%=open) | + | `setName` | STRING | Change the device internal name. Name length may be subject to restrictions depending on the device and underlying protocol. | + | `setNodeDefinition` | STRING; STRING (optional); STRING (optional) | Fill the node definition (some transitions can be forbidden) p1: type (mandatory) p2: subType (mandatory if definition is set) p3: definition | + | `stop` | | Stop the current actuator behavior (movement, sound or timer) | + | `update` | | Update the gateway software. The update may have to be downloaded first, which can take a while. | + | `writeManufacturerData` | OBJECT | Write manufacturer data values. Example: { "setting1": true, "setting2": 42, "setting3": "overkiz", "setting4": "Dk8PDr1WD0sfAAAAAAAAAAAAAAAAAAAA", "setting5": [ "valueA", "valueB", "valueC" ], "setting6": { "value": 15, "definition": 158 } } | + + **States** + + | State | Type | Range / Values | Notes | + |-------|------|----------------|-------| + | `ActivePartitionState` | DataState | | | + | `AvailabilityState` | DiscreteState | available, unavailable | | + | `BatteryDiscreteLevelState` | DiscreteState | good, medium, low, critical | | + | `BatteryLevelState` | ContinuousState | | | + | `ClosureState` | ContinuousState | [0..100] | | + | `ErrorState` | DataState | | | + | `ErrorsState` | DataState | | | + | `FirmwareHashState` | DataState | | | + | `FirmwareRevisionState` | DataState | | | + | `NameState` | DataState | | | + | `NewFirmwareAvailableState` | DataState | | | + | `OpenClosedState` | DiscreteState | open, closed | | + | `Private10State` | DataState | | | + | `Private1State` | DataState | | | + | `Private2State` | DataState | | | + | `Private3State` | DataState | | | + | `Private4State` | DataState | | | + | `Private5State` | DataState | | | + | `Private6State` | DataState | | | + | `Private7State` | DataState | | | + | `Private8State` | DataState | | | + | `Private9State` | DataState | | | + | `ReachedAliasesState` | DataState | | | + | `RemovableState` | DataState | | | + | `SignalQualityState` | ContinuousState | | | + | `StatusState` | DiscreteState | available, unavailable | | + | `UnavailableFeaturesState` | DataState | | | + +??? note "Generic/Untyped (ACTUATOR) — 3 commands, 4 states" + + **Type IDs:** `16` | **Servers:** `rexel`, `somfy_europe` | **Controllable:** `ogp:Untyped` | **Profiles:** `Specific` + + **Commands** + + | Command | Parameters | Notes | + |---------|-----------|-------| + | `identify` | | Ask the device to identify itself by doing a slight movement or blink or beep | + | `setName` | STRING | Change the device internal name. Name length may be subject to restrictions depending on the device and underlying protocol. | + | `setNodeDefinition` | STRING; STRING (optional); STRING (optional) | Fill the node definition (some transitions can be forbidden) p1: type (mandatory) p2: subType (mandatory if definition is set) p3: definition | + + **States** + + | State | Type | Range / Values | Notes | + |-------|------|----------------|-------| + | `AvailabilityState` | DiscreteState | available, unavailable | | + | `NameState` | DataState | | | + | `RemovableState` | DataState | | | + | `StatusState` | DiscreteState | available, unavailable | | + +??? note "HeatingSystem/DynamicThermostat (ACTUATOR) — 18 commands, 40 states" + + **Type IDs:** `259` | **Servers:** `rexel` | **Controllable:** `ogp:Thermostat` | **Profiles:** `StatefulThermostatWithSensor`, `StatefulThermostat`, `Thermostat`, `RelativeHumidity`, `StatefulSwitchable`, `Switchable`, `StatefulAirFan`, `AirFan` + + **Commands** + + | Command | Parameters | Notes | + |---------|-----------|-------| + | `executeManufacturerProcedure` | STRING; OBJECT (optional) | execute manufacturer procedure command. p1: the procedure name p2: the params associated Example: p1 = "dead_man_up" p2 = {"duration": 42} | + | `goToAlias` | STRING | Send alias command linked with the ID. | + | `identify` | | Ask the device to identify itself by doing a slight movement or blink or beep | + | `off` | | Turn off the device | + | `on` | | Turn on the device | + | `readManufacturerData` | ARRAY | Read manufacturer data values from given names. Example: ["setting1","setting2"]. | + | `saveAlias` | STRING | Allow to send an order for the product to save the current state of the alias. | + | `sendPrivate` | OBJECT | send a private command | + | `setFanSpeed` | STRING: low, medium, high, auto, 1 | Set the fan speed (%) | + | `setFanSpeedLevel` | INT [0..100] | Set the device fan speed level (%) | + | `setMode` | STRING | Set the active mode. | + | `setName` | STRING | Change the device internal name. Name length may be subject to restrictions depending on the device and underlying protocol. | + | `setNodeDefinition` | STRING; STRING (optional); STRING (optional) | Fill the node definition (some transitions can be forbidden) p1: type (mandatory) p2: subType (mandatory if definition is set) p3: definition | + | `setOnOff` | STRING: off, on | Turn the device on or off | + | `setTargetTemperature` | FLOAT | Set the new air temperature to reach | + | `setTimezone` | STRING | Set the device timezone, according to TZ database names. | + | `update` | | Update the gateway software. The update may have to be downloaded first, which can take a while. | + | `writeManufacturerData` | OBJECT | Write manufacturer data values. Example: { "setting1": true, "setting2": 42, "setting3": "overkiz", "setting4": "Dk8PDr1WD0sfAAAAAAAAAAAAAAAAAAAA", "setting5": [ "valueA", "valueB", "valueC" ], "setting6": { "value": 15, "definition": 158 } } | + + **States** + + | State | Type | Range / Values | Notes | + |-------|------|----------------|-------| + | `ActivePartitionState` | DataState | | | + | `AvailabilityState` | DiscreteState | available, unavailable | | + | `AvailableModesState` | DataState | | | + | `AvailableTargetTemperaturesState` | DataState | | | + | `BatteryDiscreteLevelState` | DiscreteState | good, medium, low, critical | | + | `BatteryLevelState` | ContinuousState | | | + | `ErrorEventState` | DiscreteState | accessLimitation, internal, obstacleProtection, transportBusy, deviceNoAnswer, cancelled, deprecated, interrupted, thermalProtection, maintenanceRequired, alreadyUpToDate, notSupported, hardwareError, accessDenied, updateError, resourceAlreadyExist | | + | `ErrorState` | DataState | | | + | `ErrorsState` | DataState | | | + | `FanSpeedLevelState` | ContinuousState | [0..100] | | + | `FanSpeedState` | DiscreteState | low, medium, high, 1, 2, 3, 4, 5, 6, 7, 8, 9 | | + | `FirmwareHashState` | DataState | | | + | `FirmwareRevisionState` | DataState | | | + | `ModeState` | DataState | | | + | `NameState` | DataState | | | + | `NewFirmwareAvailableState` | DataState | | | + | `OnOffState` | DiscreteState | on, off | | + | `Private10State` | DataState | | | + | `Private1State` | DataState | | | + | `Private2State` | DataState | | | + | `Private3State` | DataState | | | + | `Private4State` | DataState | | | + | `Private5State` | DataState | | | + | `Private6State` | DataState | | | + | `Private7State` | DataState | | | + | `Private8State` | DataState | | | + | `Private9State` | DataState | | | + | `ReachedAliasesState` | DataState | | | + | `RecommendedTargetTemperatureState` | ContinuousState | | | + | `RelativeHumidityState` | ContinuousState | [0.0..100.0] | | + | `RemovableState` | DataState | | | + | `SignalQualityState` | ContinuousState | | | + | `StatusState` | DiscreteState | available, unavailable | | + | `TargetTemperatureCurrentLowerBoundState` | ContinuousState | | | + | `TargetTemperatureCurrentUpperBoundState` | ContinuousState | | | + | `TargetTemperatureReachedState` | DataState | | | + | `TargetTemperatureState` | ContinuousState | [12.0..30.0] | | + | `TemperatureState` | ContinuousState | [-100.0..100.0] | | + | `TimezoneState` | DataState | | | + | `UnavailableFeaturesState` | DataState | | | + +??? note "HeatingSystem/DynamicHvacCentralUnit (ACTUATOR) — 20 commands, 41 states" + + **Type IDs:** `269` | **Servers:** `rexel` | **Controllable:** `ogp:HvacCentralUnit` | **Profiles:** `StatefulThermostatWithSensor`, `StatefulThermostat`, `Thermostat`, `RelativeHumidity`, `StatefulSwitchable`, `Switchable`, `StatefulAirFan`, `AirFan` + + **Commands** + + | Command | Parameters | Notes | + |---------|-----------|-------| + | `addGroupMember` | STRING | Add member to the group p1 : Id of the member to add to the group. | + | `executeManufacturerProcedure` | STRING; OBJECT (optional) | execute manufacturer procedure command. p1: the procedure name p2: the params associated Example: p1 = "dead_man_up" p2 = {"duration": 42} | + | `goToAlias` | STRING | Send alias command linked with the ID. | + | `identify` | | Ask the device to identify itself by doing a slight movement or blink or beep | + | `off` | | Turn off the device | + | `on` | | Turn on the device | + | `readManufacturerData` | ARRAY | Read manufacturer data values from given names. Example: ["setting1","setting2"]. | + | `removeGroupMember` | STRING | Remove a member of the group. p1 : Id of the member to remove to the group. | + | `saveAlias` | STRING | Allow to send an order for the product to save the current state of the alias. | + | `sendPrivate` | OBJECT | send a private command | + | `setFanSpeed` | STRING: low, medium, high, auto, 1 | Set the fan speed (%) | + | `setFanSpeedLevel` | INT [0..100] | Set the device fan speed level (%) | + | `setMode` | STRING | Set the active mode. | + | `setName` | STRING | Change the device internal name. Name length may be subject to restrictions depending on the device and underlying protocol. | + | `setNodeDefinition` | STRING; STRING (optional); STRING (optional) | Fill the node definition (some transitions can be forbidden) p1: type (mandatory) p2: subType (mandatory if definition is set) p3: definition | + | `setOnOff` | STRING: off, on | Turn the device on or off | + | `setTargetTemperature` | FLOAT | Set the new air temperature to reach | + | `setTimezone` | STRING | Set the device timezone, according to TZ database names. | + | `update` | | Update the gateway software. The update may have to be downloaded first, which can take a while. | + | `writeManufacturerData` | OBJECT | Write manufacturer data values. Example: { "setting1": true, "setting2": 42, "setting3": "overkiz", "setting4": "Dk8PDr1WD0sfAAAAAAAAAAAAAAAAAAAA", "setting5": [ "valueA", "valueB", "valueC" ], "setting6": { "value": 15, "definition": 158 } } | + + **States** + + | State | Type | Range / Values | Notes | + |-------|------|----------------|-------| + | `ActivePartitionState` | DataState | | | + | `AvailabilityState` | DiscreteState | available, unavailable | | + | `AvailableModesState` | DataState | | | + | `AvailableTargetTemperaturesState` | DataState | | | + | `BatteryDiscreteLevelState` | DiscreteState | good, medium, low, critical | | + | `BatteryLevelState` | ContinuousState | | | + | `ErrorEventState` | DiscreteState | accessLimitation, internal, obstacleProtection, transportBusy, deviceNoAnswer, cancelled, deprecated, interrupted, thermalProtection, maintenanceRequired, alreadyUpToDate, notSupported, hardwareError, accessDenied, updateError, resourceAlreadyExist | | + | `ErrorState` | DataState | | | + | `ErrorsState` | DataState | | | + | `FanSpeedLevelState` | ContinuousState | [0..100] | | + | `FanSpeedState` | DiscreteState | low, medium, high, 1, 2, 3, 4, 5, 6, 7, 8, 9 | | + | `FirmwareHashState` | DataState | | | + | `FirmwareRevisionState` | DataState | | | + | `GroupMembersState` | DataState | | | + | `ModeState` | DataState | | | + | `NameState` | DataState | | | + | `NewFirmwareAvailableState` | DataState | | | + | `OnOffState` | DiscreteState | on, off | | + | `Private10State` | DataState | | | + | `Private1State` | DataState | | | + | `Private2State` | DataState | | | + | `Private3State` | DataState | | | + | `Private4State` | DataState | | | + | `Private5State` | DataState | | | + | `Private6State` | DataState | | | + | `Private7State` | DataState | | | + | `Private8State` | DataState | | | + | `Private9State` | DataState | | | + | `ReachedAliasesState` | DataState | | | + | `RecommendedTargetTemperatureState` | ContinuousState | | | + | `RelativeHumidityState` | ContinuousState | [0.0..100.0] | | + | `RemovableState` | DataState | | | + | `SignalQualityState` | ContinuousState | | | + | `StatusState` | DiscreteState | available, unavailable | | + | `TargetTemperatureCurrentLowerBoundState` | ContinuousState | | | + | `TargetTemperatureCurrentUpperBoundState` | ContinuousState | | | + | `TargetTemperatureReachedState` | DataState | | | + | `TargetTemperatureState` | ContinuousState | [12.0..30.0] | | + | `TemperatureState` | ContinuousState | [-100.0..100.0] | | + | `TimezoneState` | DataState | | | + | `UnavailableFeaturesState` | DataState | | | + +??? note "HeatingSystem/DynamicHeater (ACTUATOR) — 17 commands, 41 states" + + **Type IDs:** `278` | **Servers:** `rexel` | **Controllable:** `ogp:Heater` | **Profiles:** `StatefulThermostatWithSensor`, `StatefulThermostat`, `Thermostat`, `RelativeHumidity`, `ElectricPowerMeter`, `StatefulSwitchable`, `Switchable`, `StatefulDimmable`, `Dimmable` + + **Commands** + + | Command | Parameters | Notes | + |---------|-----------|-------| + | `executeManufacturerProcedure` | STRING; OBJECT (optional) | execute manufacturer procedure command. p1: the procedure name p2: the params associated Example: p1 = "dead_man_up" p2 = {"duration": 42} | + | `goToAlias` | STRING | Send alias command linked with the ID. | + | `identify` | | Ask the device to identify itself by doing a slight movement or blink or beep | + | `off` | | Turn off the device | + | `on` | | Turn on the device | + | `readManufacturerData` | ARRAY | Read manufacturer data values from given names. Example: ["setting1","setting2"]. | + | `saveAlias` | STRING | Allow to send an order for the product to save the current state of the alias. | + | `sendPrivate` | OBJECT | send a private command | + | `setIntensity` | INT [0..100] | Light intensity level (100%=maximum intensity, 0%=off) | + | `setMode` | STRING | Set the active mode. | + | `setName` | STRING | Change the device internal name. Name length may be subject to restrictions depending on the device and underlying protocol. | + | `setNodeDefinition` | STRING; STRING (optional); STRING (optional) | Fill the node definition (some transitions can be forbidden) p1: type (mandatory) p2: subType (mandatory if definition is set) p3: definition | + | `setOnOff` | STRING: off, on | Turn the device on or off | + | `setTargetTemperature` | FLOAT | Set the new air temperature to reach | + | `setTimezone` | STRING | Set the device timezone, according to TZ database names. | + | `update` | | Update the gateway software. The update may have to be downloaded first, which can take a while. | + | `writeManufacturerData` | OBJECT | Write manufacturer data values. Example: { "setting1": true, "setting2": 42, "setting3": "overkiz", "setting4": "Dk8PDr1WD0sfAAAAAAAAAAAAAAAAAAAA", "setting5": [ "valueA", "valueB", "valueC" ], "setting6": { "value": 15, "definition": 158 } } | + + **States** + + | State | Type | Range / Values | Notes | + |-------|------|----------------|-------| + | `ActivePartitionState` | DataState | | | + | `AvailabilityState` | DiscreteState | available, unavailable | | + | `AvailableModesState` | DataState | | | + | `AvailableTargetTemperaturesState` | DataState | | | + | `BatteryDiscreteLevelState` | DiscreteState | good, medium, low, critical | | + | `BatteryLevelState` | ContinuousState | | | + | `ElectricPowerConsumptionState` | ContinuousState | | | + | `ErrorEventState` | DiscreteState | accessLimitation, internal, obstacleProtection, transportBusy, deviceNoAnswer, cancelled, deprecated, interrupted, thermalProtection, maintenanceRequired, alreadyUpToDate, notSupported, hardwareError, accessDenied, updateError, resourceAlreadyExist | | + | `ErrorState` | DataState | | | + | `ErrorsState` | DataState | | | + | `FirmwareHashState` | DataState | | | + | `FirmwareRevisionState` | DataState | | | + | `IntensityState` | ContinuousState | | | + | `LightIntensityState` | ContinuousState | [0..100] | | + | `ModeState` | DataState | | | + | `NameState` | DataState | | | + | `NewFirmwareAvailableState` | DataState | | | + | `OnOffState` | DiscreteState | on, off | | + | `Private10State` | DataState | | | + | `Private1State` | DataState | | | + | `Private2State` | DataState | | | + | `Private3State` | DataState | | | + | `Private4State` | DataState | | | + | `Private5State` | DataState | | | + | `Private6State` | DataState | | | + | `Private7State` | DataState | | | + | `Private8State` | DataState | | | + | `Private9State` | DataState | | | + | `ReachedAliasesState` | DataState | | | + | `RecommendedTargetTemperatureState` | ContinuousState | | | + | `RelativeHumidityState` | ContinuousState | [0.0..100.0] | | + | `RemovableState` | DataState | | | + | `SignalQualityState` | ContinuousState | | | + | `StatusState` | DiscreteState | available, unavailable | | + | `TargetTemperatureCurrentLowerBoundState` | ContinuousState | | | + | `TargetTemperatureCurrentUpperBoundState` | ContinuousState | | | + | `TargetTemperatureReachedState` | DataState | | | + | `TargetTemperatureState` | ContinuousState | [12.0..30.0] | | + | `TemperatureState` | ContinuousState | [-100.0..100.0] | | + | `TimezoneState` | DataState | | | + | `UnavailableFeaturesState` | DataState | | | + +??? note "HeatingSystem/DynamicHvacZone (ACTUATOR) — 18 commands, 43 states" + + **Type IDs:** `289` | **Servers:** `rexel` | **Controllable:** `ogp:HvacZone` | **Profiles:** `StatefulThermostatWithSensor`, `StatefulThermostat`, `Thermostat`, `StatefulSwitchable`, `Switchable`, `StatefulAirFan`, `AirFan` + + **Commands** + + | Command | Parameters | Notes | + |---------|-----------|-------| + | `activateOption` | STRING | Activate an option | + | `cancelHolidayMode` | | Deactivate holidays mode | + | `configureHolidayMode` | INT; INT | Configure holiday mode p1 : start date (timestamp in millisecond) p2 : end date (timestamp in millisecond) | + | `deactivateOption` | STRING | Deactivate an option | + | `executeManufacturerProcedure` | STRING; OBJECT (optional) | execute manufacturer procedure command. p1: the procedure name p2: the params associated Example: p1 = "dead_man_up" p2 = {"duration": 42} | + | `identify` | | Ask the device to identify itself by doing a slight movement or blink or beep | + | `off` | | Turn off the device | + | `on` | | Turn on the device | + | `readManufacturerData` | ARRAY | Read manufacturer data values from given names. Example: ["setting1","setting2"]. | + | `sendPrivate` | OBJECT | send a private command | + | `setFanSpeed` | STRING: low, medium, high, auto, 1 | Set the fan speed (%) | + | `setFanSpeedLevel` | INT [0..100] | Set the device fan speed level (%) | + | `setMode` | STRING | Set the active mode. | + | `setName` | STRING | Change the device internal name. Name length may be subject to restrictions depending on the device and underlying protocol. | + | `setOnOff` | STRING: off, on | Turn the device on or off | + | `setTargetTemperature` | FLOAT | Set the new air temperature to reach | + | `update` | | Update the gateway software. The update may have to be downloaded first, which can take a while. | + | `writeManufacturerData` | OBJECT | Write manufacturer data values. Example: { "setting1": true, "setting2": 42, "setting3": "overkiz", "setting4": "Dk8PDr1WD0sfAAAAAAAAAAAAAAAAAAAA", "setting5": [ "valueA", "valueB", "valueC" ], "setting6": { "value": 15, "definition": 158 } } | + + **States** + + | State | Type | Range / Values | Notes | + |-------|------|----------------|-------| + | `ActivatedOptionsState` | DataState | | | + | `ActivePartitionState` | DataState | | | + | `AvailabilityState` | DiscreteState | available, unavailable | | + | `AvailableModesState` | DataState | | | + | `AvailableOptionsState` | DataState | | | + | `AvailableTargetTemperaturesState` | DataState | | | + | `BatteryDiscreteLevelState` | DiscreteState | good, medium, low, critical | | + | `BatteryLevelState` | ContinuousState | | | + | `ErrorEventState` | DiscreteState | accessLimitation, internal, obstacleProtection, transportBusy, deviceNoAnswer, cancelled, deprecated, interrupted, thermalProtection, maintenanceRequired, alreadyUpToDate, notSupported, hardwareError, accessDenied, updateError, resourceAlreadyExist | | + | `ErrorState` | DataState | | | + | `ErrorsState` | DataState | | | + | `FanSpeedLevelState` | ContinuousState | [0..100] | | + | `FanSpeedState` | DiscreteState | low, medium, high, 1, 2, 3, 4, 5, 6, 7, 8, 9 | | + | `FirmwareHashState` | DataState | | | + | `FirmwareRevisionState` | DataState | | | + | `HolidayModeConfiguredState` | DataState | | | + | `HolidayModeEndDateTimeState` | DataState | | | + | `HolidayModeStartDateTimeState` | DataState | | | + | `ModeState` | DataState | | | + | `NameState` | DataState | | | + | `NewFirmwareAvailableState` | DataState | | | + | `OnOffState` | DiscreteState | on, off | | + | `Private10State` | DataState | | | + | `Private1State` | DataState | | | + | `Private2State` | DataState | | | + | `Private3State` | DataState | | | + | `Private4State` | DataState | | | + | `Private5State` | DataState | | | + | `Private6State` | DataState | | | + | `Private7State` | DataState | | | + | `Private8State` | DataState | | | + | `Private9State` | DataState | | | + | `RecommendedOptionsState` | DataState | | | + | `RecommendedTargetTemperatureState` | ContinuousState | | | + | `RemovableState` | DataState | | | + | `SignalQualityState` | ContinuousState | | | + | `StatusState` | DiscreteState | available, unavailable | | + | `TargetTemperatureCurrentLowerBoundState` | ContinuousState | | | + | `TargetTemperatureCurrentUpperBoundState` | ContinuousState | | | + | `TargetTemperatureReachedState` | DataState | | | + | `TargetTemperatureState` | ContinuousState | [12.0..30.0] | | + | `TemperatureState` | ContinuousState | [-100.0..100.0] | | + | `UnavailableFeaturesState` | DataState | | | + +??? note "HeatingSystem/DynamicThermostat (ACTUATOR) — 18 commands, 39 states" + + **Type IDs:** `259` | **Servers:** `somfy_europe` | **Controllable:** `ogp:Thermostat` | **Profiles:** `StatefulThermostatWithSensor`, `StatefulThermostat`, `Thermostat`, `RelativeHumidity`, `StatefulSwitchable`, `Switchable`, `StatefulAirFan`, `AirFan` + + **Commands** + + | Command | Parameters | Notes | + |---------|-----------|-------| + | `executeManufacturerProcedure` | STRING; OBJECT (optional) | execute manufacturer procedure command. p1: the procedure name p2: the params associated Example: p1 = "dead_man_up" p2 = {"duration": 42} | + | `goToAlias` | STRING | Send alias command linked with the ID. | + | `identify` | | Ask the device to identify itself by doing a slight movement or blink or beep | + | `off` | | Turn off the device | + | `on` | | Turn on the device | + | `readManufacturerData` | ARRAY | Read manufacturer data values from given names. Example: ["setting1","setting2"]. | + | `saveAlias` | STRING | Allow to send an order for the product to save the current state of the alias. | + | `sendPrivate` | OBJECT | send a private command | + | `setFanSpeed` | STRING: low, medium, high, auto, 1 | Set the fan speed (%) | + | `setFanSpeedLevel` | INT [0..100] | Set the device fan speed level (%) | + | `setMode` | STRING | Set the active mode. | + | `setName` | STRING | Change the device internal name. Name length may be subject to restrictions depending on the device and underlying protocol. | + | `setNodeDefinition` | STRING; STRING (optional); STRING (optional) | Fill the node definition (some transitions can be forbidden) p1: type (mandatory) p2: subType (mandatory if definition is set) p3: definition | + | `setOnOff` | STRING: off, on | Turn the device on or off | + | `setTargetTemperature` | FLOAT | Set the new air temperature to reach | + | `setTimezone` | STRING | Set the device timezone, according to TZ database names. | + | `update` | | Update the gateway software. The update may have to be downloaded first, which can take a while. | + | `writeManufacturerData` | OBJECT | Write manufacturer data values. Example: { "setting1": true, "setting2": 42, "setting3": "overkiz", "setting4": "Dk8PDr1WD0sfAAAAAAAAAAAAAAAAAAAA", "setting5": [ "valueA", "valueB", "valueC" ], "setting6": { "value": 15, "definition": 158 } } | + + **States** + + | State | Type | Range / Values | Notes | + |-------|------|----------------|-------| + | `ActivePartitionState` | DataState | | | + | `AvailabilityState` | DiscreteState | available, unavailable | | + | `AvailableModesState` | DataState | | | + | `AvailableTargetTemperaturesState` | DataState | | | + | `BatteryDiscreteLevelState` | DiscreteState | good, medium, low, critical | | + | `BatteryLevelState` | ContinuousState | | | + | `ErrorState` | DataState | | | + | `ErrorsState` | DataState | | | + | `FanSpeedLevelState` | ContinuousState | [0..100] | | + | `FanSpeedState` | DiscreteState | low, medium, high, 1, 2, 3, 4, 5, 6, 7, 8, 9 | | + | `FirmwareHashState` | DataState | | | + | `FirmwareRevisionState` | DataState | | | + | `ModeState` | DataState | | | + | `NameState` | DataState | | | + | `NewFirmwareAvailableState` | DataState | | | + | `OnOffState` | DiscreteState | on, off | | + | `Private10State` | DataState | | | + | `Private1State` | DataState | | | + | `Private2State` | DataState | | | + | `Private3State` | DataState | | | + | `Private4State` | DataState | | | + | `Private5State` | DataState | | | + | `Private6State` | DataState | | | + | `Private7State` | DataState | | | + | `Private8State` | DataState | | | + | `Private9State` | DataState | | | + | `ReachedAliasesState` | DataState | | | + | `RecommendedTargetTemperatureState` | ContinuousState | | | + | `RelativeHumidityState` | ContinuousState | [0.0..100.0] | | + | `RemovableState` | DataState | | | + | `SignalQualityState` | ContinuousState | | | + | `StatusState` | DiscreteState | available, unavailable | | + | `TargetTemperatureCurrentLowerBoundState` | ContinuousState | | | + | `TargetTemperatureCurrentUpperBoundState` | ContinuousState | | | + | `TargetTemperatureReachedState` | DataState | | | + | `TargetTemperatureState` | ContinuousState | [12.0..30.0] | | + | `TemperatureState` | ContinuousState | [-100.0..100.0] | | + | `TimezoneState` | DataState | | | + | `UnavailableFeaturesState` | DataState | | | + +??? note "HeatingSystem/DynamicHvacCentralUnit (ACTUATOR) — 20 commands, 40 states" + + **Type IDs:** `269` | **Servers:** `somfy_europe` | **Controllable:** `ogp:HvacCentralUnit` | **Profiles:** `StatefulThermostatWithSensor`, `StatefulThermostat`, `Thermostat`, `RelativeHumidity`, `StatefulSwitchable`, `Switchable`, `StatefulAirFan`, `AirFan` + + **Commands** + + | Command | Parameters | Notes | + |---------|-----------|-------| + | `addGroupMember` | STRING | Add member to the group p1 : Id of the member to add to the group. | + | `executeManufacturerProcedure` | STRING; OBJECT (optional) | execute manufacturer procedure command. p1: the procedure name p2: the params associated Example: p1 = "dead_man_up" p2 = {"duration": 42} | + | `goToAlias` | STRING | Send alias command linked with the ID. | + | `identify` | | Ask the device to identify itself by doing a slight movement or blink or beep | + | `off` | | Turn off the device | + | `on` | | Turn on the device | + | `readManufacturerData` | ARRAY | Read manufacturer data values from given names. Example: ["setting1","setting2"]. | + | `removeGroupMember` | STRING | Remove a member of the group. p1 : Id of the member to remove to the group. | + | `saveAlias` | STRING | Allow to send an order for the product to save the current state of the alias. | + | `sendPrivate` | OBJECT | send a private command | + | `setFanSpeed` | STRING: low, medium, high, auto, 1 | Set the fan speed (%) | + | `setFanSpeedLevel` | INT [0..100] | Set the device fan speed level (%) | + | `setMode` | STRING | Set the active mode. | + | `setName` | STRING | Change the device internal name. Name length may be subject to restrictions depending on the device and underlying protocol. | + | `setNodeDefinition` | STRING; STRING (optional); STRING (optional) | Fill the node definition (some transitions can be forbidden) p1: type (mandatory) p2: subType (mandatory if definition is set) p3: definition | + | `setOnOff` | STRING: off, on | Turn the device on or off | + | `setTargetTemperature` | FLOAT | Set the new air temperature to reach | + | `setTimezone` | STRING | Set the device timezone, according to TZ database names. | + | `update` | | Update the gateway software. The update may have to be downloaded first, which can take a while. | + | `writeManufacturerData` | OBJECT | Write manufacturer data values. Example: { "setting1": true, "setting2": 42, "setting3": "overkiz", "setting4": "Dk8PDr1WD0sfAAAAAAAAAAAAAAAAAAAA", "setting5": [ "valueA", "valueB", "valueC" ], "setting6": { "value": 15, "definition": 158 } } | + + **States** + + | State | Type | Range / Values | Notes | + |-------|------|----------------|-------| + | `ActivePartitionState` | DataState | | | + | `AvailabilityState` | DiscreteState | available, unavailable | | + | `AvailableModesState` | DataState | | | + | `AvailableTargetTemperaturesState` | DataState | | | + | `BatteryDiscreteLevelState` | DiscreteState | good, medium, low, critical | | + | `BatteryLevelState` | ContinuousState | | | + | `ErrorState` | DataState | | | + | `ErrorsState` | DataState | | | + | `FanSpeedLevelState` | ContinuousState | [0..100] | | + | `FanSpeedState` | DiscreteState | low, medium, high, 1, 2, 3, 4, 5, 6, 7, 8, 9 | | + | `FirmwareHashState` | DataState | | | + | `FirmwareRevisionState` | DataState | | | + | `GroupMembersState` | DataState | | | + | `ModeState` | DataState | | | + | `NameState` | DataState | | | + | `NewFirmwareAvailableState` | DataState | | | + | `OnOffState` | DiscreteState | on, off | | + | `Private10State` | DataState | | | + | `Private1State` | DataState | | | + | `Private2State` | DataState | | | + | `Private3State` | DataState | | | + | `Private4State` | DataState | | | + | `Private5State` | DataState | | | + | `Private6State` | DataState | | | + | `Private7State` | DataState | | | + | `Private8State` | DataState | | | + | `Private9State` | DataState | | | + | `ReachedAliasesState` | DataState | | | + | `RecommendedTargetTemperatureState` | ContinuousState | | | + | `RelativeHumidityState` | ContinuousState | [0.0..100.0] | | + | `RemovableState` | DataState | | | + | `SignalQualityState` | ContinuousState | | | + | `StatusState` | DiscreteState | available, unavailable | | + | `TargetTemperatureCurrentLowerBoundState` | ContinuousState | | | + | `TargetTemperatureCurrentUpperBoundState` | ContinuousState | | | + | `TargetTemperatureReachedState` | DataState | | | + | `TargetTemperatureState` | ContinuousState | [12.0..30.0] | | + | `TemperatureState` | ContinuousState | [-100.0..100.0] | | + | `TimezoneState` | DataState | | | + | `UnavailableFeaturesState` | DataState | | | + +??? note "HeatingSystem/DynamicHeater (ACTUATOR) — 17 commands, 40 states" + + **Type IDs:** `278` | **Servers:** `somfy_europe` | **Controllable:** `ogp:Heater` | **Profiles:** `StatefulThermostatWithSensor`, `StatefulThermostat`, `Thermostat`, `RelativeHumidity`, `ElectricPowerMeter`, `StatefulSwitchable`, `Switchable`, `StatefulDimmable`, `Dimmable` + + **Commands** + + | Command | Parameters | Notes | + |---------|-----------|-------| + | `executeManufacturerProcedure` | STRING; OBJECT (optional) | execute manufacturer procedure command. p1: the procedure name p2: the params associated Example: p1 = "dead_man_up" p2 = {"duration": 42} | + | `goToAlias` | STRING | Send alias command linked with the ID. | + | `identify` | | Ask the device to identify itself by doing a slight movement or blink or beep | + | `off` | | Turn off the device | + | `on` | | Turn on the device | + | `readManufacturerData` | ARRAY | Read manufacturer data values from given names. Example: ["setting1","setting2"]. | + | `saveAlias` | STRING | Allow to send an order for the product to save the current state of the alias. | + | `sendPrivate` | OBJECT | send a private command | + | `setIntensity` | INT [0..100] | Light intensity level (100%=maximum intensity, 0%=off) | + | `setMode` | STRING | Set the active mode. | + | `setName` | STRING | Change the device internal name. Name length may be subject to restrictions depending on the device and underlying protocol. | + | `setNodeDefinition` | STRING; STRING (optional); STRING (optional) | Fill the node definition (some transitions can be forbidden) p1: type (mandatory) p2: subType (mandatory if definition is set) p3: definition | + | `setOnOff` | STRING: off, on | Turn the device on or off | + | `setTargetTemperature` | FLOAT | Set the new air temperature to reach | + | `setTimezone` | STRING | Set the device timezone, according to TZ database names. | + | `update` | | Update the gateway software. The update may have to be downloaded first, which can take a while. | + | `writeManufacturerData` | OBJECT | Write manufacturer data values. Example: { "setting1": true, "setting2": 42, "setting3": "overkiz", "setting4": "Dk8PDr1WD0sfAAAAAAAAAAAAAAAAAAAA", "setting5": [ "valueA", "valueB", "valueC" ], "setting6": { "value": 15, "definition": 158 } } | + + **States** + + | State | Type | Range / Values | Notes | + |-------|------|----------------|-------| + | `ActivePartitionState` | DataState | | | + | `AvailabilityState` | DiscreteState | available, unavailable | | + | `AvailableModesState` | DataState | | | + | `AvailableTargetTemperaturesState` | DataState | | | + | `BatteryDiscreteLevelState` | DiscreteState | good, medium, low, critical | | + | `BatteryLevelState` | ContinuousState | | | + | `ElectricPowerConsumptionState` | ContinuousState | | | + | `ErrorState` | DataState | | | + | `ErrorsState` | DataState | | | + | `FirmwareHashState` | DataState | | | + | `FirmwareRevisionState` | DataState | | | + | `IntensityState` | ContinuousState | | | + | `LightIntensityState` | ContinuousState | [0..100] | | + | `ModeState` | DataState | | | + | `NameState` | DataState | | | + | `NewFirmwareAvailableState` | DataState | | | + | `OnOffState` | DiscreteState | on, off | | + | `Private10State` | DataState | | | + | `Private1State` | DataState | | | + | `Private2State` | DataState | | | + | `Private3State` | DataState | | | + | `Private4State` | DataState | | | + | `Private5State` | DataState | | | + | `Private6State` | DataState | | | + | `Private7State` | DataState | | | + | `Private8State` | DataState | | | + | `Private9State` | DataState | | | + | `ReachedAliasesState` | DataState | | | + | `RecommendedTargetTemperatureState` | ContinuousState | | | + | `RelativeHumidityState` | ContinuousState | [0.0..100.0] | | + | `RemovableState` | DataState | | | + | `SignalQualityState` | ContinuousState | | | + | `StatusState` | DiscreteState | available, unavailable | | + | `TargetTemperatureCurrentLowerBoundState` | ContinuousState | | | + | `TargetTemperatureCurrentUpperBoundState` | ContinuousState | | | + | `TargetTemperatureReachedState` | DataState | | | + | `TargetTemperatureState` | ContinuousState | [12.0..30.0] | | + | `TemperatureState` | ContinuousState | [-100.0..100.0] | | + | `TimezoneState` | DataState | | | + | `UnavailableFeaturesState` | DataState | | | + +??? note "HeatingSystem/DynamicHvacZone (ACTUATOR) — 18 commands, 42 states" + + **Type IDs:** `289` | **Servers:** `somfy_europe` | **Controllable:** `ogp:HvacZone` | **Profiles:** `StatefulThermostatWithSensor`, `StatefulThermostat`, `Thermostat`, `StatefulSwitchable`, `Switchable`, `StatefulAirFan`, `AirFan` + + **Commands** + + | Command | Parameters | Notes | + |---------|-----------|-------| + | `activateOption` | STRING | Activate an option | + | `cancelHolidayMode` | | Deactivate holidays mode | + | `configureHolidayMode` | INT; INT | Configure holiday mode p1 : start date (timestamp in millisecond) p2 : end date (timestamp in millisecond) | + | `deactivateOption` | STRING | Deactivate an option | + | `executeManufacturerProcedure` | STRING; OBJECT (optional) | execute manufacturer procedure command. p1: the procedure name p2: the params associated Example: p1 = "dead_man_up" p2 = {"duration": 42} | + | `identify` | | Ask the device to identify itself by doing a slight movement or blink or beep | + | `off` | | Turn off the device | + | `on` | | Turn on the device | + | `readManufacturerData` | ARRAY | Read manufacturer data values from given names. Example: ["setting1","setting2"]. | + | `sendPrivate` | OBJECT | send a private command | + | `setFanSpeed` | STRING: low, medium, high, auto, 1 | Set the fan speed (%) | + | `setFanSpeedLevel` | INT [0..100] | Set the device fan speed level (%) | + | `setMode` | STRING | Set the active mode. | + | `setName` | STRING | Change the device internal name. Name length may be subject to restrictions depending on the device and underlying protocol. | + | `setOnOff` | STRING: off, on | Turn the device on or off | + | `setTargetTemperature` | FLOAT | Set the new air temperature to reach | + | `update` | | Update the gateway software. The update may have to be downloaded first, which can take a while. | + | `writeManufacturerData` | OBJECT | Write manufacturer data values. Example: { "setting1": true, "setting2": 42, "setting3": "overkiz", "setting4": "Dk8PDr1WD0sfAAAAAAAAAAAAAAAAAAAA", "setting5": [ "valueA", "valueB", "valueC" ], "setting6": { "value": 15, "definition": 158 } } | + + **States** + + | State | Type | Range / Values | Notes | + |-------|------|----------------|-------| + | `ActivatedOptionsState` | DataState | | | + | `ActivePartitionState` | DataState | | | + | `AvailabilityState` | DiscreteState | available, unavailable | | + | `AvailableModesState` | DataState | | | + | `AvailableOptionsState` | DataState | | | + | `AvailableTargetTemperaturesState` | DataState | | | + | `BatteryDiscreteLevelState` | DiscreteState | good, medium, low, critical | | + | `BatteryLevelState` | ContinuousState | | | + | `ErrorState` | DataState | | | + | `ErrorsState` | DataState | | | + | `FanSpeedLevelState` | ContinuousState | [0..100] | | + | `FanSpeedState` | DiscreteState | low, medium, high, 1, 2, 3, 4, 5, 6, 7, 8, 9 | | + | `FirmwareHashState` | DataState | | | + | `FirmwareRevisionState` | DataState | | | + | `HolidayModeConfiguredState` | DataState | | | + | `HolidayModeEndDateTimeState` | DataState | | | + | `HolidayModeStartDateTimeState` | DataState | | | + | `ModeState` | DataState | | | + | `NameState` | DataState | | | + | `NewFirmwareAvailableState` | DataState | | | + | `OnOffState` | DiscreteState | on, off | | + | `Private10State` | DataState | | | + | `Private1State` | DataState | | | + | `Private2State` | DataState | | | + | `Private3State` | DataState | | | + | `Private4State` | DataState | | | + | `Private5State` | DataState | | | + | `Private6State` | DataState | | | + | `Private7State` | DataState | | | + | `Private8State` | DataState | | | + | `Private9State` | DataState | | | + | `RecommendedOptionsState` | DataState | | | + | `RecommendedTargetTemperatureState` | ContinuousState | | | + | `RemovableState` | DataState | | | + | `SignalQualityState` | ContinuousState | | | + | `StatusState` | DiscreteState | available, unavailable | | + | `TargetTemperatureCurrentLowerBoundState` | ContinuousState | | | + | `TargetTemperatureCurrentUpperBoundState` | ContinuousState | | | + | `TargetTemperatureReachedState` | DataState | | | + | `TargetTemperatureState` | ContinuousState | [12.0..30.0] | | + | `TemperatureState` | ContinuousState | [-100.0..100.0] | | + | `UnavailableFeaturesState` | DataState | | | + +??? note "HumiditySensor/DynamicHumiditySensor (SENSOR) — 7 commands, 25 states" + + **Type IDs:** `276` | **Servers:** `rexel` | **Controllable:** `ogp:HumiditySensor` | **Profiles:** `RelativeHumidity` + + **Commands** + + | Command | Parameters | Notes | + |---------|-----------|-------| + | `executeManufacturerProcedure` | STRING; OBJECT (optional) | execute manufacturer procedure command. p1: the procedure name p2: the params associated Example: p1 = "dead_man_up" p2 = {"duration": 42} | + | `identify` | | Ask the device to identify itself by doing a slight movement or blink or beep | + | `readManufacturerData` | ARRAY | Read manufacturer data values from given names. Example: ["setting1","setting2"]. | + | `sendPrivate` | OBJECT | send a private command | + | `setName` | STRING | Change the device internal name. Name length may be subject to restrictions depending on the device and underlying protocol. | + | `update` | | Update the gateway software. The update may have to be downloaded first, which can take a while. | + | `writeManufacturerData` | OBJECT | Write manufacturer data values. Example: { "setting1": true, "setting2": 42, "setting3": "overkiz", "setting4": "Dk8PDr1WD0sfAAAAAAAAAAAAAAAAAAAA", "setting5": [ "valueA", "valueB", "valueC" ], "setting6": { "value": 15, "definition": 158 } } | + + **States** + + | State | Type | Range / Values | Notes | + |-------|------|----------------|-------| + | `ActivePartitionState` | DataState | | | + | `AvailabilityState` | DiscreteState | available, unavailable | | + | `BatteryDiscreteLevelState` | DiscreteState | good, medium, low, critical | | + | `BatteryLevelState` | ContinuousState | | | + | `ErrorEventState` | DiscreteState | accessLimitation, internal, obstacleProtection, transportBusy, deviceNoAnswer, cancelled, deprecated, interrupted, thermalProtection, maintenanceRequired, alreadyUpToDate, notSupported, hardwareError, accessDenied, updateError, resourceAlreadyExist | | + | `ErrorState` | DataState | | | + | `ErrorsState` | DataState | | | + | `FirmwareHashState` | DataState | | | + | `FirmwareRevisionState` | DataState | | | + | `NameState` | DataState | | | + | `NewFirmwareAvailableState` | DataState | | | + | `Private10State` | DataState | | | + | `Private1State` | DataState | | | + | `Private2State` | DataState | | | + | `Private3State` | DataState | | | + | `Private4State` | DataState | | | + | `Private5State` | DataState | | | + | `Private6State` | DataState | | | + | `Private7State` | DataState | | | + | `Private8State` | DataState | | | + | `Private9State` | DataState | | | + | `RelativeHumidityState` | ContinuousState | [0.0..100.0] | | + | `RemovableState` | DataState | | | + | `SignalQualityState` | ContinuousState | | | + | `StatusState` | DiscreteState | available, unavailable | | + +??? note "HumiditySensor/DynamicHumiditySensor (SENSOR) — 7 commands, 24 states" + + **Type IDs:** `276` | **Servers:** `somfy_europe` | **Controllable:** `ogp:HumiditySensor` | **Profiles:** `RelativeHumidity` + + **Commands** + + | Command | Parameters | Notes | + |---------|-----------|-------| + | `executeManufacturerProcedure` | STRING; OBJECT (optional) | execute manufacturer procedure command. p1: the procedure name p2: the params associated Example: p1 = "dead_man_up" p2 = {"duration": 42} | + | `identify` | | Ask the device to identify itself by doing a slight movement or blink or beep | + | `readManufacturerData` | ARRAY | Read manufacturer data values from given names. Example: ["setting1","setting2"]. | + | `sendPrivate` | OBJECT | send a private command | + | `setName` | STRING | Change the device internal name. Name length may be subject to restrictions depending on the device and underlying protocol. | + | `update` | | Update the gateway software. The update may have to be downloaded first, which can take a while. | + | `writeManufacturerData` | OBJECT | Write manufacturer data values. Example: { "setting1": true, "setting2": 42, "setting3": "overkiz", "setting4": "Dk8PDr1WD0sfAAAAAAAAAAAAAAAAAAAA", "setting5": [ "valueA", "valueB", "valueC" ], "setting6": { "value": 15, "definition": 158 } } | + + **States** + + | State | Type | Range / Values | Notes | + |-------|------|----------------|-------| + | `ActivePartitionState` | DataState | | | + | `AvailabilityState` | DiscreteState | available, unavailable | | + | `BatteryDiscreteLevelState` | DiscreteState | good, medium, low, critical | | + | `BatteryLevelState` | ContinuousState | | | + | `ErrorState` | DataState | | | + | `ErrorsState` | DataState | | | + | `FirmwareHashState` | DataState | | | + | `FirmwareRevisionState` | DataState | | | + | `NameState` | DataState | | | + | `NewFirmwareAvailableState` | DataState | | | + | `Private10State` | DataState | | | + | `Private1State` | DataState | | | + | `Private2State` | DataState | | | + | `Private3State` | DataState | | | + | `Private4State` | DataState | | | + | `Private5State` | DataState | | | + | `Private6State` | DataState | | | + | `Private7State` | DataState | | | + | `Private8State` | DataState | | | + | `Private9State` | DataState | | | + | `RelativeHumidityState` | ContinuousState | [0.0..100.0] | | + | `RemovableState` | DataState | | | + | `SignalQualityState` | ContinuousState | | | + | `StatusState` | DiscreteState | available, unavailable | | + +??? note "IntrusionSensor/DynamicIntrusionSensor (SENSOR) — 8 commands, 27 states" + + **Type IDs:** `281` | **Servers:** `rexel` | **Controllable:** `ogp:IntrusionSensor` | **Profiles:** `IntrusionDetector` + + **Commands** + + | Command | Parameters | Notes | + |---------|-----------|-------| + | `executeManufacturerProcedure` | STRING; OBJECT (optional) | execute manufacturer procedure command. p1: the procedure name p2: the params associated Example: p1 = "dead_man_up" p2 = {"duration": 42} | + | `identify` | | Ask the device to identify itself by doing a slight movement or blink or beep | + | `readManufacturerData` | ARRAY | Read manufacturer data values from given names. Example: ["setting1","setting2"]. | + | `sendPrivate` | OBJECT | send a private command | + | `setName` | STRING | Change the device internal name. Name length may be subject to restrictions depending on the device and underlying protocol. | + | `setNodeDefinition` | STRING; STRING (optional); STRING (optional) | Fill the node definition (some transitions can be forbidden) p1: type (mandatory) p2: subType (mandatory if definition is set) p3: definition | + | `update` | | Update the gateway software. The update may have to be downloaded first, which can take a while. | + | `writeManufacturerData` | OBJECT | Write manufacturer data values. Example: { "setting1": true, "setting2": 42, "setting3": "overkiz", "setting4": "Dk8PDr1WD0sfAAAAAAAAAAAAAAAAAAAA", "setting5": [ "valueA", "valueB", "valueC" ], "setting6": { "value": 15, "definition": 158 } } | + + **States** + + | State | Type | Range / Values | Notes | + |-------|------|----------------|-------| + | `ActivePartitionState` | DataState | | | + | `AvailabilityState` | DiscreteState | available, unavailable | | + | `BatteryDiscreteLevelState` | DiscreteState | good, medium, low, critical | | + | `BatteryLevelState` | ContinuousState | | | + | `ErrorEventState` | DiscreteState | accessLimitation, internal, obstacleProtection, transportBusy, deviceNoAnswer, cancelled, deprecated, interrupted, thermalProtection, maintenanceRequired, alreadyUpToDate, notSupported, hardwareError, accessDenied, updateError, resourceAlreadyExist | | + | `ErrorState` | DataState | | | + | `ErrorsState` | DataState | | | + | `FirmwareHashState` | DataState | | | + | `FirmwareRevisionState` | DataState | | | + | `IntrusionDetectionEventState` | DiscreteState | panic, intrusion | | + | `IntrusionState` | DiscreteState | detected, notDetected | | + | `NameState` | DataState | | | + | `NewFirmwareAvailableState` | DataState | | | + | `PanicEventState` | DataState | | | + | `Private10State` | DataState | | | + | `Private1State` | DataState | | | + | `Private2State` | DataState | | | + | `Private3State` | DataState | | | + | `Private4State` | DataState | | | + | `Private5State` | DataState | | | + | `Private6State` | DataState | | | + | `Private7State` | DataState | | | + | `Private8State` | DataState | | | + | `Private9State` | DataState | | | + | `RemovableState` | DataState | | | + | `SignalQualityState` | ContinuousState | | | + | `StatusState` | DiscreteState | available, unavailable | | + +??? note "IntrusionSensor/DynamicIntrusionSensor (SENSOR) — 8 commands, 26 states" + + **Type IDs:** `281` | **Servers:** `somfy_europe` | **Controllable:** `ogp:IntrusionSensor` | **Profiles:** `IntrusionDetector` + + **Commands** + + | Command | Parameters | Notes | + |---------|-----------|-------| + | `executeManufacturerProcedure` | STRING; OBJECT (optional) | execute manufacturer procedure command. p1: the procedure name p2: the params associated Example: p1 = "dead_man_up" p2 = {"duration": 42} | + | `identify` | | Ask the device to identify itself by doing a slight movement or blink or beep | + | `readManufacturerData` | ARRAY | Read manufacturer data values from given names. Example: ["setting1","setting2"]. | + | `sendPrivate` | OBJECT | send a private command | + | `setName` | STRING | Change the device internal name. Name length may be subject to restrictions depending on the device and underlying protocol. | + | `setNodeDefinition` | STRING; STRING (optional); STRING (optional) | Fill the node definition (some transitions can be forbidden) p1: type (mandatory) p2: subType (mandatory if definition is set) p3: definition | + | `update` | | Update the gateway software. The update may have to be downloaded first, which can take a while. | + | `writeManufacturerData` | OBJECT | Write manufacturer data values. Example: { "setting1": true, "setting2": 42, "setting3": "overkiz", "setting4": "Dk8PDr1WD0sfAAAAAAAAAAAAAAAAAAAA", "setting5": [ "valueA", "valueB", "valueC" ], "setting6": { "value": 15, "definition": 158 } } | + + **States** + + | State | Type | Range / Values | Notes | + |-------|------|----------------|-------| + | `ActivePartitionState` | DataState | | | + | `AvailabilityState` | DiscreteState | available, unavailable | | + | `BatteryDiscreteLevelState` | DiscreteState | good, medium, low, critical | | + | `BatteryLevelState` | ContinuousState | | | + | `ErrorState` | DataState | | | + | `ErrorsState` | DataState | | | + | `FirmwareHashState` | DataState | | | + | `FirmwareRevisionState` | DataState | | | + | `IntrusionEventState` | DiscreteState | | | + | `IntrusionState` | DiscreteState | detected, notDetected | | + | `NameState` | DataState | | | + | `NewFirmwareAvailableState` | DataState | | | + | `PanicEventState` | DataState | | | + | `Private10State` | DataState | | | + | `Private1State` | DataState | | | + | `Private2State` | DataState | | | + | `Private3State` | DataState | | | + | `Private4State` | DataState | | | + | `Private5State` | DataState | | | + | `Private6State` | DataState | | | + | `Private7State` | DataState | | | + | `Private8State` | DataState | | | + | `Private9State` | DataState | | | + | `RemovableState` | DataState | | | + | `SignalQualityState` | ContinuousState | | | + | `StatusState` | DiscreteState | available, unavailable | | + +??? note "Light/DynamicLight (ACTUATOR) — 20 commands, 32 states" + + **Type IDs:** `257` | **Servers:** `rexel` | **Controllable:** `ogp:Light` | **Profiles:** `StatefulLightDimmer`, `ElectricPowerMeter`, `StatefulSwitchable`, `Switchable`, `StatefulDimmable`, `Dimmable`, `Cyclic` + + **Commands** + + | Command | Parameters | Notes | + |---------|-----------|-------| + | `cycle` | | Do a cycle of supported motion kinematics or modes | + | `dimDown` | | Decrease the light intensity step by step | + | `dimUp` | | Increase the light intensity step by step | + | `executeManufacturerProcedure` | STRING; OBJECT (optional) | execute manufacturer procedure command. p1: the procedure name p2: the params associated Example: p1 = "dead_man_up" p2 = {"duration": 42} | + | `goToAlias` | STRING | Send alias command linked with the ID. | + | `identify` | | Ask the device to identify itself by doing a slight movement or blink or beep | + | `off` | | Turn off the device | + | `on` | | Turn on the device | + | `readManufacturerData` | ARRAY | Read manufacturer data values from given names. Example: ["setting1","setting2"]. | + | `saveAlias` | STRING | Allow to send an order for the product to save the current state of the alias. | + | `sendPrivate` | OBJECT | send a private command | + | `setColorTemperature` | INT [1000..10000] | Set the perceived white temperature for this lamp (°K) | + | `setIntensity` | INT [0..100] | Light intensity level (100%=maximum intensity, 0%=off) | + | `setName` | STRING | Change the device internal name. Name length may be subject to restrictions depending on the device and underlying protocol. | + | `setNodeDefinition` | STRING; STRING (optional); STRING (optional) | Fill the node definition (some transitions can be forbidden) p1: type (mandatory) p2: subType (mandatory if definition is set) p3: definition | + | `setOnOff` | STRING: off, on | Turn the device on or off | + | `setRGB` | INT [0..255]; INT [0..255]; INT [0..255] | Set the Red,Green,Blue components of the lamp color | + | `toggle` | | Toggle on/off status | + | `update` | | Update the gateway software. The update may have to be downloaded first, which can take a while. | + | `writeManufacturerData` | OBJECT | Write manufacturer data values. Example: { "setting1": true, "setting2": 42, "setting3": "overkiz", "setting4": "Dk8PDr1WD0sfAAAAAAAAAAAAAAAAAAAA", "setting5": [ "valueA", "valueB", "valueC" ], "setting6": { "value": 15, "definition": 158 } } | + + **States** + + | State | Type | Range / Values | Notes | + |-------|------|----------------|-------| + | `ActivePartitionState` | DataState | | | + | `AvailabilityState` | DiscreteState | available, unavailable | | + | `BatteryDiscreteLevelState` | DiscreteState | good, medium, low, critical | | + | `BatteryLevelState` | ContinuousState | | | + | `ColorModeState` | DiscreteState | cieXYZ, hueAndStaturation, temperature, rgb | | + | `ColorTemperatureState` | ContinuousState | | | + | `ElectricPowerConsumptionState` | ContinuousState | | | + | `ErrorEventState` | DiscreteState | accessLimitation, internal, obstacleProtection, transportBusy, deviceNoAnswer, cancelled, deprecated, interrupted, thermalProtection, maintenanceRequired, alreadyUpToDate, notSupported, hardwareError, accessDenied, updateError, resourceAlreadyExist | | + | `ErrorState` | DataState | | | + | `ErrorsState` | DataState | | | + | `FirmwareHashState` | DataState | | | + | `FirmwareRevisionState` | DataState | | | + | `IntensityState` | ContinuousState | | | + | `LightIntensityState` | ContinuousState | [0..100] | | + | `NameState` | DataState | | | + | `NewFirmwareAvailableState` | DataState | | | + | `OnOffState` | DiscreteState | on, off | | + | `Private10State` | DataState | | | + | `Private1State` | DataState | | | + | `Private2State` | DataState | | | + | `Private3State` | DataState | | | + | `Private4State` | DataState | | | + | `Private5State` | DataState | | | + | `Private6State` | DataState | | | + | `Private7State` | DataState | | | + | `Private8State` | DataState | | | + | `Private9State` | DataState | | | + | `RGBColorState` | DataState | | | + | `ReachedAliasesState` | DataState | | | + | `RemovableState` | DataState | | | + | `SignalQualityState` | ContinuousState | | | + | `StatusState` | DiscreteState | available, unavailable | | + +??? note "Light/DynamicLight (ACTUATOR) — 20 commands, 31 states" + + **Type IDs:** `257` | **Servers:** `somfy_europe` | **Controllable:** `ogp:Light` | **Profiles:** `StatefulLightDimmer`, `ElectricPowerMeter`, `StatefulSwitchable`, `Switchable`, `StatefulDimmable`, `Dimmable`, `Cyclic` + + **Commands** + + | Command | Parameters | Notes | + |---------|-----------|-------| + | `cycle` | | Do a cycle of supported motion kinematics or modes | + | `dimDown` | | Decrease the light intensity step by step | + | `dimUp` | | Increase the light intensity step by step | + | `executeManufacturerProcedure` | STRING; OBJECT (optional) | execute manufacturer procedure command. p1: the procedure name p2: the params associated Example: p1 = "dead_man_up" p2 = {"duration": 42} | + | `goToAlias` | STRING | Send alias command linked with the ID. | + | `identify` | | Ask the device to identify itself by doing a slight movement or blink or beep | + | `off` | | Turn off the device | + | `on` | | Turn on the device | + | `readManufacturerData` | ARRAY | Read manufacturer data values from given names. Example: ["setting1","setting2"]. | + | `saveAlias` | STRING | Allow to send an order for the product to save the current state of the alias. | + | `sendPrivate` | OBJECT | send a private command | + | `setColorTemperature` | INT [1000..10000] | Set the perceived white temperature for this lamp (°K) | + | `setIntensity` | INT [0..100] | Light intensity level (100%=maximum intensity, 0%=off) | + | `setName` | STRING | Change the device internal name. Name length may be subject to restrictions depending on the device and underlying protocol. | + | `setNodeDefinition` | STRING; STRING (optional); STRING (optional) | Fill the node definition (some transitions can be forbidden) p1: type (mandatory) p2: subType (mandatory if definition is set) p3: definition | + | `setOnOff` | STRING: off, on | Turn the device on or off | + | `setRGB` | INT [0..255]; INT [0..255]; INT [0..255] | Set the Red,Green,Blue components of the lamp color | + | `toggle` | | Toggle on/off status | + | `update` | | Update the gateway software. The update may have to be downloaded first, which can take a while. | + | `writeManufacturerData` | OBJECT | Write manufacturer data values. Example: { "setting1": true, "setting2": 42, "setting3": "overkiz", "setting4": "Dk8PDr1WD0sfAAAAAAAAAAAAAAAAAAAA", "setting5": [ "valueA", "valueB", "valueC" ], "setting6": { "value": 15, "definition": 158 } } | + + **States** + + | State | Type | Range / Values | Notes | + |-------|------|----------------|-------| + | `ActivePartitionState` | DataState | | | + | `AvailabilityState` | DiscreteState | available, unavailable | | + | `BatteryDiscreteLevelState` | DiscreteState | good, medium, low, critical | | + | `BatteryLevelState` | ContinuousState | | | + | `ColorModeState` | DiscreteState | cieXYZ, hueAndStaturation, temperature, rgb | | + | `ColorTemperatureState` | ContinuousState | | | + | `ElectricPowerConsumptionState` | ContinuousState | | | + | `ErrorState` | DataState | | | + | `ErrorsState` | DataState | | | + | `FirmwareHashState` | DataState | | | + | `FirmwareRevisionState` | DataState | | | + | `IntensityState` | ContinuousState | | | + | `LightIntensityState` | ContinuousState | [0..100] | | + | `NameState` | DataState | | | + | `NewFirmwareAvailableState` | DataState | | | + | `OnOffState` | DiscreteState | on, off | | + | `Private10State` | DataState | | | + | `Private1State` | DataState | | | + | `Private2State` | DataState | | | + | `Private3State` | DataState | | | + | `Private4State` | DataState | | | + | `Private5State` | DataState | | | + | `Private6State` | DataState | | | + | `Private7State` | DataState | | | + | `Private8State` | DataState | | | + | `Private9State` | DataState | | | + | `RGBColorState` | DataState | | | + | `ReachedAliasesState` | DataState | | | + | `RemovableState` | DataState | | | + | `SignalQualityState` | ContinuousState | | | + | `StatusState` | DiscreteState | available, unavailable | | + +??? note "LightSensor/DynamicLightSensor (SENSOR) — 7 commands, 26 states" + + **Type IDs:** `273` | **Servers:** `rexel` | **Controllable:** `ogp:LightSensor` | **Profiles:** `Luminance` + + **Commands** + + | Command | Parameters | Notes | + |---------|-----------|-------| + | `executeManufacturerProcedure` | STRING; OBJECT (optional) | execute manufacturer procedure command. p1: the procedure name p2: the params associated Example: p1 = "dead_man_up" p2 = {"duration": 42} | + | `identify` | | Ask the device to identify itself by doing a slight movement or blink or beep | + | `readManufacturerData` | ARRAY | Read manufacturer data values from given names. Example: ["setting1","setting2"]. | + | `sendPrivate` | OBJECT | send a private command | + | `setName` | STRING | Change the device internal name. Name length may be subject to restrictions depending on the device and underlying protocol. | + | `update` | | Update the gateway software. The update may have to be downloaded first, which can take a while. | + | `writeManufacturerData` | OBJECT | Write manufacturer data values. Example: { "setting1": true, "setting2": 42, "setting3": "overkiz", "setting4": "Dk8PDr1WD0sfAAAAAAAAAAAAAAAAAAAA", "setting5": [ "valueA", "valueB", "valueC" ], "setting6": { "value": 15, "definition": 158 } } | + + **States** + + | State | Type | Range / Values | Notes | + |-------|------|----------------|-------| + | `ActivePartitionState` | DataState | | | + | `AvailabilityState` | DiscreteState | available, unavailable | | + | `BatteryDiscreteLevelState` | DiscreteState | good, medium, low, critical | | + | `BatteryLevelState` | ContinuousState | | | + | `ErrorEventState` | DiscreteState | accessLimitation, internal, obstacleProtection, transportBusy, deviceNoAnswer, cancelled, deprecated, interrupted, thermalProtection, maintenanceRequired, alreadyUpToDate, notSupported, hardwareError, accessDenied, updateError, resourceAlreadyExist | | + | `ErrorState` | DataState | | | + | `ErrorsState` | DataState | | | + | `FirmwareHashState` | DataState | | | + | `FirmwareRevisionState` | DataState | | | + | `IlluminanceState` | ContinuousState | | | + | `LuminanceState` | ContinuousState | | | + | `NameState` | DataState | | | + | `NewFirmwareAvailableState` | DataState | | | + | `Private10State` | DataState | | | + | `Private1State` | DataState | | | + | `Private2State` | DataState | | | + | `Private3State` | DataState | | | + | `Private4State` | DataState | | | + | `Private5State` | DataState | | | + | `Private6State` | DataState | | | + | `Private7State` | DataState | | | + | `Private8State` | DataState | | | + | `Private9State` | DataState | | | + | `RemovableState` | DataState | | | + | `SignalQualityState` | ContinuousState | | | + | `StatusState` | DiscreteState | available, unavailable | | + +??? note "LightSensor/DynamicLightSensor (SENSOR) — 7 commands, 25 states" + + **Type IDs:** `273` | **Servers:** `somfy_europe` | **Controllable:** `ogp:LightSensor` | **Profiles:** `Luminance` + + **Commands** + + | Command | Parameters | Notes | + |---------|-----------|-------| + | `executeManufacturerProcedure` | STRING; OBJECT (optional) | execute manufacturer procedure command. p1: the procedure name p2: the params associated Example: p1 = "dead_man_up" p2 = {"duration": 42} | + | `identify` | | Ask the device to identify itself by doing a slight movement or blink or beep | + | `readManufacturerData` | ARRAY | Read manufacturer data values from given names. Example: ["setting1","setting2"]. | + | `sendPrivate` | OBJECT | send a private command | + | `setName` | STRING | Change the device internal name. Name length may be subject to restrictions depending on the device and underlying protocol. | + | `update` | | Update the gateway software. The update may have to be downloaded first, which can take a while. | + | `writeManufacturerData` | OBJECT | Write manufacturer data values. Example: { "setting1": true, "setting2": 42, "setting3": "overkiz", "setting4": "Dk8PDr1WD0sfAAAAAAAAAAAAAAAAAAAA", "setting5": [ "valueA", "valueB", "valueC" ], "setting6": { "value": 15, "definition": 158 } } | + + **States** + + | State | Type | Range / Values | Notes | + |-------|------|----------------|-------| + | `ActivePartitionState` | DataState | | | + | `AvailabilityState` | DiscreteState | available, unavailable | | + | `BatteryDiscreteLevelState` | DiscreteState | good, medium, low, critical | | + | `BatteryLevelState` | ContinuousState | | | + | `ErrorState` | DataState | | | + | `ErrorsState` | DataState | | | + | `FirmwareHashState` | DataState | | | + | `FirmwareRevisionState` | DataState | | | + | `IlluminanceState` | ContinuousState | | | + | `LuminanceState` | ContinuousState | | | + | `NameState` | DataState | | | + | `NewFirmwareAvailableState` | DataState | | | + | `Private10State` | DataState | | | + | `Private1State` | DataState | | | + | `Private2State` | DataState | | | + | `Private3State` | DataState | | | + | `Private4State` | DataState | | | + | `Private5State` | DataState | | | + | `Private6State` | DataState | | | + | `Private7State` | DataState | | | + | `Private8State` | DataState | | | + | `Private9State` | DataState | | | + | `RemovableState` | DataState | | | + | `SignalQualityState` | ContinuousState | | | + | `StatusState` | DiscreteState | available, unavailable | | + +??? note "MusicPlayer/DynamicAudioPlayer (ACTUATOR) — 29 commands, 39 states" + + **Type IDs:** `288` | **Servers:** `rexel` | **Controllable:** `ogp:AudioPlayer` | **Profiles:** `StoppableMusicPlayer`, `MusicPlayer`, `StatefulStartStop`, `StartStop`, `VolumeControl`, `StatefulSwitchable`, `Switchable` + + **Commands** + + | Command | Parameters | Notes | + |---------|-----------|-------| + | `activateOption` | STRING | Activate an option | + | `addGroupMember` | STRING | Add member to the group p1 : Id of the member to add to the group. | + | `deactivateOption` | STRING | Deactivate an option | + | `executeManufacturerProcedure` | STRING; OBJECT (optional) | execute manufacturer procedure command. p1: the procedure name p2: the params associated Example: p1 = "dead_man_up" p2 = {"duration": 42} | + | `fastBackward` | INT | Go to a backward position for a specified time. p1 : Amount of time in sec. | + | `fastForward` | INT | Go to a forward position for a specified time. p1 : Amount of time in sec. | + | `getMediaElements` | | Get the list of all media available. | + | `identify` | | Ask the device to identify itself by doing a slight movement or blink or beep | + | `mute` | | Mute the device | + | `next` | | Play next track | + | `off` | | Turn off the device | + | `on` | | Turn on the device | + | `pause` | | Pause current action | + | `play` | | Play media | + | `previous` | | Play previous track | + | `readManufacturerData` | ARRAY | Read manufacturer data values from given names. Example: ["setting1","setting2"]. | + | `removeGroupMember` | STRING | Remove a member of the group. p1 : Id of the member to remove to the group. | + | `resume` | | Resume paused action. | + | `sendPrivate` | OBJECT | send a private command | + | `setMediaElement` | STRING | Set the media element as current. p1 : Id of the media element to set. | + | `setName` | STRING | Change the device internal name. Name length may be subject to restrictions depending on the device and underlying protocol. | + | `setOnOff` | STRING: off, on | Turn the device on or off | + | `setTimelinePosition` | INT | Go to a position on the timeline. p1 : Position time in sec. | + | `setVolume` | INT [0..100] | Set the device output volume | + | `start` | | Start the default actuator behavior (movement, sound or timer) | + | `stop` | | Stop the current actuator behavior (movement, sound or timer) | + | `unmute` | | Unmute the device | + | `update` | | Update the gateway software. The update may have to be downloaded first, which can take a while. | + | `writeManufacturerData` | OBJECT | Write manufacturer data values. Example: { "setting1": true, "setting2": 42, "setting3": "overkiz", "setting4": "Dk8PDr1WD0sfAAAAAAAAAAAAAAAAAAAA", "setting5": [ "valueA", "valueB", "valueC" ], "setting6": { "value": 15, "definition": 158 } } | + + **States** + + | State | Type | Range / Values | Notes | + |-------|------|----------------|-------| + | `ActivatedOptionsState` | DataState | | | + | `ActivePartitionState` | DataState | | | + | `AvailabilityState` | DiscreteState | available, unavailable | | + | `AvailableOptionsState` | DataState | | | + | `BatteryDiscreteLevelState` | DiscreteState | good, medium, low, critical | | + | `BatteryLevelState` | ContinuousState | | | + | `ErrorEventState` | DiscreteState | accessLimitation, internal, obstacleProtection, transportBusy, deviceNoAnswer, cancelled, deprecated, interrupted, thermalProtection, maintenanceRequired, alreadyUpToDate, notSupported, hardwareError, accessDenied, updateError, resourceAlreadyExist | | + | `ErrorState` | DataState | | | + | `ErrorsState` | DataState | | | + | `FirmwareHashState` | DataState | | | + | `FirmwareRevisionState` | DataState | | | + | `GroupMembersState` | DataState | | | + | `HasNextState` | DataState | | | + | `HasPreviousState` | DataState | | | + | `MediaElementState` | DataState | | | + | `MediaElementsEventState` | DataState | | | + | `MuteState` | DataState | | | + | `NameState` | DataState | | | + | `NewFirmwareAvailableState` | DataState | | | + | `OnOffState` | DiscreteState | on, off | | + | `PausedState` | DataState | | | + | `Private10State` | DataState | | | + | `Private1State` | DataState | | | + | `Private2State` | DataState | | | + | `Private3State` | DataState | | | + | `Private4State` | DataState | | | + | `Private5State` | DataState | | | + | `Private6State` | DataState | | | + | `Private7State` | DataState | | | + | `Private8State` | DataState | | | + | `Private9State` | DataState | | | + | `RecommendedOptionsState` | DataState | | | + | `RemovableState` | DataState | | | + | `SignalQualityState` | ContinuousState | | | + | `StartedStoppedState` | DiscreteState | started, stopped | | + | `StatusState` | DiscreteState | available, unavailable | | + | `TimelineDurationState` | DataState | | | + | `TimelinePositionState` | DataState | | | + | `VolumeLevelState` | DataState | | | + +??? note "MusicPlayer/DynamicAudioPlayer (ACTUATOR) — 29 commands, 37 states" + + **Type IDs:** `288` | **Servers:** `somfy_europe` | **Controllable:** `ogp:AudioPlayer` | **Profiles:** `StoppableMusicPlayer`, `MusicPlayer`, `StatefulStartStop`, `StartStop`, `VolumeControl`, `StatefulSwitchable`, `Switchable` + + **Commands** + + | Command | Parameters | Notes | + |---------|-----------|-------| + | `activateOption` | STRING | Activate an option | + | `addGroupMember` | STRING | Add member to the group p1 : Id of the member to add to the group. | + | `deactivateOption` | STRING | Deactivate an option | + | `executeManufacturerProcedure` | STRING; OBJECT (optional) | execute manufacturer procedure command. p1: the procedure name p2: the params associated Example: p1 = "dead_man_up" p2 = {"duration": 42} | + | `fastBackward` | INT | Go to a backward position for a specified time. p1 : Amount of time in sec. | + | `fastForward` | INT | Go to a forward position for a specified time. p1 : Amount of time in sec. | + | `getMediaElements` | | Get the list of all media available. | + | `identify` | | Ask the device to identify itself by doing a slight movement or blink or beep | + | `mute` | | Mute the device | + | `next` | | Play next track | + | `off` | | Turn off the device | + | `on` | | Turn on the device | + | `pause` | | Pause current action | + | `play` | | Play media | + | `previous` | | Play previous track | + | `readManufacturerData` | ARRAY | Read manufacturer data values from given names. Example: ["setting1","setting2"]. | + | `removeGroupMember` | STRING | Remove a member of the group. p1 : Id of the member to remove to the group. | + | `resume` | | Resume paused action. | + | `sendPrivate` | OBJECT | send a private command | + | `setMediaElement` | STRING | Set the media element as current. p1 : Id of the media element to set. | + | `setName` | STRING | Change the device internal name. Name length may be subject to restrictions depending on the device and underlying protocol. | + | `setOnOff` | STRING: off, on | Turn the device on or off | + | `setTimelinePosition` | INT | Go to a position on the timeline. p1 : Position time in sec. | + | `setVolume` | INT [0..100] | Set the device output volume | + | `start` | | Start the default actuator behavior (movement, sound or timer) | + | `stop` | | Stop the current actuator behavior (movement, sound or timer) | + | `unmute` | | Unmute the device | + | `update` | | Update the gateway software. The update may have to be downloaded first, which can take a while. | + | `writeManufacturerData` | OBJECT | Write manufacturer data values. Example: { "setting1": true, "setting2": 42, "setting3": "overkiz", "setting4": "Dk8PDr1WD0sfAAAAAAAAAAAAAAAAAAAA", "setting5": [ "valueA", "valueB", "valueC" ], "setting6": { "value": 15, "definition": 158 } } | + + **States** + + | State | Type | Range / Values | Notes | + |-------|------|----------------|-------| + | `ActivatedOptionsState` | DataState | | | + | `ActivePartitionState` | DataState | | | + | `AvailabilityState` | DiscreteState | available, unavailable | | + | `AvailableOptionsState` | DataState | | | + | `BatteryDiscreteLevelState` | DiscreteState | good, medium, low, critical | | + | `BatteryLevelState` | ContinuousState | | | + | `ErrorState` | DataState | | | + | `ErrorsState` | DataState | | | + | `FirmwareHashState` | DataState | | | + | `FirmwareRevisionState` | DataState | | | + | `GroupMembersState` | DataState | | | + | `HasNextState` | DataState | | | + | `HasPreviousState` | DataState | | | + | `MediaElementState` | DataState | | | + | `MuteState` | DataState | | | + | `NameState` | DataState | | | + | `NewFirmwareAvailableState` | DataState | | | + | `OnOffState` | DiscreteState | on, off | | + | `PausedState` | DataState | | | + | `Private10State` | DataState | | | + | `Private1State` | DataState | | | + | `Private2State` | DataState | | | + | `Private3State` | DataState | | | + | `Private4State` | DataState | | | + | `Private5State` | DataState | | | + | `Private6State` | DataState | | | + | `Private7State` | DataState | | | + | `Private8State` | DataState | | | + | `Private9State` | DataState | | | + | `RecommendedOptionsState` | DataState | | | + | `RemovableState` | DataState | | | + | `SignalQualityState` | ContinuousState | | | + | `StartedStoppedState` | DiscreteState | started, stopped | | + | `StatusState` | DiscreteState | available, unavailable | | + | `TimelineDurationState` | DataState | | | + | `TimelinePositionState` | DataState | | | + | `VolumeLevelState` | DataState | | | + +??? note "NoiseSensor/DynamicAmbientNoiseSensor (SENSOR) — 7 commands, 25 states" + + **Type IDs:** `305` | **Servers:** `rexel` | **Controllable:** `ogp:AmbientNoiseSensor` | **Profiles:** `AmbientNoiseSensor` + + **Commands** + + | Command | Parameters | Notes | + |---------|-----------|-------| + | `executeManufacturerProcedure` | STRING; OBJECT (optional) | execute manufacturer procedure command. p1: the procedure name p2: the params associated Example: p1 = "dead_man_up" p2 = {"duration": 42} | + | `identify` | | Ask the device to identify itself by doing a slight movement or blink or beep | + | `readManufacturerData` | ARRAY | Read manufacturer data values from given names. Example: ["setting1","setting2"]. | + | `sendPrivate` | OBJECT | send a private command | + | `setName` | STRING | Change the device internal name. Name length may be subject to restrictions depending on the device and underlying protocol. | | `update` | | Update the gateway software. The update may have to be downloaded first, which can take a while. | | `writeManufacturerData` | OBJECT | Write manufacturer data values. Example: { "setting1": true, "setting2": 42, "setting3": "overkiz", "setting4": "Dk8PDr1WD0sfAAAAAAAAAAAAAAAAAAAA", "setting5": [ "valueA", "valueB", "valueC" ], "setting6": { "value": 15, "definition": 158 } } | @@ -13511,20 +18370,17 @@ This page lists all known device types from the Overkiz API, grouped by protocol | State | Type | Range / Values | Notes | |-------|------|----------------|-------| | `ActivePartitionState` | DataState | | | - | `AuthenticationExpiredState` | DataState | | | + | `AmbientNoiseState` | ContinuousState | | | | `AvailabilityState` | DiscreteState | available, unavailable | | | `BatteryDiscreteLevelState` | DiscreteState | good, medium, low, critical | | | `BatteryLevelState` | ContinuousState | | | - | `ClosureState` | ContinuousState | [0..100] | | | `ErrorEventState` | DiscreteState | accessLimitation, internal, obstacleProtection, transportBusy, deviceNoAnswer, cancelled, deprecated, interrupted, thermalProtection, maintenanceRequired, alreadyUpToDate, notSupported, hardwareError, accessDenied, updateError, resourceAlreadyExist | | | `ErrorState` | DataState | | | | `ErrorsState` | DataState | | | | `FirmwareHashState` | DataState | | | | `FirmwareRevisionState` | DataState | | | - | `LockedUnlockedState` | DiscreteState | locked, unlocked | | | `NameState` | DataState | | | | `NewFirmwareAvailableState` | DataState | | | - | `OpenClosedState` | DiscreteState | open, closed | | | `Private10State` | DataState | | | | `Private1State` | DataState | | | | `Private2State` | DataState | | | @@ -13535,20 +18391,13 @@ This page lists all known device types from the Overkiz API, grouped by protocol | `Private7State` | DataState | | | | `Private8State` | DataState | | | | `Private9State` | DataState | | | - | `ReachedAliasesState` | DataState | | | | `RemovableState` | DataState | | | - | `SSIDState` | DataState | | | | `SignalQualityState` | ContinuousState | | | | `StatusState` | DiscreteState | available, unavailable | | - | `UnavailableFeaturesState` | DataState | | | -??? note "unknown/Invalid (ACTUATOR) — 0 commands, 0 states" - - **Type IDs:** `0` | **Servers:** `rexel`, `somfy_europe` | **Controllable:** `ogp:Invalid` | **Profiles:** `Specific` - -??? note "waterLeakSensor/DynamicWaterLeakSensor (SENSOR) — 7 commands, 26 states" +??? note "NoiseSensor/DynamicAmbientNoiseSensor (SENSOR) — 7 commands, 24 states" - **Type IDs:** `306` | **Servers:** `somfy_europe` | **Controllable:** `ogp:WaterLeakSensor` | **Profiles:** `waterLeakSensor` + **Type IDs:** `305` | **Servers:** `somfy_europe` | **Controllable:** `ogp:AmbientNoiseSensor` | **Profiles:** `AmbientNoiseSensor` **Commands** @@ -13567,10 +18416,10 @@ This page lists all known device types from the Overkiz API, grouped by protocol | State | Type | Range / Values | Notes | |-------|------|----------------|-------| | `ActivePartitionState` | DataState | | | + | `AmbientNoiseState` | ContinuousState | | | | `AvailabilityState` | DiscreteState | available, unavailable | | | `BatteryDiscreteLevelState` | DiscreteState | good, medium, low, critical | | | `BatteryLevelState` | ContinuousState | | | - | `ErrorEventState` | DiscreteState | accessLimitation, internal, obstacleProtection, transportBusy, deviceNoAnswer, cancelled, deprecated, interrupted, thermalProtection, maintenanceRequired, alreadyUpToDate, notSupported, hardwareError, accessDenied, updateError, resourceAlreadyExist | | | `ErrorState` | DataState | | | | `ErrorsState` | DataState | | | | `FirmwareHashState` | DataState | | | @@ -13590,17 +18439,10 @@ This page lists all known device types from the Overkiz API, grouped by protocol | `RemovableState` | DataState | | | | `SignalQualityState` | ContinuousState | | | | `StatusState` | DiscreteState | available, unavailable | | - | `WaterLeakEventState` | DiscreteState | waterLeak | | - | `WaterLeakState` | DiscreteState | detected, notDetected | | +??? note "OccupancySensor/DynamicOccupancySensor (SENSOR) — 7 commands, 25 states" -## OGP - -50 device types. - -??? note "AirSensor/DynamicAirSensor (SENSOR) — 7 commands, 26 states" - - **Type IDs:** `304` | **Servers:** `rexel`, `somfy_europe` | **Controllable:** `ogp:AirSensor` | **Profiles:** `CO2Concentration` + **Type IDs:** `280` | **Servers:** `rexel` | **Controllable:** `ogp:OccupancySensor` | **Profiles:** `OccupancyDetector` **Commands** @@ -13619,11 +18461,9 @@ This page lists all known device types from the Overkiz API, grouped by protocol | State | Type | Range / Values | Notes | |-------|------|----------------|-------| | `ActivePartitionState` | DataState | | | - | `AirQualityIndexLevelState` | DiscreteState | good, moderate, unhealthyForSensitiveGroups, unhealthy, veryUnhealthy, hazardous | | | `AvailabilityState` | DiscreteState | available, unavailable | | | `BatteryDiscreteLevelState` | DiscreteState | good, medium, low, critical | | | `BatteryLevelState` | ContinuousState | | | - | `CO2ConcentrationState` | ContinuousState | | | | `ErrorEventState` | DiscreteState | accessLimitation, internal, obstacleProtection, transportBusy, deviceNoAnswer, cancelled, deprecated, interrupted, thermalProtection, maintenanceRequired, alreadyUpToDate, notSupported, hardwareError, accessDenied, updateError, resourceAlreadyExist | | | `ErrorState` | DataState | | | | `ErrorsState` | DataState | | | @@ -13631,6 +18471,7 @@ This page lists all known device types from the Overkiz API, grouped by protocol | `FirmwareRevisionState` | DataState | | | | `NameState` | DataState | | | | `NewFirmwareAvailableState` | DataState | | | + | `OccupancyState` | DiscreteState | personInside, noPersonInside | | | `Private10State` | DataState | | | | `Private1State` | DataState | | | | `Private2State` | DataState | | | @@ -13645,25 +18486,19 @@ This page lists all known device types from the Overkiz API, grouped by protocol | `SignalQualityState` | ContinuousState | | | | `StatusState` | DiscreteState | available, unavailable | | -??? note "Alarm/DynamicAlarm (ACTUATOR) — 13 commands, 33 states" +??? note "OccupancySensor/DynamicOccupancySensor (SENSOR) — 7 commands, 24 states" - **Type IDs:** `282` | **Servers:** `rexel` | **Controllable:** `ogp:Alarm` | **Profiles:** `SmokeDetector`, `IntrusionDetector`, `StatefulAlarm`, `Alarm` + **Type IDs:** `280` | **Servers:** `somfy_europe` | **Controllable:** `ogp:OccupancySensor` | **Profiles:** `OccupancyDetector` **Commands** | Command | Parameters | Notes | |---------|-----------|-------| - | `addGroupMember` | STRING | Add member to the group p1 : Id of the member to add to the group. | - | `arm` | | Arm the system | - | `disarm` | | Disarm the system | | `executeManufacturerProcedure` | STRING; OBJECT (optional) | execute manufacturer procedure command. p1: the procedure name p2: the params associated Example: p1 = "dead_man_up" p2 = {"duration": 42} | | `identify` | | Ask the device to identify itself by doing a slight movement or blink or beep | | `readManufacturerData` | ARRAY | Read manufacturer data values from given names. Example: ["setting1","setting2"]. | - | `removeGroupMember` | STRING | Remove a member of the group. p1 : Id of the member to remove to the group. | | `sendPrivate` | OBJECT | send a private command | - | `setMode` | STRING | Set the active mode. | | `setName` | STRING | Change the device internal name. Name length may be subject to restrictions depending on the device and underlying protocol. | - | `setNodeDefinition` | STRING; STRING (optional); STRING (optional) | Fill the node definition (some transitions can be forbidden) p1: type (mandatory) p2: subType (mandatory if definition is set) p3: definition | | `update` | | Update the gateway software. The update may have to be downloaded first, which can take a while. | | `writeManufacturerData` | OBJECT | Write manufacturer data values. Example: { "setting1": true, "setting2": 42, "setting3": "overkiz", "setting4": "Dk8PDr1WD0sfAAAAAAAAAAAAAAAAAAAA", "setting5": [ "valueA", "valueB", "valueC" ], "setting6": { "value": 15, "definition": 158 } } | @@ -13672,23 +18507,16 @@ This page lists all known device types from the Overkiz API, grouped by protocol | State | Type | Range / Values | Notes | |-------|------|----------------|-------| | `ActivePartitionState` | DataState | | | - | `ArmedState` | DataState | | | | `AvailabilityState` | DiscreteState | available, unavailable | | - | `AvailableModesState` | DataState | | | | `BatteryDiscreteLevelState` | DiscreteState | good, medium, low, critical | | | `BatteryLevelState` | ContinuousState | | | - | `ErrorEventState` | DiscreteState | accessLimitation, internal, obstacleProtection, transportBusy, deviceNoAnswer, cancelled, deprecated, interrupted, thermalProtection, maintenanceRequired, alreadyUpToDate, notSupported, hardwareError, accessDenied, updateError, resourceAlreadyExist | | | `ErrorState` | DataState | | | | `ErrorsState` | DataState | | | | `FirmwareHashState` | DataState | | | | `FirmwareRevisionState` | DataState | | | - | `GroupMembersState` | DataState | | | - | `IntrusionDetectionEventState` | DiscreteState | panic, intrusion | | - | `IntrusionState` | DiscreteState | detected, notDetected | | - | `ModeState` | DataState | | | | `NameState` | DataState | | | | `NewFirmwareAvailableState` | DataState | | | - | `PanicEventState` | DataState | | | + | `OccupancyState` | DiscreteState | personInside, noPersonInside | | | `Private10State` | DataState | | | | `Private1State` | DataState | | | | `Private2State` | DataState | | | @@ -13701,29 +18529,30 @@ This page lists all known device types from the Overkiz API, grouped by protocol | `Private9State` | DataState | | | | `RemovableState` | DataState | | | | `SignalQualityState` | ContinuousState | | | - | `SmokeDetectionEventState` | DiscreteState | smoke | | - | `SmokeState` | DiscreteState | detected, notDetected | | | `StatusState` | DiscreteState | available, unavailable | | -??? note "Alarm/DynamicAlarm (ACTUATOR) — 13 commands, 35 states" +??? note "OnOff/DynamicOutlet (ACTUATOR) — 16 commands, 29 states" - **Type IDs:** `282` | **Servers:** `somfy_europe` | **Controllable:** `ogp:Alarm` | **Profiles:** `SmokeDetector`, `waterLeakSensor`, `IntrusionDetector`, `StatefulAlarm`, `Alarm` + **Type IDs:** `261` | **Servers:** `rexel` | **Controllable:** `ogp:Outlet` | **Profiles:** `StatefulSwitchablePlug`, `ElectricPowerMeter`, `StatefulSwitchable`, `Switchable`, `StatefulDimmable`, `Dimmable`, `Cyclic` **Commands** | Command | Parameters | Notes | |---------|-----------|-------| - | `addGroupMember` | STRING | Add member to the group p1 : Id of the member to add to the group. | - | `arm` | | Arm the system | - | `disarm` | | Disarm the system | + | `cycle` | | Do a cycle of supported motion kinematics or modes | | `executeManufacturerProcedure` | STRING; OBJECT (optional) | execute manufacturer procedure command. p1: the procedure name p2: the params associated Example: p1 = "dead_man_up" p2 = {"duration": 42} | + | `goToAlias` | STRING | Send alias command linked with the ID. | | `identify` | | Ask the device to identify itself by doing a slight movement or blink or beep | + | `off` | | Turn off the device | + | `on` | | Turn on the device | | `readManufacturerData` | ARRAY | Read manufacturer data values from given names. Example: ["setting1","setting2"]. | - | `removeGroupMember` | STRING | Remove a member of the group. p1 : Id of the member to remove to the group. | + | `saveAlias` | STRING | Allow to send an order for the product to save the current state of the alias. | | `sendPrivate` | OBJECT | send a private command | - | `setMode` | STRING | Set the active mode. | + | `setIntensity` | INT [0..100] | Light intensity level (100%=maximum intensity, 0%=off) | | `setName` | STRING | Change the device internal name. Name length may be subject to restrictions depending on the device and underlying protocol. | | `setNodeDefinition` | STRING; STRING (optional); STRING (optional) | Fill the node definition (some transitions can be forbidden) p1: type (mandatory) p2: subType (mandatory if definition is set) p3: definition | + | `setOnOff` | STRING: off, on | Turn the device on or off | + | `toggle` | | Toggle on/off status | | `update` | | Update the gateway software. The update may have to be downloaded first, which can take a while. | | `writeManufacturerData` | OBJECT | Write manufacturer data values. Example: { "setting1": true, "setting2": 42, "setting3": "overkiz", "setting4": "Dk8PDr1WD0sfAAAAAAAAAAAAAAAAAAAA", "setting5": [ "valueA", "valueB", "valueC" ], "setting6": { "value": 15, "definition": 158 } } | @@ -13732,23 +18561,20 @@ This page lists all known device types from the Overkiz API, grouped by protocol | State | Type | Range / Values | Notes | |-------|------|----------------|-------| | `ActivePartitionState` | DataState | | | - | `ArmedState` | DataState | | | | `AvailabilityState` | DiscreteState | available, unavailable | | - | `AvailableModesState` | DataState | | | | `BatteryDiscreteLevelState` | DiscreteState | good, medium, low, critical | | | `BatteryLevelState` | ContinuousState | | | + | `ElectricPowerConsumptionState` | ContinuousState | | | | `ErrorEventState` | DiscreteState | accessLimitation, internal, obstacleProtection, transportBusy, deviceNoAnswer, cancelled, deprecated, interrupted, thermalProtection, maintenanceRequired, alreadyUpToDate, notSupported, hardwareError, accessDenied, updateError, resourceAlreadyExist | | | `ErrorState` | DataState | | | | `ErrorsState` | DataState | | | | `FirmwareHashState` | DataState | | | | `FirmwareRevisionState` | DataState | | | - | `GroupMembersState` | DataState | | | - | `IntrusionDetectionEventState` | DiscreteState | panic, intrusion | | - | `IntrusionState` | DiscreteState | detected, notDetected | | - | `ModeState` | DataState | | | + | `IntensityState` | ContinuousState | | | + | `LightIntensityState` | ContinuousState | [0..100] | | | `NameState` | DataState | | | | `NewFirmwareAvailableState` | DataState | | | - | `PanicEventState` | DataState | | | + | `OnOffState` | DiscreteState | on, off | | | `Private10State` | DataState | | | | `Private1State` | DataState | | | | `Private2State` | DataState | | | @@ -13759,37 +18585,33 @@ This page lists all known device types from the Overkiz API, grouped by protocol | `Private7State` | DataState | | | | `Private8State` | DataState | | | | `Private9State` | DataState | | | + | `ReachedAliasesState` | DataState | | | | `RemovableState` | DataState | | | | `SignalQualityState` | ContinuousState | | | - | `SmokeDetectionEventState` | DiscreteState | smoke | | - | `SmokeState` | DiscreteState | detected, notDetected | | | `StatusState` | DiscreteState | available, unavailable | | - | `WaterLeakEventState` | DiscreteState | waterLeak | | - | `WaterLeakState` | DiscreteState | detected, notDetected | | -??? note "Awning/DynamicAwning (ACTUATOR) — 17 commands, 30 states" +??? note "OnOff/DynamicOutlet (ACTUATOR) — 16 commands, 28 states" - **Type IDs:** `277` | **Servers:** `rexel`, `somfy_europe` | **Controllable:** `ogp:Awning` | **Profiles:** `StatefulDeployableAwning`, `StatefulDeployable`, `Deployable`, `StatefulDeployUndeploy`, `DeployUndeploy` + **Type IDs:** `261` | **Servers:** `somfy_europe` | **Controllable:** `ogp:Outlet` | **Profiles:** `StatefulSwitchablePlug`, `ElectricPowerMeter`, `StatefulSwitchable`, `Switchable`, `StatefulDimmable`, `Dimmable`, `Cyclic` **Commands** | Command | Parameters | Notes | |---------|-----------|-------| - | `deploy` | | Fully deploy the device | + | `cycle` | | Do a cycle of supported motion kinematics or modes | | `executeManufacturerProcedure` | STRING; OBJECT (optional) | execute manufacturer procedure command. p1: the procedure name p2: the params associated Example: p1 = "dead_man_up" p2 = {"duration": 42} | | `goToAlias` | STRING | Send alias command linked with the ID. | | `identify` | | Ask the device to identify itself by doing a slight movement or blink or beep | + | `off` | | Turn off the device | + | `on` | | Turn on the device | | `readManufacturerData` | ARRAY | Read manufacturer data values from given names. Example: ["setting1","setting2"]. | - | `rollOut` | | Roll out the device (unfold - deploy - less compact position) | - | `rollUp` | | Roll up the device (fold - most compact position) | | `saveAlias` | STRING | Allow to send an order for the product to save the current state of the alias. | | `sendPrivate` | OBJECT | send a private command | - | `setDeployment` | INT [0..100] | Device deployment level (100%=fully deployed, 0%=fully undeployed) | + | `setIntensity` | INT [0..100] | Light intensity level (100%=maximum intensity, 0%=off) | | `setName` | STRING | Change the device internal name. Name length may be subject to restrictions depending on the device and underlying protocol. | | `setNodeDefinition` | STRING; STRING (optional); STRING (optional) | Fill the node definition (some transitions can be forbidden) p1: type (mandatory) p2: subType (mandatory if definition is set) p3: definition | - | `setRollingOut` | INT [0..100] | set the device rolling out percentage | - | `stop` | | Stop the current actuator behavior (movement, sound or timer) | - | `undeploy` | | Fully undeploy the device | + | `setOnOff` | STRING: off, on | Turn the device on or off | + | `toggle` | | Toggle on/off status | | `update` | | Update the gateway software. The update may have to be downloaded first, which can take a while. | | `writeManufacturerData` | OBJECT | Write manufacturer data values. Example: { "setting1": true, "setting2": 42, "setting3": "overkiz", "setting4": "Dk8PDr1WD0sfAAAAAAAAAAAAAAAAAAAA", "setting5": [ "valueA", "valueB", "valueC" ], "setting6": { "value": 15, "definition": 158 } } | @@ -13801,15 +18623,16 @@ This page lists all known device types from the Overkiz API, grouped by protocol | `AvailabilityState` | DiscreteState | available, unavailable | | | `BatteryDiscreteLevelState` | DiscreteState | good, medium, low, critical | | | `BatteryLevelState` | ContinuousState | | | - | `DeployedUndeployedState` | DiscreteState | deployed, undeployed | | - | `DeploymentState` | ContinuousState | [0..100] | | - | `ErrorEventState` | DiscreteState | accessLimitation, internal, obstacleProtection, transportBusy, deviceNoAnswer, cancelled, deprecated, interrupted, thermalProtection, maintenanceRequired, alreadyUpToDate, notSupported, hardwareError, accessDenied, updateError, resourceAlreadyExist | | + | `ElectricPowerConsumptionState` | ContinuousState | | | | `ErrorState` | DataState | | | | `ErrorsState` | DataState | | | | `FirmwareHashState` | DataState | | | | `FirmwareRevisionState` | DataState | | | + | `IntensityState` | ContinuousState | | | + | `LightIntensityState` | ContinuousState | [0..100] | | | `NameState` | DataState | | | | `NewFirmwareAvailableState` | DataState | | | + | `OnOffState` | DiscreteState | on, off | | | `Private10State` | DataState | | | | `Private1State` | DataState | | | | `Private2State` | DataState | | | @@ -13822,25 +18645,42 @@ This page lists all known device types from the Overkiz API, grouped by protocol | `Private9State` | DataState | | | | `ReachedAliasesState` | DataState | | | | `RemovableState` | DataState | | | - | `RolledUpState` | DataState | | | - | `RollingOutState` | ContinuousState | | | | `SignalQualityState` | ContinuousState | | | | `StatusState` | DiscreteState | available, unavailable | | - | `UnavailableFeaturesState` | DataState | | | -??? note "CarbonDioxideSensor/DynamicCarbonDioxideSensor (SENSOR) — 7 commands, 25 states" +??? note "Oven/DynamicOven (ACTUATOR) — 27 commands, 69 states" - **Type IDs:** `291` | **Servers:** `rexel`, `somfy_europe` | **Controllable:** `ogp:CarbonDioxideSensor` | **Profiles:** `CO2Concentration` + **Type IDs:** `284` | **Servers:** `rexel` | **Controllable:** `ogp:Oven` | **Profiles:** `StatefulStartStopOven`, `StatefulStartStop`, `StartStop`, `StatefulThermostatWithSensor`, `StatefulLockWithOpeningStatus`, `StatefulThermostat`, `Thermostat`, `StatefulSwitchable`, `Switchable`, `StatefulLock`, `LockStatus`, `Lock`, `StatefulDimmable`, `Dimmable` **Commands** | Command | Parameters | Notes | |---------|-----------|-------| + | `activateOption` | STRING | Activate an option | + | `deactivateOption` | STRING | Deactivate an option | | `executeManufacturerProcedure` | STRING; OBJECT (optional) | execute manufacturer procedure command. p1: the procedure name p2: the params associated Example: p1 = "dead_man_up" p2 = {"duration": 42} | | `identify` | | Ask the device to identify itself by doing a slight movement or blink or beep | + | `lock` | | Lock the device | + | `off` | | Turn off the device | + | `on` | | Turn on the device | + | `pause` | | Pause current action | | `readManufacturerData` | ARRAY | Read manufacturer data values from given names. Example: ["setting1","setting2"]. | + | `resume` | | Resume paused action. | | `sendPrivate` | OBJECT | send a private command | + | `setIntensity` | INT [0..100] | Light intensity level (100%=maximum intensity, 0%=off) | + | `setMode` | STRING | Set the active mode. | | `setName` | STRING | Change the device internal name. Name length may be subject to restrictions depending on the device and underlying protocol. | + | `setOnOff` | STRING: off, on | Turn the device on or off | + | `setRecipe` | STRING | Select/Activate a given recipe. | + | `setTargetHumidity` | INT [0..100] | Set the target humidity. | + | `setTargetPower` | INT | Set the target power. | + | `setTargetTemperature` | FLOAT | Set the new air temperature to reach | + | `setTargetTime` | INT | Set a target action duration. | + | `setTargetWeight` | INT | Indicate a target element weight. | + | `setTimezone` | STRING | Set the device timezone, according to TZ database names. | + | `start` | | Start the default actuator behavior (movement, sound or timer) | + | `stop` | | Stop the current actuator behavior (movement, sound or timer) | + | `unlock` | | Unlock the device | | `update` | | Update the gateway software. The update may have to be downloaded first, which can take a while. | | `writeManufacturerData` | OBJECT | Write manufacturer data values. Example: { "setting1": true, "setting2": 42, "setting3": "overkiz", "setting4": "Dk8PDr1WD0sfAAAAAAAAAAAAAAAAAAAA", "setting5": [ "valueA", "valueB", "valueC" ], "setting6": { "value": 15, "definition": 158 } } | @@ -13848,18 +18688,33 @@ This page lists all known device types from the Overkiz API, grouped by protocol | State | Type | Range / Values | Notes | |-------|------|----------------|-------| + | `ActivatedOptionsState` | DataState | | | | `ActivePartitionState` | DataState | | | | `AvailabilityState` | DiscreteState | available, unavailable | | + | `AvailableModesState` | DataState | | | + | `AvailableOptionsState` | DataState | | | + | `AvailableRecipesState` | DataState | | | + | `AvailableTargetTemperaturesState` | DataState | | | | `BatteryDiscreteLevelState` | DiscreteState | good, medium, low, critical | | | `BatteryLevelState` | ContinuousState | | | - | `CO2ConcentrationState` | ContinuousState | | | + | `CurrentCycleStageState` | DataState | | | + | `CurrentSoilingState` | ContinuousState | | | + | `CycleStageSequenceState` | DataState | | | | `ErrorEventState` | DiscreteState | accessLimitation, internal, obstacleProtection, transportBusy, deviceNoAnswer, cancelled, deprecated, interrupted, thermalProtection, maintenanceRequired, alreadyUpToDate, notSupported, hardwareError, accessDenied, updateError, resourceAlreadyExist | | | `ErrorState` | DataState | | | | `ErrorsState` | DataState | | | | `FirmwareHashState` | DataState | | | | `FirmwareRevisionState` | DataState | | | + | `IntensityState` | ContinuousState | | | + | `LightIntensityState` | ContinuousState | [0..100] | | + | `LockedUnlockedState` | DiscreteState | locked, unlocked | | + | `ModeState` | DataState | | | | `NameState` | DataState | | | | `NewFirmwareAvailableState` | DataState | | | + | `OnOffState` | DiscreteState | on, off | | + | `OpenClosedState` | DiscreteState | open, closed | | + | `OpenState` | DataState | | | + | `PausedState` | DataState | | | | `Private10State` | DataState | | | | `Private1State` | DataState | | | | `Private2State` | DataState | | | @@ -13870,29 +18725,72 @@ This page lists all known device types from the Overkiz API, grouped by protocol | `Private7State` | DataState | | | | `Private8State` | DataState | | | | `Private9State` | DataState | | | + | `RecipeState` | DataState | | | + | `RecommendedOptionsState` | DataState | | | + | `RecommendedTargetHumidityState` | ContinuousState | | | + | `RecommendedTargetPowerState` | ContinuousState | | | + | `RecommendedTargetTemperatureState` | ContinuousState | | | + | `RecommendedTargetTimeState` | ContinuousState | | | + | `RecommendedTargetWeightState` | ContinuousState | | | + | `RemainingTimeState` | ContinuousState | | | | `RemovableState` | DataState | | | + | `RunningTimerState` | DataState | | | | `SignalQualityState` | ContinuousState | | | + | `StartedStoppedState` | DiscreteState | started, stopped | | | `StatusState` | DiscreteState | available, unavailable | | + | `TargetHumidityCurrentLowerBoundState` | ContinuousState | | | + | `TargetHumidityCurrentUpperBoundState` | ContinuousState | | | + | `TargetHumidityState` | ContinuousState | | | + | `TargetPowerCurrentLowerBoundState` | ContinuousState | | | + | `TargetPowerCurrentUpperBoundState` | ContinuousState | | | + | `TargetPowerState` | ContinuousState | | | + | `TargetTemperatureCurrentLowerBoundState` | ContinuousState | | | + | `TargetTemperatureCurrentUpperBoundState` | ContinuousState | | | + | `TargetTemperatureReachedState` | DataState | | | + | `TargetTemperatureState` | ContinuousState | [12.0..30.0] | | + | `TargetTimeCurrentLowerBoundState` | ContinuousState | | | + | `TargetTimeCurrentUpperBoundState` | ContinuousState | | | + | `TargetTimeState` | ContinuousState | | | + | `TargetWeightCurrentLowerBoundState` | ContinuousState | | | + | `TargetWeightCurrentUpperBoundState` | ContinuousState | | | + | `TargetWeightState` | ContinuousState | | | + | `TemperatureState` | ContinuousState | [-100.0..100.0] | | + | `TimezoneState` | DataState | | | + | `UnavailableFeaturesState` | DataState | | | -??? note "CircuitBreaker/DynamicCircuitBreaker (ACTUATOR) — 13 commands, 25 states" +??? note "Oven/DynamicOven (ACTUATOR) — 27 commands, 68 states" - **Type IDs:** `286` | **Servers:** `rexel`, `somfy_europe` | **Controllable:** `ogp:CircuitBreaker` | **Profiles:** `StatefulSwitchablePlug`, `StatefulSwitchable`, `Switchable`, `Cyclic` + **Type IDs:** `284` | **Servers:** `somfy_europe` | **Controllable:** `ogp:Oven` | **Profiles:** `StatefulStartStopOven`, `StatefulStartStop`, `StartStop`, `StatefulThermostatWithSensor`, `StatefulLockWithOpeningStatus`, `StatefulThermostat`, `Thermostat`, `StatefulSwitchable`, `Switchable`, `StatefulLock`, `LockStatus`, `Lock`, `StatefulDimmable`, `Dimmable` **Commands** | Command | Parameters | Notes | |---------|-----------|-------| - | `cycle` | | Do a cycle of supported motion kinematics or modes | + | `activateOption` | STRING | Activate an option | + | `deactivateOption` | STRING | Deactivate an option | | `executeManufacturerProcedure` | STRING; OBJECT (optional) | execute manufacturer procedure command. p1: the procedure name p2: the params associated Example: p1 = "dead_man_up" p2 = {"duration": 42} | | `identify` | | Ask the device to identify itself by doing a slight movement or blink or beep | + | `lock` | | Lock the device | | `off` | | Turn off the device | | `on` | | Turn on the device | + | `pause` | | Pause current action | | `readManufacturerData` | ARRAY | Read manufacturer data values from given names. Example: ["setting1","setting2"]. | + | `resume` | | Resume paused action. | | `sendPrivate` | OBJECT | send a private command | + | `setIntensity` | INT [0..100] | Light intensity level (100%=maximum intensity, 0%=off) | + | `setMode` | STRING | Set the active mode. | | `setName` | STRING | Change the device internal name. Name length may be subject to restrictions depending on the device and underlying protocol. | - | `setNodeDefinition` | STRING; STRING (optional); STRING (optional) | Fill the node definition (some transitions can be forbidden) p1: type (mandatory) p2: subType (mandatory if definition is set) p3: definition | | `setOnOff` | STRING: off, on | Turn the device on or off | - | `toggle` | | Toggle on/off status | + | `setRecipe` | STRING | Select/Activate a given recipe. | + | `setTargetHumidity` | INT [0..100] | Set the target humidity. | + | `setTargetPower` | INT | Set the target power. | + | `setTargetTemperature` | FLOAT | Set the new air temperature to reach | + | `setTargetTime` | INT | Set a target action duration. | + | `setTargetWeight` | INT | Indicate a target element weight. | + | `setTimezone` | STRING | Set the device timezone, according to TZ database names. | + | `start` | | Start the default actuator behavior (movement, sound or timer) | + | `stop` | | Stop the current actuator behavior (movement, sound or timer) | + | `unlock` | | Unlock the device | | `update` | | Update the gateway software. The update may have to be downloaded first, which can take a while. | | `writeManufacturerData` | OBJECT | Write manufacturer data values. Example: { "setting1": true, "setting2": 42, "setting3": "overkiz", "setting4": "Dk8PDr1WD0sfAAAAAAAAAAAAAAAAAAAA", "setting5": [ "valueA", "valueB", "valueC" ], "setting6": { "value": 15, "definition": 158 } } | @@ -13900,18 +18798,32 @@ This page lists all known device types from the Overkiz API, grouped by protocol | State | Type | Range / Values | Notes | |-------|------|----------------|-------| + | `ActivatedOptionsState` | DataState | | | | `ActivePartitionState` | DataState | | | | `AvailabilityState` | DiscreteState | available, unavailable | | + | `AvailableModesState` | DataState | | | + | `AvailableOptionsState` | DataState | | | + | `AvailableRecipesState` | DataState | | | + | `AvailableTargetTemperaturesState` | DataState | | | | `BatteryDiscreteLevelState` | DiscreteState | good, medium, low, critical | | | `BatteryLevelState` | ContinuousState | | | - | `ErrorEventState` | DiscreteState | accessLimitation, internal, obstacleProtection, transportBusy, deviceNoAnswer, cancelled, deprecated, interrupted, thermalProtection, maintenanceRequired, alreadyUpToDate, notSupported, hardwareError, accessDenied, updateError, resourceAlreadyExist | | + | `CurrentCycleStageState` | DataState | | | + | `CurrentSoilingState` | ContinuousState | | | + | `CycleStageSequenceState` | DataState | | | | `ErrorState` | DataState | | | | `ErrorsState` | DataState | | | | `FirmwareHashState` | DataState | | | | `FirmwareRevisionState` | DataState | | | + | `IntensityState` | ContinuousState | | | + | `LightIntensityState` | ContinuousState | [0..100] | | + | `LockedUnlockedState` | DiscreteState | locked, unlocked | | + | `ModeState` | DataState | | | | `NameState` | DataState | | | | `NewFirmwareAvailableState` | DataState | | | | `OnOffState` | DiscreteState | on, off | | + | `OpenClosedState` | DiscreteState | open, closed | | + | `OpenState` | DataState | | | + | `PausedState` | DataState | | | | `Private10State` | DataState | | | | `Private1State` | DataState | | | | `Private2State` | DataState | | | @@ -13922,23 +18834,63 @@ This page lists all known device types from the Overkiz API, grouped by protocol | `Private7State` | DataState | | | | `Private8State` | DataState | | | | `Private9State` | DataState | | | + | `RecipeState` | DataState | | | + | `RecommendedOptionsState` | DataState | | | + | `RecommendedTargetHumidityState` | ContinuousState | | | + | `RecommendedTargetPowerState` | ContinuousState | | | + | `RecommendedTargetTemperatureState` | ContinuousState | | | + | `RecommendedTargetTimeState` | ContinuousState | | | + | `RecommendedTargetWeightState` | ContinuousState | | | + | `RemainingTimeState` | ContinuousState | | | | `RemovableState` | DataState | | | + | `RunningTimerState` | DataState | | | | `SignalQualityState` | ContinuousState | | | + | `StartedStoppedState` | DiscreteState | started, stopped | | | `StatusState` | DiscreteState | available, unavailable | | + | `TargetHumidityCurrentLowerBoundState` | ContinuousState | | | + | `TargetHumidityCurrentUpperBoundState` | ContinuousState | | | + | `TargetHumidityState` | ContinuousState | | | + | `TargetPowerCurrentLowerBoundState` | ContinuousState | | | + | `TargetPowerCurrentUpperBoundState` | ContinuousState | | | + | `TargetPowerState` | ContinuousState | | | + | `TargetTemperatureCurrentLowerBoundState` | ContinuousState | | | + | `TargetTemperatureCurrentUpperBoundState` | ContinuousState | | | + | `TargetTemperatureReachedState` | DataState | | | + | `TargetTemperatureState` | ContinuousState | [12.0..30.0] | | + | `TargetTimeCurrentLowerBoundState` | ContinuousState | | | + | `TargetTimeCurrentUpperBoundState` | ContinuousState | | | + | `TargetTimeState` | ContinuousState | | | + | `TargetWeightCurrentLowerBoundState` | ContinuousState | | | + | `TargetWeightCurrentUpperBoundState` | ContinuousState | | | + | `TargetWeightState` | ContinuousState | | | + | `TemperatureState` | ContinuousState | [-100.0..100.0] | | + | `TimezoneState` | DataState | | | + | `UnavailableFeaturesState` | DataState | | | -??? note "ContactSensor/DynamicOpeningSensor (SENSOR) — 7 commands, 26 states" +??? note "Pergola/DynamicPergola (ACTUATOR) — 18 commands, 31 states" - **Type IDs:** `272` | **Servers:** `rexel`, `somfy_europe` | **Controllable:** `ogp:OpeningSensor` | **Profiles:** `WindowOpeningStatus`, `OpeningStatus` + **Type IDs:** `287` | **Servers:** `rexel` | **Controllable:** `ogp:Pergola` | **Profiles:** `StatefulOrientablePlusCloseablePergola`, `StatefulOrientablePlusCloseable`, `OrientablePlusCloseable`, `StatefulCloseable`, `Closeable`, `StatefulOpenClose`, `OpenClose` **Commands** | Command | Parameters | Notes | |---------|-----------|-------| + | `close` | | Fully close the device | | `executeManufacturerProcedure` | STRING; OBJECT (optional) | execute manufacturer procedure command. p1: the procedure name p2: the params associated Example: p1 = "dead_man_up" p2 = {"duration": 42} | + | `goToAlias` | STRING | Send alias command linked with the ID. | | `identify` | | Ask the device to identify itself by doing a slight movement or blink or beep | + | `open` | | Fully open the device | | `readManufacturerData` | ARRAY | Read manufacturer data values from given names. Example: ["setting1","setting2"]. | + | `right` | | Right the device (go to minimum tilt position - open) | + | `saveAlias` | STRING | Allow to send an order for the product to save the current state of the alias. | | `sendPrivate` | OBJECT | send a private command | + | `setClosure` | INT [0..100] | Closure level (100%=fully close, 0%=open) | | `setName` | STRING | Change the device internal name. Name length may be subject to restrictions depending on the device and underlying protocol. | + | `setNodeDefinition` | STRING; STRING (optional); STRING (optional) | Fill the node definition (some transitions can be forbidden) p1: type (mandatory) p2: subType (mandatory if definition is set) p3: definition | + | `setOrientation` | INT [0..100] | Set the relative orientation (0-100%) of the device slats | + | `setTilt` | INT [0..100] | set the device tilt percentage | + | `stop` | | Stop the current actuator behavior (movement, sound or timer) | + | `tilt` | | Go to maximum tilt position (closed) | | `update` | | Update the gateway software. The update may have to be downloaded first, which can take a while. | | `writeManufacturerData` | OBJECT | Write manufacturer data values. Example: { "setting1": true, "setting2": 42, "setting3": "overkiz", "setting4": "Dk8PDr1WD0sfAAAAAAAAAAAAAAAAAAAA", "setting5": [ "valueA", "valueB", "valueC" ], "setting6": { "value": 15, "definition": 158 } } | @@ -13950,6 +18902,7 @@ This page lists all known device types from the Overkiz API, grouped by protocol | `AvailabilityState` | DiscreteState | available, unavailable | | | `BatteryDiscreteLevelState` | DiscreteState | good, medium, low, critical | | | `BatteryLevelState` | ContinuousState | | | + | `ClosureState` | ContinuousState | [0..100] | | | `ErrorEventState` | DiscreteState | accessLimitation, internal, obstacleProtection, transportBusy, deviceNoAnswer, cancelled, deprecated, interrupted, thermalProtection, maintenanceRequired, alreadyUpToDate, notSupported, hardwareError, accessDenied, updateError, resourceAlreadyExist | | | `ErrorState` | DataState | | | | `ErrorsState` | DataState | | | @@ -13958,7 +18911,6 @@ This page lists all known device types from the Overkiz API, grouped by protocol | `NameState` | DataState | | | | `NewFirmwareAvailableState` | DataState | | | | `OpenClosedState` | DiscreteState | open, closed | | - | `OpenState` | DataState | | | | `Private10State` | DataState | | | | `Private1State` | DataState | | | | `Private2State` | DataState | | | @@ -13969,13 +18921,18 @@ This page lists all known device types from the Overkiz API, grouped by protocol | `Private7State` | DataState | | | | `Private8State` | DataState | | | | `Private9State` | DataState | | | + | `ReachedAliasesState` | DataState | | | | `RemovableState` | DataState | | | | `SignalQualityState` | ContinuousState | | | + | `SlateOrientationState` | ContinuousState | [0..100] | | | `StatusState` | DiscreteState | available, unavailable | | + | `TiltState` | ContinuousState | | | + | `TiltedState` | DiscreteState | true, false | | + | `UnavailableFeaturesState` | DataState | | | -??? note "Curtain/DynamicCurtain (ACTUATOR) — 14 commands, 28 states" +??? note "Pergola/DynamicPergola (ACTUATOR) — 18 commands, 30 states" - **Type IDs:** `271` | **Servers:** `rexel`, `somfy_europe` | **Controllable:** `ogp:Curtain` | **Profiles:** `StatefulCloseableCurtain`, `StatefulCloseable`, `Closeable`, `StatefulOpenClose`, `OpenClose` + **Type IDs:** `287` | **Servers:** `somfy_europe` | **Controllable:** `ogp:Pergola` | **Profiles:** `StatefulOrientablePlusCloseablePergola`, `StatefulOrientablePlusCloseable`, `OrientablePlusCloseable`, `StatefulCloseable`, `Closeable`, `StatefulOpenClose`, `OpenClose` **Commands** @@ -13987,12 +18944,16 @@ This page lists all known device types from the Overkiz API, grouped by protocol | `identify` | | Ask the device to identify itself by doing a slight movement or blink or beep | | `open` | | Fully open the device | | `readManufacturerData` | ARRAY | Read manufacturer data values from given names. Example: ["setting1","setting2"]. | + | `right` | | Right the device (go to minimum tilt position - open) | | `saveAlias` | STRING | Allow to send an order for the product to save the current state of the alias. | | `sendPrivate` | OBJECT | send a private command | | `setClosure` | INT [0..100] | Closure level (100%=fully close, 0%=open) | | `setName` | STRING | Change the device internal name. Name length may be subject to restrictions depending on the device and underlying protocol. | | `setNodeDefinition` | STRING; STRING (optional); STRING (optional) | Fill the node definition (some transitions can be forbidden) p1: type (mandatory) p2: subType (mandatory if definition is set) p3: definition | + | `setOrientation` | INT [0..100] | Set the relative orientation (0-100%) of the device slats | + | `setTilt` | INT [0..100] | set the device tilt percentage | | `stop` | | Stop the current actuator behavior (movement, sound or timer) | + | `tilt` | | Go to maximum tilt position (closed) | | `update` | | Update the gateway software. The update may have to be downloaded first, which can take a while. | | `writeManufacturerData` | OBJECT | Write manufacturer data values. Example: { "setting1": true, "setting2": 42, "setting3": "overkiz", "setting4": "Dk8PDr1WD0sfAAAAAAAAAAAAAAAAAAAA", "setting5": [ "valueA", "valueB", "valueC" ], "setting6": { "value": 15, "definition": 158 } } | @@ -14005,7 +18966,6 @@ This page lists all known device types from the Overkiz API, grouped by protocol | `BatteryDiscreteLevelState` | DiscreteState | good, medium, low, critical | | | `BatteryLevelState` | ContinuousState | | | | `ClosureState` | ContinuousState | [0..100] | | - | `ErrorEventState` | DiscreteState | accessLimitation, internal, obstacleProtection, transportBusy, deviceNoAnswer, cancelled, deprecated, interrupted, thermalProtection, maintenanceRequired, alreadyUpToDate, notSupported, hardwareError, accessDenied, updateError, resourceAlreadyExist | | | `ErrorState` | DataState | | | | `ErrorsState` | DataState | | | | `FirmwareHashState` | DataState | | | @@ -14026,22 +18986,33 @@ This page lists all known device types from the Overkiz API, grouped by protocol | `ReachedAliasesState` | DataState | | | | `RemovableState` | DataState | | | | `SignalQualityState` | ContinuousState | | | + | `SlateOrientationState` | ContinuousState | [0..100] | | | `StatusState` | DiscreteState | available, unavailable | | + | `TiltState` | ContinuousState | | | + | `TiltedState` | DiscreteState | true, false | | | `UnavailableFeaturesState` | DataState | | | -??? note "ElectricitySensor/DynamicElectricityConsumptionSensor (SENSOR) — 7 commands, 26 states" +??? note "ProtocolGateway/DynamicBridge (ACTUATOR) — 15 commands, 26 states" - **Type IDs:** `293` | **Servers:** `rexel`, `somfy_europe` | **Controllable:** `ogp:ElectricityConsumptionSensor` | **Profiles:** `ElectricEnergyAndPower`, `ElectricPowerMeter`, `ElectricEnergyConsumption` + **Type IDs:** `1` | **Servers:** `rexel` | **Controllable:** `ogp:Bridge` | **Profiles:** `Specific` **Commands** | Command | Parameters | Notes | |---------|-----------|-------| + | `associateCandidate` | STRING | Pair given candidate | + | `discover` | | Start a new discovery procedure. | | `executeManufacturerProcedure` | STRING; OBJECT (optional) | execute manufacturer procedure command. p1: the procedure name p2: the params associated Example: p1 = "dead_man_up" p2 = {"duration": 42} | + | `getCandidates` | | Discover all candidates available for association. | | `identify` | | Ask the device to identify itself by doing a slight movement or blink or beep | + | `joinSetup` | | Join an existing setup | + | `pair` | STRING; STRING (optional); STRING (optional) | Execute the pairing procedure p1: type (mandatory) p2: subType (mandatory if definition is set) p3: definition | | `readManufacturerData` | ARRAY | Read manufacturer data values from given names. Example: ["setting1","setting2"]. | + | `reset` | | Bring back into initial condition. | | `sendPrivate` | OBJECT | send a private command | + | `setAuthentication` | OBJECT | Set authentication properties of a node | | `setName` | STRING | Change the device internal name. Name length may be subject to restrictions depending on the device and underlying protocol. | + | `shareSetup` | | Share the current setup with another controller | | `update` | | Update the gateway software. The update may have to be downloaded first, which can take a while. | | `writeManufacturerData` | OBJECT | Write manufacturer data values. Example: { "setting1": true, "setting2": 42, "setting3": "overkiz", "setting4": "Dk8PDr1WD0sfAAAAAAAAAAAAAAAAAAAA", "setting5": [ "valueA", "valueB", "valueC" ], "setting6": { "value": 15, "definition": 158 } } | @@ -14050,12 +19021,12 @@ This page lists all known device types from the Overkiz API, grouped by protocol | State | Type | Range / Values | Notes | |-------|------|----------------|-------| | `ActivePartitionState` | DataState | | | + | `AuthenticationExpiredState` | DataState | | | | `AvailabilityState` | DiscreteState | available, unavailable | | | `BatteryDiscreteLevelState` | DiscreteState | good, medium, low, critical | | | `BatteryLevelState` | ContinuousState | | | - | `ElectricEnergyConsumptionState` | ContinuousState | | | - | `ElectricPowerConsumptionState` | ContinuousState | | | - | `ErrorEventState` | DiscreteState | accessLimitation, internal, obstacleProtection, transportBusy, deviceNoAnswer, cancelled, deprecated, interrupted, thermalProtection, maintenanceRequired, alreadyUpToDate, notSupported, hardwareError, accessDenied, updateError, resourceAlreadyExist | | + | `CandidatesState` | DataState | | | + | `ErrorEventState` | DiscreteState | | | | `ErrorState` | DataState | | | | `ErrorsState` | DataState | | | | `FirmwareHashState` | DataState | | | @@ -14076,27 +19047,22 @@ This page lists all known device types from the Overkiz API, grouped by protocol | `SignalQualityState` | ContinuousState | | | | `StatusState` | DiscreteState | available, unavailable | | -??? note "GarageDoor/DynamicGarageDoor (ACTUATOR) — 15 commands, 28 states" +??? note "ProtocolGateway/DynamicGateway (ACTUATOR) — 10 commands, 35 states" - **Type IDs:** `266` | **Servers:** `rexel`, `somfy_europe` | **Controllable:** `ogp:GarageDoor` | **Profiles:** `StatefulCloseableGarageOpener`, `StatefulCloseable`, `Closeable`, `StatefulOpenClose`, `OpenClose`, `Cyclic` + **Type IDs:** `2` | **Servers:** `rexel` | **Controllable:** `ogp:Gateway` | **Profiles:** `Specific` **Commands** | Command | Parameters | Notes | |---------|-----------|-------| - | `close` | | Fully close the device | - | `cycle` | | Do a cycle of supported motion kinematics or modes | | `executeManufacturerProcedure` | STRING; OBJECT (optional) | execute manufacturer procedure command. p1: the procedure name p2: the params associated Example: p1 = "dead_man_up" p2 = {"duration": 42} | - | `goToAlias` | STRING | Send alias command linked with the ID. | | `identify` | | Ask the device to identify itself by doing a slight movement or blink or beep | - | `open` | | Fully open the device | | `readManufacturerData` | ARRAY | Read manufacturer data values from given names. Example: ["setting1","setting2"]. | - | `saveAlias` | STRING | Allow to send an order for the product to save the current state of the alias. | + | `reboot` | | Reboot the device | + | `reset` | | Bring back into initial condition. | | `sendPrivate` | OBJECT | send a private command | - | `setClosure` | INT [0..100] | Closure level (100%=fully close, 0%=open) | | `setName` | STRING | Change the device internal name. Name length may be subject to restrictions depending on the device and underlying protocol. | - | `setNodeDefinition` | STRING; STRING (optional); STRING (optional) | Fill the node definition (some transitions can be forbidden) p1: type (mandatory) p2: subType (mandatory if definition is set) p3: definition | - | `stop` | | Stop the current actuator behavior (movement, sound or timer) | + | `setTimezone` | STRING | Set the device timezone, according to TZ database names. | | `update` | | Update the gateway software. The update may have to be downloaded first, which can take a while. | | `writeManufacturerData` | OBJECT | Write manufacturer data values. Example: { "setting1": true, "setting2": 42, "setting3": "overkiz", "setting4": "Dk8PDr1WD0sfAAAAAAAAAAAAAAAAAAAA", "setting5": [ "valueA", "valueB", "valueC" ], "setting6": { "value": 15, "definition": 158 } } | @@ -14105,18 +19071,25 @@ This page lists all known device types from the Overkiz API, grouped by protocol | State | Type | Range / Values | Notes | |-------|------|----------------|-------| | `ActivePartitionState` | DataState | | | + | `ApnState` | DataState | | | | `AvailabilityState` | DiscreteState | available, unavailable | | | `BatteryDiscreteLevelState` | DiscreteState | good, medium, low, critical | | | `BatteryLevelState` | ContinuousState | | | - | `ClosureState` | ContinuousState | [0..100] | | | `ErrorEventState` | DiscreteState | accessLimitation, internal, obstacleProtection, transportBusy, deviceNoAnswer, cancelled, deprecated, interrupted, thermalProtection, maintenanceRequired, alreadyUpToDate, notSupported, hardwareError, accessDenied, updateError, resourceAlreadyExist | | | `ErrorState` | DataState | | | | `ErrorsState` | DataState | | | | `FirmwareHashState` | DataState | | | | `FirmwareRevisionState` | DataState | | | + | `IccidState` | DataState | | | + | `ImsiState` | DataState | | | + | `LocalAccessProofState` | DataState | | | + | `LocalIPv4AddressState` | DataState | | | + | `MobileOperatorState` | DataState | | | | `NameState` | DataState | | | + | `NetworkGatewayState` | DataState | | | + | `NetworkMacState` | DataState | | | + | `NetworkMaskState` | DataState | | | | `NewFirmwareAvailableState` | DataState | | | - | `OpenClosedState` | DiscreteState | open, closed | | | `Private10State` | DataState | | | | `Private1State` | DataState | | | | `Private2State` | DataState | | | @@ -14127,25 +19100,35 @@ This page lists all known device types from the Overkiz API, grouped by protocol | `Private7State` | DataState | | | | `Private8State` | DataState | | | | `Private9State` | DataState | | | - | `ReachedAliasesState` | DataState | | | | `RemovableState` | DataState | | | + | `SSIDState` | DataState | | | | `SignalQualityState` | ContinuousState | | | | `StatusState` | DiscreteState | available, unavailable | | - | `UnavailableFeaturesState` | DataState | | | + | `TimezoneState` | DataState | | | -??? note "GasSensor/DynamicGasMeasurementSensor (SENSOR) — 7 commands, 26 states" +??? note "ProtocolGateway/DynamicBridge (ACTUATOR) — 17 commands, 28 states" - **Type IDs:** `296` | **Servers:** `rexel`, `somfy_europe` | **Controllable:** `ogp:GasMeasurementSensor` | **Profiles:** `GasConsumption` + **Type IDs:** `1` | **Servers:** `somfy_europe` | **Controllable:** `ogp:Bridge` | **Profiles:** `Specific` **Commands** | Command | Parameters | Notes | |---------|-----------|-------| + | `associateCandidate` | STRING | Pair given candidate | + | `closeCommissioning` | | Close the commissioning window. | + | `discover` | | Start a new discovery procedure. | | `executeManufacturerProcedure` | STRING; OBJECT (optional) | execute manufacturer procedure command. p1: the procedure name p2: the params associated Example: p1 = "dead_man_up" p2 = {"duration": 42} | + | `getCandidates` | | Discover all candidates available for association. | | `identify` | | Ask the device to identify itself by doing a slight movement or blink or beep | + | `joinSetup` | | Join an existing setup | + | `openCommissioning` | INT [1..65535] | Open the commissioning window to let the device be discovered by other controllers. Duration in seconds for which the commissioning window will be open. | + | `pair` | STRING; STRING (optional); STRING (optional) | Execute the pairing procedure p1: type (mandatory) p2: subType (mandatory if definition is set) p3: definition | | `readManufacturerData` | ARRAY | Read manufacturer data values from given names. Example: ["setting1","setting2"]. | + | `reset` | | Bring back into initial condition. | | `sendPrivate` | OBJECT | send a private command | + | `setAuthentication` | OBJECT | Set authentication properties of a node | | `setName` | STRING | Change the device internal name. Name length may be subject to restrictions depending on the device and underlying protocol. | + | `shareSetup` | | Share the current setup with another controller | | `update` | | Update the gateway software. The update may have to be downloaded first, which can take a while. | | `writeManufacturerData` | OBJECT | Write manufacturer data values. Example: { "setting1": true, "setting2": 42, "setting3": "overkiz", "setting4": "Dk8PDr1WD0sfAAAAAAAAAAAAAAAAAAAA", "setting5": [ "valueA", "valueB", "valueC" ], "setting6": { "value": 15, "definition": 158 } } | @@ -14154,16 +19137,18 @@ This page lists all known device types from the Overkiz API, grouped by protocol | State | Type | Range / Values | Notes | |-------|------|----------------|-------| | `ActivePartitionState` | DataState | | | + | `AuthenticationExpiredState` | DataState | | | | `AvailabilityState` | DiscreteState | available, unavailable | | | `BatteryDiscreteLevelState` | DiscreteState | good, medium, low, critical | | | `BatteryLevelState` | ContinuousState | | | - | `ErrorEventState` | DiscreteState | accessLimitation, internal, obstacleProtection, transportBusy, deviceNoAnswer, cancelled, deprecated, interrupted, thermalProtection, maintenanceRequired, alreadyUpToDate, notSupported, hardwareError, accessDenied, updateError, resourceAlreadyExist | | + | `CandidatesState` | DataState | | | + | `CommissioningWindowCloseTimestampState` | DataState | [1..65535] | | + | `CommissioningWindowOpenState` | DataState | | | + | `CredentialsState` | DataState | | | | `ErrorState` | DataState | | | | `ErrorsState` | DataState | | | | `FirmwareHashState` | DataState | | | | `FirmwareRevisionState` | DataState | | | - | `GasConsumptionState` | ContinuousState | | | - | `GasFlowState` | ContinuousState | | | | `NameState` | DataState | | | | `NewFirmwareAvailableState` | DataState | | | | `Private10State` | DataState | | | @@ -14180,27 +19165,22 @@ This page lists all known device types from the Overkiz API, grouped by protocol | `SignalQualityState` | ContinuousState | | | | `StatusState` | DiscreteState | available, unavailable | | -??? note "Gate/DynamicGate (ACTUATOR) — 15 commands, 28 states" +??? note "ProtocolGateway/DynamicGateway (ACTUATOR) — 10 commands, 34 states" - **Type IDs:** `265` | **Servers:** `rexel`, `somfy_europe` | **Controllable:** `ogp:Gate` | **Profiles:** `StatefulCloseableGateOpener`, `StatefulCloseable`, `Closeable`, `StatefulOpenClose`, `OpenClose`, `Cyclic` + **Type IDs:** `2` | **Servers:** `somfy_europe` | **Controllable:** `ogp:Gateway` | **Profiles:** `Specific` **Commands** | Command | Parameters | Notes | |---------|-----------|-------| - | `close` | | Fully close the device | - | `cycle` | | Do a cycle of supported motion kinematics or modes | | `executeManufacturerProcedure` | STRING; OBJECT (optional) | execute manufacturer procedure command. p1: the procedure name p2: the params associated Example: p1 = "dead_man_up" p2 = {"duration": 42} | - | `goToAlias` | STRING | Send alias command linked with the ID. | | `identify` | | Ask the device to identify itself by doing a slight movement or blink or beep | - | `open` | | Fully open the device | | `readManufacturerData` | ARRAY | Read manufacturer data values from given names. Example: ["setting1","setting2"]. | - | `saveAlias` | STRING | Allow to send an order for the product to save the current state of the alias. | + | `reboot` | | Reboot the device | + | `reset` | | Bring back into initial condition. | | `sendPrivate` | OBJECT | send a private command | - | `setClosure` | INT [0..100] | Closure level (100%=fully close, 0%=open) | | `setName` | STRING | Change the device internal name. Name length may be subject to restrictions depending on the device and underlying protocol. | - | `setNodeDefinition` | STRING; STRING (optional); STRING (optional) | Fill the node definition (some transitions can be forbidden) p1: type (mandatory) p2: subType (mandatory if definition is set) p3: definition | - | `stop` | | Stop the current actuator behavior (movement, sound or timer) | + | `setTimezone` | STRING | Set the device timezone, according to TZ database names. | | `update` | | Update the gateway software. The update may have to be downloaded first, which can take a while. | | `writeManufacturerData` | OBJECT | Write manufacturer data values. Example: { "setting1": true, "setting2": 42, "setting3": "overkiz", "setting4": "Dk8PDr1WD0sfAAAAAAAAAAAAAAAAAAAA", "setting5": [ "valueA", "valueB", "valueC" ], "setting6": { "value": 15, "definition": 158 } } | @@ -14209,18 +19189,24 @@ This page lists all known device types from the Overkiz API, grouped by protocol | State | Type | Range / Values | Notes | |-------|------|----------------|-------| | `ActivePartitionState` | DataState | | | + | `ApnState` | DataState | | | | `AvailabilityState` | DiscreteState | available, unavailable | | | `BatteryDiscreteLevelState` | DiscreteState | good, medium, low, critical | | | `BatteryLevelState` | ContinuousState | | | - | `ClosureState` | ContinuousState | [0..100] | | - | `ErrorEventState` | DiscreteState | accessLimitation, internal, obstacleProtection, transportBusy, deviceNoAnswer, cancelled, deprecated, interrupted, thermalProtection, maintenanceRequired, alreadyUpToDate, notSupported, hardwareError, accessDenied, updateError, resourceAlreadyExist | | | `ErrorState` | DataState | | | | `ErrorsState` | DataState | | | | `FirmwareHashState` | DataState | | | | `FirmwareRevisionState` | DataState | | | + | `IccidState` | DataState | | | + | `ImsiState` | DataState | | | + | `LocalAccessProofState` | DataState | | | + | `LocalIPv4AddressState` | DataState | | | + | `MobileOperatorState` | DataState | | | | `NameState` | DataState | | | + | `NetworkGatewayState` | DataState | | | + | `NetworkMacState` | DataState | | | + | `NetworkMaskState` | DataState | | | | `NewFirmwareAvailableState` | DataState | | | - | `OpenClosedState` | DiscreteState | open, closed | | | `Private10State` | DataState | | | | `Private1State` | DataState | | | | `Private2State` | DataState | | | @@ -14231,57 +19217,25 @@ This page lists all known device types from the Overkiz API, grouped by protocol | `Private7State` | DataState | | | | `Private8State` | DataState | | | | `Private9State` | DataState | | | - | `ReachedAliasesState` | DataState | | | | `RemovableState` | DataState | | | + | `SSIDState` | DataState | | | | `SignalQualityState` | ContinuousState | | | | `StatusState` | DiscreteState | available, unavailable | | - | `UnavailableFeaturesState` | DataState | | | - -??? note "Generic/Untyped (ACTUATOR) — 3 commands, 4 states" - - **Type IDs:** `16` | **Servers:** `rexel`, `somfy_europe` | **Controllable:** `ogp:Untyped` | **Profiles:** `Specific` - - **Commands** - - | Command | Parameters | Notes | - |---------|-----------|-------| - | `identify` | | Ask the device to identify itself by doing a slight movement or blink or beep | - | `setName` | STRING | Change the device internal name. Name length may be subject to restrictions depending on the device and underlying protocol. | - | `setNodeDefinition` | STRING; STRING (optional); STRING (optional) | Fill the node definition (some transitions can be forbidden) p1: type (mandatory) p2: subType (mandatory if definition is set) p3: definition | - - **States** - - | State | Type | Range / Values | Notes | - |-------|------|----------------|-------| - | `AvailabilityState` | DiscreteState | available, unavailable | | - | `NameState` | DataState | | | - | `RemovableState` | DataState | | | - | `StatusState` | DiscreteState | available, unavailable | | + | `TimezoneState` | DataState | | | -??? note "HeatingSystem/DynamicThermostat (ACTUATOR) — 18 commands, 40 states" +??? note "RainSensor/DynamicRainSensor (SENSOR) — 7 commands, 25 states" - **Type IDs:** `259` | **Servers:** `rexel`, `somfy_europe` | **Controllable:** `ogp:Thermostat` | **Profiles:** `StatefulThermostatWithSensor`, `StatefulThermostat`, `Thermostat`, `RelativeHumidity`, `StatefulSwitchable`, `Switchable`, `StatefulAirFan`, `AirFan` + **Type IDs:** `275` | **Servers:** `rexel` | **Controllable:** `ogp:RainSensor` | **Profiles:** `RainDetector` **Commands** | Command | Parameters | Notes | |---------|-----------|-------| | `executeManufacturerProcedure` | STRING; OBJECT (optional) | execute manufacturer procedure command. p1: the procedure name p2: the params associated Example: p1 = "dead_man_up" p2 = {"duration": 42} | - | `goToAlias` | STRING | Send alias command linked with the ID. | | `identify` | | Ask the device to identify itself by doing a slight movement or blink or beep | - | `off` | | Turn off the device | - | `on` | | Turn on the device | | `readManufacturerData` | ARRAY | Read manufacturer data values from given names. Example: ["setting1","setting2"]. | - | `saveAlias` | STRING | Allow to send an order for the product to save the current state of the alias. | | `sendPrivate` | OBJECT | send a private command | - | `setFanSpeed` | STRING: low, medium, high, auto, 1 | Set the fan speed (%) | - | `setFanSpeedLevel` | INT [0..100] | Set the device fan speed level (%) | - | `setMode` | STRING | Set the active mode. | | `setName` | STRING | Change the device internal name. Name length may be subject to restrictions depending on the device and underlying protocol. | - | `setNodeDefinition` | STRING; STRING (optional); STRING (optional) | Fill the node definition (some transitions can be forbidden) p1: type (mandatory) p2: subType (mandatory if definition is set) p3: definition | - | `setOnOff` | STRING: off, on | Turn the device on or off | - | `setTargetTemperature` | FLOAT | Set the new air temperature to reach | - | `setTimezone` | STRING | Set the device timezone, according to TZ database names. | | `update` | | Update the gateway software. The update may have to be downloaded first, which can take a while. | | `writeManufacturerData` | OBJECT | Write manufacturer data values. Example: { "setting1": true, "setting2": 42, "setting3": "overkiz", "setting4": "Dk8PDr1WD0sfAAAAAAAAAAAAAAAAAAAA", "setting5": [ "valueA", "valueB", "valueC" ], "setting6": { "value": 15, "definition": 158 } } | @@ -14291,21 +19245,15 @@ This page lists all known device types from the Overkiz API, grouped by protocol |-------|------|----------------|-------| | `ActivePartitionState` | DataState | | | | `AvailabilityState` | DiscreteState | available, unavailable | | - | `AvailableModesState` | DataState | | | - | `AvailableTargetTemperaturesState` | DataState | | | | `BatteryDiscreteLevelState` | DiscreteState | good, medium, low, critical | | | `BatteryLevelState` | ContinuousState | | | | `ErrorEventState` | DiscreteState | accessLimitation, internal, obstacleProtection, transportBusy, deviceNoAnswer, cancelled, deprecated, interrupted, thermalProtection, maintenanceRequired, alreadyUpToDate, notSupported, hardwareError, accessDenied, updateError, resourceAlreadyExist | | | `ErrorState` | DataState | | | | `ErrorsState` | DataState | | | - | `FanSpeedLevelState` | ContinuousState | [0..100] | | - | `FanSpeedState` | DiscreteState | low, medium, high, 1, 2, 3, 4, 5, 6, 7, 8, 9 | | | `FirmwareHashState` | DataState | | | | `FirmwareRevisionState` | DataState | | | - | `ModeState` | DataState | | | | `NameState` | DataState | | | | `NewFirmwareAvailableState` | DataState | | | - | `OnOffState` | DiscreteState | on, off | | | `Private10State` | DataState | | | | `Private1State` | DataState | | | | `Private2State` | DataState | | | @@ -14316,46 +19264,24 @@ This page lists all known device types from the Overkiz API, grouped by protocol | `Private7State` | DataState | | | | `Private8State` | DataState | | | | `Private9State` | DataState | | | - | `ReachedAliasesState` | DataState | | | - | `RecommendedTargetTemperatureState` | ContinuousState | | | - | `RelativeHumidityState` | ContinuousState | [0.0..100.0] | | + | `RainState` | DiscreteState | detected, notDetected | | | `RemovableState` | DataState | | | | `SignalQualityState` | ContinuousState | | | | `StatusState` | DiscreteState | available, unavailable | | - | `TargetTemperatureCurrentLowerBoundState` | ContinuousState | | | - | `TargetTemperatureCurrentUpperBoundState` | ContinuousState | | | - | `TargetTemperatureReachedState` | DataState | | | - | `TargetTemperatureState` | ContinuousState | [12.0..30.0] | | - | `TemperatureState` | ContinuousState | [-100.0..100.0] | | - | `TimezoneState` | DataState | | | - | `UnavailableFeaturesState` | DataState | | | -??? note "HeatingSystem/DynamicHvacCentralUnit (ACTUATOR) — 20 commands, 41 states" +??? note "RainSensor/DynamicRainSensor (SENSOR) — 7 commands, 24 states" - **Type IDs:** `269` | **Servers:** `rexel`, `somfy_europe` | **Controllable:** `ogp:HvacCentralUnit` | **Profiles:** `StatefulThermostatWithSensor`, `StatefulThermostat`, `Thermostat`, `RelativeHumidity`, `StatefulSwitchable`, `Switchable`, `StatefulAirFan`, `AirFan` + **Type IDs:** `275` | **Servers:** `somfy_europe` | **Controllable:** `ogp:RainSensor` | **Profiles:** `RainDetector` **Commands** | Command | Parameters | Notes | |---------|-----------|-------| - | `addGroupMember` | STRING | Add member to the group p1 : Id of the member to add to the group. | | `executeManufacturerProcedure` | STRING; OBJECT (optional) | execute manufacturer procedure command. p1: the procedure name p2: the params associated Example: p1 = "dead_man_up" p2 = {"duration": 42} | - | `goToAlias` | STRING | Send alias command linked with the ID. | | `identify` | | Ask the device to identify itself by doing a slight movement or blink or beep | - | `off` | | Turn off the device | - | `on` | | Turn on the device | | `readManufacturerData` | ARRAY | Read manufacturer data values from given names. Example: ["setting1","setting2"]. | - | `removeGroupMember` | STRING | Remove a member of the group. p1 : Id of the member to remove to the group. | - | `saveAlias` | STRING | Allow to send an order for the product to save the current state of the alias. | | `sendPrivate` | OBJECT | send a private command | - | `setFanSpeed` | STRING: low, medium, high, auto, 1 | Set the fan speed (%) | - | `setFanSpeedLevel` | INT [0..100] | Set the device fan speed level (%) | - | `setMode` | STRING | Set the active mode. | | `setName` | STRING | Change the device internal name. Name length may be subject to restrictions depending on the device and underlying protocol. | - | `setNodeDefinition` | STRING; STRING (optional); STRING (optional) | Fill the node definition (some transitions can be forbidden) p1: type (mandatory) p2: subType (mandatory if definition is set) p3: definition | - | `setOnOff` | STRING: off, on | Turn the device on or off | - | `setTargetTemperature` | FLOAT | Set the new air temperature to reach | - | `setTimezone` | STRING | Set the device timezone, according to TZ database names. | | `update` | | Update the gateway software. The update may have to be downloaded first, which can take a while. | | `writeManufacturerData` | OBJECT | Write manufacturer data values. Example: { "setting1": true, "setting2": 42, "setting3": "overkiz", "setting4": "Dk8PDr1WD0sfAAAAAAAAAAAAAAAAAAAA", "setting5": [ "valueA", "valueB", "valueC" ], "setting6": { "value": 15, "definition": 158 } } | @@ -14365,22 +19291,14 @@ This page lists all known device types from the Overkiz API, grouped by protocol |-------|------|----------------|-------| | `ActivePartitionState` | DataState | | | | `AvailabilityState` | DiscreteState | available, unavailable | | - | `AvailableModesState` | DataState | | | - | `AvailableTargetTemperaturesState` | DataState | | | | `BatteryDiscreteLevelState` | DiscreteState | good, medium, low, critical | | | `BatteryLevelState` | ContinuousState | | | - | `ErrorEventState` | DiscreteState | accessLimitation, internal, obstacleProtection, transportBusy, deviceNoAnswer, cancelled, deprecated, interrupted, thermalProtection, maintenanceRequired, alreadyUpToDate, notSupported, hardwareError, accessDenied, updateError, resourceAlreadyExist | | | `ErrorState` | DataState | | | | `ErrorsState` | DataState | | | - | `FanSpeedLevelState` | ContinuousState | [0..100] | | - | `FanSpeedState` | DiscreteState | low, medium, high, 1, 2, 3, 4, 5, 6, 7, 8, 9 | | | `FirmwareHashState` | DataState | | | | `FirmwareRevisionState` | DataState | | | - | `GroupMembersState` | DataState | | | - | `ModeState` | DataState | | | | `NameState` | DataState | | | | `NewFirmwareAvailableState` | DataState | | | - | `OnOffState` | DiscreteState | on, off | | | `Private10State` | DataState | | | | `Private1State` | DataState | | | | `Private2State` | DataState | | | @@ -14391,23 +19309,14 @@ This page lists all known device types from the Overkiz API, grouped by protocol | `Private7State` | DataState | | | | `Private8State` | DataState | | | | `Private9State` | DataState | | | - | `ReachedAliasesState` | DataState | | | - | `RecommendedTargetTemperatureState` | ContinuousState | | | - | `RelativeHumidityState` | ContinuousState | [0.0..100.0] | | + | `RainState` | DiscreteState | detected, notDetected | | | `RemovableState` | DataState | | | | `SignalQualityState` | ContinuousState | | | | `StatusState` | DiscreteState | available, unavailable | | - | `TargetTemperatureCurrentLowerBoundState` | ContinuousState | | | - | `TargetTemperatureCurrentUpperBoundState` | ContinuousState | | | - | `TargetTemperatureReachedState` | DataState | | | - | `TargetTemperatureState` | ContinuousState | [12.0..30.0] | | - | `TemperatureState` | ContinuousState | [-100.0..100.0] | | - | `TimezoneState` | DataState | | | - | `UnavailableFeaturesState` | DataState | | | -??? note "HeatingSystem/DynamicHeater (ACTUATOR) — 17 commands, 41 states" +??? note "Scene/DynamicScene (ACTUATOR) — 9 commands, 25 states" - **Type IDs:** `278` | **Servers:** `rexel`, `somfy_europe` | **Controllable:** `ogp:Heater` | **Profiles:** `StatefulThermostatWithSensor`, `StatefulThermostat`, `Thermostat`, `RelativeHumidity`, `ElectricPowerMeter`, `StatefulSwitchable`, `Switchable`, `StatefulDimmable`, `Dimmable` + **Type IDs:** `294` | **Servers:** `rexel` | **Controllable:** `ogp:Scene` | **Profiles:** `Specific` **Commands** @@ -14416,18 +19325,10 @@ This page lists all known device types from the Overkiz API, grouped by protocol | `executeManufacturerProcedure` | STRING; OBJECT (optional) | execute manufacturer procedure command. p1: the procedure name p2: the params associated Example: p1 = "dead_man_up" p2 = {"duration": 42} | | `goToAlias` | STRING | Send alias command linked with the ID. | | `identify` | | Ask the device to identify itself by doing a slight movement or blink or beep | - | `off` | | Turn off the device | - | `on` | | Turn on the device | | `readManufacturerData` | ARRAY | Read manufacturer data values from given names. Example: ["setting1","setting2"]. | | `saveAlias` | STRING | Allow to send an order for the product to save the current state of the alias. | | `sendPrivate` | OBJECT | send a private command | - | `setIntensity` | INT [0..100] | Light intensity level (100%=maximum intensity, 0%=off) | - | `setMode` | STRING | Set the active mode. | | `setName` | STRING | Change the device internal name. Name length may be subject to restrictions depending on the device and underlying protocol. | - | `setNodeDefinition` | STRING; STRING (optional); STRING (optional) | Fill the node definition (some transitions can be forbidden) p1: type (mandatory) p2: subType (mandatory if definition is set) p3: definition | - | `setOnOff` | STRING: off, on | Turn the device on or off | - | `setTargetTemperature` | FLOAT | Set the new air temperature to reach | - | `setTimezone` | STRING | Set the device timezone, according to TZ database names. | | `update` | | Update the gateway software. The update may have to be downloaded first, which can take a while. | | `writeManufacturerData` | OBJECT | Write manufacturer data values. Example: { "setting1": true, "setting2": 42, "setting3": "overkiz", "setting4": "Dk8PDr1WD0sfAAAAAAAAAAAAAAAAAAAA", "setting5": [ "valueA", "valueB", "valueC" ], "setting6": { "value": 15, "definition": 158 } } | @@ -14437,22 +19338,15 @@ This page lists all known device types from the Overkiz API, grouped by protocol |-------|------|----------------|-------| | `ActivePartitionState` | DataState | | | | `AvailabilityState` | DiscreteState | available, unavailable | | - | `AvailableModesState` | DataState | | | - | `AvailableTargetTemperaturesState` | DataState | | | | `BatteryDiscreteLevelState` | DiscreteState | good, medium, low, critical | | | `BatteryLevelState` | ContinuousState | | | - | `ElectricPowerConsumptionState` | ContinuousState | | | | `ErrorEventState` | DiscreteState | accessLimitation, internal, obstacleProtection, transportBusy, deviceNoAnswer, cancelled, deprecated, interrupted, thermalProtection, maintenanceRequired, alreadyUpToDate, notSupported, hardwareError, accessDenied, updateError, resourceAlreadyExist | | | `ErrorState` | DataState | | | | `ErrorsState` | DataState | | | | `FirmwareHashState` | DataState | | | | `FirmwareRevisionState` | DataState | | | - | `IntensityState` | ContinuousState | | | - | `LightIntensityState` | ContinuousState | [0..100] | | - | `ModeState` | DataState | | | | `NameState` | DataState | | | | `NewFirmwareAvailableState` | DataState | | | - | `OnOffState` | DiscreteState | on, off | | | `Private10State` | DataState | | | | `Private1State` | DataState | | | | `Private2State` | DataState | | | @@ -14464,43 +19358,25 @@ This page lists all known device types from the Overkiz API, grouped by protocol | `Private8State` | DataState | | | | `Private9State` | DataState | | | | `ReachedAliasesState` | DataState | | | - | `RecommendedTargetTemperatureState` | ContinuousState | | | - | `RelativeHumidityState` | ContinuousState | [0.0..100.0] | | | `RemovableState` | DataState | | | | `SignalQualityState` | ContinuousState | | | | `StatusState` | DiscreteState | available, unavailable | | - | `TargetTemperatureCurrentLowerBoundState` | ContinuousState | | | - | `TargetTemperatureCurrentUpperBoundState` | ContinuousState | | | - | `TargetTemperatureReachedState` | DataState | | | - | `TargetTemperatureState` | ContinuousState | [12.0..30.0] | | - | `TemperatureState` | ContinuousState | [-100.0..100.0] | | - | `TimezoneState` | DataState | | | - | `UnavailableFeaturesState` | DataState | | | -??? note "HeatingSystem/DynamicHvacZone (ACTUATOR) — 18 commands, 43 states" +??? note "Scene/DynamicScene (ACTUATOR) — 9 commands, 24 states" - **Type IDs:** `289` | **Servers:** `rexel`, `somfy_europe` | **Controllable:** `ogp:HvacZone` | **Profiles:** `StatefulThermostatWithSensor`, `StatefulThermostat`, `Thermostat`, `StatefulSwitchable`, `Switchable`, `StatefulAirFan`, `AirFan` + **Type IDs:** `294` | **Servers:** `somfy_europe` | **Controllable:** `ogp:Scene` | **Profiles:** `Specific` **Commands** | Command | Parameters | Notes | |---------|-----------|-------| - | `activateOption` | STRING | Activate an option | - | `cancelHolidayMode` | | Deactivate holidays mode | - | `configureHolidayMode` | INT; INT | Configure holiday mode p1 : start date (timestamp in millisecond) p2 : end date (timestamp in millisecond) | - | `deactivateOption` | STRING | Deactivate an option | | `executeManufacturerProcedure` | STRING; OBJECT (optional) | execute manufacturer procedure command. p1: the procedure name p2: the params associated Example: p1 = "dead_man_up" p2 = {"duration": 42} | + | `goToAlias` | STRING | Send alias command linked with the ID. | | `identify` | | Ask the device to identify itself by doing a slight movement or blink or beep | - | `off` | | Turn off the device | - | `on` | | Turn on the device | | `readManufacturerData` | ARRAY | Read manufacturer data values from given names. Example: ["setting1","setting2"]. | + | `saveAlias` | STRING | Allow to send an order for the product to save the current state of the alias. | | `sendPrivate` | OBJECT | send a private command | - | `setFanSpeed` | STRING: low, medium, high, auto, 1 | Set the fan speed (%) | - | `setFanSpeedLevel` | INT [0..100] | Set the device fan speed level (%) | - | `setMode` | STRING | Set the active mode. | | `setName` | STRING | Change the device internal name. Name length may be subject to restrictions depending on the device and underlying protocol. | - | `setOnOff` | STRING: off, on | Turn the device on or off | - | `setTargetTemperature` | FLOAT | Set the new air temperature to reach | | `update` | | Update the gateway software. The update may have to be downloaded first, which can take a while. | | `writeManufacturerData` | OBJECT | Write manufacturer data values. Example: { "setting1": true, "setting2": 42, "setting3": "overkiz", "setting4": "Dk8PDr1WD0sfAAAAAAAAAAAAAAAAAAAA", "setting5": [ "valueA", "valueB", "valueC" ], "setting6": { "value": 15, "definition": 158 } } | @@ -14508,28 +19384,16 @@ This page lists all known device types from the Overkiz API, grouped by protocol | State | Type | Range / Values | Notes | |-------|------|----------------|-------| - | `ActivatedOptionsState` | DataState | | | | `ActivePartitionState` | DataState | | | | `AvailabilityState` | DiscreteState | available, unavailable | | - | `AvailableModesState` | DataState | | | - | `AvailableOptionsState` | DataState | | | - | `AvailableTargetTemperaturesState` | DataState | | | | `BatteryDiscreteLevelState` | DiscreteState | good, medium, low, critical | | | `BatteryLevelState` | ContinuousState | | | - | `ErrorEventState` | DiscreteState | accessLimitation, internal, obstacleProtection, transportBusy, deviceNoAnswer, cancelled, deprecated, interrupted, thermalProtection, maintenanceRequired, alreadyUpToDate, notSupported, hardwareError, accessDenied, updateError, resourceAlreadyExist | | | `ErrorState` | DataState | | | | `ErrorsState` | DataState | | | - | `FanSpeedLevelState` | ContinuousState | [0..100] | | - | `FanSpeedState` | DiscreteState | low, medium, high, 1, 2, 3, 4, 5, 6, 7, 8, 9 | | | `FirmwareHashState` | DataState | | | | `FirmwareRevisionState` | DataState | | | - | `HolidayModeConfiguredState` | DataState | | | - | `HolidayModeEndDateTimeState` | DataState | | | - | `HolidayModeStartDateTimeState` | DataState | | | - | `ModeState` | DataState | | | | `NameState` | DataState | | | | `NewFirmwareAvailableState` | DataState | | | - | `OnOffState` | DiscreteState | on, off | | | `Private10State` | DataState | | | | `Private1State` | DataState | | | | `Private2State` | DataState | | | @@ -14540,21 +19404,14 @@ This page lists all known device types from the Overkiz API, grouped by protocol | `Private7State` | DataState | | | | `Private8State` | DataState | | | | `Private9State` | DataState | | | - | `RecommendedOptionsState` | DataState | | | - | `RecommendedTargetTemperatureState` | ContinuousState | | | + | `ReachedAliasesState` | DataState | | | | `RemovableState` | DataState | | | | `SignalQualityState` | ContinuousState | | | | `StatusState` | DiscreteState | available, unavailable | | - | `TargetTemperatureCurrentLowerBoundState` | ContinuousState | | | - | `TargetTemperatureCurrentUpperBoundState` | ContinuousState | | | - | `TargetTemperatureReachedState` | DataState | | | - | `TargetTemperatureState` | ContinuousState | [12.0..30.0] | | - | `TemperatureState` | ContinuousState | [-100.0..100.0] | | - | `UnavailableFeaturesState` | DataState | | | -??? note "HumiditySensor/DynamicHumiditySensor (SENSOR) — 7 commands, 25 states" +??? note "SceneLauncherController/DynamicSceneLauncherController (REMOTE_CONTROLLER) — 7 commands, 25 states" - **Type IDs:** `276` | **Servers:** `rexel`, `somfy_europe` | **Controllable:** `ogp:HumiditySensor` | **Profiles:** `RelativeHumidity` + **Type IDs:** `292` | **Servers:** `rexel` | **Controllable:** `ogp:SceneLauncherController` | **Profiles:** `ScenarioTrigger` **Commands** @@ -14576,11 +19433,12 @@ This page lists all known device types from the Overkiz API, grouped by protocol | `AvailabilityState` | DiscreteState | available, unavailable | | | `BatteryDiscreteLevelState` | DiscreteState | good, medium, low, critical | | | `BatteryLevelState` | ContinuousState | | | - | `ErrorEventState` | DiscreteState | accessLimitation, internal, obstacleProtection, transportBusy, deviceNoAnswer, cancelled, deprecated, interrupted, thermalProtection, maintenanceRequired, alreadyUpToDate, notSupported, hardwareError, accessDenied, updateError, resourceAlreadyExist | | + | `ErrorEventState` | DiscreteState | | | | `ErrorState` | DataState | | | | `ErrorsState` | DataState | | | | `FirmwareHashState` | DataState | | | | `FirmwareRevisionState` | DataState | | | + | `LaunchStatusState` | DiscreteState | launched, standby | | | `NameState` | DataState | | | | `NewFirmwareAvailableState` | DataState | | | | `Private10State` | DataState | | | @@ -14593,14 +19451,13 @@ This page lists all known device types from the Overkiz API, grouped by protocol | `Private7State` | DataState | | | | `Private8State` | DataState | | | | `Private9State` | DataState | | | - | `RelativeHumidityState` | ContinuousState | [0.0..100.0] | | | `RemovableState` | DataState | | | | `SignalQualityState` | ContinuousState | | | | `StatusState` | DiscreteState | available, unavailable | | -??? note "IntrusionSensor/DynamicIntrusionSensor (SENSOR) — 8 commands, 27 states" +??? note "SceneLauncherController/DynamicSceneLauncherController (REMOTE_CONTROLLER) — 7 commands, 27 states" - **Type IDs:** `281` | **Servers:** `rexel`, `somfy_europe` | **Controllable:** `ogp:IntrusionSensor` | **Profiles:** `IntrusionDetector` + **Type IDs:** `292` | **Servers:** `somfy_europe` | **Controllable:** `ogp:SceneLauncherController` | **Profiles:** `Switch`, `SwitchEvent`, `ScenarioTrigger` **Commands** @@ -14611,7 +19468,6 @@ This page lists all known device types from the Overkiz API, grouped by protocol | `readManufacturerData` | ARRAY | Read manufacturer data values from given names. Example: ["setting1","setting2"]. | | `sendPrivate` | OBJECT | send a private command | | `setName` | STRING | Change the device internal name. Name length may be subject to restrictions depending on the device and underlying protocol. | - | `setNodeDefinition` | STRING; STRING (optional); STRING (optional) | Fill the node definition (some transitions can be forbidden) p1: type (mandatory) p2: subType (mandatory if definition is set) p3: definition | | `update` | | Update the gateway software. The update may have to be downloaded first, which can take a while. | | `writeManufacturerData` | OBJECT | Write manufacturer data values. Example: { "setting1": true, "setting2": 42, "setting3": "overkiz", "setting4": "Dk8PDr1WD0sfAAAAAAAAAAAAAAAAAAAA", "setting5": [ "valueA", "valueB", "valueC" ], "setting6": { "value": 15, "definition": 158 } } | @@ -14619,20 +19475,20 @@ This page lists all known device types from the Overkiz API, grouped by protocol | State | Type | Range / Values | Notes | |-------|------|----------------|-------| + | `ActionEventState` | DataState | | | + | `ActionState` | DataState | | | | `ActivePartitionState` | DataState | | | | `AvailabilityState` | DiscreteState | available, unavailable | | + | `AvailableActionsState` | DataState | | | | `BatteryDiscreteLevelState` | DiscreteState | good, medium, low, critical | | | `BatteryLevelState` | ContinuousState | | | - | `ErrorEventState` | DiscreteState | accessLimitation, internal, obstacleProtection, transportBusy, deviceNoAnswer, cancelled, deprecated, interrupted, thermalProtection, maintenanceRequired, alreadyUpToDate, notSupported, hardwareError, accessDenied, updateError, resourceAlreadyExist | | | `ErrorState` | DataState | | | | `ErrorsState` | DataState | | | | `FirmwareHashState` | DataState | | | | `FirmwareRevisionState` | DataState | | | - | `IntrusionDetectionEventState` | DiscreteState | panic, intrusion | | - | `IntrusionState` | DiscreteState | detected, notDetected | | + | `LaunchStatusState` | DiscreteState | launched, standby | | | `NameState` | DataState | | | | `NewFirmwareAvailableState` | DataState | | | - | `PanicEventState` | DataState | | | | `Private10State` | DataState | | | | `Private1State` | DataState | | | | `Private2State` | DataState | | | @@ -14647,32 +19503,26 @@ This page lists all known device types from the Overkiz API, grouped by protocol | `SignalQualityState` | ContinuousState | | | | `StatusState` | DiscreteState | available, unavailable | | -??? note "Light/DynamicLight (ACTUATOR) — 20 commands, 32 states" +??? note "Screen/DynamicScreen (ACTUATOR) — 14 commands, 28 states" - **Type IDs:** `257` | **Servers:** `rexel`, `somfy_europe` | **Controllable:** `ogp:Light` | **Profiles:** `StatefulLightDimmer`, `ElectricPowerMeter`, `StatefulSwitchable`, `Switchable`, `StatefulDimmable`, `Dimmable`, `Cyclic` + **Type IDs:** `263` | **Servers:** `rexel` | **Controllable:** `ogp:Blind` | **Profiles:** `StatefulCloseableBlind`, `StatefulCloseable`, `Closeable`, `StatefulOpenClose`, `OpenClose` **Commands** | Command | Parameters | Notes | - |---------|-----------|-------| - | `cycle` | | Do a cycle of supported motion kinematics or modes | - | `dimDown` | | Decrease the light intensity step by step | - | `dimUp` | | Increase the light intensity step by step | + |---------|-----------|-------| + | `close` | | Fully close the device | | `executeManufacturerProcedure` | STRING; OBJECT (optional) | execute manufacturer procedure command. p1: the procedure name p2: the params associated Example: p1 = "dead_man_up" p2 = {"duration": 42} | | `goToAlias` | STRING | Send alias command linked with the ID. | | `identify` | | Ask the device to identify itself by doing a slight movement or blink or beep | - | `off` | | Turn off the device | - | `on` | | Turn on the device | + | `open` | | Fully open the device | | `readManufacturerData` | ARRAY | Read manufacturer data values from given names. Example: ["setting1","setting2"]. | | `saveAlias` | STRING | Allow to send an order for the product to save the current state of the alias. | | `sendPrivate` | OBJECT | send a private command | - | `setColorTemperature` | INT [1000..10000] | Set the perceived white temperature for this lamp (°K) | - | `setIntensity` | INT [0..100] | Light intensity level (100%=maximum intensity, 0%=off) | + | `setClosure` | INT [0..100] | Closure level (100%=fully close, 0%=open) | | `setName` | STRING | Change the device internal name. Name length may be subject to restrictions depending on the device and underlying protocol. | | `setNodeDefinition` | STRING; STRING (optional); STRING (optional) | Fill the node definition (some transitions can be forbidden) p1: type (mandatory) p2: subType (mandatory if definition is set) p3: definition | - | `setOnOff` | STRING: off, on | Turn the device on or off | - | `setRGB` | INT [0..255]; INT [0..255]; INT [0..255] | Set the Red,Green,Blue components of the lamp color | - | `toggle` | | Toggle on/off status | + | `stop` | | Stop the current actuator behavior (movement, sound or timer) | | `update` | | Update the gateway software. The update may have to be downloaded first, which can take a while. | | `writeManufacturerData` | OBJECT | Write manufacturer data values. Example: { "setting1": true, "setting2": 42, "setting3": "overkiz", "setting4": "Dk8PDr1WD0sfAAAAAAAAAAAAAAAAAAAA", "setting5": [ "valueA", "valueB", "valueC" ], "setting6": { "value": 15, "definition": 158 } } | @@ -14684,19 +19534,15 @@ This page lists all known device types from the Overkiz API, grouped by protocol | `AvailabilityState` | DiscreteState | available, unavailable | | | `BatteryDiscreteLevelState` | DiscreteState | good, medium, low, critical | | | `BatteryLevelState` | ContinuousState | | | - | `ColorModeState` | DiscreteState | cieXYZ, hueAndStaturation, temperature, rgb | | - | `ColorTemperatureState` | ContinuousState | | | - | `ElectricPowerConsumptionState` | ContinuousState | | | + | `ClosureState` | ContinuousState | [0..100] | | | `ErrorEventState` | DiscreteState | accessLimitation, internal, obstacleProtection, transportBusy, deviceNoAnswer, cancelled, deprecated, interrupted, thermalProtection, maintenanceRequired, alreadyUpToDate, notSupported, hardwareError, accessDenied, updateError, resourceAlreadyExist | | | `ErrorState` | DataState | | | | `ErrorsState` | DataState | | | | `FirmwareHashState` | DataState | | | | `FirmwareRevisionState` | DataState | | | - | `IntensityState` | ContinuousState | | | - | `LightIntensityState` | ContinuousState | [0..100] | | | `NameState` | DataState | | | | `NewFirmwareAvailableState` | DataState | | | - | `OnOffState` | DiscreteState | on, off | | + | `OpenClosedState` | DiscreteState | open, closed | | | `Private10State` | DataState | | | | `Private1State` | DataState | | | | `Private2State` | DataState | | | @@ -14707,25 +19553,32 @@ This page lists all known device types from the Overkiz API, grouped by protocol | `Private7State` | DataState | | | | `Private8State` | DataState | | | | `Private9State` | DataState | | | - | `RGBColorState` | DataState | | | | `ReachedAliasesState` | DataState | | | | `RemovableState` | DataState | | | | `SignalQualityState` | ContinuousState | | | | `StatusState` | DiscreteState | available, unavailable | | + | `UnavailableFeaturesState` | DataState | | | -??? note "LightSensor/DynamicLightSensor (SENSOR) — 7 commands, 26 states" +??? note "Screen/DynamicScreen (ACTUATOR) — 14 commands, 27 states" - **Type IDs:** `273` | **Servers:** `rexel`, `somfy_europe` | **Controllable:** `ogp:LightSensor` | **Profiles:** `Luminance` + **Type IDs:** `263` | **Servers:** `somfy_europe` | **Controllable:** `ogp:Blind` | **Profiles:** `StatefulCloseableBlind`, `StatefulCloseable`, `Closeable`, `StatefulOpenClose`, `OpenClose` **Commands** | Command | Parameters | Notes | |---------|-----------|-------| + | `close` | | Fully close the device | | `executeManufacturerProcedure` | STRING; OBJECT (optional) | execute manufacturer procedure command. p1: the procedure name p2: the params associated Example: p1 = "dead_man_up" p2 = {"duration": 42} | + | `goToAlias` | STRING | Send alias command linked with the ID. | | `identify` | | Ask the device to identify itself by doing a slight movement or blink or beep | + | `open` | | Fully open the device | | `readManufacturerData` | ARRAY | Read manufacturer data values from given names. Example: ["setting1","setting2"]. | + | `saveAlias` | STRING | Allow to send an order for the product to save the current state of the alias. | | `sendPrivate` | OBJECT | send a private command | + | `setClosure` | INT [0..100] | Closure level (100%=fully close, 0%=open) | | `setName` | STRING | Change the device internal name. Name length may be subject to restrictions depending on the device and underlying protocol. | + | `setNodeDefinition` | STRING; STRING (optional); STRING (optional) | Fill the node definition (some transitions can be forbidden) p1: type (mandatory) p2: subType (mandatory if definition is set) p3: definition | + | `stop` | | Stop the current actuator behavior (movement, sound or timer) | | `update` | | Update the gateway software. The update may have to be downloaded first, which can take a while. | | `writeManufacturerData` | OBJECT | Write manufacturer data values. Example: { "setting1": true, "setting2": 42, "setting3": "overkiz", "setting4": "Dk8PDr1WD0sfAAAAAAAAAAAAAAAAAAAA", "setting5": [ "valueA", "valueB", "valueC" ], "setting6": { "value": 15, "definition": 158 } } | @@ -14737,15 +19590,14 @@ This page lists all known device types from the Overkiz API, grouped by protocol | `AvailabilityState` | DiscreteState | available, unavailable | | | `BatteryDiscreteLevelState` | DiscreteState | good, medium, low, critical | | | `BatteryLevelState` | ContinuousState | | | - | `ErrorEventState` | DiscreteState | accessLimitation, internal, obstacleProtection, transportBusy, deviceNoAnswer, cancelled, deprecated, interrupted, thermalProtection, maintenanceRequired, alreadyUpToDate, notSupported, hardwareError, accessDenied, updateError, resourceAlreadyExist | | + | `ClosureState` | ContinuousState | [0..100] | | | `ErrorState` | DataState | | | | `ErrorsState` | DataState | | | | `FirmwareHashState` | DataState | | | | `FirmwareRevisionState` | DataState | | | - | `IlluminanceState` | ContinuousState | | | - | `LuminanceState` | ContinuousState | | | | `NameState` | DataState | | | | `NewFirmwareAvailableState` | DataState | | | + | `OpenClosedState` | DiscreteState | open, closed | | | `Private10State` | DataState | | | | `Private1State` | DataState | | | | `Private2State` | DataState | | | @@ -14756,45 +19608,35 @@ This page lists all known device types from the Overkiz API, grouped by protocol | `Private7State` | DataState | | | | `Private8State` | DataState | | | | `Private9State` | DataState | | | + | `ReachedAliasesState` | DataState | | | | `RemovableState` | DataState | | | | `SignalQualityState` | ContinuousState | | | | `StatusState` | DiscreteState | available, unavailable | | + | `UnavailableFeaturesState` | DataState | | | -??? note "MusicPlayer/DynamicAudioPlayer (ACTUATOR) — 29 commands, 39 states" +??? note "Shutter/DynamicShutter (ACTUATOR) — 17 commands, 35 states" - **Type IDs:** `288` | **Servers:** `rexel`, `somfy_europe` | **Controllable:** `ogp:AudioPlayer` | **Profiles:** `StoppableMusicPlayer`, `MusicPlayer`, `StatefulStartStop`, `StartStop`, `VolumeControl`, `StatefulSwitchable`, `Switchable` + **Type IDs:** `262` | **Servers:** `rexel` | **Controllable:** `ogp:Shutter` | **Profiles:** `StatefulCloseableShutter`, `StatefulCloseable`, `Closeable`, `StatefulOpenClose`, `OpenClose`, `Cyclic` **Commands** | Command | Parameters | Notes | |---------|-----------|-------| | `activateOption` | STRING | Activate an option | - | `addGroupMember` | STRING | Add member to the group p1 : Id of the member to add to the group. | + | `close` | | Fully close the device | + | `cycle` | | Do a cycle of supported motion kinematics or modes | | `deactivateOption` | STRING | Deactivate an option | | `executeManufacturerProcedure` | STRING; OBJECT (optional) | execute manufacturer procedure command. p1: the procedure name p2: the params associated Example: p1 = "dead_man_up" p2 = {"duration": 42} | - | `fastBackward` | INT | Go to a backward position for a specified time. p1 : Amount of time in sec. | - | `fastForward` | INT | Go to a forward position for a specified time. p1 : Amount of time in sec. | - | `getMediaElements` | | Get the list of all media available. | + | `goToAlias` | STRING | Send alias command linked with the ID. | | `identify` | | Ask the device to identify itself by doing a slight movement or blink or beep | - | `mute` | | Mute the device | - | `next` | | Play next track | - | `off` | | Turn off the device | - | `on` | | Turn on the device | - | `pause` | | Pause current action | - | `play` | | Play media | - | `previous` | | Play previous track | + | `open` | | Fully open the device | | `readManufacturerData` | ARRAY | Read manufacturer data values from given names. Example: ["setting1","setting2"]. | - | `removeGroupMember` | STRING | Remove a member of the group. p1 : Id of the member to remove to the group. | - | `resume` | | Resume paused action. | + | `saveAlias` | STRING | Allow to send an order for the product to save the current state of the alias. | | `sendPrivate` | OBJECT | send a private command | - | `setMediaElement` | STRING | Set the media element as current. p1 : Id of the media element to set. | + | `setClosure` | INT [0..100] | Closure level (100%=fully close, 0%=open) | | `setName` | STRING | Change the device internal name. Name length may be subject to restrictions depending on the device and underlying protocol. | - | `setOnOff` | STRING: off, on | Turn the device on or off | - | `setTimelinePosition` | INT | Go to a position on the timeline. p1 : Position time in sec. | - | `setVolume` | INT [0..100] | Set the device output volume | - | `start` | | Start the default actuator behavior (movement, sound or timer) | + | `setNodeDefinition` | STRING; STRING (optional); STRING (optional) | Fill the node definition (some transitions can be forbidden) p1: type (mandatory) p2: subType (mandatory if definition is set) p3: definition | | `stop` | | Stop the current actuator behavior (movement, sound or timer) | - | `unmute` | | Unmute the device | | `update` | | Update the gateway software. The update may have to be downloaded first, which can take a while. | | `writeManufacturerData` | OBJECT | Write manufacturer data values. Example: { "setting1": true, "setting2": 42, "setting3": "overkiz", "setting4": "Dk8PDr1WD0sfAAAAAAAAAAAAAAAAAAAA", "setting5": [ "valueA", "valueB", "valueC" ], "setting6": { "value": 15, "definition": 158 } } | @@ -14802,27 +19644,25 @@ This page lists all known device types from the Overkiz API, grouped by protocol | State | Type | Range / Values | Notes | |-------|------|----------------|-------| + | `AccessLimitationState` | DataState | | | | `ActivatedOptionsState` | DataState | | | | `ActivePartitionState` | DataState | | | | `AvailabilityState` | DiscreteState | available, unavailable | | | `AvailableOptionsState` | DataState | | | | `BatteryDiscreteLevelState` | DiscreteState | good, medium, low, critical | | | `BatteryLevelState` | ContinuousState | | | + | `ClosureState` | ContinuousState | [0..100] | | | `ErrorEventState` | DiscreteState | accessLimitation, internal, obstacleProtection, transportBusy, deviceNoAnswer, cancelled, deprecated, interrupted, thermalProtection, maintenanceRequired, alreadyUpToDate, notSupported, hardwareError, accessDenied, updateError, resourceAlreadyExist | | | `ErrorState` | DataState | | | | `ErrorsState` | DataState | | | | `FirmwareHashState` | DataState | | | | `FirmwareRevisionState` | DataState | | | - | `GroupMembersState` | DataState | | | - | `HasNextState` | DataState | | | - | `HasPreviousState` | DataState | | | - | `MediaElementState` | DataState | | | - | `MediaElementsEventState` | DataState | | | - | `MuteState` | DataState | | | + | `LimitationSourcesState` | DataState | | | + | `LimitationTimeState` | DataState | | | | `NameState` | DataState | | | | `NewFirmwareAvailableState` | DataState | | | - | `OnOffState` | DiscreteState | on, off | | - | `PausedState` | DataState | | | + | `OpenClosedState` | DiscreteState | open, closed | | + | `PermissiveLimitationState` | DataState | | | | `Private10State` | DataState | | | | `Private1State` | DataState | | | | `Private2State` | DataState | | | @@ -14833,28 +19673,36 @@ This page lists all known device types from the Overkiz API, grouped by protocol | `Private7State` | DataState | | | | `Private8State` | DataState | | | | `Private9State` | DataState | | | + | `ReachedAliasesState` | DataState | | | | `RecommendedOptionsState` | DataState | | | | `RemovableState` | DataState | | | | `SignalQualityState` | ContinuousState | | | - | `StartedStoppedState` | DiscreteState | started, stopped | | | `StatusState` | DiscreteState | available, unavailable | | - | `TimelineDurationState` | DataState | | | - | `TimelinePositionState` | DataState | | | - | `VolumeLevelState` | DataState | | | + | `UnavailableFeaturesState` | DataState | | | -??? note "NoiseSensor/DynamicAmbientNoiseSensor (SENSOR) — 7 commands, 25 states" +??? note "Shutter/DynamicShutter (ACTUATOR) — 17 commands, 34 states" - **Type IDs:** `305` | **Servers:** `rexel`, `somfy_europe` | **Controllable:** `ogp:AmbientNoiseSensor` | **Profiles:** `AmbientNoiseSensor` + **Type IDs:** `262` | **Servers:** `somfy_europe` | **Controllable:** `ogp:Shutter` | **Profiles:** `StatefulCloseableShutter`, `StatefulCloseable`, `Closeable`, `StatefulOpenClose`, `OpenClose`, `Cyclic` **Commands** | Command | Parameters | Notes | |---------|-----------|-------| + | `activateOption` | STRING | Activate an option | + | `close` | | Fully close the device | + | `cycle` | | Do a cycle of supported motion kinematics or modes | + | `deactivateOption` | STRING | Deactivate an option | | `executeManufacturerProcedure` | STRING; OBJECT (optional) | execute manufacturer procedure command. p1: the procedure name p2: the params associated Example: p1 = "dead_man_up" p2 = {"duration": 42} | + | `goToAlias` | STRING | Send alias command linked with the ID. | | `identify` | | Ask the device to identify itself by doing a slight movement or blink or beep | + | `open` | | Fully open the device | | `readManufacturerData` | ARRAY | Read manufacturer data values from given names. Example: ["setting1","setting2"]. | + | `saveAlias` | STRING | Allow to send an order for the product to save the current state of the alias. | | `sendPrivate` | OBJECT | send a private command | + | `setClosure` | INT [0..100] | Closure level (100%=fully close, 0%=open) | | `setName` | STRING | Change the device internal name. Name length may be subject to restrictions depending on the device and underlying protocol. | + | `setNodeDefinition` | STRING; STRING (optional); STRING (optional) | Fill the node definition (some transitions can be forbidden) p1: type (mandatory) p2: subType (mandatory if definition is set) p3: definition | + | `stop` | | Stop the current actuator behavior (movement, sound or timer) | | `update` | | Update the gateway software. The update may have to be downloaded first, which can take a while. | | `writeManufacturerData` | OBJECT | Write manufacturer data values. Example: { "setting1": true, "setting2": 42, "setting3": "overkiz", "setting4": "Dk8PDr1WD0sfAAAAAAAAAAAAAAAAAAAA", "setting5": [ "valueA", "valueB", "valueC" ], "setting6": { "value": 15, "definition": 158 } } | @@ -14862,18 +19710,24 @@ This page lists all known device types from the Overkiz API, grouped by protocol | State | Type | Range / Values | Notes | |-------|------|----------------|-------| + | `AccessLimitationState` | DataState | | | + | `ActivatedOptionsState` | DataState | | | | `ActivePartitionState` | DataState | | | - | `AmbientNoiseState` | ContinuousState | | | | `AvailabilityState` | DiscreteState | available, unavailable | | + | `AvailableOptionsState` | DataState | | | | `BatteryDiscreteLevelState` | DiscreteState | good, medium, low, critical | | | `BatteryLevelState` | ContinuousState | | | - | `ErrorEventState` | DiscreteState | accessLimitation, internal, obstacleProtection, transportBusy, deviceNoAnswer, cancelled, deprecated, interrupted, thermalProtection, maintenanceRequired, alreadyUpToDate, notSupported, hardwareError, accessDenied, updateError, resourceAlreadyExist | | + | `ClosureState` | ContinuousState | [0..100] | | | `ErrorState` | DataState | | | | `ErrorsState` | DataState | | | | `FirmwareHashState` | DataState | | | | `FirmwareRevisionState` | DataState | | | + | `LimitationSourcesState` | DataState | | | + | `LimitationTimeState` | DataState | | | | `NameState` | DataState | | | | `NewFirmwareAvailableState` | DataState | | | + | `OpenClosedState` | DiscreteState | open, closed | | + | `PermissiveLimitationState` | DataState | | | | `Private10State` | DataState | | | | `Private1State` | DataState | | | | `Private2State` | DataState | | | @@ -14884,13 +19738,16 @@ This page lists all known device types from the Overkiz API, grouped by protocol | `Private7State` | DataState | | | | `Private8State` | DataState | | | | `Private9State` | DataState | | | + | `ReachedAliasesState` | DataState | | | + | `RecommendedOptionsState` | DataState | | | | `RemovableState` | DataState | | | | `SignalQualityState` | ContinuousState | | | | `StatusState` | DiscreteState | available, unavailable | | + | `UnavailableFeaturesState` | DataState | | | -??? note "OccupancySensor/DynamicOccupancySensor (SENSOR) — 7 commands, 25 states" +??? note "SmokeSensor/DynamicSmokeSensor (SENSOR) — 7 commands, 25 states" - **Type IDs:** `280` | **Servers:** `rexel`, `somfy_europe` | **Controllable:** `ogp:OccupancySensor` | **Profiles:** `OccupancyDetector` + **Type IDs:** `307` | **Servers:** `somfy_europe` | **Controllable:** `ogp:SmokeSensor` | **Profiles:** `SmokeDetector` **Commands** @@ -14912,14 +19769,12 @@ This page lists all known device types from the Overkiz API, grouped by protocol | `AvailabilityState` | DiscreteState | available, unavailable | | | `BatteryDiscreteLevelState` | DiscreteState | good, medium, low, critical | | | `BatteryLevelState` | ContinuousState | | | - | `ErrorEventState` | DiscreteState | accessLimitation, internal, obstacleProtection, transportBusy, deviceNoAnswer, cancelled, deprecated, interrupted, thermalProtection, maintenanceRequired, alreadyUpToDate, notSupported, hardwareError, accessDenied, updateError, resourceAlreadyExist | | | `ErrorState` | DataState | | | | `ErrorsState` | DataState | | | | `FirmwareHashState` | DataState | | | | `FirmwareRevisionState` | DataState | | | | `NameState` | DataState | | | | `NewFirmwareAvailableState` | DataState | | | - | `OccupancyState` | DiscreteState | personInside, noPersonInside | | | `Private10State` | DataState | | | | `Private1State` | DataState | | | | `Private2State` | DataState | | | @@ -14932,30 +19787,24 @@ This page lists all known device types from the Overkiz API, grouped by protocol | `Private9State` | DataState | | | | `RemovableState` | DataState | | | | `SignalQualityState` | ContinuousState | | | + | `SmokeEventState` | DiscreteState | false, true | | + | `SmokeState` | DiscreteState | detected, notDetected | | | `StatusState` | DiscreteState | available, unavailable | | -??? note "OnOff/DynamicOutlet (ACTUATOR) — 16 commands, 29 states" +??? note "Switch/DynamicSwitch (ACTUATOR) — 8 commands, 27 states" - **Type IDs:** `261` | **Servers:** `rexel`, `somfy_europe` | **Controllable:** `ogp:Outlet` | **Profiles:** `StatefulSwitchablePlug`, `ElectricPowerMeter`, `StatefulSwitchable`, `Switchable`, `StatefulDimmable`, `Dimmable`, `Cyclic` + **Type IDs:** `297` | **Servers:** `rexel` | **Controllable:** `ogp:Switch` | **Profiles:** `SwitchEvent`, `Switch` **Commands** | Command | Parameters | Notes | |---------|-----------|-------| - | `cycle` | | Do a cycle of supported motion kinematics or modes | | `executeManufacturerProcedure` | STRING; OBJECT (optional) | execute manufacturer procedure command. p1: the procedure name p2: the params associated Example: p1 = "dead_man_up" p2 = {"duration": 42} | - | `goToAlias` | STRING | Send alias command linked with the ID. | | `identify` | | Ask the device to identify itself by doing a slight movement or blink or beep | - | `off` | | Turn off the device | - | `on` | | Turn on the device | | `readManufacturerData` | ARRAY | Read manufacturer data values from given names. Example: ["setting1","setting2"]. | - | `saveAlias` | STRING | Allow to send an order for the product to save the current state of the alias. | | `sendPrivate` | OBJECT | send a private command | - | `setIntensity` | INT [0..100] | Light intensity level (100%=maximum intensity, 0%=off) | | `setName` | STRING | Change the device internal name. Name length may be subject to restrictions depending on the device and underlying protocol. | | `setNodeDefinition` | STRING; STRING (optional); STRING (optional) | Fill the node definition (some transitions can be forbidden) p1: type (mandatory) p2: subType (mandatory if definition is set) p3: definition | - | `setOnOff` | STRING: off, on | Turn the device on or off | - | `toggle` | | Toggle on/off status | | `update` | | Update the gateway software. The update may have to be downloaded first, which can take a while. | | `writeManufacturerData` | OBJECT | Write manufacturer data values. Example: { "setting1": true, "setting2": 42, "setting3": "overkiz", "setting4": "Dk8PDr1WD0sfAAAAAAAAAAAAAAAAAAAA", "setting5": [ "valueA", "valueB", "valueC" ], "setting6": { "value": 15, "definition": 158 } } | @@ -14963,21 +19812,20 @@ This page lists all known device types from the Overkiz API, grouped by protocol | State | Type | Range / Values | Notes | |-------|------|----------------|-------| + | `ActionState` | DataState | | | | `ActivePartitionState` | DataState | | | | `AvailabilityState` | DiscreteState | available, unavailable | | + | `AvailableActionsState` | DataState | | | | `BatteryDiscreteLevelState` | DiscreteState | good, medium, low, critical | | | `BatteryLevelState` | ContinuousState | | | - | `ElectricPowerConsumptionState` | ContinuousState | | | + | `ButtonActionsEventState` | DataState | | | | `ErrorEventState` | DiscreteState | accessLimitation, internal, obstacleProtection, transportBusy, deviceNoAnswer, cancelled, deprecated, interrupted, thermalProtection, maintenanceRequired, alreadyUpToDate, notSupported, hardwareError, accessDenied, updateError, resourceAlreadyExist | | | `ErrorState` | DataState | | | | `ErrorsState` | DataState | | | | `FirmwareHashState` | DataState | | | | `FirmwareRevisionState` | DataState | | | - | `IntensityState` | ContinuousState | | | - | `LightIntensityState` | ContinuousState | [0..100] | | | `NameState` | DataState | | | | `NewFirmwareAvailableState` | DataState | | | - | `OnOffState` | DiscreteState | on, off | | | `Private10State` | DataState | | | | `Private1State` | DataState | | | | `Private2State` | DataState | | | @@ -14988,44 +19836,24 @@ This page lists all known device types from the Overkiz API, grouped by protocol | `Private7State` | DataState | | | | `Private8State` | DataState | | | | `Private9State` | DataState | | | - | `ReachedAliasesState` | DataState | | | | `RemovableState` | DataState | | | | `SignalQualityState` | ContinuousState | | | | `StatusState` | DiscreteState | available, unavailable | | -??? note "Oven/DynamicOven (ACTUATOR) — 27 commands, 69 states" +??? note "Switch/DynamicSwitch (ACTUATOR) — 8 commands, 26 states" - **Type IDs:** `284` | **Servers:** `rexel`, `somfy_europe` | **Controllable:** `ogp:Oven` | **Profiles:** `StatefulStartStopOven`, `StatefulStartStop`, `StartStop`, `StatefulThermostatWithSensor`, `StatefulLockWithOpeningStatus`, `StatefulThermostat`, `Thermostat`, `StatefulSwitchable`, `Switchable`, `StatefulLock`, `LockStatus`, `Lock`, `StatefulDimmable`, `Dimmable` + **Type IDs:** `297` | **Servers:** `somfy_europe` | **Controllable:** `ogp:Switch` | **Profiles:** `SwitchEvent`, `Switch` **Commands** | Command | Parameters | Notes | |---------|-----------|-------| - | `activateOption` | STRING | Activate an option | - | `deactivateOption` | STRING | Deactivate an option | | `executeManufacturerProcedure` | STRING; OBJECT (optional) | execute manufacturer procedure command. p1: the procedure name p2: the params associated Example: p1 = "dead_man_up" p2 = {"duration": 42} | | `identify` | | Ask the device to identify itself by doing a slight movement or blink or beep | - | `lock` | | Lock the device | - | `off` | | Turn off the device | - | `on` | | Turn on the device | - | `pause` | | Pause current action | | `readManufacturerData` | ARRAY | Read manufacturer data values from given names. Example: ["setting1","setting2"]. | - | `resume` | | Resume paused action. | | `sendPrivate` | OBJECT | send a private command | - | `setIntensity` | INT [0..100] | Light intensity level (100%=maximum intensity, 0%=off) | - | `setMode` | STRING | Set the active mode. | | `setName` | STRING | Change the device internal name. Name length may be subject to restrictions depending on the device and underlying protocol. | - | `setOnOff` | STRING: off, on | Turn the device on or off | - | `setRecipe` | STRING | Select/Activate a given recipe. | - | `setTargetHumidity` | INT [0..100] | Set the target humidity. | - | `setTargetPower` | INT | Set the target power. | - | `setTargetTemperature` | FLOAT | Set the new air temperature to reach | - | `setTargetTime` | INT | Set a target action duration. | - | `setTargetWeight` | INT | Indicate a target element weight. | - | `setTimezone` | STRING | Set the device timezone, according to TZ database names. | - | `start` | | Start the default actuator behavior (movement, sound or timer) | - | `stop` | | Stop the current actuator behavior (movement, sound or timer) | - | `unlock` | | Unlock the device | + | `setNodeDefinition` | STRING; STRING (optional); STRING (optional) | Fill the node definition (some transitions can be forbidden) p1: type (mandatory) p2: subType (mandatory if definition is set) p3: definition | | `update` | | Update the gateway software. The update may have to be downloaded first, which can take a while. | | `writeManufacturerData` | OBJECT | Write manufacturer data values. Example: { "setting1": true, "setting2": 42, "setting3": "overkiz", "setting4": "Dk8PDr1WD0sfAAAAAAAAAAAAAAAAAAAA", "setting5": [ "valueA", "valueB", "valueC" ], "setting6": { "value": 15, "definition": 158 } } | @@ -15033,33 +19861,19 @@ This page lists all known device types from the Overkiz API, grouped by protocol | State | Type | Range / Values | Notes | |-------|------|----------------|-------| - | `ActivatedOptionsState` | DataState | | | + | `ActionEventState` | DataState | | | + | `ActionState` | DataState | | | | `ActivePartitionState` | DataState | | | | `AvailabilityState` | DiscreteState | available, unavailable | | - | `AvailableModesState` | DataState | | | - | `AvailableOptionsState` | DataState | | | - | `AvailableRecipesState` | DataState | | | - | `AvailableTargetTemperaturesState` | DataState | | | + | `AvailableActionsState` | DataState | | | | `BatteryDiscreteLevelState` | DiscreteState | good, medium, low, critical | | | `BatteryLevelState` | ContinuousState | | | - | `CurrentCycleStageState` | DataState | | | - | `CurrentSoilingState` | ContinuousState | | | - | `CycleStageSequenceState` | DataState | | | - | `ErrorEventState` | DiscreteState | accessLimitation, internal, obstacleProtection, transportBusy, deviceNoAnswer, cancelled, deprecated, interrupted, thermalProtection, maintenanceRequired, alreadyUpToDate, notSupported, hardwareError, accessDenied, updateError, resourceAlreadyExist | | | `ErrorState` | DataState | | | | `ErrorsState` | DataState | | | | `FirmwareHashState` | DataState | | | | `FirmwareRevisionState` | DataState | | | - | `IntensityState` | ContinuousState | | | - | `LightIntensityState` | ContinuousState | [0..100] | | - | `LockedUnlockedState` | DiscreteState | locked, unlocked | | - | `ModeState` | DataState | | | | `NameState` | DataState | | | | `NewFirmwareAvailableState` | DataState | | | - | `OnOffState` | DiscreteState | on, off | | - | `OpenClosedState` | DiscreteState | open, closed | | - | `OpenState` | DataState | | | - | `PausedState` | DataState | | | | `Private10State` | DataState | | | | `Private1State` | DataState | | | | `Private2State` | DataState | | | @@ -15070,63 +19884,23 @@ This page lists all known device types from the Overkiz API, grouped by protocol | `Private7State` | DataState | | | | `Private8State` | DataState | | | | `Private9State` | DataState | | | - | `RecipeState` | DataState | | | - | `RecommendedOptionsState` | DataState | | | - | `RecommendedTargetHumidityState` | ContinuousState | | | - | `RecommendedTargetPowerState` | ContinuousState | | | - | `RecommendedTargetTemperatureState` | ContinuousState | | | - | `RecommendedTargetTimeState` | ContinuousState | | | - | `RecommendedTargetWeightState` | ContinuousState | | | - | `RemainingTimeState` | ContinuousState | | | | `RemovableState` | DataState | | | - | `RunningTimerState` | DataState | | | | `SignalQualityState` | ContinuousState | | | - | `StartedStoppedState` | DiscreteState | started, stopped | | | `StatusState` | DiscreteState | available, unavailable | | - | `TargetHumidityCurrentLowerBoundState` | ContinuousState | | | - | `TargetHumidityCurrentUpperBoundState` | ContinuousState | | | - | `TargetHumidityState` | ContinuousState | | | - | `TargetPowerCurrentLowerBoundState` | ContinuousState | | | - | `TargetPowerCurrentUpperBoundState` | ContinuousState | | | - | `TargetPowerState` | ContinuousState | | | - | `TargetTemperatureCurrentLowerBoundState` | ContinuousState | | | - | `TargetTemperatureCurrentUpperBoundState` | ContinuousState | | | - | `TargetTemperatureReachedState` | DataState | | | - | `TargetTemperatureState` | ContinuousState | [12.0..30.0] | | - | `TargetTimeCurrentLowerBoundState` | ContinuousState | | | - | `TargetTimeCurrentUpperBoundState` | ContinuousState | | | - | `TargetTimeState` | ContinuousState | | | - | `TargetWeightCurrentLowerBoundState` | ContinuousState | | | - | `TargetWeightCurrentUpperBoundState` | ContinuousState | | | - | `TargetWeightState` | ContinuousState | | | - | `TemperatureState` | ContinuousState | [-100.0..100.0] | | - | `TimezoneState` | DataState | | | - | `UnavailableFeaturesState` | DataState | | | -??? note "Pergola/DynamicPergola (ACTUATOR) — 18 commands, 31 states" +??? note "TemperatureSensor/DynamicTemperatureSensor (SENSOR) — 7 commands, 25 states" - **Type IDs:** `287` | **Servers:** `rexel`, `somfy_europe` | **Controllable:** `ogp:Pergola` | **Profiles:** `StatefulOrientablePlusCloseablePergola`, `StatefulOrientablePlusCloseable`, `OrientablePlusCloseable`, `StatefulCloseable`, `Closeable`, `StatefulOpenClose`, `OpenClose` + **Type IDs:** `270` | **Servers:** `rexel` | **Controllable:** `ogp:TemperatureSensor` | **Profiles:** `Temperature` **Commands** | Command | Parameters | Notes | |---------|-----------|-------| - | `close` | | Fully close the device | | `executeManufacturerProcedure` | STRING; OBJECT (optional) | execute manufacturer procedure command. p1: the procedure name p2: the params associated Example: p1 = "dead_man_up" p2 = {"duration": 42} | - | `goToAlias` | STRING | Send alias command linked with the ID. | | `identify` | | Ask the device to identify itself by doing a slight movement or blink or beep | - | `open` | | Fully open the device | | `readManufacturerData` | ARRAY | Read manufacturer data values from given names. Example: ["setting1","setting2"]. | - | `right` | | Right the device (go to minimum tilt position - open) | - | `saveAlias` | STRING | Allow to send an order for the product to save the current state of the alias. | | `sendPrivate` | OBJECT | send a private command | - | `setClosure` | INT [0..100] | Closure level (100%=fully close, 0%=open) | | `setName` | STRING | Change the device internal name. Name length may be subject to restrictions depending on the device and underlying protocol. | - | `setNodeDefinition` | STRING; STRING (optional); STRING (optional) | Fill the node definition (some transitions can be forbidden) p1: type (mandatory) p2: subType (mandatory if definition is set) p3: definition | - | `setOrientation` | INT [0..100] | Set the relative orientation (0-100%) of the device slats | - | `setTilt` | INT [0..100] | set the device tilt percentage | - | `stop` | | Stop the current actuator behavior (movement, sound or timer) | - | `tilt` | | Go to maximum tilt position (closed) | | `update` | | Update the gateway software. The update may have to be downloaded first, which can take a while. | | `writeManufacturerData` | OBJECT | Write manufacturer data values. Example: { "setting1": true, "setting2": 42, "setting3": "overkiz", "setting4": "Dk8PDr1WD0sfAAAAAAAAAAAAAAAAAAAA", "setting5": [ "valueA", "valueB", "valueC" ], "setting6": { "value": 15, "definition": 158 } } | @@ -15138,7 +19912,6 @@ This page lists all known device types from the Overkiz API, grouped by protocol | `AvailabilityState` | DiscreteState | available, unavailable | | | `BatteryDiscreteLevelState` | DiscreteState | good, medium, low, critical | | | `BatteryLevelState` | ContinuousState | | | - | `ClosureState` | ContinuousState | [0..100] | | | `ErrorEventState` | DiscreteState | accessLimitation, internal, obstacleProtection, transportBusy, deviceNoAnswer, cancelled, deprecated, interrupted, thermalProtection, maintenanceRequired, alreadyUpToDate, notSupported, hardwareError, accessDenied, updateError, resourceAlreadyExist | | | `ErrorState` | DataState | | | | `ErrorsState` | DataState | | | @@ -15146,7 +19919,6 @@ This page lists all known device types from the Overkiz API, grouped by protocol | `FirmwareRevisionState` | DataState | | | | `NameState` | DataState | | | | `NewFirmwareAvailableState` | DataState | | | - | `OpenClosedState` | DiscreteState | open, closed | | | `Private10State` | DataState | | | | `Private1State` | DataState | | | | `Private2State` | DataState | | | @@ -15157,36 +19929,24 @@ This page lists all known device types from the Overkiz API, grouped by protocol | `Private7State` | DataState | | | | `Private8State` | DataState | | | | `Private9State` | DataState | | | - | `ReachedAliasesState` | DataState | | | | `RemovableState` | DataState | | | | `SignalQualityState` | ContinuousState | | | - | `SlateOrientationState` | ContinuousState | [0..100] | | | `StatusState` | DiscreteState | available, unavailable | | - | `TiltState` | ContinuousState | | | - | `TiltedState` | DiscreteState | true, false | | - | `UnavailableFeaturesState` | DataState | | | + | `TemperatureState` | ContinuousState | [-100.0..100.0] | | -??? note "ProtocolGateway/DynamicBridge (ACTUATOR) — 15 commands, 26 states" +??? note "TemperatureSensor/DynamicTemperatureSensor (SENSOR) — 7 commands, 24 states" - **Type IDs:** `1` | **Servers:** `rexel`, `somfy_europe` | **Controllable:** `ogp:Bridge` | **Profiles:** `Specific` + **Type IDs:** `270` | **Servers:** `somfy_europe` | **Controllable:** `ogp:TemperatureSensor` | **Profiles:** `Temperature` **Commands** | Command | Parameters | Notes | |---------|-----------|-------| - | `associateCandidate` | STRING | Pair given candidate | - | `discover` | | Start a new discovery procedure. | | `executeManufacturerProcedure` | STRING; OBJECT (optional) | execute manufacturer procedure command. p1: the procedure name p2: the params associated Example: p1 = "dead_man_up" p2 = {"duration": 42} | - | `getCandidates` | | Discover all candidates available for association. | | `identify` | | Ask the device to identify itself by doing a slight movement or blink or beep | - | `joinSetup` | | Join an existing setup | - | `pair` | STRING; STRING (optional); STRING (optional) | Execute the pairing procedure p1: type (mandatory) p2: subType (mandatory if definition is set) p3: definition | | `readManufacturerData` | ARRAY | Read manufacturer data values from given names. Example: ["setting1","setting2"]. | - | `reset` | | Bring back into initial condition. | | `sendPrivate` | OBJECT | send a private command | - | `setAuthentication` | OBJECT | Set authentication properties of a node | | `setName` | STRING | Change the device internal name. Name length may be subject to restrictions depending on the device and underlying protocol. | - | `shareSetup` | | Share the current setup with another controller | | `update` | | Update the gateway software. The update may have to be downloaded first, which can take a while. | | `writeManufacturerData` | OBJECT | Write manufacturer data values. Example: { "setting1": true, "setting2": 42, "setting3": "overkiz", "setting4": "Dk8PDr1WD0sfAAAAAAAAAAAAAAAAAAAA", "setting5": [ "valueA", "valueB", "valueC" ], "setting6": { "value": 15, "definition": 158 } } | @@ -15195,12 +19955,9 @@ This page lists all known device types from the Overkiz API, grouped by protocol | State | Type | Range / Values | Notes | |-------|------|----------------|-------| | `ActivePartitionState` | DataState | | | - | `AuthenticationExpiredState` | DataState | | | | `AvailabilityState` | DiscreteState | available, unavailable | | | `BatteryDiscreteLevelState` | DiscreteState | good, medium, low, critical | | | `BatteryLevelState` | ContinuousState | | | - | `CandidatesState` | DataState | | | - | `ErrorEventState` | DiscreteState | accessLimitation, internal, obstacleProtection, transportBusy, deviceNoAnswer, cancelled, deprecated, interrupted, thermalProtection, maintenanceRequired, alreadyUpToDate, notSupported, hardwareError, accessDenied, updateError, resourceAlreadyExist | | | `ErrorState` | DataState | | | | `ErrorsState` | DataState | | | | `FirmwareHashState` | DataState | | | @@ -15220,23 +19977,24 @@ This page lists all known device types from the Overkiz API, grouped by protocol | `RemovableState` | DataState | | | | `SignalQualityState` | ContinuousState | | | | `StatusState` | DiscreteState | available, unavailable | | + | `TemperatureState` | ContinuousState | [-100.0..100.0] | | -??? note "ProtocolGateway/DynamicGateway (ACTUATOR) — 10 commands, 35 states" +??? note "ThirdPartyGateway/DynamicThirdPartyGateway (ACTUATOR) — 10 commands, 26 states" - **Type IDs:** `2` | **Servers:** `rexel`, `somfy_europe` | **Controllable:** `ogp:Gateway` | **Profiles:** `Specific` + **Type IDs:** `283` | **Servers:** `rexel` | **Controllable:** `ogp:ThirdPartyGateway` | **Profiles:** `Specific` **Commands** | Command | Parameters | Notes | |---------|-----------|-------| + | `addGroupMember` | STRING | Add member to the group p1 : Id of the member to add to the group. | | `executeManufacturerProcedure` | STRING; OBJECT (optional) | execute manufacturer procedure command. p1: the procedure name p2: the params associated Example: p1 = "dead_man_up" p2 = {"duration": 42} | | `identify` | | Ask the device to identify itself by doing a slight movement or blink or beep | | `readManufacturerData` | ARRAY | Read manufacturer data values from given names. Example: ["setting1","setting2"]. | - | `reboot` | | Reboot the device | - | `reset` | | Bring back into initial condition. | + | `removeGroupMember` | STRING | Remove a member of the group. p1 : Id of the member to remove to the group. | | `sendPrivate` | OBJECT | send a private command | + | `setAuthentication` | OBJECT | Set authentication properties of a node | | `setName` | STRING | Change the device internal name. Name length may be subject to restrictions depending on the device and underlying protocol. | - | `setTimezone` | STRING | Set the device timezone, according to TZ database names. | | `update` | | Update the gateway software. The update may have to be downloaded first, which can take a while. | | `writeManufacturerData` | OBJECT | Write manufacturer data values. Example: { "setting1": true, "setting2": 42, "setting3": "overkiz", "setting4": "Dk8PDr1WD0sfAAAAAAAAAAAAAAAAAAAA", "setting5": [ "valueA", "valueB", "valueC" ], "setting6": { "value": 15, "definition": 158 } } | @@ -15245,7 +20003,7 @@ This page lists all known device types from the Overkiz API, grouped by protocol | State | Type | Range / Values | Notes | |-------|------|----------------|-------| | `ActivePartitionState` | DataState | | | - | `ApnState` | DataState | | | + | `AuthenticationExpiredState` | DataState | | | | `AvailabilityState` | DiscreteState | available, unavailable | | | `BatteryDiscreteLevelState` | DiscreteState | good, medium, low, critical | | | `BatteryLevelState` | ContinuousState | | | @@ -15254,15 +20012,8 @@ This page lists all known device types from the Overkiz API, grouped by protocol | `ErrorsState` | DataState | | | | `FirmwareHashState` | DataState | | | | `FirmwareRevisionState` | DataState | | | - | `IccidState` | DataState | | | - | `ImsiState` | DataState | | | - | `LocalAccessProofState` | DataState | | | - | `LocalIPv4AddressState` | DataState | | | - | `MobileOperatorState` | DataState | | | - | `NameState` | DataState | | | - | `NetworkGatewayState` | DataState | | | - | `NetworkMacState` | DataState | | | - | `NetworkMaskState` | DataState | | | + | `GroupMembersState` | DataState | | | + | `NameState` | DataState | | | | `NewFirmwareAvailableState` | DataState | | | | `Private10State` | DataState | | | | `Private1State` | DataState | | | @@ -15275,23 +20026,24 @@ This page lists all known device types from the Overkiz API, grouped by protocol | `Private8State` | DataState | | | | `Private9State` | DataState | | | | `RemovableState` | DataState | | | - | `SSIDState` | DataState | | | | `SignalQualityState` | ContinuousState | | | | `StatusState` | DiscreteState | available, unavailable | | - | `TimezoneState` | DataState | | | -??? note "RainSensor/DynamicRainSensor (SENSOR) — 7 commands, 25 states" +??? note "ThirdPartyGateway/DynamicThirdPartyGateway (ACTUATOR) — 10 commands, 25 states" - **Type IDs:** `275` | **Servers:** `rexel`, `somfy_europe` | **Controllable:** `ogp:RainSensor` | **Profiles:** `RainDetector` + **Type IDs:** `283` | **Servers:** `somfy_europe` | **Controllable:** `ogp:ThirdPartyGateway` | **Profiles:** `Specific` **Commands** | Command | Parameters | Notes | |---------|-----------|-------| + | `addGroupMember` | STRING | Add member to the group p1 : Id of the member to add to the group. | | `executeManufacturerProcedure` | STRING; OBJECT (optional) | execute manufacturer procedure command. p1: the procedure name p2: the params associated Example: p1 = "dead_man_up" p2 = {"duration": 42} | | `identify` | | Ask the device to identify itself by doing a slight movement or blink or beep | | `readManufacturerData` | ARRAY | Read manufacturer data values from given names. Example: ["setting1","setting2"]. | + | `removeGroupMember` | STRING | Remove a member of the group. p1 : Id of the member to remove to the group. | | `sendPrivate` | OBJECT | send a private command | + | `setAuthentication` | OBJECT | Set authentication properties of a node | | `setName` | STRING | Change the device internal name. Name length may be subject to restrictions depending on the device and underlying protocol. | | `update` | | Update the gateway software. The update may have to be downloaded first, which can take a while. | | `writeManufacturerData` | OBJECT | Write manufacturer data values. Example: { "setting1": true, "setting2": 42, "setting3": "overkiz", "setting4": "Dk8PDr1WD0sfAAAAAAAAAAAAAAAAAAAA", "setting5": [ "valueA", "valueB", "valueC" ], "setting6": { "value": 15, "definition": 158 } } | @@ -15301,14 +20053,15 @@ This page lists all known device types from the Overkiz API, grouped by protocol | State | Type | Range / Values | Notes | |-------|------|----------------|-------| | `ActivePartitionState` | DataState | | | + | `AuthenticationExpiredState` | DataState | | | | `AvailabilityState` | DiscreteState | available, unavailable | | | `BatteryDiscreteLevelState` | DiscreteState | good, medium, low, critical | | | `BatteryLevelState` | ContinuousState | | | - | `ErrorEventState` | DiscreteState | accessLimitation, internal, obstacleProtection, transportBusy, deviceNoAnswer, cancelled, deprecated, interrupted, thermalProtection, maintenanceRequired, alreadyUpToDate, notSupported, hardwareError, accessDenied, updateError, resourceAlreadyExist | | | `ErrorState` | DataState | | | | `ErrorsState` | DataState | | | | `FirmwareHashState` | DataState | | | | `FirmwareRevisionState` | DataState | | | + | `GroupMembersState` | DataState | | | | `NameState` | DataState | | | | `NewFirmwareAvailableState` | DataState | | | | `Private10State` | DataState | | | @@ -15321,26 +20074,36 @@ This page lists all known device types from the Overkiz API, grouped by protocol | `Private7State` | DataState | | | | `Private8State` | DataState | | | | `Private9State` | DataState | | | - | `RainState` | DiscreteState | detected, notDetected | | | `RemovableState` | DataState | | | | `SignalQualityState` | ContinuousState | | | | `StatusState` | DiscreteState | available, unavailable | | -??? note "Scene/DynamicScene (ACTUATOR) — 9 commands, 25 states" +??? note "VenetianBlind/DynamicVenetianBlind (ACTUATOR) — 20 commands, 31 states" - **Type IDs:** `294` | **Servers:** `rexel`, `somfy_europe` | **Controllable:** `ogp:Scene` | **Profiles:** `Specific` + **Type IDs:** `264` | **Servers:** `rexel` | **Controllable:** `ogp:VenetianBlind` | **Profiles:** `StatefulOrientableShutter`, `StatefulOrientablePlusCloseable`, `OrientablePlusCloseable`, `StatefulOpenClose`, `OpenClose`, `StatefulCloseable`, `Closeable` **Commands** | Command | Parameters | Notes | |---------|-----------|-------| + | `close` | | Fully close the device | | `executeManufacturerProcedure` | STRING; OBJECT (optional) | execute manufacturer procedure command. p1: the procedure name p2: the params associated Example: p1 = "dead_man_up" p2 = {"duration": 42} | | `goToAlias` | STRING | Send alias command linked with the ID. | | `identify` | | Ask the device to identify itself by doing a slight movement or blink or beep | + | `open` | | Fully open the device | | `readManufacturerData` | ARRAY | Read manufacturer data values from given names. Example: ["setting1","setting2"]. | + | `right` | | Right the device (go to minimum tilt position - open) | | `saveAlias` | STRING | Allow to send an order for the product to save the current state of the alias. | | `sendPrivate` | OBJECT | send a private command | + | `setClosure` | INT [0..100] | Closure level (100%=fully close, 0%=open) | | `setName` | STRING | Change the device internal name. Name length may be subject to restrictions depending on the device and underlying protocol. | + | `setNodeDefinition` | STRING; STRING (optional); STRING (optional) | Fill the node definition (some transitions can be forbidden) p1: type (mandatory) p2: subType (mandatory if definition is set) p3: definition | + | `setOrientation` | INT [0..100] | Set the relative orientation (0-100%) of the device slats | + | `setTilt` | INT [0..100] | set the device tilt percentage | + | `stop` | | Stop the current actuator behavior (movement, sound or timer) | + | `tilt` | | Go to maximum tilt position (closed) | + | `tiltDown` | | Lower the slats to a horizontal position step by step (which will let in more light) | + | `tiltUp` | | Straighten the slats to a vertical position step by step (which will let in less light) | | `update` | | Update the gateway software. The update may have to be downloaded first, which can take a while. | | `writeManufacturerData` | OBJECT | Write manufacturer data values. Example: { "setting1": true, "setting2": 42, "setting3": "overkiz", "setting4": "Dk8PDr1WD0sfAAAAAAAAAAAAAAAAAAAA", "setting5": [ "valueA", "valueB", "valueC" ], "setting6": { "value": 15, "definition": 158 } } | @@ -15352,6 +20115,7 @@ This page lists all known device types from the Overkiz API, grouped by protocol | `AvailabilityState` | DiscreteState | available, unavailable | | | `BatteryDiscreteLevelState` | DiscreteState | good, medium, low, critical | | | `BatteryLevelState` | ContinuousState | | | + | `ClosureState` | ContinuousState | [0..100] | | | `ErrorEventState` | DiscreteState | accessLimitation, internal, obstacleProtection, transportBusy, deviceNoAnswer, cancelled, deprecated, interrupted, thermalProtection, maintenanceRequired, alreadyUpToDate, notSupported, hardwareError, accessDenied, updateError, resourceAlreadyExist | | | `ErrorState` | DataState | | | | `ErrorsState` | DataState | | | @@ -15359,6 +20123,7 @@ This page lists all known device types from the Overkiz API, grouped by protocol | `FirmwareRevisionState` | DataState | | | | `NameState` | DataState | | | | `NewFirmwareAvailableState` | DataState | | | + | `OpenClosedState` | DiscreteState | open, closed | | | `Private10State` | DataState | | | | `Private1State` | DataState | | | | `Private2State` | DataState | | | @@ -15372,21 +20137,38 @@ This page lists all known device types from the Overkiz API, grouped by protocol | `ReachedAliasesState` | DataState | | | | `RemovableState` | DataState | | | | `SignalQualityState` | ContinuousState | | | + | `SlateOrientationState` | ContinuousState | [0..100] | | | `StatusState` | DiscreteState | available, unavailable | | + | `TiltState` | ContinuousState | | | + | `TiltedState` | DiscreteState | true, false | | + | `UnavailableFeaturesState` | DataState | | | -??? note "SceneLauncherController/DynamicSceneLauncherController (REMOTE_CONTROLLER) — 7 commands, 25 states" +??? note "VenetianBlind/DynamicVenetianBlind (ACTUATOR) — 20 commands, 30 states" - **Type IDs:** `292` | **Servers:** `rexel` | **Controllable:** `ogp:SceneLauncherController` | **Profiles:** `ScenarioTrigger` + **Type IDs:** `264` | **Servers:** `somfy_europe` | **Controllable:** `ogp:VenetianBlind` | **Profiles:** `StatefulOrientableShutter`, `StatefulOrientablePlusCloseable`, `OrientablePlusCloseable`, `StatefulOpenClose`, `OpenClose`, `StatefulCloseable`, `Closeable` **Commands** | Command | Parameters | Notes | |---------|-----------|-------| + | `close` | | Fully close the device | | `executeManufacturerProcedure` | STRING; OBJECT (optional) | execute manufacturer procedure command. p1: the procedure name p2: the params associated Example: p1 = "dead_man_up" p2 = {"duration": 42} | + | `goToAlias` | STRING | Send alias command linked with the ID. | | `identify` | | Ask the device to identify itself by doing a slight movement or blink or beep | + | `open` | | Fully open the device | | `readManufacturerData` | ARRAY | Read manufacturer data values from given names. Example: ["setting1","setting2"]. | + | `right` | | Right the device (go to minimum tilt position - open) | + | `saveAlias` | STRING | Allow to send an order for the product to save the current state of the alias. | | `sendPrivate` | OBJECT | send a private command | + | `setClosure` | INT [0..100] | Closure level (100%=fully close, 0%=open) | | `setName` | STRING | Change the device internal name. Name length may be subject to restrictions depending on the device and underlying protocol. | + | `setNodeDefinition` | STRING; STRING (optional); STRING (optional) | Fill the node definition (some transitions can be forbidden) p1: type (mandatory) p2: subType (mandatory if definition is set) p3: definition | + | `setOrientation` | INT [0..100] | Set the relative orientation (0-100%) of the device slats | + | `setTilt` | INT [0..100] | set the device tilt percentage | + | `stop` | | Stop the current actuator behavior (movement, sound or timer) | + | `tilt` | | Go to maximum tilt position (closed) | + | `tiltDown` | | Lower the slats to a horizontal position step by step (which will let in more light) | + | `tiltUp` | | Straighten the slats to a vertical position step by step (which will let in less light) | | `update` | | Update the gateway software. The update may have to be downloaded first, which can take a while. | | `writeManufacturerData` | OBJECT | Write manufacturer data values. Example: { "setting1": true, "setting2": 42, "setting3": "overkiz", "setting4": "Dk8PDr1WD0sfAAAAAAAAAAAAAAAAAAAA", "setting5": [ "valueA", "valueB", "valueC" ], "setting6": { "value": 15, "definition": 158 } } | @@ -15398,14 +20180,14 @@ This page lists all known device types from the Overkiz API, grouped by protocol | `AvailabilityState` | DiscreteState | available, unavailable | | | `BatteryDiscreteLevelState` | DiscreteState | good, medium, low, critical | | | `BatteryLevelState` | ContinuousState | | | - | `ErrorEventState` | DiscreteState | accessLimitation, internal, obstacleProtection, transportBusy, deviceNoAnswer, cancelled, deprecated, interrupted, thermalProtection, maintenanceRequired, alreadyUpToDate, notSupported, hardwareError, accessDenied, updateError, resourceAlreadyExist | | + | `ClosureState` | ContinuousState | [0..100] | | | `ErrorState` | DataState | | | | `ErrorsState` | DataState | | | | `FirmwareHashState` | DataState | | | | `FirmwareRevisionState` | DataState | | | - | `LaunchStatusState` | DiscreteState | launched, standby | | | `NameState` | DataState | | | | `NewFirmwareAvailableState` | DataState | | | + | `OpenClosedState` | DiscreteState | open, closed | | | `Private10State` | DataState | | | | `Private1State` | DataState | | | | `Private2State` | DataState | | | @@ -15416,23 +20198,38 @@ This page lists all known device types from the Overkiz API, grouped by protocol | `Private7State` | DataState | | | | `Private8State` | DataState | | | | `Private9State` | DataState | | | + | `ReachedAliasesState` | DataState | | | | `RemovableState` | DataState | | | | `SignalQualityState` | ContinuousState | | | + | `SlateOrientationState` | ContinuousState | [0..100] | | | `StatusState` | DiscreteState | available, unavailable | | + | `TiltState` | ContinuousState | | | + | `TiltedState` | DiscreteState | true, false | | + | `UnavailableFeaturesState` | DataState | | | -??? note "SceneLauncherController/DynamicSceneLauncherController (REMOTE_CONTROLLER) — 7 commands, 28 states" +??? note "VentilationSystem/DynamicVentilation (ACTUATOR) — 17 commands, 32 states" - **Type IDs:** `292` | **Servers:** `somfy_europe` | **Controllable:** `ogp:SceneLauncherController` | **Profiles:** `Switch`, `SwitchEvent`, `ScenarioTrigger` + **Type IDs:** `260` | **Servers:** `rexel` | **Controllable:** `ogp:Ventilation` | **Profiles:** `StatefulSwitchableVentilation`, `Temperature`, `StatefulSwitchable`, `Switchable`, `StatefulAirFan`, `AirFan` **Commands** | Command | Parameters | Notes | |---------|-----------|-------| | `executeManufacturerProcedure` | STRING; OBJECT (optional) | execute manufacturer procedure command. p1: the procedure name p2: the params associated Example: p1 = "dead_man_up" p2 = {"duration": 42} | + | `goToAlias` | STRING | Send alias command linked with the ID. | | `identify` | | Ask the device to identify itself by doing a slight movement or blink or beep | + | `off` | | Turn off the device | + | `on` | | Turn on the device | | `readManufacturerData` | ARRAY | Read manufacturer data values from given names. Example: ["setting1","setting2"]. | + | `saveAlias` | STRING | Allow to send an order for the product to save the current state of the alias. | | `sendPrivate` | OBJECT | send a private command | + | `setFanSpeed` | STRING: low, medium, high, auto, 1 | Set the fan speed (%) | + | `setFanSpeedLevel` | INT [0..100] | Set the device fan speed level (%) | + | `setMode` | STRING | Set the active mode. | | `setName` | STRING | Change the device internal name. Name length may be subject to restrictions depending on the device and underlying protocol. | + | `setNodeDefinition` | STRING; STRING (optional); STRING (optional) | Fill the node definition (some transitions can be forbidden) p1: type (mandatory) p2: subType (mandatory if definition is set) p3: definition | + | `setOnOff` | STRING: off, on | Turn the device on or off | + | `toggle` | | Toggle on/off status | | `update` | | Update the gateway software. The update may have to be downloaded first, which can take a while. | | `writeManufacturerData` | OBJECT | Write manufacturer data values. Example: { "setting1": true, "setting2": 42, "setting3": "overkiz", "setting4": "Dk8PDr1WD0sfAAAAAAAAAAAAAAAAAAAA", "setting5": [ "valueA", "valueB", "valueC" ], "setting6": { "value": 15, "definition": 158 } } | @@ -15440,21 +20237,22 @@ This page lists all known device types from the Overkiz API, grouped by protocol | State | Type | Range / Values | Notes | |-------|------|----------------|-------| - | `ActionState` | DataState | | | | `ActivePartitionState` | DataState | | | | `AvailabilityState` | DiscreteState | available, unavailable | | - | `AvailableActionsState` | DataState | | | + | `AvailableModesState` | DataState | | | | `BatteryDiscreteLevelState` | DiscreteState | good, medium, low, critical | | | `BatteryLevelState` | ContinuousState | | | - | `ButtonActionsEventState` | DataState | | | | `ErrorEventState` | DiscreteState | accessLimitation, internal, obstacleProtection, transportBusy, deviceNoAnswer, cancelled, deprecated, interrupted, thermalProtection, maintenanceRequired, alreadyUpToDate, notSupported, hardwareError, accessDenied, updateError, resourceAlreadyExist | | | `ErrorState` | DataState | | | | `ErrorsState` | DataState | | | + | `FanSpeedLevelState` | ContinuousState | [0..100] | | + | `FanSpeedState` | DiscreteState | low, medium, high, 1, 2, 3, 4, 5, 6, 7, 8, 9 | | | `FirmwareHashState` | DataState | | | | `FirmwareRevisionState` | DataState | | | - | `LaunchStatusState` | DiscreteState | launched, standby | | + | `ModeState` | DataState | | | | `NameState` | DataState | | | | `NewFirmwareAvailableState` | DataState | | | + | `OnOffState` | DiscreteState | on, off | | | `Private10State` | DataState | | | | `Private1State` | DataState | | | | `Private2State` | DataState | | | @@ -15465,13 +20263,16 @@ This page lists all known device types from the Overkiz API, grouped by protocol | `Private7State` | DataState | | | | `Private8State` | DataState | | | | `Private9State` | DataState | | | + | `ReachedAliasesState` | DataState | | | | `RemovableState` | DataState | | | | `SignalQualityState` | ContinuousState | | | | `StatusState` | DiscreteState | available, unavailable | | + | `TemperatureState` | ContinuousState | [-100.0..100.0] | | + | `UnavailableFeaturesState` | DataState | | | -??? note "Screen/DynamicScreen (ACTUATOR) — 14 commands, 28 states" +??? note "VentilationSystem/DynamicAirVent (ACTUATOR) — 18 commands, 33 states" - **Type IDs:** `263` | **Servers:** `rexel`, `somfy_europe` | **Controllable:** `ogp:Blind` | **Profiles:** `StatefulCloseableBlind`, `StatefulCloseable`, `Closeable`, `StatefulOpenClose`, `OpenClose` + **Type IDs:** `268` | **Servers:** `rexel` | **Controllable:** `ogp:AirVent` | **Profiles:** `StatefulCloseableAirVent`, `StatefulOrientableSlats`, `OrientableSlats`, `StatefulBasicCloseable`, `BasicCloseable`, `StatefulBasicOpenClose`, `BasicOpenClose` **Commands** @@ -15483,12 +20284,16 @@ This page lists all known device types from the Overkiz API, grouped by protocol | `identify` | | Ask the device to identify itself by doing a slight movement or blink or beep | | `open` | | Fully open the device | | `readManufacturerData` | ARRAY | Read manufacturer data values from given names. Example: ["setting1","setting2"]. | + | `right` | | Right the device (go to minimum tilt position - open) | | `saveAlias` | STRING | Allow to send an order for the product to save the current state of the alias. | | `sendPrivate` | OBJECT | send a private command | | `setClosure` | INT [0..100] | Closure level (100%=fully close, 0%=open) | + | `setMode` | STRING | Set the active mode. | | `setName` | STRING | Change the device internal name. Name length may be subject to restrictions depending on the device and underlying protocol. | | `setNodeDefinition` | STRING; STRING (optional); STRING (optional) | Fill the node definition (some transitions can be forbidden) p1: type (mandatory) p2: subType (mandatory if definition is set) p3: definition | - | `stop` | | Stop the current actuator behavior (movement, sound or timer) | + | `setOrientation` | INT [0..100] | Set the relative orientation (0-100%) of the device slats | + | `setTilt` | INT [0..100] | set the device tilt percentage | + | `tilt` | | Go to maximum tilt position (closed) | | `update` | | Update the gateway software. The update may have to be downloaded first, which can take a while. | | `writeManufacturerData` | OBJECT | Write manufacturer data values. Example: { "setting1": true, "setting2": 42, "setting3": "overkiz", "setting4": "Dk8PDr1WD0sfAAAAAAAAAAAAAAAAAAAA", "setting5": [ "valueA", "valueB", "valueC" ], "setting6": { "value": 15, "definition": 158 } } | @@ -15498,6 +20303,7 @@ This page lists all known device types from the Overkiz API, grouped by protocol |-------|------|----------------|-------| | `ActivePartitionState` | DataState | | | | `AvailabilityState` | DiscreteState | available, unavailable | | + | `AvailableModesState` | DataState | | | | `BatteryDiscreteLevelState` | DiscreteState | good, medium, low, critical | | | `BatteryLevelState` | ContinuousState | | | | `ClosureState` | ContinuousState | [0..100] | | @@ -15506,6 +20312,7 @@ This page lists all known device types from the Overkiz API, grouped by protocol | `ErrorsState` | DataState | | | | `FirmwareHashState` | DataState | | | | `FirmwareRevisionState` | DataState | | | + | `ModeState` | DataState | | | | `NameState` | DataState | | | | `NewFirmwareAvailableState` | DataState | | | | `OpenClosedState` | DiscreteState | open, closed | | @@ -15522,32 +20329,35 @@ This page lists all known device types from the Overkiz API, grouped by protocol | `ReachedAliasesState` | DataState | | | | `RemovableState` | DataState | | | | `SignalQualityState` | ContinuousState | | | + | `SlateOrientationState` | ContinuousState | [0..100] | | | `StatusState` | DiscreteState | available, unavailable | | + | `TiltState` | ContinuousState | | | + | `TiltedState` | DiscreteState | true, false | | | `UnavailableFeaturesState` | DataState | | | -??? note "Shutter/DynamicShutter (ACTUATOR) — 17 commands, 35 states" +??? note "VentilationSystem/DynamicVentilation (ACTUATOR) — 17 commands, 31 states" - **Type IDs:** `262` | **Servers:** `rexel`, `somfy_europe` | **Controllable:** `ogp:Shutter` | **Profiles:** `StatefulCloseableShutter`, `StatefulCloseable`, `Closeable`, `StatefulOpenClose`, `OpenClose`, `Cyclic` + **Type IDs:** `260` | **Servers:** `somfy_europe` | **Controllable:** `ogp:Ventilation` | **Profiles:** `StatefulSwitchableVentilation`, `Temperature`, `StatefulSwitchable`, `Switchable`, `StatefulAirFan`, `AirFan` **Commands** | Command | Parameters | Notes | |---------|-----------|-------| - | `activateOption` | STRING | Activate an option | - | `close` | | Fully close the device | - | `cycle` | | Do a cycle of supported motion kinematics or modes | - | `deactivateOption` | STRING | Deactivate an option | | `executeManufacturerProcedure` | STRING; OBJECT (optional) | execute manufacturer procedure command. p1: the procedure name p2: the params associated Example: p1 = "dead_man_up" p2 = {"duration": 42} | | `goToAlias` | STRING | Send alias command linked with the ID. | | `identify` | | Ask the device to identify itself by doing a slight movement or blink or beep | - | `open` | | Fully open the device | + | `off` | | Turn off the device | + | `on` | | Turn on the device | | `readManufacturerData` | ARRAY | Read manufacturer data values from given names. Example: ["setting1","setting2"]. | | `saveAlias` | STRING | Allow to send an order for the product to save the current state of the alias. | | `sendPrivate` | OBJECT | send a private command | - | `setClosure` | INT [0..100] | Closure level (100%=fully close, 0%=open) | + | `setFanSpeed` | STRING: low, medium, high, auto, 1 | Set the fan speed (%) | + | `setFanSpeedLevel` | INT [0..100] | Set the device fan speed level (%) | + | `setMode` | STRING | Set the active mode. | | `setName` | STRING | Change the device internal name. Name length may be subject to restrictions depending on the device and underlying protocol. | | `setNodeDefinition` | STRING; STRING (optional); STRING (optional) | Fill the node definition (some transitions can be forbidden) p1: type (mandatory) p2: subType (mandatory if definition is set) p3: definition | - | `stop` | | Stop the current actuator behavior (movement, sound or timer) | + | `setOnOff` | STRING: off, on | Turn the device on or off | + | `toggle` | | Toggle on/off status | | `update` | | Update the gateway software. The update may have to be downloaded first, which can take a while. | | `writeManufacturerData` | OBJECT | Write manufacturer data values. Example: { "setting1": true, "setting2": 42, "setting3": "overkiz", "setting4": "Dk8PDr1WD0sfAAAAAAAAAAAAAAAAAAAA", "setting5": [ "valueA", "valueB", "valueC" ], "setting6": { "value": 15, "definition": 158 } } | @@ -15555,25 +20365,21 @@ This page lists all known device types from the Overkiz API, grouped by protocol | State | Type | Range / Values | Notes | |-------|------|----------------|-------| - | `AccessLimitationState` | DataState | | | - | `ActivatedOptionsState` | DataState | | | | `ActivePartitionState` | DataState | | | | `AvailabilityState` | DiscreteState | available, unavailable | | - | `AvailableOptionsState` | DataState | | | + | `AvailableModesState` | DataState | | | | `BatteryDiscreteLevelState` | DiscreteState | good, medium, low, critical | | | `BatteryLevelState` | ContinuousState | | | - | `ClosureState` | ContinuousState | [0..100] | | - | `ErrorEventState` | DiscreteState | accessLimitation, internal, obstacleProtection, transportBusy, deviceNoAnswer, cancelled, deprecated, interrupted, thermalProtection, maintenanceRequired, alreadyUpToDate, notSupported, hardwareError, accessDenied, updateError, resourceAlreadyExist | | | `ErrorState` | DataState | | | | `ErrorsState` | DataState | | | + | `FanSpeedLevelState` | ContinuousState | [0..100] | | + | `FanSpeedState` | DiscreteState | low, medium, high, 1, 2, 3, 4, 5, 6, 7, 8, 9 | | | `FirmwareHashState` | DataState | | | | `FirmwareRevisionState` | DataState | | | - | `LimitationSourcesState` | DataState | | | - | `LimitationTimeState` | DataState | | | + | `ModeState` | DataState | | | | `NameState` | DataState | | | | `NewFirmwareAvailableState` | DataState | | | - | `OpenClosedState` | DiscreteState | open, closed | | - | `PermissiveLimitationState` | DataState | | | + | `OnOffState` | DiscreteState | on, off | | | `Private10State` | DataState | | | | `Private1State` | DataState | | | | `Private2State` | DataState | | | @@ -15585,25 +20391,36 @@ This page lists all known device types from the Overkiz API, grouped by protocol | `Private8State` | DataState | | | | `Private9State` | DataState | | | | `ReachedAliasesState` | DataState | | | - | `RecommendedOptionsState` | DataState | | | | `RemovableState` | DataState | | | | `SignalQualityState` | ContinuousState | | | | `StatusState` | DiscreteState | available, unavailable | | + | `TemperatureState` | ContinuousState | [-100.0..100.0] | | | `UnavailableFeaturesState` | DataState | | | -??? note "SmokeSensor/DynamicSmokeSensor (SENSOR) — 7 commands, 26 states" +??? note "VentilationSystem/DynamicAirVent (ACTUATOR) — 18 commands, 32 states" - **Type IDs:** `307` | **Servers:** `somfy_europe` | **Controllable:** `ogp:SmokeSensor` | **Profiles:** `SmokeDetector` + **Type IDs:** `268` | **Servers:** `somfy_europe` | **Controllable:** `ogp:AirVent` | **Profiles:** `StatefulCloseableAirVent`, `StatefulOrientableSlats`, `OrientableSlats`, `StatefulBasicCloseable`, `BasicCloseable`, `StatefulBasicOpenClose`, `BasicOpenClose` **Commands** | Command | Parameters | Notes | |---------|-----------|-------| + | `close` | | Fully close the device | | `executeManufacturerProcedure` | STRING; OBJECT (optional) | execute manufacturer procedure command. p1: the procedure name p2: the params associated Example: p1 = "dead_man_up" p2 = {"duration": 42} | + | `goToAlias` | STRING | Send alias command linked with the ID. | | `identify` | | Ask the device to identify itself by doing a slight movement or blink or beep | + | `open` | | Fully open the device | | `readManufacturerData` | ARRAY | Read manufacturer data values from given names. Example: ["setting1","setting2"]. | + | `right` | | Right the device (go to minimum tilt position - open) | + | `saveAlias` | STRING | Allow to send an order for the product to save the current state of the alias. | | `sendPrivate` | OBJECT | send a private command | + | `setClosure` | INT [0..100] | Closure level (100%=fully close, 0%=open) | + | `setMode` | STRING | Set the active mode. | | `setName` | STRING | Change the device internal name. Name length may be subject to restrictions depending on the device and underlying protocol. | + | `setNodeDefinition` | STRING; STRING (optional); STRING (optional) | Fill the node definition (some transitions can be forbidden) p1: type (mandatory) p2: subType (mandatory if definition is set) p3: definition | + | `setOrientation` | INT [0..100] | Set the relative orientation (0-100%) of the device slats | + | `setTilt` | INT [0..100] | set the device tilt percentage | + | `tilt` | | Go to maximum tilt position (closed) | | `update` | | Update the gateway software. The update may have to be downloaded first, which can take a while. | | `writeManufacturerData` | OBJECT | Write manufacturer data values. Example: { "setting1": true, "setting2": 42, "setting3": "overkiz", "setting4": "Dk8PDr1WD0sfAAAAAAAAAAAAAAAAAAAA", "setting5": [ "valueA", "valueB", "valueC" ], "setting6": { "value": 15, "definition": 158 } } | @@ -15613,15 +20430,18 @@ This page lists all known device types from the Overkiz API, grouped by protocol |-------|------|----------------|-------| | `ActivePartitionState` | DataState | | | | `AvailabilityState` | DiscreteState | available, unavailable | | + | `AvailableModesState` | DataState | | | | `BatteryDiscreteLevelState` | DiscreteState | good, medium, low, critical | | | `BatteryLevelState` | ContinuousState | | | - | `ErrorEventState` | DiscreteState | accessLimitation, internal, obstacleProtection, transportBusy, deviceNoAnswer, cancelled, deprecated, interrupted, thermalProtection, maintenanceRequired, alreadyUpToDate, notSupported, hardwareError, accessDenied, updateError, resourceAlreadyExist | | + | `ClosureState` | ContinuousState | [0..100] | | | `ErrorState` | DataState | | | | `ErrorsState` | DataState | | | | `FirmwareHashState` | DataState | | | | `FirmwareRevisionState` | DataState | | | + | `ModeState` | DataState | | | | `NameState` | DataState | | | | `NewFirmwareAvailableState` | DataState | | | + | `OpenClosedState` | DiscreteState | open, closed | | | `Private10State` | DataState | | | | `Private1State` | DataState | | | | `Private2State` | DataState | | | @@ -15632,26 +20452,44 @@ This page lists all known device types from the Overkiz API, grouped by protocol | `Private7State` | DataState | | | | `Private8State` | DataState | | | | `Private9State` | DataState | | | + | `ReachedAliasesState` | DataState | | | | `RemovableState` | DataState | | | | `SignalQualityState` | ContinuousState | | | - | `SmokeDetectionEventState` | DiscreteState | smoke | | - | `SmokeState` | DiscreteState | detected, notDetected | | + | `SlateOrientationState` | ContinuousState | [0..100] | | | `StatusState` | DiscreteState | available, unavailable | | + | `TiltState` | ContinuousState | | | + | `TiltedState` | DiscreteState | true, false | | + | `UnavailableFeaturesState` | DataState | | | -??? note "Switch/DynamicSwitch (ACTUATOR) — 8 commands, 27 states" +??? note "WashingMachine/DynamicWashingMachine (ACTUATOR) — 23 commands, 56 states" - **Type IDs:** `297` | **Servers:** `rexel`, `somfy_europe` | **Controllable:** `ogp:Switch` | **Profiles:** `SwitchEvent`, `Switch` + **Type IDs:** `285` | **Servers:** `rexel` | **Controllable:** `ogp:WashingMachine` | **Profiles:** `StatefulStartStopWashingMachine`, `StatefulStartStop`, `StartStop`, `StatefulLockWithOpeningStatus`, `StatefulThermostat`, `Thermostat`, `StatefulSwitchable`, `Switchable`, `StatefulLock`, `LockStatus`, `Lock` **Commands** | Command | Parameters | Notes | |---------|-----------|-------| + | `activateOption` | STRING | Activate an option | + | `deactivateOption` | STRING | Deactivate an option | | `executeManufacturerProcedure` | STRING; OBJECT (optional) | execute manufacturer procedure command. p1: the procedure name p2: the params associated Example: p1 = "dead_man_up" p2 = {"duration": 42} | | `identify` | | Ask the device to identify itself by doing a slight movement or blink or beep | + | `lock` | | Lock the device | + | `off` | | Turn off the device | + | `on` | | Turn on the device | + | `pause` | | Pause current action | | `readManufacturerData` | ARRAY | Read manufacturer data values from given names. Example: ["setting1","setting2"]. | + | `resume` | | Resume paused action. | | `sendPrivate` | OBJECT | send a private command | + | `setMode` | STRING | Set the active mode. | | `setName` | STRING | Change the device internal name. Name length may be subject to restrictions depending on the device and underlying protocol. | - | `setNodeDefinition` | STRING; STRING (optional); STRING (optional) | Fill the node definition (some transitions can be forbidden) p1: type (mandatory) p2: subType (mandatory if definition is set) p3: definition | + | `setOnOff` | STRING: off, on | Turn the device on or off | + | `setTargetSpinSpeed` | INT | Set the target spin speed. | + | `setTargetTemperature` | FLOAT | Set the new air temperature to reach | + | `setTargetTime` | INT | Set a target action duration. | + | `setTimezone` | STRING | Set the device timezone, according to TZ database names. | + | `start` | | Start the default actuator behavior (movement, sound or timer) | + | `stop` | | Stop the current actuator behavior (movement, sound or timer) | + | `unlock` | | Unlock the device | | `update` | | Update the gateway software. The update may have to be downloaded first, which can take a while. | | `writeManufacturerData` | OBJECT | Write manufacturer data values. Example: { "setting1": true, "setting2": 42, "setting3": "overkiz", "setting4": "Dk8PDr1WD0sfAAAAAAAAAAAAAAAAAAAA", "setting5": [ "valueA", "valueB", "valueC" ], "setting6": { "value": 15, "definition": 158 } } | @@ -15659,20 +20497,30 @@ This page lists all known device types from the Overkiz API, grouped by protocol | State | Type | Range / Values | Notes | |-------|------|----------------|-------| - | `ActionState` | DataState | | | + | `ActivatedOptionsState` | DataState | | | | `ActivePartitionState` | DataState | | | | `AvailabilityState` | DiscreteState | available, unavailable | | - | `AvailableActionsState` | DataState | | | + | `AvailableModesState` | DataState | | | + | `AvailableOptionsState` | DataState | | | + | `AvailableTargetSpinSpeedsState` | DataState | | | + | `AvailableTargetTemperaturesState` | DataState | | | | `BatteryDiscreteLevelState` | DiscreteState | good, medium, low, critical | | | `BatteryLevelState` | ContinuousState | | | - | `ButtonActionsEventState` | DataState | | | + | `CurrentCycleStageState` | DataState | | | + | `CycleStageSequenceState` | DataState | | | | `ErrorEventState` | DiscreteState | accessLimitation, internal, obstacleProtection, transportBusy, deviceNoAnswer, cancelled, deprecated, interrupted, thermalProtection, maintenanceRequired, alreadyUpToDate, notSupported, hardwareError, accessDenied, updateError, resourceAlreadyExist | | | `ErrorState` | DataState | | | | `ErrorsState` | DataState | | | | `FirmwareHashState` | DataState | | | | `FirmwareRevisionState` | DataState | | | + | `LockedUnlockedState` | DiscreteState | locked, unlocked | | + | `ModeState` | DataState | | | | `NameState` | DataState | | | | `NewFirmwareAvailableState` | DataState | | | + | `OnOffState` | DiscreteState | on, off | | + | `OpenClosedState` | DiscreteState | open, closed | | + | `OpenState` | DataState | | | + | `PausedState` | DataState | | | | `Private10State` | DataState | | | | `Private1State` | DataState | | | | `Private2State` | DataState | | | @@ -15683,23 +20531,58 @@ This page lists all known device types from the Overkiz API, grouped by protocol | `Private7State` | DataState | | | | `Private8State` | DataState | | | | `Private9State` | DataState | | | + | `RecommendedOptionsState` | DataState | | | + | `RecommendedTargetSpinSpeedState` | ContinuousState | | | + | `RecommendedTargetTemperatureState` | ContinuousState | | | + | `RecommendedTargetTimeState` | ContinuousState | | | + | `RemainingTimeState` | ContinuousState | | | | `RemovableState` | DataState | | | + | `RunningTimerState` | DataState | | | | `SignalQualityState` | ContinuousState | | | + | `StartedStoppedState` | DiscreteState | started, stopped | | | `StatusState` | DiscreteState | available, unavailable | | + | `TargetSpinSpeedCurrentLowerBoundState` | ContinuousState | | | + | `TargetSpinSpeedCurrentUpperBoundState` | ContinuousState | | | + | `TargetSpinSpeedState` | ContinuousState | | | + | `TargetTemperatureCurrentLowerBoundState` | ContinuousState | | | + | `TargetTemperatureCurrentUpperBoundState` | ContinuousState | | | + | `TargetTemperatureReachedState` | DataState | | | + | `TargetTemperatureState` | ContinuousState | [12.0..30.0] | | + | `TargetTimeCurrentLowerBoundState` | ContinuousState | | | + | `TargetTimeCurrentUpperBoundState` | ContinuousState | | | + | `TargetTimeState` | ContinuousState | | | + | `TimezoneState` | DataState | | | + | `UnavailableFeaturesState` | DataState | | | -??? note "TemperatureSensor/DynamicTemperatureSensor (SENSOR) — 7 commands, 25 states" +??? note "WashingMachine/DynamicWashingMachine (ACTUATOR) — 23 commands, 55 states" - **Type IDs:** `270` | **Servers:** `rexel`, `somfy_europe` | **Controllable:** `ogp:TemperatureSensor` | **Profiles:** `Temperature` + **Type IDs:** `285` | **Servers:** `somfy_europe` | **Controllable:** `ogp:WashingMachine` | **Profiles:** `StatefulStartStopWashingMachine`, `StatefulStartStop`, `StartStop`, `StatefulLockWithOpeningStatus`, `StatefulThermostat`, `Thermostat`, `StatefulSwitchable`, `Switchable`, `StatefulLock`, `LockStatus`, `Lock` **Commands** | Command | Parameters | Notes | |---------|-----------|-------| + | `activateOption` | STRING | Activate an option | + | `deactivateOption` | STRING | Deactivate an option | | `executeManufacturerProcedure` | STRING; OBJECT (optional) | execute manufacturer procedure command. p1: the procedure name p2: the params associated Example: p1 = "dead_man_up" p2 = {"duration": 42} | | `identify` | | Ask the device to identify itself by doing a slight movement or blink or beep | + | `lock` | | Lock the device | + | `off` | | Turn off the device | + | `on` | | Turn on the device | + | `pause` | | Pause current action | | `readManufacturerData` | ARRAY | Read manufacturer data values from given names. Example: ["setting1","setting2"]. | + | `resume` | | Resume paused action. | | `sendPrivate` | OBJECT | send a private command | + | `setMode` | STRING | Set the active mode. | | `setName` | STRING | Change the device internal name. Name length may be subject to restrictions depending on the device and underlying protocol. | + | `setOnOff` | STRING: off, on | Turn the device on or off | + | `setTargetSpinSpeed` | INT | Set the target spin speed. | + | `setTargetTemperature` | FLOAT | Set the new air temperature to reach | + | `setTargetTime` | INT | Set a target action duration. | + | `setTimezone` | STRING | Set the device timezone, according to TZ database names. | + | `start` | | Start the default actuator behavior (movement, sound or timer) | + | `stop` | | Stop the current actuator behavior (movement, sound or timer) | + | `unlock` | | Unlock the device | | `update` | | Update the gateway software. The update may have to be downloaded first, which can take a while. | | `writeManufacturerData` | OBJECT | Write manufacturer data values. Example: { "setting1": true, "setting2": 42, "setting3": "overkiz", "setting4": "Dk8PDr1WD0sfAAAAAAAAAAAAAAAAAAAA", "setting5": [ "valueA", "valueB", "valueC" ], "setting6": { "value": 15, "definition": 158 } } | @@ -15707,17 +20590,29 @@ This page lists all known device types from the Overkiz API, grouped by protocol | State | Type | Range / Values | Notes | |-------|------|----------------|-------| + | `ActivatedOptionsState` | DataState | | | | `ActivePartitionState` | DataState | | | | `AvailabilityState` | DiscreteState | available, unavailable | | + | `AvailableModesState` | DataState | | | + | `AvailableOptionsState` | DataState | | | + | `AvailableTargetSpinSpeedsState` | DataState | | | + | `AvailableTargetTemperaturesState` | DataState | | | | `BatteryDiscreteLevelState` | DiscreteState | good, medium, low, critical | | | `BatteryLevelState` | ContinuousState | | | - | `ErrorEventState` | DiscreteState | accessLimitation, internal, obstacleProtection, transportBusy, deviceNoAnswer, cancelled, deprecated, interrupted, thermalProtection, maintenanceRequired, alreadyUpToDate, notSupported, hardwareError, accessDenied, updateError, resourceAlreadyExist | | + | `CurrentCycleStageState` | DataState | | | + | `CycleStageSequenceState` | DataState | | | | `ErrorState` | DataState | | | | `ErrorsState` | DataState | | | | `FirmwareHashState` | DataState | | | | `FirmwareRevisionState` | DataState | | | + | `LockedUnlockedState` | DiscreteState | locked, unlocked | | + | `ModeState` | DataState | | | | `NameState` | DataState | | | | `NewFirmwareAvailableState` | DataState | | | + | `OnOffState` | DiscreteState | on, off | | + | `OpenClosedState` | DiscreteState | open, closed | | + | `OpenState` | DataState | | | + | `PausedState` | DataState | | | | `Private10State` | DataState | | | | `Private1State` | DataState | | | | `Private2State` | DataState | | | @@ -15728,27 +20623,51 @@ This page lists all known device types from the Overkiz API, grouped by protocol | `Private7State` | DataState | | | | `Private8State` | DataState | | | | `Private9State` | DataState | | | + | `RecommendedOptionsState` | DataState | | | + | `RecommendedTargetSpinSpeedState` | ContinuousState | | | + | `RecommendedTargetTemperatureState` | ContinuousState | | | + | `RecommendedTargetTimeState` | ContinuousState | | | + | `RemainingTimeState` | ContinuousState | | | | `RemovableState` | DataState | | | + | `RunningTimerState` | DataState | | | | `SignalQualityState` | ContinuousState | | | + | `StartedStoppedState` | DiscreteState | started, stopped | | | `StatusState` | DiscreteState | available, unavailable | | - | `TemperatureState` | ContinuousState | [-100.0..100.0] | | + | `TargetSpinSpeedCurrentLowerBoundState` | ContinuousState | | | + | `TargetSpinSpeedCurrentUpperBoundState` | ContinuousState | | | + | `TargetSpinSpeedState` | ContinuousState | | | + | `TargetTemperatureCurrentLowerBoundState` | ContinuousState | | | + | `TargetTemperatureCurrentUpperBoundState` | ContinuousState | | | + | `TargetTemperatureReachedState` | DataState | | | + | `TargetTemperatureState` | ContinuousState | [12.0..30.0] | | + | `TargetTimeCurrentLowerBoundState` | ContinuousState | | | + | `TargetTimeCurrentUpperBoundState` | ContinuousState | | | + | `TargetTimeState` | ContinuousState | | | + | `TimezoneState` | DataState | | | + | `UnavailableFeaturesState` | DataState | | | -??? note "ThirdPartyGateway/DynamicThirdPartyGateway (ACTUATOR) — 10 commands, 26 states" +??? note "WaterHeatingSystem/DynamicDomesticHotWaterProduction (ACTUATOR) — 16 commands, 41 states" - **Type IDs:** `283` | **Servers:** `rexel`, `somfy_europe` | **Controllable:** `ogp:ThirdPartyGateway` | **Profiles:** `Specific` + **Type IDs:** `290` | **Servers:** `rexel` | **Controllable:** `ogp:DomesticHotWater` | **Profiles:** `StatefulThermostatWithSensor`, `StatefulThermostat`, `Thermostat`, `StatefulSwitchable`, `Switchable` **Commands** | Command | Parameters | Notes | |---------|-----------|-------| - | `addGroupMember` | STRING | Add member to the group p1 : Id of the member to add to the group. | + | `activateOption` | STRING | Activate an option | + | `cancelHolidayMode` | | Deactivate holidays mode | + | `configureHolidayMode` | INT; INT | Configure holiday mode p1 : start date (timestamp in millisecond) p2 : end date (timestamp in millisecond) | + | `deactivateOption` | STRING | Deactivate an option | | `executeManufacturerProcedure` | STRING; OBJECT (optional) | execute manufacturer procedure command. p1: the procedure name p2: the params associated Example: p1 = "dead_man_up" p2 = {"duration": 42} | | `identify` | | Ask the device to identify itself by doing a slight movement or blink or beep | + | `off` | | Turn off the device | + | `on` | | Turn on the device | | `readManufacturerData` | ARRAY | Read manufacturer data values from given names. Example: ["setting1","setting2"]. | - | `removeGroupMember` | STRING | Remove a member of the group. p1 : Id of the member to remove to the group. | | `sendPrivate` | OBJECT | send a private command | - | `setAuthentication` | OBJECT | Set authentication properties of a node | + | `setMode` | STRING | Set the active mode. | | `setName` | STRING | Change the device internal name. Name length may be subject to restrictions depending on the device and underlying protocol. | + | `setOnOff` | STRING: off, on | Turn the device on or off | + | `setTargetTemperature` | FLOAT | Set the new air temperature to reach | | `update` | | Update the gateway software. The update may have to be downloaded first, which can take a while. | | `writeManufacturerData` | OBJECT | Write manufacturer data values. Example: { "setting1": true, "setting2": 42, "setting3": "overkiz", "setting4": "Dk8PDr1WD0sfAAAAAAAAAAAAAAAAAAAA", "setting5": [ "valueA", "valueB", "valueC" ], "setting6": { "value": 15, "definition": 158 } } | @@ -15756,9 +20675,12 @@ This page lists all known device types from the Overkiz API, grouped by protocol | State | Type | Range / Values | Notes | |-------|------|----------------|-------| + | `ActivatedOptionsState` | DataState | | | | `ActivePartitionState` | DataState | | | - | `AuthenticationExpiredState` | DataState | | | | `AvailabilityState` | DiscreteState | available, unavailable | | + | `AvailableModesState` | DataState | | | + | `AvailableOptionsState` | DataState | | | + | `AvailableTargetTemperaturesState` | DataState | | | | `BatteryDiscreteLevelState` | DiscreteState | good, medium, low, critical | | | `BatteryLevelState` | ContinuousState | | | | `ErrorEventState` | DiscreteState | accessLimitation, internal, obstacleProtection, transportBusy, deviceNoAnswer, cancelled, deprecated, interrupted, thermalProtection, maintenanceRequired, alreadyUpToDate, notSupported, hardwareError, accessDenied, updateError, resourceAlreadyExist | | @@ -15766,9 +20688,13 @@ This page lists all known device types from the Overkiz API, grouped by protocol | `ErrorsState` | DataState | | | | `FirmwareHashState` | DataState | | | | `FirmwareRevisionState` | DataState | | | - | `GroupMembersState` | DataState | | | + | `HolidayModeConfiguredState` | DataState | | | + | `HolidayModeEndDateTimeState` | DataState | | | + | `HolidayModeStartDateTimeState` | DataState | | | + | `ModeState` | DataState | | | | `NameState` | DataState | | | | `NewFirmwareAvailableState` | DataState | | | + | `OnOffState` | DiscreteState | on, off | | | `Private10State` | DataState | | | | `Private1State` | DataState | | | | `Private2State` | DataState | | | @@ -15779,36 +20705,40 @@ This page lists all known device types from the Overkiz API, grouped by protocol | `Private7State` | DataState | | | | `Private8State` | DataState | | | | `Private9State` | DataState | | | + | `RecommendedOptionsState` | DataState | | | + | `RecommendedTargetTemperatureState` | ContinuousState | | | | `RemovableState` | DataState | | | | `SignalQualityState` | ContinuousState | | | | `StatusState` | DiscreteState | available, unavailable | | + | `TargetTemperatureCurrentLowerBoundState` | ContinuousState | | | + | `TargetTemperatureCurrentUpperBoundState` | ContinuousState | | | + | `TargetTemperatureReachedState` | DataState | | | + | `TargetTemperatureState` | ContinuousState | [12.0..30.0] | | + | `TemperatureState` | ContinuousState | [-100.0..100.0] | | + | `UnavailableFeaturesState` | DataState | | | -??? note "VenetianBlind/DynamicVenetianBlind (ACTUATOR) — 20 commands, 31 states" +??? note "WaterHeatingSystem/DynamicDomesticHotWaterProduction (ACTUATOR) — 16 commands, 40 states" - **Type IDs:** `264` | **Servers:** `rexel`, `somfy_europe` | **Controllable:** `ogp:VenetianBlind` | **Profiles:** `StatefulOrientableShutter`, `StatefulOrientablePlusCloseable`, `OrientablePlusCloseable`, `StatefulOpenClose`, `OpenClose`, `StatefulCloseable`, `Closeable` + **Type IDs:** `290` | **Servers:** `somfy_europe` | **Controllable:** `ogp:DomesticHotWater` | **Profiles:** `StatefulThermostatWithSensor`, `StatefulThermostat`, `Thermostat`, `StatefulSwitchable`, `Switchable` **Commands** | Command | Parameters | Notes | |---------|-----------|-------| - | `close` | | Fully close the device | + | `activateOption` | STRING | Activate an option | + | `cancelHolidayMode` | | Deactivate holidays mode | + | `configureHolidayMode` | INT; INT | Configure holiday mode p1 : start date (timestamp in millisecond) p2 : end date (timestamp in millisecond) | + | `deactivateOption` | STRING | Deactivate an option | | `executeManufacturerProcedure` | STRING; OBJECT (optional) | execute manufacturer procedure command. p1: the procedure name p2: the params associated Example: p1 = "dead_man_up" p2 = {"duration": 42} | - | `goToAlias` | STRING | Send alias command linked with the ID. | | `identify` | | Ask the device to identify itself by doing a slight movement or blink or beep | - | `open` | | Fully open the device | + | `off` | | Turn off the device | + | `on` | | Turn on the device | | `readManufacturerData` | ARRAY | Read manufacturer data values from given names. Example: ["setting1","setting2"]. | - | `right` | | Right the device (go to minimum tilt position - open) | - | `saveAlias` | STRING | Allow to send an order for the product to save the current state of the alias. | | `sendPrivate` | OBJECT | send a private command | - | `setClosure` | INT [0..100] | Closure level (100%=fully close, 0%=open) | + | `setMode` | STRING | Set the active mode. | | `setName` | STRING | Change the device internal name. Name length may be subject to restrictions depending on the device and underlying protocol. | - | `setNodeDefinition` | STRING; STRING (optional); STRING (optional) | Fill the node definition (some transitions can be forbidden) p1: type (mandatory) p2: subType (mandatory if definition is set) p3: definition | - | `setOrientation` | INT [0..100] | Set the relative orientation (0-100%) of the device slats | - | `setTilt` | INT [0..100] | set the device tilt percentage | - | `stop` | | Stop the current actuator behavior (movement, sound or timer) | - | `tilt` | | Go to maximum tilt position (closed) | - | `tiltDown` | | Lower the slats to a horizontal position step by step (which will let in more light) | - | `tiltUp` | | Straighten the slats to a vertical position step by step (which will let in less light) | + | `setOnOff` | STRING: off, on | Turn the device on or off | + | `setTargetTemperature` | FLOAT | Set the new air temperature to reach | | `update` | | Update the gateway software. The update may have to be downloaded first, which can take a while. | | `writeManufacturerData` | OBJECT | Write manufacturer data values. Example: { "setting1": true, "setting2": 42, "setting3": "overkiz", "setting4": "Dk8PDr1WD0sfAAAAAAAAAAAAAAAAAAAA", "setting5": [ "valueA", "valueB", "valueC" ], "setting6": { "value": 15, "definition": 158 } } | @@ -15816,19 +20746,25 @@ This page lists all known device types from the Overkiz API, grouped by protocol | State | Type | Range / Values | Notes | |-------|------|----------------|-------| + | `ActivatedOptionsState` | DataState | | | | `ActivePartitionState` | DataState | | | | `AvailabilityState` | DiscreteState | available, unavailable | | + | `AvailableModesState` | DataState | | | + | `AvailableOptionsState` | DataState | | | + | `AvailableTargetTemperaturesState` | DataState | | | | `BatteryDiscreteLevelState` | DiscreteState | good, medium, low, critical | | | `BatteryLevelState` | ContinuousState | | | - | `ClosureState` | ContinuousState | [0..100] | | - | `ErrorEventState` | DiscreteState | accessLimitation, internal, obstacleProtection, transportBusy, deviceNoAnswer, cancelled, deprecated, interrupted, thermalProtection, maintenanceRequired, alreadyUpToDate, notSupported, hardwareError, accessDenied, updateError, resourceAlreadyExist | | | `ErrorState` | DataState | | | | `ErrorsState` | DataState | | | | `FirmwareHashState` | DataState | | | | `FirmwareRevisionState` | DataState | | | + | `HolidayModeConfiguredState` | DataState | | | + | `HolidayModeEndDateTimeState` | DataState | | | + | `HolidayModeStartDateTimeState` | DataState | | | + | `ModeState` | DataState | | | | `NameState` | DataState | | | | `NewFirmwareAvailableState` | DataState | | | - | `OpenClosedState` | DiscreteState | open, closed | | + | `OnOffState` | DiscreteState | on, off | | | `Private10State` | DataState | | | | `Private1State` | DataState | | | | `Private2State` | DataState | | | @@ -15839,38 +20775,31 @@ This page lists all known device types from the Overkiz API, grouped by protocol | `Private7State` | DataState | | | | `Private8State` | DataState | | | | `Private9State` | DataState | | | - | `ReachedAliasesState` | DataState | | | + | `RecommendedOptionsState` | DataState | | | + | `RecommendedTargetTemperatureState` | ContinuousState | | | | `RemovableState` | DataState | | | | `SignalQualityState` | ContinuousState | | | - | `SlateOrientationState` | ContinuousState | [0..100] | | | `StatusState` | DiscreteState | available, unavailable | | - | `TiltState` | ContinuousState | | | - | `TiltedState` | DiscreteState | true, false | | + | `TargetTemperatureCurrentLowerBoundState` | ContinuousState | | | + | `TargetTemperatureCurrentUpperBoundState` | ContinuousState | | | + | `TargetTemperatureReachedState` | DataState | | | + | `TargetTemperatureState` | ContinuousState | [12.0..30.0] | | + | `TemperatureState` | ContinuousState | [-100.0..100.0] | | | `UnavailableFeaturesState` | DataState | | | -??? note "VentilationSystem/DynamicVentilation (ACTUATOR) — 17 commands, 32 states" +??? note "WaterSensor/DynamicWaterMeasurementSensor (SENSOR) — 7 commands, 26 states" - **Type IDs:** `260` | **Servers:** `rexel`, `somfy_europe` | **Controllable:** `ogp:Ventilation` | **Profiles:** `StatefulSwitchableVentilation`, `Temperature`, `StatefulSwitchable`, `Switchable`, `StatefulAirFan`, `AirFan` + **Type IDs:** `295` | **Servers:** `rexel` | **Controllable:** `ogp:WaterMeasurementSensor` | **Profiles:** `WaterConsumption` **Commands** | Command | Parameters | Notes | |---------|-----------|-------| | `executeManufacturerProcedure` | STRING; OBJECT (optional) | execute manufacturer procedure command. p1: the procedure name p2: the params associated Example: p1 = "dead_man_up" p2 = {"duration": 42} | - | `goToAlias` | STRING | Send alias command linked with the ID. | | `identify` | | Ask the device to identify itself by doing a slight movement or blink or beep | - | `off` | | Turn off the device | - | `on` | | Turn on the device | | `readManufacturerData` | ARRAY | Read manufacturer data values from given names. Example: ["setting1","setting2"]. | - | `saveAlias` | STRING | Allow to send an order for the product to save the current state of the alias. | | `sendPrivate` | OBJECT | send a private command | - | `setFanSpeed` | STRING: low, medium, high, auto, 1 | Set the fan speed (%) | - | `setFanSpeedLevel` | INT [0..100] | Set the device fan speed level (%) | - | `setMode` | STRING | Set the active mode. | | `setName` | STRING | Change the device internal name. Name length may be subject to restrictions depending on the device and underlying protocol. | - | `setNodeDefinition` | STRING; STRING (optional); STRING (optional) | Fill the node definition (some transitions can be forbidden) p1: type (mandatory) p2: subType (mandatory if definition is set) p3: definition | - | `setOnOff` | STRING: off, on | Turn the device on or off | - | `toggle` | | Toggle on/off status | | `update` | | Update the gateway software. The update may have to be downloaded first, which can take a while. | | `writeManufacturerData` | OBJECT | Write manufacturer data values. Example: { "setting1": true, "setting2": 42, "setting3": "overkiz", "setting4": "Dk8PDr1WD0sfAAAAAAAAAAAAAAAAAAAA", "setting5": [ "valueA", "valueB", "valueC" ], "setting6": { "value": 15, "definition": 158 } } | @@ -15880,20 +20809,15 @@ This page lists all known device types from the Overkiz API, grouped by protocol |-------|------|----------------|-------| | `ActivePartitionState` | DataState | | | | `AvailabilityState` | DiscreteState | available, unavailable | | - | `AvailableModesState` | DataState | | | | `BatteryDiscreteLevelState` | DiscreteState | good, medium, low, critical | | | `BatteryLevelState` | ContinuousState | | | | `ErrorEventState` | DiscreteState | accessLimitation, internal, obstacleProtection, transportBusy, deviceNoAnswer, cancelled, deprecated, interrupted, thermalProtection, maintenanceRequired, alreadyUpToDate, notSupported, hardwareError, accessDenied, updateError, resourceAlreadyExist | | | `ErrorState` | DataState | | | | `ErrorsState` | DataState | | | - | `FanSpeedLevelState` | ContinuousState | [0..100] | | - | `FanSpeedState` | DiscreteState | low, medium, high, 1, 2, 3, 4, 5, 6, 7, 8, 9 | | | `FirmwareHashState` | DataState | | | | `FirmwareRevisionState` | DataState | | | - | `ModeState` | DataState | | | | `NameState` | DataState | | | | `NewFirmwareAvailableState` | DataState | | | - | `OnOffState` | DiscreteState | on, off | | | `Private10State` | DataState | | | | `Private1State` | DataState | | | | `Private2State` | DataState | | | @@ -15904,37 +20828,25 @@ This page lists all known device types from the Overkiz API, grouped by protocol | `Private7State` | DataState | | | | `Private8State` | DataState | | | | `Private9State` | DataState | | | - | `ReachedAliasesState` | DataState | | | | `RemovableState` | DataState | | | | `SignalQualityState` | ContinuousState | | | | `StatusState` | DiscreteState | available, unavailable | | - | `TemperatureState` | ContinuousState | [-100.0..100.0] | | - | `UnavailableFeaturesState` | DataState | | | + | `WaterConsumptionState` | ContinuousState | | | + | `WaterFlowState` | ContinuousState | | | -??? note "VentilationSystem/DynamicAirVent (ACTUATOR) — 18 commands, 33 states" +??? note "WaterSensor/DynamicWaterMeasurementSensor (SENSOR) — 7 commands, 25 states" - **Type IDs:** `268` | **Servers:** `rexel`, `somfy_europe` | **Controllable:** `ogp:AirVent` | **Profiles:** `StatefulCloseableAirVent`, `StatefulOrientableSlats`, `OrientableSlats`, `StatefulBasicCloseable`, `BasicCloseable`, `StatefulBasicOpenClose`, `BasicOpenClose` + **Type IDs:** `295` | **Servers:** `somfy_europe` | **Controllable:** `ogp:WaterMeasurementSensor` | **Profiles:** `WaterConsumption` **Commands** | Command | Parameters | Notes | |---------|-----------|-------| - | `close` | | Fully close the device | | `executeManufacturerProcedure` | STRING; OBJECT (optional) | execute manufacturer procedure command. p1: the procedure name p2: the params associated Example: p1 = "dead_man_up" p2 = {"duration": 42} | - | `goToAlias` | STRING | Send alias command linked with the ID. | | `identify` | | Ask the device to identify itself by doing a slight movement or blink or beep | - | `open` | | Fully open the device | | `readManufacturerData` | ARRAY | Read manufacturer data values from given names. Example: ["setting1","setting2"]. | - | `right` | | Right the device (go to minimum tilt position - open) | - | `saveAlias` | STRING | Allow to send an order for the product to save the current state of the alias. | | `sendPrivate` | OBJECT | send a private command | - | `setClosure` | INT [0..100] | Closure level (100%=fully close, 0%=open) | - | `setMode` | STRING | Set the active mode. | | `setName` | STRING | Change the device internal name. Name length may be subject to restrictions depending on the device and underlying protocol. | - | `setNodeDefinition` | STRING; STRING (optional); STRING (optional) | Fill the node definition (some transitions can be forbidden) p1: type (mandatory) p2: subType (mandatory if definition is set) p3: definition | - | `setOrientation` | INT [0..100] | Set the relative orientation (0-100%) of the device slats | - | `setTilt` | INT [0..100] | set the device tilt percentage | - | `tilt` | | Go to maximum tilt position (closed) | | `update` | | Update the gateway software. The update may have to be downloaded first, which can take a while. | | `writeManufacturerData` | OBJECT | Write manufacturer data values. Example: { "setting1": true, "setting2": 42, "setting3": "overkiz", "setting4": "Dk8PDr1WD0sfAAAAAAAAAAAAAAAAAAAA", "setting5": [ "valueA", "valueB", "valueC" ], "setting6": { "value": 15, "definition": 158 } } | @@ -15944,19 +20856,14 @@ This page lists all known device types from the Overkiz API, grouped by protocol |-------|------|----------------|-------| | `ActivePartitionState` | DataState | | | | `AvailabilityState` | DiscreteState | available, unavailable | | - | `AvailableModesState` | DataState | | | | `BatteryDiscreteLevelState` | DiscreteState | good, medium, low, critical | | | `BatteryLevelState` | ContinuousState | | | - | `ClosureState` | ContinuousState | [0..100] | | - | `ErrorEventState` | DiscreteState | accessLimitation, internal, obstacleProtection, transportBusy, deviceNoAnswer, cancelled, deprecated, interrupted, thermalProtection, maintenanceRequired, alreadyUpToDate, notSupported, hardwareError, accessDenied, updateError, resourceAlreadyExist | | | `ErrorState` | DataState | | | | `ErrorsState` | DataState | | | | `FirmwareHashState` | DataState | | | | `FirmwareRevisionState` | DataState | | | - | `ModeState` | DataState | | | | `NameState` | DataState | | | | `NewFirmwareAvailableState` | DataState | | | - | `OpenClosedState` | DiscreteState | open, closed | | | `Private10State` | DataState | | | | `Private1State` | DataState | | | | `Private2State` | DataState | | | @@ -15967,44 +20874,25 @@ This page lists all known device types from the Overkiz API, grouped by protocol | `Private7State` | DataState | | | | `Private8State` | DataState | | | | `Private9State` | DataState | | | - | `ReachedAliasesState` | DataState | | | | `RemovableState` | DataState | | | | `SignalQualityState` | ContinuousState | | | - | `SlateOrientationState` | ContinuousState | [0..100] | | | `StatusState` | DiscreteState | available, unavailable | | - | `TiltState` | ContinuousState | | | - | `TiltedState` | DiscreteState | true, false | | - | `UnavailableFeaturesState` | DataState | | | + | `WaterConsumptionState` | ContinuousState | | | + | `WaterFlowState` | ContinuousState | | | -??? note "WashingMachine/DynamicWashingMachine (ACTUATOR) — 23 commands, 56 states" +??? note "WeatherSensor/DynamicWeatherStation (SENSOR) — 7 commands, 34 states" - **Type IDs:** `285` | **Servers:** `rexel`, `somfy_europe` | **Controllable:** `ogp:WashingMachine` | **Profiles:** `StatefulStartStopWashingMachine`, `StatefulStartStop`, `StartStop`, `StatefulLockWithOpeningStatus`, `StatefulThermostat`, `Thermostat`, `StatefulSwitchable`, `Switchable`, `StatefulLock`, `LockStatus`, `Lock` + **Type IDs:** `279` | **Servers:** `rexel` | **Controllable:** `ogp:WeatherStation` | **Profiles:** `WindSpeedAndDirection`, `WindSpeed`, `WindDirection`, `Temperature`, `RelativeHumidity`, `RainDetector`, `Luminance` **Commands** | Command | Parameters | Notes | |---------|-----------|-------| - | `activateOption` | STRING | Activate an option | - | `deactivateOption` | STRING | Deactivate an option | | `executeManufacturerProcedure` | STRING; OBJECT (optional) | execute manufacturer procedure command. p1: the procedure name p2: the params associated Example: p1 = "dead_man_up" p2 = {"duration": 42} | | `identify` | | Ask the device to identify itself by doing a slight movement or blink or beep | - | `lock` | | Lock the device | - | `off` | | Turn off the device | - | `on` | | Turn on the device | - | `pause` | | Pause current action | | `readManufacturerData` | ARRAY | Read manufacturer data values from given names. Example: ["setting1","setting2"]. | - | `resume` | | Resume paused action. | | `sendPrivate` | OBJECT | send a private command | - | `setMode` | STRING | Set the active mode. | | `setName` | STRING | Change the device internal name. Name length may be subject to restrictions depending on the device and underlying protocol. | - | `setOnOff` | STRING: off, on | Turn the device on or off | - | `setTargetSpinSpeed` | INT | Set the target spin speed. | - | `setTargetTemperature` | FLOAT | Set the new air temperature to reach | - | `setTargetTime` | INT | Set a target action duration. | - | `setTimezone` | STRING | Set the device timezone, according to TZ database names. | - | `start` | | Start the default actuator behavior (movement, sound or timer) | - | `stop` | | Stop the current actuator behavior (movement, sound or timer) | - | `unlock` | | Unlock the device | | `update` | | Update the gateway software. The update may have to be downloaded first, which can take a while. | | `writeManufacturerData` | OBJECT | Write manufacturer data values. Example: { "setting1": true, "setting2": 42, "setting3": "overkiz", "setting4": "Dk8PDr1WD0sfAAAAAAAAAAAAAAAAAAAA", "setting5": [ "valueA", "valueB", "valueC" ], "setting6": { "value": 15, "definition": 158 } } | @@ -16012,30 +20900,21 @@ This page lists all known device types from the Overkiz API, grouped by protocol | State | Type | Range / Values | Notes | |-------|------|----------------|-------| - | `ActivatedOptionsState` | DataState | | | | `ActivePartitionState` | DataState | | | | `AvailabilityState` | DiscreteState | available, unavailable | | - | `AvailableModesState` | DataState | | | - | `AvailableOptionsState` | DataState | | | - | `AvailableTargetSpinSpeedsState` | DataState | | | - | `AvailableTargetTemperaturesState` | DataState | | | | `BatteryDiscreteLevelState` | DiscreteState | good, medium, low, critical | | | `BatteryLevelState` | ContinuousState | | | - | `CurrentCycleStageState` | DataState | | | - | `CycleStageSequenceState` | DataState | | | | `ErrorEventState` | DiscreteState | accessLimitation, internal, obstacleProtection, transportBusy, deviceNoAnswer, cancelled, deprecated, interrupted, thermalProtection, maintenanceRequired, alreadyUpToDate, notSupported, hardwareError, accessDenied, updateError, resourceAlreadyExist | | | `ErrorState` | DataState | | | | `ErrorsState` | DataState | | | | `FirmwareHashState` | DataState | | | | `FirmwareRevisionState` | DataState | | | - | `LockedUnlockedState` | DiscreteState | locked, unlocked | | - | `ModeState` | DataState | | | + | `FrostState` | DiscreteState | true, false | | + | `IceState` | DiscreteState | true, false | | + | `IlluminanceState` | ContinuousState | | | + | `LuminanceState` | ContinuousState | | | | `NameState` | DataState | | | | `NewFirmwareAvailableState` | DataState | | | - | `OnOffState` | DiscreteState | on, off | | - | `OpenClosedState` | DiscreteState | open, closed | | - | `OpenState` | DataState | | | - | `PausedState` | DataState | | | | `Private10State` | DataState | | | | `Private1State` | DataState | | | | `Private2State` | DataState | | | @@ -16046,51 +20925,29 @@ This page lists all known device types from the Overkiz API, grouped by protocol | `Private7State` | DataState | | | | `Private8State` | DataState | | | | `Private9State` | DataState | | | - | `RecommendedOptionsState` | DataState | | | - | `RecommendedTargetSpinSpeedState` | ContinuousState | | | - | `RecommendedTargetTemperatureState` | ContinuousState | | | - | `RecommendedTargetTimeState` | ContinuousState | | | - | `RemainingTimeState` | ContinuousState | | | + | `RainState` | DiscreteState | detected, notDetected | | + | `RelativeHumidityState` | ContinuousState | [0.0..100.0] | | | `RemovableState` | DataState | | | - | `RunningTimerState` | DataState | | | | `SignalQualityState` | ContinuousState | | | - | `StartedStoppedState` | DiscreteState | started, stopped | | + | `SnowState` | DiscreteState | true, false | | | `StatusState` | DiscreteState | available, unavailable | | - | `TargetSpinSpeedCurrentLowerBoundState` | ContinuousState | | | - | `TargetSpinSpeedCurrentUpperBoundState` | ContinuousState | | | - | `TargetSpinSpeedState` | ContinuousState | | | - | `TargetTemperatureCurrentLowerBoundState` | ContinuousState | | | - | `TargetTemperatureCurrentUpperBoundState` | ContinuousState | | | - | `TargetTemperatureReachedState` | DataState | | | - | `TargetTemperatureState` | ContinuousState | [12.0..30.0] | | - | `TargetTimeCurrentLowerBoundState` | ContinuousState | | | - | `TargetTimeCurrentUpperBoundState` | ContinuousState | | | - | `TargetTimeState` | ContinuousState | | | - | `TimezoneState` | DataState | | | - | `UnavailableFeaturesState` | DataState | | | + | `TemperatureState` | ContinuousState | [-100.0..100.0] | | + | `WindDirectionState` | ContinuousState | [0..360] | | + | `WindSpeedState` | ContinuousState | | | -??? note "WaterHeatingSystem/DynamicDomesticHotWaterProduction (ACTUATOR) — 16 commands, 41 states" +??? note "WeatherSensor/DynamicWeatherStation (SENSOR) — 7 commands, 33 states" - **Type IDs:** `290` | **Servers:** `rexel`, `somfy_europe` | **Controllable:** `ogp:DomesticHotWater` | **Profiles:** `StatefulThermostatWithSensor`, `StatefulThermostat`, `Thermostat`, `StatefulSwitchable`, `Switchable` + **Type IDs:** `279` | **Servers:** `somfy_europe` | **Controllable:** `ogp:WeatherStation` | **Profiles:** `WindSpeedAndDirection`, `WindSpeed`, `WindDirection`, `Temperature`, `RelativeHumidity`, `RainDetector`, `Luminance` **Commands** | Command | Parameters | Notes | |---------|-----------|-------| - | `activateOption` | STRING | Activate an option | - | `cancelHolidayMode` | | Deactivate holidays mode | - | `configureHolidayMode` | INT; INT | Configure holiday mode p1 : start date (timestamp in millisecond) p2 : end date (timestamp in millisecond) | - | `deactivateOption` | STRING | Deactivate an option | | `executeManufacturerProcedure` | STRING; OBJECT (optional) | execute manufacturer procedure command. p1: the procedure name p2: the params associated Example: p1 = "dead_man_up" p2 = {"duration": 42} | | `identify` | | Ask the device to identify itself by doing a slight movement or blink or beep | - | `off` | | Turn off the device | - | `on` | | Turn on the device | | `readManufacturerData` | ARRAY | Read manufacturer data values from given names. Example: ["setting1","setting2"]. | | `sendPrivate` | OBJECT | send a private command | - | `setMode` | STRING | Set the active mode. | | `setName` | STRING | Change the device internal name. Name length may be subject to restrictions depending on the device and underlying protocol. | - | `setOnOff` | STRING: off, on | Turn the device on or off | - | `setTargetTemperature` | FLOAT | Set the new air temperature to reach | | `update` | | Update the gateway software. The update may have to be downloaded first, which can take a while. | | `writeManufacturerData` | OBJECT | Write manufacturer data values. Example: { "setting1": true, "setting2": 42, "setting3": "overkiz", "setting4": "Dk8PDr1WD0sfAAAAAAAAAAAAAAAAAAAA", "setting5": [ "valueA", "valueB", "valueC" ], "setting6": { "value": 15, "definition": 158 } } | @@ -16098,26 +20955,20 @@ This page lists all known device types from the Overkiz API, grouped by protocol | State | Type | Range / Values | Notes | |-------|------|----------------|-------| - | `ActivatedOptionsState` | DataState | | | | `ActivePartitionState` | DataState | | | | `AvailabilityState` | DiscreteState | available, unavailable | | - | `AvailableModesState` | DataState | | | - | `AvailableOptionsState` | DataState | | | - | `AvailableTargetTemperaturesState` | DataState | | | | `BatteryDiscreteLevelState` | DiscreteState | good, medium, low, critical | | | `BatteryLevelState` | ContinuousState | | | - | `ErrorEventState` | DiscreteState | accessLimitation, internal, obstacleProtection, transportBusy, deviceNoAnswer, cancelled, deprecated, interrupted, thermalProtection, maintenanceRequired, alreadyUpToDate, notSupported, hardwareError, accessDenied, updateError, resourceAlreadyExist | | | `ErrorState` | DataState | | | | `ErrorsState` | DataState | | | | `FirmwareHashState` | DataState | | | | `FirmwareRevisionState` | DataState | | | - | `HolidayModeConfiguredState` | DataState | | | - | `HolidayModeEndDateTimeState` | DataState | | | - | `HolidayModeStartDateTimeState` | DataState | | | - | `ModeState` | DataState | | | + | `FrostState` | DiscreteState | true, false | | + | `IceState` | DiscreteState | true, false | | + | `IlluminanceState` | ContinuousState | | | + | `LuminanceState` | ContinuousState | | | | `NameState` | DataState | | | | `NewFirmwareAvailableState` | DataState | | | - | `OnOffState` | DiscreteState | on, off | | | `Private10State` | DataState | | | | `Private1State` | DataState | | | | `Private2State` | DataState | | | @@ -16128,21 +20979,19 @@ This page lists all known device types from the Overkiz API, grouped by protocol | `Private7State` | DataState | | | | `Private8State` | DataState | | | | `Private9State` | DataState | | | - | `RecommendedOptionsState` | DataState | | | - | `RecommendedTargetTemperatureState` | ContinuousState | | | + | `RainState` | DiscreteState | detected, notDetected | | + | `RelativeHumidityState` | ContinuousState | [0.0..100.0] | | | `RemovableState` | DataState | | | | `SignalQualityState` | ContinuousState | | | + | `SnowState` | DiscreteState | true, false | | | `StatusState` | DiscreteState | available, unavailable | | - | `TargetTemperatureCurrentLowerBoundState` | ContinuousState | | | - | `TargetTemperatureCurrentUpperBoundState` | ContinuousState | | | - | `TargetTemperatureReachedState` | DataState | | | - | `TargetTemperatureState` | ContinuousState | [12.0..30.0] | | | `TemperatureState` | ContinuousState | [-100.0..100.0] | | - | `UnavailableFeaturesState` | DataState | | | + | `WindDirectionState` | ContinuousState | [0..360] | | + | `WindSpeedState` | ContinuousState | | | -??? note "WaterSensor/DynamicWaterMeasurementSensor (SENSOR) — 7 commands, 26 states" +??? note "WindSensor/DynamicWindSensor (SENSOR) — 7 commands, 26 states" - **Type IDs:** `295` | **Servers:** `rexel`, `somfy_europe` | **Controllable:** `ogp:WaterMeasurementSensor` | **Profiles:** `WaterConsumption` + **Type IDs:** `274` | **Servers:** `rexel` | **Controllable:** `ogp:WindSensor` | **Profiles:** `WindSpeedAndDirection`, `WindSpeed`, `WindDirection` **Commands** @@ -16184,12 +21033,12 @@ This page lists all known device types from the Overkiz API, grouped by protocol | `RemovableState` | DataState | | | | `SignalQualityState` | ContinuousState | | | | `StatusState` | DiscreteState | available, unavailable | | - | `WaterConsumptionState` | ContinuousState | | | - | `WaterFlowState` | ContinuousState | | | + | `WindDirectionState` | ContinuousState | [0..360] | | + | `WindSpeedState` | ContinuousState | | | -??? note "WeatherSensor/DynamicWeatherStation (SENSOR) — 7 commands, 34 states" +??? note "WindSensor/DynamicWindSensor (SENSOR) — 7 commands, 25 states" - **Type IDs:** `279` | **Servers:** `rexel`, `somfy_europe` | **Controllable:** `ogp:WeatherStation` | **Profiles:** `WindSpeedAndDirection`, `WindSpeed`, `WindDirection`, `Temperature`, `RelativeHumidity`, `RainDetector`, `Luminance` + **Type IDs:** `274` | **Servers:** `somfy_europe` | **Controllable:** `ogp:WindSensor` | **Profiles:** `WindSpeedAndDirection`, `WindSpeed`, `WindDirection` **Commands** @@ -16211,15 +21060,10 @@ This page lists all known device types from the Overkiz API, grouped by protocol | `AvailabilityState` | DiscreteState | available, unavailable | | | `BatteryDiscreteLevelState` | DiscreteState | good, medium, low, critical | | | `BatteryLevelState` | ContinuousState | | | - | `ErrorEventState` | DiscreteState | accessLimitation, internal, obstacleProtection, transportBusy, deviceNoAnswer, cancelled, deprecated, interrupted, thermalProtection, maintenanceRequired, alreadyUpToDate, notSupported, hardwareError, accessDenied, updateError, resourceAlreadyExist | | | `ErrorState` | DataState | | | | `ErrorsState` | DataState | | | | `FirmwareHashState` | DataState | | | | `FirmwareRevisionState` | DataState | | | - | `FrostState` | DiscreteState | true, false | | - | `IceState` | DiscreteState | true, false | | - | `IlluminanceState` | ContinuousState | | | - | `LuminanceState` | ContinuousState | | | | `NameState` | DataState | | | | `NewFirmwareAvailableState` | DataState | | | | `Private10State` | DataState | | | @@ -16232,29 +21076,36 @@ This page lists all known device types from the Overkiz API, grouped by protocol | `Private7State` | DataState | | | | `Private8State` | DataState | | | | `Private9State` | DataState | | | - | `RainState` | DiscreteState | detected, notDetected | | - | `RelativeHumidityState` | ContinuousState | [0.0..100.0] | | | `RemovableState` | DataState | | | | `SignalQualityState` | ContinuousState | | | - | `SnowState` | DiscreteState | true, false | | | `StatusState` | DiscreteState | available, unavailable | | - | `TemperatureState` | ContinuousState | [-100.0..100.0] | | | `WindDirectionState` | ContinuousState | [0..360] | | | `WindSpeedState` | ContinuousState | | | -??? note "WindSensor/DynamicWindSensor (SENSOR) — 7 commands, 26 states" +??? note "Window/DynamicWindow (ACTUATOR) — 18 commands, 31 states" - **Type IDs:** `274` | **Servers:** `rexel`, `somfy_europe` | **Controllable:** `ogp:WindSensor` | **Profiles:** `WindSpeedAndDirection`, `WindSpeed`, `WindDirection` + **Type IDs:** `267` | **Servers:** `rexel` | **Controllable:** `ogp:Window` | **Profiles:** `StatefulWindowLockWithOpeningStatus`, `StatefulLockWithOpeningStatus`, `StatefulOpenClose`, `OpenClose`, `StatefulCloseable`, `Closeable`, `StatefulLock`, `LockStatus`, `Lock`, `Cyclic` **Commands** | Command | Parameters | Notes | |---------|-----------|-------| + | `close` | | Fully close the device | + | `cycle` | | Do a cycle of supported motion kinematics or modes | | `executeManufacturerProcedure` | STRING; OBJECT (optional) | execute manufacturer procedure command. p1: the procedure name p2: the params associated Example: p1 = "dead_man_up" p2 = {"duration": 42} | + | `goToAlias` | STRING | Send alias command linked with the ID. | | `identify` | | Ask the device to identify itself by doing a slight movement or blink or beep | + | `lock` | | Lock the device | + | `open` | | Fully open the device | | `readManufacturerData` | ARRAY | Read manufacturer data values from given names. Example: ["setting1","setting2"]. | + | `saveAlias` | STRING | Allow to send an order for the product to save the current state of the alias. | | `sendPrivate` | OBJECT | send a private command | + | `setAuthentication` | OBJECT | Set authentication properties of a node | + | `setClosure` | INT [0..100] | Closure level (100%=fully close, 0%=open) | | `setName` | STRING | Change the device internal name. Name length may be subject to restrictions depending on the device and underlying protocol. | + | `setNodeDefinition` | STRING; STRING (optional); STRING (optional) | Fill the node definition (some transitions can be forbidden) p1: type (mandatory) p2: subType (mandatory if definition is set) p3: definition | + | `stop` | | Stop the current actuator behavior (movement, sound or timer) | + | `unlock` | | Unlock the device | | `update` | | Update the gateway software. The update may have to be downloaded first, which can take a while. | | `writeManufacturerData` | OBJECT | Write manufacturer data values. Example: { "setting1": true, "setting2": 42, "setting3": "overkiz", "setting4": "Dk8PDr1WD0sfAAAAAAAAAAAAAAAAAAAA", "setting5": [ "valueA", "valueB", "valueC" ], "setting6": { "value": 15, "definition": 158 } } | @@ -16263,16 +21114,20 @@ This page lists all known device types from the Overkiz API, grouped by protocol | State | Type | Range / Values | Notes | |-------|------|----------------|-------| | `ActivePartitionState` | DataState | | | + | `AuthenticationExpiredState` | DataState | | | | `AvailabilityState` | DiscreteState | available, unavailable | | | `BatteryDiscreteLevelState` | DiscreteState | good, medium, low, critical | | | `BatteryLevelState` | ContinuousState | | | + | `ClosureState` | ContinuousState | [0..100] | | | `ErrorEventState` | DiscreteState | accessLimitation, internal, obstacleProtection, transportBusy, deviceNoAnswer, cancelled, deprecated, interrupted, thermalProtection, maintenanceRequired, alreadyUpToDate, notSupported, hardwareError, accessDenied, updateError, resourceAlreadyExist | | | `ErrorState` | DataState | | | | `ErrorsState` | DataState | | | | `FirmwareHashState` | DataState | | | | `FirmwareRevisionState` | DataState | | | + | `LockedUnlockedState` | DiscreteState | locked, unlocked | | | `NameState` | DataState | | | | `NewFirmwareAvailableState` | DataState | | | + | `OpenClosedState` | DiscreteState | open, closed | | | `Private10State` | DataState | | | | `Private1State` | DataState | | | | `Private2State` | DataState | | | @@ -16283,15 +21138,16 @@ This page lists all known device types from the Overkiz API, grouped by protocol | `Private7State` | DataState | | | | `Private8State` | DataState | | | | `Private9State` | DataState | | | + | `ReachedAliasesState` | DataState | | | | `RemovableState` | DataState | | | + | `SSIDState` | DataState | | | | `SignalQualityState` | ContinuousState | | | | `StatusState` | DiscreteState | available, unavailable | | - | `WindDirectionState` | ContinuousState | [0..360] | | - | `WindSpeedState` | ContinuousState | | | + | `UnavailableFeaturesState` | DataState | | | -??? note "Window/DynamicWindow (ACTUATOR) — 18 commands, 31 states" +??? note "Window/DynamicWindow (ACTUATOR) — 18 commands, 30 states" - **Type IDs:** `267` | **Servers:** `rexel`, `somfy_europe` | **Controllable:** `ogp:Window` | **Profiles:** `StatefulWindowLockWithOpeningStatus`, `StatefulLockWithOpeningStatus`, `StatefulOpenClose`, `OpenClose`, `StatefulCloseable`, `Closeable`, `StatefulLock`, `LockStatus`, `Lock`, `Cyclic` + **Type IDs:** `267` | **Servers:** `somfy_europe` | **Controllable:** `ogp:Window` | **Profiles:** `StatefulWindowLockWithOpeningStatus`, `StatefulLockWithOpeningStatus`, `StatefulOpenClose`, `OpenClose`, `StatefulCloseable`, `Closeable`, `StatefulLock`, `LockStatus`, `Lock`, `Cyclic` **Commands** @@ -16326,7 +21182,6 @@ This page lists all known device types from the Overkiz API, grouped by protocol | `BatteryDiscreteLevelState` | DiscreteState | good, medium, low, critical | | | `BatteryLevelState` | ContinuousState | | | | `ClosureState` | ContinuousState | [0..100] | | - | `ErrorEventState` | DiscreteState | accessLimitation, internal, obstacleProtection, transportBusy, deviceNoAnswer, cancelled, deprecated, interrupted, thermalProtection, maintenanceRequired, alreadyUpToDate, notSupported, hardwareError, accessDenied, updateError, resourceAlreadyExist | | | `ErrorState` | DataState | | | | `ErrorsState` | DataState | | | | `FirmwareHashState` | DataState | | | @@ -16356,7 +21211,7 @@ This page lists all known device types from the Overkiz API, grouped by protocol **Type IDs:** `0` | **Servers:** `rexel`, `somfy_europe` | **Controllable:** `ogp:Invalid` | **Profiles:** `Specific` -??? note "waterLeakSensor/DynamicWaterLeakSensor (SENSOR) — 7 commands, 26 states" +??? note "waterLeakSensor/DynamicWaterLeakSensor (SENSOR) — 7 commands, 25 states" **Type IDs:** `306` | **Servers:** `somfy_europe` | **Controllable:** `ogp:WaterLeakSensor` | **Profiles:** `waterLeakSensor` @@ -16380,7 +21235,6 @@ This page lists all known device types from the Overkiz API, grouped by protocol | `AvailabilityState` | DiscreteState | available, unavailable | | | `BatteryDiscreteLevelState` | DiscreteState | good, medium, low, critical | | | `BatteryLevelState` | ContinuousState | | | - | `ErrorEventState` | DiscreteState | accessLimitation, internal, obstacleProtection, transportBusy, deviceNoAnswer, cancelled, deprecated, interrupted, thermalProtection, maintenanceRequired, alreadyUpToDate, notSupported, hardwareError, accessDenied, updateError, resourceAlreadyExist | | | `ErrorState` | DataState | | | | `ErrorsState` | DataState | | | | `FirmwareHashState` | DataState | | | @@ -16400,7 +21254,7 @@ This page lists all known device types from the Overkiz API, grouped by protocol | `RemovableState` | DataState | | | | `SignalQualityState` | ContinuousState | | | | `StatusState` | DiscreteState | available, unavailable | | - | `WaterLeakEventState` | DiscreteState | waterLeak | | + | `WaterLeakEventState` | DiscreteState | false, true | | | `WaterLeakState` | DiscreteState | detected, notDetected | | diff --git a/pyoverkiz/enums/command.py b/pyoverkiz/enums/command.py index 05a0a5c4..b2d3a8b5 100644 --- a/pyoverkiz/enums/command.py +++ b/pyoverkiz/enums/command.py @@ -64,6 +64,7 @@ class OverkizCommand(StrEnum): CLEAR_ALL_LINKED_DEVICES = "clearAllLinkedDevices" CLEAR_CREDENTIALS = "clearCredentials" CLOSE = "close" + CLOSE_COMMISSIONING = "closeCommissioning" CLOSE_NETWORK = "closeNetwork" CLOSE_NETWORK_MANAGEMENT = "closeNetworkManagement" CLOSE_SLATS = "closeSlats" @@ -203,6 +204,7 @@ class OverkizCommand(StrEnum): ON_WITH_INTERNAL_TIMER = "onWithInternalTimer" ON_WITH_TIMER = "onWithTimer" OPEN = "open" + OPEN_COMMISSIONING = "openCommissioning" OPEN_CONFIGURATION = "openConfiguration" OPEN_DOOR = "openDoor" OPEN_GATE = "openGate" diff --git a/pyoverkiz/enums/state.py b/pyoverkiz/enums/state.py index 1b081f3a..021b9c11 100644 --- a/pyoverkiz/enums/state.py +++ b/pyoverkiz/enums/state.py @@ -121,6 +121,7 @@ class OverkizState(StrEnum): CORE_ABSENCE_START_DATE_TIME = "core:AbsenceStartDateTimeState" CORE_ACCESS_LIMITATION = "core:AccessLimitationState" CORE_ACTION = "core:ActionState" + CORE_ACTION_EVENT = "core:ActionEventState" CORE_ACTIVATED_OPTIONS = "core:ActivatedOptionsState" CORE_ACTIVE_COOLING_TIME_PROGRAM = "core:ActiveCoolingTimeProgramState" CORE_ACTIVE_FAN = "core:ActiveFanState" @@ -212,6 +213,10 @@ class OverkizState(StrEnum): CORE_COMFORT_TARGET_TEMPERATURE_UNIT = "core:ComfortTargetTemperatureUnitState" CORE_COMFORT_TEMPERATURE_STEP = "core:ComfortTemperatureStepState" CORE_COMMAND_LOCK_LEVELS = "core:CommandLockLevelsState" + CORE_COMMISSIONING_WINDOW_CLOSE_TIMESTAMP = ( + "core:CommissioningWindowCloseTimestampState" + ) + CORE_COMMISSIONING_WINDOW_OPEN = "core:CommissioningWindowOpenState" CORE_CONFIGURATION_PARAMETER_NUMBER = "core:ConfigurationParameterNumberState" CORE_CONFIGURATION_PARAMETER_VALUE = "core:ConfigurationParameterValueState" CORE_CONNECTIVITY = "core:ConnectivityState" @@ -244,6 +249,7 @@ class OverkizState(StrEnum): CORE_COUNTRY_CODE = "core:CountryCodeState" CORE_CO_CONCENTRATION = "core:COConcentrationState" CORE_CO_DETECTION = "core:CODetectionState" + CORE_CREDENTIALS = "core:CredentialsState" CORE_CURRENT = "core:CurrentState" CORE_CURRENT_CYCLE_STAGE = "core:CurrentCycleStageState" CORE_CURRENT_SOILING = "core:CurrentSoilingState" @@ -364,6 +370,7 @@ class OverkizState(StrEnum): CORE_INTRUSION = "core:IntrusionState" CORE_INTRUSION_DETECTED = "core:IntrusionDetectedState" CORE_INTRUSION_DETECTION_EVENT = "core:IntrusionDetectionEventState" + CORE_INTRUSION_EVENT = "core:IntrusionEventState" CORE_IP_ADDRESS = "core:IPAddressState" CORE_LABEL = "core:LabelState" CORE_LANGUAGE = "core:LanguageState" @@ -603,6 +610,7 @@ class OverkizState(StrEnum): CORE_SLATS_ORIENTATION = "core:SlatsOrientationState" CORE_SMOKE = "core:SmokeState" CORE_SMOKE_DETECTION_EVENT = "core:SmokeDetectionEventState" + CORE_SMOKE_EVENT = "core:SmokeEventState" CORE_SNOW = "core:SnowState" CORE_SOFTWARE_WIRING_INVERSION = "core:SoftwareWiringInversionState" CORE_SOLAR_RADIATION = "core:SolarRadiationState" @@ -1892,6 +1900,7 @@ class OverkizState(StrEnum): NETATMO_WIND_SPEED = "netatmo:WindSpeedState" OGCP_ACCESS_LIMITATION = "ogcp:AccessLimitationState" OGCP_ACTION = "ogcp:ActionState" + OGCP_ACTION_EVENT = "ogcp:ActionEventState" OGCP_ACTIVATED_OPTIONS = "ogcp:ActivatedOptionsState" OGCP_ACTIVE_PARTITION = "ogcp:ActivePartitionState" OGCP_AIR_QUALITY_INDEX_LEVEL = "ogcp:AirQualityIndexLevelState" @@ -1914,6 +1923,11 @@ class OverkizState(StrEnum): OGCP_CO2_CONCENTRATION = "ogcp:CO2ConcentrationState" OGCP_COLOR_MODE = "ogcp:ColorModeState" OGCP_COLOR_TEMPERATURE = "ogcp:ColorTemperatureState" + OGCP_COMMISSIONING_WINDOW_CLOSE_TIMESTAMP = ( + "ogcp:CommissioningWindowCloseTimestampState" + ) + OGCP_COMMISSIONING_WINDOW_OPEN = "ogcp:CommissioningWindowOpenState" + OGCP_CREDENTIALS = "ogcp:CredentialsState" OGCP_CURRENT_CYCLE_STAGE = "ogcp:CurrentCycleStageState" OGCP_CURRENT_SOILING = "ogcp:CurrentSoilingState" OGCP_CYCLE_STAGE_SEQUENCE = "ogcp:CycleStageSequenceState" @@ -1944,6 +1958,7 @@ class OverkizState(StrEnum): OGCP_INTENSITY = "ogcp:IntensityState" OGCP_INTRUSION = "ogcp:IntrusionState" OGCP_INTRUSION_DETECTION_EVENT = "ogcp:IntrusionDetectionEventState" + OGCP_INTRUSION_EVENT = "ogcp:IntrusionEventState" OGCP_LAUNCH_STATUS = "ogcp:LaunchStatusState" OGCP_LIGHT_INTENSITY = "ogcp:LightIntensityState" OGCP_LIMITATION_SOURCES = "ogcp:LimitationSourcesState" @@ -2000,6 +2015,7 @@ class OverkizState(StrEnum): OGCP_SLATE_ORIENTATION = "ogcp:SlateOrientationState" OGCP_SMOKE = "ogcp:SmokeState" OGCP_SMOKE_DETECTION_EVENT = "ogcp:SmokeDetectionEventState" + OGCP_SMOKE_EVENT = "ogcp:SmokeEventState" OGCP_SNOW = "ogcp:SnowState" OGCP_SSID = "ogcp:SSIDState" OGCP_STARTED_STOPPED = "ogcp:StartedStoppedState" @@ -2051,6 +2067,7 @@ class OverkizState(StrEnum): OGCP_WIND_SPEED = "ogcp:WindSpeedState" OGP_ACCESS_LIMITATION = "ogp:AccessLimitationState" OGP_ACTION = "ogp:ActionState" + OGP_ACTION_EVENT = "ogp:ActionEventState" OGP_ACTIVATED_OPTIONS = "ogp:ActivatedOptionsState" OGP_ACTIVE_PARTITION = "ogp:ActivePartitionState" OGP_AIR_QUALITY_INDEX_LEVEL = "ogp:AirQualityIndexLevelState" @@ -2073,6 +2090,11 @@ class OverkizState(StrEnum): OGP_CO2_CONCENTRATION = "ogp:CO2ConcentrationState" OGP_COLOR_MODE = "ogp:ColorModeState" OGP_COLOR_TEMPERATURE = "ogp:ColorTemperatureState" + OGP_COMMISSIONING_WINDOW_CLOSE_TIMESTAMP = ( + "ogp:CommissioningWindowCloseTimestampState" + ) + OGP_COMMISSIONING_WINDOW_OPEN = "ogp:CommissioningWindowOpenState" + OGP_CREDENTIALS = "ogp:CredentialsState" OGP_CURRENT_CYCLE_STAGE = "ogp:CurrentCycleStageState" OGP_CURRENT_SOILING = "ogp:CurrentSoilingState" OGP_CYCLE_STAGE_SEQUENCE = "ogp:CycleStageSequenceState" @@ -2103,6 +2125,7 @@ class OverkizState(StrEnum): OGP_INTENSITY = "ogp:IntensityState" OGP_INTRUSION = "ogp:IntrusionState" OGP_INTRUSION_DETECTION_EVENT = "ogp:IntrusionDetectionEventState" + OGP_INTRUSION_EVENT = "ogp:IntrusionEventState" OGP_LAUNCH_STATUS = "ogp:LaunchStatusState" OGP_LIGHT_INTENSITY = "ogp:LightIntensityState" OGP_LIMITATION_SOURCES = "ogp:LimitationSourcesState" @@ -2159,6 +2182,7 @@ class OverkizState(StrEnum): OGP_SLATE_ORIENTATION = "ogp:SlateOrientationState" OGP_SMOKE = "ogp:SmokeState" OGP_SMOKE_DETECTION_EVENT = "ogp:SmokeDetectionEventState" + OGP_SMOKE_EVENT = "ogp:SmokeEventState" OGP_SNOW = "ogp:SnowState" OGP_SSID = "ogp:SSIDState" OGP_STARTED_STOPPED = "ogp:StartedStoppedState" diff --git a/pyoverkiz/enums/ui.py b/pyoverkiz/enums/ui.py index 6d655901..b1cbfbfe 100644 --- a/pyoverkiz/enums/ui.py +++ b/pyoverkiz/enums/ui.py @@ -205,6 +205,7 @@ class UIWidget(UnknownEnumMixin, StrEnum): DYNAMIC_ALARM = "DynamicAlarm" DYNAMIC_AMBIENT_NOISE_SENSOR = "DynamicAmbientNoiseSensor" DYNAMIC_AUDIO_PLAYER = "DynamicAudioPlayer" + DYNAMIC_AUDIOPLAYER = "DynamicAudioplayer" DYNAMIC_AWNING = "DynamicAwning" DYNAMIC_BRIDGE = "DynamicBridge" DYNAMIC_CARBON_DIOXIDE_SENSOR = "DynamicCarbonDioxideSensor"