dji_mqtt_connect 0.1.7 → 0.1.9

data/lib/dji_mqtt_connect/client.rb

@@ -6,7 +6,7 @@ module DjiMqttConnect
   # Client for communicating with DJI Cloud API MQTT Messages
   # see: https://developer.dji.com/doc/cloud-api-tutorial/en/server-api-reference/mqtt/topic-definition.html
   class Client
-    def self.build(mqtt_address, username:, password:, &block)
+    def self.build(mqtt_address, username:, password:, client_name: DjiMqttConnect.client_name, &block)
       mqtt_url = URI.parse(mqtt_address)
       mqtt_host = mqtt_url.host
       mqtt_port = mqtt_url.port.to_i
@@ -18,7 +18,7 @@ module DjiMqttConnect
         mqtt_client = MQTT::Client.connect(
           host: mqtt_host,
           port: mqtt_port,
-          client_id: DjiMqttConnect.client_id,
+          client_id: MQTT::Client.generate_client_id(client_name),
           username: username,
           password: password,
           ssl: !%w[tcp mqtt ws].include?(mqtt_scheme)

data/lib/dji_mqtt_connect/messages/thing/product/hms_events_message.rb

@@ -26,6 +26,33 @@ module DjiMqttConnect
 
             attribute :sensor_index, Types::Integer
           end
+
+          def in_the_sky?
+            in_the_sky == 1
+          end
+
+          def aircraft_message
+            if in_the_sky?
+              Translations.aircraft_in_the_sky_hms_event_code_message(
+                code: code,
+                sensor_index: args.sensor_index,
+                component_index: args.component_index
+              )
+            else
+              Translations.aircraft_hms_event_code_message(
+                code: code,
+                sensor_index: args.sensor_index,
+                component_index: args.component_index
+              )
+            end
+          end
+
+          def dock_message
+            Translations.dock_hms_event_code_message(
+              code: code,
+              sensor_index: args.sensor_index
+            )
+          end
         end
       end
     end

data/lib/dji_mqtt_connect/railtie.rb

@@ -2,6 +2,9 @@
 
 module DjiMqttConnect
   class Railtie < Rails::Railtie
+    # Add all error code translations to I18n
+    DjiMqttConnect::Translations.load_translations!
+
     # Allow ActiveJob to serialize DjiMqttConnect::Message objects
     config.active_job.custom_serializers << Railties::MessageSerializer
 

data/lib/dji_mqtt_connect/translations.rb

@@ -0,0 +1,91 @@
+# frozen_string_literal: true
+
+module DjiMqttConnect
+  # https://developer.dji.com/doc/cloud-api-tutorial/en/feature-set/dock-feature-set/hms.html
+  module Translations
+    module_function
+
+    def load_translations!
+      I18n.load_path += Dir[File.expand_path(File.join(__dir__, "../../config/locales/*.yml"))]
+    end
+
+    def aircraft_in_the_sky_hms_event_code_message(code:, sensor_index:, component_index:)
+      I18n.translate(
+        "fpv_tip_#{code}_in_the_sky",
+        alarmid: code,
+        index: sensor_index + 1,
+        component_index: component_index + 1,
+        battery_index: battery_position(sensor_index),
+        scope: "dji_mqtt_connect.hms_event_codes",
+        default: code
+      )
+    end
+
+    def aircraft_hms_event_code_message(code:, sensor_index:, component_index:)
+      I18n.translate(
+        "fpv_tip_#{code}",
+        alarmid: code,
+        index: sensor_index + 1,
+        component_index: component_index + 1,
+        battery_index: battery_position(sensor_index),
+        scope: "dji_mqtt_connect.hms_event_codes",
+        default: code
+      )
+    end
+
+    def dock_hms_event_code_message(code:, sensor_index:)
+      I18n.translate(
+        "dock_tip_#{code}",
+        alarmid: code,
+        dock_cover_index: dock_cover_position(sensor_index),
+        charging_rod_index: dock_charging_rod_position(sensor_index),
+        scope: "dji_mqtt_connect.hms_event_codes",
+        default: code
+      )
+    end
+
+    def position_name(position)
+      I18n.translate(position, scope: "dji_mqtt_connect.position", default: position)
+    end
+
+    # If the text contains "%battery_index" and sensor_index is 0, use "left" to replace "%battery_index", otherwise, use "right" to replace.
+    def battery_position(sensor_index)
+      case sensor_index
+      when 0
+        position_name("left")
+      when 1
+        position_name("right")
+      else
+        position_name("unknown")
+      end
+    end
+
+    # If the text contains "%dock_cover_index" and sensor_index is 0, use "left" to replace "%dock_cover_index", otherwise, use "right" to replace.
+    def dock_cover_position(sensor_index)
+      case sensor_index
+      when 0
+        position_name("left")
+      when 1
+        position_name("right")
+      else
+        position_name("unknown")
+      end
+    end
+
+    # If the text contains "%charging_rod_index", when sensor_index is 0, replace "%charging_rod_index" with "front". When sensor_index is 1, use "back" instead. When sensor_index is 2, use "left" instead. When sensor_index is 3, use "right" instead.
+    def dock_charging_rod_position(sensor_index)
+      case sensor_index
+      when 0
+        position_name("front")
+      when 1
+        position_name("back")
+      when 2
+        position_name("left")
+      when 3
+        position_name("right")
+      else
+        position_name("unknown")
+      end
+    end
+  end
+end

data/lib/dji_mqtt_connect/types.rb

@@ -21,7 +21,12 @@ module DjiMqttConnect
     Longitude = NullInteger | Types::JSON::Decimal.constrained(gteq: -180, lteq: 180)
 
     # Device Details
-    DeviceDomain = Types::Coercible::Integer # dock returns this value as string
+    AIRCRAFT_DOMAIN = 0
+    PAYLOAD_DOMAIN = 1
+    REMOTE_CONTROLLER_DOMAIN = 2
+    DOCK_DOMAIN = 3
+
+    DeviceDomain = Types::Coercible::Integer.enum(AIRCRAFT_DOMAIN, PAYLOAD_DOMAIN, REMOTE_CONTROLLER_DOMAIN, DOCK_DOMAIN) # dock returns this value as string
     DeviceType = Types::Integer
     DeviceSubType = Types::Integer
 

data/lib/dji_mqtt_connect/version.rb

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

data/lib/dji_mqtt_connect.rb

@@ -11,6 +11,7 @@ module DjiMqttConnect
   autoload :Message, "dji_mqtt_connect/message"
   autoload :MessageMarshal, "dji_mqtt_connect/message_marshal"
   autoload :TopicRepository, "dji_mqtt_connect/topic_repository"
+  autoload :Translations, "dji_mqtt_connect/translations"
   autoload :Types, "dji_mqtt_connect/types"
 
   module Sys
@@ -92,7 +93,7 @@ module DjiMqttConnect
     autoload :MessageSerializer, "dji_mqtt_connect/railties/message_serializer"
   end
 
-  cattr_accessor :client_id, default: MQTT::Client.generate_client_id(name)
+  cattr_accessor :client_name, default: name
   cattr_accessor :logger, default: ActiveSupport::TaggedLogging.new(ActiveSupport::Logger.new($stdout)).tap { |logger| logger.level = Logger::INFO }
 end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dji_mqtt_connect
 version: !ruby/object:Gem::Version
-  version: 0.1.7
+  version: 0.1.9
 platform: ruby
 authors:
 - Sphere Drones
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-05-19 00:00:00.000000000 Z
+date: 2023-05-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -103,6 +103,8 @@ files:
 - Gemfile.lock
 - README.md
 - Rakefile
+- config/locales/dji_mqtt_connect.en.yml
+- config/locales/dji_mqtt_connect.zh.yml
 - dji_mqtt_connect.gemspec
 - lib/dji_mqtt_connect.rb
 - lib/dji_mqtt_connect/client.rb
@@ -150,6 +152,7 @@ files:
 - lib/dji_mqtt_connect/topics/thing/product/osd.rb
 - lib/dji_mqtt_connect/topics/thing/product/requests.rb
 - lib/dji_mqtt_connect/topics/thing/product/requests_reply.rb
+- lib/dji_mqtt_connect/translations.rb
 - lib/dji_mqtt_connect/types.rb
 - lib/dji_mqtt_connect/utils/message_parsing.rb
 - lib/dji_mqtt_connect/utils/message_sanitizer.rb