ImperiHome Standard System API

  • Information
  • API

Starting from version 2.2.0, we created a very simple standard API that the ImperiHome application supports and that system manufacturers/developers can implement to make their objects compatible with ImperiHome right out of the box.

This API is called ImperiHome Standard System (ISS).

To test a demo ISS system directly in ImperiHome, add an ISS system and enter 'http://dev.evertygo.com/apidoc/iss/demo' as Local API Base Url.

To be compatible, your ISS implementation must reply to different REST API calls whose description can be found in the API tab.

Available Device types:

Device type string Description
DevCamera MJPEG IP Camera
DevCO2 CO2 sensor
DevCO2Alert CO2 Alert sensor
DevDimmer Dimmable light
DevDoor Door / window security sensor
DevElectricity Electricity consumption sensor
DevFlood Flood security sensor
DevGenericSensor Generic sensor (any value)
DevHygrometry Hygro sensor
DevLock Door lock
DevLuminosity Luminance sensor
DevMotion Motion security sensor
DevMultiSwitch Multiple choice actuator
DevNoise Noise sensor
DevPlayer Audio/Video player
DevPlaylist Audio/Video playlist
DevPressure Pressure sensor
DevRain Rain sensor
DevRGBLight RGB(W) Light (dimmable)
DevScene Scene (launchable)
DevShutter Shutter actuator
DevSmoke Smoke security sensor
DevSwitch Standard on/off switch
DevTemperature Temperature sensor
DevTempHygro Temperature and Hygrometry combined sensor
DevThermostat Thermostat
DevUV UV sensor
DevWind Wind sensor


Device parameters definitions:

Common params for all devices
Param Key Description
defaultIcon Default icon URL for this device (starting with http:// or https://)

DevCamera
Param Key Description
localjpegurl Local URL to the JPEG snapshot of the camera
Note : login/pass can be passed like this http://login:pass@url
localmjpegurl Local URL to the camera's MJPEG stream
remotejpegurl Remote URL to the JPEG snapshot of the camera
remotemjpegurl Remote URL to the camera's MJPEG stream


DevCO2
Param Key Description Possible attributes
Value CO2 value unit (default ppm)


DevDimmer
Param Key Description Possible attributes
Status Current status : 1 = On / 0 = Off N/A
Level Current dim level (0-100) unit (default %)
Energy Energy value (number) unit (default Watts)


DevShutter
Param Key Description Possible attributes
stopable Ability to stop shutter : 1 = Yes / 0 = No N/A
pulseable Ability to send pulse commands to shutter : 1 = Yes / 0 = No N/A
Level Current dim level (0-100) unit (default %)


DevDoor, DevFlood, DevMotion, DevSmoke, DevCO2Alert
Param Key Description Possible attributes
armable Ability to arm the device : 1 = Yes / 0 = No N/A
ackable Ability to acknowledge alerts : 1 = Yes / 0 = No N/A
Armed Current arming status : 1 = On / 0 = Off N/A
Tripped Is the sensor tripped? (0 = No / 1 = Tripped) N/A
lasttrip Date of last trip (timestamp format) N/A


DevElectricity
Param Key Description Possible attributes
Watts Current consumption unit (default Watt)
graphable (true or false)
ConsoTotal Current total consumption unit (default kWh)
graphable (true or false)


DevGenericSensor
Param Key Description Possible attributes
Value Current value unit (default N/A)
graphable (true or false)


DevHygrometry
Param Key Description Possible attributes
Value Current hygro value unit (default %)
graphable (true or false)


DevLock
Param Key Description Possible attributes
Status Current status (0 = opened / 1 = closed) N/A


DevLuminosity
Param Key Description Possible attributes
Value Current lum value unit (default lux)
graphable (true or false)


DevMultiSwitch
Param Key Description Possible attributes
Value Current value N/A
Choices Comma-separated list of possible values N/A


DevNoise
Param Key Description Possible attributes
Value Current noise level unit (default dB)
graphable (true or false)


DevPlayer
Param Key Description Possible attributes
playing Indicates if currently playing (0 = No / 1 = Yes) N/A
volume Volume level (0 to 100) N/A
mute Mute status (0 = not muted / 1 = muted) N/A
duration Current track duration (in seconds) N/A
position Current position in track (in seconds) N/A
title Current track title N/A
album Current track album N/A
artist Current track artist N/A
thumbnail URL to current track thumbnail image N/A


DevPlaylist
Param Key Description Possible attributes
Choices String representation of json encoded playlist items list.
Example of JSON representation :
{
  "id": "id1",
  "name": "Item name",
  "subtitle": "Item subtitle",
  "duration": "02:34",
  "icon": "http://url.to.cover/cover.jpg"
}
N/A


DevPressure
Param Key Description Possible attributes
Value Current pressure unit (default mbar)
graphable (true or false)


DevRain
Param Key Description Possible attributes
Value Current instant rain value unit (default mm/h)
graphable (true or false)
Accumulation Total rain accumulation unit (default mm)
graphable (true or false)


DevRGBLight
Param Key Description Possible attributes
dimmable Ability to control luminosity : 1 = Yes / 0 = No N/A
whitechannel Does the light has a white channel : 1 = Yes / 0 = No N/A
Energy Energy value (number) unit (default Watts)
Status Current status : 1 = On / 0 = Off N/A
Level If dimmable, current dim level (0-100) N/A
color Color code in 8 hex characters : AARRGGBB N/A


DevScene
Param Key Description Possible attributes
LastRun Date of last run N/A


DevSwitch
Param Key Description Possible attributes
Status Current status : 1 = On / 0 = Off N/A
Energy Energy value (number) unit (default Watts)
pulseable Enables the 'pulse' action and button : 1 = YES, 0 = NO N/A


DevTemperature
Param Key Description Possible attributes
Value Current temperature unit (default °C)
graphable (true or false)


DevTempHygro
Param Key Description Possible attributes
temp Current temperature unit (default °C)
graphable (true or false)
hygro Current hygro value unit (default %)
graphable (true or false)


DevThermostat
Param Key Description Possible attributes
curmode Current thermostat mode from available modes (see availablemodes) N/A
curfanmode
(optional)
Current fan mode from available fan modes (see availablefanmodes) N/A
curenergymode
(optional)
Current energy mode from available energy modes (see availableenergymodes) N/A
curtemp Current ambient temperature unit (default °C)
cursetpoint Current thermostat setpoint 0 (same unit as curtemp) N/A
cursetpoint1
(optional)
Current thermostat setpoint 1 (same unit as curtemp), in case of dual setpoints thermostats N/A
cursetpointindex
(optional)
Currently active thermostat setpoint index. Can be 0 or 1. N/A
step The setpoint step between 2 values (default 0.5) N/A
minVal Minimum setpoint value N/A
maxVal Maximum setpoint value N/A
availablemodes Comma-separated list of possible values for thermostat mode N/A
availablefanmodes Comma-separated list of possible values for fan mode N/A
availablenergymodes Comma-separated list of possible values for energy mode N/A


DevUV
Param Key Description Possible attributes
Value Current UV index unit (default index)
graphable (true or false)


DevWind
Param Key Description Possible attributes
Speed Current wind speed unit (default km/h)
graphable (true or false)
Direction Wind direction unit (default Degrees)


Device Actions:

Device Type ActionName ActionParam
DevSwitch
DevDimmer
DevDimmer
DevRGBLight
DevLock
setStatus 0 or 1
DevSwitch pulse none
DevDoor
DevMotion
DevFlood
DevSmoke
setArmed 0 or 1
DevDoor
DevMotion
DevFlood
DevSmoke
setAck none
DevDimmer
DevShutter
DevRGBLight
setLevel 0-100
DevPlayer setposition Position in track (seconds)
DevPlayer setvolume 0-100
DevPlayer play
pause
next
previous
stop
mute
none
DevShutter stopShutter none
DevShutter pulseShutter up or down
DevScene launchScene none
DevMultiSwitch
DevPlaylist
setChoice any string from available choices
DevThermostat setMode
setEnergyMode
setFanMode
Mode name (string)
DevThermostat setSetPoint
setSetPoint1
Set point temperature (double)
DevRGBLight setColor Hex color code : AARRGGBB (string)