LinuxMCE - User contributions [en]

Onkyo TXSR805

2010-06-07T22:48:18Z

Newacct:

[[category: Audio]]
{{versioninfo}}
{{stub}}
[[category: Tutorials]]
== Using the Onkyo TX-SR805 with RS232 Control ==

'''THIS CODE IS STILL BEING DEVELOPED'''

Future home of the howto for setting up a Onkyo TX-SR805 with RS232 support.
 
May widen howto to all Onkyo RS232 Receivers.
 

This device does currently work with limited functionality. A writeup for how to add this device to a Linux MCE system will be done soon. 
 
** If you use this device and have any problems or suggestions to the code here, please switch over to the discussion tab and bring it to my attention ** 

----
 
Current features supported: 
-On/Off 
-Change inputs 
-Volume control (Up/Down in set increments. cmd_313 Set Volume still needs work) 
 
Being worked on: 
-Precise Volume Control (cmd_313) 
-Listening Modes 
-Zone 2/3 
-FM Tuner 
 
----
'''Ruby Code:'''

Section: 193 Off 
<$"!1PWR00\r"$>

Section: 192 On 
<$"!1PWR01\r"$>
sleep(2)
<$"!AMT00\r"$>
@mute = false

Section: 169 AM 
<$"!1SLI25\r"$>

Section: 164 Aux 
<$"!1SLI03\r"$>

Section: 172 Aux 2 
<$"!1SLI04\r"$>

Section: 162 CD 
<$"!1SLI23\r"$>

Section: 165 DVD 
<$"!1SLI10\r"$>

Section: 170 FM 
<$"!1SLI24\r"$>

Section: 163 Phono 
<$"!1SLI22\r"$>

Section: 160 Tape / Tape 1 
<$"!1SLI20\r"$>

Section: 173 Tape 2 
<$"!1SLI21\r"$>

Section: 166 Tuner 
<$"!1SLI26\r"$>

Section: 909 XM 
<$"!1SLI31\r"$>

Section: 373 Private Method Listing 
# Written by Jason Bennett
#
# Process 373 - Methods
def receiveMsg
buff = conn_.Recv(7, 1000)
log("Message Received: #{buff}")
trash = conn_.Recv(1, 100)
if buff.length() < 7
parsed1 = "ERR"
parsed2 = "00"
else
parsed2 = buff[5..6]
parsed1 = buff[2..4]
return [parsed1, parsed2]
end
end
#-------------------------------------------- Parsing -----------------------------------------------------------------------------------
def chkMsg(cat, opt)
case cat
# Power
when "PWR"
cmd = Command.new(device_.devid_, -1001, 1, 2, 48) # 48 = Power State
case opt
when "01"
cmd.params_[10] = "1" # Command 48, Param 10: 1 = On
when "00"
cmd.params_[10] = "0" # Command 48, Param 10: 2 = Off
end
SendCommand(cmd)
# Master Volume Level
when "MVL"
cmd = Command.new(device_.devid_, -1001, 1, 2, 71) # 71 = Volume
cmd.params_[30] = opt.hex.to_s # Command 71, Param 16 = Volume Level in Decimal
log("volume reported as: #{opt.hex}")
SendCommand(cmd)
# Input Selection
when "SLI"
cmd = Command.new(device_.devid_, -1001, 1, 2, 49) # 49 = Input Selection
case opt
when "00"
input_param = 316
when "01"
input_param = 317
when "02"
input_param = 318
when "03"
input_param = 164
when "04"
input_param = 172
when "10"
input_param = 165
when "20"
input_param = 160
when "22"
input_param = 163
when "23"
input_param = 162
when "24"
input_param = 170
when "25"
input_param = 169
when "26"
input_param = 166
when "31"
input_param = 909
end
cmd.params_[41] = input_param.to_s # Command 49, Param 41 = Input
SendCommand(cmd)
end
end
#-------------------------------------------- Logging -----------------------------------------------------------------------------------
def log(line)
$log = File.open("/var/log/pluto/#{device_.devid_}_Generic_Serial_Device.log", "a")
$log.puts "(***):#{line}"
$log.close
end

Section: 350 Process Incoming Data 
# Written by Jason Bennett
#
# Process 350 - Incoming
incMsg = receiveMsg()
log("New Msg: #{incMsg[0]}:#{incMsg[1]}")
chkMsg(incMsg[0], incMsg[1])

Section: 355 Process Initialize 
#31-May-06 14:13 init Onkyo Receiver
initok=false
for iRetry in 0...4
print "Initializing unit\n"
conn_.Send("!1PWRQSTN\r")
buf = conn_.Recv(200, 1000)
if !buf.nil? && buf.include?("PWR0")
print "Initialized ok\n"
initok=true
break
else
print "Didn't respond to command\n"
end
end
if initok==false
DisableDevice( device_.devid_, true )
print "The device wouldn't respond. Disabling it.\n"
return
end
print "Initialized ok, doing log\n"

Section: 97 Mute 
if(@mute)
<$"!1AMT00\r"$>
else
<$"!1AMT01\r"$>
end
@mute=!@mute

Section: 313 Set Volume 
slevel = "%x" % level.to_i
<$"!1MVL" + slevel + "\r"$>
SetDeviceDataInDB( device_.devid_, 158, level ) # 158 = DEVICEDATA_Volume_Level_CONST
print "volume and corresponding device data set\n"

Section: 90 Vol Down 
<$"!1MVLDOWN\r"$>

Section: 89 Vol Up 
<$"!1MVLUP\r"$>

Insteon PLM Ruby Code 373

2010-05-16T00:27:08Z

Newacct:

{{Versioninfo}}
[[category: Insteon]]
<pre>#### Written by Dan Damron
#### #373 Private Method Listing ####

def mainStart() ## This is called FIRST, reruns cannot call this.
#Register Message Interceptor
@interceptor = Command.new(device_.devid_, -1000, 1, 5, 37)
@interceptor.params_[2] = device_.devid_.to_s
SendCommand(@interceptor)
#Get the PLM Database
sendGetLink
#get Child devices
log('Finding Children..')
device_.childdevices_.each{|c| $children[device_.childdevices_[c.to_s.to_i].devdata_[12].chomp.strip] = c.to_s.to_i}
$children.each{|c,v| log(c + ' = ' + v.to_s)
}
log('reading stored Child configuration:')

$children.each_key{|c|
#Get each Childs configuration
$state[c] = 0
getdeviceconfig(c) #

#the above getdeviceconfig packs $configparams array
log('Configuration for ' + c + ' = ' + $configparams.inspect.to_s)
}

log('********************************************************')
#get childs actual configuation and status
$children.each_key{|c| sendGetChildStatus(c)}
SndIns()

end
def mainRestart()
#We have hashes already set up.
$childdatabases.each_key{|@insteonID|
$state[@insteonID] = 0
sendGetChildStatus(@insteonID)}
SndIns()
end

def setdeviceconfig(insteonid, configurestring)
@deviceid = $children[insteonid]
@cmdfrom = device_.devid_
@cmdto = 4 #general info plugin
@priority = 1
@type=1 #command
@cmdid = 246

#set up command..
@cmd = Command.new(@cmdfrom, @cmdto, @priority, @type, @cmdid)
@cmd.params_[2] = @deviceid.to_s
@cmd.params_[52] = '59' # Configuration
@cmd.params_[5] = configurestring
SendCommand(@cmd)
#log('SetDeviceConfig:' + configurestring)
#log('Configuration Saved - will be available on next reload')
end

def getdeviceconfig(insteonid)
@deviceid = $children[insteonid]
@configstring = ''
begin
@configstring = device_.childdevices_[@deviceid].devdata_[59].to_s
rescue
log('Device ID = ' + @deviceid.to_s)
log($red + 'Error - Child has no configuration'+ $grey)
log('Setting initial value of "****************"')
setdeviceconfig(insteonid, ('*' * 16))
@configstring = '*' * 16
sendPing(insteonid)
end
if @configstring == ''
$configparams = ['****************']
log('CAUGHT BLANK RECORD')
setdeviceconfig(insteonid, ('*' * 16))
sendPing(insteonid)
else
$configparams = @configstring.unpack('a16' * (@configstring.length / 16))
$devicetemplate[insteonid] = getdevicetemplate($configparams[0][0..1], $configparams[0][2..3])
end
#log($yellow + 'getdeviceconfig:' + $configparams.inspect + $grey)
#add the configuration parameters to the child database
$childdatabases[insteonid] = $configparams
#get the device type

end

def sendGetLink()
#lets just see exactly what is in the PLM database
param = {'Command' => 'GetLnk'}
$cmdqueue << param
SndIns()
end

def sendGetNext()
param = {'Command' => 'GetNext'}
if $wAIT
$cmdqueue.insert(1, param)
else
$cmdqueue.insert(0,param)
end
SndIns()
end

def sendRemoteGetLink(insteonID)
# Read First ALDB Record
# a few variables need to be set up here..
$recordof = insteonID # save the insteon ID
insID = insteonID.chomp.split('.') # get the seperate bytes
$remoteDBOffsetMSB = 0x0F # initial offset
$remoteDBOffsetLSB = 0xF8 # initial LSB offset
param = {'Command' => 'SndIns',
'Parameter1' => insID[0], #HB
'Parameter2' => insID[1], #MB
'Parameter3' => insID[2], #LB
'Parameter4' => '0F', #Flags
'Parameter5' => '28', #Cmd1
'Parameter6' => "%X" %$remoteDBOffsetMSB #Cmd2 Set MSB Offset
}
$cmdqueue << param
# repeat last param for each byte to read (F8..FF)=first record

for x in 0..7
param = {'Command' => 'SndIns',
'Parameter1' => insID[0], #HB
'Parameter2' => insID[1], #MB
'Parameter3' => insID[2], #LB
'Parameter4' => '0F', #Flags
'Parameter5' => '2B', #Cmd1 Peek
'Parameter6' => "%X" %($remoteDBOffsetLSB + x) #Cmd2
}

$cmdqueue << param
end

end

def sendRemoteGetNext(insteonID)
insID = insteonID.chomp.split('.') # get the seperate bytes
### Do NOT forget to check to see if we need to decrease the MSB

if $remoteDBOffsetLSB == 0x00
#OffsetMSB needs to be decreased, and LSB needs reset.
$remoteDBOffsetMSB = $remoteDBOffsetMSB - 1
$remoteDBOffsetLSN = 0xFF # the next line will decrease this by 8
end
# decrease DBOffsetLSB by 0x08
$remoteDBOffsetLSB = $remoteDBOffsetLSB - 0x08

for x in 0..7
param = {'Command' => 'SndIns',
'Parameter1' => insID[0], #HB
'Parameter2' => insID[1], #MB
'Parameter3' => insID[2], #LB
'Parameter4' => '0F', #Flags
'Parameter5' => '2B', #Cmd1 Peek
'Parameter6' => "%X" %($remoteDBOffsetLSB + x) #Cmd2
}
#log('sendRemoteGetNet:added to queue:' + param.inspect)
if $wAIT
$cmdqueue.insert(x + 1, param)
else
$cmdqueue.insert(x,param)
end

end
end

### Main command parsing routine is EZToDCE
def EZToDCE(param)
#param contains a hash of EZBridge command structure
#log($blue + 'Queue:' + $cmdqueue[0].inspect + $grey)
#log($blue + 'Param:' + param.inspect + $grey)
#log($blue + 'currentcmd:' + $currentcmd.to_s + $grey)
#checkWait(param)
case param['Response']
# Standard RESPONSES (to commands)
when 'GetRevision' # Special Response
log('-----|---------GetRevision:' + param['Parameter1'])

when 'GetLatLong' # Special Response
log('-----|---------GetLatLong: Lat=' + param['Lat'] + ', Long=' + param['Long'])

when 'SetLatLong'
if param['Parameter1'] == 'True' then
log('-----|---------SetLatLong: Ok')
else
log('-----X---------SetLatLong: FAILED!')
end
when 'SetPasswd'

when 'SetTimeZone'

when 'GetClock' # Special Response

when 'SetClock'

when 'SetNTPServer'

when 'Upgrade'

when 'NetCfg'

when 'Reset'
#Reset Response

cmdComplete
SndIns()
when 'LstTimers' # Special Response

when 'ClrTimers'

when 'AddTimer'

when 'GetTimer' # Special Response

when 'SetTimer'

when 'DelTimer'

when 'GetVersion' # Special Response

when 'SndGrp'

when 'SndIns' # response from SndIns
### BUG FOUND ### When the EZBridge receives a command from an EXTERNAL source
### ie not from this device, cmdqueue will be nil, and the code below
### fails. Have to check against that.
if not $cmdqueue.empty?
#First, check the response to make sure the command made it ok.
if param['Parameter9'].to_i == 6 #Ack received
#log('Sending to ProcessACK')
processACK(param)
else # NACK received - command failed.
log('Command NACKED')
end
else
#Response received for another device.
log('Response detected for a command that was not sent by me')
end
when 'SndX10'
log('Response detected for SndX10')
if param['Parameter5'].to_i == 6 #ack
log('X10 Command Successfull')

cmdComplete
SndIns()
else
log('X10 Command FAILED')
cmdComplete
SndIns()

end
when 'StLnk'

when 'CancelLnk'

when 'SetDev'

when 'RstPLM'
#Reset Response
$timeout = 1
cmdComplete
SndIns()

when 'GetLnk'
if param['Parameter3'].to_i == 6 #ack
log('GetLnk ACKED')
#if we get this, we should get a AllLink Record Response next
else
log('GetLnk NACKED')
# The PLM is BLANK
#have to add records to the PLM here.
cmdComplete
### FINISHED WITH GetLnk
checkChildRecordsinPLM()
SndIns()
end
when 'GetNext'
if param['Parameter3'].to_i == 6 #ack
log('sendGetNext ACKED')
#if we get this, we should get a AllLink Record Response next
else
log('sendGetNext NACKED')
#we get this when there are no more records
cmdComplete
#FINISHED with GetNext
# if we are here, we are in config mode
# so, next is to check to make sure the
# childrens insteon ID is in the PLM
checkChildRecordsinPLM()
# now, to make sure that all the records in the PLM are sensed as children

SndIns()
end

when 'SetCfg' # response from Setcfg command
if param['Parameter4'].to_i == 6 #ack
log('SetCfg Completed')
cmdComplete
SndIns()
else
log('SetCfg NACKED')
end
when 'GetLnkData'

when 'LEDON'

when 'LEDOFF'

when 'MngLnk'
if param['Parameter12'].to_i == 6
log('MngLnk => ACK')
else
log('MngLnk => NACK')
end
cmdComplete
SndIns()

when 'GetCfg' # Special Response

when 'LstMacros' # Special Response

when 'ClrMacros'

when 'AddMacro'

when 'GetMacro' # Special Response

when 'SetMacro'

when 'DelMacro'

when 'LstDevices' # Special Response

when 'ClrDevices'

when 'AddDevice'

when 'GetDevice' # Special Response

when 'SetDevice'

when 'DelDevice'

when 'LstZones'

when 'ClrZones'

when 'AddZone'

when 'GetZone'

when 'SetZone'

when 'DelZone'

when 'AddDevZone'

when 'DelDevZone'

# Response Messages
when 'InsExtMsg'

when 'InsStdMsg'
case $currentcmd # if this msg is part of a response, the Insteon Cmd1 will be saved here.
when 0x0
#log('REROUTING to processExternalCommand(param)')
processExternalCommand(param)
when 0x1 #Assign to Group
### This is a broadcast message sent
# from a PING command
# or from a StartLink...
log('Caught Assign to Group Message from Device')
### BUG HERE
#have to check flags to see if this is a broadcast message
log('Checking if this is a broadcast message')
log('Flags:' + param['Parameter9'])
if (param['Parameter9'].hex & 0x80) == 0x80
log('Message IS BROADCAST')
#recvComplete
processDeviceInfo(param)

# check to see if current cmd is for this broadcast..
log('Current Command:' + $cmdqueue[0]['Parameter5'])
if $cmdqueue[0]['Parameter5'] == '10'
#log('Clearing PING Command')
$currentcmd = 0
cmdComplete
SndIns()
else
log('CURRENT CMD IS NOT PING - NOT CLEARING')
end

else
log('Message is NOT Broadcast')
end
when 0x2 #Delete from Group
when 0x10 # PING
#this is where I catch the InsStdMsg for ping.
log('Caught PING Message from Device')
$currentcmd = 1

when 0x11 # ON
log('Caught Insteon ON from INTERNAL source')
insHb = param['Parameter3'] # From
insMb = param['Parameter4']
insLb = param['Parameter5']

insID = insHb + "." + insMb + "." + insLb
myDevFrom = $children[insID]
log('Current DIM level:' + param['Parameter11'])

reportStatus(myDevFrom, hextopercent(param['Parameter11']))

$currentcmd = 0
cmdComplete

SndIns()
when 0x13 # OFF
insHb = param['Parameter3'] # From
insMb = param['Parameter4']
insLb = param['Parameter5']
insID = insHb + "." + insMb + "." + insLb
myDevFrom = $children[insID]
reportStatus(myDevFrom, 0)

$currentcmd = 0
cmdComplete
#log('EVENT and state SENT!!!.48:[10]=0')
SndIns()
when 0x19 # Status Report
# now to clear the currentcmd and remove command from the queue
$currentcmd = 0
cmdComplete

log('Processing 0x19 Status Report')
#This is where I get the database delta (in cmd1)
insHb = param['Parameter3'] # From
insMb = param['Parameter4']
insLb = param['Parameter5']
insID = insHb + "." + insMb + "." + insLb
#First, to compare the DB Delta with current config.
#Database Delta...
delta = param['Parameter10'].to_s
log($blue + 'Database Delta=' + delta + $grey)
log($blue + 'Configuration is:' + getdeltafromconfig(insID) + $grey)
if delta == getdeltafromconfig(insID)
if $children[insID] != nil
myDevFrom = $children[insID]
myDevTo = -1000 #DCE Router
myPriority = 1
myType = 2 #Event

#Send an EVENT to report STATE ONLY if database has not changed
# AND child exists in pluto
reportStatus(myDevFrom, hextopercent(param['Parameter11']))
end
else
log('Databse CHANGED -getting remote database')
#here, I have to WIPE the databse
# to prepare it for new data
### here is where the DAMN CONFIG was reset!!!
oldconfigstring = $childdatabases[insID][0]
$childdatabases[insID] = [oldconfigstring]
log('Setting Database Config')
$childdatabases[insID][0][6..7] = delta
savechilddatabases(insID)
sendRemoteGetLink(insID)
end
# finally, to check execute next command...
SndIns()
when 0x28 # Set Address MSB
log('Received SET Address MSB from remote device')
$currentcmd = 0
$remoteLinkRecord = ''
cmdComplete
SndIns()
when 0x2B # peek
### BUG HERE... have to verify response is a PEEK command
#response command is stored in parameter10
if param['Parameter10'].hex == 0x2B # this is the peek command
cmdComplete
log('Received PEEK from remote Device! DATA=' + param['Parameter11'])
checkPeekData(param)
$currentcmd = 0
SndIns()
else
log('Waiting for remote PEEK response, but got :' + param['Parameter10'])
end
else
end

when 'X10Msg'
log($purple + 'X10 Message Received' + $grey)
if param['Parameter4'].hex == 0x00
log('This byte is a House/Unit Code')
hn = param['Parameter3'][0].chr
ln = param['Parameter3'][1].chr
$x10byte1 = $X10HouseCodes[hn]
$x10byte1 += $X10UnitCodes[ln]
log('Translated X10 House/Unit Code:' + $x10byte1)
else
log('This byte is a House/Command Code')
hn = param['Parameter3'][0].chr
ln = param['Parameter3'][1].chr
$x10byte2 = $X10HouseCodes[hn]
$x10byte2 += $X10CommandCodes[ln]
log('Translated X10 Command Code:' + $x10byte2)
log('X10 Command ready to send:' + $x10byte1 + ' ' + $x10byte2)
case $X10CommandCodes[ln]
when 'On'
#Send ON to lmnce
if $children[$x10byte1] == nil
log('I do not control this X10 device')
else
cmd = Command.new($children[$x10byte1].to_i, -1000, 1, 1, 192)
cmd.params_[120] = "1"
SendCommand(cmd)
end
when 'Off'
#Send OFF to lmnce
if $children[$x10byte1] == nil
log('I do not control this X10 device')
else
cmd = Command.new($children[$x10byte1].to_i, -1000, 1, 1, 193)
cmd.params_[120] = "1"
SendCommand(cmd)
end
when 'Bright'
if $children[$x10byte1] == nil
log('I do not control this X10 device')
else
#send a command to set the state + 1
@curstate = ($state[$x10byte1] / 100) * 32 #get equal 32 steps
$state[$x10byte1] = ((@curstate + 1) / 32) * 100
cmd = Command.new($children[$x10byte1].to_i, -1000, 1, 1, 184)
cmd.params_[76] = $state[$x10byte1].to_s
cmd.params_[120] = "1"
SendCommand(cmd)
#$state[$x10byte1] = ($state[$x10byte1] / 100) * 32
end
when 'Dim'
@curstate = ($state[$x10byte1] / 100) * 32 #get equal 32 steps
$state[$x10byte1] = ((@curstate - 1) / 32) * 100
cmd = Command.new($children[$x10byte1].to_i, -1000, 1, 1, 184)
cmd.params_[76] = $state[$x10byte1].to_s
cmd.params_[120] = "1"
SendCommand(cmd)
when 'All Lights Off'
log('ALL Lights OFF Command not implemented')
when 'All Lights On'
log('All Lights ON Command not implemented')
when 'Status Request'
log('Status Request Command not implemented')
when 'Hail Ack'
log('Hail Ack Command not implemented')
end

end
when 'InsLnkSts'
log('InsLnkSts Received')

when 'BtnRpt'
log('Button Report Received')
when 'UsrRst'
log('User Reset Response Received')
when 'GrpEvntRpt'
log('Group Event Report Received')

when 'LnkData'
processLnkData(param)
# Other messages
when 'PLMTimeout'
log('PLM Timeout detected.. resetting EZBridge')
resetcmd = {'Command' => 'Reset'}
if $wAIT == true
$cmdqueue.insert(1, resetcmd)
else
$cmdqueue.insert(0,resetcmd)
end
sleep 15
$wAIT = false
SndIns()
when 'PLMEchoError' # Have not seen this since a1.23
# error sending command to PLM, reset command and try again
log('-----XXXXXXX' + param['Response'])
resetcmd = {'Command' => 'Reset'}
if $wAIT == true
$cmdqueue.insert(1, resetcmd)
else
$cmdqueue.insert(0,resetcmd)
end

sleep 15
$wAIT = false
SndIns()
when 'LongAck'
log('-----XXXXXXX' + param['Response'])
# Error - seems to show up after PLMEchoError
resetcmd = {'Command' => 'Reset'}
if $wAIT == true
$cmdqueue.insert(1, resetcmd)
else
$cmdqueue.insert(0,resetcmd)
end
sleep 15
$wAIT = false
SndIns()
else
log('-----XXXXXXX UNKNOWN Response Received')
end

end

### Support routine for EZToDCE
def processLnkData(param)
#Caught a LnkData Response
log('LnkData Message Received')
log(param.inspect)
if param['Parameter6'] == '00' and param['Parameter7'] == '00'
log('FOUND X10 DEVICE!!!')
insteonID = padhex(param['Parameter5'])
else
insteonID = padhex(param['Parameter5']) + '.' + padhex(param['Parameter6']) + '.' + padhex(param['Parameter7'])
end
group = param['Parameter4']
recflags = param['Parameter3']
lnkdata1 = param['Parameter8']
lnkdata2 = param['Parameter9']
lnkdata3 = param['Parameter10']
#pack string to store for PLM Database
@currentrecord = recflags + group
@currentrecord += param['Parameter5'] + param['Parameter6'] + param['Parameter7']
@currentrecord += lnkdata1 + lnkdata2 + lnkdata3

#Add to plmdatabase
$plmdatabase << @currentrecord
log('record Flags:' + recflags)
#log('PLM database=' +$plmdatabase.inspect)
if (recflags[0] & 0x80) == 0x80 # Record is in use if true
end
if (recflags[0] & 0x40) == 0x40 # Controller if true
log('Controller')
else
log('Responder')
end

log('Insteon ID:' + insteonID + ', Group:' + group)

cmdComplete
sendGetNext()

end
### Support Routine for EZToDCE
def processExternalCommand(param)
#there is no current command
# THIS IS COMING FROM AN OUTSIDE SOURCE
#EG: Manually turning Light Switch On/Off
# process this command.
# Note, this is a standard message
### have to check here if child is mine!

# This is where I have to check for a broadcast command..
#if so, search the child databases for responders,
#and fire events for each responder.
#Message flag is in parameter9 Group command 0xCx (All-Link Broadcast Message Pg 42.)
#Group is in parameter8
#From InsteonID is parameters 3, 4, 5
if (param['Parameter9'].hex & 0xC0) == 0xC0 # Message is Broadcast
log('Rerouting to processBroadcastMessage')
processBroadcastMessage(param)
else
log('Process External Command:')
log('Param:' + param.inspect)

# there is no ack here. Simply Send COMMANDS back to DCE
# and Complete the recv..
case param['Parameter10'].hex #this is the command
when 0x01 #Assign to Group
log('Caught EXTERNAL Assign to Group')
processDeviceInfo(param)
recvComplete
when 0x02 #Delete from Group
log('Caught EXTERNAL Delete from Group')
recvComplete
when 0x10 # PING
log('Caught EXTERNAL Insteon PING result')
recvComplete

when 0x11 #ON
log('Caught EXTERNAL Insteon ON command result')
#on level is in cmd2
insHb = param['Parameter3'] # From
insMb = param['Parameter4']
insLb = param['Parameter5']
insID = insHb + "." + insMb + "." + insLb
log('From:' +insID)
log('Device:' + $children[insID].to_s)
myDevFrom = $children[insID]
# check to see if I own child
if myDevFrom == nil
log('I do not control this device.')
else
reportStatus(myDevFrom, hextopercent(param['Parameter11']))
$currentcmd = 0
end
recvComplete

when 0x13 #OFF
log('Caught EXTERNAL Insteon OFF result')
#on level is in cmd2
insHb = param['Parameter3'] # From
insMb = param['Parameter4']
insLb = param['Parameter5']
insID = insHb + "." + insMb + "." + insLb
myDevFrom = $children[insID]
if myDevFrom == nil
log('I do not control this device.')
else

reportStatus(myDevFrom, 0)

$currentcmd = 0
#log('EVENT and state SENT!!!.48:[10]=0')
end
recvComplete
when 0x15; log('Caught EXTERNAL Insteon Brighten Result')
when 0x16; log('Caught EXTERNAL Insteon DIM Result')
when 0x24; log('Caught EXTERNAL Insteon DO EE READ')
when 0x28; log('Caught EXTERNAL Insteon SET ADDRESS MSB')
when 0x29; log('Caught EXTERNAL Insteon POKE')
when 0x2A; log('Caught EXTERNAL Insteon POKE EXTENDED')
when 0x2B; log('Caught EXTERNAL Insteon PEEK')
when 0x2C; log('Caught EXTERNAL Insteon PEEK INTERNAL')
when 0x2D; log('Caught EXTERNAL Insteon POKE INTERNAL')
else
log('Unknown EXTERNAL Insteon Command.')
end
end
end
### Support Routine for EZToDCE
def processACK(param)
#log('In ProcessACK: Param7:' + param['Parameter7'])
#log('CurrentCmd=' + $currentcmd.to_s)
case param['Parameter7'].hex #Received an ack to THIS command
when 0x1 #Assign to Group
log('Got Assign to Group ACK')
$currentcmd = 0x01
$cmdqueue[0]['Command'] = 'InsStdMsg'
#processDeviceInfo(param)
#cmdComplete
when 0x2 #Delete from Group
when 0x10 # PING
log('Got PING ACK')
#cmdComplete
$currentcmd = 0x1
$cmdqueue[0]['Command'] = 'InsStdMsg'
when 0x11 #ON
$currentcmd = 0x11
$cmdqueue[0]['Command'] = 'InsStdMsg'
when 0x13 #OFF
$currentcmd = 0x13
$cmdqueue[0]['Command'] = 'InsStdMsg'
when 0x15 #Bright
$currentcmd = 0x15
$cmdqueue[0]['Command'] = 'InsStdMsg'
when 0x16 #DIM
$currentcmd = 0x16
$cmdqueue[0]['Command'] = 'InsStdMsg'
when 0x17 #Start Manual Change
when 0x18 #Stop Manual Change
when 0x19 #Status Request
# Status Request Acked - get ready for InsStdMsg
$currentcmd = 0x19
# change cmd to reflect InsStdMsg
$cmdqueue[0]['Command'] = 'InsStdMsg'
when 0x24
log('Caught ACK for Insteon DO EE READ')
$currentcmd = 0x24
$cmdqueue[0]['Command'] = 'InsStdMsg'
when 0x28
log('Caught ACK for Insteon SET ADDRESS MSB')
$currentcmd = 0x28
$cmdqueue[0]['Command'] = 'InsStdMsg'

when 0x29
log('Caught ACK for Insteon POKE')
$currentcmd = 0x29
$cmdqueue[0]['Command'] = 'InsStdMsg'

when 0x2A
log('Caught ACK for Insteon POKE EXTENDED')
$currentcmd = 0x2A
$cmdqueue[0]['Command'] = 'InsStdMsg'

when 0x2B
#log('Caught ACK for Insteon PEEK')
$currentcmd = 0x2B
$cmdqueue[0]['Command'] = 'InsStdMsg'

when 0x2C
log('Caught ACK for Insteon PEEK INTERNAL')
$currentcmd = 0x2C
$cmdqueue[0]['Command'] = 'InsStdMsg'

when 0x2D
log('Caught ACK for Insteon POKE INTERNAL')
$currentcmd = 0x2D
$cmdqueue[0]['Command'] = 'InsStdMsg'

else
log('Unknown Insteon Cmd1')
end
end

def checkPeekData(param)

$remoteLinkRecord += param['Parameter11'].hex.chr
log('CURRENT REMOTE RECORD IS:')
debug($remoteLinkRecord)
if $remoteLinkRecord.length == 8
log('REMOTE RECORD COMPLETE!')
processRemoteRecord(param)
$remoteLinkRecord = ''
end
end

def processRemoteRecord(param)
#have to find MY address
insHb = param['Parameter3'] # From
insMb = param['Parameter4']
insLb = param['Parameter5']
insID = padhex(insHb) + "." + padhex(insMb) + "." + padhex(insLb)

log('Processing remote Record below:')

@flags = "\nFrom Device:" + insID + "\nFlags:\n"

if ($remoteLinkRecord[0] & 0x02) == 0x02 # High water mark
@flags += "Not the last record\n"
else
@flags += "This IS the last record\n"
end

if ($remoteLinkRecord[0] & 0x80) == 0x80 # Record is in use
@flags += "Record In Use\n"
if ($remoteLinkRecord[0] & 0x40) == 0x40 # Controller/Responder
@flags += "I am a Controller of "
else
@flags += "I am a Responder of "
end
@insteonID = "%02X" %$remoteLinkRecord[2] + '.'
@insteonID += "%02X" %$remoteLinkRecord[3] + '.'
@insteonID += "%02X" %$remoteLinkRecord[4]

@group = "%X" %$remoteLinkRecord[1]
@flags += @insteonID + " Group:" + @group
@work = "%02X" %$remoteLinkRecord[0] #Control byte
@work += "%02X" %$remoteLinkRecord[1] # Group
@work += "%02X" %$remoteLinkRecord[2] # ID HB
@work += "%02X" %$remoteLinkRecord[3] # ID MB
@work += "%02X" %$remoteLinkRecord[4] # ID LB
@work += "%02X" %$remoteLinkRecord[5] # Data1
@work += "%02X" %$remoteLinkRecord[6] # Data2
@work += "%02X" %$remoteLinkRecord[7] # Data3
log('adding to:' + insID)
log('Value:' + @work)
$childdatabases[insID] << @work #add it to the database
# log('Current Database:' + $childdatabases.inspect)
#now to save the database to configuration.
savechilddatabases(insID)
# Now to check to see if the child exists as a record
if $childdatabases[@insteonID] == nil
log('InsteonID is NEW, adding Child database entry')
$childdatabases[@insteonID] = ['****************']
$rerun = true
sendAddtoPLM(@insteonID)
sendPing(@insteonID)
else
log('InsteonID:' + @insteonID.to_s + 'seems to exist in child databases')
log('CDB:' + $childdatabases.inspect)

end
else
@flags += "Record NOT in use\n"
end
log($aqua + @flags + $grey)
log2(@flags)
if ($remoteLinkRecord[0] & 0x02) == 0x02
sendRemoteGetNext(insID)
end
end

def savechilddatabases(insteonID)
#This takes the $childdatabase hash+array and encodes it to
# save it as a string.
@work = ''
#log($yellow + 'SaveChildDatabases::nitems:' + $childdatabases[insteonID].nitems.to_s)
#log($childdatabases[insteonID].inspect + $grey)
$childdatabases[insteonID].each{|record|
@work += record
}

#now to save the string...
setdeviceconfig(insteonID, @work)

end
def sendPing(insteonID)
insID = insteonID.split('.')
param = {'Command' => 'SndIns',
'Parameter1' => insID[0],
'Parameter2' => insID[1],
'Parameter3' => insID[2],
'Parameter4' => '0F',
'Parameter5' => '10', #ID Request
'Parameter6' => '00'}
$cmdqueue << param
log('PING Sent!')
end

def getdevicetemplate(cat, subcat)

log('Entered getdevicetemplate, Cat=' + cat.to_s + ', subcat = ' + subcat.to_s)
@templid = 0
case cat.hex
when 0x0 # Generalized Controllers
case subcat.hex
when 0x04; log('Found ControLinc [2430]')
when 0x05; log('Found RemoteLinc [2440]')
when 0x06; log('Found Icon Tabletop Controller [2830]')
when 0x09; log('Found SignaLinc RF Signal Enhancer [2442]')
when 0x0A; log('Found Balboa Instruments Poolux LCD Controller')
when 0x0B; log('Found Access Point [2443]')
when 0x0C; log('Found IES Color Touchscreen')
end
when 0x01 # Dimmable Lighting Control
# all these devices are associated with Template 38
# Light Switch (dimmable)
@templid = 38
case subcat.hex
when 0x00; log('Found LampLinc V2 [2456D3]')
when 0x01; log('Found SwitchLinc V2 Dimmer 600W [2476D]')
when 0x02; log('Found In-LineLinc Dimmer [2475D]')
when 0x03; log('Found Icon Switch Dimmer [2876D]')
when 0x04; log('Found SwitchLinc V2 Dimmer 1000W [2476DH]')
when 0x06; log('Found LampLinc 2-pin [2456D2]')
when 0x07; log('Found Icon LampLinc V2 2-pin [2456D2]')
when 0x09; log('Found KeypadLinc Dimmer [2486D]')
when 0x0A; log('Found Icon In-Wall Controller [2886D]')
when 0x0D; log('Found SocketLinc [2454D]')
when 0x13; log('Found Icon SwitchLinc Dimmer for Lixar/Bell Canada [2676D-B]')
when 0x17; log('Found ToggleLinc Dimmer [2466D]')
end
when 0x02 # Switched Lighting Control
# all these devices are associated with Template 37
# Light Switch (ON/OFF)
@templid = 37
case subcat.hex

when 0x09; log('Found ApplianceLinc [2456S3]')
when 0x0A; log('Found SwitchLinc Relay [2476S]')
when 0x0B; log('Found Icon On Off Switch [2876S]')
when 0x0C; log('Found Icon Appliance Adapter [2856S3]')
when 0x0D; log('Found ToggleLinc Relay [2466S]')
when 0x0E; log('Found Switchlinc Relay Countdown Timer [2476ST]')
when 0x10; log('Found In-LineLinc Relay [2475D]')
when 0x13; log('Found Icon SwitchLinc Relay for Lixar/Bell Canada [2676R-B]')
end
when 0x03 # Network Bridges
case subcat.hex
when 0x01; log('Found PowerLinc Serial [2414S]')
when 0x02; log('Found PowerLinc USB [2414U]')
when 0x03; log('Found Icon PowerLinc Serial [2814S]')
when 0x04; log('Found Icon PowerLinc USB [2814U]')
when 0x05; log('Found Smartlabs Power Line Modem Serial [2412S]')
end
when 0x04 # Irrigation Control
# all these devices are associated with Template 1780
# Standard Irrigation Sprinkler
@templid = 1780
case subcat.hex

when 0x00; log('Found Simplehomenet EZRain1 Sprinkler Controller')
end
when 0x05 # Climate Control
case subcat.hex
when 0x00; log('Found Broan SMSC080 Exhaust Fan')
when 0x01; log('Found Simplehomenet EZTherm')
when 0x02; log('Found Broan SMSC110 Exhaust Fan')
when 0x03; log('Found Venstar RF Thermostat Module')
when 0x04; log('Found Simplehomenet EZStat Thermostat')
end
when 0x06 # Pool and Spa Control
case subcat.hex
when 0x00; log('Found Simplehomenet EZPool')
end
when 0x07 # Sensors and Actuators
case subcat.hex
when 0x00
end
when 0x08 # Home Entertainment
case subcat.hex
when 0x00
end
when 0x09 # Energy Management
case subcat.hex
when 0x00
end
when 0x0A # Built-In Appliance Control
case subcat.hex
when 0x00
end
when 0x0B # Plumbing
case subcat.hex
when 0x00
end
when 0x0C # Communication
case subcat.hex
when 0x00
end
when 0x0D # Computer Control
case subcat.hex
when 0x00
end
when 0x0E # Window Coverings
case subcat.hex
when 0x00
end
when 0x0F # Access Control
case subcat.hex
when 0x00
end
when 0x10 # Security, Health, and Safety
when 0x11 # Surveillance
when 0x12 # Automotive
when 0x13 # Pet care
when 0x14 # Toys
when 0x15 # Timekeeping
when 0x16 # Holiday
end
return @templid
end

def processDeviceInfo(param)
### temporary
### 12-24-07 Adding Device Template compatibility..
#have to find MY address
insHb = param['Parameter3'] # From
insMb = param['Parameter4']
insLb = param['Parameter5']

insID = padhex(insHb) + "." + padhex(insMb) + "." + padhex(insLb)
#set the devicecat and device subcat in the childdatabases
# 0-1 Device Category
# 2-3 Device SubCategory
# 4-5 Device Firmware
log('proccessDeviceInfo:Insteon ID' + insID)
$childdatabases[insID][0][0..1] = param['Parameter6']
$childdatabases[insID][0][2..3] = param['Parameter7']
$childdatabases[insID][0][4..5] = param['Parameter8']
savechilddatabases(insID)
log('InsteonID: ' + insID)
#log('Child Config AFTER update:' + $childdatabases[insID][0].to_s)
log($yellow)
@template = getdevicetemplate(param['Parameter6'], param['Parameter7'])
$devicetemplate[insID] = @template
log('Template ID:' + @template.to_s)
### eventually, open a XML configuration script?
### or read saved data from mysql?
### most likely save this information to sql with device.
### eventually, IPKDB will be available to ping.
log('for Insteon ID:' + insID)
log($grey)
end

def recvComplete
# Clears the wait flag, but does not remove a command from the queue
$wAIT = false
log($green + "Receive Completed. Checking command queue" + $grey)
if $cmdqueue.nitems > 0 then
log("Queue:" + $aqua + $cmdqueue.nitems.to_s + $grey + " : executing next command")
SndIns()
else
log($yellow + 'Queue Empty.' + $grey)
if $rerun
log('RERUN=TRUE, RESTARTING')
$rerun = false
mainRestart()
else
log('RERUN Not needed. Checking if reported..')
#report Child devices here.
if not $reported
log('Reporting Child Devices')
@work = ""
$childdatabases.each{
|insteonID,value|
log('Child:' + insteonID)
log('Config:' + value.inspect)
@template = $devicetemplate[insteonID]
@work += insteonID + "\t\t\t" + @template.to_s + "\t\n"
}
log(@work)
cmd = Command.new(device_.devid_, -1001, 1, 2, 54)
cmd.params_[13] = @work
SendCommand(cmd)

$reported = true
else
log('report not needed')
end
end

end
end
def removecurrentcommand
#get the current child
log('in RemoveCurrentCommand')
log('Current Command:' + $cmdqueue[0].inspect)
#id is in param123
@id = $cmdqueue[0]['Parameter1']
@id += '.' + $cmdqueue[0]['Parameter2']
@id += '.' + $cmdqueue[0]['Parameter3']
log('ID=' + @id)
#now to remove from child and PLM databases
removefromchild(@id)
removefromplm(@id)
cmdComplete
end
def cmdComplete
# Clears the wait flag, and removes the command from the queue.
$wAIT = false
$resetNext = 0
$cmdqueue.delete_at(0)
# now that THAT command is completed, check to see if there is
# another command ready to transmit.
log($green + "Command Completed." + $grey)
end
def checkWait(param)
#Checks for response from current command.
if $cmdqueue[0] != nil
if $wAIT == true
#log('CW:waiting for command to complete')
else
#log('CW:reports clear')
end
else
log('------:)----checkWait: command queue is emtpy')
if $wAIT == true #this should never happen
log('------:(XXX-CheckWait: TRUE')
end
end
end

def plmparse(value)
#THIS ROUTINE REPLACES parsestring()
#this routine will PARSE the incoming stream into valid messages
# value is the complete command
param = {}
#here is a special case, the PLM seems to lock up.
if value == 0x15.chr
log('The PLM stopped responding')
log('Please unplug it, and plug it back in')
log('and do a quick reload router.')

end
while value.length > 2
case value[1]
when 0x62 # Special case, need to look at flags
if (value[5] & 0x10) == 0x10 # check for extended flag
cmdlen = 23
else
cmdlen = 9
end
param['Response'] = 'SndIns'
when 0x50; cmdlen = 11; param['Response'] = 'InsStdMsg'
when 0x51; cmdlen = 25; param['Response'] = 'InsExtMsg'
when 0x68; cmdlen = 4 #Set Insteon ACK Message Byte
when 0x71; cmdlen = 5 #Set Insteon ACK Message Two Bytes
when 0x70; cmdlen = 4 #Set Insteon NACK Message Byte
when 0x63; cmdlen = 5; param['Response'] = 'SndX10'
when 0x52; cmdlen = 4; param['Response'] = 'X10Msg'
when 0x61; cmdlen = 6; param['Response'] = 'SndGrp'
when 0x56; cmdlen = 7; param['Response'] = 'GrpEvntRpt'
when 0x58; cmdlen = 3 #All-Link Cleanup Status Report
when 0x64; cmdlen = 5; param['Response'] = 'StLnk'
when 0x65; cmdlen = 3; param['Response'] = 'CancelLnk'
when 0x53; cmdlen = 10; param['Response'] = 'InsLnkSts'
when 0x69; cmdlen = 3; param['Response'] = 'GetLnk'
when 0x6A; cmdlen = 3; param['Response'] = 'GetNext'
when 0x6C; cmdlen = 3 #Get All-Link Record for Sender
when 0x57; cmdlen = 10; param['Response'] = 'LnkData'
when 0x6F; cmdlen = 12; param['Response'] = 'MngLnk'
when 0x67; cmdlen = 3; param['Response'] = 'RstPLM'
when 0x6B; cmdlen = 4; param['Response'] = 'SetCfg'
when 0x60; cmdlen = 9; param['Response'] = 'GetVersion'
when 0x66; cmdlen = 6 #Set Host Device Category
when 0x72; cmdlen = 3 # RF Sleep
when 0x54; cmdlen = 3; param['Response'] = 'BtnRpt'
when 0x6D; cmdlen = 3; param['Response'] = 'LEDON'
when 0x6E; cmdlen = 3; param['Response'] = 'LEDOFF'
else

log('ERROR IN PLMPARSE- Unknown Command')
debug(value)

return ''
end

#Now we know the length the command should be, see if we have it.
#log('waiting for ' + cmdlen.to_s + ' characters...')
#log('length of current input is ' + value.length.to_s)
if value.length >= cmdlen
#log('GOT whole response')
#Yes, we have the whole command, Pack it in param
for byt in 1..cmdlen
param['Parameter' + byt.to_s] = "%02X" %value[byt - 1]
end
#now remove it from the string..
value = value.slice(cmdlen, value.length - cmdlen)
#Send it off for parsing
#log('Sending to EZToDCE:' + param.inspect.to_s)
EZToDCE(param)
else
#log('Still waiting...')
#no, we have NOT received the whole command.

end
end
return value
end

def rawX10(value)

x10MSN = $X10HouseCodes.index[value[0..0]]
x10LSN = $X10UnitCodes.index[value[1..1]]
return x10MSN + x10LSN
end

def X10Flag(value)
return + $X10CommandCodes.index[Value] + '0'
end

def SndIns
# create a new PLM command for SndIns
if not $wAIT
#log('SndIns:currentcmd=' + $currentcmd.to_s)

if $cmdqueue.nitems > 0
log("SndIns:Queue:" + $aqua + $cmdqueue.nitems.to_s + $grey)
#log('SndIns:' + $cmdqueue.inspect)
param = $cmdqueue[0]
### have to figure out the command byte 2 here
work = '02'.hex.chr + plmcommand(param)
### PLM command compilation
for loop in 2..param.keys.nitems
@dummy = param['Parameter' + (loop - 1).to_s].to_s
work+= @dummy.hex.chr
end
conn_.Reconnect()
debugout(work)
conn_.Send(work)
#sleep 0.1
$wAIT = TRUE
else
log($yellow + 'Queue Empty.' + $grey)
if $rerun
log('RERUN=TRUE, RESTARTING')
$rerun = false
mainRestart()
else
log('RERUN Not needed')
if not $reported
log('Reporting Child Devices')
@work = ""
$childdatabases.each{
|insteonID,value|
log('Child:' + insteonID)
log('Config:' + value.inspect)
@template = $devicetemplate[insteonID]
@work += insteonID + "\t\t\t" + @template.to_s + "\t\n"
}
log(@work)
cmd = Command.new(device_.devid_, -1001, 1, 2, 54)
cmd.params_[13] = @work
SendCommand(cmd)

$reported = true
else
log('report not needed')
end
end

end
else
log('X-----------SndIns: Waiting for response to:' + $cmdqueue[0]['Command'].to_s)
log('X-----------SndIns: Current Queue Length:' + $cmdqueue.nitems.to_s)
end
end
def plmcommand(param)
### this returns the proper Byte2 for the command.
case param['Command']
when 'GetVersion'; return 0x60.chr
when 'SndIns'; return 0x62.chr
when 'SndGrp'; return 0x61.chr
when 'SndX10'; return 0x63.chr
when 'GetLnk'; return 0x69.chr
when 'GetNext'; return 0x6A.chr
when 'BtnRpt'; return 0x54.chr
when 'GetCfg'; return 0x73.chr
when 'StLnk'; return 0x64.chr
when 'CancelLnk'; return 0x65.chr
when 'MngLnk'; return 0x6F.chr
when 'RstPLM'; return 0x67.chr
when 'SetCfg'; return 0x6B.chr
when 'LEDON'; return 0x6D.chr
when 'LEDOFF'; return 0x6E.chr
## hack
when 'InsStdMsg'
log('ERROR:PLMCommand encountered a COMMAND of INSSTDMSG')
break
return 0x62.chr
end
end

def debug(text)
work = 'DEBUG:'

for c in 1..text.length
work += "%02X" %text[c-1] + ' '
end
log($yellow + work + "Length:" + text.length.to_s + $grey)
end
def debugout(text)
work = 'out:'

for c in 1..text.length
work += "%02X" %text[c-1] + ' '
end
log($green + work + "Length:" + text.length.to_s + $grey)
end
def debugin(text)
work = 'IN:'

for c in 1..text.length
work += "%02X" %text[c-1] + ' '
end
log($red + work + "Length:" + text.length.to_s + $grey)
end

def padhex(hex)
if hex.length==1
hex = "0" + hex
end
return hex
end

def percenttohex(level)
# convert from percent to byte
return "%X" %(level.to_i * 2.55).to_i
end

def hextopercent(level)
return (level.hex.to_i / 2.55).to_i
end

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
def log2(line)
#this will send a message out the the orbiters..
#/usr/pluto/bin/MessageSend localhost 0 20 1 809 9 "Text to Display" 70 "alert" 182 "30" 251 "??"
cmd = Command.new(device_.devid_, -1000, 1, 1, 809)
cmd.params_[9] = line #text to display
cmd.params_[70] = 'PLMMessage' #Token
cmd.params_[182] = '10' #Timeout in seconds
cmd.params_[251] = '??'
SendCommand(cmd)
end
def checkChildRecordsinPLM()
log('Entered CheckChildRecordsinPLM')
# log('In CheckChildRecordsinPLM')
# time to verify all children are in the PLM
#
# log('Total PLM Records:' + $plmdatabase.nitems.to_s)
$plmdatabase.each{|record|
log('Record: = '+ getIIDfromRecord(record) + ' Group:' + getGroupfromRecord(record))
log('checking to see if it needs to be added as a child...')
if not existsinchild(getIIDfromRecord(record))

log(getIIDfromRecord(record) + ' needs to be added to the child database')
addtochild(getIIDfromRecord(record))
end
}

$childdatabases.each {|child,value|
if not existsinplm(child)
log(child + ' needs to be added to PLM')
sendAddtoPLM(child)
else
log(child + ' exists in PLM')
end

#now to scan the childs database
for record in 1..(value.nitems - 1)
@test = value[record]
if not existsinplm(getIIDfromRecord(@test))
log(getIIDfromRecord(@test) + ' needs to be added to PLM')
sendAddtoPLM(getIIDfromRecord(@test))
else
log(getIIDfromRecord(@test) + ' exists in PLM')
end
#Also check to see if it needs to be added in the childdatabases
end
}

end
def existsinplm(insteonid)
result = false
$plmdatabase.each{|record|
#log(insteonid + '==' + getIIDfromRecord(record))
if insteonid == getIIDfromRecord(record)
result = true
end
}
return result
end
def existsinchild(insteonid)
log('ExistsinChild:InsteonID:' + insteonid)
result = $childdatabases.keys.include?(insteonid)
log('ExistsinChild result:FALSE') if not result
log('ExistsinChild result:TRUE') if result
return result
end
def addtochild(insteonID)
log('addtochild Routne called')
log('Adding ' + insteonID + ' to the child database...')
if insteonID.length == 2 then
log('Child is X10')
$state[insteonID] = 0
else
log('Child is Insteon')
$childdatabases[insteonID] = ['****************']
sendPing(insteonID)
$rerun = true
end
end
def removefromchild(insteonID)
log('Removing ' + insteonID + ' from child database')
$childdatabases.delete(insteonID)
$state.delete(insteonID)
end
def removefromplm(insteonID)
log('Removing from plm')
$plmdatabase.each{|record|
#log(insteonid + '==' + getIIDfromRecord(record))
if insteonID == getIIDfromRecord(record)
debug(record)
log('Found Record, Deleting')
$plmdatabase.delete(record)

#now, we have to remove it from the device.
param = {'Command' =>'MngLnk',
'Parameter1' => '80', #DELETE
'Parameter2' => record[0..1], #control byte
'Parameter3' => record[2..3], #group
'Parameter4' => record[4..5],#HB
'Parameter5' => record[6..7],#MB
'Parameter6' => record[8..9],#LB
'Parameter7' => record[10..11],#data1
'Parameter8' => record[12..13],#data2
'Parameter9' => record[14..15] #data3

}
log(param.inspect)
$cmdqueue << param
end
}
end
def sendAddtoPLM(insteonID)
log('Adding ' + insteonID + ' to the PLM database...')
#This adds a record into the PLM
@insID = insteonID.split('.')
param = {'Command' => 'MngLnk',
'Parameter1' => '40', #control code -- add new record as Controller
'Parameter2' => 'C2', #All Link Record Flags AKA Record Control Byte
'Parameter3' => '01', #All Link Group
'Parameter4' => @insID[0], #HB
'Parameter5' => @insID[1], #MB
'Parameter6' => @insID[2], #LB
'Parameter7' => '01', #Link Data 1 ON-Level
'Parameter8' => '01', #Link Data 2 Ramp Rate
'Parameter9' => 'FF'} #Link Data 3 not used
if $wAIT
$cmdqueue.insert(1, param)
else
$cmdqueue.insert(0, param)
end

SndIns()
end

def getIIDfromRecord(recordstring)
#this extracts the insteonID string from the record.
#log('getIIDfromRecord::recordstring:' + recordstring)
@idhb = recordstring[4..5]
@idmb = recordstring[6..7]
@idlb = recordstring[8..9]
@result = @idhb + '.' + @idmb + '.' +@idlb
#log('GetIIDfromRecord: Found ID:' + @result)
return @result
end

def processBroadcastMessage(param)
#search the child databases for responders,
#and fire COMMANDS for each responder. 06Feb08
#and fire events for each responder.XXXXXXXXXXXXX
#Message flag is in parameter9 Group command 0xCx (All-Link Broadcast Message Pg 42.)
#Group is in parameter8
#From InsteonID is parameters 3, 4, 5
group = param['Parameter8']
from = padhex(param['Parameter3']) + '.'
from += padhex(param['Parameter4']) + '.'
from += padhex(param['Parameter5'])
log('Looking for ' + from + ' Group:' + group)
#Ok, now have to search child databases for from AND group AND responder
$childdatabases.each{|child,value|
#log('Searching:' + child)
for rec in 1..(value.nitems - 1)
record = value[rec]
if getIIDfromRecord(record) == from # First, look for Insteon ID
#log('Found ID')
if getGroupfromRecord(record) == group #next, Group
#log('Found Group')
if isResponderRecord(record) # is a responder?
#log('Found Responder')
#figure out the child devicenum
from = $children[child]
#figure out the command
case param['Parameter10'].hex
when 0x11 #on
reportStatus(from, 100)
when 0x13 #off
reportStatus(from, 0)
when 0x17 #dim/brighten -ignore
level = 0
when 0x18 # STOP dim/brighten - sendgetstatus
level = 0
sendGetChildStatus(child)
else
level = 0
log('Command is other than ON/OFF/Dim/Brighten')
end
end
end
end
end
}
end

def reportStatus(from, level)
log('From:' + from.to_s)
log('current State:' + $state[from].to_s)
log('Wanted State:' + level.to_s)
case $state[from]
when 0
if level >=1
cmd = Command.new(from, from, 1, 1, 192) #on
cmd.params_[120] = "1"
SendCommand(cmd)
cmd = Command.new(from, from, 1, 1, 184)
cmd.params_[76] = level.to_s
cmd.params_[120] = "1"
SendCommand(cmd)
end
when 100
if level >= 1
cmd = Command.new(from, from, 1, 1, 184)
cmd.params_[76] = level.to_s
cmd.params_[120] = "1"
SendCommand(cmd)
else
cmd = Command.new(from, from, 1, 1, 193) # off
cmd.params_[120] = "1"
SendCommand(cmd)
end
else
if level == 100
cmd = Command.new(from, from, 1, 1, 193) #off
cmd.params_[120] = "1"
SendCommand(cmd)
cmd = Command.new(from, from, 1, 1, 192) # on
cmd.params_[120] = "1"
SendCommand(cmd)
end
cmd = Command.new(from, from, 1, 1, 184) #SetLevel
cmd.params_[76] = level.to_s
cmd.params_[120] = "1"
SendCommand(cmd)
end
log('ReportStatus: device:' + from.to_s + ' Status:' + level.to_s)
$state[from] = level

end

def isResponderRecord(recordstring)
work = recordstring[0..1].hex
if (work & 0x40) == 0x40 #check bit 6
result = false #signifies Controller record
else
result = true #signifies Responder record
end
return result
end

def getGroupfromRecord(recordstring)
#this extracts the GROUP from the record.
if recordstring == nil
return '00'
else
return recordstring[2..3]
end
end
def getdeltafromconfig(insteonID)
#This returns the delta from the child.
@work = $childdatabases[insteonID][0] # the settings stored in [0]
if @work == nil
return '00'
else
return @work[6..7]
end
end
def sendGetChildStatus(insteonID)
#log('sendGetChildStatus Called')
if insteonID.length != 2 #X10 device
@insID = insteonID.split('.')
param = {'Command' => 'SndIns',
'Parameter1' => @insID[0],
'Parameter2' => @insID[1],
'Parameter3' => @insID[2],
'Parameter4' => '0F', #flags
'Parameter5' => '19', #Status Request
'Parameter6' => '00'} #not used.
$cmdqueue << param
SndIns()
#Returned response will have cmd1 = DBDelta
#Returned response will have cmd2 = ON-Level
else
log('X10 does not report status')
end
end

# time to define a structure to save the raw data in hex
# starts at [0]
# Bytes Meaning
# 0-1 Device Category
# 2-3 Device SubCategory
# 4-5 Device Firmware
# 6-7 Database Delta
# 8-9 reserved
# 10-11 reserved
# 12-13 reserved
# 14-15 reserved
###### First database record below (in same format its read from the device)
###### This is the same format as an ALL-Link Record Response from the PLM
###### (0x57) bytes 3..10
# 16-17 record control byte
# 18-19 Group
# 20-21 ID HB
# 22-23 ID MB
# 24-25 ID LB
# 26-27 Link Specific Data1
# 28-29 Link Specific Data2
# 30-31 Link Specific Data3
######
# 32-47 next database record...

</pre>

LG 42LB5D

2010-02-02T09:56:45Z

Newacct:

[[Category: Video]]
[[Category: Displays]]

{| align="right"
| __TOC__
|}
==Features==
===Basics===
* 42" (diagonal) [[16:9|widescreen]] [[LCD]] television
* Good build quality on the whole, though some edges on the plastic casing were left "sharp" (I'm OCD about fit and finish)
* Not that heavy for its size (one person can lift it, in or out of packing carton)
Special features and nice touches:
* [[RS232 port]] at the back to allow external control (by LinuxMCE for example)
* Power LED is red on standby, and switches to green when set is on (thank goodness, blue-LED fever is abating! :-)
* Brightness can be instantly adjusted via two remote buttons -- the only thing better would be a photosensor that adjusts things automatically for ambient light (but that's what hacking is all about ;-)
===Picture fidelity===
* Crisp picture when provided with full quality source (e.g. true HD)
* Crisp picture with some ghosting when using the RGB-PC input with a standard (though longer than average) VGA video cable -- I will try to add a photo of the effect; the lowest-tech connections ([[S-Video]], RF, and the like) for PC video are NOT recommended!
* A touch blurry with low-end sources ([[S-Video]], RF) like older game systems, but still a fairly good overall picture; I have yet to test other signal methods with my game systems (requires special cables I don't yet have).
===Usability===
* The [[OSD]] UI and remote are excellent. Both the menus and the buttons are laid out sensibly, and the system incorporates a great idea for settings that are cyclic (most are): the first time you press a button (e.g. [[aspect ratio]]), it brings up an [[OSD]] reminder of the current setting; subsequent presses will cycle through the available options. It's simple, and effective at preventing accidental setting changes by a single inadvertent button press on the remote.
Resolutions:
* 1024x768
* 1280x768
* 1360x768

== Adding new template ==
Here is a description of adding a Template for LG LCD TV with serial connections for control. According to the manual the following models should work:
LCD TV MODELS 37LB5D / 42LB5D / 47LB5D 52LB5D/ 32LB4D / 37LB4D / 42LB4D
I have the 42LB5D, so I know that this one works.

=== Specify device data and parameters ===

On the LinuxMCE admin website go to: Advanced > Configuration > Device Templates

Select: Manufacturer 'LG', Device Category 'TVs/Plasmas/LCD's/Projectors' and press 'Add device template'

Description : XXLB4/5D
Implements DCE : yes
Command line : Generic_Serial_Device
Device Category AV TVs/Plasmas/Projection... #77
Manufacturer LG

Also have added following parameters (You need to add them one by one under the header 'Device data'):

Device data
Current Data Comments Default Value
#37 COM Port on PC(string) The serial port
#76 COM Port ParityBit/Stop(string) Parity/Stop bits (factory defaults) N81
#78 COM Port BaudRate(string) Baud rate (factory default) B9600
#157 Discrete Volume(bool) Indicates if the volume on... 1

Settings are factory defaults and shouldn't be changed (9600 baud rate, 8 bits, 1 stop bit). Make sure that the check box for Allowed to Modify is checked, so that you can change to the appropriate COM port later.

=== 'Edit Ruby code' (on template page) ===

==== 'Add/remove commands' ====
First, I clicked on 'Add/remove commands' and clicked on commands that are supported by device...

* Ruby Internal Commands
* Standard TV

==== 'Add Ruby snippets to commands'====
Edited corresponding Ruby snippets for each command. Basically those are just simple strings that get send on rs232 to take proper action on device according to received command from LinuxMCE... Use the extended editor for the multiline entries (otherwise ruby won't understand it and gives lot's of errors)
<pre>
#193 Off
log('Sending OFF Command')
<$"ka 01 00\r"$>
#192 On
log('Sending ON Command')
<$"ka 01 01\r"$>
Inputs
#419 Antenna

#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"$>
#713 Component 2
log('Switching Input to Component 2')
<$"kb 01 05\r"$>
#426 External 3
log('Switching Input to HDMI 3')
<$"kb 01 09\r"$>
#361 HDMI
log('Switching Input to HDMI 1')
<$"kb 01 07\r"$>
#767 HDMI 2
log('Switching Input to HDMI 2')
<$"kb 01 08\r"$>
#376 Input 3
log('Switching Input to HDMI 3')
<$"kb 01 09\r"$>
#154 RGB
log('Switching Input to RGB/PC')
<$"kb 01 06\r"$>
#166 Tuner
log('Switching Input to Analog Tuner')
<$"kb 01 01\r"$>
#873 Tuner - Digital
log('Switching Input to Digital Tuner')
<$"kb 01 00\r"$>
Aspect Ratios
#879 16:9
log('Switching Aspect Ratio to 16:9')
<$"kc 01 02\r"$>
#877 4:3
log('Switching Aspect Ratio to 4:3')
<$"kc 01 01\r"$>
Disk Handle
#48 Eject Disk

DSP Modes
#116 DSP Mode
log('Switching DSP Modes: Toggled Only')
<$"mc 01 52\r"$>
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 = ''
loop do
buff=conn_.Recv(30,200)
if buff.empty?
log('Nothing Received')
break
end
log('Received: ' + Regexp.escape(buff.to_s))
if buff.include?("OK")
log(Regexp.escape(buff.to_s) + ': Command Processed Successfully')
elsif buff.include?("NG")
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.include?("OK")
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
#548 Menu
log('Sending Menu Command')
<$"mc 01 43\r"$>
#676 Video Mute
log('Sending Video Mute Command')
<$"kd 01 00\r"$>
Numbers
#364 -/--/---

#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 12\r"$>
#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"$>
#363 Back / Clear Entry
log('Sending Back/Clear Command ')
<$"mc 01 1A\r"$>
On-Screen Menu Navig
#240 Back / Prior Menu
log('Sending Exit Command ')
<$"mc 01 5B\r"$>
#225 Display

#368 Help

#86 Menu (Show Menu)
log('Sending Menu Command ')
<$"mc 01 43\r"$>
#201 Move Down
log('Sending Move Down Command ')
<$"mc 01 41\r"$>
#202 Move Left
log('Sending Move Left Command ')
<$"mc 01 07\r"$>
#203 Move Right
log('Sending Move RighCommand ')
<$"mc 01 06\r"$>
#200 Move Up
log('Sending Move Up Command ')
<$"mc 01 40\r"$>
Simple Control
#92 Pause
log('Sending Pause Command ')
<$"mc 01 BA\r"$>
#139 Play
log('Sending Play Command ')
<$"mc 01 B0\r"$>
#102 Record
#log('Sending Record Command ')
#<$"mc 01 BD\r"$>
#64 Skip Back - Channel/Track Lower
log('Sending Channel Down Command ')
<$"mc 01 01\r"$>
#63 Skip Fwd - Channel/Track Greater
log('Sending Channel Up Command ')
<$"mc 01 00\r"$>
#95 Stop
log('Sending Stop Command ')
<$"mc 01 B1\r"$>
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)
# 158 = DEVICEDATA_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)
Speed Ctrl
#125 Scan Back/Rewind
log('Sending Rewind Command ')
<$"mc 01 8F\r"$>
#93 Scan Fwd/Fast Fwd
log('Sending Fast Fwd Command ')
<$"mc 01 8E\r"$>
#98 Slow Scan Back

#99 Slow Scan Forward

TV
#136 Previous Channel
log('Sending Previous Channel Command ')
<$"mc 01 B2\r"$>
</pre>

== Adding device ==

This is a simple process that you can now add via the [[LinuxMCE Admin Website]] at '''Wizard > [[AV Devices|A/V Equipment]]'''
=== Add device based on created template ===
Just search for the device template that you created and select it from the list
=== Specify COM port for it ===
Just tell LinuxMCE which com port to use.
=== Assing it to new room ===
Tell LinuxMCE which room to assign this device
=== Specifiy Audio pipe connections to inputs on receiver ===
Tell LinuxMCE how you have thing attached to the LG TV and how the LG TV is attached to the computer.

''I have it attached via RGB port and I have my cable box attached to AV1 and my HDTV connected to Tuner-Digital input.''

==Making Plug&Play==
This is not needed to use the TV, but I post as an option.
Location: /usr/pluto/pnp

vi /usr/pluto/pnp/20_LGLCD.sh
add the following and then make the file executable.

<pre> #!/bin/bash
#Play and Play script for LG TV's Models Numbers:LGXXLB4/5D
#Set ID needs to be set to 01
#Serial feedback is very slow so it requires several seconds to get feedback
#Device Template Number:1905 on my local Machine.
#Serail Command for Power On ka 01 01
#Serial Command for Power OFF ka 01 00
#Returns two different strings depending on whether or not the TV is On or Off, so we will try to turn it ON then resend the ON command as it returns proper string (ka 01 01\r\na 00 OK01x\r\n)
echo "LG TV Detection script queue $2"
/usr/pluto/bin/TestSerialPort -p $3 -P N81 -b 9600 -t "ka 01 01\r"
sleep 5s
/usr/pluto/bin/TestSerialPort -p $3 -P N81 -b 9600 -t "ka 01 01\r" -i 5 -s "OK01x\r"
if [[ "$?" -ne 0 ]]; then
echo "It's not a LG TV"
/usr/pluto/bin/MessageSend dcerouter -r 0 $1 1 806 224 $2 13 "$4" 44 0
else
echo "It is a LG TV"
/usr/pluto/bin/MessageSend dcerouter -r 0 $1 1 806 224 $2 13 "$4" 44 1905
fi</pre>

the plugin will run the script with 4 parameters: the device id of the plugin, the unique id for this event (the PK_PnpQueue), a path where the device is located (ip address for ethernet devices, serial port for rs232 devices, etc.), and the name of the pnp detection script.

The detection script should attempt to determine what device template is on the path using any appropriate means. If it finds a match, it should fire a message using the paramters it received, such as this:

/usr/pluto/bin/MessageSend dcerouter -r 0 $1 806 224 $2 13 "$4" 44 1905(this is the template id for the devicetemplate you created above)

Onkyo TXSR805

2010-02-02T09:54:39Z

Newacct:

[[category: Audio]]
{{stub}}
[[category: Tutorials]]
== Using the Onkyo TX-SR805 with RS232 Control ==

'''THIS CODE IS STILL BEING DEVELOPED'''

Future home of the howto for setting up a Onkyo TX-SR805 with RS232 support.
 
May widen howto to all Onkyo RS232 Receivers.
 

This device does currently work with limited functionality. A writeup for how to add this device to a Linux MCE system will be done soon. 
 
** If you use this device and have any problems or suggestions to the code here, please switch over to the discussion tab and bring it to my attention ** 

----
 
Current features supported: 
-On/Off 
-Change inputs 
-Volume control (Up/Down in set increments. cmd_313 Set Volume still needs work) 
 
Being worked on: 
-Precise Volume Control (cmd_313) 
-Listening Modes 
-Zone 2/3 
-FM Tuner 
 
----
'''Ruby Code:'''

Section: 193 Off 
<$"!1PWR00\r"$>

Section: 192 On 
<$"!1PWR01\r"$>
sleep(2)
<$"!AMT00\r"$>
@mute = false

Section: 169 AM 
<$"!1SLI25\r"$>

Section: 164 Aux 
<$"!1SLI03\r"$>

Section: 172 Aux 2 
<$"!1SLI04\r"$>

Section: 162 CD 
<$"!1SLI23\r"$>

Section: 165 DVD 
<$"!1SLI10\r"$>

Section: 170 FM 
<$"!1SLI24\r"$>

Section: 163 Phono 
<$"!1SLI22\r"$>

Section: 160 Tape / Tape 1 
<$"!1SLI20\r"$>

Section: 173 Tape 2 
<$"!1SLI21\r"$>

Section: 166 Tuner 
<$"!1SLI26\r"$>

Section: 909 XM 
<$"!1SLI31\r"$>

Section: 373 Private Method Listing 
# Written by Jason Bennett
#
# Process 373 - Methods
def receiveMsg
buff = conn_.Recv(7, 1000)
log("Message Received: #{buff}")
trash = conn_.Recv(1, 100)
if buff.length() < 7
parsed1 = "ERR"
parsed2 = "00"
else
parsed2 = buff[5].chr + buff[6].chr
parsed1 = buff[2].chr + buff[3].chr + buff[4].chr
return [parsed1, parsed2]
end
end
#-------------------------------------------- Parsing -----------------------------------------------------------------------------------
def chkMsg(cat, opt)
case cat
# Power
when "PWR"
cmd = Command.new(device_.devid_, -1001, 1, 2, 48) # 48 = Power State
case opt
when "01"
cmd.params_[10] = "1" # Command 48, Param 10: 1 = On
when "00"
cmd.params_[10] = "0" # Command 48, Param 10: 2 = Off
end
SendCommand(cmd)
# Master Volume Level
when "MVL"
cmd = Command.new(device_.devid_, -1001, 1, 2, 71) # 71 = Volume
cmd.params_[30] = opt.hex.to_s # Command 71, Param 16 = Volume Level in Decimal
log("volume reported as: #{opt.hex.to_s}")
SendCommand(cmd)
# Input Selection
when "SLI"
cmd = Command.new(device_.devid_, -1001, 1, 2, 49) # 49 = Input Selection
case opt
when "00"
input_param = 316
when "01"
input_param = 317
when "02"
input_param = 318
when "03"
input_param = 164
when "04"
input_param = 172
when "10"
input_param = 165
when "20"
input_param = 160
when "22"
input_param = 163
when "23"
input_param = 162
when "24"
input_param = 170
when "25"
input_param = 169
when "26"
input_param = 166
when "31"
input_param = 909
end
cmd.params_[41] = input_param.to_s() # Command 49, Param 41 = Input
SendCommand(cmd)
end
end
#-------------------------------------------- Logging -----------------------------------------------------------------------------------
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

Section: 350 Process Incoming Data 
# Written by Jason Bennett
#
# Process 350 - Incoming
incMsg = receiveMsg()
log("New Msg: #{incMsg[0]}:#{incMsg[1]}")
chkMsg(incMsg[0], incMsg[1])

Section: 355 Process Initialize 
#31-May-06 14:13 init Onkyo Receiver
initok=false
for iRetry in 0...4
print "Initializing unit\n"
conn_.Send("!1PWRQSTN\r")
buf = conn_.Recv(200, 1000)
if !buf.nil? && buf.include?("PWR0")
print "Initialized ok\n"
initok=true
break
else
print "Didn't respond to command\n"
end
end
if initok==false
DisableDevice( device_.devid_, true )
print "The device wouldn't respond. Disabling it.\n"
return
end
print "Initialized ok, doing log\n"

Section: 97 Mute 
if(@mute)
<$"!1AMT00\r"$>
else
<$"!1AMT01\r"$>
end
@mute=!@mute

Section: 313 Set Volume 
slevel = sprintf( "%x", level.to_i)
<$"!1MVL" + slevel + "\r"$>
SetDeviceDataInDB( device_.devid_, 158, level ) # 158 = DEVICEDATA_Volume_Level_CONST
print "volume and corresponding device data set\n"

Section: 90 Vol Down 
<$"!1MVLDOWN\r"$>

Section: 89 Vol Up 
<$"!1MVLUP\r"$>

Insteon PLM Ruby Code 355

2010-01-27T09:16:39Z

Newacct:

[[category: Insteon]]
<pre>#### Written by Dan Damron
#### #355 Process Initialize ####
$red = 0x1b.chr + '[31m'
$green = 0x1b.chr + '[32m'
$yellow = 0x1b.chr + '[33m'
$blue = 0x1b.chr + '[34m'
$purple = 0x1b.chr + '[35m'
$aqua = 0x1b.chr + '[36m'
$grey = 0x1b.chr + '[37m'
$redBack = 0x1b.chr + '[41m'
$greenBack = 0x1b.chr + '[42m'
$yellowBack = 0x1b.chr + '[43m'
$blueBack = 0x1b.chr + '[44m'
$purpleBack = 0x1b.chr + '[45m'
$aquaBack = 0x1b.chr + '[46m'
$greyBack = 0x1b.chr + '[47m'
$blackBack = 0x1b.chr + '[48m'
$remoteLinkRecord = ''
#$remoteRecordReady = 0
$configstring = ''
$configparams = []
$childdatabases = {}
$newdevices = {}
$state = {}
$devicetemplate = {}
$plmdatabase = []
$plmlastrecord = true
$log = ''
$cmdTo = ''
$cmdFrom = ''
$cmdPriority = ''
$cmdType = ''
$cmdID = ''
$cmdParams = {}
$children = {}
$recvbuff = ''
$wAIT = false
$currentCmd = {}
$flagsBroadcastMessage = 128
$flagsDirectMessage = 0
$flagsAckDirectMessage = 32
$flagsNackDirectMessage = 160
$flagsGroupBroadcaseMessage = 192
$flagsGroupCleanupDirectMessage = 64
$flagsGroupAckDirectMessage =96
$flagsGroupNackDirectMessage = 224
$cmdqueue = []
$currentcmd = 0 # to save state of command when receiving more data.
$resetNext = 0 # used in Process IDLE to trap stalled responses.
$savedstate = nil
$dcequeue = []
$rerun = false
$reported = false
$X10HouseCodes = {
'6', 'A',
'E', 'B',
'2', 'C',
'A', 'D',
'1', 'E',
'9', 'F',
'5', 'G',
'D', 'H',
'7', 'I',
'F', 'J',
'3', 'K',
'B', 'L',
'0', 'M',
'8', 'N',
'4', 'O',
'C', 'P'}
$X10UnitCodes = {
'6', '1',
'E', '2',
'2', '3',
'A', '4',
'1', '5',
'9', '6',
'5', '7',
'D', '8',
'7', '9',
'F', '10',
'3', '11',
'B', '12',
'0', '13',
'8', '14',
'4', '15',
'C', '16'}
$X10CommandCodes = {
'6', 'All Lights Off',
'E', 'Status = off',
'2', 'On',
'A', 'Pre-Set Dim',
'1', 'All Lights On',
'9', 'Hail Ack',
'5', 'Bright',
'D', 'Status=on',
'7', 'Extended Code',
'F', 'Status Request',
'3', 'Off',
'B', 'Pre-set Dim',
'0', 'All Units Off',
'8', 'Hail Request',
'4', 'Dim',
'C', 'Extended Data(analog)'}
$responseString = '<' + '/' + 'Response>'

############################## TEST Code below #################################
# testing Reading a devices Database
# Common Insteon Device Memory Locations:
# 0x0001 EESize - MSB of size of EEPROM chip in device
# 0x0002 EEVersion - Firmware Revision number
# 0x0020 EEOnLevel - Preset On-Level for lighting control
# 0x0021 EERampRate - Ramp Rate for Lighting Control
# 0x0030 EEX10BaseHouse - Base X10 House Code for device
# 0x0031 EEX10BaseUnit - Base X10 Unit Code for device
#
# ALDB/L
# Starts at the top of external serial eeprom and grows downward.
# most limited-memory INSTEON devices, top of memory is 0x0FFF
# Each Record is 8 bytes long, so the first record starts at
# 0x0FF8, the second record starts at 0x0FF0
#
# ALDB/L Record Format:
# Record Control: 1 byte
# Group: 1 Byte
# ID: 3 Bytes HB MB LB
# Data1: 1 Byte Link-specific data (eg. On-Level)
# Data2: 1 Byte Link specific data (eg. Ramp Rates)
# Data3: 1 Byte Link specific data (normally unused)
#
# Record Control Byte Bitmap:
# 7: 1=Record in use, 0=Record is available
# 6: 1=Controller of ID, 0=Responder of ID
# 5: Product Dependant
# 4: Product Dependant
# 3: Product Dependant
# 2: Product Dependant
# 1: 1=Record has been used before, 0=High water mark (last record)
# 0: Reserved
#PLM cat 03 subcat 05
# param = {'Command' => 'StLnk',
#'Parameter1' => '01', #Link code 0x01=controller
#'Parameter2' => '8F' #All Link Group
#}
#$cmdqueue << param
# param = {'Command' => 'CancelLnk'}
#$cmdqueue << param
#SndIns()
#
#Lets try the Assign to ALL-Link Group ### SUCCESS!!!
#param = {'Command' => 'SndIns',
#'Parameter1' => '0A', #HB
#'Parameter2' => '8F', #MB
#'Parameter3' => '5A', #LB
#'Parameter4' => '0F', #Flags
#'Parameter5' => '01', #Cmd1
#'Parameter6' => '8F' #Cmd2
#}
#
#
#param = {'Command' => 'MngLnk',
#'Parameter1' => '00', # Control Code
#'Parameter2' => 'C2', #All Link Record Flags AKA Record Control Byte
#'Parameter3' => '01', #All Link Group
#'Parameter4' => '0A', #HB
#'Parameter5' => '97', #MB
#'Parameter6' => '0B', #LB
#'Parameter7' => '01', #Link Data 1 ON-Level
#'Parameter8' => '01', #Link Data 2 Ramp Rate
#'Parameter9' => '00'} #Link Data 3 not used
#$cmdqueue << param
#
#
## Test Device: LampLinc ID:0A.97.0B
# Assign Test device to Group
#param = {'Command' => 'SndIns',
#'Parameter1' => '0A', #HB
#'Parameter2' => '97', #MB
#'Parameter3' => '0B', #LB
#'Parameter4' => '0F', #Flags
#'Parameter5' => '01', #Cmd1
#'Parameter6' => '01' #Cmd2
#}
#$cmdqueue << param
#
#
############################## Real Code below #################################
log('MY DEVICE:' + device_.devid_.to_s)

#################################################
#What I need to do and the order I need to do it.
#done read PLM database
#done get child devices
#done read child devices configuration
#done1 all child devices in the PLM database?
#done if not, add their ID to the PLM database (new group numbers?)
# get the status of each (child) device
# compare the Database delta with the value stored in the configuration
# Different?
# read the child database
# update configuration
# check devices links to see if any are new
# new link found, what to do?? send a message?
# create new child device?
# PING the new device and back to 1
###
# easiest way?.. create hash for PLM records
# create hash for child devices is needed
# (not needed if DBDelta is same)

#reset the PLM
$timeout = 3
#param = {'Command' => 'RstPLM'}
#$cmdqueue << param
#SndIns()

#put IM in monitor mode..
param = {'Command' => 'SetCfg', 'Parameter1' => '40'}
$cmdqueue << param
SndIns()
mainStart()

##children found... get the status of each child...
#$children.each_key{|c|
# if c.length > 2 #filter out X10 for now
# #pack insteon message here, and send it out!
# # receive message in parsemessage and relay commands back in it.
# insteonID = c.chomp.split('.')
# param = {'Command' => 'SndIns',
# 'Parameter1' => insteonID[0],
# 'Parameter2' => insteonID[1],
# 'Parameter3' => insteonID[2],
# 'Parameter4' => '0F', #flags
# 'Parameter5' => '19', #Status Request
# 'Parameter6' => '00'} #not used.
# $cmdqueue << param
## below gets the device Cat/SubCat/Firmware
# param = {'Command' => 'SndIns',
# 'Parameter1' => insteonID[0],
# 'Parameter2' => insteonID[1],
# 'Parameter3' => insteonID[2],
# 'Parameter4' => '0F', #flags
# 'Parameter5' => '10', #PING
# 'Parameter6' => '00'} #not used.
# $cmdqueue << param
#
# end
# }</pre>

Insteon PLM Ruby Code 373

2010-01-27T09:03:48Z

Newacct:

[[category: Insteon]]
<pre>#### Written by Dan Damron
#### #373 Private Method Listing ####

def mainStart() ## This is called FIRST, reruns cannot call this.
#Register Message Interceptor
@interceptor = Command.new(device_.devid_, -1000, 1, 5, 37)
@interceptor.params_[2] = device_.devid_.to_s
SendCommand(@interceptor)
#Get the PLM Database
sendGetLink
#get Child devices
log('Finding Children..')
device_.childdevices_.each{|c| $children[device_.childdevices_[c.to_s.to_i].devdata_[12].chomp.lstrip.rstrip] = c.to_s.to_i}
$children.each{|c,v| log(c + ' = ' + v.to_s)
}
log('reading stored Child configuration:')

$children.each_key{|c|
#Get each Childs configuration
$state[c] = 0
getdeviceconfig(c) #

#the above getdeviceconfig packs $configparams array
log('Configuration for ' + c + ' = ' + $configparams.inspect.to_s)
}

log('********************************************************')
#get childs actual configuation and status
$children.each_key{|c| sendGetChildStatus(c)}
SndIns()

end
def mainRestart()
#We have hashes already set up.
$childdatabases.each_key{|@insteonID|
$state[@insteonID] = 0
sendGetChildStatus(@insteonID)}
SndIns()
end

def setdeviceconfig(insteonid, configurestring)
@deviceid = $children[insteonid]
@cmdfrom = device_.devid_
@cmdto = 4 #general info plugin
@priority = 1
@type=1 #command
@cmdid = 246

#set up command..
@cmd = Command.new(@cmdfrom, @cmdto, @priority, @type, @cmdid)
@cmd.params_[2] = @deviceid.to_s
@cmd.params_[52] = '59' # Configuration
@cmd.params_[5] = configurestring
SendCommand(@cmd)
#log('SetDeviceConfig:' + configurestring)
#log('Configuration Saved - will be available on next reload')
end

def getdeviceconfig(insteonid)
@deviceid = $children[insteonid]
@configstring = ''
begin
@configstring = device_.childdevices_[@deviceid].devdata_[59].to_s
rescue
log('Device ID = ' + @deviceid.to_s)
log($red + 'Error - Child has no configuration'+ $grey)
log('Setting initial value of "****************"')
setdeviceconfig(insteonid, ('*' * 16))
@configstring = '*' * 16
sendPing(insteonid)
end
if @configstring == ''
$configparams = ['****************']
log('CAUGHT BLANK RECORD')
setdeviceconfig(insteonid, ('*' * 16))
sendPing(insteonid)
else
$configparams = @configstring.unpack('a16' * (@configstring.length / 16))
$devicetemplate[insteonid] = getdevicetemplate($configparams[0][0..1], $configparams[0][2..3])
end
#log($yellow + 'getdeviceconfig:' + $configparams.inspect + $grey)
#add the configuration parameters to the child database
$childdatabases[insteonid] = $configparams
#get the device type

end

def sendGetLink()
#lets just see exactly what is in the PLM database
param = {'Command' => 'GetLnk'}
$cmdqueue << param
SndIns()
end

def sendGetNext()
param = {'Command' => 'GetNext'}
if $wAIT
$cmdqueue.insert(1, param)
else
$cmdqueue.insert(0,param)
end
SndIns()
end

def sendRemoteGetLink(insteonID)
# Read First ALDB Record
# a few variables need to be set up here..
$recordof = insteonID # save the insteon ID
insID = insteonID.chomp.split('.') # get the seperate bytes
$remoteDBOffsetMSB = 0x0F # initial offset
$remoteDBOffsetLSB = 0xF8 # initial LSB offset
param = {'Command' => 'SndIns',
'Parameter1' => insID[0], #HB
'Parameter2' => insID[1], #MB
'Parameter3' => insID[2], #LB
'Parameter4' => '0F', #Flags
'Parameter5' => '28', #Cmd1
'Parameter6' => "%X" %$remoteDBOffsetMSB #Cmd2 Set MSB Offset
}
$cmdqueue << param
# repeat last param for each byte to read (F8..FF)=first record

for x in 0..7
param = {'Command' => 'SndIns',
'Parameter1' => insID[0], #HB
'Parameter2' => insID[1], #MB
'Parameter3' => insID[2], #LB
'Parameter4' => '0F', #Flags
'Parameter5' => '2B', #Cmd1 Peek
'Parameter6' => "%X" %($remoteDBOffsetLSB + x) #Cmd2
}

$cmdqueue << param
end

end

def sendRemoteGetNext(insteonID)
insID = insteonID.chomp.split('.') # get the seperate bytes
### Do NOT forget to check to see if we need to decrease the MSB

if $remoteDBOffsetLSB == 0x00
#OffsetMSB needs to be decreased, and LSB needs reset.
$remoteDBOffsetMSB = $remoteDBOffsetMSB - 1
$remoteDBOffsetLSN = 0xFF # the next line will decrease this by 8
end
# decrease DBOffsetLSB by 0x08
$remoteDBOffsetLSB = $remoteDBOffsetLSB - 0x08

for x in 0..7
param = {'Command' => 'SndIns',
'Parameter1' => insID[0], #HB
'Parameter2' => insID[1], #MB
'Parameter3' => insID[2], #LB
'Parameter4' => '0F', #Flags
'Parameter5' => '2B', #Cmd1 Peek
'Parameter6' => "%X" %($remoteDBOffsetLSB + x) #Cmd2
}
#log('sendRemoteGetNet:added to queue:' + param.inspect)
if $wAIT
$cmdqueue.insert(x + 1, param)
else
$cmdqueue.insert(x,param)
end

end
end

### Main command parsing routine is EZToDCE
def EZToDCE(param)
#param contains a hash of EZBridge command structure
#log($blue + 'Queue:' + $cmdqueue[0].inspect + $grey)
#log($blue + 'Param:' + param.inspect + $grey)
#log($blue + 'currentcmd:' + $currentcmd.to_s + $grey)
#checkWait(param)
case param['Response']
# Standard RESPONSES (to commands)
when 'GetRevision' # Special Response
log('-----|---------GetRevision:' + param['Parameter1'])

when 'GetLatLong' # Special Response
log('-----|---------GetLatLong: Lat=' + param['Lat'] + ', Long=' + param['Long'])

when 'SetLatLong'
if param['Parameter1'] == 'True' then
log('-----|---------SetLatLong: Ok')
else
log('-----X---------SetLatLong: FAILED!')
end
when 'SetPasswd'

when 'SetTimeZone'

when 'GetClock' # Special Response

when 'SetClock'

when 'SetNTPServer'

when 'Upgrade'

when 'NetCfg'

when 'Reset'
#Reset Response

cmdComplete
SndIns()
when 'LstTimers' # Special Response

when 'ClrTimers'

when 'AddTimer'

when 'GetTimer' # Special Response

when 'SetTimer'

when 'DelTimer'

when 'GetVersion' # Special Response

when 'SndGrp'

when 'SndIns' # response from SndIns
### BUG FOUND ### When the EZBridge receives a command from an EXTERNAL source
### ie not from this device, cmdqueue will be nil, and the code below
### fails. Have to check against that.
if not $cmdqueue.empty?
#First, check the response to make sure the command made it ok.
if param['Parameter9'].to_i == 6 #Ack received
#log('Sending to ProcessACK')
processACK(param)
else # NACK received - command failed.
log('Command NACKED')
end
else
#Response received for another device.
log('Response detected for a command that was not sent by me')
end
when 'SndX10'
log('Response detected for SndX10')
if param['Parameter5'].to_i == 6 #ack
log('X10 Command Successfull')

cmdComplete
SndIns()
else
log('X10 Command FAILED')
cmdComplete
SndIns()

end
when 'StLnk'

when 'CancelLnk'

when 'SetDev'

when 'RstPLM'
#Reset Response
$timeout = 1
cmdComplete
SndIns()

when 'GetLnk'
if param['Parameter3'].to_i == 6 #ack
log('GetLnk ACKED')
#if we get this, we should get a AllLink Record Response next
else
log('GetLnk NACKED')
# The PLM is BLANK
#have to add records to the PLM here.
cmdComplete
### FINISHED WITH GetLnk
checkChildRecordsinPLM()
SndIns()
end
when 'GetNext'
if param['Parameter3'].to_i == 6 #ack
log('sendGetNext ACKED')
#if we get this, we should get a AllLink Record Response next
else
log('sendGetNext NACKED')
#we get this when there are no more records
cmdComplete
#FINISHED with GetNext
# if we are here, we are in config mode
# so, next is to check to make sure the
# childrens insteon ID is in the PLM
checkChildRecordsinPLM()
# now, to make sure that all the records in the PLM are sensed as children

SndIns()
end

when 'SetCfg' # response from Setcfg command
if param['Parameter4'].to_i == 6 #ack
log('SetCfg Completed')
cmdComplete
SndIns()
else
log('SetCfg NACKED')
end
when 'GetLnkData'

when 'LEDON'

when 'LEDOFF'

when 'MngLnk'
if param['Parameter12'].to_i == 6
log('MngLnk => ACK')
else
log('MngLnk => NACK')
end
cmdComplete
SndIns()

when 'GetCfg' # Special Response

when 'LstMacros' # Special Response

when 'ClrMacros'

when 'AddMacro'

when 'GetMacro' # Special Response

when 'SetMacro'

when 'DelMacro'

when 'LstDevices' # Special Response

when 'ClrDevices'

when 'AddDevice'

when 'GetDevice' # Special Response

when 'SetDevice'

when 'DelDevice'

when 'LstZones'

when 'ClrZones'

when 'AddZone'

when 'GetZone'

when 'SetZone'

when 'DelZone'

when 'AddDevZone'

when 'DelDevZone'

# Response Messages
when 'InsExtMsg'

when 'InsStdMsg'
case $currentcmd # if this msg is part of a response, the Insteon Cmd1 will be saved here.
when 0x0
#log('REROUTING to processExternalCommand(param)')
processExternalCommand(param)
when 0x1 #Assign to Group
### This is a broadcast message sent
# from a PING command
# or from a StartLink...
log('Caught Assign to Group Message from Device')
### BUG HERE
#have to check flags to see if this is a broadcast message
log('Checking if this is a broadcast message')
log('Flags:' + param['Parameter9'])
if (param['Parameter9'].hex & 0x80) == 0x80
log('Message IS BROADCAST')
#recvComplete
processDeviceInfo(param)

# check to see if current cmd is for this broadcast..
log('Current Command:' + $cmdqueue[0]['Parameter5'])
if $cmdqueue[0]['Parameter5'] == '10'
#log('Clearing PING Command')
$currentcmd = 0
cmdComplete
SndIns()
else
log('CURRENT CMD IS NOT PING - NOT CLEARING')
end

else
log('Message is NOT Broadcast')
end
when 0x2 #Delete from Group
when 0x10 # PING
#this is where I catch the InsStdMsg for ping.
log('Caught PING Message from Device')
$currentcmd = 1

when 0x11 # ON
log('Caught Insteon ON from INTERNAL source')
insHb = param['Parameter3'] # From
insMb = param['Parameter4']
insLb = param['Parameter5']

insID = insHb + "." + insMb + "." + insLb
myDevFrom = $children[insID]
log('Current DIM level:' + param['Parameter11'])

reportStatus(myDevFrom, hextopercent(param['Parameter11']))

$currentcmd = 0
cmdComplete

SndIns()
when 0x13 # OFF
insHb = param['Parameter3'] # From
insMb = param['Parameter4']
insLb = param['Parameter5']
insID = insHb + "." + insMb + "." + insLb
myDevFrom = $children[insID]
reportStatus(myDevFrom, 0)

$currentcmd = 0
cmdComplete
#log('EVENT and state SENT!!!.48:[10]=0')
SndIns()
when 0x19 # Status Report
# now to clear the currentcmd and remove command from the queue
$currentcmd = 0
cmdComplete

log('Processing 0x19 Status Report')
#This is where I get the database delta (in cmd1)
insHb = param['Parameter3'] # From
insMb = param['Parameter4']
insLb = param['Parameter5']
insID = insHb + "." + insMb + "." + insLb
#First, to compare the DB Delta with current config.
#Database Delta...
delta = param['Parameter10'].to_s
log($blue + 'Database Delta=' + delta + $grey)
log($blue + 'Configuration is:' + getdeltafromconfig(insID) + $grey)
if delta == getdeltafromconfig(insID)
if $children[insID] != nil
myDevFrom = $children[insID]
myDevTo = -1000 #DCE Router
myPriority = 1
myType = 2 #Event

#Send an EVENT to report STATE ONLY if database has not changed
# AND child exists in pluto
reportStatus(myDevFrom, hextopercent(param['Parameter11']))
end
else
log('Databse CHANGED -getting remote database')
#here, I have to WIPE the databse
# to prepare it for new data
### here is where the DAMN CONFIG was reset!!!
oldconfigstring = $childdatabases[insID][0]
$childdatabases[insID] = [oldconfigstring]
log('Setting Database Config')
$childdatabases[insID][0][6..7] = delta
savechilddatabases(insID)
sendRemoteGetLink(insID)
end
# finally, to check execute next command...
SndIns()
when 0x28 # Set Address MSB
log('Received SET Address MSB from remote device')
$currentcmd = 0
$remoteLinkRecord = ''
cmdComplete
SndIns()
when 0x2B # peek
### BUG HERE... have to verify response is a PEEK command
#response command is stored in parameter10
if param['Parameter10'].hex == 0x2B # this is the peek command
cmdComplete
log('Received PEEK from remote Device! DATA=' + param['Parameter11'])
checkPeekData(param)
$currentcmd = 0
SndIns()
else
log('Waiting for remote PEEK response, but got :' + param['Parameter10'])
end
else
end

when 'X10Msg'
log($purple + 'X10 Message Received' + $grey)
if param['Parameter4'].hex == 0x00
log('This byte is a House/Unit Code')
hn = param['Parameter3'][0].chr
ln = param['Parameter3'][1].chr
$x10byte1 = $X10HouseCodes[hn]
$x10byte1 += $X10UnitCodes[ln]
log('Translated X10 House/Unit Code:' + $x10byte1)
else
log('This byte is a House/Command Code')
hn = param['Parameter3'][0].chr
ln = param['Parameter3'][1].chr
$x10byte2 = $X10HouseCodes[hn]
$x10byte2 += $X10CommandCodes[ln]
log('Translated X10 Command Code:' + $x10byte2)
log('X10 Command ready to send:' + $x10byte1 + ' ' + $x10byte2)
case $X10CommandCodes[ln]
when 'On'
#Send ON to lmnce
if $children[$x10byte1] == nil
log('I do not control this X10 device')
else
cmd = Command.new($children[$x10byte1].to_i, -1000, 1, 1, 192)
cmd.params_[120] = "1"
SendCommand(cmd)
end
when 'Off'
#Send OFF to lmnce
if $children[$x10byte1] == nil
log('I do not control this X10 device')
else
cmd = Command.new($children[$x10byte1].to_i, -1000, 1, 1, 193)
cmd.params_[120] = "1"
SendCommand(cmd)
end
when 'Bright'
if $children[$x10byte1] == nil
log('I do not control this X10 device')
else
#send a command to set the state + 1
@curstate = ($state[$x10byte1] / 100) * 32 #get equal 32 steps
$state[$x10byte1] = ((@curstate + 1) / 32) * 100
cmd = Command.new($children[$x10byte1].to_i, -1000, 1, 1, 184)
cmd.params_[76] = $state[$x10byte1].to_s
cmd.params_[120] = "1"
SendCommand(cmd)
#$state[$x10byte1] = ($state[$x10byte1] / 100) * 32
end
when 'Dim'
@curstate = ($state[$x10byte1] / 100) * 32 #get equal 32 steps
$state[$x10byte1] = ((@curstate - 1) / 32) * 100
cmd = Command.new($children[$x10byte1].to_i, -1000, 1, 1, 184)
cmd.params_[76] = $state[$x10byte1].to_s
cmd.params_[120] = "1"
SendCommand(cmd)
when 'All Lights Off'
log('ALL Lights OFF Command not implemented')
when 'All Lights On'
log('All Lights ON Command not implemented')
when 'Status Request'
log('Status Request Command not implemented')
when 'Hail Ack'
log('Hail Ack Command not implemented')
end

end
when 'InsLnkSts'
log('InsLnkSts Received')

when 'BtnRpt'
log('Button Report Received')
when 'UsrRst'
log('User Reset Response Received')
when 'GrpEvntRpt'
log('Group Event Report Received')

when 'LnkData'
processLnkData(param)
# Other messages
when 'PLMTimeout'
log('PLM Timeout detected.. resetting EZBridge')
resetcmd = {'Command' => 'Reset'}
if $wAIT == true
$cmdqueue.insert(1, resetcmd)
else
$cmdqueue.insert(0,resetcmd)
end
sleep 15
$wAIT = false
SndIns()
when 'PLMEchoError' # Have not seen this since a1.23
# error sending command to PLM, reset command and try again
log('-----XXXXXXX' + param['Response'])
resetcmd = {'Command' => 'Reset'}
if $wAIT == true
$cmdqueue.insert(1, resetcmd)
else
$cmdqueue.insert(0,resetcmd)
end

sleep 15
$wAIT = false
SndIns()
when 'LongAck'
log('-----XXXXXXX' + param['Response'])
# Error - seems to show up after PLMEchoError
resetcmd = {'Command' => 'Reset'}
if $wAIT == true
$cmdqueue.insert(1, resetcmd)
else
$cmdqueue.insert(0,resetcmd)
end
sleep 15
$wAIT = false
SndIns()
else
log('-----XXXXXXX UNKNOWN Response Received')
end

end

### Support routine for EZToDCE
def processLnkData(param)
#Caught a LnkData Response
log('LnkData Message Received')
log(param.inspect)
if param['Parameter6'] == '00' and param['Parameter7'] == '00'
log('FOUND X10 DEVICE!!!')
insteonID = padhex(param['Parameter5'])
else
insteonID = padhex(param['Parameter5']) + '.' + padhex(param['Parameter6']) + '.' + padhex(param['Parameter7'])
end
group = param['Parameter4']
recflags = param['Parameter3']
lnkdata1 = param['Parameter8']
lnkdata2 = param['Parameter9']
lnkdata3 = param['Parameter10']
#pack string to store for PLM Database
@currentrecord = recflags + group
@currentrecord += param['Parameter5'] + param['Parameter6'] + param['Parameter7']
@currentrecord += lnkdata1 + lnkdata2 + lnkdata3

#Add to plmdatabase
$plmdatabase << @currentrecord
log('record Flags:' + recflags)
#log('PLM database=' +$plmdatabase.inspect)
if (recflags[0] & 0x80) == 0x80 # Record is in use if true
end
if (recflags[0] & 0x40) == 0x40 # Controller if true
log('Controller')
else
log('Responder')
end

log('Insteon ID:' + insteonID + ', Group:' + group)

cmdComplete
sendGetNext()

end
### Support Routine for EZToDCE
def processExternalCommand(param)
#there is no current command
# THIS IS COMING FROM AN OUTSIDE SOURCE
#EG: Manually turning Light Switch On/Off
# process this command.
# Note, this is a standard message
### have to check here if child is mine!

# This is where I have to check for a broadcast command..
#if so, search the child databases for responders,
#and fire events for each responder.
#Message flag is in parameter9 Group command 0xCx (All-Link Broadcast Message Pg 42.)
#Group is in parameter8
#From InsteonID is parameters 3, 4, 5
if (param['Parameter9'].hex & 0xC0) == 0xC0 # Message is Broadcast
log('Rerouting to processBroadcastMessage')
processBroadcastMessage(param)
else
log('Process External Command:')
log('Param:' + param.inspect)

# there is no ack here. Simply Send COMMANDS back to DCE
# and Complete the recv..
case param['Parameter10'].hex #this is the command
when 0x01 #Assign to Group
log('Caught EXTERNAL Assign to Group')
processDeviceInfo(param)
recvComplete
when 0x02 #Delete from Group
log('Caught EXTERNAL Delete from Group')
recvComplete
when 0x10 # PING
log('Caught EXTERNAL Insteon PING result')
recvComplete

when 0x11 #ON
log('Caught EXTERNAL Insteon ON command result')
#on level is in cmd2
insHb = param['Parameter3'] # From
insMb = param['Parameter4']
insLb = param['Parameter5']
insID = insHb + "." + insMb + "." + insLb
log('From:' +insID)
log('Device:' + $children[insID].to_s)
myDevFrom = $children[insID]
# check to see if I own child
if myDevFrom == nil
log('I do not control this device.')
else
reportStatus(myDevFrom, hextopercent(param['Parameter11']))
$currentcmd = 0
end
recvComplete

when 0x13 #OFF
log('Caught EXTERNAL Insteon OFF result')
#on level is in cmd2
insHb = param['Parameter3'] # From
insMb = param['Parameter4']
insLb = param['Parameter5']
insID = insHb + "." + insMb + "." + insLb
myDevFrom = $children[insID]
if myDevFrom == nil
log('I do not control this device.')
else

reportStatus(myDevFrom, 0)

$currentcmd = 0
#log('EVENT and state SENT!!!.48:[10]=0')
end
recvComplete
when 0x15; log('Caught EXTERNAL Insteon Brighten Result')
when 0x16; log('Caught EXTERNAL Insteon DIM Result')
when 0x24; log('Caught EXTERNAL Insteon DO EE READ')
when 0x28; log('Caught EXTERNAL Insteon SET ADDRESS MSB')
when 0x29; log('Caught EXTERNAL Insteon POKE')
when 0x2A; log('Caught EXTERNAL Insteon POKE EXTENDED')
when 0x2B; log('Caught EXTERNAL Insteon PEEK')
when 0x2C; log('Caught EXTERNAL Insteon PEEK INTERNAL')
when 0x2D; log('Caught EXTERNAL Insteon POKE INTERNAL')
else
log('Unknown EXTERNAL Insteon Command.')
end
end
end
### Support Routine for EZToDCE
def processACK(param)
#log('In ProcessACK: Param7:' + param['Parameter7'])
#log('CurrentCmd=' + $currentcmd.to_s)
case param['Parameter7'].hex #Received an ack to THIS command
when 0x1 #Assign to Group
log('Got Assign to Group ACK')
$currentcmd = 0x01
$cmdqueue[0]['Command'] = 'InsStdMsg'
#processDeviceInfo(param)
#cmdComplete
when 0x2 #Delete from Group
when 0x10 # PING
log('Got PING ACK')
#cmdComplete
$currentcmd = 0x1
$cmdqueue[0]['Command'] = 'InsStdMsg'
when 0x11 #ON
$currentcmd = 0x11
$cmdqueue[0]['Command'] = 'InsStdMsg'
when 0x13 #OFF
$currentcmd = 0x13
$cmdqueue[0]['Command'] = 'InsStdMsg'
when 0x15 #Bright
$currentcmd = 0x15
$cmdqueue[0]['Command'] = 'InsStdMsg'
when 0x16 #DIM
$currentcmd = 0x16
$cmdqueue[0]['Command'] = 'InsStdMsg'
when 0x17 #Start Manual Change
when 0x18 #Stop Manual Change
when 0x19 #Status Request
# Status Request Acked - get ready for InsStdMsg
$currentcmd = 0x19
# change cmd to reflect InsStdMsg
$cmdqueue[0]['Command'] = 'InsStdMsg'
when 0x24
log('Caught ACK for Insteon DO EE READ')
$currentcmd = 0x24
$cmdqueue[0]['Command'] = 'InsStdMsg'
when 0x28
log('Caught ACK for Insteon SET ADDRESS MSB')
$currentcmd = 0x28
$cmdqueue[0]['Command'] = 'InsStdMsg'

when 0x29
log('Caught ACK for Insteon POKE')
$currentcmd = 0x29
$cmdqueue[0]['Command'] = 'InsStdMsg'

when 0x2A
log('Caught ACK for Insteon POKE EXTENDED')
$currentcmd = 0x2A
$cmdqueue[0]['Command'] = 'InsStdMsg'

when 0x2B
#log('Caught ACK for Insteon PEEK')
$currentcmd = 0x2B
$cmdqueue[0]['Command'] = 'InsStdMsg'

when 0x2C
log('Caught ACK for Insteon PEEK INTERNAL')
$currentcmd = 0x2C
$cmdqueue[0]['Command'] = 'InsStdMsg'

when 0x2D
log('Caught ACK for Insteon POKE INTERNAL')
$currentcmd = 0x2D
$cmdqueue[0]['Command'] = 'InsStdMsg'

else
log('Unknown Insteon Cmd1')
end
end

def checkPeekData(param)

$remoteLinkRecord += param['Parameter11'].hex.chr
log('CURRENT REMOTE RECORD IS:')
debug($remoteLinkRecord)
if $remoteLinkRecord.length == 8
log('REMOTE RECORD COMPLETE!')
processRemoteRecord(param)
$remoteLinkRecord = ''
end
end

def processRemoteRecord(param)
#have to find MY address
insHb = param['Parameter3'] # From
insMb = param['Parameter4']
insLb = param['Parameter5']
insID = padhex(insHb) + "." + padhex(insMb) + "." + padhex(insLb)

log('Processing remote Record below:')

@flags = "\nFrom Device:" + insID + "\nFlags:\n"

if ($remoteLinkRecord[0] & 0x02) == 0x02 # High water mark
@flags += "Not the last record\n"
else
@flags += "This IS the last record\n"
end

if ($remoteLinkRecord[0] & 0x80) == 0x80 # Record is in use
@flags += "Record In Use\n"
if ($remoteLinkRecord[0] & 0x40) == 0x40 # Controller/Responder
@flags += "I am a Controller of "
else
@flags += "I am a Responder of "
end
@insteonID = "%02X" %$remoteLinkRecord[2] + '.'
@insteonID += "%02X" %$remoteLinkRecord[3] + '.'
@insteonID += "%02X" %$remoteLinkRecord[4]

@group = "%X" %$remoteLinkRecord[1]
@flags += @insteonID + " Group:" + @group
@work = "%02X" %$remoteLinkRecord[0] #Control byte
@work += "%02X" %$remoteLinkRecord[1] # Group
@work += "%02X" %$remoteLinkRecord[2] # ID HB
@work += "%02X" %$remoteLinkRecord[3] # ID MB
@work += "%02X" %$remoteLinkRecord[4] # ID LB
@work += "%02X" %$remoteLinkRecord[5] # Data1
@work += "%02X" %$remoteLinkRecord[6] # Data2
@work += "%02X" %$remoteLinkRecord[7] # Data3
log('adding to:' + insID)
log('Value:' + @work)
$childdatabases[insID] << @work #add it to the database
# log('Current Database:' + $childdatabases.inspect)
#now to save the database to configuration.
savechilddatabases(insID)
# Now to check to see if the child exists as a record
if $childdatabases[@insteonID] == nil
log('InsteonID is NEW, adding Child database entry')
$childdatabases[@insteonID] = ['****************']
$rerun = true
sendAddtoPLM(@insteonID)
sendPing(@insteonID)
else
log('InsteonID:' + @insteonID.to_s + 'seems to exist in child databases')
log('CDB:' + $childdatabases.inspect)

end
else
@flags += "Record NOT in use\n"
end
log($aqua + @flags + $grey)
log2(@flags)
if ($remoteLinkRecord[0] & 0x02) == 0x02
sendRemoteGetNext(insID)
end
end

def savechilddatabases(insteonID)
#This takes the $childdatabase hash+array and encodes it to
# save it as a string.
@work = ''
#log($yellow + 'SaveChildDatabases::nitems:' + $childdatabases[insteonID].nitems.to_s)
#log($childdatabases[insteonID].inspect + $grey)
$childdatabases[insteonID].each{|record|
@work += record
}

#now to save the string...
setdeviceconfig(insteonID, @work)

end
def sendPing(insteonID)
insID = insteonID.split('.')
param = {'Command' => 'SndIns',
'Parameter1' => insID[0],
'Parameter2' => insID[1],
'Parameter3' => insID[2],
'Parameter4' => '0F',
'Parameter5' => '10', #ID Request
'Parameter6' => '00'}
$cmdqueue << param
log('PING Sent!')
end

def getdevicetemplate(cat, subcat)

log('Entered getdevicetemplate, Cat=' + cat.to_s + ', subcat = ' + subcat.to_s)
@templid = 0
case cat.hex
when 0x0 # Generalized Controllers
case subcat.hex
when 0x04; log('Found ControLinc [2430]')
when 0x05; log('Found RemoteLinc [2440]')
when 0x06; log('Found Icon Tabletop Controller [2830]')
when 0x09; log('Found SignaLinc RF Signal Enhancer [2442]')
when 0x0A; log('Found Balboa Instruments Poolux LCD Controller')
when 0x0B; log('Found Access Point [2443]')
when 0x0C; log('Found IES Color Touchscreen')
end
when 0x01 # Dimmable Lighting Control
# all these devices are associated with Template 38
# Light Switch (dimmable)
@templid = 38
case subcat.hex
when 0x00; log('Found LampLinc V2 [2456D3]')
when 0x01; log('Found SwitchLinc V2 Dimmer 600W [2476D]')
when 0x02; log('Found In-LineLinc Dimmer [2475D]')
when 0x03; log('Found Icon Switch Dimmer [2876D]')
when 0x04; log('Found SwitchLinc V2 Dimmer 1000W [2476DH]')
when 0x06; log('Found LampLinc 2-pin [2456D2]')
when 0x07; log('Found Icon LampLinc V2 2-pin [2456D2]')
when 0x09; log('Found KeypadLinc Dimmer [2486D]')
when 0x0A; log('Found Icon In-Wall Controller [2886D]')
when 0x0D; log('Found SocketLinc [2454D]')
when 0x13; log('Found Icon SwitchLinc Dimmer for Lixar/Bell Canada [2676D-B]')
when 0x17; log('Found ToggleLinc Dimmer [2466D]')
end
when 0x02 # Switched Lighting Control
# all these devices are associated with Template 37
# Light Switch (ON/OFF)
@templid = 37
case subcat.hex

when 0x09; log('Found ApplianceLinc [2456S3]')
when 0x0A; log('Found SwitchLinc Relay [2476S]')
when 0x0B; log('Found Icon On Off Switch [2876S]')
when 0x0C; log('Found Icon Appliance Adapter [2856S3]')
when 0x0D; log('Found ToggleLinc Relay [2466S]')
when 0x0E; log('Found Switchlinc Relay Countdown Timer [2476ST]')
when 0x10; log('Found In-LineLinc Relay [2475D]')
when 0x13; log('Found Icon SwitchLinc Relay for Lixar/Bell Canada [2676R-B]')
end
when 0x03 # Network Bridges
case subcat.hex
when 0x01; log('Found PowerLinc Serial [2414S]')
when 0x02; log('Found PowerLinc USB [2414U]')
when 0x03; log('Found Icon PowerLinc Serial [2814S]')
when 0x04; log('Found Icon PowerLinc USB [2814U]')
when 0x05; log('Found Smartlabs Power Line Modem Serial [2412S]')
end
when 0x04 # Irrigation Control
# all these devices are associated with Template 1780
# Standard Irrigation Sprinkler
@templid = 1780
case subcat.hex

when 0x00; log('Found Simplehomenet EZRain1 Sprinkler Controller')
end
when 0x05 # Climate Control
case subcat.hex
when 0x00; log('Found Broan SMSC080 Exhaust Fan')
when 0x01; log('Found Simplehomenet EZTherm')
when 0x02; log('Found Broan SMSC110 Exhaust Fan')
when 0x03; log('Found Venstar RF Thermostat Module')
when 0x04; log('Found Simplehomenet EZStat Thermostat')
end
when 0x06 # Pool and Spa Control
case subcat.hex
when 0x00; log('Found Simplehomenet EZPool')
end
when 0x07 # Sensors and Actuators
case subcat.hex
when 0x00
end
when 0x08 # Home Entertainment
case subcat.hex
when 0x00
end
when 0x09 # Energy Management
case subcat.hex
when 0x00
end
when 0x0A # Built-In Appliance Control
case subcat.hex
when 0x00
end
when 0x0B # Plumbing
case subcat.hex
when 0x00
end
when 0x0C # Communication
case subcat.hex
when 0x00
end
when 0x0D # Computer Control
case subcat.hex
when 0x00
end
when 0x0E # Window Coverings
case subcat.hex
when 0x00
end
when 0x0F # Access Control
case subcat.hex
when 0x00
end
when 0x10 # Security, Health, and Safety
when 0x11 # Surveillance
when 0x12 # Automotive
when 0x13 # Pet care
when 0x14 # Toys
when 0x15 # Timekeeping
when 0x16 # Holiday
end
return @templid
end

def processDeviceInfo(param)
### temporary
### 12-24-07 Adding Device Template compatibility..
#have to find MY address
insHb = param['Parameter3'] # From
insMb = param['Parameter4']
insLb = param['Parameter5']

insID = padhex(insHb) + "." + padhex(insMb) + "." + padhex(insLb)
#set the devicecat and device subcat in the childdatabases
# 0-1 Device Category
# 2-3 Device SubCategory
# 4-5 Device Firmware
log('proccessDeviceInfo:Insteon ID' + insID)
$childdatabases[insID][0][0..1] = param['Parameter6']
$childdatabases[insID][0][2..3] = param['Parameter7']
$childdatabases[insID][0][4..5] = param['Parameter8']
savechilddatabases(insID)
log('InsteonID: ' + insID)
#log('Child Config AFTER update:' + $childdatabases[insID][0].to_s)
log($yellow)
@template = getdevicetemplate(param['Parameter6'], param['Parameter7'])
$devicetemplate[insID] = @template
log('Template ID:' + @template.to_s)
### eventually, open a XML configuration script?
### or read saved data from mysql?
### most likely save this information to sql with device.
### eventually, IPKDB will be available to ping.
log('for Insteon ID:' + insID)
log($grey)
end

def recvComplete
# Clears the wait flag, but does not remove a command from the queue
$wAIT = false
log($green + "Receive Completed. Checking command queue" + $grey)
if $cmdqueue.nitems > 0 then
log("Queue:" + $aqua + $cmdqueue.nitems.to_s + $grey + " : executing next command")
SndIns()
else
log($yellow + 'Queue Empty.' + $grey)
if $rerun
log('RERUN=TRUE, RESTARTING')
$rerun = false
mainRestart()
else
log('RERUN Not needed. Checking if reported..')
#report Child devices here.
if not $reported
log('Reporting Child Devices')
@work = ""
$childdatabases.each{
|insteonID,value|
log('Child:' + insteonID)
log('Config:' + value.inspect)
@template = $devicetemplate[insteonID]
@work += insteonID + "\t\t\t" + @template.to_s + "\t\n"
}
log(@work)
cmd = Command.new(device_.devid_, -1001, 1, 2, 54)
cmd.params_[13] = @work
SendCommand(cmd)

$reported = true
else
log('report not needed')
end
end

end
end
def removecurrentcommand
#get the current child
log('in RemoveCurrentCommand')
log('Current Command:' + $cmdqueue[0].inspect)
#id is in param123
@id = $cmdqueue[0]['Parameter1']
@id += '.' + $cmdqueue[0]['Parameter2']
@id += '.' + $cmdqueue[0]['Parameter3']
log('ID=' + @id)
#now to remove from child and PLM databases
removefromchild(@id)
removefromplm(@id)
cmdComplete
end
def cmdComplete
# Clears the wait flag, and removes the command from the queue.
$wAIT = false
$resetNext = 0
$cmdqueue.delete_at(0)
# now that THAT command is completed, check to see if there is
# another command ready to transmit.
log($green + "Command Completed." + $grey)
end
def checkWait(param)
#Checks for response from current command.
if $cmdqueue[0] != nil
if $wAIT == true
#log('CW:waiting for command to complete')
else
#log('CW:reports clear')
end
else
log('------:)----checkWait: command queue is emtpy')
if $wAIT == true #this should never happen
log('------:(XXX-CheckWait: TRUE')
end
end
end

def plmparse(value)
#THIS ROUTINE REPLACES parsestring()
#this routine will PARSE the incoming stream into valid messages
# value is the complete command
param = {}
#here is a special case, the PLM seems to lock up.
if value == 0x15.chr
log('The PLM stopped responding')
log('Please unplug it, and plug it back in')
log('and do a quick reload router.')

end
while value.length > 2
case value[1]
when 0x62 # Special case, need to look at flags
if (value[5] & 0x10) == 0x10 # check for extended flag
cmdlen = 23
else
cmdlen = 9
end
param['Response'] = 'SndIns'
when 0x50; cmdlen = 11; param['Response'] = 'InsStdMsg'
when 0x51; cmdlen = 25; param['Response'] = 'InsExtMsg'
when 0x68; cmdlen = 4 #Set Insteon ACK Message Byte
when 0x71; cmdlen = 5 #Set Insteon ACK Message Two Bytes
when 0x70; cmdlen = 4 #Set Insteon NACK Message Byte
when 0x63; cmdlen = 5; param['Response'] = 'SndX10'
when 0x52; cmdlen = 4; param['Response'] = 'X10Msg'
when 0x61; cmdlen = 6; param['Response'] = 'SndGrp'
when 0x56; cmdlen = 7; param['Response'] = 'GrpEvntRpt'
when 0x58; cmdlen = 3 #All-Link Cleanup Status Report
when 0x64; cmdlen = 5; param['Response'] = 'StLnk'
when 0x65; cmdlen = 3; param['Response'] = 'CancelLnk'
when 0x53; cmdlen = 10; param['Response'] = 'InsLnkSts'
when 0x69; cmdlen = 3; param['Response'] = 'GetLnk'
when 0x6A; cmdlen = 3; param['Response'] = 'GetNext'
when 0x6C; cmdlen = 3 #Get All-Link Record for Sender
when 0x57; cmdlen = 10; param['Response'] = 'LnkData'
when 0x6F; cmdlen = 12; param['Response'] = 'MngLnk'
when 0x67; cmdlen = 3; param['Response'] = 'RstPLM'
when 0x6B; cmdlen = 4; param['Response'] = 'SetCfg'
when 0x60; cmdlen = 9; param['Response'] = 'GetVersion'
when 0x66; cmdlen = 6 #Set Host Device Category
when 0x72; cmdlen = 3 # RF Sleep
when 0x54; cmdlen = 3; param['Response'] = 'BtnRpt'
when 0x6D; cmdlen = 3; param['Response'] = 'LEDON'
when 0x6E; cmdlen = 3; param['Response'] = 'LEDOFF'
else

log('ERROR IN PLMPARSE- Unknown Command')
debug(value)

return ''
end

#Now we know the length the command should be, see if we have it.
#log('waiting for ' + cmdlen.to_s + ' characters...')
#log('length of current input is ' + value.length.to_s)
if value.length >= cmdlen
#log('GOT whole response')
#Yes, we have the whole command, Pack it in param
for byt in 1..cmdlen
param['Parameter' + byt.to_s] = "%02X" %value[byt - 1]
end
#now remove it from the string..
value = value.slice(cmdlen, value.length - cmdlen)
#Send it off for parsing
#log('Sending to EZToDCE:' + param.inspect.to_s)
EZToDCE(param)
else
#log('Still waiting...')
#no, we have NOT received the whole command.

end
end
return value
end

def rawX10(value)

x10MSN = $X10HouseCodes.index[value[0..0]]
x10LSN = $X10UnitCodes.index[value[1..1]]
return x10MSN + x10LSN
end

def X10Flag(value)
return + $X10CommandCodes.index[Value] + '0'
end

def SndIns
# create a new PLM command for SndIns
if not $wAIT
#log('SndIns:currentcmd=' + $currentcmd.to_s)

if $cmdqueue.nitems > 0
log("SndIns:Queue:" + $aqua + $cmdqueue.nitems.to_s + $grey)
#log('SndIns:' + $cmdqueue.inspect)
param = $cmdqueue[0]
### have to figure out the command byte 2 here
work = '02'.hex.chr + plmcommand(param)
### PLM command compilation
for loop in 2..param.keys.nitems
@dummy = param['Parameter' + (loop - 1).to_s].to_s
work+= @dummy.hex.chr
end
conn_.Reconnect()
debugout(work)
conn_.Send(work)
#sleep 0.1
$wAIT = TRUE
else
log($yellow + 'Queue Empty.' + $grey)
if $rerun
log('RERUN=TRUE, RESTARTING')
$rerun = false
mainRestart()
else
log('RERUN Not needed')
if not $reported
log('Reporting Child Devices')
@work = ""
$childdatabases.each{
|insteonID,value|
log('Child:' + insteonID)
log('Config:' + value.inspect)
@template = $devicetemplate[insteonID]
@work += insteonID + "\t\t\t" + @template.to_s + "\t\n"
}
log(@work)
cmd = Command.new(device_.devid_, -1001, 1, 2, 54)
cmd.params_[13] = @work
SendCommand(cmd)

$reported = true
else
log('report not needed')
end
end

end
else
log('X-----------SndIns: Waiting for response to:' + $cmdqueue[0]['Command'].to_s)
log('X-----------SndIns: Current Queue Length:' + $cmdqueue.nitems.to_s)
end
end
def plmcommand(param)
### this returns the proper Byte2 for the command.
case param['Command']
when 'GetVersion'; return 0x60.chr
when 'SndIns'; return 0x62.chr
when 'SndGrp'; return 0x61.chr
when 'SndX10'; return 0x63.chr
when 'GetLnk'; return 0x69.chr
when 'GetNext'; return 0x6A.chr
when 'BtnRpt'; return 0x54.chr
when 'GetCfg'; return 0x73.chr
when 'StLnk'; return 0x64.chr
when 'CancelLnk'; return 0x65.chr
when 'MngLnk'; return 0x6F.chr
when 'RstPLM'; return 0x67.chr
when 'SetCfg'; return 0x6B.chr
when 'LEDON'; return 0x6D.chr
when 'LEDOFF'; return 0x6E.chr
## hack
when 'InsStdMsg'
log('ERROR:PLMCommand encountered a COMMAND of INSSTDMSG')
break
return 0x62.chr
end
end

def debug(text)
work = 'DEBUG:'

for c in 1..text.length
work += "%02X" %text[c-1] + ' '
end
log($yellow + work + "Length:" + text.length.to_s + $grey)
end
def debugout(text)
work = 'out:'

for c in 1..text.length
work += "%02X" %text[c-1] + ' '
end
log($green + work + "Length:" + text.length.to_s + $grey)
end
def debugin(text)
work = 'IN:'

for c in 1..text.length
work += "%02X" %text[c-1] + ' '
end
log($red + work + "Length:" + text.length.to_s + $grey)
end

def padhex(hex)
if hex.length==1
hex = "0" + hex
end
return hex
end

def percenttohex(level)
# convert from percent to byte
return "%X" %(level.to_i * 2.55).to_i
end

def hextopercent(level)
return (level.hex.to_i / 2.55).to_i
end

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
def log2(line)
#this will send a message out the the orbiters..
#/usr/pluto/bin/MessageSend localhost 0 20 1 809 9 "Text to Display" 70 "alert" 182 "30" 251 "??"
cmd = Command.new(device_.devid_, -1000, 1, 1, 809)
cmd.params_[9] = line #text to display
cmd.params_[70] = 'PLMMessage' #Token
cmd.params_[182] = '10' #Timeout in seconds
cmd.params_[251] = '??'
SendCommand(cmd)
end
def checkChildRecordsinPLM()
log('Entered CheckChildRecordsinPLM')
# log('In CheckChildRecordsinPLM')
# time to verify all children are in the PLM
#
# log('Total PLM Records:' + $plmdatabase.nitems.to_s)
$plmdatabase.each{|record|
log('Record: = '+ getIIDfromRecord(record) + ' Group:' + getGroupfromRecord(record))
log('checking to see if it needs to be added as a child...')
if not existsinchild(getIIDfromRecord(record))

log(getIIDfromRecord(record) + ' needs to be added to the child database')
addtochild(getIIDfromRecord(record))
end
}

$childdatabases.each {|child,value|
if not existsinplm(child)
log(child + ' needs to be added to PLM')
sendAddtoPLM(child)
else
log(child + ' exists in PLM')
end

#now to scan the childs database
for record in 1..(value.nitems - 1)
@test = value[record]
if not existsinplm(getIIDfromRecord(@test))
log(getIIDfromRecord(@test) + ' needs to be added to PLM')
sendAddtoPLM(getIIDfromRecord(@test))
else
log(getIIDfromRecord(@test) + ' exists in PLM')
end
#Also check to see if it needs to be added in the childdatabases
end
}

end
def existsinplm(insteonid)
result = false
$plmdatabase.each{|record|
#log(insteonid + '==' + getIIDfromRecord(record))
if insteonid == getIIDfromRecord(record)
result = true
end
}
return result
end
def existsinchild(insteonid)
log('ExistsinChild:InsteonID:' + insteonid)
result = $childdatabases.keys.include?(insteonid)
log('ExistsinChild result:FALSE') if not result
log('ExistsinChild result:TRUE') if result
return result
end
def addtochild(insteonID)
log('addtochild Routne called')
log('Adding ' + insteonID + ' to the child database...')
if insteonID.length == 2 then
log('Child is X10')
$state[insteonID] = 0
else
log('Child is Insteon')
$childdatabases[insteonID] = ['****************']
sendPing(insteonID)
$rerun = true
end
end
def removefromchild(insteonID)
log('Removing ' + insteonID + ' from child database')
$childdatabases.delete(insteonID)
$state.delete(insteonID)
end
def removefromplm(insteonID)
log('Removing from plm')
$plmdatabase.each{|record|
#log(insteonid + '==' + getIIDfromRecord(record))
if insteonID == getIIDfromRecord(record)
debug(record)
log('Found Record, Deleting')
$plmdatabase.delete(record)

#now, we have to remove it from the device.
param = {'Command' =>'MngLnk',
'Parameter1' => '80', #DELETE
'Parameter2' => record[0..1], #control byte
'Parameter3' => record[2..3], #group
'Parameter4' => record[4..5],#HB
'Parameter5' => record[6..7],#MB
'Parameter6' => record[8..9],#LB
'Parameter7' => record[10..11],#data1
'Parameter8' => record[12..13],#data2
'Parameter9' => record[14..15] #data3

}
log(param.inspect)
$cmdqueue << param
end
}
end
def sendAddtoPLM(insteonID)
log('Adding ' + insteonID + ' to the PLM database...')
#This adds a record into the PLM
@insID = insteonID.split('.')
param = {'Command' => 'MngLnk',
'Parameter1' => '40', #control code -- add new record as Controller
'Parameter2' => 'C2', #All Link Record Flags AKA Record Control Byte
'Parameter3' => '01', #All Link Group
'Parameter4' => @insID[0], #HB
'Parameter5' => @insID[1], #MB
'Parameter6' => @insID[2], #LB
'Parameter7' => '01', #Link Data 1 ON-Level
'Parameter8' => '01', #Link Data 2 Ramp Rate
'Parameter9' => 'FF'} #Link Data 3 not used
if $wAIT
$cmdqueue.insert(1, param)
else
$cmdqueue.insert(0, param)
end

SndIns()
end

def getIIDfromRecord(recordstring)
#this extracts the insteonID string from the record.
#log('getIIDfromRecord::recordstring:' + recordstring)
@idhb = recordstring[4..5]
@idmb = recordstring[6..7]
@idlb = recordstring[8..9]
@result = @idhb + '.' + @idmb + '.' +@idlb
#log('GetIIDfromRecord: Found ID:' + @result)
return @result
end

def processBroadcastMessage(param)
#search the child databases for responders,
#and fire COMMANDS for each responder. 06Feb08
#and fire events for each responder.XXXXXXXXXXXXX
#Message flag is in parameter9 Group command 0xCx (All-Link Broadcast Message Pg 42.)
#Group is in parameter8
#From InsteonID is parameters 3, 4, 5
group = param['Parameter8']
from = padhex(param['Parameter3']) + '.'
from += padhex(param['Parameter4']) + '.'
from += padhex(param['Parameter5'])
log('Looking for ' + from + ' Group:' + group)
#Ok, now have to search child databases for from AND group AND responder
$childdatabases.each{|child,value|
#log('Searching:' + child)
for rec in 1..(value.nitems - 1)
record = value[rec]
if getIIDfromRecord(record) == from # First, look for Insteon ID
#log('Found ID')
if getGroupfromRecord(record) == group #next, Group
#log('Found Group')
if isResponderRecord(record) # is a responder?
#log('Found Responder')
#figure out the child devicenum
from = $children[child]
#figure out the command
case param['Parameter10'].hex
when 0x11 #on
reportStatus(from, 100)
when 0x13 #off
reportStatus(from, 0)
when 0x17 #dim/brighten -ignore
level = 0
when 0x18 # STOP dim/brighten - sendgetstatus
level = 0
sendGetChildStatus(child)
else
level = 0
log('Command is other than ON/OFF/Dim/Brighten')
end
end
end
end
end
}
end

def reportStatus(from, level)
log('From:' + from.to_s)
log('current State:' + $state[from].to_s)
log('Wanted State:' + level.to_s)
case $state[from]
when 0
if level >=1
cmd = Command.new(from, from, 1, 1, 192) #on
cmd.params_[120] = "1"
SendCommand(cmd)
cmd = Command.new(from, from, 1, 1, 184)
cmd.params_[76] = level.to_s
cmd.params_[120] = "1"
SendCommand(cmd)
end
when 100
if level >= 1
cmd = Command.new(from, from, 1, 1, 184)
cmd.params_[76] = level.to_s
cmd.params_[120] = "1"
SendCommand(cmd)
else
cmd = Command.new(from, from, 1, 1, 193) # off
cmd.params_[120] = "1"
SendCommand(cmd)
end
else
if level == 100
cmd = Command.new(from, from, 1, 1, 193) #off
cmd.params_[120] = "1"
SendCommand(cmd)
cmd = Command.new(from, from, 1, 1, 192) # on
cmd.params_[120] = "1"
SendCommand(cmd)
end
cmd = Command.new(from, from, 1, 1, 184) #SetLevel
cmd.params_[76] = level.to_s
cmd.params_[120] = "1"
SendCommand(cmd)
end
log('ReportStatus: device:' + from.to_s + ' Status:' + level.to_s)
$state[from] = level

end

def isResponderRecord(recordstring)
work = recordstring[0..1].hex
if (work & 0x40) == 0x40 #check bit 6
result = false #signifies Controller record
else
result = true #signifies Responder record
end
return result
end

def getGroupfromRecord(recordstring)
#this extracts the GROUP from the record.
if recordstring == nil
return '00'
else
return recordstring[2..3]
end
end
def getdeltafromconfig(insteonID)
#This returns the delta from the child.
@work = $childdatabases[insteonID][0] # the settings stored in [0]
if @work == nil
return '00'
else
return @work[6..7]
end
end
def sendGetChildStatus(insteonID)
#log('sendGetChildStatus Called')
if insteonID.length != 2 #X10 device
@insID = insteonID.split('.')
param = {'Command' => 'SndIns',
'Parameter1' => @insID[0],
'Parameter2' => @insID[1],
'Parameter3' => @insID[2],
'Parameter4' => '0F', #flags
'Parameter5' => '19', #Status Request
'Parameter6' => '00'} #not used.
$cmdqueue << param
SndIns()
#Returned response will have cmd1 = DBDelta
#Returned response will have cmd2 = ON-Level
else
log('X10 does not report status')
end
end

# time to define a structure to save the raw data in hex
# starts at [0]
# Bytes Meaning
# 0-1 Device Category
# 2-3 Device SubCategory
# 4-5 Device Firmware
# 6-7 Database Delta
# 8-9 reserved
# 10-11 reserved
# 12-13 reserved
# 14-15 reserved
###### First database record below (in same format its read from the device)
###### This is the same format as an ALL-Link Record Response from the PLM
###### (0x57) bytes 3..10
# 16-17 record control byte
# 18-19 Group
# 20-21 ID HB
# 22-23 ID MB
# 24-25 ID LB
# 26-27 Link Specific Data1
# 28-29 Link Specific Data2
# 30-31 Link Specific Data3
######
# 32-47 next database record...

</pre>

D-Link DCS-5300G

2010-01-27T08:47:39Z

Newacct:

[[Category: Cameras]]
[[Category: IP Cameras]]

[[Image:D-link-dcs-5300g.jpg|right]]
[[Image:DCS-70.jpg|right]]

= Status =
The D-Link DCS-5300G device template can be derived from the Panasonic IP Camera. A initial version can be found in the testing sqlCVS repository. It is fully plug and play and supports pan and tilt.

= Features =
* Browser based
* PAN Range +/- 135°, TILT Range +90°/ -45°
* 802.11g WLAN (2 antennas with RP-SMA connector)
* 10/100mbit LAN
* 2x I/O Port, 1x Sensor Input, 1x Relay Output
* 1x mic input, 1x A/V Connector
* 30fps max
* active motion detector
* MPEG4 compression
* UPnP, DynDNS
* Real-Time Live Video & Audio Streaming
* compatible with DCS-70 outdoor mount

= Ruby Code =
<pre>
RCODE:
0:require 'Ruby_Generic_Serial_Device'
1:class Command < Ruby_Generic_Serial_Device::RubyCommandWrapper
2:end
3:class Device_95 < Ruby_Generic_Serial_Device::RubySerialIOWrapper
4:#### 84 ####################################################################
5:def cmd_84(data, format, disable_aspect_lock, streamid, width, height, cmd=nil)
6:@returnParamArray.clear
7:conn_.Reconnect()
8:auth_s=device_.devdata_[114]+":"+device_.devdata_[115]
9:auth_a=Array.new;
10:auth_s.each{|c| auth_a.push(c)}
11:
12:fix_path=device_.devdata_[2]
13:fix_path='/'+fix_path if fix_path[0]!='/'[0]
14:
15:s = "GET "+fix_path+" HTTP/1.0\r\n"
16:s+= "Accept: */*\r\n"
17:s+= "Authorization: Basic "+auth_a.pack("m").chop+"\r\n"
18:s+= "\r\n"
19:
20:conn_.Send(s)
21:recv=""
22:loop do
23: buff=conn_.Recv(16384, 5000)
24: if buff.empty?
25: break
26: end
27: recv += buff
28:end
29:if recv=~ /^HTTP[^\r\n]+200\sOK.+?\r\n\r\n(.+)$/m
30: fileName="/tmp/ip_camera_img"+device_.devid_.to_s
31: imageFile=File.new(fileName+".jpg",'w')
32: imageFile.print $1
33: imageFile.close()
34: system("/usr/bin/convert "+fileName+".jpg "+fileName+".png");
35: size=File.stat(fileName+".png").size
36: imageFile=File.new(fileName+".png",'r')
37: img = imageFile.read(size);
38: imageFile.close()
39: data_set(img)
40: format_set('png')
41:end
42:return @returnParamArray
43:end
44:#### 200 ####################################################################
45:def cmd_200(cmd=nil)
46:@returnParamArray.clear
47:conn_.Reconnect()
48:auth_s=device_.devdata_[114]+":"+device_.devdata_[115]
49:auth_a=Array.new;
50:auth_s.each{|c| auth_a.push(c)}
51:s = "GET /cgi-bin/camctrl.cgi?move=up HTTP/1.0\r\n"
52:s+= "Accept: */*\r\n"
53:s+= "Authorization: Basic "+auth_a.pack("m").chop+"\r\n"
54:s+= "\r\n"
55:
56:conn_.Send(s)
57:recv=""
58:loop do
59:buff=conn_.Recv(256, 5000)
60:if buff.empty?
61:break
62:end
63:recv += buff
64:end
65:return @returnParamArray
66:end
67:#### 201 ####################################################################
68:def cmd_201(cmd=nil)
69:@returnParamArray.clear
70:conn_.Reconnect()
71:auth_s=device_.devdata_[114]+":"+device_.devdata_[115]
72:auth_a=Array.new;
73:auth_s.each{|c| auth_a.push(c)}
74:s = "GET /cgi-bin/camctrl.cgi?move=down HTTP/1.0\r\n"
75:s+= "Accept: */*\r\n"
76:s+= "Authorization: Basic "+auth_a.pack("m").chop+"\r\n"
77:s+= "\r\n"
78:
79:conn_.Send(s)
80:recv=""
81:loop do
82:buff=conn_.Recv(256, 5000)
83:if buff.empty?
84:break
85:end
86:recv += buff
87:end
88:return @returnParamArray
89:end
90:#### 202 ####################################################################
91:def cmd_202(cmd=nil)
92:@returnParamArray.clear
93:conn_.Reconnect()
94:auth_s=device_.devdata_[114]+":"+device_.devdata_[115]
95:auth_a=Array.new;
96:auth_s.each{|c| auth_a.push(c)}
97:s = "GET /cgi-bin/camctrl.cgi?move=left HTTP/1.0\r\n"
98:s+= "Accept: */*\r\n"
99:s+= "Authorization: Basic "+auth_a.pack("m").chop+"\r\n"
100:s+= "\r\n"
101:
102:conn_.Send(s)
103:recv=""
104:loop do
105:buff=conn_.Recv(256, 5000)
106:if buff.empty?
107:break
108:end
109:recv += buff
110:end
111:return @returnParamArray
112:end
113:#### 203 ####################################################################
114:def cmd_203(cmd=nil)
115:@returnParamArray.clear
116:conn_.Reconnect()
117:auth_s=device_.devdata_[114]+":"+device_.devdata_[115]
118:auth_a=Array.new;
119:auth_s.each{|c| auth_a.push(c)}
120:s = "GET /cgi-bin/camctrl.cgi?move=right HTTP/1.0\r\n"
121:s+= "Accept: */*\r\n"
122:s+= "Authorization: Basic "+auth_a.pack("m").chop+"\r\n"
123:s+= "\r\n"
124:
125:conn_.Send(s)
126:recv=""
127:loop do
128: buff=conn_.Recv(256, 5000)
129: if buff.empty?
130: break
131: end
132: recv += buff
133:end
134:return @returnParamArray
135:end
136:#### START SETTERS ####################################################################
137:def initialize()
138:super
139:@returnParamArray=Array.new
140:end
141:def data_set(value)
142:@returnParamArray[19]=value
143:end
144:def format_set(value)
145:@returnParamArray[20]=value
146:end
147:#### END SETTERS ####################################################################
148:end
</pre>

Generic Serial Device

2010-01-27T08:44:25Z

Newacct:

{| align="right"
| __TOC__
|}
[[Category: Programmer's Guide]]
[[Category: Serial]]
[[Category: GSD]]

Generic_Serial_Device (also known as '''GSD''') is a LinuxMCE device that allows end-user to do simple programming for RS232, serial USB (See [[Serial Hack]] for details on getting USB to serial adapters identified properly in the admin panel!) or network connected devices.
:Note : The information is not quite complete because I'm not the original author.

== Short description ==
It's a standard DCE device, it only can execute commands and send events .
The main idea is instead of programming a device in C++, compile, link with proper libraries you can edit (in a webpage) few lines of code in ruby which will be executed when device receives that command. It exports several objects into ruby so you'll have access to devicedata, device hierarchy, established connection and so on.

The ruby code for each device template is stored somewhere in ''InfraredGroup_Command'' table. To edit the code go to Wizard> Devices > Generic_Serial_Devices on [[LinuxMCE-admin]] website. You have to add a device from a device template in order to see anything in that page.

Select the device, and click "RubyCodes" button to be able to edit code that will be executed.
You should be able to see commands that are specified in device template (like ON/OFF/WhateverElse) and a group of ''Internal Commands'' which are used to perform certain actions are to add helper functions.

If the command you are trying to add doesn't show on first page, go to ''Add/Remove commands'' and add more commands for your device.

=== Ruby source code ===

There are 2 forms of ruby code you can write :
* standard ruby code (check [http://www.ruby-lang.org/en/] and [http://poignantguide.net/ruby/] for syntax, references and programming guides)
* short form for '''conn_.Send'''
<$"PWON\r"$>
:which simply will send the string ''"PWON\r"'' to device.

You'll have to quick reload router to get new code. Restarting GSD only will keep old code because the code is supplied by [[Infrared_Plugin]] which caches pluto_main and won't update it's cache without full restart of [[DCERouter]]. With this code it creates a ruby source which will be interpreted by embedded ruby.

It will create methods called "cmd_CmdIDx" for each command(x) defined in web interface except ''Private_Method_Listing'' which will be inserted in the body of the class directly without wrapping.

The source usually looks like (''DevID'' is iPK_Device of specific device, ''CmdIDx'' is iPK_Command ) :

require 'Ruby_Generic_Serial_Device'
class Command < Ruby_Generic_Serial_Device::RubyCommandWrapper
end
class Device_DevID < Ruby_Generic_Serial_Device::RubySerialWrapper
def cmd_CmdID1(paramlist)
@returnParamArray.clear
### WEB CODE for CmdID1 GOES HERE ###
return @returnParamArray
end
def cmd_CmdID2(paramlist)
@returnParamArray.clear
### WEB CODE for CmdID2 GOES HERE ###
return @returnParamArray
end
...
def cmd_ReceiveCommandForChild(cmd)
### Process_Receive Command_For_Child GOES HERE ###
end
...
### Private_Method_Listing GOES HERE ###
...
def initialize()
super
@returnParamArray=Array.new
end
### Generated Setters/Getters goes here (may be empty, but usually looks like below) ###
def data_set(value)
@returnParamArray[19]=value
end

end

There might be more then one class definition in that source. This may happen when child device is itself a GSD device.

=== Command details ===
When the command from DCE arrives it is routed to specific device and ''cmd_XXX'' is run. The commands are run one by one, meaning that you cannot run 2 commands simultaneously. This limitation is implied by embedded ruby interpretor which fails if run from multiple threads.
DCE commands may have return parameters (well known GetVideoFrame), as ruby can return only 1 parameter the ''@returnParamArray'' was added. You can see that in each method we insert '''@returnParamArray.clear''' then the real code and then '''return @returnParamArray'''. Also some setters are generated (like the one from above) for code readability.

Beside usual DCE command you'll see some ''Internal Commands''. Here goes a small list and what they do:
* '''Private Method Listing''' - used to insert all kind of helpers
* '''Process IDLE''' - method executed once in a while (may be used to keep connection alive, scan for new devices on serial bus)
* '''Process Incoming Data''' - called when some data is available
* '''Process Receive Command For Child''' - called if the device has children and those are pretty dummy (like Lights under CM11), so practically the parent will do the job. As a parameter you have ''cmd'' which is a wrapper for DCEMessage, so you'll have access to deviceId, senderId, commandID and so on.
* '''Process Initialize''' - called when device is starting (to perform handshake with device or some other initialisation required by protocol)
* '''Process Release''' - to close gracefully connection with device (say "good bye" or something)

== Implementation notes ==
There are several classes that actually need to be touched. Most of the other classes are just for wrapping DCE objects (like Device, Message, Connection and so on) and exporting them into ruby.

Most important classes :
* '''RubyDCEDeviceNode''' is actually the Device, responsable with initialisation and partially a message handler.
* '''RubyDCEEmbededClass''' is bridge between DeviceNode and ruby, it has ''CallCmdHandler'' which does the real call to ruby and sends back result.
* '''RubyIOManager''' is the one responsible for instantiating RubyDCEDeviceNodes, code retrieval, command handler and serializing ruby calls.
* '''RubyDCECodeSupplier''' gives you the ruby code
* '''RubyCommandWrapper''' a wrapper for Message
* '''GSDMessageProcessing''' is [[Message_Translation|message translator]] which will try to run command if it's implemented without translation.
* '''RubySerialIOConnectionWrapper''' helps to wrap Serial and TCP/IP based connection under same interface, see down the hierarchy the connection you need.

There are also some files needed for building a library for ruby with SWIG, let them alone, it should work.

The compilation will give you '''Generic_Serial_Device''' and '''Ruby_Generic_Serial_Device.so''', first file is the binary itself, second file is the bridge library and it will be included by ruby (the request for it is in the first line of the generated source)

== Known issues ==

* Only '''ONE''' command can be executed at a time. This is a limitation of embedded ruby, which should be run from one thread only.
* If command expected an answer, it would wait about 20 seconds for the ruby command to complete, and if the command haven't completed yet, it would send an empty response.
* Most of the data are pretty cryptic (like ''device_.devdata_[114]''), you have to look that that number represents (device data id, command id, command parameter id, event id, event parameter id, some other id)

== Short example ==
For more details about exported classes and available methods check [[GSD_Ruby_Interface]]

Here is a short example from ''Panasonic IP Camera'':
0:require 'Ruby_Generic_Serial_Device'
1:class Command < Ruby_Generic_Serial_Device::RubyCommandWrapper
2:end
3:class Device_47 < Ruby_Generic_Serial_Device::RubySerialWrapper
4:#### 84 ####################################################################
5:def cmd_84(data, format, disable_aspect_lock, streamid, width, height)
6:@returnParamArray.clear
7:conn_.Reconnect()
8:auth_s=device_.devdata_[114]+":"+device_.devdata_[115]
9:auth_a=Array.new;
10:auth_s.each{|c| auth_a.push(c)}
11:
12:fix_path=device_.devdata_[2];
13:fix_path='/'+fix_path if fix_path[0]!='/'[0];
14:
15:s = "GET "+fix_path+" HTTP/1.0\r\n"
16:s+= "Accept: */*\r\n"
17:s+= "Authorization: Basic "+auth_a.pack("m").chop+"\r\n"
18:s+= "\r\n"
19:
20:conn_.Send(s)
21:recv=""
22:loop {
23: buff=conn_.Recv(16384, 5000)
24: if buff.empty?
25: break
26: end
27: recv += buff
28:}
29:if recv=~ /^HTTP[^\r\n]+200\sOK.+?\r\n\r\n(.+)$/m
30: data_set($1)
31: format_set('jpg')
32:end
33:return @returnParamArray
34:end
...
194:#### START SETTERS ####################################################################
195:def initialize()
196:super
197:@returnParamArray=Array.new
198:end
199:def data_set(value)
200:@returnParamArray[19]=value
201:end
202:def format_set(value)
203:@returnParamArray[20]=value
204:end
205:#### END SETTERS ####################################################################
206:end
You can see how command 84 (GetVideoFrame) is implemented:
* it has 6 parameters ''cmd_84(data, format, disable_aspect_lock, streamid, width, height)'', parameters ''data'' and ''format'' are also output parameters
* to set output parameters methods like ''data_set'' and ''format_set'' are automatically generated
* ''device_.devdata_[114]'', ''device_.devdata_[115]'' are the username and password to login into camera
* then it creates HTTP header with basic authorization
* ''device_.devdata_[2]'' is the path to the snapshot (it is configurable because it can change between models)
* it sends the request and waits for the answer
* reads the answer, regexp parse it and gets JPEG content
* sets output parameters
* returns @returnParamArray (the return statement is added automatically)

== Example - Adding Clipsal Interface ==

We can control lights, curtains and climate controls using Clipsal Interface that connects through Serial Port.

[[Here is a detailed example of how to add Clipsal Interface using Generic Serial Device.|Adding Clipsal Interface using Generic Serial Device]]

== Useful Pages ==
* [[Serial Hack]] - A quick and dirty hack to fix the USB to Serial adapter problem! (Device not showing the correct block device on the admin panel)
* [[How to add your own GSD device]]