Interfaces
The main purpose of interfaces is to provide for a better user experience. Using interfaces, a plugin developer can suggest the ui to be used for this ThingClass. For example, having a plugin that can control a dimmable light would likely have a state named “powered” of type boolean and one named “brightness” of type int, ranging from 0 to 100%. Having just this information, the ui would create a generic switch component to flip the bool state and a generic slider component to allow adjusting the brightness because it can’t know what the actual switch or slider do. For a better user experience though, the plugin developer could just add the interface “dimmedlight” to this deviceclass and this way tell the ui that this actually is a dimmed light. The ui can use this information to paint a pretty brightness slider, and implicitly flip the power switch off when the brightness slider is moved to the lower end.
Another purpose of interfaces is to help the ui grouping and managing things. For example the gateway interface does not require to implement any properties, however, it tells the ui that this is a gateway and thus not relevant to show to the user in the main control entity. Instead, gateways might be listed in the configuration section of the client application.
In general it is a good idea to follow as many interfaces as precicely as possible in order to provide for the best user experience.
A interface can extend another interface. For example, the light interface only requires one state called powered of type bool. A dimmablelight extends this type and adds a brightness property to it. This means, if a ThingClass implements dimmablelight, it also needs to cater for the light interface’s states.
This is the list of interfaces available in nymea:
accesscontrol
{
"events": [
{
"name": "accessGranted"
},
{
"name": "accessDenied"
}
]
}account
This is used to flag a thing that manages user a user account. It is similar to the gateway interface. For example, if there is a remote API that requires logging in but doesn’t really offer any more functionality than that, this account shall be used. It inherits “connectable” which is used to flag if the remote server is unreachable. In addition, the “loggedIn” state indicates if the login fails. While logged in, the “userDisplayName” state should give the user’s name in a pretty printed form. A client may reconfigure the device then to login again. Such device classes usually will cause auto-devices implementing the actual features as child devices.
{
"extends": "connectable",
"states": [
{
"name": "loggedIn",
"type": "bool"
},
{
"name": "userDisplayName",
"type": "QString",
"optional": true
}
]
}See also: connectable
alarm
An interface for alarms, such as fire or intruder alarms.
{
"actions": [
{
"name": "alarm",
"logged": true
}
]
}alert
Used for things that have some sort of alert. For instance, light bulbs may be able to blink on alert actions, or speaker might be able to play an alert sound.
{
"actions": [
{
"name": "alert"
}
]
}awning
Simple awnings which can be opened and closed. Note that awnings operate inverted compared to other closables.
{
"extends": "closable"
}See also: closable
barcodescanner
{
"events": [
{
"name": "codeScanned",
"params": [
{
"name": "content",
"type": "QString"
}
],
"logged": true
}
]
}battery
{
"states": [
{
"name": "batteryCritical",
"type": "bool",
"logged": true
},
{
"name": "batteryLevel",
"type": "int",
"minValue": 0,
"maxValue": 100,
"unit": "Percentage",
"optional": true,
"logged": true
},
{
"name": "pluggedIn",
"type": "bool",
"optional": true
},
{
"name": "chargingState",
"type": "QString",
"allowedValues": [
"idle",
"charging",
"discharging"
],
"optional": true
}
]
}blind
Simple blinds which can be opened and closed.
{
"extends": "closable"
}See also: closable
button
The base for all buttons that emit a pressed event.
{
"events": [
{
"name": "pressed",
"logged": true
}
]
}childlock
Interface for devices that support a child lock on physical keys.
{
"states": [
{
"name": "childLock",
"type": "bool",
"writable": true,
"logged": true
}
]
}cleaningrobot
An interface for cleaning robots. A paused robot is unpaused by calling pauseCleaning again. Calling startCleaning on a paused robot should restart the activity (or start a different one) if possible, else it should unpause the current activity. Cleaning robots may be browsable for “maps” to return a list of maps with map images in their thumbnail urls and “zones” (as child items of maps) returning a list of zones that can be cleaned by executing the according browser items. Zone items should provide JSON objects in their description, containing “vertices” to draw the zones in the image and “color” properties
{
"states": [
{
"name": "robotState",
"type": "QString",
"possibleValues": [
"docked",
"cleaning",
"paused",
"traveling",
"stopped",
"error"
]
},
{
"name": "errorMessage",
"type": "QString",
"optional": true
}
],
"actions": [
{
"name": "startCleaning"
},
{
"name": "pauseCleaning"
},
{
"name": "stopCleaning"
},
{
"name": "returnToBase"
}
]
}closable
Interface for generic devices that can be opened and closed. The process of opening or closing can be interrupted by the stop action.
{
"extends": "simpleclosable",
"actions": [
{
"name": "stop"
}
]
}See also: simpleclosable
closablesensor
This interface can be used for i.e. magnetic window/door sensors
{
"extends": "sensor",
"states": [
{
"name": "closed",
"type": "bool",
"logged": true
}
]
}See also: sensor
co2sensor
CO2 (carbon dioxide) sensors. Measures co2 in parts per million.
{
"extends": "sensor",
"states": [
{
"name": "co2",
"type": "double",
"unit": "PartsPerMillion",
"logged": true,
"minValue": "any",
"maxValue": "any"
}
]
}See also: sensor
colorlight
{
"extends": "colortemperaturelight",
"states": [
{
"name": "color",
"type": "QColor",
"writable": true
}
]
}See also: colortemperaturelight
colortemperaturelight
{
"extends": "dimmablelight",
"states": [
{
"name": "colorTemperature",
"type": "int",
"minValue": "any",
"maxValue": "any",
"writable": true
}
]
}See also: dimmablelight
conductivitysensor
{
"extends": "sensor",
"states": [
{
"name": "conductivity",
"type": "double",
"unit": "MicroSiemensPerCentimeter",
"logged": true
}
]
}See also: sensor
connectable
{
"states": [
{
"name": "connected",
"type": "bool",
"defaultValue": false,
"logged": true
}
]
}cooling
The cooling interface defines basic cooling appliances.
{
"extends": "power",
"states": [
{
"name": "percentage",
"type": "int",
"min": 0,
"max": 100,
"unit": "Percentage",
"writable": true,
"optional": true
}
]
}See also: power
cosensor
CO (carbon monoxide) sensors. Measures co in parts per million.
{
"extends": "sensor",
"states": [
{
"name": "co",
"type": "double",
"unit": "PartsPerMillion",
"minValue": 0,
"maxValue": 255,
"logged": true
}
]
}See also: sensor
daylightsensor
Devices implementing the daylight sensor interface have a boolean state indicating if currently is daylight. Additionally the current times for sunrise and sunset are provided.
{
"extends": "sensor",
"states": [
{
"name": "daylight",
"type": "bool",
"logged": true
},
{
"name": "sunriseTime",
"unit": "UnixTime",
"type": "int"
},
{
"name": "sunsetTime",
"unit": "UnixTime",
"type": "int"
}
]
}See also: sensor
dimmablelight
{
"extends": "light",
"states": [
{
"name": "brightness",
"type": "int",
"minValue": 0,
"maxValue": 100,
"writable": true
}
]
}See also: light
doorbell
An interface for doorbells. Emits “doorbellPressed” when the doorbell is pressed.
{
"events": [
{
"name": "doorbellPressed",
"logged": true
}
]
}electricvehicle
Interface for electric vehicles. Some electric cars require a minimum charging current, otherwise they don’t start charging. Default is a minimum of 6 ampere.
{
"extends": [
"battery"
],
"states": [
{
"name": "capacity",
"type": "double",
"unit": "KiloWattHour"
},
{
"name": "minChargingCurrent",
"type": "uint",
"unit": "Ampere",
"minValue": 6,
"maxValue": 16,
"optional": true
},
{
"name": "phaseCount",
"type": "uint",
"minValue": 1,
"maxValue": 3,
"optional": true
}
]
}See also: battery
energymeter
Energy meters measure electric power consumption/production on 1, 2 or 3 phases. Often used as root measurements. If a meter uses more than 1 phase, as many states as possible for each phase shall be implemented. If there is only one phase, the total energy, total current etc. including voltage and current for phase A should be implemented.
{
"extends": [
"smartmeter"
],
"states": [
{
"name": "totalEnergyConsumed",
"type": "double",
"unit": "KiloWattHour",
"logged": true
},
{
"name": "totalEnergyProduced",
"type": "double",
"unit": "KiloWattHour",
"logged": true
},
{
"name": "currentPower",
"type": "double",
"unit": "Watt",
"logged": true
},
{
"name": "energyConsumedPhaseA",
"type": "double",
"unit": "KiloWattHour",
"optional": true
},
{
"name": "energyConsumedPhaseB",
"type": "double",
"unit": "KiloWattHour",
"optional": true
},
{
"name": "energyConsumedPhaseC",
"type": "double",
"unit": "KiloWattHour",
"optional": true
},
{
"name": "energyProducedPhaseA",
"type": "double",
"unit": "KiloWattHour",
"optional": true
},
{
"name": "energyProducedPhaseB",
"type": "double",
"unit": "KiloWattHour",
"optional": true
},
{
"name": "energyProducedPhaseC",
"type": "double",
"unit": "KiloWattHour",
"optional": true
},
{
"name": "currentPowerPhaseA",
"type": "double",
"unit": "Watt",
"optional": true
},
{
"name": "currentPowerPhaseB",
"type": "double",
"unit": "Watt",
"optional": true
},
{
"name": "currentPowerPhaseC",
"type": "double",
"unit": "Watt",
"optional": true
},
{
"name": "currentPhaseA",
"type": "double",
"unit": "Ampere"
},
{
"name": "currentPhaseB",
"type": "double",
"unit": "Ampere",
"optional": true
},
{
"name": "currentPhaseC",
"type": "double",
"unit": "Ampere",
"optional": true
},
{
"name": "voltagePhaseA",
"type": "double",
"unit": "Volt"
},
{
"name": "voltagePhaseB",
"type": "double",
"unit": "Volt",
"optional": true
},
{
"name": "voltagePhaseC",
"type": "double",
"unit": "Volt",
"optional": true
}
]
}See also: smartmeter
energystorage
Interfaces for devices that store electrical energy and can return it at a later point, such as batteries. The currentPower state follows the usual convention that positive is ‘consumed’ energy and negative values represent ‘produced’ or in this case ‘returned’ energy.
{
"extends": [
"battery",
"smartmeter"
],
"states": [
{
"name": "currentPower",
"type": "double",
"unit": "Watt",
"logged": true
},
{
"name": "capacity",
"type": "double",
"unit": "KiloWattHour"
}
]
}See also: battery, smartmeter
evcharger
An EV-charger. Extends the power interface for charging/not charging an electric vehicle. Supports regulation of the max. charging current in addition to be powered on or off.
{
"extends": [
"power"
],
"states": [
{
"name": "maxChargingCurrent",
"type": "uint",
"writable": true,
"unit": "Ampere",
"minValue": "any",
"maxValue": "any"
},
{
"name": "pluggedIn",
"type": "bool",
"optional": true
},
{
"name": "charging",
"type": "bool",
"logged": true,
"optional": true
},
{
"name": "phaseCount",
"type": "uint",
"minValue": 1,
"maxValue": 3,
"optional": true
},
{
"name": "desiredPhaseCount",
"type": "uint",
"minValue": 1,
"maxValue": 3,
"possibleValues": "any",
"writable": true,
"optional": true
},
{
"name": "sessionEnergy",
"type": "double",
"logged": true,
"unit": "KiloWattHour",
"optional": true
}
]
}See also: power
extendedawning
Awnings that support indicating their position and the moving state. Note that awnings operate inverted compared to other closables.
{
"extends": [
"awning",
"extendedclosable"
]
}See also: awning, extendedclosable
extendedblind
Blinds that support indicating their position and the moving state.
{
"extends": [
"blind",
"extendedclosable"
]
}See also: blind, extendedclosable
extendedclosable
A more advanced form of devices that support opening and closing in a more fine grained manner. They can report whether the opening/closing is currently in progress and provide a percentage of the opening/closing position. 0% means fully opened, while 100% indicates the device is fully closed
{
"extends": "closable",
"states": [
{
"name": "moving",
"type": "bool",
"logged": true
},
{
"name": "percentage",
"type": "int",
"unit": "Percentage",
"minValue": 0,
"maxValue": 100,
"writable": true
}
]
}See also: closable
extendednavigationpad
The extended media interface offers also the info and menu button of media devices.
{
"extends": "navigationpad",
"actions": [
{
"name": "navigate",
"params": [
{
"name": "to",
"type": "QString",
"allowedValues": [
"up",
"down",
"left",
"right",
"enter",
"back",
"menu",
"info",
"home"
]
}
]
}
]
}See also: navigationpad
extendedshutter
Advanced roller shutters that support indicating their position and the moving state.
{
"extends": [
"shutter",
"extendedclosable"
]
}See also: shutter, extendedclosable
extendedsmartmeterproducer
Like smartmeterproducer, but instead of only providing total produced energy, this also supports retrieving the current power supply rate. Note that currentPower is positive for producers but might also be negative if a device implements consumer and producer and currently consumes more than it produces.
{
"extends": "smartmeterproducer",
"states": [
{
"name": "currentPower",
"type": "double",
"unit": "Watt",
"logged": true
}
]
}See also: smartmeterproducer
extendedstatefulgaragedoor
A garage door which can be controlled like an extended closable, that is, by reporting and taking a percentage of the position
{
"extends": [
"statefulgaragedoor",
"extendedclosable"
]
}See also: statefulgaragedoor, extendedclosable
fingerprintreader
{
"extends": "useraccesscontrol",
"events": [
{
"name": "accessGranted",
"params": [
{
"name": "userId",
"type": "QString"
},
{
"name": "finger",
"type": "QString",
"allowedValues": [
"ThumbLeft",
"IndexFingerLeft",
"MiddleFingerLeft",
"RingFingerLeft",
"PinkyLeft",
"ThumbRight",
"IndexFingerRight",
"MiddleFingerRight",
"RingFingerRight",
"PinkyRight"
]
}
],
"logged": true
}
],
"actions": [
{
"name": "addUser",
"params": [
{
"name": "userId",
"type": "QString"
},
{
"name": "finger",
"type": "QString",
"allowedValues": [
"ThumbLeft",
"IndexFingerLeft",
"MiddleFingerLeft",
"RingFingerLeft",
"PinkyLeft",
"ThumbRight",
"IndexFingerRight",
"MiddleFingerRight",
"RingFingerRight",
"PinkyRight"
]
}
]
},
{
"name": "removeUser",
"params": [
{
"name": "userId",
"type": "QString"
}
]
}
]
}See also: useraccesscontrol
firesensor
An interface for fire/smoke sensors.
{
"extends": "sensor",
"states": [
{
"name": "fireDetected",
"type": "bool",
"logged": true
}
]
}See also: sensor
garagedoor
The base for all garage door interfaces. Can be used by the client to filter for garage doors in the system.
{}garagegate
{
"deprecated": "Use statefulgaragedoor instead",
"extends": [
"garagedoor",
"closable"
],
"states": [
{
"name": "state",
"type": "QString",
"allowedValues": [
"open",
"closed",
"opening",
"closing"
],
"logged": true
},
{
"name": "intermediatePosition",
"type": "bool"
}
]
}See also: garagedoor, closable
gassensor
Flammable gas (LPG, Propane, Methane etc) sensors. Measures co2 in parts per million.
{
"extends": "sensor",
"states": [
{
"name": "gasLevel",
"type": "double",
"unit": "PartsPerMillion",
"logged": true
}
]
}See also: sensor
gateway
The gateway interface is used for gateway devices like bridges to other networks. For instance Ethernet to Zigbee bridges, Ethernet to RF bridges or similar. Typically such device classes implement the actual functionality in child devices that will auto-appear after successful connection to the gateway/bridge.
{
"extends": "connectable"
}See also: connectable
heating
The heating interface defines basic heating appliances.
{
"extends": "power",
"states": [
{
"name": "percentage",
"type": "int",
"min": 0,
"max": 100,
"unit": "Percentage",
"writable": true,
"optional": true
}
]
}See also: power
heatpump
The base for all heat pump interfaces. Can be used by the client to filter for heat pumps in the system.
{
"states": [
{
"name": "outdoorTemperature",
"type": "double",
"unit": "DegreeCelsius",
"logged": true,
"optional": true
},
{
"name": "hotWaterTemperature",
"type": "double",
"unit": "DegreeCelsius",
"logged": true,
"optional": true
},
{
"name": "returnTemperature",
"type": "double",
"unit": "DegreeCelsius",
"logged": true,
"optional": true
},
{
"name": "flowTemperature",
"type": "double",
"unit": "DegreeCelsius",
"logged": true,
"optional": true
}
]
}humiditysensor
{
"extends": "sensor",
"states": [
{
"name": "humidity",
"type": "double",
"unit": "Percentage",
"minValue": 0,
"maxValue": 100,
"logged": true
}
]
}See also: sensor
impulsegaragedoor
This interface is for the simplest form of garage doors which can be controlled only via an impulse. Triggering the impulse will start moving the door, triggering it again will stop the movement. Triggering it yet another time will start movement in the reverse direction. Note that there is no feedback channel on such devices. The system has no chance of knowing the current state this device is actually in.
{
"extends": "garagedoor",
"actions": [
{
"name": "triggerImpulse",
"logged": true
}
]
}See also: garagedoor
inputtrigger
{
"events": [
{
"name": "triggered",
"logged": true
}
]
}irrigation
The irrigation interface is used for irrigation systems. It is used for water pumps or valves that supply any sort of irrigation. The power state turns irrigation on and off.
{
"extends": "power"
}See also: power
light
{
"extends": "power"
}See also: power
lightsensor
{
"extends": "sensor",
"states": [
{
"name": "lightIntensity",
"type": "double",
"unit": "Lux",
"logged": true
}
]
}See also: sensor
longpressbutton
A button that emits different events, pressed and longpressed, depending on how long the user presses it. Note that the button should only emit one of them at a time. I.e. don’t emit pressed on botton down and later longPressed if the user keeps on holding the button. Such a longpress should only emit longPressed. Common practice is to emit pressed if a release event is received before a timeout expires, else emit longpress when the timeout expires.
{
"extends": "button",
"events": [
{
"name": "longPressed",
"logged": true
}
]
}See also: button
longpressmultibutton
A remote control with multiple buttons that can distinguish between short and long presses. Note that the button should only emit one of them at a time. I.e. don’t emit pressed on botton down and later longPressed if the user keeps on holding the button. Such a longpress should only emit longPressed. Common practice is to emit pressed if a release event is received before a timeout expires, else emit longpress when the timeout expires.
{
"extends": "simplemultibutton",
"events": [
{
"name": "longPressed",
"params": [
{
"name": "buttonName",
"type": "QString"
}
],
"logged": true
}
]
}See also: simplemultibutton
media
The base for all media interfaces. Client applications might use this to group/filter things supporting media playback/control. When implementing a plugin use mediaplayer or mediacontroller for actual devices.
{}mediacontroller
The mediacontroller interface contains actions to control media streams.
{
"extends": "media",
"states": [
{
"name": "shuffle",
"type": "bool",
"writable": true,
"optional": true
},
{
"name": "repeat",
"type": "QString",
"allowedValues": [
"None",
"One",
"All"
],
"writable": true,
"optional": true
},
{
"name": "like",
"type": "bool",
"writable": true,
"optional": true
},
{
"name": "equalizerPreset",
"type": "QString",
"allowedValues": "any",
"writable": true,
"optional": true
},
{
"name": "nightMode",
"type": "bool",
"writable": true,
"optional": true
}
],
"actions": [
{
"name": "skipBack"
},
{
"name": "stop"
},
{
"name": "play"
},
{
"name": "pause"
},
{
"name": "skipNext"
},
{
"name": "fastForward",
"optional": true
},
{
"name": "fastRewind",
"optional": true
}
]
}See also: media
mediametadataprovider
Provide media information, meant to be used in combination with mediaplayer. For music players, use collection to provide the album/compilation, for video players fill in the series name or a movie collection name there. Artwork can be a URL to a artwork image.
{
"extends": "media",
"states": [
{
"name": "title",
"type": "QString"
},
{
"name": "artist",
"type": "QString"
},
{
"name": "collection",
"type": "QString"
},
{
"name": "artwork",
"type": "QString"
}
]
}See also: media
mediaplayer
Media player interface. Used by devices/services which can play back media. Even if a device only supports e.g. audio, the playerType state must still be added to the metadata. It may default to a single value and never change in this case. Players supporting duration and play time should provide those values in seconds.
{
"extends": "media",
"states": [
{
"name": "playbackStatus",
"type": "QString",
"allowedValues": [
"Playing",
"Paused",
"Stopped"
]
},
{
"name": "playerType",
"type": "QString",
"allowedValues": [
"audio",
"video"
]
},
{
"name": "inputSource",
"type": "QString",
"allowedValues": "any",
"writable": true,
"optional": true
},
{
"name": "playDuration",
"type": "uint",
"unit": "Seconds",
"optional": true
},
{
"name": "playTime",
"type": "uint",
"unit": "Seconds",
"optional": true
}
]
}See also: media
moisturesensor
{
"extends": "sensor",
"states": [
{
"name": "moisture",
"type": "double",
"logged": true
}
]
}See also: sensor
multibutton
A remote control with multiple buttons. Emits pressed(buttonName) on button presses.
{
"extends": "button",
"events": [
{
"name": "pressed",
"params": [
{
"name": "buttonName",
"type": "QString"
}
],
"logged": true
}
]
}See also: button
navigationpad
Many media devices have a navigation pad for browsing a library or a menu. This interface represents a basic navigation pad.
{
"extends": "media",
"actions": [
{
"name": "navigate",
"params": [
{
"name": "to",
"type": "QString",
"allowedValues": [
"up",
"down",
"left",
"right",
"enter",
"back"
]
}
]
}
]
}See also: media
no2sensor
Interface for nitrogen dioxide sensors. NO2 is measured in µg/m3.
{
"extends": "sensor",
"states": [
{
"name": "no2",
"type": "double",
"unit": "MicroGrammPerCubicalMeter",
"minValue": 0,
"maxValue": 800,
"logged": true
}
]
}See also: sensor
noisesensor
A sensor interface for noise sensors. Should deliver a median noise level in regular intervals. This is meant for overall noise level monitoring (e.g. in buildings) and not real time audio processing.
{
"extends": "sensor",
"states": [
{
"name": "noise",
"type": "double",
"unit": "Dezibel",
"logged": true
}
]
}See also: sensor
notifications
{
"actions": [
{
"name": "notify",
"params": [
{
"name": "title",
"type": "QString"
},
{
"name": "body",
"type": "QString"
}
],
"logged": true
}
]
}o2sensor
Interface for oxygen sensors. O2 saturation in percentage is mandatory, optionally more advanced sensors may offer O2 values in milligrams per liter (mg/L).
{
"extends": "sensor",
"states": [
{
"name": "o2saturation",
"type": "double",
"unit": "Percentage",
"logged": true
},
{
"name": "o2",
"type": "double",
"unit": "MilligramPerLiter",
"logged": true,
"optional": true
}
]
}See also: sensor
o3sensor
O3 (ozone) sensors. Measures o3 in parts per million.
{
"extends": "sensor",
"states": [
{
"name": "o3",
"type": "double",
"unit": "MicroGrammPerCubicalMeter",
"minValue": 0,
"maxValue": 500,
"logged": true
}
]
}See also: sensor
orpsensor
Interface for ORP (Oxidation Reduction Potential) sensors.
{
"extends": "sensor",
"states": [
{
"name": "orp",
"type": "double",
"unit": "MilliVolt",
"logged": true
}
]
}See also: sensor
outputtrigger
{
"actions": [
{
"name": "trigger"
}
]
}phsensor
Interface for PH sensors.
{
"extends": "sensor",
"states": [
{
"name": "ph",
"type": "double",
"minValue": 0,
"maxValue": 14,
"logged": true
}
]
}See also: sensor
pm10sensor
PM10 (Coarse particles) sensors. Measures PM10 particles in µg/m3.
{
"extends": "sensor",
"states": [
{
"name": "pm10",
"type": "double",
"unit": "MicroGrammPerCubicalMeter",
"minValue": 0,
"maxValue": 500,
"logged": true
}
]
}See also: sensor
pm25sensor
PM2.5 (Fine particles) sensors. Measures PM2.5 particles in µg/m3.
{
"extends": "sensor",
"states": [
{
"name": "pm25",
"type": "double",
"unit": "MicroGrammPerCubicalMeter",
"minValue": 0,
"maxValue": 500,
"logged": true
}
]
}See also: sensor
power
{
"states": [
{
"name": "power",
"type": "bool",
"writable": true,
"logged": true
}
]
}powersocket
The powersocket interface is used for smart power sockets and just extends the simple power interface.
{
"extends": "power"
}See also: power
powerswitch
The powerswitch interface is used for smart power switches and just extends the simple button interface. Use this for switches that can be on or off.
{
"extends": "button",
"states": [
{
"name": "power",
"type": "bool"
}
]
}See also: button
presencesensor
The presence sensor interface provides information whether a certain thing, for instance a human person, a tracked animal, a tracked mobile phone or smart watch is currently present. Additionally it gives information about the last time the tracked thing has been seen.
{
"extends": "sensor",
"states": [
{
"name": "isPresent",
"type": "bool",
"logged": true
}
]
}See also: sensor
pressuresensor
{
"extends": "sensor",
"states": [
{
"name": "pressure",
"type": "double",
"unit": "MilliBar",
"minValue": "any",
"maxValue": "any",
"logged": true
}
]
}See also: sensor
sensor
{}shutter
Simple roller shutters which can be opened and closed.
{
"extends": "closable"
}See also: closable
simplebutton
Deprecated - Use button instead.
{
"extends": "button"
}See also: button
simpleclosable
Interface for very basic devices that support opening and closing.
{
"actions": [
{
"name": "open"
},
{
"name": "close"
}
]
}simplegaragedoor
A Garage door that can take up and down as commands but cannot provide state information
{
"extends": [
"garagedoor",
"closable"
]
}See also: garagedoor, closable
simpleheatpump
This interface can be used for heat pumps offering one digital input for switching on and off the entire heatpump. Some heat pumps have only this possibility to be controlled. Be aware what you are doing if you switch of a heat pump and for how long.
{
"extends": [
"heatpump",
"power"
]
}simplemultibutton
Deprecated - Use multibutton instead
{
"extends": "multibutton"
}See also: multibutton
smartgridheatpump
This interface can be used for heat pumps offering the smart grid label “SG-Ready”. The modes can be set to the heatpump either trough 2 digital outputs or directly using modbus registers. These modes should be used by an energy manager and are not intended to be set by an user since there are certain rules to consider when switchen the SG mode.
{
"extends": "heatpump",
"states": [
{
"name": "sgReadyMode",
"type": "QString",
"possibleValues": [
"Off",
"Low",
"Standard",
"High"
],
"writable": true,
"logged": true
}
]
}See also: heatpump
smartlock
The smartlock interface is used for locks which can be opened digitally. The simplest form is a door opener which just unlatches the door lock for a few seconds so a person can enter. Implement the unlatch action and set the state to “unlatching” while opening. Set the state back to “locked” when done. More advanced devices might also allow keeping a door unlatched or distinguish between locked and unlocked. Fully electric doors might even support opening and closing the entire door by combining this interface with the “simpleclosable” interface.
{
"states": [
{
"name": "state",
"type": "QString",
"allowedValues": [
"locked",
"locking",
"unlocked",
"unlocking",
"unlatched",
"unlatching"
],
"logged": true,
"optional": true
}
],
"actions": [
{
"name": "lock"
},
{
"name": "unlock"
},
{
"name": "unlatch",
"optional": true
}
]
}smartmeter
Base interface for things that can monitor energy consumption/production.
{}smartmeterconsumer
This interface is used for things that can monitor energy consumption. At least the grand total of the consumer energy is provided, optionally live monitoring of the current usage may be available.
{
"extends": "smartmeter",
"states": [
{
"name": "totalEnergyConsumed",
"type": "double",
"unit": "KiloWattHour",
"logged": true
},
{
"name": "currentPower",
"type": "double",
"unit": "Watt",
"logged": true
}
]
}See also: smartmeter
smartmeterproducer
This interface is used for things that can monitor energy production. At least the grand total of the returned energy is provided, optionally live monitoring of the current production may be available. Please note that currentPower is always from a consumer perspective. Thus it will be a negative value for producing devices.
{
"extends": "smartmeter",
"states": [
{
"name": "totalEnergyProduced",
"type": "double",
"unit": "KiloWattHour",
"logged": true
},
{
"name": "currentPower",
"type": "double",
"unit": "Watt",
"logged": true
}
]
}See also: smartmeter
solarinverter
Interface for solar inverters
{
"extends": "smartmeterproducer"
}See also: smartmeterproducer
statefulgaragedoor
A garagedoor which can be controller like a closable, with open and close actions. It can report whether it’s opened or closed or standing still something in between (intermediate position) as well as reporting that it’s moving (opening/closing).
{
"extends": [
"garagedoor",
"closable"
],
"states": [
{
"name": "state",
"type": "QString",
"allowedValues": [
"open",
"closed",
"opening",
"closing",
"intermediate"
],
"logged": true
}
]
}See also: garagedoor, closable
system
This interface is used to mark device classes as system-internal. The user interface will likely hide it.
{}temperaturesensor
{
"extends": "sensor",
"states": [
{
"name": "temperature",
"type": "double",
"unit": "DegreeCelsius",
"logged": true
}
]
}See also: sensor
thermostat
The thermostat interface describes devices which have a target temperature value and regulate themselves to match that target temperature. A thermostat may support detecting for open windows in which case the windowOpenDetected state should be implemented. On the other hand, a thermostat may allow setting a window open lock in which case the windowOpen state should be implemented.
{
"states": [
{
"name": "targetTemperature",
"type": "double",
"unit": "DegreeCelsius",
"minValue": "any",
"maxValue": "any",
"writable": true,
"logged": true
},
{
"name": "temperature",
"type": "double",
"unit": "DegreeCelsius",
"optional": true,
"logged": true
},
{
"name": "heatingOn",
"type": "bool",
"optional": true,
"logged": true
},
{
"name": "coolingOn",
"type": "bool",
"optional": true,
"logged": true
},
{
"name": "boost",
"type": "bool",
"optional": true,
"logged": true
},
{
"name": "windowOpen",
"type": "bool",
"writable": true,
"optional": true,
"logged": true
},
{
"name": "windowOpenDetected",
"type": "bool",
"optional": true,
"logged": true
}
]
}update
The update interface is used for things that support being updated by nymea.
{
"states": [
{
"name": "updateStatus",
"type": "QString",
"allowedValues": [
"idle",
"available",
"updating"
]
},
{
"name": "currentVersion",
"type": "QString",
"logged": true
},
{
"name": "availableVersion",
"type": "QString",
"optional": true
},
{
"name": "updateProgress",
"type": "uint",
"unit": "Percentage",
"min": 0,
"max": 100,
"optional": true
}
],
"actions": [
{
"name": "performUpdate"
}
]
}useraccesscontrol
{
"extends": "accesscontrol",
"states": [
{
"name": "users",
"type": "QStringList"
}
],
"events": [
{
"name": "accessGranted",
"params": [
{
"name": "userId",
"type": "QString"
}
],
"logged": true
}
],
"actions": [
{
"name": "addUser",
"params": [
{
"name": "userId",
"type": "QString"
}
],
"logged": true
},
{
"name": "removeUser",
"params": [
{
"name": "userId",
"type": "QString"
}
],
"logged": true
}
]
}See also: accesscontrol
venetianblind
Venetian blinds that can be tilted. Venetian blinds must support an angle and specify the minimum and maximum supported angle. For instance, if a venetian blinds supports tilting from horizontal to vertical by 90°, the minValue should be set to 0° and the maxValue to 90°. For venetian blinds that support tilting both direction, that is, a total of 180°, the minValue should be -90° and the maxValue should be 90°. 0° is always the horizontal position. Note that the “moving” state should be true when either the percentage or the angle are moving.
{
"extends": "extendedblind",
"states": [
{
"name": "angle",
"type": "int",
"unit": "Degree",
"minValue": "any",
"maxValue": "any",
"writable": true
}
]
}See also: extendedblind
ventilation
The ventilation interface is used for any sort of ventilation. It extends the “power” interface and thus can be turned on or off. Optionally, the air flow can be controlled. The thing class must specify the minimum and maximum values for the flow control.
{
"extends": "power",
"states": [
{
"name": "flowRate",
"type": "int",
"minValue": "any",
"maxValue": "any",
"writable": true,
"optional": true,
"logged": true
}
]
}See also: power
vibrationsensor
An interface for vibration sensors.
{
"extends": "sensor",
"events": [
{
"name": "vibrationDetected",
"logged": true
}
]
}See also: sensor
vocsensor
Sensor for volatile organic compounds (VOC).
{
"extends": "sensor",
"states": [
{
"name": "voc",
"type": "uint",
"unit": "PartsPerBillion",
"minValue": 0,
"maxValue": 65353,
"logged": true
}
]
}See also: sensor
volumecontroller
{
"desciption": "A volume controller allows to control volume and mute. At the very least, increaseVolume and decreaseVolume are to be implemented for devices that don't have a way to fetch the current volume. For devices allowing to set an absolute volume value, the volume and mute states should be implemented as well.",
"extends": "media",
"states": [
{
"name": "mute",
"type": "bool",
"writable": true,
"optional": true
},
{
"name": "volume",
"type": "int",
"minValue": "any",
"maxValue": "any",
"writable": true,
"optional": true
}
],
"actions": [
{
"name": "increaseVolume"
},
{
"name": "decreaseVolume"
}
]
}See also: media
waterlevelsensor
Sensors that can measure water fill levels.
{
"extends": "sensor",
"states": [
{
"name": "waterLevel",
"type": "double",
"unit": "Liter",
"logged": true
}
]
}See also: sensor
watersensor
Interface for water sensors.
{
"extends": "sensor",
"states": [
{
"name": "waterDetected",
"type": "bool",
"logged": true
}
]
}See also: sensor
weather
{
"states": [
{
"name": "weatherDescription",
"type": "QString",
"logged": true
},
{
"name": "weatherCondition",
"type": "QString",
"allowedValues": [
"clear-day",
"clear-night",
"few-clouds-day",
"few-clouds-night",
"clouds",
"overcast",
"light-rain",
"shower-rain",
"thunderstorm",
"snow",
"fog"
],
"logged": true
},
{
"name": "temperature",
"type": "double",
"unit": "DegreeCelsius",
"logged": true
},
{
"name": "humidity",
"type": "int",
"unit": "Percentage",
"logged": true
},
{
"name": "pressure",
"type": "double",
"unit": "HectoPascal",
"logged": true
},
{
"name": "windSpeed",
"type": "double",
"unit": "MeterPerSecond",
"logged": true
},
{
"name": "windDirection",
"type": "int",
"unit": "Degree",
"logged": true
}
]
}windspeedsensor
This interface represents a wind sensor measurment and has the unit [m/s].
{
"extends": "sensor",
"states": [
{
"name": "windSpeed",
"type": "double",
"unit": "MeterPerSecond",
"logged": true
}
]
}See also: sensor
wirelessconnectable
Interface for wireless connectable devices. If reporting the signal strength is supported, the optional signalStrength state should be implemented.
{
"extends": "connectable",
"states": [
{
"name": "signalStrength",
"type": "uint",
"unit": "Percentage",
"minValue": 0,
"maxValue": 100,
"optional": true,
"logged": true
}
]
}See also: connectable