Difference between revisions of "WHO=1 - Lighting"

From piMyHome Project
Jump to navigation Jump to search
 
(97 intermediate revisions by the same user not shown)
Line 1: Line 1:
 +
== Standard Messages ==
  
−
== Standard Message ==
+
=== Standard Command ===
 +
Syntax: '''<tt>*WHO*WHAT*WHERE##</tt><br>'''
 +
Examples:
 +
<pre>
 +
*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
 +
</pre>
  
−
In the table above, we learned a Standard Message consists of <code>''' *WHO*WHAT*WHERE## ''' </code>.
+
=== Standard Request ===
−
* <tt>'''WHO'''</tt> identifies the service, such as scenario, light or automation
+
Syntax: '''<tt>*#WHO*WHERE##</tt><br>'''
−
* <tt>'''WHAT'''</tt> is the action to be performed, such as light ON/OFF or dimmer, shutter up/down etc.
 
−
* <tt>'''WHERE'''</tt> identifies the object, which can be an area, group, an environment, or just a single light or shutter etc. A <tt>'''WHERE'''</tt> field can also come with optional parameters, separated by a hash ('''#'''), e.g. <tt>'''*WHERE#PAR1#PAR2#...#PARn'''</tt>
 
  
−
== The WHAT Table ==
+
Sending a Status Request to the gateway results in a Standard Message reply.
−
'''<pre>
+
<pre>
−
Value Description
+
*#1*23##      Request status of light 23 
−
------------------------------------
+
*#1*45##      Request status of light 45
−
    0 OFF
+
*#1*37##      Request status of light 37 
−
    1  ON
+
</pre>
−
    2 Set dimmer to 20%
+
That 45 is a dimmer, we might realize when we get another reply than 0 or 1.
−
    3 Set dimmer to 30%
+
 
−
    4 Set dimmer to 40%
+
=== Standard Command Reference WHAT (WHO=1) ===
−
    5 Set dimmer to 50%
+
{| class="wikitable"
−
    6 Set dimmer to 60%
+
! style="text-align:left;"| Value
−
    7 Set dimmer to 70%
+
! style="text-align:left;"| Description
−
    8 Set dimmer to 80%
+
|-
−
    9 Set dimmer to 90%
+
|0
−
    10 Set dimmer to 100%
+
|OFF
−
    11 ON for 1 min
+
|- style="vertical-align:top;"
−
    12 ON for 2 min
+
|0#s
−
    13 ON for 3 min
+
|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
−
    14 ON for 4 min
+
|- style="vertical-align:top;"
−
    15 ON for 5 min
+
|1
−
    16 ON for 15 min
+
|ON<br>If dimmer: ON with last percentage
−
    17 ON for 30 min
+
|- style="vertical-align:top;"
−
    18 ON for 0.5 sec  
+
|1#s
−
    20 Blinking for 0.5 sec
+
|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
−
    21 Blinking for 1 sec
+
|-
−
    22 Blinking for 1.5 sec
+
|2
−
    23 Blinking for 2 sec
+
|Set dimmer to 20%
−
    24 Blinking for 2.5 sec
+
|-
−
    25 Blinking for 3 sec
+
|3
−
    26 Blinking for 3.5 sec
+
|Set dimmer to 30%
−
    27 Blinking for 4 sec
+
|-
−
    28 Blinking for 4.5 sec
+
|4
−
    29 Blinking for 5 sec
+
|Set dimmer to 40%
−
    30 Dimmer up one step
+
|-
−
    31 DImmer down one step
+
|5
−
  0#x  Turn off at x speed for step
+
|Set dimmer to 50%
−
  1#x  Turn on at x speed for step
+
|-
−
30#x#y  Up of x levels at y speed for steep
+
|6
−
31#x#y  Down of x levels at y speed for step1000
+
|Set dimmer to 60%
−
  1000  It accepts a parameter that is the value of what table
+
|-
−
</pre>'''
+
|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
 +
|- style="vertical-align:top;"
 +
|30
 +
|Dimmer up to next 10% step
 +
|- style="vertical-align:top;"
 +
|30#p#s
 +
|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
 +
|Dimmer down to previous 10% step
 +
|- style="vertical-align:top;"
 +
|31#p#s
 +
|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#
 +
|Internal Command translation, visible in monitor session only.
 +
|}
 +
 
 +
 
 +
 
 +
== Parameter Messages ==
 +
 
 +
=== Parameter Command ===
 +
Syntax: '''<tt>*#WHO*WHERE*#PARAMETER*VALUE1[*VALUE2...]##</tt><br>'''
 +
Examples:
 +
<pre>
 +
*#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>
 +
|}
 +
 
 +
 
 +
 
 +
{| style="width:100%; border:1px solid #EEEEEE; background-color:#FFFFCC"
 +
|style="text-align:left;"|[[WHO=0 - Scenarios]]
 +
|style="text-align:center;"|[[OWN_OpenWebNet_Language_Reference#WHO_Table|WHO Table]]
 +
|style="text-align:right;"|[[WHO=2 - Automation]]
 +
|}

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"