LogicMachine als Gateway zu RESOL über VBus-Protokoll

LogicMachine als Gateway zu RESOL über VBus-Protokoll

Beschreibung

Example: LogicMachine as gateway to RESOL via VBus protocol

Task

This examples will show how to integrate RESOL solar automation solution into common KNX/ModBus/BACnet/EnOCean/DALI visualization through LogicMachine.
For integration you need to have VBus LAN adapter connected to your RESOL system.
Direct commands are not yet implemented in this example.

User Libraries

Add the following scripts in Scripting –> User libraries.

luavbuspacket.lua

  1. local luavbuspacket = {}
  2. luavbuspacket_mt = { __index = luavbuspacket }
  3.  
  4. luavbuspacket.srcAddress = 0 -- source address (2 byte)
  5. luavbuspacket.dstAddress = 0 -- destination address (2 byte)
  6. luavbuspacket.protoVersion = 1 -- protocol version 0x10 o 0x20 or 0x30 (1 byte)
  7. --- packet version
  8. luavbuspacket.version = 0 -- version (1 byte)
  9. luavbuspacket.command = 0 -- command (2 bytes)
  10. luavbuspacket.payloads = 0 -- number of payloads (2 bytes)
  11. luavbuspacket.payloadsData = nil -- 4-byte payloads
  12. luavbuspacket.dataPointID = nil -- ID of the data point (2 bytes)
  13. luavbuspacket.dataPointValue = nil -- value of data point ( 4 bytes)
  14. luavbuspacket.checksum = 0 -- CRC (1 bytes)
  15. luavbuspacket.profile = nil -- vbus profile
  16. luavbuspacket.profileData = nil -- vbus profile data
  17.  
  18.  
  19.  
  20. luavbuspacket.mt = {} -- metatable
  21.  
  22. --- Creates a new instance of luavbuspacket
  23. -- @author Luca Palazzo
  24. -- @return instance of luavbuspacket
  25. -- 
  26. function luavbuspacket.new ( o )
  27.   luavbuspacket.log ( DEBUG3, string.format ( "luavbuspacket.new( %s )", o ) )
  28.   local _vp = o or {}
  29.   luavbuspacket.log ( DEBUG4, string.format ( "luavbuspacket.new(): %s", _vp ) )
  30.  
  31.   setmetatable(_vp, luavbuspacket_mt )
  32.   luavbuspacket_mt.__tostring = luavbuspacket.tostring
  33.   return _vp
  34. end
  35.  
  36. --- Stringify luavbuspacket object. Use in __tostring metatable field too
  37. -- @author Luca Palazzo
  38. -- @param packet the instance of luavbuspacket to stringify
  39. -- @return string-fied version of luavbuspacket
  40. function luavbuspacket.tostring( packet )
  41.   luavbuspacket.log ( DEBUG3, "luavbuspacket.tostring( packet )" )
  42. --  if ( packet == nil or packet.srcAddress == nil ) then
  43. --    return "nil packet"
  44. --  end
  45.   vbus_packet_string = string.format( "VBus frame source address 0x%04x destination address  0x%04x version 0x%02x command 0x%02x checksum 0x%04x payloads %d", packet.srcAddress, packet.dstAddress, packet.version, packet.command, packet.checksum, packet.payloads ) 
  46.   luavbuspacket.log ( DEBUG3,  vbus_packet_string )
  47.   return vbus_packet_string
  48. end
  49.  
  50. function luavbuspacket.profileprint( packet )
  51.   luavbuspacket.log ( DEBUG3, "luavbuspacket.profilestring( packet )" )
  52.   vbus_packet_string = ""
  53.   if ( packet == nil ) then
  54.     return "no packet"
  55.   end
  56.  
  57.   if ( packet.profile == nil ) then
  58.     return "no profile"
  59.   end
  60.  
  61.   if ( packet.profile.objects == nil ) then
  62.     return "no objects"
  63.   end
  64.  
  65.   for k, v in pairs( packet.profile.objects ) do
  66.     local offset = tonumber(v[1])
  67.     local length = tonumber(v[2])
  68.     local unknown = tonumber(v[3])
  69.     local name = v[4]
  70.     local factor = tonumber(v[5])
  71.     local unit = v[6]
  72.     if (unit==nil) then
  73.       unit = ""
  74.     end
  75.     luavbuspacket.log( DEBUG4, string.format ("Offset %d length %d", offset, length ) )
  76.  
  77.     local value = 0
  78.     packet_length = string.len(packet.payloadsData)
  79.     -- PacketDump(data)
  80.     for index = 1, length, 1 do
  81.       if ( offset+index > packet_length ) then
  82.         luavbuspacket.log ( DEBUG3, string.format ("Buffer overrun (length %d)", packet_length ) )
  83.         break
  84.       end
  85.       luavbuspacket.log ( DEBUG4, string.format ("Getting byte %d at offset %d with value 0x%02x", index, offset, packet.payloadsData:byte(offset+index) ) )
  86.       -- print ("Adding "..data:byte(offset+index+1)*(256^index))
  87.       value = value + packet.payloadsData:byte(offset+index)*(256^(index-1))
  88.       -- print ( "Value: " .. value .. " index " .. index )
  89.     end
  90.  
  91.  
  92.     luavbuspacket.log ( DEBUG2, string.format ("luavbus:packetParseV1(): name %s Value %02.2f %s", name, value*factor, unit ) )
  93.     vbus_packet_string = vbus_packet_string .. string.format ("%s: %02.2f %s ", name, value*factor, unit )
  94.  
  95.   end
  96. --  vbus_packet_string = string.format( "VBus frame source address 0x%04x destination address  0x%04x version 0x%02x command 0x%02x checksum 0x%04x", packet.srcAddress, packet.dstAddress, packet.version, packet.command, packet.checksum ) 
  97.   luavbuspacket.log ( DEBUG4,  vbus_packet_string )
  98.   return vbus_packet_string
  99. end
  100.  
  101. function luavbuspacket.getProfileData( self )
  102.   luavbuspacket.log ( DEBUG3, "luavbuspacket.getProfileData()" )
  103.  
  104.   if ( self.profile == nil ) then
  105.     luavbuspacket.log ( WARN, "Packet ha no profile" )
  106.     return nil
  107.   end
  108.  
  109.   self.profileData = {}
  110.  
  111.   for k, object in pairs( self.profile.objects ) do    
  112.     local offset = tonumber(object[1])
  113.     local length = tonumber(object[2])
  114.     local unknown = tonumber(object[3])
  115.     local name = object[4]
  116.     local factor = tonumber(object[5])
  117.     local unit = object[6]
  118.     local value = 0
  119.  
  120.     if (unit==nil) then
  121.       unit = ""
  122.     end
  123.     luavbuspacket.log( DEBUG4, string.format ("Offset %d length %d", offset, length ) )
  124.  
  125.     packet_length = string.len(self.payloadsData)
  126.     for index = 1, length, 1 do
  127.       if ( offset+index > packet_length ) then
  128.         luavbuspacket.log ( WARN, string.format ("Buffer overrun (length %d)", packet_length ) )
  129.         break
  130.       end
  131.       luavbuspacket.log ( DEBUG2, string.format ("Getting byte %d at offset %d with value 0x%02x", index, offset, self.payloadsData:byte(offset+index) ) )
  132.       -- print ("Adding "..data:byte(offset+index+1)*(256^index))
  133.       value = value + self.payloadsData:byte(offset+index)*(256^(index-1))
  134.       -- print ( "Value: " .. value .. " index " .. index )
  135.     end
  136.     data = {}
  137.     data.name = name
  138.     data.factor = factor
  139.     data.unit = unit
  140.     data.value = value*factor
  141.     table.insert(self.profileData, data)
  142.     luavbuspacket.log ( DEBUG2, string.format ("luavbuspacket.getProfileData(): name %s value %.02f",data.name, data.value ) )
  143.  
  144.   end
  145. end
  146.  
  147. function luavbuspacket.log ( level, ... )
  148.   local prefix = ""
  149.   local log_string = ""
  150.   if ( log_level ~= nil and level ~= nil and level <= log_level ) then
  151.     if ( level == ERR ) then
  152.       log_string = "ERROR"
  153.     elseif ( level == WARN ) then
  154.       log_string = "WARN"
  155.     elseif ( level == INFO ) then
  156.       log_string = "INFO"  
  157.     elseif ( level == DEBUG1 ) then
  158.       log_string = "DEBUG1"
  159.     elseif ( level == DEBUG2 ) then
  160.       log_string = "DEBUG2"
  161.     elseif ( level == DEBUG3 ) then
  162.       log_string = "DEBUG3"
  163.     elseif ( level == DEBUG4 ) then
  164.       log_string = "DEBUG4"
  165.     elseif ( level == DEBUG5 ) then
  166.       log_string = "DEBUG5"
  167.     else
  168.       log_string = "UNKNOWN"
  169.     end
  170.     print ( log_string .. ": " .. ... )
  171.   end
  172. end
  173.  
  174. return luavbuspacket

vbusprofiles.lua you define your device profiles as you wish

  1. vbusprofiles = {}
  2.  
  3. vbusprofiles[0] =
  4. '{ 
  5.   "id": "0x7E11", 
  6.   "name": "DeltaSol MX [Controller]", 
  7.   "objects": [ 
  8.     [ 0, 2, 0, "Temperature sensor 1", 0.1, "В°C" ], 
  9.     [ 2, 2, 0, "Temperature sensor 2", 0.1, "В°C" ], 
  10.     [ 4, 2, 0, "Temperature sensor 3", 0.1, "В°C" ], 
  11.     [ 6, 2, 0, "Temperature sensor 4", 0.1, "В°C" ], 
  12.     [ 8, 2, 0, "Temperature sensor 5", 0.1, "В°C" ], 
  13.     [ 10, 2, 0, "Temperature sensor 6", 0.1, "В°C" ], 
  14.     [ 12, 2, 0, "Temperature sensor 7", 0.1, "В°C" ], 
  15.     [ 14, 2, 0, "Temperature sensor 8", 0.1, "В°C" ], 
  16.     [ 16, 2, 0, "Temperature sensor 9", 0.1, "В°C" ], 
  17.     [ 18, 2, 0, "Temperature sensor 10", 0.1, "В°C" ], 
  18.     [ 20, 2, 0, "Temperature sensor 11", 0.1, "В°C" ], 
  19.     [ 22, 2, 0, "Temperature sensor 12", 0.1, "В°C" ], 
  20.     [ 24, 2, 0, "Temperature sensor 13", 0.1, "В°C" ], 
  21.     [ 26, 2, 0, "Temperature sensor 14", 0.1, "В°C" ], 
  22.     [ 28, 2, 0, "Temperature sensor 15", 0.1, "В°C" ], 
  23.     [ 30, 2, 0, "Irridiation sensor 16", 1, "W/mВІ" ], 
  24.     [ 32, 2, 0, "Temperature sensor 17", 0.1, "В°C" ], 
  25.     [ 34, 2, 0, "Temperature sensor 18", 0.1, "В°C" ], 
  26.     [ 36, 2, 0, "Temperature sensor 19", 0.1, "В°C" ], 
  27.     [ 38, 2, 0, "Temperature sensor 20", 0.1, "В°C" ], 
  28.     [ 40, 4, 0, "Volume flow rate sensor 13", 1, "l/h" ], 
  29.     [ 44, 4, 0, "Volume flow rate sensor 14", 1, "l/h" ], 
  30.     [ 48, 4, 0, "Volume flow rate sensor 15", 1, "l/h" ], 
  31.     [ 52, 4, 0, "Volume flow rate sensor 17", 1, "l/h" ], 
  32.     [ 56, 4, 0, "Volume flow rate sensor 18", 1, "l/h" ], 
  33.     [ 60, 4, 0, "Volume flow rate sensor 19", 1, "l/h" ], 
  34.     [ 64, 4, 0, "Volume flow rate sensor 20", 1, "l/h" ], 
  35.     [ 68, 2, 0, "Pressure sensor 17", 0.01, "bar" ], 
  36.     [ 70, 2, 0, "Pressure sensor 18", 0.01, "bar" ], 
  37.     [ 72, 2, 0, "Pressure sensor 19", 0.01, "bar" ], 
  38.     [ 74, 2, 0, "Pressure sensor 20", 0.01, "bar" ], 
  39.     [ 76, 1, 0, "Pump speed relay 1", 1, "%" ], 
  40.     [ 77, 1, 0, "Pump speed relay 2", 1, "%" ], 
  41.     [ 78, 1, 0, "Pump speed relay 3", 1, "%" ], 
  42.     [ 79, 1, 0, "Pump speed relay 4", 1, "%" ], 
  43.     [ 80, 1, 0, "Pump speed relay 5", 1, "%" ], 
  44.     [ 81, 1, 0, "Pump speed relay 6", 1, "%" ], 
  45.     [ 82, 1, 0, "Pump speed relay 7", 1, "%" ], 
  46.     [ 83, 1, 0, "Pump speed relay 8", 1, "%" ], 
  47.     [ 84, 1, 0, "Pump speed relay 9", 1, "%" ], 
  48.     [ 85, 1, 0, "Pump speed relay 10", 1, "%" ], 
  49.     [ 86, 1, 0, "Pump speed relay 11", 1, "%" ], 
  50.     [ 87, 1, 0, "Pump speed relay 12", 1, "%" ], 
  51.     [ 88, 1, 0, "Pump speed relay 13", 1, "%" ], 
  52.     [ 89, 1, 0, "Pump speed relay 14", 1, "%" ], 
  53.     [ 90, 2, 0, "Unknown", 1 ], 
  54.     [ 92, 4, 0, "System date", 1 ], 
  55.     [ 96, 4, 0, "Error mask", 1 ] 
  56.   ] 
  57. }'
  58.  
  59. return vbusprofiles

Resident program

  1. for _, searcher in ipairs(package.searchers or package.loaders) do
  2.   name = "luavbus"
  3.   local loader = searcher(name)
  4.   if type(loader) == 'function' then
  5.     package.preload[name] = loader
  6.     vbus  = require (name)
  7.     break
  8.   end
  9.   name = "user.luavbus"
  10.   local loader = searcher(name)
  11.   if type(loader) == 'function' then
  12.     package.preload[name] = loader
  13.     vbus  = require (name)
  14.     break
  15.   end     
  16. end
  17.  
  18. log_level = WARN
  19. if ( vbus == nil ) then
  20.   log ( "VBus modules not available")
  21.  
  22. end
  23. vbus.new(nil, TCPIP, "vbus" )
  24.  
  25. vbus.remote_host = "192.168.168.19"
  26. vbus.remote_port = "7053"
  27. vbus.password = "vbus"
  28.  
  29. vbus:connect()
  30.  
  31. -- filter = { srcAddress = 0x7e11, dstAddress = 0x0010 }
  32. -- filter = { command = 0x200 }
  33.  
  34. packets = vbus:waitData(filter, 30 )
  35.  
  36. if (packets ~= nil ) then
  37.   log( string.format ( "Returned %d packets", #packets ) )
  38.   for key, packet in pairs(packets) do
  39.     -- print ( string.format ( "Packet: %s", packet ) )
  40.     -- print ( packet:profileprint() )
  41.     if ( packet.profileData ~= nil) then
  42.       for k, data in pairs ( packet.profileData ) do
  43.         if ( data.factor < 1 ) then
  44.           log( string.format ( "Name %s Value %.02f %s", data.name, data.value, data.unit ) )
  45.         else 
  46.           log( string.format ( "Name %s Value %d %s", data.name, data.value, data.unit ) )                  
  47.         end
  48.       end
  49.  
  50.     end
  51.   end
  52. else
  53.   log( "No packet!!!")
  54. end

 
Please consult LogicMachine forum VBus thread for more functionality and updated scripts.

 
Created by Luca Palazzo