fritzbox-smarthome 0.4.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 430136a0736fded1a9e2cf308cdeb00129e94514259915306146fc65be4fb04a
-  data.tar.gz: 8755e3f921c2c815b1e6d38d3372bcfff068e6a8aa7a47785d07213585e67101
+  metadata.gz: 87ca99bd2b9c7f0ab8cc157255593d9211b16e168f838e3a7b643dd273b541e2
+  data.tar.gz: c9d862aa7dfae2b02cb16694e2caf8595397fbdc990e84fb0539159b1a5dfee6
 SHA512:
-  metadata.gz: 94ac858e01f25649f9171df8cf685658b4a4e17f5c230a1394569c37d3052444ed1b155d8eb9a58d61fc056eb471347ee5c0c163b0a777651a8abceac4a3c76a
-  data.tar.gz: 198756b6e8a1d7d2cfcf886e26f5e2efd3d75eb655d2533e94074c936b42da531d58147ceba13e3a54b5e621f66fe99f56fe5652cbdd6c2b64294a095fa5e22e
+  metadata.gz: de120146d37f15a50a43c0ba89c19cee46f91131a4765a01d518cedf897ecaa053269c6cae7bb5a6ccbdd35bd48904571722c6bafcd475d28e92ce4ff636d63c
+  data.tar.gz: 62629678cefbef554aa83ff465a3086661c0100075375723fdefe0ab655816b441da4c17aabba5c8d9462172cd559d6d64461ca584ed496c4c4769f5e815f9ea

data/.ruby-version

@@ -1 +1 @@
-3.1.2
+3.1.3

data/CHANGELOG.md

@@ -1,5 +1,16 @@
 # Changelog
 
+## v0.6.0
+
+* Add support for `Actor.find_by!(ain:)` and `Actor#reload`
+
+## v0.5.0
+
+* Unify on/off interface
+  * Provides `#active?` and `#toggle!` methods
+  * Adds new functionality to `Switch`
+  * Replacing own implementation in `Lightbulb`
+
 ## v0.4.0
 
 * Add support for Fritz!DECT lightbulbs

data/README.md

@@ -5,6 +5,7 @@ Ruby client library to interface with Smarthome features of your FritzBox.
 Currently implemented actor types:
 
 * Heater
+* Lightbulb
 * SmokeDetector
 * Switch
 
@@ -40,6 +41,12 @@ actors = Fritzbox::Smarthome::Actor.all
 # Get all actors of type Heater
 heaters = Fritzbox::Smarthome::Heater.all
 heaters.last.update_hkr_temp_set(BigDecimal('21.5'))
+
+# Get a specific actor via it's AIN
+actor = Fritzbox::Smarthome::Actor.find_by!(ain: '0815 4711')
+
+# Reload the data of an already fetched actor
+actor.reload
 ```
 
 ## Development

data/fritzbox-smarthome.gemspec

@@ -14,7 +14,7 @@ Gem::Specification.new do |spec|
   spec.license       = 'MIT'
 
   spec.files         = `git ls-files -z`.split("\x0").reject do |f|
-    f.match(%r{^(test|spec|features)/})
+    f.match(%r{^(test|spec|features|examples)/})
   end
   spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }

data/lib/fritzbox/smarthome/actor.rb

@@ -4,36 +4,63 @@ module Fritzbox
       include ActiveModel::Model
 
       attr_accessor \
-        :id,
-        :type,
-        :ain,
-        :present,
-        :name,
-        :manufacturer,
-        :group_members
+      :id,
+      :type,
+      :ain,
+      :present,
+      :name,
+      :manufacturer,
+      :group_members
+
+      ResourceNotFound = Class.new(RuntimeError)
 
       class << self
         def all(types: ['group', 'device'])
-          response = get(command: 'getdevicelistinfos')
-          xml = nori.parse(response.body)
+          xml = parse(get(command: 'getdevicelistinfos'))
+
           Array.wrap(types.map { |type| xml.dig('devicelist', type) }.flatten).compact.map do |data|
             klass = Actor.descendants.find { |k| k.match?(data) } || Actor
             self.in?([klass, Actor]) ? klass.new_from_api(data) : nil
           end.compact
         end
 
+        def find_by!(ain: nil)
+          data = parse(get(command: 'getdeviceinfos', ain: ain)).fetch('device')
+          klass = Actor.descendants.find { |k| k.match?(data) } || Actor
+
+          instance = klass.new(ain: ain)
+          instance.assign_from_api(data)
+          instance
+        rescue KeyError
+          raise ResourceNotFound, "Unable to find actor with ain='#{ain}'"
+        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') || data.dig('@productname')).to_s,
-            manufacturer:  (data.dig('manufacturer') || data.dig('@manufacturer')).to_s,
-            group_members: data.dig('groupinfo', 'members').to_s.split(',').presence
-          )
+          instance = new
+          instance.assign_from_api(data)
+          instance
         end
       end
+
+      def assign_from_api(data)
+        assign_attributes(
+          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
+
+      def reload
+        xml = parse(get(command: 'getdeviceinfos', ain: ain))
+        assign_from_api(xml.fetch('device'))
+        self
+      rescue KeyError
+        raise ResourceNotFound, "Unable to reload actor with ain='#{ain}'"
+      end
     end
   end
 end

data/lib/fritzbox/smarthome/heater.rb

@@ -14,19 +14,19 @@ module Fritzbox
         def match?(data)
           data.key?('hkr')
         end
+      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
+      def assign_from_api(data)
+        super(data)
+
+        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
+        )
       end
 
       def update_hkr_temp_set(value)

data/lib/fritzbox/smarthome/lightbulb.rb

@@ -4,32 +4,12 @@ module Fritzbox
   module Smarthome
     class Lightbulb < Actor
 
-      attr_accessor \
-        :simpleonoff_state
+      include Properties::SimpleOnOff
 
       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

data/lib/fritzbox/smarthome/properties/simple_on_off.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+module Fritzbox
+  module Smarthome
+    module Properties
+      # Defines a common interface/behaviour for actors with the "simpleonoff" state.
+      # The including class is expected to have an `ain` attribute defined.
+      module SimpleOnOff
+        extend ActiveSupport::Concern
+
+        included do
+          attr_accessor :simpleonoff_state
+        end
+
+        module ClassMethods
+          def new_from_api(data)
+            instance = defined?(super) ? super : new
+            instance.simpleonoff_state = data.dig('simpleonoff', 'state').to_i
+            instance
+          end
+        end
+
+        # @return [Boolean]
+        def active?
+          simpleonoff_state.to_s == "1"
+        end
+
+        # Makes a request to the Fritzbox and set the current instance's active state.
+        #
+        # The instance state is kept in memory and not checked with the Fritzbox state. It is
+        # possible that the device is switched on/off through other means.
+        #
+        # @example
+        #     lightbulb.active?
+        #     # => true
+        #     lightbulb.toggle!
+        #     # => 0
+        #     lightbulb.active?
+        #     # => false
+        # @return [false, Integer] Returns the new on/off state or false when the request
+        #     was unsuccessful
+        # @raise [ArgumentError] if the including class does not respond to `#ain`
+        def toggle!
+          raise ArgumentError, "Attribute `ain` is missing on #{inspect}" unless respond_to?(:ain)
+          value = active? ? 0 : 1
+          response =
+            Fritzbox::Smarthome::Resource.get(command: 'setsimpleonoff', ain: ain, onoff: value)
+
+          response.ok? && @simpleonoff_state = value
+        end
+      end
+    end
+  end
+end

data/lib/fritzbox/smarthome/properties.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require 'fritzbox/smarthome/properties/simple_on_off'
+
+module Fritzbox
+  module Smarthome
+    module Properties
+    end
+  end
+end

data/lib/fritzbox/smarthome/resource.rb

@@ -17,6 +17,10 @@ module Fritzbox
           HTTParty.get(url, **httparty_options)
         end
 
+        def parse(response)
+          nori.parse(response.body)
+        end
+
         private
 
         delegate :config, to: Smarthome
@@ -52,6 +56,8 @@ module Fritzbox
           @nori ||= Nori.new
         end
       end
+
+      delegate :get, :parse, to: :class
     end
   end
 end

data/lib/fritzbox/smarthome/smoke_detector.rb

@@ -10,15 +10,15 @@ module Fritzbox
         def match?(data)
           data.key?('alert')
         end
+      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
+      def assign_from_api(data)
+        super(data)
+
+        assign_attributes(
+          alert_state: data.dig('alert', 'state').to_i,
+          last_alert:  Time.at(data.dig('alert', 'lastalertchgtimestamp').to_i)
+        )
       end
     end
   end

data/lib/fritzbox/smarthome/switch.rb

@@ -2,12 +2,13 @@ module Fritzbox
   module Smarthome
     class Switch < Actor
 
+      include Properties::SimpleOnOff
+
       attr_accessor \
         :switch_state,
         :switch_mode,
         :switch_lock,
         :switch_devicelock,
-        :simpleonoff_state,
         :powermeter_voltage,
         :powermeter_power,
         :powermeter_energy,
@@ -18,23 +19,22 @@ module Fritzbox
         def match?(data)
           data.key?('switch')
         end
+      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
+      def assign_from_api(data)
+        super(data)
+
+        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,
+          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
+        )
       end
     end
   end

data/lib/fritzbox/smarthome/version.rb

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

data/lib/fritzbox/smarthome.rb

@@ -5,6 +5,7 @@ require 'nori'
 
 require 'fritzbox/smarthome/version'
 require 'fritzbox/smarthome/null_logger'
+require 'fritzbox/smarthome/properties'
 require 'fritzbox/smarthome/resource'
 require 'fritzbox/smarthome/actor'
 require 'fritzbox/smarthome/heater'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fritzbox-smarthome
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Klaus Meyer
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-05-15 00:00:00.000000000 Z
+date: 2022-12-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -173,6 +173,8 @@ files:
 - lib/fritzbox/smarthome/heater.rb
 - lib/fritzbox/smarthome/lightbulb.rb
 - lib/fritzbox/smarthome/null_logger.rb
+- lib/fritzbox/smarthome/properties.rb
+- lib/fritzbox/smarthome/properties/simple_on_off.rb
 - lib/fritzbox/smarthome/resource.rb
 - lib/fritzbox/smarthome/smoke_detector.rb
 - lib/fritzbox/smarthome/switch.rb