Luup Somfy Walkthrough - Revision history

A-lurker: /* Step 4: Test the port */

2014-02-02T21:55:40Z

‎Step 4: Test the port

Guessed: /* Step 5: Create the child devices for the blinds */ Add the other reference to D_BinaryLight1.xml

2012-05-30T05:49:04Z

‎Step 5: Create the child devices for the blinds: Add the other reference to D_BinaryLight1.xml

Mcvflorin: /* Step 5: Create the child devices for the blinds */

2012-05-28T07:55:24Z

‎Step 5: Create the child devices for the blinds

Micasaverde: /* Step 1: SSH into Vera */

2012-05-08T15:16:45Z

‎Step 1: SSH into Vera

Guessed: /* Step 5b: Polish up the startup sequence */ Line wrap

2011-09-05T15:45:57Z

‎Step 5b: Polish up the startup sequence: Line wrap

Guessed: Syntax color the Lua code, fix a few typo's

2011-09-04T22:41:38Z

Syntax color the Lua code, fix a few typo's

Show changes

Mcvflorin: /* Step 2b: Add your device by building the XML files by hand */

2011-06-03T09:50:30Z

‎Step 2b: Add your device by building the XML files by hand

Mcvflorin: /* Step 2b: Add your device by building the XML files by hand */

2011-06-03T09:47:20Z

‎Step 2b: Add your device by building the XML files by hand

Mcvflorin: /* Step 2b: Add your device by building the XML files by hand */

2011-06-03T09:46:21Z

‎Step 2b: Add your device by building the XML files by hand

Mcvflorin: /* Step 2b: Add your device by building the XML files by hand */

2011-06-03T09:36:40Z

‎Step 2b: Add your device by building the XML files by hand

@@ Line 101: / Line 101: @@
 In the 'Code' input box, type: ''luup.io.write('!01U')'' and click 'Go'.  That is a command according to the Somfy specs, which should make motor #1 go up.  You can try other commands and click 'Go' each time.  If everything is working ok, skip to step 6.  If it's not working, you will want to do some debugging.  Here's some debug things to try:
-.  Be sure you checked 'Verbose logging' in Step 1. In your ssh console (ie putty if you're using windows) enter ''tail -f LuaUPnP.log | grep '^5\|^01' '' where the | means to send the output through the grep utility, which will filter out only certain lines.  The ^ means 'lines that start with'.  Line that start with 5 are logs related to Lua, and lines that start with 01 are critical errors.  The \| means 'or' for grep.  Now go back and click 'go' again in the Test Luup window.  Return to the ssh console and you should see a line that starts with 51, which means data sent within Luup, that shows !01U, in this format: ''51      06/29/09 17:19:53.453   0x21 0x30 0x31 0x55 0xd 0xa (!01U\r\n)'', where the human-readable ascii text is in () at the end, following the binary/hex.  If you're going to be switching back and forth between the ssh console and web ui to do tests, then before you switch to the web ui, you can either hit 'enter' a few times in the ssh console to add some blank space, or press Ctrl+c and then 'up' followed by 'enter' to restart tail.  That way you've created some separation between existing log entries and new ones so you can clearly see what is happening when you click 'go'.  If you're not seeing anything, in the Test Luup window add the line ''lu_log('test somfy')'' above the luup.io.write.  You should see 'test somfy' get logged when you press 'go'.
+.  Be sure you checked 'Verbose logging' in Step 1. In your ssh console (ie putty if you're using windows) enter ''tail -f LuaUPnP.log | grep '^5\|^01' '' where the | means to send the output through the grep utility, which will filter out only certain lines.  The ^ means 'lines that start with'.  Line that start with 5 are logs related to Lua, and lines that start with 01 are critical errors.  The \| means 'or' for grep.  Now go back and click 'go' again in the Test Luup window.  Return to the ssh console and you should see a line that starts with 51, which means data sent within Luup, that shows !01U, in this format: ''51      06/29/09 17:19:53.453   0x21 0x30 0x31 0x55 0xd 0xa (!01U\r\n)'', where the human-readable ascii text is in () at the end, following the binary/hex.  If you're going to be switching back and forth between the ssh console and web ui to do tests, then before you switch to the web ui, you can either hit 'enter' a few times in the ssh console to add some blank space, or press Ctrl+c and then 'up' followed by 'enter' to restart tail.  That way you've created some separation between existing log entries and new ones so you can clearly see what is happening when you click 'go'.  If you're not seeing anything, in the Test Luup window add the line ''luup.log('test somfy')'' above the luup.io.write.  You should see 'test somfy' get logged when you press 'go'.
 .  Assuming you do see the line '51' log entry showing that the Luup engine is trying to send data, you may want to check the serial port itself.  You can go back to the 'serial port configuration' and remove the 'Somfy blind' device from the serial port so the Luup engine won't open the port.  Make a note of the network ip and port for the serial port.  Click 'Save' to save your changes.  Now from a command prompt run: ''telnet [ip] [port]''.  If you don't have telnet, open another putty session and click the 'telnet' radio box, put in the ip address and port and click 'open'. You should now be able to type the commands in the telnet session: ''!01U'' and see the blinds work.  If it still doesn't work, try connecting the blinds directly to your PC and using a terminal program, like Hyperterminal, to talk directly to the serial port and confirm the connections are ok.

@@ Line 199: / Line 199: @@
       if (string.find(lul_ID,s) ~= nil) then
         luup.log("Adding blind " .. s)
-        luup.chdev.append(lul_device, child_devices, s, "Blind #" .. s, "urn:schemas-upnp-org:device:BinaryLight:1", "", "", "", false)
+        luup.chdev.append(lul_device, child_devices, s, "Blind #" .. s, "urn:schemas-upnp-org:device:BinaryLight:1", "D_BinaryLight1.xml", "", "", false)
       end
     end

@@ Line 156: / Line 156: @@
        s = string.format("%02d", i)
        luup.log("Adding blind " .. s)
-       luup.chdev.append(lul_device, child_devices, s, "Blind #" .. s, "urn:schemas-upnp-org:device:BinaryLight:1", "", "", "", true)
+       luup.chdev.append(lul_device, child_devices, s, "Blind #" .. s, "urn:schemas-upnp-org:device:BinaryLight:1", "D_BinaryLight1.xml", "", "", true)
      end

@@ Line 21: / Line 21: @@
 Once you have a root password set, you will no longer be able to use telnet to login to Vera, you must use ssh.  The reason you should use ssh to login for debugging, and not telnet, is because some of the useful key sequences, like Ctrl+C, don't work in telnet.
-Once you've setup a root password, from a Mac or Linux console type: ''ssh [ip of vera]''  From a Windows PC, download putty.exe here: [http://www.chiark.greenend.org.uk/~sgtatham/putty/download.html].  You don't need to install putty, just put the .exe on your desktop or in a folder.  When you run putty.exe, type in Vera's IP address and click 'open'.
+Once you've setup a root password, from a Mac or Linux console type: ''ssh [ip of vera]''  From a Windows PC, download putty.exe here: [http://www.chiark.greenend.org.uk/~sgtatham/putty/download.html].  You don't need to install putty, just put the .exe on your desktop or in a folder.  When you run putty.exe, type in Vera's IP address and click 'open'.  If you don't see the root password or need help logging in see [[Logon_Vera_SSH#Can.27t_find_the_root_password.3F|Logon # Can't find the root password?]].
 When you see ''login as:'', enter: ''root'' and then enter your password.  Now from the ''root@HomeControl:#'' prompt type:

@@ Line 270: / Line 270: @@
        if (string.find (lul_ID,s) ~= nil) then
          luup.log("Adding blind " .. s)
-         luup.chdev.append(lul_device, child_devices, s, "Blind #" .. s, "urn:schemas-micasaverde-com:device:WindowCovering:1", "D_WindowCovering1.xml", "", "", false)
+         luup.chdev.append(lul_device, child_devices, s, "Blind #" .. s,
        end
      end

@@ Line 46: / Line 46: @@
 ''S_SwitchPower1.xml'' because when you open D_BinaryLight1.xml, you'll see that in the 'services' section, this is the filename (SCPDURL) for the SwitchPower service.
-[[Media:D_TestSerial.xml | ''D_TestSerial.xml'']] because this is a sample serial device we can use as a template.
+[[Media:D_TestSerial.zip | ''D_TestSerial.xml'']] because this is a sample serial device we can use as a template.
-[[Media:I_TestSerial.xml | ''I_TestSerial.xml'']] because this is a sample implementation for our serial device.
+[[Media:I_TestSerial.zip | ''I_TestSerial.xml'']] because this is a sample implementation for our serial device.
 Open D_TestSerial.xml in your text editor and re-save it as a different name, such as D_SomfyBlinds.xml. Change the xml field deviceType to "urn:somfy-com:device:blinds:1" or use your own domain name instead of somfy-com. Change friendlyName to "Somfy Blind Controller", manufacturer to "Somfy", manufacturerURL to "somfy.com", modelDescription to "16 port RS232 to Somfy blind interface", modelName to "1810686" (the Somfy part number). modelURL and serialNumber and UPC aren't really important so you can just remove them. Add in their place a protocol tag with the value 'raw', and handlechildren (we'll explain this one later) with the value 1, like this:

@@ Line 46: / Line 46: @@
 ''S_SwitchPower1.xml'' because when you open D_BinaryLight1.xml, you'll see that in the 'services' section, this is the filename (SCPDURL) for the SwitchPower service.
-[:File:D_TestSerial.xml|''D_TestSerial.xml''] because this is a sample serial device we can use as a template.
+[[:File:D_TestSerial.xml | ''D_TestSerial.xml'']] because this is a sample serial device we can use as a template.
-[:File:I_TestSerial.xml|''I_TestSerial.xml'' because this is a sample implementation for our serial device.
+[[:File:I_TestSerial.xml | ''I_TestSerial.xml'']] because this is a sample implementation for our serial device.
 Open D_TestSerial.xml in your text editor and re-save it as a different name, such as D_SomfyBlinds.xml. Change the xml field deviceType to "urn:somfy-com:device:blinds:1" or use your own domain name instead of somfy-com. Change friendlyName to "Somfy Blind Controller", manufacturer to "Somfy", manufacturerURL to "somfy.com", modelDescription to "16 port RS232 to Somfy blind interface", modelName to "1810686" (the Somfy part number). modelURL and serialNumber and UPC aren't really important so you can just remove them. Add in their place a protocol tag with the value 'raw', and handlechildren (we'll explain this one later) with the value 1, like this:

@@ Line 36: / Line 36: @@
    --coming soon.  for now use step 2b.
-==Step 2b: Add your device by building the XML files by hand==
+== Step 2b: Add your device by building the XML files by hand ==
-To do this you'll want a good text editor.  I'm using, such as Notepad++ available here: [http://notepad-plus.sourceforge.net/uk/site.htm] by clicking Download, Download Notepad++ executable files, download and run the npp....Installer.exe file, and you may also want to download the 'XML plugin' from the download page, and unzip it putting the file \Program Files\Notepad++\plugins.
+To do this you'll want a good text editor. I'm using, such as Notepad++ available here: [http://notepad-plus.sourceforge.net/uk/site.htm] by clicking Download, Download Notepad++ executable files, download and run the npp....Installer.exe file, and you may also want to download the 'XML plugin' from the download page, and unzip it putting the file \Program Files\Notepad++\plugins.
 In Vera's setup UI, go to Devices, Luup plugins, click 'Luup files' and download the files:
 ''D_BinaryLight1.xml'' since there is no UPnP device specification for blinds, and blinds are essentially binary devices that are either up/down, we can implement the up/down using the same service that a light switch uses, and that way any UPnP control point that can control a light switch, will also be able to control blinds.
 ''S_SwitchPower1.xml'' because when you open D_BinaryLight1.xml, you'll see that in the 'services' section, this is the filename (SCPDURL) for the SwitchPower service.
-''D_TestSerial.xml'' because this is a sample serial device we can use as a template.
+[:File:D_TestSerial.xml|''D_TestSerial.xml''] because this is a sample serial device we can use as a template.
-''I_TestSerial.xml'' because this is a sample implementation for our serial device.
+[:File:I_TestSerial.xml|''I_TestSerial.xml'' because this is a sample implementation for our serial device.
-Open D_TestSerial.xml in your text editor and re-save it as a different name, such as D_SomfyBlinds.xml.  Change the xml field deviceType to "urn:somfy-com:device:blinds:1" or use your own domain name instead of somfy-com.  Change friendlyName to "Somfy Blind Controller", manufacturer to "Somfy", manufacturerURL to "somfy.com", modelDescription to "16 port RS232 to Somfy blind interface", modelName to "1810686" (the Somfy part number).  modelURL and serialNumber and UPC aren't really important so you can just remove them.  Add in their place a protocol tag with the value 'raw', and handlechildren (we'll explain this one later) with the value 1, like this:
+Open D_TestSerial.xml in your text editor and re-save it as a different name, such as D_SomfyBlinds.xml. Change the xml field deviceType to "urn:somfy-com:device:blinds:1" or use your own domain name instead of somfy-com. Change friendlyName to "Somfy Blind Controller", manufacturer to "Somfy", manufacturerURL to "somfy.com", modelDescription to "16 port RS232 to Somfy blind interface", modelName to "1810686" (the Somfy part number). modelURL and serialNumber and UPC aren't really important so you can just remove them. Add in their place a protocol tag with the value 'raw', and handlechildren (we'll explain this one later) with the value 1, like this:
-   <protocol>raw</protocol>
+   &lt;protocol&gt;raw&lt;/protocol&gt;
-  <handleChildren>1</handleChildren>
+ &lt;handleChildren&gt;1&lt;/handleChildren&gt;
-The 'raw' protocol is because the Somfy device doesn't have any particular low level protocol, like terminating blocks of data with a carriage return, etc.  Remove all the tags in 'servicelist'.
+The 'raw' protocol is because the Somfy device doesn't have any particular low level protocol, like terminating blocks of data with a carriage return, etc. Remove all the tags in 'servicelist'.
 Change the filename in the ''implementationFile'' tag from I_TestSerial.xml to I_SomfyBlinds.xml.
-Open I_TestSerial.xml and delete the sample Lua code within the 'actionList' tag.  We have to put some Lua code in the implementation file for the Luup engine to start it, so for now just put a placeholder in the 'functions' xml tag:
+Open I_TestSerial.xml and delete the sample Lua code within the 'actionList' tag. We have to put some Lua code in the implementation file for the Luup engine to start it, so for now just put a placeholder in the 'functions' xml tag:
   function lug_startup(lul_device)
-  lu_log("Somfy blind #" .. lul_device .. " starting up with ID " .. lug_device[lul_device].ID)
+ lu_log("Somfy blind #" .. lul_device .. " starting up with ID " .. lug_device[lul_device].ID)
   end
 and in the 'startup' xml tag, put: ''lug_startup'', like this:
-  <startup>lug_startup</startup>
+  &lt;startup&gt;lug_startup&lt;/startup&gt;
-So we've created a Lua function, lug_startup, told the Luup engine to call it when the engine is starting up.  The name lug_startup is arbitrary, it can be anything you want.  Save the file as I_SomfyBlinds.xml.
+So we've created a Lua function, lug_startup, told the Luup engine to call it when the engine is starting up. The name lug_startup is arbitrary, it can be anything you want. Save the file as I_SomfyBlinds.xml.
-Back on Vera's setup ui under 'Luup files' you the first 'upload' button to upload D_SomfyBlinds.xml and the 2nd to upload I_SomfyBlinds.xml.  Check ''Restart Luup after upload'' because the files won't be processed unless we restart the Luup engine, and click 'go'.  Now leave your browser tab open at this page so that as we change the implementation file we can just click 'go' without having to select the files again.
+Back on Vera's setup ui under 'Luup files' you the first 'upload' button to upload D_SomfyBlinds.xml and the 2nd to upload I_SomfyBlinds.xml. Check ''Restart Luup after upload'' because the files won't be processed unless we restart the Luup engine, and click 'go'. Now leave your browser tab open at this page so that as we change the implementation file we can just click 'go' without having to select the files again.
-In another browser tab go to Vera's device page again and under 'Add device' put the new device filename ''D_SomfyBlinds.xml'' in the input box, and choose the room where the blind controller is located, click 'Add device'.  You'll have a new, blank device in that room, so give it a description "Somfy Blind Controller", then click 'save'.
+In another browser tab go to Vera's device page again and under 'Add device' put the new device filename ''D_SomfyBlinds.xml'' in the input box, and choose the room where the blind controller is located, click 'Add device'. You'll have a new, blank device in that room, so give it a description "Somfy Blind Controller", then click 'save'.
-Note that if the Somfy device was bi-direction we should attempt to communicate with it during the startup sequence and the startup function should return false if the sequence failed, or true if it succeeded, followed by some comments and the name of the module, which information is shown to the user in the info panel.  So: return false,'Interface not responding','Somfy Blind' or return true,'Initialized OK','Somfy Blind'
+Note that if the Somfy device was bi-direction we should attempt to communicate with it during the startup sequence and the startup function should return false if the sequence failed, or true if it succeeded, followed by some comments and the name of the module, which information is shown to the user in the info panel. So: return false,'Interface not responding','Somfy Blind' or return true,'Initialized OK','Somfy Blind'
 ==Step 3: Setup the port==