| Scene.pm |
Declaration:
The following entries belong in the .mht file
# declare the scene item
SCENE, family_room_movie, All_Lights|Scenes
# add members to the scene
SCENE_MEMBER, x10_family_light, family_room_movie, 70%, 78%The first percentage is the "on-level" and extends from 0% to 100%; it is set to 100% if ommitted. For non-dimmable items, it must be 0%, off, 100% or on.
The second percentage is the ramp-rate (see table below); it is optional and can be unique. It must be omitted if the device doest not support fade/ramp rates
States:
'on' - all scene members are set to their scene on values and with
optional ramp rate. The mh items' state is also set to mirror
the scene's control
'off' - all scene members are set off
'brighten' - all scene members' state is incremented
'dim' - all scene members' state is decremented
'resume' - resume is a special state that allows a resumption
of the original states of the scene's member lights.Ramp rate table:
Ramp rates must currently expressed in percentage form. The table below maps percentage to ramp duration.
100% - 0.1s 65% - 26s 29% - 150s
97% - 0.2s 61% - 28s 26% - 180s
94% - 0.3s 58% - 30s 23% - 210s
90% - 0.5s 55% - 32s 19% - 240s
87% - 2.0s 52% - 34s 16% - 270s
84% - 4.5s 48% - 38s 13% - 300s
81% - 6.5s 45% - 43s 10% - 360s
77% - 8.5s 42% - 47s 6% - 420s
74% - 19.0s 39% - 60s 3% - 480s
71% - 21.5s 35% - 90s 0% - 540s
68% - 23.5s 32% - 120sSpecial Considerations:
If using in conjuction with lights managed by Light_Items, various properties of the Light_Item such as "on_state" and "delay_off" may need to be stored, separately managed and restored. Use of scene->tie_event and scene->tie_filter can be used within usercode to gain access to scene and scene member states.
If control over a scene item will be "mapped" via usercode (vice directly controlled by a X10SL-compatible controller), then consider mapping the "off" part of the control to the resume method to avoid making all lights turn off. For example,
if ($some_button->state_now eq ON) {
$my_scene->set(ON);
} elsif ($some_button->state_now eq OFF) {
$my_scene->set('resume');
}Generic Scene base class
Generic_Item
add($x10sl_light, $on_level, $ramp_rate)Adds a scene member
Note that this does NOT automatically enroll the scene at the device level. $on_level and ramp_rate must both be expressed in percentage. See ramp rate table below for ramp rate mapping. $ramp_rate is optional.
TO-DO: ensure that new member doesn't already exist
remove_member($x10sl_light)Removes a member at the device level. Consider only using this method sparingly and possibly via Voice_Command.
Unenrolls member(s) from scene
Deletes (object) member if passed in; otherwise, deletes all members
remove_all_members()Removes all members defined for a scene at the device level. Consider only using this method sparingly and possibly via Voice_Command.
Convenience method as invoking a null arg remove_member isn't obvious
resumeAllows a restore of members' original state values; no restore occurs if the scene has not been set on prior to a resume
NONE
Jason Sharpee jason@sharpee.com
Based on X10_SCENE.pm from: Gregg Liming gregg@limings.net
NONE
This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.
This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
| Scene.pm |