somfy_sdn 1.0.7 → 1.0.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4edace9439651dd89a2c7618a03ae5b6ac9d4ccdf8101ac597eca8f5e66bacf9
-  data.tar.gz: 4ecefc5e15483f4b97169f3a0e8939297c1bdd4cdbe909a2388806feaa0bbac7
+  metadata.gz: 66516a3bb03695b73075a496a791502683ec12052219a5cf040cfe6e9f82b04f
+  data.tar.gz: bad8e87688534b118e679b4126490f5eab3c6e83ee7288184368e852bf0cc450
 SHA512:
-  metadata.gz: e515961e3b633fd7d02879b4d907d76a7bacde2e91f20ddb90893d676e88657f89f912dd645a7e32f9cc166641ae86b816f2dbe96ea1eb702922c51a3bc1b697
-  data.tar.gz: 5825179cad7e2dd32af3a9bbca82cf706dbd0e38b10fe0a756241f8e28e954b414a37fe1a80fa0a84e0586f515b379d27a6b0ab013e9a77a71519924ae68e4a0
+  metadata.gz: db18252c03d784aeb3461dacffc16dae04aeb176f5b98f3b796d395f95980350576075a434794e16347eef7bfb308eccf7e4307abeceb4675254a3505d74b60d
+  data.tar.gz: e17af388921091abe51a23b6fcef7c3bf0d402ad55446bfc86aa698482a22cca341f7612b73d04e97ad91e060ff13f7573016e4ddb7aca24002c69f1ee9706b9

data/lib/sdn.rb

@@ -0,0 +1,6 @@
+require 'sdn/message'
+require 'sdn/mqtt_bridge'
+
+module SDN
+  BROADCAST_ADDRESS = [0xff, 0xff, 0xff]
+end

data/lib/sdn/message.rb

@@ -3,7 +3,7 @@ require 'sdn/messages/helpers'
 module SDN
   class MalformedMessage < RuntimeError; end
 
-  class Message  
+  class Message
     class << self
       def parse(data)
         offset = -1
@@ -11,7 +11,7 @@ module SDN
         # we loop here scanning for a valid message
         loop do
           offset += 1
-          return nil if data.length - offset < 11
+          return [nil, 0] if data.length - offset < 11
           msg = to_number(data[offset])
           length = to_number(data[offset + 1])
           ack_requested = length & 0x80 == 0x80
@@ -39,9 +39,14 @@ module SDN
         reserved = to_number(data[offset + 2])
         src = transform_param(data.slice(offset + 3, 3))
         dest = transform_param(data.slice(offset + 6, 3))
-        result = message_class.new(reserved: reserved, ack_requested: ack_requested, src: src, dest: dest)
-        result.parse(data.slice(offset + 9, length - 11))
-        result.msg = msg if message_class == UnknownMessage
+        begin
+          result = message_class.new(reserved: reserved, ack_requested: ack_requested, src: src, dest: dest)
+          result.parse(data.slice(offset + 9, length - 11))
+          result.msg = msg if message_class == UnknownMessage
+        rescue ArgumentError => e
+          puts "discarding illegal message #{e}"
+          result = nil
+        end
         [result, offset + length]
       end
     end
@@ -72,10 +77,13 @@ module SDN
       length |= 0x80 if ack_requested
       result = transform_param(self.class.const_get(:MSG)) + transform_param(length) + result
       result.concat(checksum(result))
-      puts "wrote #{result.map { |b| '%02x' % b }.join(' ')}"
       result.pack("C*")
     end
 
+    def ==(other)
+      self.serialize == other.serialize
+    end
+
     def inspect
       "#<%s @reserved=%02xh, @ack_requested=%s, @src=%s, @dest=%s%s>" % [self.class.name, reserved, ack_requested, print_address(src), print_address(dest), class_inspect]
     end

data/lib/sdn/messages/control.rb

@@ -27,17 +27,17 @@ module SDN
      end
 
      def direction=(value)
-        raise ArgumentError, "direction must be one of :down, :up, or :cancel" unless DIRECTION.keys.include?(value)
+        raise ArgumentError, "direction must be one of :down, :up, or :cancel (#{value})" unless DIRECTION.keys.include?(value)
         @direction = value
      end
 
      def duration=(value)
-        raise ArgumentError, "duration must be in range 0x0a to 0xff" unless value || value >= 0x0a && value <= 0xff
+        raise ArgumentError, "duration must be in range 0x0a to 0xff (#{value})" unless value && value >= 0x0a && value <= 0xff
         @duration = value
      end
 
      def speed=(value)
-        raise ArgumentError, "speed must be one of :up, :down, or :slow" unless SPEED.keys.include?(value)
+        raise ArgumentError, "speed must be one of :up, :down, or :slow (#{value})" unless SPEED.keys.include?(value)
         @speed = speed
       end
 

data/lib/sdn/messages/ilt2/get.rb

@@ -0,0 +1,9 @@
+module SDN
+  class Message
+    module ILT2
+      class GetMotorPosition < SimpleRequest
+        MSG = 0x44
+      end
+    end
+  end
+end

data/lib/sdn/messages/ilt2/post.rb

@@ -0,0 +1,18 @@
+module SDN
+  class Message
+    module ILT2
+      class PostMotorPosition < Message
+        MSG = 0x64
+        PARAMS_LENGTH = 3
+  
+        attr_accessor :position_pulses, :position_percent
+  
+        def parse(params)
+          super
+          self.position_pulses = to_number(params[0..1])
+          self.position_percent = to_number(params[2]).to_f / 255 * 100
+        end
+      end
+    end
+  end
+end

data/lib/sdn/messages/ilt2/set.rb

@@ -0,0 +1,59 @@
+module SDN
+  class Message
+    module ILT2
+      class SetMotorPosition < Message
+        MSG = 0x54
+        PARAMS_LENGTH = 3
+        TARGET_TYPE = {
+          up_limit: 1,
+          down_limit: 2,
+          stop: 3,
+          ip: 4,
+          next_ip_up: 5,
+          next_ip_down: 6,
+          jog_up: 10,
+          jog_down: 11,
+          position_percent: 16,
+        }.freeze
+
+        attr_reader :target_type, :target
+
+        def initialize(dest = nil, target_type = :up_limit, target = 0, **kwargs)
+          kwargs[:dest] ||= dest
+          super(**kwargs)
+          self.target_type = target_type
+          self.target = target
+        end
+
+        def parse(params)
+          super
+          self.target_type = TARGET_TYPE.invert[to_number(params[0])]
+          target = to_number(params[1..2])
+          if target_type == :position_percent
+            target = target.to_f / 255 * 100
+          end
+          self.target = target
+        end
+
+        def target_type=(value)
+          raise ArgumentError, "target_type must be one of :up_limit, :down_limit, :stop, :ip, :next_ip_up, :next_ip_down, :jog_up, :jog_down, or :position_percent" unless TARGET_TYPE.keys.include?(value)
+          @target_type = value
+        end
+
+        def target=(value)
+          if target_type == :position_percent && value
+            @target = [[0, value].max, 100].min
+          else
+            @target = value&. & 0xffff
+          end
+        end
+
+        def params
+          param = target
+          param = (param * 255 / 100).to_i if target_type == :position_percent
+          transform_param(TARGET_TYPE[target_type]) + from_number(param, 2)
+        end
+      end
+    end
+  end
+end

data/lib/sdn/mqtt_bridge.rb

@@ -3,7 +3,7 @@ require 'uri'
 require 'set'
 
 module SDN
-  Group = Struct.new(:bridge, :addr, :positionpercent, :state) do
+  Group = Struct.new(:bridge, :addr, :positionpercent, :state, :motors) do
     def initialize(*)
       members.each { |k| self[k] = :nil }
       super
@@ -20,9 +20,13 @@ module SDN
       Message.print_address(Message.parse_address(addr))
     end
 
-    def motors
+    def motor_objects
       bridge.motors.select { |addr, motor| motor.groups_string.include?(printed_addr) }.values
     end
+
+    def motors_string
+      motor_objects.map { |m| SDN::Message.print_address(SDN::Message.parse_address(m.addr)) }.sort.join(',')
+    end
   end
 
   Motor = Struct.new(:bridge,
@@ -74,49 +78,50 @@ module SDN
                      :ip16pulses,
                      :ip16percent,
                      :groups) do
-     def initialize(*)
-       members.each { |k| self[k] = :nil }
-       @groups = [].fill(nil, 0, 16)
-       super
-     end
-
-     def publish(attribute, value)
-       if self[attribute] != value
-         bridge.publish("#{addr}/#{attribute}", value.to_s)
-         self[attribute] = value
-       end
-     end
-
-     def add_group(index, address)
-       bridge.add_group(SDN::Message.print_address(address)) if address
-       @groups[index] = address
-       publish(:groups, groups_string)
-     end
-
-     def set_groups(groups)
-       return unless groups =~ /^(?:\h{2}[:.]?\h{2}[:.]?\h{2}(?:,\h{2}[:.]?\h{2}[:.]?\h{2})*)?$/i
-       groups = groups.split(',').sort.uniq.map { |g| SDN::Message.parse_address(g) }
-       groups.fill(nil, groups.length, 16 - groups.length)
-       messages = []
-       sdn_addr = SDN::Message.parse_address(addr)
-       groups.each_with_index do |g, i|
-         if @groups[i] != g
-           messages << SDN::Message::SetGroupAddr.new(sdn_addr, i, g)
-           messages << SDN::Message::GetGroupAddr.new(sdn_addr, i)
-         end
-       end
-       messages
-     end
-
-     def groups_string
-       @groups.compact.map { |g| SDN::Message.print_address(g) }.sort.uniq.join(',')
-     end
-
-     def group_objects
-       groups_string.split(',').map { |addr| bridge.groups[addr.gsub('.', '')] }
-     end
+    def initialize(*)
+      members.each { |k| self[k] = :nil }
+      @groups = [].fill(nil, 0, 16)
+      super
+    end
+
+    def publish(attribute, value)
+      if self[attribute] != value
+        bridge.publish("#{addr}/#{attribute}", value.to_s)
+        self[attribute] = value
+      end
+    end
+
+    def add_group(index, address)
+      group = bridge.add_group(SDN::Message.print_address(address)) if address
+      @groups[index] = address
+      group&.publish(:motors, group.motors_string)
+      publish(:groups, groups_string)
+    end
+
+    def set_groups(groups)
+      return unless groups =~ /^(?:\h{2}[:.]?\h{2}[:.]?\h{2}(?:,\h{2}[:.]?\h{2}[:.]?\h{2})*)?$/i
+      groups = groups.split(',').sort.uniq.map { |g| SDN::Message.parse_address(g) }.select { |g| SDN::Message.is_group_address?(g) }
+      groups.fill(nil, groups.length, 16 - groups.length)
+      messages = []
+      sdn_addr = SDN::Message.parse_address(addr)
+      groups.each_with_index do |g, i|
+        if @groups[i] != g
+          messages << SDN::Message::SetGroupAddr.new(sdn_addr, i, g)
+          messages << SDN::Message::GetGroupAddr.new(sdn_addr, i)
+        end
+      end
+      messages
     end
 
+    def groups_string
+      @groups.compact.map { |g| SDN::Message.print_address(g) }.sort.uniq.join(',')
+    end
+
+    def group_objects
+      groups_string.split(',').map { |addr| bridge.groups[addr.gsub('.', '')] }
+    end
+  end
+
   class MQTTBridge
     WAIT_TIME = 0.25
     BROADCAST_WAIT = 5.0
@@ -161,6 +166,8 @@ module SDN
         loop do
           begin
             message, bytes_read = SDN::Message.parse(buffer.bytes)
+            # discard how much we read
+            buffer = buffer[bytes_read..-1]
             unless message
               begin
                 buffer.concat(@sdn.read_nonblock(64 * 1024))
@@ -175,8 +182,6 @@ module SDN
               end
               next
             end
-            # discard how much we read
-            buffer = buffer[bytes_read..-1]
 
             src = SDN::Message.print_address(message.src)
             # ignore the UAI Plus and ourselves
@@ -197,7 +202,7 @@ module SDN
               motor.publish(:positionpulses, message.position_pulses)
               motor.publish(:ip, message.ip)
               motor.group_objects.each do |group|
-                positions = group.motors.map(&:positionpercent)
+                positions = group.motor_objects.map(&:positionpercent)
                 position = nil
                 # calculate an average, but only if we know a position for
                 # every shade
@@ -218,7 +223,7 @@ module SDN
               motor.publish(:last_action_source, message.last_action_source)
               motor.publish(:last_action_cause, message.last_action_cause)
               motor.group_objects.each do |group|
-                states = group.motors.map(&:state).uniq
+                states = group.motor_objects.map(&:state).uniq
                 state = states.length == 1 ? states.first : 'mixed'
                 group.publish(:state, state)
               end
@@ -232,7 +237,7 @@ module SDN
               motor.publish(:downspeed, message.down_speed)
               motor.publish(:slowspeed, message.slow_speed)
             when SDN::Message::PostMotorIP
-              motor.publish(:"ip#{message.ip}pulses", message.position_pulses) 
+              motor.publish(:"ip#{message.ip}pulses", message.position_pulses)
               motor.publish(:"ip#{message.ip}percent", message.position_percent)
             when SDN::Message::PostGroupAddr
               motor.add_group(message.group_index, message.group_address)
@@ -241,7 +246,9 @@ module SDN
             @mutex.synchronize do
               signal = @response_pending || !follow_ups.empty?
               @response_pending = @broadcast_pending
-              @request_queue.concat(follow_ups)
+              follow_ups.each do |follow_up|
+                @request_queue.push(follow_up) unless @request_queue.include?(follow_up)
+              end
               @cond.signal if signal
             end
           rescue EOFError
@@ -281,9 +288,9 @@ module SDN
                 message = @request_queue.shift
                 if message
                   @response_pending = Time.now.to_f + WAIT_TIME
-                  if message.dest == [0xff, 0xff, 0xff]
+                  if message.dest == BROADCAST_ADDRESS || SDN::Message::is_group_address?(message.src) && message.is_a?(SDN::Message::GetNodeAddr)
                     @broadcast_pending = Time.now.to_f + BROADCAST_WAIT
-                  end    
+                  end
                 end
               end
 
@@ -293,8 +300,10 @@ module SDN
             next unless message
 
             puts "writing #{message.inspect}"
-            @sdn.write(message.serialize)
+            serialized = message.serialize
+            @sdn.write(serialized)
             @sdn.flush
+            puts "wrote #{serialized.unpack("C*").map { |b| '%02x' % b }.join(' ')}"
           end
         rescue => e
           puts "failure writing: #{e}"
@@ -310,7 +319,7 @@ module SDN
             @request_queue.push(SDN::Message::GetNodeAddr.new)
             @cond.signal
           end
-        elsif (match = topic.match(%r{^#{Regexp.escape(@base_topic)}/(?<addr>\h{6})/(?<property>label|down|up|stop|positionpulses|positionpercent|ip|wink|reset|(?<speed_type>upspeed|downspeed|slowspeed)|uplimit|downlimit|direction|ip(?<ip>\d+)(?<ip_type>pulses|percent)|groups)/set$}))
+        elsif (match = topic.match(%r{^#{Regexp.escape(@base_topic)}/(?<addr>\h{6})/(?<property>discover|label|down|up|stop|positionpulses|positionpercent|ip|wink|reset|(?<speed_type>upspeed|downspeed|slowspeed)|uplimit|downlimit|direction|ip(?<ip>\d+)(?<ip_type>pulses|percent)|groups)/set$}))
           addr = SDN::Message.parse_address(match[:addr])
           property = match[:property]
           # not homie compliant; allows linking the positionpercent property
@@ -319,10 +328,15 @@ module SDN
             property = value.downcase
             value = "true"
           end
-          motor = @motors[SDN::Message.print_address(addr).gsub('.', '')]
+          mqtt_addr = SDN::Message.print_address(addr).gsub('.', '')
+          motor = @motors[mqtt_addr]
           is_group = SDN::Message.is_group_address?(addr)
+          group = @groups[mqtt_addr]
           follow_up = SDN::Message::GetMotorStatus.new(addr)
           message = case property
+            when 'discover'
+              follow_up = nil
+              SDN::Message::GetNodeAddr.new(addr) if value == "true"
             when 'label'
               follow_up = SDN::Message::GetNodeLabel.new(addr)
               SDN::Message::SetNodeLabel.new(addr, value) unless is_group
@@ -432,7 +446,7 @@ module SDN
       publish("discovery/discover/$settable", "true")
       publish("discovery/discover/$retained", "false")
 
-      subscribe("discovery/discover/set")
+      subscribe("+/discover/set")
       subscribe("+/label/set")
       subscribe("+/down/set")
       subscribe("+/up/set")
@@ -460,7 +474,12 @@ module SDN
     def publish_motor(addr)
       publish("#{addr}/$name", addr)
       publish("#{addr}/$type", "Sonesse 30 Motor")
-      publish("#{addr}/$properties", "label,down,up,stop,positionpulses,positionpercent,ip,wink,reset,state,last_direction,last_action_source,last_action_cause,uplimit,downlimit,direction,upspeed,downspeed,slowspeed,#{(1..16).map { |ip| "ip#{ip}pulses,ip#{ip}percent" }.join(',')},groups")
+      publish("#{addr}/$properties", "discover,label,down,up,stop,positionpulses,positionpercent,ip,wink,reset,state,last_direction,last_action_source,last_action_cause,uplimit,downlimit,direction,upspeed,downspeed,slowspeed,#{(1..16).map { |ip| "ip#{ip}pulses,ip#{ip}percent" }.join(',')},groups")
+
+      publish("#{addr}/discover/$name", "Trigger Motor Discovery")
+      publish("#{addr}/discover/$datatype", "boolean")
+      publish("#{addr}/discover/$settable", "true")
+      publish("#{addr}/discover/$retained", "false")
 
       publish("#{addr}/label/$name", "Node label")
       publish("#{addr}/label/$datatype", "string")
@@ -580,7 +599,7 @@ module SDN
 
       motor = Motor.new(self, addr)
       @motors[addr] = motor
-      publish("$nodes", (["discovery"] + @motors.keys.sort + @groups.keys.sort.to_a).join(","))
+      publish("$nodes", (["discovery"] + @motors.keys.sort + @groups.keys.sort).join(","))
 
       sdn_addr = SDN::Message.parse_address(addr)
       @mutex.synchronize do
@@ -600,11 +619,17 @@ module SDN
 
     def add_group(addr)
       addr = addr.gsub('.', '')
-      return if @groups.key?(addr)
+      group = @groups[addr]
+      return group if group
 
       publish("#{addr}/$name", addr)
       publish("#{addr}/$type", "Shade Group")
-      publish("#{addr}/$properties", "down,up,stop,positionpulses,positionpercent,ip,wink,reset")
+      publish("#{addr}/$properties", "discover,down,up,stop,positionpulses,positionpercent,ip,wink,reset,state,motors")
+
+      publish("#{addr}/discover/$name", "Trigger Motor Discovery")
+      publish("#{addr}/discover/$datatype", "boolean")
+      publish("#{addr}/discover/$settable", "true")
+      publish("#{addr}/discover/$retained", "false")
 
       publish("#{addr}/down/$name", "Move in down direction")
       publish("#{addr}/down/$datatype", "boolean")
@@ -619,7 +644,7 @@ module SDN
       publish("#{addr}/stop/$name", "Cancel adjustments")
       publish("#{addr}/stop/$datatype", "boolean")
       publish("#{addr}/stop/$settable", "true")
-      publish("#{addr}/stop/$retained", "false")      
+      publish("#{addr}/stop/$retained", "false")
 
       publish("#{addr}/positionpulses/$name", "Position from up limit (in pulses)")
       publish("#{addr}/positionpulses/$datatype", "integer")
@@ -647,8 +672,12 @@ module SDN
       publish("#{addr}/state/$datatype", "enum")
       publish("#{addr}/state/$format", SDN::Message::PostMotorStatus::STATE.keys.join(','))
 
-      @groups[addr] = Group.new(self, addr)
-      publish("$nodes", (["discovery"] + @motors.keys.sort + @groups.to_a).join(","))
+      publish("#{addr}/motors/$name", "Motors that are members of this group")
+      publish("#{addr}/motors/$datatype", "string")
+
+      group = @groups[addr] = Group.new(self, addr)
+      publish("$nodes", (["discovery"] + @motors.keys.sort + @groups.keys.sort).join(","))
+      group
     end
   end
 end

data/lib/sdn/version.rb

@@ -1,3 +1,3 @@
 module SDN
-  VERSION = '1.0.7'
+  VERSION = '1.0.8'
 end

data/lib/somfy_sdn.rb

@@ -1,2 +1 @@
-require 'sdn/message'
-require 'sdn/mqtt_bridge'
+require 'sdn'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: somfy_sdn
 version: !ruby/object:Gem::Version
-  version: 1.0.7
+  version: 1.0.8
 platform: ruby
 authors:
 - Cody Cutrer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-05-15 00:00:00.000000000 Z
+date: 2020-07-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mqtt
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.0.2
+        version: 0.0.3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.0.2
+        version: 0.0.3
 - !ruby/object:Gem::Dependency
   name: serialport
   requirement: !ruby/object:Gem::Requirement
@@ -88,10 +88,14 @@ extensions: []
 extra_rdoc_files: []
 files:
 - bin/sdn_mqtt_bridge
+- lib/sdn.rb
 - lib/sdn/message.rb
 - lib/sdn/messages/control.rb
 - lib/sdn/messages/get.rb
 - lib/sdn/messages/helpers.rb
+- lib/sdn/messages/ilt2/get.rb
+- lib/sdn/messages/ilt2/post.rb
+- lib/sdn/messages/ilt2/set.rb
 - lib/sdn/messages/post.rb
 - lib/sdn/messages/set.rb
 - lib/sdn/mqtt_bridge.rb