somfy_sdn 1.0.12 → 2.1.2

data/lib/sdn/{messages → message}/set.rb

@@ -1,46 +1,67 @@
 module SDN
   class Message
-    class SetMotorLimits < Message
-      MSG = 0x11
-      PARAMS_LENGTH = 4
-      TYPE = { delete: 0x00, current_position: 0x01, specified_position: 0x02, jog_ms: 0x04, jog_pulses: 0x05 }
-      TARGET = { down: 0x00, up: 0x01 }
+    class SetFactoryDefault < Message
+      MSG = 0x1f
+      PARAMS_LENGTH = 1
+      RESET = { all_settings: 0x00, group_addresses: 0x01, limits: 0x11, rotation: 0x12, rolling_speed: 0x13, ips: 0x15, locks: 0x17 }
 
-      attr_reader :type, :target, :value
+      attr_reader :reset
 
-      def initialize(dest = nil, type = :delete, target = :up, value = nil, **kwargs)
-        kwargs[:dest] = dest
+      def initialize(dest = nil, reset = :all_settings, **kwargs)
+        kwargs[:dest] ||= dest
         super(**kwargs)
-        self.type = type
-        self.target = target
-        self.value = value
+        self.reset = reset
       end
 
       def parse(params)
         super
-        self.type = TYPE.invert[to_number(params[0])]
-        self.target = TARGET.invert[to_number(params[1])]
-        self.value = to_number(params[2..3])
+        self.reset = RESET.invert[to_number(params)]
       end
 
-      def type=(value)
-        raise ArgumentError, "type must be one of :delete, :current_position, :specified_position, :jog_ms, :jog_pulses" unless TYPE.keys.include?(value)
-        @type = value
+      def reset=(value)
+        raise ArgumentError, "reset must be one of :all_settings, :group_addresses, :limits, :rotation, :rolling_speed, :ips, :locks" unless RESET.keys.include?(value)
+        @reset = value
       end
 
-      def target=(value)
-        raise ArgumentError, "target must be one of :up, :down" unless TARGET.keys.include?(value)
-        @target = value
+      def params
+        transform_param(RESET[reset])
       end
+    end
 
-      def value=(value)
-        @value = value&. & 0xffff
+    class SetGroupAddr < Message
+      MSG = 0x51
+      PARAMS_LENGTH = 4
+
+      attr_reader :group_index, :group_address
+
+      def initialize(dest = nil, group_index = 1, group_address = nil, **kwargs)
+        kwargs[:dest] ||= dest
+        super(**kwargs)
+        self.group_index = group_index
+        self.group_address = group_address
+      end
+
+      def parse(params)
+        super
+        self.group_index = to_number(params[0]) + 1
+        self.group_address = transform_param(params[1..3])
+      end
+
+      def group_index=(value)
+        raise ArgumentError, "group_index is out of range" unless (1..16).include?(value)
+        @group_index = value
+      end
+
+      def group_address=(value)
+        @group_address = value
       end
 
       def params
-        param = value || 0
-        param /= 10 if target == :jog_ms
-        transform_param(TYPE[type]) + transform_param(TARGET[target]) + from_number(param, 2)
+        transform_param(group_index - 1) + transform_param(group_address || [0, 0, 0])
+      end
+
+      def class_inspect
+        ", group_index=#{group_index.inspect}, group_address=#{group_address ? print_address(group_address) : 'nil'}"
       end
     end
 
@@ -72,31 +93,6 @@ module SDN
       end
     end
 
-    class SetMotorRollingSpeed < Message
-      MSG = 0x13
-      PARAMS_LENGTH = 3
-
-      attr_accessor :up_speed, :down_speed, :slow_speed
-      def initialize(dest = nil, up_speed: nil, down_speed: nil, slow_speed: nil, **kwargs)
-        kwargs[:dest] ||= dest
-        super(**kwargs)
-        self.up_speed = up_speed
-        self.down_speed = down_speed
-        self.slow_speed = slow_speed
-      end
-
-      def parse(params)
-        super
-        self.up_speed = to_number(params[0])
-        self.down_speed = to_number(params[1])
-        self.slow_speed = to_number(params[2])
-      end
-
-      def params
-        transform_param(up_speed || 0xff) + transform_param(down_speed || 0xff) + transform_param(slow_speed || 0xff)
-      end
-    end
-
     class SetMotorIP < Message
       MSG = 0x15
       PARAMS_LENGTH = 4
@@ -141,74 +137,93 @@ module SDN
       end
     end
 
-    class SetFactoryDefault < Message
-      MSG = 0x1f
-      PARAMS_LENGTH = 1
-      RESET = { all_settings: 0x00, group_addresses: 0x01, limits: 0x11, rotation: 0x12, rolling_speed: 0x13, ips: 0x15, locks: 0x17 }
+    class SetMotorLimits < Message
+      MSG = 0x11
+      PARAMS_LENGTH = 4
+      TYPE = { delete: 0x00, current_position: 0x01, specified_position: 0x02, jog_ms: 0x04, jog_pulses: 0x05 }
+      TARGET = { down: 0x00, up: 0x01 }
 
-      attr_reader :reset
+      attr_reader :type, :target, :value
 
-      def initialize(dest = nil, reset = :all_settings, **kwargs)
+      def initialize(dest = nil, type = :delete, target = :up, value = nil, **kwargs)
         kwargs[:dest] ||= dest
         super(**kwargs)
-        self.reset = reset
+        self.type = type
+        self.target = target
+        self.value = value
       end
 
       def parse(params)
         super
-        self.reset = RESET.invert[to_number(params)]
+        self.type = TYPE.invert[to_number(params[0])]
+        self.target = TARGET.invert[to_number(params[1])]
+        self.value = to_number(params[2..3])
       end
 
-      def reset=(value)
-        raise ArgumentError, "reset must be one of :all_settings, :group_addresses, :limits, :rotation, :rolling_speed, :ips, :locks" unless RESET.keys.include?(value)
-        @reset = value
+      def type=(value)
+        raise ArgumentError, "type must be one of :delete, :current_position, :specified_position, :jog_ms, :jog_pulses" unless TYPE.keys.include?(value)
+        @type = value
+      end
+
+      def target=(value)
+        raise ArgumentError, "target must be one of :up, :down" unless TARGET.keys.include?(value)
+        @target = value
+      end
+
+      def value=(value)
+        @value = value&. & 0xffff
       end
 
       def params
-        transform_param(RESET[reset])
+        param = value || 0
+        param /= 10 if target == :jog_ms
+        transform_param(TYPE[type]) + transform_param(TARGET[target]) + from_number(param, 2)
       end
     end
 
-    class SetGroupAddr < Message
-      MSG = 0x51
-      PARAMS_LENGTH = 4
-
-      attr_reader :group_index, :group_address
+    class SetMotorRollingSpeed < Message
+      MSG = 0x13
+      PARAMS_LENGTH = 3
 
-      def initialize(dest = nil, group_index = 0, group_address = nil, **kwargs)
+      attr_accessor :up_speed, :down_speed, :slow_speed
+      def initialize(dest = nil, up_speed: nil, down_speed: nil, slow_speed: nil, **kwargs)
         kwargs[:dest] ||= dest
         super(**kwargs)
-        self.group_index = group_index
-        self.group_address = group_address
+        self.up_speed = up_speed
+        self.down_speed = down_speed
+        self.slow_speed = slow_speed
       end
 
       def parse(params)
         super
-        self.group_index = to_number(params[0])
-        self.group_address = transform_param(params[1..3])
+        self.up_speed = to_number(params[0])
+        self.down_speed = to_number(params[1])
+        self.slow_speed = to_number(params[2])
       end
 
-      def group_index=(value)
-        raise ArgumentError, "group_index is out of range" unless (0...16).include?(value)
-        @group_index = value
+      def params
+        transform_param(up_speed || 0xff) + transform_param(down_speed || 0xff) + transform_param(slow_speed || 0xff)
       end
+    end
 
-      def group_address=(value)
-        @group_address = value
-      end
+    class SetNetworkLock < Message
+      MSG = 0x16
 
-      def params
-        transform_param(group_index) + transform_param(group_address || [0, 0, 0])
+      attr_accessor :locked, :priority
+
+      def parse(params)
+        self.locked = to_number(params[0]) == 1 ? true : false
+        self.priority = to_number(params[1])
       end
 
-      def class_inspect
-        ", group_index=#{group_index.inspect}, group_address=#{group_address ? print_address(group_address) : 'nil'}"
+      def params
+        transform_param(locked ? 1 : 0) + transform_param(priority)
       end
     end
 
     class SetNodeLabel < Message
       MSG = 0x55
-      PARAMS_LENGTH = 16
+      MAX_LENGTH = 16
 
       attr_accessor :label
 
@@ -223,7 +238,7 @@ module SDN
       end
 
       def params
-        from_string(label, 16)
+        from_string(label, self.class::MAX_LENGTH)
       end
     end
   end

data/lib/sdn/message.rb

@@ -1,15 +1,21 @@
-require 'sdn/messages/helpers'
+require 'sdn/message/helpers'
 
 module SDN
   class MalformedMessage < RuntimeError; end
 
   class Message
     class << self
-      def expected_response
+      def inherited(klass)
+        return Message.inherited(klass) unless self == Message
+        @message_map = nil
+        (@subclasses ||= []) << klass
+      end
+
+      def expected_response?(message)
         if name =~ /::Get([A-Za-z]+)/
-          const_get("Post#{$1}", true)
+          message.class.name == name.sub("::Get", "::Post")
         else
-          Ack
+          message.is_a?(Ack) || message.is_a?(Nack)
         end
       end
 
@@ -19,20 +25,22 @@ module SDN
         # we loop here scanning for a valid message
         loop do
           offset += 1
+          # give these weird messages a chance
+          result = ILT2::MasterControl.parse(data)
+          return result if result
+
           return [nil, 0] if data.length - offset < 11
           msg = to_number(data[offset])
           length = to_number(data[offset + 1])
           ack_requested = length & 0x80 == 0x80
           length &= 0x7f
           # impossible message
-          next if length < 11 || length > 32
+          next if length < 11 || length > 43
           # don't have enough data for what this message wants;
           # it could be garbage on the line so keep scanning
           next if length > data.length - offset
 
-          message_class = constants.find { |c| (const_get(c, false).const_get(:MSG, false) rescue nil) == msg }
-          message_class = const_get(message_class, false) if message_class
-          message_class ||= UnknownMessage
+          message_class = message_map[msg] || UnknownMessage
 
           calculated_sum = checksum(data.slice(offset, length - 2))
           read_sum = data.slice(offset + length - 2, 2)
@@ -41,34 +49,41 @@ module SDN
           break
         end
 
-        puts "discarding invalid data prior to message #{data[0...offset].map { |b| '%02x' % b }.join(' ')}" unless offset == 0
-        puts "read #{data.slice(offset, length).map { |b| '%02x' % b }.join(' ')}"
-
-        reserved = to_number(data[offset + 2])
+        node_type = node_type_from_number(to_number(data[offset + 2]))
         src = transform_param(data.slice(offset + 3, 3))
         dest = transform_param(data.slice(offset + 6, 3))
         begin
-          result = message_class.new(reserved: reserved, ack_requested: ack_requested, src: src, dest: dest)
+          result = message_class.new(node_type: node_type, 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}"
+          SDN.logger.warn "discarding illegal message of type #{message_class.name}: #{e}"
           result = nil
         end
         [result, offset + length]
       end
+
+      private
+
+      def message_map
+        @message_map ||=
+          @subclasses.inject({}) do |memo, klass|
+            next memo unless klass.constants(false).include?(:MSG)
+            memo[klass.const_get(:MSG, false)] = klass
+            memo
+          end
+      end
     end
 
     include Helpers
     singleton_class.include Helpers
 
-    attr_reader :reserved, :ack_requested, :src, :dest
-    attr_writer :ack_requested
+    attr_accessor :node_type, :ack_requested, :src, :dest
 
-    def initialize(reserved: nil, ack_requested: false, src: nil, dest: nil)
-      @reserved = reserved || 0x02 # message sent to Sonesse 30
+    def initialize(node_type: nil, ack_requested: false, src: nil, dest: nil)
+      @node_type = node_type || 0
       @ack_requested = ack_requested
-      if src.nil? && is_group_address?(dest)
+      if src.nil? && !dest.nil? && is_group_address?(dest)
         src = dest
         dest = nil
       end
@@ -81,7 +96,7 @@ module SDN
     end
 
     def serialize
-      result = transform_param(reserved) + transform_param(src) + transform_param(dest) + params
+      result = transform_param(node_type_to_number(node_type)) + transform_param(src) + transform_param(dest) + params
       length = result.length + 4
       length |= 0x80 if ack_requested
       result = transform_param(self.class.const_get(:MSG)) + transform_param(length) + result
@@ -94,11 +109,11 @@ module SDN
     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]
+      "#<%s @node_type=%s, @ack_requested=%s, @src=%s, @dest=%s%s>" % [self.class.name, node_type_to_string(node_type), ack_requested, print_address(src), print_address(dest), class_inspect]
     end
 
     def class_inspect
-      ivars = instance_variables - [:@reserved, :@ack_requested, :@src, :@dest]
+      ivars = instance_variables - [:@node_type, :@ack_requested, :@src, :@dest, :@params]
       return if ivars.empty?
       ivars.map { |iv| ", #{iv}=#{instance_variable_get(iv).inspect}" }.join
     end
@@ -121,19 +136,36 @@ module SDN
     class Nack < Message
       MSG = 0x6f
       PARAMS_LENGTH = 1
-      VALUES = { data_error: 0x01, unknown_message: 0x10, node_is_locked: 0x20, wrong_position: 0x21, limits_not_set: 0x22, ip_not_set: 0x23, out_of_range: 0x24, busy: 0xff }
+      VALUES = { data_error: 0x01,
+                 unknown_message: 0x10,
+                 node_is_locked: 0x20,
+                 wrong_position: 0x21,
+                 limits_not_set: 0x22,
+                 ip_not_set: 0x23,
+                 out_of_range: 0x24,
+                 busy: 0xff }
+                 # 17 limits not set?
+                 # 37 not implemented? (get motor rolling speed)
+                 # 39 at limit? blocked?
+
 
       # presumed
       attr_accessor :error_code
 
+      def initialize(dest = nil, error_code = nil, **kwargs)
+        kwargs[:dest] ||= dest
+        super(**kwargs)
+        self.error_code = error_code
+      end
+
       def parse(params)
         super
         error_code = to_number(params[0])
-        self.error_code = VALUES[error_code] || error_code
+        self.error_code = VALUES.invert[error_code] || error_code
       end
     end
 
-    class Ack < Message
+    class Ack < SimpleRequest
       MSG = 0x7f
       PARAMS_LENGTH = 0
     end
@@ -142,10 +174,25 @@ module SDN
     class UnknownMessage < Message
       attr_accessor :msg, :params
 
+      def initialize(params = [], **kwargs)
+        super(**kwargs)
+        self.params = params
+      end
+
       alias parse params=
 
+      def serialize
+        # prevent serializing something we don't know
+        raise NotImplementedError unless params
+        super
+      end
+
       def class_inspect
-        result = ", @msg=%02xh" % msg
+        result = if self.class == UnknownMessage
+          result = ", @msg=%02xh" % msg 
+        else
+          super || ""
+        end
         return result if params.empty?
 
         result << ", @params=#{params.map { |b| "%02x" % b }.join(' ')}"
@@ -154,7 +201,11 @@ module SDN
   end
 end
 
-require 'sdn/messages/control'
-require 'sdn/messages/get'
-require 'sdn/messages/post'
-require 'sdn/messages/set'
+require 'sdn/message/control'
+require 'sdn/message/get'
+require 'sdn/message/post'
+require 'sdn/message/set'
+require 'sdn/message/ilt2/get'
+require 'sdn/message/ilt2/master_control'
+require 'sdn/message/ilt2/post'
+require 'sdn/message/ilt2/set'

data/lib/sdn/version.rb

@@ -1,3 +1,3 @@
 module SDN
-  VERSION = '1.0.12'
+  VERSION = '2.1.2'
 end

data/lib/sdn.rb

@@ -1,6 +1,21 @@
+require 'logger'
+
+require 'sdn/client'
 require 'sdn/message'
-require 'sdn/mqtt_bridge'
 
 module SDN
   BROADCAST_ADDRESS = [0xff, 0xff, 0xff]
+
+  class << self
+    def logger
+      @logger ||= begin
+        Logger.new(STDOUT, :info).tap do |logger|
+          logger.datetime_format = '%Y-%m-%d %H:%M:%S.%L'
+          logger.formatter = proc do |severity, datetime, progname, msg|
+            "#{datetime.strftime(logger.datetime_format)} [#{Process.pid}/#{Thread.current.object_id}] #{severity}: #{msg}\n"
+          end
+        end
+      end
+    end
+  end
 end

metadata

@@ -1,57 +1,85 @@
 --- !ruby/object:Gem::Specification
 name: somfy_sdn
 version: !ruby/object:Gem::Version
-  version: 1.0.12
+  version: 2.1.2
 platform: ruby
 authors:
 - Cody Cutrer
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-11-02 00:00:00.000000000 Z
+date: 2022-01-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: mqtt
+  name: mqtt-ccutrer
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.5.0
+        version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.5.0
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: ccutrer-serialport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: curses
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
 - !ruby/object:Gem::Dependency
   name: net-telnet-rfc2217
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.0.3
+        version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.0.3
+        version: '1.0'
 - !ruby/object:Gem::Dependency
-  name: ccutrer-serialport
+  name: thor
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.0.0
+        version: '1.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.0.0
+        version: '1.1'
 - !ruby/object:Gem::Dependency
   name: byebug
   requirement: !ruby/object:Gem::Requirement
@@ -80,32 +108,41 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '13.0'
-description:
+description: 
 email: cody@cutrer.com'
 executables:
-- sdn_mqtt_bridge
+- somfy_sdn
 extensions: []
 extra_rdoc_files: []
 files:
-- bin/sdn_mqtt_bridge
+- bin/somfy_sdn
 - lib/sdn.rb
+- lib/sdn/cli/mqtt.rb
+- lib/sdn/cli/mqtt/group.rb
+- lib/sdn/cli/mqtt/motor.rb
+- lib/sdn/cli/mqtt/read.rb
+- lib/sdn/cli/mqtt/subscriptions.rb
+- lib/sdn/cli/mqtt/write.rb
+- lib/sdn/cli/provisioner.rb
+- lib/sdn/cli/simulator.rb
+- lib/sdn/client.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
+- lib/sdn/message/control.rb
+- lib/sdn/message/get.rb
+- lib/sdn/message/helpers.rb
+- lib/sdn/message/ilt2/get.rb
+- lib/sdn/message/ilt2/master_control.rb
+- lib/sdn/message/ilt2/post.rb
+- lib/sdn/message/ilt2/set.rb
+- lib/sdn/message/post.rb
+- lib/sdn/message/set.rb
 - lib/sdn/version.rb
 - lib/somfy_sdn.rb
 homepage: https://github.com/ccutrer/somfy_sdn
 licenses:
 - MIT
 metadata: {}
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -120,8 +157,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
-signing_key:
+rubygems_version: 3.1.2
+signing_key: 
 specification_version: 4
 summary: Library for communication with Somfy SDN RS-485 motorized shades
 test_files: []

data/bin/sdn_mqtt_bridge

@@ -1,5 +0,0 @@
-#!/usr/bin/env ruby
-
-require 'somfy_sdn'
-
-SDN::MQTTBridge.new(ARGV[0], ARGV[1])

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

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