dji_mqtt_connect 0.1.12.1 → 0.1.13

data/lib/dji_mqtt_connect/messages/thing/product/{fileupload_progress_events_message.rb → events/fileupload_progress.rb}

@@ -6,9 +6,6 @@ module DjiMqttConnect
     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
@@ -35,10 +32,6 @@ module DjiMqttConnect
           attribute :status, Types::String
         end
       end
-
-      def need_reply?
-        need_reply == 1
-      end
     end
   end
 end

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

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+module DjiMqttConnect
+  module Thing::Product
+    # Report wayline task progress
+    # https://developer.dji.com/doc/cloud-api-tutorial/en/server-api-reference/mqtt/thing-model/gateway/dock/wayline.html#report-wayline-task-progress
+    class FlighttaskProgressEventsMessage < EventsMessage
+      attribute :_method, Types::String.enum("flighttask_progress")
+
+      attribute :data do
+        attribute :output do
+          attribute :ext do
+            attribute :current_waypoint_index, Types::Integer
+            attribute :media_count, Types::Integer
+            attribute :track_id, Types::String
+            attribute :flight_id, Types::String
+
+            attribute :break_point do
+              attribute :index, Types::Integer
+
+              # {"0":"On the wayline segment","1":"On the waypoint"}
+              attribute :state, Types::Integer.enum(0, 1)
+
+              # {"min":"0","max":"1.0"}
+              attribute :progress, Types::JSON::Decimal.constrained(gteq: 0, lteq: 1.0)
+
+              attribute :wayline_id, Types::Integer
+
+              attribute :break_reason, Types::Integer
+
+              attribute :latitude, Types::Latitude
+              attribute :longitude, Types::Longitude
+
+              # {"unit":"m","unitName":"meter"}
+              attribute :height, Types::JSON::Decimal
+
+              attribute :attitude_head, Types::Integer
+            end
+          end
+
+          # {"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"
+          )
+
+          attribute :progress do
+            # {"0-4":"MissionCenter starting, checking and resuming","5-18":"Waiting state","19, 20":"Task executing","21-29":"Returning to home","30-39":"Pulling logs","Others":"Interaction completed"}
+            attribute :current_step, Types::Integer
+
+            # {"min":"0","max":"100","step":"1"}
+            attribute :percent, Types::Integer.constrained(gteq: 0, lteq: 100)
+          end
+        end
+
+        attribute :result, Types::Integer
+      end
+    end
+  end
+end

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

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module DjiMqttConnect
+  module Thing::Product
+    # Notification of task readiness
+    # https://developer.dji.com/doc/cloud-api-tutorial/en/server-api-reference/mqtt/thing-model/gateway/dock/wayline.html#notification-of-task-readiness
+    class FlighttaskReadyEventsMessage < EventsMessage
+      attribute :_method, Types::String.enum("flighttask_ready")
+
+      attribute :data do
+        attribute :flight_ids, Types::Array.of(Types::String)
+      end
+    end
+  end
+end

data/lib/dji_mqtt_connect/messages/thing/product/{highest_priority_upload_flighttask_media_events_message.rb → events/highest_priority_upload_flighttask_media.rb}

@@ -5,16 +5,9 @@ module DjiMqttConnect
     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/events_message.rb

@@ -7,9 +7,16 @@ module DjiMqttConnect
       attribute :tid, Types::UUID
       attribute :timestamp, Types::Timestamp
 
+      # NOTE: Included in most events messages, requires a reply on the events_reply topic if true
+      attribute? :need_reply, Types::Integer.enum(0, 1)
+
       attribute :_data, Types::Hash
       attribute :_method, Types::String
 
+      def need_reply?
+        need_reply == 1
+      end
+
       def to_s
         # Include data method for Generic messages
         instance_of?(EventsMessage) ? "#{super}[#{_method}]" : super

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

@@ -22,8 +22,11 @@ module DjiMqttConnect
       attribute :timestamp, Types::Timestamp
 
       attribute :_method, Types::String.enum(
+        "device_exit_homing_notify",
         "file_upload_callback",
         "fileupload_progress",
+        "flighttask_progress",
+        "flighttask_ready",
         "highest_priority_upload_flighttask_media"
       )
 

data/lib/dji_mqtt_connect/messages/thing/product/requests/flighttask_resource_get.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module DjiMqttConnect
+  module Thing::Product
+    # Get the wayline task resource
+    # https://developer.dji.com/doc/cloud-api-tutorial/en/server-api-reference/mqtt/thing-model/gateway/dock/wayline.html#get-the-wayline-task-resource
+    class FlighttaskResourceGetRequestsMessage < RequestsMessage
+      attribute :_method, Types::String.enum("flighttask_resource_get")
+
+      attribute :data do
+        attribute :flight_id, Types::String
+      end
+    end
+  end
+end

data/lib/dji_mqtt_connect/messages/thing/product/requests_reply/flighttask_resource_get.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module DjiMqttConnect
+  module Thing::Product
+    # Get the wayline task resource
+    # https://developer.dji.com/doc/cloud-api-tutorial/en/server-api-reference/mqtt/thing-model/gateway/dock/wayline.html#get-the-wayline-task-resource
+    class FlighttaskResourceGetRequestsReplyMessage < Message
+      def self.build_for(airport_organization_get_message, file:, result: 0)
+        new(
+          _method: airport_organization_get_message._method,
+          tid: airport_organization_get_message.tid,
+          bid: airport_organization_get_message.bid,
+          timestamp: current_timestamp,
+          data: {
+            result: result,
+            output: {
+              file: file
+            }
+          }
+        )
+      end
+
+      attribute :tid, Types::UUID
+      attribute :bid, Types::UUID
+      attribute :timestamp, Types::Timestamp
+
+      attribute :_method, Types::String.enum("flighttask_resource_get")
+
+      attribute :data do
+        attribute :result, Types::Integer
+
+        attribute :output do
+          attribute :file do
+            # File MD5 signature
+            attribute :fingerprint, Types::String
+
+            # File URL
+            attribute :url, Types::String
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module DjiMqttConnect
+  module Thing::Product
+    class AlarmStateSwitchServicesMessage < ServicesMessage
+      ACTION_OPEN = 1
+      ACTION_CLOSE = 0
+
+      def self.build(action:, bid: generate_bid, tid: generate_tid, timestamp: current_timestamp)
+        new(
+          bid: bid,
+          tid: tid,
+          timestamp: timestamp,
+          _method: "alarm_state_switch",
+          data: {
+            action: action
+          }
+        )
+      end
+
+      attribute :_method, Types::String.enum("alarm_state_switch")
+
+      attribute :data do
+        # {"0":"Close","1":"Open"}
+        attribute :action, Types::Integer.enum(ACTION_CLOSE, ACTION_OPEN)
+      end
+    end
+  end
+end

data/lib/dji_mqtt_connect/messages/thing/product/{cover_close_services_message.rb → services/cover_close.rb}

@@ -2,7 +2,7 @@
 
 module DjiMqttConnect
   module Thing::Product
-    class CoverCloseServicesMessage < Message
+    class CoverCloseServicesMessage < ServicesMessage
       def self.build(bid: generate_bid, tid: generate_tid, timestamp: current_timestamp)
         new(
           bid: bid,
@@ -12,11 +12,8 @@ module DjiMqttConnect
         )
       end
 
-      attribute :tid, Types::UUID
-      attribute :bid, Types::UUID
-      attribute :timestamp, Types::Timestamp
-
       attribute :_method, Types::String.enum("cover_close")
+
       attribute :data, Types::Hash.default({}.freeze)
     end
   end

data/lib/dji_mqtt_connect/messages/thing/product/{cover_open_services_message.rb → services/cover_open.rb}

@@ -2,7 +2,7 @@
 
 module DjiMqttConnect
   module Thing::Product
-    class CoverOpenServicesMessage < Message
+    class CoverOpenServicesMessage < ServicesMessage
       def self.build(bid: generate_bid, tid: generate_tid, timestamp: current_timestamp)
         new(
           bid: bid,
@@ -12,11 +12,8 @@ module DjiMqttConnect
         )
       end
 
-      attribute :tid, Types::UUID
-      attribute :bid, Types::UUID
-      attribute :timestamp, Types::Timestamp
-
       attribute :_method, Types::String.enum("cover_open")
+
       attribute :data, Types::Hash.default({}.freeze)
     end
   end

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

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module DjiMqttConnect
+  module Thing::Product
+    class DebugModeCloseServicesMessage < ServicesMessage
+      def self.build(bid: generate_bid, tid: generate_tid, timestamp: current_timestamp)
+        new(
+          bid: bid,
+          tid: tid,
+          timestamp: timestamp,
+          _method: "debug_mode_close"
+        )
+      end
+
+      attribute :_method, Types::String.enum("debug_mode_close")
+
+      attribute :data, Types::Hash.default({}.freeze)
+    end
+  end
+end

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

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module DjiMqttConnect
+  module Thing::Product
+    class DebugModeOpenServicesMessage < ServicesMessage
+      def self.build(bid: generate_bid, tid: generate_tid, timestamp: current_timestamp)
+        new(
+          bid: bid,
+          tid: tid,
+          timestamp: timestamp,
+          _method: "debug_mode_open"
+        )
+      end
+
+      attribute :_method, Types::String.enum("debug_mode_open")
+
+      attribute :data, Types::Hash.default({}.freeze)
+    end
+  end
+end

data/lib/dji_mqtt_connect/messages/thing/product/{fileupload_list_services_message.rb → services/fileupload_list.rb}

@@ -2,7 +2,7 @@
 
 module DjiMqttConnect
   module Thing::Product
-    class FileuploadListServicesMessage < Message
+    class FileuploadListServicesMessage < ServicesMessage
       def self.build(module_list:, bid: generate_bid, tid: generate_tid, timestamp: current_timestamp)
         new(
           _method: "fileupload_list",
@@ -17,9 +17,6 @@ module DjiMqttConnect
 
       attribute :_method, Types::String.enum("fileupload_list")
 
-      attribute :tid, Types::UUID
-      attribute :bid, Types::UUID
-      attribute :timestamp, Types::Timestamp
       attribute :data do
         attribute :module_list, Types::Array.of(Types::Coercible::String.enum("0", "3"))
       end

data/lib/dji_mqtt_connect/messages/thing/product/{fileupload_start_services_message.rb → services/fileupload_start.rb}

@@ -2,7 +2,7 @@
 
 module DjiMqttConnect
   module Thing::Product
-    class FileuploadStartServicesMessage < Message
+    class FileuploadStartServicesMessage < ServicesMessage
       def self.build(data:, bid: generate_bid, tid: generate_tid, timestamp: current_timestamp)
         new(
           _method: "fileupload_start",
@@ -15,10 +15,6 @@ module DjiMqttConnect
 
       attribute :_method, Types::String.enum("fileupload_start")
 
-      attribute :tid, Types::UUID
-      attribute :bid, Types::UUID
-      attribute :timestamp, Types::Timestamp
-
       attribute :data do
         attribute :endpoint, Types::String
         attribute :bucket, Types::String

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

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module DjiMqttConnect
+  module Thing::Product
+    # Execute wayline task
+    # https://developer.dji.com/doc/cloud-api-tutorial/en/server-api-reference/mqtt/thing-model/gateway/dock/wayline.html#execute-wayline-task
+    class FlighttaskExecuteServicesMessage < ServicesMessage
+      def self.build(flight_id:, bid: generate_bid, tid: generate_tid, timestamp: current_timestamp)
+        new(
+          bid: bid,
+          tid: tid,
+          timestamp: timestamp,
+          _method: "flighttask_execute",
+          data: {
+            flight_id: flight_id
+          }
+        )
+      end
+
+      attribute :_method, Types::String.enum("flighttask_execute")
+
+      attribute :data do
+        attribute :flight_id, Types::String
+      end
+    end
+  end
+end

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

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module DjiMqttConnect
+  module Thing::Product
+    class FlighttaskPauseServicesMessage < ServicesMessage
+      def self.build(bid: generate_bid, tid: generate_tid, timestamp: current_timestamp)
+        new(
+          bid: bid,
+          tid: tid,
+          timestamp: timestamp,
+          _method: "flighttask_pause"
+        )
+      end
+
+      attribute :_method, Types::String.enum("flighttask_pause")
+
+      attribute :data, Types::Hash.default({}.freeze)
+    end
+  end
+end

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

@@ -0,0 +1,86 @@
+# frozen_string_literal: true
+
+module DjiMqttConnect
+  module Thing::Product
+    # Issue wayline task
+    # https://developer.dji.com/doc/cloud-api-tutorial/en/server-api-reference/mqtt/thing-model/gateway/dock/wayline.html#issue-wayline-task
+    class FlighttaskPrepareServicesMessage < ServicesMessage
+      def self.build(data:, bid: generate_bid, tid: generate_tid, timestamp: current_timestamp)
+        new(
+          bid: bid,
+          tid: tid,
+          timestamp: timestamp,
+          _method: "flighttask_prepare",
+          data: data
+        )
+      end
+
+      attribute :_method, Types::String.enum("flighttask_prepare")
+
+      attribute :data do
+        # Millisecond timestamp of task execution time.
+        # Optional field. When the task_type is 0 or 1, it is required. When the task_type is 2, it is not required.
+        attribute? :execute_time, Types::Timestamp
+
+        attribute :flight_id, Types::String
+
+        # The execution time of immediate task and timed task are defined by execute_time.
+        # The conditional task supports the task readiness condition defined by ready_conditions.
+        # The task can be executed if conditions are satisfied within a specified period.
+        # Immediate task has the highest priority.
+        # Timed task and conditional task have the same priority.
+        # {"0":"Immediate task","1":"Timed task","2":"Conditional task"}
+        attribute :task_type, Types::Integer.enum(0, 1, 2)
+
+        # {"0":"Normal waypoint wayline"}
+        attribute :wayline_type, Types::Integer.enum(0)
+
+        attribute :file do
+          # File MD5 signature
+          attribute :fingerprint, Types::String
+
+          # File URL
+          attribute :url, Types::String
+        end
+
+        # Optional field. For conditional task (which means the task_type is 2), this field is required. For other types of tasks, this field is ignored.
+        # After the conditional task is issued, device will check whether the ready_conditions are satisfied or not at a fixed frequency.
+        # If conditions are satisfied, flighttask_ready event will be sent.
+        # When the device side receives the flighttask_execute command, conditions of the ready_conditions of task will be checked whether they are all satisfied.
+        attribute? :ready_conditions do
+          attribute? :battery_capacity, Types::Integer
+
+          attribute? :begin_time, Types::Timestamp
+
+          attribute? :end_time, Types::Timestamp
+        end
+
+        # Optional field. Pre-check conditions added for task execution on the device side. If any condition is not satisfied, execution will fail.
+        attribute? :executable_conditions do
+          attribute :storage_capacity, Types::Integer
+        end
+
+        # Optional field for resuming interrupted wayline task. If specified, the wayline task will start executing from the breakpoint position indicated by the field.
+        attribute? :break_point do
+          attribute :index, Types::Integer
+
+          # {"0":"On the wayline segment","1":"On the waypoint"}
+          attribute :state, Types::Integer.enum(0, 1)
+
+          attribute :progress, Types::Float.constrained(gteq: 0, lteq: 1.0)
+
+          attribute :wayline_id, Types::Integer
+        end
+
+        # {"unit":"meter","min":20,"max":1500}
+        attribute :rth_altitude, Types::Integer.constrained(gteq: 20, lteq: 1500)
+
+        # {"0":"Return to Home (RTH)","1":"Hovering","2":"Landing"}
+        attribute :out_of_control_action, Types::Integer.enum(0, 1, 2)
+
+        # {"0":"Continue executing the wayline task","1":"Exit the wayline task and execute the remote controller out of control action"}
+        attribute :exit_wayline_when_rc_lost, Types::Integer.enum(0, 1)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module DjiMqttConnect
+  module Thing::Product
+    # Resume wayline task
+    # https://developer.dji.com/doc/cloud-api-tutorial/en/server-api-reference/mqtt/thing-model/gateway/dock/wayline.html#resume-wayline-task
+    class FlighttaskRecoveryServicesMessage < ServicesMessage
+      def self.build(bid: generate_bid, tid: generate_tid, timestamp: current_timestamp)
+        new(
+          bid: bid,
+          tid: tid,
+          timestamp: timestamp,
+          _method: "flighttask_recovery"
+        )
+      end
+
+      attribute :_method, Types::String.enum("flighttask_recovery")
+
+      attribute :data, Types::Hash.default({}.freeze)
+    end
+  end
+end

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

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module DjiMqttConnect
+  module Thing::Product
+    # Cancel wayline task
+    # https://developer.dji.com/doc/cloud-api-tutorial/en/server-api-reference/mqtt/thing-model/gateway/dock/wayline.html#cancel-wayline-task
+    class FlighttaskUndoServicesMessage < ServicesMessage
+      def self.build(flight_ids:, bid: generate_bid, tid: generate_tid, timestamp: current_timestamp)
+        new(
+          bid: bid,
+          tid: tid,
+          timestamp: timestamp,
+          _method: "flighttask_undo",
+          data: {
+            flight_ids: flight_ids
+          }
+        )
+      end
+
+      attribute :_method, Types::String.enum("flighttask_undo")
+
+      attribute :data do
+        attribute :flight_ids, Types::Array.of(Types::String)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module DjiMqttConnect
+  module Thing::Product
+    # Return to Home (RTH)
+    # https://developer.dji.com/doc/cloud-api-tutorial/en/server-api-reference/mqtt/thing-model/gateway/dock/wayline.html#return-to-home-rth
+    class ReturnHomeServicesMessage < Message
+      def self.build(bid: generate_bid, tid: generate_tid, timestamp: current_timestamp)
+        new(
+          bid: bid,
+          tid: tid,
+          timestamp: timestamp,
+          _method: "return_home"
+        )
+      end
+
+      attribute :tid, Types::UUID
+      attribute :bid, Types::UUID
+      attribute :timestamp, Types::Timestamp
+
+      attribute :_method, Types::String.enum("return_home")
+      attribute :data, Types::Hash.default({}.freeze)
+    end
+  end
+end

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

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module DjiMqttConnect
+  module Thing::Product
+    # Cancel return to home
+    #
+    # After returning to home, the aircraft will exit the wayline mode. At this point, if the return-to-home command is canceled, the aircraft will hover.
+    #
+    # https://developer.dji.com/doc/cloud-api-tutorial/en/server-api-reference/mqtt/thing-model/gateway/dock/wayline.html#cancel-return-to-home
+    class ReturnHomeCancelServicesMessage < Message
+      def self.build(bid: generate_bid, tid: generate_tid, timestamp: current_timestamp)
+        new(
+          bid: bid,
+          tid: tid,
+          timestamp: timestamp,
+          _method: "return_home_cancel"
+        )
+      end
+
+      attribute :tid, Types::UUID
+      attribute :bid, Types::UUID
+      attribute :timestamp, Types::Timestamp
+
+      attribute :_method, Types::String.enum("return_home_cancel")
+      attribute :data, Types::Hash.default({}.freeze)
+    end
+  end
+end

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

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module DjiMqttConnect
+  module Thing::Product
+    class ServicesMessage < Message
+      # Ensure all values are accepted
+      schema schema.strict
+
+      attribute :tid, Types::UUID
+      attribute :bid, Types::UUID
+      attribute :timestamp, Types::Timestamp
+    end
+  end
+end

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

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module DjiMqttConnect
+  module Thing::Product
+    class AlarmStateSwitchServicesReplyMessage < ServicesReplyMessage
+      attribute :_method, Types::String.enum("alarm_state_switch")
+
+      attribute :data do
+        attribute :result, Types::Integer
+
+        attribute :output do
+          # {"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(
+            "sent",
+            "in_progress",
+            "ok",
+            "paused",
+            "rejected",
+            "failed",
+            "canceled",
+            "timeout"
+          )
+        end
+      end
+    end
+  end
+end