dji_mqtt_connect 0.1.8 → 0.1.10

data/lib/dji_mqtt_connect/client.rb

@@ -46,6 +46,11 @@ module DjiMqttConnect
       Thing::Product::EventsTopicRepository.new(self)
     end
 
+    # Handles topic thing/product/#{pid}/events_reply
+    def thing_product_events_reply_topic
+      Thing::Product::EventsReplyTopicRepository.new(self)
+    end
+
     # Handles topic thing/product/#{pid}/osd
     def thing_product_osd_topic
       Thing::Product::OsdTopicRepository.new(self)

data/lib/dji_mqtt_connect/factories.rb

@@ -4,6 +4,65 @@ module DjiMqttConnect
   # Factories for building example messages
   # Do not include this in your production code
   module Factories
+    # Events
+
+    def build_file_upload_callback_events_message
+      message_data = {
+        file: {
+          object_key: "object_key",
+          path: "xxx",
+          name: "dog.jpeg",
+          ext: {
+            flight_id: "xxx",
+            drone_model_key: "0-67-0",
+            payload_model_key: "0-67-0",
+            is_original: true
+          },
+          metadata: {
+            shoot_position: {
+              lat: 22.1,
+              lng: 122.5
+            },
+            gimbal_yaw_degree: -91.4,
+            absolute_altitude: 56.311,
+            relative_altitude: 41.124,
+            created_time: "2021-05-10 16:04:20"
+          }
+        },
+        result: 0
+      }
+
+      Thing::Product::FileUploadCallbackEventsMessage.new(
+        _method: "file_upload_callback",
+        bid: "12345678-1234-1234-1234-12345678901B",
+        tid: "12345678-1234-1234-1234-12345678901A",
+        need_reply: 1,
+        gateway: "xxx",
+        timestamp: 1654070968655,
+        data: message_data,
+        _data: message_data
+      )
+    end
+
+    def build_highest_priority_upload_flighttask_media_events_message
+      message_data = {
+        flight_id: SecureRandom.uuid
+      }
+
+      Thing::Product::HighestPriorityUploadFlighttaskMediaEventsMessage.new(
+        bid: "fe0e2218-038f-46fe-b27d-74cd257c386a",
+        _data: message_data,
+        data: message_data,
+        _method: "highest_priority_upload_flighttask_media",
+        need_reply: 1,
+        tid: "c6aa22c0-e9dd-4895-a25c-6c12411513df",
+        timestamp: 1684986146586,
+        gateway: "DOCK01"
+      )
+    end
+
+    # Status
+
     def build_device_online_update_topo_message
       message_data = {
         type: 98,
@@ -46,6 +105,8 @@ module DjiMqttConnect
       )
     end
 
+    #  Requests
+
     def build_thing_product_config_requests_message
       message_data = {
         config_type: "json",

data/lib/dji_mqtt_connect/marshals/thing/product/events_reply_marshal.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require "dry-transformer"
+require "json"
+
+module DjiMqttConnect
+  module Thing::Product
+    class EventsReplyMarshal < MessageMarshal
+      # Renames the method attribute
+      class HashTransformer < Dry::Transformer::Pipe
+        import Dry::Transformer::HashTransformations
+
+        define! do
+          rename_keys _method: :method
+        end
+      end
+
+      # Converts a message for transmission via MQTT
+      def dump(message)
+        # Fix up the hash representation
+        transformed_message = hash_transformer.call(message)
+
+        # Convert the transformed message into JSON
+        JSON.generate(transformed_message)
+      end
+
+      private
+
+      def hash_transformer
+        @hash_transformer ||= HashTransformer.new
+      end
+    end
+  end
+end

data/lib/dji_mqtt_connect/messages/sys/product/update_topo_status_message.rb

@@ -15,12 +15,15 @@ module DjiMqttConnect
 
         attribute :sub_devices, Types::Array do
           attribute :sn, Types::String
+          attribute? :domain, Types::DeviceDomain
           attribute :type, Types::DeviceType
           attribute :sub_type, Types::DeviceSubType
           attribute :index,	Types::String
           attribute :device_secret, Types::String
           attribute :nonce, Types::String
           attribute? :version, Types::Integer
+
+          alias_method :serial_number, :sn
         end
       end
     end

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

@@ -11,6 +11,9 @@ module DjiMqttConnect
         job_number
       ]
 
+      # {"0":"Idle mode (No cooling, heating, and dehumidification)","1":"Cooling mode","2":"Heating mode","3":"Dehumidification mode","4":"Cooling exit mode","5":"Heating exit mode","6":"Dehumidification exit mode","7":"Cooling preparation mode","8":"Heating preparation mode","9":"Dehumidification preparation mode"}
+      AirConditionerState = Types::Integer.enum(0, 1, 2, 3, 4, 5, 6, 7, 8, 9)
+
       attribute :data do
         include Mixins::LatitudeConditional
         include Mixins::LongitudeConditional
@@ -152,9 +155,12 @@ module DjiMqttConnect
         attribute? :mode_code, Types::Integer.enum(0, 1, 2, 3, 4)
 
         attribute? :air_conditioner do
-          # {"0":"Idle mode (No cooling, heating, and dehumidification)","1":"Cooling mode","2":"Heating mode","3":"Dehumidification mode","4":"Cooling exit mode","5":"Heating exit mode","6":"Dehumidification exit mode","7":"Cooling preparation mode","8":"Heating preparation mode","9":"Dehumidification preparation mode"}
-          attribute :air_conditioner_state, Types::Integer.enum(0, 1, 2, 3, 4, 5, 6, 7, 8, 9)
+          attribute :air_conditioner_state, AirConditionerState | Types::Integer
           attribute :switch_time, Types::Integer
+
+          def air_conditioner_state?
+            AirConditionerState.valid?(air_conditioner_state)
+          end
         end
 
         # {"0":"Closed","1":"Opened"}

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

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module DjiMqttConnect
+  module Thing::Product
+    # https://developer.dji.com/doc/cloud-api-tutorial/en/server-api-reference/mqtt/topic-definition.html#events-reply-struct-example
+    class EventsReplyMessage < Message
+      # a result of 0 means we approve of this action
+      def self.build_for(events_message, result: 0)
+        new(
+          _method: events_message._method,
+          tid: events_message.tid,
+          bid: events_message.bid,
+          timestamp: Time.now.strftime("%s%L").to_i,
+          data: {
+            result: result
+          }
+        )
+      end
+
+      attribute :bid, Types::UUID
+      attribute :tid, Types::UUID
+      attribute :timestamp, Types::Timestamp
+
+      attribute :_method, Types::String.enum(
+        "file_upload_callback",
+        "highest_priority_upload_flighttask_media"
+      )
+
+      attribute :data do
+        attribute :result, Types::Integer
+      end
+    end
+  end
+end

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

@@ -51,6 +51,10 @@ module DjiMqttConnect
 
         attribute :result, Types::Integer
       end
+
+      def need_reply?
+        need_reply == 1
+      end
     end
   end
 end

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

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module DjiMqttConnect
+  module Thing::Product
+    class HighestPriorityUploadFlighttaskMediaEventsMessage < EventsMessage
+      attribute :_method, Types::String.enum("highest_priority_upload_flighttask_media")
+
+      # NOTE: Not documented, but appears in examples
+      attribute? :need_reply, Types::Integer.enum(0, 1)
+
+      attribute :data do
+        attribute :flight_id, Types::String
+      end
+
+      def need_reply?
+        need_reply == 1
+      end
+    end
+  end
+end

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/topics/thing/product/events_reply.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module DjiMqttConnect
+  module Thing::Product
+    class EventsReplyTopicRepository < TopicRepository
+      # Publishes a message to gateway_sn on the "thing/product/+/events_reply" topic.
+      def publish_to_device(gateway_sn, events_reply_message)
+        publish_to_topic(
+          "thing/product/#{gateway_sn}/events_reply",
+          events_reply_message,
+          marshal: EventsReplyMarshal
+        )
+      end
+    end
+  end
+end

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.8"
+  VERSION = "0.1.10"
 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
@@ -34,10 +35,13 @@ module DjiMqttConnect
     module Product
       # Messages
       autoload :FileUploadCallbackEventsMessage, "dji_mqtt_connect/messages/thing/product/file_upload_callback_events_message"
+      autoload :HighestPriorityUploadFlighttaskMediaEventsMessage, "dji_mqtt_connect/messages/thing/product/highest_priority_upload_flighttask_media_events_message"
       autoload :HmsEventsMessage, "dji_mqtt_connect/messages/thing/product/hms_events_message"
       autoload :StatusCodeEventsMessage, "dji_mqtt_connect/messages/thing/product/status_code_events_message"
       autoload :EventsMessage, "dji_mqtt_connect/messages/thing/product/events_message"
 
+      autoload :EventsReplyMessage, "dji_mqtt_connect/messages/thing/product/events_reply_message"
+
       autoload :OsdMessage, "dji_mqtt_connect/messages/thing/product/osd_message"
       autoload :DockOsdMessage, "dji_mqtt_connect/messages/thing/product/dock_osd_message"
       autoload :DroneOsdMessage, "dji_mqtt_connect/messages/thing/product/drone_osd_message"
@@ -58,12 +62,14 @@ module DjiMqttConnect
 
       # Topics
       autoload :EventsTopicRepository, "dji_mqtt_connect/topics/thing/product/events"
+      autoload :EventsReplyTopicRepository, "dji_mqtt_connect/topics/thing/product/events_reply"
       autoload :OsdTopicRepository, "dji_mqtt_connect/topics/thing/product/osd"
       autoload :RequestsTopicRepository, "dji_mqtt_connect/topics/thing/product/requests"
       autoload :RequestsReplyTopicRepository, "dji_mqtt_connect/topics/thing/product/requests_reply"
 
       # Marshals
       autoload :EventsMarshal, "dji_mqtt_connect/marshals/thing/product/events_marshal"
+      autoload :EventsReplyMarshal, "dji_mqtt_connect/marshals/thing/product/events_reply_marshal"
 
       autoload :OsdMarshal, "dji_mqtt_connect/marshals/thing/product/osd_marshal"
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dji_mqtt_connect
 version: !ruby/object:Gem::Version
-  version: 0.1.8
+  version: 0.1.10
 platform: ruby
 authors:
 - Sphere Drones
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-05-19 00:00:00.000000000 Z
+date: 2023-05-25 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
@@ -111,6 +113,7 @@ files:
 - lib/dji_mqtt_connect/marshals/sys/product/status_marshal.rb
 - lib/dji_mqtt_connect/marshals/sys/product/status_reply_marshal.rb
 - lib/dji_mqtt_connect/marshals/thing/product/events_marshal.rb
+- lib/dji_mqtt_connect/marshals/thing/product/events_reply_marshal.rb
 - lib/dji_mqtt_connect/marshals/thing/product/osd_marshal.rb
 - lib/dji_mqtt_connect/marshals/thing/product/requests_marshal.rb
 - lib/dji_mqtt_connect/marshals/thing/product/requests_reply_marshal.rb
@@ -130,7 +133,9 @@ files:
 - lib/dji_mqtt_connect/messages/thing/product/dock_osd_message.rb
 - lib/dji_mqtt_connect/messages/thing/product/drone_osd_message.rb
 - lib/dji_mqtt_connect/messages/thing/product/events_message.rb
+- lib/dji_mqtt_connect/messages/thing/product/events_reply_message.rb
 - lib/dji_mqtt_connect/messages/thing/product/file_upload_callback_events_message.rb
+- lib/dji_mqtt_connect/messages/thing/product/highest_priority_upload_flighttask_media_events_message.rb
 - lib/dji_mqtt_connect/messages/thing/product/hms_events_message.rb
 - lib/dji_mqtt_connect/messages/thing/product/osd_message.rb
 - lib/dji_mqtt_connect/messages/thing/product/remote_osd_message.rb
@@ -147,9 +152,11 @@ files:
 - lib/dji_mqtt_connect/topics/sys/product/status.rb
 - lib/dji_mqtt_connect/topics/sys/product/status_reply.rb
 - lib/dji_mqtt_connect/topics/thing/product/events.rb
+- lib/dji_mqtt_connect/topics/thing/product/events_reply.rb
 - 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