Difference between revisions of "Homewizard"

From TD-er's Wiki
Jump to navigationJump to search
(Created page with "The home-wizard URLs: Note that the password is sent plain-text in the url. Base of url is: http://<ip-homewizard>/<wachtwoord> Read switchnumbers: /swlist Read switchen an...")
 
Line 4: Line 4:
 
Base of url is: http://<ip-homewizard>/<wachtwoord>
 
Base of url is: http://<ip-homewizard>/<wachtwoord>
  
Read switchnumbers:
 
/swlist
 
  
Read switchen and sensor status:
+
== Read switchnumbers ==
/get-sensors
+
* /swlist
  
Switch (e.g. lamp) on or off:
+
== Read switchen and sensor status ==
/sw/<switch-number>/<on|off>
+
* /get-sensors
  
Operate dimmer:
+
== Switch (e.g. lamp) on or off ==
/sw/dim/<dimmer-number>/<value 0 ... 255>
+
* /sw/<switch-number>/<on|off>
  
Scene on/off:
+
== Operate dimmer ==
/gp/<scene-number>/<on|off>
+
* /sw/dim/<dimmer-number>/<value 0 ... 255>
  
Other commands:
+
== Scene on/off ==
/get-status : state of all sensors
+
* /gp/<scene-number>/<on|off>
/get-sensors : all devices and sensors
+
 
/notifications: all your notifications
+
== Other commands ==
/nf-receivers: notification receivers
+
* /get-status : state of all sensors
/timers: overview of timers
+
* /get-sensors : all devices and sensors
/suntimes/today: sunrise & sunset of today
+
* /notifications: all your notifications
/wea/get: your location according to HomeWizard
+
* /nf-receivers: notification receivers
 +
* /timers: overview of timers
 +
* /suntimes/today: sunrise & sunset of today
 +
* /wea/get: your location according to HomeWizard
 +
 
 +
 
 +
 
 +
== Awareness ==
 +
 
 +
 
 +
Detection-sensors will be registered with an ID starting at 0 and a log will be created.
 +
This log will contain a timestamp for each event.
 +
 
 +
A doorbell will only have "yes" events and magnetic door-sensors or daylight-detectors will have a "yes" and "no" event (e.g. door opened, door closed). Both will be logged, including the event-type.
 +
 
 +
The logs can be retrieved using:
 +
* /kks/get/<id>/log
 +
 
 +
 
 +
== Temperature sensors ==
 +
New temperature sensors will be assigned an ID starting at 0.
 +
The temperature and humidity will be logged with a timestamp.
 +
 
 +
=== Resolution ===
 +
To get the log:
 +
* /te/graph/<id>/day-week-month-year
 +
 
 +
==== Day ====
 +
For the current day, the resolution is one sample per 15 minutes.
 +
 
 +
==== Week ====
 +
20% of the data will be kept by removing 4 entries out of 5.
 +
 
 +
==== Month ====
 +
For each day, the minimum and maximum value will be stored.
 +
 
 +
==== Year ====
 +
Minimum and maximum of each month will be stored.

Revision as of 07:53, 27 September 2013

The home-wizard URLs:

Note that the password is sent plain-text in the url. Base of url is: http://<ip-homewizard>/<wachtwoord>


Read switchnumbers

  • /swlist

Read switchen and sensor status

  • /get-sensors

Switch (e.g. lamp) on or off

  • /sw/<switch-number>/<on|off>

Operate dimmer

  • /sw/dim/<dimmer-number>/<value 0 ... 255>

Scene on/off

  • /gp/<scene-number>/<on|off>

Other commands

  • /get-status : state of all sensors
  • /get-sensors : all devices and sensors
  • /notifications: all your notifications
  • /nf-receivers: notification receivers
  • /timers: overview of timers
  • /suntimes/today: sunrise & sunset of today
  • /wea/get: your location according to HomeWizard


Awareness

Detection-sensors will be registered with an ID starting at 0 and a log will be created. This log will contain a timestamp for each event.

A doorbell will only have "yes" events and magnetic door-sensors or daylight-detectors will have a "yes" and "no" event (e.g. door opened, door closed). Both will be logged, including the event-type.

The logs can be retrieved using:

  • /kks/get/<id>/log


Temperature sensors

New temperature sensors will be assigned an ID starting at 0. The temperature and humidity will be logged with a timestamp.

Resolution

To get the log:

  • /te/graph/<id>/day-week-month-year

Day

For the current day, the resolution is one sample per 15 minutes.

Week

20% of the data will be kept by removing 4 entries out of 5.

Month

For each day, the minimum and maximum value will be stored.

Year

Minimum and maximum of each month will be stored.