dji_mqtt_connect 0.1.9 → 0.1.11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0fdf863220666d558b5c4172d11802585133231df7de49352e8d516094a69e38
-  data.tar.gz: ca3937a310a7c19f671bc5afd8d5c5d2b82e40e6bdc02c1c42e56cbfe2898717
+  metadata.gz: 2685591a0d96c757f12c00f683a9dc45ee25b81091414dc81d72f93ccfe2f324
+  data.tar.gz: 53e45915630050082bd9dd1ddeb228d1eb9ce318d47eab213e0df0fb42c4d18a
 SHA512:
-  metadata.gz: 3edf674897efce7593a2086c61c3dab3d9757b4b05b0d13686dccaf8c8e21a382302e96f2a5832f3c2fcdd89427748de4e4bdb646c643dceec9da45a6370e50b
-  data.tar.gz: 99f44ec7e179f04e6966dfc112dadde605d491e991d3f59caa460196cdc1d805bf4bcae6c301d7ae31c919a09d8031886b5762c477346baf7d104d067ca770c6
+  metadata.gz: fc83f3608e9162591d40e6bc0115f804b55d779149ef6612a3ae84b4864e98052e5d40b8faedc8b2f541fa056e589b9c1c7eba79dd3a812f35012c72b906947b
+  data.tar.gz: da787b447741b0236e9c31bb28ea04ef33a900e47f5386e18dff9ebd43d243449a7d3119a9348f9f0515c314887288b4b3021b88ab4d522d6c8a266952a51ace

data/Gemfile.lock

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

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,119 @@ 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_fileupload_progress_events_message
+      message_data = {
+        output: {
+          ext: {
+            files: [
+              {
+                module: "0",
+                size: 155232,
+                device_sn: "drone_sn",
+                key: "4bf0039f-6434-44a8-b891-8d7b6b7ff138/drone_sn/video_20220621_110830.log",
+                fingerprint: "4f65b891f3bc09bdb6d4c36a996b532d",
+                progress: {
+                  current_step: 19,
+                  prgress: 100,
+                  finish_time: 1655781395926,
+                  upload_rate: 0,
+                  result: 0,
+                  status: "ok"
+                }
+              },
+              {
+                module: "3",
+                size: 155232,
+                device_sn: "dock_sn",
+                key: "4bf0039f-6434-44a8-b891-8d7b6b7ff138/dock_sn/video_20220621_110830.log",
+                fingerprint: "4f65b891f3bc09bdb6d4c36a996b532d",
+                progress: {
+                  current_step: 19,
+                  total_step: 30,
+                  prgress: 100,
+                  finish_time: 1655781395926,
+                  upload_rate: 0,
+                  result: 0,
+                  status: "ok"
+                }
+              }
+            ]
+          },
+          status: "ok"
+        }
+      }
+
+      Thing::Product::FileuploadProgressEventsMessage.new(
+        _method: "fileupload_progress",
+        need_reply: 0,
+        bid: "12345678-1234-1234-1234-12345678901B",
+        tid: "12345678-1234-1234-1234-12345678901A",
+        timestamp: 1655781395926,
+        gateway: "dock_sn",
+        _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 +159,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,35 @@
+# 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",
+        "fileupload_progress",
+        "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/fileupload_progress_events_message.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module DjiMqttConnect
+  module Thing::Product
+    # https://developer.dji.com/doc/cloud-api-tutorial/en/server-api-reference/mqtt/thing-model/gateway/dock/log.html#inform-of-file-uploading-progress
+    class FileuploadProgressEventsMessage < EventsMessage
+      attribute :_method, Types::String.enum("fileupload_progress")
+
+      # NOTE: Not documented, but appears in examples
+      attribute? :need_reply, Types::Integer.enum(0, 1)
+
+      attribute :data do
+        attribute :output do
+          attribute :ext do
+            attribute :files, Types::Array do
+              # {"0":"Aircraft","3":"DJI Dock"}
+              attribute :module, Types::Coercible::Integer.enum(0, 3)
+
+              attribute :size, Types::Integer
+              attribute :device_sn, Types::String
+              attribute :key, Types::String
+              attribute :fingerprint, Types::String
+
+              attribute :progress do
+                attribute :current_step, Types::Integer
+                attribute? :total_step, Types::Integer
+                attribute :prgress, Types::Integer
+                attribute :finish_time, Types::Timestamp
+                attribute :upload_rate, Types::Integer
+                attribute :result, Types::Integer
+                attribute :status, Types::String
+              end
+            end
+          end
+          attribute :status, Types::String
+        end
+      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/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/version.rb

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

data/lib/dji_mqtt_connect.rb

@@ -35,10 +35,14 @@ module DjiMqttConnect
     module Product
       # Messages
       autoload :FileUploadCallbackEventsMessage, "dji_mqtt_connect/messages/thing/product/file_upload_callback_events_message"
+      autoload :FileuploadProgressEventsMessage, "dji_mqtt_connect/messages/thing/product/fileupload_progress_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"
@@ -59,12 +63,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.9
+  version: 0.1.11
 platform: ruby
 authors:
 - Sphere Drones
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-05-24 00:00:00.000000000 Z
+date: 2023-05-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -113,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
@@ -132,7 +133,10 @@ 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/fileupload_progress_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
@@ -149,6 +153,7 @@ 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