LinuxMCE - User contributions [en]

User talk:Bulek

2012-09-12T01:31:06Z

Bulek: /* Tricks */

== Tricks ==

=== How to setup FM Tuner ===

1. Create Audio Receiver Device (Marantz SR5600 in my case)

2. Create its child device: Tuner - Digital - OTARadio #2042 (ID of 64 in my case)

3. Create Media Scenario :

[[File:tuner_scenarios.png]]

First two commands select proper input (FM Tuner) on audio receiver and tune FM Tuner to certain frequency. Device 64 is device from 2. In such configuration special screen appears for basic control of Tuner (mostly only Mute/Vol+-).

=== Nokia N800 ===

1. gain root access
install openssh
ssh root@localhost
passwd xxxx

2. enable Red Code (address matrix in new repository)

3. install all needed packages

4. transfer fonts
From Core
mkdir /usr/share/fonts/truetype/
mkdir /usr/share/fonts/truetype/msttcorefonts/

to N800 into same directory
tar zxvf tts_fonts.tgz

4. Run Orbiter :
Much easier from GUI, but if you have problems, starting by hand would help :

/usr/bin/Orbiter -r 192.168.80.1 -d 36 -l /tmp/orbiter.log

=== Contributing/Changing templates notes ===

I'm doing this for better trace of sqlcvs contributions entered...

12.03.2008:
- added Cybrotech manufacturer
- added template for Cybrotech Automation Interface

==Request for comment==
Hi,
I've made a request for comment with regard to a debate we're having about categorization of articles. If you could take a look here [[LinuxMCE Wiki talk:Community Portal]] when you have time and perhaps leave a comment I'd be very grateful.

[[User:Lozzo|Lozzo]] 11:40, 8 October 2007 (MST)

=== Setting up telephony features my way... ===
1. call comes in and you have to somehow to reroute it to individual users

2. if you go to users page on web-admin, you can see "Extension for intercom" - that's virtual internal number for each user...

3. if you go to Telecom-Call Routing, there you can determine what will happen with incoming call to each user depending on whether it is normal or priority caller and depending on user's mode...

I do it in slightly different manner, cause I think it's too much to make all those settings for all users...

I usually setup up two adition users (hidden from Orbiters): Doorphone and Housephone

I reroute calls from doorphone to virtual extension of user Doorphone and all incoming calls to virtual extension of Housephone

Therefore I make all those settings in Telecom-Call Routing but only for those two "users".

Now for instance you can set call routing :

- to ring phones and then to voicemail if user is in Home mode
- to go directly to voicemail or to forward call to your celullar phone when you're away

in my case I have SIP trunk as connection to my ip provider I just set all incoming calls to go to extension of housephone (in Advanced-Configuration-Phones setup - where you get Freepbx menus)

2008-12-15T15:46:19Z

Bulek:

Misterhouse

2008-12-07T21:35:00Z

Bulek: /* Integration with LMCE */

{| align="right"
| __TOC__
|}
[[Category:Tutorials]]
[[Category:Automation]]
[http://www.misterhouse.com Misterhouse] is a great integrated Home automation program and much more.

== Installation ==
=== Template ===
It seems that template for Misterhouse is already in LMCE - I only needed to add Computers to "controlled by category", so it can be added as child of Core or MD...

In template, there is an "/usr/local/misterhouse/start.sh" entry in Command line data- that means that LMCE will start this script and therefore also misterhouse. Installation should be made regarding this fact.

=== HowTo ===
Currently there are no Ubuntu packages for MH, so it has to be installed from scratch. An detailed guide can be found on Misterhouse's site, I also have found isntructions for ubuntu and MH [http://misterhouse.wikispaces.com/MisterhouseOnUbuntu MisterhouseOnUbuntu]

== Integration with LMCE ==
Here's a dirty code snippet for LinuxMCE's listener script under Misterhouse. Be careful since it intercepts all messages and that could become quite greedy...

Before using this script you have to add listener as device under LinuxMCE as explained in LinuxMCE's docs...
You have to follow first few steps from LinuxMCE's text message intercepting tutorial (create logic handler device) and then add this script to your Misterhouse setup :

<pre>

# Category=LinuxMCE
#
#@ Connection with LinuxMCE DCE Router via TCP port localhost:3450 (mh.ini -> pluto_DCE_router).
#
use strict;

##############################################################################
$pluto_event_receiver = new Socket_Item(undef, undef, '193.77.90.224:3450','event_receiver','tcp','record');

$pluto_command_sender = new Socket_Item(undef, undef, '193.77.90.224:3450','command_sender','tcp','record');

if ($Startup) {
start $pluto_event_receiver;
set $pluto_event_receiver "COMMAND 6778";

start $pluto_command_sender;
set $pluto_command_sender "EVENT 6778";
set $pluto_command_sender "PLAIN_TEXT";
# purge other interceptors on same device ID
# set $pluto_command_sender "MESSAGET 13";
# set $pluto_command_sender "6778 -1000 13";
send_command_to_pluto("6778 -1000 13");

# intercepts all messages, I guess it's better to be selective here !!!!
# set $pluto_command_sender "MESSAGET 22";
# set $pluto_command_sender "6778 -1000 8 0 0 0 0 0";
send_command_to_pluto("6778 -1000 8 0 0 0 0 0");

}

sub send_command_to_pluto {
my ($message) = @_;
set $pluto_command_sender "MESSAGET " . length ($message);
set $pluto_command_sender $message;
print_log "Sending Command to Pluto DCE : $message\n";
print "Sending Command to Pluto DCE : $message\n";
}

if (my $msg = said $pluto_event_receiver) {
print_log "Pluto Event received: $msg\n";
print "Pluto Event received: $msg\n";
}

</pre>

Some additional work on this matter is described on forum threads here :
[http://forum.linuxmce.org/index.php?topic=3573.0]
[http://forum.linuxmce.org/index.php?topic=391.0]
[http://forum.linuxmce.org/index.php?topic=1884.0]

Adding some useful snippets :

<pre>
if (my $msg = said $pluto_device_event_receiver) {
print_log "Pluto Device Message received: $msg\n";

$msg =~ s/[\"\']//g; # remove quotes before splitting on whitespace

if ($msg =~/(\w*)\s(\w*)\s(\w*)\s(\w*)\s(\w*)\s(\w*)\s(\w*)\s(\w*)/ ) {
print_log "DeviceFrom: $1";
print_log "DeviceTo:: $2";
print_log "MsgType: $3 (1=Command, 2=Event)";
print_log "MsgId: $4";
print_log "param1id: $5";
print_log "param2value (X10 Device): $6";
print_log "param2id: $7";
print_log "param2value (X10 Command): $8";
if ($8 == '192') {
print_log "Turn $6 ON";
set $6 ON;
}
if ($8 == '193') {
print_log "Turn $6 OFF";
set $6 OFF;
}
}
}
</pre>

<pre>
# Category=Pluto
#
#@ Connection with Pluto DCE Router via TCP port localhost:3450 (mh.ini -> pluto_DCE_router).
#
use strict;
$restartTimer = new Timer;

##############################################################################

sub connect_lmce {
print_log "Configuring sockets";
$pluto_device_event_receiver = new Socket_Item(undef, undef, '192.168.1.1:3450','device_event_receiver','tcp','record');
$pluto_device_command_sender = new Socket_Item(undef, undef, '192.168.1.1:3450','device_command_sender','tcp','record');

print_log "Closing sockets if any left open";
if (active_now $pluto_device_event_receiver) {stop $pluto_device_event_receiver;}
if (active_now $pluto_device_command_sender) {stop $pluto_device_command_sender;}

print_log "Open and setup new sockets";

start $pluto_device_event_receiver;
set $pluto_device_event_receiver "COMMAND 179";

start $pluto_device_command_sender;
set $pluto_device_command_sender "EVENT 179";
set $pluto_device_command_sender "PLAIN_TEXT";
}

if ($Startup) {
print_log "Starting connection to LMCE";
set $restartTimer 10, sub {connect_lmce;};
}

if (inactive_now $pluto_device_event_receiver or inactive_now $pluto_device_command_sender) {
print_log "Connection to LMCE terminated, restarting";
set $restartTimer 10, sub {connect_lmce;};
}

if (new_minute 1 and !active $pluto_device_event_receiver or new_minute 1 and !active $pluto_device_command_sender) {
print_log "Connection to LMCE still terminated, restarting";
connect_lmce;
}

#my $motion=0;

if (my $msg = said $pluto_device_event_receiver) {
print_log "Pluto Device Message received: $msg\n";

$msg =~ s/[\"\']//g; # remove quotes before splitting on whitespace

if ($msg =~/(\w*)\s(\w*)\s(\w*)\s(\w*)\s(\w*)\s(\w*)\s(\w*)\s(\w*)/ or $msg =~/(\w*)\s(\w*)\s(\w*)\s(\w*)\s(\w*)\s(\w*)/) {
print_log "DeviceFrom: $1";
print_log "DeviceTo: $2";
print_log "MsgType: $3 (1=Command, 2=Event)";
print_log "MsgId: $4";
print_log "param1id: $5";
print_log "param2value: $6";
if (defined $7) { print_log "param2id: $7";}
if (defined $8) { print_log "param2value: $8";}

#############################################################
# $1 $2 $3 $4 $5 $6 $7 $8
# from to msgtype msgid p1id p1val p2id p2val
# Example command from orbiter
# 69 206 1 192 97 "" 98 ""
# 69 206 1 193 97 ""
# 69 205 1 184 76 "100"
# Example command from admin site
# 0 204 1 760 10 "C2" 154 "192"
# 0 204 1 760 10 "C2" 154 "193"
#############################################################

my $target;
my $x10_id;

if ($2 == '162') { $x10_id = 'A5'; }
if ($2 == '186') { $x10_id = 'A3'; }
if ($2 == '187') { $x10_id = 'B1'; }
if ($2 == '188') { $x10_id = 'A8'; }
if ($2 == '189') { $x10_id = 'B3'; }
if ($2 == '190') { $x10_id = 'B4'; }
if ($2 == '191') { $x10_id = 'A10'; }
if ($2 == '192') { $x10_id = 'A9'; }
if ($2 == '218') { $x10_id = 'A6'; }
if (defined $x10_id) { $target = new X10_Item("$x10_id");}

if ($4 == '760' ) { $target = new X10_Item("$6");}

if ($8 == '192' or $4 == '192') {
print_log "Turn device $x10_id ON";
set $target ON;
}
if ($8 == '193' or $4 == '193') {
print_log "Turn device $x10_id OFF";
set $target OFF;
}
if ($4 == '184') {
print_log "Setting device $x10_id to $6%";
set $target "$6%";
}
}
}

sub send_pluto_message {
my($message) = @_;
set $pluto_device_command_sender "MESSAGET " . length ($message);
set $pluto_device_command_sender $message;
}

sub update_temp {
# Example message@
# 167=temp sensor ID, 2=event, 25=event ID (temp changed), 30=value, temperature (string)
# my $message = sprintf("167 -1000 2 25 30 %d.2",$random_number);

my($sensor, $temp) = @_;
my $lmce_device;

### map iButtons to lmce device numbers - there are better ways of doing this! ###
if ($sensor == 0) { $lmce_device = 166; }
if ($sensor == 1) { $lmce_device = 167; }

my $message = sprintf("$lmce_device -1000 2 25 30 %d.2",$temp);
send_pluto_message($message);
print_log "Updating sensor $lmce_device $temp";
}

sub lmce_motion {
my($device_id) = @_;
# 6780=Detector ID, 2=event, 9=event ID (tripped), 25=tripped value, 0=value (tripped OFF)
my $message = "$device_id -1000 2 9 25 0";
send_pluto_message($message);
}

sub lmce_still {
my($device_id) = @_;
# 6780=Detector ID, 2=event, 9=event ID (tripped), 25=tripped value, 1=value (tripped ON)
my $message = "$device_id -1000 2 9 25 1";
send_pluto_message($message);
}

if ($state = state_now $Kitchen_Motion) {
if ($state eq MOTION) {
lmce_motion(185);
}
if ($state eq STILL) {
lmce_still(185);
}
}

if ($state = state_now $Landing_Motion) {
if ($state eq MOTION) {
lmce_motion(184);
}
if ($state eq STILL) {
lmce_still(184);
}
}

if ($state = state_now $Hall_Motion) {
if ($state eq MOTION) {
lmce_motion(183);
}
if ($state eq STILL) {
lmce_still(183);
}
}
</pre>

<pre>
if ($msg =~/(\w*)\s(\w*)\s(\w*)\s(\w*)\s(\w*)\s(\w*)\s(\w*)\s(\w*)/ or $msg =~/(\w*)\s(\w*)\s(\w*)\s(\w*)\s(\w*)\s(\w*)/
or $msg =~/(\w*)\s(\w*)\s(\w*)\s(\w*)/ ) {
print_log "DeviceFrom: $1";
print_log "DeviceTo: $2";
print_log "MsgType: $3 (1=Command, 2=Event)";
print_log "MsgId: $4";
if (defined $5) { print_log "param1id: $5";}
if (defined $6) { print_log "param2value: $6";}
if (defined $7) { print_log "param2id: $7";}
if (defined $8) { print_log "param2value: $8";}

#############################################################
# $1 $2 $3 $4 $5 $6 $7 $8
# from to msgtype msgid p1id p1val p2id p2val
# Example command from orbiter
# 69 206 1 192 97 "" 98 ""
# 69 206 1 193 97 ""
# 69 205 1 184 76 "100"
# 69 218 1 193
# Example command from admin site
# 0 204 1 760 10 "C2" 154 "192"
# 0 204 1 760 10 "C2" 154 "193"
#############################################################
</pre>

It seems this is the most current version of MH connecting to LMCE:

<pre>
# Category=Pluto
#
#@ Connection with Pluto DCE Router via TCP port localhost:3450 (mh.ini -> pluto_DCE_router).

# strict Perl syntax
use strict;

# Use timer.
$restartTimer = new Timer;

if($Startup)
{
print_log "Starting connection to LMCE";
set $restartTimer 10, sub {connect_lmce;};
}

if
(
inactive_now($pluto_device_event_receiver) ||
inactive_now($pluto_device_command_sender)
)
{
print_log "Connection to LMCE terminated, restarting";
set $restartTimer 10, sub {connect_lmce;};
}

# Should parenthesize &&/|| expressions to make precedence explicit
if(new_minute 1 && !active $pluto_device_event_receiver || new_minute 1 && !active $pluto_device_command_sender)
{
print_log "Connection to LMCE still terminated, restarting";
connect_lmce();
}

#my $motion=0;

if(my($msg) = said($pluto_device_event_receiver))
{ # Process message.
print_log "Pluto Device Message received: $msg\n";

# Remove quotes before splitting on whitespace.
$msg =~ s/[\"\']//g;

#############################################################
# message Parameters as ordered fields
#############################################################
# $1 $2 $3 $4 $5 $6 $7 $8
# from to msgtype msgid p1id p1val p2id p2val
#############################################################
# Example command from orbiter
# 69 206 1 192 97 "" 98 ""
# 69 206 1 193 97 ""
# 69 205 1 184 76 "100"
# Example command from admin site
# 0 204 1 760 10 "C2" 154 "192"
# 0 204 1 760 10 "C2" 154 "193"
#############################################################

# Decode message into required and optional fields as validation.
my
(
$reqFieldsPat = '(\w+)\s+(\w+)\s+(\w+)\s+(\w+)\s+(\w+)\s+(\w+)';
$optFieldsPat = '\s*(\w*)\s*(\w*)';
);
if
(
my
(
# required fields
$deviceFrom, $deviceTo, $msgType, $msgId,
$param1Id, $param1Value,

# optional fields
$param2Id, $param2Value
)
= ($msg =~ /$reqFieldsPat$optFieldsPat/)
)
{ # Process valid message.
%msgTypes =
{
'1' => 'Command',
'2' => 'Event'
};
$msgType .=
': ' . defined($msgTypes{$msgType})?
$msgTypes{$msgType} : 'unknown type';

# Log required fields.
print_log <<EOT;
DeviceFrom: $deviceFrom
DeviceTo: $deviceTo
MsgType: $msgType
MsgId: $msgId
param1id: $param1Id
param2value: $param1Val
EOT

# Log optional fields.
if(defined($param2Id))
{
print_log "param2id: $$param2Id";
print_log 'param2value: ' .
(defined($param2Val))? $param2Val : 'undefined';
}

# Use X10 ID as target.
my($target);
my $x10_id;
%dev2x10 =
{ # device ID to X10 ID
'162' => 'A5',
'186' => 'A3',
'187' => 'B1',
'188' => 'A8',
'189' => 'B3',
'190' => 'B4',
'191' => 'A10',
'192' => 'A9',
'218' => 'A6'
}; # dev2x10

$x10_id = $dev2x10{$deviceTo};
if(defined($x10_id))
{
$target = new X10_Item($x10_id);
}

# Probably can convert arbitrary msgID / setting rules
# to %msg2Setting if they're exclusive and regular.
if($msgId eq '760' )
{ # new item in param1
$target = new X10_Item($param1Val);
}

# Execute message on target.
if($msgId eq '192' || $param2Val eq '192')
{ # ON
print_log "Turn device $x10_id ON";
set $target ON;
}
if($msgId eq '193' || $param2Val eq '193')
{ # OFF
print_log "Turn device $x10_id OFF";
set $target OFF;
}
if($msgId eq '184')
{ # in param1
print_log "Setting device $x10_id to $param1Val%";
set $target "$param1Val%";
}
} # Process message.
}

my(%motionStates) =
{
'MOTION' => '0',
'STILL' => '1'
};
my(%motionLocation2DeviceId) =
{
$Hall_Motion => '183',
$Landing_Motion => '184',
$Kitchen_Motion => '185'
};
my(@motionLocations) = keys(motionLocation2DeviceId);
foreach my($motionLocation) (@motionLocations)
{
if($state = state_now($motionLocation)
{
lmce_motion($motionStates{$state}, $motionLocation);
}
}

# subs ########################################################################

sub connect_lmce
{
print_log "Configuring sockets";
$pluto_device_event_receiver =
new Socket_Item(undef, undef, '192.168.1.1:3450','device_event_receiver','tcp','record');
$pluto_device_command_sender =
new Socket_Item(undef, undef, '192.168.1.1:3450','device_command_sender','tcp','record');

print_log "Closing sockets if any left open";
if(active_now($pluto_device_event_receiver))
{
stop($pluto_device_event_receiver);
}
if(active_now($pluto_device_command_sender))
{
stop($pluto_device_command_sender);
}

print_log "Open and setup new sockets";
start($pluto_device_event_receiver);
set $pluto_device_event_receiver "COMMAND 179";

start($pluto_device_command_sender);
set $pluto_device_command_sender "EVENT 179";
set $pluto_device_command_sender "PLAIN_TEXT";
}

sub send_pluto_message
{
my($message) = @_;

set $pluto_device_command_sender "MESSAGET " . length($message);
set $pluto_device_command_sender $message;
}

sub update_temp
{
my($sensor, $temp) = @_;

# Example message@
# 167=temp sensor ID, 2=event, 25=event ID (temp changed), 30=value, temperature (string)
# my($message) = "167 -1000 2 25 30 $random_number.2";

# Map iButtons to lmce device numbers.
my(%sensorId2LMCEDeviceId) =
{
0 => 166,
1 => 167
}
my($lmce_device) = $sensorId2LMCEDeviceId{$sensor};

my($message) = "$lmce_device -1000 2 25 30 $temp.2";
send_pluto_message($message);
print_log "Updating sensor $lmce_device $temp";
}

sub lmce_motion
{
my($motionState, $device_id) = @_;

# 6780=Detector ID, 2=event, 9=event ID (tripped), 25=tripped value, 1=value (tripped 0=OFF || 1=ON)
my($message) = "$device_id -1000 2 9 25 $motionState";
send_pluto_message($message);
}
</pre>

<pre>
</pre>

<pre>
</pre>

Adding support for floorplan devices

2008-12-04T16:22:22Z

Bulek: /* Problems !!!! */

I needed support for brightness sensors - particularly to display them on floorplan with current values. Since this procedure probably resembles adding support for other devices too, I'm posting my notes...
 
Major steps :

1. create proper template for device (watch proper category and parent settings) 
2. create coresponding event, that will be used to report current values for floorplan device' state 
3. add proper icon and other data in database 
 
 
Since steps 1.-3. were already made for brightness sensors, I did only steps that follow below. I guess Dan can describe steps 1. to 3. much better... 
First I wanted to discover how this feature already works for temperature sensors...
 
It goes like this : 
First there is event called "Temperature changed" that reporting device (home automation controller for instance) creates with parameter of current temperature value. Message gets through DCERouter to Climate Plugin that does this

else if( pMessage->m_dwMessage_Type==MESSAGETYPE_EVENT && pMessage->m_dwID==EVENT_Temperature_Changed_CONST )
{
// Replace the current temp
string sLevel = pMessage->m_mapParameters[EVENTPARAMETER_Value_CONST];
string sCurrentState = pDevice->m_sState_get();
string::size_type pos = sCurrentState.find('(');
if( pos!=string::npos )
sCurrentState = sCurrentState.substr(0,pos-1); // Get rid of the current temp
pDevice->m_sState_set(sCurrentState + " (" + sLevel + ")");
}

in

void Climate_Plugin::PreprocessClimateMessage(DeviceData_Router *pDevice,Message *pMessage)

and sets state of device to reported value.
 
Then Orbiter plugin at line 1367 and procedure

void Orbiter_Plugin::CMD_Get_Current_Floorplan(string sID,int iPK_FloorplanType,string *sValue_To_Assign,string &sCMD_Result,Message *pMessage)

does this (line 1429) :
pFloorplanInfoProvider->GetFloorplanDeviceInfo(pDeviceData_Router,fpObj->m_pEntertainArea,fpObj->Type,iPK_FloorplanObjectType_Color,iColor,sDescription,OSD,PK_DesignObj_Toolbar);

FloorplanInfoProvider is actually coresponding plugin that provides more info about floorplan object. In Climate plugin there is this procedure :

void Climate_Plugin::GetFloorplanDeviceInfo(DeviceData_Router *pDeviceData_Router,EntertainArea *pEntertainArea,int iFloorplanObjectType,int &iPK_FloorplanObjectType_Color,int &Color,string &sDescription,string &OSD,int &PK_DesignObj_Toolbar)
{
switch(iFloorplanObjectType)
{
case FLOORPLANOBJECTTYPE_CLIMATE_THERMOSTAT_CONST:
PK_DesignObj_Toolbar=DESIGNOBJ_grpThermostatControls_CONST;
break;
case FLOORPLANOBJECTTYPE_CLIMATE_THERMOMETER_CONST:
PK_DesignObj_Toolbar=0;
break;
case FLOORPLANOBJECTTYPE_CLIMATE_WEATHER_STATION_CONST:
PK_DesignObj_Toolbar=0;
break;
case FLOORPLANOBJECTTYPE_CLIMATE_DAMPER_CONST:
PK_DesignObj_Toolbar=0;
break;
case FLOORPLANOBJECTTYPE_CLIMATE_POOL_CONST:
PK_DesignObj_Toolbar=DESIGNOBJ_grpPoolControls_CONST;
break;
case FLOORPLANOBJECTTYPE_CLIMATE_SPRINKLER_CONST:
PK_DesignObj_Toolbar=DESIGNOBJ_grpSprinklerControls_CONST;
break;
};
if( (OSD=pDeviceData_Router->m_sState_get())=="OFF" )
iPK_FloorplanObjectType_Color = FLOORPLANOBJECTTYPE_COLOR_CLIMATE_THERMOSTAT_OFF_CONST;
else
iPK_FloorplanObjectType_Color = FLOORPLANOBJECTTYPE_COLOR_CLIMATE_THERMOSTAT_COOLING_CONST;
}

and most important is this line (near bottom) :
OSD=pDeviceData_Router->m_sState_get()

It basically reads state of device and puts it into OSD. OSD is string that will get displayed beside icon. 

Now I'll try to replicate everything similar to Lighting Plugin and brightness sensors :
 

4. Lighting Plugin
 

Added this line

case FLOORPLANOBJECTTYPE_BRIGHTNESS_SENSOR_CONST:
OSD = pDeviceData_Router->m_sState_get();

to

void Lighting_Plugin::GetFloorplanDeviceInfo(DeviceData_Router *pDeviceData_Router,EntertainArea *pEntertainArea,int iFloorplanObjectType,int &iPK_FloorplanObjectType_Color,int &Color,string &sDescription,string &OSD,int &PK_DesignObj_Toolbar)

and adding those lines

else if( pMessage->m_dwMessage_Type==MESSAGETYPE_EVENT && pMessage->m_dwID==EVENT_Brightness_Changed_CONST )
{
// Replace the current level
string sLevel = pMessage->m_mapParameters[EVENTPARAMETER_Value_CONST];
string sCurrentState = pDevice->m_sState_get();
string::size_type pos = sCurrentState.find('(');
if( pos!=string::npos )
sCurrentState = sCurrentState.substr(0,pos-1); // Get rid of the current level
pDevice->m_sState_set(sCurrentState + " (" + sLevel + ")");
}

to the bottom of
void Lighting_Plugin::PreprocessLightingMessage(DeviceData_Router *pDevice,Message *pMessage) 

== Compiling Lighting and Climate plugin : ==

SVN checkout of 710 stable release (it's more convenient to work on currently released version of LinuxMCE)...
 
The minimal routine: 
1) take the latest stable branch - e.g. 710
svn co http://svn.linuxmce.org/svn/branches/LinuxMCE-0710/
2) build it - actually you don't need to build every package- just cd to the desired folder and try to run make there. if you will get missing libs, then you should go to the corresponding library folder and build it. For Lighting and Climate plugins following is needed.

<pre>

cd LinuxMCE-0710/
find . -iname Makefile -exec sed -e 's/<-mkr_t_compile_defines->/-DKDE_LMCE -DDEBUG -DTHREAD_LOG -DLOG_ALL_QUERIES -I\/opt\/libxine1-pluto\/include -I\/opt\/libsdl1.2-1.2.7+1.2.8cvs20041007\/include -I\/opt\/libsdl1.2-1.2.7+1.2.8cvs20041007\/include\/SD/' -i '{}' \;
find . -iname Makefile -exec sed -e 's/<-mkr_t_compile_libs->/-L\/opt\/libxine1-pluto\/lib -L\/opt\/libsdl1.2-1.2.7+1.2.8cvs20041007\/lib/' -i '{}' \;

cd pluto_main
find . -iname Makefile -exec sed -e 's/<-mkr_t_compile_defines->/-DKDE_LMCE -DDEBUG -DTHREAD_LOG -DLOG_ALL_QUERIES -I\/opt\/libxine1-pluto\/include -I\/opt\/libsdl1.2-1.2.7+1.2.8cvs20041007\/include -I\/opt\/libsdl1.2-1.2.7+1.2.8cvs20041007\/include\/SD/' -i '{}' \;
find . -iname Makefile -exec sed -e 's/<-mkr_t_compile_libs->/-L\/opt\/libxine1-pluto\/lib -L\/opt\/libsdl1.2-1.2.7+1.2.8cvs20041007\/lib/' -i '{}' \;
make

cd ../SerializeClass/
find . -iname Makefile -exec sed -e 's/<-mkr_t_compile_defines->/-DKDE_LMCE -DDEBUG -DTHREAD_LOG -DLOG_ALL_QUERIES -I\/opt\/libxine1-pluto\/include -I\/opt\/libsdl1.2-1.2.7+1.2.8cvs20041007\/include -I\/opt\/libsdl1.2-1.2.7+1.2.8cvs20041007\/include\/SD/' -i '{}' \;
find . -iname Makefile -exec sed -e 's/<-mkr_t_compile_libs->/-L\/opt\/libxine1-pluto\/lib -L\/opt\/libsdl1.2-1.2.7+1.2.8cvs20041007\/lib/' -i '{}' \;
make
cd ../DCE/
find . -iname Makefile -exec sed -e 's/<-mkr_t_compile_defines->/-DKDE_LMCE -DDEBUG -DTHREAD_LOG -DLOG_ALL_QUERIES -I\/opt\/libxine1-pluto\/include -I\/opt\/libsdl1.2-1.2.7+1.2.8cvs20041007\/include -I\/opt\/libsdl1.2-1.2.7+1.2.8cvs20041007\/include\/SD/' -i '{}' \;
find . -iname Makefile -exec sed -e 's/<-mkr_t_compile_libs->/-L\/opt\/libxine1-pluto\/lib -L\/opt\/libsdl1.2-1.2.7+1.2.8cvs20041007\/lib/' -i '{}' \;
make
cd ../PlutoUtils
find . -iname Makefile -exec sed -e 's/<-mkr_t_compile_defines->/-DKDE_LMCE -DDEBUG -DTHREAD_LOG -DLOG_ALL_QUERIES -I\/opt\/libxine1-pluto\/include -I\/opt\/libsdl1.2-1.2.7+1.2.8cvs20041007\/include -I\/opt\/libsdl1.2-1.2.7+1.2.8cvs20041007\/include\/SD/' -i '{}' \;
find . -iname Makefile -exec sed -e 's/<-mkr_t_compile_libs->/-L\/opt\/libxine1-pluto\/lib -L\/opt\/libsdl1.2-1.2.7+1.2.8cvs20041007\/lib/' -i '{}' \;
make

cd ../Lighting_Plugin/
find . -iname Makefile -exec sed -e 's/<-mkr_t_compile_defines->/-DKDE_LMCE -DDEBUG -DTHREAD_LOG -DLOG_ALL_QUERIES -I\/opt\/libxine1-pluto\/include -I\/opt\/libsdl1.2-1.2.7+1.2.8cvs20041007\/include -I\/opt\/libsdl1.2-1.2.7+1.2.8cvs20041007\/include\/SD/' -i '{}' \;
find . -iname Makefile -exec sed -e 's/<-mkr_t_compile_libs->/-L\/opt\/libxine1-pluto\/lib -L\/opt\/libsdl1.2-1.2.7+1.2.8cvs20041007\/lib/' -i '{}' \;
make so

cp /usr/pluto/bin/Lighting_Plugin.so /usr/pluto/bin/Lighting_Plugin.orig.so
cp -f ./Lighting_Plugin.so /usr/pluto/bin/Lighting_Plugin.so

cd ../Climate_Plugin/
find . -iname Makefile -exec sed -e 's/<-mkr_t_compile_defines->/-DKDE_LMCE -DDEBUG -DTHREAD_LOG -DLOG_ALL_QUERIES -I\/opt\/libxine1-pluto\/include -I\/opt\/libsdl1.2-1.2.7+1.2.8cvs20041007\/include -I\/opt\/libsdl1.2-1.2.7+1.2.8cvs20041007\/include\/SD/' -i '{}' \;
find . -iname Makefile -exec sed -e 's/<-mkr_t_compile_libs->/-L\/opt\/libxine1-pluto\/lib -L\/opt\/libsdl1.2-1.2.7+1.2.8cvs20041007\/lib/' -i '{}' \;
make so

cp /usr/pluto/bin/Climate_Plugin.so /usr/pluto/bin/Climate_Plugin.orig.so
cp -f ./Climate_Plugin.so /usr/pluto/bin/Climate_Plugin.so

</pre>

== Problems !!!! ==

If you need any new DCE Event or DCE Command added, then you have to work with developers, cause it must be entered into main database first, so you can get right inlude files to use your addition.

[[Category: Programmer's Guide]]

Adding support for floorplan devices

Climate Plugin

2008-12-02T12:11:00Z

Bulek: New page: Category:Climate Category:LinuxMCE_Plugins == Description == == How to use Climate devices in Orbiter ==

[[Category:Climate]]
[[Category:LinuxMCE_Plugins]]
== Description ==

== How to use Climate devices in Orbiter ==

Lighting Plugin

2008-12-02T12:10:55Z

Bulek: New page: Category:Lighting Category:LinuxMCE_Plugins == Description == == How to use Climate devices in Orbiter ==

[[Category:Lighting]]
[[Category:LinuxMCE_Plugins]]

== Description ==

== How to use Climate devices in Orbiter ==

Cisco 7970

2008-11-08T13:48:02Z

Bulek: /* Usefull links */

[[Category: Hardware]]
[[Category: Phones]]
[[Category: Orbiters]]

== Preface ==
[[Image:Cisco7909.JPG]]

LinuxMCE allows the use of many devices as [[Orbiters]]. One of them is the [http://www.cisco.com/en/US/products/hw/phones/ps379/ps5440/index.html CISCO 7970]. You can use it to control your home as well as to make calls.

To add a new CISCO 7970 phone as an Orbiter follow these simple instructions (from information in the [http://forum.linuxmce.org/ LinuxMCE support forum]).

== Preparation ==

CISCO 7970 phone is plug-in-play device; LinuxMCE adds it automatically when it is plugged into the network. But first, we have to make some preparations. Run an Orbiter. Be sure that no others tasks are running.
Check the DHCP setting of your phone. It should be something like that: "get IP via DHCP and no alternative servers".
Check the range of MAC addresses:
#Go to Advanced --> Configuration --> Device Template.
#Chose manufacturer CISCO. You should see in the right list at least two models: 7970 and 7960.
#Press the button 'Show model'.
#On the opened window check 'Range MAC addresses'. The range contains two big decimal digits. To get correct range for your phone first see its MAC address. A MAC address is six groups of two hexadecimal digits, separated by hyphens (-) or colons (:). The first three groups identify a maker. You leave them and fill the rest by 0 and F. For example, if MAC is 00:16:78:CD:01:D8 its range will be 00:16:78:00:00:00 - 00:16:78:FF:FF:FF. After that you should convert those two values into LinuxMCE representation. To do that run a script /usr/pluto/bin/convert_mac and pass the hexadecimal values as parameters:
/usr/pluto/bin/convert_mac 00:16:78:00:00:00
/usr/pluto/bin/convert_mac 00:16:78:FF:FF:FF
:As result you will get two big decimal digits. Add them to the phone template and store.
If you have problems with phone installation, it may be related to firmware. The phone should have the latest firmware upgrade. (I didn't have any problem with existing firmware on my CISCO 7970, though).

Note for '''CISCO 7960 SIP''' users: if your phone fails to register with asterisk then edit /tftpboot/SIPDefault.cnf and append
nat_enable: 1

== Installation ==

#Plug the phone power and network cable. Note if you have two network cards on your core you should plug network cable in the right switch.
#During boot of the phone after 2-3 minutes you should see on the Orbiter a message about new device with your phone MAC address was detected. You should click by caption "Cisco 7970" below that.
#After that the phone should be registered with asterisk and you can see a normal CISCO screen.
#However, it'll take another 2-3 minutes to generate a new Orbiter for CISCO7970.
#When this operation finishes you'll see a message on the Orbiter screen. Make a quick reload of router (Wizard -- Reboot -- Quick Reload Router. I also rebooted CISCO 7970 because I didn't see anything in the menu Services).
#Now go to menu Services on CISCO 7970 and chose Orbiter.

== Troubleshooting ==
*Problem: Phone boots successfully but there is no any message on the Orbiter's screen.
*Solution: If the message doesn't appear check MAC addresses range.

== Some useful tips ==
*To reset a Network configuration of CISCO79xx go to menu 'Network Setting' and press the following sequence of buttons:
**#**
*To check network communications between CISCO7970 and CORE run tcpdump on the CORE:
tcpdump -i eth1 [CISCO7970 IP Address]
or to see detailed packets information:
tcpdump -i -vv eth1 [CISCO7970 IP Address]
or change TimeZone change following line in /tftpboot/SEPDefault7970.cnf.xml (you can find proper TimeZone strings [http://www.voip-info.org/wiki/view/Asterisk+phone+cisco+7970+SIP here] ):
<timeZone>W. Europe Standard/Daylight Time</timeZone>
*To add the voicemail options to the message button, edit the sccp.conf file and add the following to the lines section of each phone:
mailbox=<extension>
vmnum=*97
Email suggestions to: stepanov.michael [at] gmail [dot] com or leave a comment.

==Add Directory buttons to Cisco IP Phone==

=== Download ===
Download the files here: [http://www.unit-e.cc/~tschak/Directory.zip http://www.unit-e.cc/~tschak/Directory.zip]

=== Synopsis ===

This set of files adds a working Directory for your Cisco IP phone. It has been tested on my Cisco 7970 phone, but does not use any additional features, so it should work on any of the other Cisco IP phones that support XML services, such as the Cisco 7960.

It adds the following Features:

* Directory button now works!
* Works with Contacts from the Pluto phone directory
* Paginates them based on # of entries in phone book
* Shows the phone type.

=== Installing this Patch ===

* Unpack the files to the pluto-admin directory. (/var/www/pluto-admin/)
* edit the file /tftpboot/SEPDefault7970.cnf.xml (it just needs to be the default xml for your cisco phone, adjust as needed.)
** Find the <directoryURL></directoryURL> tags, and place '''http://192.168.80.1/pluto-admin/directory.php''' between them.
* Reboot the phone by pressing the settings button, and pressing the following button sequence '''**#**'''

Once the phone boots, try the directory by pressing the Directory button!

If there are any problems, let me know --[[User:Tschak909|Tschak909]] ( thom.cherryhomes (at) gmail (dot) com ).

==Add usefull XML services beside Orbiter==

Currently this feature doesn't make much sense if you use Orbiter on phone, cause it's constantly refreshing and you loose focus of any other menu on the phone.... I've searched internet a bit and found few usefull applications that will let you put rss or xml feeds to your 7970.

Basically you can try rss or xml feeds directly, but also there is usefull script that automatically converts pages to proper format - for example:
http://phone-xml.berbee.com/menu.xml?opts=67

Gives you rss feeds from CNN and BBC. You can also use this script to convert any rss feed to same shape (it's weather rss feed in my country):

http://phone-xml.berbee.com/rss/items.php?url=http://vreme.zurnal24.si/xml/rss/vreme.xml

I have further modified file /var/www/pluto-admin/ServicesMenu.php - and added more entries - basically it's XML list of various URLs to follow.

==Usefull links==

[http://www.asteriskpbx.de/index.php?open79xx Open 79XX XML Directory] - Gives you possibility to edit info showed/used on Phone... I've just tried ver 1.2 and it seems really useful. Beside contacts and search capability, it allows user to organize external xml services, memos, notes together in one easy to traverse menu... Really worth of consideration...

Cisco 7970

2008-11-08T01:25:46Z

Bulek:

2008-07-17T01:17:51Z

Bulek:

[[Category: Admin Website]]
[[Category: Automation]]

I've begun dealing with Events and Events handler and I'm describing few common events I've added to my setup. Please contribute yours as well...

[[Image:TimedEvents.jpg|thumb|200px|Timed Events Admin Page]]
This is how you tell LinuxMCE to do certain tasks at specific times or at regular intervals. For example, you may want to do something every hour, or at 9:00am on Sundays.
 

===House Mode Based Events===
==Coming Home==

==Going To Sleep==

==Waking Up==

==Editing a Time Event==
[[Image:EditTimedEvents.jpg|thumb|200px|Edit Timed Events Admin Page]]
Simply choose the room for which you would like this Timed Event associated and at the bottom of the page you will see a drop down menu of all of the device in your system. Choose the device you want to activate and then chose the command you would like to issue that device. After adding this event, click Update to save the information.

If you would like to use this event as an alarm clock, choose what rooms this event should act as an alarm clock in. It will appear on the Orbiters' sleeping menu and you can turn the alarm on or off. Please note that currently, this function is only available via UI1 as there is no sleeping menu accessible on UI2.
 

==Advanced Menu==
[[Image:AdvancedTimedEvents.jpg|thumb|200px|Advanced Timed Events Admin Page]]

This menu becomes available only after you have added the first Timed Event, but it does give you access to some predefined events that you can edit.
Take the example of Sunset. By clicking the commands text, you can now associate any device with this Timed Event. After adding the device, you will receive a drop down menu with commands to issue this device. This allows you to customize your system to your liking.

Please note that testing any advanced event will likely result in their deletion. This is a bug currently.

Common Events Examples

2008-07-17T01:13:51Z

Bulek: New page: I've begun dealing with Events and Events handler and I'm describing few common events I've added to my setup. Please contribute yours as well...

I've begun dealing with Events and Events handler and I'm describing few common events I've added to my setup. Please contribute yours as well...

ESS Expandable Speaker Selector Switch

2008-07-03T09:58:49Z

Bulek:

{| align="right"
| __TOC__
|}

[[Category: Hardware]]
[[Category: Audio]]
[[Category:Tutorials]]

[[Image:Ess2468.gif]]

More info about [http://hacs.com/essall.php device ] :

This is nice multizone expandable speaker selector swithc, that can be IR or RS232 controlled. Each zone can also have separate control for 11 volume levels. Although recently it's price went significantly up, I still think it's quite usable (I'm yet about to try it in real life). I'll use it for connecting several speakers pairs to Multiroom secondary stereo amplified output on my Marantz SR5600. In this way I'll get nice configurable family home audio system with two audio channels distributed around house and fully controlled by LMCE (I produce second channel also on LMCE Hybrid, by using squeezeslave and another USB sound card)...

Device includes "base" module, to whom you simply attach different modules (they differ on volume control features) for each zone up to 31. Each zone is simply numbered, zone 0 is special zone - sending commands to that zone will have effect on all zones at once.

There is simple RS232 protocol for this device, described [http://hacs.com/ess_commands.php?PHPSESSID=5849f9d4952a3863fd68a4d2a507123c here] It's pretty simple and ASCII based..

The whole idea of implementation is to have each zone represented by "Zone" child devices (template #1867), adding as much as you have them in your device. By default zone "0" will be represented by device it self - so sending commands to parent device will have effect on all zones. Sending commands only to Zone child devices, will have effect only in target zone. At the start, 1 child zone is added to parent device - I assume there will be at least one zone in system. Then you add more zones to suit your system.

== Description of needed templates ==

I hope that this template will be available with stock LMCE distribution, so you won't have to create that template from scratch. Template is called "ESS Speaker Selector RS232" and was created from scratch but inspired by my work on "SR Marantz Multiroom RS232" template described on wiki.

For template to be functional I've made certain extensions to existing template for "Zone" that I hope will be usefull also to others. Extensions are described here [Marantz_SR5600]

=== Important device data and parameters for "ESS Speaker Selector RS232" template ===
Description : ESS Speaker Selector RS232
Implements DCE : yes
Command line : Generic_Serial_Device
Device Category AV/preamps/... #103
Manufacturer HACS - Home Automation Control Systems

Also have added following parameters :

Device data
Current Data Comments Default Value
#37 COM Port on PC /dev/ttyS0
#76 COM Port ParityBit/Stop N81
#78 COM Port BaudRate B9600
#220 Process Child Commands In Pare 1 (needed to have ability to send all commands to parent)
#157 Discrete Volume(bool) 1

Settings are factory defaults and should't be changed (9600 baud rate, 8 bits, 1 stop bit)...

=== 'Edit Ruby code' (on template page) ===
==== 'Determining proper set of inputs' ====

Device has two inputs for amplified stereo signals (A,B). Then each zone or all together can be switched on/off and set to input A or B. Zone modules can have no volume control, manual control or 11-level volume control controlled from RS232 interface. Each zone has two inputs for amplified signalI've added all inputs that are present on device. There is also a special input called "FM" where I connected Live TV embedded device to be able to control tuner functions (tuning/searching up/down, go to preset stations, etc...)

==== 'Set proper set of commands' ====

Basically I've added command groups :
Ruby Internal Commands
Simple IO commands (on,off)
Volume Commands (vol+,vol-,set volume)
Inputs (A,B)

==== 'Add Ruby snippets to commands'====

I've created new IR/Codeset group called "ESS Speaker Selector RS232", although I'm not sure how to handle it. Have also edited corresponding Ruby snippets for each command. Basically those are just simple strings that get sent on rs232 (they differ mainly on target zone) to take proper action on device according to received command from LinuxMCE...

More important parts with more Ruby code :

<pre><nowiki>
Power
#193 Off
SendZoneCommand(cmd)

#192 On
SendZoneCommand(cmd)

Inputs
#953 A
SendZoneCommand(cmd)

#954 B
SendZoneCommand(cmd)

Internal
#373 Private Method Listing
###########################################################3 Internal Methods
# To do list :
# - ???
#
#
# RS232 protocol, ZN=Zone Number (00 is all, 01-31 separate zones)
# ZN 01 ON
# ZN 02 OFF
# ZN 03 A AMP
# ZN 04 B AMP
# ZN 07 VOLUME UP
# ZN 08 VOLUME DOWN
# ZN 09 SET LEVEL 0
# ZN 10 SET LEVEL 1
# ZN 11 SET LEVEL 2
# ZN 12 SET LEVEL 3
# ZN 13 SET LEVEL 4
# ZN 14 SET LEVEL 5
# ZN 15 SET LEVEL 6
# ZN 16 SET LEVEL 7
# ZN 17 SET LEVEL 8
# ZN 18 SET LEVEL 9
# ZN 19 SET LEVEL 10
# ZN 20 SET LEVEL 11
# ZN 32 ? STATUS
# ZN 33 ? LEVEL
# ZN 34 ? ON/OFF
# ZN 35 ? A/B

def log(line)
$log = File.open("/var/log/pluto/" + device_.devid_.to_s + "_Generic_Serial_Device.log", "a")
# $log = File.open("/var/log/pluto/ESS.log", "a")
logTime = Time.now
timeStr = logTime.strftime("%d-%m-%Y %H:%M:%S ")

$log.puts timeStr + "(***):" + line.to_s
$log.close
end

def Send_RS232_Command(command)
log("Send_RS232_Command: [" + command+ "]\n")
# conn_.Send("[" + command+ "]")
end

def SendZoneCommand(cmd)

log("Got Command with ID: " + cmd.id_.to_s + " from: " + cmd.devidfrom_.to_s + " to: " + cmd.devidto_.to_s + "\n")
zone = GetZone(cmd.devidto_)
if( zone >= 0 )
zone_desc=device_.childdevices_[cmd.devidto_].devdata_[186]
log("SendZoneCommand: Child Zone " + zone_desc + "[" + zone.to_s + "]\n")
elsif (cmd.devidto_ == device_.devid_)
log("SendZoneCommand: All Zones " + zone.to_s + ". Sending command to all zones !!!")
zone=0
zone_desc="All Zones"
else
log("SendZoneCommand: Invalid zone " + zone.to_s + ". Send commands only to valid devices!!!")
end

serial_command = ""

case cmd.id_
when 192 #192 is ON
serial_command = sprintf("%02d",zone)+sprintf("%02d",1);
Send_RS232_Command(serial_command);
temp_cmd = Command.new(cmd.id_, -1001, 1, 2, 48);
temp_cmd.params_[10] = "1";
SendCommand(temp_cmd);
$ZoneStatus[zone.to_s] = "ON";
if (zone==0)
SetZones("ON")
end
when 193 #193 is OFF
serial_command = sprintf("%02d",zone)+sprintf("%02d",2);
Send_RS232_Command(serial_command);
temp_cmd = Command.new(cmd.id_, -1001, 1, 2, 48);
temp_cmd.params_[10] = "0";
SendCommand(temp_cmd);
$ZoneStatus[zone.to_s] = "OFF";
if (zone==0)
SetZones("OFF")
end

when 90 #90 is Volume Down
serial_command = sprintf("%02d",zone)+sprintf("%02d",8);
Send_RS232_Command(serial_command);
$ZoneVolumes[zone.to_s] = $ZoneVolumes[zone.to_s] - 10
if ($ZoneVolumes[zone.to_s]<0)
$ZoneVolumes[zone.to_s]=0
end
SetDeviceDataInDB( cmd.devidto_, 158, ($ZoneVolumes[zone.to_s]).to_s ) # 158 = DEVICEDATA_Volume_Level_CONST
temp_cmd = Command.new(cmd.devidto_, -1001, 1, 2, 71);
temp_cmd.params_[30] = ($ZoneVolumes[zone.to_s]).to_s
SendCommand(temp_cmd);

when 89 #90 is Volume Up
serial_command = sprintf("%02d",zone)+sprintf("%02d",7);
Send_RS232_Command(serial_command);
$ZoneVolumes[zone.to_s] = $ZoneVolumes[zone.to_s] + 10
if ($ZoneVolumes[zone.to_s]>=120)
$ZoneVolumes[zone.to_s]=110
end
SetDeviceDataInDB( cmd.devidto_, 158, ($ZoneVolumes[zone.to_s]).to_s ) # 158 = DEVICEDATA_Volume_Level_CONST
temp_cmd = Command.new(cmd.devidto_, -1001, 1, 2, 71);
temp_cmd.params_[30] = ($ZoneVolumes[zone.to_s]).to_s
SendCommand(temp_cmd);
when 313 #313 is Set Volume with Level as Param #76
log("313:Set Volume Command: Got Cmd with ID: " + cmd.id_.to_s + " from: " + cmd.devidfrom_.to_s + " to: " + cmd.devidto_.to_s + " | Zone : " + zone.to_s + "\n")
level=(cmd.params_[76]).to_i
if level >110
level=110
log("313:Set Volume Command: Volume too high - truncated to max level of 110\n")
elsif level <0
level=0
log("313:Set Volume Command: Volume too low - truncated to min level of 0\n")
end
level = (level/10.0).round
serial_command = sprintf("%02d",zone)+sprintf("%02d",level+9);
Send_RS232_Command(serial_command);
$ZoneVolumes[zone.to_s] = (cmd.params_[76]).to_i
SetDeviceDataInDB( cmd.devidto_, 158, ($ZoneVolumes[zone.to_s]).to_s ) # 158 = DEVICEDATA_Volume_Level_CONST
temp_cmd = Command.new(cmd.devidto_, -1001, 1, 2, 71);
temp_cmd.params_[30] = ($ZoneVolumes[zone.to_s]).to_s
SendCommand(temp_cmd);
if (zone==0)
SetVolumes($ZoneVolumes[zone.to_s])
end

when 616 #616 is Select A
serial_command = sprintf("%02d",zone)+sprintf("%02d",3);
Send_RS232_Command(serial_command);
when 617 #617 is Select B
serial_command = sprintf("%02d",zone)+sprintf("%02d",4);
Send_RS232_Command(serial_command);
else
log("Yet not implemented: Handler for command: ID " + cmd.id.to_s)
end

end

def GetZone(deviceDestination)
if( device_.mapDevice_PortChannel_.has_key?(deviceDestination) and
device_.mapDevice_PortChannel_[deviceDestination] != nil and
!device_.mapDevice_PortChannel_[deviceDestination].empty? )
return device_.mapDevice_PortChannel_[deviceDestination].to_i
end

return -1
end

def ReceiveReport()
@buff = conn_.RecvDelimited("]", 1000)
log("Response from ESS: " + @buff + "\n")
# log("Calling DecodeReceivedInfo: " + @buff + "\n")
# temp_resp=@buff;
# DecodeReceivedInfo(temp_resp)
# log("End of DecodeReceivedInfo: " + temp_resp + "\n")
end

def SetVolumeInZone(level,zone)
# Sets Normalized Volume Level (0..100) in certain zone
normlevel = (level.to_i/10.0).round
log("SetVolumeInZone: volume: " + level.to_s + " ["+ normlevel.to_s + "] => Zone: " + zone + "\n")

serial_command = sprintf("%02d",zone)+sprintf("%02d",normlevel+9);
Send_RS232_Command(serial_command);
# log("313:Set Volume Command: Got Cmd with ID: " + cmd.id_.to_s + " from: " + cmd.devidfrom_.to_s + " to: " + cmd.devidto_.to_s + " | Zone : " + zone.to_s + "\n")
$ZoneVolumes[zone.to_s] = level.to_i

end

def SetZonesInitialVolumes()
log("####### Set Initial Volume Levels for zones\n")
device_.mapDevice_PortChannel_.each do |key, value|
volume = device_.childdevices_[key].devdata_[208]
log("Zone " + value.to_s + " => " + volume.to_s + "\n")
sleep 1.0
SetVolumeInZone(volume.to_i,value)
SetDeviceDataInDB( device_.childdevices_[key].devid_, 158, ($ZoneVolumes[value.to_s]).to_s ) # 158 = DEVICEDATA_Volume_Level_CONST
end

end

def SetZones(state)
log("####### Setting all zones to " + state + "\n")
device_.mapDevice_PortChannel_.each do |key, value|
$ZoneStatus[value] = state
log("Zone " + value.to_s + " => " + state + "\n")
end
end

def SetVolumes(level_int)
log("####### Set Volume Levels for all zones\n")
device_.mapDevice_PortChannel_.each do |key, value|
log("Zone " + value.to_s + " => " + level_int.to_s + "\n")
$ZoneVolumes[value.to_s] = level_int
SetDeviceDataInDB( device_.childdevices_[key].devid_, 158, ($ZoneVolumes[value.to_s]).to_s ) # 158 = DEVICEDATA_Volume_Level_CONST
end
end

#351 Process IDLE

#350 Process Incoming Data
ReceiveReport()

#355 Process Initialize

log("Initializing ESS GSD Device\n")

sleep 1.0
Send_RS232_Command("0002"); #All Zones OFF
sleep 1.0
Send_RS232_Command("0020"); #All Zones Max Volume
sleep 1.0
Send_RS232_Command("0003"); #All Zones Select A
sleep 1.0
$ZoneVolumes = Hash.new()
$ZoneStatus = Hash.new()

SetZones("OFF")
SetZonesInitialVolumes()

log("Initialization of ESS GSD Device finished !!!!\n")

#384 Process Receive Command For Child
SendZoneCommand(cmd)

#356 Process Release
Send_RS232_Command("0002"); #All Zones OFF

Send_RS232_Command("0020"); #All Zones Max Volume

Send_RS232_Command("0003"); #All Zones Select A

log("Shutting Down ESS GSD Device finished !!!!\n")

Misc
#616 Select A

#617 Select B

Sound & Volume
#97 Mute

#313 Set Volume
SendZoneCommand(cmd)

#90 Vol Down

#89 Vol Up

</nowiki></pre>

ESS Expandable Speaker Selector Switch

2008-07-03T09:55:28Z

Bulek: /* 'Add Ruby snippets to commands' */

{| align="right"
| __TOC__
|}

[[Category: Hardware]]
[[Category: Audio]]
[[Category:Tutorials]]

In editing phase !!! - working copy !!!

[[Image:Ess2468.gif]]

More info about [http://hacs.com/essall.php device ] :

This is nice multizone expandable speaker selector swithc, that can be IR or RS232 controlled. Each zone can also have separate control for 11 volume levels. Although recently it's price went significantly up, I still think it's quite usable (I'm yet about to try it in real life). I'll use it for connecting several speakers pairs to Multiroom secondary stereo amplified output on my Marantz SR5600. In this way I'll get nice configurable family home audio system with two audio channels distributed around house and fully controlled by LMCE (I produce second channel also on LMCE Hybrid, by using squeezeslave and another USB sound card)...

Device includes "base" module, to whom you simply attach different modules (they differ on volume control features) for each zone up to 31. Each zone is simply numbered, zone 0 is special zone - sending commands to that zone will have effect on all zones at once.

There is simple RS232 protocol for this device, described [http://hacs.com/ess_commands.php?PHPSESSID=5849f9d4952a3863fd68a4d2a507123c here] It's pretty simple and ASCII based..

The whole idea of implementation is to have each zone represented by "Zone" child devices (template #1867), adding as much as you have them in your device. By default zone "0" will be represented by device it self - so sending commands to parent device will have effect on all zones. Sending commands only to Zone child devices, will have effect only in target zone. At the start, 1 child zone is added to parent device - I assume there will be at least one zone in system. Then you add more zones to suit your system.

== Description of needed templates ==

I hope that this template will be available with stock LMCE distribution, so you won't have to create that template from scratch. Template is called "ESS Speaker Selector RS232" and was created from scratch but inspired by my work on "SR Marantz Multiroom RS232" template described on wiki.

For template to be functional I've made certain extensions to existing template for "Zone" that I hope will be usefull also to others. Extensions are described here [Marantz_SR5600]

=== Important device data and parameters for "ESS Speaker Selector RS232" template ===
Description : ESS Speaker Selector RS232
Implements DCE : yes
Command line : Generic_Serial_Device
Device Category AV/preamps/... #103
Manufacturer HACS - Home Automation Control Systems

Also have added following parameters :

Device data
Current Data Comments Default Value
#37 COM Port on PC /dev/ttyS0
#76 COM Port ParityBit/Stop N81
#78 COM Port BaudRate B9600
#220 Process Child Commands In Pare 1 (needed to have ability to send all commands to parent)
#157 Discrete Volume(bool) 1

Settings are factory defaults and should't be changed (9600 baud rate, 8 bits, 1 stop bit)...

=== 'Edit Ruby code' (on template page) ===
==== 'Determining proper set of inputs' ====

Device has two inputs for amplified stereo signals (A,B). Then each zone or all together can be switched on/off and set to input A or B. Zone modules can have no volume control, manual control or 11-level volume control controlled from RS232 interface. Each zone has two inputs for amplified signalI've added all inputs that are present on device. There is also a special input called "FM" where I connected Live TV embedded device to be able to control tuner functions (tuning/searching up/down, go to preset stations, etc...)

==== 'Set proper set of commands' ====

Basically I've added command groups :
Ruby Internal Commands
Simple IO commands (on,off)
Volume Commands (vol+,vol-,set volume)
Inputs (A,B)

==== 'Add Ruby snippets to commands'====

I've created new IR/Codeset group called "ESS Speaker Selector RS232", although I'm not sure how to handle it. Have also edited corresponding Ruby snippets for each command. Basically those are just simple strings that get sent on rs232 (they differ mainly on target zone) to take proper action on device according to received command from LinuxMCE...

More important parts with more Ruby code :

<pre><nowiki>
Power
#193 Off
SendZoneCommand(cmd)

#192 On
SendZoneCommand(cmd)

Inputs
#953 A
SendZoneCommand(cmd)

#954 B
SendZoneCommand(cmd)

Internal
#373 Private Method Listing
###########################################################3 Internal Methods
# To do list :
# - ???
#
#
# RS232 protocol, ZN=Zone Number (00 is all, 01-31 separate zones)
# ZN 01 ON
# ZN 02 OFF
# ZN 03 A AMP
# ZN 04 B AMP
# ZN 07 VOLUME UP
# ZN 08 VOLUME DOWN
# ZN 09 SET LEVEL 0
# ZN 10 SET LEVEL 1
# ZN 11 SET LEVEL 2
# ZN 12 SET LEVEL 3
# ZN 13 SET LEVEL 4
# ZN 14 SET LEVEL 5
# ZN 15 SET LEVEL 6
# ZN 16 SET LEVEL 7
# ZN 17 SET LEVEL 8
# ZN 18 SET LEVEL 9
# ZN 19 SET LEVEL 10
# ZN 20 SET LEVEL 11
# ZN 32 ? STATUS
# ZN 33 ? LEVEL
# ZN 34 ? ON/OFF
# ZN 35 ? A/B

def log(line)
$log = File.open("/var/log/pluto/" + device_.devid_.to_s + "_Generic_Serial_Device.log", "a")
# $log = File.open("/var/log/pluto/ESS.log", "a")
logTime = Time.now
timeStr = logTime.strftime("%d-%m-%Y %H:%M:%S ")

$log.puts timeStr + "(***):" + line.to_s
$log.close
end

def Send_RS232_Command(command)
log("Send_RS232_Command: [" + command+ "]\n")
# conn_.Send("[" + command+ "]")
end

def SendZoneCommand(cmd)

log("Got Command with ID: " + cmd.id_.to_s + " from: " + cmd.devidfrom_.to_s + " to: " + cmd.devidto_.to_s + "\n")
zone = GetZone(cmd.devidto_)
if( zone >= 0 )
zone_desc=device_.childdevices_[cmd.devidto_].devdata_[186]
log("SendZoneCommand: Child Zone " + zone_desc + "[" + zone.to_s + "]\n")
elsif (cmd.devidto_ == device_.devid_)
log("SendZoneCommand: All Zones " + zone.to_s + ". Sending command to all zones !!!")
zone=0
zone_desc="All Zones"
else
log("SendZoneCommand: Invalid zone " + zone.to_s + ". Send commands only to valid devices!!!")
end

serial_command = ""

case cmd.id_
when 192 #192 is ON
serial_command = sprintf("%02d",zone)+sprintf("%02d",1);
Send_RS232_Command(serial_command);
temp_cmd = Command.new(cmd.id_, -1001, 1, 2, 48);
temp_cmd.params_[10] = "1";
SendCommand(temp_cmd);
$ZoneStatus[zone.to_s] = "ON";
if (zone==0)
SetZones("ON")
end
when 193 #193 is OFF
serial_command = sprintf("%02d",zone)+sprintf("%02d",2);
Send_RS232_Command(serial_command);
temp_cmd = Command.new(cmd.id_, -1001, 1, 2, 48);
temp_cmd.params_[10] = "0";
SendCommand(temp_cmd);
$ZoneStatus[zone.to_s] = "OFF";
if (zone==0)
SetZones("OFF")
end

when 90 #90 is Volume Down
serial_command = sprintf("%02d",zone)+sprintf("%02d",8);
Send_RS232_Command(serial_command);
$ZoneVolumes[zone.to_s] = $ZoneVolumes[zone.to_s] - 10
if ($ZoneVolumes[zone.to_s]<0)
$ZoneVolumes[zone.to_s]=0
end
SetDeviceDataInDB( cmd.devidto_, 158, ($ZoneVolumes[zone.to_s]).to_s ) # 158 = DEVICEDATA_Volume_Level_CONST
temp_cmd = Command.new(cmd.devidto_, -1001, 1, 2, 71);
temp_cmd.params_[30] = ($ZoneVolumes[zone.to_s]).to_s
SendCommand(temp_cmd);

when 89 #90 is Volume Up
serial_command = sprintf("%02d",zone)+sprintf("%02d",7);
Send_RS232_Command(serial_command);
$ZoneVolumes[zone.to_s] = $ZoneVolumes[zone.to_s] + 10
if ($ZoneVolumes[zone.to_s]>=120)
$ZoneVolumes[zone.to_s]=110
end
SetDeviceDataInDB( cmd.devidto_, 158, ($ZoneVolumes[zone.to_s]).to_s ) # 158 = DEVICEDATA_Volume_Level_CONST
temp_cmd = Command.new(cmd.devidto_, -1001, 1, 2, 71);
temp_cmd.params_[30] = ($ZoneVolumes[zone.to_s]).to_s
SendCommand(temp_cmd);
when 313 #313 is Set Volume with Level as Param #76
log("313:Set Volume Command: Got Cmd with ID: " + cmd.id_.to_s + " from: " + cmd.devidfrom_.to_s + " to: " + cmd.devidto_.to_s + " | Zone : " + zone.to_s + "\n")
level=(cmd.params_[76]).to_i
if level >110
level=110
log("313:Set Volume Command: Volume too high - truncated to max level of 110\n")
elsif level <0
level=0
log("313:Set Volume Command: Volume too low - truncated to min level of 0\n")
end
level = (level/10.0).round
serial_command = sprintf("%02d",zone)+sprintf("%02d",level+9);
Send_RS232_Command(serial_command);
$ZoneVolumes[zone.to_s] = (cmd.params_[76]).to_i
SetDeviceDataInDB( cmd.devidto_, 158, ($ZoneVolumes[zone.to_s]).to_s ) # 158 = DEVICEDATA_Volume_Level_CONST
temp_cmd = Command.new(cmd.devidto_, -1001, 1, 2, 71);
temp_cmd.params_[30] = ($ZoneVolumes[zone.to_s]).to_s
SendCommand(temp_cmd);
if (zone==0)
SetVolumes($ZoneVolumes[zone.to_s])
end

when 616 #616 is Select A
serial_command = sprintf("%02d",zone)+sprintf("%02d",3);
Send_RS232_Command(serial_command);
when 617 #617 is Select B
serial_command = sprintf("%02d",zone)+sprintf("%02d",4);
Send_RS232_Command(serial_command);
else
log("Yet not implemented: Handler for command: ID " + cmd.id.to_s)
end

end

def GetZone(deviceDestination)
if( device_.mapDevice_PortChannel_.has_key?(deviceDestination) and
device_.mapDevice_PortChannel_[deviceDestination] != nil and
!device_.mapDevice_PortChannel_[deviceDestination].empty? )
return device_.mapDevice_PortChannel_[deviceDestination].to_i
end

return -1
end

def ReceiveReport()
@buff = conn_.RecvDelimited("]", 1000)
log("Response from ESS: " + @buff + "\n")
# log("Calling DecodeReceivedInfo: " + @buff + "\n")
# temp_resp=@buff;
# DecodeReceivedInfo(temp_resp)
# log("End of DecodeReceivedInfo: " + temp_resp + "\n")
end

def SetVolumeInZone(level,zone)
# Sets Normalized Volume Level (0..100) in certain zone
normlevel = (level.to_i/10.0).round
log("SetVolumeInZone: volume: " + level.to_s + " ["+ normlevel.to_s + "] => Zone: " + zone + "\n")

serial_command = sprintf("%02d",zone)+sprintf("%02d",normlevel+9);
Send_RS232_Command(serial_command);
# log("313:Set Volume Command: Got Cmd with ID: " + cmd.id_.to_s + " from: " + cmd.devidfrom_.to_s + " to: " + cmd.devidto_.to_s + " | Zone : " + zone.to_s + "\n")
$ZoneVolumes[zone.to_s] = level.to_i

end

def SetZonesInitialVolumes()
log("####### Set Initial Volume Levels for zones\n")
device_.mapDevice_PortChannel_.each do |key, value|
volume = device_.childdevices_[key].devdata_[208]
log("Zone " + value.to_s + " => " + volume.to_s + "\n")
sleep 1.0
SetVolumeInZone(volume.to_i,value)
SetDeviceDataInDB( device_.childdevices_[key].devid_, 158, ($ZoneVolumes[value.to_s]).to_s ) # 158 = DEVICEDATA_Volume_Level_CONST
end

end

def SetZones(state)
log("####### Setting all zones to " + state + "\n")
device_.mapDevice_PortChannel_.each do |key, value|
$ZoneStatus[value] = state
log("Zone " + value.to_s + " => " + state + "\n")
end
end

def SetVolumes(level_int)
log("####### Set Volume Levels for all zones\n")
device_.mapDevice_PortChannel_.each do |key, value|
log("Zone " + value.to_s + " => " + level_int.to_s + "\n")
$ZoneVolumes[value.to_s] = level_int
SetDeviceDataInDB( device_.childdevices_[key].devid_, 158, ($ZoneVolumes[value.to_s]).to_s ) # 158 = DEVICEDATA_Volume_Level_CONST
end
end

#351 Process IDLE

#350 Process Incoming Data
ReceiveReport()

#355 Process Initialize

log("Initializing ESS GSD Device\n")

sleep 1.0
Send_RS232_Command("0002"); #All Zones OFF
sleep 1.0
Send_RS232_Command("0020"); #All Zones Max Volume
sleep 1.0
Send_RS232_Command("0003"); #All Zones Select A
sleep 1.0
$ZoneVolumes = Hash.new()
$ZoneStatus = Hash.new()

SetZones("OFF")
SetZonesInitialVolumes()

log("Initialization of ESS GSD Device finished !!!!\n")

#384 Process Receive Command For Child
SendZoneCommand(cmd)

#356 Process Release
Send_RS232_Command("0002"); #All Zones OFF

Send_RS232_Command("0020"); #All Zones Max Volume

Send_RS232_Command("0003"); #All Zones Select A

log("Shutting Down ESS GSD Device finished !!!!\n")

Misc
#616 Select A

#617 Select B

Sound & Volume
#97 Mute

#313 Set Volume
SendZoneCommand(cmd)

#90 Vol Down

#89 Vol Up

</nowiki></pre>

User:Bulek

2008-06-29T21:34:57Z

Bulek:

Temporary copy of LG LCD TV template (based on existing LG_42LB5D template)

==== 'Add Ruby snippets to commands'====

Simpler commands from Ruby part of template :
<pre><nowiki>
Power
#193 Off
log('Sending OFF Command') <$"ka 01 00\r"$>

#192 On
log('Sending ON Command') <$"ka 01 01\r"$>

InputsInput commands not implemented: Antenna, Tuner - Digital (Click to add)
#316 AV 1
log('Switching Input to AV1') <$"kb 01 02\r"$>

#317 AV 2
log('Switching Input to AV2') <$"kb 01 03\r"$>

#712 Component 1
log('Switching Input to Component 1') <$"kb 01 04\r"$>

#361 HDMI
log('Switching Input to HDMI 1') <$"kb 01 07\r"$>

#154 RGB
log('Switching Input to RGB/PC') <$"kb 01 06\r"$>

Aspect Ratios
#879 16:9
log('Aspect Ratio 16:9') <$"kc 01 02\r"$>

#877 4:3
log('Aspect Ratio 4:3') <$"kc 01 01\r"$>

DSP Modes
#116 DSP Mode

General
#190 Enter/Go
log('Sending Enter/Go Command') <$"mc 01 44\r"$>

Internal
#373 Private Method Listing
def log(line) $log = File.open("/var/log/pluto/" + device_.devid_.to_s + "_Generic_Serial_Device.log", "a") $log.puts "(***):" + line.to_s $log.close end

#351 Process IDLE

#350 Process Incoming Data
buff = '' while(true) buff=conn_.Recv(30,200) if(buff.length() == 0) log('Nothing Received') break end log('Received: ' + Regexp.escape(buff.to_s)) if !buff.index("OK").nil? log(Regexp.escape(buff.to_s) + ': Command Processed Successfully') elsif !buff.index("NG").nil? log(Regexp.escape(buff.to_s) +': Command Processed Unsuccessfully') end end

#355 Process Initialize
for iRetry in 0...4 print "Initializing unit\n" conn_.Send("ke 01 01\r") # Send UnMute Command buf = conn_.Recv(30,200) # Expected Return # ke 01 01\r\ne 00 OK01x\r\n if !buf.nil? && !buf.index("OK").nil? print "Initialized ok\n" print "Setting volume to 30%\n" cmd_313(15) SetDeviceDataInDB( device_.devid_, 158, "15" ) # 158 = DEVICEDATA_Volume_Level_CONST return end print "Failed to initialize. Wait 1 secs and try again\n" sleep(1) end #DisableDevice( device_.devid_, true ) #print "The device would not respond. Disabling it.\n"

#384 Process Receive Command For Child

#356 Process Release

Misc
#587 Preset/Prog/Freq

#676 Video Mute
log('Sending Video Mute Command') <$"kd 01 00\r"$>

#683 Zoom
log('Aspect Ratio 16:9') <$"kc 01 05\r"$>

Numbers
#204 0
log('Sending 0 ') <$"mc 01 10\r"$>

#205 1
log('Sending 1 ') <$"mc 01 11\r"$>

#206 2
log('Sending 2 ') <$"mc 01 12r"$>

#207 3
log('Sending 3 ') <$"mc 01 13\r"$>

#208 4
log('Sending 4 ') <$"mc 01 14\r"$>

#209 5
log('Sending 5 ') <$"mc 01 15\r"$>

#210 6
log('Sending 6 ') <$"mc 01 16\r"$>

#211 7
log('Sending 7 ') <$"mc 01 17\r"$>

#212 8
log('Sending 8 ') <$"mc 01 18\r"$>

#213 9
log('Sending 9 ') <$"mc 01 19\r"$>

On-Screen Menu Navig
#86 Menu (Show Menu)
log('Sending Menu Command') <$"mc 01 43\r"$>

#201 Move Down
log('Menu Down') <$"mc 01 41\r"$>

#202 Move Left
log('Menu Left') <$"mc 01 07\r"$>

#203 Move Right
log('Menu Right') <$"mc 01 06\r"$>

#200 Move Up
log('Menu Up') <$"mc 01 40\r"$>

Picture Control
#224 Brightness Down

#223 Brightness Up

#221 Contrast Down

#220 Contrast Up

Simple Control
#64 Skip Back - Channel/Track Lower

#63 Skip Fwd - Channel/Track Greater

Sound & Volume
#97 Mute
if(@mute) <$"ke 01 00\r"$> else <$"ke 01 01\r"$> end @mute=!@mute

#313 Set Volume
@volume=level.to_i() ilevel = @volume.to_i log( 'setting volume to '+ ilevel.to_s) log('Sending the Following Command: kf 01 '+ilevel.to_s(16)+'\r') <$"kf 01 "+ilevel.to_s(16)+"\r"$> SetDeviceDataInDB( device_.devid_, 158, ilevel .to_s) # 158DEVICEDATA_Volume_Level_CONST # "volume and corresponding device data set\n"

#90 Vol Down
log('lowering volume from ' + @volume.to_s) cmd_313(@volume-1)

#89 Vol Up
log('Increasing volume from ' + @volume.to_s) cmd_313(@volume+1)

</nowiki></pre>

User:Bulek

2008-06-29T21:33:26Z

Bulek:

ESS Expandable Speaker Selector Switch

2008-06-29T15:45:03Z

Bulek:

{| align="right"
| __TOC__
|}

[[Category: Hardware]]
[[Category: Audio]]
[[Category:Tutorials]]

In editing phase !!! - working copy !!!

[[Image:Ess2468.gif]]

More info about [http://hacs.com/essall.php device ] :

This is nice multizone expandable speaker selector swithc, that can be IR or RS232 controlled. Each zone can also have separate control for 11 volume levels. Although recently it's price went significantly up, I still think it's quite usable (I'm yet about to try it in real life). I'll use it for connecting several speakers pairs to Multiroom secondary stereo amplified output on my Marantz SR5600. In this way I'll get nice configurable family home audio system with two audio channels distributed around house and fully controlled by LMCE (I produce second channel also on LMCE Hybrid, by using squeezeslave and another USB sound card)...

Device includes "base" module, to whom you simply attach different modules (they differ on volume control features) for each zone up to 31. Each zone is simply numbered, zone 0 is special zone - sending commands to that zone will have effect on all zones at once.

There is simple RS232 protocol for this device, described [http://hacs.com/ess_commands.php?PHPSESSID=5849f9d4952a3863fd68a4d2a507123c here] It's pretty simple and ASCII based..

The whole idea of implementation is to have each zone represented by "Zone" child devices (template #1867), adding as much as you have them in your device. By default zone "0" will be represented by device it self - so sending commands to parent device will have effect on all zones. Sending commands only to Zone child devices, will have effect only in target zone. At the start, 1 child zone is added to parent device - I assume there will be at least one zone in system. Then you add more zones to suit your system.

== Description of needed templates ==

I hope that this template will be available with stock LMCE distribution, so you won't have to create that template from scratch. Template is called "ESS Speaker Selector RS232" and was created from scratch but inspired by my work on "SR Marantz Multiroom RS232" template described on wiki.

For template to be functional I've made certain extensions to existing template for "Zone" that I hope will be usefull also to others. Extensions are described here [Marantz_SR5600]

=== Important device data and parameters for "ESS Speaker Selector RS232" template ===
Description : ESS Speaker Selector RS232
Implements DCE : yes
Command line : Generic_Serial_Device
Device Category AV/preamps/... #103
Manufacturer HACS - Home Automation Control Systems

Also have added following parameters :

Device data
Current Data Comments Default Value
#37 COM Port on PC /dev/ttyS0
#76 COM Port ParityBit/Stop N81
#78 COM Port BaudRate B9600
#220 Process Child Commands In Pare 1 (needed to have ability to send all commands to parent)
#157 Discrete Volume(bool) 1

Settings are factory defaults and should't be changed (9600 baud rate, 8 bits, 1 stop bit)...

=== 'Edit Ruby code' (on template page) ===
==== 'Determining proper set of inputs' ====

Device has two inputs for amplified stereo signals (A,B). Then each zone or all together can be switched on/off and set to input A or B. Zone modules can have no volume control, manual control or 11-level volume control controlled from RS232 interface. Each zone has two inputs for amplified signalI've added all inputs that are present on device. There is also a special input called "FM" where I connected Live TV embedded device to be able to control tuner functions (tuning/searching up/down, go to preset stations, etc...)

==== 'Set proper set of commands' ====

Basically I've added command groups :
Ruby Internal Commands
Simple IO commands (on,off)
Volume Commands (vol+,vol-,set volume)
Inputs (A,B)

==== 'Add Ruby snippets to commands'====

I've created new IR/Codeset group called "ESS Speaker Selector RS232", although I'm not sure how to handle it. Have also edited corresponding Ruby snippets for each command. Basically those are just simple strings that get sent on rs232 (they differ mainly on target zone) to take proper action on device according to received command from LinuxMCE...

More important parts with more Ruby code :

<pre><nowiki>
Power
#193 Off
SendZoneCommand(cmd)

#192 On
SendZoneCommand(cmd)

Inputs
#953 A
SendZoneCommand(cmd)

#954 B
SendZoneCommand(cmd)

Internal
#373 Private Method Listing
###########################################################3 Internal Methods
# To do list :
# - ???
#
#
# RS232 protocol, ZN=Zone Number (00 is all, 01-31 separate zones)
# ZN 01 ON
# ZN 02 OFF
# ZN 03 A AMP
# ZN 04 B AMP
# ZN 07 VOLUME UP
# ZN 08 VOLUME DOWN
# ZN 09 SET LEVEL 0
# ZN 10 SET LEVEL 1
# ZN 11 SET LEVEL 2
# ZN 12 SET LEVEL 3
# ZN 13 SET LEVEL 4
# ZN 14 SET LEVEL 5
# ZN 15 SET LEVEL 6
# ZN 16 SET LEVEL 7
# ZN 17 SET LEVEL 8
# ZN 18 SET LEVEL 9
# ZN 19 SET LEVEL 10
# ZN 20 SET LEVEL 11
# ZN 32 ? STATUS
# ZN 33 ? LEVEL
# ZN 34 ? ON/OFF
# ZN 35 ? A/B

def log(line)
$log = File.open("/var/log/pluto/" + device_.devid_.to_s + "_Generic_Serial_Device.log", "a")
# $log = File.open("/var/log/pluto/ESS.log", "a")
logTime = Time.now
timeStr = logTime.strftime("%d-%m-%Y %H:%M:%S ")

$log.puts timeStr + "(***):" + line.to_s
$log.close
end

def Send_RS232_Command(command)
log("Send_RS232_Command: [" + command+ "]\n")
# conn_.Send("[" + command+ "]")
end

def SendZoneCommand(cmd)

log("Got Command with ID: " + cmd.id_.to_s + " from: " + cmd.devidfrom_.to_s + " to: " + cmd.devidto_.to_s + "\n")
zone = GetZone(cmd.devidto_)
if( zone >= 0 )
zone_desc=device_.childdevices_[cmd.devidto_].devdata_[186]
log("SendZoneCommand: Child Zone " + zone_desc + "[" + zone.to_s + "]\n")
elsif (cmd.devidto_ == device_.devid_)
log("SendZoneCommand: All Zones " + zone.to_s + ". Sending command to all zones !!!")
zone=0
zone_desc="All Zones"
else
log("SendZoneCommand: Invalid zone " + zone.to_s + ". Send commands only to valid devices!!!")
end

serial_command = ""

case cmd.id_
when 192 #192 is ON
serial_command = sprintf("%02d",zone)+sprintf("%02d",1);
Send_RS232_Command(serial_command);
temp_cmd = Command.new(cmd.id_, -1001, 1, 2, 48);
temp_cmd.params_[10] = "1";
SendCommand(temp_cmd);
$ZoneStatus[zone.to_s] = "ON";
if (zone==0)
SetZones("ON")
end
when 193 #193 is OFF
serial_command = sprintf("%02d",zone)+sprintf("%02d",2);
Send_RS232_Command(serial_command);
temp_cmd = Command.new(cmd.id_, -1001, 1, 2, 48);
temp_cmd.params_[10] = "0";
SendCommand(temp_cmd);
$ZoneStatus[zone.to_s] = "OFF";
if (zone==0)
SetZones("OFF")
end

when 90 #90 is Volume Down
serial_command = sprintf("%02d",zone)+sprintf("%02d",8);
Send_RS232_Command(serial_command);
$ZoneVolumes[zone.to_s] = $ZoneVolumes[zone.to_s] - 10
if ($ZoneVolumes[zone.to_s]<0)
$ZoneVolumes[zone.to_s]=0
end
SetDeviceDataInDB( cmd.devidto_, 158, ($ZoneVolumes[zone.to_s]).to_s ) # 158 = DEVICEDATA_Volume_Level_CONST
temp_cmd = Command.new(cmd.devidto_, -1001, 1, 2, 71);
temp_cmd.params_[30] = ($ZoneVolumes[zone.to_s]).to_s
SendCommand(temp_cmd);

when 89 #90 is Volume Up
serial_command = sprintf("%02d",zone)+sprintf("%02d",7);
Send_RS232_Command(serial_command);
$ZoneVolumes[zone.to_s] = $ZoneVolumes[zone.to_s] + 10
if ($ZoneVolumes[zone.to_s]>=120)
$ZoneVolumes[zone.to_s]=110
end
SetDeviceDataInDB( cmd.devidto_, 158, ($ZoneVolumes[zone.to_s]).to_s ) # 158 = DEVICEDATA_Volume_Level_CONST
temp_cmd = Command.new(cmd.devidto_, -1001, 1, 2, 71);
temp_cmd.params_[30] = ($ZoneVolumes[zone.to_s]).to_s
SendCommand(temp_cmd);
when 313 #313 is Set Volume with Level as Param #76
log("313:Set Volume Command: Got Cmd with ID: " + cmd.id_.to_s + " from: " + cmd.devidfrom_.to_s + " to: " + cmd.devidto_.to_s + " | Zone : " + zone.to_s + "\n")
level=(cmd.params_[76]).to_i
if level >110
level=110
log("313:Set Volume Command: Volume too high - truncated to max level of 110\n")
elsif level <0
level=0
log("313:Set Volume Command: Volume too low - truncated to min level of 0\n")
end
level = (level/10.0).round
serial_command = sprintf("%02d",zone)+sprintf("%02d",level+9);
Send_RS232_Command(serial_command);
$ZoneVolumes[zone.to_s] = (cmd.params_[76]).to_i
SetDeviceDataInDB( cmd.devidto_, 158, ($ZoneVolumes[zone.to_s]).to_s ) # 158 = DEVICEDATA_Volume_Level_CONST
temp_cmd = Command.new(cmd.devidto_, -1001, 1, 2, 71);
temp_cmd.params_[30] = ($ZoneVolumes[zone.to_s]).to_s
SendCommand(temp_cmd);
if (zone==0)
SetVolumes($ZoneVolumes[zone.to_s])
end

when 616 #616 is Select A
serial_command = sprintf("%02d",zone)+sprintf("%02d",3);
Send_RS232_Command(serial_command);
when 617 #617 is Select B
serial_command = sprintf("%02d",zone)+sprintf("%02d",4);
Send_RS232_Command(serial_command);
else
log("Yet not implemented: Handler for command: ID " + cmd.id.to_s)
end

end

def GetZone(deviceDestination)
if( device_.mapDevice_PortChannel_.has_key?(deviceDestination) and
device_.mapDevice_PortChannel_[deviceDestination] != nil and
!device_.mapDevice_PortChannel_[deviceDestination].empty? )
return device_.mapDevice_PortChannel_[deviceDestination].to_i
end

return -1
end

def ReceiveReport()
@buff = conn_.RecvDelimited("]", 1000)
log("Response from ESS: " + @buff + "\n")
# log("Calling DecodeReceivedInfo: " + @buff + "\n")
# temp_resp=@buff;
# DecodeReceivedInfo(temp_resp)
# log("End of DecodeReceivedInfo: " + temp_resp + "\n")
end

def SetVolumeInZone(level,zone)
# Sets Normalized Volume Level (0..100) in certain zone
normlevel = (level.to_i/10.0).round
log("SetVolumeInZone: volume: " + level.to_s + " ["+ normlevel.to_s + "] => Zone: " + zone + "\n")

serial_command = sprintf("%02d",zone)+sprintf("%02d",normlevel+9);
Send_RS232_Command(serial_command);
# log("313:Set Volume Command: Got Cmd with ID: " + cmd.id_.to_s + " from: " + cmd.devidfrom_.to_s + " to: " + cmd.devidto_.to_s + " | Zone : " + zone.to_s + "\n")
$ZoneVolumes[zone.to_s] = level.to_i

end

def SetZonesInitialVolumes()
log("####### Set Initial Volume Levels for zones\n")
device_.mapDevice_PortChannel_.each do |key, value|
volume = device_.childdevices_[key].devdata_[208]
log("Zone " + value.to_s + " => " + volume.to_s + "\n")
SetVolumeInZone(volume.to_i,value)
SetDeviceDataInDB( device_.childdevices_[key].devid_, 158, ($ZoneVolumes[value.to_s]).to_s ) # 158 = DEVICEDATA_Volume_Level_CONST
end

end

def SetZones(state)
log("####### Setting all zones to " + state + "\n")
device_.mapDevice_PortChannel_.each do |key, value|
$ZoneStatus[value] = state
log("Zone " + value.to_s + " => " + state + "\n")
end
end

def SetVolumes(level_int)
log("####### Set Volume Levels for all zones\n")
device_.mapDevice_PortChannel_.each do |key, value|
log("Zone " + value.to_s + " => " + level_int.to_s + "\n")
$ZoneVolumes[value.to_s] = level_int
SetDeviceDataInDB( device_.childdevices_[key].devid_, 158, ($ZoneVolumes[value.to_s]).to_s ) # 158 = DEVICEDATA_Volume_Level_CONST
end
end

#351 Process IDLE

#350 Process Incoming Data
ReceiveReport()

#355 Process Initialize

log("Initializing ESS GSD Device\n")

Send_RS232_Command("0002"); #All Zones OFF

Send_RS232_Command("0020"); #All Zones Max Volume

Send_RS232_Command("0003"); #All Zones Select A

$ZoneVolumes = Hash.new()
$ZoneStatus = Hash.new()

SetZones("OFF")
SetZonesInitialVolumes()

log("Initialization of ESS GSD Device finished !!!!\n")

#384 Process Receive Command For Child
SendZoneCommand(cmd)

#356 Process Release
Send_RS232_Command("0002"); #All Zones OFF

Send_RS232_Command("0020"); #All Zones Max Volume

Send_RS232_Command("0003"); #All Zones Select A

log("Shutting Down ESS GSD Device finished !!!!\n")

Misc
#616 Select A

#617 Select B

Sound & Volume
#97 Mute

#313 Set Volume
SendZoneCommand(cmd)

#90 Vol Down

#89 Vol Up

</nowiki></pre>