ISS BETA SPECS

Warning: This article is only valid for BETA versions of ImperiHome.

The ISS documentation for the official version is available here.

 

Main API Documentation

Available here, with example sandbox :

http://www.imperihome.com/apidoc/systemapi/

 


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
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

 

DevCamera :

Param Key Description
Login Login to access camera image 
Password Password to access camera image
localjpegurl Local URL to the JPEG snapshot of the camera
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
Armable Ability to arm the device : 1 = Yes / 0 = No
Ackable Ability to acknowledge alerts : 1 = Yes / 0 = No
Armed Current arming status : 1 = On / 0 = Off
Tripped Is the sensor tripped ? (0 = No / 1 = Tripped)
lasttrip Date of last trip (timestamp format)

 

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
Status Current status (0 = opened / 1 = closed)

 

DevLuminosity :

Param Key Description Possible attributes
Value Current lum value

unit (default lux)

graphable (true or false)

 

DevMultiSwitch :

Param Key Description
Value Current value
Choices Comma-separated list of possible values

 

DevNoise :

Param Key Description Possible attributes
Value Current noise level

unit (default dB)

graphable (true or false)

 

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
LastRun Date of last run

 

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  

 

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)

 

curtemp Current ambient temperature

unit (default °C)

cursetpoint Current thermostat setpoint (same unit as curtemp)  
step The setpoint step between 2 values (default 0.5)  
availablemodes Comma-separated list of possible values for thermostat mode  

 

 

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 :

Possible action for the deviceAction api call

Device Type ActionName ActionParam

DevSwitch

DevDimmer

DevLock

DevRGBLight

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

DevShutter

stopShutter none

DevShutter

pulseShutter up or down
DevScene launchScene none
DevMultiSwitch setChoice any string from available choices
DevThermostat

setMode

setSetPoint

Mode name (string)

Set point temperature (double)

DevRGBLight

setColor

Hex color code : AARRGGBB (string)

 

 

Have more questions? Submit a request

0 Comments

Please sign in to leave a comment.
Powered by Zendesk