somfy_sdn 2.2.2 → 2.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 376921afa9659381b31f588319c02f35f3d539052e8eb6375b311420bcdac60e
-  data.tar.gz: 8c8f5644816c615d0f31dec41e615a1d5857c1f1ee94e45d83bc759616c30e04
+  metadata.gz: 58db5a5328195a9cbd9458c4702f2e31490b7a5967d7e94e4ac9fc84a569ba88
+  data.tar.gz: cb58ee6964aeb41ce39737b3bdacd44974b2f40dd53395c0376c09b8e2add269
 SHA512:
-  metadata.gz: 84de94b508cc42c76bab56b3a02ba61cd389277463583353c67df5798a710016e143b4607367be71db35efa052949c146476a591ef4d8a08f54a99e76833e907
-  data.tar.gz: 2319f36c605560ebccc80e64600a26f2fec4abb806d33bb041bb0f667c41de1f6facecf8bd93b0ec557a676b34474393c1b4fa807a3cfcc84adbbae9244e0ccc
+  metadata.gz: 0d2f32416ae7e943f101868cdda35162f1b14dd7e047d1df2725c36095fc4437e713fc32546b03e10c89e013b00210062ff3e8dfd88f6503266cc3a65e5e262b
+  data.tar.gz: 3b1e3732ad5d70fbac17f5e498b418a096c890e37b570e5da70cfbeee77c2b0ae6cec25d0ae2f8c3f39bac80e836ab8a70018b43ba75ca3be3421478281f8757

data/lib/sdn/cli/mqtt/motor.rb

@@ -11,6 +11,7 @@ module SDN
                          :position_percent,
                          :ip,
                          :state,
+                         :hass_state,
                          :last_direction,
                          :last_action_source,
                          :last_action_cause,

data/lib/sdn/cli/mqtt/read.rb

@@ -83,6 +83,16 @@ module SDN
                   follow_ups << Message::GetMotorPosition.new(message.src)
                   motor.publish(:state, message.state)
                   motor.publish(:last_direction, message.last_direction)
+                  hass_state = if message.state == :running
+                                 (message.last_direction == :down) ? :closing : :opening
+                               elsif motor.position_percent&.zero?
+                                 :open
+                               elsif motor.position_percent == 100
+                                 :closed
+                               else
+                                 :stopped
+                               end
+                  motor.publish(:hass_state, hass_state)
                   motor.publish(:last_action_source, message.last_action_source)
                   motor.publish(:last_action_cause, message.last_action_cause)
                   motor.group_objects.each do |group|

data/lib/sdn/cli/mqtt.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require "mqtt"
+require "mqtt-homeassistant"
 require "uri"
 require "set"
 
@@ -32,6 +33,7 @@ module SDN
                      auto_discover: true,
                      known_motors: [])
         @base_topic = "#{base_topic}/#{device_id}"
+        @device_id = device_id
         @mqtt = ::MQTT::Client.new(mqtt_uri)
         @mqtt.set_will("#{@base_topic}/$state", "lost", retain: true)
         @mqtt.connect
@@ -107,6 +109,21 @@ module SDN
           publish("FFFFFF/discover/$settable", "true")
           publish("FFFFFF/discover/$retained", "false")
 
+          hass_device = {
+            name: "Somfy SDN Bridge",
+            identifiers: @device_id,
+            sw_version: SDN::VERSION
+          }
+          @mqtt.publish_hass_button("discover",
+                                    command_topic: "#{@base_topic}/FFFFFF/discover/set",
+                                    device: hass_device,
+                                    icon: "mdi:search-add",
+                                    name: "Discover Motors",
+                                    node_id: @device_id,
+                                    object_id: "discover",
+                                    unique_id: "#{@device_id}_discover",
+                                    payload_press: "true")
+
           subscribe_all
 
           publish("$state", "ready")
@@ -146,6 +163,14 @@ module SDN
         motor = nil
 
         @mqtt.batch_publish do
+          hass_device = {
+            identifiers: addr,
+            model_id: node_type,
+            name: addr,
+            via_device: @device_id
+          }
+          node_id = "#{@device_id}_#{addr}"
+
           publish("#{addr}/$name", addr)
           publish("#{addr}/$type", node_type.to_s)
           properties = %w[
@@ -181,10 +206,28 @@ module SDN
           publish("#{addr}/discover/$format", "discover")
           publish("#{addr}/discover/$settable", "true")
           publish("#{addr}/discover/$retained", "false")
+          @mqtt.publish_hass_button("discover",
+                                    command_topic: "#{@base_topic}/#{addr}/discover/set",
+                                    device: hass_device,
+                                    icon: "mdi:search-add",
+                                    name: "Rediscover",
+                                    node_id: node_id,
+                                    object_id: "discover",
+                                    payload_press: "true",
+                                    unique_id: "#{node_id}_discover")
 
           publish("#{addr}/label/$name", "Node label")
           publish("#{addr}/label/$datatype", "string")
           publish("#{addr}/label/$settable", "true")
+          @mqtt.publish_hass_text("label",
+                                  command_topic: "#{@base_topic}/#{addr}/label/set",
+                                  device: hass_device,
+                                  entity_category: :config,
+                                  icon: "mdi:rename",
+                                  max: 16,
+                                  name: "Label",
+                                  node_id: node_id,
+                                  unique_id: "#{node_id}_label")
 
           publish("#{addr}/state/$name", "Current state of the motor")
           publish("#{addr}/state/$datatype", "enum")
@@ -216,24 +259,95 @@ module SDN
           publish("#{addr}/position-percent/$unit", "%")
           publish("#{addr}/position-percent/$settable", "true")
 
+          @mqtt.publish_hass_cover("motor",
+                                   command_topic: "#{@base_topic}/#{addr}/control/set",
+                                   device: hass_device,
+                                   icon: "mdi:roller-shade",
+                                   name: "Motor",
+                                   node_id: node_id,
+                                   payload_close: "down",
+                                   payload_open: "up",
+                                   payload_stop: "stop",
+                                   position_open: 0,
+                                   position_closed: 100,
+                                   position_topic: "#{@base_topic}/#{addr}/position-percent",
+                                   set_position_topic: "#{@base_topic}/#{addr}/position-percent/set",
+                                   state_topic: "#{@base_topic}/#{addr}/hass-state",
+                                   unique_id: "#{node_id}_motor")
+          {
+            Wink: "mdi:emoticon-wink",
+            Next_IP: "mdi:skip-next",
+            Previous_IP: "mdi:skip-previous",
+            Refresh: "mdi:refresh"
+          }.each do |command, icon|
+            @mqtt.publish_hass_button(command.to_s.downcase,
+                                      command_topic: "#{@base_topic}/#{addr}/control/set",
+                                      device: hass_device,
+                                      icon: icon,
+                                      name: command.to_s.sub("_", " "),
+                                      node_id: node_id,
+                                      payload_press: command.to_s.downcase,
+                                      unique_id: "#{node_id}_#{command.to_s.downcase}")
+          end
+
           publish("#{addr}/position-pulses/$name", "Position from up limit (in pulses)")
           publish("#{addr}/position-pulses/$datatype", "integer")
           publish("#{addr}/position-pulses/$format", "0:65535")
           publish("#{addr}/position-pulses/$unit", "pulses")
           publish("#{addr}/position-pulses/$settable", "true")
 
+          @mqtt.publish_hass_number("position-pulses",
+                                    command_topic: "#{@base_topic}/#{addr}/position-pulses/set",
+                                    device: hass_device,
+                                    enabled_by_default: false,
+                                    max: 65_536,
+                                    min: 0,
+                                    name: "Position (Pulses)",
+                                    node_id: node_id,
+                                    object_id: "position-pulses",
+                                    state_topic: "#{@base_topic}/#{addr}/position-pulses",
+                                    step: 10,
+                                    unit_of_measurement: "pulses",
+                                    unique_id: "#{node_id}_position-pulses")
+
           publish("#{addr}/ip/$name", "Intermediate Position")
           publish("#{addr}/ip/$datatype", "integer")
           publish("#{addr}/ip/$format", "1:16")
           publish("#{addr}/ip/$settable", "true")
           publish("#{addr}/ip/$retained", "false") if node_type == :st50ilt2
 
+          @mqtt.publish_hass_number("ip",
+                                    command_topic: "#{@base_topic}/#{addr}/ip/set",
+                                    device: hass_device,
+                                    name: "Intermediate Position",
+                                    max: 16,
+                                    min: 0,
+                                    node_id: node_id,
+                                    object_id: "ip",
+                                    payload_reset: "",
+                                    state_topic: "#{@base_topic}/#{addr}/ip",
+                                    unique_id: "#{node_id}_ip")
+
           publish("#{addr}/down-limit/$name", "Down limit")
           publish("#{addr}/down-limit/$datatype", "integer")
           publish("#{addr}/down-limit/$format", "0:65535")
           publish("#{addr}/down-limit/$unit", "pulses")
           publish("#{addr}/down-limit/$settable", "true")
 
+          @mqtt.publish_hass_number("down-limit",
+                                    command_topic: "#{@base_topic}/#{addr}/down-limit/set",
+                                    device: hass_device,
+                                    entity_category: :config,
+                                    icon: "mdi:roller-shade-closed",
+                                    max: 65_536,
+                                    min: 0,
+                                    node_id: node_id,
+                                    payload_reset: "",
+                                    state_topic: "#{@base_topic}/#{addr}/down-limit",
+                                    step: 10,
+                                    unit_of_measurement: "pulses",
+                                    unique_id: "#{node_id}_down-limit")
+
           publish("#{addr}/last-direction/$name", "Direction of last motion")
           publish("#{addr}/last-direction/$datatype", "enum")
           publish("#{addr}/last-direction/$format", Message::PostMotorStatus::DIRECTION.keys.join(","))
@@ -245,25 +359,86 @@ module SDN
             publish("#{addr}/reset/$settable", "true")
             publish("#{addr}/reset/$retained", "false")
 
+            Message::SetFactoryDefault::RESET.each_key do |key|
+              @mqtt.publish_hass_button("reset_#{key}",
+                                        command_topic: "#{@base_topic}/#{addr}/reset/set",
+                                        device: hass_device,
+                                        enabled_by_default: false,
+                                        entity_category: :config,
+                                        name: "Reset #{key.to_s.sub("_", " ")}",
+                                        node_id: node_id,
+                                        payload_press: key,
+                                        unique_id: "#{node_id}_#{key}")
+            end
+
             publish("#{addr}/last-action-source/$name", "Source of last action")
             publish("#{addr}/last-action-source/$datatype", "enum")
             publish("#{addr}/last-action-source/$format", Message::PostMotorStatus::SOURCE.keys.join(","))
 
+            @mqtt.publish_hass_sensor("last-action-source",
+                                      device: hass_device,
+                                      device_class: :enum,
+                                      entity_category: :diagnostic,
+                                      name: "Source of last action",
+                                      node_id: node_id,
+                                      object_id: "last-action-source",
+                                      options: Message::PostMotorStatus::SOURCE.keys,
+                                      state_topic: "#{@base_topic}/#{addr}/last-action-source",
+                                      unique_id: "#{node_id}_last-action-source")
+
             publish("#{addr}/last-action-cause/$name", "Cause of last action")
             publish("#{addr}/last-action-cause/$datatype", "enum")
             publish("#{addr}/last-action-cause/$format", Message::PostMotorStatus::CAUSE.keys.join(","))
 
+            @mqtt.publish_hass_sensor("last-action-cause",
+                                      device: hass_device,
+                                      device_class: :enum,
+                                      entity_category: :diagnostic,
+                                      name: "Cause of last action",
+                                      node_id: node_id,
+                                      object_id: "last-action-cause",
+                                      options: Message::PostMotorStatus::CAUSE.keys,
+                                      state_topic: "#{@base_topic}/#{addr}/last-action-cause",
+                                      unique_id: "#{node_id}_last-action-cause")
+
             publish("#{addr}/up-limit/$name", "Up limit (always = 0)")
             publish("#{addr}/up-limit/$datatype", "integer")
             publish("#{addr}/up-limit/$format", "0:65535")
             publish("#{addr}/up-limit/$unit", "pulses")
             publish("#{addr}/up-limit/$settable", "true")
 
+            @mqtt.publish_hass_number("up-limit",
+                                      command_topic: "#{@base_topic}/#{addr}/up-limit/set",
+                                      device: hass_device,
+                                      entity_category: :config,
+                                      icon: "mdi:roller-shade-open",
+                                      max: 65_536,
+                                      min: 0,
+                                      name: "Up Limit",
+                                      node_id: node_id,
+                                      payload_reset: "",
+                                      state_topic: "#{@base_topic}/#{addr}/up-limit",
+                                      step: 10,
+                                      unit_of_measurement: "pulses",
+                                      unique_id: "#{node_id}_up-limit")
+
             publish("#{addr}/direction/$name", "Motor rotation direction")
             publish("#{addr}/direction/$datatype", "enum")
             publish("#{addr}/direction/$format", "standard,reversed")
             publish("#{addr}/direction/$settable", "true")
 
+            @mqtt.publish_hass_select("direction",
+                                      command_topic: "#{@base_topic}/#{addr}/direction/set",
+                                      device: hass_device,
+                                      entity_category: :config,
+                                      icon: "mdi:circle-arrows",
+                                      name: "Motor rotation direction",
+                                      node_id: node_id,
+                                      object_id: "direction",
+                                      options: %w[standard reversed],
+                                      state_topic: "#{@base_topic}/#{addr}/direction",
+                                      unique_id: "#{node_id}_direction")
+
             publish("#{addr}/up-speed/$name", "Up speed")
             publish("#{addr}/up-speed/$datatype", "integer")
             publish("#{addr}/up-speed/$format", "6:28")
@@ -281,6 +456,21 @@ module SDN
             publish("#{addr}/slow-speed/$format", "6:28")
             publish("#{addr}/slow-speed/$unit", "RPM")
             publish("#{addr}/slow-speed/$settable", "true")
+
+            %w[Up Slow].each do |speed_type|
+              @mqtt.publish_hass_number("#{speed_type.downcase}-speed",
+                                        command_topic: "#{@base_topic}/#{addr}/#{speed_type.downcase}-speed/set",
+                                        device: hass_device,
+                                        entity_category: :config,
+                                        icon: "mdi:car-speed-limiter",
+                                        max: 28,
+                                        min: 6,
+                                        name: "#{speed_type} speed",
+                                        node_id: node_id,
+                                        state_topic: "#{@base_topic}/#{addr}/#{speed_type.downcase}-speed",
+                                        unit_of_measurement: "RPM",
+                                        unique_id: "#{node_id}_#{speed_type.downcase}-speed")
+            end
           end
 
           publish("#{addr}/groups/$name", "Group Memberships (comma separated, address must start 0101xx)")
@@ -294,11 +484,41 @@ module SDN
             publish("#{addr}/ip#{ip}-pulses/$unit", "pulses")
             publish("#{addr}/ip#{ip}-pulses/$settable", "true")
 
+            @mqtt.publish_hass_number("ip#{ip}-pulses",
+                                      command_topic: "#{@base_topic}/#{addr}/ip#{ip}-pulses/set",
+                                      device: hass_device,
+                                      enabled_by_default: false,
+                                      entity_category: :config,
+                                      max: 65_536,
+                                      min: 0,
+                                      name: "Intermediation Position #{ip} (Pulses)",
+                                      node_id: node_id,
+                                      object_id: "ip#{ip}-pulses",
+                                      payload_reset: "",
+                                      state_topic: "#{@base_topic}/#{addr}/ip#{ip}-pulses",
+                                      step: 10,
+                                      unit_of_measurement: "pulses",
+                                      unique_id: "#{node_id}_ip#{ip}-pulses")
+
             publish("#{addr}/ip#{ip}-percent/$name", "Intermediate Position #{ip}")
             publish("#{addr}/ip#{ip}-percent/$datatype", "integer")
             publish("#{addr}/ip#{ip}-percent/$format", "0:100")
             publish("#{addr}/ip#{ip}-percent/$unit", "%")
             publish("#{addr}/ip#{ip}-percent/$settable", "true")
+
+            @mqtt.publish_hass_number("ip#{ip}-percent",
+                                      command_topic: "#{@base_topic}/#{addr}/ip#{ip}-percent/set",
+                                      device: hass_device,
+                                      entity_category: :config,
+                                      max: 100,
+                                      min: 0,
+                                      name: "Intermediation Position #{ip} (Percent)",
+                                      node_id: node_id,
+                                      object_id: "ip#{ip}-percent",
+                                      payload_reset: "",
+                                      state_topic: "#{@base_topic}/#{addr}/ip#{ip}-percent",
+                                      unit_of_measurement: "%",
+                                      unique_id: "#{node_id}_ip#{ip}-percent")
           end
 
           motor = Motor.new(self, addr, node_type)

data/lib/sdn/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module SDN
-  VERSION = "2.2.2"
+  VERSION = "2.3.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: somfy_sdn
 version: !ruby/object:Gem::Version
-  version: 2.2.2
+  version: 2.3.0
 platform: ruby
 authors:
 - Cody Cutrer
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-10-02 00:00:00.000000000 Z
+date: 2025-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ccutrer-serialport
@@ -39,7 +39,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '1.4'
 - !ruby/object:Gem::Dependency
-  name: mqtt-ccutrer
+  name: mqtt-homeassistant
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
@@ -80,20 +80,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.1'
-- !ruby/object:Gem::Dependency
-  name: debug
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.9'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.9'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -108,35 +94,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '13.0'
-- !ruby/object:Gem::Dependency
-  name: rubocop-inst
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.0'
-- !ruby/object:Gem::Dependency
-  name: rubocop-rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.6'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.6'
-description: 
+description:
 email: cody@cutrer.com'
 executables:
 - somfy_sdn
@@ -172,7 +130,7 @@ licenses:
 - MIT
 metadata:
   rubygems_mfa_required: 'true'
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -188,7 +146,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.5.11
-signing_key: 
+signing_key:
 specification_version: 4
 summary: Library for communication with Somfy SDN RS-485 motorized shades
 test_files: []