fritzbox-smarthome 0.1.3 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 782cdee20c938c01c4ee6f6560e05f7a7636d8b9315e6c63f577959e3df85f45
-  data.tar.gz: a33ea016b04d0a710d13e0e1089850d74f1d16f14e9346683fac961640be2851
+  metadata.gz: d754754bef500b80a9c564a254f1df9104e69ba518484a6e1cbecea64332e2b0
+  data.tar.gz: 21b050b1a1e3fbb4810a3b7e6fea598eb877d08588073aa63af6043f75ca87ba
 SHA512:
-  metadata.gz: af9c5ed89753c194f8eefaf29dcf4893e9f68c99e7595cb95196b778b9bdbce2a7a6e2efa0b650ddf52f5fccab2e19f0bd065be68a4d805f1f94b96990a6fd61
-  data.tar.gz: 4aabacf20397befaf87d069307e2bc525bfaee04ecae6563d63ee4b1c6487f62ede5f75d850257e63fecf87ade33c21b7ef85877a00de4fde861b763b0fb7137
+  metadata.gz: c5df4e76d262a3d441e68c73abb48f5bda3ad3b588756f2344f1a8dd174e16ccaf98d4858d87beb45bebf96a99dca6e1a434c9c3b0db078b1474ff2264a81dba
+  data.tar.gz: 13637177a564bead4b2a331fd18fd2ec90677b3aa117b4be69d3bcda6b5f9f574763b178c88e5bd2fe6e166d087380ca963c0df6b3aea3561ffec855980d4f2c

data/CHANGELOG.md

@@ -1,5 +1,12 @@
 # Changelog
 
+## 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::Heaters.all
+heaters.last.update_hkr_temp_set(BigDecimal('21.5'))
 ```
 
 ## Development

data/lib/fritzbox/smarthome.rb

@@ -4,8 +4,11 @@ require 'httparty'
 require 'nori'
 
 require 'fritzbox/smarthome/version'
-require "fritzbox/smarthome/resource"
+require 'fritzbox/smarthome/resource'
 require 'fritzbox/smarthome/actor'
+require 'fritzbox/smarthome/heater'
+require 'fritzbox/smarthome/switch'
+require 'fritzbox/smarthome/smoke_detector'
 
 module Fritzbox
   module Smarthome

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) }
+            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').to_s,
+            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/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.2.0'.freeze
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fritzbox-smarthome
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.2.0
 platform: ruby
 authors:
 - Klaus Meyer
-autorequire:
+autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-01-01 00:00:00.000000000 Z
+date: 2021-01-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -170,13 +170,16 @@ files:
 - fritzbox-smarthome.gemspec
 - lib/fritzbox/smarthome.rb
 - lib/fritzbox/smarthome/actor.rb
+- lib/fritzbox/smarthome/heater.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:
 - MIT
 metadata: {}
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -191,8 +194,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
-signing_key:
+rubygems_version: 3.2.3
+signing_key: 
 specification_version: 4
 summary: Client library to interface with Smarthome features of your FritzBox
 test_files: []