Difference between revisions of "WHO=1 - Lighting"

From piMyHome Project
Jump to navigation Jump to search
 
(77 intermediate revisions by the same user not shown)
Line 1: Line 1:
−
==== Standard Message <tt>*WHO*WHAT*WHERE##</tt>====
+
== Standard Messages ==
 +
 
 +
=== Standard Command ===
 +
Syntax: '''<tt>*WHO*WHAT*WHERE##</tt><br>'''
 
Examples:
 
Examples:
 
<pre>
 
<pre>
Line 5: Line 8:
 
*1*0*23##        Turn off light 23   
 
*1*0*23##        Turn off light 23   
 
*1*7*45##        Set dimmer 45 to 70%   
 
*1*7*45##        Set dimmer 45 to 70%   
−
*1*18*37##      Turn on light 37 for 0.5 sec (useful for door opener etc.)   
+
*1*18*37##      Turn on light 37 for 0.5 sec (useful as push button for door opener etc.)   
−
*1*29*23##      Let light 23 blink for 5 sec (useful as a 'silent' alarm)  
+
*1*21*23##      Let light 23 blink with a frequency of 1 sec (useful as a 'silent' alarm)  
−
*1*30*45##      Set dimmer 45 up to next level (+10%) 
+
*1*30*45##      Set dimmer 45 up to next 10% step
 
</pre>
 
</pre>
  
−
==== Status Request <tt>*#WHO*WHERE##</tt>====
+
=== Standard Request ===
 +
Syntax: '''<tt>*#WHO*WHERE##</tt><br>'''
 +
 
 
Sending a Status Request to the gateway results in a Standard Message reply.
 
Sending a Status Request to the gateway results in a Standard Message reply.
 
<pre>
 
<pre>
Line 17: Line 22:
 
*#1*37##      Request status of light 37   
 
*#1*37##      Request status of light 37   
 
</pre>
 
</pre>
−
That 45 is a dimmer, we might realize when we get another reply than 0 or 1.  
+
That 45 is a dimmer, we might realize when we get another reply than 0 or 1.
−
 
 
  
−
== WHAT Table==
+
=== Standard Command Reference WHAT (WHO=1) ===
−
{| class="wikitable"  style="float:left;"
+
{| class="wikitable"  
 
! style="text-align:left;"| Value
 
! style="text-align:left;"| Value
 
! style="text-align:left;"| Description
 
! style="text-align:left;"| Description
Line 28: Line 32:
 
|OFF
 
|OFF
 
|- style="vertical-align:top;"
 
|- style="vertical-align:top;"
−
|0#x
+
|0#s
−
|Turn OFF dimmer with time duration x in seconds (0..255)<br>to arrive at OFF
+
|Turn OFF dimmer with s seconds (0..254) dimming time<br>to arrive at OFF<br>A value of "0" seconds will use last used dimming time
 
|- style="vertical-align:top;"
 
|- style="vertical-align:top;"
 
|1
 
|1
 
|ON<br>If dimmer: ON with last percentage
 
|ON<br>If dimmer: ON with last percentage
 
|- style="vertical-align:top;"
 
|- style="vertical-align:top;"
−
|1#x
+
|1#s
−
|Turn ON dimmer with time duration x in seconds (0..255)<br>to arrive until last percentage
+
|Turn ON dimmer with s seconds (0..254) dimming time<br>to arrive at last percentage of dimmer<br>A value of "0" seconds will use last used dimming time
 
|-
 
|-
 
|2
 
|2
Line 86: Line 90:
 
|-
 
|-
 
|18
 
|18
−
|ON for 0.5 sec  
+
|ON for 0.5 sec
−
|-
 
−
|19
 
−
|NO LOAD (dimmer)
 
 
|-
 
|-
 
|20
 
|20
−
|Blinking for 0.5 sec
+
|Blinking with a frequency of 0.5 sec
 
|-
 
|-
 
|21
 
|21
−
|Blinking for 1 sec
+
|Blinking with a frequency of 1 sec
 
|-
 
|-
 
|22
 
|22
−
|Blinking for 1.5 sec
+
|Blinking with a frequency of 1.5 sec
 
|-
 
|-
 
|23
 
|23
−
|Blinking for 2 sec
+
|Blinking with a frequency of 2 sec
 
|-
 
|-
 
|24
 
|24
−
|Blinking for 2.5 sec
+
|Blinking with a frequency of 2.5 sec
 
|-
 
|-
 
|25
 
|25
−
|Blinking for 3 sec
+
|Blinking with a frequency of 3 sec
 
|-
 
|-
 
|26
 
|26
−
|Blinking for 3.5 sec
+
|Blinking with a frequency of 3.5 sec
 
|-
 
|-
 
|27
 
|27
−
|Blinking for 4 sec
+
|Blinking with a frequency of 4 sec
 
|-
 
|-
 
|28
 
|28
−
|Blinking for 4.5 sec
+
|Blinking with a frequency of 4.5 sec
 
|-
 
|-
 
|29
 
|29
−
|Blinking for 5 sec
+
|Blinking with a frequency of 5 sec
−
|-
+
|- style="vertical-align:top;"
 
|30
 
|30
−
|Dimmer one step up
+
|Dimmer up to next 10% step
−
|-
+
|- style="vertical-align:top;"
−
|30#x#y
+
|30#p#s
−
|Dimmer x steps up a speed y
+
|Dimmer p% up with s seconds (0..254) dimming time<br>If dimmer was off before, turns on to p%<br>Dimmer arrives max. at 100%<br>A value of "0" seconds will use last used dimming time
−
|-
+
|- style="vertical-align:top;"
 
|31
 
|31
−
|Dimmer one step down
+
|Dimmer down to previous 10% step
−
|-
+
|- style="vertical-align:top;"
−
|31#x#y
+
|31#p#s
−
|Dimmer x steps down a speed y
+
|Dimmer p% down with s seconds (0..254) dimming time<br>Lowest percentage the dimmer arrives is 1%<br>A value of "0" seconds will use last used dimming time
−
|-
+
|- style="vertical-align:top;"
−
|1000<br>&nbsp;<br>&nbsp;<br>&nbsp;<br>&nbsp;
+
|1000#
−
|Command translation<br> triggered by push buttons.<br>Read only, visible in<br>monitor session.<br><tt>*1*1000#WHAT*WHERE##</tt> launches <br><tt>*1*WHAT*WHERE##</tt>
+
|Internal Command translation, visible in monitor session only.
 
|}
 
|}
  
−
{| class="wikitable" style="float:left; margin-left: 10px;"
+
 
−
! style="text-align:left;"| Dimension
+
 
−
! style="text-align:left;"| Info
+
== Parameter Messages ==
−
|-
+
 
−
|speed
+
=== Parameter Command ===
−
|0..255 (0=now, 255=slowest)
+
Syntax: '''<tt>*#WHO*WHERE*#PARAMETER*VALUE1[*VALUE2...]##</tt><br>'''
−
|-
+
Examples:
−
|step
+
<pre>
−
|one step = 10% of dimmer
+
*#1*43*#2*1*35*18##        Turn on light 43 for 1h:35m:18s
 +
*#1*44#4#03*#2*0*0*13##    Turn on light 44 of interface 03 for 13s
 +
*#1*23*#9*1##              Set max working hours of light 23 to one hour
 +
</pre>
 +
 
 +
=== Parameter Request ===
 +
Syntax: '''<tt>*#WHO*WHERE*#PARAMETER##</tt><br>'''
 +
Examples:
 +
<pre>
 +
*#1*43*#2##    Get remaining countdown time OF LIGHT 43
 +
*#1*12*#8## Get the total amount of operation hours, light 12 was powered on
 +
</pre>
 +
 
 +
=== Parameter Reference (WHO=1) ===
 +
{| class="wikitable"  
 +
! style="text-align:left;"| Parameter
 +
! style="text-align:left;"| Description
 +
|- style="vertical-align:top;"
 +
|#1
 +
|Returns dimmer status <br><tt>*#1*WHERE*1*PERCENTAGE*DIMMINGTIME##</tt>
 +
|- style="vertical-align:top;"
 +
|#1*p*s
 +
|Set dimmer p% up with s seconds (0..254) dimming time<br><span style="color:red">Didn't work for me</span>
 +
|- style="vertical-align:top;"
 +
|#2
 +
|Returns the remaining countdown time until light switches of<br><tt>*#1*WHERE*2*HOURS*MINUTES*SECONDS##</tt>
 +
|- style="vertical-align:top;"
 +
|#2*h*m*s
 +
|Turn ON light for a certain amount of time (countdown timer) <br>Values for hours, minutes, seconds are integer
 +
|- style="vertical-align:top;"
 +
|#3
 +
|Returns some "Required Only ON Light ???"<br><span style="color:red">Didn't work for me</span>
 +
|- style="vertical-align:top;"
 +
|#8
 +
|Returns the total amount of operation hours, the light was powered on<br><tt>*#1*WHERE*8*HOURS##</tt>
 +
|- style="vertical-align:top;"
 +
|#9
 +
|Returns Max amount of hours working time lamp<br><span style="color:red">Didn't work for me</span>
 +
|- style="vertical-align:top;"
 +
|#9*h
 +
|Set max. 'working time' in hours<br>Values for hours are integer<br><span style="color:red">Didn't work for me</span>
 
|}
 
|}
  
−
{| class="wikitable" style="float:left; margin-left: 10px;"
 
−
! style="text-align:left;"| WHERE
 
−
! style="text-align:left;"| Address
 
−
|-
 
−
|0
 
−
|General
 
−
|-
 
−
|1..9
 
−
|Environment 1 to 9
 
−
|-
 
−
|11..99
 
−
|Light point 1.1 to 9.9
 
−
|-
 
−
|0110..0915
 
−
|Light point 1.10 to 9.15
 
−
|-
 
−
|#1..#9
 
−
|Group 1 to 9
 
−
|}
 
  
  

Latest revision as of 19:27, 2 November 2015

Standard Messages

Standard Command

Syntax: *WHO*WHAT*WHERE##
 Examples: 

*1*1*23##        Turn on light 23  
*1*0*23##        Turn off light 23  
*1*7*45##        Set dimmer 45 to 70%  
*1*18*37##       Turn on light 37 for 0.5 sec (useful as push button for door opener etc.)  
*1*21*23##       Let light 23 blink with a frequency of 1 sec (useful as a 'silent' alarm) 
*1*30*45##       Set dimmer 45 up to next 10% step

Standard Request

Syntax: *#WHO*WHERE##

Sending a Status Request to the gateway results in a Standard Message reply. 

*#1*23##      Request status of light 23   
*#1*45##      Request status of light 45 
*#1*37##      Request status of light 37

That 45 is a dimmer, we might realize when we get another reply than 0 or 1.

Standard Command Reference WHAT (WHO=1)

Value Description
0 OFF
0#s Turn OFF dimmer with s seconds (0..254) dimming time
to arrive at OFF
A value of "0" seconds will use last used dimming time
1 ON
If dimmer: ON with last percentage
1#s Turn ON dimmer with s seconds (0..254) dimming time
to arrive at last percentage of dimmer
A value of "0" seconds will use last used dimming time
2 Set dimmer to 20%
3 Set dimmer to 30%
4 Set dimmer to 40%
5 Set dimmer to 50%
6 Set dimmer to 60%
7 Set dimmer to 70%
8 Set dimmer to 80%
9 Set dimmer to 90%
10 Set dimmer to 100%
11 ON for 1 min
12 ON for 2 min
13 ON for 3 min
14 ON for 4 min
15 ON for 5 min
16 ON for 15 min
17 ON for 30 sec
18 ON for 0.5 sec
20 Blinking with a frequency of 0.5 sec
21 Blinking with a frequency of 1 sec
22 Blinking with a frequency of 1.5 sec
23 Blinking with a frequency of 2 sec
24 Blinking with a frequency of 2.5 sec
25 Blinking with a frequency of 3 sec
26 Blinking with a frequency of 3.5 sec
27 Blinking with a frequency of 4 sec
28 Blinking with a frequency of 4.5 sec
29 Blinking with a frequency of 5 sec
30 Dimmer up to next 10% step
30#p#s Dimmer p% up with s seconds (0..254) dimming time
If dimmer was off before, turns on to p%
Dimmer arrives max. at 100%
A value of "0" seconds will use last used dimming time
31 Dimmer down to previous 10% step
31#p#s Dimmer p% down with s seconds (0..254) dimming time
Lowest percentage the dimmer arrives is 1%
A value of "0" seconds will use last used dimming time
1000# Internal Command translation, visible in monitor session only.


Parameter Messages

Parameter Command

Syntax: *#WHO*WHERE*#PARAMETER*VALUE1[*VALUE2...]##
 Examples: 

*#1*43*#2*1*35*18##        Turn on light 43 for 1h:35m:18s
*#1*44#4#03*#2*0*0*13##    Turn on light 44 of interface 03 for 13s
*#1*23*#9*1##              Set max working hours of light 23 to one hour

Parameter Request

Syntax: *#WHO*WHERE*#PARAMETER##
 Examples: 

*#1*43*#2##     Get remaining countdown time OF LIGHT 43
*#1*12*#8## 	Get the total amount of operation hours, light 12 was powered on

Parameter Reference (WHO=1)

Parameter Description
#1 Returns dimmer status
*#1*WHERE*1*PERCENTAGE*DIMMINGTIME##
#1*p*s Set dimmer p% up with s seconds (0..254) dimming time
Didn't work for me
#2 Returns the remaining countdown time until light switches of
*#1*WHERE*2*HOURS*MINUTES*SECONDS##
#2*h*m*s Turn ON light for a certain amount of time (countdown timer)
Values for hours, minutes, seconds are integer
#3 Returns some "Required Only ON Light ???"
Didn't work for me
#8 Returns the total amount of operation hours, the light was powered on
*#1*WHERE*8*HOURS##
#9 Returns Max amount of hours working time lamp
Didn't work for me
#9*h Set max. 'working time' in hours
Values for hours are integer
Didn't work for me


WHO=0 - Scenarios WHO Table WHO=2 - Automation
Retrieved from "http://www.pimyhome.org/wiki/index.php?title=WHO%3D1_-_Lighting&oldid=463"