cocoro 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 45dac1b85f589ac09c01682a1edc38cb0176736c09c7925a840f9dc2f1ccdbc9
-  data.tar.gz: 9a184111ee00c3491226efbef049b925bbd7f2e2322cfa3bf3c70645fe157e65
+  metadata.gz: 0fc40cbd13bb06a8555da9d6939190793b159fd06ffe8d651cfa9cb5350bac62
+  data.tar.gz: 6042dfbba25e20371af33af4ef6942948c3c13271426fc3328ea831b4f13ac54
 SHA512:
-  metadata.gz: abc7cf5682668a46f109acab88449a7266c6c2cd08f9503c7234b2c71760f1778c8eff6cb81eb7ebe5b074d17f2da256ece113e2e4ee2e9f9864157f715e9152
-  data.tar.gz: 834021cdc1a98adeb9156961f2d36dc1098572dee7a468b62b4df0522897024a321802201758a7bd3fbfca6c7ccdb2e094987d2041ec0d406f6c4b560528e0c0
+  metadata.gz: 82d9251f028fc3d265a81764f72bd725558b7fb6ca98a87752070af04a74a5625f3330cef4d5c0199d4158be9eb37c58443e9530ac2ec90ee5e540ab043eaddc
+  data.tar.gz: e42598903d675c80ac8e934358f937a0242b271edb61dadab77dfdb9132448f15416282d3670c6888aad2933d200bf08f949c0e7b76a34bb4b076a3f633afb76

data/.rubocop.yml

@@ -26,3 +26,4 @@ Metrics/ModuleLength:
 Metrics/BlockLength:
   Exclude:
   - spec/**/*_spec.rb
+  - cocoro.gemspec

data/Gemfile.lock

@@ -83,6 +83,7 @@ GEM
 
 PLATFORMS
   x86_64-darwin-20
+  x86_64-linux
 
 DEPENDENCIES
   cocoro!

data/lib/cocoro/client.rb

@@ -27,6 +27,8 @@ module Cocoro
     DEFAULT_RESULT_CHECK_INTERVAL = 0.7 # seconds
     DEFAULT_RESULT_CHECK_MAX_ATTEMPTS = 20
 
+    attr_accessor :logger
+
     def initialize(app_secret:, terminal_app_id_key:, logger: nil)
       @app_secret = app_secret
       @terminal_app_id_key = terminal_app_id_key
@@ -56,25 +58,17 @@ module Cocoro
         body,
         {}
       )
+    rescue Faraday::Error
+      raise Cocoro::ServerError
     end
 
     def devices
-      response = @client.get(
-        "setting/boxInfo?appSecret=#{CGI.escape(@app_secret)}&mode=other"
-      )
-      json = response.body
-      json["box"].flat_map do |box|
-        box["echonetData"].map do |data|
-          Cocoro::Device.new(
-            client: self,
-            box_id: box["boxId"],
-            device_id: data["deviceId"],
-            echonet_node: data["echonetNode"],
-            echonet_object: data["echonetObject"],
-            name: data["labelData"]["name"]
-          )
-        end
+      response = handle_server_errors do
+        @client.get(
+          "setting/boxInfo?appSecret=#{CGI.escape(@app_secret)}&mode=other"
+        )
       end
+      Cocoro::Device.parse_box_info(response.body["box"], self)
     end
 
     def device_status(device:)
@@ -84,9 +78,11 @@ module Cocoro
         echonetNode: device.echonet_node,
         echonetObject: device.echonet_object
       }.map { |k, v| [k, CGI.escape(v)].join("=") }
-      response = @client.get(
-        "control/deviceStatus?#{query_params.join("&")}"
-      )
+      response = handle_server_errors do
+        @client.get(
+          "control/deviceStatus?#{query_params.join("&")}"
+        )
+      end
       json = response.body
       Cocoro::Status.new(json["deviceStatus"]["status"])
     end
@@ -118,17 +114,19 @@ module Cocoro
         appSecret: @app_secret,
         boxId: device.box_id
       }.map { |k, v| [k, CGI.escape(v)].join("=") }
-      response = @client.post(
-        "control/deviceControl?#{query_params.join("&")}",
-        controlList: [
-          {
-            deviceId: device.device_id,
-            echonetNode: device.echonet_node,
-            echonetObject: device.echonet_object,
-            status: changes
-          }
-        ]
-      )
+      response = handle_server_errors do
+        @client.post(
+          "control/deviceControl?#{query_params.join("&")}",
+          controlList: [
+            {
+              deviceId: device.device_id,
+              echonetNode: device.echonet_node,
+              echonetObject: device.echonet_object,
+              status: changes
+            }
+          ]
+        )
+      end
       response.body["controlList"].first["id"]
     end
 
@@ -137,15 +135,25 @@ module Cocoro
         appSecret: @app_secret,
         boxId: device.box_id
       }.map { |k, v| [k, CGI.escape(v)].join("=") }
-      response = @client.post(
-        "control/controlResult?#{query_params.join("&")}",
-        resultList: [{ id: request_id }]
-      )
+      response = handle_server_errors do
+        @client.post(
+          "control/controlResult?#{query_params.join("&")}",
+          resultList: [{ id: request_id }]
+        )
+      end
       result = response.body["resultList"].first
       @logger.info("Status: #{result["status"]}")
       raise Cocoro::Error, "Error code: #{result["errorCode"]}" if result["status"] == "error"
 
       result
     end
+
+    def handle_server_errors(&block)
+      block.call
+    rescue Faraday::UnauthorizedError, Faraday::ForbiddenError
+      raise Cocoro::AuthError
+    rescue Faraday::Error
+      raise Cocoro::ServerError
+    end
   end
 end

data/lib/cocoro/device.rb

@@ -11,8 +11,29 @@ module Cocoro
     :echonet_node,
     :echonet_object,
     :name,
+    :type,
+    :maker,
+    :model,
     keyword_init: true
   ) do
+    def self.parse_box_info(box_info, client)
+      box_info.flat_map do |box|
+        box["echonetData"].map do |data|
+          new(
+            client: client,
+            box_id: box["boxId"],
+            device_id: data["deviceId"],
+            echonet_node: data["echonetNode"],
+            echonet_object: data["echonetObject"],
+            name: data["labelData"]["name"],
+            type: data["labelData"]["deviceType"],
+            maker: data["maker"],
+            model: data["model"]
+          )
+        end
+      end
+    end
+
     def status
       @status || fetch_status!
     end

data/lib/cocoro/error.rb

@@ -1,6 +1,18 @@
 # frozen_string_literal: true
 
 module Cocoro
+  # Base error class
   class Error < StandardError
   end
+
+  # Any non-200 response from the API
+  #
+  # That includes 400 responses which seems to be happening
+  # occasionally without any fault on the client side.
+  class ServerError < Cocoro::Error
+  end
+
+  # 401 or 403 error
+  class AuthError < Cocoro::ServerError
+  end
 end

data/lib/cocoro/status.rb

@@ -9,23 +9,21 @@ module Cocoro
       temperature: ["F1", 4, 1], # °C
       humidity: ["F1", 5, 1], # %
       total_air_cleaned: ["F1", 22, 4], # m^3
-      pm25: ["F1", 28, 2], # ug/m^3 : sometimes weird values because of the first byte
-      f2unknown1: ["F2", 1, 1],
-      smell: ["F2", 15, 1], # 0/33/66/100 (100=dirty)
+      pm25: ["F1", 28, 2], # ug/m^3, only last 9 bits are important
+      odor: ["F2", 15, 1], # 0/33/66/100 (100=dirty)
       dust: ["F2", 16, 1], # 0/25/50/75/100 (100=dirty)
-      overall_cleanliness: ["F2", 18, 1], # 0/25/50/75/100 (100=dirty)
-      f2unknown19: ["F2", 19, 1],
+      overall_dirtiness: ["F2", 18, 1], # 0/25/50/75/100 (100=dirty)
       enough_water: ["F2", 20, 1],
       light_detected: ["F2", 21, 1],
       air_volume: ["F3", 5, 1],
       power_on: ["F3", 14, 1],
-      humidifier_on: ["F3", 16, 1],
-      f3unknown20: ["F3", 20, 1]
+      humidifier_on: ["F3", 16, 1]
     }.freeze
     VALUES = {
       enough_water: { 0 => false, 255 => true },
       light_detected: { 0 => false, 255 => true },
       air_volume: {
+        0 => nil,
         16 => "auto",
         17 => "night",
         19 => "pollen",
@@ -41,7 +39,7 @@ module Cocoro
 
     BOOLEAN_FIELDS = %i[enough_water light_detected power_on humidifier_on].freeze
     NON_BOOLEAN_FIELDS = %i[
-      temperature humidity total_air_cleaned pm25 smell dust overall_cleanliness air_volume
+      temperature humidity total_air_cleaned pm25 odor dust overall_dirtiness air_volume
     ].freeze
 
     def initialize(array_of_status_data)
@@ -56,12 +54,9 @@ module Cocoro
       define_method(field) { read_value(field) }
     end
 
-    # Get other data that we're not sure what it means, but could be useful for debugging
-    def unknowns
-      LOCATIONS
-        .keys
-        .select { |key| key.to_s =~ /unknown/ }
-        .map { |key| [key, read_value(key)] }
+    def to_h
+      (BOOLEAN_FIELDS + NON_BOOLEAN_FIELDS)
+        .map { |f| [f, read_value(f)] }
         .to_h
         .merge(
           f1: read_binary_status("F1"),
@@ -70,13 +65,6 @@ module Cocoro
         )
     end
 
-    def to_h
-      (BOOLEAN_FIELDS + NON_BOOLEAN_FIELDS)
-        .map { |f| [f, read_value(f)] }
-        .to_h
-        .merge(unknowns)
-    end
-
     protected
 
     def read_value(name)
@@ -87,6 +75,8 @@ module Cocoro
       number = hex_code[(byte_offset - 1) * 2, byte_length * 2].to_i(16)
       if VALUES[name]&.key?(number)
         VALUES[name][number]
+      elsif name == :pm25
+        number & ((2**9) - 1) # last 9 bits only
       else
         number
       end

data/lib/cocoro/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Cocoro
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cocoro
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Tomasz Szczęśniak-Szlagowski
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-01-06 00:00:00.000000000 Z
+date: 2022-01-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -159,7 +159,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.15
+rubygems_version: 3.1.6
 signing_key:
 specification_version: 4
 summary: An unofficial Cocoro Air client