fritzbox-smarthome 0.1.3 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 782cdee20c938c01c4ee6f6560e05f7a7636d8b9315e6c63f577959e3df85f45
-  data.tar.gz: a33ea016b04d0a710d13e0e1089850d74f1d16f14e9346683fac961640be2851
+  metadata.gz: 430136a0736fded1a9e2cf308cdeb00129e94514259915306146fc65be4fb04a
+  data.tar.gz: 8755e3f921c2c815b1e6d38d3372bcfff068e6a8aa7a47785d07213585e67101
 SHA512:
-  metadata.gz: af9c5ed89753c194f8eefaf29dcf4893e9f68c99e7595cb95196b778b9bdbce2a7a6e2efa0b650ddf52f5fccab2e19f0bd065be68a4d805f1f94b96990a6fd61
-  data.tar.gz: 4aabacf20397befaf87d069307e2bc525bfaee04ecae6563d63ee4b1c6487f62ede5f75d850257e63fecf87ade33c21b7ef85877a00de4fde861b763b0fb7137
+  metadata.gz: 94ac858e01f25649f9171df8cf685658b4a4e17f5c230a1394569c37d3052444ed1b155d8eb9a58d61fc056eb471347ee5c0c163b0a777651a8abceac4a3c76a
+  data.tar.gz: 198756b6e8a1d7d2cfcf886e26f5e2efd3d75eb655d2533e94074c936b42da531d58147ceba13e3a54b5e621f66fe99f56fe5652cbdd6c2b64294a095fa5e22e

data/.ruby-version

@@ -1 +1 @@
-3.0.0
+3.1.2

data/CHANGELOG.md

@@ -1,5 +1,23 @@
 # Changelog
 
+## v0.4.0
+
+* Add support for Fritz!DECT lightbulbs
+
+## v0.3.0
+
+* Use generic Actor class for unrecognised device
+* Allow usage in rails up to 7.1.x
+* Use ruby 3.1.x in development
+* Update a other dependencies
+
+## v0.2.0
+
+**Attention**: This release contains breaking changes! Check [README](README.md) for new interface.
+
+* Add support for more actors types: switches and smoke detector
+* Extract heater specific attributes and logic to own class
+
 ## v0.1.3
 
 * avoid nil error in actors:all smart devices request

data/README.md

@@ -2,6 +2,12 @@
 
 Ruby client library to interface with Smarthome features of your FritzBox.
 
+Currently implemented actor types:
+
+* Heater
+* SmokeDetector
+* Switch
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -28,10 +34,12 @@ Fritzbox::Smarthome.configure do |config|
   config.verify_ssl = false
 end
 
+# Get all actors of any type
 actors = Fritzbox::Smarthome::Actor.all
 
-actor = actors.last
-actor.update_hkr_temp_set(BigDecimal.new('21.5'))
+# Get all actors of type Heater
+heaters = Fritzbox::Smarthome::Heater.all
+heaters.last.update_hkr_temp_set(BigDecimal('21.5'))
 ```
 
 ## Development

data/fritzbox-smarthome.gemspec

@@ -20,14 +20,14 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.add_dependency 'activesupport', '>= 5.1', '< 6.2'
-  spec.add_dependency 'activemodel', '>= 5.1', '< 6.2'
-  spec.add_dependency 'httparty', '~> 0.16'
+  spec.add_dependency 'activesupport', '>= 5.1', '<= 7.1'
+  spec.add_dependency 'activemodel', '>= 5.1', '<= 7.1'
+  spec.add_dependency 'httparty', '~> 0.20'
   spec.add_dependency 'nori', '~> 2.6'
-  spec.add_dependency 'nokogiri', '~> 1.8'
+  spec.add_dependency 'nokogiri', '~> 1.13'
 
   spec.add_development_dependency 'rake', '~> 13.0'
-  spec.add_development_dependency 'rspec', '~> 3.0'
-  spec.add_development_dependency 'webmock', '~> 3.3'
-  spec.add_development_dependency 'byebug', '~> 11.0'
+  spec.add_development_dependency 'rspec', '~> 3.11'
+  spec.add_development_dependency 'webmock', '~> 3.14'
+  spec.add_development_dependency 'byebug', '~> 11.1'
 end

data/lib/fritzbox/smarthome/actor.rb

@@ -9,49 +9,31 @@ module Fritzbox
         :ain,
         :present,
         :name,
-        :hkr_temp_is,
-        :hkr_temp_set,
-        :hkr_next_change_period,
-        :hkr_next_change_temp,
+        :manufacturer,
         :group_members
 
       class << self
         def all(types: ['group', 'device'])
           response = get(command: 'getdevicelistinfos')
           xml = nori.parse(response.body)
-
           Array.wrap(types.map { |type| xml.dig('devicelist', type) }.flatten).compact.map do |data|
-            new_from_api(data)
-          end
-        end
-
-        def only_heaters
-          all.select { |record| record.hkr_temp_is.present? }
+            klass = Actor.descendants.find { |k| k.match?(data) } || Actor
+            self.in?([klass, Actor]) ? klass.new_from_api(data) : nil
+          end.compact
         end
 
         def new_from_api(data)
           new(
-            id:                     data.dig('@id').to_s,
-            type:                   data.dig('groupinfo').present? ? :group : :device,
-            ain:                    data.dig('@identifier').to_s,
-            present:                data.dig('present') == '1',
-            name:                   data.dig('name').to_s,
-            hkr_temp_is:            data.dig('hkr', 'tist').to_i * 0.5,
-            hkr_temp_set:           data.dig('hkr', 'tsoll').to_i * 0.5,
-            hkr_next_change_period: Time.at(data.dig('hkr', 'nextchange', 'endperiod').to_i),
-            hkr_next_change_temp:   data.dig('hkr', 'nextchange', 'tchange').to_i * 0.5,
-            group_members:          data.dig('groupinfo', 'members').to_s.split(',').presence
+            id:            data.dig('@id').to_s,
+            type:          data.dig('groupinfo').present? ? :group : :device,
+            ain:           data.dig('@identifier').to_s,
+            present:       data.dig('present') == '1',
+            name:          (data.dig('name') || data.dig('@productname')).to_s,
+            manufacturer:  (data.dig('manufacturer') || data.dig('@manufacturer')).to_s,
+            group_members: data.dig('groupinfo', 'members').to_s.split(',').presence
           )
         end
       end
-
-      def update_hkr_temp_set(value)
-        raise ArgumentError unless value.is_a? BigDecimal
-        value = (value / 0.5).to_i
-        response = self.class.get(command: 'sethkrtsoll', ain: ain, param: value)
-        raise 'Could not set temperature' unless response.body == "#{value}\n"
-        true
-      end
     end
   end
 end

data/lib/fritzbox/smarthome/heater.rb

@@ -0,0 +1,41 @@
+module Fritzbox
+  module Smarthome
+    class Heater < Actor
+
+      attr_accessor \
+        :battery,
+        :batterylow,
+        :hkr_temp_is,
+        :hkr_temp_set,
+        :hkr_next_change_period,
+        :hkr_next_change_temp
+
+      class << self
+        def match?(data)
+          data.key?('hkr')
+        end
+
+        def new_from_api(data)
+          instance = super
+          instance.assign_attributes(
+            battery:                data.dig('battery').to_i,
+            batterylow:             data.dig('batterylow').to_i,
+            hkr_temp_is:            data.dig('hkr', 'tist').to_i * 0.5,
+            hkr_temp_set:           data.dig('hkr', 'tsoll').to_i * 0.5,
+            hkr_next_change_period: Time.at(data.dig('hkr', 'nextchange', 'endperiod').to_i),
+            hkr_next_change_temp:   data.dig('hkr', 'nextchange', 'tchange').to_i * 0.5
+          )
+          instance
+        end
+      end
+
+      def update_hkr_temp_set(value)
+        raise ArgumentError unless value.is_a? BigDecimal
+        value = (value / 0.5).to_i
+        response = self.class.get(command: 'sethkrtsoll', ain: ain, param: value)
+        raise 'Could not set temperature' unless response.body == "#{value}\n"
+        true
+      end
+    end
+  end
+end

data/lib/fritzbox/smarthome/lightbulb.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module Fritzbox
+  module Smarthome
+    class Lightbulb < Actor
+
+      attr_accessor \
+        :simpleonoff_state
+
+      class << self
+        def match?(data)
+          data.fetch('@productname', '') =~ /FRITZ!DECT 5\d{2}/i
+        end
+
+        def new_from_api(data)
+          instance = super
+          instance.assign_attributes(
+            simpleonoff_state:   data.dig('simpleonoff', 'state').to_i,
+          )
+          instance
+        end
+      end
+
+      def active?
+        simpleonoff_state == 1
+      end
+
+      def toggle!
+        value = active? ? 0 : 1
+        response = self.class.get(command: 'setsimpleonoff', ain: ain, onoff: value)
+
+        response.ok? && @simpleonoff_state = value
+      end
+    end
+  end
+end

data/lib/fritzbox/smarthome/null_logger.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Fritzbox
+  module Smarthome
+    class NullLogger < Logger
+      def initialize(*_args)
+        super(File::NULL)
+      end
+    end
+  end
+end

data/lib/fritzbox/smarthome/resource.rb

@@ -2,11 +2,18 @@ module Fritzbox
   module Smarthome
     class Resource
       class << self
-        def get(command:, ain: nil, param: nil)
+        # @param params [Hash] key/value pairs that will be appended to the switchcmd query string
+        def get(command:, ain: nil, param: nil, **params)
           url = "#{config.endpoint}/webservices/homeautoswitch.lua?switchcmd=#{command}&sid=#{authenticate}"
           url = "#{url}&ain=#{ain}"     if ain.present?
           url = "#{url}&param=#{param}" if param.present?
 
+          params.each_with_object(url) do |(key, value)|
+            url = "#{url}&#{key}=#{value}"
+          end
+
+          config.logger.debug(url)
+
           HTTParty.get(url, **httparty_options)
         end
 

data/lib/fritzbox/smarthome/smoke_detector.rb

@@ -0,0 +1,25 @@
+module Fritzbox
+  module Smarthome
+    class SmokeDetector < Actor
+
+      attr_accessor \
+        :alert_state,
+        :last_alert
+
+      class << self
+        def match?(data)
+          data.key?('alert')
+        end
+
+        def new_from_api(data)
+          instance = super
+          instance.assign_attributes(
+             alert_state: data.dig('alert', 'state').to_i,
+             last_alert:  Time.at(data.dig('alert', 'lastalertchgtimestamp').to_i)
+          )
+          instance
+        end
+      end
+    end
+  end
+end

data/lib/fritzbox/smarthome/switch.rb

@@ -0,0 +1,41 @@
+module Fritzbox
+  module Smarthome
+    class Switch < Actor
+
+      attr_accessor \
+        :switch_state,
+        :switch_mode,
+        :switch_lock,
+        :switch_devicelock,
+        :simpleonoff_state,
+        :powermeter_voltage,
+        :powermeter_power,
+        :powermeter_energy,
+        :temperature_celsius,
+        :temperature_offset
+
+      class << self
+        def match?(data)
+          data.key?('switch')
+        end
+
+        def new_from_api(data)
+          instance = super
+          instance.assign_attributes(
+            switch_state:        data.dig('switch', 'state').to_i,
+            switch_mode:         data.dig('switch', 'mode').to_s,
+            switch_lock:         data.dig('switch', 'lock').to_i,
+            switch_devicelock:   data.dig('switch', 'devicelock').to_i,
+            simpleonoff_state:   data.dig('simpleonoff', 'state').to_i,
+            powermeter_voltage:  data.dig('powermeter', 'voltage').to_i,
+            powermeter_power:    data.dig('powermeter', 'power').to_i,
+            powermeter_energy:   data.dig('powermeter', 'energy').to_i,
+            temperature_celsius: data.dig('temperature', 'celsius').to_i,
+            temperature_offset:  data.dig('temperature', 'offset').to_i
+          )
+          instance
+        end
+      end
+    end
+  end
+end

data/lib/fritzbox/smarthome/version.rb

@@ -1,5 +1,5 @@
 module Fritzbox
   module Smarthome
-    VERSION = '0.1.3'.freeze
+    VERSION = '0.4.0'.freeze
   end
 end

data/lib/fritzbox/smarthome.rb

@@ -4,8 +4,13 @@ require 'httparty'
 require 'nori'
 
 require 'fritzbox/smarthome/version'
-require "fritzbox/smarthome/resource"
+require 'fritzbox/smarthome/null_logger'
+require 'fritzbox/smarthome/resource'
 require 'fritzbox/smarthome/actor'
+require 'fritzbox/smarthome/heater'
+require 'fritzbox/smarthome/switch'
+require 'fritzbox/smarthome/smoke_detector'
+require 'fritzbox/smarthome/lightbulb'
 
 module Fritzbox
   module Smarthome
@@ -25,7 +30,7 @@ module Fritzbox
       defaults.username   = 'smarthome'
       defaults.password   = 'verysmart'
       defaults.verify_ssl = true
-      defaults.logger     = nil
+      defaults.logger     = NullLogger.new
     end
 
     class << self

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fritzbox-smarthome
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.4.0
 platform: ruby
 authors:
 - Klaus Meyer
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-01-01 00:00:00.000000000 Z
+date: 2022-05-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -17,9 +17,9 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '5.1'
-    - - "<"
+    - - "<="
       - !ruby/object:Gem::Version
-        version: '6.2'
+        version: '7.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -27,9 +27,9 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '5.1'
-    - - "<"
+    - - "<="
       - !ruby/object:Gem::Version
-        version: '6.2'
+        version: '7.1'
 - !ruby/object:Gem::Dependency
   name: activemodel
   requirement: !ruby/object:Gem::Requirement
@@ -37,9 +37,9 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '5.1'
-    - - "<"
+    - - "<="
       - !ruby/object:Gem::Version
-        version: '6.2'
+        version: '7.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -47,23 +47,23 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '5.1'
-    - - "<"
+    - - "<="
       - !ruby/object:Gem::Version
-        version: '6.2'
+        version: '7.1'
 - !ruby/object:Gem::Dependency
   name: httparty
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.16'
+        version: '0.20'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.16'
+        version: '0.20'
 - !ruby/object:Gem::Dependency
   name: nori
   requirement: !ruby/object:Gem::Requirement
@@ -84,14 +84,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.8'
+        version: '1.13'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.8'
+        version: '1.13'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -112,42 +112,42 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '3.11'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '3.11'
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.3'
+        version: '3.14'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.3'
+        version: '3.14'
 - !ruby/object:Gem::Dependency
   name: byebug
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '11.0'
+        version: '11.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '11.0'
+        version: '11.1'
 description: ''
 email:
 - spam@klaus-meyer.net
@@ -170,7 +170,12 @@ files:
 - fritzbox-smarthome.gemspec
 - lib/fritzbox/smarthome.rb
 - lib/fritzbox/smarthome/actor.rb
+- lib/fritzbox/smarthome/heater.rb
+- lib/fritzbox/smarthome/lightbulb.rb
+- lib/fritzbox/smarthome/null_logger.rb
 - lib/fritzbox/smarthome/resource.rb
+- lib/fritzbox/smarthome/smoke_detector.rb
+- lib/fritzbox/smarthome/switch.rb
 - lib/fritzbox/smarthome/version.rb
 homepage: https://github.com/klausmeyer/fritzbox-smarthome
 licenses:
@@ -191,7 +196,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.3.7
 signing_key:
 specification_version: 4
 summary: Client library to interface with Smarthome features of your FritzBox