dji_mqtt_connect 0.1.13.1 → 0.1.14

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c144a661c638e1cab414b4798f2fad92e0f39f9fe4f8e433b0140073f92b0735
-  data.tar.gz: 21df706b1a4f9dafbd3c8286113dea89cd476d292811cb1d2ba4f59a920d7d83
+  metadata.gz: cbf7e03c9debc9957d9d8fadc1fa6126377a14574f5f0cdc24009afac5b77bc5
+  data.tar.gz: e86ae21b238e3c0063cd42c584544350ba30b8e60eb8241c43b4d8cedb69aedf
 SHA512:
-  metadata.gz: '07308e461f220bb9b2e41210a673a00cbcaac25856c00ba019999db97e978d6c8cc37b0125a4f49784edae8956e6c3759a11c5abbdd07e3cd74381969c9b243e'
-  data.tar.gz: 651bfdc62aaacac40908c807d59903bf09a866fccd4a80aa91e2c8d5cd0db0e24e39b5710329591e99263cf834ecfa2b1787fd55ff608727daec0c2c06856f9e
+  metadata.gz: 5930cd00dbb6d2779af90659fdde1b70e2cf31247a1f31dcc3f6a4301f7663117bf06d061dfc1c1d101100c43ce040003fff5152435ad5b4bf1536cea74035a9
+  data.tar.gz: 4df8067dff28fb839f2e849b426760fa44ce2f7b9bb5f676c85daae15e54f9395030a3f6f047016f6aaa6ee9d328d75176ccc97d072615be1fb0ea6fd3d42b10

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    dji_mqtt_connect (0.1.13.1)
+    dji_mqtt_connect (0.1.14)
       activesupport (>= 6.0, <= 8)
       dry-struct (~> 1.6)
       dry-transformer (~> 1.0)

data/config/locales/{dji_mqtt_connect.en.yml → hms_event_codes.en.yml}

@@ -750,7 +750,7 @@
       fpv_tip_0x16100006_in_the_sky: Invalid IMU serial number. Return to home or
         land
       fpv_tip_0x16100008: Compass calibrating. Unable to take off. Wait for calibration
-        to complete before taking off(%{alarmid})
+        to complete before taking off (%{alarmid})
       fpv_tip_0x16100008_in_the_sky: Compass calibrating. Wait for calibration to
         complete before taking off
       fpv_tip_0x16100009: Sensor system initializing. Unable to take off. Wait for

data/config/locales/services_output_status.en.yml

@@ -0,0 +1,13 @@
+---
+:en:
+  :dji_mqtt_connect:
+    :cover_step_key:
+      check_drone_sdr_connect_state: "Check Drone SDR Connect State"
+      check_scram_state: "Check SCRAM State"
+      core_mcu_reboot: "Core MCU Reboot"
+      land_mcu_reboot: "Land MCU Reboot"
+      rain_mcu_reboot: "Rain MCU Reboot"
+      sdr_reboot: "SDR Reboot"
+    :services_output_status:
+      ok: "Success"
+      canceled: "Canceled or Stopped"

data/lib/dji_mqtt_connect/messages/thing/product/events/cover_close.rb

@@ -9,17 +9,10 @@ module DjiMqttConnect
         attribute :result, Types::Integer
 
         attribute :output do
+          include Mixins::ServicesOutputStatusChecks
+
           # {"sent":"sent","in_progress":"in progress","ok":"success","paused":"paused","rejected":"rejected","failed":"failed","canceled":"canceled or stopped","timeout":"timeout"}
-          attribute :status, Types::String.enum(
-            "sent",
-            "in_progress",
-            "ok",
-            "paused",
-            "rejected",
-            "failed",
-            "canceled",
-            "timeout"
-          )
+          attribute :status, Types::ServicesOutputStatus
 
           attribute :progress do
             # {"min":"0","max":"100","step":"1"}
@@ -56,6 +49,12 @@ module DjiMqttConnect
               "stop_charge"
             )
 
+            def humanized_step_key
+              return unless step_key
+
+              I18n.t(step_key, scope: "dji_mqtt_connect.cover_step_key", default: step_key.titleize)
+            end
+
             attribute? :step_result, Types::Integer
           end
         end

data/lib/dji_mqtt_connect/messages/thing/product/events/cover_open.rb

@@ -9,17 +9,10 @@ module DjiMqttConnect
         attribute :result, Types::Integer
 
         attribute :output do
+          include Mixins::ServicesOutputStatusChecks
+
           # {"sent":"sent","in_progress":"in progress","ok":"success","paused":"paused","rejected":"rejected","failed":"failed","canceled":"canceled or stopped","timeout":"timeout"}
-          attribute :status, Types::String.enum(
-            "sent",
-            "in_progress",
-            "ok",
-            "paused",
-            "rejected",
-            "failed",
-            "canceled",
-            "timeout"
-          )
+          attribute :status, Types::ServicesOutputStatus
 
           attribute :progress do
             # {"min":"0","max":"100","step":"1"}
@@ -56,6 +49,12 @@ module DjiMqttConnect
               "stop_charge"
             )
 
+            def humanized_step_key
+              return unless step_key
+
+              I18n.t(step_key, scope: "dji_mqtt_connect.cover_step_key", default: step_key.titleize)
+            end
+
             attribute? :step_result, Types::Integer
           end
         end

data/lib/dji_mqtt_connect/messages/thing/product/osd/dock.rb

@@ -53,7 +53,20 @@ module DjiMqttConnect
 
         attribute? :drone_charge_state do
           # {"0":"not charging","1":"charging"}
-          attribute :state, Types::Integer.enum(0, 1)
+          attribute :state, Types::Integer.enum(
+            STATE_NOT_CHARGING = 0,
+            STATE_CHARGING = 1
+          )
+
+          def humanized_state
+            state_key = case state
+            when STATE_NOT_CHARGING
+              "Not Charging"
+            when STATE_CHARGING
+              "Charging"
+            end
+            I18n.t(state_key.parameterize.underscore, scope: "dji_mqtt_connect.dock_drone_charge_state.state", default: state_key)
+          end
 
           # {"min":"0","max":"100"}
           attribute :capacity_percent, Types::Integer.constrained(gteq: 0, lteq: 100)
@@ -88,9 +101,38 @@ module DjiMqttConnect
         end
 
         attribute? :network_state do
-          attribute :type, Types::Integer
-          attribute :quality, Types::Integer
+          attribute :type, Types::Integer.enum(
+            NETWORK_TYPE_4G = 1,
+            NETWORK_TYPE_ETHERNET = 2
+          )
+          attribute :quality, Types::Integer.enum(
+            QUALITY_BAD = 0,
+            QUALITY_MODERATE = 1,
+            QUALITY_GOOD = 2
+          )
           attribute :rate, Types::JSON::Decimal
+
+          def humanized_type
+            type_key = case type
+            when NETWORK_TYPE_4G
+              "4G"
+            when NETWORK_TYPE_ETHERNET
+              "Ethernet"
+            end
+            I18n.t(type_key.downcase, scope: "dji_mqtt_connect.dock_network_state.type", default: type_key)
+          end
+
+          def humanized_quality
+            quality_key = case quality
+            when QUALITY_BAD
+              "Bad"
+            when QUALITY_MODERATE
+              "Moderate"
+            when QUALITY_GOOD
+              "Good"
+            end
+            I18n.t(quality_key.downcase, scope: "dji_mqtt_connect.dock_network_state.quality", default: quality_key)
+          end
         end
 
         attribute? :sdr do
@@ -164,22 +206,114 @@ module DjiMqttConnect
         end
 
         # {"0":"Closed","1":"Opened"}
-        attribute? :alarm_state, Types::Integer.enum(0, 1)
+        attribute? :alarm_state, Types::Integer.enum(
+          ALARM_STATE_CLOSED = 0,
+          ALARM_STATE_OPEN = 1
+        )
+
+        def humanized_alarm_state
+          return unless alarm_state
+
+          state_key = case alarm_state
+          when ALARM_STATE_CLOSED
+            "Closed"
+          when ALARM_STATE_OPEN
+            "Open"
+          end
+
+          I18n.t(state_key.downcase, scope: "dji_mqtt_connect.dock_alarm_state", default: state_key)
+        end
 
         # {"1":"Planned storage strategy of battery","2":"Emergency storage strategy of battery"}
         attribute? :battery_store_mode, Types::Integer.enum(1, 2)
 
         # {"0":"Closed","1":"Opened","2":"Half-open","3":"Cover state is abnormal"}
-        attribute? :cover_state, Types::Integer.enum(0, 1, 2, 3)
+        attribute? :cover_state, Types::Integer.enum(
+          COVER_STATE_CLOSED = 0,
+          COVER_STATE_OPEN = 1,
+          COVER_STATE_HALF_OPEN = 2,
+          COVER_STATE_ABNORMAL = 3
+        )
+
+        def humanized_cover_state
+          return unless cover_state
+
+          state_key = case cover_state
+          when COVER_STATE_CLOSED
+            "Closed"
+          when COVER_STATE_OPEN
+            "Open"
+          when COVER_STATE_HALF_OPEN
+            "Half-open"
+          when COVER_STATE_ABNORMAL
+            "Abnormal"
+          end
+
+          I18n.t(state_key.parameterize.underscore, scope: "dji_mqtt_connect.dock_cover_state", default: state_key)
+        end
 
         # {"0":"Closed","1":"Opened"}
-        attribute? :emergency_stop_state, Types::Integer.enum(0, 1)
+        attribute? :emergency_stop_state, Types::Integer.enum(
+          EMERGENCY_STOP_STATE_CLOSED = 0,
+          EMERGENCY_STOP_STATE_OPEN = 1
+        )
+
+        def humanized_emergency_stop_state
+          return unless emergency_stop_state
+
+          state_key = case emergency_stop_state
+          when EMERGENCY_STOP_STATE_CLOSED
+            "Closed"
+          when EMERGENCY_STOP_STATE_OPEN
+            "Open"
+          end
+
+          I18n.t(state_key.downcase, scope: "dji_mqtt_connect.dock_emergency_stop_state", default: state_key)
+        end
 
         # {"0":"Closed","1":"Opened","2":"Half-open","3":"Putter state is abnormal"}
-        attribute? :putter_state, Types::Integer.enum(0, 1, 2, 3)
+        attribute? :putter_state, Types::Integer.enum(
+          PUTTER_STATE_CLOSED = 0,
+          PUTTER_STATE_OPEN = 1,
+          PUTTER_STATE_HALF_OPEN = 2,
+          PUTTER_STATE_ABNORMAL = 3
+        )
+
+        def humanized_putter_state
+          return unless putter_state
+
+          state_key = case putter_state
+          when PUTTER_STATE_CLOSED
+            "Closed"
+          when PUTTER_STATE_OPEN
+            "Open"
+          when PUTTER_STATE_HALF_OPEN
+            "Half-open"
+          when PUTTER_STATE_ABNORMAL
+            "Abnormal"
+          end
+
+          I18n.t(state_key.parameterize.underscore, scope: "dji_mqtt_connect.dock_putter_state", default: state_key)
+        end
 
         # {"0":"Closed","1":"Opened"}
-        attribute? :supplement_light_state, Types::Integer.enum(0, 1)
+        attribute? :supplement_light_state, Types::Integer.enum(
+          SUPPLEMENT_LIGHT_STATE_CLOSED = 0,
+          SUPPLEMENT_LIGHT_STATE_OPEN = 1
+        )
+
+        def humanized_supplement_light_state
+          return unless supplement_light_state
+
+          state_key = case supplement_light_state
+          when SUPPLEMENT_LIGHT_STATE_CLOSED
+            "Closed"
+          when SUPPLEMENT_LIGHT_STATE_OPEN
+            "Open"
+          end
+
+          I18n.t(state_key.downcase, scope: "dji_mqtt_connect.dock_supplement_light_state", default: state_key)
+        end
 
         attribute? :sub_device do
           attribute? :device_sn, Types::String

data/lib/dji_mqtt_connect/messages/thing/product/services_reply/alarm_state_switch.rb

@@ -9,17 +9,10 @@ module DjiMqttConnect
         attribute :result, Types::Integer
 
         attribute :output do
+          include Mixins::ServicesOutputStatusChecks
+
           # {"sent":"sent","in_progress":"in progress","ok":"success","paused":"paused","rejected":"rejected","failed":"failed","canceled":"canceled or stopped","timeout":"timeout"}
-          attribute :status, Types::String.enum(
-            "sent",
-            "in_progress",
-            "ok",
-            "paused",
-            "rejected",
-            "failed",
-            "canceled",
-            "timeout"
-          )
+          attribute :status, Types::ServicesOutputStatus
         end
       end
     end

data/lib/dji_mqtt_connect/messages/thing/product/services_reply/cover_close.rb

@@ -9,17 +9,10 @@ module DjiMqttConnect
         attribute :result, Types::Integer
 
         attribute :output do
+          include Mixins::ServicesOutputStatusChecks
+
           # {"sent":"sent","in_progress":"in progress","ok":"success","paused":"paused","rejected":"rejected","failed":"failed","canceled":"canceled or stopped","timeout":"timeout"}
-          attribute :status, Types::String.enum(
-            "sent",
-            "in_progress",
-            "ok",
-            "paused",
-            "rejected",
-            "failed",
-            "canceled",
-            "timeout"
-          )
+          attribute :status, Types::ServicesOutputStatus
         end
       end
     end

data/lib/dji_mqtt_connect/messages/thing/product/services_reply/cover_open.rb

@@ -9,17 +9,10 @@ module DjiMqttConnect
         attribute :result, Types::Integer
 
         attribute :output do
+          include Mixins::ServicesOutputStatusChecks
+
           # {"sent":"sent","in_progress":"in progress","ok":"success","paused":"paused","rejected":"rejected","failed":"failed","canceled":"canceled or stopped","timeout":"timeout"}
-          attribute :status, Types::String.enum(
-            "sent",
-            "in_progress",
-            "ok",
-            "paused",
-            "rejected",
-            "failed",
-            "canceled",
-            "timeout"
-          )
+          attribute :status, Types::ServicesOutputStatus
         end
       end
     end

data/lib/dji_mqtt_connect/messages/thing/product/services_reply/debug_mode_close.rb

@@ -9,17 +9,10 @@ module DjiMqttConnect
         attribute :result, Types::Integer
 
         attribute :output do
+          include Mixins::ServicesOutputStatusChecks
+
           # {"sent":"sent","in_progress":"in progress","ok":"success","paused":"paused","rejected":"rejected","failed":"failed","canceled":"canceled or stopped","timeout":"timeout"}
-          attribute :status, Types::String.enum(
-            "sent",
-            "in_progress",
-            "ok",
-            "paused",
-            "rejected",
-            "failed",
-            "canceled",
-            "timeout"
-          )
+          attribute :status, Types::ServicesOutputStatus
         end
       end
     end

data/lib/dji_mqtt_connect/messages/thing/product/services_reply/debug_mode_open.rb

@@ -9,17 +9,10 @@ module DjiMqttConnect
         attribute :result, Types::Integer
 
         attribute :output do
+          include Mixins::ServicesOutputStatusChecks
+
           # {"sent":"sent","in_progress":"in progress","ok":"success","paused":"paused","rejected":"rejected","failed":"failed","canceled":"canceled or stopped","timeout":"timeout"}
-          attribute :status, Types::String.enum(
-            "sent",
-            "in_progress",
-            "ok",
-            "paused",
-            "rejected",
-            "failed",
-            "canceled",
-            "timeout"
-          )
+          attribute :status, Types::ServicesOutputStatus
         end
       end
     end

data/lib/dji_mqtt_connect/messages/thing/product/services_reply/return_home.rb

@@ -9,17 +9,10 @@ module DjiMqttConnect
         attribute :result, Types::Integer
 
         attribute :output do
+          include Mixins::ServicesOutputStatusChecks
+
           # {"sent":"sent","in_progress":"in progress","ok":"succeeded","paused":"paused","rejected":"rejected","failed":"failed","canceled":"canceled or terminated","timeout":"timeout"}
-          attribute :status, Types::String.enum(
-            "sent",
-            "in_progress",
-            "ok",
-            "paused",
-            "rejected",
-            "failed",
-            "canceled",
-            "timeout"
-          )
+          attribute :status, Types::ServicesOutputStatus
         end
       end
     end

data/lib/dji_mqtt_connect/mixins/services_output_status_checks.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module DjiMqttConnect
+end
+# frozen_string_literal: true
+
+module DjiMqttConnect
+  module Mixins
+    # Provides checks for the output object that contains a Types::ServicesOutputStatus status value
+    module ServicesOutputStatusChecks
+      def status_finalized?
+        [
+          Types::SERVICE_OUTPUT_STATUS_OK,
+          Types::SERVICE_OUTPUT_STATUS_REJECTED,
+          Types::SERVICE_OUTPUT_STATUS_FAILED,
+          Types::SERVICE_OUTPUT_STATUS_CANCELED,
+          Types::SERVICE_OUTPUT_STATUS_TIMEOUT
+        ].include?(status)
+      end
+      alias_method :status_finalised?, :status_finalized?
+
+      def humanized_status
+        I18n.t(status, scope: "dji_mqtt_connect.services_output_status", default: status.titleize)
+      end
+    end
+  end
+end

data/lib/dji_mqtt_connect/types.rb

@@ -34,5 +34,17 @@ module DjiMqttConnect
 
     InvalidTemperature = Types::Integer.constrained(gteq: 1300) # maximum temp of k-type thermocouple, errors are usually 30K+
     Temperature = InvalidTemperature | Types::JSON::Decimal
+
+    # {"sent":"sent","in_progress":"in progress","ok":"success","paused":"paused","rejected":"rejected","failed":"failed","canceled":"canceled or stopped","timeout":"timeout"}
+    ServicesOutputStatus = Types::String.enum(
+      SERVICE_OUTPUT_STATUS_SENT = "sent",
+      SERVICE_OUTPUT_STATUS_IN_PROGRESS = "in_progress",
+      SERVICE_OUTPUT_STATUS_OK = "ok",
+      SERVICE_OUTPUT_STATUS_PAUSED = "paused",
+      SERVICE_OUTPUT_STATUS_REJECTED = "rejected",
+      SERVICE_OUTPUT_STATUS_FAILED = "failed",
+      SERVICE_OUTPUT_STATUS_CANCELED = "canceled",
+      SERVICE_OUTPUT_STATUS_TIMEOUT = "timeout"
+    )
   end
 end

data/lib/dji_mqtt_connect/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module DjiMqttConnect
-  VERSION = "0.1.13.1"
+  VERSION = "0.1.14"
 end

data/lib/dji_mqtt_connect.rb

@@ -126,6 +126,7 @@ module DjiMqttConnect
   module Mixins
     autoload :LatitudeConditional, "dji_mqtt_connect/mixins/latitude_conditional"
     autoload :LongitudeConditional, "dji_mqtt_connect/mixins/longitude_conditional"
+    autoload :ServicesOutputStatusChecks, "dji_mqtt_connect/mixins/services_output_status_checks"
     autoload :TemperatureConditional, "dji_mqtt_connect/mixins/temperature_conditional"
   end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dji_mqtt_connect
 version: !ruby/object:Gem::Version
-  version: 0.1.13.1
+  version: 0.1.14
 platform: ruby
 authors:
 - Sphere Drones
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-06-08 00:00:00.000000000 Z
+date: 2023-06-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -103,8 +103,9 @@ files:
 - Gemfile.lock
 - README.md
 - Rakefile
-- config/locales/dji_mqtt_connect.en.yml
-- config/locales/dji_mqtt_connect.zh.yml
+- config/locales/hms_event_codes.en.yml
+- config/locales/hms_event_codes.zh.yml
+- config/locales/services_output_status.en.yml
 - dji_mqtt_connect.gemspec
 - lib/dji_mqtt_connect.rb
 - lib/dji_mqtt_connect/client.rb
@@ -184,6 +185,7 @@ files:
 - lib/dji_mqtt_connect/messages/thing/product/services_reply_message.rb
 - lib/dji_mqtt_connect/mixins/latitude_conditional.rb
 - lib/dji_mqtt_connect/mixins/longitude_conditional.rb
+- lib/dji_mqtt_connect/mixins/services_output_status_checks.rb
 - lib/dji_mqtt_connect/mixins/temperature_conditional.rb
 - lib/dji_mqtt_connect/railtie.rb
 - lib/dji_mqtt_connect/railties/message_serializer.rb