dji_mqtt_connect 0.1.24.1 → 0.1.25

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

@@ -1,34 +1,20 @@
 # 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
+      include Utils::MessageDumping
 
       # Converts a message for transmission via MQTT
       def dump(message)
         # Fix up the hash representation
-        transformed_message = hash_transformer.call(message)
+        transformed_message = convert_message_to_hash(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/marshals/thing/product/osd_marshal.rb

@@ -9,7 +9,7 @@ module DjiMqttConnect
       include Utils::MessageParsing
 
       # Make a copy of the raw data
-      class AttributeTransformer < Dry::Transformer::Pipe
+      class OsdTransformer < Dry::Transformer::Pipe
         import Dry::Transformer::Conditional
         import Dry::Transformer::HashTransformations
 
@@ -53,15 +53,15 @@ module DjiMqttConnect
           OsdMessage
         end
 
-        transformed_message = attribute_transformer.call(parsed_message)
+        transformed_message = osd_transformer.call(parsed_message)
 
         build_message(message_class, transformed_message)
       end
 
       private
 
-      def attribute_transformer
-        @attribute_transformer ||= AttributeTransformer.new
+      def osd_transformer
+        @osd_transformer ||= OsdTransformer.new
       end
 
       def dock_osd_data_attributes

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

@@ -10,7 +10,7 @@ module DjiMqttConnect
       include Utils::MessageParsing
 
       # Rename pesky `method` argument to `_method` and makes a copy of the raw data
-      class AttributeTransformer < Dry::Transformer::Pipe
+      class RequestsTransformer < Dry::Transformer::Pipe
         import Dry::Transformer::HashTransformations
 
         define! do
@@ -25,7 +25,7 @@ module DjiMqttConnect
         parsed_message = parse_json(raw_message)
 
         # Transform the message
-        transformed_message = attribute_transformer.call(parsed_message)
+        transformed_message = requests_transformer.call(parsed_message)
         message_method = transformed_message["_method"]
 
         # Build an instance of the class, or a generic message from the current class
@@ -35,8 +35,8 @@ module DjiMqttConnect
 
       private
 
-      def attribute_transformer
-        @attribute_transformer ||= AttributeTransformer.new
+      def requests_transformer
+        @requests_transformer ||= RequestsTransformer.new
       end
     end
   end

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

@@ -1,34 +1,20 @@
 # frozen_string_literal: true
 
-require "dry-transformer"
 require "json"
 
 module DjiMqttConnect
   module Thing::Product
     class RequestsReplyMarshal < MessageMarshal
-      # Renames the method attribute
-      class HashTransformer < Dry::Transformer::Pipe
-        import Dry::Transformer::HashTransformations
-
-        define! do
-          rename_keys _method: :method
-        end
-      end
+      include Utils::MessageDumping
 
       # Converts a message for transmission via MQTT
       def dump(message)
         # Fix up the hash representation
-        transformed_message = hash_transformer.call(message)
+        transformed_message = convert_message_to_hash(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/marshals/thing/product/services_marshal.rb

@@ -1,34 +1,20 @@
 # frozen_string_literal: true
 
-require "dry-transformer"
 require "json"
 
 module DjiMqttConnect
   module Thing::Product
     class ServicesMarshal < MessageMarshal
-      # Renames the method attribute
-      class HashTransformer < Dry::Transformer::Pipe
-        import Dry::Transformer::HashTransformations
-
-        define! do
-          rename_keys _method: :method
-        end
-      end
+      include Utils::MessageDumping
 
       # Converts a message for transmission via MQTT
       def dump(message)
         # Fix up the hash representation
-        transformed_message = hash_transformer.call(message)
+        transformed_message = convert_message_to_hash(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/marshals/thing/product/services_reply_marshal.rb

@@ -10,7 +10,7 @@ module DjiMqttConnect
       include Utils::MessageParsing
 
       # Rename pesky `method` argument to `_method` and makes a copy of the raw data
-      class AttributeTransformer < Dry::Transformer::Pipe
+      class ServicesReplyTransformer < Dry::Transformer::Pipe
         import Dry::Transformer::HashTransformations
 
         define! do
@@ -25,7 +25,7 @@ module DjiMqttConnect
         parsed_message = parse_json(raw_message)
 
         # Transform the message
-        transformed_message = attribute_transformer.call(parsed_message)
+        transformed_message = services_reply_transformer.call(parsed_message)
         message_method = transformed_message["_method"]
 
         # Build an instance of the class, or a generic message from the current class
@@ -35,8 +35,8 @@ module DjiMqttConnect
 
       private
 
-      def attribute_transformer
-        @attribute_transformer ||= AttributeTransformer.new
+      def services_reply_transformer
+        @services_reply_transformer ||= ServicesReplyTransformer.new
       end
     end
   end

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

@@ -10,7 +10,7 @@ module DjiMqttConnect
       include Utils::MessageParsing
 
       # Rename pesky `method` argument to `_method` and makes a copy of the raw data
-      class AttributeTransformer < Dry::Transformer::Pipe
+      class StateTransformer < Dry::Transformer::Pipe
         import Dry::Transformer::HashTransformations
 
         define! do
@@ -24,7 +24,7 @@ module DjiMqttConnect
         parsed_message = parse_json(raw_message)
 
         # Transform the message
-        transformed_message = attribute_transformer.call(parsed_message)
+        transformed_message = state_transformer.call(parsed_message)
 
         # Build an instance of the class, or a generic message from the current class
         build_message(StateMessage, transformed_message)
@@ -32,8 +32,8 @@ module DjiMqttConnect
 
       private
 
-      def attribute_transformer
-        @attribute_transformer ||= AttributeTransformer.new
+      def state_transformer
+        @state_transformer ||= StateTransformer.new
       end
     end
   end

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

@@ -1,34 +1,20 @@
 # frozen_string_literal: true
 
-require "dry-transformer"
 require "json"
 
 module DjiMqttConnect
   module Thing::Product
     class StateReplyMarshal < MessageMarshal
-      # Renames the method attribute
-      class HashTransformer < Dry::Transformer::Pipe
-        import Dry::Transformer::HashTransformations
-
-        define! do
-          rename_keys _method: :method
-        end
-      end
+      include Utils::MessageDumping
 
       # Converts a message for transmission via MQTT
       def dump(message)
         # Fix up the hash representation
-        transformed_message = hash_transformer.call(message)
+        transformed_message = convert_message_to_hash(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/status/update_topo.rb

@@ -14,7 +14,7 @@ module DjiMqttConnect
         attribute? :thing_version, Types::String # dock contains thing_version instead of version
 
         attribute :sub_devices, Types::Array do
-          attribute :sn, Types::String
+          attribute :sn, Types::SerialNumber
           attribute? :domain, Types::DeviceDomain
           attribute :type, Types::DeviceType
           attribute :sub_type, Types::DeviceSubType

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

@@ -11,6 +11,16 @@ module DjiMqttConnect
       attribute :_data, Types::Hash
       attribute :_method, Types::String
 
+      attribute :data, Types::Hash.default({}.freeze)
+
+      def humanized_summary
+        Translations.sys_product_status_summary(_method, **humanized_summary_interpolation)
+      end
+
+      def humanized_summary_interpolation
+        data.to_h.merge(method: _method)
+      end
+
       def to_s
         # Include data method for Generic messages
         instance_of?(StatusMessage) ? "#{super}[#{_method}]" : super

data/lib/dji_mqtt_connect/messages/sys/product/status_reply/update_topo.rb

@@ -2,7 +2,7 @@
 
 module DjiMqttConnect
   module Sys::Product
-    class UpdateTopoStatusReplyMessage < Message
+    class UpdateTopoStatusReplyMessage < StatusReplyMessage
       # Builds a reply for an update_topo status message
       # a result of 0 means we approve of this action
       def self.build_for(update_topo_status_message, result: 0)
@@ -18,15 +18,6 @@ module DjiMqttConnect
       end
 
       attribute :_method, Types::String.enum("update_topo")
-
-      attribute :tid, Types::UUID
-      attribute :bid, Types::UUID
-      attribute :timestamp, Types::Timestamp
-      attribute :data do
-        include Mixins::ResultMessage
-
-        attribute :result, Types::ResultCode
-      end
     end
   end
 end

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

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module DjiMqttConnect
+  module Sys::Product
+    class StatusReplyMessage < DjiMqttConnect::Message
+      # Ensure all values are accepted
+      schema schema.strict
+
+      attribute :tid, Types::UUID
+      attribute :bid, Types::UUID
+      attribute :timestamp, Types::Timestamp
+
+      attribute :_method, Types::String
+
+      attribute :data do
+        include Mixins::ResultMessage
+
+        attribute :result, Types::ResultCode
+      end
+    end
+  end
+end

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

@@ -4,31 +4,32 @@ module DjiMqttConnect
   module Thing::Product
     class AirsenseWarningEventsMessage < EventsMessage
       attribute :_method, Types::String.enum("airsense_warning")
-      attribute :_data, Types::Array
 
-      attribute :data, Types::Array do
-        attribute :icao, Types::String
+      attribute :data do
+        attribute :list, Types::Array do
+          attribute :icao, Types::String
 
-        # {"0":"No danger","1":"Level one","2":"Level two","3":"Level three","4":"Level four"}
-        attribute :warning_level, Types::Integer.enum(0, 1, 2, 3, 4)
+          # {"0":"No danger","1":"Level one","2":"Level two","3":"Level three","4":"Level four"}
+          attribute :warning_level, Types::Integer.enum(0, 1, 2, 3, 4)
 
-        attribute :latitude, Types::Latitude
+          attribute :latitude, Types::Latitude
 
-        attribute :longitude, Types::Longitude
+          attribute :longitude, Types::Longitude
 
-        attribute :altitude, Types::Integer
+          attribute :altitude, Types::Integer
 
-        # {"0":"Ellipsoid height","1":"altitude"}
-        attribute :altitude_type, Types::Integer.enum(0, 1)
+          # {"0":"Ellipsoid height","1":"altitude"}
+          attribute :altitude_type, Types::Integer.enum(0, 1)
 
-        attribute :distance, Types::Integer
+          attribute :distance, Types::Integer
 
-        attribute :heading, Types::JSON::Decimal
+          attribute :heading, Types::JSON::Decimal
 
-        attribute :relative_altitude, Types::Integer
+          attribute :relative_altitude, Types::Integer
 
-        # {"0":"Relative height unchanged","1":"Relative height increase","2":"Relative height decrease"}
-        attribute :vert_trend, Types::Integer.enum(0, 1, 2)
+          # {"0":"Relative height unchanged","1":"Relative height increase","2":"Relative height decrease"}
+          attribute :vert_trend, Types::Integer.enum(0, 1, 2)
+        end
       end
     end
   end

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

@@ -33,6 +33,15 @@ module DjiMqttConnect
           end
         end
       end
+
+      def humanized_summary_interpolation
+        super.merge(
+          status: data.output.humanized_status,
+          percent: data.output.progress.percent,
+          current_step: data.output.progress.current_step || "-",
+          total_steps: data.output.progress.total_steps || "-"
+        )
+      end
     end
   end
 end

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

@@ -33,6 +33,15 @@ module DjiMqttConnect
           end
         end
       end
+
+      def humanized_summary_interpolation
+        super.merge(
+          status: data.output.humanized_status,
+          percent: data.output.progress.percent,
+          current_step: data.output.progress.current_step || "-",
+          total_steps: data.output.progress.total_steps || "-"
+        )
+      end
     end
   end
 end

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

@@ -4,6 +4,7 @@ module DjiMqttConnect
   module Thing::Product
     # Notification of device exits the Return to Home (RTH) state
     # https://developer.dji.com/doc/cloud-api-tutorial/en/server-api-reference/mqtt/thing-model/gateway/dock/wayline.html#notification-of-device-exits-the-return-to-home-rth-state
+    # https://developer.dji.com/doc/cloud-api-tutorial/en/api-reference/dock-to-cloud/mqtt/dock/dock2/wayline.html#device-notification-of-return-to-home-exit-state
     class DeviceExitHomingNotifyEventsMessage < EventsMessage
       ENTERING_EXIT_RTH_STATE_ACTION = 1
       EXIT_EXITING_RTH_STATE_ACTION = 0
@@ -14,6 +15,10 @@ module DjiMqttConnect
         # {"1":"Enter exiting RTH state"},{"0":"Exit exiting RTH state"}
         attribute :action, Types::Coercible::Integer.enum(EXIT_EXITING_RTH_STATE_ACTION, ENTERING_EXIT_RTH_STATE_ACTION)
 
+        def humanized_action
+          I18n.t(action, scope: "dji_mqtt_connect.thing_product_device_exit_homing_notify_events_message.humanized_action")
+        end
+
         attribute :sn, Types::SerialNumber
 
         # {"0":"Add joystick throttle","1":"Add joystick pitch","2":"The initialization of behavior tree is failed","3":"Surrounded by obstacles","4":"Flight restriction is triggered","5":"Obstacle is too closed","6":"No GPS signal","7":"The output flag of GPS and VIO location is false","8":"The error of GPS and VIO fusion position is too large","9":"Backtrack in a short distance","10":"Trigger the RTH in a short distance"}
@@ -30,6 +35,14 @@ module DjiMqttConnect
           BACKTRACK_IN_A_SHORT_DISTANCE_REASON = 9,
           TRIGGER_THE_RTH_IN_A_SHORT_DISTANCE_REASON = 10
         )
+
+        def humanized_reason
+          I18n.t(reason, scope: "dji_mqtt_connect.thing_product_device_exit_homing_notify_events_message.humanized_reason", default: "-")
+        end
+      end
+
+      def humanized_summary_interpolation
+        super.merge(action: data.humanized_action, reason: data.humanized_reason)
       end
     end
   end

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

@@ -33,6 +33,15 @@ module DjiMqttConnect
           end
         end
       end
+
+      def humanized_summary_interpolation
+        super.merge(
+          status: data.output.humanized_status,
+          percent: data.output.progress.percent,
+          current_step: data.output.progress.current_step || "-",
+          total_steps: data.output.progress.total_steps || "-"
+        )
+      end
     end
   end
 end

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

@@ -18,7 +18,7 @@ module DjiMqttConnect
           attribute :name, Types::String
 
           attribute :ext do
-            attribute :flight_id, Types::String
+            attribute :flight_id, Types::FlightID
 
             attribute :drone_model_key, Types::String
 
@@ -50,6 +50,18 @@ module DjiMqttConnect
           end
         end
       end
+
+      def humanized_summary_interpolation
+        super.merge(
+          file_name: data.file.name,
+          flight_id: data.file.ext.flight_id
+        )
+      end
+
+      # All the flight IDs in the message
+      def flight_ids
+        [data.file.ext.flight_id]
+      end
     end
   end
 end

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

@@ -13,8 +13,12 @@ module DjiMqttConnect
               # {"0":"Aircraft","3":"DJI Dock"}
               attribute :module, Types::Coercible::Integer.enum(0, 3)
 
+              def humanized_module
+                I18n.t(self.module, scope: "dji_mqtt_connect.thing_product_fileupload_progress_events_message.humanized_module")
+              end
+
               attribute :size, Types::Integer
-              attribute :device_sn, Types::String
+              attribute :device_sn, Types::SerialNumber
               attribute :key, Types::String
               attribute? :fingerprint, Types::String
 
@@ -26,12 +30,35 @@ module DjiMqttConnect
                 attribute :upload_rate, Types::Integer
                 attribute? :result, Types::Integer
                 attribute :status, Types::String
+
+                def humanized_status
+                  # NOTE: status shares many values with flighttask_status, but not all
+                  I18n.t(status, scope: "dji_mqtt_connect.flighttask_status", default: status.titleize)
+                end
+              end
+
+              def humanized_summary
+                I18n.t(
+                  "humanized_summary",
+                  scope: "dji_mqtt_connect.thing_product_fileupload_progress_events_message",
+                  module: humanized_module,
+                  key: key.split("/").last,
+                  status: progress.humanized_status,
+                  progress: progress.progress
+                )
               end
             end
           end
+
           attribute :status, Types::String
         end
       end
+
+      def humanized_summary_interpolation
+        super.merge(
+          progress: data.output.ext.files.map(&:humanized_summary).join(", ")
+        )
+      end
     end
   end
 end

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

@@ -21,6 +21,14 @@ module DjiMqttConnect
 
         # {"1":"Failed to parse file information returned from the cloud.","2":"Failed to retrieve file information from the aircraft's end.","3":"Failed to download the file from the cloud.","4":"Link flipping failed.","5":"File transmission failed."}
         attribute :reason, Types::Integer.enum(0, 1, 2, 3, 4, 5)
+
+        def humanized_reason
+          I18n.t(reason, scope: "dji_mqtt_connect.thing_product_flight_areas_sync_progress_events_message.humanized_reason")
+        end
+      end
+
+      def humanized_summary_interpolation
+        super.merge(reason: data.humanized_reason)
       end
     end
   end