dji_mqtt_connect 0.1.24.1 → 0.1.25

data/lib/dji_mqtt_connect/messages/thing/product/services/return_specific_home.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module DjiMqttConnect
+  module Thing::Product
+    # Return to Specific Home
+    # https://developer.dji.com/doc/cloud-api-tutorial/en/api-reference/dock-to-cloud/mqtt/dock/dock2/wayline.html#designate-home-point-for-returning
+    class ReturnSpecificHomeServicesMessage < ServicesMessage
+      def self.build(home_dock_sn:, bid: generate_bid, tid: generate_tid, timestamp: current_timestamp)
+        new(
+          bid: bid,
+          tid: tid,
+          timestamp: timestamp,
+          _method: "return_specific_home",
+          data: {
+            home_dock_sn: home_dock_sn
+          }
+        )
+      end
+
+      attribute :_method, Types::String.enum("return_specific_home")
+
+      attribute :data do
+        attribute :home_dock_sn, Types::SerialNumber
+      end
+    end
+  end
+end

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

@@ -2,13 +2,30 @@
 
 module DjiMqttConnect
   module Thing::Product
-    class ServicesMessage < Message
+    class ServicesMessage < 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, Types::Hash.default({}.freeze)
+
+      def humanized_summary
+        Translations.thing_product_services_summary(_method, **humanized_summary_interpolation)
+      end
+
+      def humanized_summary_interpolation
+        data.to_h.merge(method: _method)
+      end
+
+      # Returns all the flight IDs in the message
+      def flight_ids
+        []
+      end
     end
   end
 end

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

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+module DjiMqttConnect
+  module Thing::Product
+    class FlighttaskProgressGetServicesReplyMessage < ServicesReplyMessage
+      attribute :_method, Types::String.enum("flighttask_progress_get")
+
+      attribute :data do
+        include Mixins::ResultMessage
+
+        attribute :result, Types::ResultCode
+
+        attribute :output do
+          attribute :flight_id, Types::String
+
+          # {"partially_done":"partially done","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(
+            "partially_done",
+            "sent",
+            "in_progress",
+            "ok",
+            "paused",
+            "rejected",
+            "failed",
+            "canceled",
+            "timeout"
+          )
+
+          def humanized_status
+            I18n.t(status, scope: "dji_mqtt_connect.flighttask_status", default: status.titleize)
+          end
+
+          attribute :progress do
+            # {"0":"Initial state","1":"Pre-flight check, whether the aircraft is executing a wayline","2":"Pre-flight check, whether the dock has exited working mode","3":"Pre-flight check, wayline execution in progress","4":"Pre-return-to-home check, in the process of returning to home","5":"Wayline execution enters the preparation state, waiting for the mission to be issued","6":"Dock enters working state","7":"Enter the startup check and cover preparation work","8":"Remote image transmission frequency Pairing","9":"Waiting for the flight system to be ready, push connection established","10":"Waiting for RTK source to listen for reported values","11":"Check if the RTK source is from the dock, if not, reset it","12":"Waiting for flight control notification","13":"The dock has no control and seizes the control of the aircraft","14":"Consistency check of custom flight area","15":"Consistency check of offline maps","16":"Get the latest KMZ URL","17":"Download KMZ","18":"KMZ uploading","19":"Coloring configuration","20":"Aircraft takeoff parameter setting, alternate landing point setting, takeoff altitude setting, coloring setting","21":"Aircraft flyto takeoff parameter setting","22":"Takeoff dock checks the landing dock preparation status","23":"Home point setting","24":"Trigger wayline execution","25":"Wayline executing","26":"Enter pre-return-to-home check","27":"Aircraft landing at the dock","28":"Close the cover after landing","29":"Dock exits working mode","30":"Dock abnormal recovery","31":"Dock uploads flight system logs","32":"Check camera recording state","33":"Get the number of media files","34":"Abnormal recovery after dock takeoff cover","35":"Notify mission result","36":"Log list retrieval - Aircraft list","37":"Log list retrieval - Retrieve the list of docks","38":"Log list retrieval - Upload log list result","39":"Log retrieval - Retrieve aircraft logs","40":"Log retrieval - Retrieve dock logs","41":"Log retrieval - Compress aircraft logs","42":"Log retrieval - Compress dock logs","43":"Log retrieval - Upload aircraft logs","44":"Log retrieval - Upload dock logs","45":"Log retrieval - Notify the result","46":"Custom flight area file update preparation","47":"Custom flight area updating","48":"Offline map update preparation","49":"Offline map updating","65533":"Wait for service response after completion","65534":"No specific state","65535":"UNKNOWN"}
+            attribute :current_step, Types::Integer
+
+            def humanized_current_step
+              I18n.t(current_step, scope: "dji_mqtt_connect.flighttask_progress.current_step", default: current_step.to_s)
+            end
+
+            # {"min":"0","max":"100","step":"1"}
+            attribute :percent, Types::Integer.constrained(gteq: 0, lteq: 100)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module DjiMqttConnect
+  module Thing::Product
+    class FlighttaskStopServicesReplyMessage < ServicesReplyMessage
+      attribute :_method, Types::String.enum("flighttask_stop")
+    end
+  end
+end

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

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module DjiMqttConnect
+  module Thing::Product
+    class ReturnSpecificHomeServicesReplyMessage < ServicesReplyMessage
+      attribute :_method, Types::String.enum("return_specific_home")
+
+      attribute :data do
+        include Mixins::ResultMessage
+
+        attribute :result, Types::ResultCode
+
+        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::ServicesOutputStatus
+        end
+      end
+    end
+  end
+end

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

@@ -16,6 +16,14 @@ module DjiMqttConnect
         attribute :result, Types::ResultCode
       end
 
+      def humanized_summary
+        Translations.thing_product_services_reply_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?(ServicesReplyMessage) ? "#{super}[#{_method}]" : super

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

@@ -78,7 +78,9 @@ module DjiMqttConnect
       attribute :tid, Types::UUID
       attribute :bid, Types::UUID
       attribute :timestamp, Types::Timestamp
-      attribute :gateway, Types::String
+
+      # Can be determined from the topic, but included for convenience
+      attribute :gateway, Types::SerialNumber
 
       attribute :_data, Types::Hash
 
@@ -94,12 +96,51 @@ module DjiMqttConnect
           attribute :state, Types::Integer
         end
 
+        attribute? :cameras, Types::Array do
+          attribute :camera_mode, Types::Integer
+          attribute :liveview_world_region do
+            attribute :bottom, Types::JSON::Decimal
+            attribute :left, Types::JSON::Decimal
+            attribute :right, Types::JSON::Decimal
+            attribute :top, Types::JSON::Decimal
+          end
+          attribute :payload_index, Types::String
+          attribute :photo_state, Types::Integer
+          attribute :record_time, Types::Integer
+          attribute :recording_state, Types::Integer
+          attribute :remain_photo_num, Types::Integer
+          attribute :remain_record_duration, Types::Integer
+          attribute :wide_calibrate_farthest_focus_value, Types::Integer
+          attribute :wide_calibrate_nearest_focus_value, Types::Integer
+          attribute :wide_exposure_mode, Types::Integer
+          attribute :wide_exposure_value, Types::Integer
+          attribute :wide_focus_mode, Types::Integer
+          attribute :wide_focus_state, Types::Integer
+          attribute :wide_focus_value, Types::Integer
+          attribute :wide_iso, Types::Integer
+          attribute :wide_max_focus_value, Types::Integer
+          attribute :wide_min_focus_value, Types::Integer
+          attribute :wide_shutter_speed, Types::Integer
+          attribute :zoom_calibrate_farthest_focus_value, Types::Integer
+          attribute :zoom_calibrate_nearest_focus_value, Types::Integer
+          attribute :zoom_exposure_mode, Types::Integer
+          attribute :zoom_exposure_value, Types::Integer
+          attribute :zoom_factor, Types::JSON::Decimal
+          attribute :zoom_focus_mode, Types::Integer
+          attribute :zoom_focus_state, Types::Integer
+          attribute :zoom_focus_value, Types::Integer
+          attribute :zoom_iso, Types::Integer
+          attribute :zoom_max_focus_value, Types::Integer
+          attribute :zoom_min_focus_value, Types::Integer
+          attribute :zoom_shutter_speed, Types::Integer
+        end
+
         # Not all messages will have a live_capacity attribute
         attribute? :live_capacity do
           attribute :available_video_number, Types::Integer
           attribute :coexist_video_number_max, Types::Integer
           attribute :device_list, Types::Array do
-            attribute :sn, Types::String
+            attribute :sn, Types::SerialNumber
             attribute :available_video_number, Types::Integer
             attribute :coexist_video_number_max, Types::Integer
             attribute :camera_list, Types::Array do
@@ -107,18 +148,28 @@ module DjiMqttConnect
               attribute :available_video_number, Types::Integer
               attribute :coexist_video_number_max, Types::Integer
               attribute :video_list, Types::Array do
+                include Mixins::VideoType
+
                 attribute :video_index, Types::String
-                attribute :video_type, Types::String
-                attribute :switchable_video_types, Types::Array.of(Types::String)
+
+                attribute :video_type, Types::VideoType
+
+                attribute :switchable_video_types, Types::Array.of(Types::VideoType)
               end
             end
           end
         end
 
         attribute? :live_status, Types::Array do
+          include Mixins::VideoType
+          include Mixins::VideoQuality
+
           attribute :video_id, Types::String
-          attribute :video_type, Types::String
-          attribute :video_quality, Types::Integer
+
+          attribute :video_type, Types::VideoType
+
+          attribute :video_quality, Types::VideoQuality
+
           attribute :status, Types::Integer
           attribute :error_status, Types::Integer
         end
@@ -127,7 +178,7 @@ module DjiMqttConnect
           attribute :control_source, Types::String
           attribute? :firmware_version, Types::String
           attribute :payload_index, Types::String
-          attribute? :sn, Types::String
+          attribute? :sn, Types::SerialNumber
         end
 
         attribute? :rtcm_info do
@@ -141,13 +192,13 @@ module DjiMqttConnect
         attribute? :wireless_link_topo do
           attribute :center_node do
             attribute :sdr_id, Types::Integer
-            attribute :sn, Types::String
+            attribute :sn, Types::SerialNumber
           end
 
           attribute :leaf_nodes, Types::Array do
             attribute :control_source_index, Types::Integer
             attribute :sdr_id, Types::Integer
-            attribute :sn, Types::String
+            attribute :sn, Types::SerialNumber
             attribute :valid, Types::Bool
           end
 
@@ -178,6 +229,17 @@ module DjiMqttConnect
         attribute? :low_battery_warning_threshold, Types::Integer
         attribute? :serious_low_battery_warning_threshold, Types::Integer
       end
+
+      def humanized_summary
+        Translations.thing_product_state_summary(**humanized_summary_interpolation)
+      end
+
+      def humanized_summary_interpolation
+        data.to_h.merge(
+          # Provides a list of all keys that are not nil or empty
+          topics: data.to_h.compact.keys.sort.join(", ").presence || "-"
+        )
+      end
     end
   end
 end

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

@@ -2,7 +2,7 @@
 
 module DjiMqttConnect
   module Thing::Product
-    class StateReplyMessage < Message
+    class StateReplyMessage < DjiMqttConnect::Message
       # a result of 0 means we approve of this action
       def self.build_for(events_message, result: 0)
         new(
@@ -15,6 +15,9 @@ module DjiMqttConnect
         )
       end
 
+      # Ensure all values are accepted
+      schema schema.strict
+
       attribute :bid, Types::UUID
       attribute :tid, Types::UUID
       attribute :timestamp, Types::Timestamp
@@ -24,6 +27,14 @@ module DjiMqttConnect
 
         attribute :result, Types::ResultCode
       end
+
+      def humanized_summary
+        Translations.thing_product_state_reply_summary(**humanized_summary_interpolation)
+      end
+
+      def humanized_summary_interpolation
+        data.to_h
+      end
     end
   end
 end

data/lib/dji_mqtt_connect/mixins/video_quality.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module DjiMqttConnect
+  module Mixins
+    # Adds video quality helper methods
+    # Assumes a `video_quality` attribute is present of type `Types::VideoQuality`
+    module VideoQuality
+      def humanized_video_quality
+        if video_quality_adaptive?
+          I18n.t("adaptive", scope: "dji_mqtt_connect.video_quality")
+        elsif video_quality_smooth?
+          I18n.t("smooth", scope: "dji_mqtt_connect.video_quality")
+        elsif video_quality_standard_definition?
+          I18n.t("standard_definition", scope: "dji_mqtt_connect.video_quality")
+        elsif video_quality_high_definition?
+          I18n.t("high_definition", scope: "dji_mqtt_connect.video_quality")
+        elsif video_quality_ultra_high_definition?
+          I18n.t("ultra_high_definition", scope: "dji_mqtt_connect.video_quality")
+        end
+      end
+
+      def video_quality_adaptive?
+        video_quality == Types::VIDEO_QUALITY_ADAPTIVE
+      end
+
+      def video_quality_smooth?
+        video_quality == Types::VIDEO_QUALITY_SMOOTH
+      end
+
+      def video_quality_standard_definition?
+        video_quality == Types::VIDEO_QUALITY_STANDARD_DEFINITION
+      end
+
+      def video_quality_high_definition?
+        video_quality == Types::VIDEO_QUALITY_HIGH_DEFINITION
+      end
+
+      def video_quality_ultra_high_definition?
+        video_quality == Types::VIDEO_QUALITY_ULTRA_HIGH_DEFINITION
+      end
+    end
+  end
+end

data/lib/dji_mqtt_connect/mixins/video_type.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module DjiMqttConnect
+  module Mixins
+    # Adds video type helper methods
+    # Assumes a `video_type` attribute is present of type `Types::VideoType`
+    module VideoType
+      def humanized_video_type
+        if video_type_infrared?
+          I18n.t("infrared", scope: "dji_mqtt_connect.video_types") # Infrared
+        elsif video_type_normal?
+          I18n.t("normal", scope: "dji_mqtt_connect.video_types") # Default
+        elsif video_type_wide_angle?
+          I18n.t("wide_angle", scope: "dji_mqtt_connect.video_types") # Wide-angle
+        elsif video_type_zoom?
+          I18n.t("zoom", scope: "dji_mqtt_connect.video_types") # Zoom
+        end
+      end
+
+      def video_type_infrared?
+        video_type == Types::VIDEO_TYPE_INFRARED
+      end
+
+      def video_type_normal?
+        video_type == Types::VIDEO_TYPE_NORMAL
+      end
+
+      def video_type_wide_angle?
+        video_type == Types::VIDEO_TYPE_WIDE_ANGLE
+      end
+
+      def video_type_zoom?
+        video_type == Types::VIDEO_TYPE_ZOOM
+      end
+    end
+  end
+end

data/lib/dji_mqtt_connect/translations.rb

@@ -91,5 +91,149 @@ module DjiMqttConnect
         position_name("unknown")
       end
     end
+
+    ### Message Summaries ###
+
+    def result_summary(result)
+      I18n.t(
+        "dji_mqtt_connect.result_summary",
+        result: result,
+        result_message: result_message(result)
+      )
+    end
+
+    def failed_result_summary(result)
+      I18n.t(
+        "dji_mqtt_connect.failed_result_summary",
+        result: result,
+        result_message: result_message(result)
+      )
+    end
+
+    def sys_product_status_summary(method, result: 0, **data)
+      return failed_result_summary(result) if result != 0
+
+      I18n.t(
+        method,
+        **data,
+        scope: "dji_mqtt_connect.sys_product_status_summary",
+        default: :default,
+        method: method,
+        result: result_summary(result)
+      )
+    end
+
+    def thing_product_events_summary(method, result: 0, **data)
+      return failed_result_summary(result) if result != 0
+
+      I18n.t(
+        method,
+        **data,
+        scope: "dji_mqtt_connect.thing_product_events_summary",
+        default: :default,
+        method: method,
+        result: result_summary(result)
+      )
+    end
+
+    def thing_product_events_reply_summary(method, result: 0, **data)
+      return failed_result_summary(result) if result != 0
+
+      I18n.t(
+        method,
+        **data,
+        scope: "dji_mqtt_connect.thing_product_events_reply_summary",
+        default: :default,
+        method: method,
+        result: result_summary(result)
+      )
+    end
+
+    def thing_product_osd_summary(**data)
+      I18n.t("default", **data, scope: "dji_mqtt_connect.thing_product_osd_summary")
+    end
+
+    def thing_product_dock_osd_summary(**data)
+      I18n.t("dock", **data, scope: "dji_mqtt_connect.thing_product_osd_summary", default: :default)
+    end
+
+    def thing_product_drone_osd_summary(**data)
+      I18n.t("drone", **data, scope: "dji_mqtt_connect.thing_product_osd_summary", default: :default)
+    end
+
+    def thing_product_remote_osd_summary(**data)
+      I18n.t("remote", **data, scope: "dji_mqtt_connect.thing_product_osd_summary", default: :default)
+    end
+
+    def thing_product_requests_summary(method, result: 0, **data)
+      return failed_result_summary(result) if result != 0
+
+      I18n.t(
+        method,
+        **data,
+        scope: "dji_mqtt_connect.thing_product_requests_summary",
+        default: :default,
+        method: method,
+        result: result_summary(result)
+      )
+    end
+
+    def thing_product_requests_reply_summary(method, result: 0, **data)
+      return failed_result_summary(result) if result != 0
+
+      I18n.t(
+        method,
+        **data,
+        scope: "dji_mqtt_connect.thing_product_requests_reply_summary",
+        default: :default,
+        method: method,
+        result: result_summary(result)
+      )
+    end
+
+    def thing_product_services_summary(method, **data)
+      I18n.t(
+        method,
+        **data,
+        scope: "dji_mqtt_connect.thing_product_services_summary",
+        default: :default,
+        method: method
+      )
+    end
+
+    def thing_product_services_reply_summary(method, result: 0, **data)
+      return failed_result_summary(result) if result != 0
+
+      I18n.t(
+        method,
+        **data,
+        scope: "dji_mqtt_connect.thing_product_services_reply_summary",
+        default: :default,
+        method: method,
+        result: result_summary(result)
+      )
+    end
+
+    def thing_product_state_summary(result: 0, **data)
+      return failed_result_summary(result) if result != 0
+
+      I18n.t(
+        "state",
+        **data,
+        scope: "dji_mqtt_connect.thing_product_state_summary",
+        default: :default,
+        result: result_summary(result)
+      )
+    end
+
+    def thing_product_state_reply_summary(result: 0, **data)
+      return failed_result_summary(result) if result != 0
+
+      I18n.t(
+        "dji_mqtt_connect.thing_product_state_reply_summary",
+        **data,
+        result: result_summary(result)
+      )
+    end
   end
 end

data/lib/dji_mqtt_connect/types.rb

@@ -19,7 +19,11 @@ module DjiMqttConnect
     # Just make sure Timestamps are 13 digits long
     Timestamp = Types::Integer & Types::Coercible::String.constrained(format: /\A[1-9][0-9]{12}\z/)
 
-    SerialNumber = Types::String
+    # Serial Numbers are alphanumeric with optional hyphen
+    SerialNumber = Types::String.constrained(format: /\A[0-9A-Z]+(-[0-9A-Z]+)?\z/)
+
+    # Flight ID is a string with at least 1 character
+    FlightID = Types::String.constrained(min_size: 1)
 
     # lat/lng coordinates
     Latitude = NullInteger | Types::JSON::Decimal.constrained(gteq: -90, lteq: 90)
@@ -78,6 +82,25 @@ module DjiMqttConnect
       SERVICE_OUTPUT_STATUS_TIMEOUT = "timeout"
     )
 
+    # Video Quality
+    # {"0":"Adaptive","1":"Smooth","2":"Standard definition","3":"High definition","4":"Ultra-high definition"}
+    VideoQuality = Types::Integer.enum(
+      VIDEO_QUALITY_ADAPTIVE = 0,
+      VIDEO_QUALITY_SMOOTH = 1,
+      VIDEO_QUALITY_STANDARD_DEFINITION = 2,
+      VIDEO_QUALITY_HIGH_DEFINITION = 3,
+      VIDEO_QUALITY_ULTRA_HIGH_DEFINITION = 4
+    )
+
+    # Video Type
+    # {"ir":"Infrared","normal":"Default","wide":"Wide-angle","zoom":"Zoom"}
+    VideoType = Types::String.enum(
+      VIDEO_TYPE_INFRARED = "ir",
+      VIDEO_TYPE_NORMAL = "normal",
+      VIDEO_TYPE_WIDE_ANGLE = "wide",
+      VIDEO_TYPE_ZOOM = "zoom"
+    )
+
     # Result for messages
     ResultCode = Types::Integer.constrained(gteq: 0)
   end

data/lib/dji_mqtt_connect/utils/message_dumping.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+require "dry-transformer"
+
+module DjiMqttConnect
+  module Utils
+    # Provides methods for transforming data for a marshal to dump
+    module MessageDumping
+      # Renames the method attribute
+      class MessageTransformer < Dry::Transformer::Pipe
+        import Dry::Transformer::HashTransformations
+
+        define! do
+          rename_keys _method: :method
+        end
+      end
+
+      private
+
+      # Converts a DjiMqttConnect::Message to a serializeable hash
+      def convert_message_to_hash(message)
+        # Fix up the hash representation
+        transformed_message = message_transformer.call(message)
+
+        # Convert the transformed message into JSON-compatible data
+        convert_to_serializable_object(transformed_message)
+      end
+
+      # Converts an object to a mqtt serializable object
+      def convert_to_serializable_object(object)
+        case object
+        when Hash
+          object.transform_values { |value| convert_to_serializable_object(value) }
+        when Array
+          object.map { |value| convert_to_serializable_object(value) }
+        when BigDecimal
+          # DJI expects floats, not string decimals
+          object.to_f
+        else
+          object
+        end
+      end
+
+      def message_transformer
+        @message_transformer ||= MessageTransformer.new
+      end
+    end
+  end
+end

data/lib/dji_mqtt_connect/version.rb

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