Device Types
This page lists all known device types from the Overkiz API, grouped by protocol. Each entry shows the commands it accepts and the states it exposes.
Note
This page is auto-generated from the Overkiz API. Run uv run utils/generate_device_catalog.py to regenerate.
35 protocols, 570 unique device types documented below.
Protocols
- ARISTON (5 types)
- AUGUST (1 types)
- AURORA (1 types)
- CAMERA (1 types)
- DEDIETRICHSTC (4 types)
- ELIOT (11 types)
- ENOCEAN (35 types)
- HLRR_WIFI (2 types)
- HOMEKIT (1 types)
- HUE (5 types)
- INTERNAL (15 types)
- IO (84 types)
- JSW (1 types)
- KNX (50 types)
- MODBUS (12 types)
- MODBUSLINK (8 types)
- MYFOX (9 types)
- NEST (4 types)
- NETATMO (36 types)
- OGCP (47 types)
- OGP (47 types)
- OPENDOORS (1 types)
- OVP (25 types)
- PROFALUX_868 (5 types)
- RAMSES (7 types)
- RTD (5 types)
- RTDS (11 types)
- RTS (25 types)
- SOMFY_THERMOSTAT (3 types)
- UPNP_CONTROL (2 types)
- URMET (2 types)
- WISER (4 types)
- YOKIS (21 types)
- ZIGBEE (50 types)
- ZWAVE (30 types)
ARISTON
5 device types.
HeatingSystem/AristonBoiler (ACTUATOR) — 2 commands, 3 states
Type IDs: 257, 259 | Servers: rexel | Controllable: ariston:BoilerMainControllerAristonComponent | Profiles: StatefulOperatingModeHeating, OperatingModeHeating
Commands
| Command | Parameters | Notes |
|---|---|---|
setHolidaysOnOffWithTimer |
STRING: off, on; INT [1..365] (optional) | Set holidays mode on/off with expiration delay - p1: The holidays mode - p2: The derogation expiration delay (in days), is required if the holiday mode is enabled |
setOperatingMode |
STRING: summer, winter, off | Set an operating mode |
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
HolidaysModeEndDateTimeState |
DataState | ||
HolidaysModeState |
DiscreteState | off, on | |
OperatingModeState |
DiscreteState | antifreeze, auto, away, eco, frostprotection |
HeatingSystem/AristonHeatPump (ACTUATOR) — 2 commands, 4 states
Type IDs: 258 | Servers: rexel | Controllable: ariston:HeatPumpMainControllerAristonComponent | Profiles: StatefulOperatingModeHeating, OperatingModeHeating
Commands
| Command | Parameters | Notes |
|---|---|---|
setHolidaysOnOffWithTimer |
STRING: off, on; INT [1..365] (optional) | Set holidays mode on/off with expiration delay - p1: The holidays mode - p2: The derogation expiration delay (in days), is required if the holiday mode is enabled |
setOperatingMode |
STRING: summer, winter, heat, cool, off | Set an operating mode |
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
CoolingModeActivableState |
DiscreteState | false, true | |
HolidaysModeEndDateTimeState |
DataState | ||
HolidaysModeState |
DiscreteState | off, on | |
OperatingModeState |
DiscreteState | antifreeze, auto, away, eco, frostprotection |
HeatingSystem/AristonHeatingZone (ACTUATOR) — 3 commands, 17 states
Type IDs: 1024 | Servers: rexel | Controllable: ariston:HeatingZoneControllerAristonComponent | Profiles: StatefulThermostat, Thermostat
Commands
| Command | Parameters | Notes |
|---|---|---|
setDerogatedTargetTemperature |
STRING: off, on; FLOAT [10.0..30.0] (optional) | Set the derogated temperature setpoint - p1 : enable or disable the derogation - p2 : derogated target temperature value |
setHeatingMode |
STRING: stop, manu, auto | Set the device heating mode |
setTargetTemperature |
FLOAT [10.0..30.0] | Set the new air temperature to reach |
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
ComfortTargetTemperatureState |
ContinuousState | ||
ComfortTargetTemperatureUnitState |
ContinuousState | ||
ComfortTemperatureStepState |
ContinuousState | ||
DerogatedTargetTemperatureState |
ContinuousState | ||
DerogationEndDateTimeState |
DataState | ||
DerogationOnOffState |
DiscreteState | off, on | |
MaximumComfortTemperatureState |
ContinuousState | ||
MaximumReducedTemperatureState |
ContinuousState | ||
MinimumComfortTemperatureState |
ContinuousState | ||
MinimumReducedTemperatureState |
ContinuousState | ||
ReducedTemperatureState |
ContinuousState | ||
ReducedTemperatureStepState |
ContinuousState | ||
ReducedTemperatureUnitState |
ContinuousState | ||
TargetRoomTemperatureState |
ContinuousState | ||
TargetRoomTemperatureUnitState |
ContinuousState | ||
TargetTemperatureState |
ContinuousState | [12.0..30.0] | |
ZoneHeatingModeState |
DiscreteState | auto, manu, stop |
TemperatureSensor (SENSOR) — 0 commands, 2 states
Type IDs: 512, 1024 | Servers: rexel | Controllable: ariston:OutdoorTemperatureAristonSensor | Profiles: Temperature
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
TemperatureState |
ContinuousState | [-100.0..100.0] | |
TemperatureUnitState |
ContinuousState |
WaterHeatingSystem/DomesticHotWaterProduction (ACTUATOR) — 1 commands, 7 states
Type IDs: 768 | Servers: rexel | Controllable: ariston:DomesticHotWaterProductionAristonComponent | Profiles: DHWThermostat, DHWTemperature
Commands
| Command | Parameters | Notes |
|---|---|---|
setTargetDHWTemperature |
FLOAT [36.0..60.0] | Set the new water temperature to reach for a Domestic Hot Water system |
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
DHWTemperatureState |
ContinuousState | [-100.0..100.0] | |
DHWTemperatureStepState |
ContinuousState | ||
DHWTemperatureUnitState |
ContinuousState | ||
MaximumDHWTemperatureState |
ContinuousState | ||
MinimumDHWTemperatureState |
ContinuousState | ||
WaterInletTemperatureState |
ContinuousState | ||
WaterInletTemperatureUnitState |
ContinuousState |
AUGUST
1 device types.
DoorLock (ACTUATOR) — 5 commands, 5 states
Type IDs: 1 | Servers: somfy_europe | Controllable: august:SmartLockComponent | Profiles: StatefulDoorLock, StatefulLock, LockStatus, Lock
Commands
| Command | Parameters | Notes |
|---|---|---|
lock |
Lock the device | |
refreshState |
Refresh the device states | |
registerWebhook |
Register a subscription to webhook. | |
removeWebhook |
Removes the subscription registration for the current “pairing” derived from the pairing token. | |
unlock |
Unlock the device |
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
BatteryState |
DiscreteState | verylow, low, normal, full | |
LockedUnlockedState |
DiscreteState | locked, unlocked | |
NameState |
DataState | ||
StatusState |
DiscreteState | available, unavailable | |
WebhookIdState |
DataState |
AURORA
1 device types.
Light/DimmerLight (ACTUATOR) — 14 commands, 8 states
Type IDs: 0 | Servers: rexel | Controllable: aurora:AuroraDimmerActuator | Profiles: StatefulLightDimmer, StatefulDimmable, Dimmable, Switchable
Data Properties
core:identifyInterval=1000
Commands
| Command | Parameters | Notes |
|---|---|---|
goToMemorized1Position |
Set the device to a user pre-defined position | |
goToMemorized2Position |
Set the device to a user pre-defined position | |
goToMemorized3Position |
Set the device to a user pre-defined position | |
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 | |
setIntensity |
INT [0..100]; STRING: memorized1, memorized2, memorized3 | Light intensity level (100%=maximum intensity, 0%=off) |
setIntensityWithTimer |
STRING: memorized1, memorized2, memorized3; INT [0..100]; INT [5..14400]; STRING: memorized1, memorized2, memorized3 (optional); INT [0..100] (optional) | Set the light intensity to p1% then after p2 seconds, set it to p3%. (If p3 is not specified the light is turned off after the delay) |
setMemorized1Position |
INT [0..100] | Set favorite position |
setMemorized1PositionName |
STRING | Change the favorite position internal name. Name length may be subject to restrictions depending on the device and underlying protocol. |
setMemorized2Position |
INT [0..100] | Set favorite position |
setMemorized2PositionName |
STRING | Change the favorite position internal name. Name length may be subject to restrictions depending on the device and underlying protocol. |
setMemorized3Position |
INT [0..100] | Set favorite position |
setMemorized3PositionName |
STRING | Change the favorite position internal name. Name length may be subject to restrictions depending on the device and underlying protocol. |
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
IPAddressState |
DataState | ||
LightIntensityState |
ContinuousState | [0..100] | |
Memorized1PositionNameState |
DataState | ||
Memorized1PositionState |
ContinuousState | ||
Memorized2PositionNameState |
DataState | ||
Memorized2PositionState |
ContinuousState | ||
Memorized3PositionNameState |
DataState | ||
Memorized3PositionState |
ContinuousState |
CAMERA
1 device types.
Camera/GenericCamera (ACTUATOR) — 2 commands, 0 states
Type IDs: 65536, 131072 | Servers: somfy_europe | Controllable: camera:GenericCameraComponent | Profiles: PictureCamera
Commands
| Command | Parameters | Notes |
|---|---|---|
takePicture |
Take a still picture | |
takePictureSequence |
INT [1..20] (optional); INT [2..10] (optional) |
DEDIETRICHSTC
4 device types.
HeatingSystem/ThermostatSetPoint (ACTUATOR) — 30 commands, 25 states
Type IDs: 2 | Servers: rexel | Controllable: dedietrichstc:ThermostatComponent | Profiles: StatefulDualThermostat, DualThermostat, StatefulThermostat, Thermostat
Commands
| Command | Parameters | Notes |
|---|---|---|
refreshActiveTimeProgram |
Refresh curent active time program. | |
refreshActivitiesNames |
Refresh activity names. | |
refreshControlStrategy |
Refresh control strategy parameter of the heating zone. | |
refreshCoolingTargetTemperature |
Refresh cooling target temperature. | |
refreshDerogationTime |
Refresh derogation time | |
refreshFireplaceMode |
Refresh if fireplace mode is activate/deactivate on heating system. | |
refreshFrostProtectionAndHolidayTargetTemperature |
Refresh target temperature for frost protection and holiday mode. | |
refreshHeatingCoolingSpeed |
Refresh heating cooling speed parameter of the heating zone. | |
refreshHeatingCurve |
Refresh heating curve parameter of the heating zone. | |
refreshHolidayDate |
Refresh date for holiday mode. | |
refreshMaxPreHeatTime |
Refresh pre-heat time parameter of the heating zone. | |
refreshMode |
Refresh the mode | |
refreshTargetTemperature |
Refresh the temperature value | |
refreshTimeProgramActivities |
Refresh time program activities parameter of the heating zone. | |
setActiveTimeProgram |
INT [1..6] | Defines curent active time program |
setActivitiesNames |
OBJECT | Set activity names. |
setControlStrategy |
STRING: room-temperature-control, auto, outside-temperature-control, outside-temperature-control-with-room-temperature-compensation | Set the control strategy. |
setCoolDownSpeed |
STRING: slowest, extra-slow, slow, normal, fast | Set the cool down speed. p1 is the cool down speed. |
setCoolingTargetTemperature |
FLOAT [7.0..35.0] | Set the cooling target temperature (manual set point) |
setDerogatedTargetTemperature |
FLOAT [0.0..60.0]; INT (optional) | Set the derogated temperature of the room and when this new temperature has to end. p1 is the target temperature for derogated period. p2 is the duration of derogated period in minutes (optional). When temporaryOverrideEnd is not provided the next switch time of the active time program will be set as end time. |
setFireplaceMode |
STRING: true, false | Activate/Deactivate on heating system fireplace mode. |
setFrostProtectionAndHolidayTargetTemperature |
FLOAT [0.0..60.0] | Set target temperature for frost protection and holiday mode. |
setHeatUpSpeed |
STRING: slowest, extra-slow, slow, normal, fast | Set the heat up speed. p1 is the heat up speed. |
setHeatingCurve |
OBJECT | Set the heating curve parameter. |
setHeatingTargetTemperature |
FLOAT [7.0..35.0] | Set the heating target temperature (manual set point) |
setHoliday |
STRING; STRING | Set heating system on holiday mode. p1 is the date of the holiday begining. p2 is the date of the holiday ending. Each parameter is a full-date and time hh:mm as defined in ISO8601, without seconds, sec-frac and timezone example : "2020-03-05T22:00" |
setMaxPreHeatTime |
INT | Set the max pre-heat time (in minutes). |
setOnFrostProtectionMode |
Set on system frost protection mode. | |
setTargetTemperature |
FLOAT [0.0..60.0] | Set the new air temperature to reach |
setTimeProgramActivities |
OBJECT | Set time program activities parameter of the heating zone. |
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
ActiveCoolingTimeProgramState |
DataState | ||
ActiveHeatingTimeProgramState |
DataState | ||
ActiveTimeProgramState |
DataState | ||
ActivitiesNamesState |
DataState | ||
ControlStrategyState |
DataState | ||
CoolDownSpeedState |
DataState | ||
CoolingTargetTemperatureState |
ContinuousState | [12.0..30.0] | |
DerogationEndDateTimeState |
DataState | ||
FireplaceModeActiveState |
DiscreteState | false, true | |
FrostProtectionAndHolidaysTargetTemperatureState |
ContinuousState | ||
HeatUpSpeedState |
DataState | ||
HeatingCurveState |
DataState | ||
HeatingTargetTemperatureState |
ContinuousState | [12.0..30.0] | |
HolidayModeEndDateTimeState |
DataState | ||
HolidayModeStartDateTimeState |
DataState | ||
MaxPreHeatTimeState |
DataState | ||
ModeState |
DataState | ||
NameState |
DataState | ||
NextModeState |
DataState | ||
NextSwitchDayOffsetState |
DataState | ||
NextSwitchTimeState |
DataState | ||
NextSwitchroomTemperatureSetpointValueState |
DataState | ||
TargetTemperatureState |
ContinuousState | [12.0..30.0] | |
TimeProgramActivitiesState |
DataState | ||
ZoneActivityState |
DataState |
ProtocolGateway/DeDietrichSTCStack (PROTOCOL_GATEWAY) — 24 commands, 23 states
Type IDs: 1 | Servers: rexel | Controllable: dedietrichstc:DeDietrichSTCStackComponent | Profiles: Specific
Commands
| Command | Parameters | Notes |
|---|---|---|
deletePairedDevice |
STRING | Delete a paired devices. |
discover |
Start a new discovery procedure. | |
getPairedDevices |
Retrieve paired devices. | |
refreshApplianceTime |
Refresh appliance time of the system. | |
refreshDeviceInformation |
Refresh device Information. | |
refreshDeviceLocation |
Refresh device location. | |
refreshError |
Refresh the current error. | |
refreshFlowTemperature |
Refresh flow temperature. | |
refreshGatewayConnectionStatus |
Refresh De Dietrich Smart TC connection status. | |
refreshHeatingTemperatureThreshold |
Refresh heating temperature threshold. | |
refreshInstallerInformation |
Refresh installer information. | |
refreshOperatingMode |
Refresh an operating mode. | |
refreshWaterFillingStatus |
Refresh De Dietrich Water filling status. | |
refreshWaterPressure |
Refresh water pressure. | |
refreshWebhookId |
Refresh webhook identifier. | |
registerWebhook |
Register a subscription to webhook. | |
removeWebhook |
Removes the subscription registration for the current “pairing” derived from the pairing token. | |
sendWaterFillingCommand |
STRING: start, stop | Send a command for water filling. |
setDeviceLocation |
FLOAT; FLOAT; INT | Set device location. p1 represent the latitude. p2 represent the longitude. p3 represent the resolution. |
setHeatingTemperatureThreshold |
FLOAT [10.0..30.0] | Set heating temperature threshold. |
setInstallerInformation |
OBJECT | Set installer information. |
setOperatingMode |
STRING: off, heating-auto, forced-cooling, heating-cooling-auto | Set De Dietrich Operating mode. |
setWaterFillingMode |
STRING: off, manual, auto | Set De Dietrich Water filling mode. |
updateWebhook |
update the subscription to webhook. |
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
ConnectionStatusState |
DataState | ||
DateTimeState |
DataState | ||
DeviceSerialNumberState |
DataState | ||
ErrorCodeState |
DataState | ||
ErrorState |
DataState | ||
FlowTemperatureState |
ContinuousState | ||
HeatingTemperatureThresholdState |
ContinuousState | ||
InstallerInformationState |
DataState | ||
LocationLatitudeState |
DataState | ||
LocationLongitudeState |
DataState | ||
NameState |
DataState | ||
OperatingModeState |
DiscreteState | antifreeze, auto, away, eco, frostprotection | |
OperatingOptionsState |
DataState | ||
PairedDevicesState |
DataState | ||
ProductHardwareVersionState |
DataState | ||
ProductSoftwareVersionState |
DataState | ||
UTCTimeOffsetState |
DataState | ||
WaterFillingModeState |
DataState | ||
WaterFillingStatusState |
DataState | ||
WaterPressureState |
ContinuousState | ||
WebhookErrorCodeState |
DataState | ||
WebhookErrorStatusState |
DataState | ||
WebhookIdState |
DataState |
TemperatureSensor (SENSOR) — 1 commands, 1 states
Type IDs: 2 | Servers: rexel | Controllable: dedietrichstc:TemperatureSensor | Profiles: Temperature
Commands
| Command | Parameters | Notes |
|---|---|---|
refreshTemperature |
Refresh the last measured temperature |
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
TemperatureState |
ContinuousState | [-100.0..100.0] |
WaterHeatingSystem/DomesticHotWaterProduction (ACTUATOR) — 12 commands, 9 states
Type IDs: 3 | Servers: rexel | Controllable: dedietrichstc:DomesticHotWaterComponent | Profiles: Specific
Commands
| Command | Parameters | Notes |
|---|---|---|
refreshDHWActiveTimeProgram |
Refresh domestic hot water current active time program. | |
refreshDHWParameters |
Refresh parameters of the domestic hot water. | |
refreshDerogationTime |
Refresh derogation time | |
refreshDeviceInformation |
Refresh device Information. | |
refreshHolidayDate |
Refresh date for holiday mode. | |
refreshMode |
Refresh the mode | |
setBoostMode |
INT (optional) | Set system on boost mode. p1 is the duration of derogated period in minutes (optional). When temporaryOverrideEnd is not provided the next switch time of the active time program will be set as end time. |
setDHWActiveTimeProgram |
INT [1..6] | Set the domestic hot water current active time program. |
setDHWParameters |
OBJECT | Set parameters of the domestic hot water. |
setHoliday |
STRING; STRING | Set heating system on holiday mode. p1 is the date of the holiday begining. p2 is the date of the holiday ending. Each parameter is a full-date and time hh:mm as defined in ISO8601, without seconds, sec-frac and timezone example : "2020-03-05T22:00" |
setOnComfortMode |
Set on system comfort mode. | |
setOnFrostProtectionMode |
Set on system frost protection mode. |
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
ActiveTimeProgramState |
DataState | ||
DHWParametersState |
DataState | ||
DHWTypeState |
DataState | ||
DerogationEndDateTimeState |
DataState | ||
HolidayModeEndDateTimeState |
DataState | ||
HolidayModeStartDateTimeState |
DataState | ||
ModeState |
DataState | ||
NameState |
DataState | ||
NextModeState |
DataState |
ELIOT
11 device types.
CircuitBreaker (ACTUATOR) — 5 commands, 2 states
Type IDs: 515 | Servers: rexel, somfy_europe | Controllable: eliot:CircuitBreakerComponent | Profiles: StatefulSwitchablePlug, StatefulSwitchable, Switchable
Commands
| Command | Parameters | Notes |
|---|---|---|
off |
Turn off the device | |
on |
Turn on the device | |
onWithTimer |
INT [5..14400] | Turn the device on for a given amount of seconds then turn it off |
refreshState |
Refresh the device states | |
setOnOff |
STRING: off, on | Turn the device on or off |
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
FirmwareRevisionState |
DataState | ||
OnOffState |
DiscreteState | on, off |
CircuitBreaker (ACTUATOR) — 6 commands, 3 states
Type IDs: 517 | Servers: rexel, somfy_europe | Controllable: eliot:CircuitBreakerPeakAndOffPeakHoursComponent | Profiles: StatefulSwitchablePlug, StatefulOperatingModeHeating, OperatingModeHeating, StatefulSwitchable, Switchable
Commands
| Command | Parameters | Notes |
|---|---|---|
off |
Turn off the device | |
on |
Turn on the device | |
onWithTimer |
INT [5..14400] | Turn the device on for a given amount of seconds then turn it off |
refreshState |
Refresh the device states | |
setOnOff |
STRING: off, on | Turn the device on or off |
setOperatingMode |
STRING: off, auto, boost | Set an operating mode |
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
FirmwareRevisionState |
DataState | ||
OnOffState |
DiscreteState | on, off | |
OperatingModeState |
DiscreteState | antifreeze, auto, away, eco, frostprotection |
ElectricitySensor/CumulativeElectricPowerConsumptionSensor (SENSOR) — 0 commands, 2 states
Type IDs: 257, 258, 513, 514, 515, 516, 517, 518, 519 | Servers: rexel, somfy_europe | Controllable: eliot:EliotElectricEnergyConsumptionSensor | Profiles: ElectricEnergyAndPower, ElectricPowerMeter, ElectricEnergyConsumption
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
ElectricEnergyConsumptionState |
ContinuousState | ||
ElectricPowerConsumptionState |
ContinuousState |
Light/StatefulOnOffLight (ACTUATOR) — 6 commands, 2 states
Type IDs: 257 | Servers: rexel, somfy_europe | Controllable: eliot:OnOffLightEliotComponent | Profiles: StatefulSwitchableLight, StatefulSwitchable, Switchable
Commands
| Command | Parameters | Notes |
|---|---|---|
off |
Turn off the device | |
on |
Turn on the device | |
onWithTimer |
INT [5..14400] | Turn the device on for a given amount of seconds then turn it off |
refreshAllLightStates |
Refresh all states of the light. @deprecated : use refreshState instead. | |
refreshState |
Refresh the device states | |
setOnOff |
STRING: off, on | Turn the device on or off |
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
FirmwareRevisionState |
DataState | ||
OnOffState |
DiscreteState | on, off |
Light/DimmerLight (ACTUATOR) — 17 commands, 9 states
Type IDs: 258 | Servers: rexel, somfy_europe | Controllable: eliot:DimmerLightEliotComponent | Profiles: StatefulLightDimmer, StatefulDimmable, Dimmable, StatefulSwitchable, Switchable
Commands
| Command | Parameters | Notes |
|---|---|---|
goToMemorized1Position |
Set the device to a user pre-defined position | |
goToMemorized2Position |
Set the device to a user pre-defined position | |
goToMemorized3Position |
Set the device to a user pre-defined position | |
off |
Turn off the device | |
on |
Turn on the device | |
onWithTimer |
INT [5..14400] | Turn the device on for a given amount of seconds then turn it off |
refreshAllLightStates |
Refresh all states of the light. @deprecated : use refreshState instead. | |
refreshState |
Refresh the device states | |
setIntensity |
INT [0..100]; STRING: memorized1, memorized2, memorized3 | Light intensity level (100%=maximum intensity, 0%=off) |
setIntensityWithTimer |
STRING: memorized1, memorized2, memorized3; INT [0..100]; INT [5..14400]; STRING: memorized1, memorized2, memorized3 (optional); INT [0..100] (optional) | Set the light intensity to p1% then after p2 seconds, set it to p3%. (If p3 is not specified the light is turned off after the delay) |
setMemorized1Position |
INT [0..100] | Set favorite position |
setMemorized1PositionName |
STRING | Change the favorite position internal name. Name length may be subject to restrictions depending on the device and underlying protocol. |
setMemorized2Position |
INT [0..100] | Set favorite position |
setMemorized2PositionName |
STRING | Change the favorite position internal name. Name length may be subject to restrictions depending on the device and underlying protocol. |
setMemorized3Position |
INT [0..100] | Set favorite position |
setMemorized3PositionName |
STRING | Change the favorite position 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 |
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
FirmwareRevisionState |
DataState | ||
LightIntensityState |
ContinuousState | [0..100] | |
Memorized1PositionNameState |
DataState | ||
Memorized1PositionState |
ContinuousState | ||
Memorized2PositionNameState |
DataState | ||
Memorized2PositionState |
ContinuousState | ||
Memorized3PositionNameState |
DataState | ||
Memorized3PositionState |
ContinuousState | ||
OnOffState |
DiscreteState | on, off |
OnOff/StatefulOnOff (ACTUATOR) — 6 commands, 2 states
Type IDs: 513, 516 | Servers: rexel, somfy_europe | Controllable: eliot:OnOffSwitchEliotComponent | Profiles: StatefulSwitchablePlug, StatefulSwitchable, Switchable
Commands
| Command | Parameters | Notes |
|---|---|---|
off |
Turn off the device | |
on |
Turn on the device | |
onWithTimer |
INT [5..14400] | Turn the device on for a given amount of seconds then turn it off |
refreshAllSwitchStates |
Refresh all states of the plug on/off. @deprecated : use refreshState instead. | |
refreshState |
Refresh the device states | |
setOnOff |
STRING: off, on | Turn the device on or off |
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
FirmwareRevisionState |
DataState | ||
OnOffState |
DiscreteState | on, off |
OnOff/StatefulOnOff (ACTUATOR) — 7 commands, 3 states
Type IDs: 519 | Servers: rexel, somfy_europe | Controllable: eliot:ElectricVehicleChargerPeakAndOffPeakHoursComponent | Profiles: StatefulSwitchablePlug, StatefulOperatingModeHeating, OperatingModeHeating, StatefulSwitchable, Switchable
Commands
| Command | Parameters | Notes |
|---|---|---|
off |
Turn off the device | |
on |
Turn on the device | |
onWithTimer |
INT [5..14400] | Turn the device on for a given amount of seconds then turn it off |
refreshAllSwitchStates |
Refresh all states of the plug on/off. @deprecated : use refreshState instead. | |
refreshState |
Refresh the device states | |
setOnOff |
STRING: off, on | Turn the device on or off |
setOperatingMode |
STRING: off, auto, boost | Set an operating mode |
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
FirmwareRevisionState |
DataState | ||
OnOffState |
DiscreteState | on, off | |
OperatingModeState |
DiscreteState | antifreeze, auto, away, eco, frostprotection |
RemoteController/RemoteControllerOneWay (REMOTE_CONTROLLER) — 1 commands, 3 states
Type IDs: 1025 | Servers: rexel, somfy_europe | Controllable: eliot:RemoteEliotComponent | Profiles: RockerSwitch
Commands
| Command | Parameters | Notes |
|---|---|---|
refreshState |
Refresh the device states |
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
BatteryState |
DiscreteState | verylow, low, normal, full | |
FirmwareRevisionState |
DataState | ||
RockerSwitchPushWayState |
DiscreteState | heldDown, pressed, pressedX2, pressedX3, pressedX4 |
RollerShutter/UpDownRollerShutter (ACTUATOR) — 6 commands, 3 states
Type IDs: 769 | Servers: rexel, somfy_europe | Controllable: eliot:RollerShutterEliotComponent | Profiles: StatefulOpenCloseShutter, StatefulOpenClose, OpenClose
Commands
| Command | Parameters | Notes |
|---|---|---|
close |
Fully close the device | |
down |
Move the device completely down | |
open |
Fully open the device | |
refreshState |
Refresh the device states | |
stop |
Stop the current actuator behavior (movement, sound or timer) | |
up |
Move the device completely up |
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
ClosureState |
ContinuousState | [0..100] | |
FirmwareRevisionState |
DataState | ||
OpenClosedState |
DiscreteState | open, closed |
WaterHeatingSystem/DomesticHotWaterProduction (ACTUATOR) — 5 commands, 2 states
Type IDs: 514 | Servers: rexel, somfy_europe | Controllable: eliot:DomesticHotWaterComponent | Profiles: StatefulSwitchablePlug, StatefulSwitchable, Switchable
Commands
| Command | Parameters | Notes |
|---|---|---|
off |
Turn off the device | |
on |
Turn on the device | |
onWithTimer |
INT [5..14400] | Turn the device on for a given amount of seconds then turn it off |
refreshState |
Refresh the device states | |
setOnOff |
STRING: off, on | Turn the device on or off |
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
FirmwareRevisionState |
DataState | ||
OnOffState |
DiscreteState | on, off |
WaterHeatingSystem/DomesticHotWaterProduction (ACTUATOR) — 6 commands, 3 states
Type IDs: 518 | Servers: rexel, somfy_europe | Controllable: eliot:DomesticHotWaterPeakAndOffPeakHoursComponent | Profiles: StatefulSwitchablePlug, StatefulOperatingModeHeating, OperatingModeHeating, StatefulSwitchable, Switchable
Commands
| Command | Parameters | Notes |
|---|---|---|
off |
Turn off the device | |
on |
Turn on the device | |
onWithTimer |
INT [5..14400] | Turn the device on for a given amount of seconds then turn it off |
refreshState |
Refresh the device states | |
setOnOff |
STRING: off, on | Turn the device on or off |
setOperatingMode |
STRING: off, auto, boost | Set an operating mode |
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
FirmwareRevisionState |
DataState | ||
OnOffState |
DiscreteState | on, off | |
OperatingModeState |
DiscreteState | antifreeze, auto, away, eco, frostprotection |
ENOCEAN
35 device types.
ElectricitySensor/CumulativeElectricPowerConsumptionSensor (SENSOR) — 5 commands, 6 states
Type IDs: 230901871017984, 230901871018021, 230901871083631, 230901938126848, 230901938192495, 230901971681350 | Servers: rexel, somfy_europe | Controllable: enocean:EnOceanSwitchOnOffConsumptionSensorType8 | Profiles: ElectricEnergyAndPower, ElectricPowerMeter, ElectricEnergyConsumption
Commands
| Command | Parameters | Notes |
|---|---|---|
activateEnergyAutoReport |
Activate energy auto reporting (also deactivate power autoreporting) | |
activatePowerAutoReport |
Activate power auto reporting (also deactivate energy autoreporting) | |
deactivateAutoReport |
Deactivate auto reporting (energy and power) | |
refreshEnergy |
Refresh the energy consomption | |
refreshPower |
Refresh the power consumption |
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
DiscreteRSSILevelState |
DiscreteState | good, low, normal, verylow | |
ElectricEnergyConsumptionState |
ContinuousState | ||
ElectricPowerConsumptionState |
ContinuousState | ||
EnOceanAutoReportState |
DiscreteState | energy, off, power | |
RSSILevelState |
ContinuousState | ||
StatusState |
DiscreteState | available, unavailable |
Generic/EnOceanGeneric (ACTUATOR) — 3 commands, 1 states
Type IDs: 270492762112000 | Servers: rexel, somfy_europe | Controllable: enocean:EnOceanGenericActuator | Profiles: Switchable, Generic
Commands
| Command | Parameters | Notes |
|---|---|---|
off |
Turn off the device | |
on |
Turn on the device | |
onWithTimer |
INT [5..14400] | Turn the device on for a given amount of seconds then turn it off |
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
StatusState |
DiscreteState | available, unavailable |
HeatingSystem/ValveHeatingTemperatureInterface (ACTUATOR) — 10 commands, 13 states
Type IDs: 181556874313728 | Servers: rexel, somfy_europe | Controllable: enocean:EnOceanHVACBatteryPoweredComponent | Profiles: StatefulCloseableValve, StatefulBasicCloseable, BasicCloseable, StatefulThermostat, Thermostat, StatefulBasicOpenClose, BasicOpenClose
Commands
| Command | Parameters | Notes |
|---|---|---|
activateSummerMode |
activate the summer mode, less energy consumption | |
close |
Fully close the device | |
closeValve |
Fully close the valve | |
deactivateSummerMode |
Deactivate the summer mode, more energy consumption | |
open |
Fully open the device | |
openValve |
Fully open the valve | |
setClosure |
INT [0..100] | Closure level (100%=fully close, 0%=open) |
setTargetTemperature |
FLOAT [0.0..100.0] | Set the new air temperature to reach |
setTargetTemperatureValue |
FLOAT [0.0..100.0] | Set the new temperature to reach |
setValvePosition |
INT [0..100] | Valve position (100%=fully closed, 0%=opened) |
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
BatteryState |
DiscreteState | verylow, low, normal, full | |
ClosureState |
ContinuousState | [0..100] | |
DiscreteRSSILevelState |
DiscreteState | good, low, normal, verylow | |
EnOceanHVACControlModeState |
DiscreteState | temperatureControl, valvePositionControl | |
EnergyHarvesterState |
DiscreteState | active, inactive | |
OpenClosedState |
DiscreteState | open, closed | |
OpenClosedValveState |
DiscreteState | open, closed | |
RSSILevelState |
ContinuousState | ||
StatusState |
DiscreteState | available, unavailable | |
SummerModeState |
DiscreteState | off, on | |
TargetTemperatureState |
ContinuousState | [12.0..30.0] | |
TargetValvePositionState |
ContinuousState | ||
ValvePositionState |
ContinuousState | [0..100] |
HeatingSystem/ValveHeatingTemperatureInterface (ACTUATOR) — 11 commands, 13 states
Type IDs: 181556874313784 | Servers: rexel, somfy_europe | Controllable: enocean:EnOceanCaleffiValveComponent | Profiles: StatefulCloseableValve, StatefulBasicCloseable, BasicCloseable, StatefulThermostat, Thermostat, StatefulBasicOpenClose, BasicOpenClose
Commands
| Command | Parameters | Notes |
|---|---|---|
activateSummerMode |
activate the summer mode, less energy consumption | |
close |
Fully close the device | |
closeValve |
Fully close the valve | |
deactivateSummerMode |
Deactivate the summer mode, more energy consumption | |
open |
Fully open the device | |
openValve |
Fully open the valve | |
setClosure |
INT [0..100] | Closure level (100%=fully close, 0%=open) |
setTargetTemperature |
FLOAT [0.0..100.0] | Set the new air temperature to reach |
setTargetTemperatureValue |
FLOAT [0.0..100.0] | Set the new temperature to reach |
setTargetTemperatureWithExternalMeasure |
FLOAT [0.0..100.0]; FLOAT [0.0..100.0] | Set the new temperature to reach indicating an external temperature measure |
setValvePosition |
INT [0..100] | Valve position (100%=fully closed, 0%=opened) |
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
BatteryState |
DiscreteState | verylow, low, normal, full | |
ClosureState |
ContinuousState | [0..100] | |
DiscreteRSSILevelState |
DiscreteState | good, low, normal, verylow | |
EnOceanHVACControlModeState |
DiscreteState | temperatureControl, valvePositionControl | |
EnergyHarvesterState |
DiscreteState | active, inactive | |
OpenClosedState |
DiscreteState | open, closed | |
OpenClosedValveState |
DiscreteState | open, closed | |
RSSILevelState |
ContinuousState | ||
StatusState |
DiscreteState | available, unavailable | |
SummerModeState |
DiscreteState | off, on | |
TargetTemperatureState |
ContinuousState | [12.0..30.0] | |
TargetValvePositionState |
ContinuousState | ||
ValvePositionState |
ContinuousState | [0..100] |
HeatingSystem/ValveHeatingTemperatureInterface (ACTUATOR) — 9 commands, 12 states
Type IDs: 181556874313801, 181556874444800, 181556874444873 | Servers: rexel, somfy_europe | Controllable: enocean:EnOceanMicroPeltValveComponent | Profiles: StatefulCloseableValve, StatefulBasicCloseable, BasicCloseable, StatefulBasicOpenClose, BasicOpenClose
Commands
| Command | Parameters | Notes |
|---|---|---|
activateSummerMode |
activate the summer mode, less energy consumption | |
close |
Fully close the device | |
closeValve |
Fully close the valve | |
deactivateSummerMode |
Deactivate the summer mode, more energy consumption | |
open |
Fully open the device | |
openValve |
Fully open the valve | |
repeatTargetValvePosition |
Repeat the last target position to the valve (this action will keep the valve alive) | |
setClosure |
INT [0..100] | Closure level (100%=fully close, 0%=open) |
setValvePosition |
INT [0..100] | Valve position (100%=fully closed, 0%=opened) |
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
BatteryState |
DiscreteState | verylow, low, normal, full | |
ClosureState |
ContinuousState | [0..100] | |
DiscreteRSSILevelState |
DiscreteState | good, low, normal, verylow | |
EnOceanHVACControlModeState |
DiscreteState | temperatureControl, valvePositionControl | |
EnergyHarvesterState |
DiscreteState | active, inactive | |
OpenClosedState |
DiscreteState | open, closed | |
OpenClosedValveState |
DiscreteState | open, closed | |
RSSILevelState |
ContinuousState | ||
StatusState |
DiscreteState | available, unavailable | |
SummerModeState |
DiscreteState | off, on | |
TargetValvePositionState |
ContinuousState | ||
ValvePositionState |
ContinuousState | [0..100] |
HeatingSystem/ValveHeatingTemperatureInterface (ACTUATOR) — 18 commands, 18 states
Type IDs: 181556874379337 | Servers: rexel, somfy_europe | Controllable: enocean:EnOceanMicroPeltValveV2WithRemoteCommissioningComponent | Profiles: StatefulCloseableValve, StatefulBasicCloseable, BasicCloseable, StatefulThermostat, Thermostat, StatefulBasicOpenClose, BasicOpenClose
Commands
| Command | Parameters | Notes |
|---|---|---|
activateSummerMode |
activate the summer mode, less energy consumption | |
addGatewayLink |
add the gateway to list of the linked devices. @Deprecated : use linkGateway | |
close |
Fully close the device | |
closeValve |
Fully close the valve | |
deactivateSummerMode |
Deactivate the summer mode, more energy consumption | |
linkGateway |
The command linkGateway will allow the gateway to control the "target" device. If a gateway is linked, the product can be controlled by using Overkiz server's. By default, the gateway is not linked to the "target" device. | |
open |
Fully open the device | |
openValve |
Fully open the valve | |
removeGatewayLink |
remove the gateway from the list of the link devices.@Deprecated : use unlinkGateway | |
repeatTargetValvePosition |
Repeat the last target position to the valve (this action will keep the valve alive) | |
setClosure |
INT [0..100] | Closure level (100%=fully close, 0%=open) |
setExternalReferenceTemperature |
FLOAT [0.0..100.0] | Set the reference temperature (get from an external sensor) |
setKey |
INT [1..4294967295] | set the key of the product. |
setKeyWithOldOne |
INT [1..4294967295]; INT [1..4294967295] | set the key of the product. p1 : new key, p2 : old key |
setTargetTemperature |
FLOAT [0.0..100.0] | Set the new air temperature to reach |
setTargetTemperatureValue |
FLOAT [0.0..100.0] | Set the new temperature to reach |
setValvePosition |
INT [0..100] | Valve position (100%=fully closed, 0%=opened) |
unlinkGateway |
The command unlinkGateway will forbid the gateway to control the "target" device. If a gateway is not linked, the product can not be controlled by using Overkiz server's. By default, the gateway is not linked to the "target" device. |
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
BatteryState |
DiscreteState | verylow, low, normal, full | |
ClosureState |
ContinuousState | [0..100] | |
DiscreteRSSILevelState |
DiscreteState | good, low, normal, verylow | |
EnOceanHVACControlModeState |
DiscreteState | temperatureControl, valvePositionControl | |
EnergyHarvesterState |
DiscreteState | active, inactive | |
ExternalReferenceTemperatureState |
ContinuousState | ||
OpenClosedState |
DiscreteState | open, closed | |
OpenClosedValveState |
DiscreteState | open, closed | |
RSSILevelState |
ContinuousState | ||
RemoteCommissioningDeviceKeyState |
DataState | ||
RemoteCommissioningLastExecutionStatusState |
DataState | ||
RemoteCommissioningLinkedDevicesState |
DataState | ||
RemoteCommissioningLinkedGatewayState |
DataState | ||
StatusState |
DiscreteState | available, unavailable | |
SummerModeState |
DiscreteState | off, on | |
TargetTemperatureState |
ContinuousState | [12.0..30.0] | |
TargetValvePositionState |
ContinuousState | ||
ValvePositionState |
ContinuousState | [0..100] |
HeatingSystem/ValveHeatingTemperatureInterface (ACTUATOR) — 27 commands, 18 states
Type IDs: 181556874379362 | Servers: rexel, somfy_europe | Controllable: enocean:EnOceanPMDMValveWithRemoteCommissioning | Profiles: StatefulCloseableValve, StatefulBasicCloseable, BasicCloseable, StatefulThermostat, Thermostat, StatefulBasicOpenClose, BasicOpenClose
Commands
| Command | Parameters | Notes |
|---|---|---|
activateSummerMode |
activate the summer mode, less energy consumption | |
addDevicesLink |
OBJECT | Add a link between your device and the devices (one or more) that will control it. @Deprecated : use addLinkedDevices |
addGatewayLink |
add the gateway to list of the linked devices. @Deprecated : use linkGateway | |
addLinkedDevices |
OBJECT | The command addLinkedDevices will add a link between your "target" device and another "source" devices (one or more) that will control your "target" device. |
clearAllLinkedDevices |
Clear all devices linked before. @Deprecated: use unlinkAllDevices | |
close |
Fully close the device | |
closeValve |
Fully close the valve | |
deactivateSummerMode |
Deactivate the summer mode, more energy consumption | |
linkGateway |
The command linkGateway will allow the gateway to control the "target" device. If a gateway is linked, the product can be controlled by using Overkiz server's. By default, the gateway is not linked to the "target" device. | |
open |
Fully open the device | |
openValve |
Fully open the valve | |
removeDeviceLink |
INT | remove a device to the list of the devices linked by the remote commissioning. Address of the device to remove is the parameter. @Deprecated : use removeLinkedDevice |
removeGatewayLink |
remove the gateway from the list of the link devices.@Deprecated : use unlinkGateway | |
removeLinkedDevice |
STRING | The command removeLinkedDevice will remove the device linked before with the command setLinkedDevices or addLinkedDevices.This command can remove only 1 device. p1 : the deviceURL you want to delete. |
repeatTargetValvePosition |
Repeat the last target position to the valve (this action will keep the valve alive) | |
setClosure |
INT [0..100] | Closure level (100%=fully close, 0%=open) |
setKey |
INT [1..4294967295] | set the key of the product. |
setKeyWithOldOne |
INT [1..4294967295]; INT [1..4294967295] | set the key of the product. p1 : new key, p2 : old key |
setLinkedDevices |
ARRAY | The command setLinkedDevices will set a link between a "target" device, and one or more "source" devices that will control your "target" device. The links are described in a JSON (p1). All existing links already set in the "target" will be erased. |
setLinks |
OBJECT | Set a link between your device and the devices (one or more) that will control it. All existing links already set in the target will be erase. @Deprecated: use setLinkedDevices |
setTargetTemperature |
FLOAT [0.0..100.0] | Set the new air temperature to reach |
setTargetTemperatureValue |
FLOAT [0.0..100.0] | Set the new temperature to reach |
setValvePosition |
INT [0..100] | Valve position (100%=fully closed, 0%=opened) |
unlinkAllDevices |
The command unlinkAllDevices will clear all "source" devices linked before to this device. | |
unlinkGateway |
The command unlinkGateway will forbid the gateway to control the "target" device. If a gateway is not linked, the product can not be controlled by using Overkiz server's. By default, the gateway is not linked to the "target" device. | |
updateLinkedDevices |
ARRAY | The command updateLinkedDevices will set a link between a "target" device, and one or more "source" devices that will control your "target" device. The links are described in a JSON (p1). Only the different links will be updated. Full configuration will be resent when ; - some devices are removed only - same devices but with different configurations - previous configuration has failed - no configuration has been sent yet Only differences will be sent when : - some devices are added only An error with NO_ACTION code will be returned if configuration is exactly the same. |
updateLinks |
OBJECT | Link given devices to current device using remote commissioning and comparing to existing configuration as follow : Full configuration will be resent when ; - some devices are removed only - same devices but with different configurations - previous configuration has failed - no configuration has been sent yet Only differences will be sent when : - some devices are added only An error with NO_ACTION code will be returned if configuration is exactly the same. @Deprecated : use updateLinkedDevices |
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
BatteryState |
DiscreteState | verylow, low, normal, full | |
ClosureState |
ContinuousState | [0..100] | |
DiscreteRSSILevelState |
DiscreteState | good, low, normal, verylow | |
EnOceanHVACControlModeState |
DiscreteState | temperatureControl, valvePositionControl | |
EnergyHarvesterState |
DiscreteState | active, inactive | |
OpenClosedState |
DiscreteState | open, closed | |
OpenClosedValveState |
DiscreteState | open, closed | |
RSSILevelState |
ContinuousState | ||
RemoteCommissioningDeviceKeyState |
DataState | ||
RemoteCommissioningDevicesState |
DataState | ||
RemoteCommissioningLastExecutionStatusState |
DataState | ||
RemoteCommissioningLinkedDevicesState |
DataState | ||
RemoteCommissioningLinkedGatewayState |
DataState | ||
StatusState |
DiscreteState | available, unavailable | |
SummerModeState |
DiscreteState | off, on | |
TargetTemperatureState |
ContinuousState | [12.0..30.0] | |
TargetValvePositionState |
ContinuousState | ||
ValvePositionState |
ContinuousState | [0..100] |
HeatingSystem/ValveHeatingTemperatureInterface (ACTUATOR) — 17 commands, 17 states
Type IDs: 181556874379370, 181556958265450 | Servers: rexel, somfy_europe | Controllable: enocean:EnOceanMicroPeltValveWithRemoteCommissioningComponent | Profiles: StatefulCloseableValve, StatefulBasicCloseable, BasicCloseable, StatefulThermostat, Thermostat, StatefulBasicOpenClose, BasicOpenClose
Commands
| Command | Parameters | Notes |
|---|---|---|
activateSummerMode |
activate the summer mode, less energy consumption | |
addGatewayLink |
add the gateway to list of the linked devices. @Deprecated : use linkGateway | |
close |
Fully close the device | |
closeValve |
Fully close the valve | |
deactivateSummerMode |
Deactivate the summer mode, more energy consumption | |
linkGateway |
The command linkGateway will allow the gateway to control the "target" device. If a gateway is linked, the product can be controlled by using Overkiz server's. By default, the gateway is not linked to the "target" device. | |
open |
Fully open the device | |
openValve |
Fully open the valve | |
removeGatewayLink |
remove the gateway from the list of the link devices.@Deprecated : use unlinkGateway | |
repeatTargetValvePosition |
Repeat the last target position to the valve (this action will keep the valve alive) | |
setClosure |
INT [0..100] | Closure level (100%=fully close, 0%=open) |
setKey |
INT [1..4294967295] | set the key of the product. |
setKeyWithOldOne |
INT [1..4294967295]; INT [1..4294967295] | set the key of the product. p1 : new key, p2 : old key |
setTargetTemperature |
FLOAT [0.0..100.0] | Set the new air temperature to reach |
setTargetTemperatureValue |
FLOAT [0.0..100.0] | Set the new temperature to reach |
setValvePosition |
INT [0..100] | Valve position (100%=fully closed, 0%=opened) |
unlinkGateway |
The command unlinkGateway will forbid the gateway to control the "target" device. If a gateway is not linked, the product can not be controlled by using Overkiz server's. By default, the gateway is not linked to the "target" device. |
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
BatteryState |
DiscreteState | verylow, low, normal, full | |
ClosureState |
ContinuousState | [0..100] | |
DiscreteRSSILevelState |
DiscreteState | good, low, normal, verylow | |
EnOceanHVACControlModeState |
DiscreteState | temperatureControl, valvePositionControl | |
EnergyHarvesterState |
DiscreteState | active, inactive | |
OpenClosedState |
DiscreteState | open, closed | |
OpenClosedValveState |
DiscreteState | open, closed | |
RSSILevelState |
ContinuousState | ||
RemoteCommissioningDeviceKeyState |
DataState | ||
RemoteCommissioningLastExecutionStatusState |
DataState | ||
RemoteCommissioningLinkedDevicesState |
DataState | ||
RemoteCommissioningLinkedGatewayState |
DataState | ||
StatusState |
DiscreteState | available, unavailable | |
SummerModeState |
DiscreteState | off, on | |
TargetTemperatureState |
ContinuousState | [12.0..30.0] | |
TargetValvePositionState |
ContinuousState | ||
ValvePositionState |
ContinuousState | [0..100] |
HeatingSystem/ValveHeatingTemperatureInterface (ACTUATOR) — 11 commands, 13 states
Type IDs: 181556958199808, 181556958199914 | Servers: rexel, somfy_europe | Controllable: enocean:EnOceanHarvestingPoweredMicroPeltValveComponent | Profiles: StatefulCloseableValve, StatefulBasicCloseable, BasicCloseable, StatefulThermostat, Thermostat, StatefulBasicOpenClose, BasicOpenClose
Commands
| Command | Parameters | Notes |
|---|---|---|
activateSummerMode |
activate the summer mode, less energy consumption | |
close |
Fully close the device | |
closeValve |
Fully close the valve | |
deactivateSummerMode |
Deactivate the summer mode, more energy consumption | |
open |
Fully open the device | |
openValve |
Fully open the valve | |
repeatTargetValvePosition |
Repeat the last target position to the valve (this action will keep the valve alive) | |
setClosure |
INT [0..100] | Closure level (100%=fully close, 0%=open) |
setTargetTemperature |
FLOAT [0.0..100.0] | Set the new air temperature to reach |
setTargetTemperatureValue |
FLOAT [0.0..100.0] | Set the new temperature to reach |
setValvePosition |
INT [0..100] | Valve position (100%=fully closed, 0%=opened) |
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
BatteryState |
DiscreteState | verylow, low, normal, full | |
ClosureState |
ContinuousState | [0..100] | |
DiscreteRSSILevelState |
DiscreteState | good, low, normal, verylow | |
EnOceanHVACControlModeState |
DiscreteState | temperatureControl, valvePositionControl | |
EnergyHarvesterState |
DiscreteState | active, inactive | |
OpenClosedState |
DiscreteState | open, closed | |
OpenClosedValveState |
DiscreteState | open, closed | |
RSSILevelState |
ContinuousState | ||
StatusState |
DiscreteState | available, unavailable | |
SummerModeState |
DiscreteState | off, on | |
TargetTemperatureState |
ContinuousState | [12.0..30.0] | |
TargetValvePositionState |
ContinuousState | ||
ValvePositionState |
ContinuousState | [0..100] |
HeatingSystem/OnOffHeatingSystem (ACTUATOR) — 7 commands, 5 states
Type IDs: 230901753643008, 230901871018021 | Servers: rexel, somfy_europe | Controllable: enocean:EnOceanOnOffHeatingSystemComponent | Profiles: StatefulSwitchableHeating, StatefulSwitchable, Switchable
Commands
| Command | Parameters | Notes |
|---|---|---|
activateLocalControl |
Enable the local control | |
deactivateLocalControl |
Disable the local control | |
off |
Turn off the device | |
on |
Turn on the device | |
onWithTimer |
INT [5..14400] | Turn the device on for a given amount of seconds then turn it off |
refreshStatus |
Refresh the status of the device | |
setOnOff |
STRING: off, on | Turn the device on or off |
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
DiscreteRSSILevelState |
DiscreteState | good, low, normal, verylow | |
LocalControlState |
DiscreteState | off, on | |
OnOffState |
DiscreteState | on, off | |
RSSILevelState |
ContinuousState | ||
StatusState |
DiscreteState | available, unavailable |
HeatingSystem/OnOffHeatingSystem (ACTUATOR) — 13 commands, 10 states
Type IDs: 230901753643119 | Servers: rexel, somfy_europe | Controllable: enocean:EnOceanOnOffHeatingSystemComponentWithReCom | Profiles: StatefulSwitchableHeating, StatefulSwitchable, Switchable
Commands
| Command | Parameters | Notes |
|---|---|---|
activateLocalControl |
Enable the local control | |
deactivateLocalControl |
Disable the local control | |
linkGateway |
The command linkGateway will allow the gateway to control the "target" device. If a gateway is linked, the product can be controlled by using Overkiz server's. By default, the gateway is not linked to the "target" device. | |
off |
Turn off the device | |
on |
Turn on the device | |
onWithTimer |
INT [5..14400] | Turn the device on for a given amount of seconds then turn it off |
refreshStatus |
Refresh the status of the device | |
setKey |
INT [1..4294967295] | set the key of the product. |
setKeyWithOldOne |
INT [1..4294967295]; INT [1..4294967295] | set the key of the product. p1 : new key, p2 : old key |
setLinkedDevices |
ARRAY | The command setLinkedDevices will set a link between a "target" device, and one or more "source" devices that will control your "target" device. The links are described in a JSON (p1). All existing links already set in the "target" will be erased. |
setOnOff |
STRING: off, on | Turn the device on or off |
unlinkAllDevices |
The command unlinkAllDevices will clear all "source" devices linked before to this device. | |
unlinkGateway |
The command unlinkGateway will forbid the gateway to control the "target" device. If a gateway is not linked, the product can not be controlled by using Overkiz server's. By default, the gateway is not linked to the "target" device. |
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
DiscreteRSSILevelState |
DiscreteState | good, low, normal, verylow | |
LocalControlState |
DiscreteState | off, on | |
OnOffState |
DiscreteState | on, off | |
RSSILevelState |
ContinuousState | ||
RemoteCommissioningDeviceKeyState |
DataState | ||
RemoteCommissioningDevicesState |
DataState | ||
RemoteCommissioningLastExecutionStatusState |
DataState | ||
RemoteCommissioningLinkedDevicesState |
DataState | ||
RemoteCommissioningLinkedGatewayState |
DataState | ||
StatusState |
DiscreteState | available, unavailable |
HeatingSystem/ElectricalHeater (ACTUATOR) — 6 commands, 6 states
Type IDs: 230901938126848 | Servers: rexel, somfy_europe | Controllable: enocean:EnOceanPilotWireComponent | Profiles: StatefulHeatingLevel, HeatingLevel
Commands
| Command | Parameters | Notes |
|---|---|---|
activateLocalControl |
Enable the local control | |
deactivateLocalControl |
Disable the local control | |
off |
Turn off the device | |
refreshHeatingLevel |
Refresh the heating level mode | |
refreshStatus |
Refresh the status of the device | |
setHeatingLevel |
STRING: off, comfort, eco, frostprotection, comfort-1 | Sets the device heating level mode |
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
DiscreteRSSILevelState |
DiscreteState | good, low, normal, verylow | |
LocalControlState |
DiscreteState | off, on | |
RSSILevelState |
ContinuousState | ||
StatusState |
DiscreteState | available, unavailable | |
TargetHeatingLevelState |
DiscreteState | comfort, comfort-1, comfort-2, eco, frostprotection | |
TargetHeatingLevelState |
DiscreteState | comfort, comfort-1, comfort-2, eco, frostprotection, off |
HeatingSystem/ElectricalHeater (ACTUATOR) — 12 commands, 11 states
Type IDs: 230901938192495 | Servers: rexel, somfy_europe | Controllable: enocean:EnOceanPilotWireComponentWithReCom | Profiles: StatefulHeatingLevel, HeatingLevel
Commands
| Command | Parameters | Notes |
|---|---|---|
activateLocalControl |
Enable the local control | |
deactivateLocalControl |
Disable the local control | |
linkGateway |
The command linkGateway will allow the gateway to control the "target" device. If a gateway is linked, the product can be controlled by using Overkiz server's. By default, the gateway is not linked to the "target" device. | |
off |
Turn off the device | |
refreshHeatingLevel |
Refresh the heating level mode | |
refreshStatus |
Refresh the status of the device | |
setHeatingLevel |
STRING: off, comfort, eco, frostprotection, comfort-1 | Sets the device heating level mode |
setKey |
INT [1..4294967295] | set the key of the product. |
setKeyWithOldOne |
INT [1..4294967295]; INT [1..4294967295] | set the key of the product. p1 : new key, p2 : old key |
setLinkedDevices |
ARRAY | The command setLinkedDevices will set a link between a "target" device, and one or more "source" devices that will control your "target" device. The links are described in a JSON (p1). All existing links already set in the "target" will be erased. |
unlinkAllDevices |
The command unlinkAllDevices will clear all "source" devices linked before to this device. | |
unlinkGateway |
The command unlinkGateway will forbid the gateway to control the "target" device. If a gateway is not linked, the product can not be controlled by using Overkiz server's. By default, the gateway is not linked to the "target" device. |
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
DiscreteRSSILevelState |
DiscreteState | good, low, normal, verylow | |
LocalControlState |
DiscreteState | off, on | |
RSSILevelState |
ContinuousState | ||
RemoteCommissioningDeviceKeyState |
DataState | ||
RemoteCommissioningDevicesState |
DataState | ||
RemoteCommissioningLastExecutionStatusState |
DataState | ||
RemoteCommissioningLinkedDevicesState |
DataState | ||
RemoteCommissioningLinkedGatewayState |
DataState | ||
StatusState |
DiscreteState | available, unavailable | |
TargetHeatingLevelState |
DiscreteState | comfort, comfort-1, comfort-2, eco, frostprotection | |
TargetHeatingLevelState |
DiscreteState | comfort, comfort-1, comfort-2, eco, frostprotection, off |
HumiditySensor/RelativeHumiditySensor (SENSOR) — 0 commands, 4 states
Type IDs: 462911591940096, 462911591940140, 462911591940166, 462911608717312, 462911608717325 | Servers: rexel, somfy_europe | Controllable: enocean:EnOceanHumiditySensor | Profiles: RelativeHumidity
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
DiscreteRSSILevelState |
DiscreteState | good, low, normal, verylow | |
RSSILevelState |
ContinuousState | ||
RelativeHumidityState |
ContinuousState | [0.0..100.0] | |
StatusState |
DiscreteState | available, unavailable |
Light/OnOffLight (ACTUATOR) — 3 commands, 1 states
Type IDs: 270492762243072 | Servers: rexel, somfy_europe | Controllable: enocean:EnOceanOnOffLight | Profiles: SwitchableLight, Switchable
Commands
| Command | Parameters | Notes |
|---|---|---|
off |
Turn off the device | |
on |
Turn on the device | |
onWithTimer |
INT [5..14400] | Turn the device on for a given amount of seconds then turn it off |
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
StatusState |
DiscreteState | available, unavailable |
NetworkComponent/Repeater (INFRASTRUCTURE_COMPONENT) — 4 commands, 4 states
Type IDs: 230901753643119, 230901871083631, 230901938192495, 230901988524143, 230902038855791, 230918916735087 | Servers: rexel, somfy_europe | Controllable: enocean:EnOceanNativeRepeaterComponent | Profiles: Specific
Commands
| Command | Parameters | Notes |
|---|---|---|
activateRepeaterLevel1 |
Activate the repeater mode level 1 | |
activateRepeaterLevel2 |
Activate the repeater mode level 2 | |
deactivateRepeater |
Deactivate the repeater mode | |
getRepeaterStatusQuery |
Get the repeater status |
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
DiscreteRSSILevelState |
DiscreteState | good, low, normal, verylow | |
RSSILevelState |
ContinuousState | ||
RepeaterLevelState |
DiscreteState | level1, level2, off | |
StatusState |
DiscreteState | available, unavailable |
NetworkComponent/Repeater (INFRASTRUCTURE_COMPONENT) — 3 commands, 4 states
Type IDs: 230901988458566, 230901988524102, 230902038790214, 230902038855750, 230918916669510 | Servers: rexel, somfy_europe | Controllable: enocean:EnOceanRepeaterComponent | Profiles: Specific
Commands
| Command | Parameters | Notes |
|---|---|---|
activateRepeaterLevel1 |
Activate the repeater mode level 1 | |
activateRepeaterLevel2 |
Activate the repeater mode level 2 | |
deactivateRepeater |
Deactivate the repeater mode |
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
DiscreteRSSILevelState |
DiscreteState | good, low, normal, verylow | |
RSSILevelState |
ContinuousState | ||
RepeaterLevelState |
DiscreteState | level1, level2, off | |
StatusState |
DiscreteState | available, unavailable |
OnOff/StatefulOnOff (ACTUATOR) — 5 commands, 4 states
Type IDs: 230901753577472 | Servers: rexel, somfy_europe | Controllable: enocean:EnOceanSwitchOnOffType1 | Profiles: StatefulSwitchablePlug, StatefulSwitchable, Switchable
Commands
| Command | Parameters | Notes |
|---|---|---|
off |
Turn off the device | |
on |
Turn on the device | |
onWithTimer |
INT [5..14400] | Turn the device on for a given amount of seconds then turn it off |
refreshStatus |
Refresh the status of the device | |
setOnOff |
STRING: off, on | Turn the device on or off |
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
DiscreteRSSILevelState |
DiscreteState | good, low, normal, verylow | |
OnOffState |
DiscreteState | on, off | |
RSSILevelState |
ContinuousState | ||
StatusState |
DiscreteState | available, unavailable |
OnOff/StatefulOnOff (ACTUATOR) — 15 commands, 10 states
Type IDs: 230901871017984 | Servers: rexel, somfy_europe | Controllable: enocean:EnOceanSwitchOnOffType8 | Profiles: StatefulSwitchablePlug, StatefulSwitchable, Switchable
Commands
| Command | Parameters | Notes |
|---|---|---|
activateContextSavingOnPowerCut |
Activate last device state saving on power cut | |
activateLocalControl |
Enable the local control | |
activateNightMode |
Activate the Night Mode (example : switch off the local LED) | |
activatePowerFailureDetection |
Activate the power failure detection | |
deactivateContextSavingOnPowerCut |
Deactivate last device state saving on power cut | |
deactivateLocalControl |
Disable the local control | |
deactivateNightMode |
Deactivate the night mode (example : switch on the local LED) | |
deactivatePowerFailureDetection |
Deactivate the power failure detection | |
off |
Turn off the device | |
on |
Turn on the device | |
onWithTimer |
INT [5..14400] | Turn the device on for a given amount of seconds then turn it off |
refreshStatus |
Refresh the status of the device | |
setContextSavingOnPowerCut |
STRING: off, on | Activate (on) or deactivate (off) last device state saving on power cut |
setDefaultOnOffState |
STRING: on, off | set the Default Output State |
setOnOff |
STRING: off, on | Turn the device on or off |
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
ContextSavingOnPowerCutState |
DiscreteState | off, on | |
DefaultOnOffState |
DiscreteState | off, on, previous, togglePrevious, unknown | |
DiscreteRSSILevelState |
DiscreteState | good, low, normal, verylow | |
LocalControlState |
DiscreteState | off, on | |
NightModeState |
DiscreteState | off, on | |
OnOffState |
DiscreteState | on, off | |
PowerFailureDetectionState |
DiscreteState | off, on | |
PowerFailureState |
DiscreteState | detected, notDetected | |
RSSILevelState |
ContinuousState | ||
StatusState |
DiscreteState | available, unavailable |
OnOff/StatefulOnOff (ACTUATOR) — 21 commands, 15 states
Type IDs: 230901871083631 | Servers: rexel, somfy_europe | Controllable: enocean:EnOceanSwitchOnOffType8WithReCom | Profiles: StatefulSwitchablePlug, StatefulSwitchable, Switchable
Commands
| Command | Parameters | Notes |
|---|---|---|
activateContextSavingOnPowerCut |
Activate last device state saving on power cut | |
activateLocalControl |
Enable the local control | |
activateNightMode |
Activate the Night Mode (example : switch off the local LED) | |
activatePowerFailureDetection |
Activate the power failure detection | |
deactivateContextSavingOnPowerCut |
Deactivate last device state saving on power cut | |
deactivateLocalControl |
Disable the local control | |
deactivateNightMode |
Deactivate the night mode (example : switch on the local LED) | |
deactivatePowerFailureDetection |
Deactivate the power failure detection | |
linkGateway |
The command linkGateway will allow the gateway to control the "target" device. If a gateway is linked, the product can be controlled by using Overkiz server's. By default, the gateway is not linked to the "target" device. | |
off |
Turn off the device | |
on |
Turn on the device | |
onWithTimer |
INT [5..14400] | Turn the device on for a given amount of seconds then turn it off |
refreshStatus |
Refresh the status of the device | |
setContextSavingOnPowerCut |
STRING: off, on | Activate (on) or deactivate (off) last device state saving on power cut |
setDefaultOnOffState |
STRING: on, off | set the Default Output State |
setKey |
INT [1..4294967295] | set the key of the product. |
setKeyWithOldOne |
INT [1..4294967295]; INT [1..4294967295] | set the key of the product. p1 : new key, p2 : old key |
setLinkedDevices |
ARRAY | The command setLinkedDevices will set a link between a "target" device, and one or more "source" devices that will control your "target" device. The links are described in a JSON (p1). All existing links already set in the "target" will be erased. |
setOnOff |
STRING: off, on | Turn the device on or off |
unlinkAllDevices |
The command unlinkAllDevices will clear all "source" devices linked before to this device. | |
unlinkGateway |
The command unlinkGateway will forbid the gateway to control the "target" device. If a gateway is not linked, the product can not be controlled by using Overkiz server's. By default, the gateway is not linked to the "target" device. |
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
ContextSavingOnPowerCutState |
DiscreteState | off, on | |
DefaultOnOffState |
DiscreteState | off, on, previous, togglePrevious, unknown | |
DiscreteRSSILevelState |
DiscreteState | good, low, normal, verylow | |
LocalControlState |
DiscreteState | off, on | |
NightModeState |
DiscreteState | off, on | |
OnOffState |
DiscreteState | on, off | |
PowerFailureDetectionState |
DiscreteState | off, on | |
PowerFailureState |
DiscreteState | detected, notDetected | |
RSSILevelState |
ContinuousState | ||
RemoteCommissioningDeviceKeyState |
DataState | ||
RemoteCommissioningDevicesState |
DataState | ||
RemoteCommissioningLastExecutionStatusState |
DataState | ||
RemoteCommissioningLinkedDevicesState |
DataState | ||
RemoteCommissioningLinkedGatewayState |
DataState | ||
StatusState |
DiscreteState | available, unavailable |
OnOff/StatefulOnOff (ACTUATOR) — 16 commands, 10 states
Type IDs: 230901971681350 | Servers: rexel, somfy_europe | Controllable: enocean:EnOceanSwitchOnOffTypeE | Profiles: StatefulSwitchablePlug, StatefulSwitchable, Switchable
Commands
| Command | Parameters | Notes |
|---|---|---|
activateContextSavingOnPowerCut |
Activate last device state saving on power cut | |
activateLocalControl |
Enable the local control | |
activateNightMode |
Activate the Night Mode (example : switch off the local LED) | |
activateTaughtInDevices |
Enable taught-in devices (with different EEP) | |
deactivateContextSavingOnPowerCut |
Deactivate last device state saving on power cut | |
deactivateLocalControl |
Disable the local control | |
deactivateNightMode |
Deactivate the night mode (example : switch on the local LED) | |
deactivateTaughtInDevices |
Disable taught-in devices (with different EEP) | |
off |
Turn off the device | |
on |
Turn on the device | |
onWithTimer |
INT [5..14400] | Turn the device on for a given amount of seconds then turn it off |
refreshStatus |
Refresh the status of the device | |
setContextSavingOnPowerCut |
STRING: off, on | Activate (on) or deactivate (off) last device state saving on power cut |
setDefaultOnOffState |
STRING: on, off | set the Default Output State |
setOnOff |
STRING: off, on | Turn the device on or off |
setTaughtInDevices |
STRING: enabled, disabled | Enable/Disable taught-in devices (with different EEP) |
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
ContextSavingOnPowerCutState |
DiscreteState | off, on | |
DefaultOnOffState |
DiscreteState | off, on, previous, togglePrevious, unknown | |
DiscreteRSSILevelState |
DiscreteState | good, low, normal, verylow | |
LocalControlState |
DiscreteState | off, on | |
NightModeState |
DiscreteState | off, on | |
OnOffState |
DiscreteState | on, off | |
PowerFailureState |
DiscreteState | detected, notDetected | |
RSSILevelState |
ContinuousState | ||
StatusState |
DiscreteState | available, unavailable | |
TaughInDevicesState |
DiscreteState | disabled, enabled |
OnOff/StatefulOnOff (ACTUATOR) — 17 commands, 11 states
Type IDs: 230901988458496, 230901988458566, 230901988458607, 230902038790144, 230902038790214, 230902038790255, 230902038790259, 230902038855795 | Servers: rexel, somfy_europe | Controllable: enocean:EnOceanSwitchOnOffTypeF | Profiles: StatefulSwitchablePlug, StatefulSwitchable, Switchable
Commands
| Command | Parameters | Notes |
|---|---|---|
activateContextSavingOnPowerCut |
Activate last device state saving on power cut | |
activateLocalControl |
Enable the local control | |
activateNightMode |
Activate the Night Mode (example : switch off the local LED) | |
deactivateContextSavingOnPowerCut |
Deactivate last device state saving on power cut | |
deactivateLocalControl |
Disable the local control | |
deactivateNightMode |
Deactivate the night mode (example : switch on the local LED) | |
off |
Turn off the device | |
on |
Turn on the device | |
onWithTimer |
INT [5..14400] | Turn the device on for a given amount of seconds then turn it off |
refreshExternalInterfaceSettings |
Refresh external interface settings | |
refreshStatus |
Refresh the status of the device | |
setAutoOffTimer |
FLOAT [0.0..6553.4] | time in second - Timer To automatically set OFF output channel when it is set ON. Value 0 mean timer desactivated |
setContextSavingOnPowerCut |
STRING: off, on | Activate (on) or deactivate (off) last device state saving on power cut |
setDefaultOnOffState |
STRING: on, off | set the Default Output State |
setDelayOffTimer |
FLOAT [0.0..6553.4] | time in second - Delay timer before setting output channel to OFF value received by radio command. Value 0 mean timer desactivated |
setExternalInterfaceMode |
STRING: autoDetection, externalPushButton, externalSwitch, notApplicable | set external interface type : mono-stable or bistable switch |
setOnOff |
STRING: off, on | Turn the device on or off |
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
AutoOffTimerState |
ContinuousState | ||
ContextSavingOnPowerCutState |
DiscreteState | off, on | |
DefaultOnOffState |
DiscreteState | off, on, previous, togglePrevious, unknown | |
DelayOffTimerState |
ContinuousState | ||
DiscreteRSSILevelState |
DiscreteState | good, low, normal, verylow | |
LocalControlState |
DiscreteState | off, on | |
NightModeState |
DiscreteState | off, on | |
OnOffState |
DiscreteState | on, off | |
RSSILevelState |
ContinuousState | ||
StatusState |
DiscreteState | available, unavailable | |
SwitchExternalInterfaceState |
DiscreteState | autoDetection, externalPushButton, externalSwitch, notApplicable |
OnOff/StatefulOnOff (ACTUATOR) — 33 commands, 16 states
Type IDs: 230901988524102, 230902038855750 | Servers: rexel, somfy_europe | Controllable: enocean:EnOceanSwitchOnOffTypeFWithRemoteCommissioning | Profiles: StatefulSwitchablePlug, StatefulSwitchable, Switchable
Commands
| Command | Parameters | Notes |
|---|---|---|
activateContextSavingOnPowerCut |
Activate last device state saving on power cut | |
activateLocalControl |
Enable the local control | |
activateNightMode |
Activate the Night Mode (example : switch off the local LED) | |
addDevicesLink |
OBJECT | Add a link between your device and the devices (one or more) that will control it. @Deprecated : use addLinkedDevices |
addGatewayLink |
add the gateway to list of the linked devices. @Deprecated : use linkGateway | |
addLinkedDevices |
OBJECT | The command addLinkedDevices will add a link between your "target" device and another "source" devices (one or more) that will control your "target" device. |
clearAllLinkedDevices |
Clear all devices linked before. @Deprecated: use unlinkAllDevices | |
deactivateContextSavingOnPowerCut |
Deactivate last device state saving on power cut | |
deactivateLocalControl |
Disable the local control | |
deactivateNightMode |
Deactivate the night mode (example : switch on the local LED) | |
linkGateway |
The command linkGateway will allow the gateway to control the "target" device. If a gateway is linked, the product can be controlled by using Overkiz server's. By default, the gateway is not linked to the "target" device. | |
off |
Turn off the device | |
on |
Turn on the device | |
onWithTimer |
INT [5..14400] | Turn the device on for a given amount of seconds then turn it off |
refreshExternalInterfaceSettings |
Refresh external interface settings | |
refreshStatus |
Refresh the status of the device | |
removeDeviceLink |
INT | remove a device to the list of the devices linked by the remote commissioning. Address of the device to remove is the parameter. @Deprecated : use removeLinkedDevice |
removeGatewayLink |
remove the gateway from the list of the link devices.@Deprecated : use unlinkGateway | |
removeLinkedDevice |
STRING | The command removeLinkedDevice will remove the device linked before with the command setLinkedDevices or addLinkedDevices.This command can remove only 1 device. p1 : the deviceURL you want to delete. |
setAutoOffTimer |
FLOAT [0.0..6553.4] | time in second - Timer To automatically set OFF output channel when it is set ON. Value 0 mean timer desactivated |
setContextSavingOnPowerCut |
STRING: off, on | Activate (on) or deactivate (off) last device state saving on power cut |
setDefaultOnOffState |
STRING: on, off | set the Default Output State |
setDelayOffTimer |
FLOAT [0.0..6553.4] | time in second - Delay timer before setting output channel to OFF value received by radio command. Value 0 mean timer desactivated |
setExternalInterfaceMode |
STRING: autoDetection, externalPushButton, externalSwitch, notApplicable | set external interface type : mono-stable or bistable switch |
setKey |
INT [1..4294967295] | set the key of the product. |
setKeyWithOldOne |
INT [1..4294967295]; INT [1..4294967295] | set the key of the product. p1 : new key, p2 : old key |
setLinkedDevices |
ARRAY | The command setLinkedDevices will set a link between a "target" device, and one or more "source" devices that will control your "target" device. The links are described in a JSON (p1). All existing links already set in the "target" will be erased. |
setLinks |
OBJECT | Set a link between your device and the devices (one or more) that will control it. All existing links already set in the target will be erase. @Deprecated: use setLinkedDevices |
setOnOff |
STRING: off, on | Turn the device on or off |
unlinkAllDevices |
The command unlinkAllDevices will clear all "source" devices linked before to this device. | |
unlinkGateway |
The command unlinkGateway will forbid the gateway to control the "target" device. If a gateway is not linked, the product can not be controlled by using Overkiz server's. By default, the gateway is not linked to the "target" device. | |
updateLinkedDevices |
ARRAY | The command updateLinkedDevices will set a link between a "target" device, and one or more "source" devices that will control your "target" device. The links are described in a JSON (p1). Only the different links will be updated. Full configuration will be resent when ; - some devices are removed only - same devices but with different configurations - previous configuration has failed - no configuration has been sent yet Only differences will be sent when : - some devices are added only An error with NO_ACTION code will be returned if configuration is exactly the same. |
updateLinks |
OBJECT | Link given devices to current device using remote commissioning and comparing to existing configuration as follow : Full configuration will be resent when ; - some devices are removed only - same devices but with different configurations - previous configuration has failed - no configuration has been sent yet Only differences will be sent when : - some devices are added only An error with NO_ACTION code will be returned if configuration is exactly the same. @Deprecated : use updateLinkedDevices |
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
AutoOffTimerState |
ContinuousState | ||
ContextSavingOnPowerCutState |
DiscreteState | off, on | |
DefaultOnOffState |
DiscreteState | off, on, previous, togglePrevious, unknown | |
DelayOffTimerState |
ContinuousState | ||
DiscreteRSSILevelState |
DiscreteState | good, low, normal, verylow | |
LocalControlState |
DiscreteState | off, on | |
NightModeState |
DiscreteState | off, on | |
OnOffState |
DiscreteState | on, off | |
RSSILevelState |
ContinuousState | ||
RemoteCommissioningDeviceKeyState |
DataState | ||
RemoteCommissioningDevicesState |
DataState | ||
RemoteCommissioningLastExecutionStatusState |
DataState | ||
RemoteCommissioningLinkedDevicesState |
DataState | ||
RemoteCommissioningLinkedGatewayState |
DataState | ||
StatusState |
DiscreteState | available, unavailable | |
SwitchExternalInterfaceState |
DiscreteState | autoDetection, externalPushButton, externalSwitch, notApplicable |
OnOff/StatefulOnOff (ACTUATOR) — 23 commands, 16 states
Type IDs: 230901988524143, 230902038855791 | Servers: rexel, somfy_europe | Controllable: enocean:EnOceanSwitchOnOffTypeFWithReCom | Profiles: StatefulSwitchablePlug, StatefulSwitchable, Switchable
Commands
| Command | Parameters | Notes |
|---|---|---|
activateContextSavingOnPowerCut |
Activate last device state saving on power cut | |
activateLocalControl |
Enable the local control | |
activateNightMode |
Activate the Night Mode (example : switch off the local LED) | |
deactivateContextSavingOnPowerCut |
Deactivate last device state saving on power cut | |
deactivateLocalControl |
Disable the local control | |
deactivateNightMode |
Deactivate the night mode (example : switch on the local LED) | |
linkGateway |
The command linkGateway will allow the gateway to control the "target" device. If a gateway is linked, the product can be controlled by using Overkiz server's. By default, the gateway is not linked to the "target" device. | |
off |
Turn off the device | |
on |
Turn on the device | |
onWithTimer |
INT [5..14400] | Turn the device on for a given amount of seconds then turn it off |
refreshExternalInterfaceSettings |
Refresh external interface settings | |
refreshStatus |
Refresh the status of the device | |
setAutoOffTimer |
FLOAT [0.0..6553.4] | time in second - Timer To automatically set OFF output channel when it is set ON. Value 0 mean timer desactivated |
setContextSavingOnPowerCut |
STRING: off, on | Activate (on) or deactivate (off) last device state saving on power cut |
setDefaultOnOffState |
STRING: on, off | set the Default Output State |
setDelayOffTimer |
FLOAT [0.0..6553.4] | time in second - Delay timer before setting output channel to OFF value received by radio command. Value 0 mean timer desactivated |
setExternalInterfaceMode |
STRING: autoDetection, externalPushButton, externalSwitch, notApplicable | set external interface type : mono-stable or bistable switch |
setKey |
INT [1..4294967295] | set the key of the product. |
setKeyWithOldOne |
INT [1..4294967295]; INT [1..4294967295] | set the key of the product. p1 : new key, p2 : old key |
setLinkedDevices |
ARRAY | The command setLinkedDevices will set a link between a "target" device, and one or more "source" devices that will control your "target" device. The links are described in a JSON (p1). All existing links already set in the "target" will be erased. |
setOnOff |
STRING: off, on | Turn the device on or off |
unlinkAllDevices |
The command unlinkAllDevices will clear all "source" devices linked before to this device. | |
unlinkGateway |
The command unlinkGateway will forbid the gateway to control the "target" device. If a gateway is not linked, the product can not be controlled by using Overkiz server's. By default, the gateway is not linked to the "target" device. |
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
AutoOffTimerState |
ContinuousState | ||
ContextSavingOnPowerCutState |
DiscreteState | off, on | |
DefaultOnOffState |
DiscreteState | off, on, previous, togglePrevious, unknown | |
DelayOffTimerState |
ContinuousState | ||
DiscreteRSSILevelState |
DiscreteState | good, low, normal, verylow | |
LocalControlState |
DiscreteState | off, on | |
NightModeState |
DiscreteState | off, on | |
OnOffState |
DiscreteState | on, off | |
RSSILevelState |
ContinuousState | ||
RemoteCommissioningDeviceKeyState |
DataState | ||
RemoteCommissioningDevicesState |
DataState | ||
RemoteCommissioningLastExecutionStatusState |
DataState | ||
RemoteCommissioningLinkedDevicesState |
DataState | ||
RemoteCommissioningLinkedGatewayState |
DataState | ||
StatusState |
DiscreteState | available, unavailable | |
SwitchExternalInterfaceState |
DiscreteState | autoDetection, externalPushButton, externalSwitch, notApplicable |
OnOff/StatelessOnOff (ACTUATOR) — 4 commands, 1 states
Type IDs: 270492762177536 | Servers: rexel, somfy_europe | Controllable: enocean:EnOceanSwitchOnOff | Profiles: SwitchablePlug, Switchable
Commands
| Command | Parameters | Notes |
|---|---|---|
off |
Turn off the device | |
on |
Turn on the device | |
onWithTimer |
INT [5..14400] | Turn the device on for a given amount of seconds then turn it off |
setOnOff |
STRING: off, on | Turn the device on or off |
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
StatusState |
DiscreteState | available, unavailable |
RollerShutter/UpDownRollerShutter (ACTUATOR) — 8 commands, 5 states
Type IDs: 181692132229133 | Servers: rexel, somfy_europe | Controllable: enocean:EnOceanStatefulRollerShutter | Profiles: OpenCloseShutter, OpenClose
Commands
| Command | Parameters | Notes |
|---|---|---|
close |
Fully close the device | |
down |
Move the device completely down | |
open |
Fully open the device | |
stop |
Stop the current actuator behavior (movement, sound or timer) | |
teachIn |
command to teach the box in the actuator | |
timedClose |
FLOAT [0.0..255.0] | close the device for the given time |
timedOpen |
FLOAT [0.0..255.0] | open the device for the given time |
up |
Move the device completely up |
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
DiscreteRSSILevelState |
DiscreteState | good, low, normal, verylow | |
OpenClosedUnknownState |
DiscreteState | closed, open, unknown | |
RSSILevelState |
ContinuousState | ||
StatusState |
DiscreteState | available, unavailable | |
UpDownRestState |
DiscreteState | down, rest, up |
RollerShutter/PositionableRollerShutter (ACTUATOR) — 31 commands, 14 states
Type IDs: 230918916669510 | Servers: rexel, somfy_europe | Controllable: enocean:EnoceanRollerShutterWithRemoteCommissioning | Profiles: StatefulCloseableShutter, StatefulCloseable, Closeable, StatefulOpenClose, OpenClose
Commands
| Command | Parameters | Notes |
|---|---|---|
addDevicesLink |
OBJECT | Add a link between your device and the devices (one or more) that will control it. @Deprecated : use addLinkedDevices |
addGatewayLink |
add the gateway to list of the linked devices. @Deprecated : use linkGateway | |
addLinkedDevices |
OBJECT | The command addLinkedDevices will add a link between your "target" device and another "source" devices (one or more) that will control your "target" device. |
clearAllLinkedDevices |
Clear all devices linked before. @Deprecated: use unlinkAllDevices | |
close |
Fully close the device | |
down |
Move the device completely down | |
getCalibrationStatus |
Get calibration status. | |
getCalibrationTimeDown |
Get calibration time down. | |
getCalibrationTimeUp |
Get calibration time up. | |
getClosure |
Get closure level (100%=fully close, 0%=open) | |
linkGateway |
The command linkGateway will allow the gateway to control the "target" device. If a gateway is linked, the product can be controlled by using Overkiz server's. By default, the gateway is not linked to the "target" device. | |
open |
Fully open the device | |
refreshSwitchType |
refresh switch type. | |
removeDeviceLink |
INT | remove a device to the list of the devices linked by the remote commissioning. Address of the device to remove is the parameter. @Deprecated : use removeLinkedDevice |
removeGatewayLink |
remove the gateway from the list of the link devices.@Deprecated : use unlinkGateway | |
removeLinkedDevice |
STRING | The command removeLinkedDevice will remove the device linked before with the command setLinkedDevices or addLinkedDevices.This command can remove only 1 device. p1 : the deviceURL you want to delete. |
setClosure |
INT [0..100] | Closure level (100%=fully close, 0%=open) |
setKey |
INT [1..4294967295] | set the key of the product. |
setKeyWithOldOne |
INT [1..4294967295]; INT [1..4294967295] | set the key of the product. p1 : new key, p2 : old key |
setLinkedDevices |
ARRAY | The command setLinkedDevices will set a link between a "target" device, and one or more "source" devices that will control your "target" device. The links are described in a JSON (p1). All existing links already set in the "target" will be erased. |
setLinks |
OBJECT | Set a link between your device and the devices (one or more) that will control it. All existing links already set in the target will be erase. @Deprecated: use setLinkedDevices |
setSwitchType |
STRING: biStableTypeOne, biStableTypeTwo, biStableTypeThree, monoStableTypeFour | Set switch type. |
setTimeCalibration |
FLOAT [5.0..300.0] | Set time calibration in seconds. |
startCalibration |
STRING: classic, complex | Start classic or complex calibration. |
stop |
Stop the current actuator behavior (movement, sound or timer) | |
stopCalibration |
Stop calibration. | |
unlinkAllDevices |
The command unlinkAllDevices will clear all "source" devices linked before to this device. | |
unlinkGateway |
The command unlinkGateway will forbid the gateway to control the "target" device. If a gateway is not linked, the product can not be controlled by using Overkiz server's. By default, the gateway is not linked to the "target" device. | |
up |
Move the device completely up | |
updateLinkedDevices |
ARRAY | The command updateLinkedDevices will set a link between a "target" device, and one or more "source" devices that will control your "target" device. The links are described in a JSON (p1). Only the different links will be updated. Full configuration will be resent when ; - some devices are removed only - same devices but with different configurations - previous configuration has failed - no configuration has been sent yet Only differences will be sent when : - some devices are added only An error with NO_ACTION code will be returned if configuration is exactly the same. |
updateLinks |
OBJECT | Link given devices to current device using remote commissioning and comparing to existing configuration as follow : Full configuration will be resent when ; - some devices are removed only - same devices but with different configurations - previous configuration has failed - no configuration has been sent yet Only differences will be sent when : - some devices are added only An error with NO_ACTION code will be returned if configuration is exactly the same. @Deprecated : use updateLinkedDevices |
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
CalibrationStatusState |
DiscreteState | calibrated, notCalibrated | |
CalibrationTimeDownState |
ContinuousState | ||
CalibrationTimeUpState |
ContinuousState | ||
ClosureState |
ContinuousState | [0..100] | |
DiscreteRSSILevelState |
DiscreteState | good, low, normal, verylow | |
OpenClosedState |
DiscreteState | open, closed | |
RSSILevelState |
ContinuousState | ||
RemoteCommissioningDeviceKeyState |
DataState | ||
RemoteCommissioningDevicesState |
DataState | ||
RemoteCommissioningLastExecutionStatusState |
DataState | ||
RemoteCommissioningLinkedDevicesState |
DataState | ||
RemoteCommissioningLinkedGatewayState |
DataState | ||
StatusState |
DiscreteState | available, unavailable | |
SwitchTypeState |
DiscreteState | bistable, monostable |
RollerShutter/PositionableRollerShutter (ACTUATOR) — 7 commands, 5 states
Type IDs: 230918916669551 | Servers: rexel, somfy_europe | Controllable: enocean:EnOceanAvidsenRollerShutterComponent | Profiles: StatefulCloseableShutter, StatefulCloseable, Closeable, StatefulOpenClose, OpenClose
Commands
| Command | Parameters | Notes |
|---|---|---|
close |
Fully close the device | |
down |
Move the device completely down | |
getClosure |
Get closure level (100%=fully close, 0%=open) | |
open |
Fully open the device | |
setClosure |
INT [0..100] | Closure level (100%=fully close, 0%=open) |
stop |
Stop the current actuator behavior (movement, sound or timer) | |
up |
Move the device completely up |
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
ClosureState |
ContinuousState | [0..100] | |
DiscreteRSSILevelState |
DiscreteState | good, low, normal, verylow | |
OpenClosedState |
DiscreteState | open, closed | |
RSSILevelState |
ContinuousState | ||
StatusState |
DiscreteState | available, unavailable |
RollerShutter/PositionableRollerShutter (ACTUATOR) — 14 commands, 10 states
Type IDs: 230918916735087 | Servers: rexel, somfy_europe | Controllable: enocean:EnOceanAvidsenRollerShutterComponentWithReCom | Profiles: StatefulCloseableShutter, StatefulCloseable, Closeable, StatefulOpenClose, OpenClose
Commands
| Command | Parameters | Notes |
|---|---|---|
close |
Fully close the device | |
down |
Move the device completely down | |
getClosure |
Get closure level (100%=fully close, 0%=open) | |
linkGateway |
The command linkGateway will allow the gateway to control the "target" device. If a gateway is linked, the product can be controlled by using Overkiz server's. By default, the gateway is not linked to the "target" device. | |
open |
Fully open the device | |
setClosure |
INT [0..100] | Closure level (100%=fully close, 0%=open) |
setKey |
INT [1..4294967295] | set the key of the product. |
setKeyWithOldOne |
INT [1..4294967295]; INT [1..4294967295] | set the key of the product. p1 : new key, p2 : old key |
setLinkedDevices |
ARRAY | The command setLinkedDevices will set a link between a "target" device, and one or more "source" devices that will control your "target" device. The links are described in a JSON (p1). All existing links already set in the "target" will be erased. |
startClassicCalibration |
Start classic calibration. | |
stop |
Stop the current actuator behavior (movement, sound or timer) | |
unlinkAllDevices |
The command unlinkAllDevices will clear all "source" devices linked before to this device. | |
unlinkGateway |
The command unlinkGateway will forbid the gateway to control the "target" device. If a gateway is not linked, the product can not be controlled by using Overkiz server's. By default, the gateway is not linked to the "target" device. | |
up |
Move the device completely up |
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
ClosureState |
ContinuousState | [0..100] | |
DiscreteRSSILevelState |
DiscreteState | good, low, normal, verylow | |
OpenClosedState |
DiscreteState | open, closed | |
RSSILevelState |
ContinuousState | ||
RemoteCommissioningDeviceKeyState |
DataState | ||
RemoteCommissioningDevicesState |
DataState | ||
RemoteCommissioningLastExecutionStatusState |
DataState | ||
RemoteCommissioningLinkedDevicesState |
DataState | ||
RemoteCommissioningLinkedGatewayState |
DataState | ||
StatusState |
DiscreteState | available, unavailable |
RollerShutter/UpDownRollerShutter (ACTUATOR) — 4 commands, 1 states
Type IDs: 270492762308608 | Servers: rexel, somfy_europe | Controllable: enocean:EnOceanRollerShutter | Profiles: OpenCloseShutterSwitch, BasicOpenClose, BasicUpDown
Commands
| Command | Parameters | Notes |
|---|---|---|
close |
Fully close the device | |
down |
Move the device completely down | |
open |
Fully open the device | |
up |
Move the device completely up |
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
StatusState |
DiscreteState | available, unavailable |
TemperatureSensor (SENSOR) — 0 commands, 5 states
Type IDs: 181556874313728, 181556874313784, 181556874313801, 181556874379337, 181556874379362, 181556874379370, 181556874444800, 181556874444873, 181556958199808, 181556958199914, 181556958265450 | Servers: rexel, somfy_europe | Controllable: enocean:EnOceanHVACTemperatureSensor | Profiles: Temperature
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
DiscreteRSSILevelState |
DiscreteState | good, low, normal, verylow | |
RSSILevelState |
ContinuousState | ||
SensorDefectState |
DiscreteState | dead, lowBattery, maintenanceRequired, noDefect | |
StatusState |
DiscreteState | available, unavailable | |
TemperatureState |
ContinuousState | [-100.0..100.0] |
TemperatureSensor (SENSOR) — 0 commands, 4 states
Type IDs: 462903002005504, 462903069114368, 462903069114438, 462903303995392, 462903303995436, 462911591940096, 462911591940140, 462911591940166, 462911608717312, 462911608717325 | Servers: rexel, somfy_europe | Controllable: enocean:EnOceanTemperatureSensorType01 | Profiles: Temperature
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
DiscreteRSSILevelState |
DiscreteState | good, low, normal, verylow | |
RSSILevelState |
ContinuousState | ||
StatusState |
DiscreteState | available, unavailable | |
TemperatureState |
ContinuousState | [-100.0..100.0] |
VenetianBlind/PositionableVenetianBlind (ACTUATOR) — 6 commands, 6 states
Type IDs: 230918950223872 | Servers: rexel, somfy_europe | Controllable: enocean:EnOceanVenetianBlindController | Profiles: StatefulVenetianBlind, StatefulOrientableAndCloseable, OrientableAndCloseable, OpenClose
Commands
| Command | Parameters | Notes |
|---|---|---|
close |
Fully close the device | |
down |
Move the device completely down | |
open |
Fully open the device | |
setClosureAndOrientation |
INT [0..100]; INT [0..100] | Set both the closure level (0-100%) and relative slats orientation (0-100%) of the device |
stop |
Stop the current actuator behavior (movement, sound or timer) | |
up |
Move the device completely up |
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
ClosureState |
ContinuousState | [0..100] | |
DiscreteRSSILevelState |
DiscreteState | good, low, normal, verylow | |
OpenClosedState |
DiscreteState | open, closed | |
RSSILevelState |
ContinuousState | ||
SlateOrientationState |
ContinuousState | [0..100] | |
StatusState |
DiscreteState | available, unavailable |
VenetianBlind/PositionableVenetianBlind (ACTUATOR) — 22 commands, 11 states
Type IDs: 230918950289408 | Servers: rexel, somfy_europe | Controllable: enocean:EnOceanVenetianBlindControllerWithRemoteCommissioning | Profiles: StatefulVenetianBlind, StatefulOrientableAndCloseable, OrientableAndCloseable, OpenClose
Commands
| Command | Parameters | Notes |
|---|---|---|
addDevicesLink |
OBJECT | Add a link between your device and the devices (one or more) that will control it. @Deprecated : use addLinkedDevices |
addGatewayLink |
add the gateway to list of the linked devices. @Deprecated : use linkGateway | |
addLinkedDevices |
OBJECT | The command addLinkedDevices will add a link between your "target" device and another "source" devices (one or more) that will control your "target" device. |
clearAllLinkedDevices |
Clear all devices linked before. @Deprecated: use unlinkAllDevices | |
close |
Fully close the device | |
down |
Move the device completely down | |
linkGateway |
The command linkGateway will allow the gateway to control the "target" device. If a gateway is linked, the product can be controlled by using Overkiz server's. By default, the gateway is not linked to the "target" device. | |
open |
Fully open the device | |
removeDeviceLink |
INT | remove a device to the list of the devices linked by the remote commissioning. Address of the device to remove is the parameter. @Deprecated : use removeLinkedDevice |
removeGatewayLink |
remove the gateway from the list of the link devices.@Deprecated : use unlinkGateway | |
removeLinkedDevice |
STRING | The command removeLinkedDevice will remove the device linked before with the command setLinkedDevices or addLinkedDevices.This command can remove only 1 device. p1 : the deviceURL you want to delete. |
setClosureAndOrientation |
INT [0..100]; INT [0..100] | Set both the closure level (0-100%) and relative slats orientation (0-100%) of the device |
setKey |
INT [1..4294967295] | set the key of the product. |
setKeyWithOldOne |
INT [1..4294967295]; INT [1..4294967295] | set the key of the product. p1 : new key, p2 : old key |
setLinkedDevices |
ARRAY | The command setLinkedDevices will set a link between a "target" device, and one or more "source" devices that will control your "target" device. The links are described in a JSON (p1). All existing links already set in the "target" will be erased. |
setLinks |
OBJECT | Set a link between your device and the devices (one or more) that will control it. All existing links already set in the target will be erase. @Deprecated: use setLinkedDevices |
stop |
Stop the current actuator behavior (movement, sound or timer) | |
unlinkAllDevices |
The command unlinkAllDevices will clear all "source" devices linked before to this device. | |
unlinkGateway |
The command unlinkGateway will forbid the gateway to control the "target" device. If a gateway is not linked, the product can not be controlled by using Overkiz server's. By default, the gateway is not linked to the "target" device. | |
up |
Move the device completely up | |
updateLinkedDevices |
ARRAY | The command updateLinkedDevices will set a link between a "target" device, and one or more "source" devices that will control your "target" device. The links are described in a JSON (p1). Only the different links will be updated. Full configuration will be resent when ; - some devices are removed only - same devices but with different configurations - previous configuration has failed - no configuration has been sent yet Only differences will be sent when : - some devices are added only An error with NO_ACTION code will be returned if configuration is exactly the same. |
updateLinks |
OBJECT | Link given devices to current device using remote commissioning and comparing to existing configuration as follow : Full configuration will be resent when ; - some devices are removed only - same devices but with different configurations - previous configuration has failed - no configuration has been sent yet Only differences will be sent when : - some devices are added only An error with NO_ACTION code will be returned if configuration is exactly the same. @Deprecated : use updateLinkedDevices |
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
ClosureState |
ContinuousState | [0..100] | |
DiscreteRSSILevelState |
DiscreteState | good, low, normal, verylow | |
OpenClosedState |
DiscreteState | open, closed | |
RSSILevelState |
ContinuousState | ||
RemoteCommissioningDeviceKeyState |
DataState | ||
RemoteCommissioningDevicesState |
DataState | ||
RemoteCommissioningLastExecutionStatusState |
DataState | ||
RemoteCommissioningLinkedDevicesState |
DataState | ||
RemoteCommissioningLinkedGatewayState |
DataState | ||
SlateOrientationState |
ContinuousState | [0..100] | |
StatusState |
DiscreteState | available, unavailable |
VentilationSystem/DimplexVentilationInletOutlet (ACTUATOR) — 4 commands, 1 states
Type IDs: 181557142749184 | Servers: rexel, somfy_europe | Controllable: enocean:EnOceanDimplexVentilationComponent | Profiles: Specific
Commands
| Command | Parameters | Notes |
|---|---|---|
auto |
Change ventilation mode to auto | |
dec |
INT | Decrement ventilation fan speed |
inc |
INT | Increment ventilation fan speed |
max |
Change ventilation mode to max |
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
StatusState |
DiscreteState | available, unavailable |
HLRR_WIFI
2 device types.
HitachiHeatingSystem/HitachiAirToAirHeatPump (ACTUATOR) — 1 commands, 14 states
Type IDs: 655360 | Servers: hi_kumo_europe | Controllable: hlrrwifi:HLinkMainController | Profiles: ThermostatTargetReader
Commands
| Command | Parameters | Notes |
|---|---|---|
globalControl |
STRING: off, on; INT; STRING: auto, high, low, medium, silent; STRING: auto, circulator, cooling, dehumidify, fan; STRING: both, horizontal, stop, vertical; STRING: off, on | p1: Main operation => on|off p2: Temperature in Celsius p3: Fan speed => auto|high|medium|low|silent p4: Mode => auto|heating|dehumidify|cooling|fan|circulator|leaveHome p5: Swing => stop|vertical|horizontal|both p6: Leave home => on|off |
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
DiagnosticCodeState |
DataState | ||
FanSpeedState |
DiscreteState | auto, high, low, medium, silent | |
FilterConditionState |
DiscreteState | OK, alert | |
LeaveHomeState |
DiscreteState | off, on | |
MainOperationState |
DiscreteState | off, on | |
ModeChangeState |
DiscreteState | auto, autoCooling, autoHeating, circulator, cooling, dehumidify, fan, heating | |
OutdoorTemperatureState |
ContinuousState | ||
ProductModelNameState |
DataState | ||
RSSILevelState |
ContinuousState | ||
RemoconControlState |
DiscreteState | disable, enable | |
RoomTemperatureState |
ContinuousState | ||
SwingState |
DiscreteState | both, horizontal, stop, vertical | |
TargetTemperatureState |
ContinuousState | [12.0..30.0] | |
TemperatureChangeState |
ContinuousState |
ProtocolGateway/HLRRWifiBridge (PROTOCOL_GATEWAY) — 2 commands, 2 states
Type IDs: 8589934592 | Servers: hi_kumo_europe | Controllable: hlrrwifi:HLRRWifiBridge | Profiles: Specific
Commands
| Command | Parameters | Notes |
|---|---|---|
getName |
Refresh the device internal name | |
setName |
STRING | Change the device internal name. Name length may be subject to restrictions depending on the device and underlying protocol. |
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
LocalModeState |
DiscreteState | false, true | |
NameState |
DataState |
HOMEKIT
1 device types.
ProtocolGateway/HomekitStack (PROTOCOL_GATEWAY) — 1 commands, 0 states
Type IDs: 0 | Servers: somfy_europe | Controllable: homekit:StackComponent | Profiles: Specific
Commands
| Command | Parameters | Notes |
|---|---|---|
deleteControllers |
Unpair all controllers linked to the stack |
HUE
5 device types.
Light/DimmerHueSatOrCTLight (ACTUATOR) — 16 commands, 10 states
Type IDs: 72137043618037761, 72137043618037762, 72137043618037763, 72141446093733889, 72141446093733890, 72141446093733891, 72141446093733895, 72141446093733898, 72141446093733900, 72141446093733902, 72141484463226900, 72141484630999041, 72141514813210626, 72415224354832384 | Servers: rexel, somfy_europe | Controllable: hue:ColorLightModuleHUEComponent | Profiles: StatefulLightDimmer, StatefulDimmable, Dimmable, StatefulSwitchable, Switchable
Data Properties
core:identifyInterval=3000
Commands
| Command | Parameters | Notes |
|---|---|---|
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 | |
onWithTimer |
INT [5..14400] | Turn the device on for a given amount of seconds then turn it off |
refreshState |
Refresh the device states | |
setCTB |
INT [2000..6536]; INT [0..100] | Set the perceived white temperature for this lamp (°K) and its brightness (%) |
setCieColorSpaceXY |
FLOAT [0.0..1.0]; FLOAT [0.0..1.0] | Set the CIE color space coordinates (X,Y) of the lamp |
setColorTemperature |
INT [2000..6536] | Set the perceived white temperature for this lamp (°K) |
setHSB |
INT [0..360]; INT [0..100]; INT [0..100] | Set the color hue (°), color saturation (%) and brightness (%) of the lamp |
setHueAndSaturation |
INT [0..360]; INT [0..100] | Set the color hue (°) and color saturation(%) of the lamp |
setIntensity |
INT [0..100] | Light intensity level (100%=maximum intensity, 0%=off) |
setIntensityWithTimer |
INT [0..100]; INT [5..14400]; INT [0..100] (optional) | Set the light intensity to p1% then after p2 seconds, set it to p3%. (If p3 is not specified the light is turned off after the delay) |
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 |
setRGB |
INT [0..255]; INT [0..255]; INT [0..255] | Set the Red,Green,Blue components of the lamp color |
setXYB |
FLOAT [0.0..1.0]; FLOAT [0.0..1.0]; INT [0..100] | Set the CIE color space coordinates (X,Y) and brightness (%) of the lamp |
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
CieColorSpaceXState |
ContinuousState | ||
CieColorSpaceYState |
ContinuousState | ||
ColorHueState |
ContinuousState | ||
ColorSaturationState |
ContinuousState | ||
ColorTemperatureState |
ContinuousState | ||
HueColorModeState |
DiscreteState | ct, hs, xy | |
LightIntensityState |
ContinuousState | [0..100] | |
NameState |
DataState | ||
OnOffState |
DiscreteState | on, off | |
StatusState |
DiscreteState | available, unavailable |
Light/DimmerColorTemperatureLight (ACTUATOR) — 11 commands, 6 states
Type IDs: 72137090862678022, 72141484630999050, 72141484630999051, 72141484630999052, 72141519158509569, 72141519158509572, 72141519158509578, 72141519158509579, 72141519158509580, 72141519158509581, 72141519158509582, 72141519158509583, 72413098346020864 | Servers: rexel, somfy_europe | Controllable: hue:PhoenixHUEComponent | Profiles: StatefulLightDimmer, StatefulDimmable, Dimmable, StatefulSwitchable, Switchable
Data Properties
core:identifyInterval=3000
Commands
| Command | Parameters | Notes |
|---|---|---|
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 | |
onWithTimer |
INT [5..14400] | Turn the device on for a given amount of seconds then turn it off |
refreshState |
Refresh the device states | |
setCTB |
INT [2000..6536]; INT [0..100] | Set the perceived white temperature for this lamp (°K) and its brightness (%) |
setColorTemperature |
INT [2000..6536] | Set the perceived white temperature for this lamp (°K) |
setIntensity |
INT [0..100] | Light intensity level (100%=maximum intensity, 0%=off) |
setIntensityWithTimer |
INT [0..100]; INT [5..14400]; INT [0..100] (optional) | Set the light intensity to p1% then after p2 seconds, set it to p3%. (If p3 is not specified the light is turned off after the delay) |
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 |
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
ColorTemperatureState |
ContinuousState | ||
HueColorModeState |
DiscreteState | ct, hs, xy | |
LightIntensityState |
ContinuousState | [0..100] | |
NameState |
DataState | ||
OnOffState |
DiscreteState | on, off | |
StatusState |
DiscreteState | available, unavailable |
Light/DimmerLight (ACTUATOR) — 9 commands, 4 states
Type IDs: 72141156921638912, 72141531691089921, 72141531691089922, 72141531691089924, 72141531691089926, 72141531691089927, 72141531691089930, 72141531691089934, 72141531858862081, 72339362347483136 | Servers: rexel, somfy_europe | Controllable: hue:HueLuxHUEComponent | Profiles: StatefulLightDimmer, StatefulDimmable, Dimmable, StatefulSwitchable, Switchable
Data Properties
core:identifyInterval=3000
Commands
| Command | Parameters | Notes |
|---|---|---|
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 | |
onWithTimer |
INT [5..14400] | Turn the device on for a given amount of seconds then turn it off |
refreshState |
Refresh the device states | |
setIntensity |
INT [0..100] | Light intensity level (100%=maximum intensity, 0%=off) |
setIntensityWithTimer |
INT [0..100]; INT [5..14400]; INT [0..100] (optional) | Set the light intensity to p1% then after p2 seconds, set it to p3%. (If p3 is not specified the light is turned off after the delay) |
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 |
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
LightIntensityState |
ContinuousState | [0..100] | |
NameState |
DataState | ||
OnOffState |
DiscreteState | on, off | |
StatusState |
DiscreteState | available, unavailable |
Light/DimmerHueSaturationLight (ACTUATOR) — 14 commands, 9 states
Type IDs: 72141484463226881, 72141484463226885, 72141484463226886, 72141484463226887, 72141484463226890, 72141484463226891, 72141484463226892, 72141484463226893, 72141484463226894, 72141514813210625, 72339358052515840 | Servers: rexel, somfy_europe | Controllable: hue:BloomHUEComponent | Profiles: StatefulLightDimmer, StatefulDimmable, Dimmable, StatefulSwitchable, Switchable
Data Properties
core:identifyInterval=3000
Commands
| Command | Parameters | Notes |
|---|---|---|
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 | |
onWithTimer |
INT [5..14400] | Turn the device on for a given amount of seconds then turn it off |
refreshState |
Refresh the device states | |
setCieColorSpaceXY |
FLOAT [0.0..1.0]; FLOAT [0.0..1.0] | Set the CIE color space coordinates (X,Y) of the lamp |
setHSB |
INT [0..360]; INT [0..100]; INT [0..100] | Set the color hue (°), color saturation (%) and brightness (%) of the lamp |
setHueAndSaturation |
INT [0..360]; INT [0..100] | Set the color hue (°) and color saturation(%) of the lamp |
setIntensity |
INT [0..100] | Light intensity level (100%=maximum intensity, 0%=off) |
setIntensityWithTimer |
INT [0..100]; INT [5..14400]; INT [0..100] (optional) | Set the light intensity to p1% then after p2 seconds, set it to p3%. (If p3 is not specified the light is turned off after the delay) |
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 |
setRGB |
INT [0..255]; INT [0..255]; INT [0..255] | Set the Red,Green,Blue components of the lamp color |
setXYB |
FLOAT [0.0..1.0]; FLOAT [0.0..1.0]; INT [0..100] | Set the CIE color space coordinates (X,Y) and brightness (%) of the lamp |
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
CieColorSpaceXState |
ContinuousState | ||
CieColorSpaceYState |
ContinuousState | ||
ColorHueState |
ContinuousState | ||
ColorSaturationState |
ContinuousState | ||
HueColorModeState |
DiscreteState | ct, hs, xy | |
LightIntensityState |
ContinuousState | [0..100] | |
NameState |
DataState | ||
OnOffState |
DiscreteState | on, off | |
StatusState |
DiscreteState | available, unavailable |
ProtocolGateway/HueBridge (PROTOCOL_GATEWAY) — 0 commands, 1 states
Type IDs: 16777216, 16777217, 16777218 | Servers: rexel, somfy_europe | Controllable: hue:BridgeHUEV2Component | Profiles: Specific
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
NameState |
DataState |
INTERNAL
15 device types.
Alarm/TSKAlarmController (ACTUATOR) — 16 commands, 5 states
Type IDs: 1 | Servers: atlantic_cozytouch, hi_kumo_europe, rexel, somfy_europe | Controllable: internal:TSKAlarmComponent | Profiles: Alarm, Switchable
Commands
| Command | Parameters | Notes |
|---|---|---|
alarmOff |
Turn off the alarm (All zones) | |
alarmOn |
Turn the alarm on | |
alarmPartial1 |
Set the alarm on partial 1 mode | |
alarmPartial2 |
Set the alarm on partial 2 mode | |
arm |
Arm the system | |
disarm |
Disarm the system | |
getName |
Refresh the device internal name | |
off |
Turn off the device | |
on |
Turn on the device | |
refreshAlarmDelay |
Refresh the waiting time for an alarm mode change | |
refreshCurrentAlarmMode |
Refresh current alarm mode | |
refreshIntrusionDetected |
Refresh intrusion detected state | |
setAlarmDelay |
INT [0..255] | Change waiting time (in s) before changing alarm mode |
setIntrusionDetected |
STRING: detected, notDetected, pending, sos | Change the intrusion detected state |
setName |
STRING | Change the device internal name. Name length may be subject to restrictions depending on the device and underlying protocol. |
setTargetAlarmMode |
STRING: off, partial1, partial2, sos, total | Change the current alarm mode (after a configured delay) |
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
AlarmDelayState |
ContinuousState | ||
CurrentAlarmModeState |
DiscreteState | off, partial1, partial2, total | |
IntrusionDetectedState |
DiscreteState | detected, notDetected, pending, sos | |
NameState |
DataState | ||
TargetAlarmModeState |
DiscreteState | off, partial1, partial2, sos, total |
Dock (ACTUATOR) — 25 commands, 14 states
Type IDs: 3 | Servers: atlantic_cozytouch, hi_kumo_europe, rexel, somfy_europe | Controllable: internal:TSKDockComponent | Profiles: Specific
Commands
| Command | Parameters | Notes |
|---|---|---|
blinkModemLed |
INT: 0, 100, 200, 300, 400; INT: 100, 200, 300, 400, 500 (optional) | Make modem led blink |
getName |
Refresh the device internal name | |
increasingFrequencyBip |
INT [0..255]; INT [0..255] | Ask alarm to start a bip sequence of increasing frequency p1 stands for initial interval between two bips p2 stands for alarm duration |
longBip |
INT [0..255] | Ask alarm to start a long bip sequence p1 stands for number of bips |
rebootModem |
Reboot modem | |
refreshAirplaneMode |
Refresh airplane mode state | |
refreshBatteryLevel |
Refresh the battery level | |
refreshBatteryStatus |
Refresh battery status | |
refreshGPRSRegistration |
Refresh GPRS registration | |
refreshGSMRegistration |
Refresh GSM registration | |
refreshOperatorConfig |
Refresh operator configuration | |
refreshOperatorName |
Refresh registered operator name | |
refreshRSSILevel |
Refresh RSSI level | |
refreshSIMCardStatus |
Refresh SIM card status | |
refreshSirenStatus |
Refresh siren status | |
setAirplaneMode |
STRING | Change airplaine mode |
setLightingLedModemMode |
INT: 0, 1 | Change lighting led modem mode, 0=off ; 1=on |
setModemLedOff |
Turn off modem led | |
setModemLedOn |
Turn on modem led | |
setOperatorConfig |
STRING | Change operator configuration |
setSIMPinCode |
STRING | Enter SIM PIN code |
setSirenStatus |
STRING: on, off; STRING: cyclic; INT (optional); INT (optional) | Trigger / Stop the siren if p1=cyclic, p2=on delay in seconds and p3=off delay in seconds |
shortBip |
INT [0..255] | Ask alarm for short bip sequence p1 stands for number of bips |
siren |
STRING: cyclic, off, on | Change siren status |
stopBlinkModemLed |
Stop modem led blinking |
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
AirplaneModeState |
ContinuousState | ||
BatteryLevelState |
ContinuousState | ||
BatteryStatusState |
ContinuousState | ||
GPRSRegistrationState |
DiscreteState | false, true | |
GSMRegistrationState |
DiscreteState | false, true | |
LastConnectivitySwitchState |
ContinuousState | ||
LightingLedModemModeState |
ContinuousState | ||
NameState |
DataState | ||
ProviderNameState |
ContinuousState | ||
RSSILevelState |
ContinuousState | ||
SIMCardActivationState |
DiscreteState | false, true | |
SIMCardConnectivityState |
DiscreteState | offline, online, registered | |
SIMCardStatusState |
DiscreteState | KO, OK, inProgress | |
SirenStatusState |
DiscreteState | cyclic, off, on |
Pod (ACTUATOR) — 2 commands, 1 states
Type IDs: 2 | Servers: atlantic_cozytouch, hi_kumo_europe, rexel, somfy_europe | Controllable: internal:PodComponent | Profiles: Specific
Commands
| Command | Parameters | Notes |
|---|---|---|
getName |
Refresh the device internal name | |
refreshPodMode |
Refresh pod mode |
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
NameState |
DataState |
Pod (ACTUATOR) — 11 commands, 7 states
Type IDs: 4 | Servers: atlantic_cozytouch, hi_kumo_europe, rexel | Controllable: internal:PodMiniComponent | Profiles: UpdatableComponent
Commands
| Command | Parameters | Notes |
|---|---|---|
activateCalendar |
Activate Calendar Trigger | |
deactivateCalendar |
deactivate Calendar Trigger | |
getName |
Refresh the device internal name | |
refreshPodMode |
Refresh pod mode | |
refreshUpdateStatus |
Refresh updateStatus | |
setCalendar |
STRING: yes, no | activate/deactivate Calendar Trigger |
setCountryCode |
STRING | Set the ISO 3166-1 Country Code |
setLightingLedPodMode |
FLOAT [0.0..1.0] | Change lighting led pod mode intensity, 0=0% ; 1=100% |
setPodLedOff |
Turn off the pod led | |
setPodLedOn |
Turn on the pod led | |
update |
Update the gateway software. The update may have to be downloaded first, which can take a while. |
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
ConnectivityState |
DiscreteState | offline, online | |
CountryCodeState |
DataState | ||
LastActionConfigButtonState |
DiscreteState | doublePress, longPress, simplePress, triplePress, veryLongPress | |
LightingLedPodModeState |
ContinuousState | ||
LocalAccessProofState |
DataState | ||
LocalIPv4AddressState |
DataState | ||
NameState |
DataState |
Pod (ACTUATOR) — 12 commands, 8 states
Type IDs: 5 | Servers: atlantic_cozytouch, hi_kumo_europe, rexel | Controllable: internal:PodV2Component | Profiles: UpdatableComponent
Commands
| Command | Parameters | Notes |
|---|---|---|
activateCalendar |
Activate Calendar Trigger | |
deactivateCalendar |
deactivate Calendar Trigger | |
getName |
Refresh the device internal name | |
refreshBatteryStatus |
Refresh battery status | |
refreshPodMode |
Refresh pod mode | |
refreshUpdateStatus |
Refresh updateStatus | |
setCalendar |
STRING: yes, no | activate/deactivate Calendar Trigger |
setCountryCode |
STRING | Set the ISO 3166-1 Country Code |
setLightingLedPodMode |
FLOAT [0.0..1.0] | Change lighting led pod mode intensity, 0=0% ; 1=100% |
setPodLedOff |
Turn off the pod led | |
setPodLedOn |
Turn on the pod led | |
update |
Update the gateway software. The update may have to be downloaded first, which can take a while. |
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
BatteryStatusState |
ContinuousState | ||
ConnectivityState |
DiscreteState | offline, online | |
CountryCodeState |
DataState | ||
CyclicButtonState |
DiscreteState | pressed, stop | |
LightingLedPodModeState |
ContinuousState | ||
LocalAccessProofState |
DataState | ||
LocalIPv4AddressState |
DataState | ||
NameState |
DataState |
Pod (ACTUATOR) — 0 commands, 0 states
Type IDs: 6 | Servers: atlantic_cozytouch, hi_kumo_europe, rexel, somfy_europe | Controllable: internal:UPodComponent | Profiles: Specific
Pod (ACTUATOR) — 0 commands, 2 states
Type IDs: 7 | Servers: atlantic_cozytouch, hi_kumo_europe, rexel, somfy_europe | Controllable: internal:UPodNetWorkComponent | Profiles: Specific
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
RSSILevelState |
ContinuousState | ||
RSSIQualityState |
ContinuousState |
Pod (ACTUATOR) — 11 commands, 9 states
Type IDs: 10 | Servers: atlantic_cozytouch, hi_kumo_europe, rexel | Controllable: internal:PodV3Component | Profiles: UpdatableComponent
Commands
| Command | Parameters | Notes |
|---|---|---|
activateCalendar |
Activate Calendar Trigger | |
deactivateCalendar |
deactivate Calendar Trigger | |
getName |
Refresh the device internal name | |
refreshPodMode |
Refresh pod mode | |
refreshUpdateStatus |
Refresh updateStatus | |
setCalendar |
STRING: yes, no | activate/deactivate Calendar Trigger |
setCountryCode |
STRING | Set the ISO 3166-1 Country Code |
setLightingLedPodMode |
FLOAT [0.0..1.0] | Change lighting led pod mode intensity, 0=0% ; 1=100% |
setPodLedOff |
Turn off the pod led | |
setPodLedOn |
Turn on the pod led | |
update |
Update the gateway software. The update may have to be downloaded first, which can take a while. |
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
Button1State |
DiscreteState | pressed, stop | |
Button2State |
DiscreteState | pressed, stop | |
Button3State |
DiscreteState | pressed, stop | |
ConnectivityState |
DiscreteState | offline, online | |
CountryCodeState |
DataState | ||
LightingLedPodModeState |
ContinuousState | ||
LocalAccessProofState |
DataState | ||
LocalIPv4AddressState |
DataState | ||
NameState |
DataState |
Pod (ACTUATOR) — 11 commands, 6 states
Type IDs: 11 | Servers: atlantic_cozytouch, hi_kumo_europe, rexel | Controllable: internal:PodV3RDComponent | Profiles: UpdatableComponent
Commands
| Command | Parameters | Notes |
|---|---|---|
activateCalendar |
Activate Calendar Trigger | |
deactivateCalendar |
deactivate Calendar Trigger | |
getName |
Refresh the device internal name | |
refreshPodMode |
Refresh pod mode | |
refreshUpdateStatus |
Refresh updateStatus | |
setCalendar |
STRING: yes, no | activate/deactivate Calendar Trigger |
setCountryCode |
STRING | Set the ISO 3166-1 Country Code |
setLightingLedPodMode |
FLOAT [0.0..1.0] | Change lighting led pod mode intensity, 0=0% ; 1=100% |
setPodLedOff |
Turn off the pod led | |
setPodLedOn |
Turn on the pod led | |
update |
Update the gateway software. The update may have to be downloaded first, which can take a while. |
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
ConnectivityState |
DiscreteState | offline, online | |
CountryCodeState |
DataState | ||
LightingLedPodModeState |
ContinuousState | ||
LocalAccessProofState |
DataState | ||
LocalIPv4AddressState |
DataState | ||
NameState |
DataState |
Pod/MultiGateway (ACTUATOR) — 2 commands, 4 states
Type IDs: 12 | Servers: atlantic_cozytouch, hi_kumo_europe, rexel, somfy_europe | Controllable: internal:MultiGatewayComponent | Profiles: Specific
Commands
| Command | Parameters | Notes |
|---|---|---|
ping |
Send a ping to all gateways connected | |
restart |
Restart the multiGateway system |
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
ErrorState |
DataState | ||
ListeningState |
DataState | ||
ReceivedPingsState |
DataState | ||
ReceivedPongsState |
DataState |
Pod (ACTUATOR) — 11 commands, 8 states
Type IDs: 4 | Servers: somfy_europe | Controllable: internal:PodMiniComponent | Profiles: UpdatableComponent
Commands
| Command | Parameters | Notes |
|---|---|---|
activateCalendar |
Activate Calendar Trigger | |
deactivateCalendar |
deactivate Calendar Trigger | |
getName |
Refresh the device internal name | |
refreshPodMode |
Refresh pod mode | |
refreshUpdateStatus |
Refresh updateStatus | |
setCalendar |
STRING: yes, no | activate/deactivate Calendar Trigger |
setCountryCode |
STRING | Set the ISO 3166-1 Country Code |
setLightingLedPodMode |
FLOAT [0.0..1.0] | Change lighting led pod mode intensity, 0=0% ; 1=100% |
setPodLedOff |
Turn off the pod led | |
setPodLedOn |
Turn on the pod led | |
update |
Update the gateway software. The update may have to be downloaded first, which can take a while. |
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
ConnectivityState |
DiscreteState | offline, online | |
CountryCodeState |
DataState | ||
LastActionConfigButtonState |
DiscreteState | doublePress, longPress, simplePress, triplePress, veryLongPress | |
LightingLedPodModeState |
ContinuousState | ||
LocalAccessProofState |
DataState | ||
LocalIPv4AddressState |
DataState | ||
NameState |
DataState | ||
UpdateStepAndBootStatusState |
DataState |
Pod (ACTUATOR) — 12 commands, 9 states
Type IDs: 5 | Servers: somfy_europe | Controllable: internal:PodV2Component | Profiles: UpdatableComponent
Commands
| Command | Parameters | Notes |
|---|---|---|
activateCalendar |
Activate Calendar Trigger | |
deactivateCalendar |
deactivate Calendar Trigger | |
getName |
Refresh the device internal name | |
refreshBatteryStatus |
Refresh battery status | |
refreshPodMode |
Refresh pod mode | |
refreshUpdateStatus |
Refresh updateStatus | |
setCalendar |
STRING: yes, no | activate/deactivate Calendar Trigger |
setCountryCode |
STRING | Set the ISO 3166-1 Country Code |
setLightingLedPodMode |
FLOAT [0.0..1.0] | Change lighting led pod mode intensity, 0=0% ; 1=100% |
setPodLedOff |
Turn off the pod led | |
setPodLedOn |
Turn on the pod led | |
update |
Update the gateway software. The update may have to be downloaded first, which can take a while. |
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
BatteryStatusState |
ContinuousState | ||
ConnectivityState |
DiscreteState | offline, online | |
CountryCodeState |
DataState | ||
CyclicButtonState |
DiscreteState | pressed, stop | |
LightingLedPodModeState |
ContinuousState | ||
LocalAccessProofState |
DataState | ||
LocalIPv4AddressState |
DataState | ||
NameState |
DataState | ||
UpdateStepAndBootStatusState |
DataState |
Pod (ACTUATOR) — 11 commands, 10 states
Type IDs: 10 | Servers: somfy_europe | Controllable: internal:PodV3Component | Profiles: UpdatableComponent
Commands
| Command | Parameters | Notes |
|---|---|---|
activateCalendar |
Activate Calendar Trigger | |
deactivateCalendar |
deactivate Calendar Trigger | |
getName |
Refresh the device internal name | |
refreshPodMode |
Refresh pod mode | |
refreshUpdateStatus |
Refresh updateStatus | |
setCalendar |
STRING: yes, no | activate/deactivate Calendar Trigger |
setCountryCode |
STRING | Set the ISO 3166-1 Country Code |
setLightingLedPodMode |
FLOAT [0.0..1.0] | Change lighting led pod mode intensity, 0=0% ; 1=100% |
setPodLedOff |
Turn off the pod led | |
setPodLedOn |
Turn on the pod led | |
update |
Update the gateway software. The update may have to be downloaded first, which can take a while. |
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
Button1State |
DiscreteState | pressed, stop | |
Button2State |
DiscreteState | pressed, stop | |
Button3State |
DiscreteState | pressed, stop | |
ConnectivityState |
DiscreteState | offline, online | |
CountryCodeState |
DataState | ||
LightingLedPodModeState |
ContinuousState | ||
LocalAccessProofState |
DataState | ||
LocalIPv4AddressState |
DataState | ||
NameState |
DataState | ||
UpdateStepAndBootStatusState |
DataState |
Pod (ACTUATOR) — 11 commands, 7 states
Type IDs: 11 | Servers: somfy_europe | Controllable: internal:PodV3RDComponent | Profiles: UpdatableComponent
Commands
| Command | Parameters | Notes |
|---|---|---|
activateCalendar |
Activate Calendar Trigger | |
deactivateCalendar |
deactivate Calendar Trigger | |
getName |
Refresh the device internal name | |
refreshPodMode |
Refresh pod mode | |
refreshUpdateStatus |
Refresh updateStatus | |
setCalendar |
STRING: yes, no | activate/deactivate Calendar Trigger |
setCountryCode |
STRING | Set the ISO 3166-1 Country Code |
setLightingLedPodMode |
FLOAT [0.0..1.0] | Change lighting led pod mode intensity, 0=0% ; 1=100% |
setPodLedOff |
Turn off the pod led | |
setPodLedOn |
Turn on the pod led | |
update |
Update the gateway software. The update may have to be downloaded first, which can take a while. |
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
ConnectivityState |
DiscreteState | offline, online | |
CountryCodeState |
DataState | ||
LightingLedPodModeState |
ContinuousState | ||
LocalAccessProofState |
DataState | ||
LocalIPv4AddressState |
DataState | ||
NameState |
DataState | ||
UpdateStepAndBootStatusState |
DataState |
Wifi (ACTUATOR) — 3 commands, 3 states
Type IDs: 9 | Servers: atlantic_cozytouch, hi_kumo_europe, rexel, somfy_europe | Controllable: internal:WifiComponent | Profiles: Specific
Commands
| Command | Parameters | Notes |
|---|---|---|
clearCredentials |
Remove all credentials WARNING: Wi-Fi connectivity will be lost | |
setTargetInfraConfig |
STRING; STRING (sensitive) | p1: contains the SSID. p2: contains the passphrase. |
setWifiMode |
STRING: infrastructure, accesspoint | set wifi mode mode can contains infrastructure, accesspoint. - infrastructure means the box connects to an external network (targetInfraConfig should have been update before) - accesspoint means the box create his own wifi network (needed for Installer app or local mode via wifi) |
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
CurrentInfraConfigState |
DataState | ||
SignalStrengthState |
ContinuousState | ||
WifiModeState |
DataState |
IO
84 device types.
AdjustableSlatsRollerShutter/PositionableOrOrientableRollerShutter (ACTUATOR) — 33 commands, 16 states
Type IDs: 131328, 131330 | Servers: atlantic_cozytouch, hi_kumo_europe, rexel | Controllable: io:AdjustableSlatsRollerShutterIOComponent | Profiles: StatefulRockingShutter, StatefulOrientableOrCloseable, OrientableOrCloseable, StatefulCloseable, Closeable, OpenClose
Data Properties
core:identifyInterval=500
Commands
| Command | Parameters | Notes |
|---|---|---|
addLockLevel |
INT; INT (optional) | Add a command lock level on the device p1 : The lock level to add p2 : (optional) Duration in second of the lock Level. By default there is no expiration. |
advancedRefresh |
STRING: normal, advanced, custom; ARRAY (optional) | Refresh extra states |
close |
Fully close the device | |
delayedStopIdentify |
INT [1..254] | (IO-homecontrol specific) Ask the device to stop winking after a given number of seconds |
down |
Move the device completely down | |
executeManufacturerProcedure |
STRING; OBJECT; OBJECT (optional) | execute manufacturer procedure command. p1: the procedure name p2: the params associated Example: p1 = "dead_man_up" p2 = {"duration": 42} |
getName |
Refresh the device internal name | |
identify |
Ask the device to identify itself by doing a slight movement or blink or beep | |
keepOneWayControllersAndDeleteNode |
Delete 2way key from actuator and delete the device. All one way controllers remain linked to the actuator. | |
open |
Fully open the device | |
pairOneWayController |
STRING; INT [1..16] (optional) | Pair a one way controller to actuator. p1 : Payload of the QRCode associated to the one way controller p2 : channel (Optional - default : 1) |
readManufacturerData |
ARRAY | Read manufacturer data values from given names. Example: ["setting1","setting2"]. |
removeLockLevel |
INT | Remove the command lock level on the device p1 : The lock level to remove |
resetLockLevels |
Remove all lock levels on the device | |
runManufacturerSettingsCommand |
STRING; OBJECT | Send a manufacturer configuration command. p1: The manufacturer configuration command to use p2: The arguments to send to this command |
sendIOKey |
Send the IO key to device. | |
setClosure |
INT [0..100] | Closure level (100%=fully close, 0%=open) |
setClosureOrOrientation |
INT [0..100]; STRING: rocker; INT [0..100] (optional) | Set device closure level (0-100%), or put the device in rocking position ('rocker') and set the relative slats orientation (0-100%) |
setClosureOrRockerPosition |
INT [0..100]; STRING: rocker | Set the device to a relative position (0-100%) or into 'rocker' position |
setConfigState |
STRING: configuration, virgin, close, transmitting | Set the device in configuration state. p1: configuration mode. |
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. |
setOrientation |
INT [0..100] | Set the relative orientation (0-100%) of the device slats |
setRockerPosition |
Set the device into the special 'rocker' position | |
startIdentify |
Ask the device to start winking immediately for an unlimited amount of time | |
stop |
Stop the current actuator behavior (movement, sound or timer) | |
stopIdentify |
Ask the device to stop winking immediately | |
unpairAllOneWayControllers |
Unpair all one way controllers from actuator. | |
unpairAllOneWayControllersAndDeleteNode |
Unpair all one way controllers from actuator. Delete 2way key from actuator and delete the device. | |
unpairOneWayController |
STRING; INT [1..16] (optional) | Unpair a one way controller from actuator. p1 : Payload of the QRCode associated to the one way controller p2 : channel (Optional - default : 1) |
up |
Move the device completely up | |
wink |
INT [1..254] | Ask the device to identify itself by doing a slight movement or blink or beep for a given amount of seconds. |
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 |
|---|---|---|---|
AdditionalStatusState |
DataState | ||
ClosureOrRockerPositionState |
ContinuousState | ||
ClosureState |
ContinuousState | [0..100] | |
CommandLockLevelsState |
DataState | ||
DiscreteRSSILevelState |
DiscreteState | good, low, normal, verylow | |
ManufacturerDiagnosticsState |
DataState | ||
ManufacturerSettingsState |
DataState | ||
MovingState |
DiscreteState | false, true | |
NameState |
DataState | ||
PriorityLockLevelState |
DiscreteState | comfortLevel1, comfortLevel2, comfortLevel3, comfortLevel4, environmentProtection, humanProtection, userLevel1, userLevel2 | |
PriorityLockOriginatorState |
DiscreteState | LSC, SAAC, SFC, UPS, externalGateway, localUser, myself, rain, security, temperature, timer, user, wind | |
PriorityLockTimerState |
ContinuousState | ||
RSSILevelState |
ContinuousState | ||
SlateOrientationState |
ContinuousState | [0..100] | |
StatusState |
DiscreteState | available, unavailable | |
TargetClosureState |
ContinuousState |
AdjustableSlatsRollerShutter/PositionableOrOrientableRollerShutter (ACTUATOR) — 32 commands, 14 states
Type IDs: 131328, 131330 | Servers: somfy_europe | Controllable: io:AdjustableSlatsRollerShutterIOComponent | Profiles: StatefulRockingShutter, StatefulOrientableOrCloseable, OrientableOrCloseable, StatefulCloseable, Closeable, OpenClose
Data Properties
core:identifyInterval=500
Commands
| Command | Parameters | Notes |
|---|---|---|
addLockLevel |
INT; INT (optional) | Add a command lock level on the device p1 : The lock level to add p2 : (optional) Duration in second of the lock Level. By default there is no expiration. |
advancedRefresh |
STRING: normal, advanced, custom; ARRAY (optional) | Refresh extra states |
close |
Fully close the device | |
delayedStopIdentify |
INT [1..254] | (IO-homecontrol specific) Ask the device to stop winking after a given number of seconds |
down |
Move the device completely down | |
executeManufacturerProcedure |
STRING; OBJECT; OBJECT (optional) | execute manufacturer procedure command. p1: the procedure name p2: the params associated Example: p1 = "dead_man_up" p2 = {"duration": 42} |
getName |
Refresh the device internal name | |
identify |
Ask the device to identify itself by doing a slight movement or blink or beep | |
keepOneWayControllersAndDeleteNode |
Delete 2way key from actuator and delete the device. All one way controllers remain linked to the actuator. | |
open |
Fully open the device | |
pairOneWayController |
STRING; INT [1..16] (optional) | Pair a one way controller to actuator. p1 : Payload of the QRCode associated to the one way controller p2 : channel (Optional - default : 1) |
readManufacturerData |
ARRAY | Read manufacturer data values from given names. Example: ["setting1","setting2"]. |
removeLockLevel |
INT | Remove the command lock level on the device p1 : The lock level to remove |
resetLockLevels |
Remove all lock levels on the device | |
sendIOKey |
Send the IO key to device. | |
setClosure |
INT [0..100] | Closure level (100%=fully close, 0%=open) |
setClosureOrOrientation |
INT [0..100]; STRING: rocker; INT [0..100] (optional) | Set device closure level (0-100%), or put the device in rocking position ('rocker') and set the relative slats orientation (0-100%) |
setClosureOrRockerPosition |
INT [0..100]; STRING: rocker | Set the device to a relative position (0-100%) or into 'rocker' position |
setConfigState |
STRING: configuration, virgin, close, transmitting | Set the device in configuration state. p1: configuration mode. |
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. |
setOrientation |
INT [0..100] | Set the relative orientation (0-100%) of the device slats |
setRockerPosition |
Set the device into the special 'rocker' position | |
startIdentify |
Ask the device to start winking immediately for an unlimited amount of time | |
stop |
Stop the current actuator behavior (movement, sound or timer) | |
stopIdentify |
Ask the device to stop winking immediately | |
unpairAllOneWayControllers |
Unpair all one way controllers from actuator. | |
unpairAllOneWayControllersAndDeleteNode |
Unpair all one way controllers from actuator. Delete 2way key from actuator and delete the device. | |
unpairOneWayController |
STRING; INT [1..16] (optional) | Unpair a one way controller from actuator. p1 : Payload of the QRCode associated to the one way controller p2 : channel (Optional - default : 1) |
up |
Move the device completely up | |
wink |
INT [1..254] | Ask the device to identify itself by doing a slight movement or blink or beep for a given amount of seconds. |
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 |
|---|---|---|---|
AdditionalStatusState |
DataState | ||
ClosureOrRockerPositionState |
ContinuousState | ||
ClosureState |
ContinuousState | [0..100] | |
CommandLockLevelsState |
DataState | ||
DiscreteRSSILevelState |
DiscreteState | good, low, normal, verylow | |
MovingState |
DiscreteState | false, true | |
NameState |
DataState | ||
PriorityLockLevelState |
DiscreteState | comfortLevel1, comfortLevel2, comfortLevel3, comfortLevel4, environmentProtection, humanProtection, userLevel1, userLevel2 | |
PriorityLockOriginatorState |
DiscreteState | LSC, SAAC, SFC, UPS, externalGateway, localUser, myself, rain, security, temperature, timer, user, wind | |
PriorityLockTimerState |
ContinuousState | ||
RSSILevelState |
ContinuousState | ||
SlateOrientationState |
ContinuousState | [0..100] | |
StatusState |
DiscreteState | available, unavailable | |
TargetClosureState |
ContinuousState |
Alarm/StatefulAlarmController (ACTUATOR) — 21 commands, 9 states
Type IDs: 1507328 | Servers: atlantic_cozytouch, hi_kumo_europe, rexel, somfy_europe | Controllable: io:AlarmIOComponent | Profiles: Alarm
Data Properties
core:identifyInterval=500
Commands
| Command | Parameters | Notes |
|---|---|---|
addLockLevel |
INT; INT (optional) | Add a command lock level on the device p1 : The lock level to add p2 : (optional) Duration in second of the lock Level. By default there is no expiration. |
advancedRefresh |
STRING: normal, advanced, custom; ARRAY (optional) | Refresh extra states |
alarmOff |
Turn off the alarm (All zones) | |
alarmOn |
Turn the alarm on | |
alarmZoneOn |
STRING: A, B, C, A,B, B,C | Turn on some alarm zones |
arm |
Arm the system | |
delayedStopIdentify |
INT [1..254] | (IO-homecontrol specific) Ask the device to stop winking after a given number of seconds |
disarm |
Disarm the system | |
getName |
Refresh the device internal name | |
identify |
Ask the device to identify itself by doing a slight movement or blink or beep | |
pairOneWayController |
STRING; INT [1..16] (optional) | Pair a one way controller to actuator. p1 : Payload of the QRCode associated to the one way controller p2 : channel (Optional - default : 1) |
refreshState |
Refresh the device states | |
removeLockLevel |
INT | Remove the command lock level on the device p1 : The lock level to remove |
resetLockLevels |
Remove all lock levels on the device | |
setConfigState |
STRING: configuration, virgin, close, transmitting | Set the device in configuration state. p1: configuration mode. |
setName |
STRING | Change the device internal name. Name length may be subject to restrictions depending on the device and underlying protocol. |
startIdentify |
Ask the device to start winking immediately for an unlimited amount of time | |
stopIdentify |
Ask the device to stop winking immediately | |
unpairAllOneWayControllers |
Unpair all one way controllers from actuator. | |
unpairOneWayController |
STRING; INT [1..16] (optional) | Unpair a one way controller from actuator. p1 : Payload of the QRCode associated to the one way controller p2 : channel (Optional - default : 1) |
wink |
INT [1..254] | Ask the device to identify itself by doing a slight movement or blink or beep for a given amount of seconds. |
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
ActiveZonesState |
DataState | ||
CommandLockLevelsState |
DataState | ||
DiscreteRSSILevelState |
DiscreteState | good, low, normal, verylow | |
NameState |
DataState | ||
PriorityLockLevelState |
DiscreteState | comfortLevel1, comfortLevel2, comfortLevel3, comfortLevel4, environmentProtection, humanProtection, userLevel1, userLevel2 | |
PriorityLockOriginatorState |
DiscreteState | LSC, SAAC, SFC, UPS, externalGateway, localUser, myself, rain, security, temperature, timer, user, wind | |
PriorityLockTimerState |
ContinuousState | ||
RSSILevelState |
ContinuousState | ||
StatusState |
DiscreteState | available, unavailable |
Awning/DynamicAwning (ACTUATOR) — 30 commands, 17 states
Type IDs: 18691697868802 | Servers: atlantic_cozytouch, hi_kumo_europe, rexel | Controllable: io:DynamicAwningIOComponent | Profiles: StatefulDeployUndeployAwning, StatefulDeployUndeploy, DeployUndeploy, StatefulDeployable, Deployable
Data Properties
core:identifyInterval=500
Commands
| Command | Parameters | Notes |
|---|---|---|
addLockLevel |
INT; INT (optional) | Add a command lock level on the device p1 : The lock level to add p2 : (optional) Duration in second of the lock Level. By default there is no expiration. |
advancedRefresh |
STRING: normal, advanced, custom; ARRAY (optional) | Refresh extra states |
delayedStopIdentify |
INT [1..254] | (IO-homecontrol specific) Ask the device to stop winking after a given number of seconds |
deploy |
Fully deploy the device | |
executeManufacturerProcedure |
STRING; OBJECT; OBJECT (optional) | execute manufacturer procedure command. p1: the procedure name p2: the params associated Example: p1 = "dead_man_up" p2 = {"duration": 42} |
getName |
Refresh the device internal name | |
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 | |
keepOneWayControllersAndDeleteNode |
Delete 2way key from actuator and delete the device. All one way controllers remain linked to the actuator. | |
pairOneWayController |
STRING; INT [1..16] (optional) | Pair a one way controller to actuator. p1 : Payload of the QRCode associated to the one way controller p2 : channel (Optional - default : 1) |
readManufacturerData |
ARRAY | Read manufacturer data values from given names. Example: ["setting1","setting2"]. |
removeLockLevel |
INT | Remove the command lock level on the device p1 : The lock level to remove |
resetLockLevels |
Remove all lock levels on the device | |
rollOut |
Roll out the device (unfold - deploy - less compact position) | |
rollUp |
Roll up the device (fold - most compact position) | |
runManufacturerSettingsCommand |
STRING; OBJECT | Send a manufacturer configuration command. p1: The manufacturer configuration command to use p2: The arguments to send to this command |
saveAlias |
STRING | Allow to send an order for the product to save the current state of the alias. |
sendIOKey |
Send the IO key to device. | |
setConfigState |
STRING: configuration, virgin, close, transmitting | Set the device in configuration state. p1: configuration mode. |
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. |
setRollingOut |
INT [0..100] | set the device rolling out percentage |
startIdentify |
Ask the device to start winking immediately for an unlimited amount of time | |
stop |
Stop the current actuator behavior (movement, sound or timer) | |
stopIdentify |
Ask the device to stop winking immediately | |
undeploy |
Fully undeploy the device | |
unpairAllOneWayControllers |
Unpair all one way controllers from actuator. | |
unpairAllOneWayControllersAndDeleteNode |
Unpair all one way controllers from actuator. Delete 2way key from actuator and delete the device. | |
unpairOneWayController |
STRING; INT [1..16] (optional) | Unpair a one way controller from actuator. p1 : Payload of the QRCode associated to the one way controller p2 : channel (Optional - default : 1) |
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 |
|---|---|---|---|
AdditionalStatusState |
DataState | ||
BatteryDiscreteLevelState |
DiscreteState | good, medium, low, critical | |
CommandLockLevelsState |
DataState | ||
DeployedUndeployedState |
DiscreteState | deployed, undeployed | |
DeploymentState |
ContinuousState | [0..100] | |
DiscreteRSSILevelState |
DiscreteState | good, low, normal, verylow | |
ManufacturerDiagnosticsState |
DataState | ||
ManufacturerSettingsState |
DataState | ||
NameState |
DataState | ||
PriorityLockLevelState |
DiscreteState | comfortLevel1, comfortLevel2, comfortLevel3, comfortLevel4, environmentProtection, humanProtection, userLevel1, userLevel2 | |
PriorityLockOriginatorState |
DiscreteState | LSC, SAAC, SFC, UPS, externalGateway, localUser, myself, rain, security, temperature, timer, user, wind | |
PriorityLockTimerState |
ContinuousState | ||
RSSILevelState |
ContinuousState | ||
ReachedAliasesState |
DataState | ||
RolledUpState |
DataState | ||
RollingOutState |
ContinuousState | ||
StatusState |
DiscreteState | available, unavailable |
Awning/PositionableHorizontalAwning (ACTUATOR) — 36 commands, 17 states
Type IDs: 1048576 | Servers: atlantic_cozytouch, hi_kumo_europe, rexel | Controllable: io:HorizontalAwningIOComponent | Profiles: StatefulDeployableAwning, StatefulDeployable, Deployable, DeployUndeploy, StatefulOpenClose, OpenClose
Data Properties
core:identifyInterval=500
Commands
| Command | Parameters | Notes |
|---|---|---|
addLockLevel |
INT; INT (optional) | Add a command lock level on the device p1 : The lock level to add p2 : (optional) Duration in second of the lock Level. By default there is no expiration. |
advancedRefresh |
STRING: normal, advanced, custom; ARRAY (optional) | Refresh extra states |
close |
Fully close the device | |
delayedStopIdentify |
INT [1..254] | (IO-homecontrol specific) Ask the device to stop winking after a given number of seconds |
deploy |
Fully deploy the device | |
down |
Move the device completely down | |
executeManufacturerProcedure |
STRING; OBJECT; OBJECT (optional) | execute manufacturer procedure command. p1: the procedure name p2: the params associated Example: p1 = "dead_man_up" p2 = {"duration": 42} |
getName |
Refresh the device internal name | |
identify |
Ask the device to identify itself by doing a slight movement or blink or beep | |
keepOneWayControllersAndDeleteNode |
Delete 2way key from actuator and delete the device. All one way controllers remain linked to the actuator. | |
my |
Set the device to a user pre-defined position | |
open |
Fully open the device | |
pairOneWayController |
STRING; INT [1..16] (optional) | Pair a one way controller to actuator. p1 : Payload of the QRCode associated to the one way controller p2 : channel (Optional - default : 1) |
readManufacturerData |
ARRAY | Read manufacturer data values from given names. Example: ["setting1","setting2"]. |
refreshMemorized1Position |
Refresh memorized 1 position state | |
removeLockLevel |
INT | Remove the command lock level on the device p1 : The lock level to remove |
resetLockLevels |
Remove all lock levels on the device | |
runManufacturerSettingsCommand |
STRING; OBJECT | Send a manufacturer configuration command. p1: The manufacturer configuration command to use p2: The arguments to send to this command |
sendIOKey |
Send the IO key to device. | |
setClosure |
INT [0..100] | Closure level (100%=fully close, 0%=open) |
setConfigState |
STRING: configuration, virgin, close, transmitting | Set the device in configuration state. p1: configuration mode. |
setDeployment |
INT [0..100] | Device deployment level (100%=fully deployed, 0%=fully undeployed) |
setMemorized1Position |
INT [0..100] | Set favorite position |
setName |
STRING | Change the device internal name. Name length may be subject to restrictions depending on the device and underlying protocol. |
setPosition |
STRING: my, memorized1, secured; INT [0..100] | Set the device to a pre-defined position (enum) or a relative position (0-100%) |
setSecuredPosition |
INT [0..100] | Set the relative position value (0-100%) to be used for the 'secured' position alias |
startIdentify |
Ask the device to start winking immediately for an unlimited amount of time | |
stop |
Stop the current actuator behavior (movement, sound or timer) | |
stopIdentify |
Ask the device to stop winking immediately | |
undeploy |
Fully undeploy the device | |
unpairAllOneWayControllers |
Unpair all one way controllers from actuator. | |
unpairAllOneWayControllersAndDeleteNode |
Unpair all one way controllers from actuator. Delete 2way key from actuator and delete the device. | |
unpairOneWayController |
STRING; INT [1..16] (optional) | Unpair a one way controller from actuator. p1 : Payload of the QRCode associated to the one way controller p2 : channel (Optional - default : 1) |
up |
Move the device completely up | |
wink |
INT [1..254] | Ask the device to identify itself by doing a slight movement or blink or beep for a given amount of seconds. |
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 |
|---|---|---|---|
AdditionalStatusState |
DataState | ||
CommandLockLevelsState |
DataState | ||
DeploymentState |
ContinuousState | [0..100] | |
DiscreteRSSILevelState |
DiscreteState | good, low, normal, verylow | |
ManufacturerDiagnosticsState |
DataState | ||
ManufacturerSettingsState |
DataState | ||
Memorized1PositionState |
ContinuousState | ||
MovingState |
DiscreteState | false, true | |
NameState |
DataState | ||
OpenClosedState |
DiscreteState | open, closed | |
PriorityLockLevelState |
DiscreteState | comfortLevel1, comfortLevel2, comfortLevel3, comfortLevel4, environmentProtection, humanProtection, userLevel1, userLevel2 | |
PriorityLockOriginatorState |
DiscreteState | LSC, SAAC, SFC, UPS, externalGateway, localUser, myself, rain, security, temperature, timer, user, wind | |
PriorityLockTimerState |
ContinuousState | ||
RSSILevelState |
ContinuousState | ||
SecuredPositionState |
ContinuousState | ||
StatusState |
DiscreteState | available, unavailable | |
TargetClosureState |
ContinuousState |
Awning/DynamicAwning (ACTUATOR) — 29 commands, 15 states
Type IDs: 18691697868802 | Servers: somfy_europe | Controllable: io:DynamicAwningIOComponent | Profiles: StatefulDeployUndeployAwning, StatefulDeployUndeploy, DeployUndeploy, StatefulDeployable, Deployable
Data Properties
core:identifyInterval=500
Commands
| Command | Parameters | Notes |
|---|---|---|
addLockLevel |
INT; INT (optional) | Add a command lock level on the device p1 : The lock level to add p2 : (optional) Duration in second of the lock Level. By default there is no expiration. |
advancedRefresh |
STRING: normal, advanced, custom; ARRAY (optional) | Refresh extra states |
delayedStopIdentify |
INT [1..254] | (IO-homecontrol specific) Ask the device to stop winking after a given number of seconds |
deploy |
Fully deploy the device | |
executeManufacturerProcedure |
STRING; OBJECT; OBJECT (optional) | execute manufacturer procedure command. p1: the procedure name p2: the params associated Example: p1 = "dead_man_up" p2 = {"duration": 42} |
getName |
Refresh the device internal name | |
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 | |
keepOneWayControllersAndDeleteNode |
Delete 2way key from actuator and delete the device. All one way controllers remain linked to the actuator. | |
pairOneWayController |
STRING; INT [1..16] (optional) | Pair a one way controller to actuator. p1 : Payload of the QRCode associated to the one way controller p2 : channel (Optional - default : 1) |
readManufacturerData |
ARRAY | Read manufacturer data values from given names. Example: ["setting1","setting2"]. |
removeLockLevel |
INT | Remove the command lock level on the device p1 : The lock level to remove |
resetLockLevels |
Remove all lock levels on the device | |
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. |
sendIOKey |
Send the IO key to device. | |
setConfigState |
STRING: configuration, virgin, close, transmitting | Set the device in configuration state. p1: configuration mode. |
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. |
setRollingOut |
INT [0..100] | set the device rolling out percentage |
startIdentify |
Ask the device to start winking immediately for an unlimited amount of time | |
stop |
Stop the current actuator behavior (movement, sound or timer) | |
stopIdentify |
Ask the device to stop winking immediately | |
undeploy |
Fully undeploy the device | |
unpairAllOneWayControllers |
Unpair all one way controllers from actuator. | |
unpairAllOneWayControllersAndDeleteNode |
Unpair all one way controllers from actuator. Delete 2way key from actuator and delete the device. | |
unpairOneWayController |
STRING; INT [1..16] (optional) | Unpair a one way controller from actuator. p1 : Payload of the QRCode associated to the one way controller p2 : channel (Optional - default : 1) |
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 |
|---|---|---|---|
AdditionalStatusState |
DataState | ||
BatteryDiscreteLevelState |
DiscreteState | good, medium, low, critical | |
CommandLockLevelsState |
DataState | ||
DeployedUndeployedState |
DiscreteState | deployed, undeployed | |
DeploymentState |
ContinuousState | [0..100] | |
DiscreteRSSILevelState |
DiscreteState | good, low, normal, verylow | |
NameState |
DataState | ||
PriorityLockLevelState |
DiscreteState | comfortLevel1, comfortLevel2, comfortLevel3, comfortLevel4, environmentProtection, humanProtection, userLevel1, userLevel2 | |
PriorityLockOriginatorState |
DiscreteState | LSC, SAAC, SFC, UPS, externalGateway, localUser, myself, rain, security, temperature, timer, user, wind | |
PriorityLockTimerState |
ContinuousState | ||
RSSILevelState |
ContinuousState | ||
ReachedAliasesState |
DataState | ||
RolledUpState |
DataState | ||
RollingOutState |
ContinuousState | ||
StatusState |
DiscreteState | available, unavailable |
Awning/PositionableHorizontalAwning (ACTUATOR) — 35 commands, 15 states
Type IDs: 1048576 | Servers: somfy_europe | Controllable: io:HorizontalAwningIOComponent | Profiles: StatefulDeployableAwning, StatefulDeployable, Deployable, DeployUndeploy, StatefulOpenClose, OpenClose
Data Properties
core:identifyInterval=500
Commands
| Command | Parameters | Notes |
|---|---|---|
addLockLevel |
INT; INT (optional) | Add a command lock level on the device p1 : The lock level to add p2 : (optional) Duration in second of the lock Level. By default there is no expiration. |
advancedRefresh |
STRING: normal, advanced, custom; ARRAY (optional) | Refresh extra states |
close |
Fully close the device | |
delayedStopIdentify |
INT [1..254] | (IO-homecontrol specific) Ask the device to stop winking after a given number of seconds |
deploy |
Fully deploy the device | |
down |
Move the device completely down | |
executeManufacturerProcedure |
STRING; OBJECT; OBJECT (optional) | execute manufacturer procedure command. p1: the procedure name p2: the params associated Example: p1 = "dead_man_up" p2 = {"duration": 42} |
getName |
Refresh the device internal name | |
identify |
Ask the device to identify itself by doing a slight movement or blink or beep | |
keepOneWayControllersAndDeleteNode |
Delete 2way key from actuator and delete the device. All one way controllers remain linked to the actuator. | |
my |
Set the device to a user pre-defined position | |
open |
Fully open the device | |
pairOneWayController |
STRING; INT [1..16] (optional) | Pair a one way controller to actuator. p1 : Payload of the QRCode associated to the one way controller p2 : channel (Optional - default : 1) |
readManufacturerData |
ARRAY | Read manufacturer data values from given names. Example: ["setting1","setting2"]. |
refreshMemorized1Position |
Refresh memorized 1 position state | |
removeLockLevel |
INT | Remove the command lock level on the device p1 : The lock level to remove |
resetLockLevels |
Remove all lock levels on the device | |
sendIOKey |
Send the IO key to device. | |
setClosure |
INT [0..100] | Closure level (100%=fully close, 0%=open) |
setConfigState |
STRING: configuration, virgin, close, transmitting | Set the device in configuration state. p1: configuration mode. |
setDeployment |
INT [0..100] | Device deployment level (100%=fully deployed, 0%=fully undeployed) |
setMemorized1Position |
INT [0..100] | Set favorite position |
setName |
STRING | Change the device internal name. Name length may be subject to restrictions depending on the device and underlying protocol. |
setPosition |
STRING: my, memorized1, secured; INT [0..100] | Set the device to a pre-defined position (enum) or a relative position (0-100%) |
setSecuredPosition |
INT [0..100] | Set the relative position value (0-100%) to be used for the 'secured' position alias |
startIdentify |
Ask the device to start winking immediately for an unlimited amount of time | |
stop |
Stop the current actuator behavior (movement, sound or timer) | |
stopIdentify |
Ask the device to stop winking immediately | |
undeploy |
Fully undeploy the device | |
unpairAllOneWayControllers |
Unpair all one way controllers from actuator. | |
unpairAllOneWayControllersAndDeleteNode |
Unpair all one way controllers from actuator. Delete 2way key from actuator and delete the device. | |
unpairOneWayController |
STRING; INT [1..16] (optional) | Unpair a one way controller from actuator. p1 : Payload of the QRCode associated to the one way controller p2 : channel (Optional - default : 1) |
up |
Move the device completely up | |
wink |
INT [1..254] | Ask the device to identify itself by doing a slight movement or blink or beep for a given amount of seconds. |
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 |
|---|---|---|---|
AdditionalStatusState |
DataState | ||
CommandLockLevelsState |
DataState | ||
DeploymentState |
ContinuousState | [0..100] | |
DiscreteRSSILevelState |
DiscreteState | good, low, normal, verylow | |
Memorized1PositionState |
ContinuousState | ||
MovingState |
DiscreteState | false, true | |
NameState |
DataState | ||
OpenClosedState |
DiscreteState | open, closed | |
PriorityLockLevelState |
DiscreteState | comfortLevel1, comfortLevel2, comfortLevel3, comfortLevel4, environmentProtection, humanProtection, userLevel1, userLevel2 | |
PriorityLockOriginatorState |
DiscreteState | LSC, SAAC, SFC, UPS, externalGateway, localUser, myself, rain, security, temperature, timer, user, wind | |
PriorityLockTimerState |
ContinuousState | ||
RSSILevelState |
ContinuousState | ||
SecuredPositionState |
ContinuousState | ||
StatusState |
DiscreteState | available, unavailable | |
TargetClosureState |
ContinuousState |
CarButtonSensor (SENSOR) — 0 commands, 2 states
Type IDs: 590336 | Servers: atlantic_cozytouch, hi_kumo_europe, rexel, somfy_europe | Controllable: io:CarButtonIODeviceSensor | Profiles: PushButtonSensor
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
ButtonState |
DiscreteState | pressed, released, shortPressed | |
StatusState |
DiscreteState | available, unavailable |
ConsumptionSensor/CumulativeFossilEnergyConsumptionSensor (SENSOR) — 0 commands, 2 states
Type IDs: 1442316 | Servers: atlantic_cozytouch, hi_kumo_europe, rexel, somfy_europe | Controllable: io:TotalFossilEnergyConsumptionSensor | Profiles: FossilEnergyConsumption
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
FossilEnergyConsumptionState |
ContinuousState | ||
StatusState |
DiscreteState | available, unavailable |
DoorLock (ACTUATOR) — 30 commands, 13 states
Type IDs: 589824, 589826 | Servers: atlantic_cozytouch, hi_kumo_europe, rexel | Controllable: io:DoorLockIOComponent | Profiles: StatefulDoorLockWithOpeningStatus, StatefulLockWithOpeningStatus, StatefulLock, LockStatus, Lock, StatefulBasicOpenClose, BasicOpenClose
Data Properties
core:identifyInterval=500
Commands
| Command | Parameters | Notes |
|---|---|---|
addLockLevel |
INT; INT (optional) | Add a command lock level on the device p1 : The lock level to add p2 : (optional) Duration in second of the lock Level. By default there is no expiration. |
advancedRefresh |
STRING: normal, advanced, custom; ARRAY (optional) | Refresh extra states |
close |
Fully close the device | |
delayedStopIdentify |
INT [1..254] | (IO-homecontrol specific) Ask the device to stop winking after a given number of seconds |
executeManufacturerProcedure |
STRING; OBJECT; OBJECT (optional) | execute manufacturer procedure command. p1: the procedure name p2: the params associated Example: p1 = "dead_man_up" p2 = {"duration": 42} |
getName |
Refresh the device internal name | |
getOpenClose |
Refresh the open/close state of the device | |
identify |
Ask the device to identify itself by doing a slight movement or blink or beep | |
keepOneWayControllersAndDeleteNode |
Delete 2way key from actuator and delete the device. All one way controllers remain linked to the actuator. | |
lock |
Lock the device | |
open |
Fully open the device | |
pairOneWayController |
STRING; INT [1..16] (optional) | Pair a one way controller to actuator. p1 : Payload of the QRCode associated to the one way controller p2 : channel (Optional - default : 1) |
readManufacturerData |
ARRAY | Read manufacturer data values from given names. Example: ["setting1","setting2"]. |
refreshLockedUnlocked |
Refresh locked/unlocked state | |
removeLockLevel |
INT | Remove the command lock level on the device p1 : The lock level to remove |
resetLockLevels |
Remove all lock levels on the device | |
runManufacturerSettingsCommand |
STRING; OBJECT | Send a manufacturer configuration command. p1: The manufacturer configuration command to use p2: The arguments to send to this command |
sendIOKey |
Send the IO key to device. | |
setConfigState |
STRING: configuration, virgin, close, transmitting | Set the device in configuration state. p1: configuration mode. |
setLockedUnlocked |
STRING: locked, unlocked | Set the device state to either 'locked' or 'unlocked' |
setName |
STRING | Change the device internal name. Name length may be subject to restrictions depending on the device and underlying protocol. |
setOpenClosed |
STRING: open, closed | Set the device state to either 'open' or 'closed' |
startIdentify |
Ask the device to start winking immediately for an unlimited amount of time | |
stopIdentify |
Ask the device to stop winking immediately | |
unlock |
Unlock the device | |
unpairAllOneWayControllers |
Unpair all one way controllers from actuator. | |
unpairAllOneWayControllersAndDeleteNode |
Unpair all one way controllers from actuator. Delete 2way key from actuator and delete the device. | |
unpairOneWayController |
STRING; INT [1..16] (optional) | Unpair a one way controller from actuator. p1 : Payload of the QRCode associated to the one way controller p2 : channel (Optional - default : 1) |
wink |
INT [1..254] | Ask the device to identify itself by doing a slight movement or blink or beep for a given amount of seconds. |
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 |
|---|---|---|---|
AdditionalStatusState |
DataState | ||
CommandLockLevelsState |
DataState | ||
DiscreteRSSILevelState |
DiscreteState | good, low, normal, verylow | |
LockedUnlockedState |
DiscreteState | locked, unlocked | |
ManufacturerDiagnosticsState |
DataState | ||
ManufacturerSettingsState |
DataState | ||
NameState |
DataState | ||
OpenClosedState |
DiscreteState | open, closed | |
PriorityLockLevelState |
DiscreteState | comfortLevel1, comfortLevel2, comfortLevel3, comfortLevel4, environmentProtection, humanProtection, userLevel1, userLevel2 | |
PriorityLockOriginatorState |
DiscreteState | LSC, SAAC, SFC, UPS, externalGateway, localUser, myself, rain, security, temperature, timer, user, wind | |
PriorityLockTimerState |
ContinuousState | ||
RSSILevelState |
ContinuousState | ||
StatusState |
DiscreteState | available, unavailable |
DoorLock/WindowLock (ACTUATOR) — 22 commands, 11 states
Type IDs: 590080, 590090 | Servers: atlantic_cozytouch, hi_kumo_europe, rexel, somfy_europe | Controllable: io:WindowLockIOComponent | Profiles: StatefulWindowLockWithOpeningStatus, StatefulLockWithOpeningStatus, StatefulLock, LockStatus, Lock, StatefulBasicOpenClose, BasicOpenClose
Data Properties
core:identifyInterval=500
Commands
| Command | Parameters | Notes |
|---|---|---|
addLockLevel |
INT; INT (optional) | Add a command lock level on the device p1 : The lock level to add p2 : (optional) Duration in second of the lock Level. By default there is no expiration. |
advancedRefresh |
STRING: normal, advanced, custom; ARRAY (optional) | Refresh extra states |
close |
Fully close the device | |
delayedStopIdentify |
INT [1..254] | (IO-homecontrol specific) Ask the device to stop winking after a given number of seconds |
getName |
Refresh the device internal name | |
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 | |
pairOneWayController |
STRING; INT [1..16] (optional) | Pair a one way controller to actuator. p1 : Payload of the QRCode associated to the one way controller p2 : channel (Optional - default : 1) |
removeLockLevel |
INT | Remove the command lock level on the device p1 : The lock level to remove |
resetLockLevels |
Remove all lock levels on the device | |
setConfigState |
STRING: configuration, virgin, close, transmitting | Set the device in configuration state. p1: configuration mode. |
setLockPosition |
ANY | |
setLockedUnlocked |
STRING: locked, unlocked | Set the device state to either 'locked' or 'unlocked' |
setName |
STRING | Change the device internal name. Name length may be subject to restrictions depending on the device and underlying protocol. |
setOpenClosed |
STRING: open, closed | Set the device state to either 'open' or 'closed' |
startIdentify |
Ask the device to start winking immediately for an unlimited amount of time | |
stopIdentify |
Ask the device to stop winking immediately | |
unlock |
Unlock the device | |
unpairAllOneWayControllers |
Unpair all one way controllers from actuator. | |
unpairOneWayController |
STRING; INT [1..16] (optional) | Unpair a one way controller from actuator. p1 : Payload of the QRCode associated to the one way controller p2 : channel (Optional - default : 1) |
wink |
INT [1..254] | Ask the device to identify itself by doing a slight movement or blink or beep for a given amount of seconds. |
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
CommandLockLevelsState |
DataState | ||
DiscreteRSSILevelState |
DiscreteState | good, low, normal, verylow | |
LockedUnlockedState |
DiscreteState | locked, unlocked | |
NameState |
DataState | ||
OpenClosedState |
DiscreteState | open, closed | |
PriorityLockLevelState |
DiscreteState | comfortLevel1, comfortLevel2, comfortLevel3, comfortLevel4, environmentProtection, humanProtection, userLevel1, userLevel2 | |
PriorityLockOriginatorState |
DiscreteState | LSC, SAAC, SFC, UPS, externalGateway, localUser, myself, rain, security, temperature, timer, user, wind | |
PriorityLockTimerState |
ContinuousState | ||
RSSILevelState |
ContinuousState | ||
StatusState |
DiscreteState | available, unavailable | |
WindowLockedState |
DiscreteState | daylocked, homesecure, secured |
DoorLock/CarLock (ACTUATOR) — 22 commands, 10 states
Type IDs: 590336 | Servers: atlantic_cozytouch, hi_kumo_europe, rexel, somfy_europe | Controllable: io:CarLockIOComponent | Profiles: StatefulCarLockWithOpeningStatus, StatefulLockWithOpeningStatus, StatefulLock, LockStatus, Lock, StatefulOpenClose, OpenClose
Data Properties
core:identifyInterval=500
Commands
| Command | Parameters | Notes |
|---|---|---|
addLockLevel |
INT; INT (optional) | Add a command lock level on the device p1 : The lock level to add p2 : (optional) Duration in second of the lock Level. By default there is no expiration. |
advancedRefresh |
STRING: normal, advanced, custom; ARRAY (optional) | Refresh extra states |
close |
Fully close the device | |
delayedStopIdentify |
INT [1..254] | (IO-homecontrol specific) Ask the device to stop winking after a given number of seconds |
getName |
Refresh the device internal name | |
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 | |
pairOneWayController |
STRING; INT [1..16] (optional) | Pair a one way controller to actuator. p1 : Payload of the QRCode associated to the one way controller p2 : channel (Optional - default : 1) |
removeLockLevel |
INT | Remove the command lock level on the device p1 : The lock level to remove |
resetLockLevels |
Remove all lock levels on the device | |
setConfigState |
STRING: configuration, virgin, close, transmitting | Set the device in configuration state. p1: configuration mode. |
setLockedUnlocked |
STRING: locked, unlocked | Set the device state to either 'locked' or 'unlocked' |
setName |
STRING | Change the device internal name. Name length may be subject to restrictions depending on the device and underlying protocol. |
setOpenClosed |
STRING: open, closed | Set the device state to either 'open' or 'closed' |
startIdentify |
Ask the device to start winking immediately for an unlimited amount of time | |
stop |
Stop the current actuator behavior (movement, sound or timer) | |
stopIdentify |
Ask the device to stop winking immediately | |
unlock |
Unlock the device | |
unpairAllOneWayControllers |
Unpair all one way controllers from actuator. | |
unpairOneWayController |
STRING; INT [1..16] (optional) | Unpair a one way controller from actuator. p1 : Payload of the QRCode associated to the one way controller p2 : channel (Optional - default : 1) |
wink |
INT [1..254] | Ask the device to identify itself by doing a slight movement or blink or beep for a given amount of seconds. |
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
CommandLockLevelsState |
DataState | ||
DiscreteRSSILevelState |
DiscreteState | good, low, normal, verylow | |
LockedUnlockedState |
DiscreteState | locked, unlocked | |
NameState |
DataState | ||
OpenClosedState |
DiscreteState | open, closed | |
PriorityLockLevelState |
DiscreteState | comfortLevel1, comfortLevel2, comfortLevel3, comfortLevel4, environmentProtection, humanProtection, userLevel1, userLevel2 | |
PriorityLockOriginatorState |
DiscreteState | LSC, SAAC, SFC, UPS, externalGateway, localUser, myself, rain, security, temperature, timer, user, wind | |
PriorityLockTimerState |
ContinuousState | ||
RSSILevelState |
ContinuousState | ||
StatusState |
DiscreteState | available, unavailable |
DoorLock (ACTUATOR) — 29 commands, 11 states
Type IDs: 589824, 589826 | Servers: somfy_europe | Controllable: io:DoorLockIOComponent | Profiles: StatefulDoorLockWithOpeningStatus, StatefulLockWithOpeningStatus, StatefulLock, LockStatus, Lock, StatefulBasicOpenClose, BasicOpenClose
Data Properties
core:identifyInterval=500
Commands
| Command | Parameters | Notes |
|---|---|---|
addLockLevel |
INT; INT (optional) | Add a command lock level on the device p1 : The lock level to add p2 : (optional) Duration in second of the lock Level. By default there is no expiration. |
advancedRefresh |
STRING: normal, advanced, custom; ARRAY (optional) | Refresh extra states |
close |
Fully close the device | |
delayedStopIdentify |
INT [1..254] | (IO-homecontrol specific) Ask the device to stop winking after a given number of seconds |
executeManufacturerProcedure |
STRING; OBJECT; OBJECT (optional) | execute manufacturer procedure command. p1: the procedure name p2: the params associated Example: p1 = "dead_man_up" p2 = {"duration": 42} |
getName |
Refresh the device internal name | |
getOpenClose |
Refresh the open/close state of the device | |
identify |
Ask the device to identify itself by doing a slight movement or blink or beep | |
keepOneWayControllersAndDeleteNode |
Delete 2way key from actuator and delete the device. All one way controllers remain linked to the actuator. | |
lock |
Lock the device | |
open |
Fully open the device | |
pairOneWayController |
STRING; INT [1..16] (optional) | Pair a one way controller to actuator. p1 : Payload of the QRCode associated to the one way controller p2 : channel (Optional - default : 1) |
readManufacturerData |
ARRAY | Read manufacturer data values from given names. Example: ["setting1","setting2"]. |
refreshLockedUnlocked |
Refresh locked/unlocked state | |
removeLockLevel |
INT | Remove the command lock level on the device p1 : The lock level to remove |
resetLockLevels |
Remove all lock levels on the device | |
sendIOKey |
Send the IO key to device. | |
setConfigState |
STRING: configuration, virgin, close, transmitting | Set the device in configuration state. p1: configuration mode. |
setLockedUnlocked |
STRING: locked, unlocked | Set the device state to either 'locked' or 'unlocked' |
setName |
STRING | Change the device internal name. Name length may be subject to restrictions depending on the device and underlying protocol. |
setOpenClosed |
STRING: open, closed | Set the device state to either 'open' or 'closed' |
startIdentify |
Ask the device to start winking immediately for an unlimited amount of time | |
stopIdentify |
Ask the device to stop winking immediately | |
unlock |
Unlock the device | |
unpairAllOneWayControllers |
Unpair all one way controllers from actuator. | |
unpairAllOneWayControllersAndDeleteNode |
Unpair all one way controllers from actuator. Delete 2way key from actuator and delete the device. | |
unpairOneWayController |
STRING; INT [1..16] (optional) | Unpair a one way controller from actuator. p1 : Payload of the QRCode associated to the one way controller p2 : channel (Optional - default : 1) |
wink |
INT [1..254] | Ask the device to identify itself by doing a slight movement or blink or beep for a given amount of seconds. |
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 |
|---|---|---|---|
AdditionalStatusState |
DataState | ||
CommandLockLevelsState |
DataState | ||
DiscreteRSSILevelState |
DiscreteState | good, low, normal, verylow | |
LockedUnlockedState |
DiscreteState | locked, unlocked | |
NameState |
DataState | ||
OpenClosedState |
DiscreteState | open, closed | |
PriorityLockLevelState |
DiscreteState | comfortLevel1, comfortLevel2, comfortLevel3, comfortLevel4, environmentProtection, humanProtection, userLevel1, userLevel2 | |
PriorityLockOriginatorState |
DiscreteState | LSC, SAAC, SFC, UPS, externalGateway, localUser, myself, rain, security, temperature, timer, user, wind | |
PriorityLockTimerState |
ContinuousState | ||
RSSILevelState |
ContinuousState | ||
StatusState |
DiscreteState | available, unavailable |
ElectricitySensor/CumulativeElectricPowerConsumptionSensor (SENSOR) — 0 commands, 12 states
Type IDs: 1442060 | Servers: atlantic_cozytouch, hi_kumo_europe, rexel, somfy_europe | Controllable: io:TotalElectricalEnergyConsumptionSensor | Profiles: ElectricEnergyConsumption
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
ConsumptionTariff0State |
ContinuousState | ||
ConsumptionTariff1State |
ContinuousState | ||
ConsumptionTariff2State |
ContinuousState | ||
ConsumptionTariff3State |
ContinuousState | ||
ConsumptionTariff4State |
ContinuousState | ||
ConsumptionTariff5State |
ContinuousState | ||
ConsumptionTariff6State |
ContinuousState | ||
ConsumptionTariff7State |
ContinuousState | ||
ConsumptionTariff8State |
ContinuousState | ||
ConsumptionTariff9State |
ContinuousState | ||
ElectricEnergyConsumptionState |
ContinuousState | ||
StatusState |
DiscreteState | available, unavailable |
ExteriorHeatingSystem/DimmerExteriorHeating (ACTUATOR) — 28 commands, 13 states
Type IDs: 1376258 | Servers: atlantic_cozytouch, hi_kumo_europe, rexel | Controllable: io:ExteriorHeatingIOComponent | Profiles: StatefulLevelControlHeating, StatefulLevelControl, LevelControl, Switchable
Data Properties
core:identifyInterval=500
Commands
| Command | Parameters | Notes |
|---|---|---|
addLockLevel |
INT; INT (optional) | Add a command lock level on the device p1 : The lock level to add p2 : (optional) Duration in second of the lock Level. By default there is no expiration. |
advancedRefresh |
STRING: normal, advanced, custom; ARRAY (optional) | Refresh extra states |
delayedStopIdentify |
INT [1..254] | (IO-homecontrol specific) Ask the device to stop winking after a given number of seconds |
executeManufacturerProcedure |
STRING; OBJECT; OBJECT (optional) | execute manufacturer procedure command. p1: the procedure name p2: the params associated Example: p1 = "dead_man_up" p2 = {"duration": 42} |
getLevel |
||
getName |
Refresh the device internal name | |
identify |
Ask the device to identify itself by doing a slight movement or blink or beep | |
keepOneWayControllersAndDeleteNode |
Delete 2way key from actuator and delete the device. All one way controllers remain linked to the actuator. | |
my |
Set the device to a user pre-defined position | |
off |
Turn off the device | |
on |
Turn on the device | |
pairOneWayController |
STRING; INT [1..16] (optional) | Pair a one way controller to actuator. p1 : Payload of the QRCode associated to the one way controller p2 : channel (Optional - default : 1) |
readManufacturerData |
ARRAY | Read manufacturer data values from given names. Example: ["setting1","setting2"]. |
removeLockLevel |
INT | Remove the command lock level on the device p1 : The lock level to remove |
resetLockLevels |
Remove all lock levels on the device | |
runManufacturerSettingsCommand |
STRING; OBJECT | Send a manufacturer configuration command. p1: The manufacturer configuration command to use p2: The arguments to send to this command |
sendIOKey |
Send the IO key to device. | |
setConfigState |
STRING: configuration, virgin, close, transmitting | Set the device in configuration state. p1: configuration mode. |
setLevel |
INT [0..100]; STRING: memorized1, my | Generic device working level (0-100%) Functional meaning depends on device |
setMemorized1Position |
INT [0..100] | Set favorite position |
setName |
STRING | Change the device internal name. Name length may be subject to restrictions depending on the device and underlying protocol. |
startIdentify |
Ask the device to start winking immediately for an unlimited amount of time | |
stopIdentify |
Ask the device to stop winking immediately | |
unpairAllOneWayControllers |
Unpair all one way controllers from actuator. | |
unpairAllOneWayControllersAndDeleteNode |
Unpair all one way controllers from actuator. Delete 2way key from actuator and delete the device. | |
unpairOneWayController |
STRING; INT [1..16] (optional) | Unpair a one way controller from actuator. p1 : Payload of the QRCode associated to the one way controller p2 : channel (Optional - default : 1) |
wink |
INT [1..254] | Ask the device to identify itself by doing a slight movement or blink or beep for a given amount of seconds. |
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 |
|---|---|---|---|
AdditionalStatusState |
DataState | ||
CommandLockLevelsState |
DataState | ||
DiscreteRSSILevelState |
DiscreteState | good, low, normal, verylow | |
LevelState |
ContinuousState | [0..100] | |
ManufacturerDiagnosticsState |
DataState | ||
ManufacturerSettingsState |
DataState | ||
Memorized1PositionState |
ContinuousState | ||
NameState |
DataState | ||
PriorityLockLevelState |
DiscreteState | comfortLevel1, comfortLevel2, comfortLevel3, comfortLevel4, environmentProtection, humanProtection, userLevel1, userLevel2 | |
PriorityLockOriginatorState |
DiscreteState | LSC, SAAC, SFC, UPS, externalGateway, localUser, myself, rain, security, temperature, timer, user, wind | |
PriorityLockTimerState |
ContinuousState | ||
RSSILevelState |
ContinuousState | ||
StatusState |
DiscreteState | available, unavailable |
ExteriorHeatingSystem/DiscreteExteriorHeating (ACTUATOR) — 24 commands, 12 states
Type IDs: 1391106 | Servers: atlantic_cozytouch, hi_kumo_europe, rexel | Controllable: io:DiscreteExteriorHeatingIOComponent | Profiles: StatefulSwitchableHeating, StatefulSwitchable, Switchable
Data Properties
core:identifyInterval=500
Commands
| Command | Parameters | Notes |
|---|---|---|
addLockLevel |
INT; INT (optional) | Add a command lock level on the device p1 : The lock level to add p2 : (optional) Duration in second of the lock Level. By default there is no expiration. |
advancedRefresh |
STRING: normal, advanced, custom; ARRAY (optional) | Refresh extra states |
delayedStopIdentify |
INT [1..254] | (IO-homecontrol specific) Ask the device to stop winking after a given number of seconds |
executeManufacturerProcedure |
STRING; OBJECT; OBJECT (optional) | execute manufacturer procedure command. p1: the procedure name p2: the params associated Example: p1 = "dead_man_up" p2 = {"duration": 42} |
getName |
Refresh the device internal name | |
identify |
Ask the device to identify itself by doing a slight movement or blink or beep | |
keepOneWayControllersAndDeleteNode |
Delete 2way key from actuator and delete the device. All one way controllers remain linked to the actuator. | |
off |
Turn off the device | |
on |
Turn on the device | |
pairOneWayController |
STRING; INT [1..16] (optional) | Pair a one way controller to actuator. p1 : Payload of the QRCode associated to the one way controller p2 : channel (Optional - default : 1) |
readManufacturerData |
ARRAY | Read manufacturer data values from given names. Example: ["setting1","setting2"]. |
removeLockLevel |
INT | Remove the command lock level on the device p1 : The lock level to remove |
resetLockLevels |
Remove all lock levels on the device | |
runManufacturerSettingsCommand |
STRING; OBJECT | Send a manufacturer configuration command. p1: The manufacturer configuration command to use p2: The arguments to send to this command |
sendIOKey |
Send the IO key to device. | |
setConfigState |
STRING: configuration, virgin, close, transmitting | Set the device in configuration state. p1: configuration mode. |
setName |
STRING | Change the device internal name. Name length may be subject to restrictions depending on the device and underlying protocol. |
startIdentify |
Ask the device to start winking immediately for an unlimited amount of time | |
stopIdentify |
Ask the device to stop winking immediately | |
unpairAllOneWayControllers |
Unpair all one way controllers from actuator. | |
unpairAllOneWayControllersAndDeleteNode |
Unpair all one way controllers from actuator. Delete 2way key from actuator and delete the device. | |
unpairOneWayController |
STRING; INT [1..16] (optional) | Unpair a one way controller from actuator. p1 : Payload of the QRCode associated to the one way controller p2 : channel (Optional - default : 1) |
wink |
INT [1..254] | Ask the device to identify itself by doing a slight movement or blink or beep for a given amount of seconds. |
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 |
|---|---|---|---|
AdditionalStatusState |
DataState | ||
CommandLockLevelsState |
DataState | ||
DiscreteRSSILevelState |
DiscreteState | good, low, normal, verylow | |
ManufacturerDiagnosticsState |
DataState | ||
ManufacturerSettingsState |
DataState | ||
NameState |
DataState | ||
OnOffState |
DiscreteState | on, off | |
PriorityLockLevelState |
DiscreteState | comfortLevel1, comfortLevel2, comfortLevel3, comfortLevel4, environmentProtection, humanProtection, userLevel1, userLevel2 | |
PriorityLockOriginatorState |
DiscreteState | LSC, SAAC, SFC, UPS, externalGateway, localUser, myself, rain, security, temperature, timer, user, wind | |
PriorityLockTimerState |
ContinuousState | ||
RSSILevelState |
ContinuousState | ||
StatusState |
DiscreteState | available, unavailable |
ExteriorHeatingSystem/DimmerExteriorHeating (ACTUATOR) — 27 commands, 11 states
Type IDs: 1376258 | Servers: somfy_europe | Controllable: io:ExteriorHeatingIOComponent | Profiles: StatefulLevelControlHeating, StatefulLevelControl, LevelControl, Switchable
Data Properties
core:identifyInterval=500
Commands
| Command | Parameters | Notes |
|---|---|---|
addLockLevel |
INT; INT (optional) | Add a command lock level on the device p1 : The lock level to add p2 : (optional) Duration in second of the lock Level. By default there is no expiration. |
advancedRefresh |
STRING: normal, advanced, custom; ARRAY (optional) | Refresh extra states |
delayedStopIdentify |
INT [1..254] | (IO-homecontrol specific) Ask the device to stop winking after a given number of seconds |
executeManufacturerProcedure |
STRING; OBJECT; OBJECT (optional) | execute manufacturer procedure command. p1: the procedure name p2: the params associated Example: p1 = "dead_man_up" p2 = {"duration": 42} |
getLevel |
||
getName |
Refresh the device internal name | |
identify |
Ask the device to identify itself by doing a slight movement or blink or beep | |
keepOneWayControllersAndDeleteNode |
Delete 2way key from actuator and delete the device. All one way controllers remain linked to the actuator. | |
my |
Set the device to a user pre-defined position | |
off |
Turn off the device | |
on |
Turn on the device | |
pairOneWayController |
STRING; INT [1..16] (optional) | Pair a one way controller to actuator. p1 : Payload of the QRCode associated to the one way controller p2 : channel (Optional - default : 1) |
readManufacturerData |
ARRAY | Read manufacturer data values from given names. Example: ["setting1","setting2"]. |
removeLockLevel |
INT | Remove the command lock level on the device p1 : The lock level to remove |
resetLockLevels |
Remove all lock levels on the device | |
sendIOKey |
Send the IO key to device. | |
setConfigState |
STRING: configuration, virgin, close, transmitting | Set the device in configuration state. p1: configuration mode. |
setLevel |
INT [0..100]; STRING: memorized1, my | Generic device working level (0-100%) Functional meaning depends on device |
setMemorized1Position |
INT [0..100] | Set favorite position |
setName |
STRING | Change the device internal name. Name length may be subject to restrictions depending on the device and underlying protocol. |
startIdentify |
Ask the device to start winking immediately for an unlimited amount of time | |
stopIdentify |
Ask the device to stop winking immediately | |
unpairAllOneWayControllers |
Unpair all one way controllers from actuator. | |
unpairAllOneWayControllersAndDeleteNode |
Unpair all one way controllers from actuator. Delete 2way key from actuator and delete the device. | |
unpairOneWayController |
STRING; INT [1..16] (optional) | Unpair a one way controller from actuator. p1 : Payload of the QRCode associated to the one way controller p2 : channel (Optional - default : 1) |
wink |
INT [1..254] | Ask the device to identify itself by doing a slight movement or blink or beep for a given amount of seconds. |
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 |
|---|---|---|---|
AdditionalStatusState |
DataState | ||
CommandLockLevelsState |
DataState | ||
DiscreteRSSILevelState |
DiscreteState | good, low, normal, verylow | |
LevelState |
ContinuousState | [0..100] | |
Memorized1PositionState |
ContinuousState | ||
NameState |
DataState | ||
PriorityLockLevelState |
DiscreteState | comfortLevel1, comfortLevel2, comfortLevel3, comfortLevel4, environmentProtection, humanProtection, userLevel1, userLevel2 | |
PriorityLockOriginatorState |
DiscreteState | LSC, SAAC, SFC, UPS, externalGateway, localUser, myself, rain, security, temperature, timer, user, wind | |
PriorityLockTimerState |
ContinuousState | ||
RSSILevelState |
ContinuousState | ||
StatusState |
DiscreteState | available, unavailable |
ExteriorHeatingSystem/DiscreteExteriorHeating (ACTUATOR) — 23 commands, 10 states
Type IDs: 1391106 | Servers: somfy_europe | Controllable: io:DiscreteExteriorHeatingIOComponent | Profiles: StatefulSwitchableHeating, StatefulSwitchable, Switchable
Data Properties
core:identifyInterval=500
Commands
| Command | Parameters | Notes |
|---|---|---|
addLockLevel |
INT; INT (optional) | Add a command lock level on the device p1 : The lock level to add p2 : (optional) Duration in second of the lock Level. By default there is no expiration. |
advancedRefresh |
STRING: normal, advanced, custom; ARRAY (optional) | Refresh extra states |
delayedStopIdentify |
INT [1..254] | (IO-homecontrol specific) Ask the device to stop winking after a given number of seconds |
executeManufacturerProcedure |
STRING; OBJECT; OBJECT (optional) | execute manufacturer procedure command. p1: the procedure name p2: the params associated Example: p1 = "dead_man_up" p2 = {"duration": 42} |
getName |
Refresh the device internal name | |
identify |
Ask the device to identify itself by doing a slight movement or blink or beep | |
keepOneWayControllersAndDeleteNode |
Delete 2way key from actuator and delete the device. All one way controllers remain linked to the actuator. | |
off |
Turn off the device | |
on |
Turn on the device | |
pairOneWayController |
STRING; INT [1..16] (optional) | Pair a one way controller to actuator. p1 : Payload of the QRCode associated to the one way controller p2 : channel (Optional - default : 1) |
readManufacturerData |
ARRAY | Read manufacturer data values from given names. Example: ["setting1","setting2"]. |
removeLockLevel |
INT | Remove the command lock level on the device p1 : The lock level to remove |
resetLockLevels |
Remove all lock levels on the device | |
sendIOKey |
Send the IO key to device. | |
setConfigState |
STRING: configuration, virgin, close, transmitting | Set the device in configuration state. p1: configuration mode. |
setName |
STRING | Change the device internal name. Name length may be subject to restrictions depending on the device and underlying protocol. |
startIdentify |
Ask the device to start winking immediately for an unlimited amount of time | |
stopIdentify |
Ask the device to stop winking immediately | |
unpairAllOneWayControllers |
Unpair all one way controllers from actuator. | |
unpairAllOneWayControllersAndDeleteNode |
Unpair all one way controllers from actuator. Delete 2way key from actuator and delete the device. | |
unpairOneWayController |
STRING; INT [1..16] (optional) | Unpair a one way controller from actuator. p1 : Payload of the QRCode associated to the one way controller p2 : channel (Optional - default : 1) |
wink |
INT [1..254] | Ask the device to identify itself by doing a slight movement or blink or beep for a given amount of seconds. |
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 |
|---|---|---|---|
AdditionalStatusState |
DataState | ||
CommandLockLevelsState |
DataState | ||
DiscreteRSSILevelState |
DiscreteState | good, low, normal, verylow | |
NameState |
DataState | ||
OnOffState |
DiscreteState | on, off | |
PriorityLockLevelState |
DiscreteState | comfortLevel1, comfortLevel2, comfortLevel3, comfortLevel4, environmentProtection, humanProtection, userLevel1, userLevel2 | |
PriorityLockOriginatorState |
DiscreteState | LSC, SAAC, SFC, UPS, externalGateway, localUser, myself, rain, security, temperature, timer, user, wind | |
PriorityLockTimerState |
ContinuousState | ||
RSSILevelState |
ContinuousState | ||
StatusState |
DiscreteState | available, unavailable |
ExteriorScreen/PositionableScreen (ACTUATOR) — 36 commands, 18 states
Type IDs: 196608, 196610 | Servers: atlantic_cozytouch, hi_kumo_europe, rexel | Controllable: io:VerticalExteriorAwningIOComponent | Profiles: StatefulDeployableVerticalAwning, StatefulDeployable, Deployable, DeployUndeploy, StatefulCloseable, StatefulOpenClose, OpenClose
Data Properties
core:identifyInterval=500
Commands
| Command | Parameters | Notes |
|---|---|---|
addLockLevel |
INT; INT (optional) | Add a command lock level on the device p1 : The lock level to add p2 : (optional) Duration in second of the lock Level. By default there is no expiration. |
advancedRefresh |
STRING: normal, advanced, custom; ARRAY (optional) | Refresh extra states |
close |
Fully close the device | |
delayedStopIdentify |
INT [1..254] | (IO-homecontrol specific) Ask the device to stop winking after a given number of seconds |
deploy |
Fully deploy the device | |
down |
Move the device completely down | |
executeManufacturerProcedure |
STRING; OBJECT; OBJECT (optional) | execute manufacturer procedure command. p1: the procedure name p2: the params associated Example: p1 = "dead_man_up" p2 = {"duration": 42} |
getName |
Refresh the device internal name | |
identify |
Ask the device to identify itself by doing a slight movement or blink or beep | |
keepOneWayControllersAndDeleteNode |
Delete 2way key from actuator and delete the device. All one way controllers remain linked to the actuator. | |
my |
Set the device to a user pre-defined position | |
open |
Fully open the device | |
pairOneWayController |
STRING; INT [1..16] (optional) | Pair a one way controller to actuator. p1 : Payload of the QRCode associated to the one way controller p2 : channel (Optional - default : 1) |
readManufacturerData |
ARRAY | Read manufacturer data values from given names. Example: ["setting1","setting2"]. |
refreshMemorized1Position |
Refresh memorized 1 position state | |
removeLockLevel |
INT | Remove the command lock level on the device p1 : The lock level to remove |
resetLockLevels |
Remove all lock levels on the device | |
runManufacturerSettingsCommand |
STRING; OBJECT | Send a manufacturer configuration command. p1: The manufacturer configuration command to use p2: The arguments to send to this command |
sendIOKey |
Send the IO key to device. | |
setClosure |
INT [0..100] | Closure level (100%=fully close, 0%=open) |
setConfigState |
STRING: configuration, virgin, close, transmitting | Set the device in configuration state. p1: configuration mode. |
setDeployment |
INT [0..100] | Device deployment level (100%=fully deployed, 0%=fully undeployed) |
setMemorized1Position |
INT [0..100] | Set favorite position |
setName |
STRING | Change the device internal name. Name length may be subject to restrictions depending on the device and underlying protocol. |
setPosition |
STRING: my, memorized1, secured; INT [0..100] | Set the device to a pre-defined position (enum) or a relative position (0-100%) |
setSecuredPosition |
INT [0..100] | Set the relative position value (0-100%) to be used for the 'secured' position alias |
startIdentify |
Ask the device to start winking immediately for an unlimited amount of time | |
stop |
Stop the current actuator behavior (movement, sound or timer) | |
stopIdentify |
Ask the device to stop winking immediately | |
undeploy |
Fully undeploy the device | |
unpairAllOneWayControllers |
Unpair all one way controllers from actuator. | |
unpairAllOneWayControllersAndDeleteNode |
Unpair all one way controllers from actuator. Delete 2way key from actuator and delete the device. | |
unpairOneWayController |
STRING; INT [1..16] (optional) | Unpair a one way controller from actuator. p1 : Payload of the QRCode associated to the one way controller p2 : channel (Optional - default : 1) |
up |
Move the device completely up | |
wink |
INT [1..254] | Ask the device to identify itself by doing a slight movement or blink or beep for a given amount of seconds. |
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 |
|---|---|---|---|
AdditionalStatusState |
DataState | ||
ClosureState |
ContinuousState | [0..100] | |
CommandLockLevelsState |
DataState | ||
DeploymentState |
ContinuousState | [0..100] | |
DiscreteRSSILevelState |
DiscreteState | good, low, normal, verylow | |
ManufacturerDiagnosticsState |
DataState | ||
ManufacturerSettingsState |
DataState | ||
Memorized1PositionState |
ContinuousState | ||
MovingState |
DiscreteState | false, true | |
NameState |
DataState | ||
OpenClosedState |
DiscreteState | open, closed | |
PriorityLockLevelState |
DiscreteState | comfortLevel1, comfortLevel2, comfortLevel3, comfortLevel4, environmentProtection, humanProtection, userLevel1, userLevel2 | |
PriorityLockOriginatorState |
DiscreteState | LSC, SAAC, SFC, UPS, externalGateway, localUser, myself, rain, security, temperature, timer, user, wind | |
PriorityLockTimerState |
ContinuousState | ||
RSSILevelState |
ContinuousState | ||
SecuredPositionState |
ContinuousState | ||
StatusState |
DiscreteState | available, unavailable | |
TargetClosureState |
ContinuousState |
ExteriorScreen/PositionableScreen (ACTUATOR) — 33 commands, 17 states
Type IDs: 196609 | Servers: atlantic_cozytouch, hi_kumo_europe, rexel | Controllable: io:VerticalExteriorAwningVeluxIOComponent | Profiles: StatefulDeployableVerticalAwning, StatefulDeployable, Deployable, DeployUndeploy, StatefulCloseable, StatefulOpenClose, OpenClose
Data Properties
core:identifyInterval=500
Commands
| Command | Parameters | Notes |
|---|---|---|
addLockLevel |
INT; INT (optional) | Add a command lock level on the device p1 : The lock level to add p2 : (optional) Duration in second of the lock Level. By default there is no expiration. |
advancedRefresh |
STRING: normal, advanced, custom; ARRAY (optional) | Refresh extra states |
close |
Fully close the device | |
delayedStopIdentify |
INT [1..254] | (IO-homecontrol specific) Ask the device to stop winking after a given number of seconds |
deploy |
Fully deploy the device | |
down |
Move the device completely down | |
executeManufacturerProcedure |
STRING; OBJECT; OBJECT (optional) | execute manufacturer procedure command. p1: the procedure name p2: the params associated Example: p1 = "dead_man_up" p2 = {"duration": 42} |
getName |
Refresh the device internal name | |
identify |
Ask the device to identify itself by doing a slight movement or blink or beep | |
keepOneWayControllersAndDeleteNode |
Delete 2way key from actuator and delete the device. All one way controllers remain linked to the actuator. | |
open |
Fully open the device | |
pairOneWayController |
STRING; INT [1..16] (optional) | Pair a one way controller to actuator. p1 : Payload of the QRCode associated to the one way controller p2 : channel (Optional - default : 1) |
readManufacturerData |
ARRAY | Read manufacturer data values from given names. Example: ["setting1","setting2"]. |
removeLockLevel |
INT | Remove the command lock level on the device p1 : The lock level to remove |
resetLockLevels |
Remove all lock levels on the device | |
runManufacturerSettingsCommand |
STRING; OBJECT | Send a manufacturer configuration command. p1: The manufacturer configuration command to use p2: The arguments to send to this command |
sendIOKey |
Send the IO key to device. | |
setClosure |
INT [0..100] | Closure level (100%=fully close, 0%=open) |
setConfigState |
STRING: configuration, virgin, close, transmitting | Set the device in configuration state. p1: configuration mode. |
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. |
setPosition |
STRING: secured; INT [0..100] | Set the device to a pre-defined position (enum) or a relative position (0-100%) |
setSecuredPosition |
INT [0..100] | Set the relative position value (0-100%) to be used for the 'secured' position alias |
startIdentify |
Ask the device to start winking immediately for an unlimited amount of time | |
stop |
Stop the current actuator behavior (movement, sound or timer) | |
stopIdentify |
Ask the device to stop winking immediately | |
undeploy |
Fully undeploy the device | |
unpairAllOneWayControllers |
Unpair all one way controllers from actuator. | |
unpairAllOneWayControllersAndDeleteNode |
Unpair all one way controllers from actuator. Delete 2way key from actuator and delete the device. | |
unpairOneWayController |
STRING; INT [1..16] (optional) | Unpair a one way controller from actuator. p1 : Payload of the QRCode associated to the one way controller p2 : channel (Optional - default : 1) |
up |
Move the device completely up | |
wink |
INT [1..254] | Ask the device to identify itself by doing a slight movement or blink or beep for a given amount of seconds. |
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 |
|---|---|---|---|
AdditionalStatusState |
DataState | ||
ClosureState |
ContinuousState | [0..100] | |
CommandLockLevelsState |
DataState | ||
DeploymentState |
ContinuousState | [0..100] | |
DiscreteRSSILevelState |
DiscreteState | good, low, normal, verylow | |
ManufacturerDiagnosticsState |
DataState | ||
ManufacturerSettingsState |
DataState | ||
MovingState |
DiscreteState | false, true | |
NameState |
DataState | ||
OpenClosedState |
DiscreteState | open, closed | |
PriorityLockLevelState |
DiscreteState | comfortLevel1, comfortLevel2, comfortLevel3, comfortLevel4, environmentProtection, humanProtection, userLevel1, userLevel2 | |
PriorityLockOriginatorState |
DiscreteState | LSC, SAAC, SFC, UPS, externalGateway, localUser, myself, rain, security, temperature, timer, user, wind | |
PriorityLockTimerState |
ContinuousState | ||
RSSILevelState |
ContinuousState | ||
SecuredPositionState |
ContinuousState | ||
StatusState |
DiscreteState | available, unavailable | |
TargetClosureState |
ContinuousState |
ExteriorScreen/PositionableScreen (ACTUATOR) — 35 commands, 16 states
Type IDs: 196608, 196610 | Servers: somfy_europe | Controllable: io:VerticalExteriorAwningIOComponent | Profiles: StatefulDeployableVerticalAwning, StatefulDeployable, Deployable, DeployUndeploy, StatefulCloseable, StatefulOpenClose, OpenClose
Data Properties
core:identifyInterval=500
Commands
| Command | Parameters | Notes |
|---|---|---|
addLockLevel |
INT; INT (optional) | Add a command lock level on the device p1 : The lock level to add p2 : (optional) Duration in second of the lock Level. By default there is no expiration. |
advancedRefresh |
STRING: normal, advanced, custom; ARRAY (optional) | Refresh extra states |
close |
Fully close the device | |
delayedStopIdentify |
INT [1..254] | (IO-homecontrol specific) Ask the device to stop winking after a given number of seconds |
deploy |
Fully deploy the device | |
down |
Move the device completely down | |
executeManufacturerProcedure |
STRING; OBJECT; OBJECT (optional) | execute manufacturer procedure command. p1: the procedure name p2: the params associated Example: p1 = "dead_man_up" p2 = {"duration": 42} |
getName |
Refresh the device internal name | |
identify |
Ask the device to identify itself by doing a slight movement or blink or beep | |
keepOneWayControllersAndDeleteNode |
Delete 2way key from actuator and delete the device. All one way controllers remain linked to the actuator. | |
my |
Set the device to a user pre-defined position | |
open |
Fully open the device | |
pairOneWayController |
STRING; INT [1..16] (optional) | Pair a one way controller to actuator. p1 : Payload of the QRCode associated to the one way controller p2 : channel (Optional - default : 1) |
readManufacturerData |
ARRAY | Read manufacturer data values from given names. Example: ["setting1","setting2"]. |
refreshMemorized1Position |
Refresh memorized 1 position state | |
removeLockLevel |
INT | Remove the command lock level on the device p1 : The lock level to remove |
resetLockLevels |
Remove all lock levels on the device | |
sendIOKey |
Send the IO key to device. | |
setClosure |
INT [0..100] | Closure level (100%=fully close, 0%=open) |
setConfigState |
STRING: configuration, virgin, close, transmitting | Set the device in configuration state. p1: configuration mode. |
setDeployment |
INT [0..100] | Device deployment level (100%=fully deployed, 0%=fully undeployed) |
setMemorized1Position |
INT [0..100] | Set favorite position |
setName |
STRING | Change the device internal name. Name length may be subject to restrictions depending on the device and underlying protocol. |
setPosition |
STRING: my, memorized1, secured; INT [0..100] | Set the device to a pre-defined position (enum) or a relative position (0-100%) |
setSecuredPosition |
INT [0..100] | Set the relative position value (0-100%) to be used for the 'secured' position alias |
startIdentify |
Ask the device to start winking immediately for an unlimited amount of time | |
stop |
Stop the current actuator behavior (movement, sound or timer) | |
stopIdentify |
Ask the device to stop winking immediately | |
undeploy |
Fully undeploy the device | |
unpairAllOneWayControllers |
Unpair all one way controllers from actuator. | |
unpairAllOneWayControllersAndDeleteNode |
Unpair all one way controllers from actuator. Delete 2way key from actuator and delete the device. | |
unpairOneWayController |
STRING; INT [1..16] (optional) | Unpair a one way controller from actuator. p1 : Payload of the QRCode associated to the one way controller p2 : channel (Optional - default : 1) |
up |
Move the device completely up | |
wink |
INT [1..254] | Ask the device to identify itself by doing a slight movement or blink or beep for a given amount of seconds. |
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 |
|---|---|---|---|
AdditionalStatusState |
DataState | ||
ClosureState |
ContinuousState | [0..100] | |
CommandLockLevelsState |
DataState | ||
DeploymentState |
ContinuousState | [0..100] | |
DiscreteRSSILevelState |
DiscreteState | good, low, normal, verylow | |
Memorized1PositionState |
ContinuousState | ||
MovingState |
DiscreteState | false, true | |
NameState |
DataState | ||
OpenClosedState |
DiscreteState | open, closed | |
PriorityLockLevelState |
DiscreteState | comfortLevel1, comfortLevel2, comfortLevel3, comfortLevel4, environmentProtection, humanProtection, userLevel1, userLevel2 | |
PriorityLockOriginatorState |
DiscreteState | LSC, SAAC, SFC, UPS, externalGateway, localUser, myself, rain, security, temperature, timer, user, wind | |
PriorityLockTimerState |
ContinuousState | ||
RSSILevelState |
ContinuousState | ||
SecuredPositionState |
ContinuousState | ||
StatusState |
DiscreteState | available, unavailable | |
TargetClosureState |
ContinuousState |
ExteriorScreen/PositionableScreen (ACTUATOR) — 32 commands, 15 states
Type IDs: 196609 | Servers: somfy_europe | Controllable: io:VerticalExteriorAwningVeluxIOComponent | Profiles: StatefulDeployableVerticalAwning, StatefulDeployable, Deployable, DeployUndeploy, StatefulCloseable, StatefulOpenClose, OpenClose
Data Properties
core:identifyInterval=500
Commands
| Command | Parameters | Notes |
|---|---|---|
addLockLevel |
INT; INT (optional) | Add a command lock level on the device p1 : The lock level to add p2 : (optional) Duration in second of the lock Level. By default there is no expiration. |
advancedRefresh |
STRING: normal, advanced, custom; ARRAY (optional) | Refresh extra states |
close |
Fully close the device | |
delayedStopIdentify |
INT [1..254] | (IO-homecontrol specific) Ask the device to stop winking after a given number of seconds |
deploy |
Fully deploy the device | |
down |
Move the device completely down | |
executeManufacturerProcedure |
STRING; OBJECT; OBJECT (optional) | execute manufacturer procedure command. p1: the procedure name p2: the params associated Example: p1 = "dead_man_up" p2 = {"duration": 42} |
getName |
Refresh the device internal name | |
identify |
Ask the device to identify itself by doing a slight movement or blink or beep | |
keepOneWayControllersAndDeleteNode |
Delete 2way key from actuator and delete the device. All one way controllers remain linked to the actuator. | |
open |
Fully open the device | |
pairOneWayController |
STRING; INT [1..16] (optional) | Pair a one way controller to actuator. p1 : Payload of the QRCode associated to the one way controller p2 : channel (Optional - default : 1) |
readManufacturerData |
ARRAY | Read manufacturer data values from given names. Example: ["setting1","setting2"]. |
removeLockLevel |
INT | Remove the command lock level on the device p1 : The lock level to remove |
resetLockLevels |
Remove all lock levels on the device | |
sendIOKey |
Send the IO key to device. | |
setClosure |
INT [0..100] | Closure level (100%=fully close, 0%=open) |
setConfigState |
STRING: configuration, virgin, close, transmitting | Set the device in configuration state. p1: configuration mode. |
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. |
setPosition |
STRING: secured; INT [0..100] | Set the device to a pre-defined position (enum) or a relative position (0-100%) |
setSecuredPosition |
INT [0..100] | Set the relative position value (0-100%) to be used for the 'secured' position alias |
startIdentify |
Ask the device to start winking immediately for an unlimited amount of time | |
stop |
Stop the current actuator behavior (movement, sound or timer) | |
stopIdentify |
Ask the device to stop winking immediately | |
undeploy |
Fully undeploy the device | |
unpairAllOneWayControllers |
Unpair all one way controllers from actuator. | |
unpairAllOneWayControllersAndDeleteNode |
Unpair all one way controllers from actuator. Delete 2way key from actuator and delete the device. | |
unpairOneWayController |
STRING; INT [1..16] (optional) | Unpair a one way controller from actuator. p1 : Payload of the QRCode associated to the one way controller p2 : channel (Optional - default : 1) |
up |
Move the device completely up | |
wink |
INT [1..254] | Ask the device to identify itself by doing a slight movement or blink or beep for a given amount of seconds. |
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 |
|---|---|---|---|
AdditionalStatusState |
DataState | ||
ClosureState |
ContinuousState | [0..100] | |
CommandLockLevelsState |
DataState | ||
DeploymentState |
ContinuousState | [0..100] | |
DiscreteRSSILevelState |
DiscreteState | good, low, normal, verylow | |
MovingState |
DiscreteState | false, true | |
NameState |
DataState | ||
OpenClosedState |
DiscreteState | open, closed | |
PriorityLockLevelState |
DiscreteState | comfortLevel1, comfortLevel2, comfortLevel3, comfortLevel4, environmentProtection, humanProtection, userLevel1, userLevel2 | |
PriorityLockOriginatorState |
DiscreteState | LSC, SAAC, SFC, UPS, externalGateway, localUser, myself, rain, security, temperature, timer, user, wind | |
PriorityLockTimerState |
ContinuousState | ||
RSSILevelState |
ContinuousState | ||
SecuredPositionState |
ContinuousState | ||
StatusState |
DiscreteState | available, unavailable | |
TargetClosureState |
ContinuousState |
ExteriorVenetianBlind/PositionableExteriorVenetianBlind (ACTUATOR) — 38 commands, 19 states
Type IDs: 1114112 | Servers: atlantic_cozytouch, hi_kumo_europe, rexel | Controllable: io:ExteriorVenetianBlindIOComponent | Profiles: StatefulVenetianBlind, StatefulOrientableAndCloseable, OrientableAndCloseable, OpenClose
Data Properties
core:identifyInterval=500
Commands
| Command | Parameters | Notes |
|---|---|---|
addLockLevel |
INT; INT (optional) | Add a command lock level on the device p1 : The lock level to add p2 : (optional) Duration in second of the lock Level. By default there is no expiration. |
advancedRefresh |
STRING: normal, advanced, custom; ARRAY (optional) | Refresh extra states |
close |
Fully close the device | |
delayedStopIdentify |
INT [1..254] | (IO-homecontrol specific) Ask the device to stop winking after a given number of seconds |
down |
Move the device completely down | |
executeManufacturerProcedure |
STRING; OBJECT; OBJECT (optional) | execute manufacturer procedure command. p1: the procedure name p2: the params associated Example: p1 = "dead_man_up" p2 = {"duration": 42} |
getName |
Refresh the device internal name | |
identify |
Ask the device to identify itself by doing a slight movement or blink or beep | |
keepOneWayControllersAndDeleteNode |
Delete 2way key from actuator and delete the device. All one way controllers remain linked to the actuator. | |
my |
Set the device to a user pre-defined position | |
open |
Fully open the device | |
pairOneWayController |
STRING; INT [1..16] (optional) | Pair a one way controller to actuator. p1 : Payload of the QRCode associated to the one way controller p2 : channel (Optional - default : 1) |
readManufacturerData |
ARRAY | Read manufacturer data values from given names. Example: ["setting1","setting2"]. |
refreshMemorized1Position |
Refresh memorized 1 position state | |
removeLockLevel |
INT | Remove the command lock level on the device p1 : The lock level to remove |
resetLockLevels |
Remove all lock levels on the device | |
runManufacturerSettingsCommand |
STRING; OBJECT | Send a manufacturer configuration command. p1: The manufacturer configuration command to use p2: The arguments to send to this command |
sendIOKey |
Send the IO key to device. | |
setClosure |
INT [0..100] | Closure level (100%=fully close, 0%=open) |
setClosureAndOrientation |
STRING: my, memorized1, secured; INT [0..100]; STRING: my, memorized1; INT [0..100] | Set both the closure level (0-100%) and relative slats orientation (0-100%) of the device |
setConfigState |
STRING: configuration, virgin, close, transmitting | Set the device in configuration state. p1: configuration mode. |
setMemorized1Orientation |
INT [0..100] | Set favorite orientation |
setMemorized1Position |
INT [0..100] | Set favorite position |
setName |
STRING | Change the device internal name. Name length may be subject to restrictions depending on the device and underlying protocol. |
setOrientation |
STRING: my, memorized1; INT [0..100] | Set the relative orientation (0-100%) of the device slats |
setPosition |
STRING: my, memorized1, secured; INT [0..100] | Set the device to a pre-defined position (enum) or a relative position (0-100%) |
setSecuredPosition |
INT [0..100] | Set the relative position value (0-100%) to be used for the 'secured' position alias |
startIdentify |
Ask the device to start winking immediately for an unlimited amount of time | |
stop |
Stop the current actuator behavior (movement, sound or timer) | |
stopIdentify |
Ask the device to stop winking immediately | |
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) | |
unpairAllOneWayControllers |
Unpair all one way controllers from actuator. | |
unpairAllOneWayControllersAndDeleteNode |
Unpair all one way controllers from actuator. Delete 2way key from actuator and delete the device. | |
unpairOneWayController |
STRING; INT [1..16] (optional) | Unpair a one way controller from actuator. p1 : Payload of the QRCode associated to the one way controller p2 : channel (Optional - default : 1) |
up |
Move the device completely up | |
wink |
INT [1..254] | Ask the device to identify itself by doing a slight movement or blink or beep for a given amount of seconds. |
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 |
|---|---|---|---|
AdditionalStatusState |
DataState | ||
ClosureState |
ContinuousState | [0..100] | |
CommandLockLevelsState |
DataState | ||
DiscreteRSSILevelState |
DiscreteState | good, low, normal, verylow | |
ManufacturerDiagnosticsState |
DataState | ||
ManufacturerSettingsState |
DataState | ||
Memorized1OrientationState |
ContinuousState | ||
Memorized1PositionState |
ContinuousState | ||
MovingState |
DiscreteState | false, true | |
NameState |
DataState | ||
OpenClosedState |
DiscreteState | open, closed | |
PriorityLockLevelState |
DiscreteState | comfortLevel1, comfortLevel2, comfortLevel3, comfortLevel4, environmentProtection, humanProtection, userLevel1, userLevel2 | |
PriorityLockOriginatorState |
DiscreteState | LSC, SAAC, SFC, UPS, externalGateway, localUser, myself, rain, security, temperature, timer, user, wind | |
PriorityLockTimerState |
ContinuousState | ||
RSSILevelState |
ContinuousState | ||
SecuredPositionState |
ContinuousState | ||
SlateOrientationState |
ContinuousState | [0..100] | |
StatusState |
DiscreteState | available, unavailable | |
TargetClosureState |
ContinuousState |
ExteriorVenetianBlind/PositionableExteriorVenetianBlind (ACTUATOR) — 37 commands, 17 states
Type IDs: 1114112 | Servers: somfy_europe | Controllable: io:ExteriorVenetianBlindIOComponent | Profiles: StatefulVenetianBlind, StatefulOrientableAndCloseable, OrientableAndCloseable, OpenClose
Data Properties
core:identifyInterval=500
Commands
| Command | Parameters | Notes |
|---|---|---|
addLockLevel |
INT; INT (optional) | Add a command lock level on the device p1 : The lock level to add p2 : (optional) Duration in second of the lock Level. By default there is no expiration. |
advancedRefresh |
STRING: normal, advanced, custom; ARRAY (optional) | Refresh extra states |
close |
Fully close the device | |
delayedStopIdentify |
INT [1..254] | (IO-homecontrol specific) Ask the device to stop winking after a given number of seconds |
down |
Move the device completely down | |
executeManufacturerProcedure |
STRING; OBJECT; OBJECT (optional) | execute manufacturer procedure command. p1: the procedure name p2: the params associated Example: p1 = "dead_man_up" p2 = {"duration": 42} |
getName |
Refresh the device internal name | |
identify |
Ask the device to identify itself by doing a slight movement or blink or beep | |
keepOneWayControllersAndDeleteNode |
Delete 2way key from actuator and delete the device. All one way controllers remain linked to the actuator. | |
my |
Set the device to a user pre-defined position | |
open |
Fully open the device | |
pairOneWayController |
STRING; INT [1..16] (optional) | Pair a one way controller to actuator. p1 : Payload of the QRCode associated to the one way controller p2 : channel (Optional - default : 1) |
readManufacturerData |
ARRAY | Read manufacturer data values from given names. Example: ["setting1","setting2"]. |
refreshMemorized1Position |
Refresh memorized 1 position state | |
removeLockLevel |
INT | Remove the command lock level on the device p1 : The lock level to remove |
resetLockLevels |
Remove all lock levels on the device | |
sendIOKey |
Send the IO key to device. | |
setClosure |
INT [0..100] | Closure level (100%=fully close, 0%=open) |
setClosureAndOrientation |
STRING: my, memorized1, secured; INT [0..100]; STRING: my, memorized1; INT [0..100] | Set both the closure level (0-100%) and relative slats orientation (0-100%) of the device |
setConfigState |
STRING: configuration, virgin, close, transmitting | Set the device in configuration state. p1: configuration mode. |
setMemorized1Orientation |
INT [0..100] | Set favorite orientation |
setMemorized1Position |
INT [0..100] | Set favorite position |
setName |
STRING | Change the device internal name. Name length may be subject to restrictions depending on the device and underlying protocol. |
setOrientation |
STRING: my, memorized1; INT [0..100] | Set the relative orientation (0-100%) of the device slats |
setPosition |
STRING: my, memorized1, secured; INT [0..100] | Set the device to a pre-defined position (enum) or a relative position (0-100%) |
setSecuredPosition |
INT [0..100] | Set the relative position value (0-100%) to be used for the 'secured' position alias |
startIdentify |
Ask the device to start winking immediately for an unlimited amount of time | |
stop |
Stop the current actuator behavior (movement, sound or timer) | |
stopIdentify |
Ask the device to stop winking immediately | |
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) | |
unpairAllOneWayControllers |
Unpair all one way controllers from actuator. | |
unpairAllOneWayControllersAndDeleteNode |
Unpair all one way controllers from actuator. Delete 2way key from actuator and delete the device. | |
unpairOneWayController |
STRING; INT [1..16] (optional) | Unpair a one way controller from actuator. p1 : Payload of the QRCode associated to the one way controller p2 : channel (Optional - default : 1) |
up |
Move the device completely up | |
wink |
INT [1..254] | Ask the device to identify itself by doing a slight movement or blink or beep for a given amount of seconds. |
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 |
|---|---|---|---|
AdditionalStatusState |
DataState | ||
ClosureState |
ContinuousState | [0..100] | |
CommandLockLevelsState |
DataState | ||
DiscreteRSSILevelState |
DiscreteState | good, low, normal, verylow | |
Memorized1OrientationState |
ContinuousState | ||
Memorized1PositionState |
ContinuousState | ||
MovingState |
DiscreteState | false, true | |
NameState |
DataState | ||
OpenClosedState |
DiscreteState | open, closed | |
PriorityLockLevelState |
DiscreteState | comfortLevel1, comfortLevel2, comfortLevel3, comfortLevel4, environmentProtection, humanProtection, userLevel1, userLevel2 | |
PriorityLockOriginatorState |
DiscreteState | LSC, SAAC, SFC, UPS, externalGateway, localUser, myself, rain, security, temperature, timer, user, wind | |
PriorityLockTimerState |
ContinuousState | ||
RSSILevelState |
ContinuousState | ||
SecuredPositionState |
ContinuousState | ||
SlateOrientationState |
ContinuousState | [0..100] | |
StatusState |
DiscreteState | available, unavailable | |
TargetClosureState |
ContinuousState |
GarageDoor/PositionableGarageDoor (ACTUATOR) — 28 commands, 13 states
Type IDs: 327680, 327682 | Servers: atlantic_cozytouch, hi_kumo_europe, rexel | Controllable: io:GarageOpenerIOComponent | Profiles: StatefulCloseableGarageOpener, StatefulCloseable, Closeable, OpenClose
Data Properties
core:identifyInterval=500
Commands
| Command | Parameters | Notes |
|---|---|---|
addLockLevel |
INT; INT (optional) | Add a command lock level on the device p1 : The lock level to add p2 : (optional) Duration in second of the lock Level. By default there is no expiration. |
advancedRefresh |
STRING: normal, advanced, custom; ARRAY (optional) | Refresh extra states |
close |
Fully close the device | |
delayedStopIdentify |
INT [1..254] | (IO-homecontrol specific) Ask the device to stop winking after a given number of seconds |
down |
Move the device completely down | |
executeManufacturerProcedure |
STRING; OBJECT; OBJECT (optional) | execute manufacturer procedure command. p1: the procedure name p2: the params associated Example: p1 = "dead_man_up" p2 = {"duration": 42} |
getName |
Refresh the device internal name | |
identify |
Ask the device to identify itself by doing a slight movement or blink or beep | |
keepOneWayControllersAndDeleteNode |
Delete 2way key from actuator and delete the device. All one way controllers remain linked to the actuator. | |
open |
Fully open the device | |
pairOneWayController |
STRING; INT [1..16] (optional) | Pair a one way controller to actuator. p1 : Payload of the QRCode associated to the one way controller p2 : channel (Optional - default : 1) |
readManufacturerData |
ARRAY | Read manufacturer data values from given names. Example: ["setting1","setting2"]. |
removeLockLevel |
INT | Remove the command lock level on the device p1 : The lock level to remove |
resetLockLevels |
Remove all lock levels on the device | |
runManufacturerSettingsCommand |
STRING; OBJECT | Send a manufacturer configuration command. p1: The manufacturer configuration command to use p2: The arguments to send to this command |
sendIOKey |
Send the IO key to device. | |
setClosure |
INT [0..100] | Closure level (100%=fully close, 0%=open) |
setConfigState |
STRING: configuration, virgin, close, transmitting | Set the device in configuration state. p1: configuration mode. |
setName |
STRING | Change the device internal name. Name length may be subject to restrictions depending on the device and underlying protocol. |
startIdentify |
Ask the device to start winking immediately for an unlimited amount of time | |
stop |
Stop the current actuator behavior (movement, sound or timer) | |
stopIdentify |
Ask the device to stop winking immediately | |
unpairAllOneWayControllers |
Unpair all one way controllers from actuator. | |
unpairAllOneWayControllersAndDeleteNode |
Unpair all one way controllers from actuator. Delete 2way key from actuator and delete the device. | |
unpairOneWayController |
STRING; INT [1..16] (optional) | Unpair a one way controller from actuator. p1 : Payload of the QRCode associated to the one way controller p2 : channel (Optional - default : 1) |
up |
Move the device completely up | |
wink |
INT [1..254] | Ask the device to identify itself by doing a slight movement or blink or beep for a given amount of seconds. |
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 |
|---|---|---|---|
AdditionalStatusState |
DataState | ||
ClosureState |
ContinuousState | [0..100] | |
CommandLockLevelsState |
DataState | ||
DiscreteRSSILevelState |
DiscreteState | good, low, normal, verylow | |
ManufacturerDiagnosticsState |
DataState | ||
ManufacturerSettingsState |
DataState | ||
NameState |
DataState | ||
OpenClosedUnknownState |
DiscreteState | closed, open, unknown | |
PriorityLockLevelState |
DiscreteState | comfortLevel1, comfortLevel2, comfortLevel3, comfortLevel4, environmentProtection, humanProtection, userLevel1, userLevel2 | |
PriorityLockOriginatorState |
DiscreteState | LSC, SAAC, SFC, UPS, externalGateway, localUser, myself, rain, security, temperature, timer, user, wind | |
PriorityLockTimerState |
ContinuousState | ||
RSSILevelState |
ContinuousState | ||
StatusState |
DiscreteState | available, unavailable |
GarageDoor/DiscretePositionableGarageDoor (ACTUATOR) — 27 commands, 12 states
Type IDs: 342528, 342530 | Servers: atlantic_cozytouch, hi_kumo_europe, rexel | Controllable: io:DiscreteGarageOpenerIOComponent | Profiles: OpenCloseGarageOpener, OpenClose
Data Properties
core:identifyInterval=500
Commands
| Command | Parameters | Notes |
|---|---|---|
addLockLevel |
INT; INT (optional) | Add a command lock level on the device p1 : The lock level to add p2 : (optional) Duration in second of the lock Level. By default there is no expiration. |
advancedRefresh |
STRING: normal, advanced, custom; ARRAY (optional) | Refresh extra states |
close |
Fully close the device | |
delayedStopIdentify |
INT [1..254] | (IO-homecontrol specific) Ask the device to stop winking after a given number of seconds |
down |
Move the device completely down | |
executeManufacturerProcedure |
STRING; OBJECT; OBJECT (optional) | execute manufacturer procedure command. p1: the procedure name p2: the params associated Example: p1 = "dead_man_up" p2 = {"duration": 42} |
getName |
Refresh the device internal name | |
identify |
Ask the device to identify itself by doing a slight movement or blink or beep | |
keepOneWayControllersAndDeleteNode |
Delete 2way key from actuator and delete the device. All one way controllers remain linked to the actuator. | |
open |
Fully open the device | |
pairOneWayController |
STRING; INT [1..16] (optional) | Pair a one way controller to actuator. p1 : Payload of the QRCode associated to the one way controller p2 : channel (Optional - default : 1) |
readManufacturerData |
ARRAY | Read manufacturer data values from given names. Example: ["setting1","setting2"]. |
removeLockLevel |
INT | Remove the command lock level on the device p1 : The lock level to remove |
resetLockLevels |
Remove all lock levels on the device | |
runManufacturerSettingsCommand |
STRING; OBJECT | Send a manufacturer configuration command. p1: The manufacturer configuration command to use p2: The arguments to send to this command |
sendIOKey |
Send the IO key to device. | |
setConfigState |
STRING: configuration, virgin, close, transmitting | Set the device in configuration state. p1: configuration mode. |
setName |
STRING | Change the device internal name. Name length may be subject to restrictions depending on the device and underlying protocol. |
startIdentify |
Ask the device to start winking immediately for an unlimited amount of time | |
stop |
Stop the current actuator behavior (movement, sound or timer) | |
stopIdentify |
Ask the device to stop winking immediately | |
unpairAllOneWayControllers |
Unpair all one way controllers from actuator. | |
unpairAllOneWayControllersAndDeleteNode |
Unpair all one way controllers from actuator. Delete 2way key from actuator and delete the device. | |
unpairOneWayController |
STRING; INT [1..16] (optional) | Unpair a one way controller from actuator. p1 : Payload of the QRCode associated to the one way controller p2 : channel (Optional - default : 1) |
up |
Move the device completely up | |
wink |
INT [1..254] | Ask the device to identify itself by doing a slight movement or blink or beep for a given amount of seconds. |
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 |
|---|---|---|---|
AdditionalStatusState |
DataState | ||
CommandLockLevelsState |
DataState | ||
DiscreteRSSILevelState |
DiscreteState | good, low, normal, verylow | |
ManufacturerDiagnosticsState |
DataState | ||
ManufacturerSettingsState |
DataState | ||
NameState |
DataState | ||
OpenClosedUnknownState |
DiscreteState | closed, open, unknown | |
PriorityLockLevelState |
DiscreteState | comfortLevel1, comfortLevel2, comfortLevel3, comfortLevel4, environmentProtection, humanProtection, userLevel1, userLevel2 | |
PriorityLockOriginatorState |
DiscreteState | LSC, SAAC, SFC, UPS, externalGateway, localUser, myself, rain, security, temperature, timer, user, wind | |
PriorityLockTimerState |
ContinuousState | ||
RSSILevelState |
ContinuousState | ||
StatusState |
DiscreteState | available, unavailable |
GarageDoor/PositionableGarageDoor (ACTUATOR) — 26 commands, 13 states
Type IDs: 524288, 524290 | Servers: atlantic_cozytouch, hi_kumo_europe, rexel | Controllable: io:RollingDoorOpenerIOComponent | Profiles: StatefulCloseableSlidingDoor, StatefulCloseable, Closeable, StatefulOpenClose, OpenClose
Data Properties
core:identifyInterval=500
Commands
| Command | Parameters | Notes |
|---|---|---|
addLockLevel |
INT; INT (optional) | Add a command lock level on the device p1 : The lock level to add p2 : (optional) Duration in second of the lock Level. By default there is no expiration. |
advancedRefresh |
STRING: normal, advanced, custom; ARRAY (optional) | Refresh extra states |
close |
Fully close the device | |
delayedStopIdentify |
INT [1..254] | (IO-homecontrol specific) Ask the device to stop winking after a given number of seconds |
executeManufacturerProcedure |
STRING; OBJECT; OBJECT (optional) | execute manufacturer procedure command. p1: the procedure name p2: the params associated Example: p1 = "dead_man_up" p2 = {"duration": 42} |
getName |
Refresh the device internal name | |
identify |
Ask the device to identify itself by doing a slight movement or blink or beep | |
keepOneWayControllersAndDeleteNode |
Delete 2way key from actuator and delete the device. All one way controllers remain linked to the actuator. | |
open |
Fully open the device | |
pairOneWayController |
STRING; INT [1..16] (optional) | Pair a one way controller to actuator. p1 : Payload of the QRCode associated to the one way controller p2 : channel (Optional - default : 1) |
readManufacturerData |
ARRAY | Read manufacturer data values from given names. Example: ["setting1","setting2"]. |
removeLockLevel |
INT | Remove the command lock level on the device p1 : The lock level to remove |
resetLockLevels |
Remove all lock levels on the device | |
runManufacturerSettingsCommand |
STRING; OBJECT | Send a manufacturer configuration command. p1: The manufacturer configuration command to use p2: The arguments to send to this command |
sendIOKey |
Send the IO key to device. | |
setClosure |
INT [0..100] | Closure level (100%=fully close, 0%=open) |
setConfigState |
STRING: configuration, virgin, close, transmitting | Set the device in configuration state. p1: configuration mode. |
setName |
STRING | Change the device internal name. Name length may be subject to restrictions depending on the device and underlying protocol. |
startIdentify |
Ask the device to start winking immediately for an unlimited amount of time | |
stop |
Stop the current actuator behavior (movement, sound or timer) | |
stopIdentify |
Ask the device to stop winking immediately | |
unpairAllOneWayControllers |
Unpair all one way controllers from actuator. | |
unpairAllOneWayControllersAndDeleteNode |
Unpair all one way controllers from actuator. Delete 2way key from actuator and delete the device. | |
unpairOneWayController |
STRING; INT [1..16] (optional) | Unpair a one way controller from actuator. p1 : Payload of the QRCode associated to the one way controller p2 : channel (Optional - default : 1) |
wink |
INT [1..254] | Ask the device to identify itself by doing a slight movement or blink or beep for a given amount of seconds. |
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 |
|---|---|---|---|
AdditionalStatusState |
DataState | ||
ClosureState |
ContinuousState | [0..100] | |
CommandLockLevelsState |
DataState | ||
DiscreteRSSILevelState |
DiscreteState | good, low, normal, verylow | |
ManufacturerDiagnosticsState |
DataState | ||
ManufacturerSettingsState |
DataState | ||
NameState |
DataState | ||
OpenClosedState |
DiscreteState | open, closed | |
PriorityLockLevelState |
DiscreteState | comfortLevel1, comfortLevel2, comfortLevel3, comfortLevel4, environmentProtection, humanProtection, userLevel1, userLevel2 | |
PriorityLockOriginatorState |
DiscreteState | LSC, SAAC, SFC, UPS, externalGateway, localUser, myself, rain, security, temperature, timer, user, wind | |
PriorityLockTimerState |
ContinuousState | ||
RSSILevelState |
ContinuousState | ||
StatusState |
DiscreteState | available, unavailable |
GarageDoor/PositionableGarageDoor (ACTUATOR) — 27 commands, 11 states
Type IDs: 327680, 327682 | Servers: somfy_europe | Controllable: io:GarageOpenerIOComponent | Profiles: StatefulCloseableGarageOpener, StatefulCloseable, Closeable, OpenClose
Data Properties
core:identifyInterval=500
Commands
| Command | Parameters | Notes |
|---|---|---|
addLockLevel |
INT; INT (optional) | Add a command lock level on the device p1 : The lock level to add p2 : (optional) Duration in second of the lock Level. By default there is no expiration. |
advancedRefresh |
STRING: normal, advanced, custom; ARRAY (optional) | Refresh extra states |
close |
Fully close the device | |
delayedStopIdentify |
INT [1..254] | (IO-homecontrol specific) Ask the device to stop winking after a given number of seconds |
down |
Move the device completely down | |
executeManufacturerProcedure |
STRING; OBJECT; OBJECT (optional) | execute manufacturer procedure command. p1: the procedure name p2: the params associated Example: p1 = "dead_man_up" p2 = {"duration": 42} |
getName |
Refresh the device internal name | |
identify |
Ask the device to identify itself by doing a slight movement or blink or beep | |
keepOneWayControllersAndDeleteNode |
Delete 2way key from actuator and delete the device. All one way controllers remain linked to the actuator. | |
open |
Fully open the device | |
pairOneWayController |
STRING; INT [1..16] (optional) | Pair a one way controller to actuator. p1 : Payload of the QRCode associated to the one way controller p2 : channel (Optional - default : 1) |
readManufacturerData |
ARRAY | Read manufacturer data values from given names. Example: ["setting1","setting2"]. |
removeLockLevel |
INT | Remove the command lock level on the device p1 : The lock level to remove |
resetLockLevels |
Remove all lock levels on the device | |
sendIOKey |
Send the IO key to device. | |
setClosure |
INT [0..100] | Closure level (100%=fully close, 0%=open) |
setConfigState |
STRING: configuration, virgin, close, transmitting | Set the device in configuration state. p1: configuration mode. |
setName |
STRING | Change the device internal name. Name length may be subject to restrictions depending on the device and underlying protocol. |
startIdentify |
Ask the device to start winking immediately for an unlimited amount of time | |
stop |
Stop the current actuator behavior (movement, sound or timer) | |
stopIdentify |
Ask the device to stop winking immediately | |
unpairAllOneWayControllers |
Unpair all one way controllers from actuator. | |
unpairAllOneWayControllersAndDeleteNode |
Unpair all one way controllers from actuator. Delete 2way key from actuator and delete the device. | |
unpairOneWayController |
STRING; INT [1..16] (optional) | Unpair a one way controller from actuator. p1 : Payload of the QRCode associated to the one way controller p2 : channel (Optional - default : 1) |
up |
Move the device completely up | |
wink |
INT [1..254] | Ask the device to identify itself by doing a slight movement or blink or beep for a given amount of seconds. |
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 |
|---|---|---|---|
AdditionalStatusState |
DataState | ||
ClosureState |
ContinuousState | [0..100] | |
CommandLockLevelsState |
DataState | ||
DiscreteRSSILevelState |
DiscreteState | good, low, normal, verylow | |
NameState |
DataState | ||
OpenClosedUnknownState |
DiscreteState | closed, open, unknown | |
PriorityLockLevelState |
DiscreteState | comfortLevel1, comfortLevel2, comfortLevel3, comfortLevel4, environmentProtection, humanProtection, userLevel1, userLevel2 | |
PriorityLockOriginatorState |
DiscreteState | LSC, SAAC, SFC, UPS, externalGateway, localUser, myself, rain, security, temperature, timer, user, wind | |
PriorityLockTimerState |
ContinuousState | ||
RSSILevelState |
ContinuousState | ||
StatusState |
DiscreteState | available, unavailable |
GarageDoor/DiscretePositionableGarageDoor (ACTUATOR) — 26 commands, 10 states
Type IDs: 342528, 342530 | Servers: somfy_europe | Controllable: io:DiscreteGarageOpenerIOComponent | Profiles: OpenCloseGarageOpener, OpenClose
Data Properties
core:identifyInterval=500
Commands
| Command | Parameters | Notes |
|---|---|---|
addLockLevel |
INT; INT (optional) | Add a command lock level on the device p1 : The lock level to add p2 : (optional) Duration in second of the lock Level. By default there is no expiration. |
advancedRefresh |
STRING: normal, advanced, custom; ARRAY (optional) | Refresh extra states |
close |
Fully close the device | |
delayedStopIdentify |
INT [1..254] | (IO-homecontrol specific) Ask the device to stop winking after a given number of seconds |
down |
Move the device completely down | |
executeManufacturerProcedure |
STRING; OBJECT; OBJECT (optional) | execute manufacturer procedure command. p1: the procedure name p2: the params associated Example: p1 = "dead_man_up" p2 = {"duration": 42} |
getName |
Refresh the device internal name | |
identify |
Ask the device to identify itself by doing a slight movement or blink or beep | |
keepOneWayControllersAndDeleteNode |
Delete 2way key from actuator and delete the device. All one way controllers remain linked to the actuator. | |
open |
Fully open the device | |
pairOneWayController |
STRING; INT [1..16] (optional) | Pair a one way controller to actuator. p1 : Payload of the QRCode associated to the one way controller p2 : channel (Optional - default : 1) |
readManufacturerData |
ARRAY | Read manufacturer data values from given names. Example: ["setting1","setting2"]. |
removeLockLevel |
INT | Remove the command lock level on the device p1 : The lock level to remove |
resetLockLevels |
Remove all lock levels on the device | |
sendIOKey |
Send the IO key to device. | |
setConfigState |
STRING: configuration, virgin, close, transmitting | Set the device in configuration state. p1: configuration mode. |
setName |
STRING | Change the device internal name. Name length may be subject to restrictions depending on the device and underlying protocol. |
startIdentify |
Ask the device to start winking immediately for an unlimited amount of time | |
stop |
Stop the current actuator behavior (movement, sound or timer) | |
stopIdentify |
Ask the device to stop winking immediately | |
unpairAllOneWayControllers |
Unpair all one way controllers from actuator. | |
unpairAllOneWayControllersAndDeleteNode |
Unpair all one way controllers from actuator. Delete 2way key from actuator and delete the device. | |
unpairOneWayController |
STRING; INT [1..16] (optional) | Unpair a one way controller from actuator. p1 : Payload of the QRCode associated to the one way controller p2 : channel (Optional - default : 1) |
up |
Move the device completely up | |
wink |
INT [1..254] | Ask the device to identify itself by doing a slight movement or blink or beep for a given amount of seconds. |
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 |
|---|---|---|---|
AdditionalStatusState |
DataState | ||
CommandLockLevelsState |
DataState | ||
DiscreteRSSILevelState |
DiscreteState | good, low, normal, verylow | |
NameState |
DataState | ||
OpenClosedUnknownState |
DiscreteState | closed, open, unknown | |
PriorityLockLevelState |
DiscreteState | comfortLevel1, comfortLevel2, comfortLevel3, comfortLevel4, environmentProtection, humanProtection, userLevel1, userLevel2 | |
PriorityLockOriginatorState |
DiscreteState | LSC, SAAC, SFC, UPS, externalGateway, localUser, myself, rain, security, temperature, timer, user, wind | |
PriorityLockTimerState |
ContinuousState | ||
RSSILevelState |
ContinuousState | ||
StatusState |
DiscreteState | available, unavailable |
GarageDoor/PositionableGarageDoor (ACTUATOR) — 25 commands, 11 states
Type IDs: 524288, 524290 | Servers: somfy_europe | Controllable: io:RollingDoorOpenerIOComponent | Profiles: StatefulCloseableSlidingDoor, StatefulCloseable, Closeable, StatefulOpenClose, OpenClose
Data Properties
core:identifyInterval=500
Commands
| Command | Parameters | Notes |
|---|---|---|
addLockLevel |
INT; INT (optional) | Add a command lock level on the device p1 : The lock level to add p2 : (optional) Duration in second of the lock Level. By default there is no expiration. |
advancedRefresh |
STRING: normal, advanced, custom; ARRAY (optional) | Refresh extra states |
close |
Fully close the device | |
delayedStopIdentify |
INT [1..254] | (IO-homecontrol specific) Ask the device to stop winking after a given number of seconds |
executeManufacturerProcedure |
STRING; OBJECT; OBJECT (optional) | execute manufacturer procedure command. p1: the procedure name p2: the params associated Example: p1 = "dead_man_up" p2 = {"duration": 42} |
getName |
Refresh the device internal name | |
identify |
Ask the device to identify itself by doing a slight movement or blink or beep | |
keepOneWayControllersAndDeleteNode |
Delete 2way key from actuator and delete the device. All one way controllers remain linked to the actuator. | |
open |
Fully open the device | |
pairOneWayController |
STRING; INT [1..16] (optional) | Pair a one way controller to actuator. p1 : Payload of the QRCode associated to the one way controller p2 : channel (Optional - default : 1) |
readManufacturerData |
ARRAY | Read manufacturer data values from given names. Example: ["setting1","setting2"]. |
removeLockLevel |
INT | Remove the command lock level on the device p1 : The lock level to remove |
resetLockLevels |
Remove all lock levels on the device | |
sendIOKey |
Send the IO key to device. | |
setClosure |
INT [0..100] | Closure level (100%=fully close, 0%=open) |
setConfigState |
STRING: configuration, virgin, close, transmitting | Set the device in configuration state. p1: configuration mode. |
setName |
STRING | Change the device internal name. Name length may be subject to restrictions depending on the device and underlying protocol. |
startIdentify |
Ask the device to start winking immediately for an unlimited amount of time | |
stop |
Stop the current actuator behavior (movement, sound or timer) | |
stopIdentify |
Ask the device to stop winking immediately | |
unpairAllOneWayControllers |
Unpair all one way controllers from actuator. | |
unpairAllOneWayControllersAndDeleteNode |
Unpair all one way controllers from actuator. Delete 2way key from actuator and delete the device. | |
unpairOneWayController |
STRING; INT [1..16] (optional) | Unpair a one way controller from actuator. p1 : Payload of the QRCode associated to the one way controller p2 : channel (Optional - default : 1) |
wink |
INT [1..254] | Ask the device to identify itself by doing a slight movement or blink or beep for a given amount of seconds. |
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 |
|---|---|---|---|
AdditionalStatusState |
DataState | ||
ClosureState |
ContinuousState | [0..100] | |
CommandLockLevelsState |
DataState | ||
DiscreteRSSILevelState |
DiscreteState | good, low, normal, verylow | |
NameState |
DataState | ||
OpenClosedState |
DiscreteState | open, closed | |
PriorityLockLevelState |
DiscreteState | comfortLevel1, comfortLevel2, comfortLevel3, comfortLevel4, environmentProtection, humanProtection, userLevel1, userLevel2 | |
PriorityLockOriginatorState |
DiscreteState | LSC, SAAC, SFC, UPS, externalGateway, localUser, myself, rain, security, temperature, timer, user, wind | |
PriorityLockTimerState |
ContinuousState | ||
RSSILevelState |
ContinuousState | ||
StatusState |
DiscreteState | available, unavailable |
Gate/PositionableGateWithPedestrianPosition (ACTUATOR) — 30 commands, 14 states
Type IDs: 458752, 458754 | Servers: atlantic_cozytouch, hi_kumo_europe, rexel | Controllable: io:GateOpenerIOComponent | Profiles: StatefulCloseableGateOpener, StatefulCloseable, Closeable, OpenClose
Data Properties
core:identifyInterval=500
Commands
| Command | Parameters | Notes |
|---|---|---|
addLockLevel |
INT; INT (optional) | Add a command lock level on the device p1 : The lock level to add p2 : (optional) Duration in second of the lock Level. By default there is no expiration. |
advancedRefresh |
STRING: normal, advanced, custom; ARRAY (optional) | Refresh extra states |
close |
Fully close the device | |
delayedStopIdentify |
INT [1..254] | (IO-homecontrol specific) Ask the device to stop winking after a given number of seconds |
executeManufacturerProcedure |
STRING; OBJECT; OBJECT (optional) | execute manufacturer procedure command. p1: the procedure name p2: the params associated Example: p1 = "dead_man_up" p2 = {"duration": 42} |
getName |
Refresh the device internal name | |
identify |
Ask the device to identify itself by doing a slight movement or blink or beep | |
keepOneWayControllersAndDeleteNode |
Delete 2way key from actuator and delete the device. All one way controllers remain linked to the actuator. | |
open |
Fully open the device | |
pairOneWayController |
STRING; INT [1..16] (optional) | Pair a one way controller to actuator. p1 : Payload of the QRCode associated to the one way controller p2 : channel (Optional - default : 1) |
readManufacturerData |
ARRAY | Read manufacturer data values from given names. Example: ["setting1","setting2"]. |
refreshPedestrianPosition |
Refresh the pedestrian position state | |
removeLockLevel |
INT | Remove the command lock level on the device p1 : The lock level to remove |
resetLockLevels |
Remove all lock levels on the device | |
runManufacturerSettingsCommand |
STRING; OBJECT | Send a manufacturer configuration command. p1: The manufacturer configuration command to use p2: The arguments to send to this command |
sendIOKey |
Send the IO key to device. | |
setClosure |
INT [0..100] | Closure level (100%=fully close, 0%=open) |
setClosureOrPedestrianPosition |
INT [0..100]; STRING: pedestrian | Set the device closure level (0-100%) or set the device in 'pedestrian' mode |
setConfigState |
STRING: configuration, virgin, close, transmitting | Set the device in configuration state. p1: configuration mode. |
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. |
setPedestrianPosition |
Set the device into the special 'pedestrian' position | |
startIdentify |
Ask the device to start winking immediately for an unlimited amount of time | |
stop |
Stop the current actuator behavior (movement, sound or timer) | |
stopIdentify |
Ask the device to stop winking immediately | |
unpairAllOneWayControllers |
Unpair all one way controllers from actuator. | |
unpairAllOneWayControllersAndDeleteNode |
Unpair all one way controllers from actuator. Delete 2way key from actuator and delete the device. | |
unpairOneWayController |
STRING; INT [1..16] (optional) | Unpair a one way controller from actuator. p1 : Payload of the QRCode associated to the one way controller p2 : channel (Optional - default : 1) |
wink |
INT [1..254] | Ask the device to identify itself by doing a slight movement or blink or beep for a given amount of seconds. |
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 |
|---|---|---|---|
AdditionalStatusState |
DataState | ||
ClosureState |
ContinuousState | [0..100] | |
CommandLockLevelsState |
DataState | ||
DiscreteRSSILevelState |
DiscreteState | good, low, normal, verylow | |
ManufacturerDiagnosticsState |
DataState | ||
ManufacturerSettingsState |
DataState | ||
NameState |
DataState | ||
OpenClosedPedestrianState |
DiscreteState | closed, open, pedestrian, unknown | |
PedestrianPositionState |
ContinuousState | ||
PriorityLockLevelState |
DiscreteState | comfortLevel1, comfortLevel2, comfortLevel3, comfortLevel4, environmentProtection, humanProtection, userLevel1, userLevel2 | |
PriorityLockOriginatorState |
DiscreteState | LSC, SAAC, SFC, UPS, externalGateway, localUser, myself, rain, security, temperature, timer, user, wind | |
PriorityLockTimerState |
ContinuousState | ||
RSSILevelState |
ContinuousState | ||
StatusState |
DiscreteState | available, unavailable |
Gate/SlidingDiscreteGateWithPedestrianPosition (ACTUATOR) — 27 commands, 13 states
Type IDs: 473600, 473602 | Servers: atlantic_cozytouch, hi_kumo_europe, rexel | Controllable: io:SlidingDiscreteGateOpenerIOComponent | Profiles: OpenCloseSlidingGateOpener, OpenClose
Data Properties
core:identifyInterval=500
Commands
| Command | Parameters | Notes |
|---|---|---|
addLockLevel |
INT; INT (optional) | Add a command lock level on the device p1 : The lock level to add p2 : (optional) Duration in second of the lock Level. By default there is no expiration. |
advancedRefresh |
STRING: normal, advanced, custom; ARRAY (optional) | Refresh extra states |
close |
Fully close the device | |
delayedStopIdentify |
INT [1..254] | (IO-homecontrol specific) Ask the device to stop winking after a given number of seconds |
executeManufacturerProcedure |
STRING; OBJECT; OBJECT (optional) | execute manufacturer procedure command. p1: the procedure name p2: the params associated Example: p1 = "dead_man_up" p2 = {"duration": 42} |
getName |
Refresh the device internal name | |
identify |
Ask the device to identify itself by doing a slight movement or blink or beep | |
keepOneWayControllersAndDeleteNode |
Delete 2way key from actuator and delete the device. All one way controllers remain linked to the actuator. | |
open |
Fully open the device | |
pairOneWayController |
STRING; INT [1..16] (optional) | Pair a one way controller to actuator. p1 : Payload of the QRCode associated to the one way controller p2 : channel (Optional - default : 1) |
readManufacturerData |
ARRAY | Read manufacturer data values from given names. Example: ["setting1","setting2"]. |
refreshPedestrianPosition |
Refresh the pedestrian position state | |
removeLockLevel |
INT | Remove the command lock level on the device p1 : The lock level to remove |
resetLockLevels |
Remove all lock levels on the device | |
runManufacturerSettingsCommand |
STRING; OBJECT | Send a manufacturer configuration command. p1: The manufacturer configuration command to use p2: The arguments to send to this command |
sendIOKey |
Send the IO key to device. | |
setConfigState |
STRING: configuration, virgin, close, transmitting | Set the device in configuration state. p1: configuration mode. |
setName |
STRING | Change the device internal name. Name length may be subject to restrictions depending on the device and underlying protocol. |
setPedestrianPosition |
Set the device into the special 'pedestrian' position | |
startIdentify |
Ask the device to start winking immediately for an unlimited amount of time | |
stop |
Stop the current actuator behavior (movement, sound or timer) | |
stopIdentify |
Ask the device to stop winking immediately | |
unpairAllOneWayControllers |
Unpair all one way controllers from actuator. | |
unpairAllOneWayControllersAndDeleteNode |
Unpair all one way controllers from actuator. Delete 2way key from actuator and delete the device. | |
unpairOneWayController |
STRING; INT [1..16] (optional) | Unpair a one way controller from actuator. p1 : Payload of the QRCode associated to the one way controller p2 : channel (Optional - default : 1) |
wink |
INT [1..254] | Ask the device to identify itself by doing a slight movement or blink or beep for a given amount of seconds. |
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 |
|---|---|---|---|
AdditionalStatusState |
DataState | ||
CommandLockLevelsState |
DataState | ||
DiscreteRSSILevelState |
DiscreteState | good, low, normal, verylow | |
ManufacturerDiagnosticsState |
DataState | ||
ManufacturerSettingsState |
DataState | ||
NameState |
DataState | ||
OpenClosedPedestrianState |
DiscreteState | closed, open, pedestrian, unknown | |
PedestrianPositionState |
ContinuousState | ||
PriorityLockLevelState |
DiscreteState | comfortLevel1, comfortLevel2, comfortLevel3, comfortLevel4, environmentProtection, humanProtection, userLevel1, userLevel2 | |
PriorityLockOriginatorState |
DiscreteState | LSC, SAAC, SFC, UPS, externalGateway, localUser, myself, rain, security, temperature, timer, user, wind | |
PriorityLockTimerState |
ContinuousState | ||
RSSILevelState |
ContinuousState | ||
StatusState |
DiscreteState | available, unavailable |
Gate/PositionableGateWithPedestrianPosition (ACTUATOR) — 29 commands, 12 states
Type IDs: 458752, 458754 | Servers: somfy_europe | Controllable: io:GateOpenerIOComponent | Profiles: StatefulCloseableGateOpener, StatefulCloseable, Closeable, OpenClose
Data Properties
core:identifyInterval=500
Commands
| Command | Parameters | Notes |
|---|---|---|
addLockLevel |
INT; INT (optional) | Add a command lock level on the device p1 : The lock level to add p2 : (optional) Duration in second of the lock Level. By default there is no expiration. |
advancedRefresh |
STRING: normal, advanced, custom; ARRAY (optional) | Refresh extra states |
close |
Fully close the device | |
delayedStopIdentify |
INT [1..254] | (IO-homecontrol specific) Ask the device to stop winking after a given number of seconds |
executeManufacturerProcedure |
STRING; OBJECT; OBJECT (optional) | execute manufacturer procedure command. p1: the procedure name p2: the params associated Example: p1 = "dead_man_up" p2 = {"duration": 42} |
getName |
Refresh the device internal name | |
identify |
Ask the device to identify itself by doing a slight movement or blink or beep | |
keepOneWayControllersAndDeleteNode |
Delete 2way key from actuator and delete the device. All one way controllers remain linked to the actuator. | |
open |
Fully open the device | |
pairOneWayController |
STRING; INT [1..16] (optional) | Pair a one way controller to actuator. p1 : Payload of the QRCode associated to the one way controller p2 : channel (Optional - default : 1) |
readManufacturerData |
ARRAY | Read manufacturer data values from given names. Example: ["setting1","setting2"]. |
refreshPedestrianPosition |
Refresh the pedestrian position state | |
removeLockLevel |
INT | Remove the command lock level on the device p1 : The lock level to remove |
resetLockLevels |
Remove all lock levels on the device | |
sendIOKey |
Send the IO key to device. | |
setClosure |
INT [0..100] | Closure level (100%=fully close, 0%=open) |
setClosureOrPedestrianPosition |
INT [0..100]; STRING: pedestrian | Set the device closure level (0-100%) or set the device in 'pedestrian' mode |
setConfigState |
STRING: configuration, virgin, close, transmitting | Set the device in configuration state. p1: configuration mode. |
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. |
setPedestrianPosition |
Set the device into the special 'pedestrian' position | |
startIdentify |
Ask the device to start winking immediately for an unlimited amount of time | |
stop |
Stop the current actuator behavior (movement, sound or timer) | |
stopIdentify |
Ask the device to stop winking immediately | |
unpairAllOneWayControllers |
Unpair all one way controllers from actuator. | |
unpairAllOneWayControllersAndDeleteNode |
Unpair all one way controllers from actuator. Delete 2way key from actuator and delete the device. | |
unpairOneWayController |
STRING; INT [1..16] (optional) | Unpair a one way controller from actuator. p1 : Payload of the QRCode associated to the one way controller p2 : channel (Optional - default : 1) |
wink |
INT [1..254] | Ask the device to identify itself by doing a slight movement or blink or beep for a given amount of seconds. |
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 |
|---|---|---|---|
AdditionalStatusState |
DataState | ||
ClosureState |
ContinuousState | [0..100] | |
CommandLockLevelsState |
DataState | ||
DiscreteRSSILevelState |
DiscreteState | good, low, normal, verylow | |
NameState |
DataState | ||
OpenClosedPedestrianState |
DiscreteState | closed, open, pedestrian, unknown | |
PedestrianPositionState |
ContinuousState | ||
PriorityLockLevelState |
DiscreteState | comfortLevel1, comfortLevel2, comfortLevel3, comfortLevel4, environmentProtection, humanProtection, userLevel1, userLevel2 | |
PriorityLockOriginatorState |
DiscreteState | LSC, SAAC, SFC, UPS, externalGateway, localUser, myself, rain, security, temperature, timer, user, wind | |
PriorityLockTimerState |
ContinuousState | ||
RSSILevelState |
ContinuousState | ||
StatusState |
DiscreteState | available, unavailable |
Gate/SlidingDiscreteGateWithPedestrianPosition (ACTUATOR) — 26 commands, 11 states
Type IDs: 473600, 473602 | Servers: somfy_europe | Controllable: io:SlidingDiscreteGateOpenerIOComponent | Profiles: OpenCloseSlidingGateOpener, OpenClose
Data Properties
core:identifyInterval=500
Commands
| Command | Parameters | Notes |
|---|---|---|
addLockLevel |
INT; INT (optional) | Add a command lock level on the device p1 : The lock level to add p2 : (optional) Duration in second of the lock Level. By default there is no expiration. |
advancedRefresh |
STRING: normal, advanced, custom; ARRAY (optional) | Refresh extra states |
close |
Fully close the device | |
delayedStopIdentify |
INT [1..254] | (IO-homecontrol specific) Ask the device to stop winking after a given number of seconds |
executeManufacturerProcedure |
STRING; OBJECT; OBJECT (optional) | execute manufacturer procedure command. p1: the procedure name p2: the params associated Example: p1 = "dead_man_up" p2 = {"duration": 42} |
getName |
Refresh the device internal name | |
identify |
Ask the device to identify itself by doing a slight movement or blink or beep | |
keepOneWayControllersAndDeleteNode |
Delete 2way key from actuator and delete the device. All one way controllers remain linked to the actuator. | |
open |
Fully open the device | |
pairOneWayController |
STRING; INT [1..16] (optional) | Pair a one way controller to actuator. p1 : Payload of the QRCode associated to the one way controller p2 : channel (Optional - default : 1) |
readManufacturerData |
ARRAY | Read manufacturer data values from given names. Example: ["setting1","setting2"]. |
refreshPedestrianPosition |
Refresh the pedestrian position state | |
removeLockLevel |
INT | Remove the command lock level on the device p1 : The lock level to remove |
resetLockLevels |
Remove all lock levels on the device | |
sendIOKey |
Send the IO key to device. | |
setConfigState |
STRING: configuration, virgin, close, transmitting | Set the device in configuration state. p1: configuration mode. |
setName |
STRING | Change the device internal name. Name length may be subject to restrictions depending on the device and underlying protocol. |
setPedestrianPosition |
Set the device into the special 'pedestrian' position | |
startIdentify |
Ask the device to start winking immediately for an unlimited amount of time | |
stop |
Stop the current actuator behavior (movement, sound or timer) | |
stopIdentify |
Ask the device to stop winking immediately | |
unpairAllOneWayControllers |
Unpair all one way controllers from actuator. | |
unpairAllOneWayControllersAndDeleteNode |
Unpair all one way controllers from actuator. Delete 2way key from actuator and delete the device. | |
unpairOneWayController |
STRING; INT [1..16] (optional) | Unpair a one way controller from actuator. p1 : Payload of the QRCode associated to the one way controller p2 : channel (Optional - default : 1) |
wink |
INT [1..254] | Ask the device to identify itself by doing a slight movement or blink or beep for a given amount of seconds. |
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 |
|---|---|---|---|
AdditionalStatusState |
DataState | ||
CommandLockLevelsState |
DataState | ||
DiscreteRSSILevelState |
DiscreteState | good, low, normal, verylow | |
NameState |
DataState | ||
OpenClosedPedestrianState |
DiscreteState | closed, open, pedestrian, unknown | |
PedestrianPositionState |
ContinuousState | ||
PriorityLockLevelState |
DiscreteState | comfortLevel1, comfortLevel2, comfortLevel3, comfortLevel4, environmentProtection, humanProtection, userLevel1, userLevel2 | |
PriorityLockOriginatorState |
DiscreteState | LSC, SAAC, SFC, UPS, externalGateway, localUser, myself, rain, security, temperature, timer, user, wind | |
PriorityLockTimerState |
ContinuousState | ||
RSSILevelState |
ContinuousState | ||
StatusState |
DiscreteState | available, unavailable |
Generic/IOGeneric (ACTUATOR) — 16 commands, 9 states
Type IDs: 0, 1179648, 1245184, 1376256, 1572864, 1573120 | Servers: atlantic_cozytouch, hi_kumo_europe, rexel, somfy_europe | Controllable: io:UnknownIOComponent | Profiles: StatefulLevelControl, LevelControl, Generic
Data Properties
core:identifyInterval=500
Commands
| Command | Parameters | Notes |
|---|---|---|
addLockLevel |
INT; INT (optional) | Add a command lock level on the device p1 : The lock level to add p2 : (optional) Duration in second of the lock Level. By default there is no expiration. |
advancedRefresh |
STRING: normal, advanced, custom; ARRAY (optional) | Refresh extra states |
delayedStopIdentify |
INT [1..254] | (IO-homecontrol specific) Ask the device to stop winking after a given number of seconds |
getName |
Refresh the device internal name | |
identify |
Ask the device to identify itself by doing a slight movement or blink or beep | |
pairOneWayController |
STRING; INT [1..16] (optional) | Pair a one way controller to actuator. p1 : Payload of the QRCode associated to the one way controller p2 : channel (Optional - default : 1) |
removeLockLevel |
INT | Remove the command lock level on the device p1 : The lock level to remove |
resetLockLevels |
Remove all lock levels on the device | |
setConfigState |
STRING: configuration, virgin, close, transmitting | Set the device in configuration state. p1: configuration mode. |
setLevel |
INT [0..100] | Generic device working level (0-100%) Functional meaning depends on device |
setName |
STRING | Change the device internal name. Name length may be subject to restrictions depending on the device and underlying protocol. |
startIdentify |
Ask the device to start winking immediately for an unlimited amount of time | |
stopIdentify |
Ask the device to stop winking immediately | |
unpairAllOneWayControllers |
Unpair all one way controllers from actuator. | |
unpairOneWayController |
STRING; INT [1..16] (optional) | Unpair a one way controller from actuator. p1 : Payload of the QRCode associated to the one way controller p2 : channel (Optional - default : 1) |
wink |
INT [1..254] | Ask the device to identify itself by doing a slight movement or blink or beep for a given amount of seconds. |
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
CommandLockLevelsState |
DataState | ||
DiscreteRSSILevelState |
DiscreteState | good, low, normal, verylow | |
LevelState |
ContinuousState | [0..100] | |
NameState |
DataState | ||
PriorityLockLevelState |
DiscreteState | comfortLevel1, comfortLevel2, comfortLevel3, comfortLevel4, environmentProtection, humanProtection, userLevel1, userLevel2 | |
PriorityLockOriginatorState |
DiscreteState | LSC, SAAC, SFC, UPS, externalGateway, localUser, myself, rain, security, temperature, timer, user, wind | |
PriorityLockTimerState |
ContinuousState | ||
RSSILevelState |
ContinuousState | ||
StatusState |
DiscreteState | available, unavailable |
HeatPumpSystem/HeatPump (ACTUATOR) — 27 commands, 18 states
Type IDs: 1441792 | Servers: atlantic_cozytouch, hi_kumo_europe, rexel, somfy_europe | Controllable: io:HeatPumpIOComponent | Profiles: StatefulThermostatWithSensor, StatefulThermostat, Thermostat
Data Properties
core:identifyInterval=500
Commands
| Command | Parameters | Notes |
|---|---|---|
addLockLevel |
INT; INT (optional) | Add a command lock level on the device p1 : The lock level to add p2 : (optional) Duration in second of the lock Level. By default there is no expiration. |
advancedRefresh |
STRING: normal, advanced, custom; ARRAY (optional) | Refresh extra states |
delayedStopIdentify |
INT [1..254] | (IO-homecontrol specific) Ask the device to stop winking after a given number of seconds |
getName |
Refresh the device internal name | |
identify |
Ask the device to identify itself by doing a slight movement or blink or beep | |
pairOneWayController |
STRING; INT [1..16] (optional) | Pair a one way controller to actuator. p1 : Payload of the QRCode associated to the one way controller p2 : channel (Optional - default : 1) |
refreshActiveModes |
||
refreshComfortTemperature |
Refresh the temperature of comfort mode | |
refreshEcoTemperature |
Refresh the temperature of eco mode | |
refreshHaltedTemperature |
||
refreshSetBackTemperature |
||
refreshTargetTemperature |
Refresh the temperature value | |
refreshTemperature |
Refresh the last measured temperature | |
removeLockLevel |
INT | Remove the command lock level on the device p1 : The lock level to remove |
resetLockLevels |
Remove all lock levels on the device | |
setActiveMode |
ANY | |
setComfortTemperature |
FLOAT [0.0..100.0] | Set target temperature of comfort mode |
setConfigState |
STRING: configuration, virgin, close, transmitting | Set the device in configuration state. p1: configuration mode. |
setEcoTemperature |
ANY | Set target temperature of eco mode |
setName |
STRING | Change the device internal name. Name length may be subject to restrictions depending on the device and underlying protocol. |
setSetBackTemperature |
ANY | |
setTargetTemperature |
FLOAT [0.0..100.0]; STRING: eco, secured, comfort, halted, antifrost | Set the new air temperature to reach |
startIdentify |
Ask the device to start winking immediately for an unlimited amount of time | |
stopIdentify |
Ask the device to stop winking immediately | |
unpairAllOneWayControllers |
Unpair all one way controllers from actuator. | |
unpairOneWayController |
STRING; INT [1..16] (optional) | Unpair a one way controller from actuator. p1 : Payload of the QRCode associated to the one way controller p2 : channel (Optional - default : 1) |
wink |
INT [1..254] | Ask the device to identify itself by doing a slight movement or blink or beep for a given amount of seconds. |
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
ComfortRoomTemperatureState |
ContinuousState | ||
CommandLockLevelsState |
DataState | ||
DiscreteRSSILevelState |
DiscreteState | good, low, normal, verylow | |
EcoRoomTemperatureState |
ContinuousState | ||
HaltedRoomTemperatureState |
ContinuousState | ||
HeatPumpActivesModesState |
DataState | ||
HeatPumpCapabilitiesState |
DataState | ||
NameState |
DataState | ||
PriorityLockLevelState |
DiscreteState | comfortLevel1, comfortLevel2, comfortLevel3, comfortLevel4, environmentProtection, humanProtection, userLevel1, userLevel2 | |
PriorityLockOriginatorState |
DiscreteState | LSC, SAAC, SFC, UPS, externalGateway, localUser, myself, rain, security, temperature, timer, user, wind | |
PriorityLockTimerState |
ContinuousState | ||
RSSILevelState |
ContinuousState | ||
SecondaryTemperatureState |
ContinuousState | ||
SetBackRoomTemperatureState |
ContinuousState | ||
StatusState |
DiscreteState | available, unavailable | |
TargetRoomTemperatureState |
ContinuousState | ||
TargetTemperatureState |
ContinuousState | [12.0..30.0] | |
TemperatureState |
ContinuousState | [-100.0..100.0] |
HeatingSystem/KizOThermBridge (ACTUATOR) — 17 commands, 15 states
Type IDs: 267 | Servers: atlantic_cozytouch, hi_kumo_europe, rexel, somfy_europe | Controllable: io:KizOThermIOComponent | Profiles: DHWThermostatTargetReader
Data Properties
core:identifyInterval=500
Commands
| Command | Parameters | Notes |
|---|---|---|
addLockLevel |
INT; INT (optional) | Add a command lock level on the device p1 : The lock level to add p2 : (optional) Duration in second of the lock Level. By default there is no expiration. |
advancedRefresh |
STRING: normal, advanced, custom; ARRAY (optional) | Refresh extra states |
delayedStopIdentify |
INT [1..254] | (IO-homecontrol specific) Ask the device to stop winking after a given number of seconds |
getName |
Refresh the device internal name | |
identify |
Ask the device to identify itself by doing a slight movement or blink or beep | |
pairOneWayController |
STRING; INT [1..16] (optional) | Pair a one way controller to actuator. p1 : Payload of the QRCode associated to the one way controller p2 : channel (Optional - default : 1) |
refreshState |
Refresh the device states | |
removeLockLevel |
INT | Remove the command lock level on the device p1 : The lock level to remove |
resetLockLevels |
Remove all lock levels on the device | |
setConfigState |
STRING: configuration, virgin, close, transmitting | Set the device in configuration state. p1: configuration mode. |
setName |
STRING | Change the device internal name. Name length may be subject to restrictions depending on the device and underlying protocol. |
setOperatingModes |
ANY | |
startIdentify |
Ask the device to start winking immediately for an unlimited amount of time | |
stopIdentify |
Ask the device to stop winking immediately | |
unpairAllOneWayControllers |
Unpair all one way controllers from actuator. | |
unpairOneWayController |
STRING; INT [1..16] (optional) | Unpair a one way controller from actuator. p1 : Payload of the QRCode associated to the one way controller p2 : channel (Optional - default : 1) |
wink |
INT [1..254] | Ask the device to identify itself by doing a slight movement or blink or beep for a given amount of seconds. |
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
CommandLockLevelsState |
DataState | ||
DiscreteRSSILevelState |
DiscreteState | good, low, normal, verylow | |
KizOThermCapabilitiesState |
DataState | ||
KizOThermOperatingModesState |
DataState | ||
NameState |
DataState | ||
OnOffFlameState |
DiscreteState | off, on | |
PrimaryTargetWaterTemperatureState |
ContinuousState | ||
PriorityLockLevelState |
DiscreteState | comfortLevel1, comfortLevel2, comfortLevel3, comfortLevel4, environmentProtection, humanProtection, userLevel1, userLevel2 | |
PriorityLockOriginatorState |
DiscreteState | LSC, SAAC, SFC, UPS, externalGateway, localUser, myself, rain, security, temperature, timer, user, wind | |
PriorityLockTimerState |
ContinuousState | ||
RSSILevelState |
ContinuousState | ||
RefreshableObjectsState |
DataState | ||
SecondaryTargetWaterTemperatureState |
ContinuousState | ||
StatusState |
DiscreteState | available, unavailable | |
TargetDHWTemperatureState |
ContinuousState | [38.0..60.0] |
HeatingSystem/HeatingTemperatureInterface (ACTUATOR) — 31 commands, 18 states
Type IDs: 917504 | Servers: atlantic_cozytouch, hi_kumo_europe, rexel, somfy_europe | Controllable: io:HeatingTemperatureInterfaceIOComponent | Profiles: StatefulThermostatWithSensor, StatefulThermostat, Thermostat
Data Properties
core:identifyInterval=500
Commands
| Command | Parameters | Notes |
|---|---|---|
addLockLevel |
INT; INT (optional) | Add a command lock level on the device p1 : The lock level to add p2 : (optional) Duration in second of the lock Level. By default there is no expiration. |
advancedRefresh |
STRING: normal, advanced, custom; ARRAY (optional) | Refresh extra states |
delayedStopIdentify |
INT [1..254] | (IO-homecontrol specific) Ask the device to stop winking after a given number of seconds |
getName |
Refresh the device internal name | |
identify |
Ask the device to identify itself by doing a slight movement or blink or beep | |
pairOneWayController |
STRING; INT [1..16] (optional) | Pair a one way controller to actuator. p1 : Payload of the QRCode associated to the one way controller p2 : channel (Optional - default : 1) |
refreshActiveMode |
Refresh the device active mode | |
refreshComfortTemperature |
Refresh the temperature of comfort mode | |
refreshEcoTemperature |
Refresh the temperature of eco mode | |
refreshSecuredPositionTemperature |
Refresh the temperature of secured mode | |
refreshSetPointMode |
Refresh the heating target mode or temperature (if supported) | |
refreshTargetTemperature |
Refresh the temperature value | |
refreshTemperature |
Refresh the last measured temperature | |
removeLockLevel |
INT | Remove the command lock level on the device p1 : The lock level to remove |
resetLockLevels |
Remove all lock levels on the device | |
setActiveAndSetPointModes |
ANY; ANY | |
setActiveMode |
ANY | |
setComfortTemperature |
FLOAT [0.0..100.0] | Set target temperature of comfort mode |
setConfigState |
STRING: configuration, virgin, close, transmitting | Set the device in configuration state. p1: configuration mode. |
setEcoTemperature |
ANY | Set target temperature of eco mode |
setName |
STRING | Change the device internal name. Name length may be subject to restrictions depending on the device and underlying protocol. |
setOperatingMode |
ANY | |
setSecuredPosition |
INT [0..100] | Set the relative position value (0-100%) to be used for the 'secured' position alias |
setSecuredPositionTemperature |
ANY | Set target temperature of secured mode |
setSetPointMode |
ANY | |
setTargetTemperature |
FLOAT [0.0..100.0]; STRING: eco, secured, comfort, halted, antifrost | Set the new air temperature to reach |
startIdentify |
Ask the device to start winking immediately for an unlimited amount of time | |
stopIdentify |
Ask the device to stop winking immediately | |
unpairAllOneWayControllers |
Unpair all one way controllers from actuator. | |
unpairOneWayController |
STRING; INT [1..16] (optional) | Unpair a one way controller from actuator. p1 : Payload of the QRCode associated to the one way controller p2 : channel (Optional - default : 1) |
wink |
INT [1..254] | Ask the device to identify itself by doing a slight movement or blink or beep for a given amount of seconds. |
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
ComfortRoomTemperatureState |
ContinuousState | ||
CommandLockLevelsState |
DataState | ||
DiscreteRSSILevelState |
DiscreteState | good, low, normal, verylow | |
EcoRoomTemperatureState |
ContinuousState | ||
HeatingTemperatureInterfaceActiveModeState |
DiscreteState | auto, manu | |
HeatingTemperatureInterfaceCapabilitiesState |
DataState | ||
HeatingTemperatureInterfaceEnergyDemandState |
DataState | ||
HeatingTemperatureInterfaceOperatingModeState |
DataState | ||
HeatingTemperatureInterfaceSetPointModeState |
DiscreteState | comfort, eco, secured | |
NameState |
DataState | ||
PriorityLockLevelState |
DiscreteState | comfortLevel1, comfortLevel2, comfortLevel3, comfortLevel4, environmentProtection, humanProtection, userLevel1, userLevel2 | |
PriorityLockOriginatorState |
DiscreteState | LSC, SAAC, SFC, UPS, externalGateway, localUser, myself, rain, security, temperature, timer, user, wind | |
PriorityLockTimerState |
ContinuousState | ||
RSSILevelState |
ContinuousState | ||
SecuredPositionTemperatureState |
ContinuousState | ||
StatusState |
DiscreteState | available, unavailable | |
TargetTemperatureState |
ContinuousState | [12.0..30.0] | |
TemperatureState |
ContinuousState | [-100.0..100.0] |
HeatingSystem/AtlanticPassAPCHeatPump (ACTUATOR) — 41 commands, 39 states
Type IDs: 1442060 | Servers: atlantic_cozytouch, hi_kumo_europe, rexel, somfy_europe | Controllable: io:AtlanticPassAPCHeatPumpMainComponent | Profiles: Specific
Data Properties
core:identifyInterval=500
Commands
| Command | Parameters | Notes |
|---|---|---|
addLockLevel |
INT; INT (optional) | Add a command lock level on the device p1 : The lock level to add p2 : (optional) Duration in second of the lock Level. By default there is no expiration. |
advancedRefresh |
STRING: normal, advanced, custom; ARRAY (optional) | Refresh extra states |
cancelAbsence |
Cancel absence mode on the device | |
delayedStopIdentify |
INT [1..254] | (IO-homecontrol specific) Ask the device to stop winking after a given number of seconds |
getName |
Refresh the device internal name | |
identify |
Ask the device to identify itself by doing a slight movement or blink or beep | |
pairOneWayController |
STRING; INT [1..16] (optional) | Pair a one way controller to actuator. p1 : Payload of the QRCode associated to the one way controller p2 : channel (Optional - default : 1) |
refreshAbsenceSchedulingAvailability |
Check if the absence (holiday) scheduling feature is available | |
refreshDHWAvailability |
Refesh the ECS availability mode | |
refreshDeviceSerialNumber |
Refresh the device serial number | |
refreshElectricEnergyConsumption |
Refresh the electric energy consumption | |
refreshEnergyConsumptionAvailability |
Refresh presence or not of the manage consumption function by energy type | |
refreshErrorCode |
Refresh the current error code | |
refreshHeatingDerogationAvailability |
Check if the heating derogation feature is available | |
refreshOperatingMode |
Refresh an operating mode. | |
refreshOutsideTemperature |
Refresh the outside temperature | |
refreshOutsideTemperatureSensorAvailability |
Check if the system includes an outside temperature sensor | |
refreshProductType |
Refresh product type | |
refreshThermalSchedulingAvailability |
Check if the thermal (heating or cooling) scheduling feature is available | |
refreshTimeProgramById |
STRING | Refresh time programmation corresponding to given id (usually a number) |
refreshZonesNumber |
Refresh the number of associated zones | |
refreshZonesPassAPCCoolingProfile |
Refresh the cooling profile for each zones | |
refreshZonesPassAPCHeatingProfile |
Refresh the heating profile for each zones | |
refreshZonesTargetTemperature |
Refresh the temperature value for each zones | |
refreshZonesTemperature |
Refresh temperature of all zones | |
refreshZonesTemperatureSensorAvailability |
Check if zones have an internal temperature sensor | |
refreshZonesThermalConfiguration |
Refresh zones thermal configuration (heating, cooling, both) | |
removeLockLevel |
INT | Remove the command lock level on the device p1 : The lock level to remove |
resetLockLevels |
Remove all lock levels on the device | |
setAbsenceCoolingTargetTemperature |
FLOAT [18.0..40.0] | Set the cooling target temperature for absence mode. |
setAbsenceEndDateTime |
OBJECT | Set end date of absence period including hour, minute, day, month and year fields |
setAbsenceHeatingTargetTemperature |
FLOAT [4.0..16.0] | Set the heating target temperature for absence mode. |
setAbsenceStartDateTime |
OBJECT | Set start date of absence period including hour, minute, day, month and year fields |
setName |
STRING | Change the device internal name. Name length may be subject to restrictions depending on the device and underlying protocol. |
setPassAPCOperatingMode |
STRING: cooling, drying, heating, stop | Set operating mode to Pass APC |
setTimeProgramById |
STRING; ARRAY | Set time programmation indicating target program id (usually a number) |
startIdentify |
Ask the device to start winking immediately for an unlimited amount of time | |
stopIdentify |
Ask the device to stop winking immediately | |
unpairAllOneWayControllers |
Unpair all one way controllers from actuator. | |
unpairOneWayController |
STRING; INT [1..16] (optional) | Unpair a one way controller from actuator. p1 : Payload of the QRCode associated to the one way controller p2 : channel (Optional - default : 1) |
wink |
INT [1..254] | Ask the device to identify itself by doing a slight movement or blink or beep for a given amount of seconds. |
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
AbsenceCoolingTargetTemperatureState |
ContinuousState | ||
AbsenceEndDateTimeState |
DataState | ||
AbsenceHeatingTargetTemperatureState |
ContinuousState | ||
AbsenceSchedulingAvailabilityState |
DiscreteState | available, unavailable | |
AbsenceSchedulingModeState |
DiscreteState | dateScheduling, numberOfDaysScheduling | |
AbsenceStartDateTimeState |
DataState | ||
CommandLockLevelsState |
DataState | ||
DHWAvailabilityState |
DiscreteState | available, unavailable | |
DeviceSerialNumberState |
DataState | ||
DiscreteRSSILevelState |
DiscreteState | good, low, normal, verylow | |
ECSPowerConsumptionExtra1State |
ContinuousState | ||
ECSPowerConsumptionExtra2State |
ContinuousState | ||
ECSPowerConsumptionExtra3State |
ContinuousState | ||
ECSPowerConsumptionState |
ContinuousState | ||
EnergyConsumptionAvailabilityState |
DiscreteState | available, unavailable | |
ErrorCodeState |
DataState | ||
HeatingDerogationAvailabilityState |
DiscreteState | available, unavailable | |
HeatingPowerConsumptionExtra1State |
ContinuousState | ||
HeatingPowerConsumptionExtra2State |
ContinuousState | ||
HeatingPowerConsumptionExtra3State |
ContinuousState | ||
HeatingPowerConsumptionState |
ContinuousState | ||
LastPassAPCOperatingModeState |
DiscreteState | cooling, drying, heating, stop | |
NameState |
DataState | ||
PassAPCOperatingModeState |
DiscreteState | cooling, drying, heating, stop | |
PassAPCProductTypeState |
DiscreteState | accumulationDomesticHotWater, airConditioning, boiler, convector, doubleFlowControlledMechanicalVentilation, heatPump, heater, hybrid, singleFlowControlledMechanicalVentilation, thermodynamicDomesticHotWater, zoneController | |
PriorityLockLevelState |
DiscreteState | comfortLevel1, comfortLevel2, comfortLevel3, comfortLevel4, environmentProtection, humanProtection, userLevel1, userLevel2 | |
PriorityLockOriginatorState |
DiscreteState | LSC, SAAC, SFC, UPS, externalGateway, localUser, myself, rain, security, temperature, timer, user, wind | |
PriorityLockTimerState |
ContinuousState | ||
ProductModelNameState |
DataState | ||
RSSILevelState |
ContinuousState | ||
StatusState |
DiscreteState | available, unavailable | |
ThermalSchedulingAvailabilityState |
DiscreteState | available, unavailable | |
ThermalSchedulingModeState |
DiscreteState | heatingAndCoolingCommonScheduling, heatingAndCoolingSeparatedScheduling | |
TimeProgram1State |
DataState | ||
TimeProgram2State |
DataState | ||
TimeProgram3State |
DataState | ||
TimeProgram4State |
DataState | ||
VersionState |
ContinuousState | ||
ZonesNumberState |
DataState |
HeatingSystem/AtlanticPassAPCHeatingAndCoolingZone (ACTUATOR) — 28 commands, 22 states
Type IDs: 1442060 | Servers: atlantic_cozytouch, hi_kumo_europe, rexel, somfy_europe | Controllable: io:AtlanticPassAPCHeatingAndCoolingZoneComponent | Profiles: ThermostatTargetReader
Commands
| Command | Parameters | Notes |
|---|---|---|
addLockLevel |
INT; INT (optional) | Add a command lock level on the device p1 : The lock level to add p2 : (optional) Duration in second of the lock Level. By default there is no expiration. |
advancedRefresh |
STRING: normal, advanced, custom; ARRAY (optional) | Refresh extra states |
refreshComfortCoolingTargetTemperature |
Refresh comfort cooling target temperature. | |
refreshComfortHeatingTargetTemperature |
Refresh comfort heating target temperature. | |
refreshDerogationRemainingTime |
Refresh the derogation remaining duration | |
refreshEcoCoolingTargetTemperature |
Refresh eco cooling target temperature. | |
refreshEcoHeatingTargetTemperature |
Refresh eco heating target temperature. | |
refreshPassAPCCoolingMode |
Ask the device to return coling mode | |
refreshPassAPCCoolingProfile |
Ask the device to return cooling profile | |
refreshPassAPCHeatingMode |
Ask the device to return heating mode | |
refreshPassAPCHeatingProfile |
Ask the device to return heating profile | |
refreshTargetTemperature |
Refresh the temperature value | |
removeLockLevel |
INT | Remove the command lock level on the device p1 : The lock level to remove |
resetLockLevels |
Remove all lock levels on the device | |
setActiveCoolingTimeProgram |
STRING | Select the active time program for cooling mode. Parameter matchs with program id (usually numbers) |
setActiveHeatingTimeProgram |
STRING | Select the active time program for heating mode. Parameter matchs with program id (usually numbers) |
setComfortCoolingTargetTemperature |
FLOAT [7.0..30.0] | Define the cooling setpoint temperature for comfort mode |
setComfortHeatingTargetTemperature |
FLOAT [10.0..35.0] | Define the heating setpoint temperature for comfort mode |
setCoolingOnOffState |
STRING: on, off | Switch on or switch off the heating system |
setDerogatedTargetTemperature |
FLOAT [7.0..35.0] | Set the derogated temperature setpoint |
setDerogationOnOffState |
STRING: on, off | Switch on or switch off the derogation mode |
setDerogationTime |
INT [0..24] | Defines the duration of derogation mode |
setEcoCoolingTargetTemperature |
FLOAT [7.0..30.0] | Define the cooling setpoint temperature for eco mode |
setEcoHeatingTargetTemperature |
FLOAT [7.0..30.0] | Define the heating setpoint temperature for eco mode |
setHeatingOnOffState |
STRING: on, off | Switch on or switch off the cooling system |
setName |
STRING | Change the device internal name. Name length may be subject to restrictions depending on the device and underlying protocol. |
setPassAPCCoolingMode |
STRING: absence, auto, comfort, eco, externalScheduling | Set the cooling mode |
setPassAPCHeatingMode |
STRING: absence, auto, comfort, eco, externalScheduling | Set the heating mode |
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
ActiveCoolingTimeProgramState |
DataState | ||
ActiveHeatingTimeProgramState |
DataState | ||
ComfortCoolingTargetTemperatureState |
ContinuousState | ||
ComfortHeatingTargetTemperatureState |
ContinuousState | ||
CommandLockLevelsState |
DataState | ||
CoolingInternalSchedulingAvailabilityState |
DiscreteState | available, unavailable | |
CoolingOnOffState |
DiscreteState | off, on | |
DerogatedTargetTemperatureState |
ContinuousState | ||
DerogationOnOffState |
DiscreteState | off, on | |
DerogationRemainingTimeState |
DataState | ||
EcoCoolingTargetTemperatureState |
ContinuousState | ||
EcoHeatingTargetTemperatureState |
ContinuousState | ||
HeatingInternalSchedulingAvailabilityState |
DiscreteState | available, unavailable | |
HeatingOnOffState |
DiscreteState | off, on | |
NameState |
DataState | ||
PassAPCCoolingModeState |
DiscreteState | absence, auto, comfort, eco, externalScheduling, internalScheduling, manu, stop | |
PassAPCCoolingProfileState |
DiscreteState | absence, comfort, derogation, eco, externalSetpoint, frostprotection, manu, stop | |
PassAPCHeatingModeState |
DiscreteState | absence, auto, comfort, eco, externalScheduling, internalScheduling, manu, stop | |
PassAPCHeatingProfileState |
DiscreteState | absence, comfort, derogation, eco, externalSetpoint, frostprotection, manu, stop | |
StatusState |
DiscreteState | available, unavailable | |
TargetTemperatureState |
ContinuousState | [12.0..30.0] | |
ThermalConfigurationState |
DiscreteState | cooling, heating, heatingAndCooling |
HeatingSystem/AtlanticPassAPCBoiler (ACTUATOR) — 38 commands, 38 states
Type IDs: 1442316 | Servers: atlantic_cozytouch, hi_kumo_europe, rexel, somfy_europe | Controllable: io:AtlanticPassAPCBoilerMainComponent | Profiles: Specific
Data Properties
core:identifyInterval=500
Commands
| Command | Parameters | Notes |
|---|---|---|
addLockLevel |
INT; INT (optional) | Add a command lock level on the device p1 : The lock level to add p2 : (optional) Duration in second of the lock Level. By default there is no expiration. |
advancedRefresh |
STRING: normal, advanced, custom; ARRAY (optional) | Refresh extra states |
cancelAbsence |
Cancel absence mode on the device | |
delayedStopIdentify |
INT [1..254] | (IO-homecontrol specific) Ask the device to stop winking after a given number of seconds |
getName |
Refresh the device internal name | |
identify |
Ask the device to identify itself by doing a slight movement or blink or beep | |
pairOneWayController |
STRING; INT [1..16] (optional) | Pair a one way controller to actuator. p1 : Payload of the QRCode associated to the one way controller p2 : channel (Optional - default : 1) |
refreshAbsenceSchedulingAvailability |
Check if the absence (holiday) scheduling feature is available | |
refreshDHWAvailability |
Refesh the ECS availability mode | |
refreshDeviceSerialNumber |
Refresh the device serial number | |
refreshEnergyConsumptionAvailability |
Refresh presence or not of the manage consumption function by energy type | |
refreshErrorCode |
Refresh the current error code | |
refreshHeatingDerogationAvailability |
Check if the heating derogation feature is available | |
refreshOperatingMode |
Refresh an operating mode. | |
refreshOutsideTemperature |
Refresh the outside temperature | |
refreshOutsideTemperatureSensorAvailability |
Check if the system includes an outside temperature sensor | |
refreshProductType |
Refresh product type | |
refreshThermalSchedulingAvailability |
Check if the thermal (heating or cooling) scheduling feature is available | |
refreshTimeProgramById |
STRING | Refresh time programmation corresponding to given id (usually a number) |
refreshZonesNumber |
Refresh the number of associated zones | |
refreshZonesPassAPCHeatingProfile |
Refresh the heating profile for each zones | |
refreshZonesTargetTemperature |
Refresh the temperature value for each zones | |
refreshZonesTemperature |
Refresh temperature of all zones | |
refreshZonesTemperatureSensorAvailability |
Check if zones have an internal temperature sensor | |
refreshZonesThermalConfiguration |
Refresh zones thermal configuration (heating, cooling, both) | |
removeLockLevel |
INT | Remove the command lock level on the device p1 : The lock level to remove |
resetLockLevels |
Remove all lock levels on the device | |
setAbsenceEndDateTime |
OBJECT | Set end date of absence period including hour, minute, day, month and year fields |
setAbsenceHeatingTargetTemperature |
FLOAT [4.0..16.0] | Set the heating target temperature for absence mode. |
setAbsenceStartDateTime |
OBJECT | Set start date of absence period including hour, minute, day, month and year fields |
setName |
STRING | Change the device internal name. Name length may be subject to restrictions depending on the device and underlying protocol. |
setPassAPCOperatingMode |
STRING: cooling, drying, heating, stop | Set operating mode to Pass APC |
setTimeProgramById |
STRING; ARRAY | Set time programmation indicating target program id (usually a number) |
startIdentify |
Ask the device to start winking immediately for an unlimited amount of time | |
stopIdentify |
Ask the device to stop winking immediately | |
unpairAllOneWayControllers |
Unpair all one way controllers from actuator. | |
unpairOneWayController |
STRING; INT [1..16] (optional) | Unpair a one way controller from actuator. p1 : Payload of the QRCode associated to the one way controller p2 : channel (Optional - default : 1) |
wink |
INT [1..254] | Ask the device to identify itself by doing a slight movement or blink or beep for a given amount of seconds. |
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
AbsenceEndDateTimeState |
DataState | ||
AbsenceHeatingTargetTemperatureState |
ContinuousState | ||
AbsenceSchedulingAvailabilityState |
DiscreteState | available, unavailable | |
AbsenceSchedulingModeState |
DiscreteState | dateScheduling, numberOfDaysScheduling | |
AbsenceStartDateTimeState |
DataState | ||
CommandLockLevelsState |
DataState | ||
DHWAvailabilityState |
DiscreteState | available, unavailable | |
DeviceSerialNumberState |
DataState | ||
DiscreteRSSILevelState |
DiscreteState | good, low, normal, verylow | |
ECSPowerConsumptionExtra1State |
ContinuousState | ||
ECSPowerConsumptionExtra2State |
ContinuousState | ||
ECSPowerConsumptionExtra3State |
ContinuousState | ||
ECSPowerConsumptionState |
ContinuousState | ||
EnergyConsumptionAvailabilityState |
DiscreteState | available, unavailable | |
ErrorCodeState |
DataState | ||
HeatingDerogationAvailabilityState |
DiscreteState | available, unavailable | |
HeatingPowerConsumptionExtra1State |
ContinuousState | ||
HeatingPowerConsumptionExtra2State |
ContinuousState | ||
HeatingPowerConsumptionExtra3State |
ContinuousState | ||
HeatingPowerConsumptionState |
ContinuousState | ||
LastPassAPCOperatingModeState |
DiscreteState | cooling, drying, heating, stop | |
NameState |
DataState | ||
PassAPCOperatingModeState |
DiscreteState | cooling, drying, heating, stop | |
PassAPCProductTypeState |
DiscreteState | accumulationDomesticHotWater, airConditioning, boiler, convector, doubleFlowControlledMechanicalVentilation, heatPump, heater, hybrid, singleFlowControlledMechanicalVentilation, thermodynamicDomesticHotWater, zoneController | |
PriorityLockLevelState |
DiscreteState | comfortLevel1, comfortLevel2, comfortLevel3, comfortLevel4, environmentProtection, humanProtection, userLevel1, userLevel2 | |
PriorityLockOriginatorState |
DiscreteState | LSC, SAAC, SFC, UPS, externalGateway, localUser, myself, rain, security, temperature, timer, user, wind | |
PriorityLockTimerState |
ContinuousState | ||
ProductModelNameState |
DataState | ||
RSSILevelState |
ContinuousState | ||
StatusState |
DiscreteState | available, unavailable | |
ThermalSchedulingAvailabilityState |
DiscreteState | available, unavailable | |
ThermalSchedulingModeState |
DiscreteState | heatingAndCoolingCommonScheduling, heatingAndCoolingSeparatedScheduling | |
TimeProgram1State |
DataState | ||
TimeProgram2State |
DataState | ||
TimeProgram3State |
DataState | ||
TimeProgram4State |
DataState | ||
VersionState |
ContinuousState | ||
ZonesNumberState |
DataState |
HeatingSystem/AtlanticPassAPCHeatingZone (ACTUATOR) — 19 commands, 15 states
Type IDs: 1442316 | Servers: atlantic_cozytouch, hi_kumo_europe, rexel, somfy_europe | Controllable: io:AtlanticPassAPCHeatingZoneComponent | Profiles: ThermostatTargetReader
Commands
| Command | Parameters | Notes |
|---|---|---|
addLockLevel |
INT; INT (optional) | Add a command lock level on the device p1 : The lock level to add p2 : (optional) Duration in second of the lock Level. By default there is no expiration. |
advancedRefresh |
STRING: normal, advanced, custom; ARRAY (optional) | Refresh extra states |
refreshComfortHeatingTargetTemperature |
Refresh comfort heating target temperature. | |
refreshDerogationRemainingTime |
Refresh the derogation remaining duration | |
refreshEcoHeatingTargetTemperature |
Refresh eco heating target temperature. | |
refreshPassAPCHeatingMode |
Ask the device to return heating mode | |
refreshPassAPCHeatingProfile |
Ask the device to return heating profile | |
refreshTargetTemperature |
Refresh the temperature value | |
removeLockLevel |
INT | Remove the command lock level on the device p1 : The lock level to remove |
resetLockLevels |
Remove all lock levels on the device | |
setActiveHeatingTimeProgram |
STRING | Select the active time program for heating mode. Parameter matchs with program id (usually numbers) |
setComfortHeatingTargetTemperature |
FLOAT [10.0..35.0] | Define the heating setpoint temperature for comfort mode |
setDerogatedTargetTemperature |
FLOAT [7.0..35.0]; INT: 0 | Set the derogated temperature setpoint |
setDerogationOnOffState |
STRING: on, off | Switch on or switch off the derogation mode |
setDerogationTime |
INT [0..24] | Defines the duration of derogation mode |
setEcoHeatingTargetTemperature |
FLOAT [7.0..30.0] | Define the heating setpoint temperature for eco mode |
setHeatingOnOffState |
STRING: on, off | Switch on or switch off the cooling system |
setName |
STRING | Change the device internal name. Name length may be subject to restrictions depending on the device and underlying protocol. |
setPassAPCHeatingMode |
STRING: absence, auto, comfort, eco, externalScheduling | Set the heating mode |
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
ActiveHeatingTimeProgramState |
DataState | ||
ComfortHeatingTargetTemperatureState |
ContinuousState | ||
CommandLockLevelsState |
DataState | ||
DerogatedTargetTemperatureState |
ContinuousState | ||
DerogationOnOffState |
DiscreteState | off, on | |
DerogationRemainingTimeState |
DataState | ||
EcoHeatingTargetTemperatureState |
ContinuousState | ||
HeatingComfortModeAvailabilityState |
DiscreteState | available, unavailable | |
HeatingOnOffState |
DiscreteState | off, on | |
NameState |
DataState | ||
PassAPCHeatingModeState |
DiscreteState | absence, auto, comfort, eco, externalScheduling, internalScheduling, manu, stop | |
PassAPCHeatingProfileState |
DiscreteState | absence, comfort, derogation, eco, externalSetpoint, frostprotection, manu, stop | |
StatusState |
DiscreteState | available, unavailable | |
TargetTemperatureState |
ContinuousState | [12.0..30.0] | |
ThermalConfigurationState |
DiscreteState | cooling, heating, heatingAndCooling |
HeatingSystem/AtlanticPassAPCZoneControl (ACTUATOR) — 37 commands, 30 states
Type IDs: 1835020 | Servers: atlantic_cozytouch, hi_kumo_europe, rexel, somfy_europe | Controllable: io:AtlanticPassAPCZoneControlMainComponent | Profiles: Specific
Data Properties
core:identifyInterval=500
Commands
| Command | Parameters | Notes |
|---|---|---|
addLockLevel |
INT; INT (optional) | Add a command lock level on the device p1 : The lock level to add p2 : (optional) Duration in second of the lock Level. By default there is no expiration. |
advancedRefresh |
STRING: normal, advanced, custom; ARRAY (optional) | Refresh extra states |
cancelAbsence |
Cancel absence mode on the device | |
delayedStopIdentify |
INT [1..254] | (IO-homecontrol specific) Ask the device to stop winking after a given number of seconds |
getName |
Refresh the device internal name | |
identify |
Ask the device to identify itself by doing a slight movement or blink or beep | |
pairOneWayController |
STRING; INT [1..16] (optional) | Pair a one way controller to actuator. p1 : Payload of the QRCode associated to the one way controller p2 : channel (Optional - default : 1) |
refreshAbsenceSchedulingAvailability |
Check if the absence (holiday) scheduling feature is available | |
refreshDeviceSerialNumber |
Refresh the device serial number | |
refreshErrorCode |
Refresh the current error code | |
refreshHeatingDerogationAvailability |
Check if the heating derogation feature is available | |
refreshOperatingMode |
Refresh an operating mode. | |
refreshProductType |
Refresh product type | |
refreshThermalSchedulingAvailability |
Check if the thermal (heating or cooling) scheduling feature is available | |
refreshTimeProgramById |
STRING | Refresh time programmation corresponding to given id (usually a number) |
refreshZonesNumber |
Refresh the number of associated zones | |
refreshZonesPassAPCCoolingProfile |
Refresh the cooling profile for each zones | |
refreshZonesPassAPCHeatingProfile |
Refresh the heating profile for each zones | |
refreshZonesTargetTemperature |
Refresh the temperature value for each zones | |
refreshZonesTemperature |
Refresh temperature of all zones | |
refreshZonesTemperatureSensorAvailability |
Check if zones have an internal temperature sensor | |
refreshZonesThermalConfiguration |
Refresh zones thermal configuration (heating, cooling, both) | |
removeLockLevel |
INT | Remove the command lock level on the device p1 : The lock level to remove |
resetLockLevels |
Remove all lock levels on the device | |
setAbsenceCoolingTargetTemperature |
FLOAT [18.0..40.0] | Set the cooling target temperature for absence mode. |
setAbsenceEndDateTime |
OBJECT | Set end date of absence period including hour, minute, day, month and year fields |
setAbsenceHeatingTargetTemperature |
FLOAT [4.0..16.0] | Set the heating target temperature for absence mode. |
setAbsenceStartDateTime |
OBJECT | Set start date of absence period including hour, minute, day, month and year fields |
setHeatingCoolingAutoSwitch |
STRING: on, off | Enable or disable automatic switch between heating and cooling modes |
setName |
STRING | Change the device internal name. Name length may be subject to restrictions depending on the device and underlying protocol. |
setPassAPCOperatingMode |
STRING: cooling, drying, heating, stop | Set operating mode to Pass APC |
setTimeProgramById |
STRING; ARRAY | Set time programmation indicating target program id (usually a number) |
startIdentify |
Ask the device to start winking immediately for an unlimited amount of time | |
stopIdentify |
Ask the device to stop winking immediately | |
unpairAllOneWayControllers |
Unpair all one way controllers from actuator. | |
unpairOneWayController |
STRING; INT [1..16] (optional) | Unpair a one way controller from actuator. p1 : Payload of the QRCode associated to the one way controller p2 : channel (Optional - default : 1) |
wink |
INT [1..254] | Ask the device to identify itself by doing a slight movement or blink or beep for a given amount of seconds. |
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
AbsenceCoolingTargetTemperatureState |
ContinuousState | ||
AbsenceEndDateTimeState |
DataState | ||
AbsenceHeatingTargetTemperatureState |
ContinuousState | ||
AbsenceSchedulingAvailabilityState |
DiscreteState | available, unavailable | |
AbsenceSchedulingModeState |
DiscreteState | dateScheduling, numberOfDaysScheduling | |
AbsenceStartDateTimeState |
DataState | ||
CommandLockLevelsState |
DataState | ||
DeviceSerialNumberState |
DataState | ||
DiscreteRSSILevelState |
DiscreteState | good, low, normal, verylow | |
ErrorCodeState |
DataState | ||
HeatingCoolingAutoSwitchState |
DiscreteState | off, on | |
HeatingDerogationAvailabilityState |
DiscreteState | available, unavailable | |
LastPassAPCOperatingModeState |
DiscreteState | cooling, drying, heating, stop | |
NameState |
DataState | ||
PassAPCOperatingModeState |
DiscreteState | cooling, drying, heating, stop | |
PassAPCProductTypeState |
DiscreteState | accumulationDomesticHotWater, airConditioning, boiler, convector, doubleFlowControlledMechanicalVentilation, heatPump, heater, hybrid, singleFlowControlledMechanicalVentilation, thermodynamicDomesticHotWater, zoneController | |
PriorityLockLevelState |
DiscreteState | comfortLevel1, comfortLevel2, comfortLevel3, comfortLevel4, environmentProtection, humanProtection, userLevel1, userLevel2 | |
PriorityLockOriginatorState |
DiscreteState | LSC, SAAC, SFC, UPS, externalGateway, localUser, myself, rain, security, temperature, timer, user, wind | |
PriorityLockTimerState |
ContinuousState | ||
ProductModelNameState |
DataState | ||
RSSILevelState |
ContinuousState | ||
StatusState |
DiscreteState | available, unavailable | |
ThermalSchedulingAvailabilityState |
DiscreteState | available, unavailable | |
ThermalSchedulingModeState |
DiscreteState | heatingAndCoolingCommonScheduling, heatingAndCoolingSeparatedScheduling | |
TimeProgram1State |
DataState | ||
TimeProgram2State |
DataState | ||
TimeProgram3State |
DataState | ||
TimeProgram4State |
DataState | ||
VersionState |
ContinuousState | ||
ZonesNumberState |
DataState |
HeatingSystem/AtlanticPassAPCHeatingAndCoolingZone (ACTUATOR) — 35 commands, 26 states
Type IDs: 1835020 | Servers: atlantic_cozytouch, hi_kumo_europe, rexel, somfy_europe | Controllable: io:AtlanticPassAPCZoneControlZoneComponent | Profiles: StatefulCoolingThermostat, CoolingThermostat, StatefulDualThermostat, DualThermostat, ThermostatTargetReader
Commands
| Command | Parameters | Notes |
|---|---|---|
addLockLevel |
INT; INT (optional) | Add a command lock level on the device p1 : The lock level to add p2 : (optional) Duration in second of the lock Level. By default there is no expiration. |
advancedRefresh |
STRING: normal, advanced, custom; ARRAY (optional) | Refresh extra states |
refreshComfortCoolingTargetTemperature |
Refresh comfort cooling target temperature. | |
refreshComfortHeatingTargetTemperature |
Refresh comfort heating target temperature. | |
refreshEcoCoolingTargetTemperature |
Refresh eco cooling target temperature. | |
refreshEcoHeatingTargetTemperature |
Refresh eco heating target temperature. | |
refreshMaximumCoolingTargetTemperature |
Refresh the maximum cooling target temperature | |
refreshMaximumHeatingTargetTemperature |
Refresh the maximum heating target temperature | |
refreshMinimumCoolingTargetTemperature |
Refresh the minimum cooling target temperature | |
refreshMinimumHeatingTargetTemperature |
Refresh the minimum heating target temperature | |
refreshPassAPCCoolingMode |
Ask the device to return coling mode | |
refreshPassAPCCoolingProfile |
Ask the device to return cooling profile | |
refreshPassAPCHeatingMode |
Ask the device to return heating mode | |
refreshPassAPCHeatingProfile |
Ask the device to return heating profile | |
refreshTargetTemperature |
Refresh the temperature value | |
removeLockLevel |
INT | Remove the command lock level on the device p1 : The lock level to remove |
resetLockLevels |
Remove all lock levels on the device | |
setActiveCoolingTimeProgram |
STRING | Select the active time program for cooling mode. Parameter matchs with program id (usually numbers) |
setActiveHeatingTimeProgram |
STRING | Select the active time program for heating mode. Parameter matchs with program id (usually numbers) |
setComfortCoolingTargetTemperature |
FLOAT [7.0..30.0] | Define the cooling setpoint temperature for comfort mode |
setComfortHeatingTargetTemperature |
FLOAT [10.0..35.0] | Define the heating setpoint temperature for comfort mode |
setCoolingOnOffState |
STRING: on, off | Switch on or switch off the heating system |
setCoolingTargetTemperature |
FLOAT [7.0..35.0] | Set the cooling target temperature (manual set point) |
setDerogationOnOffState |
STRING: on, off | Switch on or switch off the derogation mode |
setEcoCoolingTargetTemperature |
FLOAT [7.0..30.0] | Define the cooling setpoint temperature for eco mode |
setEcoHeatingTargetTemperature |
FLOAT [7.0..30.0] | Define the heating setpoint temperature for eco mode |
setHeatingOnOffState |
STRING: on, off | Switch on or switch off the cooling system |
setHeatingTargetTemperature |
FLOAT [7.0..35.0] | Set the heating target temperature (manual set point) |
setMaximumCoolingTargetTemperature |
FLOAT [4.0..40.0] | Set the maximum cooling target temperature (manual set point) |
setMaximumHeatingTargetTemperature |
FLOAT [4.0..40.0] | Set the maximum heating target temperature (manual set point) |
setMinimumCoolingTargetTemperature |
FLOAT [4.0..40.0] | Set the minimum cooling target temperature (manual set point) |
setMinimumHeatingTargetTemperature |
FLOAT [4.0..40.0] | Set the minimum heating target temperature (manual set point) |
setName |
STRING | Change the device internal name. Name length may be subject to restrictions depending on the device and underlying protocol. |
setPassAPCCoolingMode |
STRING: absence, auto, comfort, eco, externalScheduling | Set the cooling mode |
setPassAPCHeatingMode |
STRING: absence, auto, comfort, eco, externalScheduling | Set the heating mode |
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
ActiveCoolingTimeProgramState |
DataState | ||
ActiveHeatingTimeProgramState |
DataState | ||
ComfortCoolingTargetTemperatureState |
ContinuousState | ||
ComfortHeatingTargetTemperatureState |
ContinuousState | ||
CommandLockLevelsState |
DataState | ||
CoolingManualModeAvailabilityState |
DiscreteState | available, unavailable | |
CoolingOnOffState |
DiscreteState | off, on | |
CoolingTargetTemperatureState |
ContinuousState | [12.0..30.0] | |
DerogationOnOffState |
DiscreteState | off, on | |
EcoCoolingTargetTemperatureState |
ContinuousState | ||
EcoHeatingTargetTemperatureState |
ContinuousState | ||
HeatingManualModeAvailabilityState |
DiscreteState | available, unavailable | |
HeatingOnOffState |
DiscreteState | off, on | |
HeatingTargetTemperatureState |
ContinuousState | [12.0..30.0] | |
MaximumCoolingTargetTemperatureState |
ContinuousState | ||
MaximumHeatingTargetTemperatureState |
ContinuousState | ||
MinimumCoolingTargetTemperatureState |
ContinuousState | ||
MinimumHeatingTargetTemperatureState |
ContinuousState | ||
NameState |
DataState | ||
PassAPCCoolingModeState |
DiscreteState | absence, auto, comfort, eco, externalScheduling, internalScheduling, manu, stop | |
PassAPCCoolingProfileState |
DiscreteState | absence, comfort, derogation, eco, externalSetpoint, frostprotection, manu, stop | |
PassAPCHeatingModeState |
DiscreteState | absence, auto, comfort, eco, externalScheduling, internalScheduling, manu, stop | |
PassAPCHeatingProfileState |
DiscreteState | absence, comfort, derogation, eco, externalSetpoint, frostprotection, manu, stop | |
StatusState |
DiscreteState | available, unavailable | |
TargetTemperatureState |
ContinuousState | [12.0..30.0] | |
ThermalConfigurationState |
DiscreteState | cooling, heating, heatingAndCooling |
Light/DimmerLight (ACTUATOR) — 33 commands, 15 states
Type IDs: 393216, 393218 | Servers: atlantic_cozytouch, hi_kumo_europe, rexel | Controllable: io:DimmableLightIOComponent | Profiles: StatefulLightDimmer, StatefulDimmable, Dimmable, StatefulSwitchable, Switchable
Data Properties
core:identifyInterval=500
Commands
| Command | Parameters | Notes |
|---|---|---|
addLockLevel |
INT; INT (optional) | Add a command lock level on the device p1 : The lock level to add p2 : (optional) Duration in second of the lock Level. By default there is no expiration. |
advancedRefresh |
STRING: normal, advanced, custom; ARRAY (optional) | Refresh extra states |
delayedStopIdentify |
INT [1..254] | (IO-homecontrol specific) Ask the device to stop winking after a given number of seconds |
executeManufacturerProcedure |
STRING; OBJECT; OBJECT (optional) | execute manufacturer procedure command. p1: the procedure name p2: the params associated Example: p1 = "dead_man_up" p2 = {"duration": 42} |
getName |
Refresh the device internal name | |
identify |
Ask the device to identify itself by doing a slight movement or blink or beep | |
keepOneWayControllersAndDeleteNode |
Delete 2way key from actuator and delete the device. All one way controllers remain linked to the actuator. | |
my |
Set the device to a user pre-defined position | |
off |
Turn off the device | |
on |
Turn on the device | |
onWithTimer |
INT [5..14400] | Turn the device on for a given amount of seconds then turn it off |
pairOneWayController |
STRING; INT [1..16] (optional) | Pair a one way controller to actuator. p1 : Payload of the QRCode associated to the one way controller p2 : channel (Optional - default : 1) |
readManufacturerData |
ARRAY | Read manufacturer data values from given names. Example: ["setting1","setting2"]. |
refreshMemorized1Position |
Refresh memorized 1 position state | |
removeLockLevel |
INT | Remove the command lock level on the device p1 : The lock level to remove |
resetLockLevels |
Remove all lock levels on the device | |
runManufacturerSettingsCommand |
STRING; OBJECT | Send a manufacturer configuration command. p1: The manufacturer configuration command to use p2: The arguments to send to this command |
sendIOKey |
Send the IO key to device. | |
setConfigState |
STRING: configuration, virgin, close, transmitting | Set the device in configuration state. p1: configuration mode. |
setIntensity |
INT [0..100] | Light intensity level (100%=maximum intensity, 0%=off) |
setIntensityWithTimer |
INT [0..100]; INT [5..14400]; INT [0..100] (optional) | Set the light intensity to p1% then after p2 seconds, set it to p3%. (If p3 is not specified the light is turned off after the delay) |
setMemorized1Position |
INT [0..100] | Set favorite position |
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 |
setPosition |
STRING: my, memorized1, secured; INT [0..100] | Set the device to a pre-defined position (enum) or a relative position (0-100%) |
setSecuredPosition |
INT [0..100] | Set the relative position value (0-100%) to be used for the 'secured' position alias |
startIdentify |
Ask the device to start winking immediately for an unlimited amount of time | |
stopIdentify |
Ask the device to stop winking immediately | |
unpairAllOneWayControllers |
Unpair all one way controllers from actuator. | |
unpairAllOneWayControllersAndDeleteNode |
Unpair all one way controllers from actuator. Delete 2way key from actuator and delete the device. | |
unpairOneWayController |
STRING; INT [1..16] (optional) | Unpair a one way controller from actuator. p1 : Payload of the QRCode associated to the one way controller p2 : channel (Optional - default : 1) |
wink |
INT [1..254] | Ask the device to identify itself by doing a slight movement or blink or beep for a given amount of seconds. |
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 |
|---|---|---|---|
AdditionalStatusState |
DataState | ||
CommandLockLevelsState |
DataState | ||
DiscreteRSSILevelState |
DiscreteState | good, low, normal, verylow | |
LightIntensityState |
ContinuousState | [0..100] | |
ManufacturerDiagnosticsState |
DataState | ||
ManufacturerSettingsState |
DataState | ||
Memorized1PositionState |
ContinuousState | ||
NameState |
DataState | ||
OnOffState |
DiscreteState | on, off | |
PriorityLockLevelState |
DiscreteState | comfortLevel1, comfortLevel2, comfortLevel3, comfortLevel4, environmentProtection, humanProtection, userLevel1, userLevel2 | |
PriorityLockOriginatorState |
DiscreteState | LSC, SAAC, SFC, UPS, externalGateway, localUser, myself, rain, security, temperature, timer, user, wind | |
PriorityLockTimerState |
ContinuousState | ||
RSSILevelState |
ContinuousState | ||
SecuredPositionState |
ContinuousState | ||
StatusState |
DiscreteState | available, unavailable |
Light/DimmerRGBColouredLight (ACTUATOR) — 35 commands, 18 states
Type IDs: 393472, 393474 | Servers: atlantic_cozytouch, hi_kumo_europe, rexel | Controllable: io:DimmableRGBLightIOComponent | Profiles: StatefulLightDimmer, StatefulDimmable, Dimmable, StatefulSwitchable, Switchable
Data Properties
core:identifyInterval=500
Commands
| Command | Parameters | Notes |
|---|---|---|
addLockLevel |
INT; INT (optional) | Add a command lock level on the device p1 : The lock level to add p2 : (optional) Duration in second of the lock Level. By default there is no expiration. |
advancedRefresh |
STRING: normal, advanced, custom; ARRAY (optional) | Refresh extra states |
delayedStopIdentify |
INT [1..254] | (IO-homecontrol specific) Ask the device to stop winking after a given number of seconds |
executeManufacturerProcedure |
STRING; OBJECT; OBJECT (optional) | execute manufacturer procedure command. p1: the procedure name p2: the params associated Example: p1 = "dead_man_up" p2 = {"duration": 42} |
getName |
Refresh the device internal name | |
identify |
Ask the device to identify itself by doing a slight movement or blink or beep | |
keepOneWayControllersAndDeleteNode |
Delete 2way key from actuator and delete the device. All one way controllers remain linked to the actuator. | |
my |
Set the device to a user pre-defined position | |
off |
Turn off the device | |
on |
Turn on the device | |
onWithTimer |
INT [5..14400] | Turn the device on for a given amount of seconds then turn it off |
pairOneWayController |
STRING; INT [1..16] (optional) | Pair a one way controller to actuator. p1 : Payload of the QRCode associated to the one way controller p2 : channel (Optional - default : 1) |
readManufacturerData |
ARRAY | Read manufacturer data values from given names. Example: ["setting1","setting2"]. |
refreshMemorized1Position |
Refresh memorized 1 position state | |
removeLockLevel |
INT | Remove the command lock level on the device p1 : The lock level to remove |
resetLockLevels |
Remove all lock levels on the device | |
runManufacturerSettingsCommand |
STRING; OBJECT | Send a manufacturer configuration command. p1: The manufacturer configuration command to use p2: The arguments to send to this command |
sendIOKey |
Send the IO key to device. | |
setConfigState |
STRING: configuration, virgin, close, transmitting | Set the device in configuration state. p1: configuration mode. |
setIntensity |
INT [0..100] | Light intensity level (100%=maximum intensity, 0%=off) |
setIntensityWithTimer |
INT [0..100]; INT [5..14400]; INT [0..100] (optional) | Set the light intensity to p1% then after p2 seconds, set it to p3%. (If p3 is not specified the light is turned off after the delay) |
setMemorized1Position |
INT [0..100] | Set favorite position |
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 |
setPosition |
STRING: my, memorized1, secured; INT [0..100] | Set the device to a pre-defined position (enum) or a relative position (0-100%) |
setRGB |
INT [0..255]; INT [0..255]; INT [0..255] | Set the Red,Green,Blue components of the lamp color |
setRGBWithTimer |
INT [0..255]; INT [0..255]; INT [0..255]; INT [5..14400] | Set the Red,Green,Blue components of the lamp color |
setSecuredPosition |
INT [0..100] | Set the relative position value (0-100%) to be used for the 'secured' position alias |
startIdentify |
Ask the device to start winking immediately for an unlimited amount of time | |
stopIdentify |
Ask the device to stop winking immediately | |
unpairAllOneWayControllers |
Unpair all one way controllers from actuator. | |
unpairAllOneWayControllersAndDeleteNode |
Unpair all one way controllers from actuator. Delete 2way key from actuator and delete the device. | |
unpairOneWayController |
STRING; INT [1..16] (optional) | Unpair a one way controller from actuator. p1 : Payload of the QRCode associated to the one way controller p2 : channel (Optional - default : 1) |
wink |
INT [1..254] | Ask the device to identify itself by doing a slight movement or blink or beep for a given amount of seconds. |
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 |
|---|---|---|---|
AdditionalStatusState |
DataState | ||
BlueColorIntensityState |
ContinuousState | ||
CommandLockLevelsState |
DataState | ||
DiscreteRSSILevelState |
DiscreteState | good, low, normal, verylow | |
GreenColorIntensityState |
ContinuousState | ||
LightIntensityState |
ContinuousState | [0..100] | |
ManufacturerDiagnosticsState |
DataState | ||
ManufacturerSettingsState |
DataState | ||
Memorized1PositionState |
ContinuousState | ||
NameState |
DataState | ||
OnOffState |
DiscreteState | on, off | |
PriorityLockLevelState |
DiscreteState | comfortLevel1, comfortLevel2, comfortLevel3, comfortLevel4, environmentProtection, humanProtection, userLevel1, userLevel2 | |
PriorityLockOriginatorState |
DiscreteState | LSC, SAAC, SFC, UPS, externalGateway, localUser, myself, rain, security, temperature, timer, user, wind | |
PriorityLockTimerState |
ContinuousState | ||
RSSILevelState |
ContinuousState | ||
RedColorIntensityState |
ContinuousState | ||
SecuredPositionState |
ContinuousState | ||
StatusState |
DiscreteState | available, unavailable |
Light/DimmerColorTemperatureLight (ACTUATOR) — 34 commands, 16 states
Type IDs: 393730 | Servers: atlantic_cozytouch, hi_kumo_europe, rexel | Controllable: io:DimmableColorTemperatureLightIOComponent | Profiles: StatefulLightDimmer, StatefulDimmable, Dimmable, StatefulSwitchable, Switchable
Data Properties
core:identifyInterval=500
Commands
| Command | Parameters | Notes |
|---|---|---|
addLockLevel |
INT; INT (optional) | Add a command lock level on the device p1 : The lock level to add p2 : (optional) Duration in second of the lock Level. By default there is no expiration. |
advancedRefresh |
STRING: normal, advanced, custom; ARRAY (optional) | Refresh extra states |
delayedStopIdentify |
INT [1..254] | (IO-homecontrol specific) Ask the device to stop winking after a given number of seconds |
executeManufacturerProcedure |
STRING; OBJECT; OBJECT (optional) | execute manufacturer procedure command. p1: the procedure name p2: the params associated Example: p1 = "dead_man_up" p2 = {"duration": 42} |
getName |
Refresh the device internal name | |
identify |
Ask the device to identify itself by doing a slight movement or blink or beep | |
keepOneWayControllersAndDeleteNode |
Delete 2way key from actuator and delete the device. All one way controllers remain linked to the actuator. | |
my |
Set the device to a user pre-defined position | |
off |
Turn off the device | |
on |
Turn on the device | |
onWithTimer |
INT [5..14400] | Turn the device on for a given amount of seconds then turn it off |
pairOneWayController |
STRING; INT [1..16] (optional) | Pair a one way controller to actuator. p1 : Payload of the QRCode associated to the one way controller p2 : channel (Optional - default : 1) |
readManufacturerData |
ARRAY | Read manufacturer data values from given names. Example: ["setting1","setting2"]. |
refreshMemorized1Position |
Refresh memorized 1 position state | |
removeLockLevel |
INT | Remove the command lock level on the device p1 : The lock level to remove |
resetLockLevels |
Remove all lock levels on the device | |
runManufacturerSettingsCommand |
STRING; OBJECT | Send a manufacturer configuration command. p1: The manufacturer configuration command to use p2: The arguments to send to this command |
sendIOKey |
Send the IO key to device. | |
setColorTemperature |
INT [2000..6500] | Set the perceived white temperature for this lamp (°K) |
setConfigState |
STRING: configuration, virgin, close, transmitting | Set the device in configuration state. p1: configuration mode. |
setIntensity |
INT [0..100] | Light intensity level (100%=maximum intensity, 0%=off) |
setIntensityWithTimer |
INT [0..100]; INT [5..14400]; INT [0..100] (optional) | Set the light intensity to p1% then after p2 seconds, set it to p3%. (If p3 is not specified the light is turned off after the delay) |
setMemorized1Position |
INT [0..100] | Set favorite position |
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 |
setPosition |
STRING: my, memorized1, secured; INT [0..100] | Set the device to a pre-defined position (enum) or a relative position (0-100%) |
setSecuredPosition |
INT [0..100] | Set the relative position value (0-100%) to be used for the 'secured' position alias |
startIdentify |
Ask the device to start winking immediately for an unlimited amount of time | |
stopIdentify |
Ask the device to stop winking immediately | |
unpairAllOneWayControllers |
Unpair all one way controllers from actuator. | |
unpairAllOneWayControllersAndDeleteNode |
Unpair all one way controllers from actuator. Delete 2way key from actuator and delete the device. | |
unpairOneWayController |
STRING; INT [1..16] (optional) | Unpair a one way controller from actuator. p1 : Payload of the QRCode associated to the one way controller p2 : channel (Optional - default : 1) |
wink |
INT [1..254] | Ask the device to identify itself by doing a slight movement or blink or beep for a given amount of seconds. |
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 |
|---|---|---|---|
AdditionalStatusState |
DataState | ||
ColorTemperatureState |
ContinuousState | ||
CommandLockLevelsState |
DataState | ||
DiscreteRSSILevelState |
DiscreteState | good, low, normal, verylow | |
LightIntensityState |
ContinuousState | [0..100] | |
ManufacturerDiagnosticsState |
DataState | ||
ManufacturerSettingsState |
DataState | ||
Memorized1PositionState |
ContinuousState | ||
NameState |
DataState | ||
OnOffState |
DiscreteState | on, off | |
PriorityLockLevelState |
DiscreteState | comfortLevel1, comfortLevel2, comfortLevel3, comfortLevel4, environmentProtection, humanProtection, userLevel1, userLevel2 | |
PriorityLockOriginatorState |
DiscreteState | LSC, SAAC, SFC, UPS, externalGateway, localUser, myself, rain, security, temperature, timer, user, wind | |
PriorityLockTimerState |
ContinuousState | ||
RSSILevelState |
ContinuousState | ||
SecuredPositionState |
ContinuousState | ||
StatusState |
DiscreteState | available, unavailable |
Light/StatefulOnOffLight (ACTUATOR) — 26 commands, 12 states
Type IDs: 408064, 408066, 2199023663618 | Servers: atlantic_cozytouch, hi_kumo_europe, rexel | Controllable: io:OnOffLightIOComponent | Profiles: StatefulSwitchableLight, StatefulSwitchable, Switchable
Data Properties
core:identifyInterval=500
Commands
| Command | Parameters | Notes |
|---|---|---|
addLockLevel |
INT; INT (optional) | Add a command lock level on the device p1 : The lock level to add p2 : (optional) Duration in second of the lock Level. By default there is no expiration. |
advancedRefresh |
STRING: normal, advanced, custom; ARRAY (optional) | Refresh extra states |
delayedStopIdentify |
INT [1..254] | (IO-homecontrol specific) Ask the device to stop winking after a given number of seconds |
executeManufacturerProcedure |
STRING; OBJECT; OBJECT (optional) | execute manufacturer procedure command. p1: the procedure name p2: the params associated Example: p1 = "dead_man_up" p2 = {"duration": 42} |
getName |
Refresh the device internal name | |
identify |
Ask the device to identify itself by doing a slight movement or blink or beep | |
keepOneWayControllersAndDeleteNode |
Delete 2way key from actuator and delete the device. All one way controllers remain linked to the actuator. | |
off |
Turn off the device | |
on |
Turn on the device | |
onWithTimer |
INT [5..14400] | Turn the device on for a given amount of seconds then turn it off |
pairOneWayController |
STRING; INT [1..16] (optional) | Pair a one way controller to actuator. p1 : Payload of the QRCode associated to the one way controller p2 : channel (Optional - default : 1) |
readManufacturerData |
ARRAY | Read manufacturer data values from given names. Example: ["setting1","setting2"]. |
removeLockLevel |
INT | Remove the command lock level on the device p1 : The lock level to remove |
resetLockLevels |
Remove all lock levels on the device | |
runManufacturerSettingsCommand |
STRING; OBJECT | Send a manufacturer configuration command. p1: The manufacturer configuration command to use p2: The arguments to send to this command |
sendIOKey |
Send the IO key to device. | |
setConfigState |
STRING: configuration, virgin, close, transmitting | Set the device in configuration state. p1: configuration 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 |
startIdentify |
Ask the device to start winking immediately for an unlimited amount of time | |
stopIdentify |
Ask the device to stop winking immediately | |
unpairAllOneWayControllers |
Unpair all one way controllers from actuator. | |
unpairAllOneWayControllersAndDeleteNode |
Unpair all one way controllers from actuator. Delete 2way key from actuator and delete the device. | |
unpairOneWayController |
STRING; INT [1..16] (optional) | Unpair a one way controller from actuator. p1 : Payload of the QRCode associated to the one way controller p2 : channel (Optional - default : 1) |
wink |
INT [1..254] | Ask the device to identify itself by doing a slight movement or blink or beep for a given amount of seconds. |
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 |
|---|---|---|---|
AdditionalStatusState |
DataState | ||
CommandLockLevelsState |
DataState | ||
DiscreteRSSILevelState |
DiscreteState | good, low, normal, verylow | |
ManufacturerDiagnosticsState |
DataState | ||
ManufacturerSettingsState |
DataState | ||
NameState |
DataState | ||
OnOffState |
DiscreteState | on, off | |
PriorityLockLevelState |
DiscreteState | comfortLevel1, comfortLevel2, comfortLevel3, comfortLevel4, environmentProtection, humanProtection, userLevel1, userLevel2 | |
PriorityLockOriginatorState |
DiscreteState | LSC, SAAC, SFC, UPS, externalGateway, localUser, myself, rain, security, temperature, timer, user, wind | |
PriorityLockTimerState |
ContinuousState | ||
RSSILevelState |
ContinuousState | ||
StatusState |
DiscreteState | available, unavailable |
Light/TimedOnOffLight (ACTUATOR) — 29 commands, 15 states
Type IDs: 983554 | Servers: atlantic_cozytouch, hi_kumo_europe, rexel | Controllable: io:LightMicroModuleSomfyIOComponent | Profiles: StatefulSwitchableLight, StatefulSwitchable, Switchable
Data Properties
core:identifyInterval=500
Commands
| Command | Parameters | Notes |
|---|---|---|
addLockLevel |
INT; INT (optional) | Add a command lock level on the device p1 : The lock level to add p2 : (optional) Duration in second of the lock Level. By default there is no expiration. |
advancedRefresh |
STRING: normal, advanced, custom; ARRAY (optional) | Refresh extra states |
delayedStopIdentify |
INT [1..254] | (IO-homecontrol specific) Ask the device to stop winking after a given number of seconds |
executeManufacturerProcedure |
STRING; OBJECT; OBJECT (optional) | execute manufacturer procedure command. p1: the procedure name p2: the params associated Example: p1 = "dead_man_up" p2 = {"duration": 42} |
getName |
Refresh the device internal name | |
identify |
Ask the device to identify itself by doing a slight movement or blink or beep | |
keepOneWayControllersAndDeleteNode |
Delete 2way key from actuator and delete the device. All one way controllers remain linked to the actuator. | |
off |
Turn off the device | |
on |
Turn on the device | |
onWithInternalTimer |
on using product internal timer | |
onWithTimer |
INT [5..14400] | Turn the device on for a given amount of seconds then turn it off |
pairOneWayController |
STRING; INT [1..16] (optional) | Pair a one way controller to actuator. p1 : Payload of the QRCode associated to the one way controller p2 : channel (Optional - default : 1) |
readManufacturerData |
ARRAY | Read manufacturer data values from given names. Example: ["setting1","setting2"]. |
removeLockLevel |
INT | Remove the command lock level on the device p1 : The lock level to remove |
resetLockLevels |
Remove all lock levels on the device | |
runManufacturerSettingsCommand |
STRING; OBJECT | Send a manufacturer configuration command. p1: The manufacturer configuration command to use p2: The arguments to send to this command |
sendIOKey |
Send the IO key to device. | |
setConfigState |
STRING: configuration, virgin, close, transmitting | Set the device in configuration state. p1: configuration mode. |
setInternalTimer |
INT [0..65535] | set component internal timer |
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 |
setPictoValue |
STRING: onOffLight, onOffSwitch | set the picto value state |
startIdentify |
Ask the device to start winking immediately for an unlimited amount of time | |
stopIdentify |
Ask the device to stop winking immediately | |
unpairAllOneWayControllers |
Unpair all one way controllers from actuator. | |
unpairAllOneWayControllersAndDeleteNode |
Unpair all one way controllers from actuator. Delete 2way key from actuator and delete the device. | |
unpairOneWayController |
STRING; INT [1..16] (optional) | Unpair a one way controller from actuator. p1 : Payload of the QRCode associated to the one way controller p2 : channel (Optional - default : 1) |
wink |
INT [1..254] | Ask the device to identify itself by doing a slight movement or blink or beep for a given amount of seconds. |
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 |
|---|---|---|---|
AdditionalStatusState |
DataState | ||
CommandLockLevelsState |
DataState | ||
DiscreteRSSILevelState |
DiscreteState | good, low, normal, verylow | |
ManufacturerDiagnosticsState |
DataState | ||
ManufacturerSettingsState |
DataState | ||
NameState |
DataState | ||
OnOffState |
DiscreteState | on, off | |
PairedMicroModuleWithLowBatteryState |
DataState | ||
PictoState |
DiscreteState | onOffLight | |
PriorityLockLevelState |
DiscreteState | comfortLevel1, comfortLevel2, comfortLevel3, comfortLevel4, environmentProtection, humanProtection, userLevel1, userLevel2 | |
PriorityLockOriginatorState |
DiscreteState | LSC, SAAC, SFC, UPS, externalGateway, localUser, myself, rain, security, temperature, timer, user, wind | |
PriorityLockTimerState |
ContinuousState | ||
RSSILevelState |
ContinuousState | ||
StatusState |
DiscreteState | available, unavailable | |
TimerState |
ContinuousState |
Light/DimmerLight (ACTUATOR) — 35 commands, 14 states
Type IDs: 2199023648770 | Servers: atlantic_cozytouch, hi_kumo_europe, rexel | Controllable: io:DimmableLightMicroModuleSomfyIOComponent | Profiles: StatefulLightDimmer, StatefulDimmable, Dimmable, StatefulSwitchable, Switchable
Data Properties
core:identifyInterval=500
Commands
| Command | Parameters | Notes |
|---|---|---|
addLockLevel |
INT; INT (optional) | Add a command lock level on the device p1 : The lock level to add p2 : (optional) Duration in second of the lock Level. By default there is no expiration. |
advancedRefresh |
STRING: normal, advanced, custom; ARRAY (optional) | Refresh extra states |
decreaseIntensityForBoundConfiguration |
INT [25..3175] (optional) | Decrease the intensity to configure the bounds. p1: Duration of intensity change, time in millisecond. |
delayedStopIdentify |
INT [1..254] | (IO-homecontrol specific) Ask the device to stop winking after a given number of seconds |
executeManufacturerProcedure |
STRING; OBJECT; OBJECT (optional) | execute manufacturer procedure command. p1: the procedure name p2: the params associated Example: p1 = "dead_man_up" p2 = {"duration": 42} |
getName |
Refresh the device internal name | |
identify |
Ask the device to identify itself by doing a slight movement or blink or beep | |
increaseIntensityForBoundConfiguration |
INT [25..3200] (optional) | Increase the intensity to configure the bounds. p1: Duration of intensity change, time in millisecond. |
keepOneWayControllersAndDeleteNode |
Delete 2way key from actuator and delete the device. All one way controllers remain linked to the actuator. | |
my |
Set the device to a user pre-defined position | |
off |
Turn off the device | |
on |
Turn on the device | |
onWithTimer |
INT [5..14400] | Turn the device on for a given amount of seconds then turn it off |
pairOneWayController |
STRING; INT [1..16] (optional) | Pair a one way controller to actuator. p1 : Payload of the QRCode associated to the one way controller p2 : channel (Optional - default : 1) |
readManufacturerData |
ARRAY | Read manufacturer data values from given names. Example: ["setting1","setting2"]. |
refreshMemorized1Position |
Refresh memorized 1 position state | |
removeLockLevel |
INT | Remove the command lock level on the device p1 : The lock level to remove |
resetLockLevels |
Remove all lock levels on the device | |
runManufacturerSettingsCommand |
STRING; OBJECT | Send a manufacturer configuration command. p1: The manufacturer configuration command to use p2: The arguments to send to this command |
saveBound |
STRING: lower, upper | Save a bound value with the current position value. p1 : the type of the bound saved. |
sendIOKey |
Send the IO key to device. | |
setConfigState |
STRING: configuration, virgin, close, transmitting | Set the device in configuration state. p1: configuration mode. |
setIntensity |
INT [0..100] | Light intensity level (100%=maximum intensity, 0%=off) |
setIntensityWithTimer |
INT [0..100]; INT [5..14400]; INT [0..100] (optional) | Set the light intensity to p1% then after p2 seconds, set it to p3%. (If p3 is not specified the light is turned off after the delay) |
setMemorized1Position |
INT [0..100] | Set favorite position |
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 |
setPosition |
STRING: my, memorized1, secured; INT [0..100] | Set the device to a pre-defined position (enum) or a relative position (0-100%) |
startIdentify |
Ask the device to start winking immediately for an unlimited amount of time | |
stopIdentify |
Ask the device to stop winking immediately | |
unpairAllOneWayControllers |
Unpair all one way controllers from actuator. | |
unpairAllOneWayControllersAndDeleteNode |
Unpair all one way controllers from actuator. Delete 2way key from actuator and delete the device. | |
unpairOneWayController |
STRING; INT [1..16] (optional) | Unpair a one way controller from actuator. p1 : Payload of the QRCode associated to the one way controller p2 : channel (Optional - default : 1) |
wink |
INT [1..254] | Ask the device to identify itself by doing a slight movement or blink or beep for a given amount of seconds. |
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 |
|---|---|---|---|
AdditionalStatusState |
DataState | ||
CommandLockLevelsState |
DataState | ||
DiscreteRSSILevelState |
DiscreteState | good, low, normal, verylow | |
LightIntensityState |
ContinuousState | [0..100] | |
ManufacturerDiagnosticsState |
DataState | ||
ManufacturerSettingsState |
DataState | ||
Memorized1PositionState |
ContinuousState | ||
NameState |
DataState | ||
OnOffState |
DiscreteState | on, off | |
PriorityLockLevelState |
DiscreteState | comfortLevel1, comfortLevel2, comfortLevel3, comfortLevel4, environmentProtection, humanProtection, userLevel1, userLevel2 | |
PriorityLockOriginatorState |
DiscreteState | LSC, SAAC, SFC, UPS, externalGateway, localUser, myself, rain, security, temperature, timer, user, wind | |
PriorityLockTimerState |
ContinuousState | ||
RSSILevelState |
ContinuousState | ||
StatusState |
DiscreteState | available, unavailable |
Light/DimmerLight (ACTUATOR) — 32 commands, 13 states
Type IDs: 393216, 393218 | Servers: somfy_europe | Controllable: io:DimmableLightIOComponent | Profiles: StatefulLightDimmer, StatefulDimmable, Dimmable, StatefulSwitchable, Switchable
Data Properties
core:identifyInterval=500
Commands
| Command | Parameters | Notes |
|---|---|---|
addLockLevel |
INT; INT (optional) | Add a command lock level on the device p1 : The lock level to add p2 : (optional) Duration in second of the lock Level. By default there is no expiration. |
advancedRefresh |
STRING: normal, advanced, custom; ARRAY (optional) | Refresh extra states |
delayedStopIdentify |
INT [1..254] | (IO-homecontrol specific) Ask the device to stop winking after a given number of seconds |
executeManufacturerProcedure |
STRING; OBJECT; OBJECT (optional) | execute manufacturer procedure command. p1: the procedure name p2: the params associated Example: p1 = "dead_man_up" p2 = {"duration": 42} |
getName |
Refresh the device internal name | |
identify |
Ask the device to identify itself by doing a slight movement or blink or beep | |
keepOneWayControllersAndDeleteNode |
Delete 2way key from actuator and delete the device. All one way controllers remain linked to the actuator. | |
my |
Set the device to a user pre-defined position | |
off |
Turn off the device | |
on |
Turn on the device | |
onWithTimer |
INT [5..14400] | Turn the device on for a given amount of seconds then turn it off |
pairOneWayController |
STRING; INT [1..16] (optional) | Pair a one way controller to actuator. p1 : Payload of the QRCode associated to the one way controller p2 : channel (Optional - default : 1) |
readManufacturerData |
ARRAY | Read manufacturer data values from given names. Example: ["setting1","setting2"]. |
refreshMemorized1Position |
Refresh memorized 1 position state | |
removeLockLevel |
INT | Remove the command lock level on the device p1 : The lock level to remove |
resetLockLevels |
Remove all lock levels on the device | |
sendIOKey |
Send the IO key to device. | |
setConfigState |
STRING: configuration, virgin, close, transmitting | Set the device in configuration state. p1: configuration mode. |
setIntensity |
INT [0..100] | Light intensity level (100%=maximum intensity, 0%=off) |
setIntensityWithTimer |
INT [0..100]; INT [5..14400]; INT [0..100] (optional) | Set the light intensity to p1% then after p2 seconds, set it to p3%. (If p3 is not specified the light is turned off after the delay) |
setMemorized1Position |
INT [0..100] | Set favorite position |
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 |
setPosition |
STRING: my, memorized1, secured; INT [0..100] | Set the device to a pre-defined position (enum) or a relative position (0-100%) |
setSecuredPosition |
INT [0..100] | Set the relative position value (0-100%) to be used for the 'secured' position alias |
startIdentify |
Ask the device to start winking immediately for an unlimited amount of time | |
stopIdentify |
Ask the device to stop winking immediately | |
unpairAllOneWayControllers |
Unpair all one way controllers from actuator. | |
unpairAllOneWayControllersAndDeleteNode |
Unpair all one way controllers from actuator. Delete 2way key from actuator and delete the device. | |
unpairOneWayController |
STRING; INT [1..16] (optional) | Unpair a one way controller from actuator. p1 : Payload of the QRCode associated to the one way controller p2 : channel (Optional - default : 1) |
wink |
INT [1..254] | Ask the device to identify itself by doing a slight movement or blink or beep for a given amount of seconds. |
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 |
|---|---|---|---|
AdditionalStatusState |
DataState | ||
CommandLockLevelsState |
DataState | ||
DiscreteRSSILevelState |
DiscreteState | good, low, normal, verylow | |
LightIntensityState |
ContinuousState | [0..100] | |
Memorized1PositionState |
ContinuousState | ||
NameState |
DataState | ||
OnOffState |
DiscreteState | on, off | |
PriorityLockLevelState |
DiscreteState | comfortLevel1, comfortLevel2, comfortLevel3, comfortLevel4, environmentProtection, humanProtection, userLevel1, userLevel2 | |
PriorityLockOriginatorState |
DiscreteState | LSC, SAAC, SFC, UPS, externalGateway, localUser, myself, rain, security, temperature, timer, user, wind | |
PriorityLockTimerState |
ContinuousState | ||
RSSILevelState |
ContinuousState | ||
SecuredPositionState |
ContinuousState | ||
StatusState |
DiscreteState | available, unavailable |
Light/DimmerRGBColouredLight (ACTUATOR) — 34 commands, 16 states
Type IDs: 393472, 393474 | Servers: somfy_europe | Controllable: io:DimmableRGBLightIOComponent | Profiles: StatefulLightDimmer, StatefulDimmable, Dimmable, StatefulSwitchable, Switchable
Data Properties
core:identifyInterval=500
Commands
| Command | Parameters | Notes |
|---|---|---|
addLockLevel |
INT; INT (optional) | Add a command lock level on the device p1 : The lock level to add p2 : (optional) Duration in second of the lock Level. By default there is no expiration. |
advancedRefresh |
STRING: normal, advanced, custom; ARRAY (optional) | Refresh extra states |
delayedStopIdentify |
INT [1..254] | (IO-homecontrol specific) Ask the device to stop winking after a given number of seconds |
executeManufacturerProcedure |
STRING; OBJECT; OBJECT (optional) | execute manufacturer procedure command. p1: the procedure name p2: the params associated Example: p1 = "dead_man_up" p2 = {"duration": 42} |
getName |
Refresh the device internal name | |
identify |
Ask the device to identify itself by doing a slight movement or blink or beep | |
keepOneWayControllersAndDeleteNode |
Delete 2way key from actuator and delete the device. All one way controllers remain linked to the actuator. | |
my |
Set the device to a user pre-defined position | |
off |
Turn off the device | |
on |
Turn on the device | |
onWithTimer |
INT [5..14400] | Turn the device on for a given amount of seconds then turn it off |
pairOneWayController |
STRING; INT [1..16] (optional) | Pair a one way controller to actuator. p1 : Payload of the QRCode associated to the one way controller p2 : channel (Optional - default : 1) |
readManufacturerData |
ARRAY | Read manufacturer data values from given names. Example: ["setting1","setting2"]. |
refreshMemorized1Position |
Refresh memorized 1 position state | |
removeLockLevel |
INT | Remove the command lock level on the device p1 : The lock level to remove |
resetLockLevels |
Remove all lock levels on the device | |
sendIOKey |
Send the IO key to device. | |
setConfigState |
STRING: configuration, virgin, close, transmitting | Set the device in configuration state. p1: configuration mode. |
setIntensity |
INT [0..100] | Light intensity level (100%=maximum intensity, 0%=off) |
setIntensityWithTimer |
INT [0..100]; INT [5..14400]; INT [0..100] (optional) | Set the light intensity to p1% then after p2 seconds, set it to p3%. (If p3 is not specified the light is turned off after the delay) |
setMemorized1Position |
INT [0..100] | Set favorite position |
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 |
setPosition |
STRING: my, memorized1, secured; INT [0..100] | Set the device to a pre-defined position (enum) or a relative position (0-100%) |
setRGB |
INT [0..255]; INT [0..255]; INT [0..255] | Set the Red,Green,Blue components of the lamp color |
setRGBWithTimer |
INT [0..255]; INT [0..255]; INT [0..255]; INT [5..14400] | Set the Red,Green,Blue components of the lamp color |
setSecuredPosition |
INT [0..100] | Set the relative position value (0-100%) to be used for the 'secured' position alias |
startIdentify |
Ask the device to start winking immediately for an unlimited amount of time | |
stopIdentify |
Ask the device to stop winking immediately | |
unpairAllOneWayControllers |
Unpair all one way controllers from actuator. | |
unpairAllOneWayControllersAndDeleteNode |
Unpair all one way controllers from actuator. Delete 2way key from actuator and delete the device. | |
unpairOneWayController |
STRING; INT [1..16] (optional) | Unpair a one way controller from actuator. p1 : Payload of the QRCode associated to the one way controller p2 : channel (Optional - default : 1) |
wink |
INT [1..254] | Ask the device to identify itself by doing a slight movement or blink or beep for a given amount of seconds. |
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 |
|---|---|---|---|
AdditionalStatusState |
DataState | ||
BlueColorIntensityState |
ContinuousState | ||
CommandLockLevelsState |
DataState | ||
DiscreteRSSILevelState |
DiscreteState | good, low, normal, verylow | |
GreenColorIntensityState |
ContinuousState | ||
LightIntensityState |
ContinuousState | [0..100] | |
Memorized1PositionState |
ContinuousState | ||
NameState |
DataState | ||
OnOffState |
DiscreteState | on, off | |
PriorityLockLevelState |
DiscreteState | comfortLevel1, comfortLevel2, comfortLevel3, comfortLevel4, environmentProtection, humanProtection, userLevel1, userLevel2 | |
PriorityLockOriginatorState |
DiscreteState | LSC, SAAC, SFC, UPS, externalGateway, localUser, myself, rain, security, temperature, timer, user, wind | |
PriorityLockTimerState |
ContinuousState | ||
RSSILevelState |
ContinuousState | ||
RedColorIntensityState |
ContinuousState | ||
SecuredPositionState |
ContinuousState | ||
StatusState |
DiscreteState | available, unavailable |
Light/DimmerColorTemperatureLight (ACTUATOR) — 33 commands, 14 states
Type IDs: 393730 | Servers: somfy_europe | Controllable: io:DimmableColorTemperatureLightIOComponent | Profiles: StatefulLightDimmer, StatefulDimmable, Dimmable, StatefulSwitchable, Switchable
Data Properties
core:identifyInterval=500
Commands
| Command | Parameters | Notes |
|---|---|---|
addLockLevel |
INT; INT (optional) | Add a command lock level on the device p1 : The lock level to add p2 : (optional) Duration in second of the lock Level. By default there is no expiration. |
advancedRefresh |
STRING: normal, advanced, custom; ARRAY (optional) | Refresh extra states |
delayedStopIdentify |
INT [1..254] | (IO-homecontrol specific) Ask the device to stop winking after a given number of seconds |
executeManufacturerProcedure |
STRING; OBJECT; OBJECT (optional) | execute manufacturer procedure command. p1: the procedure name p2: the params associated Example: p1 = "dead_man_up" p2 = {"duration": 42} |
getName |
Refresh the device internal name | |
identify |
Ask the device to identify itself by doing a slight movement or blink or beep | |
keepOneWayControllersAndDeleteNode |
Delete 2way key from actuator and delete the device. All one way controllers remain linked to the actuator. | |
my |
Set the device to a user pre-defined position | |
off |
Turn off the device | |
on |
Turn on the device | |
onWithTimer |
INT [5..14400] | Turn the device on for a given amount of seconds then turn it off |
pairOneWayController |
STRING; INT [1..16] (optional) | Pair a one way controller to actuator. p1 : Payload of the QRCode associated to the one way controller p2 : channel (Optional - default : 1) |
readManufacturerData |
ARRAY | Read manufacturer data values from given names. Example: ["setting1","setting2"]. |
refreshMemorized1Position |
Refresh memorized 1 position state | |
removeLockLevel |
INT | Remove the command lock level on the device p1 : The lock level to remove |
resetLockLevels |
Remove all lock levels on the device | |
sendIOKey |
Send the IO key to device. | |
setColorTemperature |
INT [2000..6500] | Set the perceived white temperature for this lamp (°K) |
setConfigState |
STRING: configuration, virgin, close, transmitting | Set the device in configuration state. p1: configuration mode. |
setIntensity |
INT [0..100] | Light intensity level (100%=maximum intensity, 0%=off) |
setIntensityWithTimer |
INT [0..100]; INT [5..14400]; INT [0..100] (optional) | Set the light intensity to p1% then after p2 seconds, set it to p3%. (If p3 is not specified the light is turned off after the delay) |
setMemorized1Position |
INT [0..100] | Set favorite position |
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 |
setPosition |
STRING: my, memorized1, secured; INT [0..100] | Set the device to a pre-defined position (enum) or a relative position (0-100%) |
setSecuredPosition |
INT [0..100] | Set the relative position value (0-100%) to be used for the 'secured' position alias |
startIdentify |
Ask the device to start winking immediately for an unlimited amount of time | |
stopIdentify |
Ask the device to stop winking immediately | |
unpairAllOneWayControllers |
Unpair all one way controllers from actuator. | |
unpairAllOneWayControllersAndDeleteNode |
Unpair all one way controllers from actuator. Delete 2way key from actuator and delete the device. | |
unpairOneWayController |
STRING; INT [1..16] (optional) | Unpair a one way controller from actuator. p1 : Payload of the QRCode associated to the one way controller p2 : channel (Optional - default : 1) |
wink |
INT [1..254] | Ask the device to identify itself by doing a slight movement or blink or beep for a given amount of seconds. |
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 |
|---|---|---|---|
AdditionalStatusState |
DataState | ||
ColorTemperatureState |
ContinuousState | ||
CommandLockLevelsState |
DataState | ||
DiscreteRSSILevelState |
DiscreteState | good, low, normal, verylow | |
LightIntensityState |
ContinuousState | [0..100] | |
Memorized1PositionState |
ContinuousState | ||
NameState |
DataState | ||
OnOffState |
DiscreteState | on, off | |
PriorityLockLevelState |
DiscreteState | comfortLevel1, comfortLevel2, comfortLevel3, comfortLevel4, environmentProtection, humanProtection, userLevel1, userLevel2 | |
PriorityLockOriginatorState |
DiscreteState | LSC, SAAC, SFC, UPS, externalGateway, localUser, myself, rain, security, temperature, timer, user, wind | |
PriorityLockTimerState |
ContinuousState | ||
RSSILevelState |
ContinuousState | ||
SecuredPositionState |
ContinuousState | ||
StatusState |
DiscreteState | available, unavailable |
Light/StatefulOnOffLight (ACTUATOR) — 25 commands, 10 states
Type IDs: 408064, 408066, 2199023663618 | Servers: somfy_europe | Controllable: io:OnOffLightIOComponent | Profiles: StatefulSwitchableLight, StatefulSwitchable, Switchable
Data Properties
core:identifyInterval=500
Commands
| Command | Parameters | Notes |
|---|---|---|
addLockLevel |
INT; INT (optional) | Add a command lock level on the device p1 : The lock level to add p2 : (optional) Duration in second of the lock Level. By default there is no expiration. |
advancedRefresh |
STRING: normal, advanced, custom; ARRAY (optional) | Refresh extra states |
delayedStopIdentify |
INT [1..254] | (IO-homecontrol specific) Ask the device to stop winking after a given number of seconds |
executeManufacturerProcedure |
STRING; OBJECT; OBJECT (optional) | execute manufacturer procedure command. p1: the procedure name p2: the params associated Example: p1 = "dead_man_up" p2 = {"duration": 42} |
getName |
Refresh the device internal name | |
identify |
Ask the device to identify itself by doing a slight movement or blink or beep | |
keepOneWayControllersAndDeleteNode |
Delete 2way key from actuator and delete the device. All one way controllers remain linked to the actuator. | |
off |
Turn off the device | |
on |
Turn on the device | |
onWithTimer |
INT [5..14400] | Turn the device on for a given amount of seconds then turn it off |
pairOneWayController |
STRING; INT [1..16] (optional) | Pair a one way controller to actuator. p1 : Payload of the QRCode associated to the one way controller p2 : channel (Optional - default : 1) |
readManufacturerData |
ARRAY | Read manufacturer data values from given names. Example: ["setting1","setting2"]. |
removeLockLevel |
INT | Remove the command lock level on the device p1 : The lock level to remove |
resetLockLevels |
Remove all lock levels on the device | |
sendIOKey |
Send the IO key to device. | |
setConfigState |
STRING: configuration, virgin, close, transmitting | Set the device in configuration state. p1: configuration 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 |
startIdentify |
Ask the device to start winking immediately for an unlimited amount of time | |
stopIdentify |
Ask the device to stop winking immediately | |
unpairAllOneWayControllers |
Unpair all one way controllers from actuator. | |
unpairAllOneWayControllersAndDeleteNode |
Unpair all one way controllers from actuator. Delete 2way key from actuator and delete the device. | |
unpairOneWayController |
STRING; INT [1..16] (optional) | Unpair a one way controller from actuator. p1 : Payload of the QRCode associated to the one way controller p2 : channel (Optional - default : 1) |
wink |
INT [1..254] | Ask the device to identify itself by doing a slight movement or blink or beep for a given amount of seconds. |
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 |
|---|---|---|---|
AdditionalStatusState |
DataState | ||
CommandLockLevelsState |
DataState | ||
DiscreteRSSILevelState |
DiscreteState | good, low, normal, verylow | |
NameState |
DataState | ||
OnOffState |
DiscreteState | on, off | |
PriorityLockLevelState |
DiscreteState | comfortLevel1, comfortLevel2, comfortLevel3, comfortLevel4, environmentProtection, humanProtection, userLevel1, userLevel2 | |
PriorityLockOriginatorState |
DiscreteState | LSC, SAAC, SFC, UPS, externalGateway, localUser, myself, rain, security, temperature, timer, user, wind | |
PriorityLockTimerState |
ContinuousState | ||
RSSILevelState |
ContinuousState | ||
StatusState |
DiscreteState | available, unavailable |
Light/TimedOnOffLight (ACTUATOR) — 28 commands, 13 states
Type IDs: 983554 | Servers: somfy_europe | Controllable: io:LightMicroModuleSomfyIOComponent | Profiles: StatefulSwitchableLight, StatefulSwitchable, Switchable
Data Properties
core:identifyInterval=500
Commands
| Command | Parameters | Notes |
|---|---|---|
addLockLevel |
INT; INT (optional) | Add a command lock level on the device p1 : The lock level to add p2 : (optional) Duration in second of the lock Level. By default there is no expiration. |
advancedRefresh |
STRING: normal, advanced, custom; ARRAY (optional) | Refresh extra states |
delayedStopIdentify |
INT [1..254] | (IO-homecontrol specific) Ask the device to stop winking after a given number of seconds |
executeManufacturerProcedure |
STRING; OBJECT; OBJECT (optional) | execute manufacturer procedure command. p1: the procedure name p2: the params associated Example: p1 = "dead_man_up" p2 = {"duration": 42} |
getName |
Refresh the device internal name | |
identify |
Ask the device to identify itself by doing a slight movement or blink or beep | |
keepOneWayControllersAndDeleteNode |
Delete 2way key from actuator and delete the device. All one way controllers remain linked to the actuator. | |
off |
Turn off the device | |
on |
Turn on the device | |
onWithInternalTimer |
on using product internal timer | |
onWithTimer |
INT [5..14400] | Turn the device on for a given amount of seconds then turn it off |
pairOneWayController |
STRING; INT [1..16] (optional) | Pair a one way controller to actuator. p1 : Payload of the QRCode associated to the one way controller p2 : channel (Optional - default : 1) |
readManufacturerData |
ARRAY | Read manufacturer data values from given names. Example: ["setting1","setting2"]. |
removeLockLevel |
INT | Remove the command lock level on the device p1 : The lock level to remove |
resetLockLevels |
Remove all lock levels on the device | |
sendIOKey |
Send the IO key to device. | |
setConfigState |
STRING: configuration, virgin, close, transmitting | Set the device in configuration state. p1: configuration mode. |
setInternalTimer |
INT [0..65535] | set component internal timer |
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 |
setPictoValue |
STRING: onOffLight, onOffSwitch | set the picto value state |
startIdentify |
Ask the device to start winking immediately for an unlimited amount of time | |
stopIdentify |
Ask the device to stop winking immediately | |
unpairAllOneWayControllers |
Unpair all one way controllers from actuator. | |
unpairAllOneWayControllersAndDeleteNode |
Unpair all one way controllers from actuator. Delete 2way key from actuator and delete the device. | |
unpairOneWayController |
STRING; INT [1..16] (optional) | Unpair a one way controller from actuator. p1 : Payload of the QRCode associated to the one way controller p2 : channel (Optional - default : 1) |
wink |
INT [1..254] | Ask the device to identify itself by doing a slight movement or blink or beep for a given amount of seconds. |
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 |
|---|---|---|---|
AdditionalStatusState |
DataState | ||
CommandLockLevelsState |
DataState | ||
DiscreteRSSILevelState |
DiscreteState | good, low, normal, verylow | |
NameState |
DataState | ||
OnOffState |
DiscreteState | on, off | |
PairedMicroModuleWithLowBatteryState |
DataState | ||
PictoState |
DiscreteState | onOffLight | |
PriorityLockLevelState |
DiscreteState | comfortLevel1, comfortLevel2, comfortLevel3, comfortLevel4, environmentProtection, humanProtection, userLevel1, userLevel2 | |
PriorityLockOriginatorState |
DiscreteState | LSC, SAAC, SFC, UPS, externalGateway, localUser, myself, rain, security, temperature, timer, user, wind | |
PriorityLockTimerState |
ContinuousState | ||
RSSILevelState |
ContinuousState | ||
StatusState |
DiscreteState | available, unavailable | |
TimerState |
ContinuousState |
Light/DimmerLight (ACTUATOR) — 34 commands, 12 states
Type IDs: 2199023648770 | Servers: somfy_europe | Controllable: io:DimmableLightMicroModuleSomfyIOComponent | Profiles: StatefulLightDimmer, StatefulDimmable, Dimmable, StatefulSwitchable, Switchable
Data Properties
core:identifyInterval=500
Commands
| Command | Parameters | Notes |
|---|---|---|
addLockLevel |
INT; INT (optional) | Add a command lock level on the device p1 : The lock level to add p2 : (optional) Duration in second of the lock Level. By default there is no expiration. |
advancedRefresh |
STRING: normal, advanced, custom; ARRAY (optional) | Refresh extra states |
decreaseIntensityForBoundConfiguration |
INT [25..3175] (optional) | Decrease the intensity to configure the bounds. p1: Duration of intensity change, time in millisecond. |
delayedStopIdentify |
INT [1..254] | (IO-homecontrol specific) Ask the device to stop winking after a given number of seconds |
executeManufacturerProcedure |
STRING; OBJECT; OBJECT (optional) | execute manufacturer procedure command. p1: the procedure name p2: the params associated Example: p1 = "dead_man_up" p2 = {"duration": 42} |
getName |
Refresh the device internal name | |
identify |
Ask the device to identify itself by doing a slight movement or blink or beep | |
increaseIntensityForBoundConfiguration |
INT [25..3200] (optional) | Increase the intensity to configure the bounds. p1: Duration of intensity change, time in millisecond. |
keepOneWayControllersAndDeleteNode |
Delete 2way key from actuator and delete the device. All one way controllers remain linked to the actuator. | |
my |
Set the device to a user pre-defined position | |
off |
Turn off the device | |
on |
Turn on the device | |
onWithTimer |
INT [5..14400] | Turn the device on for a given amount of seconds then turn it off |
pairOneWayController |
STRING; INT [1..16] (optional) | Pair a one way controller to actuator. p1 : Payload of the QRCode associated to the one way controller p2 : channel (Optional - default : 1) |
readManufacturerData |
ARRAY | Read manufacturer data values from given names. Example: ["setting1","setting2"]. |
refreshMemorized1Position |
Refresh memorized 1 position state | |
removeLockLevel |
INT | Remove the command lock level on the device p1 : The lock level to remove |
resetLockLevels |
Remove all lock levels on the device | |
saveBound |
STRING: lower, upper | Save a bound value with the current position value. p1 : the type of the bound saved. |
sendIOKey |
Send the IO key to device. | |
setConfigState |
STRING: configuration, virgin, close, transmitting | Set the device in configuration state. p1: configuration mode. |
setIntensity |
INT [0..100] | Light intensity level (100%=maximum intensity, 0%=off) |
setIntensityWithTimer |
INT [0..100]; INT [5..14400]; INT [0..100] (optional) | Set the light intensity to p1% then after p2 seconds, set it to p3%. (If p3 is not specified the light is turned off after the delay) |
setMemorized1Position |
INT [0..100] | Set favorite position |
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 |
setPosition |
STRING: my, memorized1, secured; INT [0..100] | Set the device to a pre-defined position (enum) or a relative position (0-100%) |
startIdentify |
Ask the device to start winking immediately for an unlimited amount of time | |
stopIdentify |
Ask the device to stop winking immediately | |
unpairAllOneWayControllers |
Unpair all one way controllers from actuator. | |
unpairAllOneWayControllersAndDeleteNode |
Unpair all one way controllers from actuator. Delete 2way key from actuator and delete the device. | |
unpairOneWayController |
STRING; INT [1..16] (optional) | Unpair a one way controller from actuator. p1 : Payload of the QRCode associated to the one way controller p2 : channel (Optional - default : 1) |
wink |
INT [1..254] | Ask the device to identify itself by doing a slight movement or blink or beep for a given amount of seconds. |
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 |
|---|---|---|---|
AdditionalStatusState |
DataState | ||
CommandLockLevelsState |
DataState | ||
DiscreteRSSILevelState |
DiscreteState | good, low, normal, verylow | |
LightIntensityState |
ContinuousState | [0..100] | |
Memorized1PositionState |
ContinuousState | ||
NameState |
DataState | ||
OnOffState |
DiscreteState | on, off | |
PriorityLockLevelState |
DiscreteState | comfortLevel1, comfortLevel2, comfortLevel3, comfortLevel4, environmentProtection, humanProtection, userLevel1, userLevel2 | |
PriorityLockOriginatorState |
DiscreteState | LSC, SAAC, SFC, UPS, externalGateway, localUser, myself, rain, security, temperature, timer, user, wind | |
PriorityLockTimerState |
ContinuousState | ||
RSSILevelState |
ContinuousState | ||
StatusState |
DiscreteState | available, unavailable |
OnOff/StatefulOnOff (ACTUATOR) — 20 commands, 9 states
Type IDs: 983040 | Servers: atlantic_cozytouch, hi_kumo_europe, rexel, somfy_europe | Controllable: io:OnOffIOComponent | Profiles: StatefulSwitchablePlug, StatefulSwitchable, Switchable
Data Properties
core:identifyInterval=500
Commands
| Command | Parameters | Notes |
|---|---|---|
addLockLevel |
INT; INT (optional) | Add a command lock level on the device p1 : The lock level to add p2 : (optional) Duration in second of the lock Level. By default there is no expiration. |
advancedRefresh |
STRING: normal, advanced, custom; ARRAY (optional) | Refresh extra states |
delayedStopIdentify |
INT [1..254] | (IO-homecontrol specific) Ask the device to stop winking after a given number of seconds |
getName |
Refresh the device internal name | |
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 | |
onWithTimer |
INT [5..14400] | Turn the device on for a given amount of seconds then turn it off |
pairOneWayController |
STRING; INT [1..16] (optional) | Pair a one way controller to actuator. p1 : Payload of the QRCode associated to the one way controller p2 : channel (Optional - default : 1) |
removeLockLevel |
INT | Remove the command lock level on the device p1 : The lock level to remove |
resetLockLevels |
Remove all lock levels on the device | |
setConfigState |
STRING: configuration, virgin, close, transmitting | Set the device in configuration state. p1: configuration 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 |
startIdentify |
Ask the device to start winking immediately for an unlimited amount of time | |
stopIdentify |
Ask the device to stop winking immediately | |
toggle |
Toggle on/off status | |
unpairAllOneWayControllers |
Unpair all one way controllers from actuator. | |
unpairOneWayController |
STRING; INT [1..16] (optional) | Unpair a one way controller from actuator. p1 : Payload of the QRCode associated to the one way controller p2 : channel (Optional - default : 1) |
wink |
INT [1..254] | Ask the device to identify itself by doing a slight movement or blink or beep for a given amount of seconds. |
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
CommandLockLevelsState |
DataState | ||
DiscreteRSSILevelState |
DiscreteState | good, low, normal, verylow | |
NameState |
DataState | ||
OnOffState |
DiscreteState | on, off | |
PriorityLockLevelState |
DiscreteState | comfortLevel1, comfortLevel2, comfortLevel3, comfortLevel4, environmentProtection, humanProtection, userLevel1, userLevel2 | |
PriorityLockOriginatorState |
DiscreteState | LSC, SAAC, SFC, UPS, externalGateway, localUser, myself, rain, security, temperature, timer, user, wind | |
PriorityLockTimerState |
ContinuousState | ||
RSSILevelState |
ContinuousState | ||
StatusState |
DiscreteState | available, unavailable |
OnOff/TimedOnOff (ACTUATOR) — 20 commands, 9 states
Type IDs: 983552 | Servers: atlantic_cozytouch, hi_kumo_europe, rexel, somfy_europe | Controllable: io:SwitchMicroModuleIOComponent | Profiles: StatefulSwitchableLight, StatefulSwitchable, Switchable
Data Properties
core:identifyInterval=500
Commands
| Command | Parameters | Notes |
|---|---|---|
addLockLevel |
INT; INT (optional) | Add a command lock level on the device p1 : The lock level to add p2 : (optional) Duration in second of the lock Level. By default there is no expiration. |
advancedRefresh |
STRING: normal, advanced, custom; ARRAY (optional) | Refresh extra states |
delayedStopIdentify |
INT [1..254] | (IO-homecontrol specific) Ask the device to stop winking after a given number of seconds |
getName |
Refresh the device internal name | |
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 | |
onWithInternalTimer |
on using product internal timer | |
onWithTimer |
INT [5..14400] | Turn the device on for a given amount of seconds then turn it off |
pairOneWayController |
STRING; INT [1..16] (optional) | Pair a one way controller to actuator. p1 : Payload of the QRCode associated to the one way controller p2 : channel (Optional - default : 1) |
removeLockLevel |
INT | Remove the command lock level on the device p1 : The lock level to remove |
resetLockLevels |
Remove all lock levels on the device | |
setConfigState |
STRING: configuration, virgin, close, transmitting | Set the device in configuration state. p1: configuration 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 |
startIdentify |
Ask the device to start winking immediately for an unlimited amount of time | |
stopIdentify |
Ask the device to stop winking immediately | |
unpairAllOneWayControllers |
Unpair all one way controllers from actuator. | |
unpairOneWayController |
STRING; INT [1..16] (optional) | Unpair a one way controller from actuator. p1 : Payload of the QRCode associated to the one way controller p2 : channel (Optional - default : 1) |
wink |
INT [1..254] | Ask the device to identify itself by doing a slight movement or blink or beep for a given amount of seconds. |
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
CommandLockLevelsState |
DataState | ||
DiscreteRSSILevelState |
DiscreteState | good, low, normal, verylow | |
NameState |
DataState | ||
OnOffState |
DiscreteState | on, off | |
PriorityLockLevelState |
DiscreteState | comfortLevel1, comfortLevel2, comfortLevel3, comfortLevel4, environmentProtection, humanProtection, userLevel1, userLevel2 | |
PriorityLockOriginatorState |
DiscreteState | LSC, SAAC, SFC, UPS, externalGateway, localUser, myself, rain, security, temperature, timer, user, wind | |
PriorityLockTimerState |
ContinuousState | ||
RSSILevelState |
ContinuousState | ||
StatusState |
DiscreteState | available, unavailable |
Pergola/PergolaHorizontalAwning (ACTUATOR) — 36 commands, 17 states
Type IDs: 1048832, 1048834 | Servers: atlantic_cozytouch, hi_kumo_europe, rexel | Controllable: io:PergolaRailGuidedAwningIOComponent | Profiles: StatefulSlidingPergola, StatefulDeployable, Deployable, DeployUndeploy, StatefulOpenClose, OpenClose
Data Properties
core:identifyInterval=500
Commands
| Command | Parameters | Notes |
|---|---|---|
addLockLevel |
INT; INT (optional) | Add a command lock level on the device p1 : The lock level to add p2 : (optional) Duration in second of the lock Level. By default there is no expiration. |
advancedRefresh |
STRING: normal, advanced, custom; ARRAY (optional) | Refresh extra states |
close |
Fully close the device | |
delayedStopIdentify |
INT [1..254] | (IO-homecontrol specific) Ask the device to stop winking after a given number of seconds |
deploy |
Fully deploy the device | |
down |
Move the device completely down | |
executeManufacturerProcedure |
STRING; OBJECT; OBJECT (optional) | execute manufacturer procedure command. p1: the procedure name p2: the params associated Example: p1 = "dead_man_up" p2 = {"duration": 42} |
getName |
Refresh the device internal name | |
identify |
Ask the device to identify itself by doing a slight movement or blink or beep | |
keepOneWayControllersAndDeleteNode |
Delete 2way key from actuator and delete the device. All one way controllers remain linked to the actuator. | |
my |
Set the device to a user pre-defined position | |
open |
Fully open the device | |
pairOneWayController |
STRING; INT [1..16] (optional) | Pair a one way controller to actuator. p1 : Payload of the QRCode associated to the one way controller p2 : channel (Optional - default : 1) |
readManufacturerData |
ARRAY | Read manufacturer data values from given names. Example: ["setting1","setting2"]. |
refreshMemorized1Position |
Refresh memorized 1 position state | |
removeLockLevel |
INT | Remove the command lock level on the device p1 : The lock level to remove |
resetLockLevels |
Remove all lock levels on the device | |
runManufacturerSettingsCommand |
STRING; OBJECT | Send a manufacturer configuration command. p1: The manufacturer configuration command to use p2: The arguments to send to this command |
sendIOKey |
Send the IO key to device. | |
setClosure |
INT [0..100] | Closure level (100%=fully close, 0%=open) |
setConfigState |
STRING: configuration, virgin, close, transmitting | Set the device in configuration state. p1: configuration mode. |
setDeployment |
INT [0..100] | Device deployment level (100%=fully deployed, 0%=fully undeployed) |
setMemorized1Position |
INT [0..100] | Set favorite position |
setName |
STRING | Change the device internal name. Name length may be subject to restrictions depending on the device and underlying protocol. |
setPosition |
STRING: my, memorized1, secured; INT [0..100] | Set the device to a pre-defined position (enum) or a relative position (0-100%) |
setSecuredPosition |
INT [0..100] | Set the relative position value (0-100%) to be used for the 'secured' position alias |
startIdentify |
Ask the device to start winking immediately for an unlimited amount of time | |
stop |
Stop the current actuator behavior (movement, sound or timer) | |
stopIdentify |
Ask the device to stop winking immediately | |
undeploy |
Fully undeploy the device | |
unpairAllOneWayControllers |
Unpair all one way controllers from actuator. | |
unpairAllOneWayControllersAndDeleteNode |
Unpair all one way controllers from actuator. Delete 2way key from actuator and delete the device. | |
unpairOneWayController |
STRING; INT [1..16] (optional) | Unpair a one way controller from actuator. p1 : Payload of the QRCode associated to the one way controller p2 : channel (Optional - default : 1) |
up |
Move the device completely up | |
wink |
INT [1..254] | Ask the device to identify itself by doing a slight movement or blink or beep for a given amount of seconds. |
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 |
|---|---|---|---|
AdditionalStatusState |
DataState | ||
CommandLockLevelsState |
DataState | ||
DeploymentState |
ContinuousState | [0..100] | |
DiscreteRSSILevelState |
DiscreteState | good, low, normal, verylow | |
ManufacturerDiagnosticsState |
DataState | ||
ManufacturerSettingsState |
DataState | ||
Memorized1PositionState |
ContinuousState | ||
MovingState |
DiscreteState | false, true | |
NameState |
DataState | ||
OpenClosedState |
DiscreteState | open, closed | |
PriorityLockLevelState |
DiscreteState | comfortLevel1, comfortLevel2, comfortLevel3, comfortLevel4, environmentProtection, humanProtection, userLevel1, userLevel2 | |
PriorityLockOriginatorState |
DiscreteState | LSC, SAAC, SFC, UPS, externalGateway, localUser, myself, rain, security, temperature, timer, user, wind | |
PriorityLockTimerState |
ContinuousState | ||
RSSILevelState |
ContinuousState | ||
SecuredPositionState |
ContinuousState | ||
StatusState |
DiscreteState | available, unavailable | |
TargetClosureState |
ContinuousState |
Pergola/PergolaHorizontalAwning (ACTUATOR) — 35 commands, 15 states
Type IDs: 1048832, 1048834 | Servers: somfy_europe | Controllable: io:PergolaRailGuidedAwningIOComponent | Profiles: StatefulSlidingPergola, StatefulDeployable, Deployable, DeployUndeploy, StatefulOpenClose, OpenClose
Data Properties
core:identifyInterval=500
Commands
| Command | Parameters | Notes |
|---|---|---|
addLockLevel |
INT; INT (optional) | Add a command lock level on the device p1 : The lock level to add p2 : (optional) Duration in second of the lock Level. By default there is no expiration. |
advancedRefresh |
STRING: normal, advanced, custom; ARRAY (optional) | Refresh extra states |
close |
Fully close the device | |
delayedStopIdentify |
INT [1..254] | (IO-homecontrol specific) Ask the device to stop winking after a given number of seconds |
deploy |
Fully deploy the device | |
down |
Move the device completely down | |
executeManufacturerProcedure |
STRING; OBJECT; OBJECT (optional) | execute manufacturer procedure command. p1: the procedure name p2: the params associated Example: p1 = "dead_man_up" p2 = {"duration": 42} |
getName |
Refresh the device internal name | |
identify |
Ask the device to identify itself by doing a slight movement or blink or beep | |
keepOneWayControllersAndDeleteNode |
Delete 2way key from actuator and delete the device. All one way controllers remain linked to the actuator. | |
my |
Set the device to a user pre-defined position | |
open |
Fully open the device | |
pairOneWayController |
STRING; INT [1..16] (optional) | Pair a one way controller to actuator. p1 : Payload of the QRCode associated to the one way controller p2 : channel (Optional - default : 1) |
readManufacturerData |
ARRAY | Read manufacturer data values from given names. Example: ["setting1","setting2"]. |
refreshMemorized1Position |
Refresh memorized 1 position state | |
removeLockLevel |
INT | Remove the command lock level on the device p1 : The lock level to remove |
resetLockLevels |
Remove all lock levels on the device | |
sendIOKey |
Send the IO key to device. | |
setClosure |
INT [0..100] | Closure level (100%=fully close, 0%=open) |
setConfigState |
STRING: configuration, virgin, close, transmitting | Set the device in configuration state. p1: configuration mode. |
setDeployment |
INT [0..100] | Device deployment level (100%=fully deployed, 0%=fully undeployed) |
setMemorized1Position |
INT [0..100] | Set favorite position |
setName |
STRING | Change the device internal name. Name length may be subject to restrictions depending on the device and underlying protocol. |
setPosition |
STRING: my, memorized1, secured; INT [0..100] | Set the device to a pre-defined position (enum) or a relative position (0-100%) |
setSecuredPosition |
INT [0..100] | Set the relative position value (0-100%) to be used for the 'secured' position alias |
startIdentify |
Ask the device to start winking immediately for an unlimited amount of time | |
stop |
Stop the current actuator behavior (movement, sound or timer) | |
stopIdentify |
Ask the device to stop winking immediately | |
undeploy |
Fully undeploy the device | |
unpairAllOneWayControllers |
Unpair all one way controllers from actuator. | |
unpairAllOneWayControllersAndDeleteNode |
Unpair all one way controllers from actuator. Delete 2way key from actuator and delete the device. | |
unpairOneWayController |
STRING; INT [1..16] (optional) | Unpair a one way controller from actuator. p1 : Payload of the QRCode associated to the one way controller p2 : channel (Optional - default : 1) |
up |
Move the device completely up | |
wink |
INT [1..254] | Ask the device to identify itself by doing a slight movement or blink or beep for a given amount of seconds. |
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 |
|---|---|---|---|
AdditionalStatusState |
DataState | ||
CommandLockLevelsState |
DataState | ||
DeploymentState |
ContinuousState | [0..100] | |
DiscreteRSSILevelState |
DiscreteState | good, low, normal, verylow | |
Memorized1PositionState |
ContinuousState | ||
MovingState |
DiscreteState | false, true | |
NameState |
DataState | ||
OpenClosedState |
DiscreteState | open, closed | |
PriorityLockLevelState |
DiscreteState | comfortLevel1, comfortLevel2, comfortLevel3, comfortLevel4, environmentProtection, humanProtection, userLevel1, userLevel2 | |
PriorityLockOriginatorState |
DiscreteState | LSC, SAAC, SFC, UPS, externalGateway, localUser, myself, rain, security, temperature, timer, user, wind | |
PriorityLockTimerState |
ContinuousState | ||
RSSILevelState |
ContinuousState | ||
SecuredPositionState |
ContinuousState | ||
StatusState |
DiscreteState | available, unavailable | |
TargetClosureState |
ContinuousState |
RollerShutter/PositionableRollerShutter (ACTUATOR) — 34 commands, 17 states
Type IDs: 131072, 131074 | Servers: atlantic_cozytouch, hi_kumo_europe, rexel | Controllable: io:RollerShutterGenericIOComponent | Profiles: StatefulCloseableShutter, StatefulCloseable, Closeable, StatefulOpenClose, OpenClose
Data Properties
core:identifyInterval=500
Commands
| Command | Parameters | Notes |
|---|---|---|
addLockLevel |
INT; INT (optional) | Add a command lock level on the device p1 : The lock level to add p2 : (optional) Duration in second of the lock Level. By default there is no expiration. |
advancedRefresh |
STRING: normal, advanced, custom; ARRAY (optional) | Refresh extra states |
close |
Fully close the device | |
delayedStopIdentify |
INT [1..254] | (IO-homecontrol specific) Ask the device to stop winking after a given number of seconds |
down |
Move the device completely down | |
executeManufacturerProcedure |
STRING; OBJECT; OBJECT (optional) | execute manufacturer procedure command. p1: the procedure name p2: the params associated Example: p1 = "dead_man_up" p2 = {"duration": 42} |
getName |
Refresh the device internal name | |
identify |
Ask the device to identify itself by doing a slight movement or blink or beep | |
keepOneWayControllersAndDeleteNode |
Delete 2way key from actuator and delete the device. All one way controllers remain linked to the actuator. | |
my |
Set the device to a user pre-defined position | |
open |
Fully open the device | |
pairOneWayController |
STRING; INT [1..16] (optional) | Pair a one way controller to actuator. p1 : Payload of the QRCode associated to the one way controller p2 : channel (Optional - default : 1) |
readManufacturerData |
ARRAY | Read manufacturer data values from given names. Example: ["setting1","setting2"]. |
refreshMemorized1Position |
Refresh memorized 1 position state | |
removeLockLevel |
INT | Remove the command lock level on the device p1 : The lock level to remove |
resetLockLevels |
Remove all lock levels on the device | |
runManufacturerSettingsCommand |
STRING; OBJECT | Send a manufacturer configuration command. p1: The manufacturer configuration command to use p2: The arguments to send to this command |
sendIOKey |
Send the IO key to device. | |
setClosure |
INT [0..100] | Closure level (100%=fully close, 0%=open) |
setConfigState |
STRING: configuration, virgin, close, transmitting | Set the device in configuration state. p1: configuration mode. |
setDeployment |
INT [0..100] | Device deployment level (100%=fully deployed, 0%=fully undeployed) |
setMemorized1Position |
INT [0..100] | Set favorite position |
setName |
STRING | Change the device internal name. Name length may be subject to restrictions depending on the device and underlying protocol. |
setPosition |
STRING: my, memorized1, secured; INT [0..100] | Set the device to a pre-defined position (enum) or a relative position (0-100%) |
setSecuredPosition |
INT [0..100] | Set the relative position value (0-100%) to be used for the 'secured' position alias |
startIdentify |
Ask the device to start winking immediately for an unlimited amount of time | |
stop |
Stop the current actuator behavior (movement, sound or timer) | |
stopIdentify |
Ask the device to stop winking immediately | |
unpairAllOneWayControllers |
Unpair all one way controllers from actuator. | |
unpairAllOneWayControllersAndDeleteNode |
Unpair all one way controllers from actuator. Delete 2way key from actuator and delete the device. | |
unpairOneWayController |
STRING; INT [1..16] (optional) | Unpair a one way controller from actuator. p1 : Payload of the QRCode associated to the one way controller p2 : channel (Optional - default : 1) |
up |
Move the device completely up | |
wink |
INT [1..254] | Ask the device to identify itself by doing a slight movement or blink or beep for a given amount of seconds. |
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 |
|---|---|---|---|
AdditionalStatusState |
DataState | ||
ClosureState |
ContinuousState | [0..100] | |
CommandLockLevelsState |
DataState | ||
DiscreteRSSILevelState |
DiscreteState | good, low, normal, verylow | |
ManufacturerDiagnosticsState |
DataState | ||
ManufacturerSettingsState |
DataState | ||
Memorized1PositionState |
ContinuousState | ||
MovingState |
DiscreteState | false, true | |
NameState |
DataState | ||
OpenClosedState |
DiscreteState | open, closed | |
PriorityLockLevelState |
DiscreteState | comfortLevel1, comfortLevel2, comfortLevel3, comfortLevel4, environmentProtection, humanProtection, userLevel1, userLevel2 | |
PriorityLockOriginatorState |
DiscreteState | LSC, SAAC, SFC, UPS, externalGateway, localUser, myself, rain, security, temperature, timer, user, wind | |
PriorityLockTimerState |
ContinuousState | ||
RSSILevelState |
ContinuousState | ||
SecuredPositionState |
ContinuousState | ||
StatusState |
DiscreteState | available, unavailable | |
TargetClosureState |
ContinuousState |
RollerShutter/PositionableTiltedRollerShutter (ACTUATOR) — 29 commands, 13 states
Type IDs: 131073 | Servers: atlantic_cozytouch, hi_kumo_europe, rexel, somfy_europe | Controllable: io:RollerShutterVeluxIOComponent | Profiles: StatefulCloseableShutter, StatefulCloseable, Closeable, StatefulOpenClose, OpenClose
Data Properties
core:identifyInterval=500
Commands
| Command | Parameters | Notes |
|---|---|---|
addLockLevel |
INT; INT (optional) | Add a command lock level on the device p1 : The lock level to add p2 : (optional) Duration in second of the lock Level. By default there is no expiration. |
advancedRefresh |
STRING: normal, advanced, custom; ARRAY (optional) | Refresh extra states |
close |
Fully close the device | |
delayedStopIdentify |
INT [1..254] | (IO-homecontrol specific) Ask the device to stop winking after a given number of seconds |
down |
Move the device completely down | |
getName |
Refresh the device internal name | |
identify |
Ask the device to identify itself by doing a slight movement or blink or beep | |
my |
Set the device to a user pre-defined position | |
open |
Fully open the device | |
pairOneWayController |
STRING; INT [1..16] (optional) | Pair a one way controller to actuator. p1 : Payload of the QRCode associated to the one way controller p2 : channel (Optional - default : 1) |
refreshMemorized1Position |
Refresh memorized 1 position state | |
removeLockLevel |
INT | Remove the command lock level on the device p1 : The lock level to remove |
resetLockLevels |
Remove all lock levels on the device | |
setClosure |
INT [0..100] | Closure level (100%=fully close, 0%=open) |
setClosureAndLinearSpeed |
INT [0..100]; STRING: lowspeed (optional) | Set the device to a closure level (0-100%) with an optional given speed |
setConfigState |
STRING: configuration, virgin, close, transmitting | Set the device in configuration state. p1: configuration mode. |
setDeployment |
INT [0..100] | Device deployment level (100%=fully deployed, 0%=fully undeployed) |
setMemorized1Position |
INT [0..100] | Set favorite position |
setName |
STRING | Change the device internal name. Name length may be subject to restrictions depending on the device and underlying protocol. |
setPosition |
STRING: my, memorized1, secured; INT [0..100] | Set the device to a pre-defined position (enum) or a relative position (0-100%) |
setPositionAndLinearSpeed |
STRING: my; INT [0..100]; STRING: lowspeed (optional) | Set the device to a pre-defined position (enum) or a relative position (0-100%) with a given speed |
setSecuredPosition |
INT [0..100] | Set the relative position value (0-100%) to be used for the 'secured' position alias |
startIdentify |
Ask the device to start winking immediately for an unlimited amount of time | |
stop |
Stop the current actuator behavior (movement, sound or timer) | |
stopIdentify |
Ask the device to stop winking immediately | |
unpairAllOneWayControllers |
Unpair all one way controllers from actuator. | |
unpairOneWayController |
STRING; INT [1..16] (optional) | Unpair a one way controller from actuator. p1 : Payload of the QRCode associated to the one way controller p2 : channel (Optional - default : 1) |
up |
Move the device completely up | |
wink |
INT [1..254] | Ask the device to identify itself by doing a slight movement or blink or beep for a given amount of seconds. |
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
BatteryDiscreteLevelState |
DiscreteState | good, medium, low, critical | |
ClosureState |
ContinuousState | [0..100] | |
CommandLockLevelsState |
DataState | ||
DiscreteRSSILevelState |
DiscreteState | good, low, normal, verylow | |
Memorized1PositionState |
ContinuousState | ||
NameState |
DataState | ||
OpenClosedState |
DiscreteState | open, closed | |
PriorityLockLevelState |
DiscreteState | comfortLevel1, comfortLevel2, comfortLevel3, comfortLevel4, environmentProtection, humanProtection, userLevel1, userLevel2 | |
PriorityLockOriginatorState |
DiscreteState | LSC, SAAC, SFC, UPS, externalGateway, localUser, myself, rain, security, temperature, timer, user, wind | |
PriorityLockTimerState |
ContinuousState | ||
RSSILevelState |
ContinuousState | ||
SecuredPositionState |
ContinuousState | ||
StatusState |
DiscreteState | available, unavailable |
RollerShutter/PositionableProjectionRollerShutter (ACTUATOR) — 29 commands, 13 states
Type IDs: 131584 | Servers: atlantic_cozytouch, hi_kumo_europe, rexel, somfy_europe | Controllable: io:ProjectionRollerShutterIOComponent | Profiles: StatefulCloseableShutter, StatefulCloseable, Closeable, StatefulOpenClose, OpenClose
Data Properties
core:identifyInterval=500
Commands
| Command | Parameters | Notes |
|---|---|---|
addLockLevel |
INT; INT (optional) | Add a command lock level on the device p1 : The lock level to add p2 : (optional) Duration in second of the lock Level. By default there is no expiration. |
advancedRefresh |
STRING: normal, advanced, custom; ARRAY (optional) | Refresh extra states |
close |
Fully close the device | |
delayedStopIdentify |
INT [1..254] | (IO-homecontrol specific) Ask the device to stop winking after a given number of seconds |
down |
Move the device completely down | |
getName |
Refresh the device internal name | |
identify |
Ask the device to identify itself by doing a slight movement or blink or beep | |
my |
Set the device to a user pre-defined position | |
open |
Fully open the device | |
pairOneWayController |
STRING; INT [1..16] (optional) | Pair a one way controller to actuator. p1 : Payload of the QRCode associated to the one way controller p2 : channel (Optional - default : 1) |
refreshMemorized1Position |
Refresh memorized 1 position state | |
removeLockLevel |
INT | Remove the command lock level on the device p1 : The lock level to remove |
resetLockLevels |
Remove all lock levels on the device | |
setClosure |
INT [0..100] | Closure level (100%=fully close, 0%=open) |
setClosureAndProjectionAngle |
INT [0..100]; INT [0..100] | |
setConfigState |
STRING: configuration, virgin, close, transmitting | Set the device in configuration state. p1: configuration mode. |
setDeployment |
INT [0..100] | Device deployment level (100%=fully deployed, 0%=fully undeployed) |
setMemorized1Position |
INT [0..100] | Set favorite position |
setName |
STRING | Change the device internal name. Name length may be subject to restrictions depending on the device and underlying protocol. |
setPosition |
STRING: my, memorized1, secured; INT [0..100] | Set the device to a pre-defined position (enum) or a relative position (0-100%) |
setProjectionAngle |
ANY | |
setSecuredPosition |
INT [0..100] | Set the relative position value (0-100%) to be used for the 'secured' position alias |
startIdentify |
Ask the device to start winking immediately for an unlimited amount of time | |
stop |
Stop the current actuator behavior (movement, sound or timer) | |
stopIdentify |
Ask the device to stop winking immediately | |
unpairAllOneWayControllers |
Unpair all one way controllers from actuator. | |
unpairOneWayController |
STRING; INT [1..16] (optional) | Unpair a one way controller from actuator. p1 : Payload of the QRCode associated to the one way controller p2 : channel (Optional - default : 1) |
up |
Move the device completely up | |
wink |
INT [1..254] | Ask the device to identify itself by doing a slight movement or blink or beep for a given amount of seconds. |
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
ClosureState |
ContinuousState | [0..100] | |
CommandLockLevelsState |
DataState | ||
DiscreteRSSILevelState |
DiscreteState | good, low, normal, verylow | |
Memorized1PositionState |
ContinuousState | ||
NameState |
DataState | ||
OpenClosedState |
DiscreteState | open, closed | |
PriorityLockLevelState |
DiscreteState | comfortLevel1, comfortLevel2, comfortLevel3, comfortLevel4, environmentProtection, humanProtection, userLevel1, userLevel2 | |
PriorityLockOriginatorState |
DiscreteState | LSC, SAAC, SFC, UPS, externalGateway, localUser, myself, rain, security, temperature, timer, user, wind | |
PriorityLockTimerState |
ContinuousState | ||
ProjectionAngleState |
ContinuousState | ||
RSSILevelState |
ContinuousState | ||
SecuredPositionState |
ContinuousState | ||
StatusState |
DiscreteState | available, unavailable |
RollerShutter/PositionableDualRollerShutter (ACTUATOR) — 43 commands, 16 states
Type IDs: 851968 | Servers: atlantic_cozytouch, hi_kumo_europe, rexel, somfy_europe | Controllable: io:DualRollerShutterIOComponent | Profiles: StatefulCloseableShutter, StatefulCloseable, Closeable, StatefulOpenClose, OpenClose
Data Properties
core:identifyInterval=500
Commands
| Command | Parameters | Notes |
|---|---|---|
addLockLevel |
INT; INT (optional) | Add a command lock level on the device p1 : The lock level to add p2 : (optional) Duration in second of the lock Level. By default there is no expiration. |
advancedRefresh |
STRING: normal, advanced, custom; ARRAY (optional) | Refresh extra states |
close |
Fully close the device | |
delayedStopIdentify |
INT [1..254] | (IO-homecontrol specific) Ask the device to stop winking after a given number of seconds |
down |
Move the device completely down | |
getClosure |
Get closure level (100%=fully close, 0%=open) | |
getLowerClosure |
||
getName |
Refresh the device internal name | |
getUpperClosure |
||
identify |
Ask the device to identify itself by doing a slight movement or blink or beep | |
lowerClose |
||
lowerDown |
||
lowerOpen |
||
lowerUp |
||
my |
Set the device to a user pre-defined position | |
open |
Fully open the device | |
pairOneWayController |
STRING; INT [1..16] (optional) | Pair a one way controller to actuator. p1 : Payload of the QRCode associated to the one way controller p2 : channel (Optional - default : 1) |
refreshMemorized1Position |
Refresh memorized 1 position state | |
removeLockLevel |
INT | Remove the command lock level on the device p1 : The lock level to remove |
resetLockLevels |
Remove all lock levels on the device | |
setClosure |
INT [0..100] | Closure level (100%=fully close, 0%=open) |
setConfigState |
STRING: configuration, virgin, close, transmitting | Set the device in configuration state. p1: configuration mode. |
setLowerClosure |
ANY | |
setLowerPosition |
ANY | |
setMemorized1Position |
INT [0..100] | Set favorite position |
setName |
STRING | Change the device internal name. Name length may be subject to restrictions depending on the device and underlying protocol. |
setPosition |
STRING: my, memorized1, secured; INT [0..100] | Set the device to a pre-defined position (enum) or a relative position (0-100%) |
setSecuredPosition |
INT [0..100] | Set the relative position value (0-100%) to be used for the 'secured' position alias |
setUpperAndLowerClosure |
INT [0..100]; INT [0..100] | |
setUpperAndLowerPosition |
INT [0..100]; INT [0..100] | |
setUpperClosure |
ANY | |
setUpperPosition |
ANY | |
startIdentify |
Ask the device to start winking immediately for an unlimited amount of time | |
stop |
Stop the current actuator behavior (movement, sound or timer) | |
stopIdentify |
Ask the device to stop winking immediately | |
unpairAllOneWayControllers |
Unpair all one way controllers from actuator. | |
unpairOneWayController |
STRING; INT [1..16] (optional) | Unpair a one way controller from actuator. p1 : Payload of the QRCode associated to the one way controller p2 : channel (Optional - default : 1) |
up |
Move the device completely up | |
upperClose |
||
upperDown |
||
upperOpen |
||
upperUp |
||
wink |
INT [1..254] | Ask the device to identify itself by doing a slight movement or blink or beep for a given amount of seconds. |
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
ClosureState |
ContinuousState | [0..100] | |
CommandLockLevelsState |
DataState | ||
DiscreteRSSILevelState |
DiscreteState | good, low, normal, verylow | |
LowerClosureState |
ContinuousState | ||
LowerOpenClosedState |
DiscreteState | closed, open | |
Memorized1PositionState |
ContinuousState | ||
NameState |
DataState | ||
OpenClosedState |
DiscreteState | open, closed | |
PriorityLockLevelState |
DiscreteState | comfortLevel1, comfortLevel2, comfortLevel3, comfortLevel4, environmentProtection, humanProtection, userLevel1, userLevel2 | |
PriorityLockOriginatorState |
DiscreteState | LSC, SAAC, SFC, UPS, externalGateway, localUser, myself, rain, security, temperature, timer, user, wind | |
PriorityLockTimerState |
ContinuousState | ||
RSSILevelState |
ContinuousState | ||
SecuredPositionState |
ContinuousState | ||
StatusState |
DiscreteState | available, unavailable | |
UpperClosureState |
ContinuousState | ||
UpperOpenClosedState |
DiscreteState | closed, open |
RollerShutter/PositionableRollerShutter (ACTUATOR) — 33 commands, 15 states
Type IDs: 131072, 131074 | Servers: somfy_europe | Controllable: io:RollerShutterGenericIOComponent | Profiles: StatefulCloseableShutter, StatefulCloseable, Closeable, StatefulOpenClose, OpenClose
Data Properties
core:identifyInterval=500
Commands
| Command | Parameters | Notes |
|---|---|---|
addLockLevel |
INT; INT (optional) | Add a command lock level on the device p1 : The lock level to add p2 : (optional) Duration in second of the lock Level. By default there is no expiration. |
advancedRefresh |
STRING: normal, advanced, custom; ARRAY (optional) | Refresh extra states |
close |
Fully close the device | |
delayedStopIdentify |
INT [1..254] | (IO-homecontrol specific) Ask the device to stop winking after a given number of seconds |
down |
Move the device completely down | |
executeManufacturerProcedure |
STRING; OBJECT; OBJECT (optional) | execute manufacturer procedure command. p1: the procedure name p2: the params associated Example: p1 = "dead_man_up" p2 = {"duration": 42} |
getName |
Refresh the device internal name | |
identify |
Ask the device to identify itself by doing a slight movement or blink or beep | |
keepOneWayControllersAndDeleteNode |
Delete 2way key from actuator and delete the device. All one way controllers remain linked to the actuator. | |
my |
Set the device to a user pre-defined position | |
open |
Fully open the device | |
pairOneWayController |
STRING; INT [1..16] (optional) | Pair a one way controller to actuator. p1 : Payload of the QRCode associated to the one way controller p2 : channel (Optional - default : 1) |
readManufacturerData |
ARRAY | Read manufacturer data values from given names. Example: ["setting1","setting2"]. |
refreshMemorized1Position |
Refresh memorized 1 position state | |
removeLockLevel |
INT | Remove the command lock level on the device p1 : The lock level to remove |
resetLockLevels |
Remove all lock levels on the device | |
sendIOKey |
Send the IO key to device. | |
setClosure |
INT [0..100] | Closure level (100%=fully close, 0%=open) |
setConfigState |
STRING: configuration, virgin, close, transmitting | Set the device in configuration state. p1: configuration mode. |
setDeployment |
INT [0..100] | Device deployment level (100%=fully deployed, 0%=fully undeployed) |
setMemorized1Position |
INT [0..100] | Set favorite position |
setName |
STRING | Change the device internal name. Name length may be subject to restrictions depending on the device and underlying protocol. |
setPosition |
STRING: my, memorized1, secured; INT [0..100] | Set the device to a pre-defined position (enum) or a relative position (0-100%) |
setSecuredPosition |
INT [0..100] | Set the relative position value (0-100%) to be used for the 'secured' position alias |
startIdentify |
Ask the device to start winking immediately for an unlimited amount of time | |
stop |
Stop the current actuator behavior (movement, sound or timer) | |
stopIdentify |
Ask the device to stop winking immediately | |
unpairAllOneWayControllers |
Unpair all one way controllers from actuator. | |
unpairAllOneWayControllersAndDeleteNode |
Unpair all one way controllers from actuator. Delete 2way key from actuator and delete the device. | |
unpairOneWayController |
STRING; INT [1..16] (optional) | Unpair a one way controller from actuator. p1 : Payload of the QRCode associated to the one way controller p2 : channel (Optional - default : 1) |
up |
Move the device completely up | |
wink |
INT [1..254] | Ask the device to identify itself by doing a slight movement or blink or beep for a given amount of seconds. |
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 |
|---|---|---|---|
AdditionalStatusState |
DataState | ||
ClosureState |
ContinuousState | [0..100] | |
CommandLockLevelsState |
DataState | ||
DiscreteRSSILevelState |
DiscreteState | good, low, normal, verylow | |
Memorized1PositionState |
ContinuousState | ||
MovingState |
DiscreteState | false, true | |
NameState |
DataState | ||
OpenClosedState |
DiscreteState | open, closed | |
PriorityLockLevelState |
DiscreteState | comfortLevel1, comfortLevel2, comfortLevel3, comfortLevel4, environmentProtection, humanProtection, userLevel1, userLevel2 | |
PriorityLockOriginatorState |
DiscreteState | LSC, SAAC, SFC, UPS, externalGateway, localUser, myself, rain, security, temperature, timer, user, wind | |
PriorityLockTimerState |
ContinuousState | ||
RSSILevelState |
ContinuousState | ||
SecuredPositionState |
ContinuousState | ||
StatusState |
DiscreteState | available, unavailable | |
TargetClosureState |
ContinuousState |
Screen/PositionableScreen (ACTUATOR) — 33 commands, 17 states
Type IDs: 655360, 655362 | Servers: atlantic_cozytouch, hi_kumo_europe, rexel | Controllable: io:VerticalInteriorBlindGenericIOComponent | Profiles: StatefulCloseableBlind, StatefulCloseable, Closeable, StatefulOpenClose, OpenClose
Data Properties
core:identifyInterval=500
Commands
| Command | Parameters | Notes |
|---|---|---|
addLockLevel |
INT; INT (optional) | Add a command lock level on the device p1 : The lock level to add p2 : (optional) Duration in second of the lock Level. By default there is no expiration. |
advancedRefresh |
STRING: normal, advanced, custom; ARRAY (optional) | Refresh extra states |
close |
Fully close the device | |
delayedStopIdentify |
INT [1..254] | (IO-homecontrol specific) Ask the device to stop winking after a given number of seconds |
down |
Move the device completely down | |
executeManufacturerProcedure |
STRING; OBJECT; OBJECT (optional) | execute manufacturer procedure command. p1: the procedure name p2: the params associated Example: p1 = "dead_man_up" p2 = {"duration": 42} |
getName |
Refresh the device internal name | |
identify |
Ask the device to identify itself by doing a slight movement or blink or beep | |
keepOneWayControllersAndDeleteNode |
Delete 2way key from actuator and delete the device. All one way controllers remain linked to the actuator. | |
my |
Set the device to a user pre-defined position | |
open |
Fully open the device | |
pairOneWayController |
STRING; INT [1..16] (optional) | Pair a one way controller to actuator. p1 : Payload of the QRCode associated to the one way controller p2 : channel (Optional - default : 1) |
readManufacturerData |
ARRAY | Read manufacturer data values from given names. Example: ["setting1","setting2"]. |
refreshMemorized1Position |
Refresh memorized 1 position state | |
removeLockLevel |
INT | Remove the command lock level on the device p1 : The lock level to remove |
resetLockLevels |
Remove all lock levels on the device | |
runManufacturerSettingsCommand |
STRING; OBJECT | Send a manufacturer configuration command. p1: The manufacturer configuration command to use p2: The arguments to send to this command |
sendIOKey |
Send the IO key to device. | |
setClosure |
INT [0..100] | Closure level (100%=fully close, 0%=open) |
setConfigState |
STRING: configuration, virgin, close, transmitting | Set the device in configuration state. p1: configuration mode. |
setMemorized1Position |
INT [0..100] | Set favorite position |
setName |
STRING | Change the device internal name. Name length may be subject to restrictions depending on the device and underlying protocol. |
setPosition |
STRING: my, memorized1, secured; INT [0..100] | Set the device to a pre-defined position (enum) or a relative position (0-100%) |
setSecuredPosition |
INT [0..100] | Set the relative position value (0-100%) to be used for the 'secured' position alias |
startIdentify |
Ask the device to start winking immediately for an unlimited amount of time | |
stop |
Stop the current actuator behavior (movement, sound or timer) | |
stopIdentify |
Ask the device to stop winking immediately | |
unpairAllOneWayControllers |
Unpair all one way controllers from actuator. | |
unpairAllOneWayControllersAndDeleteNode |
Unpair all one way controllers from actuator. Delete 2way key from actuator and delete the device. | |
unpairOneWayController |
STRING; INT [1..16] (optional) | Unpair a one way controller from actuator. p1 : Payload of the QRCode associated to the one way controller p2 : channel (Optional - default : 1) |
up |
Move the device completely up | |
wink |
INT [1..254] | Ask the device to identify itself by doing a slight movement or blink or beep for a given amount of seconds. |
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 |
|---|---|---|---|
AdditionalStatusState |
DataState | ||
ClosureState |
ContinuousState | [0..100] | |
CommandLockLevelsState |
DataState | ||
DiscreteRSSILevelState |
DiscreteState | good, low, normal, verylow | |
ManufacturerDiagnosticsState |
DataState | ||
ManufacturerSettingsState |
DataState | ||
Memorized1PositionState |
ContinuousState | ||
MovingState |
DiscreteState | false, true | |
NameState |
DataState | ||
OpenClosedState |
DiscreteState | open, closed | |
PriorityLockLevelState |
DiscreteState | comfortLevel1, comfortLevel2, comfortLevel3, comfortLevel4, environmentProtection, humanProtection, userLevel1, userLevel2 | |
PriorityLockOriginatorState |
DiscreteState | LSC, SAAC, SFC, UPS, externalGateway, localUser, myself, rain, security, temperature, timer, user, wind | |
PriorityLockTimerState |
ContinuousState | ||
RSSILevelState |
ContinuousState | ||
SecuredPositionState |
ContinuousState | ||
StatusState |
DiscreteState | available, unavailable | |
TargetClosureState |
ContinuousState |
Screen/PositionableTiltedScreen (ACTUATOR) — 26 commands, 12 states
Type IDs: 655361 | Servers: atlantic_cozytouch, hi_kumo_europe, rexel, somfy_europe | Controllable: io:VerticalInteriorBlindVeluxIOComponent | Profiles: StatefulCloseableBlind, StatefulCloseable, Closeable, StatefulOpenClose, OpenClose
Data Properties
core:identifyInterval=500
Commands
| Command | Parameters | Notes |
|---|---|---|
addLockLevel |
INT; INT (optional) | Add a command lock level on the device p1 : The lock level to add p2 : (optional) Duration in second of the lock Level. By default there is no expiration. |
advancedRefresh |
STRING: normal, advanced, custom; ARRAY (optional) | Refresh extra states |
close |
Fully close the device | |
delayedStopIdentify |
INT [1..254] | (IO-homecontrol specific) Ask the device to stop winking after a given number of seconds |
down |
Move the device completely down | |
getName |
Refresh the device internal name | |
identify |
Ask the device to identify itself by doing a slight movement or blink or beep | |
my |
Set the device to a user pre-defined position | |
open |
Fully open the device | |
pairOneWayController |
STRING; INT [1..16] (optional) | Pair a one way controller to actuator. p1 : Payload of the QRCode associated to the one way controller p2 : channel (Optional - default : 1) |
refreshMemorized1Position |
Refresh memorized 1 position state | |
removeLockLevel |
INT | Remove the command lock level on the device p1 : The lock level to remove |
resetLockLevels |
Remove all lock levels on the device | |
setClosure |
INT [0..100] | Closure level (100%=fully close, 0%=open) |
setConfigState |
STRING: configuration, virgin, close, transmitting | Set the device in configuration state. p1: configuration mode. |
setMemorized1Position |
INT [0..100] | Set favorite position |
setName |
STRING | Change the device internal name. Name length may be subject to restrictions depending on the device and underlying protocol. |
setPosition |
STRING: my, memorized1, secured; INT [0..100] | Set the device to a pre-defined position (enum) or a relative position (0-100%) |
setSecuredPosition |
INT [0..100] | Set the relative position value (0-100%) to be used for the 'secured' position alias |
startIdentify |
Ask the device to start winking immediately for an unlimited amount of time | |
stop |
Stop the current actuator behavior (movement, sound or timer) | |
stopIdentify |
Ask the device to stop winking immediately | |
unpairAllOneWayControllers |
Unpair all one way controllers from actuator. | |
unpairOneWayController |
STRING; INT [1..16] (optional) | Unpair a one way controller from actuator. p1 : Payload of the QRCode associated to the one way controller p2 : channel (Optional - default : 1) |
up |
Move the device completely up | |
wink |
INT [1..254] | Ask the device to identify itself by doing a slight movement or blink or beep for a given amount of seconds. |
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
ClosureState |
ContinuousState | [0..100] | |
CommandLockLevelsState |
DataState | ||
DiscreteRSSILevelState |
DiscreteState | good, low, normal, verylow | |
Memorized1PositionState |
ContinuousState | ||
NameState |
DataState | ||
OpenClosedState |
DiscreteState | open, closed | |
PriorityLockLevelState |
DiscreteState | comfortLevel1, comfortLevel2, comfortLevel3, comfortLevel4, environmentProtection, humanProtection, userLevel1, userLevel2 | |
PriorityLockOriginatorState |
DiscreteState | LSC, SAAC, SFC, UPS, externalGateway, localUser, myself, rain, security, temperature, timer, user, wind | |
PriorityLockTimerState |
ContinuousState | ||
RSSILevelState |
ContinuousState | ||
SecuredPositionState |
ContinuousState | ||
StatusState |
DiscreteState | available, unavailable |
Screen/PositionableScreen (ACTUATOR) — 32 commands, 15 states
Type IDs: 655360, 655362 | Servers: somfy_europe | Controllable: io:VerticalInteriorBlindGenericIOComponent | Profiles: StatefulCloseableBlind, StatefulCloseable, Closeable, StatefulOpenClose, OpenClose
Data Properties
core:identifyInterval=500
Commands
| Command | Parameters | Notes |
|---|---|---|
addLockLevel |
INT; INT (optional) | Add a command lock level on the device p1 : The lock level to add p2 : (optional) Duration in second of the lock Level. By default there is no expiration. |
advancedRefresh |
STRING: normal, advanced, custom; ARRAY (optional) | Refresh extra states |
close |
Fully close the device | |
delayedStopIdentify |
INT [1..254] | (IO-homecontrol specific) Ask the device to stop winking after a given number of seconds |
down |
Move the device completely down | |
executeManufacturerProcedure |
STRING; OBJECT; OBJECT (optional) | execute manufacturer procedure command. p1: the procedure name p2: the params associated Example: p1 = "dead_man_up" p2 = {"duration": 42} |
getName |
Refresh the device internal name | |
identify |
Ask the device to identify itself by doing a slight movement or blink or beep | |
keepOneWayControllersAndDeleteNode |
Delete 2way key from actuator and delete the device. All one way controllers remain linked to the actuator. | |
my |
Set the device to a user pre-defined position | |
open |
Fully open the device | |
pairOneWayController |
STRING; INT [1..16] (optional) | Pair a one way controller to actuator. p1 : Payload of the QRCode associated to the one way controller p2 : channel (Optional - default : 1) |
readManufacturerData |
ARRAY | Read manufacturer data values from given names. Example: ["setting1","setting2"]. |
refreshMemorized1Position |
Refresh memorized 1 position state | |
removeLockLevel |
INT | Remove the command lock level on the device p1 : The lock level to remove |
resetLockLevels |
Remove all lock levels on the device | |
sendIOKey |
Send the IO key to device. | |
setClosure |
INT [0..100] | Closure level (100%=fully close, 0%=open) |
setConfigState |
STRING: configuration, virgin, close, transmitting | Set the device in configuration state. p1: configuration mode. |
setMemorized1Position |
INT [0..100] | Set favorite position |
setName |
STRING | Change the device internal name. Name length may be subject to restrictions depending on the device and underlying protocol. |
setPosition |
STRING: my, memorized1, secured; INT [0..100] | Set the device to a pre-defined position (enum) or a relative position (0-100%) |
setSecuredPosition |
INT [0..100] | Set the relative position value (0-100%) to be used for the 'secured' position alias |
startIdentify |
Ask the device to start winking immediately for an unlimited amount of time | |
stop |
Stop the current actuator behavior (movement, sound or timer) | |
stopIdentify |
Ask the device to stop winking immediately | |
unpairAllOneWayControllers |
Unpair all one way controllers from actuator. | |
unpairAllOneWayControllersAndDeleteNode |
Unpair all one way controllers from actuator. Delete 2way key from actuator and delete the device. | |
unpairOneWayController |
STRING; INT [1..16] (optional) | Unpair a one way controller from actuator. p1 : Payload of the QRCode associated to the one way controller p2 : channel (Optional - default : 1) |
up |
Move the device completely up | |
wink |
INT [1..254] | Ask the device to identify itself by doing a slight movement or blink or beep for a given amount of seconds. |
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 |
|---|---|---|---|
AdditionalStatusState |
DataState | ||
ClosureState |
ContinuousState | [0..100] | |
CommandLockLevelsState |
DataState | ||
DiscreteRSSILevelState |
DiscreteState | good, low, normal, verylow | |
Memorized1PositionState |
ContinuousState | ||
MovingState |
DiscreteState | false, true | |
NameState |
DataState | ||
OpenClosedState |
DiscreteState | open, closed | |
PriorityLockLevelState |
DiscreteState | comfortLevel1, comfortLevel2, comfortLevel3, comfortLevel4, environmentProtection, humanProtection, userLevel1, userLevel2 | |
PriorityLockOriginatorState |
DiscreteState | LSC, SAAC, SFC, UPS, externalGateway, localUser, myself, rain, security, temperature, timer, user, wind | |
PriorityLockTimerState |
ContinuousState | ||
RSSILevelState |
ContinuousState | ||
SecuredPositionState |
ContinuousState | ||
StatusState |
DiscreteState | available, unavailable | |
TargetClosureState |
ContinuousState |
SwimmingPool (ACTUATOR) — 19 commands, 9 states
Type IDs: 393471 | Servers: atlantic_cozytouch, hi_kumo_europe, rexel, somfy_europe | Controllable: io:SwimmingPoolIOComponent | Profiles: SwitchableLight, StatefulSwitchable, Switchable
Data Properties
core:identifyInterval=500
Commands
| Command | Parameters | Notes |
|---|---|---|
addLockLevel |
INT; INT (optional) | Add a command lock level on the device p1 : The lock level to add p2 : (optional) Duration in second of the lock Level. By default there is no expiration. |
advancedRefresh |
STRING: normal, advanced, custom; ARRAY (optional) | Refresh extra states |
delayedStopIdentify |
INT [1..254] | (IO-homecontrol specific) Ask the device to stop winking after a given number of seconds |
getName |
Refresh the device internal name | |
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 | |
onWithTimer |
INT [5..14400] | Turn the device on for a given amount of seconds then turn it off |
pairOneWayController |
STRING; INT [1..16] (optional) | Pair a one way controller to actuator. p1 : Payload of the QRCode associated to the one way controller p2 : channel (Optional - default : 1) |
removeLockLevel |
INT | Remove the command lock level on the device p1 : The lock level to remove |
resetLockLevels |
Remove all lock levels on the device | |
setConfigState |
STRING: configuration, virgin, close, transmitting | Set the device in configuration state. p1: configuration 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 |
startIdentify |
Ask the device to start winking immediately for an unlimited amount of time | |
stopIdentify |
Ask the device to stop winking immediately | |
unpairAllOneWayControllers |
Unpair all one way controllers from actuator. | |
unpairOneWayController |
STRING; INT [1..16] (optional) | Unpair a one way controller from actuator. p1 : Payload of the QRCode associated to the one way controller p2 : channel (Optional - default : 1) |
wink |
INT [1..254] | Ask the device to identify itself by doing a slight movement or blink or beep for a given amount of seconds. |
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
CommandLockLevelsState |
DataState | ||
DiscreteRSSILevelState |
DiscreteState | good, low, normal, verylow | |
NameState |
DataState | ||
OnOffState |
DiscreteState | on, off | |
PriorityLockLevelState |
DiscreteState | comfortLevel1, comfortLevel2, comfortLevel3, comfortLevel4, environmentProtection, humanProtection, userLevel1, userLevel2 | |
PriorityLockOriginatorState |
DiscreteState | LSC, SAAC, SFC, UPS, externalGateway, localUser, myself, rain, security, temperature, timer, user, wind | |
PriorityLockTimerState |
ContinuousState | ||
RSSILevelState |
ContinuousState | ||
StatusState |
DiscreteState | available, unavailable |
SwingingShutter (ACTUATOR) — 30 commands, 15 states
Type IDs: 1572866 | Servers: atlantic_cozytouch, hi_kumo_europe, rexel | Controllable: io:SwingingShutterSomfyIOComponent | Profiles: StatefulCloseableSwingingShutter, StatefulCloseable, Closeable, StatefulOpenClose, OpenClose
Data Properties
core:identifyInterval=500
Commands
| Command | Parameters | Notes |
|---|---|---|
addLockLevel |
INT; INT (optional) | Add a command lock level on the device p1 : The lock level to add p2 : (optional) Duration in second of the lock Level. By default there is no expiration. |
advancedRefresh |
STRING: normal, advanced, custom; ARRAY (optional) | Refresh extra states |
close |
Fully close the device | |
delayedStopIdentify |
INT [1..254] | (IO-homecontrol specific) Ask the device to stop winking after a given number of seconds |
executeManufacturerProcedure |
STRING; OBJECT; OBJECT (optional) | execute manufacturer procedure command. p1: the procedure name p2: the params associated Example: p1 = "dead_man_up" p2 = {"duration": 42} |
getName |
Refresh the device internal name | |
identify |
Ask the device to identify itself by doing a slight movement or blink or beep | |
keepOneWayControllersAndDeleteNode |
Delete 2way key from actuator and delete the device. All one way controllers remain linked to the actuator. | |
my |
Set the device to a user pre-defined position | |
open |
Fully open the device | |
pairOneWayController |
STRING; INT [1..16] (optional) | Pair a one way controller to actuator. p1 : Payload of the QRCode associated to the one way controller p2 : channel (Optional - default : 1) |
readManufacturerData |
ARRAY | Read manufacturer data values from given names. Example: ["setting1","setting2"]. |
refreshMemorized1Position |
Refresh memorized 1 position state | |
removeLockLevel |
INT | Remove the command lock level on the device p1 : The lock level to remove |
resetLockLevels |
Remove all lock levels on the device | |
runManufacturerSettingsCommand |
STRING; OBJECT | Send a manufacturer configuration command. p1: The manufacturer configuration command to use p2: The arguments to send to this command |
sendIOKey |
Send the IO key to device. | |
setClosure |
INT [0..100] | Closure level (100%=fully close, 0%=open) |
setConfigState |
STRING: configuration, virgin, close, transmitting | Set the device in configuration state. p1: configuration mode. |
setMemorized1Position |
INT [0..100] | Set favorite position |
setName |
STRING | Change the device internal name. Name length may be subject to restrictions depending on the device and underlying protocol. |
setPosition |
STRING: my, memorized1, secured; INT [0..100] | Set the device to a pre-defined position (enum) or a relative position (0-100%) |
setSecuredPosition |
INT [0..100] | Set the relative position value (0-100%) to be used for the 'secured' position alias |
startIdentify |
Ask the device to start winking immediately for an unlimited amount of time | |
stop |
Stop the current actuator behavior (movement, sound or timer) | |
stopIdentify |
Ask the device to stop winking immediately | |
unpairAllOneWayControllers |
Unpair all one way controllers from actuator. | |
unpairAllOneWayControllersAndDeleteNode |
Unpair all one way controllers from actuator. Delete 2way key from actuator and delete the device. | |
unpairOneWayController |
STRING; INT [1..16] (optional) | Unpair a one way controller from actuator. p1 : Payload of the QRCode associated to the one way controller p2 : channel (Optional - default : 1) |
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 |
|---|---|---|---|
AdditionalStatusState |
DataState | ||
ClosureState |
ContinuousState | [0..100] | |
CommandLockLevelsState |
DataState | ||
DiscreteRSSILevelState |
DiscreteState | good, low, normal, verylow | |
ManufacturerDiagnosticsState |
DataState | ||
ManufacturerSettingsState |
DataState | ||
Memorized1PositionState |
ContinuousState | ||
NameState |
DataState | ||
OpenClosedState |
DiscreteState | open, closed | |
PriorityLockLevelState |
DiscreteState | comfortLevel1, comfortLevel2, comfortLevel3, comfortLevel4, environmentProtection, humanProtection, userLevel1, userLevel2 | |
PriorityLockOriginatorState |
DiscreteState | LSC, SAAC, SFC, UPS, externalGateway, localUser, myself, rain, security, temperature, timer, user, wind | |
PriorityLockTimerState |
ContinuousState | ||
RSSILevelState |
ContinuousState | ||
SecuredPositionState |
ContinuousState | ||
StatusState |
DiscreteState | available, unavailable |
SwingingShutter (ACTUATOR) — 27 commands, 13 states
Type IDs: 1587714 | Servers: atlantic_cozytouch, hi_kumo_europe, rexel | Controllable: io:DiscreteSwingingShutterSomfyIOComponent | Profiles: StatefulOpenCloseSwingingShutter, StatefulOpenClose, OpenClose
Data Properties
core:identifyInterval=500
Commands
| Command | Parameters | Notes |
|---|---|---|
addLockLevel |
INT; INT (optional) | Add a command lock level on the device p1 : The lock level to add p2 : (optional) Duration in second of the lock Level. By default there is no expiration. |
advancedRefresh |
STRING: normal, advanced, custom; ARRAY (optional) | Refresh extra states |
close |
Fully close the device | |
delayedStopIdentify |
INT [1..254] | (IO-homecontrol specific) Ask the device to stop winking after a given number of seconds |
executeManufacturerProcedure |
STRING; OBJECT; OBJECT (optional) | execute manufacturer procedure command. p1: the procedure name p2: the params associated Example: p1 = "dead_man_up" p2 = {"duration": 42} |
getName |
Refresh the device internal name | |
identify |
Ask the device to identify itself by doing a slight movement or blink or beep | |
keepOneWayControllersAndDeleteNode |
Delete 2way key from actuator and delete the device. All one way controllers remain linked to the actuator. | |
my |
Set the device to a user pre-defined position | |
open |
Fully open the device | |
pairOneWayController |
STRING; INT [1..16] (optional) | Pair a one way controller to actuator. p1 : Payload of the QRCode associated to the one way controller p2 : channel (Optional - default : 1) |
readManufacturerData |
ARRAY | Read manufacturer data values from given names. Example: ["setting1","setting2"]. |
refreshMemorized1Position |
Refresh memorized 1 position state | |
removeLockLevel |
INT | Remove the command lock level on the device p1 : The lock level to remove |
resetLockLevels |
Remove all lock levels on the device | |
runManufacturerSettingsCommand |
STRING; OBJECT | Send a manufacturer configuration command. p1: The manufacturer configuration command to use p2: The arguments to send to this command |
sendIOKey |
Send the IO key to device. | |
setConfigState |
STRING: configuration, virgin, close, transmitting | Set the device in configuration state. p1: configuration mode. |
setMemorized1Position |
INT [0..100] | Set favorite position |
setName |
STRING | Change the device internal name. Name length may be subject to restrictions depending on the device and underlying protocol. |
startIdentify |
Ask the device to start winking immediately for an unlimited amount of time | |
stop |
Stop the current actuator behavior (movement, sound or timer) | |
stopIdentify |
Ask the device to stop winking immediately | |
unpairAllOneWayControllers |
Unpair all one way controllers from actuator. | |
unpairAllOneWayControllersAndDeleteNode |
Unpair all one way controllers from actuator. Delete 2way key from actuator and delete the device. | |
unpairOneWayController |
STRING; INT [1..16] (optional) | Unpair a one way controller from actuator. p1 : Payload of the QRCode associated to the one way controller p2 : channel (Optional - default : 1) |
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 |
|---|---|---|---|
AdditionalStatusState |
DataState | ||
CommandLockLevelsState |
DataState | ||
DiscreteRSSILevelState |
DiscreteState | good, low, normal, verylow | |
ManufacturerDiagnosticsState |
DataState | ||
ManufacturerSettingsState |
DataState | ||
Memorized1PositionState |
ContinuousState | ||
NameState |
DataState | ||
OpenClosedState |
DiscreteState | open, closed | |
PriorityLockLevelState |
DiscreteState | comfortLevel1, comfortLevel2, comfortLevel3, comfortLevel4, environmentProtection, humanProtection, userLevel1, userLevel2 | |
PriorityLockOriginatorState |
DiscreteState | LSC, SAAC, SFC, UPS, externalGateway, localUser, myself, rain, security, temperature, timer, user, wind | |
PriorityLockTimerState |
ContinuousState | ||
RSSILevelState |
ContinuousState | ||
StatusState |
DiscreteState | available, unavailable |
SwingingShutter (ACTUATOR) — 29 commands, 13 states
Type IDs: 1572866 | Servers: somfy_europe | Controllable: io:SwingingShutterSomfyIOComponent | Profiles: StatefulCloseableSwingingShutter, StatefulCloseable, Closeable, StatefulOpenClose, OpenClose
Data Properties
core:identifyInterval=500
Commands
| Command | Parameters | Notes |
|---|---|---|
addLockLevel |
INT; INT (optional) | Add a command lock level on the device p1 : The lock level to add p2 : (optional) Duration in second of the lock Level. By default there is no expiration. |
advancedRefresh |
STRING: normal, advanced, custom; ARRAY (optional) | Refresh extra states |
close |
Fully close the device | |
delayedStopIdentify |
INT [1..254] | (IO-homecontrol specific) Ask the device to stop winking after a given number of seconds |
executeManufacturerProcedure |
STRING; OBJECT; OBJECT (optional) | execute manufacturer procedure command. p1: the procedure name p2: the params associated Example: p1 = "dead_man_up" p2 = {"duration": 42} |
getName |
Refresh the device internal name | |
identify |
Ask the device to identify itself by doing a slight movement or blink or beep | |
keepOneWayControllersAndDeleteNode |
Delete 2way key from actuator and delete the device. All one way controllers remain linked to the actuator. | |
my |
Set the device to a user pre-defined position | |
open |
Fully open the device | |
pairOneWayController |
STRING; INT [1..16] (optional) | Pair a one way controller to actuator. p1 : Payload of the QRCode associated to the one way controller p2 : channel (Optional - default : 1) |
readManufacturerData |
ARRAY | Read manufacturer data values from given names. Example: ["setting1","setting2"]. |
refreshMemorized1Position |
Refresh memorized 1 position state | |
removeLockLevel |
INT | Remove the command lock level on the device p1 : The lock level to remove |
resetLockLevels |
Remove all lock levels on the device | |
sendIOKey |
Send the IO key to device. | |
setClosure |
INT [0..100] | Closure level (100%=fully close, 0%=open) |
setConfigState |
STRING: configuration, virgin, close, transmitting | Set the device in configuration state. p1: configuration mode. |
setMemorized1Position |
INT [0..100] | Set favorite position |
setName |
STRING | Change the device internal name. Name length may be subject to restrictions depending on the device and underlying protocol. |
setPosition |
STRING: my, memorized1, secured; INT [0..100] | Set the device to a pre-defined position (enum) or a relative position (0-100%) |
setSecuredPosition |
INT [0..100] | Set the relative position value (0-100%) to be used for the 'secured' position alias |
startIdentify |
Ask the device to start winking immediately for an unlimited amount of time | |
stop |
Stop the current actuator behavior (movement, sound or timer) | |
stopIdentify |
Ask the device to stop winking immediately | |
unpairAllOneWayControllers |
Unpair all one way controllers from actuator. | |
unpairAllOneWayControllersAndDeleteNode |
Unpair all one way controllers from actuator. Delete 2way key from actuator and delete the device. | |
unpairOneWayController |
STRING; INT [1..16] (optional) | Unpair a one way controller from actuator. p1 : Payload of the QRCode associated to the one way controller p2 : channel (Optional - default : 1) |
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 |
|---|---|---|---|
AdditionalStatusState |
DataState | ||
ClosureState |
ContinuousState | [0..100] | |
CommandLockLevelsState |
DataState | ||
DiscreteRSSILevelState |
DiscreteState | good, low, normal, verylow | |
Memorized1PositionState |
ContinuousState | ||
NameState |
DataState | ||
OpenClosedState |
DiscreteState | open, closed | |
PriorityLockLevelState |
DiscreteState | comfortLevel1, comfortLevel2, comfortLevel3, comfortLevel4, environmentProtection, humanProtection, userLevel1, userLevel2 | |
PriorityLockOriginatorState |
DiscreteState | LSC, SAAC, SFC, UPS, externalGateway, localUser, myself, rain, security, temperature, timer, user, wind | |
PriorityLockTimerState |
ContinuousState | ||
RSSILevelState |
ContinuousState | ||
SecuredPositionState |
ContinuousState | ||
StatusState |
DiscreteState | available, unavailable |
SwingingShutter (ACTUATOR) — 26 commands, 11 states
Type IDs: 1587714 | Servers: somfy_europe | Controllable: io:DiscreteSwingingShutterSomfyIOComponent | Profiles: StatefulOpenCloseSwingingShutter, StatefulOpenClose, OpenClose
Data Properties
core:identifyInterval=500
Commands
| Command | Parameters | Notes |
|---|---|---|
addLockLevel |
INT; INT (optional) | Add a command lock level on the device p1 : The lock level to add p2 : (optional) Duration in second of the lock Level. By default there is no expiration. |
advancedRefresh |
STRING: normal, advanced, custom; ARRAY (optional) | Refresh extra states |
close |
Fully close the device | |
delayedStopIdentify |
INT [1..254] | (IO-homecontrol specific) Ask the device to stop winking after a given number of seconds |
executeManufacturerProcedure |
STRING; OBJECT; OBJECT (optional) | execute manufacturer procedure command. p1: the procedure name p2: the params associated Example: p1 = "dead_man_up" p2 = {"duration": 42} |
getName |
Refresh the device internal name | |
identify |
Ask the device to identify itself by doing a slight movement or blink or beep | |
keepOneWayControllersAndDeleteNode |
Delete 2way key from actuator and delete the device. All one way controllers remain linked to the actuator. | |
my |
Set the device to a user pre-defined position | |
open |
Fully open the device | |
pairOneWayController |
STRING; INT [1..16] (optional) | Pair a one way controller to actuator. p1 : Payload of the QRCode associated to the one way controller p2 : channel (Optional - default : 1) |
readManufacturerData |
ARRAY | Read manufacturer data values from given names. Example: ["setting1","setting2"]. |
refreshMemorized1Position |
Refresh memorized 1 position state | |
removeLockLevel |
INT | Remove the command lock level on the device p1 : The lock level to remove |
resetLockLevels |
Remove all lock levels on the device | |
sendIOKey |
Send the IO key to device. | |
setConfigState |
STRING: configuration, virgin, close, transmitting | Set the device in configuration state. p1: configuration mode. |
setMemorized1Position |
INT [0..100] | Set favorite position |
setName |
STRING | Change the device internal name. Name length may be subject to restrictions depending on the device and underlying protocol. |
startIdentify |
Ask the device to start winking immediately for an unlimited amount of time | |
stop |
Stop the current actuator behavior (movement, sound or timer) | |
stopIdentify |
Ask the device to stop winking immediately | |
unpairAllOneWayControllers |
Unpair all one way controllers from actuator. | |
unpairAllOneWayControllersAndDeleteNode |
Unpair all one way controllers from actuator. Delete 2way key from actuator and delete the device. | |
unpairOneWayController |
STRING; INT [1..16] (optional) | Unpair a one way controller from actuator. p1 : Payload of the QRCode associated to the one way controller p2 : channel (Optional - default : 1) |
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 |
|---|---|---|---|
AdditionalStatusState |
DataState | ||
CommandLockLevelsState |
DataState | ||
DiscreteRSSILevelState |
DiscreteState | good, low, normal, verylow | |
Memorized1PositionState |
ContinuousState | ||
NameState |
DataState | ||
OpenClosedState |
DiscreteState | open, closed | |
PriorityLockLevelState |
DiscreteState | comfortLevel1, comfortLevel2, comfortLevel3, comfortLevel4, environmentProtection, humanProtection, userLevel1, userLevel2 | |
PriorityLockOriginatorState |
DiscreteState | LSC, SAAC, SFC, UPS, externalGateway, localUser, myself, rain, security, temperature, timer, user, wind | |
PriorityLockTimerState |
ContinuousState | ||
RSSILevelState |
ContinuousState | ||
StatusState |
DiscreteState | available, unavailable |
TemperatureSensor (SENSOR) — 0 commands, 2 states
Type IDs: 267, 1442060, 1442316, 1835020 | Servers: atlantic_cozytouch, hi_kumo_europe, rexel, somfy_europe | Controllable: io:KizOThermRoomTemperatureSensor | Profiles: Temperature
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
StatusState |
DiscreteState | available, unavailable | |
TemperatureState |
ContinuousState | [-100.0..100.0] |
VenetianBlind/PositionableVenetianBlind (ACTUATOR) — 28 commands, 15 states
Type IDs: 65536 | Servers: atlantic_cozytouch, hi_kumo_europe, rexel, somfy_europe | Controllable: io:VenetianBlindIOComponent | Profiles: StatefulVenetianBlind, StatefulOrientableAndCloseable, OrientableAndCloseable, OpenClose
Data Properties
core:identifyInterval=500
Commands
| Command | Parameters | Notes |
|---|---|---|
addLockLevel |
INT; INT (optional) | Add a command lock level on the device p1 : The lock level to add p2 : (optional) Duration in second of the lock Level. By default there is no expiration. |
advancedRefresh |
STRING: normal, advanced, custom; ARRAY (optional) | Refresh extra states |
close |
Fully close the device | |
delayedStopIdentify |
INT [1..254] | (IO-homecontrol specific) Ask the device to stop winking after a given number of seconds |
down |
Move the device completely down | |
getName |
Refresh the device internal name | |
identify |
Ask the device to identify itself by doing a slight movement or blink or beep | |
my |
Set the device to a user pre-defined position | |
open |
Fully open the device | |
pairOneWayController |
STRING; INT [1..16] (optional) | Pair a one way controller to actuator. p1 : Payload of the QRCode associated to the one way controller p2 : channel (Optional - default : 1) |
refreshMemorized1Position |
Refresh memorized 1 position state | |
removeLockLevel |
INT | Remove the command lock level on the device p1 : The lock level to remove |
resetLockLevels |
Remove all lock levels on the device | |
setClosure |
INT [0..100] | Closure level (100%=fully close, 0%=open) |
setClosureAndOrientation |
INT [0..100]; INT [0..100] | Set both the closure level (0-100%) and relative slats orientation (0-100%) of the device |
setConfigState |
STRING: configuration, virgin, close, transmitting | Set the device in configuration state. p1: configuration mode. |
setMemorized1Position |
INT [0..100] | Set favorite position |
setName |
STRING | Change the device internal name. Name length may be subject to restrictions depending on the device and underlying protocol. |
setOrientation |
INT [0..100] | Set the relative orientation (0-100%) of the device slats |
setPosition |
STRING: my, memorized1, secured; INT [0..100] | Set the device to a pre-defined position (enum) or a relative position (0-100%) |
setSecuredPosition |
INT [0..100] | Set the relative position value (0-100%) to be used for the 'secured' position alias |
startIdentify |
Ask the device to start winking immediately for an unlimited amount of time | |
stop |
Stop the current actuator behavior (movement, sound or timer) | |
stopIdentify |
Ask the device to stop winking immediately | |
unpairAllOneWayControllers |
Unpair all one way controllers from actuator. | |
unpairOneWayController |
STRING; INT [1..16] (optional) | Unpair a one way controller from actuator. p1 : Payload of the QRCode associated to the one way controller p2 : channel (Optional - default : 1) |
up |
Move the device completely up | |
wink |
INT [1..254] | Ask the device to identify itself by doing a slight movement or blink or beep for a given amount of seconds. |
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
ClosureState |
ContinuousState | [0..100] | |
CommandLockLevelsState |
DataState | ||
DiscreteRSSILevelState |
DiscreteState | good, low, normal, verylow | |
Memorized1PositionState |
ContinuousState | ||
MovingState |
DiscreteState | false, true | |
NameState |
DataState | ||
OpenClosedState |
DiscreteState | open, closed | |
PriorityLockLevelState |
DiscreteState | comfortLevel1, comfortLevel2, comfortLevel3, comfortLevel4, environmentProtection, humanProtection, userLevel1, userLevel2 | |
PriorityLockOriginatorState |
DiscreteState | LSC, SAAC, SFC, UPS, externalGateway, localUser, myself, rain, security, temperature, timer, user, wind | |
PriorityLockTimerState |
ContinuousState | ||
RSSILevelState |
ContinuousState | ||
SecuredPositionState |
ContinuousState | ||
SlateOrientationState |
ContinuousState | [0..100] | |
StatusState |
DiscreteState | available, unavailable | |
TargetClosureState |
ContinuousState |
VentilationSystem/VentilationInlet (ACTUATOR) — 18 commands, 11 states
Type IDs: 1310720, 1310976 | Servers: atlantic_cozytouch, hi_kumo_europe, rexel, somfy_europe | Controllable: io:VentilationPointIOComponent | Profiles: SwitchableVentilation, Switchable
Data Properties
core:identifyInterval=500
Commands
| Command | Parameters | Notes |
|---|---|---|
addLockLevel |
INT; INT (optional) | Add a command lock level on the device p1 : The lock level to add p2 : (optional) Duration in second of the lock Level. By default there is no expiration. |
advancedRefresh |
STRING: normal, advanced, custom; ARRAY (optional) | Refresh extra states |
delayedStopIdentify |
INT [1..254] | (IO-homecontrol specific) Ask the device to stop winking after a given number of seconds |
getName |
Refresh the device internal name | |
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 | |
pairOneWayController |
STRING; INT [1..16] (optional) | Pair a one way controller to actuator. p1 : Payload of the QRCode associated to the one way controller p2 : channel (Optional - default : 1) |
removeLockLevel |
INT | Remove the command lock level on the device p1 : The lock level to remove |
resetLockLevels |
Remove all lock levels on the device | |
setAirInput |
INT [0..100] | Set ventilation strength (%) |
setConfigState |
STRING: configuration, virgin, close, transmitting | Set the device in configuration state. p1: configuration mode. |
setName |
STRING | Change the device internal name. Name length may be subject to restrictions depending on the device and underlying protocol. |
startIdentify |
Ask the device to start winking immediately for an unlimited amount of time | |
stopIdentify |
Ask the device to stop winking immediately | |
unpairAllOneWayControllers |
Unpair all one way controllers from actuator. | |
unpairOneWayController |
STRING; INT [1..16] (optional) | Unpair a one way controller from actuator. p1 : Payload of the QRCode associated to the one way controller p2 : channel (Optional - default : 1) |
wink |
INT [1..254] | Ask the device to identify itself by doing a slight movement or blink or beep for a given amount of seconds. |
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
AirInputState |
ContinuousState | ||
CommandLockLevelsState |
DataState | ||
DiscreteRSSILevelState |
DiscreteState | good, low, normal, verylow | |
Memorized1PositionState |
ContinuousState | ||
NameState |
DataState | ||
PriorityLockLevelState |
DiscreteState | comfortLevel1, comfortLevel2, comfortLevel3, comfortLevel4, environmentProtection, humanProtection, userLevel1, userLevel2 | |
PriorityLockOriginatorState |
DiscreteState | LSC, SAAC, SFC, UPS, externalGateway, localUser, myself, rain, security, temperature, timer, user, wind | |
PriorityLockTimerState |
ContinuousState | ||
RSSILevelState |
ContinuousState | ||
SecuredPositionState |
ContinuousState | ||
StatusState |
DiscreteState | available, unavailable |
VentilationSystem/VentilationTransfer (ACTUATOR) — 18 commands, 11 states
Type IDs: 1311232 | Servers: atlantic_cozytouch, hi_kumo_europe, rexel, somfy_europe | Controllable: io:VentilationPointAirTransferIOComponent | Profiles: SwitchableVentilation, Switchable
Data Properties
core:identifyInterval=500
Commands
| Command | Parameters | Notes |
|---|---|---|
addLockLevel |
INT; INT (optional) | Add a command lock level on the device p1 : The lock level to add p2 : (optional) Duration in second of the lock Level. By default there is no expiration. |
advancedRefresh |
STRING: normal, advanced, custom; ARRAY (optional) | Refresh extra states |
delayedStopIdentify |
INT [1..254] | (IO-homecontrol specific) Ask the device to stop winking after a given number of seconds |
getName |
Refresh the device internal name | |
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 | |
pairOneWayController |
STRING; INT [1..16] (optional) | Pair a one way controller to actuator. p1 : Payload of the QRCode associated to the one way controller p2 : channel (Optional - default : 1) |
removeLockLevel |
INT | Remove the command lock level on the device p1 : The lock level to remove |
resetLockLevels |
Remove all lock levels on the device | |
setAirTransfer |
INT [0..100] | Set ventilation strength (%) |
setConfigState |
STRING: configuration, virgin, close, transmitting | Set the device in configuration state. p1: configuration mode. |
setName |
STRING | Change the device internal name. Name length may be subject to restrictions depending on the device and underlying protocol. |
startIdentify |
Ask the device to start winking immediately for an unlimited amount of time | |
stopIdentify |
Ask the device to stop winking immediately | |
unpairAllOneWayControllers |
Unpair all one way controllers from actuator. | |
unpairOneWayController |
STRING; INT [1..16] (optional) | Unpair a one way controller from actuator. p1 : Payload of the QRCode associated to the one way controller p2 : channel (Optional - default : 1) |
wink |
INT [1..254] | Ask the device to identify itself by doing a slight movement or blink or beep for a given amount of seconds. |
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
AirTransferState |
ContinuousState | ||
CommandLockLevelsState |
DataState | ||
DiscreteRSSILevelState |
DiscreteState | good, low, normal, verylow | |
Memorized1PositionState |
ContinuousState | ||
NameState |
DataState | ||
PriorityLockLevelState |
DiscreteState | comfortLevel1, comfortLevel2, comfortLevel3, comfortLevel4, environmentProtection, humanProtection, userLevel1, userLevel2 | |
PriorityLockOriginatorState |
DiscreteState | LSC, SAAC, SFC, UPS, externalGateway, localUser, myself, rain, security, temperature, timer, user, wind | |
PriorityLockTimerState |
ContinuousState | ||
RSSILevelState |
ContinuousState | ||
SecuredPositionState |
ContinuousState | ||
StatusState |
DiscreteState | available, unavailable |
VentilationSystem/VentilationOutlet (ACTUATOR) — 18 commands, 12 states
Type IDs: 1311488 | Servers: atlantic_cozytouch, hi_kumo_europe, rexel, somfy_europe | Controllable: io:VentilationPointAirOutletIOComponent | Profiles: SwitchableVentilation, AirOutputLevelSensor, Switchable
Data Properties
core:identifyInterval=500
Commands
| Command | Parameters | Notes |
|---|---|---|
addLockLevel |
INT; INT (optional) | Add a command lock level on the device p1 : The lock level to add p2 : (optional) Duration in second of the lock Level. By default there is no expiration. |
advancedRefresh |
STRING: normal, advanced, custom; ARRAY (optional) | Refresh extra states |
delayedStopIdentify |
INT [1..254] | (IO-homecontrol specific) Ask the device to stop winking after a given number of seconds |
getName |
Refresh the device internal name | |
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 | |
pairOneWayController |
STRING; INT [1..16] (optional) | Pair a one way controller to actuator. p1 : Payload of the QRCode associated to the one way controller p2 : channel (Optional - default : 1) |
removeLockLevel |
INT | Remove the command lock level on the device p1 : The lock level to remove |
resetLockLevels |
Remove all lock levels on the device | |
setAirOutput |
INT [0..100] | Set ventilation strength (%) |
setConfigState |
STRING: configuration, virgin, close, transmitting | Set the device in configuration state. p1: configuration mode. |
setName |
STRING | Change the device internal name. Name length may be subject to restrictions depending on the device and underlying protocol. |
startIdentify |
Ask the device to start winking immediately for an unlimited amount of time | |
stopIdentify |
Ask the device to stop winking immediately | |
unpairAllOneWayControllers |
Unpair all one way controllers from actuator. | |
unpairOneWayController |
STRING; INT [1..16] (optional) | Unpair a one way controller from actuator. p1 : Payload of the QRCode associated to the one way controller p2 : channel (Optional - default : 1) |
wink |
INT [1..254] | Ask the device to identify itself by doing a slight movement or blink or beep for a given amount of seconds. |
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
AirOutputLevelState |
ContinuousState | [0..100] | |
AirOutputState |
ContinuousState | ||
CommandLockLevelsState |
DataState | ||
DiscreteRSSILevelState |
DiscreteState | good, low, normal, verylow | |
Memorized1PositionState |
ContinuousState | ||
NameState |
DataState | ||
PriorityLockLevelState |
DiscreteState | comfortLevel1, comfortLevel2, comfortLevel3, comfortLevel4, environmentProtection, humanProtection, userLevel1, userLevel2 | |
PriorityLockOriginatorState |
DiscreteState | LSC, SAAC, SFC, UPS, externalGateway, localUser, myself, rain, security, temperature, timer, user, wind | |
PriorityLockTimerState |
ContinuousState | ||
RSSILevelState |
ContinuousState | ||
SecuredPositionState |
ContinuousState | ||
StatusState |
DiscreteState | available, unavailable |
WaterHeatingSystem/AtlanticPassAPCDHW (ACTUATOR) — 17 commands, 11 states
Type IDs: 1442060, 1442316 | Servers: atlantic_cozytouch, hi_kumo_europe, rexel, somfy_europe | Controllable: io:AtlanticPassAPCDHWComponent | Profiles: DHWThermostatTargetReader
Commands
| Command | Parameters | Notes |
|---|---|---|
addLockLevel |
INT; INT (optional) | Add a command lock level on the device p1 : The lock level to add p2 : (optional) Duration in second of the lock Level. By default there is no expiration. |
advancedRefresh |
STRING: normal, advanced, custom; ARRAY (optional) | Refresh extra states |
refreshComfortTargetDHWTemperature |
Refresh comfort target DHW temperature. | |
refreshDHWConfiguration |
Refesh the ECS configuration | |
refreshDHWDerogationAvailability |
Check if Domestic Hot Water system supports derogations | |
refreshDHWOnOffState |
Check if DHW module is on or off | |
refreshEcoTargetDHWTemperature |
Refresh eco target DHW temperature. | |
refreshPassAPCDHWMode |
Refresh DHW mode. | |
refreshPassAPCDHWProfile |
Refresh DHW profile. | |
refreshTargetDHWTemperature |
Refresh the target DHW temperature | |
removeLockLevel |
INT | Remove the command lock level on the device p1 : The lock level to remove |
resetLockLevels |
Remove all lock levels on the device | |
setBoostOnOffState |
STRING: on, off | Switch on or switch off the boost mode |
setComfortTargetDHWTemperature |
FLOAT [8.0..80.0] | Set the comfort mode target temperature of Domestic Hot Water system |
setDHWOnOffState |
STRING: off, on | Switch on or switch off the DHW module |
setEcoTargetDHWTemperature |
FLOAT [8.0..80.0] | Set the eco mode target temperature of Domestic Hot Water system |
setPassAPCDHWMode |
STRING: comfort, eco, externalScheduling, internalScheduling, manu | Set the Domestic Hot Water system mode |
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
BoostOnOffState |
DiscreteState | off, on | |
ComfortTargetDHWTemperatureState |
ContinuousState | ||
CommandLockLevelsState |
DataState | ||
DHWDerogationAvailabilityState |
DiscreteState | available, unavailable | |
DHWOnOffState |
DiscreteState | off, on | |
EcoTargetDHWTemperatureState |
ContinuousState | ||
PassAPCDHWConfigurationState |
DiscreteState | cumulated, snapshot | |
PassAPCDHWModeState |
DiscreteState | comfort, eco, externalScheduling, internalScheduling, manu, peakAndOffPeakScheduling, peakAndOffPeakTimes, stop | |
PassAPCDHWProfileState |
DiscreteState | absence, comfort, derogation, eco, externalSetpoint, frostprotection, manu, other, stop | |
StatusState |
DiscreteState | available, unavailable | |
TargetDHWTemperatureState |
ContinuousState | [38.0..60.0] |
Window/PositionableWindow (ACTUATOR) — 19 commands, 10 states
Type IDs: 262144 | Servers: atlantic_cozytouch, hi_kumo_europe, rexel, somfy_europe | Controllable: io:WindowOpenerGenericIOComponent | Profiles: StatefulCloseableWindow, StatefulCloseable, Closeable, StatefulOpenClose, OpenClose
Data Properties
core:identifyInterval=500
Commands
| Command | Parameters | Notes |
|---|---|---|
addLockLevel |
INT; INT (optional) | Add a command lock level on the device p1 : The lock level to add p2 : (optional) Duration in second of the lock Level. By default there is no expiration. |
advancedRefresh |
STRING: normal, advanced, custom; ARRAY (optional) | Refresh extra states |
close |
Fully close the device | |
delayedStopIdentify |
INT [1..254] | (IO-homecontrol specific) Ask the device to stop winking after a given number of seconds |
getName |
Refresh the device internal name | |
identify |
Ask the device to identify itself by doing a slight movement or blink or beep | |
open |
Fully open the device | |
pairOneWayController |
STRING; INT [1..16] (optional) | Pair a one way controller to actuator. p1 : Payload of the QRCode associated to the one way controller p2 : channel (Optional - default : 1) |
removeLockLevel |
INT | Remove the command lock level on the device p1 : The lock level to remove |
resetLockLevels |
Remove all lock levels on the device | |
setClosure |
INT [0..100] | Closure level (100%=fully close, 0%=open) |
setConfigState |
STRING: configuration, virgin, close, transmitting | Set the device in configuration state. p1: configuration mode. |
setName |
STRING | Change the device internal name. Name length may be subject to restrictions depending on the device and underlying protocol. |
startIdentify |
Ask the device to start winking immediately for an unlimited amount of time | |
stop |
Stop the current actuator behavior (movement, sound or timer) | |
stopIdentify |
Ask the device to stop winking immediately | |
unpairAllOneWayControllers |
Unpair all one way controllers from actuator. | |
unpairOneWayController |
STRING; INT [1..16] (optional) | Unpair a one way controller from actuator. p1 : Payload of the QRCode associated to the one way controller p2 : channel (Optional - default : 1) |
wink |
INT [1..254] | Ask the device to identify itself by doing a slight movement or blink or beep for a given amount of seconds. |
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
ClosureState |
ContinuousState | [0..100] | |
CommandLockLevelsState |
DataState | ||
DiscreteRSSILevelState |
DiscreteState | good, low, normal, verylow | |
NameState |
DataState | ||
OpenClosedState |
DiscreteState | open, closed | |
PriorityLockLevelState |
DiscreteState | comfortLevel1, comfortLevel2, comfortLevel3, comfortLevel4, environmentProtection, humanProtection, userLevel1, userLevel2 | |
PriorityLockOriginatorState |
DiscreteState | LSC, SAAC, SFC, UPS, externalGateway, localUser, myself, rain, security, temperature, timer, user, wind | |
PriorityLockTimerState |
ContinuousState | ||
RSSILevelState |
ContinuousState | ||
StatusState |
DiscreteState | available, unavailable |
Window/PositionableTiltedWindow (ACTUATOR) — 23 commands, 12 states
Type IDs: 262145, 262401 | Servers: atlantic_cozytouch, hi_kumo_europe, rexel, somfy_europe | Controllable: io:WindowOpenerVeluxIOComponent | Profiles: StatefulCloseableWindow, StatefulCloseable, Closeable, StatefulOpenClose, OpenClose
Data Properties
core:identifyInterval=500
Commands
| Command | Parameters | Notes |
|---|---|---|
addLockLevel |
INT; INT (optional) | Add a command lock level on the device p1 : The lock level to add p2 : (optional) Duration in second of the lock Level. By default there is no expiration. |
advancedRefresh |
STRING: normal, advanced, custom; ARRAY (optional) | Refresh extra states |
close |
Fully close the device | |
delayedStopIdentify |
INT [1..254] | (IO-homecontrol specific) Ask the device to stop winking after a given number of seconds |
getName |
Refresh the device internal name | |
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 | |
pairOneWayController |
STRING; INT [1..16] (optional) | Pair a one way controller to actuator. p1 : Payload of the QRCode associated to the one way controller p2 : channel (Optional - default : 1) |
removeLockLevel |
INT | Remove the command lock level on the device p1 : The lock level to remove |
resetLockLevels |
Remove all lock levels on the device | |
saveAlias |
STRING | Allow to send an order for the product to save the current state of the alias. |
setClosure |
INT [0..100] | Closure level (100%=fully close, 0%=open) |
setClosureAndLinearSpeed |
INT [0..100]; STRING: lowspeed (optional) | Set the device to a closure level (0-100%) with an optional given speed |
setConfigState |
STRING: configuration, virgin, close, transmitting | Set the device in configuration state. p1: configuration mode. |
setName |
STRING | Change the device internal name. Name length may be subject to restrictions depending on the device and underlying protocol. |
setPositionAndLinearSpeed |
STRING: my; INT [0..100]; STRING: lowspeed (optional) | Set the device to a pre-defined position (enum) or a relative position (0-100%) with a given speed |
startIdentify |
Ask the device to start winking immediately for an unlimited amount of time | |
stop |
Stop the current actuator behavior (movement, sound or timer) | |
stopIdentify |
Ask the device to stop winking immediately | |
unpairAllOneWayControllers |
Unpair all one way controllers from actuator. | |
unpairOneWayController |
STRING; INT [1..16] (optional) | Unpair a one way controller from actuator. p1 : Payload of the QRCode associated to the one way controller p2 : channel (Optional - default : 1) |
wink |
INT [1..254] | Ask the device to identify itself by doing a slight movement or blink or beep for a given amount of seconds. |
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
BatteryDiscreteLevelState |
DiscreteState | good, medium, low, critical | |
ClosureState |
ContinuousState | [0..100] | |
CommandLockLevelsState |
DataState | ||
DiscreteRSSILevelState |
DiscreteState | good, low, normal, verylow | |
NameState |
DataState | ||
OpenClosedState |
DiscreteState | open, closed | |
PriorityLockLevelState |
DiscreteState | comfortLevel1, comfortLevel2, comfortLevel3, comfortLevel4, environmentProtection, humanProtection, userLevel1, userLevel2 | |
PriorityLockOriginatorState |
DiscreteState | LSC, SAAC, SFC, UPS, externalGateway, localUser, myself, rain, security, temperature, timer, user, wind | |
PriorityLockTimerState |
ContinuousState | ||
RSSILevelState |
ContinuousState | ||
ReachedAliasesState |
DataState | ||
StatusState |
DiscreteState | available, unavailable |
Window/PositionableSlidingWindow (ACTUATOR) — 25 commands, 11 states
Type IDs: 1769472 | Servers: atlantic_cozytouch, hi_kumo_europe, rexel, somfy_europe | Controllable: io:PositionableSlidingWindowComponent | Profiles: StatefulCloseableSlidingWindow, StatefulCloseable, Closeable, StatefulOpenClose, OpenClose
Data Properties
core:identifyInterval=500
Commands
| Command | Parameters | Notes |
|---|---|---|
addLockLevel |
INT; INT (optional) | Add a command lock level on the device p1 : The lock level to add p2 : (optional) Duration in second of the lock Level. By default there is no expiration. |
advancedRefresh |
STRING: normal, advanced, custom; ARRAY (optional) | Refresh extra states |
close |
Fully close the device | |
delayedStopIdentify |
INT [1..254] | (IO-homecontrol specific) Ask the device to stop winking after a given number of seconds |
getName |
Refresh the device internal name | |
identify |
Ask the device to identify itself by doing a slight movement or blink or beep | |
my |
Set the device to a user pre-defined position | |
open |
Fully open the device | |
pairOneWayController |
STRING; INT [1..16] (optional) | Pair a one way controller to actuator. p1 : Payload of the QRCode associated to the one way controller p2 : channel (Optional - default : 1) |
refreshMemorized1Position |
Refresh memorized 1 position state | |
removeLockLevel |
INT | Remove the command lock level on the device p1 : The lock level to remove |
resetLockLevels |
Remove all lock levels on the device | |
setClosure |
INT [0..100] | Closure level (100%=fully close, 0%=open) |
setClosureAndLinearSpeed |
INT [0..100]; STRING: lowspeed (optional) | Set the device to a closure level (0-100%) with an optional given speed |
setConfigState |
STRING: configuration, virgin, close, transmitting | Set the device in configuration state. p1: configuration mode. |
setMemorized1Position |
INT [0..100] | Set favorite position |
setName |
STRING | Change the device internal name. Name length may be subject to restrictions depending on the device and underlying protocol. |
setPosition |
STRING: my; INT [0..100] | Set the device to a pre-defined position (enum) or a relative position (0-100%) |
setPositionAndLinearSpeed |
STRING: my; INT [0..100]; STRING: lowspeed (optional) | Set the device to a pre-defined position (enum) or a relative position (0-100%) with a given speed |
startIdentify |
Ask the device to start winking immediately for an unlimited amount of time | |
stop |
Stop the current actuator behavior (movement, sound or timer) | |
stopIdentify |
Ask the device to stop winking immediately | |
unpairAllOneWayControllers |
Unpair all one way controllers from actuator. | |
unpairOneWayController |
STRING; INT [1..16] (optional) | Unpair a one way controller from actuator. p1 : Payload of the QRCode associated to the one way controller p2 : channel (Optional - default : 1) |
wink |
INT [1..254] | Ask the device to identify itself by doing a slight movement or blink or beep for a given amount of seconds. |
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
ClosureState |
ContinuousState | [0..100] | |
CommandLockLevelsState |
DataState | ||
DiscreteRSSILevelState |
DiscreteState | good, low, normal, verylow | |
Memorized1PositionState |
ContinuousState | ||
NameState |
DataState | ||
OpenClosedState |
DiscreteState | open, closed | |
PriorityLockLevelState |
DiscreteState | comfortLevel1, comfortLevel2, comfortLevel3, comfortLevel4, environmentProtection, humanProtection, userLevel1, userLevel2 | |
PriorityLockOriginatorState |
DiscreteState | LSC, SAAC, SFC, UPS, externalGateway, localUser, myself, rain, security, temperature, timer, user, wind | |
PriorityLockTimerState |
ContinuousState | ||
RSSILevelState |
ContinuousState | ||
StatusState |
DiscreteState | available, unavailable |
Window/PositionableAndLockableSlidingWindow (ACTUATOR) — 37 commands, 20 states
Type IDs: 1769730, 2199025025282 | Servers: atlantic_cozytouch, hi_kumo_europe, rexel | Controllable: io:PositionableAndLockableSlidingWindowComponent | Profiles: StatefulCloseableSlidingWindow, StatefulCloseable, Closeable, StatefulLock, LockStatus, Lock, OpenClose
Data Properties
core:identifyInterval=500
Commands
| Command | Parameters | Notes |
|---|---|---|
activateTimer |
activate the timer | |
addLockLevel |
INT; INT (optional) | Add a command lock level on the device p1 : The lock level to add p2 : (optional) Duration in second of the lock Level. By default there is no expiration. |
advancedRefresh |
STRING: normal, advanced, custom; ARRAY (optional) | Refresh extra states |
close |
Fully close the device | |
deactivateTimer |
Deactivate device internal timer | |
delayedStopIdentify |
INT [1..254] | (IO-homecontrol specific) Ask the device to stop winking after a given number of seconds |
executeManufacturerProcedure |
STRING; OBJECT; OBJECT (optional) | execute manufacturer procedure command. p1: the procedure name p2: the params associated Example: p1 = "dead_man_up" p2 = {"duration": 42} |
getName |
Refresh the device internal name | |
identify |
Ask the device to identify itself by doing a slight movement or blink or beep | |
keepOneWayControllersAndDeleteNode |
Delete 2way key from actuator and delete the device. All one way controllers remain linked to the actuator. | |
lock |
Lock the device | |
my |
Set the device to a user pre-defined position | |
open |
Fully open the device | |
pairOneWayController |
STRING; INT [1..16] (optional) | Pair a one way controller to actuator. p1 : Payload of the QRCode associated to the one way controller p2 : channel (Optional - default : 1) |
readManufacturerData |
ARRAY | Read manufacturer data values from given names. Example: ["setting1","setting2"]. |
refreshMemorized1Position |
Refresh memorized 1 position state | |
removeLockLevel |
INT | Remove the command lock level on the device p1 : The lock level to remove |
resetLockLevels |
Remove all lock levels on the device | |
runManufacturerSettingsCommand |
STRING; OBJECT | Send a manufacturer configuration command. p1: The manufacturer configuration command to use p2: The arguments to send to this command |
sendIOKey |
Send the IO key to device. | |
setClosure |
INT [0..100] | Closure level (100%=fully close, 0%=open) |
setClosureAndLinearSpeed |
INT [0..100]; STRING: lowspeed (optional) | Set the device to a closure level (0-100%) with an optional given speed |
setConfigState |
STRING: configuration, virgin, close, transmitting | Set the device in configuration state. p1: configuration mode. |
setMemorized1Position |
INT [0..100] | Set favorite position |
setName |
STRING | Change the device internal name. Name length may be subject to restrictions depending on the device and underlying protocol. |
setPosition |
STRING: my, securedVentilation; INT [0..100] | Set the device to a pre-defined position (enum) or a relative position (0-100%) |
setPositionAndLinearSpeed |
STRING: my, securedVentilation; INT [0..100]; STRING: lowspeed (optional) | Set the device to a pre-defined position (enum) or a relative position (0-100%) with a given speed |
setTimer |
INT [0..65535] | set the duration in second of the timer |
startIdentify |
Ask the device to start winking immediately for an unlimited amount of time | |
stop |
Stop the current actuator behavior (movement, sound or timer) | |
stopIdentify |
Ask the device to stop winking immediately | |
unlock |
Unlock the device | |
unpairAllOneWayControllers |
Unpair all one way controllers from actuator. | |
unpairAllOneWayControllersAndDeleteNode |
Unpair all one way controllers from actuator. Delete 2way key from actuator and delete the device. | |
unpairOneWayController |
STRING; INT [1..16] (optional) | Unpair a one way controller from actuator. p1 : Payload of the QRCode associated to the one way controller p2 : channel (Optional - default : 1) |
wink |
INT [1..254] | Ask the device to identify itself by doing a slight movement or blink or beep for a given amount of seconds. |
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 |
|---|---|---|---|
AdditionalStatusState |
DataState | ||
ClosureState |
ContinuousState | [0..100] | |
CommandLockLevelsState |
DataState | ||
DiscreteRSSILevelState |
DiscreteState | good, low, normal, verylow | |
LockedUnlockedState |
DiscreteState | locked, unlocked | |
ManufacturerDiagnosticsState |
DataState | ||
ManufacturerSettingsState |
DataState | ||
Memorized1PositionState |
ContinuousState | ||
NameState |
DataState | ||
OpenClosedSecuredVentilationState |
DiscreteState | open, securedVentilation, closed | |
OpeningDirectionState |
DiscreteState | left, right | |
PriorityLockLevelState |
DiscreteState | comfortLevel1, comfortLevel2, comfortLevel3, comfortLevel4, environmentProtection, humanProtection, userLevel1, userLevel2 | |
PriorityLockOriginatorState |
DiscreteState | LSC, SAAC, SFC, UPS, externalGateway, localUser, myself, rain, security, temperature, timer, user, wind | |
PriorityLockTimerState |
ContinuousState | ||
RSSILevelState |
ContinuousState | ||
RemainingTimeState |
ContinuousState | ||
SecuredVentilationFeatureState |
DiscreteState | enabled, disabled | |
StatusState |
DiscreteState | available, unavailable | |
TimerActivationState |
DataState | ||
TimerState |
ContinuousState |
Window/PositionableAndLockableSlidingWindow (ACTUATOR) — 36 commands, 18 states
Type IDs: 1769730, 2199025025282 | Servers: somfy_europe | Controllable: io:PositionableAndLockableSlidingWindowComponent | Profiles: StatefulCloseableSlidingWindow, StatefulCloseable, Closeable, StatefulLock, LockStatus, Lock, OpenClose
Data Properties
core:identifyInterval=500
Commands
| Command | Parameters | Notes |
|---|---|---|
activateTimer |
activate the timer | |
addLockLevel |
INT; INT (optional) | Add a command lock level on the device p1 : The lock level to add p2 : (optional) Duration in second of the lock Level. By default there is no expiration. |
advancedRefresh |
STRING: normal, advanced, custom; ARRAY (optional) | Refresh extra states |
close |
Fully close the device | |
deactivateTimer |
Deactivate device internal timer | |
delayedStopIdentify |
INT [1..254] | (IO-homecontrol specific) Ask the device to stop winking after a given number of seconds |
executeManufacturerProcedure |
STRING; OBJECT; OBJECT (optional) | execute manufacturer procedure command. p1: the procedure name p2: the params associated Example: p1 = "dead_man_up" p2 = {"duration": 42} |
getName |
Refresh the device internal name | |
identify |
Ask the device to identify itself by doing a slight movement or blink or beep | |
keepOneWayControllersAndDeleteNode |
Delete 2way key from actuator and delete the device. All one way controllers remain linked to the actuator. | |
lock |
Lock the device | |
my |
Set the device to a user pre-defined position | |
open |
Fully open the device | |
pairOneWayController |
STRING; INT [1..16] (optional) | Pair a one way controller to actuator. p1 : Payload of the QRCode associated to the one way controller p2 : channel (Optional - default : 1) |
readManufacturerData |
ARRAY | Read manufacturer data values from given names. Example: ["setting1","setting2"]. |
refreshMemorized1Position |
Refresh memorized 1 position state | |
removeLockLevel |
INT | Remove the command lock level on the device p1 : The lock level to remove |
resetLockLevels |
Remove all lock levels on the device | |
sendIOKey |
Send the IO key to device. | |
setClosure |
INT [0..100] | Closure level (100%=fully close, 0%=open) |
setClosureAndLinearSpeed |
INT [0..100]; STRING: lowspeed (optional) | Set the device to a closure level (0-100%) with an optional given speed |
setConfigState |
STRING: configuration, virgin, close, transmitting | Set the device in configuration state. p1: configuration mode. |
setMemorized1Position |
INT [0..100] | Set favorite position |
setName |
STRING | Change the device internal name. Name length may be subject to restrictions depending on the device and underlying protocol. |
setPosition |
STRING: my, securedVentilation; INT [0..100] | Set the device to a pre-defined position (enum) or a relative position (0-100%) |
setPositionAndLinearSpeed |
STRING: my, securedVentilation; INT [0..100]; STRING: lowspeed (optional) | Set the device to a pre-defined position (enum) or a relative position (0-100%) with a given speed |
setTimer |
INT [0..65535] | set the duration in second of the timer |
startIdentify |
Ask the device to start winking immediately for an unlimited amount of time | |
stop |
Stop the current actuator behavior (movement, sound or timer) | |
stopIdentify |
Ask the device to stop winking immediately | |
unlock |
Unlock the device | |
unpairAllOneWayControllers |
Unpair all one way controllers from actuator. | |
unpairAllOneWayControllersAndDeleteNode |
Unpair all one way controllers from actuator. Delete 2way key from actuator and delete the device. | |
unpairOneWayController |
STRING; INT [1..16] (optional) | Unpair a one way controller from actuator. p1 : Payload of the QRCode associated to the one way controller p2 : channel (Optional - default : 1) |
wink |
INT [1..254] | Ask the device to identify itself by doing a slight movement or blink or beep for a given amount of seconds. |
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 |
|---|---|---|---|
AdditionalStatusState |
DataState | ||
ClosureState |
ContinuousState | [0..100] | |
CommandLockLevelsState |
DataState | ||
DiscreteRSSILevelState |
DiscreteState | good, low, normal, verylow | |
LockedUnlockedState |
DiscreteState | locked, unlocked | |
Memorized1PositionState |
ContinuousState | ||
NameState |
DataState | ||
OpenClosedSecuredVentilationState |
DiscreteState | open, securedVentilation, closed | |
OpeningDirectionState |
DiscreteState | left, right | |
PriorityLockLevelState |
DiscreteState | comfortLevel1, comfortLevel2, comfortLevel3, comfortLevel4, environmentProtection, humanProtection, userLevel1, userLevel2 | |
PriorityLockOriginatorState |
DiscreteState | LSC, SAAC, SFC, UPS, externalGateway, localUser, myself, rain, security, temperature, timer, user, wind | |
PriorityLockTimerState |
ContinuousState | ||
RSSILevelState |
ContinuousState | ||
RemainingTimeState |
ContinuousState | ||
SecuredVentilationFeatureState |
DiscreteState | enabled, disabled | |
StatusState |
DiscreteState | available, unavailable | |
TimerActivationState |
DataState | ||
TimerState |
ContinuousState |
JSW
1 device types.
Camera/JSWCamera (ACTUATOR) — 12 commands, 2 states
Type IDs: 0 | Servers: rexel, somfy_europe | Controllable: jsw:CameraController | Profiles: Specific
Commands
| Command | Parameters | Notes |
|---|---|---|
connect |
Open a new session on the camera and return a session token (The token is returned asynchronously in a JSWConnectTokenObtainedEvent) | |
deleteRecordedFile |
INT | Delete an recorded file p1: event time of a recorded file, obtained from returning value of listRecordedFiles command |
disconnect |
STRING | Close a camera session p1: token obtained by "connect" command (The session token is invalidated after using this command) |
downloadRecordedFile |
INT | Allow to get an URL to download a recorded file p1: event time of a recorded file, obtained from listRecordedFiles command (The URL is returned asynchronously in a DownloadRecordedFileEvent) |
getSessionStatus |
STRING | Refresh the camera status state p1:token obtained by "connect" command |
listRecordedFiles |
INT; INT (optional) | List recorded files in a given time period p1: start_Time -> unix time format (UTC) p2: end_Time -> unix time format (UTC) - optional field (defaults to now) (The list is returned asynchronously in a ListRecordedFilesEvent) |
playJSWRecordedFile |
INT; STRING | Play a recorded file p1: event time of a recorded file, obtained from listRecordedFiles command p2: token obtained by "connect" command |
setPassword |
STRING (sensitive); STRING (sensitive) | Change the current password p1:old password p2:new password |
startJSWLiveVideo |
STRING | Start a live video and get an URL for live streaming p1: token obtained by "connect" command |
startJSWRecording |
Start recording a video. Uses a temporary session for 1 minute. | |
stopJSWLiveVideo |
STRING | Stop live video streaming p1: token obtained by "connect" command, same token that was used for startJSWLiveVideoCommand |
stopJSWPlayRecordedFile |
STRING | Stop playing a recorded file p1: token obtained by "connect" command, same token that was used for playJSWRecordedFileCommand |
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
FreeMemoryState |
ContinuousState | ||
TotalMemoryState |
ContinuousState |
KNX
50 device types.
AirSensor/CO2Sensor (SENSOR) — 1 commands, 1 states
Type IDs: 562949953427201 | Servers: rexel | Controllable: knx:CO2SensorKNXComponent | Profiles: CO2Concentration
Commands
| Command | Parameters | Notes |
|---|---|---|
ping |
Check if device is available |
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
CO2ConcentrationState |
ContinuousState |
Alarm/AlarmZoneController (ACTUATOR) — 6 commands, 2 states
Type IDs: 562949953423619 | Servers: rexel | Controllable: knx:AlarmZoneKNXComponent | Profiles: StatefulAlarm, Alarm, StatefulSwitchable, Switchable
Commands
| Command | Parameters | Notes |
|---|---|---|
arm |
Arm the system | |
disarm |
Disarm the system | |
off |
Turn off the device | |
on |
Turn on the device | |
ping |
Check if device is available | |
setOnOff |
STRING: off, on | Turn the device on or off |
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
ArmedState |
DataState | ||
OnOffState |
DiscreteState | on, off |
Alarm/AlarmZoneStatusSensor (SENSOR) — 1 commands, 2 states
Type IDs: 562949953426435 | Servers: rexel | Controllable: knx:AlarmZoneStatusSensorKNXComponent | Profiles: AlarmStatus
Commands
| Command | Parameters | Notes |
|---|---|---|
ping |
Check if device is available |
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
ActiveModeState |
DiscreteState | active, inactive | |
ArmedState |
DataState |
Awning/DiscreteAwning (ACTUATOR) — 6 commands, 0 states
Type IDs: 562949953423874 | Servers: rexel | Controllable: knx:DiscreteAwningKNXComponent | Profiles: DeployUndeployAwning, DeployUndeploy, OpenClose
Commands
| Command | Parameters | Notes |
|---|---|---|
close |
Fully close the device | |
deploy |
Fully deploy the device | |
open |
Fully open the device | |
ping |
Check if device is available | |
stop |
Stop the current actuator behavior (movement, sound or timer) | |
undeploy |
Fully undeploy the device |
Awning/PositionableHorizontalAwning (ACTUATOR) — 8 commands, 2 states
Type IDs: 562949953424130 | Servers: rexel | Controllable: knx:PositionableAwningKNXComponent | Profiles: DeployableAwning, Deployable, DeployUndeploy, StatefulCloseable, StatefulOpenClose, OpenClose
Commands
| Command | Parameters | Notes |
|---|---|---|
close |
Fully close the device | |
deploy |
Fully deploy the device | |
open |
Fully open the device | |
ping |
Check if device is available | |
setClosure |
INT [0..100] | Closure level (100%=fully close, 0%=open) |
setDeployment |
INT [0..100] | Device deployment level (100%=fully deployed, 0%=fully undeployed) |
stop |
Stop the current actuator behavior (movement, sound or timer) | |
undeploy |
Fully undeploy the device |
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
ClosureState |
ContinuousState | [0..100] | |
OpenClosedState |
DiscreteState | open, closed |
CircuitBreaker (ACTUATOR) — 4 commands, 1 states
Type IDs: 562949953430273 | Servers: rexel | Controllable: knx:CircuitBreakerKNXComponent | Profiles: StatefulSwitchablePlug, StatefulSwitchable, Switchable
Commands
| Command | Parameters | Notes |
|---|---|---|
off |
Turn off the device | |
on |
Turn on the device | |
ping |
Check if device is available | |
setOnOff |
STRING: off, on | Turn the device on or off |
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
OnOffState |
DiscreteState | on, off |
Door/OpenCloseDoorOpener (ACTUATOR) — 4 commands, 0 states
Type IDs: 562949953423877 | Servers: rexel | Controllable: knx:DiscreteDoorOpenerKNXComponent | Profiles: OpenCloseSlidingDoor, OpenClose
Commands
| Command | Parameters | Notes |
|---|---|---|
close |
Fully close the device | |
open |
Fully open the device | |
ping |
Check if device is available | |
stop |
Stop the current actuator behavior (movement, sound or timer) |
Door/PositionableDoorOpener (ACTUATOR) — 6 commands, 2 states
Type IDs: 562949953424133 | Servers: rexel | Controllable: knx:PositionableDoorOpenerKNXComponent | Profiles: StatefulCloseableSlidingDoor, StatefulCloseable, Closeable, StatefulOpenClose, OpenClose
Commands
| Command | Parameters | Notes |
|---|---|---|
close |
Fully close the device | |
open |
Fully open the device | |
ping |
Check if device is available | |
setClosure |
INT [0..100] | Closure level (100%=fully close, 0%=open) |
setDeployment |
INT [0..100] | Device deployment level (100%=fully deployed, 0%=fully undeployed) |
stop |
Stop the current actuator behavior (movement, sound or timer) |
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
ClosureState |
ContinuousState | [0..100] | |
OpenClosedState |
DiscreteState | open, closed |
Door/CyclicDoorOpener (ACTUATOR) — 2 commands, 0 states
Type IDs: 562949953428228 | Servers: rexel | Controllable: knx:CyclicDoorOpenerKNXComponent | Profiles: CyclicSlidingDoor, Cyclic
Commands
| Command | Parameters | Notes |
|---|---|---|
cycle |
Do a cycle of supported motion kinematics or modes | |
ping |
Check if device is available |
ElectricitySensor/MultiMeterElectricSensor (SENSOR) — 3 commands, 29 states
Type IDs: 562949953427969, 562949953427971 | Servers: rexel | Controllable: knx:ElectricityCounterInWAmpVoltKNXComponent | Profiles: ElectricEnergyAndPower, ElectricPowerMeter, ElectricEnergyConsumption
Commands
| Command | Parameters | Notes |
|---|---|---|
ping |
Check if device is available | |
requestSendingCounterStatus |
||
resetPartialCounter |
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
ConsumptionAllTariffState |
ContinuousState | ||
ConsumptionTariff0State |
ContinuousState | ||
ConsumptionTariff10State |
ContinuousState | ||
ConsumptionTariff1State |
ContinuousState | ||
ConsumptionTariff2State |
ContinuousState | ||
ConsumptionTariff3State |
ContinuousState | ||
ConsumptionTariff4State |
ContinuousState | ||
ConsumptionTariff5State |
ContinuousState | ||
ConsumptionTariff6State |
ContinuousState | ||
ConsumptionTariff7State |
ContinuousState | ||
ConsumptionTariff8State |
ContinuousState | ||
ConsumptionTariff9State |
ContinuousState | ||
ElectricCurrentState |
ContinuousState | ||
ElectricEnergyConsumptionState |
ContinuousState | ||
ElectricPowerConsumptionState |
ContinuousState | ||
ElectricVoltageState |
ContinuousState | ||
PartialConsumptionAllTariffState |
ContinuousState | ||
PartialConsumptionTariff0State |
ContinuousState | ||
PartialConsumptionTariff10State |
ContinuousState | ||
PartialConsumptionTariff1State |
ContinuousState | ||
PartialConsumptionTariff2State |
ContinuousState | ||
PartialConsumptionTariff3State |
ContinuousState | ||
PartialConsumptionTariff4State |
ContinuousState | ||
PartialConsumptionTariff5State |
ContinuousState | ||
PartialConsumptionTariff6State |
ContinuousState | ||
PartialConsumptionTariff7State |
ContinuousState | ||
PartialConsumptionTariff8State |
ContinuousState | ||
PartialConsumptionTariff9State |
ContinuousState | ||
PartialElectricEnergyConsumptionState |
ContinuousState |
ElectricitySensor/ElectricityTariffData (SENSOR) — 1 commands, 3 states
Type IDs: 562949953427969, 562949953427970, 562949953427971, 562949953427972 | Servers: rexel | Controllable: knx:ElectricityTariffDataKNXComponent | Profiles: Specific
Commands
| Command | Parameters | Notes |
|---|---|---|
ping |
Check if device is available |
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
CurrentTariffNumberState |
DataState | ||
NextTariffDelayState |
DataState | ||
NextTariffNumberState |
DataState |
ElectricitySensor/MultiMeterElectricSensor (SENSOR) — 3 commands, 5 states
Type IDs: 562949953427970 | Servers: rexel | Controllable: knx:ElectricityCounterInKWMilliAmpMilliVoltKNXComponent | Profiles: ElectricEnergyAndPower, ElectricPowerMeter, ElectricEnergyConsumption
Commands
| Command | Parameters | Notes |
|---|---|---|
ping |
Check if device is available | |
requestSendingCounterStatus |
||
resetPartialCounter |
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
ElectricCurrentState |
ContinuousState | ||
ElectricEnergyConsumptionState |
ContinuousState | ||
ElectricPowerConsumptionState |
ContinuousState | ||
ElectricVoltageState |
ContinuousState | ||
PartialElectricEnergyConsumptionState |
ContinuousState |
GarageDoor/DiscretePositionableGarageDoor (ACTUATOR) — 4 commands, 0 states
Type IDs: 562949953423875 | Servers: rexel | Controllable: knx:DiscreteGarageOpenerKNXComponent | Profiles: OpenCloseGarageOpener, OpenClose
Commands
| Command | Parameters | Notes |
|---|---|---|
close |
Fully close the device | |
open |
Fully open the device | |
ping |
Check if device is available | |
stop |
Stop the current actuator behavior (movement, sound or timer) |
GarageDoor/PositionableGarageDoor (ACTUATOR) — 6 commands, 2 states
Type IDs: 562949953424131 | Servers: rexel | Controllable: knx:PositionableGarageOpenerKNXComponent | Profiles: StatefulCloseableGarageOpener, StatefulCloseable, Closeable, StatefulOpenClose, OpenClose
Commands
| Command | Parameters | Notes |
|---|---|---|
close |
Fully close the device | |
open |
Fully open the device | |
ping |
Check if device is available | |
setClosure |
INT [0..100] | Closure level (100%=fully close, 0%=open) |
setDeployment |
INT [0..100] | Device deployment level (100%=fully deployed, 0%=fully undeployed) |
stop |
Stop the current actuator behavior (movement, sound or timer) |
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
ClosureState |
ContinuousState | [0..100] | |
OpenClosedState |
DiscreteState | open, closed |
GarageDoor/CyclicGarageDoor (ACTUATOR) — 2 commands, 0 states
Type IDs: 562949953428226 | Servers: rexel | Controllable: knx:CyclicGarageOpenerKNXComponent | Profiles: CyclicGarageOpener, Cyclic
Commands
| Command | Parameters | Notes |
|---|---|---|
cycle |
Do a cycle of supported motion kinematics or modes | |
ping |
Check if device is available |
Gate/DiscretePositionableGate (ACTUATOR) — 4 commands, 0 states
Type IDs: 562949953423876 | Servers: rexel | Controllable: knx:DiscreteGateOpenerKNXComponent | Profiles: OpenCloseGateOpener, OpenClose
Commands
| Command | Parameters | Notes |
|---|---|---|
close |
Fully close the device | |
open |
Fully open the device | |
ping |
Check if device is available | |
stop |
Stop the current actuator behavior (movement, sound or timer) |
Gate/PositionableGate (ACTUATOR) — 6 commands, 2 states
Type IDs: 562949953424132 | Servers: rexel | Controllable: knx:PositionableGateOpenerKNXComponent | Profiles: StatefulCloseableGateOpener, StatefulCloseable, Closeable, StatefulOpenClose, OpenClose
Commands
| Command | Parameters | Notes |
|---|---|---|
close |
Fully close the device | |
open |
Fully open the device | |
ping |
Check if device is available | |
setClosure |
INT [0..100] | Closure level (100%=fully close, 0%=open) |
setDeployment |
INT [0..100] | Device deployment level (100%=fully deployed, 0%=fully undeployed) |
stop |
Stop the current actuator behavior (movement, sound or timer) |
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
ClosureState |
ContinuousState | [0..100] | |
OpenClosedState |
DiscreteState | open, closed |
Gate/CyclicGate (ACTUATOR) — 2 commands, 0 states
Type IDs: 562949953428227 | Servers: rexel | Controllable: knx:CyclicGateOpenerKNXComponent | Profiles: CyclicGateOpener, Cyclic
Commands
| Command | Parameters | Notes |
|---|---|---|
cycle |
Do a cycle of supported motion kinematics or modes | |
ping |
Check if device is available |
Generic/StatefulOnOff (ACTUATOR) — 4 commands, 1 states
Type IDs: 562949953423617 | Servers: rexel | Controllable: knx:Generic1BitKNXComponent | Profiles: StatefulSwitchable, Switchable, Generic
Commands
| Command | Parameters | Notes |
|---|---|---|
off |
Turn off the device | |
on |
Turn on the device | |
ping |
Check if device is available | |
setOnOff |
STRING: off, on | Turn the device on or off |
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
OnOffState |
DiscreteState | on, off |
Generic/PushButton (ACTUATOR) — 2 commands, 0 states
Type IDs: 562949953428225 | Servers: rexel | Controllable: knx:GenericPushButtonKNXComponent | Profiles: Cyclic, Generic
Commands
| Command | Parameters | Notes |
|---|---|---|
cycle |
Do a cycle of supported motion kinematics or modes | |
ping |
Check if device is available |
GenericSensor/OnOffSensor (SENSOR) — 1 commands, 1 states
Type IDs: 562949953426433, 562949953426434 | Servers: rexel | Controllable: knx:Generic1BitSensorKNXComponent | Profiles: Specific
Commands
| Command | Parameters | Notes |
|---|---|---|
ping |
Check if device is available |
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
BooleanState |
DiscreteState | false, true |
HeatingSystem/WallHeatingTemperatureInterface (ACTUATOR) — 4 commands, 3 states
Type IDs: 562949953425409, 562949953425410 | Servers: rexel | Controllable: knx:WallHeatingTemperatureInterfaceKNXComponent | Profiles: StatefulThermostat, Thermostat
Commands
| Command | Parameters | Notes |
|---|---|---|
ping |
Check if device is available | |
setHVACMode |
STRING: auto, comfort, standby, economy, buildingProtection | Set a HVAC mode |
setHeatingOrCoolingMode |
ANY | |
setTargetTemperature |
FLOAT [0.0..100.0]; STRING: eco, secured, comfort, halted, antifrost | Set the new air temperature to reach |
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
HVACModeState |
DiscreteState | auto, buildingProtection, comfort, economy, standby | |
HeatingOrCoolingModeState |
DiscreteState | cooling, heating | |
TargetTemperatureState |
ContinuousState | [12.0..30.0] |
HeatingSystem/HeatingTemperatureInterfaceSyncoRoom (ACTUATOR) — 5 commands, 4 states
Type IDs: 562949953430017 | Servers: rexel | Controllable: knx:RoomTemperatureSetpointsKNXComponent | Profiles: Specific
Commands
| Command | Parameters | Notes |
|---|---|---|
ping |
Check if device is available | |
setComfortTargetTemperature |
FLOAT [0.0..100.0] | Define the temperature for the comfort mode |
setEcoTargetTemperature |
FLOAT [0.0..100.0] | Define the temperature for the eco mode |
setHVACMode |
STRING: auto, comfort, standby, economy, buildingProtection | Set a HVAC mode |
setPrecomfortTargetTemperature |
FLOAT [0.0..100.0] | Define the temperature for the precomfort mode |
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
ComfortTargetTemperatureState |
ContinuousState | ||
EcoTargetTemperatureState |
ContinuousState | ||
HVACModeState |
DiscreteState | auto, buildingProtection, comfort, economy, standby | |
PrecomfortTargetTemperatureState |
ContinuousState |
HeatingSystem/HVACController (ACTUATOR) — 2 commands, 1 states
Type IDs: 562949953430018 | Servers: rexel | Controllable: knx:HVACInterfaceKNXComponent | Profiles: Specific
Commands
| Command | Parameters | Notes |
|---|---|---|
ping |
Check if device is available | |
setHVACMode |
STRING: auto, comfort, standby, economy, buildingProtection | Set a HVAC mode |
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
HVACModeState |
DiscreteState | auto, buildingProtection, comfort, economy, standby |
HumiditySensor/RelativeHumiditySensor (SENSOR) — 1 commands, 1 states
Type IDs: 562949953427457 | Servers: rexel | Controllable: knx:HumiditySensorKNXComponent | Profiles: RelativeHumidity
Commands
| Command | Parameters | Notes |
|---|---|---|
ping |
Check if device is available |
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
RelativeHumidityState |
ContinuousState | [0.0..100.0] |
Light/StatefulOnOffLight (ACTUATOR) — 4 commands, 1 states
Type IDs: 562949953421569, 562949953422081 | Servers: rexel | Controllable: knx:OnOffLightKNXComponent | Profiles: StatefulSwitchableLight, StatefulSwitchable, Switchable
Commands
| Command | Parameters | Notes |
|---|---|---|
off |
Turn off the device | |
on |
Turn on the device | |
ping |
Check if device is available | |
setOnOff |
STRING: off, on | Turn the device on or off |
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
OnOffState |
DiscreteState | on, off |
Light/DimmerLight (ACTUATOR) — 5 commands, 2 states
Type IDs: 562949953422337 | Servers: rexel | Controllable: knx:DimmableLightKNXComponent | Profiles: StatefulLightDimmer, StatefulDimmable, Dimmable, StatefulSwitchable, Switchable
Commands
| Command | Parameters | Notes |
|---|---|---|
off |
Turn off the device | |
on |
Turn on the device | |
ping |
Check if device is available | |
setIntensity |
INT [0..100] | Light intensity level (100%=maximum intensity, 0%=off) |
setOnOff |
STRING: off, on | Turn the device on or off |
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
LightIntensityState |
ContinuousState | [0..100] | |
OnOffState |
DiscreteState | on, off |
Light/DimmerColouredLight (ACTUATOR) — 6 commands, 2 states
Type IDs: 562949953422593 | Servers: rexel | Controllable: knx:DimmableColouredLightKNXComponent | Profiles: StatefulLightDimmer, StatefulDimmable, Dimmable, StatefulSwitchable, Switchable
Commands
| Command | Parameters | Notes |
|---|---|---|
off |
Turn off the device | |
on |
Turn on the device | |
ping |
Check if device is available | |
setIntensity |
INT [0..100] | Light intensity level (100%=maximum intensity, 0%=off) |
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 |
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
LightIntensityState |
ContinuousState | [0..100] | |
OnOffState |
DiscreteState | on, off |
Light/DimmerRGBColouredLight (ACTUATOR) — 8 commands, 5 states
Type IDs: 562949953422849 | Servers: rexel | Controllable: knx:DimmableRGBColouredLightKNXComponent | Profiles: StatefulLightDimmer, StatefulDimmable, Dimmable, StatefulSwitchable, Switchable
Commands
| Command | Parameters | Notes |
|---|---|---|
off |
Turn off the device | |
on |
Turn on the device | |
ping |
Check if device is available | |
setBlueColorIntensity |
ANY | |
setGreenColorIntensity |
ANY | |
setIntensity |
INT [0..100] | Light intensity level (100%=maximum intensity, 0%=off) |
setOnOff |
STRING: off, on | Turn the device on or off |
setRedColorIntensity |
ANY |
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
BlueColorIntensityState |
ContinuousState | ||
GreenColorIntensityState |
ContinuousState | ||
LightIntensityState |
ContinuousState | [0..100] | |
OnOffState |
DiscreteState | on, off | |
RedColorIntensityState |
ContinuousState |
Light/DimmerRGBWColouredLight (ACTUATOR) — 9 commands, 6 states
Type IDs: 562949953422850 | Servers: rexel | Controllable: knx:DimmableRGBWColouredLightKNXComponent | Profiles: StatefulLightDimmer, StatefulDimmable, Dimmable, StatefulSwitchable, Switchable
Commands
| Command | Parameters | Notes |
|---|---|---|
off |
Turn off the device | |
on |
Turn on the device | |
ping |
Check if device is available | |
setBlueColorIntensity |
ANY | |
setGreenColorIntensity |
ANY | |
setIntensity |
INT [0..100] | Light intensity level (100%=maximum intensity, 0%=off) |
setOnOff |
STRING: off, on | Turn the device on or off |
setRedColorIntensity |
ANY | |
setWhiteColorIntensity |
ANY |
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
BlueColorIntensityState |
ContinuousState | ||
GreenColorIntensityState |
ContinuousState | ||
LightIntensityState |
ContinuousState | [0..100] | |
OnOffState |
DiscreteState | on, off | |
RedColorIntensityState |
ContinuousState | ||
WhiteColorIntensityState |
ContinuousState |
LightSensor/LuminanceSensor (SENSOR) — 1 commands, 1 states
Type IDs: 562949953421825, 562949953427713 | Servers: rexel | Controllable: knx:LightSensorKNXComponent | Profiles: Luminance
Commands
| Command | Parameters | Notes |
|---|---|---|
ping |
Check if device is available |
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
LuminanceState |
ContinuousState |
OnOff/StatefulOnOff (ACTUATOR) — 4 commands, 1 states
Type IDs: 562949953423105 | Servers: rexel | Controllable: knx:OnOffKNXComponent | Profiles: StatefulSwitchablePlug, StatefulSwitchable, Switchable
Commands
| Command | Parameters | Notes |
|---|---|---|
off |
Turn off the device | |
on |
Turn on the device | |
ping |
Check if device is available | |
setOnOff |
STRING: off, on | Turn the device on or off |
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
OnOffState |
DiscreteState | on, off |
RainSensor/RainAlarmSensor (SENSOR) — 1 commands, 2 states
Type IDs: 562949953427713, 562949953428481 | Servers: rexel | Controllable: knx:RainSensorKNXComponent | Profiles: RainDetector
Commands
| Command | Parameters | Notes |
|---|---|---|
ping |
Check if device is available |
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
RainAlarmState |
DiscreteState | alarm, noAlarm | |
RainState |
DiscreteState | detected, notDetected |
RemoteController/OnOffRemotecontroller (REMOTE_CONTROLLER) — 1 commands, 1 states
Type IDs: 562949953428737 | Servers: rexel | Controllable: knx:OnOffKNXRemoteController | Profiles: OnOffButton
Commands
| Command | Parameters | Notes |
|---|---|---|
ping |
Check if device is available |
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
OnOffButtonState |
DiscreteState | on, off |
RemoteController/ScenarioTrigger (REMOTE_CONTROLLER) — 1 commands, 2 states
Type IDs: 562949953429761 | Servers: rexel | Controllable: knx:ScenarioTrigger | Profiles: PushButtonSensor
Commands
| Command | Parameters | Notes |
|---|---|---|
ping |
Check if device is available |
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
BooleanState |
DiscreteState | false, true | |
ButtonState |
DiscreteState | pressed, released, shortPressed |
RollerShutter/UpDownRollerShutter (ACTUATOR) — 6 commands, 0 states
Type IDs: 562949953423873 | Servers: rexel | Controllable: knx:BasicRollerShutterKNXComponent | Profiles: OpenCloseShutter, OpenClose
Commands
| Command | Parameters | Notes |
|---|---|---|
close |
Fully close the device | |
down |
Move the device completely down | |
open |
Fully open the device | |
ping |
Check if device is available | |
stop |
Stop the current actuator behavior (movement, sound or timer) | |
up |
Move the device completely up |
RollerShutter/PositionableRollerShutter (ACTUATOR) — 8 commands, 2 states
Type IDs: 562949953424129 | Servers: rexel | Controllable: knx:RollerShutterGenericKNXComponent | Profiles: StatefulCloseableShutter, StatefulCloseable, Closeable, StatefulOpenClose, OpenClose
Commands
| Command | Parameters | Notes |
|---|---|---|
close |
Fully close the device | |
down |
Move the device completely down | |
open |
Fully open the device | |
ping |
Check if device is available | |
setClosure |
INT [0..100] | Closure level (100%=fully close, 0%=open) |
setDeployment |
INT [0..100] | Device deployment level (100%=fully deployed, 0%=fully undeployed) |
stop |
Stop the current actuator behavior (movement, sound or timer) | |
up |
Move the device completely up |
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
ClosureState |
ContinuousState | [0..100] | |
OpenClosedState |
DiscreteState | open, closed |
Scene (ACTUATOR) — 2 commands, 0 states
Type IDs: 281474976710657 | Servers: rexel | Controllable: knx:SceneKNXComponent | Profiles: SceneController
Commands
| Command | Parameters | Notes |
|---|---|---|
activate |
Activate a scene or pre-defined scenario | |
learn |
SwingingShutter/CyclicSwingingShutter (ACTUATOR) — 2 commands, 0 states
Type IDs: 562949953428229 | Servers: rexel | Controllable: knx:CyclicSwingingShutterKNXComponent | Profiles: SwingingCyclicShutter, Cyclic
Commands
| Command | Parameters | Notes |
|---|---|---|
cycle |
Do a cycle of supported motion kinematics or modes | |
ping |
Check if device is available |
Switch/StatefulOnOffSwitch (ACTUATOR) — 4 commands, 0 states
Type IDs: 562949953423361 | Servers: rexel | Controllable: knx:OnOffSwitchKNXComponent | Profiles: SwitchablePlug, Switchable
Commands
| Command | Parameters | Notes |
|---|---|---|
off |
Turn off the device | |
on |
Turn on the device | |
ping |
Check if device is available | |
setOnOff |
STRING: off, on | Turn the device on or off |
TemperatureSensor (SENSOR) — 1 commands, 1 states
Type IDs: 562949953425409, 562949953425410, 562949953426945, 562949953427713, 562949953430017, 562949953430019 | Servers: rexel | Controllable: knx:TemperatureSensorKNXComponent | Profiles: Temperature
Commands
| Command | Parameters | Notes |
|---|---|---|
ping |
Check if device is available |
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
TemperatureState |
ContinuousState | [-100.0..100.0] |
Timer/StartStopTimer (ACTUATOR) — 3 commands, 1 states
Type IDs: 562949953429249 | Servers: rexel | Controllable: knx:StartStopTimerKNXComponent | Profiles: StatefulStartStopTimer, StatefulStartStop, StartStop
Commands
| Command | Parameters | Notes |
|---|---|---|
ping |
Check if device is available | |
start |
Start the default actuator behavior (movement, sound or timer) | |
stop |
Stop the current actuator behavior (movement, sound or timer) |
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
StartedStoppedState |
DiscreteState | started, stopped |
Timer/StartTimer (ACTUATOR) — 2 commands, 1 states
Type IDs: 562949953429505 | Servers: rexel | Controllable: knx:StartTimerKNXComponent | Profiles: StatefulStartableTimer, StatefulStartable, Startable
Commands
| Command | Parameters | Notes |
|---|---|---|
ping |
Check if device is available | |
start |
Start the default actuator behavior (movement, sound or timer) |
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
StartedStoppedState |
DiscreteState | started, stopped |
VenetianBlind/PositionableVenetianBlind (ACTUATOR) — 8 commands, 3 states
Type IDs: 562949953424385 | Servers: rexel | Controllable: knx:GenericVenetianBlindKNXComponent | Profiles: StatefulOrientableShutter, StatefulOrientablePlusCloseable, OrientablePlusCloseable, StatefulCloseable, Closeable, StatefulOpenClose, OpenClose
Commands
| Command | Parameters | Notes |
|---|---|---|
close |
Fully close the device | |
down |
Move the device completely down | |
open |
Fully open the device | |
ping |
Check if device is available | |
setClosure |
INT [0..100] | Closure level (100%=fully close, 0%=open) |
setOrientation |
INT [0..100] | Set the relative orientation (0-100%) of the device slats |
stop |
Stop the current actuator behavior (movement, sound or timer) | |
up |
Move the device completely up |
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
ClosureState |
ContinuousState | [0..100] | |
OpenClosedState |
DiscreteState | open, closed | |
SlateOrientationState |
ContinuousState | [0..100] |
VenetianBlind/PositionableVenetianBlind (ACTUATOR) — 6 commands, 3 states
Type IDs: 562949953424386 | Servers: rexel | Controllable: knx:PergolaKNXComponent | Profiles: StatefulOrientablePlusCloseablePergola, StatefulOrientablePlusCloseable, OrientablePlusCloseable, StatefulCloseable, Closeable, StatefulOpenClose, OpenClose
Commands
| Command | Parameters | Notes |
|---|---|---|
close |
Fully close the device | |
open |
Fully open the device | |
ping |
Check if device is available | |
setClosure |
INT [0..100] | Closure level (100%=fully close, 0%=open) |
setOrientation |
INT [0..100] | Set the relative orientation (0-100%) of the device slats |
stop |
Stop the current actuator behavior (movement, sound or timer) |
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
ClosureState |
ContinuousState | [0..100] | |
OpenClosedState |
DiscreteState | open, closed | |
SlateOrientationState |
ContinuousState | [0..100] |
VentilationSystem/OnOffVentilationSpeed (ACTUATOR) — 4 commands, 1 states
Type IDs: 562949953428993 | Servers: rexel | Controllable: knx:OnOffVentilationSpeedKNXComponent | Profiles: StatefulSwitchableVentilation, StatefulSwitchable, Switchable
Commands
| Command | Parameters | Notes |
|---|---|---|
off |
Turn off the device | |
on |
Turn on the device | |
ping |
Check if device is available | |
setOnOff |
STRING: off, on | Turn the device on or off |
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
OnOffState |
DiscreteState | on, off |
WaterHeatingSystem/DomesticHotWaterTank (ACTUATOR) — 4 commands, 1 states
Type IDs: 562949953423618 | Servers: rexel | Controllable: knx:DomesticHotWaterTankKNXComponent | Profiles: StatefulSwitchableHeating, StatefulSwitchable, Switchable
Commands
| Command | Parameters | Notes |
|---|---|---|
off |
Turn off the device | |
on |
Turn on the device | |
ping |
Check if device is available | |
setOnOff |
STRING: off, on | Turn the device on or off |
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
OnOffState |
DiscreteState | on, off |
WaterHeatingSystem/DomesticHotWaterSyncoLiving (ACTUATOR) — 4 commands, 2 states
Type IDs: 562949953430019 | Servers: rexel | Controllable: knx:DomesticHotWaterControlKNXComponent | Profiles: StatefulThermostat, Thermostat
Commands
| Command | Parameters | Notes |
|---|---|---|
ping |
Check if device is available | |
setDHWMMode |
STRING: auto, frostprotection, legionellaprotection, normal, reduced | Set a DHWM mode |
setForceHeating |
Set the force heating mode | |
setTargetTemperature |
FLOAT [0.0..100.0]; STRING: eco, secured, comfort, halted, antifrost | Set the new air temperature to reach |
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
DHWMModeState |
DiscreteState | auto, frostprotection, legionellaprotection, normal, reduced | |
TargetTemperatureState |
ContinuousState | [12.0..30.0] |
WindSensor/WindSpeedSensor (SENSOR) — 1 commands, 1 states
Type IDs: 562949953426689, 562949953427713 | Servers: rexel | Controllable: knx:WindSensorKNXComponent | Profiles: WindSpeed
Commands
| Command | Parameters | Notes |
|---|---|---|
ping |
Check if device is available |
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
WindSpeedState |
ContinuousState |
Window/CyclicTiltedWindow (ACTUATOR) — 2 commands, 0 states
Type IDs: 562949953428230 | Servers: rexel | Controllable: knx:CyclicTiltedWindowKNXComponent | Profiles: CyclicWindow, Cyclic
Commands
| Command | Parameters | Notes |
|---|---|---|
cycle |
Do a cycle of supported motion kinematics or modes | |
ping |
Check if device is available |
MODBUS
12 device types.
ElectricitySensor/CumulativeElectricPowerConsumptionSensor (SENSOR) — 0 commands, 2 states
Type IDs: 14 | Servers: hi_kumo_europe, rexel, somfy_europe | Controllable: modbus:YutakiV2SpaceCoolingElectricalEnergyConsumptionComponent | Profiles: ElectricEnergyAndPower, ElectricPowerMeter, ElectricEnergyConsumption
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
ElectricEnergyConsumptionState |
ContinuousState | ||
ElectricPowerConsumptionState |
ContinuousState |
HeatingSystem/HitachiThermostat (SENSOR) — 0 commands, 1 states
Type IDs: 12, 14 | Servers: hi_kumo_europe, rexel, somfy_europe | Controllable: modbus:YutakiRoomThermostatZone1Component | Profiles: Specific
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
AlarmNumberState |
DataState |
HitachiHeatingSystem/HitachiAirToWaterMainComponent (ACTUATOR) — 41 commands, 67 states
Type IDs: 12, 14 | Servers: hi_kumo_europe, rexel, somfy_europe | Controllable: modbus:YutakiMainComponent | Profiles: Specific
Commands
| Command | Parameters | Notes |
|---|---|---|
refreshCentralSetting1 |
||
refreshCentralSetting2 |
||
refreshCentralSetting3 |
||
refreshControlBlockMenu |
||
refreshControlCommunicationAlarmBit |
||
refreshControlUnit |
||
refreshControlUnitMode |
||
refreshEcoModeOffset |
||
refreshEcoModeOffsetTarget |
||
refreshHLinkCommunicationAlarm |
||
refreshHardwareVersion |
||
refreshLCDCentralMode |
||
refreshLCDSoftwareNumber |
||
refreshOperationState |
||
refreshOutdoorAmbientTemperature |
||
refreshPCB1SoftwareNumber |
||
refreshRoomThermostatSetTemperatureC1 |
||
refreshRoomThermostatSetTemperatureC2 |
||
refreshRoomThermostatTemperatureC1 |
||
refreshRoomThermostatTemperatureC2 |
||
refreshSoftwareVersion |
||
refreshSpaceMode |
||
refreshStatusBlockMenu |
||
refreshStatusCommunicationAlarmBit |
||
refreshStatusUnitMode |
||
refreshSystemConfiguration |
||
refreshTahomaRoomThermostatAvailable |
||
refreshWaterInletUnitTemperature |
||
refreshWaterOutletUnitTemperature |
||
setCentralSetting1 |
ANY | |
setCentralSetting2 |
ANY | |
setCentralSetting3 |
ANY | |
setControlBlockMenu |
ANY | |
setControlCommunicationAlarmBit |
ANY | |
setControlUnit |
ANY | |
setControlUnitMode |
ANY | |
setEcoComfortMode |
ANY; ANY; ANY; ANY | |
setEcoModeOffset |
ANY | |
setGlobalAutoManuMode |
ANY | |
setSpaceMode |
ANY | |
setTahomaRoomThermostatAvailable |
STRING |
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
AlarmNumberState |
DataState | ||
AutoManuModeState |
DiscreteState | auto, manu | |
CauseOfStoppageState |
DataState | ||
CentralSetting1State |
DataState | ||
CentralSetting2State |
DataState | ||
CentralSetting3State |
DataState | ||
CompressorCurrentValueState |
DataState | ||
CompressorFrequencyState |
DataState | ||
CompressorRunningCurrentState |
DataState | ||
ControlBlockMenuState |
DiscreteState | block, no | |
ControlCommunicationAlarmBitState |
DiscreteState | alarm, no | |
ControlUnitModeState |
DiscreteState | cool, heat | |
ControlUnitState |
DiscreteState | run, stop | |
DefrostingState |
DataState | ||
DischargeGasTemperatureState |
DataState | ||
DischargePressureState |
DataState | ||
DischargeTemperatureState |
DataState | ||
EcoModeOffsetState |
ContinuousState | ||
EcoModeOffsetTargetState |
ContinuousState | ||
EvaporatingTemperatureState |
DataState | ||
EvaporationTemperatureState |
DataState | ||
GasTemperatureState |
DataState | ||
HLinkCommunicationAlarmState |
DiscreteState | alarm, noAlarm | |
HardwareVersionState |
DataState | ||
IndoorExpansionValveOpeningState |
DataState | ||
IndoorExpansionValveState |
DataState | ||
InverterOperationFrequencyState |
DataState | ||
LCDCentralModeState |
DataState | ||
LCDSoftwareNumberState |
DataState | ||
LiquidTemperatureState |
DataState | ||
LiquidTemperatureTHMIState |
DataState | ||
MixingValvePositionState |
DataState | ||
OperationState |
DiscreteState | alarm, cool demand-off, cool thermo-off, cool thermo-on, dhw-off, heat demand-off, heat thermo-off, heat thermo-on, off, swp-off | |
OutdoorAmbientTemperatureState |
DataState | ||
OutdoorExpansionValveState |
DataState | ||
OutdoorUnitAmbientState |
DataState | ||
PCB1SoftwareNumberState |
DataState | ||
ProductSpecCodeState |
DataState | ||
RetryCodeState |
DataState | ||
RoomThermostatSetTemperatureC1State |
DataState | ||
RoomThermostatSetTemperatureC2State |
DataState | ||
RoomThermostatTemperatureC1State |
DataState | ||
RoomThermostatTemperatureC2State |
DataState | ||
SecondAmbientAverageTemperatureState |
DataState | ||
SecondAmbientTemperatureState |
DataState | ||
SoftwareNumberState |
DataState | ||
SoftwareVersionState |
DataState | ||
SpaceModeState |
DiscreteState | comfort, eco | |
StatusBlockMenuState |
DataState | ||
StatusCommunicationAlarmBitState |
DiscreteState | alarm, no | |
StatusUnitModeState |
DataState | ||
SuctionPressureState |
DataState | ||
SuctionTemperatureState |
DataState | ||
SystemConfigurationState |
DataState | ||
SystemStatus2State |
DataState | ||
TahomaRoomThermostatAvailableState |
DiscreteState | available, not available | |
UnitModelState |
DataState | ||
VirtualEcoComfortModeState |
DataState | ||
WaterFlowLevelState |
DataState | ||
WaterInletUnitTemperatureState |
DataState | ||
WaterOutletHpTemperatureState |
DataState | ||
WaterOutletTemperature2State |
DataState | ||
WaterOutletTemperature3State |
DataState | ||
WaterOutletUnitTemperatureState |
DataState | ||
WaterPumpSpeedState |
DataState | ||
WaterTemperatureSettingState |
DataState | ||
YutakiVirtualOperatingModeState |
DiscreteState | auto, holidays, normal, timer |
HitachiHeatingSystem/HitachiAirToWaterHeatingZone (ACTUATOR) — 24 commands, 17 states
Type IDs: 12 | Servers: hi_kumo_europe, rexel, somfy_europe | Controllable: modbus:YutakiZone1Component | Profiles: Specific
Commands
| Command | Parameters | Notes |
|---|---|---|
globalControl |
ANY; ANY; ANY | |
refreshControlCircuit1 |
||
refreshControlCoolingOTCZone1 |
||
refreshControlHeatingOTCZone1 |
||
refreshRoomAmbientTemperatureControlZone1 |
||
refreshRoomAmbientTemperatureStatusZone1 |
||
refreshStatusCircuit1 |
||
refreshStatusCoolingOTCZone1 |
||
refreshStatusHeatingOTCZone1 |
||
refreshThermostatSettingControlZone1 |
||
refreshThermostatSettingStatusZone1 |
||
refreshWaterCoolingSettingTemperatureControlZone1 |
||
refreshWaterCoolingSettingTemperatureStatusZone1 |
||
refreshWaterHeatingSettingTemperatureControlZone1 |
||
refreshWaterHeatingSettingTemperatureStatusZone1 |
||
setAutoManuMode |
ANY | |
setControlCircuit1 |
ANY | |
setControlCoolingOTCZone1 |
ANY | |
setControlHeatingOTCZone1 |
ANY | |
setHolidayMode |
ANY | |
setRoomAmbientTemperatureControlZone1 |
INT | |
setThermostatSettingControlZone1 |
FLOAT | |
setWaterCoolingSettingTemperatureControlZone1 |
INT | |
setWaterHeatingSettingTemperatureControlZone1 |
INT |
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
AlarmNumberState |
DataState | ||
AutoManuModeZone1State |
DiscreteState | auto, manu | |
ControlCircuit1State |
DiscreteState | run, stop | |
ControlCoolingOTCZone1State |
DiscreteState | fix, no, points | |
ControlHeatingOTCZone1State |
DiscreteState | fix, gradient, no, points | |
HolidayModeZone1State |
DiscreteState | off, on | |
RoomAmbientTemperatureControlZone1State |
DataState | ||
RoomAmbientTemperatureStatusZone1State |
DataState | ||
StatusCircuit1State |
DiscreteState | run, stop | |
StatusCoolingOTCZone1State |
DiscreteState | fix, no, points | |
StatusHeatingOTCZone1State |
DiscreteState | fix, gradient, no, points | |
ThermostatSettingControlZone1State |
DataState | ||
ThermostatSettingStatusZone1State |
DataState | ||
WaterCoolingSettingTemperatureControlZone1State |
DataState | ||
WaterCoolingSettingTemperatureStatusZone1State |
DataState | ||
WaterHeatingSettingTemperatureControlZone1State |
DataState | ||
WaterHeatingSettingTemperatureStatusZone1State |
DataState |
HitachiHeatingSystem/HitachiAirToWaterHeatingZone (ACTUATOR) — 24 commands, 17 states
Type IDs: 12 | Servers: hi_kumo_europe, rexel, somfy_europe | Controllable: modbus:YutakiZone2Component | Profiles: Specific
Commands
| Command | Parameters | Notes |
|---|---|---|
globalControl |
ANY; ANY; ANY | |
refreshControlCircuit2 |
||
refreshControlCoolingOTCZone2 |
||
refreshControlHeatingOTCZone2 |
||
refreshRoomAmbientTemperatureControlZone2 |
||
refreshRoomAmbientTemperatureStatusZone2 |
||
refreshStatusCircuit2 |
||
refreshStatusCoolingOTCZone2 |
||
refreshStatusHeatingOTCZone2 |
||
refreshThermostatSettingControlZone2 |
||
refreshThermostatSettingStatusZone2 |
||
refreshWaterCoolingSettingTemperatureControlZone2 |
||
refreshWaterCoolingSettingTemperatureStatusZone2 |
||
refreshWaterHeatingSettingTemperatureControlZone2 |
||
refreshWaterHeatingSettingTemperatureStatusZone2 |
||
setAutoManuMode |
ANY | |
setControlCircuit2 |
ANY | |
setControlCoolingOTCZone2 |
ANY | |
setControlHeatingOTCZone2 |
ANY | |
setHolidayMode |
ANY | |
setRoomAmbientTemperatureControlZone2 |
INT | |
setThermostatSettingControlZone2 |
FLOAT | |
setWaterCoolingSettingTemperatureControlZone2 |
INT | |
setWaterHeatingSettingTemperatureControlZone2 |
INT |
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
AlarmNumberState |
DataState | ||
AutoManuModeZone2State |
DiscreteState | auto, manu | |
ControlCircuit2State |
DiscreteState | run, stop | |
ControlCoolingOTCZone2State |
DiscreteState | fix, no, points | |
ControlHeatingOTCZone2State |
DiscreteState | fix, gradient, no, points | |
HolidayModeZone2State |
DiscreteState | off, on | |
RoomAmbientTemperatureControlZone2State |
DataState | ||
RoomAmbientTemperatureStatusZone2State |
DataState | ||
StatusCircuit2State |
DiscreteState | run, stop | |
StatusCoolingOTCZone2State |
DiscreteState | fix, no, points | |
StatusHeatingOTCZone2State |
DiscreteState | fix, gradient, no, points | |
ThermostatSettingControlZone2State |
DataState | ||
ThermostatSettingStatusZone2State |
DataState | ||
WaterCoolingSettingTemperatureControlZone2State |
DataState | ||
WaterCoolingSettingTemperatureStatusZone2State |
DataState | ||
WaterHeatingSettingTemperatureControlZone2State |
DataState | ||
WaterHeatingSettingTemperatureStatusZone2State |
DataState |
HitachiHeatingSystem/HitachiDHW (ACTUATOR) — 16 commands, 13 states
Type IDs: 12 | Servers: hi_kumo_europe, rexel, somfy_europe | Controllable: modbus:YutakiDHWTComponent | Profiles: DHWTemperature
Commands
| Command | Parameters | Notes |
|---|---|---|
globalControlDHW |
ANY; ANY; ANY | |
refreshControlAntiLegionella |
||
refreshControlAntiLegionellaSettingTemperature |
||
refreshControlDHW |
||
refreshControlDHWSettingTemperature |
||
refreshDHWMode |
||
refreshDHWTTemperature |
||
refreshStatusAntiLegionella |
||
refreshStatusAntiLegionellaSettingTemperature |
||
refreshStatusDHW |
||
refreshStatusDHWSettingTemperature |
||
setControlAntiLegionella |
ANY | |
setControlAntiLegionellaSettingTemperature |
INT | |
setControlDHW |
ANY | |
setControlDHWSettingTemperature |
INT | |
setDHWMode |
ANY |
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
AlarmNumberState |
DataState | ||
ControlAntiLegionellaSettingTemperatureState |
DataState | ||
ControlAntiLegionellaState |
DiscreteState | run, stop | |
ControlDHWSettingTemperatureState |
DataState | ||
ControlDHWState |
DiscreteState | run, stop | |
DHWModeState |
DiscreteState | high demand, standard | |
DHWTemperatureState |
ContinuousState | [-100.0..100.0] | |
StatusAntiLegionellaSettingTemperatureState |
DataState | ||
StatusAntiLegionellaState |
DiscreteState | run, stop | |
StatusDHWSettingTemperatureState |
DataState | ||
StatusDHWState |
DataState | ||
VirtualGlobalControlState |
DataState | ||
YutakiDHWVirtualOperatingModeState |
DiscreteState | high demand, off, standard |
HitachiHeatingSystem/HitachiSwimmingPool (ACTUATOR) — 7 commands, 6 states
Type IDs: 12, 14 | Servers: hi_kumo_europe, rexel, somfy_europe | Controllable: modbus:YutakiSwimmingPoolComponent | Profiles: Specific
Commands
| Command | Parameters | Notes |
|---|---|---|
refreshControlSwimmingPool |
||
refreshControlSwimmingPoolSettingTemperature |
||
refreshStatusSwimmingPool |
||
refreshStatusSwimmingPoolSettingTemperature |
||
refreshSwimmingPoolTemperature |
||
setControlSwimmingPool |
ANY | |
setControlSwimmingPoolSettingTemperature |
INT |
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
AlarmNumberState |
DataState | ||
ControlSwimmingPoolSettingTemperatureState |
DataState | ||
ControlSwimmingPoolState |
DiscreteState | run, stop | |
StatusSwimmingPoolSettingTemperatureState |
DataState | ||
StatusSwimmingPoolState |
DiscreteState | run, stop | |
SwimmingPoolTemperatureState |
DataState |
HitachiHeatingSystem/HitachiAirToWaterHeatingZone (ACTUATOR) — 26 commands, 19 states
Type IDs: 14 | Servers: hi_kumo_europe, rexel, somfy_europe | Controllable: modbus:YutakiV2Zone1Component | Profiles: Specific
Commands
| Command | Parameters | Notes |
|---|---|---|
globalControl |
ANY; ANY; ANY | |
refreshControlCircuit1 |
||
refreshControlCoolingOTCZone1 |
||
refreshControlHeatingOTCZone1 |
||
refreshMode |
Refresh the mode | |
refreshRoomAmbientTemperatureControlZone1 |
||
refreshRoomAmbientTemperatureStatusZone1 |
||
refreshStatusCircuit1 |
||
refreshStatusCoolingOTCZone1 |
||
refreshStatusHeatingOTCZone1 |
||
refreshThermostatSettingControlZone1 |
||
refreshThermostatSettingStatusZone1 |
||
refreshWaterCoolingSettingTemperatureControlZone1 |
||
refreshWaterCoolingSettingTemperatureStatusZone1 |
||
refreshWaterHeatingSettingTemperatureControlZone1 |
||
refreshWaterHeatingSettingTemperatureStatusZone1 |
||
setAutoManuMode |
ANY | |
setControlCircuit1 |
ANY | |
setControlCoolingOTCZone1 |
ANY | |
setControlHeatingOTCZone1 |
ANY | |
setHolidayMode |
ANY | |
setRoomAmbientTemperatureControlZone1 |
INT | |
setTargetMode |
STRING: comfort, eco | set the target mode |
setThermostatSettingControlZone1 |
FLOAT | |
setWaterCoolingSettingTemperatureControlZone1 |
INT | |
setWaterHeatingSettingTemperatureControlZone1 |
INT |
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
AlarmNumberState |
DataState | ||
AutoManuModeZone1State |
DiscreteState | auto, manu | |
ControlCircuit1State |
DiscreteState | run, stop | |
ControlCoolingOTCZone1State |
DiscreteState | fix, no, points | |
ControlHeatingOTCZone1State |
DiscreteState | fix, gradient, no, points | |
HolidayModeZone1State |
DiscreteState | off, on | |
RoomAmbientTemperatureControlZone1State |
DataState | ||
RoomAmbientTemperatureStatusZone1State |
DataState | ||
StatusCircuit1State |
DiscreteState | run, stop | |
StatusCoolingOTCZone1State |
DiscreteState | fix, no, points | |
StatusHeatingOTCZone1State |
DiscreteState | fix, gradient, no, points | |
ThermostatSettingControlZone1State |
DataState | ||
ThermostatSettingStatusZone1State |
DataState | ||
WaterCoolingSettingTemperatureControlZone1State |
DataState | ||
WaterCoolingSettingTemperatureStatusZone1State |
DataState | ||
WaterHeatingSettingTemperatureControlZone1State |
DataState | ||
WaterHeatingSettingTemperatureStatusZone1State |
DataState | ||
YutakiModeState |
DiscreteState | comfort, eco | |
YutakiTargetModeState |
DiscreteState | comfort, eco |
HitachiHeatingSystem/HitachiAirToWaterHeatingZone (ACTUATOR) — 26 commands, 19 states
Type IDs: 14 | Servers: hi_kumo_europe, rexel, somfy_europe | Controllable: modbus:YutakiV2Zone2Component | Profiles: Specific
Commands
| Command | Parameters | Notes |
|---|---|---|
globalControl |
ANY; ANY; ANY | |
refreshControlCircuit2 |
||
refreshControlCoolingOTCZone2 |
||
refreshControlHeatingOTCZone2 |
||
refreshMode |
Refresh the mode | |
refreshRoomAmbientTemperatureControlZone2 |
||
refreshRoomAmbientTemperatureStatusZone2 |
||
refreshStatusCircuit2 |
||
refreshStatusCoolingOTCZone2 |
||
refreshStatusHeatingOTCZone2 |
||
refreshThermostatSettingControlZone2 |
||
refreshThermostatSettingStatusZone2 |
||
refreshWaterCoolingSettingTemperatureControlZone2 |
||
refreshWaterCoolingSettingTemperatureStatusZone2 |
||
refreshWaterHeatingSettingTemperatureControlZone2 |
||
refreshWaterHeatingSettingTemperatureStatusZone2 |
||
setAutoManuMode |
ANY | |
setControlCircuit2 |
ANY | |
setControlCoolingOTCZone2 |
ANY | |
setControlHeatingOTCZone2 |
ANY | |
setHolidayMode |
ANY | |
setRoomAmbientTemperatureControlZone2 |
INT | |
setTargetMode |
STRING: comfort, eco | set the target mode |
setThermostatSettingControlZone2 |
FLOAT | |
setWaterCoolingSettingTemperatureControlZone2 |
INT | |
setWaterHeatingSettingTemperatureControlZone2 |
INT |
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
AlarmNumberState |
DataState | ||
AutoManuModeZone2State |
DiscreteState | auto, manu | |
ControlCircuit2State |
DiscreteState | run, stop | |
ControlCoolingOTCZone2State |
DiscreteState | fix, no, points | |
ControlHeatingOTCZone2State |
DiscreteState | fix, gradient, no, points | |
HolidayModeZone2State |
DiscreteState | off, on | |
RoomAmbientTemperatureControlZone2State |
DataState | ||
RoomAmbientTemperatureStatusZone2State |
DataState | ||
StatusCircuit2State |
DiscreteState | run, stop | |
StatusCoolingOTCZone2State |
DiscreteState | fix, no, points | |
StatusHeatingOTCZone2State |
DiscreteState | fix, gradient, no, points | |
ThermostatSettingControlZone2State |
DataState | ||
ThermostatSettingStatusZone2State |
DataState | ||
WaterCoolingSettingTemperatureControlZone2State |
DataState | ||
WaterCoolingSettingTemperatureStatusZone2State |
DataState | ||
WaterHeatingSettingTemperatureControlZone2State |
DataState | ||
WaterHeatingSettingTemperatureStatusZone2State |
DataState | ||
YutakiModeState |
DiscreteState | comfort, eco | |
YutakiTargetModeState |
DiscreteState | comfort, eco |
HitachiHeatingSystem/HitachiDHW (ACTUATOR) — 18 commands, 15 states
Type IDs: 14 | Servers: hi_kumo_europe, rexel, somfy_europe | Controllable: modbus:YutakiV2DHWTComponent | Profiles: DHWTemperature
Commands
| Command | Parameters | Notes |
|---|---|---|
globalControlDHW |
ANY; ANY; ANY | |
refreshBoostMode |
Refresh the boost mode | |
refreshControlAntiLegionella |
||
refreshControlAntiLegionellaSettingTemperature |
||
refreshControlDHW |
||
refreshControlDHWSettingTemperature |
||
refreshDHWMode |
||
refreshDHWTTemperature |
||
refreshStatusAntiLegionella |
||
refreshStatusAntiLegionellaSettingTemperature |
||
refreshStatusDHW |
||
refreshStatusDHWSettingTemperature |
||
setControlAntiLegionella |
ANY | |
setControlAntiLegionellaSettingTemperature |
INT | |
setControlDHW |
ANY | |
setControlDHWSettingTemperature |
INT | |
setDHWMode |
ANY | |
setTargetBoostMode |
STRING: no request, request | set the target boost mode |
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
AlarmNumberState |
DataState | ||
ControlAntiLegionellaSettingTemperatureState |
DataState | ||
ControlAntiLegionellaState |
DiscreteState | run, stop | |
ControlDHWSettingTemperatureState |
DataState | ||
ControlDHWState |
DiscreteState | run, stop | |
DHWModeState |
DiscreteState | high demand, standard | |
DHWTemperatureState |
ContinuousState | [-100.0..100.0] | |
StatusAntiLegionellaSettingTemperatureState |
DataState | ||
StatusAntiLegionellaState |
DiscreteState | run, stop | |
StatusDHWSettingTemperatureState |
DataState | ||
StatusDHWState |
DataState | ||
VirtualGlobalControlState |
DataState | ||
YutakiBoostModeState |
DiscreteState | disabled, enabled | |
YutakiDHWVirtualOperatingModeState |
DiscreteState | high demand, off, standard | |
YutakiTargetBoostModeState |
DiscreteState | disabled, enabled |
unknown (ACTUATOR) — 54 commands, 40 states
Type IDs: 11 | Servers: hi_kumo_europe, rexel, somfy_europe | Controllable: modbus:DeDietrichGatewayComponent | Profiles: Specific
Commands
| Command | Parameters | Notes |
|---|---|---|
refreshAverageFlowSensorTemperature |
||
refreshBoilerType |
||
refreshBoilersStartsCount |
||
refreshCalculatedOutletSetPointTemperature |
||
refreshCalculatedWaterSetPointTemperature |
||
refreshCascadeTemperature |
||
refreshCircuitAType |
||
refreshCircuitBType |
||
refreshCircuitCType |
||
refreshCircuitType |
||
refreshCompressorOutletTemperature |
||
refreshControllerSoftwareVersion |
||
refreshCurrentIonization |
||
refreshDomesticHotWaterTemperature |
||
refreshFanSpeed |
||
refreshFinTubeExchangerOutletRefrigerantTemperature |
||
refreshFlowSensorTemperature |
||
refreshHeatPumpOutsideTemperature |
||
refreshHeatPumpSupplyTemperature |
||
refreshHeatPumpTemperature |
||
refreshInputVoltage |
||
refreshInstantaneousPower |
||
refreshOperatingHoursCount |
||
refreshOutdoorSensorTemperature |
||
refreshProgramCircuitA |
||
refreshProgramCircuitB |
||
refreshProgramCircuitC |
||
refreshRefrigerantHeatPumpTemperature |
||
refreshRoomSensorTemperature |
||
refreshSolarCollectorTemperature |
||
refreshSolarHotWaterTemperature |
||
refreshStagesOperating |
||
refreshStorageTankSensorTemperature |
||
refreshSwimmingPoolWaterSensorTemperature |
||
refreshSystemInputFunction |
||
refreshWaterPressure |
||
refreshWishedComfortPeriodTemperature |
||
refreshWishedDomesticHotWaterTemperature |
||
refreshWishedReducedPeriodTemperature |
||
refreshWishedSwimmingPoolTemperature |
||
setCalculatedWaterSetPointTemperature |
INT | |
setCircuitAType |
INT | |
setCircuitBType |
INT | |
setCircuitCType |
INT | |
setCircuitType |
INT | |
setProgramCircuitA |
INT | |
setProgramCircuitB |
INT | |
setProgramCircuitC |
INT | |
setSystemInputFunction |
INT | |
setWaterPressure |
INT | |
setWishedComfortPeriodTemperature |
INT | |
setWishedDomesticHotWaterTemperature |
INT | |
setWishedReducedPeriodTemperature |
INT | |
setWishedSwimmingPoolTemperature |
INT |
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
AverageFlowSensorTemperatureState |
ContinuousState | ||
BoilerTypeState |
DiscreteState | SBK, normale | |
BoilersStartsCountState |
DataState | ||
CalculatedOutletSetPointTemperatureState |
ContinuousState | ||
CalculatedWaterSetPointTemperatureState |
ContinuousState | ||
CascadeTemperatureState |
ContinuousState | ||
CircuitATypeState |
DiscreteState | aux, chaud, dhw | |
CircuitBTypeState |
DiscreteState | aux, chaud, dhw | |
CircuitCTypeState |
DiscreteState | aux, chaud, dhw | |
CircuitTypeState |
DataState | ||
CompressorOutletTemperatureState |
ContinuousState | ||
ControllerSoftwareVersionState |
DataState | ||
CurrentIonizationState |
ContinuousState | ||
DomesticHotWaterTemperatureState |
ContinuousState | ||
FanSpeedState |
ContinuousState | ||
FinTubeExchangerOutletRefrigerantTemperatureState |
ContinuousState | ||
FlowSensorTemperatureState |
ContinuousState | ||
HeatPumpOutsideTemperatureState |
ContinuousState | ||
HeatPumpSupplyTemperatureState |
ContinuousState | ||
HeatPumpTemperatureState |
ContinuousState | ||
InputVoltageState |
ContinuousState | ||
InstantaneousPowerState |
ContinuousState | ||
OperatingHoursCountState |
DataState | ||
OutdoorSensorTemperatureState |
ContinuousState | ||
ProgramCircuitAState |
DataState | ||
ProgramCircuitBState |
DataState | ||
ProgramCircuitCState |
DataState | ||
RefrigerantHeatPumpTemperatureState |
ContinuousState | ||
RoomSensorTemperatureState |
ContinuousState | ||
SolarCollectorTemperatureState |
ContinuousState | ||
SolarHotWaterTemperatureState |
ContinuousState | ||
StagesOperatingState |
DataState | ||
StorageTankSensorTemperatureState |
ContinuousState | ||
SwimmingpoolWaterSensorTemperatureState |
ContinuousState | ||
SystemInputFunctionState |
DiscreteState | Boucle DHW, Piscine, aux | |
WaterPressureState |
ContinuousState | ||
WishedComfortPeriodTemperatureState |
ContinuousState | ||
WishedDomesticHotWaterTemperatureState |
ContinuousState | ||
WishedReducedPeriodTemperatureState |
ContinuousState | ||
WishedSwimmingpoolTemperatureState |
ContinuousState |
unknown (ACTUATOR) — 177 commands, 119 states
Type IDs: 13 | Servers: hi_kumo_europe, rexel, somfy_europe | Controllable: modbus:FlaktWoodsRS485Component | Profiles: Specific
Commands
| Command | Parameters | Notes |
|---|---|---|
refreshAcknowledgeAll |
refresh the acknowledge all state | |
refreshActiveTemperatureSetpoint |
||
refreshAdditionalStandbyFan |
Refresh Additional Standby Fan | |
refreshAirFlowExtractAir |
||
refreshAirFlowSupplyAir |
||
refreshAirflowControlExtract |
Refresh Airflow Control Extract | |
refreshAirflowControlSupply |
Refresh Airflow Control Supply | |
refreshAlarmRelay |
refresh the alarm relay state | |
refreshBMSTempControlYesNoState |
refresh BMS Temp Control Yes/No state | |
refreshBasicHMISpeed |
||
refreshBlockCoolingIfWinterYesNoState |
refresh Block Cooling If Winter Yes/No state | |
refreshBlockWarmingIfSummerYesNoState |
refresh Block Warming If Summer Yes/No state | |
refreshBoostRunningTime |
Refresh Boost Running Time | |
refreshBoostRunningTimer |
Refresh Boost Running Timer | |
refreshBootloaderVersion |
refresh the bootloader version state | |
refreshByPassDamper |
||
refreshCO2 |
||
refreshColdCornerDefrostAir |
||
refreshCommissioning |
refresh the Commissioning state | |
refreshCookerHoodSwitch |
||
refreshCoolSequenceYesNoState |
refresh Cool sequence Yes/No state | |
refreshCooling |
||
refreshCoolingDXYesNoState |
refresh Cooling DX Yes/No state | |
refreshCoolingOutputSignal |
refresh Cooling Output Signal | |
refreshDeadZoneOutputSignal |
refresh Dead Zone Output Signal | |
refreshDeadZoneYesNoState |
refresh dead zone Yes/No state | |
refreshDecreaseFanSpeedYesNoState |
refresh Decrease Fan Speed Yes/No state | |
refreshDefrostingFunction |
refresh the defrosting function state | |
refreshDirtyFilter |
||
refreshDirtyFilterAlarmTime |
||
refreshExternalTimer1 |
||
refreshExternalTimer2 |
||
refreshExtractFanError |
||
refreshExtractFanSpeedBoost |
||
refreshExtractFanSpeedCookerHood |
||
refreshExtractFanSpeedFireplace |
||
refreshExtractFanSpeedHome |
||
refreshExtractFanSpeedTrickle |
||
refreshExtractRoomAir |
||
refreshFanReduceSpeedOutputSignal |
refresh Fan Reduce Speed Output Signal | |
refreshFanSpeedExtractAir |
||
refreshFanSpeedFromBMSTimer |
Refresh Fan Speed From BMS Timer | |
refreshFanSpeedSupplyAir |
||
refreshFilterAlarmExhaustAir |
||
refreshFilterAlarmSupplyAir |
||
refreshFilterOrFanPressureSwitch |
Refresh Filter Or Fan Pressure Switch | |
refreshFireAlarm |
||
refreshFireAlarmFunctionStopRun |
Refresh Fire Alarm Function Stop Run | |
refreshFireplaceTimer |
Refresh Fireplace Timer | |
refreshFreezingHotWaterBattery |
||
refreshFreezingProtectionPostHeater |
||
refreshFrostAlarmPHE |
||
refreshHeatExchangeOutputSignal |
refresh Heat Exchange Output Signal | |
refreshHeatExchangerDeadZone |
refresh Heat Exchanger Dead Zone | |
refreshHeatExchangerYesNoState |
refresh heat exchanger Yes/No state | |
refreshHumidity1 |
||
refreshHumidity2 |
||
refreshIsAbsoluteCalendarSetpoint |
Refresh Is Absolute Calendar Setpoint | |
refreshMainSwitch |
||
refreshMaxSupplyAirTemperature |
||
refreshMinExtractFanSpeed |
Refresh Min Extract Fan Speed | |
refreshMinSupplyAirTemperature |
||
refreshMinSupplyFanSpeed |
Refresh Min Supply Fan Speed | |
refreshNightCoolingState |
refresh the night cooling state | |
refreshOutDoorAir |
||
refreshOutdoorExtractAirTempDiff |
Refresh Outdoor Extract Air Temp Diff | |
refreshOverHeatingElectricalHeater |
||
refreshPostHeater |
refresh the post heater state | |
refreshPostHeaterOutOfRange |
||
refreshPostHeaterYesNoState |
refresh Post Heater Yes/No state | |
refreshPostHeating |
||
refreshPostHeatingOutputSignal |
refresh Post Heating Output Signal | |
refreshPreHeater |
refresh the pre heater state | |
refreshPreHeaterOutOfRange |
||
refreshPreHeating |
||
refreshPressureControlExtract |
Refresh Pressure Control Extract | |
refreshPressureControlSupply |
Refresh Pressure Control Supply | |
refreshPressureExtractAir |
||
refreshPressureSupplyAir |
||
refreshPressureSwitchExhaustFilter |
||
refreshPressureSwitchSupplyFilter |
||
refreshPumpCoolingMalfunction |
||
refreshPumpHeaterMalfunction |
||
refreshRHEFailure |
||
refreshRampValue |
refresh Ramp Value | |
refreshRotaryHeatExchanger |
||
refreshRotorBeltOffAlarm |
refresh the rotor belt off alarm state | |
refreshSensorErrorAI10 |
refresh the sensor error AI10 state | |
refreshSensorErrorAI5 |
refresh the sensor error AI5 state | |
refreshSensorErrorExtractRoomTemp |
||
refreshSensorErrorFrostProtectPostH |
||
refreshSensorErrorOutDoorTemp |
||
refreshSensorErrorSupplyTemp |
||
refreshSetPoint |
Refresh setpoint | |
refreshSetPointAirPressure |
Refresh SetPoint Air Pressure | |
refreshSetPointCO2 |
||
refreshSetpoint |
Refresh Setpoint | |
refreshSetpointAirAirFlow |
Refresh Setpoint Air Air Flow | |
refreshSetpointAirAirflowBoost |
Refresh setpoint air airflow boost | |
refreshSetpointAirAirflowTrickle |
Refresh Setpoint Air Airflow Trickle | |
refreshSetpointAirPressureBoost |
Refresh Setpoint Air Pressure Boost | |
refreshSetpointAirPressureNormal |
Refresh Setpoint Air Pressure Normal | |
refreshSetpointAirPressureTrickle |
Refresh Setpoint Air Pressure Trickle | |
refreshShutdownTime |
Refresh Shutdown Time | |
refreshSoftwareFloatVersion |
refresh the software version state | |
refreshStartupTime |
Refresh startup time | |
refreshSummaryAlarmCooler |
||
refreshSummerWinterMode |
||
refreshSupplyAir |
||
refreshSupplyFanError |
||
refreshSupplyFanSpeedBoost |
||
refreshSupplyFanSpeedCookerHood |
||
refreshSupplyFanSpeedFireplace |
||
refreshSupplyFanSpeedHome |
||
refreshSupplyFanSpeedTrickle |
||
refreshSystemType |
refresh the system type state | |
refreshTemperatureAlarm |
refresh the temperature alarm state | |
refreshTotalAlarms1 |
Refresh Total Alarms 1 | |
refreshTotalAlarms2 |
Refresh Total Alarms 2 | |
setAcknowledgeAll |
STRING: no, yes | set acknowledge all parameter |
setActiveTemperatureSetpoint |
INT | |
setBMSTempControlYesNoState |
STRING: no, yes | set BMS temp control Yes/No state |
setBasicHMISpeed |
STRING: boost, home, trickle | Set the Basic HMI Speed |
setBlockCoolingIfWinterYesNoState |
STRING: no, yes | set block cooling if winter Yes/No state |
setBlockWarmingIfSummerYesNoState |
STRING: no, yes | set block warming if summer Yes/No state |
setCommissioning |
STRING: complete, notComplete | set the Commisioning parameter |
setCoolSequenceYesNoState |
STRING: no, yes | set cool sequence Yes/No state |
setCoolingDXYesNoState |
STRING: no, yes | set cooling DX Yes/No state |
setDeadZoneOutputSignal |
FLOAT [0.5..25.5] | set dead zone output signal |
setDeadZoneYesNoState |
STRING: no, yes | set dead zone Yes/No state |
setDecreaseFanSpeedYesNoState |
STRING: no, yes | set decrease fan speed Yes/No state |
setDefrostingFunctionRunning |
STRING: no, yes | start/stop the defrosting function |
setDirtyFilter |
STRING: no, yes | Set the dirty filter |
setDirtyFilterAlarmTime |
ANY | |
setExtractFanError |
STRING: no, yes | Set the extract fan error |
setExtractFanSpeedBoost |
INT | |
setExtractFanSpeedCookerHood |
INT | |
setExtractFanSpeedFireplace |
INT | |
setExtractFanSpeedHome |
INT | |
setExtractFanSpeedTrickle |
INT | |
setFilterAlarmExhaustAir |
STRING: no, yes | Set the Filter Alarm Exhaust Air |
setFilterAlarmSupplyAir |
STRING: no, yes | Set the Filter Alarm Supply Air |
setFireAlarm |
STRING: no, yes | set fire alarm |
setFreezingHotWaterBattery |
STRING: no, yes | set freezing hot water battery |
setFrostAlarmPHE |
STRING: no, yes | Set the Frost Alarm PHE |
setHeatExchangerDeadZone |
FLOAT [-25.0..0.0] | set heat exchanger dead zone |
setHeatExchangerYesNoState |
STRING: no, yes | set heat exchanger Yes/No state |
setMainSwitch |
STRING: auto, fireplace, hand, off | Set the Main Switch |
setMaxSupplyAirTemperature |
INT | |
setMinSupplyAirTemperature |
INT | |
setOverHeatingElectricalHeater |
STRING: no, yes | Set the over heating electrical heater |
setPostHeaterOutOfRange |
STRING: no, yes | Set the Post Heater Out Of Range |
setPostHeaterYesNoState |
STRING: no, yes | set post heater Yes/No state |
setPreHeaterOutOfRange |
STRING: no, yes | Set the PreHeater Out Of Range |
setPumpCoolingMalfunction |
STRING: no, yes | Set the Pump Cooling Malfunction |
setPumpOrHeaterMalfunction |
STRING: no, yes | set pump or heater malfunction |
setRHEFailure |
STRING: no, yes | Set the RHE Failure |
setRampValue |
INT [0..100] | set heat exchanger dead zone |
setRotorBeltOffAlarm |
STRING: no, yes | start/stop the rotor belt off alarm |
setSensorErrorAI10 |
STRING: no, yes | set the sensor error AI10 |
setSensorErrorAI5 |
STRING: no, yes | set the sensor error AI5 |
setSensorErrorExtractRoomTemp |
STRING: no, yes | Set the Sensor Error Extract Room Temperature |
setSensorErrorFrostProtect |
STRING: no, yes | set sensor frost protect |
setSensorErrorOutDoorTemp |
STRING: no, yes | Set the Sensor Error OutDoorTemperature |
setSensorErrorSupplyTemp |
STRING: no, yes | Set the Sensor Error Supply Temperature |
setSetPoint |
FLOAT | |
setSetPointCO2 |
INT | |
setSummaryAlarmCooler |
STRING: no, yes | Set the Summary Alarm Cooler |
setSummerWinterMode |
STRING: summer, winter | set summer/winter mode |
setSupplyFanError |
STRING: no, yes | set the supply fan error |
setSupplyFanSpeedBoost |
INT | |
setSupplyFanSpeedCookerHood |
INT | |
setSupplyFanSpeedFireplace |
INT | |
setSupplyFanSpeedHome |
INT | |
setSupplyFanSpeedTrickle |
INT | |
setSystemType |
STRING: EcoSTAR, Ilox, RDKR, TopMaster | set the system type parameter |
setTemperatureAlarm |
STRING: no, yes | start/stop the temperature alarm |
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
AcknowledgeAllState |
DiscreteState | no, yes | |
ActiveTemperatureSetpointState |
ContinuousState | ||
AdditionalStandByFanState |
DiscreteState | no, yes | |
AirFlowExtractAirState |
ContinuousState | ||
AirFlowSupplyAirState |
ContinuousState | ||
AirflowControlExtractState |
DiscreteState | no, yes | |
AirflowControlSupplyState |
DiscreteState | no, yes | |
AlarmRelayState |
DiscreteState | off, on | |
BMSTempControlYesNoState |
DiscreteState | no, yes | |
BasicHMISpeedState |
DiscreteState | boost, home, trickle | |
BlockCoolingIfWinterYesNoState |
DiscreteState | no, yes | |
BlockWarmingIfSummerYesNoState |
DiscreteState | no, yes | |
BoostRunningTimeState |
DataState | ||
BoostRunningTimerState |
DiscreteState | no, yes | |
BootloaderVersionState |
ContinuousState | ||
ByPassDamperState |
DiscreteState | no, yes | |
CO2State |
ContinuousState | ||
ColdCornerDefrostAirState |
ContinuousState | ||
CommissioningState |
DiscreteState | complete, notComplete | |
CookerHoodSwitchState |
DiscreteState | no, yes | |
CoolSequenceYesNoState |
DiscreteState | no, yes | |
CoolingDXYesNoState |
DiscreteState | no, yes | |
CoolingOutputSignalState |
ContinuousState | ||
CoolingState |
DataState | ||
DeadZoneOutputSignalState |
ContinuousState | ||
DeadZoneYesNoState |
DiscreteState | no, yes | |
DecreaseFanSpeedYesNoState |
DiscreteState | no, yes | |
DefrostingFunctionRunningState |
DiscreteState | no, yes | |
DirtyFilterAlarmTimeState |
DataState | ||
DirtyFilterState |
DiscreteState | no, yes | |
ExternalTimer1State |
DiscreteState | no, yes | |
ExternalTimer2State |
DiscreteState | no, yes | |
ExtractFanErrorState |
DiscreteState | no, yes | |
ExtractFanSpeedBoostState |
DataState | ||
ExtractFanSpeedCookerHoodState |
DataState | ||
ExtractFanSpeedFireplaceState |
DataState | ||
ExtractFanSpeedHomeState |
DataState | ||
ExtractFanSpeedTrickleState |
DataState | ||
ExtractRoomAirState |
ContinuousState | ||
FanReduceSpeedOutputSignalState |
ContinuousState | ||
FanSpeedExtractAirState |
DataState | ||
FanSpeedFromBMSTimerState |
DiscreteState | boost, home, trickle | |
FanSpeedSupplyAirState |
DataState | ||
FilterAlarmExhaustAirState |
DiscreteState | no, yes | |
FilterAlarmSupplyAirState |
DiscreteState | no, yes | |
FilterOrFanPressureSwitchState |
DiscreteState | fan, filter | |
FireAlarmFunctionStopRunState |
DiscreteState | runAHU, runExtractFan, runSupplyFan, stopAHU | |
FireAlarmState |
DiscreteState | no, yes | |
FireplaceTimerState |
DataState | ||
FlaktwoodsSoftwareVersionState |
ContinuousState | ||
FreezingHotWaterBatteryState |
DiscreteState | no, yes | |
FreezingProtectionPostHeaterState |
ContinuousState | ||
FrostAlarmPHEState |
DiscreteState | no, yes | |
HeatExchangeOutputSignalState |
ContinuousState | ||
HeatExchangerDeadZoneState |
ContinuousState | ||
HeatExchangerYesNoState |
DiscreteState | no, yes | |
Humidity1State |
DataState | ||
Humidity2State |
DataState | ||
IsAbsoluteCalendarSetpointState |
DiscreteState | no, yes | |
MainSwitchState |
DiscreteState | auto, fireplace, hand, off | |
MaxSupplyAirTemperatureState |
ContinuousState | ||
MinExtractFanSpeedState |
DataState | ||
MinSupplyAirTemperatureState |
ContinuousState | ||
MinSupplyFanSpeedState |
DataState | ||
NightCoolingRunningState |
DiscreteState | yes | |
OutDoorAirState |
ContinuousState | ||
OutdoorExtractAirTempDiffState |
DataState | ||
OverHeatingElectricalHeaterState |
DiscreteState | no, yes | |
PostHeaterOutOfRangeState |
DiscreteState | no, yes | |
PostHeaterState |
DiscreteState | off, on | |
PostHeaterYesNoState |
DiscreteState | no, yes | |
PostHeatingOutputSignalState |
ContinuousState | ||
PostHeatingState |
DataState | ||
PreHeaterOutOfRangeState |
DiscreteState | no, yes | |
PreHeaterState |
DiscreteState | off, on | |
PreHeatingState |
DataState | ||
PressureControlExtractState |
DiscreteState | no, yes | |
PressureControlSupplyState |
DiscreteState | no, yes | |
PressureExtractAirState |
ContinuousState | ||
PressureSupplyAirState |
ContinuousState | ||
PressureSwitchExhaustFilterState |
DiscreteState | no, yes | |
PressureSwitchSupplyFilterState |
DiscreteState | no, yes | |
PumpCoolingMalfunctionState |
DiscreteState | no, yes | |
PumpHeaterMalfunctionState |
DiscreteState | no, yes | |
RHEFailureState |
DiscreteState | no, yes | |
RampValueState |
ContinuousState | ||
RotaryHeatExchangerState |
DataState | ||
RotorBeltOffAlarmState |
DiscreteState | no, yes | |
SensorErrorAI10State |
DiscreteState | no, yes | |
SensorErrorAI5State |
DiscreteState | no, yes | |
SensorErrorExtractRoomTempState |
DiscreteState | no, yes | |
SensorErrorFrostProtectPostHState |
DiscreteState | no, yes | |
SensorErrorOutDoorTempState |
DiscreteState | no, yes | |
SensorErrorSupplyTempState |
DiscreteState | no, yes | |
SetPointCO2State |
ContinuousState | ||
SetPointState |
ContinuousState | ||
SetpointAirAirflowBoostState |
DataState | ||
SetpointAirAirflowNormalState |
DataState | ||
SetpointAirAirflowState |
DataState | ||
SetpointAirAirflowTrickleState |
DataState | ||
SetpointAirPressureBoostState |
DataState | ||
SetpointAirPressureNormalState |
DataState | ||
SetpointAirPressureState |
DataState | ||
SetpointAirPressureTrickleState |
DataState | ||
ShutdownTimeState |
DataState | ||
StartupTimeState |
DataState | ||
SummaryAlarmCoolerState |
DiscreteState | no, yes | |
SummerWinterModeState |
DiscreteState | summer, winter | |
SupplyAirState |
ContinuousState | ||
SupplyFanErrorState |
DiscreteState | no, yes | |
SupplyFanSpeedBoostState |
DataState | ||
SupplyFanSpeedCookerHoodState |
DataState | ||
SupplyFanSpeedFireplaceState |
DataState | ||
SupplyFanSpeedHomeState |
DataState | ||
SupplyFanSpeedTrickleState |
DataState | ||
SystemTypeState |
DiscreteState | EcoSTAR, Ilox, RDKR, TopMaster | |
TemperatureAlarmState |
DiscreteState | no, yes | |
TotalAlarms1State |
DataState | ||
TotalAlarms2State |
DataState |
MODBUSLINK
8 device types.
ElectricitySensor/CumulativeElectricPowerConsumptionSensor (SENSOR) — 1 commands, 11 states
Type IDs: 2199227924480, 2199227990272 | Servers: atlantic_cozytouch | Controllable: modbuslink:DHWCumulatedElectricalEnergyConsumptionMBLSystemDeviceSensor | Profiles: ElectricEnergyConsumption
Commands
| Command | Parameters | Notes |
|---|---|---|
refreshElectricEnergyConsumption |
Refresh the electric energy consumption |
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
ConsumptionTariff0State |
ContinuousState | ||
ConsumptionTariff1State |
ContinuousState | ||
ConsumptionTariff2State |
ContinuousState | ||
ConsumptionTariff3State |
ContinuousState | ||
ConsumptionTariff4State |
ContinuousState | ||
ConsumptionTariff5State |
ContinuousState | ||
ConsumptionTariff6State |
ContinuousState | ||
ConsumptionTariff7State |
ContinuousState | ||
ConsumptionTariff8State |
ContinuousState | ||
ConsumptionTariff9State |
ContinuousState | ||
ElectricEnergyConsumptionState |
ContinuousState |
HeatingSystem/AtlanticElectricalHeaterWithAdjustableTemperatureSetpoint (ACTUATOR) — 49 commands, 26 states
Type IDs: 2199227990272 | Servers: atlantic_cozytouch | Controllable: modbuslink:AtlanticElectricalHeaterWithAdjustableTemperatureSetpointMBLComponent | Profiles: StatefulHeatingLevel, HeatingLevel, StatefulThermostat, Thermostat, StatefulSwitchable, Switchable
Commands
| Command | Parameters | Notes |
|---|---|---|
off |
Turn off the device | |
on |
Turn on the device | |
refreshAbsenceEndDate |
Refresh the end date absence | |
refreshAbsenceMode |
Refresh the absence mode | |
refreshAbsenceStartDate |
Refresh the start date absence | |
refreshBoostActivation |
Refresh the boost activation | |
refreshDateTime |
Refresh the date | |
refreshDiagnostic |
Refresh some states to help problem analysis | |
refreshErrorCode |
Refresh the current error code | |
refreshFridayTimeProgram |
refresh the friday time program | |
refreshHeatingLevel |
Refresh the heating level mode | |
refreshIdentifier |
Refresh the device system identifier (can be used to link several devices) | |
refreshLanguage |
Refresh the language. | |
refreshMaximumHeatingTargetTemperature |
Refresh the maximum heating target temperature | |
refreshMondayTimeProgram |
refresh the monday time program | |
refreshOccupancyActivation |
Refresh the occupancy activation | |
refreshOnOffState |
Get the device on/off state | |
refreshOperatingMode |
Refresh an operating mode. | |
refreshSaturdayTimeProgram |
refresh the saturday time program | |
refreshSetpointLoweringTemperatureInProgMode |
Refresh lowering temperature in the room on prog mode | |
refreshStaticStates1 |
Refresh some static states | |
refreshStaticStates2 |
Refresh some static states | |
refreshSundayTimeProgram |
refresh the sunday time program | |
refreshTargetTemperature |
Refresh the temperature value | |
refreshThursdayTimeProgram |
refresh the thursday time program | |
refreshTuesdayTimeProgram |
refresh the tuesday time program | |
refreshWednesdayTimeProgram |
refresh the wednesday time program | |
setAbsenceEndDate |
OBJECT | Set the end date absence |
setAbsenceMode |
STRING: on, off, prog | Set the absence mode |
setAbsenceStartDate |
OBJECT | Set the start date absence |
setBoostActivation |
STRING: inactive, active | Activate the boost |
setDateTime |
OBJECT | Set the date and time |
setFridayTimeProgram |
OBJECT | set friday timeProgram |
setHeatingLevel |
STRING: comfort, boost, eco | Sets the device heating level mode |
setLanguage |
STRING: fr, en, es, nl, pt | Set the language |
setMaximumHeatingTargetTemperature |
FLOAT [19.0..30.0] | Set the maximum heating target temperature (manual set point) |
setMondayTimeProgram |
OBJECT | set monday timeProgram |
setOccupancyActivation |
STRING: inactive, active | Active the occupancy function. |
setOnOff |
STRING: off, on | Turn the device on or off |
setOperatingMode |
STRING: manual, prog, auto | Set an operating mode |
setSaturdayTimeProgram |
OBJECT | set saturday timeProgram |
setSetpointLoweringTemperatureInProgMode |
FLOAT [6.0..19.0]; STRING: off | Set lowering temperature in the room on prog mode |
setSundayTimeProgram |
OBJECT | set sunday timeProgram |
setTargetTemperature |
INT: 7; FLOAT [12.0..30.0] | Set the new air temperature to reach |
setThursdayTimeProgram |
OBJECT | set thursday timeProgram |
setTuesdayTimeProgram |
OBJECT | set tuesday timeProgram |
setWednesdayTimeProgram |
OBJECT | set wednesday timeProgram |
startIdentify |
Ask the device to start winking immediately for an unlimited amount of time | |
stopIdentify |
Ask the device to stop winking immediately |
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
AbsenceEndDateState |
DataState | ||
AbsenceModeState |
DiscreteState | off, on, prog | |
AbsenceStartDateState |
DataState | ||
BoostActivationState |
DiscreteState | active, inactive | |
DateTimeState |
DataState | ||
ErrorCodeState |
DataState | ||
FridayTimeProgramState |
DataState | ||
IdentifierState |
DataState | ||
LanguageState |
ContinuousState | ||
MaximumHeatingTargetTemperatureState |
ContinuousState | ||
MondayTimeProgramState |
DataState | ||
NameState |
DataState | ||
OccupancyActivationState |
DiscreteState | active, inactive | |
OccupancySensorStatusState |
DiscreteState | available, unavailable | |
OnOffState |
DiscreteState | on, off | |
OperatingModeState |
DiscreteState | antifreeze, auto, away, eco, frostprotection | |
SaturdayTimeProgramState |
DataState | ||
SetpointLoweringTemperatureInProgModeState |
ContinuousState | ||
SundayTimeProgramState |
DataState | ||
TargetHeatingLevelState |
DiscreteState | boost, comfort, eco | |
TargetHeatingLevelState |
DiscreteState | boost, comfort, eco | |
TargetTemperatureState |
ContinuousState | [12.0..30.0] | |
ThursdayTimeProgramState |
DataState | ||
TuesdayTimeProgramState |
DataState | ||
VersionState |
ContinuousState | ||
WednesdayTimeProgramState |
DataState |
HumiditySensor/RelativeHumiditySensor (ACTUATOR) — 1 commands, 1 states
Type IDs: 2199040163840 | Servers: atlantic_cozytouch | Controllable: modbuslink:MotorHumiditySensorMBLComponent | Profiles: Specific
Commands
| Command | Parameters | Notes |
|---|---|---|
refreshHumidity |
Refresh the Humidity state |
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
HumidityState |
ContinuousState |
OccupancySensor (SENSOR) — 0 commands, 1 states
Type IDs: 2199227990272 | Servers: atlantic_cozytouch | Controllable: core:OccupancySensor | Profiles: OccupancyDetector
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
OccupancyState |
DiscreteState | personInside, noPersonInside |
SwimmingPool/SwimmingPoolRollerShutter (ACTUATOR) — 5 commands, 5 states
Type IDs: 2199040163840 | Servers: atlantic_cozytouch | Controllable: modbuslink:SwimmingPoolRollerShutterMBLComponent | Profiles: StatefulOpenCloseSwimmingPoolShutter, StatefulOpenClose, OpenClose
Commands
| Command | Parameters | Notes |
|---|---|---|
close |
Fully close the device | |
open |
Fully open the device | |
refreshClosure |
Refresh the closure state | |
setOpenClosed |
STRING: open, closed | Set the device state to either 'open' or 'closed' |
stop |
Stop the current actuator behavior (movement, sound or timer) |
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
ConnectivityState |
DiscreteState | offline, online | |
OpenClosedState |
DiscreteState | open, closed | |
RollerShutterClosureState |
DiscreteState | closed, closing, open, opening, partial, unknown | |
StatusState |
DiscreteState | available, unavailable | |
WatchDogState |
DataState |
TemperatureSensor (ACTUATOR) — 1 commands, 1 states
Type IDs: 2199040163840 | Servers: atlantic_cozytouch | Controllable: modbuslink:PowerSupplyBoxTemperatureSensorMBLComponent | Profiles: Temperature
Commands
| Command | Parameters | Notes |
|---|---|---|
refreshTemperature |
Refresh the last measured temperature |
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
TemperatureState |
ContinuousState | [-100.0..100.0] |
TemperatureSensor (SENSOR) — 0 commands, 1 states
Type IDs: 2199227990272 | Servers: atlantic_cozytouch | Controllable: modbuslink:TemperatureInCelciusMBLSystemDeviceSensor | Profiles: Temperature
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
TemperatureState |
ContinuousState | [-100.0..100.0] |
WaterHeatingSystem/DomesticHotWaterProduction (ACTUATOR) — 51 commands, 43 states
Type IDs: 2199227924480 | Servers: atlantic_cozytouch | Controllable: modbuslink:AtlanticDomesticHotWaterProductionMBLComponent | Profiles: StatefulDHWThermostat, DHWThermostat
Data Properties
core:identifyInterval=500
Commands
| Command | Parameters | Notes |
|---|---|---|
refreshAbsenceEndDate |
Refresh the end date absence | |
refreshAbsenceMode |
Refresh the absence mode | |
refreshAbsenceStartDate |
Refresh the start date absence | |
refreshAntiLegionellosis |
Refresh the anti legionellosis mode | |
refreshBoostElectricPowerConsumption |
Refresh the boost electric power consumption | |
refreshBoostEndDate |
Refresh the end date boost | |
refreshBoostMode |
Refresh the boost mode | |
refreshBoostStartDate |
Refresh the start date boost | |
refreshBottomTankWaterTemperature |
Refresh the bottom of tank water temperature | |
refreshControlWaterTargetTemperature |
Refresh the control target temperature of the water | |
refreshDHWError |
Refresh the DHW error | |
refreshDHWMode |
Refresh the DHW mode | |
refreshDateTime |
Refresh the date | |
refreshDiagnostic |
Refresh some states to help problem analysis | |
refreshElectricBoosterOperatingTime |
Refresh the electical operating time | |
refreshExpectedNumberOfShower |
Refresh the expected number of shower | |
refreshHeatPumpOperatingTime |
Refresh the heat pump operating time | |
refreshHeatingStatus |
Refresh the heating status | |
refreshIHMType |
Refresh the IHM type state | |
refreshManufacturer |
Refresh the manufacturer state | |
refreshMiddleWaterTemperature |
Refresh the middle water temperature | |
refreshMiddleWaterTemperatureIn |
Refresh the middle water temperature in | |
refreshNumberControlShowerRequest |
Refresh the automatic number of shower | |
refreshNumberOfShowerRemaining |
Refresh the number of shower remaining | |
refreshOperatingRange |
Refresh the operating range state | |
refreshPowerHeatElectrical |
Refresh the power heat electrical | |
refreshPowerHeatElectricalIn |
Refresh the power heat electrical in | |
refreshPowerHeatPump |
Refresh the power heat pump | |
refreshProgrammingAvailable |
Refresh the programming available | |
refreshProgrammingSlots |
Refresh the programming slots | |
refreshRemainingHotWater |
Refresh the remaining hot water | |
refreshSmartGridOption |
Refresh the smart grid option | |
refreshStaticStates1 |
Refresh some static states | |
refreshStaticStates2 |
Refresh some static states | |
refreshV40WaterVolumeEstimation |
Refresh the V40 water volume estimation | |
refreshWaterTargetTemperature |
Refresh the target temperature of the water | |
setAbsenceEndDate |
OBJECT | Set the end date absence |
setAbsenceMode |
STRING: on, off, prog | Set the absence mode |
setAbsenceStartDate |
OBJECT | Set the start date absence |
setAntiLegionellosis |
INT [0..4] | Set how many time the anti legionellosis have to be activated per month |
setBoostEndDate |
OBJECT | Set the end date boost |
setBoostMode |
STRING: on, off, prog | Set the boost mode |
setBoostStartDate |
OBJECT | Set the start date boost |
setDHWMode |
STRING: autoMode, manualEcoActive, manualEcoInactive | Change the mode |
setDateTime |
OBJECT | Set the date and time |
setExpectedNumberOfShower |
INT [0..5] | Set the expected number of shower |
setOperatingRange |
STRING: pac24h_elec24h, pac24h_elecHC, pac24h_elecProg, pacHC_elecHC, pacProg_elecProg | Change the DHW's operating range |
setProgrammingSlots |
OBJECT | Set programming slots Constraints: - Slot 2 is optional - Minutes have to be increase by step of 10 - Minimum duration for slot 1 - 4h if slot 2 is set - 8h otherwise - Maximum duration for slot 1 - 12h - Minimum duration of slot 2 - 0h if not set - 4h otherwise - Maximum duration of slot 2 - 8h - Slot can't be stacked Example: { "slot1": { "start": "08:30", "end": "17:50" }, "slot2": { "start": "00:00", "end": "00:00" } } |
setSmartGridOption |
STRING: active, deactive | Activate or deactivate smart grid option |
setTargetDHWTemperature |
FLOAT [5.0..70.0] | Set the new water temperature to reach for a Domestic Hot Water system |
setWaterTargetTemperature |
FLOAT [5.0..70.0] | Set the target temperature of the water |
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
AbsenceEndDateState |
DataState | ||
AbsenceStartDateState |
DataState | ||
AntiLegionellosisState |
ContinuousState | ||
BoostElectricPowerConsumptionState |
ContinuousState | ||
BoostEndDateState |
DataState | ||
BoostStartDateState |
DataState | ||
BottomTankWaterTemperatureState |
ContinuousState | ||
ControlWaterTargetTemperatureState |
ContinuousState | ||
DHWAbsenceModeState |
DiscreteState | off, on, prog | |
DHWBoostModeState |
DiscreteState | off, on, prog | |
DHWCapacityState |
ContinuousState | ||
DHWErrorState |
DataState | ||
DHWModeState |
DiscreteState | auto, eco, manual | |
DateTimeState |
DataState | ||
ElectricBoosterOperatingTimeState |
ContinuousState | ||
ExpectedNumberOfShowerState |
ContinuousState | ||
HeatPumpOperatingTimeState |
ContinuousState | ||
HeatingStatusState |
DataState | ||
IHMTypeState |
DiscreteState | IHMNO2, WaterdropCE, WaterdropCETHI | |
ManufacturerNameState |
DataState | ||
ManufacturerState |
DiscreteState | Atlantic, Deltadore | |
MaximalShowerManualModeState |
ContinuousState | ||
MaximalTemperatureManualModeState |
ContinuousState | ||
MiddleWaterTemperatureInState |
ContinuousState | ||
MiddleWaterTemperatureState |
ContinuousState | ||
MinimalShowerManualModeState |
ContinuousState | ||
MinimalTemperatureManualModeState |
ContinuousState | ||
NameState |
DataState | ||
NumberControlShowerRequestState |
ContinuousState | ||
NumberOfShowerRemainingState |
ContinuousState | ||
NumberOfTankState |
ContinuousState | ||
OperatingRangeState |
DiscreteState | pac24h_elec24h, pac24h_elecHC, pac24h_elecProg, pacHC_elecHC, pacProg_elecProg | |
PowerHeatElectricalInState |
ContinuousState | ||
PowerHeatElectricalState |
DataState | ||
PowerHeatPumpState |
DataState | ||
ProgrammingAvailableState |
DataState | ||
ProgrammingSlotsState |
DataState | ||
RemainingHotWaterState |
ContinuousState | ||
SmartGridOptionState |
DiscreteState | active, deactive | |
StopRelaunchState |
DataState | ||
TargetDHWTemperatureState |
ContinuousState | [38.0..60.0] | |
V40WaterVolumeEstimationState |
DataState | ||
WaterTargetTemperatureState |
ContinuousState |
MYFOX
9 device types.
Alarm/MyFoxAlarmController (ACTUATOR) — 5 commands, 4 states
Type IDs: 1, 2, 38 | Servers: rexel, somfy_europe | Controllable: myfox:AlarmController | Profiles: Alarm
Commands
| Command | Parameters | Notes |
|---|---|---|
arm |
Arm the system | |
disarm |
Disarm the system | |
partial |
Activate night mode | |
refreshAlarmStatus |
Refresh the status of the system | |
setAlarmStatus |
STRING: armed, disarmed, partial | Set the system to the given value |
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
AlarmStatusState |
DiscreteState | armed, disarmed, partial | |
AlertTrespassState |
DataState | ||
PowerSupplyUpDownState |
DiscreteState | down, up | |
StatusState |
DiscreteState | available, unavailable |
Alarm/MyFoxAlarmController (ACTUATOR) — 6 commands, 5 states
Type IDs: 103 | Servers: rexel, somfy_europe | Controllable: myfox:SomfyProtectAlarmController | Profiles: Alarm, IntrusionDetector
Commands
| Command | Parameters | Notes |
|---|---|---|
arm |
Arm the system | |
disarm |
Disarm the system | |
partial |
Activate night mode | |
refreshAlarmStatus |
Refresh the status of the system | |
setAlarmStatus |
STRING: armed, disarmed, partial | Set the system to the given value |
trespass |
Trigger an alarm of the type trespass |
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
AlarmStatusState |
DiscreteState | armed, disarmed, partial | |
AlertTrespassState |
DataState | ||
CloudDeviceStatusState |
DiscreteState | offline, online, uninstalled | |
IntrusionState |
DiscreteState | detected, notDetected | |
StatusState |
DiscreteState | available, unavailable |
Camera/MyFoxCamera (ACTUATOR) — 3 commands, 1 states
Type IDs: 26 | Servers: rexel, somfy_europe | Controllable: myfox:CameraController | Profiles: PictureCamera
Commands
| Command | Parameters | Notes |
|---|---|---|
recordingStart |
||
recordingStop |
||
takePicture |
Take a still picture |
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
StatusState |
DiscreteState | available, unavailable |
Camera/MyFoxSecurityCamera (ACTUATOR) — 0 commands, 0 states
Type IDs: 63 | Servers: rexel, somfy_europe | Controllable: myfox:SecurityCameraController | Profiles: Specific
Camera/MyFoxSecurityCamera (ACTUATOR) — 6 commands, 4 states
Type IDs: 100, 101, 104, 105, 111 | Servers: rexel, somfy_europe | Controllable: myfox:SomfyProtectSecurityCameraController | Profiles: OpenCloseCameraShutter, BasicOpenClose
Commands
| Command | Parameters | Notes |
|---|---|---|
close |
Fully close the device | |
getName |
Refresh the device internal name | |
open |
Fully open the device | |
refreshDeviceStatus |
Refresh the device status | |
refreshShutterStatus |
Refresh the shutter status | |
setName |
STRING | Change the device internal name. Name length may be subject to restrictions depending on the device and underlying protocol. |
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
CloudDeviceStatusState |
DiscreteState | offline, online, uninstalled | |
NameState |
DataState | ||
ShutterStatusState |
DiscreteState | closed, opened | |
StatusState |
DiscreteState | available, unavailable |
Camera/MyFoxSecurityCamera (ACTUATOR) — 6 commands, 5 states
Type IDs: 102 | Servers: rexel, somfy_europe | Controllable: myfox:SomfyOnePlusCameraController | Profiles: OpenCloseCameraShutter, BasicOpenClose
Commands
| Command | Parameters | Notes |
|---|---|---|
close |
Fully close the device | |
getName |
Refresh the device internal name | |
open |
Fully open the device | |
refreshDeviceStatus |
Refresh the device status | |
refreshShutterStatus |
Refresh the shutter status | |
setName |
STRING | Change the device internal name. Name length may be subject to restrictions depending on the device and underlying protocol. |
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
CloudDeviceStatusState |
DiscreteState | offline, online, uninstalled | |
NameState |
DataState | ||
PowerSupplyUpDownState |
DiscreteState | down, up | |
ShutterStatusState |
DiscreteState | closed, opened | |
StatusState |
DiscreteState | available, unavailable |
ContactSensor (SENSOR) — 1 commands, 3 states
Type IDs: 112 | Servers: rexel, somfy_europe | Controllable: myfox:SomfyProtectDoor | Profiles: DoorContactSensor, ContactDetector
Commands
| Command | Parameters | Notes |
|---|---|---|
refreshDoorLockStatus |
Refresh the door lock status |
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
BatteryDiscreteLevelState |
DiscreteState | good, medium, low, critical | |
ContactState |
DiscreteState | open, closed | |
StatusState |
DiscreteState | available, unavailable |
DoorLock (ACTUATOR) — 3 commands, 4 states
Type IDs: 112 | Servers: rexel, somfy_europe | Controllable: myfox:SomfyProtectDoorLock | Profiles: StatefulDoorLock, StatefulLock, LockStatus, Lock
Commands
| Command | Parameters | Notes |
|---|---|---|
lock |
Lock the device | |
refreshDoorLockStatus |
Refresh the door lock status | |
unlock |
Unlock the device |
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
BatteryDiscreteLevelState |
DiscreteState | good, medium, low, critical | |
LockedUnlockedState |
DiscreteState | locked, unlocked | |
MovingState |
DiscreteState | false, true | |
StatusState |
DiscreteState | available, unavailable |
Light/StatefulOnOffLight (ACTUATOR) — 5 commands, 2 states
Type IDs: 105, 111 | Servers: rexel, somfy_europe | Controllable: myfox:LightController | Profiles: StatefulSwitchableLight, StatefulSwitchable, Switchable
Commands
| Command | Parameters | Notes |
|---|---|---|
off |
Turn off the device | |
on |
Turn on the device | |
onWithTimer |
INT [5..14400] | Turn the device on for a given amount of seconds then turn it off |
refreshOnOffState |
Get the device on/off state | |
setOnOff |
STRING: off, on | Turn the device on or off |
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
OnOffState |
DiscreteState | on, off | |
StatusState |
DiscreteState | available, unavailable |
NEST
4 device types.
ConfigurationComponent/NestStructureConfiguration (ACTUATOR) — 4 commands, 1 states
Type IDs: 2 | Servers: rexel | Controllable: nest:NestConfigurationStructureController | Profiles: OccupancyDetector
Commands
| Command | Parameters | Notes |
|---|---|---|
noPersonInside |
Set that end-user is not around the device | |
personInside |
Set that end-user is around the device | |
refreshOccupancy |
Refresh occupancy state | |
setOccupancy |
STRING: noPersonInside, personInside | Set if end-user is around the device or not |
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
OccupancyState |
DiscreteState | personInside, noPersonInside |
HeatingSystem/NestHeatingTemperatureInterface (ACTUATOR) — 17 commands, 32 states
Type IDs: 1 | Servers: rexel | Controllable: nest:NestThermostatController | Profiles: OperatingModeHeating, ThermostatTargetReader, LockStatus
Commands
| Command | Parameters | Notes |
|---|---|---|
refreshFanTimerActive |
Refresh fan timer active | |
refreshFanTimerDuration |
Refresh fan timer duration | |
refreshLabel |
Refresh label | |
refreshLockedUnlocked |
Refresh locked/unlocked state | |
refreshMaximumTargetTemperature |
Refresh the maximum target temperature value | |
refreshMinimumTargetTemperature |
Refresh the minimum target temperature value. | |
refreshOperatingMode |
Refresh an operating mode. | |
refreshTargetTemperature |
Refresh the temperature value | |
refreshTemperatureUnit |
Refresh temperature unit | |
setFanTimerActive |
STRING: true, false | Indicates if the fan timer is engaged |
setFanTimerDuration |
INT: 15, 30, 45, 60, 120 | Specifies the length of time (in minutes) that the fan is set to run |
setLabel |
STRING | Thermostat custom label |
setMaximumTargetTemperature |
FLOAT [9.0..32.0] | Maximum target temperature, in half degrees (0.5°C) |
setMinimumTargetTemperature |
FLOAT [9.0..32.0] | Minimum target temperature, in half degrees (0.5°C) |
setOperatingMode |
STRING: heat, cool, eco, off, heat-cool | Set an operating mode |
setTargetTemperature |
FLOAT [9.0..32.0] | Target temperature, in half degrees (0.5°C) |
setTemperatureUnit |
STRING: fahrenheit, celsius | Set the unit temperature. |
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
ActiveFanState |
DiscreteState | false, true | |
ConnectivityState |
DiscreteState | offline, online | |
CoolActiveState |
DiscreteState | false, true | |
EnergySavingTemperatureState |
DiscreteState | false, true | |
HeatActiveState |
DiscreteState | false, true | |
IdentifierState |
DataState | ||
LabelState |
DataState | ||
LastDeviceConnectionState |
DataState | ||
LocaleState |
DataState | ||
LockedUnlockedState |
DiscreteState | locked, unlocked | |
MaximumEcoHeatingTargetTemperatureState |
ContinuousState | ||
MaximumTargetTemperatureState |
ContinuousState | ||
MinimumEcoHeatingTargetTemperatureState |
ContinuousState | ||
MinimumTargetTemperatureState |
ContinuousState | ||
NameState |
DataState | ||
NestEffectiveOperatingModeState |
ContinuousState | ||
NestEmergencyHeatActiveState |
DiscreteState | false, true | |
NestFanTimerActiveState |
DiscreteState | false, true | |
NestFanTimerDurationState |
ContinuousState | ||
NestFanTimerTimeoutState |
ContinuousState | ||
NestLongNameState |
ContinuousState | ||
NestMaximumLockedTemperatureState |
ContinuousState | ||
NestMinimumLockedTemperatureState |
ContinuousState | ||
NestOperatingModeState |
ContinuousState | ||
NestSunlightCorrectionActiveState |
DiscreteState | false, true | |
NestSunlightCorrectionEnabledState |
DiscreteState | false, true | |
NestTimeToTemperatureState |
ContinuousState | ||
NestTimeToTemperatureTrainingState |
ContinuousState | ||
PreviousOperatingModeState |
DiscreteState | antifreeze, auto, away, eco, frostprotection, manual, max, normal, off, on, program | |
TargetTemperatureState |
ContinuousState | [12.0..30.0] | |
TemperatureUnitState |
ContinuousState | ||
VersionState |
ContinuousState |
HumiditySensor/RelativeHumiditySensor (SENSOR) — 1 commands, 1 states
Type IDs: 1 | Servers: rexel | Controllable: nest:NestThermostatHumiditySensor | Profiles: RelativeHumidity
Commands
| Command | Parameters | Notes |
|---|---|---|
refreshRelativeHumidity |
Refresh the last measured relative humidity |
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
RelativeHumidityState |
ContinuousState | [0.0..100.0] |
TemperatureSensor (SENSOR) — 1 commands, 2 states
Type IDs: 1 | Servers: rexel | Controllable: nest:NestThermostatTemperatureSensor | Profiles: Temperature
Commands
| Command | Parameters | Notes |
|---|---|---|
refreshAmbientTemperature |
Refresh Ambient Temperature |
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
AmbientTemperatureState |
ContinuousState | ||
TemperatureState |
ContinuousState | [-100.0..100.0] |
NETATMO
36 device types.
AirSensor/AirQualitySensor (SENSOR) — 0 commands, 2 states
Type IDs: 4448 | Servers: rexel, somfy_europe | Controllable: netatmo:AirQualityComponent | Profiles: Specific
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
HealthIndexState |
DiscreteState | Healthy, Fine, Fair, Poor, Unhealthy, Error | |
StatusState |
DiscreteState | available, unavailable |
Camera (ACTUATOR) — 0 commands, 7 states
Type IDs: 257, 513 | Servers: rexel, somfy_europe | Controllable: netatmo:WelcomeCameraController | Profiles: CardReader
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
CardPositionState |
DiscreteState | inserted, removed | |
ConnectivityState |
DiscreteState | offline, online | |
LastEventState |
DataState | ||
LastEventTypeState |
DataState | ||
PowerSupplyUpDownState |
DiscreteState | down, up | |
StatusState |
DiscreteState | available, unavailable | |
StreamingURLState |
DataState |
Camera (ACTUATOR) — 0 commands, 8 states
Type IDs: 258, 514 | Servers: rexel, somfy_europe | Controllable: netatmo:PresenceCameraController | Profiles: CardReader
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
CardPositionState |
DiscreteState | inserted, removed | |
ConnectivityState |
DiscreteState | offline, online | |
LastEventState |
DataState | ||
LastEventTypeState |
DataState | ||
NetatmoPresenceLightState |
DiscreteState | auto, off, on | |
PowerSupplyUpDownState |
DiscreteState | down, up | |
StatusState |
DiscreteState | available, unavailable | |
StreamingURLState |
DataState |
CarbonDioxideSensor/CO2Sensor (SENSOR) — 0 commands, 2 states
Type IDs: 4448, 8192, 8196 | Servers: rexel, somfy_europe | Controllable: netatmo:CO2Component | Profiles: CO2Concentration
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
CO2ConcentrationState |
ContinuousState | ||
StatusState |
DiscreteState | available, unavailable |
CircuitBreaker (ACTUATOR) — 6 commands, 8 states
Type IDs: 4361, 4393 | Servers: rexel, somfy_europe | Controllable: netatmo:CircuitBreakerComponent | Profiles: StatefulSwitchablePlug, StatefulSwitchable, Switchable
Commands
| Command | Parameters | Notes |
|---|---|---|
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 | |
onWithTimer |
INT [5..14400] | Turn the device on for a given amount of seconds then turn it off |
refreshState |
Refresh the device states | |
setOnOff |
STRING: off, on | Turn the device on or off |
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
ApplianceTypeState |
DataState | ||
FirmwareRevisionState |
DataState | ||
LastErrorReceivedState |
DataState | ||
LastMessageDateTimeState |
DataState | ||
OffloadState |
DiscreteState | offload, notOffload | |
OnOffState |
DiscreteState | on, off | |
RadioFrequencySignalStrengthState |
DiscreteState | average, bad, full, good, high, low, medium | |
StatusState |
DiscreteState | available, unavailable |
CircuitBreaker/CircuitBreakerPeakAndOffPeak (ACTUATOR) — 4 commands, 8 states
Type IDs: 4377, 4409 | Servers: rexel, somfy_europe | Controllable: netatmo:CircuitBreakerPeakAndOffPeakHoursComponent | Profiles: StatefulOperatingModeHeating, OperatingModeHeating
Commands
| Command | Parameters | Notes |
|---|---|---|
identify |
Ask the device to identify itself by doing a slight movement or blink or beep | |
refreshState |
Refresh the device states | |
setOperatingMode |
STRING: auto, off, boost | Set an operating mode |
setOperatingModeWithTimer |
STRING: auto, boost, off; INT [5..28800]; STRING: auto, boost, off | Set Netatmo operating mode on duration then change it. p1 : The temporary operating mode. p2 : The duration in seconds. p3 : The fallback operating mode. |
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
ApplianceTypeState |
DataState | ||
FirmwareRevisionState |
DataState | ||
LastErrorReceivedState |
DataState | ||
LastMessageDateTimeState |
DataState | ||
OffloadState |
DiscreteState | offload, notOffload | |
OperatingModeState |
DiscreteState | antifreeze, auto, away, eco, frostprotection | |
RadioFrequencySignalStrengthState |
DiscreteState | average, bad, full, good, high, low, medium | |
StatusState |
DiscreteState | available, unavailable |
ConfigurationComponent/NetatmoHome (ACTUATOR) — 10 commands, 8 states
Type IDs: 1 | Servers: rexel, somfy_europe | Controllable: netatmo:HomeController | Profiles: StatefulOperatingModeHeating, OperatingModeHeating
Commands
| Command | Parameters | Notes |
|---|---|---|
createSchedule |
STRING; ARRAY; ARRAY; FLOAT; FLOAT | Create Netatmo schedule. p1 : The schedule name p2 : Array of timetables. minuteOffset max: 10080. Example: [{"zoneId":0,"minuteOffset":0},{"zoneId":0,"minuteOffset":420},...] p3 : Array of zones. Example: [{"id":0,"type":"DAY","name":"my zone","roomTemperature":[{"temperature":17,"roomId":"123456789"},...]},...] p4 : Frost guard temperature value p5 : Away temperature value |
deleteSchedule |
STRING | Delete Netatmo schedule. p1 : The netatmo schedule id |
getScenarios |
Get Netatmo scenarios. | |
getSchedules |
Get Netatmo schedules (sent by event). | |
launchScenario |
STRING | Start a Netatmo scenarios. p1 :The scenario Id |
refreshState |
Refresh the device states | |
renameSchedule |
STRING; STRING | Rename Netatmo schedule. p1 : The netatmo schedule id p2 : The new name |
setActiveSchedule |
STRING | Set Netatmo schedule as active. p1 : The schedule id |
setOperatingMode |
STRING: program, away, frostprotection; INT (optional) | p1: operating mode p2: endTime in seconds. Must be greater than currentTime |
updateSchedule |
STRING; STRING; ARRAY; ARRAY; FLOAT; FLOAT | Update Netatmo schedule. p1 : The schedule id p2 : The schedule name p3 : Array of timetables. minuteOffset max: 10080. Example: [{"zoneId":0,"minuteOffset":0},{"zoneId":0,"minuteOffset":420},...] p4 : Array of zones. Example: [{"id":0,"type":"DAY","name":"my zone","roomTemperature":[{"temperature":17,"roomId":"123456789"},...]},...] p5 : Frost guard temperature value p6 : Away temperature value |
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
DerogationEndDateTimeState |
DataState | ||
LastScenarioLaunchedIdState |
DataState | ||
NameState |
DataState | ||
NetatmoDerogationDefaultDurationState |
DataState | ||
OperatingModeState |
DiscreteState | antifreeze, auto, away, eco, frostprotection | |
ScenariosState |
DataState | ||
ScheduleStatusState |
DataState | ||
ThermalConfigurationState |
DiscreteState | cooling, heating |
ConfigurationComponent/NetatmoHomeCoachConfiguration (SENSOR) — 1 commands, 8 states
Type IDs: 4448, 8192 | Servers: rexel, somfy_europe | Controllable: netatmo:HomeCoachConfigurationComponent | Profiles: Specific
Commands
| Command | Parameters | Notes |
|---|---|---|
refreshState |
Refresh the device states |
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
ApplianceTypeState |
DataState | ||
FirmwareRevisionState |
DataState | ||
LastErrorReceivedState |
DataState | ||
LastMessageDateTimeState |
DataState | ||
OffloadState |
DiscreteState | offload, notOffload | |
PowerSourceState |
DiscreteState | Battery, DC source | |
RadioFrequencySignalStrengthState |
DiscreteState | average, bad, full, good, high, low, medium | |
StatusState |
DiscreteState | available, unavailable |
ConfigurationComponent/NetatmoConfigurationComponent (SENSOR) — 0 commands, 9 states
Type IDs: 8193, 8194, 8195, 8196 | Servers: rexel, somfy_europe | Controllable: netatmo:ConfigurationComponent | Profiles: Specific
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
ApplianceTypeState |
DataState | ||
BatteryState |
DiscreteState | verylow, low, normal, full | |
FirmwareRevisionState |
DataState | ||
LastErrorReceivedState |
DataState | ||
LastMessageDateTimeState |
DataState | ||
OffloadState |
DiscreteState | offload, notOffload | |
PowerSourceState |
DiscreteState | Battery, DC source | |
RadioFrequencySignalStrengthState |
DiscreteState | average, bad, full, good, high, low, medium | |
StatusState |
DiscreteState | available, unavailable |
ElectricitySensor/CumulativeElectricPowerConsumptionSensor (SENSOR) — 1 commands, 1 states
Type IDs: 4098, 4099 | Servers: rexel, somfy_europe | Controllable: netatmo:NetatmoThermostatElectricalConsumptionSensor | Profiles: Specific
Commands
| Command | Parameters | Notes |
|---|---|---|
getHistory |
INT; INT; STRING | Get history from sensor beetween two specific date p1 : from date (timestamp in millisecond) p2 : to date (timestamp in millisecond) p3 : groupBy value (hour, day, month) |
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
StatusState |
DiscreteState | available, unavailable |
ElectricitySensor/CumulativeElectricPowerConsumptionSensor (SENSOR) — 0 commands, 3 states
Type IDs: 4358, 4359, 4360, 4361, 4366, 4376, 4392, 4408, 4424, 4377, 4393, 4409, 4425, 4441 | Servers: rexel, somfy_europe | Controllable: netatmo:ElectricEnergyConsumptionSensor | Profiles: ElectricPowerMeter
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
ElectricPowerConsumptionState |
ContinuousState | ||
LastEnergyOverconsumptionState |
DiscreteState | normal, high, critical | |
StatusState |
DiscreteState | available, unavailable |
HeatingSystem/NetatmoHeatingTemperatureInterface (ACTUATOR) — 6 commands, 14 states
Type IDs: 259, 515 | Servers: rexel, somfy_europe | Controllable: netatmo:NetatmoThermostatController | Profiles: ThermostatTargetReader
Commands
| Command | Parameters | Notes |
|---|---|---|
cancelNetatmoDerogatedTargetTemperature |
Cancel the derogated temperature of the room | |
refreshAllThermostatStates |
Refresh all states of the thermostat. @deprecated : use refreshState instead. | |
refreshState |
Refresh the device states | |
setNetatmoDerogatedTargetRoomTemperature |
FLOAT [5.0..30.0]; INT (optional) | p1: target temperature in Celsius p2: endTime in seconds. Must be greater than currentTime |
setNetatmoDerogatedTimeTargetRoomTemperature |
FLOAT [5.0..30.0]; INT (optional) | Set the derogated temperature in half degrees (0.5°C) of the room and when this new temperature has to end. p1 : The temperature in half degrees (0.5°C) p2 : The duration of the derogation in minute |
setNetatmoOperatingMode |
STRING: program, away, frostprotection, off, max; INT (optional) | p1: operating mode p2: endTime in seconds. Must be greater than currentTime |
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
BatteryLevelState |
ContinuousState | ||
DerogationEndDateTimeState |
DataState | ||
IdentifierState |
DataState | ||
LastDeviceConnectionState |
DataState | ||
NameState |
DataState | ||
NetatmoLastMeasurementTimeState |
DataState | ||
NetatmoThermostatTypeState |
DiscreteState | NACamera, NAPlug, NATherm1, NMG, NMH, NMR, NOC, NRV | |
OperatingModeState |
DiscreteState | antifreeze, auto, away, eco, frostprotection | |
PreviousOperatingModeState |
DiscreteState | antifreeze, auto, away, eco, frostprotection, manual, max, normal, off, on, program | |
RadioFrequencySignalStrengthState |
DiscreteState | average, bad, full, good, high, low, medium | |
StatusState |
DiscreteState | available, unavailable | |
TargetTemperatureState |
ContinuousState | [12.0..30.0] | |
VersionState |
ContinuousState | ||
WeeklySchedulesState |
DataState |
HeatingSystem/NetatmoHeatingTemperatureInterface (ACTUATOR) — 6 commands, 13 states
Type IDs: 4097, 4100 | Servers: rexel, somfy_europe | Controllable: netatmo:NetatmoRoomController | Profiles: StatefulCoolingThermostat, CoolingThermostat, StatefulOperatingModeHeating, OperatingModeHeating, StatefulThermostat, Thermostat
Commands
| Command | Parameters | Notes |
|---|---|---|
refreshState |
Refresh the device states | |
setCoolingOperatingMode |
STRING: max, off, home; INT (optional) | p1: cooling operating mode p2: endTime in seconds. Must be greater than currentTime Always return an error, not implemented |
setCoolingTargetTemperature |
FLOAT [7.0..35.0]; INT (optional) | p1: cooling target temperature in Celsius p2: endTime in seconds. Must be greater than currentTime Always return an error, not implemented |
setOperatingMode |
STRING: max, normal, off; INT (optional) | p1: operating mode p2: endTime in seconds. Must be greater than currentTime |
setPilotWireMode |
STRING: frostprotection, away, off, comfort; INT (optional) | Set wire pilot mode |
setTargetTemperature |
FLOAT [7.0..30.0]; INT (optional) | p1: target temperature in Celsius p2: endTime in seconds. Must be greater than currentTime |
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
AnticipatingHeatingState |
DataState | ||
CoolingDerogationEndTimeState |
DataState | ||
CoolingOperatingModeState |
DiscreteState | manual, max, off, home | |
CoolingTargetTemperatureState |
ContinuousState | [12.0..30.0] | |
DerogationEndDateTimeState |
DataState | ||
NameState |
DataState | ||
NetatmoPilotWireModeState |
DiscreteState | away, comfort, frostprotection, off | |
OpenWindowDetectionState |
DiscreteState | false, true | |
OperatingModeState |
DiscreteState | antifreeze, auto, away, eco, frostprotection | |
StatusState |
DiscreteState | available, unavailable | |
TargetTemperatureState |
ContinuousState | [12.0..30.0] | |
UnavailableCommandsState |
DataState | ||
WeeklySchedulesState |
DataState |
HeatingSystem/NetatmoHeatingTemperatureInterface (ACTUATOR) — 3 commands, 8 states
Type IDs: 4098 | Servers: rexel, somfy_europe | Controllable: netatmo:MullerFPNRoomController | Profiles: StatefulOperatingModeHeating, OperatingModeHeating, StatefulThermostat, Thermostat
Commands
| Command | Parameters | Notes |
|---|---|---|
refreshState |
Refresh the device states | |
setOperatingMode |
STRING: manual, normal, frostprotection; INT (optional) | p1: operating mode p2: endTime in seconds. Must be greater than currentTime |
setTargetTemperature |
FLOAT [7.0..30.0]; INT (optional) | p1: target temperature in Celsius p2: endTime in seconds. Must be greater than currentTime |
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
DerogationEndDateTimeState |
DataState | ||
NameState |
DataState | ||
OpenWindowDetectionState |
DiscreteState | false, true | |
OperatingModeState |
DiscreteState | antifreeze, auto, away, eco, frostprotection | |
PresenceState |
DiscreteState | false, true | |
StatusState |
DiscreteState | available, unavailable | |
TargetTemperatureState |
ContinuousState | [12.0..30.0] | |
WeeklySchedulesState |
DataState |
HeatingSystem/NetatmoHeatingTemperatureInterface (ACTUATOR) — 3 commands, 6 states
Type IDs: 4099 | Servers: rexel, somfy_europe | Controllable: netatmo:MullerFP4RoomController | Profiles: StatefulOperatingModeHeating, OperatingModeHeating
Commands
| Command | Parameters | Notes |
|---|---|---|
refreshState |
Refresh the device states | |
setOperatingMode |
STRING: manual, normal, frostprotection; INT (optional) | p1: operating mode p2: endTime in seconds. Must be greater than currentTime |
setPilotWireMode |
STRING: frostprotection, away, off, comfort; INT (optional) | p1: pilot wire mode p2: endTime in seconds. Must be greater than currentTime |
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
DerogationEndDateTimeState |
DataState | ||
NameState |
DataState | ||
NetatmoPilotWireModeState |
DiscreteState | away, comfort, frostprotection, off | |
OperatingModeState |
DiscreteState | antifreeze, auto, away, eco, frostprotection | |
StatusState |
DiscreteState | available, unavailable | |
WeeklySchedulesState |
DataState |
HeatingSystem/NetatmoHeatingTemperatureInterface (ACTUATOR) — 1 commands, 10 states
Type IDs: 4353 | Servers: rexel, somfy_europe | Controllable: netatmo:ThermostatComponent | Profiles: BatteryStatus
Commands
| Command | Parameters | Notes |
|---|---|---|
refreshState |
Refresh the device states |
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
ApplianceTypeState |
DataState | ||
BatteryState |
DiscreteState | verylow, low, normal, full | |
BoostOnOffState |
DiscreteState | off, on | |
FirmwareRevisionState |
DataState | ||
HeatingOnOffState |
DiscreteState | off, on | |
LastErrorReceivedState |
DataState | ||
LastMessageDateTimeState |
DataState | ||
OffloadState |
DiscreteState | offload, notOffload | |
RadioFrequencySignalStrengthState |
DiscreteState | average, bad, full, good, high, low, medium | |
StatusState |
DiscreteState | available, unavailable |
HeatingSystem/ValveHeatingTemperatureInterface (ACTUATOR) — 1 commands, 8 states
Type IDs: 4357 | Servers: rexel, somfy_europe | Controllable: netatmo:ValveComponent | Profiles: BatteryStatus
Commands
| Command | Parameters | Notes |
|---|---|---|
refreshState |
Refresh the device states |
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
ApplianceTypeState |
DataState | ||
BatteryState |
DiscreteState | verylow, low, normal, full | |
FirmwareRevisionState |
DataState | ||
LastErrorReceivedState |
DataState | ||
LastMessageDateTimeState |
DataState | ||
OffloadState |
DiscreteState | offload, notOffload | |
RadioFrequencySignalStrengthState |
DiscreteState | average, bad, full, good, high, low, medium | |
StatusState |
DiscreteState | available, unavailable |
HeatingSystem/NetatmoHeatingTemperatureInterface (ACTUATOR) — 1 commands, 7 states
Type IDs: 4367 | Servers: rexel, somfy_europe | Controllable: netatmo:ThermostatHeatingCoolingComponent | Profiles: Specific
Commands
| Command | Parameters | Notes |
|---|---|---|
refreshState |
Refresh the device states |
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
ApplianceTypeState |
DataState | ||
BoostOnOffState |
DiscreteState | off, on | |
CoolingOnOffState |
DiscreteState | off, on | |
DiscreteRSSILevelState |
DiscreteState | good, low, normal, verylow | |
FirmwareRevisionState |
DataState | ||
HeatingOnOffState |
DiscreteState | off, on | |
StatusState |
DiscreteState | available, unavailable |
HeatingSystem/NetatmoHeatingTemperatureInterface (ACTUATOR) — 1 commands, 7 states
Type IDs: 4368 | Servers: rexel, somfy_europe | Controllable: netatmo:ModulatingThermostatComponent | Profiles: Specific
Commands
| Command | Parameters | Notes |
|---|---|---|
refreshState |
Refresh the device states |
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
ApplianceTypeState |
DataState | ||
BoilerErrorState |
DiscreteState | boiler_not_responding, maintenance, water_pressure, boiler_flame, air_pressure, boiler_temperature | |
BoostOnOffState |
DiscreteState | off, on | |
DiscreteRSSILevelState |
DiscreteState | good, low, normal, verylow | |
FirmwareRevisionState |
DataState | ||
HeatingOnOffState |
DiscreteState | off, on | |
StatusState |
DiscreteState | available, unavailable |
HeatingSystem/OnOffHeatingSystem (ACTUATOR) — 6 commands, 8 states
Type IDs: 4376 | Servers: rexel, somfy_europe | Controllable: netatmo:OnOffHeatingSystemComponent | Profiles: StatefulSwitchablePlug, StatefulSwitchable, Switchable
Commands
| Command | Parameters | Notes |
|---|---|---|
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 | |
onWithTimer |
INT [5..14400] | Turn the device on for a given amount of seconds then turn it off |
refreshState |
Refresh the device states | |
setOnOff |
STRING: off, on | Turn the device on or off |
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
ApplianceTypeState |
DataState | ||
FirmwareRevisionState |
DataState | ||
LastErrorReceivedState |
DataState | ||
LastMessageDateTimeState |
DataState | ||
OffloadState |
DiscreteState | offload, notOffload | |
OnOffState |
DiscreteState | on, off | |
RadioFrequencySignalStrengthState |
DiscreteState | average, bad, full, good, high, low, medium | |
StatusState |
DiscreteState | available, unavailable |
HeatingSystem/OnOffHeatingSystemPilotWire (ACTUATOR) — 1 commands, 8 states
Type IDs: 4424 | Servers: rexel, somfy_europe | Controllable: netatmo:OnOffHeatingSystemComponentWithPilotWire | Profiles: Specific
Commands
| Command | Parameters | Notes |
|---|---|---|
refreshState |
Refresh the device states |
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
ApplianceTypeState |
DataState | ||
FirmwareRevisionState |
DataState | ||
LastErrorReceivedState |
DataState | ||
LastMessageDateTimeState |
DataState | ||
OffloadState |
DiscreteState | offload, notOffload | |
OnOffState |
DiscreteState | on, off | |
RadioFrequencySignalStrengthState |
DiscreteState | average, bad, full, good, high, low, medium | |
StatusState |
DiscreteState | available, unavailable |
HumiditySensor/RelativeHumiditySensor (SENSOR) — 0 commands, 2 states
Type IDs: 4097, 4100, 4448, 8192, 8193, 8196 | Servers: rexel, somfy_europe | Controllable: netatmo:NetatmoHumidityMeasurement | Profiles: RelativeHumidity
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
RelativeHumidityState |
ContinuousState | [0.0..100.0] | |
StatusState |
DiscreteState | available, unavailable |
Light/StatefulOnOffLight (ACTUATOR) — 6 commands, 8 states
Type IDs: 4358 | Servers: rexel, somfy_europe | Controllable: netatmo:OnOffLightComponent | Profiles: StatefulSwitchableLight, StatefulSwitchable, Switchable
Commands
| Command | Parameters | Notes |
|---|---|---|
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 | |
onWithTimer |
INT [5..14400] | Turn the device on for a given amount of seconds then turn it off |
refreshState |
Refresh the device states | |
setOnOff |
STRING: off, on | Turn the device on or off |
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
ApplianceTypeState |
DataState | ||
FirmwareRevisionState |
DataState | ||
LastErrorReceivedState |
DataState | ||
LastMessageDateTimeState |
DataState | ||
OffloadState |
DiscreteState | offload, notOffload | |
OnOffState |
DiscreteState | on, off | |
RadioFrequencySignalStrengthState |
DiscreteState | average, bad, full, good, high, low, medium | |
StatusState |
DiscreteState | available, unavailable |
Light/DimmerLight (ACTUATOR) — 17 commands, 15 states
Type IDs: 4359 | Servers: rexel, somfy_europe | Controllable: netatmo:DimmerLightComponent | Profiles: StatefulLightDimmer, StatefulDimmable, Dimmable, StatefulSwitchable, Switchable
Commands
| Command | Parameters | Notes |
|---|---|---|
goToMemorized1Position |
Set the device to a user pre-defined position | |
goToMemorized2Position |
Set the device to a user pre-defined position | |
goToMemorized3Position |
Set the device to a user pre-defined position | |
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 | |
onWithTimer |
INT [5..14400] | Turn the device on for a given amount of seconds then turn it off |
refreshState |
Refresh the device states | |
setIntensity |
INT [0..100]; STRING: memorized1, memorized2, memorized3 | Light intensity level (100%=maximum intensity, 0%=off) |
setIntensityWithTimer |
STRING: memorized1, memorized2, memorized3; INT [0..100]; INT [5..14400]; STRING: memorized1, memorized2, memorized3 (optional); INT [0..100] (optional) | Set the light intensity to p1% then after p2 seconds, set it to p3%. (If p3 is not specified the light is turned off after the delay) |
setMemorized1Position |
INT [0..100] | Set favorite position |
setMemorized1PositionName |
STRING | Change the favorite position internal name. Name length may be subject to restrictions depending on the device and underlying protocol. |
setMemorized2Position |
INT [0..100] | Set favorite position |
setMemorized2PositionName |
STRING | Change the favorite position internal name. Name length may be subject to restrictions depending on the device and underlying protocol. |
setMemorized3Position |
INT [0..100] | Set favorite position |
setMemorized3PositionName |
STRING | Change the favorite position 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 |
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
ApplianceTypeState |
DataState | ||
FirmwareRevisionState |
DataState | ||
LastErrorReceivedState |
DataState | ||
LastMessageDateTimeState |
DataState | ||
LightIntensityState |
ContinuousState | [0..100] | |
Memorized1PositionNameState |
DataState | ||
Memorized1PositionState |
ContinuousState | ||
Memorized2PositionNameState |
DataState | ||
Memorized2PositionState |
ContinuousState | ||
Memorized3PositionNameState |
DataState | ||
Memorized3PositionState |
ContinuousState | ||
OffloadState |
DiscreteState | offload, notOffload | |
OnOffState |
DiscreteState | on, off | |
RadioFrequencySignalStrengthState |
DiscreteState | average, bad, full, good, high, low, medium | |
StatusState |
DiscreteState | available, unavailable |
NoiseSensor (SENSOR) — 0 commands, 2 states
Type IDs: 4448, 8192 | Servers: rexel, somfy_europe | Controllable: netatmo:NoiseComponent | Profiles: Specific
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
NoiseState |
ContinuousState | ||
StatusState |
DiscreteState | available, unavailable |
OnOff/StatefulOnOff (ACTUATOR) — 6 commands, 8 states
Type IDs: 4360, 4392 | Servers: rexel, somfy_europe | Controllable: netatmo:OnOffSwitchComponent | Profiles: StatefulSwitchablePlug, StatefulSwitchable, Switchable
Commands
| Command | Parameters | Notes |
|---|---|---|
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 | |
onWithTimer |
INT [5..14400] | Turn the device on for a given amount of seconds then turn it off |
refreshState |
Refresh the device states | |
setOnOff |
STRING: off, on | Turn the device on or off |
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
ApplianceTypeState |
DataState | ||
FirmwareRevisionState |
DataState | ||
LastErrorReceivedState |
DataState | ||
LastMessageDateTimeState |
DataState | ||
OffloadState |
DiscreteState | offload, notOffload | |
OnOffState |
DiscreteState | on, off | |
RadioFrequencySignalStrengthState |
DiscreteState | average, bad, full, good, high, low, medium | |
StatusState |
DiscreteState | available, unavailable |
ProtocolGateway/NetatmoGateway (PROTOCOL_GATEWAY) — 1 commands, 8 states
Type IDs: 4364 | Servers: rexel, somfy_europe | Controllable: netatmo:BridgeComponent | Profiles: Specific
Commands
| Command | Parameters | Notes |
|---|---|---|
refreshState |
Refresh the device states |
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
ApplianceTypeState |
DataState | ||
DiscreteRSSILevelState |
DiscreteState | good, low, normal, verylow | |
FirmwareRevisionState |
DataState | ||
LastErrorReceivedState |
DataState | ||
LastMessageDateTimeState |
DataState | ||
OffloadState |
DiscreteState | offload, notOffload | |
RadioFrequencySignalStrengthState |
DiscreteState | average, bad, full, good, high, low, medium | |
StatusState |
DiscreteState | available, unavailable |
ProtocolGateway/NetatmoGateway (PROTOCOL_GATEWAY) — 1 commands, 9 states
Type IDs: 4365 | Servers: rexel, somfy_europe | Controllable: netatmo:ThermostatRelayComponent | Profiles: Specific
Commands
| Command | Parameters | Notes |
|---|---|---|
refreshState |
Refresh the device states |
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
ApplianceTypeState |
DataState | ||
DHWControlState |
DiscreteState | none, instantaneous, water_tank | |
FirmwareRevisionState |
DataState | ||
HeatingOnOffState |
DiscreteState | off, on | |
LastErrorReceivedState |
DataState | ||
LastMessageDateTimeState |
DataState | ||
OffloadState |
DiscreteState | offload, notOffload | |
RadioFrequencySignalStrengthState |
DiscreteState | average, bad, full, good, high, low, medium | |
StatusState |
DiscreteState | available, unavailable |
RainSensor (SENSOR) — 0 commands, 2 states
Type IDs: 8195 | Servers: rexel, somfy_europe | Controllable: netatmo:RainComponent | Profiles: RainDetector
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
RainState |
DiscreteState | detected, notDetected | |
StatusState |
DiscreteState | available, unavailable |
RemoteController/RemoteControllerOneWay (REMOTE_CONTROLLER) — 1 commands, 8 states
Type IDs: 4363 | Servers: rexel, somfy_europe | Controllable: netatmo:RemoteControllerComponent | Profiles: BatteryStatus
Commands
| Command | Parameters | Notes |
|---|---|---|
refreshState |
Refresh the device states |
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
ApplianceTypeState |
DataState | ||
BatteryState |
DiscreteState | verylow, low, normal, full | |
FirmwareRevisionState |
DataState | ||
LastErrorReceivedState |
DataState | ||
LastMessageDateTimeState |
DataState | ||
OffloadState |
DiscreteState | offload, notOffload | |
RadioFrequencySignalStrengthState |
DiscreteState | average, bad, full, good, high, low, medium | |
StatusState |
DiscreteState | available, unavailable |
RollerShutter/UpDownRollerShutter (ACTUATOR) — 8 commands, 10 states
Type IDs: 4362 | Servers: rexel, somfy_europe | Controllable: netatmo:RollerShutterComponent | Profiles: UpDown, StatefulCloseable, Closeable, StatefulOpenClose, OpenClose
Commands
| Command | Parameters | Notes |
|---|---|---|
close |
Fully close the device | |
down |
Move the device completely down | |
identify |
Ask the device to identify itself by doing a slight movement or blink or beep | |
open |
Fully open the device | |
refreshState |
Refresh the device states | |
setClosure |
INT [0..100] | Closure level (100%=fully close, 0%=open) |
stop |
Stop the current actuator behavior (movement, sound or timer) | |
up |
Move the device completely up |
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
ApplianceTypeState |
DataState | ||
ClosureState |
ContinuousState | [0..100] | |
FirmwareRevisionState |
DataState | ||
LastErrorReceivedState |
DataState | ||
LastMessageDateTimeState |
DataState | ||
MinimumClosureStepState |
ContinuousState | ||
OffloadState |
DiscreteState | offload, notOffload | |
OpenClosedState |
DiscreteState | open, closed | |
RadioFrequencySignalStrengthState |
DiscreteState | average, bad, full, good, high, low, medium | |
StatusState |
DiscreteState | available, unavailable |
TemperatureSensor (SENSOR) — 0 commands, 2 states
Type IDs: 259, 515, 4097, 4098, 4100, 4448, 8192, 8193, 8196 | Servers: rexel, somfy_europe | Controllable: netatmo:NetatmoThermostatTemperatureSensor | Profiles: Temperature
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
StatusState |
DiscreteState | available, unavailable | |
TemperatureState |
ContinuousState | [-100.0..100.0] |
VentilationSystem/OnOffVentilationSpeed (ACTUATOR) — 2 commands, 8 states
Type IDs: 4366 | Servers: rexel, somfy_europe | Controllable: netatmo:NetatmoControlledMechanicalVentilationController | Profiles: OnOffStatus, AirFanMode
Commands
| Command | Parameters | Notes |
|---|---|---|
refreshState |
Refresh the device states | |
setFanSpeedMode |
STRING: low, high | Set the device fan speed mode |
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
ApplianceTypeState |
DataState | ||
FirmwareRevisionState |
DataState | ||
LastErrorReceivedState |
DataState | ||
LastMessageDateTimeState |
DataState | ||
OffloadState |
DiscreteState | offload, notOffload | |
OnOffState |
DiscreteState | on, off | |
RadioFrequencySignalStrengthState |
DiscreteState | average, bad, full, good, high, low, medium | |
StatusState |
DiscreteState | available, unavailable |
WaterHeatingSystem/DomesticHotWaterProduction (ACTUATOR) — 6 commands, 8 states
Type IDs: 4408, 4425 | Servers: rexel, somfy_europe | Controllable: netatmo:OnOffDomesticHotWaterComponent | Profiles: StatefulSwitchablePlug, StatefulSwitchable, Switchable
Commands
| Command | Parameters | Notes |
|---|---|---|
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 | |
onWithTimer |
INT [5..14400] | Turn the device on for a given amount of seconds then turn it off |
refreshState |
Refresh the device states | |
setOnOff |
STRING: off, on | Turn the device on or off |
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
ApplianceTypeState |
DataState | ||
FirmwareRevisionState |
DataState | ||
LastErrorReceivedState |
DataState | ||
LastMessageDateTimeState |
DataState | ||
OffloadState |
DiscreteState | offload, notOffload | |
OnOffState |
DiscreteState | on, off | |
RadioFrequencySignalStrengthState |
DiscreteState | average, bad, full, good, high, low, medium | |
StatusState |
DiscreteState | available, unavailable |
WaterHeatingSystem/DomesticHotWaterProductionPeakAndOffPeak (ACTUATOR) — 4 commands, 8 states
Type IDs: 4441 | Servers: rexel, somfy_europe | Controllable: netatmo:DomesticHotWaterPeakAndOffPeakHoursComponent | Profiles: StatefulOperatingModeHeating, OperatingModeHeating
Commands
| Command | Parameters | Notes |
|---|---|---|
identify |
Ask the device to identify itself by doing a slight movement or blink or beep | |
refreshState |
Refresh the device states | |
setOperatingMode |
STRING: auto, off, boost | Set an operating mode |
setOperatingModeWithTimer |
STRING: auto, boost, off; INT [5..28800]; STRING: auto, boost, off | Set Netatmo operating mode on duration then change it. p1 : The temporary operating mode. p2 : The duration in seconds. p3 : The fallback operating mode. |
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
ApplianceTypeState |
DataState | ||
FirmwareRevisionState |
DataState | ||
LastErrorReceivedState |
DataState | ||
LastMessageDateTimeState |
DataState | ||
OffloadState |
DiscreteState | offload, notOffload | |
OperatingModeState |
DiscreteState | antifreeze, auto, away, eco, frostprotection | |
RadioFrequencySignalStrengthState |
DiscreteState | average, bad, full, good, high, low, medium | |
StatusState |
DiscreteState | available, unavailable |
WindSensor/WindSpeedAndDirectionSensor (SENSOR) — 0 commands, 3 states
Type IDs: 8194 | Servers: rexel, somfy_europe | Controllable: netatmo:WindComponent | Profiles: WindSpeedAndDirection, WindDirection, WindSpeed
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
StatusState |
DiscreteState | available, unavailable | |
WindDirectionState |
ContinuousState | [0..360] | |
WindSpeedState |
ContinuousState |
OGCP
47 device types.
AirSensor/DynamicAirSensor (SENSOR) — 7 commands, 26 states
Type IDs: 304 | Servers: rexel, 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 | ||
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 |
Alarm/DynamicAlarm (ACTUATOR) — 13 commands, 33 states
Type IDs: 282 | Servers: rexel, somfy_europe | 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 | 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 | ||
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 | smoke | |
SmokeState |
DiscreteState | detected, notDetected | |
StatusState |
DiscreteState | available, unavailable |
Awning/DynamicAwning (ACTUATOR) — 17 commands, 30 states
Type IDs: 277 | Servers: rexel, 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] | |
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 |
CarbonDioxideSensor/DynamicCarbonDioxideSensor (SENSOR) — 7 commands, 25 states
Type IDs: 291 | Servers: rexel, 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 | ||
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 |
CircuitBreaker/DynamicCircuitBreaker (ACTUATOR) — 13 commands, 25 states
Type IDs: 286 | Servers: rexel, 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 | ||
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 |
ContactSensor/DynamicOpeningSensor (SENSOR) — 7 commands, 26 states
Type IDs: 272 | Servers: rexel, 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 | ||
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 |
Curtain/DynamicCurtain (ACTUATOR) — 14 commands, 28 states
Type IDs: 271 | Servers: rexel, 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] | |
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 |
ElectricitySensor/DynamicElectricityConsumptionSensor (SENSOR) — 7 commands, 26 states
Type IDs: 293 | Servers: rexel, 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 | ||
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 |
GarageDoor/DynamicGarageDoor (ACTUATOR) — 15 commands, 28 states
Type IDs: 266 | Servers: rexel, 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] | |
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 |
GasSensor/DynamicGasMeasurementSensor (SENSOR) — 7 commands, 26 states
Type IDs: 296 | Servers: rexel, 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 | ||
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 |
Gate/DynamicGate (ACTUATOR) — 15 commands, 28 states
Type IDs: 265 | Servers: rexel, 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] | |
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 |
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 |
HeatingSystem/DynamicThermostat (ACTUATOR) — 18 commands, 40 states
Type IDs: 259 | Servers: rexel, 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 | ||
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 |
HeatingSystem/DynamicHvacCentralUnit (ACTUATOR) — 20 commands, 41 states
Type IDs: 269 | Servers: rexel, 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 | ||
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 |
HeatingSystem/DynamicHeater (ACTUATOR) — 17 commands, 41 states
Type IDs: 278 | Servers: rexel, 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 | ||
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 |
HeatingSystem/DynamicHvacZone (ACTUATOR) — 18 commands, 43 states
Type IDs: 289 | Servers: rexel, 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 | ||
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 |
HumiditySensor/DynamicHumiditySensor (SENSOR) — 7 commands, 25 states
Type IDs: 276 | Servers: rexel, 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 | ||
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 |
IntrusionSensor/DynamicIntrusionSensor (SENSOR) — 8 commands, 27 states
Type IDs: 281 | Servers: rexel, 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 | ||
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 |
Light/DynamicLight (ACTUATOR) — 20 commands, 32 states
Type IDs: 257 | Servers: rexel, 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 | ||
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 |
LightSensor/DynamicLightSensor (SENSOR) — 7 commands, 26 states
Type IDs: 273 | Servers: rexel, 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 | ||
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 |
MusicPlayer/DynamicAudioPlayer (ACTUATOR) — 29 commands, 39 states
Type IDs: 288 | Servers: rexel, 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 | ||
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 |
NoiseSensor/DynamicAmbientNoiseSensor (SENSOR) — 7 commands, 25 states
Type IDs: 305 | Servers: rexel, somfy_europe | 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 } } |
States
| 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 | ||
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 |
OccupancySensor/DynamicOccupancySensor (SENSOR) — 7 commands, 25 states
Type IDs: 280 | Servers: rexel, somfy_europe | Controllable: ogp:OccupancySensor | Profiles: OccupancyDetector
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 | ||
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 |
OnOff/DynamicOutlet (ACTUATOR) — 16 commands, 29 states
Type IDs: 261 | Servers: rexel, 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 } } |
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
ActivePartitionState |
DataState | ||
AvailabilityState |
DiscreteState | available, unavailable | |
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] | |
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 |
Oven/DynamicOven (ACTUATOR) — 27 commands, 69 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
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 } } |
States
| 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 | ||
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 | ||
Private3State |
DataState | ||
Private4State |
DataState | ||
Private5State |
DataState | ||
Private6State |
DataState | ||
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 |
Pergola/DynamicPergola (ACTUATOR) — 18 commands, 31 states
Type IDs: 287 | Servers: rexel, 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] | |
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 |
ProtocolGateway/DynamicBridge (ACTUATOR) — 15 commands, 26 states
Type IDs: 1 | Servers: rexel, somfy_europe | 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 | 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 |
ProtocolGateway/DynamicGateway (ACTUATOR) — 10 commands, 35 states
Type IDs: 2 | Servers: rexel, 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 | ||
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 |
RainSensor/DynamicRainSensor (SENSOR) — 7 commands, 25 states
Type IDs: 275 | Servers: rexel, 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 | ||
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 |
Scene/DynamicScene (ACTUATOR) — 9 commands, 25 states
Type IDs: 294 | Servers: rexel, 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 | ||
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 |
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 | 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 | ||
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 |
SceneLauncherController/DynamicSceneLauncherController (REMOTE_CONTROLLER) — 7 commands, 28 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 |
|---|---|---|---|
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 | |
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 |
Screen/DynamicScreen (ACTUATOR) — 14 commands, 28 states
Type IDs: 263 | Servers: rexel, 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] | |
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 |
Shutter/DynamicShutter (ACTUATOR) — 17 commands, 35 states
Type IDs: 262 | Servers: rexel, 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] | |
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 |
Switch/DynamicSwitch (ACTUATOR) — 8 commands, 27 states
Type IDs: 297 | Servers: rexel, 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 |
|---|---|---|---|
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 |
TemperatureSensor/DynamicTemperatureSensor (SENSOR) — 7 commands, 25 states
Type IDs: 270 | Servers: rexel, 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 | ||
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] |
ThirdPartyGateway/DynamicThirdPartyGateway (ACTUATOR) — 10 commands, 26 states
Type IDs: 283 | Servers: rexel, 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 | ||
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 |
VenetianBlind/DynamicVenetianBlind (ACTUATOR) — 20 commands, 31 states
Type IDs: 264 | Servers: rexel, 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] | |
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 |
VentilationSystem/DynamicVentilation (ACTUATOR) — 17 commands, 32 states
Type IDs: 260 | Servers: rexel, 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 | ||
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 |
VentilationSystem/DynamicAirVent (ACTUATOR) — 18 commands, 33 states
Type IDs: 268 | Servers: rexel, 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] | |
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 |
WashingMachine/DynamicWashingMachine (ACTUATOR) — 23 commands, 56 states
Type IDs: 285 | Servers: rexel, 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 | ||
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 |
WaterHeatingSystem/DynamicDomesticHotWaterProduction (ACTUATOR) — 16 commands, 41 states
Type IDs: 290 | Servers: rexel, 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 | ||
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 |
WaterSensor/DynamicWaterMeasurementSensor (SENSOR) — 7 commands, 26 states
Type IDs: 295 | Servers: rexel, 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 | ||
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 |
WeatherSensor/DynamicWeatherStation (SENSOR) — 7 commands, 34 states
Type IDs: 279 | Servers: rexel, 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 | ||
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 |
WindSensor/DynamicWindSensor (SENSOR) — 7 commands, 26 states
Type IDs: 274 | Servers: rexel, 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 | ||
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 |
Window/DynamicWindow (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
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 |
unknown/Invalid (ACTUATOR) — 0 commands, 0 states
Type IDs: 0 | Servers: rexel, somfy_europe | Controllable: ogp:Invalid | Profiles: Specific
OGP
47 device types.
AirSensor/DynamicAirSensor (SENSOR) — 7 commands, 26 states
Type IDs: 304 | Servers: rexel, 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 | ||
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 |
Alarm/DynamicAlarm (ACTUATOR) — 13 commands, 33 states
Type IDs: 282 | Servers: rexel, somfy_europe | 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 | 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 | ||
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 | smoke | |
SmokeState |
DiscreteState | detected, notDetected | |
StatusState |
DiscreteState | available, unavailable |
Awning/DynamicAwning (ACTUATOR) — 17 commands, 30 states
Type IDs: 277 | Servers: rexel, 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] | |
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 |
CarbonDioxideSensor/DynamicCarbonDioxideSensor (SENSOR) — 7 commands, 25 states
Type IDs: 291 | Servers: rexel, 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 | ||
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 |
CircuitBreaker/DynamicCircuitBreaker (ACTUATOR) — 13 commands, 25 states
Type IDs: 286 | Servers: rexel, 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 | ||
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 |
ContactSensor/DynamicOpeningSensor (SENSOR) — 7 commands, 26 states
Type IDs: 272 | Servers: rexel, 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 | ||
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 |
Curtain/DynamicCurtain (ACTUATOR) — 14 commands, 28 states
Type IDs: 271 | Servers: rexel, 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] | |
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 |
ElectricitySensor/DynamicElectricityConsumptionSensor (SENSOR) — 7 commands, 26 states
Type IDs: 293 | Servers: rexel, 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 | ||
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 |
GarageDoor/DynamicGarageDoor (ACTUATOR) — 15 commands, 28 states
Type IDs: 266 | Servers: rexel, 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] | |
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 |
GasSensor/DynamicGasMeasurementSensor (SENSOR) — 7 commands, 26 states
Type IDs: 296 | Servers: rexel, 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 | ||
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 |
Gate/DynamicGate (ACTUATOR) — 15 commands, 28 states
Type IDs: 265 | Servers: rexel, 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] | |
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 |
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 |
HeatingSystem/DynamicThermostat (ACTUATOR) — 18 commands, 40 states
Type IDs: 259 | Servers: rexel, 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 | ||
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 |
HeatingSystem/DynamicHvacCentralUnit (ACTUATOR) — 20 commands, 41 states
Type IDs: 269 | Servers: rexel, 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 | ||
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 |
HeatingSystem/DynamicHeater (ACTUATOR) — 17 commands, 41 states
Type IDs: 278 | Servers: rexel, 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 | ||
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 |
HeatingSystem/DynamicHvacZone (ACTUATOR) — 18 commands, 43 states
Type IDs: 289 | Servers: rexel, 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 | ||
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 |
HumiditySensor/DynamicHumiditySensor (SENSOR) — 7 commands, 25 states
Type IDs: 276 | Servers: rexel, 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 | ||
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 |
IntrusionSensor/DynamicIntrusionSensor (SENSOR) — 8 commands, 27 states
Type IDs: 281 | Servers: rexel, 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 | ||
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 |
Light/DynamicLight (ACTUATOR) — 20 commands, 32 states
Type IDs: 257 | Servers: rexel, 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 | ||
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 |
LightSensor/DynamicLightSensor (SENSOR) — 7 commands, 26 states
Type IDs: 273 | Servers: rexel, 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 | ||
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 |
MusicPlayer/DynamicAudioPlayer (ACTUATOR) — 29 commands, 39 states
Type IDs: 288 | Servers: rexel, 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 | ||
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 |
NoiseSensor/DynamicAmbientNoiseSensor (SENSOR) — 7 commands, 25 states
Type IDs: 305 | Servers: rexel, somfy_europe | 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 } } |
States
| 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 | ||
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 |
OccupancySensor/DynamicOccupancySensor (SENSOR) — 7 commands, 25 states
Type IDs: 280 | Servers: rexel, somfy_europe | Controllable: ogp:OccupancySensor | Profiles: OccupancyDetector
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 | ||
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 |
OnOff/DynamicOutlet (ACTUATOR) — 16 commands, 29 states
Type IDs: 261 | Servers: rexel, 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 } } |
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
ActivePartitionState |
DataState | ||
AvailabilityState |
DiscreteState | available, unavailable | |
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] | |
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 |
Oven/DynamicOven (ACTUATOR) — 27 commands, 69 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
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 } } |
States
| 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 | ||
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 | ||
Private3State |
DataState | ||
Private4State |
DataState | ||
Private5State |
DataState | ||
Private6State |
DataState | ||
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 |
Pergola/DynamicPergola (ACTUATOR) — 18 commands, 31 states
Type IDs: 287 | Servers: rexel, 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] | |
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 |
ProtocolGateway/DynamicBridge (ACTUATOR) — 15 commands, 26 states
Type IDs: 1 | Servers: rexel, somfy_europe | 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 | 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 |
ProtocolGateway/DynamicGateway (ACTUATOR) — 10 commands, 35 states
Type IDs: 2 | Servers: rexel, 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 | ||
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 |
RainSensor/DynamicRainSensor (SENSOR) — 7 commands, 25 states
Type IDs: 275 | Servers: rexel, 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 | ||
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 |
Scene/DynamicScene (ACTUATOR) — 9 commands, 25 states
Type IDs: 294 | Servers: rexel, 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 | ||
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 |
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 | 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 | ||
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 |
SceneLauncherController/DynamicSceneLauncherController (REMOTE_CONTROLLER) — 7 commands, 28 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 |
|---|---|---|---|
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 | |
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 |
Screen/DynamicScreen (ACTUATOR) — 14 commands, 28 states
Type IDs: 263 | Servers: rexel, 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] | |
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 |
Shutter/DynamicShutter (ACTUATOR) — 17 commands, 35 states
Type IDs: 262 | Servers: rexel, 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] | |
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 |
Switch/DynamicSwitch (ACTUATOR) — 8 commands, 27 states
Type IDs: 297 | Servers: rexel, 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 |
|---|---|---|---|
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 |
TemperatureSensor/DynamicTemperatureSensor (SENSOR) — 7 commands, 25 states
Type IDs: 270 | Servers: rexel, 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 | ||
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] |
ThirdPartyGateway/DynamicThirdPartyGateway (ACTUATOR) — 10 commands, 26 states
Type IDs: 283 | Servers: rexel, 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 | ||
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 |
VenetianBlind/DynamicVenetianBlind (ACTUATOR) — 20 commands, 31 states
Type IDs: 264 | Servers: rexel, 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] | |
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 |
VentilationSystem/DynamicVentilation (ACTUATOR) — 17 commands, 32 states
Type IDs: 260 | Servers: rexel, 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 | ||
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 |
VentilationSystem/DynamicAirVent (ACTUATOR) — 18 commands, 33 states
Type IDs: 268 | Servers: rexel, 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] | |
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 |
WashingMachine/DynamicWashingMachine (ACTUATOR) — 23 commands, 56 states
Type IDs: 285 | Servers: rexel, 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 | ||
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 |
WaterHeatingSystem/DynamicDomesticHotWaterProduction (ACTUATOR) — 16 commands, 41 states
Type IDs: 290 | Servers: rexel, 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 | ||
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 |
WaterSensor/DynamicWaterMeasurementSensor (SENSOR) — 7 commands, 26 states
Type IDs: 295 | Servers: rexel, 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 | ||
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 |
WeatherSensor/DynamicWeatherStation (SENSOR) — 7 commands, 34 states
Type IDs: 279 | Servers: rexel, 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 | ||
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 |
WindSensor/DynamicWindSensor (SENSOR) — 7 commands, 26 states
Type IDs: 274 | Servers: rexel, 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 | ||
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 |
Window/DynamicWindow (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
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 |
unknown/Invalid (ACTUATOR) — 0 commands, 0 states
Type IDs: 0 | Servers: rexel, somfy_europe | Controllable: ogp:Invalid | Profiles: Specific
OPENDOORS
1 device types.
DoorLock (ACTUATOR) — 3 commands, 5 states
Type IDs: 16777472 | Servers: rexel, somfy_europe | Controllable: opendoors:OpenDoorsSmartLockComponent | Profiles: StatefulDoorLock, StatefulLock, LockStatus, Lock
Commands
| Command | Parameters | Notes |
|---|---|---|
lock |
Lock the device | |
setLockedUnlocked |
STRING: locked, unlocked | Set the device state to either 'locked' or 'unlocked' |
unlock |
Unlock the device |
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
AvailabilityState |
DiscreteState | available, unavailable | |
BatteryState |
DiscreteState | verylow, low, normal, full | |
LockedUnlockedState |
DiscreteState | locked, unlocked | |
NameState |
DataState | ||
StatusState |
DiscreteState | available, unavailable |
OVP
25 device types.
ElectricitySensor/CumulativeElectricPowerConsumptionSensor (SENSOR) — 0 commands, 2 states
Type IDs: 16842763 | Servers: atlantic_cozytouch, hi_kumo_europe, rexel, somfy_europe | Controllable: ovp:CoolingCumulatedElectricalEnergyConsumptionSensor | Profiles: ElectricEnergyConsumption
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
ElectricEnergyConsumptionState |
ContinuousState | ||
StatusState |
DiscreteState | available, unavailable |
Generic/OVPGeneric (ACTUATOR) — 4 commands, 3 states
Type IDs: 0 | Servers: atlantic_cozytouch, hi_kumo_europe, rexel, somfy_europe | Controllable: ovp:UnknownOVPComponent | Profiles: StatefulLevelControl, LevelControl, Generic
Data Properties
core:identifyInterval=500
Commands
| Command | Parameters | Notes |
|---|---|---|
getName |
Refresh the device internal name | |
identify |
Ask the device to identify itself by doing a slight movement or blink or beep | |
setLevel |
INT [0..100] | Generic device working level (0-100%) Functional meaning depends on device |
setName |
STRING | Change the device internal name. Name length may be subject to restrictions depending on the device and underlying protocol. |
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
LevelState |
ContinuousState | [0..100] | |
NameState |
DataState | ||
StatusState |
DiscreteState | available, unavailable |
Generic/unknown (ACTUATOR) — 3 commands, 2 states
Type IDs: 16843019, 1099528470795 | Servers: atlantic_cozytouch, hi_kumo_europe, rexel, somfy_europe | Controllable: ovp:ModbusMainController | Profiles: Specific
Data Properties
core:identifyInterval=500
Commands
| Command | Parameters | Notes |
|---|---|---|
getName |
Refresh the device internal name | |
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. |
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
NameState |
DataState | ||
StatusState |
DiscreteState | available, unavailable |
HeatingSystem/SomfyHeatingTemperatureInterface (ACTUATOR) — 19 commands, 12 states
Type IDs: 917506 | Servers: atlantic_cozytouch, hi_kumo_europe, rexel, somfy_europe | Controllable: ovp:SomfyHeatingTemperatureInterfaceOVPComponent | Profiles: OperatingModeHeating, ThermostatTargetReader, OnOffStatus
Data Properties
core:identifyInterval=500
Commands
| Command | Parameters | Notes |
|---|---|---|
getName |
Refresh the device internal name | |
identify |
Ask the device to identify itself by doing a slight movement or blink or beep | |
refreshActiveMode |
Refresh the device active mode | |
refreshBatteryLevel |
Refresh the battery level | |
refreshComfortTemperature |
Refresh the temperature of comfort mode | |
refreshEcoTemperature |
Refresh the temperature of eco mode | |
refreshOnOffState |
Get the device on/off state | |
refreshSecuredPositionTemperature |
Refresh the temperature of secured mode | |
refreshSetPointMode |
Refresh the heating target mode or temperature (if supported) | |
refreshTargetTemperature |
Refresh the temperature value | |
refreshTemperature |
Refresh the last measured temperature | |
setActiveMode |
STRING: auto, manu | Select the active mode (auto mode activates device internal regulation) |
setComfortTemperature |
FLOAT [7.0..30.0] | Set target temperature of comfort mode |
setEcoTemperature |
FLOAT [6.0..29.0] | Set target temperature of eco mode |
setManuAndSetPointModes |
STRING: comfort, eco, secured | Change active mode to manu and select setpoint 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 |
setOperatingMode |
STRING: heating, cooling, heatingCooling | Set an operating mode |
setSecuredPositionTemperature |
FLOAT [5.0..15.0] | Set target temperature of secured mode |
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
BatteryState |
DiscreteState | verylow, low, normal, full | |
ComfortRoomTemperatureState |
ContinuousState | ||
EcoRoomTemperatureState |
ContinuousState | ||
HeatingTemperatureInterfaceActiveModeState |
DiscreteState | auto, manu | |
HeatingTemperatureInterfaceOperatingModeState |
DiscreteState | both, cooling, heating | |
HeatingTemperatureInterfaceSetPointModeState |
DiscreteState | comfort, eco, free, secured | |
NameState |
DataState | ||
OnOffState |
DiscreteState | on, off | |
SecuredPositionTemperatureState |
ContinuousState | ||
StatusState |
DiscreteState | available, unavailable | |
TargetTemperatureState |
ContinuousState | [12.0..30.0] | |
VersionState |
ContinuousState |
HeatingSystem/ImhotepHeatingTemperatureInterface (ACTUATOR) — 19 commands, 12 states
Type IDs: 917515 | Servers: atlantic_cozytouch, hi_kumo_europe, rexel, somfy_europe | Controllable: ovp:ImhotepHeatingTemperatureInterfaceOVPComponent | Profiles: ThermostatTargetReader
Data Properties
core:identifyInterval=500
Commands
| Command | Parameters | Notes |
|---|---|---|
getName |
Refresh the device internal name | |
identify |
Ask the device to identify itself by doing a slight movement or blink or beep | |
refreshActiveMode |
Refresh the device active mode | |
refreshBatteryLevel |
Refresh the battery level | |
refreshComfortTemperature |
Refresh the temperature of comfort mode | |
refreshDeviceSerialNumber |
Refresh the device serial number | |
refreshEcoTemperature |
Refresh the temperature of eco mode | |
refreshSecuredPositionTemperature |
Refresh the temperature of secured mode | |
refreshSetPointMode |
Refresh the heating target mode or temperature (if supported) | |
refreshTargetTemperature |
Refresh the temperature value | |
refreshTemperature |
Refresh the last measured temperature | |
setActiveAndSetPointModes |
STRING: auto, manu; STRING: comfort, eco, secured; FLOAT [7.0..26.0] | Select the active mode and change setpoint |
setActiveMode |
STRING: auto, manu | Select the active mode (auto mode activates device internal regulation) |
setAutoAndSetPointModes |
STRING: comfort, eco, secured | Change active mode to auto and select setpoint mode |
setComfortTemperature |
FLOAT [14.5..26.0] | Set target temperature of comfort mode |
setEcoTemperature |
FLOAT [12.5..24.0] | Set target temperature of eco mode |
setName |
STRING | Change the device internal name. Name length may be subject to restrictions depending on the device and underlying protocol. |
setSecuredPositionTemperature |
FLOAT [7.0..12.0] | Set target temperature of secured mode |
setSetPointMode |
STRING: comfort, eco, secured; FLOAT [7.0..26.0] | Set the target heating mode or temperature (if supported) |
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
BatteryState |
DiscreteState | verylow, low, normal, full | |
BoilerOperatingTimeState |
DataState | ||
ComfortRoomTemperatureState |
ContinuousState | ||
DeviceSerialNumberState |
DataState | ||
EcoRoomTemperatureState |
ContinuousState | ||
HeatingTemperatureInterfaceActiveModeState |
DiscreteState | auto, manu | |
HeatingTemperatureInterfaceSetPointModeState |
DiscreteState | comfort, eco, free, secured | |
NameState |
DataState | ||
SecuredPositionTemperatureState |
ContinuousState | ||
SetSetPointModeInProgressState |
DiscreteState | false, true | |
StatusState |
DiscreteState | available, unavailable | |
TargetTemperatureState |
ContinuousState | [12.0..30.0] |
HeatingSystem/StatefulOnOff (ACTUATOR) — 7 commands, 5 states
Type IDs: 917515 | Servers: atlantic_cozytouch, hi_kumo_europe, rexel, somfy_europe | Controllable: ovp:ImhotepHeatingTemperatureRelayOVPComponent | Profiles: SwitchableHeatingStatus, OnOffStatus
Data Properties
core:identifyInterval=500
Commands
| Command | Parameters | Notes |
|---|---|---|
getName |
Refresh the device internal name | |
identify |
Ask the device to identify itself by doing a slight movement or blink or beep | |
refreshConnectivity |
||
refreshDeviceSerialNumber |
Refresh the device serial number | |
refreshOnOffState |
Get the device on/off state | |
refreshOperatingTime |
||
setName |
STRING | Change the device internal name. Name length may be subject to restrictions depending on the device and underlying protocol. |
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
AliveDownState |
DiscreteState | alive, down | |
DeviceSerialNumberState |
DataState | ||
NameState |
DataState | ||
OnOffState |
DiscreteState | on, off | |
StatusState |
DiscreteState | available, unavailable |
HeatingSystem/unknown (ACTUATOR) — 7 commands, 7 states
Type IDs: 3407872 | Servers: atlantic_cozytouch, hi_kumo_europe, rexel, somfy_europe | Controllable: ovp:ElectricalHeaterGenericOVPComponent | Profiles: StatefulHeatingLevel, HeatingLevel
Data Properties
core:identifyInterval=500
Commands
| Command | Parameters | Notes |
|---|---|---|
getName |
Refresh the device internal name | |
identify |
Ask the device to identify itself by doing a slight movement or blink or beep | |
off |
Turn off the device | |
setHeatingLevel |
STRING: boost, comfort, comfort-1, comfort-2, eco | Sets the device heating level mode |
setHeatingLevelForTrigger |
ANY | |
setName |
STRING | Change the device internal name. Name length may be subject to restrictions depending on the device and underlying protocol. |
setTimerForTransitoryState |
ANY |
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
MaximumHeatingLevelState |
DiscreteState | boost, comfort, comfort-1, comfort-2, eco, frostprotection, off, secured | |
NameState |
DataState | ||
OnOffState |
DiscreteState | on, off | |
StatusState |
DiscreteState | available, unavailable | |
TargetHeatingLevelState |
DiscreteState | comfort, eco | |
TargetHeatingLevelState |
DiscreteState | boost, comfort, comfort-1, comfort-2, eco, frostprotection, off, secured | |
TimerForTransitoryStateState |
ContinuousState |
HeatingSystem/DeDietrichBoiler (ACTUATOR) — 3 commands, 4 states
Type IDs: 16842763 | Servers: atlantic_cozytouch, hi_kumo_europe, rexel, somfy_europe | Controllable: ovp:BoilerControllerOVPComponent | Profiles: Specific
Commands
| Command | Parameters | Notes |
|---|---|---|
refreshAlarm |
||
refreshOperatingState |
||
refreshRedAlarm |
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
AlarmState |
ContinuousState | ||
OperatingStateState |
ContinuousState | ||
RedAlarmState |
ContinuousState | ||
StatusState |
DiscreteState | available, unavailable |
HeatingSystem/DeDietrichHeatingCircuit (ACTUATOR) — 14 commands, 9 states
Type IDs: 16842763 | Servers: atlantic_cozytouch, hi_kumo_europe, rexel, somfy_europe | Controllable: ovp:HeatingCircuitOnCircuitAOVPComponent | Profiles: Temperature
Commands
| Command | Parameters | Notes |
|---|---|---|
refreshActiveTimeProgram |
Refresh curent active time program. | |
refreshCircuitType |
||
refreshComfortTemperature |
Refresh the temperature of comfort mode | |
refreshDerogationMode |
Refresh derogation command | |
refreshOperatingMode |
Refresh an operating mode. | |
refreshReducedTemperature |
||
refreshSecuredPositionTemperature |
Refresh the temperature of secured mode | |
refreshTimeProgram |
||
setActiveTimeProgram |
ANY | Defines curent active time program |
setComfortTemperature |
FLOAT [0.0..100.0] | Set target temperature of comfort mode |
setDerogationMode |
STRING: holidays, eco, comfort, auto | set a derogation mode |
setReducedTemperature |
ANY | |
setSecuredPositionTemperature |
ANY | Set target temperature of secured mode |
setTimeProgram |
ANY |
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
ActiveTimeProgramState |
DataState | ||
ComfortRoomTemperatureState |
ContinuousState | ||
HeatingDerogationModeState |
DiscreteState | auto, comfort, eco, holidays | |
OperatingModeState |
DiscreteState | antifreeze, auto, away, eco, frostprotection | |
ReducedTemperatureState |
ContinuousState | ||
SecuredPositionTemperatureState |
ContinuousState | ||
StatusState |
DiscreteState | available, unavailable | |
TemperatureState |
ContinuousState | [-100.0..100.0] | |
TimeProgramState |
DataState |
HeatingSystem/CothermThermostat (ACTUATOR) — 113 commands, 89 states
Type IDs: 17043211 | Servers: atlantic_cozytouch, hi_kumo_europe, rexel, somfy_europe | Controllable: ovp:CothermThermostatOVPComponent | Profiles: Specific
Data Properties
core:identifyInterval=500
Commands
| Command | Parameters | Notes |
|---|---|---|
getName |
Refresh the device internal name | |
identify |
Ask the device to identify itself by doing a slight movement or blink or beep | |
refreshAbscenceTime |
||
refreshAbscenceTimeMax |
||
refreshAbscenceTimeMin |
||
refreshBabyCareFunctionActivation |
||
refreshBabyCareFunctionActivationMax |
||
refreshBabyCareFunctionActivationMin |
||
refreshComfortTemperature |
Refresh the temperature of comfort mode | |
refreshComfortTemperatureMax |
||
refreshComfortTemperatureMin |
||
refreshConsignRegul |
||
refreshCountDetectPresence |
||
refreshCurrentState |
||
refreshCurrentStateMax |
||
refreshCurrentStateMin |
||
refreshCycleReport |
||
refreshDurationEnergyCounter |
||
refreshDurationEnergyCounterMax |
||
refreshDurationEnergyCounterMin |
||
refreshEcoTemperature |
Refresh the temperature of eco mode | |
refreshEcoTemperatureMax |
||
refreshEcoTemperatureMin |
||
refreshElectricPower |
||
refreshElectricPowerMax |
||
refreshElectricPowerMin |
||
refreshErrorThermostat |
||
refreshFirmwareVersion |
||
refreshFrostProtectionTemperature |
||
refreshFrostProtectionTemperatureMax |
||
refreshFrostProtectionTemperatureMin |
||
refreshHoursEnergyCounter |
||
refreshHoursEnergyCounterMax |
||
refreshHoursEnergyCounterMin |
||
refreshLockedUnlockedButton |
||
refreshMiniboxHolidayMode |
||
refreshMiniboxHolidayModeMax |
||
refreshMiniboxHolidayModeMin |
||
refreshMiniboxProgMode |
||
refreshMiniboxProgModeMax |
||
refreshMiniboxProgModeMin |
||
refreshNbSecAfterLastDetect |
||
refreshOpenWindowDetectionActivation |
||
refreshOpenWindowDetectionActivationMax |
||
refreshOpenWindowDetectionActivationMin |
||
refreshProductType |
||
refreshProductVersion |
||
refreshRoomTemperature |
||
refreshRoomTemperatureMax |
||
refreshRoomTemperatureMin |
||
refreshTechnicalOffset |
||
refreshTechnicalOffsetMax |
||
refreshTechnicalOffsetMin |
||
refreshTemporaryTemperature |
||
refreshTemporaryTemperatureMax |
||
refreshTemporaryTemperatureMin |
||
refreshThermostatRTC |
||
refreshTimer2h |
||
refreshTimer2hMax |
||
refreshTimer2hMin |
||
refreshUniqueSTChipId |
||
setAbscenceTime |
ANY | |
setAutoProgW1J1 |
ANY | |
setAutoProgW1J2 |
ANY | |
setAutoProgW1J3 |
ANY | |
setAutoProgW1J4 |
ANY | |
setAutoProgW1J5 |
ANY | |
setAutoProgW1J6 |
ANY | |
setAutoProgW1J7 |
ANY | |
setAutoProgW2J1 |
ANY | |
setAutoProgW2J2 |
ANY | |
setAutoProgW2J3 |
ANY | |
setAutoProgW2J4 |
ANY | |
setAutoProgW2J5 |
ANY | |
setAutoProgW2J6 |
ANY | |
setAutoProgW2J7 |
ANY | |
setAutoProgW3J1 |
ANY | |
setAutoProgW3J2 |
ANY | |
setAutoProgW3J3 |
ANY | |
setAutoProgW3J4 |
ANY | |
setAutoProgW3J5 |
ANY | |
setAutoProgW3J6 |
ANY | |
setAutoProgW3J7 |
ANY | |
setBabyCareFunctionActivation |
ANY | |
setComfortTemperature |
FLOAT [0.0..100.0] | Set target temperature of comfort mode |
setConsignRegul |
ANY | |
setCountDetectPresence |
ANY | |
setCurrentState |
ANY | |
setCycleReport |
ANY | |
setDurationEnergyCounter |
ANY | |
setEcoTemperature |
ANY | Set target temperature of eco mode |
setElectricPower |
ANY | |
setErrorThermostat |
ANY | |
setFrostProtectionTemperature |
ANY | |
setHoursEnergyCounter |
ANY | |
setLockedUnlockedButton |
ANY | |
setMiniboxHolidayMode |
ANY | |
setMiniboxProgMode |
ANY | |
setName |
STRING | Change the device internal name. Name length may be subject to restrictions depending on the device and underlying protocol. |
setNbSecAfterLastDetect |
ANY | |
setOpenWindowDetectionActivation |
ANY | |
setRoomTemperature |
ANY | |
setTechnicalOffset |
ANY | |
setTemporaryTemperature |
ANY | |
setThermostatRTC |
ANY | |
setTimer2h |
ANY | |
setUserProgJ1 |
ANY | |
setUserProgJ2 |
ANY | |
setUserProgJ3 |
ANY | |
setUserProgJ4 |
ANY | |
setUserProgJ5 |
ANY | |
setUserProgJ6 |
ANY | |
setUserProgJ7 |
ANY |
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
AbscenceTimeMaxState |
DataState | ||
AbscenceTimeMinState |
DataState | ||
AbscenceTimeState |
DataState | ||
AutoProgW1J1State |
DataState | ||
AutoProgW1J2State |
DataState | ||
AutoProgW1J3State |
DataState | ||
AutoProgW1J4State |
DataState | ||
AutoProgW1J5State |
DataState | ||
AutoProgW1J6State |
DataState | ||
AutoProgW1J7State |
DataState | ||
AutoProgW2J1State |
DataState | ||
AutoProgW2J2State |
DataState | ||
AutoProgW2J3State |
DataState | ||
AutoProgW2J4State |
DataState | ||
AutoProgW2J5State |
DataState | ||
AutoProgW2J6State |
DataState | ||
AutoProgW2J7State |
DataState | ||
AutoProgW3J1State |
DataState | ||
AutoProgW3J2State |
DataState | ||
AutoProgW3J3State |
DataState | ||
AutoProgW3J4State |
DataState | ||
AutoProgW3J5State |
DataState | ||
AutoProgW3J6State |
DataState | ||
AutoProgW3J7State |
DataState | ||
BabyCareFunctionActivationMaxState |
DiscreteState | active, inactive | |
BabyCareFunctionActivationMinState |
DiscreteState | active, inactive | |
BabyCareFunctionActivationState |
DiscreteState | active, inactive | |
ComfortRoomTemperatureMaxState |
ContinuousState | ||
ComfortRoomTemperatureMinState |
ContinuousState | ||
ComfortRoomTemperatureState |
ContinuousState | ||
ConsignRegulState |
ContinuousState | ||
CountDetectPresenceState |
ContinuousState | ||
CurrentStateMaxState |
DataState | ||
CurrentStateMinState |
DataState | ||
CurrentStateState |
DataState | ||
CycleReportState |
ContinuousState | ||
DurationEnergyCounterMaxState |
ContinuousState | ||
DurationEnergyCounterMinState |
ContinuousState | ||
DurationEnergyCounterState |
ContinuousState | ||
EcoRoomTemperatureMaxState |
ContinuousState | ||
EcoRoomTemperatureMinState |
ContinuousState | ||
EcoRoomTemperatureState |
ContinuousState | ||
ElectricPowerMaxState |
DataState | ||
ElectricPowerMinState |
DataState | ||
ElectricPowerState |
DataState | ||
ErrorThermostatState |
DataState | ||
FirmwareVersionState |
DataState | ||
FrostProtectionRoomTemperatureMaxState |
ContinuousState | ||
FrostProtectionRoomTemperatureMinState |
ContinuousState | ||
FrostProtectionRoomTemperatureState |
ContinuousState | ||
HoursEnergyCounterMaxState |
ContinuousState | ||
HoursEnergyCounterMinState |
ContinuousState | ||
HoursEnergyCounterState |
ContinuousState | ||
LockedButtonState |
DiscreteState | locked, unlocked | |
MiniboxHolidayModeMaxState |
DiscreteState | antifrost, comfort, eco, no_program | |
MiniboxHolidayModeMinState |
DiscreteState | antifrost, comfort, eco, no_program | |
MiniboxHolidayModeState |
DiscreteState | antifrost, comfort, eco, no_program | |
MiniboxProgModeMaxState |
DiscreteState | antifrost, comfort, eco, no_program | |
MiniboxProgModeMinState |
DiscreteState | antifrost, comfort, eco, no_program | |
MiniboxProgModeState |
DiscreteState | antifrost, comfort, eco, no_program | |
NameState |
DataState | ||
NbSecAfterLastDetectState |
ContinuousState | ||
OpenWindowDetectionActivationMaxState |
DiscreteState | active, inactive | |
OpenWindowDetectionActivationMinState |
DiscreteState | active, inactive | |
OpenWindowDetectionActivationState |
DiscreteState | active, inactive | |
ProductTypeState |
DataState | ||
ProductVersionState |
DataState | ||
RoomTemperatureMaxState |
ContinuousState | ||
RoomTemperatureMinState |
ContinuousState | ||
RoomTemperatureState |
ContinuousState | ||
StatusState |
DiscreteState | available, unavailable | |
TechnicalOffsetMaxState |
DataState | ||
TechnicalOffsetMinState |
DataState | ||
TechnicalOffsetState |
DataState | ||
TemporaryTemperatureMaxState |
ContinuousState | ||
TemporaryTemperatureMinState |
ContinuousState | ||
TemporaryTemperatureState |
ContinuousState | ||
ThermostatRTCState |
DataState | ||
Timer2hMaxState |
ContinuousState | ||
Timer2hMinState |
ContinuousState | ||
Timer2hState |
ContinuousState | ||
UniqueSTChipIdState |
DataState | ||
UserProgJ1State |
DataState | ||
UserProgJ2State |
DataState | ||
UserProgJ3State |
DataState | ||
UserProgJ4State |
DataState | ||
UserProgJ5State |
DataState | ||
UserProgJ6State |
DataState | ||
UserProgJ7State |
DataState |
HeatingSystem/KizOThermV2Bridge (ACTUATOR) — 6 commands, 23 states
Type IDs: 1099511628043, 2199023255819 | Servers: atlantic_cozytouch, hi_kumo_europe, rexel, somfy_europe | Controllable: ovp:KizOThermV2OVPComponent | Profiles: ThermostatTargetReader, DHWThermostatTargetReader, DHWTemperature
Data Properties
core:identifyInterval=500
Commands
| Command | Parameters | Notes |
|---|---|---|
getName |
Refresh the device internal name | |
identify |
Ask the device to identify itself by doing a slight movement or blink or beep | |
refreshState |
Refresh the device states | |
setName |
STRING | Change the device internal name. Name length may be subject to restrictions depending on the device and underlying protocol. |
setOperatingModes |
ANY | |
setSetpointOverride |
ANY |
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
BurnerOperationHoursState |
ContinuousState | ||
CH1ActiveModeState |
DiscreteState | active, inactive | |
CH2ActiveModeState |
DiscreteState | active, inactive | |
DHWActiveModeState |
DiscreteState | active, inactive | |
DHWTemperatureState |
ContinuousState | [-100.0..100.0] | |
ElectricEnergyGenerationState |
ContinuousState | ||
ElectricPowerGenerationState |
ContinuousState | ||
ElectricityGenerationOnOffState |
DiscreteState | off, on | |
FaultState |
DiscreteState | fault, noFault | |
KizOThermCapabilitiesState |
DataState | ||
KizOThermOperatingModesState |
DataState | ||
LowWaterPressureFaultState |
DataState | ||
NameState |
DataState | ||
OEMFaultCodeState |
ContinuousState | ||
OnOffFlameState |
DiscreteState | off, on | |
PrimaryTargetWaterTemperatureState |
ContinuousState | ||
RemoteRoomOverrideSetpointState |
ContinuousState | ||
SecondaryTargetWaterTemperatureState |
ContinuousState | ||
StatusState |
DiscreteState | available, unavailable | |
TargetDHWTemperatureState |
ContinuousState | [38.0..60.0] | |
TargetRoomTemperatureState |
ContinuousState | ||
TargetTemperatureState |
ContinuousState | [12.0..30.0] | |
WaterPressureState |
ContinuousState |
HeatingSystem/SomfyPilotWireElectricalHeater (ACTUATOR) — 9 commands, 10 states
Type IDs: 1099515035650 | Servers: atlantic_cozytouch, hi_kumo_europe, rexel, somfy_europe | Controllable: ovp:SomfyPilotWireElectricalHeaterOVPComponent | Profiles: StatefulHeatingLevel, HeatingLevel
Data Properties
core:identifyInterval=500
Commands
| Command | Parameters | Notes |
|---|---|---|
getName |
Refresh the device internal name | |
identify |
Ask the device to identify itself by doing a slight movement or blink or beep | |
off |
Turn off the device | |
refreshHeatingLevel |
Refresh the heating level mode | |
refreshIdentifier |
Refresh the device system identifier (can be used to link several devices) | |
setHeatingLevel |
STRING: boost, comfort, comfort-1, comfort-2, eco | Sets the device heating level mode |
setHeatingLevelForTrigger |
ANY | |
setName |
STRING | Change the device internal name. Name length may be subject to restrictions depending on the device and underlying protocol. |
setTimerForTransitoryState |
ANY |
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
HeatingTemperatureInterfaceActiveModeState |
DiscreteState | auto, manu | |
IdentifierState |
DataState | ||
MaximumHeatingLevelState |
DiscreteState | boost, comfort, comfort-1, comfort-2, eco, frostprotection, off, secured | |
NameState |
DataState | ||
OnOffState |
DiscreteState | on, off | |
StatusState |
DiscreteState | available, unavailable | |
TargetHeatingLevelState |
DiscreteState | comfort, eco | |
TargetHeatingLevelState |
DiscreteState | boost, comfort, comfort-1, comfort-2, eco, frostprotection, off, secured | |
TimerForTransitoryStateState |
ContinuousState | ||
VersionState |
ContinuousState |
HeatingSystem/SomfyPilotWireHeatingInterface (ACTUATOR) — 11 commands, 7 states
Type IDs: 1103806726146 | Servers: atlantic_cozytouch, hi_kumo_europe, rexel, somfy_europe | Controllable: ovp:SomfyPilotWireHeatingInterfaceOVPComponent | Profiles: SwitchableHeatingStatus, OnOffStatus
Data Properties
core:identifyInterval=500
Commands
| Command | Parameters | Notes |
|---|---|---|
getName |
Refresh the device internal name | |
identify |
Ask the device to identify itself by doing a slight movement or blink or beep | |
refreshActiveMode |
Refresh the device active mode | |
refreshBatteryLevel |
Refresh the battery level | |
refreshIdentifier |
Refresh the device system identifier (can be used to link several devices) | |
refreshOnOffState |
Get the device on/off state | |
refreshSetPointMode |
Refresh the heating target mode or temperature (if supported) | |
setActiveMode |
STRING: auto, manu | Select the active mode (auto mode activates device internal regulation) |
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 |
setSetPointMode |
STRING: comfort, eco, secured | Set the target heating mode or temperature (if supported) |
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
BatteryState |
DiscreteState | verylow, low, normal, full | |
HeatingTemperatureInterfaceActiveModeState |
DiscreteState | auto, manu | |
HeatingTemperatureInterfaceSetPointModeState |
DiscreteState | comfort, eco, free, secured | |
IdentifierState |
DataState | ||
NameState |
DataState | ||
OnOffState |
DiscreteState | on, off | |
StatusState |
DiscreteState | available, unavailable |
HitachiHeatingSystem/HitachiAirToAirHeatPump (ACTUATOR) — 7 commands, 17 states
Type IDs: 1099513069579 | Servers: atlantic_cozytouch, hi_kumo_europe, rexel, somfy_europe | Controllable: ovp:HLinkMainController | Profiles: ThermostatTargetReader
Data Properties
core:identifyInterval=500
Commands
| Command | Parameters | Notes |
|---|---|---|
getName |
Refresh the device internal name | |
globalControl |
STRING: On, Off; STRING: off, on; INT; STRING: auto, hi, med, lo, silent; STRING: auto, heating, dehumidify, cooling, fan; STRING: timer, manu, holidays (optional) | Manage device |
identify |
Ask the device to identify itself by doing a slight movement or blink or beep | |
setAutoManu |
STRING: auto, manu | Set device mode to auto or manual mode |
setHolidays |
STRING: off, on | Set holidays mode |
setMainOperation |
STRING: On, Off; STRING: off, on | Set device main operating mode |
setName |
STRING | Change the device internal name. Name length may be subject to restrictions depending on the device and underlying protocol. |
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
AutoManuModeState |
DiscreteState | auto, manu | |
DiagnosticCodeState |
DataState | ||
FanSpeedState |
DiscreteState | Auto FAN, Hi FAN, Lo FAN, Med FAN, silent | |
FilterConditionState |
DiscreteState | OK, alert | |
FilterResetState |
DiscreteState | normal, reset | |
HLinkVirtualOperatingModeState |
DiscreteState | auto, holidays, normal, timer | |
HolidaysModeState |
DiscreteState | off, on | |
MainOperationState |
DiscreteState | off, on | |
ModeChangeState |
DiscreteState | auto cooling, auto heating, circulator, cooling, dehumidify, fan, heating | |
NameState |
DataState | ||
OutdoorTemperatureState |
ContinuousState | ||
RemoconControlState |
DiscreteState | disable, enable | |
RoomTemperatureState |
ContinuousState | ||
StatusState |
DiscreteState | available, unavailable | |
TargetTemperatureState |
ContinuousState | [12.0..30.0] | |
TemperatureChangeState |
ContinuousState | ||
ThermoStatusState |
DiscreteState | off, on |
OnOff/StatefulOnOff (ACTUATOR) — 6 commands, 3 states
Type IDs: 983040, 1099512610827 | Servers: atlantic_cozytouch, hi_kumo_europe, rexel, somfy_europe | Controllable: ovp:OnOffOVPComponent | Profiles: StatefulSwitchable, Switchable, Generic
Data Properties
core:identifyInterval=500
Commands
| Command | Parameters | Notes |
|---|---|---|
getName |
Refresh the device internal name | |
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 | |
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 |
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
NameState |
DataState | ||
OnOffState |
DiscreteState | on, off | |
StatusState |
DiscreteState | available, unavailable |
ProtocolGateway/DeDietrichModbusGateway (PROTOCOL_GATEWAY) — 3 commands, 2 states
Type IDs: 16842763 | Servers: atlantic_cozytouch, hi_kumo_europe, rexel, somfy_europe | Controllable: ovp:DeDietrichModbusGatewayOVPComponent | Profiles: Specific
Data Properties
core:identifyInterval=500
Commands
| Command | Parameters | Notes |
|---|---|---|
getName |
Refresh the device internal name | |
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. |
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
NameState |
DataState | ||
StatusState |
DiscreteState | available, unavailable |
SwimmingPool/DeDietrichSwimmingPool (ACTUATOR) — 12 commands, 8 states
Type IDs: 16842763 | Servers: atlantic_cozytouch, hi_kumo_europe, rexel, somfy_europe | Controllable: ovp:SwimmingPoolOnCircuitBOVPComponent | Profiles: Temperature
Commands
| Command | Parameters | Notes |
|---|---|---|
autoMode |
Switch device to auto mode | |
refreshActiveTimeProgram |
Refresh curent active time program. | |
refreshCircuitType |
||
refreshComfortTemperature |
Refresh the temperature of comfort mode | |
refreshOperatingMode |
Refresh an operating mode. | |
refreshReducedTemperature |
||
refreshTimeProgram |
||
refreshWaterSensorValue |
||
setActiveTimeProgram |
ANY | Defines curent active time program |
setComfortTemperature |
FLOAT [0.0..100.0] | Set target temperature of comfort mode |
setReducedTemperature |
ANY | |
setTimeProgram |
ANY |
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
ActiveTimeProgramState |
DataState | ||
AutoModeState |
DiscreteState | false, true | |
ComfortRoomTemperatureState |
ContinuousState | ||
OperatingModeState |
DiscreteState | antifreeze, auto, away, eco, frostprotection | |
ReducedTemperatureState |
ContinuousState | ||
StatusState |
DiscreteState | available, unavailable | |
TemperatureState |
ContinuousState | [-100.0..100.0] | |
TimeProgramState |
DataState |
TemperatureSensor (SENSOR) — 2 commands, 3 states
Type IDs: 917506, 917515, 1099511628043, 2199023255819 | Servers: atlantic_cozytouch, hi_kumo_europe, rexel, somfy_europe | Controllable: ovp:HeatingTemperatureInterfaceTemperatureSensor | Profiles: Temperature
Commands
| Command | Parameters | Notes |
|---|---|---|
getName |
Refresh the device internal name | |
setName |
STRING | Change the device internal name. Name length may be subject to restrictions depending on the device and underlying protocol. |
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
NameState |
DataState | ||
StatusState |
DiscreteState | available, unavailable | |
TemperatureState |
ContinuousState | [-100.0..100.0] |
TemperatureSensor (SENSOR) — 0 commands, 2 states
Type IDs: 16842763, 1099511628043, 2199023255819 | Servers: atlantic_cozytouch, hi_kumo_europe, rexel, somfy_europe | Controllable: ovp:OutsideTemperatureSensorOVPComponent | Profiles: Temperature
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
StatusState |
DiscreteState | available, unavailable | |
TemperatureState |
ContinuousState | [-100.0..100.0] |
TemperatureSensor (SENSOR) — 2 commands, 4 states
Type IDs: 4295098368 | Servers: atlantic_cozytouch, hi_kumo_europe, rexel, somfy_europe | Controllable: ovp:InsideTemperatureSensorOVPComponent | Profiles: Temperature
Commands
| Command | Parameters | Notes |
|---|---|---|
getName |
Refresh the device internal name | |
setName |
STRING | Change the device internal name. Name length may be subject to restrictions depending on the device and underlying protocol. |
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
NameState |
DataState | ||
SensorDefectState |
DiscreteState | dead, lowBattery, maintenanceRequired, noDefect | |
StatusState |
DiscreteState | available, unavailable | |
TemperatureState |
ContinuousState | [-100.0..100.0] |
TemperatureSensor (SENSOR) — 3 commands, 5 states
Type IDs: 1103806726146 | Servers: atlantic_cozytouch, hi_kumo_europe, rexel, somfy_europe | Controllable: ovp:SomfyPilotWireTemperatureSensorOVPComponent | Profiles: Temperature
Commands
| Command | Parameters | Notes |
|---|---|---|
getName |
Refresh the device internal name | |
refreshTemperature |
Refresh the last measured temperature | |
setName |
STRING | Change the device internal name. Name length may be subject to restrictions depending on the device and underlying protocol. |
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
NameState |
DataState | ||
SensorDefectState |
DiscreteState | dead, lowBattery, maintenanceRequired, noDefect | |
StatusState |
DiscreteState | available, unavailable | |
TemperatureState |
ContinuousState | [-100.0..100.0] | |
VersionState |
ContinuousState |
WaterHeatingSystem/DeDietrichDHW (ACTUATOR) — 10 commands, 7 states
Type IDs: 16842763 | Servers: atlantic_cozytouch, hi_kumo_europe, rexel, somfy_europe | Controllable: ovp:DHW1OnDHWCircuitOVPComponent | Profiles: Temperature
Commands
| Command | Parameters | Notes |
|---|---|---|
refreshCircuitType |
||
refreshComfortTemperature |
Refresh the temperature of comfort mode | |
refreshDHWDerogationMode |
Refresh derogation command | |
refreshOperatingMode |
Refresh an operating mode. | |
refreshReducedTemperature |
||
refreshTimeProgram |
||
setComfortTemperature |
FLOAT [0.0..100.0] | Set target temperature of comfort mode |
setDHWDerogationMode |
STRING: auto, comfort | set a derogation mode |
setReducedTemperature |
ANY | |
setTimeProgram |
ANY |
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
ComfortRoomTemperatureState |
ContinuousState | ||
DHWDerogationModeState |
DiscreteState | auto, comfort | |
OperatingModeState |
DiscreteState | antifreeze, auto, away, eco, frostprotection | |
ReducedTemperatureState |
ContinuousState | ||
StatusState |
DiscreteState | available, unavailable | |
TemperatureState |
ContinuousState | [-100.0..100.0] | |
TimeProgramState |
DataState |
WaterHeatingSystem/DeDietrichDHW (ACTUATOR) — 6 commands, 5 states
Type IDs: 16842763 | Servers: atlantic_cozytouch, hi_kumo_europe, rexel, somfy_europe | Controllable: ovp:DHW2OnCircuitAOVPComponent | Profiles: Temperature
Commands
| Command | Parameters | Notes |
|---|---|---|
refreshActiveTimeProgram |
Refresh curent active time program. | |
refreshCircuitType |
||
refreshOperatingMode |
Refresh an operating mode. | |
refreshTimeProgram |
||
setActiveTimeProgram |
ANY | Defines curent active time program |
setTimeProgram |
ANY |
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
ActiveTimeProgramState |
DataState | ||
OperatingModeState |
DiscreteState | antifreeze, auto, away, eco, frostprotection | |
StatusState |
DiscreteState | available, unavailable | |
TemperatureState |
ContinuousState | [-100.0..100.0] | |
TimeProgramState |
DataState |
WaterHeatingSystem/DeDietrichDHW (ACTUATOR) — 4 commands, 4 states
Type IDs: 16842763 | Servers: atlantic_cozytouch, hi_kumo_europe, rexel, somfy_europe | Controllable: ovp:DHW2OnAuxiliaryCircuitOVPComponent | Profiles: Temperature
Commands
| Command | Parameters | Notes |
|---|---|---|
refreshCircuitType |
||
refreshOperatingMode |
Refresh an operating mode. | |
refreshTimeProgram |
||
setTimeProgram |
ANY |
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
OperatingModeState |
DiscreteState | antifreeze, auto, away, eco, frostprotection | |
StatusState |
DiscreteState | available, unavailable | |
TemperatureState |
ContinuousState | [-100.0..100.0] | |
TimeProgramState |
DataState |
unknown (ACTUATOR) — 1 commands, 1 states
Type IDs: 16842763 | Servers: atlantic_cozytouch, hi_kumo_europe, rexel, somfy_europe | Controllable: ovp:SolarCircuitOVPComponent | Profiles: Specific
Commands
| Command | Parameters | Notes |
|---|---|---|
refreshSoftwareVersion |
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
StatusState |
DiscreteState | available, unavailable |
PROFALUX_868
5 device types.
ExteriorScreen/UpDownExteriorScreen (ACTUATOR) — 7 commands, 0 states
Type IDs: 2 | Servers: somfy_europe | Controllable: profalux868:Profalux868ExteriorScreen | Profiles: OpenCloseScreen, OpenClose
Data Properties
core:identifyInterval=500
Commands
| Command | Parameters | Notes |
|---|---|---|
close |
Fully close the device | |
down |
Move the device completely down | |
goToMemorized1Position |
Set the device to a user pre-defined position | |
identify |
Ask the device to identify itself by doing a slight movement or blink or beep | |
open |
Fully open the device | |
stop |
Stop the current actuator behavior (movement, sound or timer) | |
up |
Move the device completely up |
ExteriorScreen/UpDownExteriorScreen (ACTUATOR) — 6 commands, 0 states
Type IDs: 5 | Servers: somfy_europe | Controllable: profalux868:Profalux868ExteriorScreenPlatinum | Profiles: OpenCloseScreen, OpenClose
Data Properties
core:identifyInterval=500
Commands
| Command | Parameters | Notes |
|---|---|---|
close |
Fully close the device | |
down |
Move the device completely down | |
identify |
Ask the device to identify itself by doing a slight movement or blink or beep | |
open |
Fully open the device | |
stop |
Stop the current actuator behavior (movement, sound or timer) | |
up |
Move the device completely up |
ExteriorVenetianBlind/UpDownExteriorVenetianBlind (ACTUATOR) — 6 commands, 0 states
Type IDs: 3, 6 | Servers: somfy_europe | Controllable: profalux868:Profalux868ExteriorVenetianBlind | Profiles: OpenCloseBlind, OpenClose
Data Properties
core:identifyInterval=500
Commands
| Command | Parameters | Notes |
|---|---|---|
close |
Fully close the device | |
down |
Move the device completely down | |
identify |
Ask the device to identify itself by doing a slight movement or blink or beep | |
open |
Fully open the device | |
stop |
Stop the current actuator behavior (movement, sound or timer) | |
up |
Move the device completely up |
RollerShutter/UpDownRollerShutter (ACTUATOR) — 7 commands, 0 states
Type IDs: 1 | Servers: somfy_europe | Controllable: profalux868:Profalux868RollerShutter | Profiles: OpenCloseShutter, OpenClose
Data Properties
core:identifyInterval=500
Commands
| Command | Parameters | Notes |
|---|---|---|
close |
Fully close the device | |
down |
Move the device completely down | |
goToMemorized1Position |
Set the device to a user pre-defined position | |
identify |
Ask the device to identify itself by doing a slight movement or blink or beep | |
open |
Fully open the device | |
stop |
Stop the current actuator behavior (movement, sound or timer) | |
up |
Move the device completely up |
RollerShutter/UpDownRollerShutter (ACTUATOR) — 6 commands, 0 states
Type IDs: 4 | Servers: somfy_europe | Controllable: profalux868:Profalux868RollerShutterPlatinum | Profiles: OpenCloseShutter, OpenClose
Data Properties
core:identifyInterval=500
Commands
| Command | Parameters | Notes |
|---|---|---|
close |
Fully close the device | |
down |
Move the device completely down | |
identify |
Ask the device to identify itself by doing a slight movement or blink or beep | |
open |
Fully open the device | |
stop |
Stop the current actuator behavior (movement, sound or timer) | |
up |
Move the device completely up |
RAMSES
7 device types.
EvoHome/HeatingSetPoint (ACTUATOR) — 5 commands, 6 states
Type IDs: 0 | Servers: somfy_europe | Controllable: ramses:EvoHomeZoneSetPoint | Profiles: StatefulThermostatWithSensor, StatefulThermostat, Thermostat
Commands
| Command | Parameters | Notes |
|---|---|---|
getName |
Refresh the device internal name | |
setName |
STRING | Change the device internal name. Name length may be subject to restrictions depending on the device and underlying protocol. |
setSetpointOverride |
INT; STRING: NoOverride, OverrideUntilNextTimeProgram, PermanentOverride, DelayedOverride, PeriodicOverride; ANY (optional) | |
setTargetTemperature |
FLOAT [0.0..100.0]; STRING: eco, secured, comfort, halted, antifrost | Set the new air temperature to reach |
setTimeProgram |
OBJECT |
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
NameState |
DataState | ||
RAMSESSetPointOverrideDurationState |
DataState | ||
RAMSESSetPointOverrideModeState |
DataState | ||
RAMSESZoneTimeProgramState |
DataState | ||
TargetTemperatureState |
ContinuousState | [12.0..30.0] | |
TemperatureState |
ContinuousState | [-100.0..100.0] |
EvoHome/DHWSetPoint (ACTUATOR) — 2 commands, 4 states
Type IDs: 1 | Servers: somfy_europe | Controllable: ramses:EvoHomeDHWSetPoint | Profiles: DHWThermostatTargetReader, Temperature
Commands
| Command | Parameters | Notes |
|---|---|---|
getName |
Refresh the device internal name | |
setTimeProgram |
OBJECT |
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
NameState |
DataState | ||
RAMSESDHWTimeProgramState |
DataState | ||
TargetDHWTemperatureState |
ContinuousState | [38.0..60.0] | |
TemperatureState |
ContinuousState | [-100.0..100.0] |
EvoHome/EvoHomeController (ACTUATOR) — 1 commands, 2 states
Type IDs: 2 | Servers: somfy_europe | Controllable: ramses:EvoHomeController | Profiles: Specific
Commands
| Command | Parameters | Notes |
|---|---|---|
setOperatingMode |
STRING: auto, off, eco, holidays, day-off; ANY (optional) |
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
RAMSESOperatingModeState |
DiscreteState | auto, eco, holidays, off | |
RAMSESOperatingModeTimeoutState |
DataState |
EvoHome/OpenThermDiagnostic (ACTUATOR) — 0 commands, 0 states
Type IDs: 3 | Servers: somfy_europe | Controllable: ramses:RamsesOpenThermGateway | Profiles: Specific
TemperatureSensor (SENSOR) — 2 commands, 3 states
Type IDs: 0 | Servers: somfy_europe | Controllable: ramses:EvoHomeZoneSensor | Profiles: Temperature
Commands
| Command | Parameters | Notes |
|---|---|---|
getName |
Refresh the device internal name | |
setName |
STRING | Change the device internal name. Name length may be subject to restrictions depending on the device and underlying protocol. |
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
NameState |
DataState | ||
SensorDefectState |
DiscreteState | dead, lowBattery, maintenanceRequired, noDefect | |
TemperatureState |
ContinuousState | [-100.0..100.0] |
TemperatureSensor (SENSOR) — 1 commands, 2 states
Type IDs: 1 | Servers: somfy_europe | Controllable: ramses:EvoHomeDHWSensor | Profiles: Temperature
Commands
| Command | Parameters | Notes |
|---|---|---|
getName |
Refresh the device internal name |
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
NameState |
DataState | ||
TemperatureState |
ContinuousState | [-100.0..100.0] |
TemperatureSensor (SENSOR) — 0 commands, 1 states
Type IDs: 2 | Servers: somfy_europe | Controllable: ramses:EvoHomeControllerSensor | Profiles: Temperature
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
TemperatureState |
ContinuousState | [-100.0..100.0] |
RTD
5 device types.
Alarm/StatelessAlarmController (ACTUATOR) — 6 commands, 0 states
Type IDs: 1 | Servers: rexel, somfy_europe | Controllable: rtd:AlarmRTDComponent | Profiles: Alarm
Data Properties
core:identifyInterval=5000
Commands
| Command | Parameters | Notes |
|---|---|---|
alarmOff |
Turn off the alarm (All zones) | |
alarmOn |
Turn the alarm on | |
alarmZoneOn |
STRING: A, B, C, A,B, B,C | Turn on some alarm zones |
arm |
Arm the system | |
disarm |
Disarm the system | |
identify |
Ask the device to identify itself by doing a slight movement or blink or beep |
Alarm/IntrusionDetector (ACTUATOR) — 2 commands, 0 states
Type IDs: 2, 3, 4 | Servers: rexel, somfy_europe | Controllable: rtd:MotionOrContactSensorRTDComponent | Profiles: Specific
Commands
| Command | Parameters | Notes |
|---|---|---|
notifyDefect |
||
notifyNoDefect |
Generic/unknown (ACTUATOR) — 0 commands, 0 states
Type IDs: 0 | Servers: rexel, somfy_europe | Controllable: rtd:UnknownRTDComponent | Profiles: Specific
Siren/RTDIndoorSiren (ACTUATOR) — 9 commands, 0 states
Type IDs: 5 | Servers: rexel, somfy_europe | Controllable: rtd:IndoorSirenRTDComponent | Profiles: Siren, VolumeControl, Switchable
Commands
| Command | Parameters | Notes |
|---|---|---|
bip |
Ask the device to make a "bip" sound | |
dingDong |
Ask the device to make a "dingDong" sound | |
fastBipSequence |
Ask the device to make a fast bip sequence | |
off |
Turn off the device | |
on |
Turn on the device | |
pair |
Execute the pairing procedure | |
ring |
Ask the device to start ringing | |
setVolume |
INT [0..100] | Set the device output volume |
stop |
Stop the current actuator behavior (movement, sound or timer) |
Siren/RTDOutdoorSiren (ACTUATOR) — 9 commands, 0 states
Type IDs: 6 | Servers: rexel, somfy_europe | Controllable: rtd:OutdoorSirenRTDComponent | Profiles: Siren, VolumeControl, Switchable
Commands
| Command | Parameters | Notes |
|---|---|---|
bip |
Ask the device to make a "bip" sound | |
fastBipSequence |
Ask the device to make a fast bip sequence | |
flash |
Ask the device to make a light flash sequence | |
off |
Turn off the device | |
on |
Turn on the device | |
pair |
Execute the pairing procedure | |
ring |
Ask the device to start ringing | |
setVolume |
INT [0..100] | Set the device output volume |
stop |
Stop the current actuator behavior (movement, sound or timer) |
RTDS
11 device types.
AirSensor/COSensor (SENSOR) — 0 commands, 3 states
Type IDs: 129 | Servers: rexel, somfy_europe | Controllable: rtds:RTDSCOSensor | Profiles: CODetection
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
CODetectionState |
DiscreteState | detected, notDetected | |
SensorDefectState |
DiscreteState | dead, lowBattery, maintenanceRequired, noDefect | |
StatusState |
DiscreteState | available, unavailable |
AirSensor/AirFlowSensor (SENSOR) — 0 commands, 3 states
Type IDs: 130 | Servers: rexel, somfy_europe | Controllable: rtds:RTDSGasSensor | Profiles: GasDetector
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
GasDetectionState |
DiscreteState | detected, notDetected | |
SensorDefectState |
DiscreteState | dead, lowBattery, maintenanceRequired, noDefect | |
StatusState |
DiscreteState | available, unavailable |
ContactSensor (SENSOR) — 0 commands, 3 states
Type IDs: 2 | Servers: rexel, somfy_europe | Controllable: rtds:RTDSContactSensor | Profiles: DoorContactSensor, ContactDetector
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
ContactState |
DiscreteState | open, closed | |
SensorDefectState |
DiscreteState | dead, lowBattery, maintenanceRequired, noDefect | |
StatusState |
DiscreteState | available, unavailable |
Generic/unknown (SENSOR) — 0 commands, 3 states
Type IDs: 133 | Servers: rexel, somfy_europe | Controllable: rtds:RTDSPowerFailure | Profiles: PowerCutDetector
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
PowerCutDetectionState |
DiscreteState | detected, notDetected | |
SensorDefectState |
DiscreteState | dead, lowBattery, maintenanceRequired, noDefect | |
StatusState |
DiscreteState | available, unavailable |
Generic/unknown (SENSOR) — 0 commands, 0 states
Type IDs: 254 | Servers: rexel, somfy_europe | Controllable: rtds:UnknownRTDSComponent | Profiles: Specific
OccupancySensor/MotionSensor (SENSOR) — 0 commands, 3 states
Type IDs: 1 | Servers: rexel, somfy_europe | Controllable: rtds:RTDSMotionSensor | Profiles: OccupancyDetector
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
OccupancyState |
DiscreteState | personInside, noPersonInside | |
SensorDefectState |
DiscreteState | dead, lowBattery, maintenanceRequired, noDefect | |
StatusState |
DiscreteState | available, unavailable |
RemoteController/AlarmRemoteController (REMOTE_CONTROLLER) — 0 commands, 7 states
Type IDs: 0 | Servers: rexel, somfy_europe | Controllable: rtds:RTDSRemoteControllerComponent | Profiles: Specific
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
ControllerBatteryState |
ContinuousState | ||
ControllerBipState |
ContinuousState | ||
ControllerOrderTypeState |
ContinuousState | ||
ControllerOriginatorState |
ContinuousState | ||
ControllerSensingState |
ContinuousState | ||
ControllerSirenState |
ContinuousState | ||
StatusState |
DiscreteState | available, unavailable |
Siren/SirenStatus (SENSOR) — 0 commands, 4 states
Type IDs: 4 | Servers: rexel, somfy_europe | Controllable: rtds:SirenStatusRTDSComponent | Profiles: Specific
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
AssemblyState |
DiscreteState | closed, open | |
AvailabilityState |
DiscreteState | available, unavailable | |
BatteryState |
DiscreteState | verylow, low, normal, full | |
StatusState |
DiscreteState | available, unavailable |
SmokeSensor (SENSOR) — 0 commands, 3 states
Type IDs: 128 | Servers: rexel, somfy_europe | Controllable: rtds:RTDSSmokeSensor | Profiles: SmokeDetector
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
SensorDefectState |
DiscreteState | dead, lowBattery, maintenanceRequired, noDefect | |
SmokeState |
DiscreteState | detected, notDetected | |
StatusState |
DiscreteState | available, unavailable |
TemperatureSensor (SENSOR) — 0 commands, 3 states
Type IDs: 132 | Servers: rexel, somfy_europe | Controllable: rtds:RTDSTemperatureSensor | Profiles: Specific
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
SensorDefectState |
DiscreteState | dead, lowBattery, maintenanceRequired, noDefect | |
StatusState |
DiscreteState | available, unavailable | |
TemperatureOutOfRangeDetectionState |
DiscreteState | detected, notDetected |
WaterSensor/WaterDetectionSensor (SENSOR) — 0 commands, 3 states
Type IDs: 131 | Servers: rexel, somfy_europe | Controllable: rtds:RTDSWaterSensor | Profiles: WaterDetector
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
SensorDefectState |
DiscreteState | dead, lowBattery, maintenanceRequired, noDefect | |
StatusState |
DiscreteState | available, unavailable | |
WaterDetectionState |
DiscreteState | detected, notDetected |
RTS
25 device types.
Awning/UpDownHorizontalAwning (ACTUATOR) — 12 commands, 0 states
Type IDs: 4, 25, 65540 | Servers: rexel, somfy_europe | Controllable: rts:HorizontalAwningRTSComponent | Profiles: DeployUndeployAwning, DeployUndeploy, OpenClose
Data Properties
core:identifyInterval=0
Commands
| Command | Parameters | Notes |
|---|---|---|
close |
INT [0..30] (optional) | Move the device completely down p1: Set the execution duration in seconds (Optional - default : 30) |
deploy |
INT [0..30] (optional) | Move the device completely down p1: Set the execution duration in seconds (Optional - default : 30) |
down |
INT [0..30] (optional) | Move the device completely down p1: Set the execution duration in seconds (Optional - default : 30) |
identify |
Ask the device to identify itself by doing a slight movement or blink or beep | |
my |
INT [0..30] (optional) | Set the device to a user pre-defined position p1: Set the execution duration in seconds (Optional - default : 30) |
open |
INT [0..30] (optional) | Move the device completely up p1: Set the execution duration in seconds (Optional - default : 30) |
openConfiguration |
INT [0..30] (optional) | Put a RTS product in configuration mode p1: Set the execution duration in seconds (Optional - default : 30) |
rest |
INT [0..30] (optional) | p1: Set the execution duration in seconds (Optional - default : 30) |
stop |
INT [0..30] (optional) | Ask the device to stop p1: Set the execution duration in seconds (Optional - default : 30) |
test |
||
undeploy |
INT [0..30] (optional) | Move the device completely up p1: Set the execution duration in seconds (Optional - default : 30) |
up |
INT [0..30] (optional) | Move the device completely up p1: Set the execution duration in seconds (Optional - default : 30) |
Curtain/UpDownCurtain (ACTUATOR) — 10 commands, 0 states
Type IDs: 10, 65561, 65562, 11, 65546, 65547 | Servers: rexel, somfy_europe | Controllable: rts:CurtainRTSComponent | Profiles: OpenCloseCurtain, OpenClose
Data Properties
core:identifyInterval=0
Commands
| Command | Parameters | Notes |
|---|---|---|
close |
INT [0..30] (optional) | Move the device completely down p1: Set the execution duration in seconds (Optional - default : 30) |
down |
INT [0..30] (optional) | Move the device completely down p1: Set the execution duration in seconds (Optional - default : 30) |
identify |
Ask the device to identify itself by doing a slight movement or blink or beep | |
my |
INT [0..30] (optional) | Set the device to a user pre-defined position p1: Set the execution duration in seconds (Optional - default : 30) |
open |
INT [0..30] (optional) | Move the device completely up p1: Set the execution duration in seconds (Optional - default : 30) |
openConfiguration |
INT [0..30] (optional) | Put a RTS product in configuration mode p1: Set the execution duration in seconds (Optional - default : 30) |
rest |
INT [0..30] (optional) | p1: Set the execution duration in seconds (Optional - default : 30) |
stop |
INT [0..30] (optional) | Ask the device to stop p1: Set the execution duration in seconds (Optional - default : 30) |
test |
||
up |
INT [0..30] (optional) | Move the device completely up p1: Set the execution duration in seconds (Optional - default : 30) |
ExteriorHeatingSystem/StatelessExteriorHeating (ACTUATOR) — 11 commands, 0 states
Type IDs: 16, 65552 | Servers: rexel, somfy_europe | Controllable: rts:ExteriorHeatingRTSComponent | Profiles: SwitchableHeating, Switchable, UpDown
Data Properties
core:identifyInterval=0
Commands
| Command | Parameters | Notes |
|---|---|---|
down |
INT [0..30] (optional) | Move the device completely down p1: Set the execution duration in seconds (Optional - default : 30) |
identify |
Ask the device to identify itself by doing a slight movement or blink or beep | |
my |
INT [0..30] (optional) | Set the device to a user pre-defined position p1: Set the execution duration in seconds (Optional - default : 30) |
off |
Turn off the device | |
on |
Turn on the device | |
onWithTimer |
INT [5..14400] | Turn the device on for a given amount of seconds then turn it off |
openConfiguration |
INT [0..30] (optional) | Put a RTS product in configuration mode p1: Set the execution duration in seconds (Optional - default : 30) |
rest |
INT [0..30] (optional) | p1: Set the execution duration in seconds (Optional - default : 30) |
stop |
INT [0..30] (optional) | Ask the device to stop p1: Set the execution duration in seconds (Optional - default : 30) |
test |
||
up |
INT [0..30] (optional) | Move the device completely up p1: Set the execution duration in seconds (Optional - default : 30) |
ExteriorScreen/UpDownExteriorScreen (ACTUATOR) — 10 commands, 0 states
Type IDs: 3, 65539 | Servers: rexel, somfy_europe | Controllable: rts:ExteriorBlindRTSComponent | Profiles: OpenCloseBlind, OpenClose
Data Properties
core:identifyInterval=0
Commands
| Command | Parameters | Notes |
|---|---|---|
close |
INT [0..30] (optional) | Move the device completely down p1: Set the execution duration in seconds (Optional - default : 30) |
down |
INT [0..30] (optional) | Move the device completely down p1: Set the execution duration in seconds (Optional - default : 30) |
identify |
Ask the device to identify itself by doing a slight movement or blink or beep | |
my |
INT [0..30] (optional) | Set the device to a user pre-defined position p1: Set the execution duration in seconds (Optional - default : 30) |
open |
INT [0..30] (optional) | Move the device completely up p1: Set the execution duration in seconds (Optional - default : 30) |
openConfiguration |
INT [0..30] (optional) | Put a RTS product in configuration mode p1: Set the execution duration in seconds (Optional - default : 30) |
rest |
INT [0..30] (optional) | p1: Set the execution duration in seconds (Optional - default : 30) |
stop |
INT [0..30] (optional) | Ask the device to stop p1: Set the execution duration in seconds (Optional - default : 30) |
test |
||
up |
INT [0..30] (optional) | Move the device completely up p1: Set the execution duration in seconds (Optional - default : 30) |
ExteriorVenetianBlind/UpDownExteriorVenetianBlind (ACTUATOR) — 13 commands, 0 states
Type IDs: 2, 65538 | Servers: rexel, somfy_europe | Controllable: rts:ExteriorVenetianBlindRTSComponent | Profiles: OpenCloseBlind, OpenClose
Data Properties
core:identifyInterval=0
Commands
| Command | Parameters | Notes |
|---|---|---|
close |
INT [0..30] (optional) | Move the device completely down p1: Set the execution duration in seconds (Optional - default : 30) |
down |
INT [0..30] (optional) | Move the device completely down p1: Set the execution duration in seconds (Optional - default : 30) |
identify |
Ask the device to identify itself by doing a slight movement or blink or beep | |
moveOf |
INT [-127..127]; INT [0..15] (optional) | Move/tilt to the specified position |
my |
INT [0..30] (optional) | Set the device to a user pre-defined position p1: Set the execution duration in seconds (Optional - default : 30) |
open |
INT [0..30] (optional) | Move the device completely up p1: Set the execution duration in seconds (Optional - default : 30) |
openConfiguration |
INT [0..30] (optional) | Put a RTS product in configuration mode p1: Set the execution duration in seconds (Optional - default : 30) |
rest |
INT [0..30] (optional) | p1: Set the execution duration in seconds (Optional - default : 30) |
stop |
INT [0..30] (optional) | Ask the device to stop p1: Set the execution duration in seconds (Optional - default : 30) |
test |
||
tiltNegative |
INT [0..127]; INT [0..15] | Tilt to negative position p1. You can cancel this command before timeout specified with p2. p1: Negative position to tilt to p2: Set the execution duration in seconds (Optional - default : 15) |
tiltPositive |
INT [0..127]; INT [0..15] | Tilt to positive position p1. You can cancel this command before timeout specified with p2. p1: Positive position to tilt to p2: Set the execution duration in seconds (Optional - default : 15) |
up |
INT [0..30] (optional) | Move the device completely up p1: Set the execution duration in seconds (Optional - default : 30) |
GarageDoor/UpDownGarageDoor (ACTUATOR) — 9 commands, 0 states
Type IDs: 5, 17, 65541, 65553 | Servers: rexel, somfy_europe | Controllable: rts:GarageDoorRTSComponent | Profiles: OpenCloseGarageOpener, OpenClose
Data Properties
core:identifyInterval=0
Commands
| Command | Parameters | Notes |
|---|---|---|
close |
INT [0..30] (optional) | Move the device completely down p1: Set the execution duration in seconds (Optional - default : 30) |
down |
INT [0..30] (optional) | Move the device completely down p1: Set the execution duration in seconds (Optional - default : 30) |
identify |
Ask the device to identify itself by doing a slight movement or blink or beep | |
open |
INT [0..30] (optional) | Move the device completely up p1: Set the execution duration in seconds (Optional - default : 30) |
openConfiguration |
INT [0..30] (optional) | Put a RTS product in configuration mode p1: Set the execution duration in seconds (Optional - default : 30) |
rest |
INT [0..30] (optional) | p1: Set the execution duration in seconds (Optional - default : 30) |
stop |
INT [0..30] (optional) | Ask the device to stop p1: Set the execution duration in seconds (Optional - default : 30) |
test |
||
up |
INT [0..30] (optional) | Move the device completely up p1: Set the execution duration in seconds (Optional - default : 30) |
GarageDoor/OpenCloseSlidingGarageDoorWithPedestrianPosition (ACTUATOR) — 10 commands, 0 states
Type IDs: 18, 19, 65554, 65555 | Servers: rexel, somfy_europe | Controllable: rts:SlidingGarageDoorWithPedestrianPositionRTSComponent | Profiles: OpenCloseGarageOpener, OpenClose
Data Properties
core:identifyInterval=0
Commands
| Command | Parameters | Notes |
|---|---|---|
close |
INT [0..30] (optional) | Move the device completely down p1: Set the execution duration in seconds (Optional - default : 30) |
down |
INT [0..30] (optional) | Move the device completely down p1: Set the execution duration in seconds (Optional - default : 30) |
identify |
Ask the device to identify itself by doing a slight movement or blink or beep | |
my |
INT [0..30] (optional) | Set the device to a user pre-defined position p1: Set the execution duration in seconds (Optional - default : 30) |
open |
INT [0..30] (optional) | Move the device completely up p1: Set the execution duration in seconds (Optional - default : 30) |
openConfiguration |
INT [0..30] (optional) | Put a RTS product in configuration mode p1: Set the execution duration in seconds (Optional - default : 30) |
rest |
INT [0..30] (optional) | p1: Set the execution duration in seconds (Optional - default : 30) |
stop |
INT [0..30] (optional) | Ask the device to stop p1: Set the execution duration in seconds (Optional - default : 30) |
test |
||
up |
INT [0..30] (optional) | Move the device completely up p1: Set the execution duration in seconds (Optional - default : 30) |
GarageDoor/UpDownGarageDoor4T (ACTUATOR) — 3 commands, 0 states
Type IDs: 405, 417 | Servers: rexel, somfy_europe | Controllable: rts:GarageDoor4TRTSComponent | Profiles: CyclicGarageOpener, Cyclic
Data Properties
core:identifyInterval=0
Commands
| Command | Parameters | Notes |
|---|---|---|
cycle |
INT [0..30] (optional) | Do a cycle of supported motion kinematics or modes p1: Set the execution duration in seconds (Optional - default : 30) |
openConfiguration |
INT [0..30] (optional) | Put a RTS product in configuration mode p1: Set the execution duration in seconds (Optional - default : 30) |
test |
Gate/OpenCloseGate (ACTUATOR) — 9 commands, 0 states
Type IDs: 6, 21, 65542, 65557 | Servers: rexel, somfy_europe | Controllable: rts:GateOpenerRTSComponent | Profiles: OpenCloseGateOpener, OpenClose
Data Properties
core:identifyInterval=5000
Commands
| Command | Parameters | Notes |
|---|---|---|
close |
INT [0..30] (optional) | Move the device completely down p1: Set the execution duration in seconds (Optional - default : 30) |
down |
INT [0..30] (optional) | Move the device completely down p1: Set the execution duration in seconds (Optional - default : 30) |
identify |
Ask the device to identify itself by doing a slight movement or blink or beep | |
open |
INT [0..30] (optional) | Move the device completely up p1: Set the execution duration in seconds (Optional - default : 30) |
openConfiguration |
INT [0..30] (optional) | Put a RTS product in configuration mode p1: Set the execution duration in seconds (Optional - default : 30) |
rest |
INT [0..30] (optional) | p1: Set the execution duration in seconds (Optional - default : 30) |
stop |
INT [0..30] (optional) | Ask the device to stop p1: Set the execution duration in seconds (Optional - default : 30) |
test |
||
up |
INT [0..30] (optional) | Move the device completely up p1: Set the execution duration in seconds (Optional - default : 30) |
Gate/OpenCloseGateWithPedestrianPosition (ACTUATOR) — 10 commands, 0 states
Type IDs: 20, 22, 65556, 65558 | Servers: rexel, somfy_europe | Controllable: rts:GateOpenerWithPedestrianPositionRTSComponent | Profiles: OpenCloseGateOpener, OpenClose
Data Properties
core:identifyInterval=0
Commands
| Command | Parameters | Notes |
|---|---|---|
close |
INT [0..30] (optional) | Move the device completely down p1: Set the execution duration in seconds (Optional - default : 30) |
down |
INT [0..30] (optional) | Move the device completely down p1: Set the execution duration in seconds (Optional - default : 30) |
identify |
Ask the device to identify itself by doing a slight movement or blink or beep | |
my |
INT [0..30] (optional) | Set the device to a user pre-defined position p1: Set the execution duration in seconds (Optional - default : 30) |
open |
INT [0..30] (optional) | Move the device completely up p1: Set the execution duration in seconds (Optional - default : 30) |
openConfiguration |
INT [0..30] (optional) | Put a RTS product in configuration mode p1: Set the execution duration in seconds (Optional - default : 30) |
rest |
INT [0..30] (optional) | p1: Set the execution duration in seconds (Optional - default : 30) |
stop |
INT [0..30] (optional) | Ask the device to stop p1: Set the execution duration in seconds (Optional - default : 30) |
test |
||
up |
INT [0..30] (optional) | Move the device completely up p1: Set the execution duration in seconds (Optional - default : 30) |
Gate/OpenCloseGate4T (ACTUATOR) — 3 commands, 0 states
Type IDs: 406, 421 | Servers: rexel, somfy_europe | Controllable: rts:GateOpenerRTS4TComponent | Profiles: CyclicGateOpener, Cyclic
Data Properties
core:identifyInterval=0
Commands
| Command | Parameters | Notes |
|---|---|---|
cycle |
INT [0..30] (optional) | Do a cycle of supported motion kinematics or modes p1: Set the execution duration in seconds (Optional - default : 30) |
openConfiguration |
INT [0..30] (optional) | Put a RTS product in configuration mode p1: Set the execution duration in seconds (Optional - default : 30) |
test |
Generic/RTSGeneric (ACTUATOR) — 7 commands, 0 states
Type IDs: 0, 65536 | Servers: rexel, somfy_europe | Controllable: rts:GenericRTSComponent | Profiles: UpDown
Data Properties
core:identifyInterval=0
Commands
| Command | Parameters | Notes |
|---|---|---|
down |
INT [0..30] (optional) | Move the device completely down p1: Set the execution duration in seconds (Optional - default : 30) |
identify |
Ask the device to identify itself by doing a slight movement or blink or beep | |
openConfiguration |
INT [0..30] (optional) | Put a RTS product in configuration mode p1: Set the execution duration in seconds (Optional - default : 30) |
rest |
INT [0..30] (optional) | p1: Set the execution duration in seconds (Optional - default : 30) |
stop |
INT [0..30] (optional) | Ask the device to stop p1: Set the execution duration in seconds (Optional - default : 30) |
test |
||
up |
INT [0..30] (optional) | Move the device completely up p1: Set the execution duration in seconds (Optional - default : 30) |
Generic/RTSGeneric4T (ACTUATOR) — 3 commands, 0 states
Type IDs: 400 | Servers: rexel, somfy_europe | Controllable: rts:Generic4TRTSComponent | Profiles: Cyclic, Generic
Data Properties
core:identifyInterval=0
Commands
| Command | Parameters | Notes |
|---|---|---|
cycle |
INT [0..30] (optional) | Do a cycle of supported motion kinematics or modes p1: Set the execution duration in seconds (Optional - default : 30) |
openConfiguration |
INT [0..30] (optional) | Put a RTS product in configuration mode p1: Set the execution duration in seconds (Optional - default : 30) |
test |
Generic/RTSGeneric (ACTUATOR) — 1 commands, 0 states
Type IDs: 16711680 | Servers: rexel, somfy_europe | Controllable: rts:UnknowRTSComponent | Profiles: Specific
Data Properties
core:identifyInterval=0
Commands
| Command | Parameters | Notes |
|---|---|---|
identify |
Ask the device to identify itself by doing a slight movement or blink or beep |
HeatingSystem/RTSThermostat (ACTUATOR) — 11 commands, 0 states
Type IDs: 9, 65545 | Servers: rexel, somfy_europe | Controllable: rts:ThermostatRTSComponent | Profiles: UpDown
Data Properties
core:identifyInterval=5000
Commands
| Command | Parameters | Notes |
|---|---|---|
autoMode |
Switch device to auto mode | |
comfortMode |
||
down |
Move the device completely down | |
ecoMode |
||
freezeProtectionMode |
||
identify |
Ask the device to identify itself by doing a slight movement or blink or beep | |
openConfiguration |
INT [0..30] (optional) | Put a RTS product in configuration mode p1: Set the execution duration in seconds (Optional - default : 30) |
rest |
||
stop |
Stop the current actuator behavior (movement, sound or timer) | |
test |
||
up |
Move the device completely up |
Light/OnOffLight (ACTUATOR) — 12 commands, 0 states
Type IDs: 7, 65543 | Servers: rexel, somfy_europe | Controllable: rts:LightRTSComponent | Profiles: SwitchableLight, Switchable, UpDown
Data Properties
core:identifyInterval=0
Commands
| Command | Parameters | Notes |
|---|---|---|
down |
INT [0..30] (optional) | Move the device completely down p1: Set the execution duration in seconds (Optional - default : 30) |
identify |
Ask the device to identify itself by doing a slight movement or blink or beep | |
my |
INT [0..30] (optional) | Set the device to a user pre-defined position p1: Set the execution duration in seconds (Optional - default : 30) |
myWithTimer |
ANY | |
off |
Turn off the device | |
on |
Turn on the device | |
onWithTimer |
INT [5..14400] | Turn the device on for a given amount of seconds then turn it off |
openConfiguration |
INT [0..30] (optional) | Put a RTS product in configuration mode p1: Set the execution duration in seconds (Optional - default : 30) |
rest |
INT [0..30] (optional) | p1: Set the execution duration in seconds (Optional - default : 30) |
stop |
INT [0..30] (optional) | Ask the device to stop p1: Set the execution duration in seconds (Optional - default : 30) |
test |
||
up |
INT [0..30] (optional) | Move the device completely up p1: Set the execution duration in seconds (Optional - default : 30) |
Light/DimmerOnOffLight (ACTUATOR) — 13 commands, 0 states
Type IDs: 23 | Servers: rexel, somfy_europe | Controllable: rts:DimmableLightRTSComponent | Profiles: SwitchableLight, Switchable, UpDown
Data Properties
core:identifyInterval=0
Commands
| Command | Parameters | Notes |
|---|---|---|
down |
INT [0..30] (optional) | Move the device completely down p1: Set the execution duration in seconds (Optional - default : 30) |
identify |
Ask the device to identify itself by doing a slight movement or blink or beep | |
my |
INT [0..30] (optional) | Set the device to a user pre-defined position p1: Set the execution duration in seconds (Optional - default : 30) |
off |
Turn off the device | |
on |
Turn on the device | |
onWithTimer |
INT [5..14400] | Turn the device on for a given amount of seconds then turn it off |
openConfiguration |
INT [0..30] (optional) | Put a RTS product in configuration mode p1: Set the execution duration in seconds (Optional - default : 30) |
rest |
INT [0..30] (optional) | p1: Set the execution duration in seconds (Optional - default : 30) |
stepNegative |
INT [0..127]; INT [0..15] | Tilt to negative position p1. You can cancel this command before timeout specified with p2. p1: Negative position to tilt to p2: Set the execution duration in seconds (Optional - default : 15) |
stepPositive |
INT [0..127]; INT [0..15] | Tilt to positive position p1. You can cancel this command before timeout specified with p2. p1: Positive position to tilt to p2: Set the execution duration in seconds (Optional - default : 15) |
stop |
INT [0..30] (optional) | Ask the device to stop p1: Set the execution duration in seconds (Optional - default : 30) |
test |
||
up |
INT [0..30] (optional) | Move the device completely up p1: Set the execution duration in seconds (Optional - default : 30) |
OnOff/StatelessOnOff (ACTUATOR) — 10 commands, 0 states
Type IDs: 13, 65549 | Servers: rexel, somfy_europe | Controllable: rts:OnOffRTSComponent | Profiles: SwitchablePlug, Switchable, UpDown
Data Properties
core:identifyInterval=0
Commands
| Command | Parameters | Notes |
|---|---|---|
down |
INT [0..30] (optional) | Move the device completely down p1: Set the execution duration in seconds (Optional - default : 30) |
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 | |
onWithTimer |
INT [5..14400] | Turn the device on for a given amount of seconds then turn it off |
openConfiguration |
INT [0..30] (optional) | Put a RTS product in configuration mode p1: Set the execution duration in seconds (Optional - default : 30) |
rest |
INT [0..30] (optional) | p1: Set the execution duration in seconds (Optional - default : 30) |
stop |
INT [0..30] (optional) | Ask the device to stop p1: Set the execution duration in seconds (Optional - default : 30) |
test |
||
up |
INT [0..30] (optional) | Move the device completely up p1: Set the execution duration in seconds (Optional - default : 30) |
Pergola/UpDownBioclimaticPergola (ACTUATOR) — 13 commands, 0 states
Type IDs: 426 | Servers: rexel, somfy_europe | Controllable: rts:BioclimaticPergolaRTSComponent | Profiles: OpenCloseWindow, OpenClose
Data Properties
core:identifyInterval=0
Commands
| Command | Parameters | Notes |
|---|---|---|
close |
INT [0..30] (optional) | Move the device completely down p1: Set the execution duration in seconds (Optional - default : 30) |
down |
INT [0..30] (optional) | Move the device completely down p1: Set the execution duration in seconds (Optional - default : 30) |
identify |
Ask the device to identify itself by doing a slight movement or blink or beep | |
moveOf |
INT [-127..127]; INT [0..15] (optional) | Move/tilt to the specified position |
my |
INT [0..30] (optional) | Set the device to a user pre-defined position p1: Set the execution duration in seconds (Optional - default : 30) |
open |
INT [0..30] (optional) | Move the device completely up p1: Set the execution duration in seconds (Optional - default : 30) |
openConfiguration |
INT [0..30] (optional) | Put a RTS product in configuration mode p1: Set the execution duration in seconds (Optional - default : 30) |
rest |
INT [0..30] (optional) | p1: Set the execution duration in seconds (Optional - default : 30) |
stop |
INT [0..30] (optional) | Ask the device to stop p1: Set the execution duration in seconds (Optional - default : 30) |
test |
||
tiltNegative |
INT [0..127]; INT [0..15] | Tilt to negative position p1. You can cancel this command before timeout specified with p2. p1: Negative position to tilt to p2: Set the execution duration in seconds (Optional - default : 15) |
tiltPositive |
INT [0..127]; INT [0..15] | Tilt to positive position p1. You can cancel this command before timeout specified with p2. p1: Positive position to tilt to p2: Set the execution duration in seconds (Optional - default : 15) |
up |
INT [0..30] (optional) | Move the device completely up p1: Set the execution duration in seconds (Optional - default : 30) |
RollerShutter/UpDownRollerShutter (ACTUATOR) — 10 commands, 0 states
Type IDs: 1, 65537 | Servers: rexel, somfy_europe | Controllable: rts:RollerShutterRTSComponent | Profiles: OpenCloseShutter, OpenClose
Data Properties
core:identifyInterval=0
Commands
| Command | Parameters | Notes |
|---|---|---|
close |
INT [0..30] (optional) | Move the device completely down p1: Set the execution duration in seconds (Optional - default : 30) |
down |
INT [0..30] (optional) | Move the device completely down p1: Set the execution duration in seconds (Optional - default : 30) |
identify |
Ask the device to identify itself by doing a slight movement or blink or beep | |
my |
INT [0..30] (optional) | Set the device to a user pre-defined position p1: Set the execution duration in seconds (Optional - default : 30) |
open |
INT [0..30] (optional) | Move the device completely up p1: Set the execution duration in seconds (Optional - default : 30) |
openConfiguration |
INT [0..30] (optional) | Put a RTS product in configuration mode p1: Set the execution duration in seconds (Optional - default : 30) |
rest |
INT [0..30] (optional) | p1: Set the execution duration in seconds (Optional - default : 30) |
stop |
INT [0..30] (optional) | Ask the device to stop p1: Set the execution duration in seconds (Optional - default : 30) |
test |
||
up |
INT [0..30] (optional) | Move the device completely up p1: Set the execution duration in seconds (Optional - default : 30) |
Screen/UpDownScreen (ACTUATOR) — 10 commands, 0 states
Type IDs: 15, 65559, 427, 428, 65551 | Servers: rexel, somfy_europe | Controllable: rts:BlindRTSComponent | Profiles: OpenCloseBlind, OpenClose
Data Properties
core:identifyInterval=0
Commands
| Command | Parameters | Notes |
|---|---|---|
close |
INT [0..30] (optional) | Move the device completely down p1: Set the execution duration in seconds (Optional - default : 30) |
down |
INT [0..30] (optional) | Move the device completely down p1: Set the execution duration in seconds (Optional - default : 30) |
identify |
Ask the device to identify itself by doing a slight movement or blink or beep | |
my |
INT [0..30] (optional) | Set the device to a user pre-defined position p1: Set the execution duration in seconds (Optional - default : 30) |
open |
INT [0..30] (optional) | Move the device completely up p1: Set the execution duration in seconds (Optional - default : 30) |
openConfiguration |
INT [0..30] (optional) | Put a RTS product in configuration mode p1: Set the execution duration in seconds (Optional - default : 30) |
rest |
INT [0..30] (optional) | p1: Set the execution duration in seconds (Optional - default : 30) |
stop |
INT [0..30] (optional) | Ask the device to stop p1: Set the execution duration in seconds (Optional - default : 30) |
test |
||
up |
INT [0..30] (optional) | Move the device completely up p1: Set the execution duration in seconds (Optional - default : 30) |
Screen/UpDownZebraScreen (ACTUATOR) — 13 commands, 0 states
Type IDs: 423 | Servers: rexel, somfy_europe | Controllable: rts:ZebraBlindRTSComponent | Profiles: OpenCloseBlind, OpenClose
Data Properties
core:identifyInterval=0
Commands
| Command | Parameters | Notes |
|---|---|---|
close |
INT [0..30] (optional) | Move the device completely down p1: Set the execution duration in seconds (Optional - default : 30) |
down |
INT [0..30] (optional) | Move the device completely down p1: Set the execution duration in seconds (Optional - default : 30) |
identify |
Ask the device to identify itself by doing a slight movement or blink or beep | |
moveOf |
INT [-127..127]; INT [0..15] (optional) | Move/tilt to the specified position |
my |
INT [0..30] (optional) | Set the device to a user pre-defined position p1: Set the execution duration in seconds (Optional - default : 30) |
open |
INT [0..30] (optional) | Move the device completely up p1: Set the execution duration in seconds (Optional - default : 30) |
openConfiguration |
INT [0..30] (optional) | Put a RTS product in configuration mode p1: Set the execution duration in seconds (Optional - default : 30) |
rest |
INT [0..30] (optional) | p1: Set the execution duration in seconds (Optional - default : 30) |
stop |
INT [0..30] (optional) | Ask the device to stop p1: Set the execution duration in seconds (Optional - default : 30) |
test |
||
tiltNegative |
INT [0..127]; INT [0..15] | Tilt to negative position p1. You can cancel this command before timeout specified with p2. p1: Negative position to tilt to p2: Set the execution duration in seconds (Optional - default : 15) |
tiltPositive |
INT [0..127]; INT [0..15] | Tilt to positive position p1. You can cancel this command before timeout specified with p2. p1: Positive position to tilt to p2: Set the execution duration in seconds (Optional - default : 15) |
up |
INT [0..30] (optional) | Move the device completely up p1: Set the execution duration in seconds (Optional - default : 30) |
SwingingShutter/UpDownSwingingShutter (ACTUATOR) — 10 commands, 0 states
Type IDs: 12, 65548 | Servers: rexel, somfy_europe | Controllable: rts:SwingingShutterRTSComponent | Profiles: OpenCloseSwingingShutter, OpenClose
Data Properties
core:identifyInterval=0
Commands
| Command | Parameters | Notes |
|---|---|---|
close |
INT [0..30] (optional) | Move the device completely down p1: Set the execution duration in seconds (Optional - default : 30) |
down |
INT [0..30] (optional) | Move the device completely down p1: Set the execution duration in seconds (Optional - default : 30) |
identify |
Ask the device to identify itself by doing a slight movement or blink or beep | |
my |
INT [0..30] (optional) | Set the device to a user pre-defined position p1: Set the execution duration in seconds (Optional - default : 30) |
open |
INT [0..30] (optional) | Move the device completely up p1: Set the execution duration in seconds (Optional - default : 30) |
openConfiguration |
INT [0..30] (optional) | Put a RTS product in configuration mode p1: Set the execution duration in seconds (Optional - default : 30) |
rest |
INT [0..30] (optional) | p1: Set the execution duration in seconds (Optional - default : 30) |
stop |
INT [0..30] (optional) | Ask the device to stop p1: Set the execution duration in seconds (Optional - default : 30) |
test |
||
up |
INT [0..30] (optional) | Move the device completely up p1: Set the execution duration in seconds (Optional - default : 30) |
VenetianBlind/UpDownVenetianBlind (ACTUATOR) — 13 commands, 0 states
Type IDs: 14, 424, 425, 65550 | Servers: rexel, somfy_europe | Controllable: rts:VenetianBlindRTSComponent | Profiles: OpenCloseBlind, OpenClose
Data Properties
core:identifyInterval=0
Commands
| Command | Parameters | Notes |
|---|---|---|
close |
INT [0..30] (optional) | Move the device completely down p1: Set the execution duration in seconds (Optional - default : 30) |
down |
INT [0..30] (optional) | Move the device completely down p1: Set the execution duration in seconds (Optional - default : 30) |
identify |
Ask the device to identify itself by doing a slight movement or blink or beep | |
moveOf |
INT [-127..127]; INT [0..15] (optional) | Move/tilt to the specified position |
my |
INT [0..30] (optional) | Set the device to a user pre-defined position p1: Set the execution duration in seconds (Optional - default : 30) |
open |
INT [0..30] (optional) | Move the device completely up p1: Set the execution duration in seconds (Optional - default : 30) |
openConfiguration |
INT [0..30] (optional) | Put a RTS product in configuration mode p1: Set the execution duration in seconds (Optional - default : 30) |
rest |
INT [0..30] (optional) | p1: Set the execution duration in seconds (Optional - default : 30) |
stop |
INT [0..30] (optional) | Ask the device to stop p1: Set the execution duration in seconds (Optional - default : 30) |
test |
||
tiltNegative |
INT [0..127]; INT [0..15] | Tilt to negative position p1. You can cancel this command before timeout specified with p2. p1: Negative position to tilt to p2: Set the execution duration in seconds (Optional - default : 15) |
tiltPositive |
INT [0..127]; INT [0..15] | Tilt to positive position p1. You can cancel this command before timeout specified with p2. p1: Positive position to tilt to p2: Set the execution duration in seconds (Optional - default : 15) |
up |
INT [0..30] (optional) | Move the device completely up p1: Set the execution duration in seconds (Optional - default : 30) |
Window/UpDownWindow (ACTUATOR) — 10 commands, 0 states
Type IDs: 24 | Servers: rexel, somfy_europe | Controllable: rts:WindowsOpenerRTSComponent | Profiles: OpenCloseWindow, OpenClose
Data Properties
core:identifyInterval=0
Commands
| Command | Parameters | Notes |
|---|---|---|
close |
INT [0..30] (optional) | Move the device completely down p1: Set the execution duration in seconds (Optional - default : 30) |
down |
INT [0..30] (optional) | Move the device completely down p1: Set the execution duration in seconds (Optional - default : 30) |
identify |
Ask the device to identify itself by doing a slight movement or blink or beep | |
my |
INT [0..30] (optional) | Set the device to a user pre-defined position p1: Set the execution duration in seconds (Optional - default : 30) |
open |
INT [0..30] (optional) | Move the device completely up p1: Set the execution duration in seconds (Optional - default : 30) |
openConfiguration |
INT [0..30] (optional) | Put a RTS product in configuration mode p1: Set the execution duration in seconds (Optional - default : 30) |
rest |
INT [0..30] (optional) | p1: Set the execution duration in seconds (Optional - default : 30) |
stop |
INT [0..30] (optional) | Ask the device to stop p1: Set the execution duration in seconds (Optional - default : 30) |
test |
||
up |
INT [0..30] (optional) | Move the device completely up p1: Set the execution duration in seconds (Optional - default : 30) |
SOMFY_THERMOSTAT
3 device types.
HeatingSystem/SomfyThermostat (ACTUATOR) — 8 commands, 19 states
Type IDs: 65537, 65538, 65539, 131073, 131074, 131075, 131076 | Servers: rexel, somfy_europe | Controllable: somfythermostat:SomfyThermostatThermostatComponent | Profiles: ThermostatTargetReader
Commands
| Command | Parameters | Notes |
|---|---|---|
exitDerogation |
Exit the derogation mode for the programming mode in the thermostat's timetable | |
getName |
Refresh the device internal name | |
refreshDerogation |
Refresh the last derogation | |
refreshModeSettings |
Refresh actual mode settings on thermostat | |
refreshState |
Refresh the device states | |
setDerogation |
STRING: atHomeMode, sleepingMode, awayMode, freezeMode, geofencingMode; FLOAT [15.0..26.0]; STRING: further_notice, next_mode; INT | set a new derogation p1: mode to activate or temperature to reach for derogation p2: derogation type (further_notice, next_mode or a time value in seconds) |
setModeTemperature |
STRING: atHomeMode, awayMode, freezeMode, geofencingMode, manualMode; FLOAT | set the target temperature for the given mode |
setName |
STRING | Change the device internal name. Name length may be subject to restrictions depending on the device and underlying protocol. |
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
AtHomeTargetTemperatureState |
ContinuousState | ||
AvailabilityState |
DiscreteState | available, unavailable | |
AwayModeTargetTemperatureState |
ContinuousState | ||
BatteryLevelState |
ContinuousState | ||
DerogatedTargetTemperatureState |
ContinuousState | ||
DerogationActivationState |
DiscreteState | active, inactive | |
DerogationEndDateTimeState |
DataState | ||
DerogationHeatingModeState |
DiscreteState | atHomeMode, awayMode, freezeMode, geofencingMode, manualMode, sleepingMode, suddenDropMode | |
DerogationStartDateTimeState |
DataState | ||
DerogationTypeState |
DiscreteState | date, furtherNotice, nextMode | |
FreezeModeTargetTemperatureState |
ContinuousState | ||
GeofencingModeTargetTemperatureState |
ContinuousState | ||
HeatingModeState |
DiscreteState | atHomeMode, awayMode, freezeMode, geofencingMode, manualMode, sleepingMode, suddenDropMode | |
ManualModeTargetTemperatureState |
ContinuousState | ||
NameState |
DataState | ||
SleepingModeTargetTemperatureState |
ContinuousState | ||
StatusState |
DiscreteState | available, unavailable | |
SuddenDropModeTargetTemperatureState |
ContinuousState | ||
TargetTemperatureState |
ContinuousState | [12.0..30.0] |
HumiditySensor/RelativeHumiditySensor (SENSOR) — 1 commands, 3 states
Type IDs: 65537, 65538, 65539, 131073, 131074, 131075, 131076 | Servers: rexel, somfy_europe | Controllable: somfythermostat:SomfyThermostatHumiditySensor | Profiles: RelativeHumidity
Commands
| Command | Parameters | Notes |
|---|---|---|
refreshRelativeHumidity |
Refresh the last measured relative humidity |
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
AvailabilityState |
DiscreteState | available, unavailable | |
RelativeHumidityState |
ContinuousState | [0.0..100.0] | |
StatusState |
DiscreteState | available, unavailable |
TemperatureSensor (SENSOR) — 1 commands, 3 states
Type IDs: 65537, 65538, 65539, 131073, 131074, 131075, 131076 | Servers: rexel, somfy_europe | Controllable: somfythermostat:SomfyThermostatTemperatureSensor | Profiles: Temperature
Commands
| Command | Parameters | Notes |
|---|---|---|
refreshTemperature |
Refresh the last measured temperature |
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
AvailabilityState |
DiscreteState | available, unavailable | |
StatusState |
DiscreteState | available, unavailable | |
TemperatureState |
ContinuousState | [-100.0..100.0] |
UPNP_CONTROL
2 device types.
MusicPlayer/MediaRenderer (ACTUATOR) — 17 commands, 1 states
Type IDs: 0 | Servers: rexel | Controllable: upnpcontrol:UPnPControlMediaRendererComponent | Profiles: StoppableMusicPlayer, MusicPlayer, VolumeControl
Commands
| Command | Parameters | Notes |
|---|---|---|
getAllPlayingInfo |
Get all information about the playing track and media | |
getCurrentTransportActions |
get current action available on the playing media | |
getMediaInfo |
Get playing media information | |
getMute |
Get the mute Status | |
getPositionInfo |
Get information about the playing track | |
getTransportInfo |
get information about the player state | |
getVolume |
Get the device output volume | |
mute |
Mute the device | |
next |
Play next track | |
pause |
Pause current action | |
play |
Play media | |
playURI |
STRING; STRING | Play a media from a given URI p1 : URI to play p2 : Associated metadatas |
previous |
Play previous track | |
rewind |
Rewind media | |
setVolume |
INT [0..100] | Set the device output volume |
stop |
Stop the current actuator behavior (movement, sound or timer) | |
unmute |
Unmute the device |
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
PlayState |
DiscreteState | forward, pause, playing, rewind, stop |
MusicPlayer/MediaRenderer (ACTUATOR) — 24 commands, 1 states
Type IDs: 65536, 65537, 65539, 65541, 65545, 65546, 65547, 65548, 65549, 65550 | Servers: rexel | Controllable: upnpcontrol:GenericSonosPlayerComponent | Profiles: StoppableMusicPlayer, MusicPlayer, VolumeControl
Commands
| Command | Parameters | Notes |
|---|---|---|
getAllPlayingInfo |
Get all information about the playing track and media | |
getCurrentTransportActions |
get current action available on the playing media | |
getGroupMute |
Get the mute status for the group | |
getGroupVolume |
Get the volume for the group | |
getMediaInfo |
Get playing media information | |
getMute |
Get the mute Status | |
getPositionInfo |
Get information about the playing track | |
getSonosFavorites |
Get the sonos favorit | |
getSonosPlaylist |
Get the sonos playlist | |
getTransportInfo |
get information about the player state | |
getVolume |
Get the device output volume | |
mute |
Mute the device | |
muteGroup |
Mute the Group | |
next |
Play next track | |
pause |
Pause current action | |
play |
Play media | |
playURI |
STRING; STRING | Play a media from a given URI p1 : URI to play p2 : Associated metadatas |
previous |
Play previous track | |
rewind |
Rewind media | |
setGroupVolume |
INT | Set the volume of the group p1: volume to set |
setVolume |
INT [0..100] | Set the device output volume |
stop |
Stop the current actuator behavior (movement, sound or timer) | |
unmute |
Unmute the device | |
unmuteGroup |
Unmute the Group |
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
PlayState |
DiscreteState | forward, pause, playing, rewind, stop |
URMET
2 device types.
CallForwardingComponent/UrmetCallForwarding (PROTOCOL_GATEWAY) — 0 commands, 1 states
Type IDs: 1 | Servers: rexel | Controllable: urmet:CallForwardingUrmetComponent | Profiles: Specific
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
UrmetSettingsState |
DataState |
StackComponent/UrmetStack (PROTOCOL_GATEWAY) — 11 commands, 2 states
Type IDs: 256 | Servers: rexel | Controllable: urmet:StackComponent | Profiles: Specific
Commands
| Command | Parameters | Notes |
|---|---|---|
callMe |
STRING | Request a call on the peripheral p1 is the udid of requester (externalInfo) |
deleteTarget |
STRING; STRING | Delete a registered target p1 is the udid of requester (externalInfo) p2 is the deviceId of the target to delete |
doNotDisturb |
STRING; INT: 0, 1 | Set DoNotDisturb mode on the peripheral p1 is the deviceId for which the do not disturb state is changed p2 activate the do not disturb mode (0 for false, 1 for true) |
getVideo |
STRING; STRING: mjpeg | Send url to get video transmission p1 is the udid of requester (externalInfo) p2 is the video format |
modifyTarget |
STRING; STRING; STRING (optional); STRING (optional); INT: 0, 1 (optional); INT: 1, 2 (optional); STRING (optional) | Modify a registered target p1 is the udid of requester (externalInfo) p2 is the deviceId of the target to modify p3 is the new phone number, matching this pattern : +XXXXXXXXXXX (leave blank to keep last value) p4 is the new name of the target (leave blank to keep last value) p5 is whether the target should be only notifiable (0 for false, 1 for true) (leave blank to keep last value) p6 is the new position of the target in the list of all peripherals (leave blank to keep last value) p7 is the new externalInfo of the target (leave blank to keep last value) |
openDoor |
STRING | Open the door of the building p1 is the udid of requester (externalInfo) |
openGate |
STRING | Open the secondary door of the building p1 is the udid of requester (externalInfo) |
registerLandlinePhone |
STRING; STRING; STRING; INT: 1, 2 | Register a new target p1 is the udid of requester (externalInfo) p2 is the name of the peripheral p3 is the phone number, matching this pattern : +XXXXXXXXXXX p4 position of the peripheral in the list of all peripherals |
registerSmartPhone |
STRING; STRING; STRING | Register current smartphone as new peripheral p1 is the name of the peripheral p2 is the udid of the peripheral (externalInfo) p3 is the phone number, matching this pattern : +XXXXXXXXXXX |
registerTablet |
STRING; STRING | Register current pad as new peripheral p1 is the name of the peripheral p2 is the udid of the peripheral (externalInfo) |
skipCall |
STRING | Reject the incoming call p1 is the udid of requester (externalInfo) |
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
ConfigState |
DataState | ||
LastEventState |
DataState |
WISER
4 device types.
ElectricitySensor/CumulativeElectricPowerProductionSensor (SENSOR) — 1 commands, 0 states
Type IDs: 1, 2, 7, 8, 9, 10, 11, 12 | Servers: somfy_europe | Controllable: wiser:TotalElectricalEnergyProductionSensor | Profiles: Specific
Commands
| Command | Parameters | Notes |
|---|---|---|
getHistory |
INT; INT; STRING | Get history from sensor beetween two specific date p1 : from date (timestamp in millisecond) p2 : to date (timestamp in millisecond) p3 : groupBy value (hour, day, month) |
GasSensor/CumulativeGasConsumptionSensor (SENSOR) — 1 commands, 0 states
Type IDs: 3 | Servers: somfy_europe | Controllable: wiser:TotalGasConsumptionSensor | Profiles: Specific
Commands
| Command | Parameters | Notes |
|---|---|---|
getHistory |
INT; INT; STRING | Get history from sensor beetween two specific date p1 : from date (timestamp in millisecond) p2 : to date (timestamp in millisecond) p3 : groupBy value (hour, day, month) |
ThermalEnergySensor/CumulativeThermalEnergyConsumptionSensor (SENSOR) — 1 commands, 0 states
Type IDs: 6 | Servers: somfy_europe | Controllable: wiser:TotalThermalEnergyConsumptionSensor | Profiles: Specific
Commands
| Command | Parameters | Notes |
|---|---|---|
getHistory |
INT; INT; STRING | Get history from sensor beetween two specific date p1 : from date (timestamp in millisecond) p2 : to date (timestamp in millisecond) p3 : groupBy value (hour, day, month) |
WaterSensor/CumulativeWaterConsumptionSensor (SENSOR) — 1 commands, 0 states
Type IDs: 4, 5 | Servers: somfy_europe | Controllable: wiser:TotalColdWaterConsumptionSensor | Profiles: Specific
Commands
| Command | Parameters | Notes |
|---|---|---|
getHistory |
INT; INT; STRING | Get history from sensor beetween two specific date p1 : from date (timestamp in millisecond) p2 : to date (timestamp in millisecond) p3 : groupBy value (hour, day, month) |
YOKIS
21 device types.
Awning/PositionableHorizontalAwning (ACTUATOR) — 28 commands, 13 states
Type IDs: 66048, 66049, 66050 | Servers: rexel | Controllable: yokis:CanvasBlindYokisComponent | Profiles: StatefulDeployableAwning, StatefulDeployable, Deployable, DeployUndeploy, StatefulCloseable, StatefulOpenClose, OpenClose
Data Properties
core:identifyInterval=500
Commands
| Command | Parameters | Notes |
|---|---|---|
activateSoftwareWiringInversion |
Activate software device wiring inversion | |
activateTorqueLimitation |
Activate device torque limitation | |
close |
Fully close the device | |
deactivateSoftwareWiringInversion |
Deactivate software device wiring inversion | |
deactivateTorqueLimitation |
Deactivate device torque limitation | |
deploy |
Fully deploy the device | |
down |
Move the device completely down | |
goToMemorized1Position |
Set the device to a user pre-defined position | |
goToMemorized2Position |
Set the device to a user pre-defined position | |
goToMemorized3Position |
Set the device to a user pre-defined position | |
identify |
Ask the device to identify itself by doing a slight movement or blink or beep | |
open |
Fully open the device | |
refreshState |
Refresh the device states | |
setClosure |
INT [0..100] | Closure level (100%=fully close, 0%=open) |
setDeployment |
INT [0..100] | Device deployment level (100%=fully deployed, 0%=fully undeployed) |
setMemorized1Position |
INT [0..100] | Set favorite position |
setMemorized1PositionName |
STRING | Change the favorite position internal name. Name length may be subject to restrictions depending on the device and underlying protocol. |
setMemorized2Position |
INT [0..100] | Set favorite position |
setMemorized2PositionName |
STRING | Change the favorite position internal name. Name length may be subject to restrictions depending on the device and underlying protocol. |
setMemorized3Position |
INT [0..100] | Set favorite position |
setMemorized3PositionName |
STRING | Change the favorite position internal name. Name length may be subject to restrictions depending on the device and underlying protocol. |
setPosition |
STRING: my, memorized1, memorized2, memorized3, secured; INT [0..100] | Set the device to a pre-defined position (enum) or a relative position (0-100%) |
setSoftwareWiringInversion |
STRING: off, on | Activate (on) or deactivate (off) software device wiring inversion |
setTorqueLimitation |
STRING: off, on | Activate (on) or deactivate (off) device torque limitation |
setTorqueMode |
STRING: high, low | Select the device torque mode |
stop |
Stop the current actuator behavior (movement, sound or timer) | |
undeploy |
Fully undeploy the device | |
up |
Move the device completely up |
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
ClosureState |
ContinuousState | [0..100] | |
DeploymentState |
ContinuousState | [0..100] | |
Memorized1PositionNameState |
DataState | ||
Memorized1PositionState |
ContinuousState | ||
Memorized2PositionNameState |
DataState | ||
Memorized2PositionState |
ContinuousState | ||
Memorized3PositionNameState |
DataState | ||
Memorized3PositionState |
ContinuousState | ||
OpenClosedState |
DiscreteState | open, closed | |
SoftwareWiringInversionState |
DiscreteState | off, on | |
TorqueLimitationState |
DiscreteState | off, on | |
TorqueModeState |
DiscreteState | high, low | |
UpdateStatusState |
DiscreteState | error, inProgress, initialized, moduleUnreachableError, networkError, queued, timeout, usbUnreachableError |
CircuitBreaker (ACTUATOR) — 11 commands, 5 states
Type IDs: 65793, 65794, 65795, 65796 | Servers: rexel | Controllable: yokis:CircuitBreakerYokisComponent | Profiles: StatefulSwitchablePlug, StatefulSwitchable, Switchable
Data Properties
core:identifyInterval=500
Commands
| Command | Parameters | Notes |
|---|---|---|
activateContextSavingOnPowerCut |
Activate last device state saving on power cut | |
deactivateContextSavingOnPowerCut |
Deactivate last device state saving on power cut | |
deactivateTimer |
Deactivate device internal timer | |
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 | |
refreshState |
Refresh the device states | |
setContextSavingOnPowerCut |
STRING: off, on | Activate (on) or deactivate (off) last device state saving on power cut |
setOnOff |
STRING: off, on | Turn the device on or off |
setTimerUnit |
STRING: sec, min | Set unit of device internal timer (sec=seconds, min=minutes) |
setYokisTimer |
INT: 0, 2, 4, 8, 15 | Set Yokis device internal temporization value |
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
ContextSavingOnPowerCutState |
DiscreteState | off, on | |
OnOffState |
DiscreteState | on, off | |
TimerState |
ContinuousState | ||
TimerUnitState |
DiscreteState | min, sec | |
UpdateStatusState |
DiscreteState | error, inProgress, initialized, moduleUnreachableError, networkError, queued, timeout, usbUnreachableError |
ContactSensor (SENSOR) — 0 commands, 1 states
Type IDs: 131073 | Servers: rexel | Controllable: yokis:YokisContactSensor | Profiles: DoorContactSensor, ContactDetector
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
ContactState |
DiscreteState | open, closed |
DoorEntry/EightButtonsDoorEntryController (REMOTE_CONTROLLER) — 0 commands, 2 states
Type IDs: 132096 | Servers: rexel | Controllable: yokis:DoorEntryControllerYokisComponent | Profiles: Button
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
LastButtonPressedState |
DataState | ||
LastButtonReleasedState |
DataState |
GarageDoor/CyclicGarageDoor (ACTUATOR) — 7 commands, 3 states
Type IDs: 65792, 65793, 65794, 65795 | Servers: rexel | Controllable: yokis:ImpulsiveGarageDoorYokisComponent | Profiles: CyclicGarageOpener, Cyclic
Data Properties
core:identifyInterval=500
Commands
| Command | Parameters | Notes |
|---|---|---|
cycle |
Do a cycle of supported motion kinematics or modes | |
deactivateTimer |
Deactivate device internal timer | |
identify |
Ask the device to identify itself by doing a slight movement or blink or beep | |
refreshState |
Refresh the device states | |
setTimerUnit |
STRING: sec, min | Set unit of device internal timer (sec=seconds, min=minutes) |
setYokisTimer |
INT: 0, 2, 4, 8, 15 | Set Yokis device internal temporization value |
stop |
Stop the current actuator behavior (movement, sound or timer) |
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
TimerState |
ContinuousState | ||
TimerUnitState |
DiscreteState | min, sec | |
UpdateStatusState |
DiscreteState | error, inProgress, initialized, moduleUnreachableError, networkError, queued, timeout, usbUnreachableError |
GarageDoor/OpenCloseGarageDoor (ACTUATOR) — 11 commands, 6 states
Type IDs: 66304 | Servers: rexel | Controllable: yokis:GarageDoorOpenerYokisComponent | Profiles: StatefulOpenCloseGarageOpener, StatefulOpenClose, OpenClose
Data Properties
core:identifyInterval=500
Commands
| Command | Parameters | Notes |
|---|---|---|
activateAutomaticClosingOnPowerOn |
Activate automatic closing on power on | |
close |
Fully close the device | |
deactivateAutomaticClosingOnPowerOn |
Deactivate automatic closing on power on | |
deactivateTimer |
Deactivate device internal timer | |
identify |
Ask the device to identify itself by doing a slight movement or blink or beep | |
open |
Fully open the device | |
refreshState |
Refresh the device states | |
setAutomaticClosingOnPowerOn |
STRING: false, true | Activate (true) or deactivate (false) automatic closing on power on |
setTimerUnit |
STRING: sec, min | Set unit of device internal timer (sec=seconds, min=minutes) |
setYokisTimer |
INT: 0, 2, 4, 8, 15 | Set Yokis device internal temporization value |
stop |
Stop the current actuator behavior (movement, sound or timer) |
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
AutomaticClosingOnPowerOnState |
DiscreteState | false, true | |
AutomationOperatingModeState |
DiscreteState | faac, universal, yokis | |
OpenClosedState |
DiscreteState | open, closed | |
TimerState |
ContinuousState | ||
TimerUnitState |
DiscreteState | min, sec | |
UpdateStatusState |
DiscreteState | error, inProgress, initialized, moduleUnreachableError, networkError, queued, timeout, usbUnreachableError |
Gate/CyclicGate (ACTUATOR) — 7 commands, 3 states
Type IDs: 65792, 65793, 65794, 65795 | Servers: rexel | Controllable: yokis:ImpulsiveGateOpenerYokisComponent | Profiles: CyclicGateOpener, Cyclic
Data Properties
core:identifyInterval=500
Commands
| Command | Parameters | Notes |
|---|---|---|
cycle |
Do a cycle of supported motion kinematics or modes | |
deactivateTimer |
Deactivate device internal timer | |
identify |
Ask the device to identify itself by doing a slight movement or blink or beep | |
refreshState |
Refresh the device states | |
setTimerUnit |
STRING: sec, min | Set unit of device internal timer (sec=seconds, min=minutes) |
setYokisTimer |
INT: 0, 2, 4, 8, 15 | Set Yokis device internal temporization value |
stop |
Stop the current actuator behavior (movement, sound or timer) |
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
TimerState |
ContinuousState | ||
TimerUnitState |
DiscreteState | min, sec | |
UpdateStatusState |
DiscreteState | error, inProgress, initialized, moduleUnreachableError, networkError, queued, timeout, usbUnreachableError |
Gate/OpenCloseGate (ACTUATOR) — 24 commands, 12 states
Type IDs: 66048, 66049 | Servers: rexel | Controllable: yokis:GateOpenerYokisComponent | Profiles: StatefulOpenCloseGateOpener, StatefulOpenClose, OpenClose
Data Properties
core:identifyInterval=500
Commands
| Command | Parameters | Notes |
|---|---|---|
activateOppositeMotionOnOverload |
Activate automatic device opposite motion if an overload is detected | |
activateSoftwareWiringInversion |
Activate software device wiring inversion | |
activateTorqueLimitation |
Activate device torque limitation | |
close |
Fully close the device | |
deactivateOppositeMotionOnOverload |
Deactivate automatic device opposite motion if an overload is detected | |
deactivateSoftwareWiringInversion |
Deactivate software device wiring inversion | |
deactivateTorqueLimitation |
Deactivate device torque limitation | |
goToMemorized1Position |
Set the device to a user pre-defined position | |
goToMemorized2Position |
Set the device to a user pre-defined position | |
goToMemorized3Position |
Set the device to a user pre-defined position | |
identify |
Ask the device to identify itself by doing a slight movement or blink or beep | |
open |
Fully open the device | |
refreshState |
Refresh the device states | |
setMemorized1Position |
INT [0..100] | Set favorite position |
setMemorized1PositionName |
STRING | Change the favorite position internal name. Name length may be subject to restrictions depending on the device and underlying protocol. |
setMemorized2Position |
INT [0..100] | Set favorite position |
setMemorized2PositionName |
STRING | Change the favorite position internal name. Name length may be subject to restrictions depending on the device and underlying protocol. |
setMemorized3Position |
INT [0..100] | Set favorite position |
setMemorized3PositionName |
STRING | Change the favorite position internal name. Name length may be subject to restrictions depending on the device and underlying protocol. |
setOppositeMotionOnOverload |
STRING: off, on | Activate (on) or deactivate (off) automatic device opposite motion if an overload is detected |
setSoftwareWiringInversion |
STRING: off, on | Activate (on) or deactivate (off) software device wiring inversion |
setTorqueLimitation |
STRING: off, on | Activate (on) or deactivate (off) device torque limitation |
setTorqueMode |
STRING: high, low | Select the device torque mode |
stop |
Stop the current actuator behavior (movement, sound or timer) |
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
Memorized1PositionNameState |
DataState | ||
Memorized1PositionState |
ContinuousState | ||
Memorized2PositionNameState |
DataState | ||
Memorized2PositionState |
ContinuousState | ||
Memorized3PositionNameState |
DataState | ||
Memorized3PositionState |
ContinuousState | ||
OpenClosedState |
DiscreteState | open, closed | |
OppositeMotionOnOverloadState |
DiscreteState | off, on | |
SoftwareWiringInversionState |
DiscreteState | off, on | |
TorqueLimitationState |
DiscreteState | off, on | |
TorqueModeState |
DiscreteState | high, low | |
UpdateStatusState |
DiscreteState | error, inProgress, initialized, moduleUnreachableError, networkError, queued, timeout, usbUnreachableError |
Gate/OpenCloseSwingingGate (ACTUATOR) — 11 commands, 6 states
Type IDs: 66304 | Servers: rexel | Controllable: yokis:SwingingGateOpenerYokisComponent | Profiles: StatefulOpenCloseGateOpener, StatefulOpenClose, OpenClose
Data Properties
core:identifyInterval=500
Commands
| Command | Parameters | Notes |
|---|---|---|
activateAutomaticClosingOnPowerOn |
Activate automatic closing on power on | |
close |
Fully close the device | |
deactivateAutomaticClosingOnPowerOn |
Deactivate automatic closing on power on | |
deactivateTimer |
Deactivate device internal timer | |
identify |
Ask the device to identify itself by doing a slight movement or blink or beep | |
open |
Fully open the device | |
refreshState |
Refresh the device states | |
setAutomaticClosingOnPowerOn |
STRING: false, true | Activate (true) or deactivate (false) automatic closing on power on |
setTimerUnit |
STRING: sec, min | Set unit of device internal timer (sec=seconds, min=minutes) |
setYokisTimer |
INT: 0, 2, 4, 8, 15 | Set Yokis device internal temporization value |
stop |
Stop the current actuator behavior (movement, sound or timer) |
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
AutomaticClosingOnPowerOnState |
DiscreteState | false, true | |
AutomationOperatingModeState |
DiscreteState | faac, universal, yokis | |
OpenClosedState |
DiscreteState | open, closed | |
TimerState |
ContinuousState | ||
TimerUnitState |
DiscreteState | min, sec | |
UpdateStatusState |
DiscreteState | error, inProgress, initialized, moduleUnreachableError, networkError, queued, timeout, usbUnreachableError |
HeatingSystem/ElectricalHeater (ACTUATOR) — 6 commands, 7 states
Type IDs: 66560 | Servers: rexel | Controllable: yokis:YokisPilotWireComponent | Profiles: StatefulHeatingLevel, HeatingLevel
Data Properties
core:identifyInterval=500
Commands
| Command | Parameters | Notes |
|---|---|---|
identify |
Ask the device to identify itself by doing a slight movement or blink or beep | |
refreshState |
Refresh the device states | |
setHeatingLevel |
STRING: comfort, comfort-1, comfort-2, eco, frostprotection | Sets the device heating level mode |
setLedOnOff |
STRING: on, off | Set the led mode |
setNumberOfOrders |
INT: 4, 6 | Set the number of orders (4 orders or 6 orders) |
setScrollOnOff |
STRING: on, off | Set the scroll mode |
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
ConfigState |
DataState | ||
ErrorState |
DataState | ||
LEDOnOffState |
DiscreteState | on, off | |
NumberOfOrderState |
DiscreteState | 4, 6 | |
ScrollOnOffState |
DiscreteState | on, off | |
TargetHeatingLevelState |
DiscreteState | comfort, eco | |
UpdateStatusState |
DiscreteState | error, inProgress, initialized, moduleUnreachableError, networkError, queued, timeout, usbUnreachableError |
Light/DimmerLight (ACTUATOR) — 28 commands, 18 states
Type IDs: 65536, 65537, 65538 | Servers: rexel | Controllable: yokis:DimmableLightYokisComponent | Profiles: StatefulLightDimmer, StatefulDimmable, Dimmable, StatefulSwitchable, Switchable
Data Properties
core:identifyInterval=500
Commands
| Command | Parameters | Notes |
|---|---|---|
activateContextSavingOnPowerCut |
Activate last device state saving on power cut | |
activateExtinctionNotification |
Activate device notification before powering off | |
deactivateContextSavingOnPowerCut |
Deactivate last device state saving on power cut | |
deactivateExtinctionNotification |
Deactivate device notification before powering off | |
deactivateTimer |
Deactivate device internal timer | |
goToMemorized1Position |
Set the device to a user pre-defined position | |
goToMemorized2Position |
Set the device to a user pre-defined position | |
goToMemorized3Position |
Set the device to a user pre-defined position | |
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 | |
refreshState |
Refresh the device states | |
setContextSavingOnPowerCut |
STRING: off, on | Activate (on) or deactivate (off) last device state saving on power cut |
setExtinctionNotification |
STRING: off, on | Activate (on) or deactivate (off) device notification before powering off |
setIntensity |
INT [0..100]; STRING: memorized1, memorized2, memorized3 | Light intensity level (100%=maximum intensity, 0%=off) |
setMemorized1Position |
INT [0..100] | Set favorite position |
setMemorized1PositionName |
STRING | Change the favorite position internal name. Name length may be subject to restrictions depending on the device and underlying protocol. |
setMemorized2Position |
INT [0..100] | Set favorite position |
setMemorized2PositionName |
STRING | Change the favorite position internal name. Name length may be subject to restrictions depending on the device and underlying protocol. |
setMemorized3Position |
INT [0..100] | Set favorite position |
setMemorized3PositionName |
STRING | Change the favorite position internal name. Name length may be subject to restrictions depending on the device and underlying protocol. |
setMinimumLightIntensity |
INT [0..100] | Set device minimum light intensity (100%=maximum intensity, 0%=off) |
setOnOff |
STRING: off, on | Turn the device on or off |
setSwitchMode |
STRING: onOff, dimmer | Set switch policy from one state to another state : On/Off (OnOff) or dimming (dimmer) |
setTimerUnit |
STRING: sec, min | Set unit of device internal timer (sec=seconds, min=minutes) |
setTransitionMode |
STRING: smooth, sharp | Set switch policy from one state to another state : On/Off (OnOff) or dimming (dimmer) |
setYokisTimer |
INT: 0, 2, 4, 8, 15 | Set Yokis device internal temporization value |
setYokisTransitionRamp |
INT: 0, 1, 2, 3, 4; STRING: sec, min | Set Yokis device internal variation ramp duration (value and unit). Supported combinations : (0,1,3,6,9,12,15,30,45) sec / [0-12] min |
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
ContextSavingOnPowerCutState |
DiscreteState | off, on | |
ExtinctionNotificationState |
DiscreteState | off, on | |
LightIntensityState |
ContinuousState | [0..100] | |
Memorized1PositionNameState |
DataState | ||
Memorized1PositionState |
ContinuousState | ||
Memorized2PositionNameState |
DataState | ||
Memorized2PositionState |
ContinuousState | ||
Memorized3PositionNameState |
DataState | ||
Memorized3PositionState |
ContinuousState | ||
MinimumLightIntensityState |
ContinuousState | ||
OnOffState |
DiscreteState | on, off | |
SwitchModeState |
DiscreteState | dimmer, onOff | |
TimerState |
ContinuousState | ||
TimerUnitState |
DiscreteState | min, sec | |
TransitionModeState |
DiscreteState | sharp, smooth | |
UpdateStatusState |
DiscreteState | error, inProgress, initialized, moduleUnreachableError, networkError, queued, timeout, usbUnreachableError | |
YokisTransitionRampDurationState |
ContinuousState | ||
YokisTransitionRampDurationUnitState |
DiscreteState | min, sec |
Light/StatefulOnOffLight (ACTUATOR) — 15 commands, 7 states
Type IDs: 65792, 65793, 65794, 65795, 65796 | Servers: rexel | Controllable: yokis:OnOffLightYokisComponent | Profiles: StatefulSwitchableLight, StatefulSwitchable, Switchable
Data Properties
core:identifyInterval=500
Commands
| Command | Parameters | Notes |
|---|---|---|
activateContextSavingOnPowerCut |
Activate last device state saving on power cut | |
activateExtinctionNotification |
Activate device notification before powering off | |
deactivateContextSavingOnPowerCut |
Deactivate last device state saving on power cut | |
deactivateExtinctionNotification |
Deactivate device notification before powering off | |
deactivateTimer |
Deactivate device internal timer | |
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 | |
refreshState |
Refresh the device states | |
setButtonMode |
STRING: onOff, push | Set device button behavior |
setContextSavingOnPowerCut |
STRING: off, on | Activate (on) or deactivate (off) last device state saving on power cut |
setExtinctionNotification |
STRING: off, on | Activate (on) or deactivate (off) device notification before powering off |
setOnOff |
STRING: off, on | Turn the device on or off |
setTimerUnit |
STRING: sec, min | Set unit of device internal timer (sec=seconds, min=minutes) |
setYokisTimer |
INT: 0, 2, 4, 8, 15 | Set Yokis device internal temporization value |
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
ButtonModeState |
DiscreteState | onOff, push | |
ContextSavingOnPowerCutState |
DiscreteState | off, on | |
ExtinctionNotificationState |
DiscreteState | off, on | |
OnOffState |
DiscreteState | on, off | |
TimerState |
ContinuousState | ||
TimerUnitState |
DiscreteState | min, sec | |
UpdateStatusState |
DiscreteState | error, inProgress, initialized, moduleUnreachableError, networkError, queued, timeout, usbUnreachableError |
NetworkComponent/Repeater (INFRASTRUCTURE_COMPONENT) — 1 commands, 0 states
Type IDs: 65536, 65537, 65538, 65792, 65793, 65794, 65795, 65796, 66048, 66049, 66050 | Servers: rexel | Controllable: yokis:RepeaterYokisComponent | Profiles: Specific
Data Properties
core:identifyInterval=500
Commands
| Command | Parameters | Notes |
|---|---|---|
identify |
Ask the device to identify itself by doing a slight movement or blink or beep |
OnOff/StatefulOnOff (ACTUATOR) — 15 commands, 7 states
Type IDs: 65792, 65793, 65794, 65795, 65796 | Servers: rexel | Controllable: yokis:PlugYokisComponent | Profiles: StatefulSwitchablePlug, StatefulSwitchable, Switchable
Data Properties
core:identifyInterval=500
Commands
| Command | Parameters | Notes |
|---|---|---|
activateContextSavingOnPowerCut |
Activate last device state saving on power cut | |
activateExtinctionNotification |
Activate device notification before powering off | |
deactivateContextSavingOnPowerCut |
Deactivate last device state saving on power cut | |
deactivateExtinctionNotification |
Deactivate device notification before powering off | |
deactivateTimer |
Deactivate device internal timer | |
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 | |
refreshState |
Refresh the device states | |
setButtonMode |
STRING: onOff, push | Set device button behavior |
setContextSavingOnPowerCut |
STRING: off, on | Activate (on) or deactivate (off) last device state saving on power cut |
setExtinctionNotification |
STRING: off, on | Activate (on) or deactivate (off) device notification before powering off |
setOnOff |
STRING: off, on | Turn the device on or off |
setTimerUnit |
STRING: sec, min | Set unit of device internal timer (sec=seconds, min=minutes) |
setYokisTimer |
INT: 0, 2, 4, 8, 15 | Set Yokis device internal temporization value |
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
ButtonModeState |
DiscreteState | onOff, push | |
ContextSavingOnPowerCutState |
DiscreteState | off, on | |
ExtinctionNotificationState |
DiscreteState | off, on | |
OnOffState |
DiscreteState | on, off | |
TimerState |
ContinuousState | ||
TimerUnitState |
DiscreteState | min, sec | |
UpdateStatusState |
DiscreteState | error, inProgress, initialized, moduleUnreachableError, networkError, queued, timeout, usbUnreachableError |
OnOff/TimedOnOff (ACTUATOR) — 9 commands, 5 states
Type IDs: 65792, 65793, 65794, 65795, 65796 | Servers: rexel | Controllable: yokis:TimedPlugYokisComponent | Profiles: StatefulSwitchablePlug, StatefulSwitchable, Switchable
Data Properties
core:identifyInterval=500
Commands
| Command | Parameters | Notes |
|---|---|---|
deactivateTimer |
Deactivate device internal timer | |
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 | |
refreshState |
Refresh the device states | |
setButtonMode |
STRING: onOff, push | Set device button behavior |
setOnOff |
STRING: off, on | Turn the device on or off |
setTimerUnit |
STRING: sec, min | Set unit of device internal timer (sec=seconds, min=minutes) |
setYokisTimer |
INT: 0, 2, 4, 8, 15 | Set Yokis device internal temporization value |
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
ButtonModeState |
DiscreteState | onOff, push | |
OnOffState |
DiscreteState | on, off | |
TimerState |
ContinuousState | ||
TimerUnitState |
DiscreteState | min, sec | |
UpdateStatusState |
DiscreteState | error, inProgress, initialized, moduleUnreachableError, networkError, queued, timeout, usbUnreachableError |
ProtocolGateway/YokisTransceiver (PROTOCOL_GATEWAY) — 1 commands, 1 states
Type IDs: 1 | Servers: rexel | Controllable: yokis:TransceiverYokisComponent | Profiles: Specific
Commands
| Command | Parameters | Notes |
|---|---|---|
setOperatingVersion |
STRING: 4, 5 | Set Yokis operating version |
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
UpdateStatusState |
DiscreteState | error, inProgress, initialized, moduleUnreachableError, networkError, queued, timeout, usbUnreachableError |
RemoteController/TwoButtonsController (REMOTE_CONTROLLER) — 0 commands, 2 states
Type IDs: 131072, 131073, 131088, 131089, 131328, 131329, 131345, 131360, 131361, 131584, 131585, 131600, 131601, 131616, 131617, 131840, 131841, 131857, 132352, 132368, 132384, 132400 | Servers: rexel | Controllable: yokis:TwoButtonsControllerYokisComponent | Profiles: Button
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
LastButtonPressedState |
DataState | ||
LastButtonReleasedState |
DataState |
RollerShutter/PositionableRollerShutter (ACTUATOR) — 28 commands, 13 states
Type IDs: 66048, 66049, 66050 | Servers: rexel | Controllable: yokis:RollerShutterYokisComponent | Profiles: StatefulCloseableShutter, StatefulCloseable, Closeable, StatefulOpenClose, OpenClose
Data Properties
core:identifyInterval=500
Commands
| Command | Parameters | Notes |
|---|---|---|
activateOppositeMotionOnOverload |
Activate automatic device opposite motion if an overload is detected | |
activateSoftwareWiringInversion |
Activate software device wiring inversion | |
activateTorqueLimitation |
Activate device torque limitation | |
close |
Fully close the device | |
deactivateOppositeMotionOnOverload |
Deactivate automatic device opposite motion if an overload is detected | |
deactivateSoftwareWiringInversion |
Deactivate software device wiring inversion | |
deactivateTorqueLimitation |
Deactivate device torque limitation | |
down |
Move the device completely down | |
goToMemorized1Position |
Set the device to a user pre-defined position | |
goToMemorized2Position |
Set the device to a user pre-defined position | |
goToMemorized3Position |
Set the device to a user pre-defined position | |
identify |
Ask the device to identify itself by doing a slight movement or blink or beep | |
open |
Fully open the device | |
refreshState |
Refresh the device states | |
setClosure |
INT [0..100] | Closure level (100%=fully close, 0%=open) |
setMemorized1Position |
INT [0..100] | Set favorite position |
setMemorized1PositionName |
STRING | Change the favorite position internal name. Name length may be subject to restrictions depending on the device and underlying protocol. |
setMemorized2Position |
INT [0..100] | Set favorite position |
setMemorized2PositionName |
STRING | Change the favorite position internal name. Name length may be subject to restrictions depending on the device and underlying protocol. |
setMemorized3Position |
INT [0..100] | Set favorite position |
setMemorized3PositionName |
STRING | Change the favorite position internal name. Name length may be subject to restrictions depending on the device and underlying protocol. |
setOppositeMotionOnOverload |
STRING: off, on | Activate (on) or deactivate (off) automatic device opposite motion if an overload is detected |
setPosition |
STRING: my, memorized1, memorized2, memorized3, secured; INT [0..100] | Set the device to a pre-defined position (enum) or a relative position (0-100%) |
setSoftwareWiringInversion |
STRING: off, on | Activate (on) or deactivate (off) software device wiring inversion |
setTorqueLimitation |
STRING: off, on | Activate (on) or deactivate (off) device torque limitation |
setTorqueMode |
STRING: high, low | Select the device torque mode |
stop |
Stop the current actuator behavior (movement, sound or timer) | |
up |
Move the device completely up |
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
ClosureState |
ContinuousState | [0..100] | |
Memorized1PositionNameState |
DataState | ||
Memorized1PositionState |
ContinuousState | ||
Memorized2PositionNameState |
DataState | ||
Memorized2PositionState |
ContinuousState | ||
Memorized3PositionNameState |
DataState | ||
Memorized3PositionState |
ContinuousState | ||
OpenClosedState |
DiscreteState | open, closed | |
OppositeMotionOnOverloadState |
DiscreteState | off, on | |
SoftwareWiringInversionState |
DiscreteState | off, on | |
TorqueLimitationState |
DiscreteState | off, on | |
TorqueModeState |
DiscreteState | high, low | |
UpdateStatusState |
DiscreteState | error, inProgress, initialized, moduleUnreachableError, networkError, queued, timeout, usbUnreachableError |
Valve/SolenoidValve (ACTUATOR) — 9 commands, 5 states
Type IDs: 65792, 65793, 65794, 65795 | Servers: rexel | Controllable: yokis:SolenoidValveYokisComponent | Profiles: StatefulOpenCloseValve, StatefulBasicOpenClose, BasicOpenClose, StatefulOpenClose, OpenClose
Data Properties
core:identifyInterval=500
Commands
| Command | Parameters | Notes |
|---|---|---|
close |
Fully close the device | |
deactivateTimer |
Deactivate device internal timer | |
identify |
Ask the device to identify itself by doing a slight movement or blink or beep | |
open |
Fully open the device | |
refreshState |
Refresh the device states | |
setButtonMode |
STRING: onOff, push | Set device button behavior |
setTimerUnit |
STRING: sec, min | Set unit of device internal timer (sec=seconds, min=minutes) |
setYokisTimer |
INT: 0, 2, 4, 8, 15 | Set Yokis device internal temporization value |
stop |
Stop the current actuator behavior (movement, sound or timer) |
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
ButtonModeState |
DiscreteState | onOff, push | |
OpenClosedState |
DiscreteState | open, closed | |
TimerState |
ContinuousState | ||
TimerUnitState |
DiscreteState | min, sec | |
UpdateStatusState |
DiscreteState | error, inProgress, initialized, moduleUnreachableError, networkError, queued, timeout, usbUnreachableError |
VentilationSystem/OnOffVentilationSpeed (ACTUATOR) — 3 commands, 5 states
Type IDs: 66048, 66049 | Servers: rexel | Controllable: yokis:VentilationYokisComponent | Profiles: StatefulAirFanMode, AirFanMode
Data Properties
core:identifyInterval=500
Commands
| Command | Parameters | Notes |
|---|---|---|
identify |
Ask the device to identify itself by doing a slight movement or blink or beep | |
refreshState |
Refresh the device states | |
setFanSpeedMode |
STRING: low, high | Set the device fan speed mode |
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
FanSpeedModeState |
DiscreteState | low, high | |
Memorized1PositionState |
ContinuousState | ||
Memorized2PositionState |
ContinuousState | ||
Memorized3PositionState |
ContinuousState | ||
UpdateStatusState |
DiscreteState | error, inProgress, initialized, moduleUnreachableError, networkError, queued, timeout, usbUnreachableError |
VentilationSystem/VentilationExtractor (ACTUATOR) — 6 commands, 6 states
Type IDs: 66048, 66049 | Servers: rexel | Controllable: yokis:ExtractorYokisComponent | Profiles: StatefulAirFanMode, AirFanMode, StatefulSwitchable, Switchable
Data Properties
core:identifyInterval=500
Commands
| Command | Parameters | Notes |
|---|---|---|
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 | |
refreshState |
Refresh the device states | |
setFanSpeedMode |
STRING: low, high | Set the device fan speed mode |
setOnOff |
STRING: off, on | Turn the device on or off |
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
FanSpeedModeState |
DiscreteState | low, high | |
Memorized1PositionState |
ContinuousState | ||
Memorized2PositionState |
ContinuousState | ||
Memorized3PositionState |
ContinuousState | ||
OnOffState |
DiscreteState | on, off | |
UpdateStatusState |
DiscreteState | error, inProgress, initialized, moduleUnreachableError, networkError, queued, timeout, usbUnreachableError |
ZIGBEE
50 device types.
Awning/PositionableHorizontalAwning (ACTUATOR) — 13 commands, 12 states
Type IDs: 2199023387141 | Servers: atlantic_cozytouch, rexel, somfy_europe | Controllable: zigbee:AwningComponent | Profiles: StatefulDeployableAwning, StatefulDeployable, Deployable, DeployUndeploy
Data Properties
core:identifyInterval=500
Commands
| Command | Parameters | Notes |
|---|---|---|
addLockLevel |
INT; INT (optional) | Add a command lock level on the device p1 : The lock level to add p2 : (optional) Duration in second of the lock Level. By default there is no expiration.; cluster:0 |
advancedRefresh |
STRING: normal, advanced | Refresh extra states; cluster:0 |
bind |
STRING; STRING | Bind a device with another device. First parameter is target device address. Second parameter is list of clusters to bind (string of clusters separated by ","). |
deploy |
Fully deploy the device; cluster:258 | |
identify |
Ask the device to identify itself by doing a slight movement or blink or beep; cluster:3 | |
ping |
Check if device is available; cluster:3 | |
removeLockLevel |
INT | Remove the command lock level on the device p1 : The lock level to remove; cluster:0 |
resetLockLevels |
Remove all lock levels on the device; cluster:0 | |
setDeployment |
INT [0..100] | Device deployment level (100%=fully deployed, 0%=fully undeployed); cluster:258 |
stop |
Stop the current actuator behavior (movement, sound or timer); cluster:258 | |
stopIdentify |
Ask the device to stop winking immediately; cluster:3 | |
unbind |
STRING; STRING | Unbind a device with another device. First parameter is target device address. Second parameter is list of clusters to unbind (string of clusters separated by ","). |
undeploy |
Fully undeploy the device; cluster:258 |
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
CommandLockLevelsState |
DataState | ||
DeploymentState |
ContinuousState | [0..100] | cluster:258 |
DiscreteRSSILevelState |
DiscreteState | good, low, normal, verylow | |
FirmwareRevisionState |
DataState | ||
LinkQualityIndicatorState |
ContinuousState | ||
ManufacturerNameState |
DataState | cluster:0 | |
PowerSourceState |
DiscreteState | Unknown, Mains (single phase), Mains (3 phase), Battery, DC source, Emergency mains constantly powered, Emergency mains and transfer switch | cluster:0 |
ProductModelNameState |
DataState | cluster:0 | |
RSSILevelState |
ContinuousState | ||
StatusState |
DiscreteState | available, unavailable | |
ZigbeeUpdateDownloadProgressState |
ContinuousState | ||
ZigbeeUpdateState |
DiscreteState | idle, running, error-timeout, error-default-initial-condition, error-on-upgrade, success, error-abort, error-not-authorized, error-invalid-image, error-wait-for-data, error-no-image-available, error-malformed-command, error-require-more-image |
Ballast (ACTUATOR) — 11 commands, 15 states
Type IDs: 2199023321345 | Servers: atlantic_cozytouch, rexel, somfy_europe | Controllable: zigbee:BallastComponent | Profiles: Specific
Data Properties
core:identifyInterval=500
Commands
| Command | Parameters | Notes |
|---|---|---|
addLockLevel |
INT; INT (optional) | Add a command lock level on the device p1 : The lock level to add p2 : (optional) Duration in second of the lock Level. By default there is no expiration.; cluster:0 |
advancedRefresh |
STRING: normal, advanced | Refresh extra states; cluster:0 |
bind |
STRING; STRING | Bind a device with another device. First parameter is target device address. Second parameter is list of clusters to bind (string of clusters separated by ","). |
identify |
Ask the device to identify itself by doing a slight movement or blink or beep; cluster:3 | |
ping |
Check if device is available; cluster:3 | |
removeLockLevel |
INT | Remove the command lock level on the device p1 : The lock level to remove; cluster:0 |
resetLockLevels |
Remove all lock levels on the device; cluster:0 | |
setBallastMaxLevel |
INT [1..100] | Set the maximum value (1% = 2, 100% = 254) for Ballast; cluster:769 |
setBallastMinLevel |
INT [1..100] | Set the minimum value (1% = 2, 100% = 254) for Ballast; cluster:769 |
stopIdentify |
Ask the device to stop winking immediately; cluster:3 | |
unbind |
STRING; STRING | Unbind a device with another device. First parameter is target device address. Second parameter is list of clusters to unbind (string of clusters separated by ","). |
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
BallastMaxLevelState |
DataState | cluster:769 | |
BallastMinLevelState |
DataState | cluster:769 | |
BallastStatusLampState |
DiscreteState | active, inactive | cluster:769 |
BallastStatusState |
DiscreteState | active, inactive | cluster:769 |
CommandLockLevelsState |
DataState | ||
DiscreteRSSILevelState |
DiscreteState | good, low, normal, verylow | |
FirmwareRevisionState |
DataState | ||
LinkQualityIndicatorState |
ContinuousState | ||
ManufacturerNameState |
DataState | cluster:0 | |
PowerSourceState |
DiscreteState | Unknown, Mains (single phase), Mains (3 phase), Battery, DC source, Emergency mains constantly powered, Emergency mains and transfer switch | cluster:0 |
ProductModelNameState |
DataState | cluster:0 | |
RSSILevelState |
ContinuousState | ||
StatusState |
DiscreteState | available, unavailable | |
ZigbeeUpdateDownloadProgressState |
ContinuousState | ||
ZigbeeUpdateState |
DiscreteState | idle, running, error-timeout, error-default-initial-condition, error-on-upgrade, success, error-abort, error-not-authorized, error-invalid-image, error-wait-for-data, error-no-image-available, error-malformed-command, error-require-more-image |
Ballast (ACTUATOR) — 12 commands, 16 states
Type IDs: 2269319856385 | Servers: atlantic_cozytouch, rexel, somfy_europe | Controllable: zigbee:SchneiderBallastComponent | Profiles: Specific
Data Properties
core:identifyInterval=500
Commands
| Command | Parameters | Notes |
|---|---|---|
addLockLevel |
INT; INT (optional) | Add a command lock level on the device p1 : The lock level to add p2 : (optional) Duration in second of the lock Level. By default there is no expiration.; cluster:0 |
advancedRefresh |
STRING: normal, advanced | Refresh extra states; cluster:0; cluster:6 |
bind |
STRING; STRING | Bind a device with another device. First parameter is target device address. Second parameter is list of clusters to bind (string of clusters separated by ","). |
identify |
Ask the device to identify itself by doing a slight movement or blink or beep; cluster:3 | |
ping |
Check if device is available; cluster:3 | |
removeLockLevel |
INT | Remove the command lock level on the device p1 : The lock level to remove; cluster:0 |
resetLockLevels |
Remove all lock levels on the device; cluster:0 | |
setBallastMaxLevel |
INT [1..100] | Set the maximum value (1% = 2, 100% = 254) for Ballast; cluster:769 |
setBallastMinLevel |
INT [1..100] | Set the minimum value (1% = 2, 100% = 254) for Ballast; cluster:769 |
setSchneiderBallastControlMode |
STRING: automatic, RC mode, RL mode, RL-LED | Set the ballast control mode; cluster:769 |
stopIdentify |
Ask the device to stop winking immediately; cluster:3 | |
unbind |
STRING; STRING | Unbind a device with another device. First parameter is target device address. Second parameter is list of clusters to unbind (string of clusters separated by ","). |
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
BallastMaxLevelState |
DataState | cluster:769 | |
BallastMinLevelState |
DataState | cluster:769 | |
BallastStatusLampState |
DiscreteState | active, inactive | cluster:769 |
BallastStatusState |
DiscreteState | active, inactive | cluster:769 |
CommandLockLevelsState |
DataState | ||
DiscreteRSSILevelState |
DiscreteState | good, low, normal, verylow | |
FirmwareRevisionState |
DataState | ||
LinkQualityIndicatorState |
ContinuousState | ||
ManufacturerNameState |
DataState | cluster:0 | |
PowerSourceState |
DiscreteState | Unknown, Mains (single phase), Mains (3 phase), Battery, DC source, Emergency mains constantly powered, Emergency mains and transfer switch | cluster:0 |
ProductModelNameState |
DataState | cluster:0 | |
RSSILevelState |
ContinuousState | ||
SchneiderBallastControlModeState |
DataState | cluster:769 | |
StatusState |
DiscreteState | available, unavailable | |
ZigbeeUpdateDownloadProgressState |
ContinuousState | ||
ZigbeeUpdateState |
DiscreteState | idle, running, error-timeout, error-default-initial-condition, error-on-upgrade, success, error-abort, error-not-authorized, error-invalid-image, error-wait-for-data, error-no-image-available, error-malformed-command, error-require-more-image |
ConfigurationComponent/SchneiderSwitchConfiguration (ACTUATOR) — 12 commands, 16 states
Type IDs: 2269319857152 | Servers: atlantic_cozytouch, rexel, somfy_europe | Controllable: zigbee:SchneiderSwitchConfigurationComponent | Profiles: Specific
Data Properties
core:identifyInterval=500
Commands
| Command | Parameters | Notes |
|---|---|---|
addLockLevel |
INT; INT (optional) | Add a command lock level on the device p1 : The lock level to add p2 : (optional) Duration in second of the lock Level. By default there is no expiration.; cluster:0 |
advancedRefresh |
STRING: normal, advanced | Refresh extra states; cluster:0; cluster:8 |
bind |
STRING; STRING | Bind a device with another device. First parameter is target device address. Second parameter is list of clusters to bind (string of clusters separated by ","). |
identify |
Ask the device to identify itself by doing a slight movement or blink or beep; cluster:3 | |
ping |
Check if device is available; cluster:3 | |
removeLockLevel |
INT | Remove the command lock level on the device p1 : The lock level to remove; cluster:0 |
resetLockLevels |
Remove all lock levels on the device; cluster:0 | |
setStartUpCurrentLevel |
STRING: min, previous; INT [0..100] | p1: min => set the current level on the minimum allow by the device previous => set the value to the state saved on the device integer[0-100] => set the custom intesity on start up.; cluster:8 |
setSwitchActionsConfiguration |
STRING: light, lightOpp, dimmer, dimmerOpp, standardShutter | Set the switch actions configuration. p1: light lightOpp = light opposite dimmer dimmerOpp = dimmer opposite standardShutter = standard Shutter standardShutterOpp = standard Shutter opposite schneiderShutter = schneider Shutter schneiderShutterOpp = schneider shutter opposite toggleLight = toggle light toggleDimmer = toogle dimmer; cluster:65303 |
setSwitchIndicationConfiguration |
STRING: indicatorOnWhenLoadOn, indicatorAlwaysOn, indicatorOnWhenLoadOff, indicatorAlwaysOff | Set the switch Led indication configuration. p1: indicatorOnWhenLoadOn indicatorAlwaysOn indicatorOnWhenLoadOff indicatorAlwaysOff; cluster:65303 |
stopIdentify |
Ask the device to stop winking immediately; cluster:3 | |
unbind |
STRING; STRING | Unbind a device with another device. First parameter is target device address. Second parameter is list of clusters to unbind (string of clusters separated by ","). |
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
BatteryLevelState |
ContinuousState | cluster:1 | |
CommandLockLevelsState |
DataState | ||
DiscreteRSSILevelState |
DiscreteState | good, low, normal, verylow | |
FirmwareRevisionState |
DataState | ||
LinkQualityIndicatorState |
ContinuousState | ||
LowBatteryThresholdState |
ContinuousState | cluster:1 | |
ManufacturerNameState |
DataState | cluster:0 | |
PowerSourceState |
DiscreteState | Unknown, Mains (single phase), Mains (3 phase), Battery, DC source, Emergency mains constantly powered, Emergency mains and transfer switch | cluster:0 |
ProductModelNameState |
DataState | cluster:0 | |
RSSILevelState |
ContinuousState | ||
StartUpCurrentLevelState |
DataState | cluster:8 | |
StatusState |
DiscreteState | available, unavailable | |
SwitchActionsState |
DataState | cluster:65303 | |
SwitchIndicationState |
DataState | cluster:65303 | |
ZigbeeUpdateDownloadProgressState |
ContinuousState | ||
ZigbeeUpdateState |
DiscreteState | idle, running, error-timeout, error-default-initial-condition, error-on-upgrade, success, error-abort, error-not-authorized, error-invalid-image, error-wait-for-data, error-no-image-available, error-malformed-command, error-require-more-image |
ContactSensor (SENSOR) — 6 commands, 13 states
Type IDs: 2199023518210, 2269320053250 | Servers: atlantic_cozytouch, rexel, somfy_europe | Controllable: zigbee:DoorSensorComponent | Profiles: DoorContactSensor, ContactDetector
Data Properties
core:identifyInterval=500
Commands
| Command | Parameters | Notes |
|---|---|---|
advancedRefresh |
STRING: normal, advanced | Refresh extra states; cluster:0 |
bind |
STRING; STRING | Bind a device with another device. First parameter is target device address. Second parameter is list of clusters to bind (string of clusters separated by ","). |
identify |
Ask the device to identify itself by doing a slight movement or blink or beep; cluster:3 | |
ping |
Check if device is available; cluster:3 | |
stopIdentify |
Ask the device to stop winking immediately; cluster:3 | |
unbind |
STRING; STRING | Unbind a device with another device. First parameter is target device address. Second parameter is list of clusters to unbind (string of clusters separated by ","). |
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
BatteryLevelState |
ContinuousState | cluster:1 | |
ContactState |
DiscreteState | open, closed | cluster:1280 |
DiscreteRSSILevelState |
DiscreteState | good, low, normal, verylow | |
FirmwareRevisionState |
DataState | ||
LinkQualityIndicatorState |
ContinuousState | ||
LowBatteryThresholdState |
ContinuousState | cluster:1 | |
ManufacturerNameState |
DataState | cluster:0 | |
PowerSourceState |
DiscreteState | Unknown, Mains (single phase), Mains (3 phase), Battery, DC source, Emergency mains constantly powered, Emergency mains and transfer switch | cluster:0 |
ProductModelNameState |
DataState | cluster:0 | |
RSSILevelState |
ContinuousState | ||
StatusState |
DiscreteState | available, unavailable | |
ZigbeeUpdateDownloadProgressState |
ContinuousState | ||
ZigbeeUpdateState |
DiscreteState | idle, running, error-timeout, error-default-initial-condition, error-on-upgrade, success, error-abort, error-not-authorized, error-invalid-image, error-wait-for-data, error-no-image-available, error-malformed-command, error-require-more-image |
Curtain/PositionableCurtain (ACTUATOR) — 15 commands, 23 states
Type IDs: 2199023387140 | Servers: atlantic_cozytouch, rexel, somfy_europe | Controllable: zigbee:CurtainComponent | Profiles: StatefulCloseableCurtain, StatefulCloseable, Closeable, OpenClose
Data Properties
core:identifyInterval=500
Commands
| Command | Parameters | Notes |
|---|---|---|
addLockLevel |
INT; INT (optional) | Add a command lock level on the device p1 : The lock level to add p2 : (optional) Duration in second of the lock Level. By default there is no expiration.; cluster:0 |
advancedRefresh |
STRING: normal, advanced | Refresh extra states; cluster:0; cluster:258 |
bind |
STRING; STRING | Bind a device with another device. First parameter is target device address. Second parameter is list of clusters to bind (string of clusters separated by ","). |
close |
Fully close the device; cluster:258 | |
identify |
Ask the device to identify itself by doing a slight movement or blink or beep; cluster:3 | |
open |
Fully open the device; cluster:258 | |
ping |
Check if device is available; cluster:3 | |
removeLockLevel |
INT | Remove the command lock level on the device p1 : The lock level to remove; cluster:0 |
resetLockLevels |
Remove all lock levels on the device; cluster:0 | |
setClosure |
INT [0..100] | Closure level (100%=fully close, 0%=open); cluster:258 |
setModes |
OBJECT | Set modes, all modes must be specified. - motorDirection: string(normal;reversed), the reversal of the motor rotating direction associated with commands. - motorRunMode: string(normal;calibration), placing the motor into Calibration Mode where limits are either setup using physical tools or limits are learned by the controller based on physical setup of the Window Covering by an installer - motorRunningMode: string(normal;maintenance), placing the motor into Maintenance Mode where the motor cannot be moved over the network or by a switch connected to a Local Switch Input. - motorLedFeedback: string(enable;disable), the display of any feedback LEDs. Example: { "motorDirection":"reversed", "motorRunMode":"normal", "motorRunningMode":"normal", "motorLedFeedback":"enable" }; cluster:258 |
setPosition |
INT [0..100] | Set the device to a pre-defined position (enum) or a relative position (0-100%); cluster:258 |
stop |
Stop the current actuator behavior (movement, sound or timer); cluster:258 | |
stopIdentify |
Ask the device to stop winking immediately; cluster:3 | |
unbind |
STRING; STRING | Unbind a device with another device. First parameter is target device address. Second parameter is list of clusters to unbind (string of clusters separated by ","). |
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
ClosureState |
ContinuousState | [0..100] | cluster:258 |
CommandLockLevelsState |
DataState | ||
ControlLiftState |
DiscreteState | lift control is open loop, lift control is closed loop | cluster:258 |
ControlTiltState |
DiscreteState | tilt control is closed loop, tilt control is open loop | cluster:258 |
DirectionState |
DiscreteState | counterClockwise, clockwise | cluster:258 |
DiscreteRSSILevelState |
DiscreteState | good, low, normal, verylow | |
EncoderLiftState |
DiscreteState | encoder controlled, timer controlled | cluster:258 |
EncoderTiltState |
DiscreteState | encoder controlled, timer controlled | cluster:258 |
FirmwareRevisionState |
DataState | ||
LinkQualityIndicatorState |
ContinuousState | ||
ManufacturerNameState |
DataState | cluster:0 | |
MotorLEDFeedbackState |
DiscreteState | LEDs will display feedback, LEDs are off | cluster:258 |
MotorRunModeState |
DiscreteState | run in calibration mode, run in normal mode | cluster:258 |
MotorRunningModeState |
DiscreteState | motor is running in maintenance mode, motor is running normally | cluster:258 |
NetworkOnlineState |
DiscreteState | online, not online | cluster:258 |
OperationalStatusState |
DataState | cluster:258 | |
PowerSourceState |
DiscreteState | Unknown, Mains (single phase), Mains (3 phase), Battery, DC source, Emergency mains constantly powered, Emergency mains and transfer switch | cluster:0 |
ProductModelNameState |
DataState | cluster:0 | |
RSSILevelState |
ContinuousState | ||
ReversalLiftState |
DiscreteState | reversal lift commands, not reversal lift commands | cluster:258 |
StatusState |
DiscreteState | available, unavailable | |
ZigbeeUpdateDownloadProgressState |
ContinuousState | ||
ZigbeeUpdateState |
DiscreteState | idle, running, error-timeout, error-default-initial-condition, error-on-upgrade, success, error-abort, error-not-authorized, error-invalid-image, error-wait-for-data, error-no-image-available, error-malformed-command, error-require-more-image |
ElectricitySensor/CumulativeElectricPowerConsumptionSensor (SENSOR) — 6 commands, 12 states
Type IDs: 2199023276289, 2199023276290, 2278664720658, 2269319811346 | Servers: atlantic_cozytouch, rexel, somfy_europe | Controllable: zigbee:ElectricalEnergyConsumptionSensorComponent | Profiles: ElectricEnergyAndPower, ElectricPowerMeter, ElectricEnergyConsumption
Data Properties
core:identifyInterval=500
Commands
| Command | Parameters | Notes |
|---|---|---|
advancedRefresh |
STRING: normal, advanced | Refresh extra states; cluster:0 |
bind |
STRING; STRING | Bind a device with another device. First parameter is target device address. Second parameter is list of clusters to bind (string of clusters separated by ","). |
identify |
Ask the device to identify itself by doing a slight movement or blink or beep; cluster:3 | |
ping |
Check if device is available; cluster:3 | |
stopIdentify |
Ask the device to stop winking immediately; cluster:3 | |
unbind |
STRING; STRING | Unbind a device with another device. First parameter is target device address. Second parameter is list of clusters to unbind (string of clusters separated by ","). |
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
DiscreteRSSILevelState |
DiscreteState | good, low, normal, verylow | |
ElectricEnergyConsumptionState |
ContinuousState | cluster:1794 | |
ElectricPowerConsumptionState |
ContinuousState | cluster:1794 | |
FirmwareRevisionState |
DataState | ||
LinkQualityIndicatorState |
ContinuousState | ||
ManufacturerNameState |
DataState | cluster:0 | |
PowerSourceState |
DiscreteState | Unknown, Mains (single phase), Mains (3 phase), Battery, DC source, Emergency mains constantly powered, Emergency mains and transfer switch | cluster:0 |
ProductModelNameState |
DataState | cluster:0 | |
RSSILevelState |
ContinuousState | ||
StatusState |
DiscreteState | available, unavailable | |
ZigbeeUpdateDownloadProgressState |
ContinuousState | ||
ZigbeeUpdateState |
DiscreteState | idle, running, error-timeout, error-default-initial-condition, error-on-upgrade, success, error-abort, error-not-authorized, error-invalid-image, error-wait-for-data, error-no-image-available, error-malformed-command, error-require-more-image |
ElectricitySensor/CumulativeElectricPowerConsumptionSensor (SENSOR) — 6 commands, 21 states
Type IDs: 2199023585538, 2271501158658 | Servers: atlantic_cozytouch, rexel, somfy_europe | Controllable: zigbee:LinkyRadioTransmitterHistoricSensorComponent | Profiles: ElectricEnergyAndPower, ElectricPowerMeter, ElectricEnergyConsumption
Data Properties
core:identifyInterval=500
Commands
| Command | Parameters | Notes |
|---|---|---|
advancedRefresh |
STRING: normal, advanced | Refresh extra states; cluster:0 |
bind |
STRING; STRING | Bind a device with another device. First parameter is target device address. Second parameter is list of clusters to bind (string of clusters separated by ","). |
identify |
Ask the device to identify itself by doing a slight movement or blink or beep; cluster:3 | |
ping |
Check if device is available; cluster:3 | |
stopIdentify |
Ask the device to stop winking immediately; cluster:3 | |
unbind |
STRING; STRING | Unbind a device with another device. First parameter is target device address. Second parameter is list of clusters to unbind (string of clusters separated by ","). |
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
DiscreteRSSILevelState |
DiscreteState | good, low, normal, verylow | |
ElectricEnergyConsumptionState |
ContinuousState | cluster:1794 | |
ElectricEnergyConsumptionTier1State |
ContinuousState | cluster:1794 | |
ElectricEnergyConsumptionTier2State |
ContinuousState | cluster:1794 | |
ElectricEnergyConsumptionTier3State |
ContinuousState | cluster:1794 | |
ElectricEnergyConsumptionTier4State |
ContinuousState | cluster:1794 | |
ElectricEnergyConsumptionTier5State |
ContinuousState | cluster:1794 | |
ElectricEnergyConsumptionTier6State |
ContinuousState | cluster:1794 | |
ElectricPowerConsumptionState |
ContinuousState | cluster:1794 | |
ElectricalContractIntensityState |
ContinuousState | cluster:2817 | |
ElectricalIntensityThresholdExceededState |
DataState | cluster:1794 | |
FirmwareRevisionState |
DataState | ||
LinkQualityIndicatorState |
ContinuousState | ||
LinkyModeState |
DiscreteState | historical, standard | cluster:1794 |
ManufacturerNameState |
DataState | cluster:0 | |
PowerSourceState |
DiscreteState | Unknown, Mains (single phase), Mains (3 phase), Battery, DC source, Emergency mains constantly powered, Emergency mains and transfer switch | cluster:0 |
ProductModelNameState |
DataState | cluster:0 | |
RSSILevelState |
ContinuousState | ||
StatusState |
DiscreteState | available, unavailable | |
ZigbeeUpdateDownloadProgressState |
ContinuousState | ||
ZigbeeUpdateState |
DiscreteState | idle, running, error-timeout, error-default-initial-condition, error-on-upgrade, success, error-abort, error-not-authorized, error-invalid-image, error-wait-for-data, error-no-image-available, error-malformed-command, error-require-more-image |
ElectricitySensor/CumulativeElectricPowerConsumptionSensor (SENSOR) — 6 commands, 32 states
Type IDs: 2271500849922, 2276869559042 | Servers: atlantic_cozytouch, rexel, somfy_europe | Controllable: zigbee:LinkyRadioTransmitterSensorComponent | Profiles: ElectricEnergyAndPower, ElectricPowerMeter, ElectricEnergyConsumption
Data Properties
core:identifyInterval=500
Commands
| Command | Parameters | Notes |
|---|---|---|
advancedRefresh |
STRING: normal, advanced | Refresh extra states; cluster:0 |
bind |
STRING; STRING | Bind a device with another device. First parameter is target device address. Second parameter is list of clusters to bind (string of clusters separated by ","). |
identify |
Ask the device to identify itself by doing a slight movement or blink or beep; cluster:3 | |
ping |
Check if device is available; cluster:3 | |
stopIdentify |
Ask the device to stop winking immediately; cluster:3 | |
unbind |
STRING; STRING | Unbind a device with another device. First parameter is target device address. Second parameter is list of clusters to unbind (string of clusters separated by ","). |
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
ActiveTierLabelState |
DataState | cluster:1794 | |
ActiveTierState |
ContinuousState | [0..48] | cluster:1794 |
DiscreteRSSILevelState |
DiscreteState | good, low, normal, verylow | |
ElectricEnergyConsumptionState |
ContinuousState | cluster:1794 | |
ElectricEnergyConsumptionTier10State |
ContinuousState | cluster:1794 | |
ElectricEnergyConsumptionTier1State |
ContinuousState | cluster:1794 | |
ElectricEnergyConsumptionTier2State |
ContinuousState | cluster:1794 | |
ElectricEnergyConsumptionTier3State |
ContinuousState | cluster:1794 | |
ElectricEnergyConsumptionTier4State |
ContinuousState | cluster:1794 | |
ElectricEnergyConsumptionTier5State |
ContinuousState | cluster:1794 | |
ElectricEnergyConsumptionTier6State |
ContinuousState | cluster:1794 | |
ElectricEnergyConsumptionTier7State |
ContinuousState | cluster:1794 | |
ElectricEnergyConsumptionTier8State |
ContinuousState | cluster:1794 | |
ElectricEnergyConsumptionTier9State |
ContinuousState | cluster:1794 | |
ElectricEnergyGenerationState |
ContinuousState | cluster:1794 | |
ElectricInstantaneousIntensityState |
ContinuousState | cluster:2820 | |
ElectricPowerConsumptionState |
ContinuousState | cluster:1794 | |
ElectricalContractIntensityState |
ContinuousState | cluster:2817 | |
ElectricalIntensityThresholdExceededState |
DataState | cluster:1794 | |
FirmwareRevisionState |
DataState | ||
IdentifierState |
DataState | cluster:1794 | |
LinkQualityIndicatorState |
ContinuousState | ||
LinkyModeState |
DiscreteState | historical, standard | cluster:1794 |
ManufacturerNameState |
DataState | cluster:0 | |
MaxElectricPowerConsumptionState |
ContinuousState | cluster:1794 | |
MaxElectricPowerGenerationState |
ContinuousState | cluster:1794 | |
PowerSourceState |
DiscreteState | Unknown, Mains (single phase), Mains (3 phase), Battery, DC source, Emergency mains constantly powered, Emergency mains and transfer switch | cluster:0 |
ProductModelNameState |
DataState | cluster:0 | |
RSSILevelState |
ContinuousState | ||
StatusState |
DiscreteState | available, unavailable | |
ZigbeeUpdateDownloadProgressState |
ContinuousState | ||
ZigbeeUpdateState |
DiscreteState | idle, running, error-timeout, error-default-initial-condition, error-on-upgrade, success, error-abort, error-not-authorized, error-invalid-image, error-wait-for-data, error-no-image-available, error-malformed-command, error-require-more-image |
ElectricitySensor/CumulativeElectricPowerConsumptionSensor (SENSOR) — 6 commands, 11 states
Type IDs: 2268296448513, 2268296383745 | Servers: atlantic_cozytouch, rexel, somfy_europe | Controllable: zigbee:ElectricalPowerConsumptionSensorComponent | Profiles: ElectricPowerMeter
Data Properties
core:identifyInterval=500
Commands
| Command | Parameters | Notes |
|---|---|---|
advancedRefresh |
STRING: normal, advanced | Refresh extra states; cluster:0 |
bind |
STRING; STRING | Bind a device with another device. First parameter is target device address. Second parameter is list of clusters to bind (string of clusters separated by ","). |
identify |
Ask the device to identify itself by doing a slight movement or blink or beep; cluster:3 | |
ping |
Check if device is available; cluster:3 | |
stopIdentify |
Ask the device to stop winking immediately; cluster:3 | |
unbind |
STRING; STRING | Unbind a device with another device. First parameter is target device address. Second parameter is list of clusters to unbind (string of clusters separated by ","). |
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
DiscreteRSSILevelState |
DiscreteState | good, low, normal, verylow | |
ElectricPowerConsumptionState |
ContinuousState | cluster:2820 | |
FirmwareRevisionState |
DataState | ||
LinkQualityIndicatorState |
ContinuousState | ||
ManufacturerNameState |
DataState | cluster:0 | |
PowerSourceState |
DiscreteState | Unknown, Mains (single phase), Mains (3 phase), Battery, DC source, Emergency mains constantly powered, Emergency mains and transfer switch | cluster:0 |
ProductModelNameState |
DataState | cluster:0 | |
RSSILevelState |
ContinuousState | ||
StatusState |
DiscreteState | available, unavailable | |
ZigbeeUpdateDownloadProgressState |
ContinuousState | ||
ZigbeeUpdateState |
DiscreteState | idle, running, error-timeout, error-default-initial-condition, error-on-upgrade, success, error-abort, error-not-authorized, error-invalid-image, error-wait-for-data, error-no-image-available, error-malformed-command, error-require-more-image |
ExteriorScreen/PositionableScreen (ACTUATOR) — 15 commands, 23 states
Type IDs: 2199023387138, 2199023387139 | Servers: atlantic_cozytouch, rexel, somfy_europe | Controllable: zigbee:VerticalExteriorAwningComponent | Profiles: StatefulCloseableScreen, StatefulCloseable, Closeable, OpenClose
Data Properties
core:identifyInterval=500
Commands
| Command | Parameters | Notes |
|---|---|---|
addLockLevel |
INT; INT (optional) | Add a command lock level on the device p1 : The lock level to add p2 : (optional) Duration in second of the lock Level. By default there is no expiration.; cluster:0 |
advancedRefresh |
STRING: normal, advanced | Refresh extra states; cluster:0; cluster:258 |
bind |
STRING; STRING | Bind a device with another device. First parameter is target device address. Second parameter is list of clusters to bind (string of clusters separated by ","). |
close |
Fully close the device; cluster:258 | |
identify |
Ask the device to identify itself by doing a slight movement or blink or beep; cluster:3 | |
open |
Fully open the device; cluster:258 | |
ping |
Check if device is available; cluster:3 | |
removeLockLevel |
INT | Remove the command lock level on the device p1 : The lock level to remove; cluster:0 |
resetLockLevels |
Remove all lock levels on the device; cluster:0 | |
setClosure |
INT [0..100] | Closure level (100%=fully close, 0%=open); cluster:258 |
setModes |
OBJECT | Set modes, all modes must be specified. - motorDirection: string(normal;reversed), the reversal of the motor rotating direction associated with commands. - motorRunMode: string(normal;calibration), placing the motor into Calibration Mode where limits are either setup using physical tools or limits are learned by the controller based on physical setup of the Window Covering by an installer - motorRunningMode: string(normal;maintenance), placing the motor into Maintenance Mode where the motor cannot be moved over the network or by a switch connected to a Local Switch Input. - motorLedFeedback: string(enable;disable), the display of any feedback LEDs. Example: { "motorDirection":"reversed", "motorRunMode":"normal", "motorRunningMode":"normal", "motorLedFeedback":"enable" }; cluster:258 |
setPosition |
INT [0..100] | Set the device to a pre-defined position (enum) or a relative position (0-100%); cluster:258 |
stop |
Stop the current actuator behavior (movement, sound or timer); cluster:258 | |
stopIdentify |
Ask the device to stop winking immediately; cluster:3 | |
unbind |
STRING; STRING | Unbind a device with another device. First parameter is target device address. Second parameter is list of clusters to unbind (string of clusters separated by ","). |
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
ClosureState |
ContinuousState | [0..100] | cluster:258 |
CommandLockLevelsState |
DataState | ||
ControlLiftState |
DiscreteState | lift control is open loop, lift control is closed loop | cluster:258 |
ControlTiltState |
DiscreteState | tilt control is closed loop, tilt control is open loop | cluster:258 |
DirectionState |
DiscreteState | counterClockwise, clockwise | cluster:258 |
DiscreteRSSILevelState |
DiscreteState | good, low, normal, verylow | |
EncoderLiftState |
DiscreteState | encoder controlled, timer controlled | cluster:258 |
EncoderTiltState |
DiscreteState | encoder controlled, timer controlled | cluster:258 |
FirmwareRevisionState |
DataState | ||
LinkQualityIndicatorState |
ContinuousState | ||
ManufacturerNameState |
DataState | cluster:0 | |
MotorLEDFeedbackState |
DiscreteState | LEDs will display feedback, LEDs are off | cluster:258 |
MotorRunModeState |
DiscreteState | run in calibration mode, run in normal mode | cluster:258 |
MotorRunningModeState |
DiscreteState | motor is running in maintenance mode, motor is running normally | cluster:258 |
NetworkOnlineState |
DiscreteState | online, not online | cluster:258 |
OperationalStatusState |
DataState | cluster:258 | |
PowerSourceState |
DiscreteState | Unknown, Mains (single phase), Mains (3 phase), Battery, DC source, Emergency mains constantly powered, Emergency mains and transfer switch | cluster:0 |
ProductModelNameState |
DataState | cluster:0 | |
RSSILevelState |
ContinuousState | ||
ReversalLiftState |
DiscreteState | reversal lift commands, not reversal lift commands | cluster:258 |
StatusState |
DiscreteState | available, unavailable | |
ZigbeeUpdateDownloadProgressState |
ContinuousState | ||
ZigbeeUpdateState |
DiscreteState | idle, running, error-timeout, error-default-initial-condition, error-on-upgrade, success, error-abort, error-not-authorized, error-invalid-image, error-wait-for-data, error-no-image-available, error-malformed-command, error-require-more-image |
GasSensor/COSensor (SENSOR) — 6 commands, 13 states
Type IDs: 2199023518213 | Servers: atlantic_cozytouch, rexel, somfy_europe | Controllable: zigbee:CarbonMonoxideSensorComponent | Profiles: CODetection
Data Properties
core:identifyInterval=500
Commands
| Command | Parameters | Notes |
|---|---|---|
advancedRefresh |
STRING: normal, advanced | Refresh extra states; cluster:0 |
bind |
STRING; STRING | Bind a device with another device. First parameter is target device address. Second parameter is list of clusters to bind (string of clusters separated by ","). |
identify |
Ask the device to identify itself by doing a slight movement or blink or beep; cluster:3 | |
ping |
Check if device is available; cluster:3 | |
stopIdentify |
Ask the device to stop winking immediately; cluster:3 | |
unbind |
STRING; STRING | Unbind a device with another device. First parameter is target device address. Second parameter is list of clusters to unbind (string of clusters separated by ","). |
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
BatteryLevelState |
ContinuousState | cluster:1 | |
CODetectionState |
DiscreteState | detected, notDetected | cluster:1280 |
DiscreteRSSILevelState |
DiscreteState | good, low, normal, verylow | |
FirmwareRevisionState |
DataState | ||
LinkQualityIndicatorState |
ContinuousState | ||
LowBatteryThresholdState |
ContinuousState | cluster:1 | |
ManufacturerNameState |
DataState | cluster:0 | |
PowerSourceState |
DiscreteState | Unknown, Mains (single phase), Mains (3 phase), Battery, DC source, Emergency mains constantly powered, Emergency mains and transfer switch | cluster:0 |
ProductModelNameState |
DataState | cluster:0 | |
RSSILevelState |
ContinuousState | ||
StatusState |
DiscreteState | available, unavailable | |
ZigbeeUpdateDownloadProgressState |
ContinuousState | ||
ZigbeeUpdateState |
DiscreteState | idle, running, error-timeout, error-default-initial-condition, error-on-upgrade, success, error-abort, error-not-authorized, error-invalid-image, error-wait-for-data, error-no-image-available, error-malformed-command, error-require-more-image |
HeatingSystem/ThermostatSetPoint (ACTUATOR) — 13 commands, 19 states
Type IDs: 2199023452416 | Servers: atlantic_cozytouch, rexel, somfy_europe | Controllable: zigbee:ThermostatHeatingComponent | Profiles: StatefulThermostatWithSensor, StatefulThermostat, Thermostat
Data Properties
core:identifyInterval=500
Commands
| Command | Parameters | Notes |
|---|---|---|
addLockLevel |
INT; INT (optional) | Add a command lock level on the device p1 : The lock level to add p2 : (optional) Duration in second of the lock Level. By default there is no expiration.; cluster:0 |
advancedRefresh |
STRING: normal, advanced | Refresh extra states; cluster:0; cluster:513 |
bind |
STRING; STRING | Bind a device with another device. First parameter is target device address. Second parameter is list of clusters to bind (string of clusters separated by ","). |
identify |
Ask the device to identify itself by doing a slight movement or blink or beep; cluster:3 | |
ping |
Check if device is available; cluster:3 | |
raiseLowerTargetTemperature |
FLOAT [-10.0..10.0] | p1: amount The final temperature (actual + amount) must be included in the min/max range of temperature defined for this product.; cluster:513; cluster:513 |
removeLockLevel |
INT | Remove the command lock level on the device p1 : The lock level to remove; cluster:0 |
resetLockLevels |
Remove all lock levels on the device; cluster:0 | |
setControlSequenceOfThermostatOperation |
STRING: coolingOnly, coolingWithReheat, heatingOnly, heatingWithReheat, coolingHeating | Set the overall operating environment of the thermostat, and thus, the possible system modes that the thermostat can operate in.; cluster:513 |
setTargetTemperature |
FLOAT [5.0..35.0] | Set the new air temperature to reach; cluster:513 |
setThermostatMode |
STRING: off, auto, cool, heat, emergencyHeating | Set the current operating mode of the thermostat; cluster:513 |
stopIdentify |
Ask the device to stop winking immediately; cluster:3 | |
unbind |
STRING; STRING | Unbind a device with another device. First parameter is target device address. Second parameter is list of clusters to unbind (string of clusters separated by ","). |
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
AvailableModesState |
DataState | cluster:513 | |
CommandLockLevelsState |
DataState | ||
ControlSequenceOfThermostatOperationState |
DiscreteState | coolingOnly, coolingWithReheat, heatingOnly, heatingWithReheat, coolingHeating, coolingHeatingWithReheat | cluster:513 |
DiscreteRSSILevelState |
DiscreteState | good, low, normal, verylow | |
FirmwareRevisionState |
DataState | ||
LinkQualityIndicatorState |
ContinuousState | ||
ManufacturerNameState |
DataState | cluster:0 | |
PowerSourceState |
DiscreteState | Unknown, Mains (single phase), Mains (3 phase), Battery, DC source, Emergency mains constantly powered, Emergency mains and transfer switch | cluster:0 |
ProductModelNameState |
DataState | cluster:0 | |
RSSILevelState |
ContinuousState | ||
RoomTemperatureState |
ContinuousState | cluster:513 | |
StatusState |
DiscreteState | available, unavailable | |
TargetTemperatureCurrentLowerBoundState |
ContinuousState | cluster:513 | |
TargetTemperatureCurrentUpperBoundState |
ContinuousState | cluster:513 | |
TargetTemperatureState |
ContinuousState | [12.0..30.0] | cluster:513 |
TemperatureState |
ContinuousState | [-100.0..100.0] | cluster:513 |
ThermostatModeState |
DiscreteState | off, auto, cool, heat, emergencyHeating, precooling, fanOnly, dry, sleep | cluster:513 |
ZigbeeUpdateDownloadProgressState |
ContinuousState | ||
ZigbeeUpdateState |
DiscreteState | idle, running, error-timeout, error-default-initial-condition, error-on-upgrade, success, error-abort, error-not-authorized, error-invalid-image, error-wait-for-data, error-no-image-available, error-malformed-command, error-require-more-image |
HeatingSystem/ThermostatSetPoint (ACTUATOR) — 14 commands, 20 states
Type IDs: 2199023452417 | Servers: atlantic_cozytouch, rexel, somfy_europe | Controllable: zigbee:ThermostatCoolingComponent | Profiles: StatefulCoolingThermostatWithSensor, StatefulCoolingThermostat, CoolingThermostat
Data Properties
core:identifyInterval=500
Commands
| Command | Parameters | Notes |
|---|---|---|
addLockLevel |
INT; INT (optional) | Add a command lock level on the device p1 : The lock level to add p2 : (optional) Duration in second of the lock Level. By default there is no expiration.; cluster:0 |
advancedRefresh |
STRING: normal, advanced | Refresh extra states; cluster:0; cluster:513 |
bind |
STRING; STRING | Bind a device with another device. First parameter is target device address. Second parameter is list of clusters to bind (string of clusters separated by ","). |
identify |
Ask the device to identify itself by doing a slight movement or blink or beep; cluster:3 | |
ping |
Check if device is available; cluster:3 | |
raiseLowerTargetTemperature |
FLOAT [-10.0..10.0] | p1: amount The final temperature (actual + amount) must be included in the min/max range of temperature defined for this product.; cluster:513; cluster:513 |
removeLockLevel |
INT | Remove the command lock level on the device p1 : The lock level to remove; cluster:0 |
resetLockLevels |
Remove all lock levels on the device; cluster:0 | |
setControlSequenceOfThermostatOperation |
STRING: coolingOnly, coolingWithReheat, heatingOnly, heatingWithReheat, coolingHeating | Set the overall operating environment of the thermostat, and thus, the possible system modes that the thermostat can operate in.; cluster:513 |
setCoolingTargetTemperature |
FLOAT [5.0..35.0] | Set the cooling target temperature (manual set point); cluster:513 |
setTargetTemperature |
FLOAT [5.0..35.0] | Set the new air temperature to reach; cluster:513 |
setThermostatMode |
STRING: off, auto, cool, heat, emergencyHeating | Set the current operating mode of the thermostat; cluster:513 |
stopIdentify |
Ask the device to stop winking immediately; cluster:3 | |
unbind |
STRING; STRING | Unbind a device with another device. First parameter is target device address. Second parameter is list of clusters to unbind (string of clusters separated by ","). |
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
AvailableModesState |
DataState | cluster:513 | |
CommandLockLevelsState |
DataState | ||
ControlSequenceOfThermostatOperationState |
DiscreteState | coolingOnly, coolingWithReheat, heatingOnly, heatingWithReheat, coolingHeating, coolingHeatingWithReheat | cluster:513 |
CoolingTargetTemperatureState |
ContinuousState | [12.0..30.0] | cluster:513 |
DiscreteRSSILevelState |
DiscreteState | good, low, normal, verylow | |
FirmwareRevisionState |
DataState | ||
LinkQualityIndicatorState |
ContinuousState | ||
ManufacturerNameState |
DataState | cluster:0 | |
PowerSourceState |
DiscreteState | Unknown, Mains (single phase), Mains (3 phase), Battery, DC source, Emergency mains constantly powered, Emergency mains and transfer switch | cluster:0 |
ProductModelNameState |
DataState | cluster:0 | |
RSSILevelState |
ContinuousState | ||
RoomTemperatureState |
ContinuousState | cluster:513 | |
StatusState |
DiscreteState | available, unavailable | |
TargetTemperatureCurrentLowerBoundState |
ContinuousState | cluster:513 | |
TargetTemperatureCurrentUpperBoundState |
ContinuousState | cluster:513 | |
TargetTemperatureState |
ContinuousState | [12.0..30.0] | cluster:513 |
TemperatureState |
ContinuousState | [-100.0..100.0] | cluster:513 |
ThermostatModeState |
DiscreteState | off, auto, cool, heat, emergencyHeating, precooling, fanOnly, dry, sleep | cluster:513 |
ZigbeeUpdateDownloadProgressState |
ContinuousState | ||
ZigbeeUpdateState |
DiscreteState | idle, running, error-timeout, error-default-initial-condition, error-on-upgrade, success, error-abort, error-not-authorized, error-invalid-image, error-wait-for-data, error-no-image-available, error-malformed-command, error-require-more-image |
HeatingSystem/ThermostatSetPoint (ACTUATOR) — 14 commands, 22 states
Type IDs: 2199023452418 | Servers: atlantic_cozytouch, rexel, somfy_europe | Controllable: zigbee:ThermostatHeatingAndCoolingComponent | Profiles: StatefulDualThermostatWithSensor, StatefulDualThermostat, DualThermostat
Data Properties
core:identifyInterval=500
Commands
| Command | Parameters | Notes |
|---|---|---|
addLockLevel |
INT; INT (optional) | Add a command lock level on the device p1 : The lock level to add p2 : (optional) Duration in second of the lock Level. By default there is no expiration.; cluster:0 |
advancedRefresh |
STRING: normal, advanced | Refresh extra states; cluster:0; cluster:513 |
bind |
STRING; STRING | Bind a device with another device. First parameter is target device address. Second parameter is list of clusters to bind (string of clusters separated by ","). |
identify |
Ask the device to identify itself by doing a slight movement or blink or beep; cluster:3 | |
ping |
Check if device is available; cluster:3 | |
raiseLowerTargetTemperature |
STRING: heat, cool, both; FLOAT [-10.0..10.0] | p1: heat => adjust heat setpoint cool => adjust cool setpoint both => adjust heat setpoint and cool setpoint p2: amount The final temperature (actual + amount) must be included in the min/max range of temperature defined for this product.; cluster:513; cluster:513 |
removeLockLevel |
INT | Remove the command lock level on the device p1 : The lock level to remove; cluster:0 |
resetLockLevels |
Remove all lock levels on the device; cluster:0 | |
setControlSequenceOfThermostatOperation |
STRING: coolingOnly, coolingWithReheat, heatingOnly, heatingWithReheat, coolingHeating | Set the overall operating environment of the thermostat, and thus, the possible system modes that the thermostat can operate in.; cluster:513 |
setCoolingTargetTemperature |
FLOAT [5.0..35.0] | Set the cooling target temperature (manual set point); cluster:513 |
setHeatingTargetTemperature |
FLOAT [5.0..35.0] | Set the heating target temperature (manual set point); cluster:513 |
setThermostatMode |
STRING: off, auto, cool, heat, emergencyHeating | Set the current operating mode of the thermostat; cluster:513 |
stopIdentify |
Ask the device to stop winking immediately; cluster:3 | |
unbind |
STRING; STRING | Unbind a device with another device. First parameter is target device address. Second parameter is list of clusters to unbind (string of clusters separated by ","). |
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
AvailableModesState |
DataState | cluster:513 | |
CommandLockLevelsState |
DataState | ||
ControlSequenceOfThermostatOperationState |
DiscreteState | coolingOnly, coolingWithReheat, heatingOnly, heatingWithReheat, coolingHeating, coolingHeatingWithReheat | cluster:513 |
CoolingTargetTemperatureCurrentLowerBoundState |
ContinuousState | cluster:513 | |
CoolingTargetTemperatureCurrentUpperBoundState |
ContinuousState | cluster:513 | |
CoolingTargetTemperatureState |
ContinuousState | [12.0..30.0] | cluster:513 |
DiscreteRSSILevelState |
DiscreteState | good, low, normal, verylow | |
FirmwareRevisionState |
DataState | ||
HeatingTargetTemperatureCurrentLowerBoundState |
ContinuousState | cluster:513 | |
HeatingTargetTemperatureCurrentUpperBoundState |
ContinuousState | cluster:513 | |
HeatingTargetTemperatureState |
ContinuousState | [12.0..30.0] | cluster:513 |
LinkQualityIndicatorState |
ContinuousState | ||
ManufacturerNameState |
DataState | cluster:0 | |
PowerSourceState |
DiscreteState | Unknown, Mains (single phase), Mains (3 phase), Battery, DC source, Emergency mains constantly powered, Emergency mains and transfer switch | cluster:0 |
ProductModelNameState |
DataState | cluster:0 | |
RSSILevelState |
ContinuousState | ||
RoomTemperatureState |
ContinuousState | cluster:513 | |
StatusState |
DiscreteState | available, unavailable | |
TemperatureState |
ContinuousState | [-100.0..100.0] | cluster:513 |
ThermostatModeState |
DiscreteState | off, auto, cool, heat, emergencyHeating, precooling, fanOnly, dry, sleep | cluster:513 |
ZigbeeUpdateDownloadProgressState |
ContinuousState | ||
ZigbeeUpdateState |
DiscreteState | idle, running, error-timeout, error-default-initial-condition, error-on-upgrade, success, error-abort, error-not-authorized, error-invalid-image, error-wait-for-data, error-no-image-available, error-malformed-command, error-require-more-image |
HeatingSystem/ThermostatSetPoint (ACTUATOR) — 19 commands, 29 states
Type IDs: 2277859590432 | Servers: atlantic_cozytouch, rexel, somfy_europe | Controllable: zigbee:AtlanticCesaV2HeatingAndCoolingZoneComponent | Profiles: StatefulDualThermostatWithSensor, StatefulDualThermostat, DualThermostat
Data Properties
core:identifyInterval=500
Commands
| Command | Parameters | Notes |
|---|---|---|
addLockLevel |
INT; INT (optional) | Add a command lock level on the device p1 : The lock level to add p2 : (optional) Duration in second of the lock Level. By default there is no expiration.; cluster:0 |
advancedRefresh |
STRING: normal, advanced | Refresh extra states; cluster:0; cluster:513 |
autoBind |
Ask the device to do an automatic binding with other compatible devices of the setup. Mostly manufacturer dependant and private procedures.; cluster:513 | |
bind |
STRING; STRING | Bind a device with another device. First parameter is target device address. Second parameter is list of clusters to bind (string of clusters separated by ","). |
identify |
Ask the device to identify itself by doing a slight movement or blink or beep; cluster:3 | |
ping |
Check if device is available; cluster:3 | |
raiseLowerTargetTemperature |
STRING: heat, cool, both; FLOAT [-10.0..10.0] | p1: heat => adjust heat setpoint cool => adjust cool setpoint both => adjust heat setpoint and cool setpoint p2: amount The final temperature (actual + amount) must be included in the min/max range of temperature defined for this product.; cluster:513; cluster:513 |
removeLockLevel |
INT | Remove the command lock level on the device p1 : The lock level to remove; cluster:0 |
resetLockLevels |
Remove all lock levels on the device; cluster:0 | |
setControlSequenceOfThermostatOperation |
STRING: coolingOnly, coolingWithReheat, heatingOnly, heatingWithReheat, coolingHeating | Set the overall operating environment of the thermostat, and thus, the possible system modes that the thermostat can operate in.; cluster:513 |
setCoolingTargetTemperature |
FLOAT [5.0..35.0] | Set the cooling target temperature (manual set point); cluster:513 |
setDerogationOnOffState |
STRING: on, off | Switch on or switch off the derogation mode; cluster:513 |
setDerogationTime |
INT [0..1440] | Defines the duration of derogation mode; cluster:513 |
setHeatingTargetTemperature |
FLOAT [5.0..35.0] | Set the heating target temperature (manual set point); cluster:513 |
setInternalSchedulingOnOffState |
STRING: on, off | Enable or disable device internal scheduling program; cluster:513 |
setThermostatMode |
STRING: off, auto, cool, heat, emergencyHeating | Set the current operating mode of the thermostat; cluster:513 |
stopAutoBind |
Ask the device to stop automatic binding with other compatible devices of the setup.; cluster:513 | |
stopIdentify |
Ask the device to stop winking immediately; cluster:3 | |
unbind |
STRING; STRING | Unbind a device with another device. First parameter is target device address. Second parameter is list of clusters to unbind (string of clusters separated by ","). |
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
AutoBindingState |
DataState | cluster:513 | |
AvailableModesState |
DataState | cluster:513 | |
CommandLockLevelsState |
DataState | ||
ControlSequenceOfThermostatOperationState |
DiscreteState | coolingOnly, coolingWithReheat, heatingOnly, heatingWithReheat, coolingHeating, coolingHeatingWithReheat | cluster:513 |
CoolingTargetTemperatureCurrentLowerBoundState |
ContinuousState | cluster:513 | |
CoolingTargetTemperatureCurrentUpperBoundState |
ContinuousState | cluster:513 | |
CoolingTargetTemperatureState |
ContinuousState | [12.0..30.0] | cluster:513 |
DerogationOnOffState |
DiscreteState | off, on | cluster:513 |
DerogationTimeState |
DataState | cluster:513 | |
DiscreteRSSILevelState |
DiscreteState | good, low, normal, verylow | |
FirmwareRevisionState |
DataState | ||
HeatingTargetTemperatureCurrentLowerBoundState |
ContinuousState | cluster:513 | |
HeatingTargetTemperatureCurrentUpperBoundState |
ContinuousState | cluster:513 | |
HeatingTargetTemperatureState |
ContinuousState | [12.0..30.0] | cluster:513 |
HolidayModeConfiguredState |
DataState | cluster:513 | |
HolidaysModeState |
DiscreteState | off, on | cluster:513 |
InternalSchedulingOnOffState |
DiscreteState | on, off | cluster:513 |
LinkQualityIndicatorState |
ContinuousState | ||
ManufacturerNameState |
DataState | cluster:0 | |
PowerSourceState |
DiscreteState | Unknown, Mains (single phase), Mains (3 phase), Battery, DC source, Emergency mains constantly powered, Emergency mains and transfer switch | cluster:0 |
ProductModelNameState |
DataState | cluster:0 | |
RSSILevelState |
ContinuousState | ||
RemainingDerogationTimeState |
DataState | cluster:513 | |
RoomTemperatureState |
ContinuousState | cluster:513 | |
StatusState |
DiscreteState | available, unavailable | |
TemperatureState |
ContinuousState | [-100.0..100.0] | cluster:513 |
ThermostatModeState |
DiscreteState | off, auto, cool, heat, emergencyHeating, precooling, fanOnly, dry, sleep | cluster:513 |
ZigbeeUpdateDownloadProgressState |
ContinuousState | ||
ZigbeeUpdateState |
DiscreteState | idle, running, error-timeout, error-default-initial-condition, error-on-upgrade, success, error-abort, error-not-authorized, error-invalid-image, error-wait-for-data, error-no-image-available, error-malformed-command, error-require-more-image |
HeatingSystem/ThermostatDualModeAndFan (ACTUATOR) — 18 commands, 25 states
Type IDs: 2277859590418 | Servers: atlantic_cozytouch, rexel, somfy_europe | Controllable: zigbee:ThermostatAndFanComponent | Profiles: StatefulDualThermostatWithSensor, StatefulDualThermostat, DualThermostat
Data Properties
core:identifyInterval=500
Commands
| Command | Parameters | Notes |
|---|---|---|
addLockLevel |
INT; INT (optional) | Add a command lock level on the device p1 : The lock level to add p2 : (optional) Duration in second of the lock Level. By default there is no expiration.; cluster:0 |
advancedRefresh |
STRING: normal, advanced | Refresh extra states; cluster:0; cluster:513 |
bind |
STRING; STRING | Bind a device with another device. First parameter is target device address. Second parameter is list of clusters to bind (string of clusters separated by ","). |
identify |
Ask the device to identify itself by doing a slight movement or blink or beep; cluster:3 | |
ping |
Check if device is available; cluster:3 | |
raiseLowerTargetTemperature |
STRING: heat, cool, both; FLOAT [-10.0..10.0] | p1: heat => adjust heat setpoint cool => adjust cool setpoint both => adjust heat setpoint and cool setpoint p2: amount The final temperature (actual + amount) must be included in the min/max range of temperature defined for this product.; cluster:513; cluster:513 |
removeLockLevel |
INT | Remove the command lock level on the device p1 : The lock level to remove; cluster:0 |
resetLockLevels |
Remove all lock levels on the device; cluster:0 | |
setACLouverPosition |
STRING: fullyClosed, fullyOpen, quarterOpen, halfOpen, threeQuartersOpen | Specify the AC louver position; cluster:513 |
setControlSequenceOfThermostatOperation |
STRING: coolingOnly, coolingWithReheat, heatingOnly, heatingWithReheat, coolingHeating | Set the overall operating environment of the thermostat, and thus, the possible system modes that the thermostat can operate in.; cluster:513 |
setCoolingTargetTemperature |
FLOAT [5.0..35.0] | Set the cooling target temperature (manual set point); cluster:513 |
setEconomyEnergyStarMode |
STRING: enable, disable | Specify the economy/energyStar mode; cluster:513 |
setFanMode |
STRING: off, low, medium, high, on | Specify the mode of fan; cluster:514 |
setHeatingTargetTemperature |
FLOAT [5.0..35.0] | Set the heating target temperature (manual set point); cluster:513 |
setThermostatMode |
STRING: off, auto, cool, heat, fanOnly | Set the current operating mode of the thermostat; cluster:513 |
setThermostatProgrammingOperationMode |
STRING: setpoint, schedule; STRING: enable, disable; STRING: enable, disable | Set the operational state of the thermostat's programming p1: schedule => enable any programmed weekly schedule configurations setpoint => thermostat setopint is altered only by manual changes, not by internal schedule programming p2: status of the auto/recovery mode p3: status of the economy/energyStar mode; cluster:513 |
stopIdentify |
Ask the device to stop winking immediately; cluster:3 | |
unbind |
STRING; STRING | Unbind a device with another device. First parameter is target device address. Second parameter is list of clusters to unbind (string of clusters separated by ","). |
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
ACLouverPositionState |
DiscreteState | fully closed, fully open, quarter open, half open, three quarters open | cluster:513 |
AvailableModesState |
DataState | cluster:513 | |
CommandLockLevelsState |
DataState | ||
ControlSequenceOfThermostatOperationState |
DiscreteState | coolingOnly, coolingWithReheat, heatingOnly, heatingWithReheat, coolingHeating, coolingHeatingWithReheat | cluster:513 |
CoolingTargetTemperatureCurrentLowerBoundState |
ContinuousState | cluster:513 | |
CoolingTargetTemperatureCurrentUpperBoundState |
ContinuousState | cluster:513 | |
CoolingTargetTemperatureState |
ContinuousState | [12.0..30.0] | cluster:513 |
DiscreteRSSILevelState |
DiscreteState | good, low, normal, verylow | |
EconomyEnergyStarModeEnabledState |
DiscreteState | enable, disable | cluster:513 |
FanModeSequenceState |
DiscreteState | low/medium/high, low/high, low/medium/high/auto, low/high/auto, on/auto | cluster:514 |
FanSpeedModeState |
DiscreteState | off, low, medium, high, on | cluster:514 |
FirmwareRevisionState |
DataState | ||
HeatingTargetTemperatureCurrentLowerBoundState |
ContinuousState | cluster:513 | |
HeatingTargetTemperatureCurrentUpperBoundState |
ContinuousState | cluster:513 | |
HeatingTargetTemperatureState |
ContinuousState | [12.0..30.0] | cluster:513 |
LinkQualityIndicatorState |
ContinuousState | ||
ManufacturerNameState |
DataState | cluster:0 | |
PowerSourceState |
DiscreteState | Unknown, Mains (single phase), Mains (3 phase), Battery, DC source, Emergency mains constantly powered, Emergency mains and transfer switch | cluster:0 |
ProductModelNameState |
DataState | cluster:0 | |
RSSILevelState |
ContinuousState | ||
StatusState |
DiscreteState | available, unavailable | |
TemperatureState |
ContinuousState | [-100.0..100.0] | cluster:513 |
ThermostatModeState |
DiscreteState | off, auto, cool, heat, emergencyHeating, precooling, fanOnly, dry, sleep | cluster:513 |
ZigbeeUpdateDownloadProgressState |
ContinuousState | ||
ZigbeeUpdateState |
DiscreteState | idle, running, error-timeout, error-default-initial-condition, error-on-upgrade, success, error-abort, error-not-authorized, error-invalid-image, error-wait-for-data, error-no-image-available, error-malformed-command, error-require-more-image |
HeatingSystem/ElectricalHeater (ACTUATOR) — 15 commands, 13 states
Type IDs: 2278664720658, 2269319811346 | Servers: atlantic_cozytouch, rexel, somfy_europe | Controllable: zigbee:WirePilotComponent | Profiles: StatefulSwitchablePlug, StatefulSwitchable, Switchable
Data Properties
core:identifyInterval=500
Commands
| Command | Parameters | Notes |
|---|---|---|
addLockLevel |
INT; INT (optional) | Add a command lock level on the device p1 : The lock level to add p2 : (optional) Duration in second of the lock Level. By default there is no expiration.; cluster:0 |
advancedRefresh |
STRING: normal, advanced | Refresh extra states; cluster:0 |
bind |
STRING; STRING | Bind a device with another device. First parameter is target device address. Second parameter is list of clusters to bind (string of clusters separated by ","). |
identify |
Ask the device to identify itself by doing a slight movement or blink or beep; cluster:3 | |
off |
Turn off the device | |
on |
Turn on the device | |
onWithTimer |
INT [5..14400] | Turn the device on for a given amount of seconds then turn it off; cluster:64512 |
ping |
Check if device is available; cluster:3 | |
removeLockLevel |
INT | Remove the command lock level on the device p1 : The lock level to remove; cluster:0 |
resetLockLevels |
Remove all lock levels on the device; cluster:0 | |
setMode |
STRING: comfort, eco, antifrost, comfort-1, comfort-2 | Set the active mode.; cluster:64512 |
setOnOff |
STRING: off, on | Turn the device on or off; cluster:64512 |
stopIdentify |
Ask the device to stop winking immediately; cluster:3 | |
toggle |
Toggle on/off status; cluster:64512 | |
unbind |
STRING; STRING | Unbind a device with another device. First parameter is target device address. Second parameter is list of clusters to unbind (string of clusters separated by ","). |
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
CommandLockLevelsState |
DataState | ||
DiscreteRSSILevelState |
DiscreteState | good, low, normal, verylow | |
FirmwareRevisionState |
DataState | ||
LinkQualityIndicatorState |
ContinuousState | ||
ManufacturerNameState |
DataState | cluster:0 | |
ModeState |
DataState | cluster:64512 | |
OnOffState |
DiscreteState | on, off | cluster:64512 |
PowerSourceState |
DiscreteState | Unknown, Mains (single phase), Mains (3 phase), Battery, DC source, Emergency mains constantly powered, Emergency mains and transfer switch | cluster:0 |
ProductModelNameState |
DataState | cluster:0 | |
RSSILevelState |
ContinuousState | ||
StatusState |
DiscreteState | available, unavailable | |
ZigbeeUpdateDownloadProgressState |
ContinuousState | ||
ZigbeeUpdateState |
DiscreteState | idle, running, error-timeout, error-default-initial-condition, error-on-upgrade, success, error-abort, error-not-authorized, error-invalid-image, error-wait-for-data, error-no-image-available, error-malformed-command, error-require-more-image |
HeatingSystem/ElectricalHeater (ACTUATOR) — 15 commands, 13 states
Type IDs: 2270846517760 | Servers: atlantic_cozytouch, rexel, somfy_europe | Controllable: zigbee:CleodeZPilotComponent | Profiles: SwitchableHeating, StatefulSwitchable, Switchable
Data Properties
core:identifyInterval=500
Commands
| Command | Parameters | Notes |
|---|---|---|
addLockLevel |
INT; INT (optional) | Add a command lock level on the device p1 : The lock level to add p2 : (optional) Duration in second of the lock Level. By default there is no expiration.; cluster:0 |
advancedRefresh |
STRING: normal, advanced | Refresh extra states; cluster:0 |
bind |
STRING; STRING | Bind a device with another device. First parameter is target device address. Second parameter is list of clusters to bind (string of clusters separated by ","). |
identify |
Ask the device to identify itself by doing a slight movement or blink or beep; cluster:3 | |
off |
Turn off the device; cluster:6 | |
on |
Turn on the device; cluster:6 | |
onWithTimer |
INT [5..14400] | Turn the device on for a given amount of seconds then turn it off; cluster:6 |
ping |
Check if device is available; cluster:3 | |
removeLockLevel |
INT | Remove the command lock level on the device p1 : The lock level to remove; cluster:0 |
resetLockLevels |
Remove all lock levels on the device; cluster:0 | |
setHeatingMode |
STRING: comfort, comfort-1, comfort-2, eco, frostprotection | Set the device heating mode; cluster:64513 |
setOnOff |
STRING: off, on | Turn the device on or off; cluster:6 |
stopIdentify |
Ask the device to stop winking immediately; cluster:3 | |
toggle |
Toggle on/off status; cluster:6 | |
unbind |
STRING; STRING | Unbind a device with another device. First parameter is target device address. Second parameter is list of clusters to unbind (string of clusters separated by ","). |
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
CleodeHeatingModeState |
DiscreteState | comfort, comfort-1, comfort-2, eco, frostprotection, offloading | cluster:64513 |
CommandLockLevelsState |
DataState | ||
DiscreteRSSILevelState |
DiscreteState | good, low, normal, verylow | |
FirmwareRevisionState |
DataState | ||
LinkQualityIndicatorState |
ContinuousState | ||
ManufacturerNameState |
DataState | cluster:0 | |
OnOffState |
DiscreteState | on, off | cluster:6 |
PowerSourceState |
DiscreteState | Unknown, Mains (single phase), Mains (3 phase), Battery, DC source, Emergency mains constantly powered, Emergency mains and transfer switch | cluster:0 |
ProductModelNameState |
DataState | cluster:0 | |
RSSILevelState |
ContinuousState | ||
StatusState |
DiscreteState | available, unavailable | |
ZigbeeUpdateDownloadProgressState |
ContinuousState | ||
ZigbeeUpdateState |
DiscreteState | idle, running, error-timeout, error-default-initial-condition, error-on-upgrade, success, error-abort, error-not-authorized, error-invalid-image, error-wait-for-data, error-no-image-available, error-malformed-command, error-require-more-image |
HumiditySensor/RelativeHumiditySensor (SENSOR) — 6 commands, 16 states
Type IDs: 2199023452673, 2269319987712 | Servers: atlantic_cozytouch, rexel, somfy_europe | Controllable: zigbee:RelativeHumidityComponent | Profiles: RelativeHumidity
Data Properties
core:identifyInterval=500
Commands
| Command | Parameters | Notes |
|---|---|---|
advancedRefresh |
STRING: normal, advanced | Refresh extra states; cluster:0 |
bind |
STRING; STRING | Bind a device with another device. First parameter is target device address. Second parameter is list of clusters to bind (string of clusters separated by ","). |
identify |
Ask the device to identify itself by doing a slight movement or blink or beep; cluster:3 | |
ping |
Check if device is available; cluster:3 | |
stopIdentify |
Ask the device to stop winking immediately; cluster:3 | |
unbind |
STRING; STRING | Unbind a device with another device. First parameter is target device address. Second parameter is list of clusters to unbind (string of clusters separated by ","). |
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
BatteryLevelState |
ContinuousState | cluster:1 | |
DiscreteRSSILevelState |
DiscreteState | good, low, normal, verylow | |
FirmwareRevisionState |
DataState | ||
LinkQualityIndicatorState |
ContinuousState | ||
LowBatteryThresholdState |
ContinuousState | cluster:1 | |
ManufacturerNameState |
DataState | cluster:0 | |
MaxMeasuredValueState |
DataState | cluster:1029 | |
MinMeasuredValueState |
DataState | cluster:1029 | |
PowerSourceState |
DiscreteState | Unknown, Mains (single phase), Mains (3 phase), Battery, DC source, Emergency mains constantly powered, Emergency mains and transfer switch | cluster:0 |
ProductModelNameState |
DataState | cluster:0 | |
RSSILevelState |
ContinuousState | ||
RelativeHumidityState |
ContinuousState | [0.0..100.0] | cluster:1029 |
StatusState |
DiscreteState | available, unavailable | |
ToleranceState |
DataState | cluster:1029 | |
ZigbeeUpdateDownloadProgressState |
ContinuousState | ||
ZigbeeUpdateState |
DiscreteState | idle, running, error-timeout, error-default-initial-condition, error-on-upgrade, success, error-abort, error-not-authorized, error-invalid-image, error-wait-for-data, error-no-image-available, error-malformed-command, error-require-more-image |
Light/StatefulOnOffLight (ACTUATOR) — 14 commands, 12 states
Type IDs: 2199023321088, 2199023321089, 2268296445952 | Servers: atlantic_cozytouch, rexel, somfy_europe | Controllable: zigbee:OnOffLightComponent | Profiles: StatefulSwitchableLight, StatefulSwitchable, Switchable
Data Properties
core:identifyInterval=500core:useControllableForGroup=zigbee:GroupOnOffLightComponent
Commands
| Command | Parameters | Notes |
|---|---|---|
addLockLevel |
INT; INT (optional) | Add a command lock level on the device p1 : The lock level to add p2 : (optional) Duration in second of the lock Level. By default there is no expiration.; cluster:0 |
advancedRefresh |
STRING: normal, advanced | Refresh extra states; cluster:0 |
bind |
STRING; STRING | Bind a device with another device. First parameter is target device address. Second parameter is list of clusters to bind (string of clusters separated by ","). |
identify |
Ask the device to identify itself by doing a slight movement or blink or beep; cluster:3 | |
off |
Turn off the device; cluster:6 | |
on |
Turn on the device; cluster:6 | |
onWithTimer |
INT [5..14400] | Turn the device on for a given amount of seconds then turn it off; cluster:6 |
ping |
Check if device is available; cluster:3 | |
removeLockLevel |
INT | Remove the command lock level on the device p1 : The lock level to remove; cluster:0 |
resetLockLevels |
Remove all lock levels on the device; cluster:0 | |
setOnOff |
STRING: off, on | Turn the device on or off; cluster:6 |
stopIdentify |
Ask the device to stop winking immediately; cluster:3 | |
toggle |
Toggle on/off status; cluster:6 | |
unbind |
STRING; STRING | Unbind a device with another device. First parameter is target device address. Second parameter is list of clusters to unbind (string of clusters separated by ","). |
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
CommandLockLevelsState |
DataState | ||
DiscreteRSSILevelState |
DiscreteState | good, low, normal, verylow | |
FirmwareRevisionState |
DataState | ||
LinkQualityIndicatorState |
ContinuousState | ||
ManufacturerNameState |
DataState | cluster:0 | |
OnOffState |
DiscreteState | on, off | cluster:6 |
PowerSourceState |
DiscreteState | Unknown, Mains (single phase), Mains (3 phase), Battery, DC source, Emergency mains constantly powered, Emergency mains and transfer switch | cluster:0 |
ProductModelNameState |
DataState | cluster:0 | |
RSSILevelState |
ContinuousState | ||
StatusState |
DiscreteState | available, unavailable | |
ZigbeeUpdateDownloadProgressState |
ContinuousState | ||
ZigbeeUpdateState |
DiscreteState | idle, running, error-timeout, error-default-initial-condition, error-on-upgrade, success, error-abort, error-not-authorized, error-invalid-image, error-wait-for-data, error-no-image-available, error-malformed-command, error-require-more-image |
Light/DimmerLight (ACTUATOR) — 16 commands, 13 states
Type IDs: 2199023321344, 2199023321345 | Servers: atlantic_cozytouch, rexel, somfy_europe | Controllable: zigbee:LightComponent | Profiles: StatefulLightDimmer, StatefulDimmable, StatefulSwitchable, Dimmable, Switchable
Data Properties
core:identifyInterval=500core:useControllableForGroup=zigbee:GroupLightComponent
Commands
| Command | Parameters | Notes |
|---|---|---|
addLockLevel |
INT; INT (optional) | Add a command lock level on the device p1 : The lock level to add p2 : (optional) Duration in second of the lock Level. By default there is no expiration.; cluster:0 |
advancedRefresh |
STRING: normal, advanced | Refresh extra states; cluster:0 |
bind |
STRING; STRING | Bind a device with another device. First parameter is target device address. Second parameter is list of clusters to bind (string of clusters separated by ","). |
identify |
Ask the device to identify itself by doing a slight movement or blink or beep; cluster:3 | |
off |
Turn off the device; cluster:6 | |
on |
Turn on the device; cluster:6 | |
onWithTimer |
INT [5..14400] | Turn the device on for a given amount of seconds then turn it off; cluster:6 |
ping |
Check if device is available; cluster:3 | |
removeLockLevel |
INT | Remove the command lock level on the device p1 : The lock level to remove; cluster:0 |
resetLockLevels |
Remove all lock levels on the device; cluster:0 | |
setIntensity |
INT [0..100] | Light intensity level (100%=maximum intensity, 0%=off); cluster:8 |
setIntensityWithTimer |
INT [0..100]; INT [5..14400]; INT [0..100] (optional) | Set the light intensity to p1% then after p2 seconds, set it to p3%. (If p3 is not specified the light is turned off after the delay); cluster:8 |
setOnOff |
STRING: off, on | Turn the device on or off; cluster:6 |
stopIdentify |
Ask the device to stop winking immediately; cluster:3 | |
toggle |
Toggle on/off status; cluster:6 | |
unbind |
STRING; STRING | Unbind a device with another device. First parameter is target device address. Second parameter is list of clusters to unbind (string of clusters separated by ","). |
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
CommandLockLevelsState |
DataState | ||
DiscreteRSSILevelState |
DiscreteState | good, low, normal, verylow | |
FirmwareRevisionState |
DataState | ||
LightIntensityState |
ContinuousState | [0..100] | cluster:8 |
LinkQualityIndicatorState |
ContinuousState | ||
ManufacturerNameState |
DataState | cluster:0 | |
OnOffState |
DiscreteState | on, off | cluster:6 |
PowerSourceState |
DiscreteState | Unknown, Mains (single phase), Mains (3 phase), Battery, DC source, Emergency mains constantly powered, Emergency mains and transfer switch | cluster:0 |
ProductModelNameState |
DataState | cluster:0 | |
RSSILevelState |
ContinuousState | ||
StatusState |
DiscreteState | available, unavailable | |
ZigbeeUpdateDownloadProgressState |
ContinuousState | ||
ZigbeeUpdateState |
DiscreteState | idle, running, error-timeout, error-default-initial-condition, error-on-upgrade, success, error-abort, error-not-authorized, error-invalid-image, error-wait-for-data, error-no-image-available, error-malformed-command, error-require-more-image |
Light/DimmerHueSaturationLight (ACTUATOR) — 21 commands, 16 states
Type IDs: 2199023321600, 2199023321601, 2199023321603 | Servers: atlantic_cozytouch, rexel, somfy_europe | Controllable: zigbee:HueLightComponent | Profiles: StatefulLightDimmer, StatefulDimmable, StatefulSwitchable, Dimmable, Switchable
Data Properties
core:identifyInterval=500core:useControllableForGroup=zigbee:GroupHueLightComponent
Commands
| Command | Parameters | Notes |
|---|---|---|
addLockLevel |
INT; INT (optional) | Add a command lock level on the device p1 : The lock level to add p2 : (optional) Duration in second of the lock Level. By default there is no expiration.; cluster:0 |
advancedRefresh |
STRING: normal, advanced | Refresh extra states; cluster:0 |
bind |
STRING; STRING | Bind a device with another device. First parameter is target device address. Second parameter is list of clusters to bind (string of clusters separated by ","). |
identify |
Ask the device to identify itself by doing a slight movement or blink or beep; cluster:3 | |
off |
Turn off the device; cluster:6 | |
on |
Turn on the device; cluster:6 | |
onWithTimer |
INT [5..14400] | Turn the device on for a given amount of seconds then turn it off; cluster:6 |
ping |
Check if device is available; cluster:3 | |
removeLockLevel |
INT | Remove the command lock level on the device p1 : The lock level to remove; cluster:0 |
resetLockLevels |
Remove all lock levels on the device; cluster:0 | |
setHue |
INT [0..360] | Set the color hue (°) of the lamp; cluster:768 |
setHueAndSaturation |
INT [0..360]; INT [0..100] | Set the color hue (°) and color saturation(%) of the lamp |
setHueAndSaturationWithTransitionTime |
INT [0..360]; INT [0..100]; FLOAT [0.0..6553.5] | Set the color hue (°) and color saturation(%) of the lamp with a transition time.; cluster:768 |
setIntensity |
INT [0..100] | Light intensity level (100%=maximum intensity, 0%=off); cluster:8 |
setIntensityWithTimer |
INT [0..100]; INT [5..14400]; INT [0..100] (optional) | Set the light intensity to p1% then after p2 seconds, set it to p3%. (If p3 is not specified the light is turned off after the delay); cluster:8 |
setOnOff |
STRING: off, on | Turn the device on or off; cluster:6 |
setSaturation |
INT [0..100] | Set the color saturation (%) of the lamp; cluster:768 |
stopIdentify |
Ask the device to stop winking immediately; cluster:3 | |
stopMoveStepColor |
Allow Move to and Step commands to be stopped.; cluster:768 | |
toggle |
Toggle on/off status; cluster:6 | |
unbind |
STRING; STRING | Unbind a device with another device. First parameter is target device address. Second parameter is list of clusters to unbind (string of clusters separated by ","). |
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
ColorHueState |
ContinuousState | cluster:768 | |
ColorModeState |
DiscreteState | cieXYZ, hueAndStaturation, temperature, rgb | cluster:768 |
ColorSaturationState |
ContinuousState | cluster:768 | |
CommandLockLevelsState |
DataState | ||
DiscreteRSSILevelState |
DiscreteState | good, low, normal, verylow | |
FirmwareRevisionState |
DataState | ||
LightIntensityState |
ContinuousState | [0..100] | cluster:8 |
LinkQualityIndicatorState |
ContinuousState | ||
ManufacturerNameState |
DataState | cluster:0 | |
OnOffState |
DiscreteState | on, off | cluster:6 |
PowerSourceState |
DiscreteState | Unknown, Mains (single phase), Mains (3 phase), Battery, DC source, Emergency mains constantly powered, Emergency mains and transfer switch | cluster:0 |
ProductModelNameState |
DataState | cluster:0 | |
RSSILevelState |
ContinuousState | ||
StatusState |
DiscreteState | available, unavailable | |
ZigbeeUpdateDownloadProgressState |
ContinuousState | ||
ZigbeeUpdateState |
DiscreteState | idle, running, error-timeout, error-default-initial-condition, error-on-upgrade, success, error-abort, error-not-authorized, error-invalid-image, error-wait-for-data, error-no-image-available, error-malformed-command, error-require-more-image |
Light/DimmerHueSaturationLight (ACTUATOR) — 22 commands, 19 states
Type IDs: 2199023321607 | Servers: atlantic_cozytouch, rexel, somfy_europe | Controllable: zigbee:ColorLoopLightComponent | Profiles: StatefulLightDimmer, StatefulDimmable, StatefulSwitchable, Dimmable, Switchable
Data Properties
core:identifyInterval=500core:useControllableForGroup=zigbee:GroupColorLoopLightComponent
Commands
| Command | Parameters | Notes |
|---|---|---|
addLockLevel |
INT; INT (optional) | Add a command lock level on the device p1 : The lock level to add p2 : (optional) Duration in second of the lock Level. By default there is no expiration.; cluster:0 |
advancedRefresh |
STRING: normal, advanced | Refresh extra states; cluster:0 |
bind |
STRING; STRING | Bind a device with another device. First parameter is target device address. Second parameter is list of clusters to bind (string of clusters separated by ","). |
identify |
Ask the device to identify itself by doing a slight movement or blink or beep; cluster:3 | |
off |
Turn off the device; cluster:6 | |
on |
Turn on the device; cluster:6 | |
onWithTimer |
INT [5..14400] | Turn the device on for a given amount of seconds then turn it off; cluster:6 |
ping |
Check if device is available; cluster:3 | |
removeLockLevel |
INT | Remove the command lock level on the device p1 : The lock level to remove; cluster:0 |
resetLockLevels |
Remove all lock levels on the device; cluster:0 | |
setColorLoopWithTransitionTime |
STRING: deactivated, activatedStartFromColorLoopStartEnhancedHue, activatedStartFromEnhancedCurrentHue; STRING: decremented, incremented; FLOAT [0.0..6550.0]; INT [0..360] | The Color Loop Set command allows a color loop to be activated such that the color lamp cycles through its range of hues. p1 : specifies the action to take for the color loop. p2 : specifies the direction for the color loop. p3 : specifies the number of seconds over which to perform a full color loop. p4 : specifies the starting hue to use for the color loop.; cluster:768 |
setHue |
INT [0..360] | Set the color hue (°) of the lamp; cluster:768 |
setHueAndSaturation |
INT [0..360]; INT [0..100] | Set the color hue (°) and color saturation(%) of the lamp |
setHueAndSaturationWithTransitionTime |
INT [0..360]; INT [0..100]; FLOAT [0.0..6553.5] | Set the color hue (°) and color saturation(%) of the lamp with a transition time.; cluster:768 |
setIntensity |
INT [0..100] | Light intensity level (100%=maximum intensity, 0%=off); cluster:8 |
setIntensityWithTimer |
INT [0..100]; INT [5..14400]; INT [0..100] (optional) | Set the light intensity to p1% then after p2 seconds, set it to p3%. (If p3 is not specified the light is turned off after the delay); cluster:8 |
setOnOff |
STRING: off, on | Turn the device on or off; cluster:6 |
setSaturation |
INT [0..100] | Set the color saturation (%) of the lamp; cluster:768 |
stopIdentify |
Ask the device to stop winking immediately; cluster:3 | |
stopMoveStepColor |
Allow Move to and Step commands to be stopped.; cluster:768 | |
toggle |
Toggle on/off status; cluster:6 | |
unbind |
STRING; STRING | Unbind a device with another device. First parameter is target device address. Second parameter is list of clusters to unbind (string of clusters separated by ","). |
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
ColorHueState |
ContinuousState | cluster:768 | |
ColorLoopActiveState |
DiscreteState | activatedStartFromColorLoopStartEnhancedHue, activatedStartFromEnhancedCurrentHue, deactivated | cluster:768 |
ColorLoopDirectionState |
DiscreteState | decremented, incremented | cluster:768 |
ColorLoopTimeState |
ContinuousState | cluster:768 | |
ColorModeState |
DiscreteState | cieXYZ, hueAndStaturation, temperature, rgb | cluster:768 |
ColorSaturationState |
ContinuousState | cluster:768 | |
CommandLockLevelsState |
DataState | ||
DiscreteRSSILevelState |
DiscreteState | good, low, normal, verylow | |
FirmwareRevisionState |
DataState | ||
LightIntensityState |
ContinuousState | [0..100] | cluster:8 |
LinkQualityIndicatorState |
ContinuousState | ||
ManufacturerNameState |
DataState | cluster:0 | |
OnOffState |
DiscreteState | on, off | cluster:6 |
PowerSourceState |
DiscreteState | Unknown, Mains (single phase), Mains (3 phase), Battery, DC source, Emergency mains constantly powered, Emergency mains and transfer switch | cluster:0 |
ProductModelNameState |
DataState | cluster:0 | |
RSSILevelState |
ContinuousState | ||
StatusState |
DiscreteState | available, unavailable | |
ZigbeeUpdateDownloadProgressState |
ContinuousState | ||
ZigbeeUpdateState |
DiscreteState | idle, running, error-timeout, error-default-initial-condition, error-on-upgrade, success, error-abort, error-not-authorized, error-invalid-image, error-wait-for-data, error-no-image-available, error-malformed-command, error-require-more-image |
Light/DimmerCIEColorSpaceXYLight (ACTUATOR) — 19 commands, 16 states
Type IDs: 2199023321608 | Servers: atlantic_cozytouch, rexel, somfy_europe | Controllable: zigbee:CIEColorSpaceXYLightComponent | Profiles: StatefulLightDimmer, StatefulDimmable, StatefulSwitchable, Dimmable, Switchable
Data Properties
core:identifyInterval=500core:useControllableForGroup=zigbee:GroupCIEColorSpaceXYLightComponent
Commands
| Command | Parameters | Notes |
|---|---|---|
addLockLevel |
INT; INT (optional) | Add a command lock level on the device p1 : The lock level to add p2 : (optional) Duration in second of the lock Level. By default there is no expiration.; cluster:0 |
advancedRefresh |
STRING: normal, advanced | Refresh extra states; cluster:0 |
bind |
STRING; STRING | Bind a device with another device. First parameter is target device address. Second parameter is list of clusters to bind (string of clusters separated by ","). |
identify |
Ask the device to identify itself by doing a slight movement or blink or beep; cluster:3 | |
off |
Turn off the device; cluster:6 | |
on |
Turn on the device; cluster:6 | |
onWithTimer |
INT [5..14400] | Turn the device on for a given amount of seconds then turn it off; cluster:6 |
ping |
Check if device is available; cluster:3 | |
removeLockLevel |
INT | Remove the command lock level on the device p1 : The lock level to remove; cluster:0 |
resetLockLevels |
Remove all lock levels on the device; cluster:0 | |
setCieColorSpaceXY |
FLOAT [0.001..0.999]; FLOAT [0.001..0.999] | Set the CIE color space coordinates (X,Y) of the lamp |
setCieColorSpaceXYWithTransitionTime |
FLOAT [0.001..0.999]; FLOAT [0.001..0.999]; FLOAT [0.0..6553.5] | Set color in the Cie color space XY with transition time. p1 : color X p2 : color Y p3 : time transition in second; cluster:768 |
setIntensity |
INT [0..100] | Light intensity level (100%=maximum intensity, 0%=off); cluster:8 |
setIntensityWithTimer |
INT [0..100]; INT [5..14400]; INT [0..100] (optional) | Set the light intensity to p1% then after p2 seconds, set it to p3%. (If p3 is not specified the light is turned off after the delay); cluster:8 |
setOnOff |
STRING: off, on | Turn the device on or off; cluster:6 |
stopIdentify |
Ask the device to stop winking immediately; cluster:3 | |
stopMoveStepColor |
Allow Move to and Step commands to be stopped.; cluster:768 | |
toggle |
Toggle on/off status; cluster:6 | |
unbind |
STRING; STRING | Unbind a device with another device. First parameter is target device address. Second parameter is list of clusters to unbind (string of clusters separated by ","). |
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
CieColorSpaceXState |
ContinuousState | cluster:768 | |
CieColorSpaceYState |
ContinuousState | cluster:768 | |
ColorModeState |
DiscreteState | cieXYZ, hueAndStaturation, temperature, rgb | cluster:768 |
CommandLockLevelsState |
DataState | ||
DiscreteRSSILevelState |
DiscreteState | good, low, normal, verylow | |
FirmwareRevisionState |
DataState | ||
LightIntensityState |
ContinuousState | [0..100] | cluster:8 |
LinkQualityIndicatorState |
ContinuousState | ||
ManufacturerNameState |
DataState | cluster:0 | |
OnOffState |
DiscreteState | on, off | cluster:6 |
PowerSourceState |
DiscreteState | Unknown, Mains (single phase), Mains (3 phase), Battery, DC source, Emergency mains constantly powered, Emergency mains and transfer switch | cluster:0 |
ProductModelNameState |
DataState | cluster:0 | |
RSSILevelState |
ContinuousState | ||
StatusState |
DiscreteState | available, unavailable | |
ZigbeeUpdateDownloadProgressState |
ContinuousState | ||
ZigbeeUpdateState |
DiscreteState | idle, running, error-timeout, error-default-initial-condition, error-on-upgrade, success, error-abort, error-not-authorized, error-invalid-image, error-wait-for-data, error-no-image-available, error-malformed-command, error-require-more-image |
Light/DimmerHueSaturationLight (ACTUATOR) — 23 commands, 18 states
Type IDs: 2199023321609, 2199023321611 | Servers: atlantic_cozytouch, rexel, somfy_europe | Controllable: zigbee:HueCIEXYLightComponent | Profiles: StatefulLightDimmer, StatefulDimmable, StatefulSwitchable, Dimmable, Switchable
Data Properties
core:identifyInterval=500core:useControllableForGroup=zigbee:GroupHueCIEXYLightComponent
Commands
| Command | Parameters | Notes |
|---|---|---|
addLockLevel |
INT; INT (optional) | Add a command lock level on the device p1 : The lock level to add p2 : (optional) Duration in second of the lock Level. By default there is no expiration.; cluster:0 |
advancedRefresh |
STRING: normal, advanced | Refresh extra states; cluster:0 |
bind |
STRING; STRING | Bind a device with another device. First parameter is target device address. Second parameter is list of clusters to bind (string of clusters separated by ","). |
identify |
Ask the device to identify itself by doing a slight movement or blink or beep; cluster:3 | |
off |
Turn off the device; cluster:6 | |
on |
Turn on the device; cluster:6 | |
onWithTimer |
INT [5..14400] | Turn the device on for a given amount of seconds then turn it off; cluster:6 |
ping |
Check if device is available; cluster:3 | |
removeLockLevel |
INT | Remove the command lock level on the device p1 : The lock level to remove; cluster:0 |
resetLockLevels |
Remove all lock levels on the device; cluster:0 | |
setCieColorSpaceXY |
FLOAT [0.001..0.999]; FLOAT [0.001..0.999] | Set the CIE color space coordinates (X,Y) of the lamp |
setCieColorSpaceXYWithTransitionTime |
FLOAT [0.001..0.999]; FLOAT [0.001..0.999]; FLOAT [0.0..6553.5] | Set color in the Cie color space XY with transition time. p1 : color X p2 : color Y p3 : time transition in second; cluster:768 |
setHue |
INT [0..360] | Set the color hue (°) of the lamp; cluster:768 |
setHueAndSaturation |
INT [0..360]; INT [0..100] | Set the color hue (°) and color saturation(%) of the lamp |
setHueAndSaturationWithTransitionTime |
INT [0..360]; INT [0..100]; FLOAT [0.0..6553.5] | Set the color hue (°) and color saturation(%) of the lamp with a transition time.; cluster:768 |
setIntensity |
INT [0..100] | Light intensity level (100%=maximum intensity, 0%=off); cluster:8 |
setIntensityWithTimer |
INT [0..100]; INT [5..14400]; INT [0..100] (optional) | Set the light intensity to p1% then after p2 seconds, set it to p3%. (If p3 is not specified the light is turned off after the delay); cluster:8 |
setOnOff |
STRING: off, on | Turn the device on or off; cluster:6 |
setSaturation |
INT [0..100] | Set the color saturation (%) of the lamp; cluster:768 |
stopIdentify |
Ask the device to stop winking immediately; cluster:3 | |
stopMoveStepColor |
Allow Move to and Step commands to be stopped.; cluster:768 | |
toggle |
Toggle on/off status; cluster:6 | |
unbind |
STRING; STRING | Unbind a device with another device. First parameter is target device address. Second parameter is list of clusters to unbind (string of clusters separated by ","). |
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
CieColorSpaceXState |
ContinuousState | cluster:768 | |
CieColorSpaceYState |
ContinuousState | cluster:768 | |
ColorHueState |
ContinuousState | cluster:768 | |
ColorModeState |
DiscreteState | cieXYZ, hueAndStaturation, temperature, rgb | cluster:768 |
ColorSaturationState |
ContinuousState | cluster:768 | |
CommandLockLevelsState |
DataState | ||
DiscreteRSSILevelState |
DiscreteState | good, low, normal, verylow | |
FirmwareRevisionState |
DataState | ||
LightIntensityState |
ContinuousState | [0..100] | cluster:8 |
LinkQualityIndicatorState |
ContinuousState | ||
ManufacturerNameState |
DataState | cluster:0 | |
OnOffState |
DiscreteState | on, off | cluster:6 |
PowerSourceState |
DiscreteState | Unknown, Mains (single phase), Mains (3 phase), Battery, DC source, Emergency mains constantly powered, Emergency mains and transfer switch | cluster:0 |
ProductModelNameState |
DataState | cluster:0 | |
RSSILevelState |
ContinuousState | ||
StatusState |
DiscreteState | available, unavailable | |
ZigbeeUpdateDownloadProgressState |
ContinuousState | ||
ZigbeeUpdateState |
DiscreteState | idle, running, error-timeout, error-default-initial-condition, error-on-upgrade, success, error-abort, error-not-authorized, error-invalid-image, error-wait-for-data, error-no-image-available, error-malformed-command, error-require-more-image |
Light/DimmerHueSaturationLight (ACTUATOR) — 24 commands, 21 states
Type IDs: 2199023321615 | Servers: atlantic_cozytouch, rexel, somfy_europe | Controllable: zigbee:ColorLoopCIEXYLightComponent | Profiles: StatefulLightDimmer, StatefulDimmable, StatefulSwitchable, Dimmable, Switchable
Data Properties
core:identifyInterval=500core:useControllableForGroup=zigbee:GroupColorLoopCIEXYLightComponent
Commands
| Command | Parameters | Notes |
|---|---|---|
addLockLevel |
INT; INT (optional) | Add a command lock level on the device p1 : The lock level to add p2 : (optional) Duration in second of the lock Level. By default there is no expiration.; cluster:0 |
advancedRefresh |
STRING: normal, advanced | Refresh extra states; cluster:0 |
bind |
STRING; STRING | Bind a device with another device. First parameter is target device address. Second parameter is list of clusters to bind (string of clusters separated by ","). |
identify |
Ask the device to identify itself by doing a slight movement or blink or beep; cluster:3 | |
off |
Turn off the device; cluster:6 | |
on |
Turn on the device; cluster:6 | |
onWithTimer |
INT [5..14400] | Turn the device on for a given amount of seconds then turn it off; cluster:6 |
ping |
Check if device is available; cluster:3 | |
removeLockLevel |
INT | Remove the command lock level on the device p1 : The lock level to remove; cluster:0 |
resetLockLevels |
Remove all lock levels on the device; cluster:0 | |
setCieColorSpaceXY |
FLOAT [0.0..1.0]; FLOAT [0.0..1.0] | Set the CIE color space coordinates (X,Y) of the lamp |
setCieColorSpaceXYWithTransitionTime |
FLOAT [0.0..1.0]; FLOAT [0.0..1.0]; FLOAT [0.0..6550.0] | Set color in the Cie color space XY with transition time. p1 : color X p2 : color Y p3 : time transition in second; cluster:768 |
setColorLoopWithTransitionTime |
STRING: deactivated, activatedStartFromColorLoopStartEnhancedHue, activatedStartFromEnhancedCurrentHue; STRING: decremented, incremented; FLOAT [0.0..6550.0]; INT [0..360] | The Color Loop Set command allows a color loop to be activated such that the color lamp cycles through its range of hues. p1 : specifies the action to take for the color loop. p2 : specifies the direction for the color loop. p3 : specifies the number of seconds over which to perform a full color loop. p4 : specifies the starting hue to use for the color loop.; cluster:768 |
setHue |
INT [0..360] | Set the color hue (°) of the lamp; cluster:768 |
setHueAndSaturation |
INT [0..360]; INT [0..100] | Set the color hue (°) and color saturation(%) of the lamp |
setHueAndSaturationWithTransitionTime |
INT [0..360]; INT [0..100]; FLOAT [0.0..6553.5] | Set the color hue (°) and color saturation(%) of the lamp with a transition time.; cluster:768 |
setIntensity |
INT [0..100] | Light intensity level (100%=maximum intensity, 0%=off); cluster:8 |
setIntensityWithTimer |
INT [0..100]; INT [5..14400]; INT [0..100] (optional) | Set the light intensity to p1% then after p2 seconds, set it to p3%. (If p3 is not specified the light is turned off after the delay); cluster:8 |
setOnOff |
STRING: off, on | Turn the device on or off; cluster:6 |
setSaturation |
INT [0..100] | Set the color saturation (%) of the lamp; cluster:768 |
stopIdentify |
Ask the device to stop winking immediately; cluster:3 | |
stopMoveStepColor |
Allow Move to and Step commands to be stopped.; cluster:768 | |
toggle |
Toggle on/off status; cluster:6 | |
unbind |
STRING; STRING | Unbind a device with another device. First parameter is target device address. Second parameter is list of clusters to unbind (string of clusters separated by ","). |
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
CieColorSpaceXState |
ContinuousState | cluster:768 | |
CieColorSpaceYState |
ContinuousState | cluster:768 | |
ColorHueState |
ContinuousState | cluster:768 | |
ColorLoopActiveState |
DiscreteState | activatedStartFromColorLoopStartEnhancedHue, activatedStartFromEnhancedCurrentHue, deactivated | cluster:768 |
ColorLoopDirectionState |
DiscreteState | decremented, incremented | cluster:768 |
ColorLoopTimeState |
ContinuousState | cluster:768 | |
ColorModeState |
DiscreteState | cieXYZ, hueAndStaturation, temperature, rgb | cluster:768 |
ColorSaturationState |
ContinuousState | cluster:768 | |
CommandLockLevelsState |
DataState | ||
DiscreteRSSILevelState |
DiscreteState | good, low, normal, verylow | |
FirmwareRevisionState |
DataState | ||
LightIntensityState |
ContinuousState | [0..100] | cluster:8 |
LinkQualityIndicatorState |
ContinuousState | ||
ManufacturerNameState |
DataState | cluster:0 | |
OnOffState |
DiscreteState | on, off | cluster:6 |
PowerSourceState |
DiscreteState | Unknown, Mains (single phase), Mains (3 phase), Battery, DC source, Emergency mains constantly powered, Emergency mains and transfer switch | cluster:0 |
ProductModelNameState |
DataState | cluster:0 | |
RSSILevelState |
ContinuousState | ||
StatusState |
DiscreteState | available, unavailable | |
ZigbeeUpdateDownloadProgressState |
ContinuousState | ||
ZigbeeUpdateState |
DiscreteState | idle, running, error-timeout, error-default-initial-condition, error-on-upgrade, success, error-abort, error-not-authorized, error-invalid-image, error-wait-for-data, error-no-image-available, error-malformed-command, error-require-more-image |
Light/DimmerColorTemperatureLight (ACTUATOR) — 19 commands, 15 states
Type IDs: 2199023321616, 2199023324160, 2199023324176 | Servers: atlantic_cozytouch, rexel, somfy_europe | Controllable: zigbee:ColorTemperatureLightComponent | Profiles: StatefulLightDimmer, StatefulDimmable, StatefulSwitchable, Dimmable, Switchable
Data Properties
core:identifyInterval=500core:useControllableForGroup=zigbee:GroupColorTemperatureLightComponent
Commands
| Command | Parameters | Notes |
|---|---|---|
addLockLevel |
INT; INT (optional) | Add a command lock level on the device p1 : The lock level to add p2 : (optional) Duration in second of the lock Level. By default there is no expiration.; cluster:0 |
advancedRefresh |
STRING: normal, advanced | Refresh extra states; cluster:0 |
bind |
STRING; STRING | Bind a device with another device. First parameter is target device address. Second parameter is list of clusters to bind (string of clusters separated by ","). |
identify |
Ask the device to identify itself by doing a slight movement or blink or beep; cluster:3 | |
moveToColorTemperature |
FLOAT [2000.0..6500.0]; FLOAT [0.0..6550.0] | Move to a color temperature. p1 : color temperature in kelvin p2 : time transition in second; cluster:768 |
off |
Turn off the device; cluster:6 | |
on |
Turn on the device; cluster:6 | |
onWithTimer |
INT [5..14400] | Turn the device on for a given amount of seconds then turn it off; cluster:6 |
ping |
Check if device is available; cluster:3 | |
removeLockLevel |
INT | Remove the command lock level on the device p1 : The lock level to remove; cluster:0 |
resetLockLevels |
Remove all lock levels on the device; cluster:0 | |
setColorTemperature |
INT [2000..6500] | Set the perceived white temperature for this lamp (°K) |
setIntensity |
INT [0..100] | Light intensity level (100%=maximum intensity, 0%=off); cluster:8 |
setIntensityWithTimer |
INT [0..100]; INT [5..14400]; INT [0..100] (optional) | Set the light intensity to p1% then after p2 seconds, set it to p3%. (If p3 is not specified the light is turned off after the delay); cluster:8 |
setOnOff |
STRING: off, on | Turn the device on or off; cluster:6 |
stopIdentify |
Ask the device to stop winking immediately; cluster:3 | |
stopMoveStepColor |
Allow Move to and Step commands to be stopped.; cluster:768 | |
toggle |
Toggle on/off status; cluster:6 | |
unbind |
STRING; STRING | Unbind a device with another device. First parameter is target device address. Second parameter is list of clusters to unbind (string of clusters separated by ","). |
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
ColorModeState |
DiscreteState | cieXYZ, hueAndStaturation, temperature, rgb | cluster:768 |
ColorTemperatureState |
ContinuousState | cluster:768 | |
CommandLockLevelsState |
DataState | ||
DiscreteRSSILevelState |
DiscreteState | good, low, normal, verylow | |
FirmwareRevisionState |
DataState | ||
LightIntensityState |
ContinuousState | [0..100] | cluster:8 |
LinkQualityIndicatorState |
ContinuousState | ||
ManufacturerNameState |
DataState | cluster:0 | |
OnOffState |
DiscreteState | on, off | cluster:6 |
PowerSourceState |
DiscreteState | Unknown, Mains (single phase), Mains (3 phase), Battery, DC source, Emergency mains constantly powered, Emergency mains and transfer switch | cluster:0 |
ProductModelNameState |
DataState | cluster:0 | |
RSSILevelState |
ContinuousState | ||
StatusState |
DiscreteState | available, unavailable | |
ZigbeeUpdateDownloadProgressState |
ContinuousState | ||
ZigbeeUpdateState |
DiscreteState | idle, running, error-timeout, error-default-initial-condition, error-on-upgrade, success, error-abort, error-not-authorized, error-invalid-image, error-wait-for-data, error-no-image-available, error-malformed-command, error-require-more-image |
Light/DimmerHueSaturationLight (ACTUATOR) — 23 commands, 17 states
Type IDs: 2199023321617, 2199023321619 | Servers: atlantic_cozytouch, rexel, somfy_europe | Controllable: zigbee:HueColorTemperatureLightComponent | Profiles: StatefulLightDimmer, StatefulDimmable, StatefulSwitchable, Dimmable, Switchable
Data Properties
core:identifyInterval=500core:useControllableForGroup=zigbee:GroupHueColorTemperatureLightComponent
Commands
| Command | Parameters | Notes |
|---|---|---|
addLockLevel |
INT; INT (optional) | Add a command lock level on the device p1 : The lock level to add p2 : (optional) Duration in second of the lock Level. By default there is no expiration.; cluster:0 |
advancedRefresh |
STRING: normal, advanced | Refresh extra states; cluster:0 |
bind |
STRING; STRING | Bind a device with another device. First parameter is target device address. Second parameter is list of clusters to bind (string of clusters separated by ","). |
identify |
Ask the device to identify itself by doing a slight movement or blink or beep; cluster:3 | |
moveToColorTemperature |
FLOAT [2000.0..6500.0]; FLOAT [0.0..6550.0] | Move to a color temperature. p1 : color temperature in kelvin p2 : time transition in second; cluster:768 |
off |
Turn off the device; cluster:6 | |
on |
Turn on the device; cluster:6 | |
onWithTimer |
INT [5..14400] | Turn the device on for a given amount of seconds then turn it off; cluster:6 |
ping |
Check if device is available; cluster:3 | |
removeLockLevel |
INT | Remove the command lock level on the device p1 : The lock level to remove; cluster:0 |
resetLockLevels |
Remove all lock levels on the device; cluster:0 | |
setColorTemperature |
INT [2000..6500] | Set the perceived white temperature for this lamp (°K) |
setHue |
INT [0..360] | Set the color hue (°) of the lamp; cluster:768 |
setHueAndSaturation |
INT [0..360]; INT [0..100] | Set the color hue (°) and color saturation(%) of the lamp |
setHueAndSaturationWithTransitionTime |
INT [0..360]; INT [0..100]; FLOAT [0.0..6553.5] | Set the color hue (°) and color saturation(%) of the lamp with a transition time.; cluster:768 |
setIntensity |
INT [0..100] | Light intensity level (100%=maximum intensity, 0%=off); cluster:8 |
setIntensityWithTimer |
INT [0..100]; INT [5..14400]; INT [0..100] (optional) | Set the light intensity to p1% then after p2 seconds, set it to p3%. (If p3 is not specified the light is turned off after the delay); cluster:8 |
setOnOff |
STRING: off, on | Turn the device on or off; cluster:6 |
setSaturation |
INT [0..100] | Set the color saturation (%) of the lamp; cluster:768 |
stopIdentify |
Ask the device to stop winking immediately; cluster:3 | |
stopMoveStepColor |
Allow Move to and Step commands to be stopped.; cluster:768 | |
toggle |
Toggle on/off status; cluster:6 | |
unbind |
STRING; STRING | Unbind a device with another device. First parameter is target device address. Second parameter is list of clusters to unbind (string of clusters separated by ","). |
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
ColorHueState |
ContinuousState | cluster:768 | |
ColorModeState |
DiscreteState | cieXYZ, hueAndStaturation, temperature, rgb | cluster:768 |
ColorSaturationState |
ContinuousState | cluster:768 | |
ColorTemperatureState |
ContinuousState | cluster:768 | |
CommandLockLevelsState |
DataState | ||
DiscreteRSSILevelState |
DiscreteState | good, low, normal, verylow | |
FirmwareRevisionState |
DataState | ||
LightIntensityState |
ContinuousState | [0..100] | cluster:8 |
LinkQualityIndicatorState |
ContinuousState | ||
ManufacturerNameState |
DataState | cluster:0 | |
OnOffState |
DiscreteState | on, off | cluster:6 |
PowerSourceState |
DiscreteState | Unknown, Mains (single phase), Mains (3 phase), Battery, DC source, Emergency mains constantly powered, Emergency mains and transfer switch | cluster:0 |
ProductModelNameState |
DataState | cluster:0 | |
RSSILevelState |
ContinuousState | ||
StatusState |
DiscreteState | available, unavailable | |
ZigbeeUpdateDownloadProgressState |
ContinuousState | ||
ZigbeeUpdateState |
DiscreteState | idle, running, error-timeout, error-default-initial-condition, error-on-upgrade, success, error-abort, error-not-authorized, error-invalid-image, error-wait-for-data, error-no-image-available, error-malformed-command, error-require-more-image |
Light/DimmerHueSaturationLight (ACTUATOR) — 24 commands, 20 states
Type IDs: 2199023321623 | Servers: atlantic_cozytouch, rexel, somfy_europe | Controllable: zigbee:ColorLoopColorTemperatureLightComponent | Profiles: StatefulLightDimmer, StatefulDimmable, StatefulSwitchable, Dimmable, Switchable
Data Properties
core:identifyInterval=500core:useControllableForGroup=zigbee:GroupColorLoopColorTemperatureLightComponent
Commands
| Command | Parameters | Notes |
|---|---|---|
addLockLevel |
INT; INT (optional) | Add a command lock level on the device p1 : The lock level to add p2 : (optional) Duration in second of the lock Level. By default there is no expiration.; cluster:0 |
advancedRefresh |
STRING: normal, advanced | Refresh extra states; cluster:0 |
bind |
STRING; STRING | Bind a device with another device. First parameter is target device address. Second parameter is list of clusters to bind (string of clusters separated by ","). |
identify |
Ask the device to identify itself by doing a slight movement or blink or beep; cluster:3 | |
moveToColorTemperature |
FLOAT [2000.0..6500.0]; FLOAT [0.0..6550.0] | Move to a color temperature. p1 : color temperature in kelvin p2 : time transition in second; cluster:768 |
off |
Turn off the device; cluster:6 | |
on |
Turn on the device; cluster:6 | |
onWithTimer |
INT [5..14400] | Turn the device on for a given amount of seconds then turn it off; cluster:6 |
ping |
Check if device is available; cluster:3 | |
removeLockLevel |
INT | Remove the command lock level on the device p1 : The lock level to remove; cluster:0 |
resetLockLevels |
Remove all lock levels on the device; cluster:0 | |
setColorLoopWithTransitionTime |
STRING: deactivated, activatedStartFromColorLoopStartEnhancedHue, activatedStartFromEnhancedCurrentHue; STRING: decremented, incremented; FLOAT [0.0..6550.0]; INT [0..360] | The Color Loop Set command allows a color loop to be activated such that the color lamp cycles through its range of hues. p1 : specifies the action to take for the color loop. p2 : specifies the direction for the color loop. p3 : specifies the number of seconds over which to perform a full color loop. p4 : specifies the starting hue to use for the color loop.; cluster:768 |
setColorTemperature |
INT [2000..6500] | Set the perceived white temperature for this lamp (°K) |
setHue |
INT [0..360] | Set the color hue (°) of the lamp; cluster:768 |
setHueAndSaturation |
INT [0..360]; INT [0..100] | Set the color hue (°) and color saturation(%) of the lamp |
setHueAndSaturationWithTransitionTime |
INT [0..360]; INT [0..100]; FLOAT [0.0..6553.5] | Set the color hue (°) and color saturation(%) of the lamp with a transition time.; cluster:768 |
setIntensity |
INT [0..100] | Light intensity level (100%=maximum intensity, 0%=off); cluster:8 |
setIntensityWithTimer |
INT [0..100]; INT [5..14400]; INT [0..100] (optional) | Set the light intensity to p1% then after p2 seconds, set it to p3%. (If p3 is not specified the light is turned off after the delay); cluster:8 |
setOnOff |
STRING: off, on | Turn the device on or off; cluster:6 |
setSaturation |
INT [0..100] | Set the color saturation (%) of the lamp; cluster:768 |
stopIdentify |
Ask the device to stop winking immediately; cluster:3 | |
stopMoveStepColor |
Allow Move to and Step commands to be stopped.; cluster:768 | |
toggle |
Toggle on/off status; cluster:6 | |
unbind |
STRING; STRING | Unbind a device with another device. First parameter is target device address. Second parameter is list of clusters to unbind (string of clusters separated by ","). |
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
ColorHueState |
ContinuousState | cluster:768 | |
ColorLoopActiveState |
DiscreteState | activatedStartFromColorLoopStartEnhancedHue, activatedStartFromEnhancedCurrentHue, deactivated | cluster:768 |
ColorLoopDirectionState |
DiscreteState | decremented, incremented | cluster:768 |
ColorLoopTimeState |
ContinuousState | cluster:768 | |
ColorModeState |
DiscreteState | cieXYZ, hueAndStaturation, temperature, rgb | cluster:768 |
ColorSaturationState |
ContinuousState | cluster:768 | |
ColorTemperatureState |
ContinuousState | cluster:768 | |
CommandLockLevelsState |
DataState | ||
DiscreteRSSILevelState |
DiscreteState | good, low, normal, verylow | |
FirmwareRevisionState |
DataState | ||
LightIntensityState |
ContinuousState | [0..100] | cluster:8 |
LinkQualityIndicatorState |
ContinuousState | ||
ManufacturerNameState |
DataState | cluster:0 | |
OnOffState |
DiscreteState | on, off | cluster:6 |
PowerSourceState |
DiscreteState | Unknown, Mains (single phase), Mains (3 phase), Battery, DC source, Emergency mains constantly powered, Emergency mains and transfer switch | cluster:0 |
ProductModelNameState |
DataState | cluster:0 | |
RSSILevelState |
ContinuousState | ||
StatusState |
DiscreteState | available, unavailable | |
ZigbeeUpdateDownloadProgressState |
ContinuousState | ||
ZigbeeUpdateState |
DiscreteState | idle, running, error-timeout, error-default-initial-condition, error-on-upgrade, success, error-abort, error-not-authorized, error-invalid-image, error-wait-for-data, error-no-image-available, error-malformed-command, error-require-more-image |
Light/DimmerColorTemperatureLight (ACTUATOR) — 21 commands, 17 states
Type IDs: 2199023321624 | Servers: atlantic_cozytouch, rexel, somfy_europe | Controllable: zigbee:ColorTemperatureCIEXYLightComponent | Profiles: StatefulLightDimmer, StatefulDimmable, StatefulSwitchable, Dimmable, Switchable
Data Properties
core:identifyInterval=500core:useControllableForGroup=zigbee:GroupColorTemperatureCIEXYLightComponent
Commands
| Command | Parameters | Notes |
|---|---|---|
addLockLevel |
INT; INT (optional) | Add a command lock level on the device p1 : The lock level to add p2 : (optional) Duration in second of the lock Level. By default there is no expiration.; cluster:0 |
advancedRefresh |
STRING: normal, advanced | Refresh extra states; cluster:0 |
bind |
STRING; STRING | Bind a device with another device. First parameter is target device address. Second parameter is list of clusters to bind (string of clusters separated by ","). |
identify |
Ask the device to identify itself by doing a slight movement or blink or beep; cluster:3 | |
moveToColorTemperature |
FLOAT [2000.0..6500.0]; FLOAT [0.0..6550.0] | Move to a color temperature. p1 : color temperature in kelvin p2 : time transition in second; cluster:768 |
off |
Turn off the device; cluster:6 | |
on |
Turn on the device; cluster:6 | |
onWithTimer |
INT [5..14400] | Turn the device on for a given amount of seconds then turn it off; cluster:6 |
ping |
Check if device is available; cluster:3 | |
removeLockLevel |
INT | Remove the command lock level on the device p1 : The lock level to remove; cluster:0 |
resetLockLevels |
Remove all lock levels on the device; cluster:0 | |
setCieColorSpaceXY |
FLOAT [0.001..0.999]; FLOAT [0.001..0.999] | Set the CIE color space coordinates (X,Y) of the lamp |
setCieColorSpaceXYWithTransitionTime |
FLOAT [0.001..0.999]; FLOAT [0.001..0.999]; FLOAT [0.0..6553.5] | Set color in the Cie color space XY with transition time. p1 : color X p2 : color Y p3 : time transition in second; cluster:768 |
setColorTemperature |
INT [2000..6500] | Set the perceived white temperature for this lamp (°K) |
setIntensity |
INT [0..100] | Light intensity level (100%=maximum intensity, 0%=off); cluster:8 |
setIntensityWithTimer |
INT [0..100]; INT [5..14400]; INT [0..100] (optional) | Set the light intensity to p1% then after p2 seconds, set it to p3%. (If p3 is not specified the light is turned off after the delay); cluster:8 |
setOnOff |
STRING: off, on | Turn the device on or off; cluster:6 |
stopIdentify |
Ask the device to stop winking immediately; cluster:3 | |
stopMoveStepColor |
Allow Move to and Step commands to be stopped.; cluster:768 | |
toggle |
Toggle on/off status; cluster:6 | |
unbind |
STRING; STRING | Unbind a device with another device. First parameter is target device address. Second parameter is list of clusters to unbind (string of clusters separated by ","). |
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
CieColorSpaceXState |
ContinuousState | cluster:768 | |
CieColorSpaceYState |
ContinuousState | cluster:768 | |
ColorModeState |
DiscreteState | cieXYZ, hueAndStaturation, temperature, rgb | cluster:768 |
ColorTemperatureState |
ContinuousState | cluster:768 | |
CommandLockLevelsState |
DataState | ||
DiscreteRSSILevelState |
DiscreteState | good, low, normal, verylow | |
FirmwareRevisionState |
DataState | ||
LightIntensityState |
ContinuousState | [0..100] | cluster:8 |
LinkQualityIndicatorState |
ContinuousState | ||
ManufacturerNameState |
DataState | cluster:0 | |
OnOffState |
DiscreteState | on, off | cluster:6 |
PowerSourceState |
DiscreteState | Unknown, Mains (single phase), Mains (3 phase), Battery, DC source, Emergency mains constantly powered, Emergency mains and transfer switch | cluster:0 |
ProductModelNameState |
DataState | cluster:0 | |
RSSILevelState |
ContinuousState | ||
StatusState |
DiscreteState | available, unavailable | |
ZigbeeUpdateDownloadProgressState |
ContinuousState | ||
ZigbeeUpdateState |
DiscreteState | idle, running, error-timeout, error-default-initial-condition, error-on-upgrade, success, error-abort, error-not-authorized, error-invalid-image, error-wait-for-data, error-no-image-available, error-malformed-command, error-require-more-image |
Light/DimmerHueSaturationLight (ACTUATOR) — 25 commands, 19 states
Type IDs: 2199023321625, 2199023321627, 2199023324416 | Servers: atlantic_cozytouch, rexel, somfy_europe | Controllable: zigbee:HueXYTemperatureLightComponent | Profiles: StatefulLightDimmer, StatefulDimmable, StatefulSwitchable, Dimmable, Switchable
Data Properties
core:identifyInterval=500core:useControllableForGroup=zigbee:GroupHueXYTemperatureLightComponent
Commands
| Command | Parameters | Notes |
|---|---|---|
addLockLevel |
INT; INT (optional) | Add a command lock level on the device p1 : The lock level to add p2 : (optional) Duration in second of the lock Level. By default there is no expiration.; cluster:0 |
advancedRefresh |
STRING: normal, advanced | Refresh extra states; cluster:0 |
bind |
STRING; STRING | Bind a device with another device. First parameter is target device address. Second parameter is list of clusters to bind (string of clusters separated by ","). |
identify |
Ask the device to identify itself by doing a slight movement or blink or beep; cluster:3 | |
moveToColorTemperature |
FLOAT [2000.0..6500.0]; FLOAT [0.0..6550.0] | Move to a color temperature. p1 : color temperature in kelvin p2 : time transition in second; cluster:768 |
off |
Turn off the device; cluster:6 | |
on |
Turn on the device; cluster:6 | |
onWithTimer |
INT [5..14400] | Turn the device on for a given amount of seconds then turn it off; cluster:6 |
ping |
Check if device is available; cluster:3 | |
removeLockLevel |
INT | Remove the command lock level on the device p1 : The lock level to remove; cluster:0 |
resetLockLevels |
Remove all lock levels on the device; cluster:0 | |
setCieColorSpaceXY |
FLOAT [0.001..0.999]; FLOAT [0.001..0.999] | Set the CIE color space coordinates (X,Y) of the lamp |
setCieColorSpaceXYWithTransitionTime |
FLOAT [0.001..0.999]; FLOAT [0.001..0.999]; FLOAT [0.0..6553.5] | Set color in the Cie color space XY with transition time. p1 : color X p2 : color Y p3 : time transition in second; cluster:768 |
setColorTemperature |
INT [2000..6500] | Set the perceived white temperature for this lamp (°K) |
setHue |
INT [0..360] | Set the color hue (°) of the lamp; cluster:768 |
setHueAndSaturation |
INT [0..360]; INT [0..100] | Set the color hue (°) and color saturation(%) of the lamp |
setHueAndSaturationWithTransitionTime |
INT [0..360]; INT [0..100]; FLOAT [0.0..6553.5] | Set the color hue (°) and color saturation(%) of the lamp with a transition time.; cluster:768 |
setIntensity |
INT [0..100] | Light intensity level (100%=maximum intensity, 0%=off); cluster:8 |
setIntensityWithTimer |
INT [0..100]; INT [5..14400]; INT [0..100] (optional) | Set the light intensity to p1% then after p2 seconds, set it to p3%. (If p3 is not specified the light is turned off after the delay); cluster:8 |
setOnOff |
STRING: off, on | Turn the device on or off; cluster:6 |
setSaturation |
INT [0..100] | Set the color saturation (%) of the lamp; cluster:768 |
stopIdentify |
Ask the device to stop winking immediately; cluster:3 | |
stopMoveStepColor |
Allow Move to and Step commands to be stopped.; cluster:768 | |
toggle |
Toggle on/off status; cluster:6 | |
unbind |
STRING; STRING | Unbind a device with another device. First parameter is target device address. Second parameter is list of clusters to unbind (string of clusters separated by ","). |
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
CieColorSpaceXState |
ContinuousState | cluster:768 | |
CieColorSpaceYState |
ContinuousState | cluster:768 | |
ColorHueState |
ContinuousState | cluster:768 | |
ColorModeState |
DiscreteState | cieXYZ, hueAndStaturation, temperature, rgb | cluster:768 |
ColorSaturationState |
ContinuousState | cluster:768 | |
ColorTemperatureState |
ContinuousState | cluster:768 | |
CommandLockLevelsState |
DataState | ||
DiscreteRSSILevelState |
DiscreteState | good, low, normal, verylow | |
FirmwareRevisionState |
DataState | ||
LightIntensityState |
ContinuousState | [0..100] | cluster:8 |
LinkQualityIndicatorState |
ContinuousState | ||
ManufacturerNameState |
DataState | cluster:0 | |
OnOffState |
DiscreteState | on, off | cluster:6 |
PowerSourceState |
DiscreteState | Unknown, Mains (single phase), Mains (3 phase), Battery, DC source, Emergency mains constantly powered, Emergency mains and transfer switch | cluster:0 |
ProductModelNameState |
DataState | cluster:0 | |
RSSILevelState |
ContinuousState | ||
StatusState |
DiscreteState | available, unavailable | |
ZigbeeUpdateDownloadProgressState |
ContinuousState | ||
ZigbeeUpdateState |
DiscreteState | idle, running, error-timeout, error-default-initial-condition, error-on-upgrade, success, error-abort, error-not-authorized, error-invalid-image, error-wait-for-data, error-no-image-available, error-malformed-command, error-require-more-image |
Light/DimmerHueSaturationLight (ACTUATOR) — 26 commands, 22 states
Type IDs: 2199023321631, 2199023324447 | Servers: atlantic_cozytouch, rexel, somfy_europe | Controllable: zigbee:ColorLightComponent | Profiles: StatefulLightDimmer, StatefulDimmable, StatefulSwitchable, Dimmable, Switchable
Data Properties
core:identifyInterval=500core:useControllableForGroup=zigbee:GroupColorLightComponent
Commands
| Command | Parameters | Notes |
|---|---|---|
addLockLevel |
INT; INT (optional) | Add a command lock level on the device p1 : The lock level to add p2 : (optional) Duration in second of the lock Level. By default there is no expiration.; cluster:0 |
advancedRefresh |
STRING: normal, advanced | Refresh extra states; cluster:0 |
bind |
STRING; STRING | Bind a device with another device. First parameter is target device address. Second parameter is list of clusters to bind (string of clusters separated by ","). |
identify |
Ask the device to identify itself by doing a slight movement or blink or beep; cluster:3 | |
moveToColorTemperature |
FLOAT [2000.0..6500.0]; FLOAT [0.0..6550.0] | Move to a color temperature. p1 : color temperature in kelvin p2 : time transition in second; cluster:768 |
off |
Turn off the device; cluster:6 | |
on |
Turn on the device; cluster:6 | |
onWithTimer |
INT [5..14400] | Turn the device on for a given amount of seconds then turn it off; cluster:6 |
ping |
Check if device is available; cluster:3 | |
removeLockLevel |
INT | Remove the command lock level on the device p1 : The lock level to remove; cluster:0 |
resetLockLevels |
Remove all lock levels on the device; cluster:0 | |
setCieColorSpaceXY |
FLOAT [0.001..0.999]; FLOAT [0.001..0.999] | Set the CIE color space coordinates (X,Y) of the lamp |
setCieColorSpaceXYWithTransitionTime |
FLOAT [0.001..0.999]; FLOAT [0.001..0.999]; FLOAT [0.0..6553.5] | Set color in the Cie color space XY with transition time. p1 : color X p2 : color Y p3 : time transition in second; cluster:768 |
setColorLoopWithTransitionTime |
STRING: deactivated, activatedStartFromColorLoopStartEnhancedHue, activatedStartFromEnhancedCurrentHue; STRING: decremented, incremented; FLOAT [0.0..6550.0]; INT [0..360] | The Color Loop Set command allows a color loop to be activated such that the color lamp cycles through its range of hues. p1 : specifies the action to take for the color loop. p2 : specifies the direction for the color loop. p3 : specifies the number of seconds over which to perform a full color loop. p4 : specifies the starting hue to use for the color loop.; cluster:768 |
setColorTemperature |
INT [2000..6500] | Set the perceived white temperature for this lamp (°K) |
setHue |
INT [0..360] | Set the color hue (°) of the lamp; cluster:768 |
setHueAndSaturation |
INT [0..360]; INT [0..100] | Set the color hue (°) and color saturation(%) of the lamp |
setHueAndSaturationWithTransitionTime |
INT [0..360]; INT [0..100]; FLOAT [0.0..6550.0] | Set the color hue (°) and color saturation(%) of the lamp with a transition time.; cluster:768 |
setIntensity |
INT [0..100] | Light intensity level (100%=maximum intensity, 0%=off); cluster:8 |
setIntensityWithTimer |
INT [0..100]; INT [5..14400]; INT [0..100] (optional) | Set the light intensity to p1% then after p2 seconds, set it to p3%. (If p3 is not specified the light is turned off after the delay); cluster:8 |
setOnOff |
STRING: off, on | Turn the device on or off; cluster:6 |
setSaturation |
INT [0..100] | Set the color saturation (%) of the lamp; cluster:768 |
stopIdentify |
Ask the device to stop winking immediately; cluster:3 | |
stopMoveStepColor |
Allow Move to and Step commands to be stopped.; cluster:768 | |
toggle |
Toggle on/off status; cluster:6 | |
unbind |
STRING; STRING | Unbind a device with another device. First parameter is target device address. Second parameter is list of clusters to unbind (string of clusters separated by ","). |
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
CieColorSpaceXState |
ContinuousState | cluster:768 | |
CieColorSpaceYState |
ContinuousState | cluster:768 | |
ColorHueState |
ContinuousState | cluster:768 | |
ColorLoopActiveState |
DiscreteState | activatedStartFromColorLoopStartEnhancedHue, activatedStartFromEnhancedCurrentHue, deactivated | cluster:768 |
ColorLoopDirectionState |
DiscreteState | decremented, incremented | cluster:768 |
ColorLoopTimeState |
ContinuousState | cluster:768 | |
ColorModeState |
DiscreteState | cieXYZ, hueAndStaturation, temperature, rgb | cluster:768 |
ColorSaturationState |
ContinuousState | cluster:768 | |
ColorTemperatureState |
ContinuousState | cluster:768 | |
CommandLockLevelsState |
DataState | ||
DiscreteRSSILevelState |
DiscreteState | good, low, normal, verylow | |
FirmwareRevisionState |
DataState | ||
LightIntensityState |
ContinuousState | [0..100] | cluster:8 |
LinkQualityIndicatorState |
ContinuousState | ||
ManufacturerNameState |
DataState | cluster:0 | |
OnOffState |
DiscreteState | on, off | cluster:6 |
PowerSourceState |
DiscreteState | Unknown, Mains (single phase), Mains (3 phase), Battery, DC source, Emergency mains constantly powered, Emergency mains and transfer switch | cluster:0 |
ProductModelNameState |
DataState | cluster:0 | |
RSSILevelState |
ContinuousState | ||
StatusState |
DiscreteState | available, unavailable | |
ZigbeeUpdateDownloadProgressState |
ContinuousState | ||
ZigbeeUpdateState |
DiscreteState | idle, running, error-timeout, error-default-initial-condition, error-on-upgrade, success, error-abort, error-not-authorized, error-invalid-image, error-wait-for-data, error-no-image-available, error-malformed-command, error-require-more-image |
Light/StatefulOnOffLight (ACTUATOR) — 19 commands, 17 states
Type IDs: 2269319856128 | Servers: atlantic_cozytouch, rexel, somfy_europe | Controllable: zigbee:SchneiderOnOffLightComponent | Profiles: StatefulSwitchableLight, StatefulSwitchable, Switchable
Data Properties
core:identifyInterval=500core:useControllableForGroup=zigbee:GroupOnOffLightComponent
Commands
| Command | Parameters | Notes |
|---|---|---|
addLockLevel |
INT; INT (optional) | Add a command lock level on the device p1 : The lock level to add p2 : (optional) Duration in second of the lock Level. By default there is no expiration.; cluster:0 |
advancedRefresh |
STRING: normal, advanced | Refresh extra states; cluster:0; cluster:6 |
bind |
STRING; STRING | Bind a device with another device. First parameter is target device address. Second parameter is list of clusters to bind (string of clusters separated by ","). |
identify |
Ask the device to identify itself by doing a slight movement or blink or beep; cluster:3 | |
off |
Turn off the device; cluster:6 | |
on |
Turn on the device; cluster:6 | |
onWithTimer |
INT [5..14400] | Turn the device on for a given amount of seconds then turn it off; cluster:6 |
ping |
Check if device is available; cluster:3 | |
removeLockLevel |
INT | Remove the command lock level on the device p1 : The lock level to remove; cluster:0 |
resetLockLevels |
Remove all lock levels on the device; cluster:0 | |
setDefaultOnOffState |
STRING: off, on, previous, togglePrevious | set the Default Output State; cluster:6 |
setOffWaitTime |
FLOAT [0.0..6553.5] | Set the timer that the "off" state shall be guarded to prevent an "on" command turning the device back to its "on" state; cluster:6 |
setOnOff |
STRING: off, on | Turn the device on or off; cluster:6 |
setSchneiderOnTimeReload |
INT [0..4294967295] | Set the number of seconds before the light is automaticaly switched off; cluster:6 |
setSchneiderOnTimeReloadOptions |
STRING: enable, disable | Enable or disable cancellation for automatic off timer. If enable : timer can be cancelled by receiving OFF command (light goes off immediately) If disable : timer can not be cancelled, is always restarted; cluster:6 |
setSchneiderPreWarningTime |
INT [0..6553] | Set the number of seconds before the light is switched off automatically during which the user is informed that the light will be switched off automaticaly; cluster:6 |
stopIdentify |
Ask the device to stop winking immediately; cluster:3 | |
toggle |
Toggle on/off status; cluster:6 | |
unbind |
STRING; STRING | Unbind a device with another device. First parameter is target device address. Second parameter is list of clusters to unbind (string of clusters separated by ","). |
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
CommandLockLevelsState |
DataState | ||
DefaultOnOffState |
DiscreteState | off, on, previous, togglePrevious, unknown | cluster:6 |
DiscreteRSSILevelState |
DiscreteState | good, low, normal, verylow | |
FirmwareRevisionState |
DataState | ||
LinkQualityIndicatorState |
ContinuousState | ||
ManufacturerNameState |
DataState | cluster:0 | |
OffWaitTimeState |
ContinuousState | cluster:6 | |
OnOffState |
DiscreteState | on, off | cluster:6 |
OnTimeReloadOptionsState |
DiscreteState | enable, disable | cluster:6 |
OnTimeReloadState |
DataState | cluster:6 | |
PowerSourceState |
DiscreteState | Unknown, Mains (single phase), Mains (3 phase), Battery, DC source, Emergency mains constantly powered, Emergency mains and transfer switch | cluster:0 |
PreWarningTimeState |
DataState | cluster:6 | |
ProductModelNameState |
DataState | cluster:0 | |
RSSILevelState |
ContinuousState | ||
StatusState |
DiscreteState | available, unavailable | |
ZigbeeUpdateDownloadProgressState |
ContinuousState | ||
ZigbeeUpdateState |
DiscreteState | idle, running, error-timeout, error-default-initial-condition, error-on-upgrade, success, error-abort, error-not-authorized, error-invalid-image, error-wait-for-data, error-no-image-available, error-malformed-command, error-require-more-image |
Light/DimmerLight (ACTUATOR) — 23 commands, 20 states
Type IDs: 2269319856384, 2269319856385 | Servers: atlantic_cozytouch, rexel, somfy_europe | Controllable: zigbee:SchneiderLightComponent | Profiles: StatefulLightDimmer, StatefulDimmable, StatefulSwitchable, Dimmable, Switchable
Data Properties
core:identifyInterval=500core:useControllableForGroup=zigbee:GroupLightComponent
Commands
| Command | Parameters | Notes |
|---|---|---|
addLockLevel |
INT; INT (optional) | Add a command lock level on the device p1 : The lock level to add p2 : (optional) Duration in second of the lock Level. By default there is no expiration.; cluster:0 |
advancedRefresh |
STRING: normal, advanced | Refresh extra states; cluster:0; cluster:6 |
bind |
STRING; STRING | Bind a device with another device. First parameter is target device address. Second parameter is list of clusters to bind (string of clusters separated by ","). |
identify |
Ask the device to identify itself by doing a slight movement or blink or beep; cluster:3 | |
off |
Turn off the device; cluster:6 | |
on |
Turn on the device; cluster:6 | |
onWithTimer |
INT [5..14400] | Turn the device on for a given amount of seconds then turn it off; cluster:6 |
ping |
Check if device is available; cluster:3 | |
removeLockLevel |
INT | Remove the command lock level on the device p1 : The lock level to remove; cluster:0 |
resetLockLevels |
Remove all lock levels on the device; cluster:0 | |
setDefaultOnOffState |
STRING: off, on, previous, togglePrevious | set the Default Output State; cluster:6 |
setIntensity |
INT [0..100] | Light intensity level (100%=maximum intensity, 0%=off); cluster:8 |
setIntensityWithTimer |
INT [0..100]; INT [5..14400]; INT [0..100] (optional) | Set the light intensity to p1% then after p2 seconds, set it to p3%. (If p3 is not specified the light is turned off after the delay); cluster:8 |
setOffWaitTime |
FLOAT [0.0..6553.5] | Set the timer that the "off" state shall be guarded to prevent an "on" command turning the device back to its "on" state; cluster:6 |
setOnIntensity |
INT [0..100]; STRING: previous | Light intensity level when the device is turned on (100%=maximum intensity, 0%=off). Some devices support previous intensity. If the parameter is at "previous" then the switching on intensity will be that which had been set when switching off; cluster:8 |
setOnOff |
STRING: off, on | Turn the device on or off; cluster:6 |
setSchneiderOnTimeReload |
INT [0..4294967295] | Set the number of seconds before the light is automaticaly switched off; cluster:6 |
setSchneiderOnTimeReloadOptions |
STRING: enable, disable | Enable or disable cancellation for automatic off timer. If enable : timer can be cancelled by receiving OFF command (light goes off immediately) If disable : timer can not be cancelled, is always restarted; cluster:6 |
setSchneiderPreWarningTime |
INT [0..6553] | Set the number of seconds before the light is switched off automatically during which the user is informed that the light will be switched off automaticaly; cluster:6 |
setStartUpCurrentLevel |
STRING: min, previous; INT [0..100] | p1: min => set the current level on the minimum allow by the device previous => set the value to the state saved on the device integer[0-100] => set the custom intesity on start up.; cluster:8 |
stopIdentify |
Ask the device to stop winking immediately; cluster:3 | |
toggle |
Toggle on/off status; cluster:6 | |
unbind |
STRING; STRING | Unbind a device with another device. First parameter is target device address. Second parameter is list of clusters to unbind (string of clusters separated by ","). |
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
CommandLockLevelsState |
DataState | ||
DefaultOnOffState |
DiscreteState | off, on, previous, togglePrevious, unknown | cluster:6 |
DiscreteRSSILevelState |
DiscreteState | good, low, normal, verylow | |
FirmwareRevisionState |
DataState | ||
LightIntensityState |
ContinuousState | [0..100] | cluster:8 |
LightOnIntensityState |
ContinuousState | cluster:8 | |
LinkQualityIndicatorState |
ContinuousState | ||
ManufacturerNameState |
DataState | cluster:0 | |
OffWaitTimeState |
ContinuousState | cluster:6 | |
OnOffState |
DiscreteState | on, off | cluster:6 |
OnTimeReloadOptionsState |
DiscreteState | enable, disable | cluster:6 |
OnTimeReloadState |
DataState | cluster:6 | |
PowerSourceState |
DiscreteState | Unknown, Mains (single phase), Mains (3 phase), Battery, DC source, Emergency mains constantly powered, Emergency mains and transfer switch | cluster:0 |
PreWarningTimeState |
DataState | cluster:6 | |
ProductModelNameState |
DataState | cluster:0 | |
RSSILevelState |
ContinuousState | ||
StartUpCurrentLevelState |
DataState | cluster:8 | |
StatusState |
DiscreteState | available, unavailable | |
ZigbeeUpdateDownloadProgressState |
ContinuousState | ||
ZigbeeUpdateState |
DiscreteState | idle, running, error-timeout, error-default-initial-condition, error-on-upgrade, success, error-abort, error-not-authorized, error-invalid-image, error-wait-for-data, error-no-image-available, error-malformed-command, error-require-more-image |
LightSensor/LuminanceSensor (SENSOR) — 6 commands, 15 states
Type IDs: 2199023322624, 2269320053263 | Servers: atlantic_cozytouch, rexel, somfy_europe | Controllable: zigbee:LightSensorComponent | Profiles: Luminance
Data Properties
core:identifyInterval=500
Commands
| Command | Parameters | Notes |
|---|---|---|
advancedRefresh |
STRING: normal, advanced | Refresh extra states; cluster:1024 |
bind |
STRING; STRING | Bind a device with another device. First parameter is target device address. Second parameter is list of clusters to bind (string of clusters separated by ","). |
identify |
Ask the device to identify itself by doing a slight movement or blink or beep; cluster:3 | |
ping |
Check if device is available; cluster:3 | |
stopIdentify |
Ask the device to stop winking immediately; cluster:3 | |
unbind |
STRING; STRING | Unbind a device with another device. First parameter is target device address. Second parameter is list of clusters to unbind (string of clusters separated by ","). |
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
DiscreteRSSILevelState |
DiscreteState | good, low, normal, verylow | |
FirmwareRevisionState |
DataState | ||
LinkQualityIndicatorState |
ContinuousState | ||
LuminanceState |
ContinuousState | cluster:1024 | |
ManufacturerNameState |
DataState | cluster:0 | |
MaxMeasuredValueState |
DataState | cluster:1024 | |
MinMeasuredValueState |
DataState | cluster:1024 | |
PowerSourceState |
DiscreteState | Unknown, Mains (single phase), Mains (3 phase), Battery, DC source, Emergency mains constantly powered, Emergency mains and transfer switch | cluster:0 |
ProductModelNameState |
DataState | cluster:0 | |
RSSILevelState |
ContinuousState | ||
SensorTypeState |
DataState | cluster:1024 | |
StatusState |
DiscreteState | available, unavailable | |
ToleranceState |
DataState | cluster:1024 | |
ZigbeeUpdateDownloadProgressState |
ContinuousState | ||
ZigbeeUpdateState |
DiscreteState | idle, running, error-timeout, error-default-initial-condition, error-on-upgrade, success, error-abort, error-not-authorized, error-invalid-image, error-wait-for-data, error-no-image-available, error-malformed-command, error-require-more-image |
OccupancySensor/MotionSensor (SENSOR) — 6 commands, 13 states
Type IDs: 2199023518209, 2269320053249, 2269320053263 | Servers: atlantic_cozytouch, rexel, somfy_europe | Controllable: zigbee:MotionSensorComponent | Profiles: OccupancyDetector
Data Properties
core:identifyInterval=500
Commands
| Command | Parameters | Notes |
|---|---|---|
advancedRefresh |
STRING: normal, advanced | Refresh extra states; cluster:0 |
bind |
STRING; STRING | Bind a device with another device. First parameter is target device address. Second parameter is list of clusters to bind (string of clusters separated by ","). |
identify |
Ask the device to identify itself by doing a slight movement or blink or beep; cluster:3 | |
ping |
Check if device is available; cluster:3 | |
stopIdentify |
Ask the device to stop winking immediately; cluster:3 | |
unbind |
STRING; STRING | Unbind a device with another device. First parameter is target device address. Second parameter is list of clusters to unbind (string of clusters separated by ","). |
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
BatteryLevelState |
ContinuousState | cluster:1 | |
DiscreteRSSILevelState |
DiscreteState | good, low, normal, verylow | |
FirmwareRevisionState |
DataState | ||
LinkQualityIndicatorState |
ContinuousState | ||
LowBatteryThresholdState |
ContinuousState | cluster:1 | |
ManufacturerNameState |
DataState | cluster:0 | |
OccupancyState |
DiscreteState | personInside, noPersonInside | cluster:1280 |
PowerSourceState |
DiscreteState | Unknown, Mains (single phase), Mains (3 phase), Battery, DC source, Emergency mains constantly powered, Emergency mains and transfer switch | cluster:0 |
ProductModelNameState |
DataState | cluster:0 | |
RSSILevelState |
ContinuousState | ||
StatusState |
DiscreteState | available, unavailable | |
ZigbeeUpdateDownloadProgressState |
ContinuousState | ||
ZigbeeUpdateState |
DiscreteState | idle, running, error-timeout, error-default-initial-condition, error-on-upgrade, success, error-abort, error-not-authorized, error-invalid-image, error-wait-for-data, error-no-image-available, error-malformed-command, error-require-more-image |
OccupancySensor (SENSOR) — 6 commands, 11 states
Type IDs: 2199023322880 | Servers: atlantic_cozytouch, rexel, somfy_europe | Controllable: zigbee:OccupancySensorComponent | Profiles: OccupancyDetector
Data Properties
core:identifyInterval=500
Commands
| Command | Parameters | Notes |
|---|---|---|
advancedRefresh |
STRING: normal, advanced | Refresh extra states; cluster:0 |
bind |
STRING; STRING | Bind a device with another device. First parameter is target device address. Second parameter is list of clusters to bind (string of clusters separated by ","). |
identify |
Ask the device to identify itself by doing a slight movement or blink or beep; cluster:3 | |
ping |
Check if device is available; cluster:3 | |
stopIdentify |
Ask the device to stop winking immediately; cluster:3 | |
unbind |
STRING; STRING | Unbind a device with another device. First parameter is target device address. Second parameter is list of clusters to unbind (string of clusters separated by ","). |
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
DiscreteRSSILevelState |
DiscreteState | good, low, normal, verylow | |
FirmwareRevisionState |
DataState | ||
LinkQualityIndicatorState |
ContinuousState | ||
ManufacturerNameState |
DataState | cluster:0 | |
OccupancyState |
DiscreteState | personInside, noPersonInside | cluster:1030 |
PowerSourceState |
DiscreteState | Unknown, Mains (single phase), Mains (3 phase), Battery, DC source, Emergency mains constantly powered, Emergency mains and transfer switch | cluster:0 |
ProductModelNameState |
DataState | cluster:0 | |
RSSILevelState |
ContinuousState | ||
StatusState |
DiscreteState | available, unavailable | |
ZigbeeUpdateDownloadProgressState |
ContinuousState | ||
ZigbeeUpdateState |
DiscreteState | idle, running, error-timeout, error-default-initial-condition, error-on-upgrade, success, error-abort, error-not-authorized, error-invalid-image, error-wait-for-data, error-no-image-available, error-malformed-command, error-require-more-image |
OnOff/StatefulOnOff (ACTUATOR) — 14 commands, 12 states
Type IDs: 2199023256064, 2199023257856, 2199023276288, 2199023276289, 2199023276290, 2199023323648, 2268296446720, 2268296448513 | Servers: atlantic_cozytouch, rexel, somfy_europe | Controllable: zigbee:OnOffComponent | Profiles: StatefulSwitchablePlug, StatefulSwitchable, Switchable
Data Properties
core:identifyInterval=500core:useControllableForGroup=zigbee:GroupOnOffComponent
Commands
| Command | Parameters | Notes |
|---|---|---|
addLockLevel |
INT; INT (optional) | Add a command lock level on the device p1 : The lock level to add p2 : (optional) Duration in second of the lock Level. By default there is no expiration.; cluster:0 |
advancedRefresh |
STRING: normal, advanced | Refresh extra states; cluster:0 |
bind |
STRING; STRING | Bind a device with another device. First parameter is target device address. Second parameter is list of clusters to bind (string of clusters separated by ","). |
identify |
Ask the device to identify itself by doing a slight movement or blink or beep; cluster:3 | |
off |
Turn off the device; cluster:6 | |
on |
Turn on the device; cluster:6 | |
onWithTimer |
INT [5..14400] | Turn the device on for a given amount of seconds then turn it off; cluster:6 |
ping |
Check if device is available; cluster:3 | |
removeLockLevel |
INT | Remove the command lock level on the device p1 : The lock level to remove; cluster:0 |
resetLockLevels |
Remove all lock levels on the device; cluster:0 | |
setOnOff |
STRING: off, on | Turn the device on or off; cluster:6 |
stopIdentify |
Ask the device to stop winking immediately; cluster:3 | |
toggle |
Toggle on/off status; cluster:6 | |
unbind |
STRING; STRING | Unbind a device with another device. First parameter is target device address. Second parameter is list of clusters to unbind (string of clusters separated by ","). |
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
CommandLockLevelsState |
DataState | ||
DiscreteRSSILevelState |
DiscreteState | good, low, normal, verylow | |
FirmwareRevisionState |
DataState | ||
LinkQualityIndicatorState |
ContinuousState | ||
ManufacturerNameState |
DataState | cluster:0 | |
OnOffState |
DiscreteState | on, off | cluster:6 |
PowerSourceState |
DiscreteState | Unknown, Mains (single phase), Mains (3 phase), Battery, DC source, Emergency mains constantly powered, Emergency mains and transfer switch | cluster:0 |
ProductModelNameState |
DataState | cluster:0 | |
RSSILevelState |
ContinuousState | ||
StatusState |
DiscreteState | available, unavailable | |
ZigbeeUpdateDownloadProgressState |
ContinuousState | ||
ZigbeeUpdateState |
DiscreteState | idle, running, error-timeout, error-default-initial-condition, error-on-upgrade, success, error-abort, error-not-authorized, error-invalid-image, error-wait-for-data, error-no-image-available, error-malformed-command, error-require-more-image |
ProtocolGateway/ZigbeeStack (PROTOCOL_GATEWAY) — 0 commands, 0 states
Type IDs: 0, 2 | Servers: atlantic_cozytouch, rexel, somfy_europe | Controllable: zigbee:TransceiverV3_0Component | Profiles: Specific
ProtocolGateway/ZigbeeStack (PROTOCOL_GATEWAY) — 6 commands, 5 states
Type IDs: 1099511648256 | Servers: atlantic_cozytouch, rexel, somfy_europe | Controllable: zigbee:StackComponent | Profiles: Specific
Commands
| Command | Parameters | Notes |
|---|---|---|
bind |
STRING; STRING | Bind a device with another device. First parameter is target device address. Second parameter is list of clusters to bind (string of clusters separated by ","). |
bindingNetwork |
Ask the device to bind its state to box | |
closeNetwork |
Ask the device to close network | |
openNetwork |
INT [0..300] | (Deprecated) Ask the device to open network over the number of seconds use as parameter. |
refreshNetwork |
Retrieve all node on network | |
unbind |
STRING; STRING | Unbind a device with another device. First parameter is target device address. Second parameter is list of clusters to unbind (string of clusters separated by ","). |
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
DiscreteRSSILevelState |
DiscreteState | good, low, normal, verylow | |
LinkQualityIndicatorState |
ContinuousState | ||
ManufacturerNameState |
DataState | cluster:0 | |
ProductModelNameState |
DataState | cluster:0 | |
RSSILevelState |
ContinuousState |
ProtocolGateway/ZigbeeStack (PROTOCOL_GATEWAY) — 9 commands, 5 states
Type IDs: 1099511648257 | Servers: atlantic_cozytouch, rexel, somfy_europe | Controllable: zigbee:StackV3Component | Profiles: Specific
Commands
| Command | Parameters | Notes |
|---|---|---|
bind |
STRING; STRING | Bind a device with another device. First parameter is target device address. Second parameter is list of clusters to bind (string of clusters separated by ","). |
bindingNetwork |
Ask the device to bind its state to box | |
closeNetwork |
Ask the device to close network | |
closeNetworkManagement |
Ask the device to close network management | |
openNetwork |
INT [0..300] | (Deprecated) Ask the device to open network over the number of seconds use as parameter. |
openNetworkManagement |
Ask the device to open network management without any security restriction over 180 seconds. | |
openNetworkWithCommissioningManagement |
Open network over 180 seconds only to devices which have right commissioning code. | |
refreshNetwork |
Retrieve all node on network | |
unbind |
STRING; STRING | Unbind a device with another device. First parameter is target device address. Second parameter is list of clusters to unbind (string of clusters separated by ","). |
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
DiscreteRSSILevelState |
DiscreteState | good, low, normal, verylow | |
LinkQualityIndicatorState |
ContinuousState | ||
ManufacturerNameState |
DataState | cluster:0 | |
ProductModelNameState |
DataState | cluster:0 | |
RSSILevelState |
ContinuousState |
RemoteController/EmptyRemoteController (REMOTE_CONTROLLER) — 2 commands, 12 states
Type IDs: 2199023321856, 2199023322112, 2199023322368, 2199023387392, 2199023779840, 2199023783936, 2199023788032, 2199023792128, 2268296446976, 2268296512256 | Servers: atlantic_cozytouch, rexel, somfy_europe | Controllable: zigbee:ZigbeeRemoteComponent | Profiles: Specific
Commands
| Command | Parameters | Notes |
|---|---|---|
bind |
STRING; STRING | Bind a device with another device. First parameter is target device address. Second parameter is list of clusters to bind (string of clusters separated by ","). |
unbind |
STRING; STRING | Unbind a device with another device. First parameter is target device address. Second parameter is list of clusters to unbind (string of clusters separated by ","). |
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
BatteryLevelState |
ContinuousState | cluster:1 | |
DiscreteRSSILevelState |
DiscreteState | good, low, normal, verylow | |
FirmwareRevisionState |
DataState | ||
LinkQualityIndicatorState |
ContinuousState | ||
LowBatteryThresholdState |
ContinuousState | cluster:1 | |
ManufacturerNameState |
DataState | cluster:0 | |
PowerSourceState |
DiscreteState | Unknown, Mains (single phase), Mains (3 phase), Battery, DC source, Emergency mains constantly powered, Emergency mains and transfer switch | cluster:0 |
ProductModelNameState |
DataState | cluster:0 | |
RSSILevelState |
ContinuousState | ||
StatusState |
DiscreteState | available, unavailable | |
ZigbeeUpdateDownloadProgressState |
ContinuousState | ||
ZigbeeUpdateState |
DiscreteState | idle, running, error-timeout, error-default-initial-condition, error-on-upgrade, success, error-abort, error-not-authorized, error-invalid-image, error-wait-for-data, error-no-image-available, error-malformed-command, error-require-more-image |
RollerShutter/PositionableRollerShutter (ACTUATOR) — 14 commands, 12 states
Type IDs: 2199023386624, 2199023387142 | Servers: atlantic_cozytouch, rexel, somfy_europe | Controllable: zigbee:RollerShutterComponent | Profiles: StatefulCloseableShutter, StatefulCloseable, Closeable, OpenClose
Data Properties
core:identifyInterval=500
Commands
| Command | Parameters | Notes |
|---|---|---|
addLockLevel |
INT; INT (optional) | Add a command lock level on the device p1 : The lock level to add p2 : (optional) Duration in second of the lock Level. By default there is no expiration.; cluster:0 |
advancedRefresh |
STRING: normal, advanced | Refresh extra states; cluster:0 |
bind |
STRING; STRING | Bind a device with another device. First parameter is target device address. Second parameter is list of clusters to bind (string of clusters separated by ","). |
close |
Fully close the device | |
identify |
Ask the device to identify itself by doing a slight movement or blink or beep; cluster:3 | |
open |
Fully open the device | |
ping |
Check if device is available; cluster:3 | |
removeLockLevel |
INT | Remove the command lock level on the device p1 : The lock level to remove; cluster:0 |
resetLockLevels |
Remove all lock levels on the device; cluster:0 | |
setClosure |
INT [0..100] | Closure level (100%=fully close, 0%=open) |
setPosition |
INT [0..100] | Set the device to a pre-defined position (enum) or a relative position (0-100%); cluster:8 |
stop |
Stop the current actuator behavior (movement, sound or timer); cluster:258 | |
stopIdentify |
Ask the device to stop winking immediately; cluster:3 | |
unbind |
STRING; STRING | Unbind a device with another device. First parameter is target device address. Second parameter is list of clusters to unbind (string of clusters separated by ","). |
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
ClosureState |
ContinuousState | [0..100] | cluster:8 |
CommandLockLevelsState |
DataState | ||
DiscreteRSSILevelState |
DiscreteState | good, low, normal, verylow | |
FirmwareRevisionState |
DataState | ||
LinkQualityIndicatorState |
ContinuousState | ||
ManufacturerNameState |
DataState | cluster:0 | |
PowerSourceState |
DiscreteState | Unknown, Mains (single phase), Mains (3 phase), Battery, DC source, Emergency mains constantly powered, Emergency mains and transfer switch | cluster:0 |
ProductModelNameState |
DataState | cluster:0 | |
RSSILevelState |
ContinuousState | ||
StatusState |
DiscreteState | available, unavailable | |
ZigbeeUpdateDownloadProgressState |
ContinuousState | ||
ZigbeeUpdateState |
DiscreteState | idle, running, error-timeout, error-default-initial-condition, error-on-upgrade, success, error-abort, error-not-authorized, error-invalid-image, error-wait-for-data, error-no-image-available, error-malformed-command, error-require-more-image |
Screen/PositionableScreen (ACTUATOR) — 15 commands, 23 states
Type IDs: 2199023387136, 2199023387137, 2199023387143, 2199023387145 | Servers: atlantic_cozytouch, rexel, somfy_europe | Controllable: zigbee:RollerShadeComponent | Profiles: StatefulCloseableScreen, StatefulCloseable, Closeable, OpenClose
Data Properties
core:identifyInterval=500
Commands
| Command | Parameters | Notes |
|---|---|---|
addLockLevel |
INT; INT (optional) | Add a command lock level on the device p1 : The lock level to add p2 : (optional) Duration in second of the lock Level. By default there is no expiration.; cluster:0 |
advancedRefresh |
STRING: normal, advanced | Refresh extra states; cluster:0; cluster:258 |
bind |
STRING; STRING | Bind a device with another device. First parameter is target device address. Second parameter is list of clusters to bind (string of clusters separated by ","). |
close |
Fully close the device; cluster:258 | |
identify |
Ask the device to identify itself by doing a slight movement or blink or beep; cluster:3 | |
open |
Fully open the device; cluster:258 | |
ping |
Check if device is available; cluster:3 | |
removeLockLevel |
INT | Remove the command lock level on the device p1 : The lock level to remove; cluster:0 |
resetLockLevels |
Remove all lock levels on the device; cluster:0 | |
setClosure |
INT [0..100] | Closure level (100%=fully close, 0%=open); cluster:258 |
setModes |
OBJECT | Set modes, all modes must be specified. - motorDirection: string(normal;reversed), the reversal of the motor rotating direction associated with commands. - motorRunMode: string(normal;calibration), placing the motor into Calibration Mode where limits are either setup using physical tools or limits are learned by the controller based on physical setup of the Window Covering by an installer - motorRunningMode: string(normal;maintenance), placing the motor into Maintenance Mode where the motor cannot be moved over the network or by a switch connected to a Local Switch Input. - motorLedFeedback: string(enable;disable), the display of any feedback LEDs. Example: { "motorDirection":"reversed", "motorRunMode":"normal", "motorRunningMode":"normal", "motorLedFeedback":"enable" }; cluster:258 |
setPosition |
INT [0..100] | Set the device to a pre-defined position (enum) or a relative position (0-100%); cluster:258 |
stop |
Stop the current actuator behavior (movement, sound or timer); cluster:258 | |
stopIdentify |
Ask the device to stop winking immediately; cluster:3 | |
unbind |
STRING; STRING | Unbind a device with another device. First parameter is target device address. Second parameter is list of clusters to unbind (string of clusters separated by ","). |
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
ClosureState |
ContinuousState | [0..100] | cluster:258 |
CommandLockLevelsState |
DataState | ||
ControlLiftState |
DiscreteState | lift control is open loop, lift control is closed loop | cluster:258 |
ControlTiltState |
DiscreteState | tilt control is closed loop, tilt control is open loop | cluster:258 |
DirectionState |
DiscreteState | counterClockwise, clockwise | cluster:258 |
DiscreteRSSILevelState |
DiscreteState | good, low, normal, verylow | |
EncoderLiftState |
DiscreteState | encoder controlled, timer controlled | cluster:258 |
EncoderTiltState |
DiscreteState | encoder controlled, timer controlled | cluster:258 |
FirmwareRevisionState |
DataState | ||
LinkQualityIndicatorState |
ContinuousState | ||
ManufacturerNameState |
DataState | cluster:0 | |
MotorLEDFeedbackState |
DiscreteState | LEDs will display feedback, LEDs are off | cluster:258 |
MotorRunModeState |
DiscreteState | run in calibration mode, run in normal mode | cluster:258 |
MotorRunningModeState |
DiscreteState | motor is running in maintenance mode, motor is running normally | cluster:258 |
NetworkOnlineState |
DiscreteState | online, not online | cluster:258 |
OperationalStatusState |
DataState | cluster:258 | |
PowerSourceState |
DiscreteState | Unknown, Mains (single phase), Mains (3 phase), Battery, DC source, Emergency mains constantly powered, Emergency mains and transfer switch | cluster:0 |
ProductModelNameState |
DataState | cluster:0 | |
RSSILevelState |
ContinuousState | ||
ReversalLiftState |
DiscreteState | reversal lift commands, not reversal lift commands | cluster:258 |
StatusState |
DiscreteState | available, unavailable | |
ZigbeeUpdateDownloadProgressState |
ContinuousState | ||
ZigbeeUpdateState |
DiscreteState | idle, running, error-timeout, error-default-initial-condition, error-on-upgrade, success, error-abort, error-not-authorized, error-invalid-image, error-wait-for-data, error-no-image-available, error-malformed-command, error-require-more-image |
SmokeSensor (SENSOR) — 6 commands, 13 states
Type IDs: 2199023518211 | Servers: atlantic_cozytouch, rexel, somfy_europe | Controllable: zigbee:SmokeSensorComponent | Profiles: SmokeDetector
Data Properties
core:identifyInterval=500
Commands
| Command | Parameters | Notes |
|---|---|---|
advancedRefresh |
STRING: normal, advanced | Refresh extra states; cluster:0 |
bind |
STRING; STRING | Bind a device with another device. First parameter is target device address. Second parameter is list of clusters to bind (string of clusters separated by ","). |
identify |
Ask the device to identify itself by doing a slight movement or blink or beep; cluster:3 | |
ping |
Check if device is available; cluster:3 | |
stopIdentify |
Ask the device to stop winking immediately; cluster:3 | |
unbind |
STRING; STRING | Unbind a device with another device. First parameter is target device address. Second parameter is list of clusters to unbind (string of clusters separated by ","). |
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
BatteryLevelState |
ContinuousState | cluster:1 | |
DiscreteRSSILevelState |
DiscreteState | good, low, normal, verylow | |
FirmwareRevisionState |
DataState | ||
LinkQualityIndicatorState |
ContinuousState | ||
LowBatteryThresholdState |
ContinuousState | cluster:1 | |
ManufacturerNameState |
DataState | cluster:0 | |
PowerSourceState |
DiscreteState | Unknown, Mains (single phase), Mains (3 phase), Battery, DC source, Emergency mains constantly powered, Emergency mains and transfer switch | cluster:0 |
ProductModelNameState |
DataState | cluster:0 | |
RSSILevelState |
ContinuousState | ||
SmokeState |
DiscreteState | detected, notDetected | cluster:1280 |
StatusState |
DiscreteState | available, unavailable | |
ZigbeeUpdateDownloadProgressState |
ContinuousState | ||
ZigbeeUpdateState |
DiscreteState | idle, running, error-timeout, error-default-initial-condition, error-on-upgrade, success, error-abort, error-not-authorized, error-invalid-image, error-wait-for-data, error-no-image-available, error-malformed-command, error-require-more-image |
TemperatureSensor (SENSOR) — 6 commands, 13 states
Type IDs: 2277859590432 | Servers: atlantic_cozytouch, rexel, somfy_europe | Controllable: zigbee:SimpleTemperatureSensorComponent | Profiles: Temperature
Data Properties
core:identifyInterval=500
Commands
| Command | Parameters | Notes |
|---|---|---|
advancedRefresh |
STRING: normal, advanced | Refresh extra states; cluster:0 |
bind |
STRING; STRING | Bind a device with another device. First parameter is target device address. Second parameter is list of clusters to bind (string of clusters separated by ","). |
identify |
Ask the device to identify itself by doing a slight movement or blink or beep; cluster:3 | |
ping |
Check if device is available; cluster:3 | |
stopIdentify |
Ask the device to stop winking immediately; cluster:3 | |
unbind |
STRING; STRING | Unbind a device with another device. First parameter is target device address. Second parameter is list of clusters to unbind (string of clusters separated by ","). |
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
DiscreteRSSILevelState |
DiscreteState | good, low, normal, verylow | |
FirmwareRevisionState |
DataState | ||
LinkQualityIndicatorState |
ContinuousState | ||
ManufacturerNameState |
DataState | cluster:0 | |
MaxMeasuredValueState |
DataState | cluster:513 | |
MinMeasuredValueState |
DataState | cluster:513 | |
PowerSourceState |
DiscreteState | Unknown, Mains (single phase), Mains (3 phase), Battery, DC source, Emergency mains constantly powered, Emergency mains and transfer switch | cluster:0 |
ProductModelNameState |
DataState | cluster:0 | |
RSSILevelState |
ContinuousState | ||
StatusState |
DiscreteState | available, unavailable | |
TemperatureState |
ContinuousState | [-100.0..100.0] | cluster:513 |
ZigbeeUpdateDownloadProgressState |
ContinuousState | ||
ZigbeeUpdateState |
DiscreteState | idle, running, error-timeout, error-default-initial-condition, error-on-upgrade, success, error-abort, error-not-authorized, error-invalid-image, error-wait-for-data, error-no-image-available, error-malformed-command, error-require-more-image |
TemperatureSensor (SENSOR) — 6 commands, 16 states
Type IDs: 2199023452672, 2199023452673, 2269319987712 | Servers: atlantic_cozytouch, rexel, somfy_europe | Controllable: zigbee:TemperatureSensorComponent | Profiles: Temperature
Data Properties
core:identifyInterval=500
Commands
| Command | Parameters | Notes |
|---|---|---|
advancedRefresh |
STRING: normal, advanced | Refresh extra states; cluster:0 |
bind |
STRING; STRING | Bind a device with another device. First parameter is target device address. Second parameter is list of clusters to bind (string of clusters separated by ","). |
identify |
Ask the device to identify itself by doing a slight movement or blink or beep; cluster:3 | |
ping |
Check if device is available; cluster:3 | |
stopIdentify |
Ask the device to stop winking immediately; cluster:3 | |
unbind |
STRING; STRING | Unbind a device with another device. First parameter is target device address. Second parameter is list of clusters to unbind (string of clusters separated by ","). |
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
BatteryLevelState |
ContinuousState | cluster:1 | |
DiscreteRSSILevelState |
DiscreteState | good, low, normal, verylow | |
FirmwareRevisionState |
DataState | ||
LinkQualityIndicatorState |
ContinuousState | ||
LowBatteryThresholdState |
ContinuousState | cluster:1 | |
ManufacturerNameState |
DataState | cluster:0 | |
MaxMeasuredValueState |
DataState | cluster:1026 | |
MinMeasuredValueState |
DataState | cluster:1026 | |
PowerSourceState |
DiscreteState | Unknown, Mains (single phase), Mains (3 phase), Battery, DC source, Emergency mains constantly powered, Emergency mains and transfer switch | cluster:0 |
ProductModelNameState |
DataState | cluster:0 | |
RSSILevelState |
ContinuousState | ||
StatusState |
DiscreteState | available, unavailable | |
TemperatureState |
ContinuousState | [-100.0..100.0] | cluster:1026 |
ToleranceState |
DataState | cluster:1026 | |
ZigbeeUpdateDownloadProgressState |
ContinuousState | ||
ZigbeeUpdateState |
DiscreteState | idle, running, error-timeout, error-default-initial-condition, error-on-upgrade, success, error-abort, error-not-authorized, error-invalid-image, error-wait-for-data, error-no-image-available, error-malformed-command, error-require-more-image |
VenetianBlind/PositionableVenetianBlind (ACTUATOR) — 17 commands, 24 states
Type IDs: 2199023387144 | Servers: atlantic_cozytouch, rexel, somfy_europe | Controllable: zigbee:InteriorBlindComponent | Profiles: StatefulOrientableAndCloseableShutter, StatefulOrientableAndCloseable, OrientableAndCloseable, OpenClose
Data Properties
core:identifyInterval=500
Commands
| Command | Parameters | Notes |
|---|---|---|
addLockLevel |
INT; INT (optional) | Add a command lock level on the device p1 : The lock level to add p2 : (optional) Duration in second of the lock Level. By default there is no expiration.; cluster:0 |
advancedRefresh |
STRING: normal, advanced | Refresh extra states; cluster:0; cluster:258 |
bind |
STRING; STRING | Bind a device with another device. First parameter is target device address. Second parameter is list of clusters to bind (string of clusters separated by ","). |
close |
Fully close the device; cluster:258 | |
identify |
Ask the device to identify itself by doing a slight movement or blink or beep; cluster:3 | |
open |
Fully open the device; cluster:258 | |
ping |
Check if device is available; cluster:3 | |
removeLockLevel |
INT | Remove the command lock level on the device p1 : The lock level to remove; cluster:0 |
resetLockLevels |
Remove all lock levels on the device; cluster:0 | |
setClosure |
INT [0..100] | Closure level (100%=fully close, 0%=open); cluster:258 |
setClosureAndOrientation |
INT [0..100]; INT [0..100] | Set both the closure level (0-100%) and relative slats orientation (0-100%) of the device; cluster:258 |
setModes |
OBJECT | Set modes, all modes must be specified. - motorDirection: string(normal;reversed), the reversal of the motor rotating direction associated with commands. - motorRunMode: string(normal;calibration), placing the motor into Calibration Mode where limits are either setup using physical tools or limits are learned by the controller based on physical setup of the Window Covering by an installer - motorRunningMode: string(normal;maintenance), placing the motor into Maintenance Mode where the motor cannot be moved over the network or by a switch connected to a Local Switch Input. - motorLedFeedback: string(enable;disable), the display of any feedback LEDs. Example: { "motorDirection":"reversed", "motorRunMode":"normal", "motorRunningMode":"normal", "motorLedFeedback":"enable" }; cluster:258 |
setOrientation |
INT [0..100] | Set the relative orientation (0-100%) of the device slats; cluster:258 |
setPosition |
INT [0..100] | Set the device to a pre-defined position (enum) or a relative position (0-100%); cluster:258 |
stop |
Stop the current actuator behavior (movement, sound or timer); cluster:258 | |
stopIdentify |
Ask the device to stop winking immediately; cluster:3 | |
unbind |
STRING; STRING | Unbind a device with another device. First parameter is target device address. Second parameter is list of clusters to unbind (string of clusters separated by ","). |
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
ClosureState |
ContinuousState | [0..100] | cluster:258 |
CommandLockLevelsState |
DataState | ||
ControlLiftState |
DiscreteState | lift control is open loop, lift control is closed loop | cluster:258 |
ControlTiltState |
DiscreteState | tilt control is closed loop, tilt control is open loop | cluster:258 |
DirectionState |
DiscreteState | counterClockwise, clockwise | cluster:258 |
DiscreteRSSILevelState |
DiscreteState | good, low, normal, verylow | |
EncoderLiftState |
DiscreteState | encoder controlled, timer controlled | cluster:258 |
EncoderTiltState |
DiscreteState | encoder controlled, timer controlled | cluster:258 |
FirmwareRevisionState |
DataState | ||
LinkQualityIndicatorState |
ContinuousState | ||
ManufacturerNameState |
DataState | cluster:0 | |
MotorLEDFeedbackState |
DiscreteState | LEDs will display feedback, LEDs are off | cluster:258 |
MotorRunModeState |
DiscreteState | run in calibration mode, run in normal mode | cluster:258 |
MotorRunningModeState |
DiscreteState | motor is running in maintenance mode, motor is running normally | cluster:258 |
NetworkOnlineState |
DiscreteState | online, not online | cluster:258 |
OperationalStatusState |
DataState | cluster:258 | |
PowerSourceState |
DiscreteState | Unknown, Mains (single phase), Mains (3 phase), Battery, DC source, Emergency mains constantly powered, Emergency mains and transfer switch | cluster:0 |
ProductModelNameState |
DataState | cluster:0 | |
RSSILevelState |
ContinuousState | ||
ReversalLiftState |
DiscreteState | reversal lift commands, not reversal lift commands | cluster:258 |
SlateOrientationState |
ContinuousState | [0..100] | cluster:258 |
StatusState |
DiscreteState | available, unavailable | |
ZigbeeUpdateDownloadProgressState |
ContinuousState | ||
ZigbeeUpdateState |
DiscreteState | idle, running, error-timeout, error-default-initial-condition, error-on-upgrade, success, error-abort, error-not-authorized, error-invalid-image, error-wait-for-data, error-no-image-available, error-malformed-command, error-require-more-image |
WaterSensor/WaterDetectionSensor (SENSOR) — 6 commands, 13 states
Type IDs: 2199023518212, 2269320053252 | Servers: atlantic_cozytouch, rexel, somfy_europe | Controllable: zigbee:WaterLeakageSensorComponent | Profiles: WaterDetector
Data Properties
core:identifyInterval=500
Commands
| Command | Parameters | Notes |
|---|---|---|
advancedRefresh |
STRING: normal, advanced | Refresh extra states; cluster:0 |
bind |
STRING; STRING | Bind a device with another device. First parameter is target device address. Second parameter is list of clusters to bind (string of clusters separated by ","). |
identify |
Ask the device to identify itself by doing a slight movement or blink or beep; cluster:3 | |
ping |
Check if device is available; cluster:3 | |
stopIdentify |
Ask the device to stop winking immediately; cluster:3 | |
unbind |
STRING; STRING | Unbind a device with another device. First parameter is target device address. Second parameter is list of clusters to unbind (string of clusters separated by ","). |
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
BatteryLevelState |
ContinuousState | cluster:1 | |
DiscreteRSSILevelState |
DiscreteState | good, low, normal, verylow | |
FirmwareRevisionState |
DataState | ||
LinkQualityIndicatorState |
ContinuousState | ||
LowBatteryThresholdState |
ContinuousState | cluster:1 | |
ManufacturerNameState |
DataState | cluster:0 | |
PowerSourceState |
DiscreteState | Unknown, Mains (single phase), Mains (3 phase), Battery, DC source, Emergency mains constantly powered, Emergency mains and transfer switch | cluster:0 |
ProductModelNameState |
DataState | cluster:0 | |
RSSILevelState |
ContinuousState | ||
StatusState |
DiscreteState | available, unavailable | |
WaterDetectionState |
DiscreteState | detected, notDetected | cluster:1280 |
ZigbeeUpdateDownloadProgressState |
ContinuousState | ||
ZigbeeUpdateState |
DiscreteState | idle, running, error-timeout, error-default-initial-condition, error-on-upgrade, success, error-abort, error-not-authorized, error-invalid-image, error-wait-for-data, error-no-image-available, error-malformed-command, error-require-more-image |
ZWAVE
30 device types.
ConfigurationComponent/ZWaveConfiguration (ACTUATOR) — 3 commands, 2 states
Type IDs: 65535, 1103823437823, 1103840215039, 1103856992255 | Servers: rexel, somfy_europe | Controllable: zwave:ConfigurationV1ClassComponent | Profiles: Specific
Commands
| Command | Parameters | Notes |
|---|---|---|
refreshConfigurationParameter |
INT | Refresh the value of a given configuration paramter. WARNING : see the product datasheet to set correct parameters for your device! |
resetConfigurationParameter |
INT | Restore the default value of a given configuration parameter. WARNING : see the product datasheet to set correct parameter for your device! |
setConfigurationParameter |
INT; INT [1..2]; INT: 4; INT | Set a value to a given configuration parameter. p1 : parameter number p2 : parameter size value p3 : parameter value WARNING : see the product datasheet to set correct parameters for your device! |
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
ConfigurationParameterNumberState |
DataState | ||
ConfigurationParameterValueState |
DataState |
ConfigurationComponent/ZWaveConfiguration (ACTUATOR) — 2 commands, 2 states
Type IDs: 65535, 1103823437823, 1103840215039, 1103856992255 | Servers: rexel, somfy_europe | Controllable: zwave:WakeUpClassV1Component | Profiles: Specific
Commands
| Command | Parameters | Notes |
|---|---|---|
refreshWakeUpInterval |
Refresh wake up interval | |
setWakeUpInterval |
INT [0..16777215] | Set wake up interval in second |
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
WakeUpIntervalTimeState |
ContinuousState | ||
WakeUpNotificationTimeState |
DataState |
ConfigurationComponent/ZWaveConfiguration (ACTUATOR) — 3 commands, 6 states
Type IDs: 65535, 1103823437823, 1103840215039, 1103856992255 | Servers: rexel, somfy_europe | Controllable: zwave:WakeUpClassV2Component | Profiles: Specific
Commands
| Command | Parameters | Notes |
|---|---|---|
refreshWakeUpCapabilitiesInterval |
Refresh wake up capabilities interval | |
refreshWakeUpInterval |
Refresh wake up interval | |
setWakeUpInterval |
INT [0..16777215] | Set wake up interval in second |
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
WakeUpDefaultIntervalTimeState |
ContinuousState | ||
WakeUpIntervalTimeState |
ContinuousState | ||
WakeUpMaxIntervalTimeState |
ContinuousState | ||
WakeUpMinIntervalTimeState |
ContinuousState | ||
WakeUpNotificationTimeState |
DataState | ||
WakeUpStepIntervalTimeState |
ContinuousState |
ConfigurationComponent/ZWaveNodonConfiguration (ACTUATOR) — 22 commands, 10 states
Type IDs: 1103823372289, 1103823372290, 1103823372291 | Servers: rexel, somfy_europe | Controllable: zwave:NodonRemoteControllerConfigurationZWaveComponent | Profiles: Specific
Commands
| Command | Parameters | Notes |
|---|---|---|
refreshButton1And3ProfileConfiguration |
Refresh profile of button 1 and 3. | |
refreshButton1Configuration |
Refresh how button 1 behaves. | |
refreshButton2And4ProfileConfiguration |
Refresh profile of button 2 and 4. | |
refreshButton2Configuration |
Refresh how button 2 behaves. | |
refreshButton3Configuration |
Refresh how button 3 behaves. | |
refreshButton4Configuration |
Refresh how button 4 behaves. | |
refreshLedManagementConfiguration |
Refresh LED behaviour. | |
refreshSceneTypeConfiguration |
Refresh the choosen way of sending Scene to the gateway. | |
resetButton1And3ProfileConfiguration |
Reset profile of button 1 and 3. | |
resetButton1Configuration |
Reset how button 1 behaves. | |
resetButton2And4ProfileConfiguration |
Reset profile of button 2 and 4. | |
resetButton2Configuration |
Reset how button 2 behaves. | |
resetButton3Configuration |
Reset how button 3 behaves. | |
resetButton4Configuration |
Reset how button 4 behaves. | |
resetLedManagementConfiguration |
Reset LED behaviour. | |
setButton1And3ProfileConfiguration |
STRING: scene, mono, duo | Set profile of button 1 and 3. |
setButton1Configuration |
STRING: controlGroup, allSwitchOn, allSwitchOff | Set how button 1 behaves. |
setButton2And4ProfileConfiguration |
STRING: scene, mono, duo | Set profile of button 2 and 4. |
setButton2Configuration |
STRING: controlGroup, allSwitchOn, allSwitchOff | Set how button 2 behaves. |
setButton3Configuration |
STRING: controlGroup, allSwitchOn, allSwitchOff | Set how button 3 behaves. |
setButton4Configuration |
STRING: controlGroup, allSwitchOn, allSwitchOff | Set how button 4 behaves. |
setLedManagementConfiguration |
STRING: noLed, flashBlue, blinkToConfirm, flashAndBlinkToConfirm | Set LED behaviour. |
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
Button1And3ProfileConfigurationState |
DataState | ||
Button1ConfigurationState |
DataState | ||
Button2And4ProfileConfigurationState |
DataState | ||
Button2ConfigurationState |
DataState | ||
Button3ConfigurationState |
DataState | ||
Button4ConfigurationState |
DataState | ||
DeviceDefectState |
DiscreteState | failed | |
LedManagementConfigurationState |
DataState | ||
NeighboursAddressesState |
DataState | ||
ZWaveSceneTypeConfigurationState |
DiscreteState | associations, scenes |
ConsumptionSensor/BatterySensor (SENSOR) — 1 commands, 2 states
Type IDs: 65535, 1103823437823, 1103840215039, 1103856992255 | Servers: rexel, somfy_europe | Controllable: zwave:BatteryClassV1Component | Profiles: BatteryStatus
Commands
| Command | Parameters | Notes |
|---|---|---|
refreshBatteryLevel |
Refresh the battery level |
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
BatteryLevelState |
ContinuousState | ||
BatteryState |
DiscreteState | verylow, low, normal, full |
ConsumptionSensor/CumulativeElectricPowerConsumptionSensor (SENSOR) — 1 commands, 7 states
Type IDs: 65535, 1103823437823, 1103840215039, 1103856992255 | Servers: rexel, somfy_europe | Controllable: zwave:MeterClassV1Component | Profiles: ElectricEnergyConsumption
Commands
| Command | Parameters | Notes |
|---|---|---|
refreshMetering |
Refresh the current metering of the device. |
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
ElectricEnergyConsumptionState |
ContinuousState | ||
MeteringConsumptionState |
ContinuousState | ||
MeteringFlowRateInCubicFeetState |
ContinuousState | ||
MeteringFlowRateInCubicMeterState |
ContinuousState | ||
MeteringFlowRateInUsGallonState |
ContinuousState | ||
MeteringScaleState |
DiscreteState | A, M.S.T, UsGallons, V, W, cubicFeet, cubicMeters, kVAh, kWh, powerFactor, pulseCount | |
MeteringTypeState |
DiscreteState | Electric meter, Gas meter, Water meter |
ConsumptionSensor/CumulativeElectricPowerConsumptionSensor (SENSOR) — 3 commands, 15 states
Type IDs: 65535, 1103823437823, 1103840215039, 1103856992255 | Servers: rexel, somfy_europe | Controllable: zwave:MeterClassV2Component | Profiles: ElectricEnergyAndPower, ElectricPowerMeter, ElectricEnergyConsumption
Commands
| Command | Parameters | Notes |
|---|---|---|
refreshMeteringSupported |
Refresh the supported scales in a sub meter. | |
refreshMeteringWithSpecificScale |
STRING: kWh, kVAh, W, pulseCount, cubicMeters | Refresh the current metering of the device. |
resetMetering |
Used to reset ALL accumulated values stored in the meter device. |
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
ElectricEnergyConsumptionState |
ContinuousState | ||
ElectricPowerConsumptionState |
ContinuousState | ||
MeteringConsumptionInkVAhState |
ContinuousState | ||
MeteringConsumptionState |
ContinuousState | ||
MeteringFlowRateInCubicFeetState |
ContinuousState | ||
MeteringFlowRateInCubicMeterState |
ContinuousState | ||
MeteringFlowRateInUsGallonState |
ContinuousState | ||
MeteringPulseCountState |
ContinuousState | ||
MeteringScaleState |
DiscreteState | A, M.S.T, UsGallons, V, W, cubicFeet, cubicMeters, kVAh, kWh, powerFactor, pulseCount | |
MeteringTypeState |
DiscreteState | Electric meter, Gas meter, Water meter | |
ZWaveMeteringDeltaTimeState |
DataState | ||
ZWaveMeteringPreviousConsumptionState |
ContinuousState | ||
ZWaveSupportedMeteringResetState |
DataState | ||
ZWaveSupportedMeteringScaleState |
DataState | ||
ZWaveSupportedMeteringTypeState |
DataState |
ConsumptionSensor/CumulativeElectricPowerConsumptionSensor (SENSOR) — 3 commands, 18 states
Type IDs: 65535, 1103823437823, 1103840215039, 1103856992255 | Servers: rexel, somfy_europe | Controllable: zwave:MeterClassV3Component | Profiles: ElectricEnergyAndPower, ElectricPowerMeter, ElectricEnergyConsumption
Commands
| Command | Parameters | Notes |
|---|---|---|
refreshMeteringSupported |
Refresh the supported scales in a sub meter. | |
refreshMeteringWithSpecificScale |
STRING: kWh, kVAh, W, pulseCount, cubicMeters | Refresh the current metering of the device. |
resetMetering |
Used to reset ALL accumulated values stored in the meter device. |
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
ElectricCurrentState |
ContinuousState | ||
ElectricEnergyConsumptionState |
ContinuousState | ||
ElectricPowerConsumptionState |
ContinuousState | ||
ElectricVoltageState |
ContinuousState | ||
MeteringConsumptionInkVAhState |
ContinuousState | ||
MeteringConsumptionState |
ContinuousState | ||
MeteringFlowRateInCubicFeetState |
ContinuousState | ||
MeteringFlowRateInCubicMeterState |
ContinuousState | ||
MeteringFlowRateInUsGallonState |
ContinuousState | ||
MeteringPowerFactorState |
ContinuousState | ||
MeteringPulseCountState |
ContinuousState | ||
MeteringScaleState |
DiscreteState | A, M.S.T, UsGallons, V, W, cubicFeet, cubicMeters, kVAh, kWh, powerFactor, pulseCount | |
MeteringTypeState |
DiscreteState | Electric meter, Gas meter, Water meter | |
ZWaveMeteringDeltaTimeState |
DataState | ||
ZWaveMeteringPreviousConsumptionState |
ContinuousState | ||
ZWaveSupportedMeteringResetState |
DataState | ||
ZWaveSupportedMeteringScaleState |
DataState | ||
ZWaveSupportedMeteringTypeState |
DataState |
ContactSensor (SENSOR) — 1 commands, 1 states
Type IDs: 65535, 1103823437823, 1103840215039, 1103856992255 | Servers: rexel, somfy_europe | Controllable: zwave:DoorLockClassOpenCloseSensorComponent | Profiles: DoorOpeningStatus, OpeningStatus
Commands
| Command | Parameters | Notes |
|---|---|---|
refreshOpenCloseState |
Refresh the Open Close State |
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
OpenClosedState |
DiscreteState | open, closed |
DoorLock (ACTUATOR) — 14 commands, 1 states
Type IDs: 65535, 1103823437823, 1103840215039, 1103856992255 | Servers: rexel, somfy_europe | Controllable: zwave:DoorLockClassV1Component | Profiles: StatefulDoorLock, StatefulLock, LockStatus, Lock
Commands
| Command | Parameters | Notes |
|---|---|---|
disableInsideHandles |
Disable the inside handle of the door lock. | |
disableLockTimeout |
Set the door lock to constant operation. | |
disableOutsideHandles |
Disable the outside handle of the door lock. | |
enableInsideHandles |
Enable the inside handle of the door lock. | |
enableOutsideHandles |
Enable the outside handle of the door lock. | |
lock |
Lock the device | |
refreshDoorLockConfiguration |
Refresh the door lock configuration | |
refreshDoorLockMode |
Refresh a door lock operation. | |
refreshLockedUnlocked |
Refresh locked/unlocked state | |
setDoorLockConfiguration |
INT [0..253]; INT [0..59]; STRING: enabled, disabled; STRING: enabled, disabled | Set the lock configuration. p1: Timeout minutes (enabled/disabled). p2: Timeout seconds (enabled/disabled). p3: Outside handles mode (enabled/disabled). p4: Inside handles mode (enabled/disabled). |
setDoorLockMode |
STRING: unsecured, unsecuredWithTimeout, unsecuredForInsideDoorHandles, unsecuredForInsideDoorHandlesWithTimeout, unsecuredForOutsideDoorHandles | Set a door lock mode. |
setHandlesMode |
STRING: enabled, disabled, none; STRING: enabled, disabled, none | Set the handles mode of the door lock. p1: Outside handles mode (enabled:disabled) p2: Inside handles mode (enabled:disabled) |
setLockTimeout |
INT [0..253]; INT [0..59] | Set timeout of the door lock. p1 : minutes timeout bewteen 0 and 253 p2 : seconds timeout bewteen 0 and 59 |
unlock |
Unlock the device |
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
LockedUnlockedState |
DiscreteState | locked, unlocked |
Generic/DimmerOnOff (ACTUATOR) — 6 commands, 2 states
Type IDs: 65535, 1103823437823, 1103840215039, 1103856992255 | Servers: rexel, somfy_europe | Controllable: zwave:BasicClassComponent | Profiles: StatefulLevelControl, LevelControl, StatefulSwitchable, Switchable, Generic
Commands
| Command | Parameters | Notes |
|---|---|---|
off |
Turn off the device | |
on |
Turn on the device | |
refreshLevel |
Refresh the current level | |
refreshOnOffState |
Get the device on/off state | |
setLevel |
INT [0..100] | Generic device working level (0-100%) Functional meaning depends on device |
setOnOff |
STRING: off, on | Turn the device on or off |
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
LevelState |
ContinuousState | [0..100] | |
OnOffState |
DiscreteState | on, off |
Generic/StatefulAlarmController (ACTUATOR) — 4 commands, 9 states
Type IDs: 65535, 1103823437823, 1103840215039, 1103856992255 | Servers: rexel, somfy_europe | Controllable: zwave:NotificationClassV2V8Component | Profiles: Specific
Commands
| Command | Parameters | Notes |
|---|---|---|
refreshNotification |
INT [0..255]; STRING; STRING (optional) | This command is used to request if the unsolicited transmission of a specific Notification Type is enabled. p1: The use of this field depends on the V1 Alarm field advertised in the Alarm Type Supported Report Command. p2: This field is used to specify a Notification Type p3: This field is used to optionally specify a Notification Event/State within the Notification Type |
refreshNotificationSupportedEvent |
STRING | This command is used to request the supported Notifications for a specified Notification Type. p1: This field is used to specify a Notification Type |
refreshNotificationSupportedType |
This command is used to request supported Notification Types | |
setNotificationStatus |
STRING; STRING: enabled, disabled | This command is used to enable or disable the unsolicited transmission of a specific Notification Type. p1: This field is used to specify a Notification Type p2: This field is used to set the Status of a Notification Type. |
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
NotificationEventState |
ContinuousState | ||
NotificationParameterEventState |
DataState | ||
NotificationStatusState |
ContinuousState | ||
NotificationSupportedEventState |
DataState | ||
NotificationSupportedEventTypeState |
ContinuousState | ||
NotificationSupportedTypeState |
DataState | ||
NotificationTypeState |
ContinuousState | ||
NotificationV1AlarmLevelState |
ContinuousState | ||
NotificationV1AlarmTypeState |
ContinuousState |
GenericSensor/UniversalSensor (SENSOR) — 1 commands, 7 states
Type IDs: 65535, 1103823437823, 1103840215039, 1103856992255 | Servers: rexel, somfy_europe | Controllable: zwave:MultilevelSensorClassV1Component | Profiles: Specific
Commands
| Command | Parameters | Notes |
|---|---|---|
refreshLevel |
Refresh the current level |
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
GeneralPurposeState |
ContinuousState | ||
LuminanceState |
ContinuousState | ||
SensorScaleState |
DataState | ||
SensorTypeState |
DataState | ||
SensorValueState |
ContinuousState | ||
TemperatureState |
ContinuousState | [-100.0..100.0] | |
ZWaveDewPointState |
ContinuousState |
GenericSensor/UniversalSensor (SENSOR) — 1 commands, 16 states
Type IDs: 65535, 1103823437823, 1103840215039, 1103856992255 | Servers: rexel, somfy_europe | Controllable: zwave:MultilevelSensorClassV2Component | Profiles: Specific
Commands
| Command | Parameters | Notes |
|---|---|---|
refreshLevel |
Refresh the current level |
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
AirPressureState |
ContinuousState | ||
BarometricPressureState |
ContinuousState | ||
DirectionState |
ContinuousState | ||
GeneralPurposeState |
ContinuousState | ||
HumidityState |
ContinuousState | ||
LuminanceState |
ContinuousState | ||
RainRateState |
ContinuousState | ||
SensorScaleState |
DataState | ||
SensorTypeState |
DataState | ||
SensorValueState |
ContinuousState | ||
SolarRadiationState |
ContinuousState | ||
TemperatureState |
ContinuousState | [-100.0..100.0] | |
TideLevelState |
ContinuousState | ||
VelocityState |
ContinuousState | ||
ZWaveDewPointState |
ContinuousState | ||
ZWavePowerState |
ContinuousState |
GenericSensor/UniversalSensor (SENSOR) — 1 commands, 23 states
Type IDs: 65535, 1103823437823, 1103840215039, 1103856992255 | Servers: rexel, somfy_europe | Controllable: zwave:MultilevelSensorClassV3Component | Profiles: Specific
Commands
| Command | Parameters | Notes |
|---|---|---|
refreshLevel |
Refresh the current level |
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
AirFlowState |
ContinuousState | ||
AirPressureState |
ContinuousState | ||
BarometricPressureState |
ContinuousState | ||
CO2ConcentrationState |
ContinuousState | ||
CurrentState |
ContinuousState | ||
DirectionState |
ContinuousState | ||
DistanceState |
ContinuousState | ||
GeneralPurposeState |
ContinuousState | ||
HumidityState |
ContinuousState | ||
LuminanceState |
ContinuousState | ||
RainRateState |
ContinuousState | ||
SensorScaleState |
DataState | ||
SensorTypeState |
DataState | ||
SensorValueState |
ContinuousState | ||
SolarRadiationState |
ContinuousState | ||
TankCapacityState |
ContinuousState | ||
TemperatureState |
ContinuousState | [-100.0..100.0] | |
TideLevelState |
ContinuousState | ||
VelocityState |
ContinuousState | ||
VoltageState |
ContinuousState | ||
WeightState |
ContinuousState | ||
ZWaveDewPointState |
ContinuousState | ||
ZWavePowerState |
ContinuousState |
GenericSensor/UniversalSensor (SENSOR) — 1 commands, 24 states
Type IDs: 65535, 1103823437823, 1103840215039, 1103856992255 | Servers: rexel, somfy_europe | Controllable: zwave:MultilevelSensorClassV4Component | Profiles: Specific
Commands
| Command | Parameters | Notes |
|---|---|---|
refreshLevel |
Refresh the current level |
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
AirFlowState |
ContinuousState | ||
AirPressureState |
ContinuousState | ||
AnglePositionState |
ContinuousState | ||
BarometricPressureState |
ContinuousState | ||
CO2ConcentrationState |
ContinuousState | ||
CurrentState |
ContinuousState | ||
DirectionState |
ContinuousState | ||
DistanceState |
ContinuousState | ||
GeneralPurposeState |
ContinuousState | ||
HumidityState |
ContinuousState | ||
LuminanceState |
ContinuousState | ||
RainRateState |
ContinuousState | ||
SensorScaleState |
DataState | ||
SensorTypeState |
DataState | ||
SensorValueState |
ContinuousState | ||
SolarRadiationState |
ContinuousState | ||
TankCapacityState |
ContinuousState | ||
TemperatureState |
ContinuousState | [-100.0..100.0] | |
TideLevelState |
ContinuousState | ||
VelocityState |
ContinuousState | ||
VoltageState |
ContinuousState | ||
WeightState |
ContinuousState | ||
ZWaveDewPointState |
ContinuousState | ||
ZWavePowerState |
ContinuousState |
HeatingSystem/ThermostatSetPoint (ACTUATOR) — 3 commands, 2 states
Type IDs: 65535, 1103823437823, 1103840215039, 1103856992255 | Servers: rexel, somfy_europe | Controllable: zwave:ThermostatModeClassV1Component | Profiles: Specific
Commands
| Command | Parameters | Notes |
|---|---|---|
refreshThermostatMode |
Get the thermostat mode | |
refreshThermostatSupportedMode |
Get the thermostat mode supported | |
setThermostatMode |
STRING: auto, autochangeover, auxiliary, away, cool | Set the desired mode in the thermostat device |
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
ThermostatModeState |
DiscreteState | auto, autochangeover, auxiliary, away, cool, dry, energycool, energyheat, fan, fullpower, furnace, heat, manufacturerspecific, moist, off, resume | |
ThermostatModeSupportedState |
DiscreteState | auto, autochangeover, auxiliary, away, cool, dry, energycool, energyheat, fan, fullpower, furnace, heat, manufacturerspecific, moist, off, resume |
HeatingSystem/ThermostatSetPoint (ACTUATOR) — 3 commands, 7 states
Type IDs: 65535, 1103823437823, 1103840215039, 1103856992255 | Servers: rexel, somfy_europe | Controllable: zwave:ThermostatSetPointClassV1Component | Profiles: Specific
Commands
| Command | Parameters | Notes |
|---|---|---|
refreshThermostatSetPoint |
STRING: heating, cooling, furnace, dry, moist | Refresh value for one setPoint passed as parameter |
refreshThermostatSetpointSupported |
Refresh the supported setpoint types | |
setThermostatSetpoint |
FLOAT; STRING: heating, cooling, furnace, dry, moist; INT: 1, 2, 7, 8, 9; STRING: celsius, fahrenheit; INT: 1, 2, 4 | Set a target temperature for the setpoint with scale (Celsius Fahrenheit) and precision (number of decimals) p1: value p2: setpoint Type p3: scale p4: precision |
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
SetPointAutochangeoverValueState |
ContinuousState | ||
SetPointCoolingValueState |
ContinuousState | ||
SetPointDryValueState |
ContinuousState | ||
SetPointFurnaceValueState |
ContinuousState | ||
SetPointHeatingValueState |
ContinuousState | ||
SetPointMoistValueState |
ContinuousState | ||
SetPointSupportedState |
DataState |
HeatingSystem/ThermostatSetPoint (ACTUATOR) — 3 commands, 10 states
Type IDs: 65535, 1103823437823, 1103840215039, 1103856992255 | Servers: rexel, somfy_europe | Controllable: zwave:ThermostatSetPointClassV2Component | Profiles: Specific
Commands
| Command | Parameters | Notes |
|---|---|---|
refreshThermostatSetPoint |
STRING: heating, cooling, furnace, dry, moist | Refresh value for one setPoint passed as parameter |
refreshThermostatSetpointSupported |
Refresh the supported setpoint types | |
setThermostatSetpoint |
FLOAT; STRING: heating, cooling, furnace, dry, moist; INT: 1, 2, 7, 8, 9; STRING: celsius, fahrenheit; INT: 1, 2, 4 | Set a target temperature for the setpoint with scale (Celsius Fahrenheit) and precision (number of decimals) p1: value p2: setpoint Type p3: scale p4: precision |
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
SetPointAutochangeoverValueState |
ContinuousState | ||
SetPointAwayheatValueState |
ContinuousState | ||
SetPointCoolingValueState |
ContinuousState | ||
SetPointDryValueState |
ContinuousState | ||
SetPointEnergycoolValueState |
ContinuousState | ||
SetPointEnergyheatValueState |
ContinuousState | ||
SetPointFurnaceValueState |
ContinuousState | ||
SetPointHeatingValueState |
ContinuousState | ||
SetPointMoistValueState |
ContinuousState | ||
SetPointSupportedState |
DataState |
NetworkComponent/Node (ACTUATOR) — 1 commands, 2 states
Type IDs: 65535, 1103823437823, 1103840215039, 1103856992255 | Servers: rexel, somfy_europe | Controllable: zwave:DynamicNodeComponent | Profiles: Specific
Commands
| Command | Parameters | Notes |
|---|---|---|
refreshComponents |
Refresh the device internal components : the composition may change depending on current active configuration |
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
DeviceDefectState |
DiscreteState | failed | |
NeighboursAddressesState |
DataState |
NetworkComponent/Node (ACTUATOR) — 4 commands, 5 states
Type IDs: 65535, 1103823437823, 1103840215039, 1103856992255 | Servers: rexel, somfy_europe | Controllable: zwave:PowerLevelClassV1Component | Profiles: Specific
Commands
| Command | Parameters | Notes |
|---|---|---|
refreshZWavePowerLevel |
Refresh the current power level value. | |
refreshZWavePowerLevelTest |
Refresh the result of the latest Powerlevel Test. | |
setZWavePowerLevel |
STRING: normalPower, minus1dBm, minus2dBm, minus3dBm, minus4dBm; INT [1..255] (optional) | This command is used to set the power level indicator value, which should be used by the node when transmitting RF p1: powerlevel p2: timeout Notice : timeout is optional if you set powerlevel with the value NormalPower |
setZWavePowerLevelTest |
INT; STRING: normalPower, minus1dBm, minus2dBm, minus3dBm, minus4dBm; INT [1..65535] | command is used to instruct the destination node to transmit a number of test frames to the specified NodeID with the RF power level specified. p1: test node p2: powerlevel p3: Test frame count |
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
ZWavePowerLevelState |
DataState | ||
ZWavePowerLevelTestFrameCountState |
DataState | ||
ZWavePowerLevelTestNodeState |
DataState | ||
ZWavePowerLevelTestStatusState |
DataState | ||
ZWavePowerLevelTimeoutState |
DataState |
NetworkComponent/Node (ACTUATOR) — 2 commands, 2 states
Type IDs: 65535, 1103823437823, 1103840215039, 1103856992255 | Servers: rexel, somfy_europe | Controllable: zwave:IndicatorClassV1Component | Profiles: Specific
Commands
| Command | Parameters | Notes |
|---|---|---|
refreshZWaveIndicatorLevel |
Refresh the state of an indicator. | |
setZWaveIndicatorLevel |
STRING: on, off; INT [1..99]; INT: 255 | This command is used to enable or disable an indicator. |
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
ZWaveIndicatorLevelState |
ContinuousState | ||
ZWaveIndicatorStatusState |
DiscreteState | off, on |
NetworkComponent/Node (ACTUATOR) — 4 commands, 5 states
Type IDs: 65535, 1103823437823, 1103840215039, 1103856992255 | Servers: rexel, somfy_europe | Controllable: zwave:MultiChannelAssociationClassV2Component | Profiles: Specific
Commands
| Command | Parameters | Notes |
|---|---|---|
refreshMultiChannelAssociation |
INT | Refresh nodes and endpoints associate with specific group. p1: specific association group to refresh. |
refreshMultiChannelAssociationSupportingGroups |
Refresh the maximum number of association groups implemented by this node. | |
removeMultiChannelAssociation |
INT; ARRAY (optional); ARRAY (optional) | !!! WARNING !!! Use carefully, you might loose report to the gateway with a wrong configuration! Remove one or more destinations to a given association group. p1: field is used to specify the actual association group. p2: field specifies a list of NodeID destinations that are to be added to the specified association group as a NodeID association, can be nil or an array. Example for nodes 1 and 2 : ["1","2"]. p3: fields specify a list of End Points which are to be added to the specified association group as an End Point association,can be nil or an array. Example for node 3 endpoint 4 and node 5 enpoint 1 : ["3/4","5/1"]. |
setMultiChannelAssociation |
INT; ARRAY (optional); ARRAY (optional) | !!! WARNING !!! Use carefully, you might loose report to the gateway with a wrong configuration! Add one or more destinations to a given association group. p1: field is used to specify the actual association group p2: field specifies a list of NodeID destinations that are to be added to the specified association group as a NodeID association,can be nil or an array. Example for nodes 1 and 2 : ["1","2"]. p3: fields specify a list of End Points which are to be added to the specified association group as an End Point association,can be nil or an array. Example for node 3 endpoint 4 and node 5 enpoint 1 : ["3/4","5/1"]. |
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
ZWaveMultiChannelAssociationEndpointsState |
DataState | ||
ZWaveMultiChannelAssociationGroupIDState |
DataState | ||
ZWaveMultiChannelAssociationMaxNodesState |
DataState | ||
ZWaveMultiChannelAssociationNodesState |
DataState | ||
ZWaveMultiChannelAssociationSupportingGroupsState |
DataState |
NetworkComponent/Node (ACTUATOR) — 4 commands, 4 states
Type IDs: 65535, 1103823437823, 1103840215039, 1103856992255 | Servers: rexel, somfy_europe | Controllable: zwave:AssociationClassV2Component | Profiles: Specific
Commands
| Command | Parameters | Notes |
|---|---|---|
refreshAssociation |
INT | Refresh nodes associate with specific group. p1: specific association group to refresh. |
refreshAssociationSupportingGroups |
Refresh the maximum number of association groups implemented by this node. | |
removeAssociation |
INT; ARRAY | !!! WARNING !!! Use carefully, you might loose report to the gateway with a wrong configuration! Remove one or more destinations to a given association group. p1: field is used to specify the actual association group. p2: field specifies a list of NodeID destinations that are to be added to the specified association group as a NodeID association. Example for nodes 1 and 2 : ["1","2"]. |
setAssociation |
INT; ARRAY | !!! WARNING !!! Use carefully, you might loose report to the gateway with a wrong configuration! Add one or more destinations to a given association group. p1: field is used to specify the actual association group p2: field specifies a list of NodeID destinations that are to be added to the specified association group as a NodeID association. Example for nodes 1 and 2 : ["1","2"]. |
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
ZWaveAssociationGroupIDState |
DataState | ||
ZWaveAssociationMaxNodesState |
DataState | ||
ZWaveAssociationNodesState |
DataState | ||
ZWaveAssociationSupportingGroupsState |
DataState |
NetworkComponent/Node (ACTUATOR) — 0 commands, 2 states
Type IDs: 8606711808 | Servers: rexel, somfy_europe | Controllable: zwave:NodeComponent | Profiles: Specific
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
DeviceDefectState |
DiscreteState | failed | |
NeighboursAddressesState |
DataState |
OnOff/StatefulOnOff (ACTUATOR) — 4 commands, 1 states
Type IDs: 65535, 1103823437823, 1103840215039, 1103856992255 | Servers: rexel, somfy_europe | Controllable: zwave:BinarySwitchClassV1Component | Profiles: StatefulSwitchablePlug, StatefulSwitchable, Switchable
Commands
| Command | Parameters | Notes |
|---|---|---|
off |
Turn off the device | |
on |
Turn on the device | |
refreshOnOffState |
Get the device on/off state | |
setOnOff |
STRING: off, on | Turn the device on or off |
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
OnOffState |
DiscreteState | on, off |
OnOff/DimmerOnOff (ACTUATOR) — 8 commands, 2 states
Type IDs: 65535, 1103823437823, 1103840215039, 1103856992255 | Servers: rexel, somfy_europe | Controllable: zwave:MultilevelSwitchClassV1Component | Profiles: StatefulSwitchableLight, StatefulLevelControl, LevelControl, StatefulSwitchable, Switchable
Commands
| Command | Parameters | Notes |
|---|---|---|
off |
Turn off the device | |
on |
Turn on the device | |
refreshLevel |
Refresh the current level | |
refreshOnOffState |
Get the device on/off state | |
setLevel |
INT [0..100] | Generic device working level (0-100%) Functional meaning depends on device |
setOnOff |
STRING: off, on | Turn the device on or off |
startLevelChangeMultilevelSwitch |
STRING: up, down; INT [0..255] | Start a multilevel change on device |
stopLevelChangeMultilevelSwitch |
Stop a multilevel change on device |
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
LevelState |
ContinuousState | [0..100] | |
OnOffState |
DiscreteState | on, off |
ProtocolGateway/ZWaveTransceiver (PROTOCOL_GATEWAY) — 13 commands, 1 states
Type IDs: 8606711808 | Servers: rexel, somfy_europe | Controllable: zwave:TransceiverZWaveComponent | Profiles: Specific
Commands
| Command | Parameters | Notes |
|---|---|---|
isFailedDevice |
INT [0..255] | Test if the device is still reachable into the network. p1 : nodeId |
removeFailedNode |
INT [0..255] | Remove a failed node. p1 : nodeId |
replaceFailedDevice |
INT [0..255] | Replace a failed node. p1 : nodeId |
startExclusion |
INT [1..3600] | Start zwave exclusion with a given timeout. |
startExclusionWithMode |
INT [1..3600]; STRING: low, normal, wide | Start zwave exclusion with a given timeout and mode. p1 : timeout p2 : mode "low" value if the device is less than 3 meters of the gateway "normal" value if the device is under the network cover of the gateway "wide" value if the device is further away than the network coverage of the gateway |
startInclusion |
INT [1..3600] | Start zwave inclusion with a given timeout. |
startInclusionWithMode |
INT [1..3600]; STRING: low, normal, wide | Start zwave inclusion with a given timeout and mode. p1 : timeout p2 : mode "low" value if the device is less than 3 meters of the gateway. "normal" value if the device is under the network cover of the gateway. "wide" value if the device is further away than the network coverage of the gateway. |
startInclusionWithModeAndSecurityLevel |
INT [1..3600]; STRING: low, normal, wide; STRING: none, CRC16, S0, S2 | !!! Warning !!! You should use another security level than S2 only if you have no other choice, Be caution with this command. Start zwave inclusion with a given timeout, mode and security level. If you set none for example for a device which can use S2 all frame will be readble without security key. p1 : timeout p2 : mode "low" value if the device is less than 3 meters of the gateway. "normal" value if the device is under the network cover of the gateway. "wide" value if the device is further away than the network coverage of the gateway. p3 : highest security level to use. |
startLearn |
INT [1..3600] | Start zwave learn with a given timeout. |
startLearnWithMode |
INT [1..3600]; STRING: classic, inclusion, exclusion | Start zwave learn with a given timeout and mode. p1 : timeout p2 : mode "classic" gateway can be included or excluded from another network. "inclusion" gateway can only be included from another network. "exclusion" gateway can only be excluded from another network. |
stopExclusion |
Stop zwave exclusion. | |
stopInclusion |
Stop zwave inclusion. | |
stopLearn |
Stop zwave learn. |
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
TransceiverStatusState |
DataState |
RemoteController/SceneController (REMOTE_CONTROLLER) — 1 commands, 3 states
Type IDs: 65535, 1103823437823, 1103840215039, 1103856992255 | Servers: rexel, somfy_europe | Controllable: zwave:CentralSceneClassV1Component | Profiles: RockerSwitch
Commands
| Command | Parameters | Notes |
|---|---|---|
refreshSupportedScenesNumber |
Refresh the number of supported scenes for the device. |
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
RockerSwitchPushWayState |
DiscreteState | heldDown, pressed, pressedX2, pressedX3, pressedX4 | |
SceneNumberState |
DataState | ||
SupportedScenesNumberState |
DataState |
RemoteController/RockerSwitchx2Controller (REMOTE_CONTROLLER) — 0 commands, 4 states
Type IDs: 1103823372289, 1103823372290, 1103823372291 | Servers: rexel, somfy_europe | Controllable: zwave:RockerSwitchx2ZWaveComponent | Profiles: RockerSwitch
States
| State | Type | Range / Values | Notes |
|---|---|---|---|
DeviceDefectState |
DiscreteState | failed | |
NeighboursAddressesState |
DataState | ||
RockerSwitchPushWayState |
DiscreteState | heldDown, pressed, pressedX2, pressedX3, pressedX4 | |
RockerSwitchx2State |
DiscreteState | A0, A1, B0, B1, released |