dji_mqtt_connect 0.1.22.2 → 0.1.23.1

data/lib/dji_mqtt_connect/factories.rb

@@ -4,231 +4,11 @@ module DjiMqttConnect
   # Factories for building example messages
   # Do not include this in your production code
   module Factories
-    # Events
+    autoload :EventsMessages, "dji_mqtt_connect/factories/events_messages"
+    autoload :StateMessages, "dji_mqtt_connect/factories/state_messages"
 
-    def build_device_exit_homing_notify_events_message
-      message_data = {
-        action: 1,
-        sn: "DOCK01",
-        reason: "0"
-      }
-      Thing::Product::DeviceExitHomingNotifyEventsMessage.new(
-        _method: "device_exit_homing_notify",
-        bid: Message.generate_bid,
-        tid: Message.generate_tid,
-        need_reply: 1,
-        gateway: "GATEWAY01",
-        timestamp: Message.current_timestamp,
-        data: message_data,
-        _data: message_data
-      )
-    end
-
-    def build_thing_product_device_reboot_events_message
-      message_data = {
-        result: 0,
-        output: {
-          status: "ok",
-          progress: {
-            percent: 100
-          }
-        }
-      }
-
-      Thing::Product::DeviceRebootEventsMessage.new(
-        bid: Message.generate_bid,
-        tid: Message.generate_tid,
-        timestamp: Message.current_timestamp,
-        _method: "device_reboot",
-        need_reply: 1,
-        data: message_data,
-        _data: message_data
-      )
-    end
-
-    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: Message.generate_bid,
-        tid: Message.generate_tid,
-        need_reply: 1,
-        gateway: "xxx",
-        timestamp: Message.current_timestamp,
-        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,
-                  progress: 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,
-                  progress: 100,
-                  finish_time: 1655781395926,
-                  upload_rate: 0,
-                  result: 0,
-                  status: "ok"
-                }
-              }
-            ]
-          },
-          status: "ok"
-        }
-      }
-
-      Thing::Product::FileuploadProgressEventsMessage.new(
-        _method: "fileupload_progress",
-        need_reply: 0,
-        bid: Message.generate_bid,
-        tid: Message.generate_tid,
-        timestamp: Message.current_timestamp,
-        gateway: "dock_sn",
-        _data: message_data,
-        data: message_data
-      )
-    end
-
-    def build_flighttask_progress_events_message
-      message_data = {
-        output: {
-          ext: {
-            current_waypoint_index: 3,
-            media_count: 6,
-            track_id: "track_id",
-            flight_id: "flight_id",
-            break_point: {
-              index: 1,
-              state: 0,
-              progress: 0.34,
-              wayline_id: 0,
-              break_reason: 1,
-              latitude: 23.4,
-              longitude: 113.99,
-              height: 100.23,
-              attitude_head: 30
-            }
-          },
-          progress: {
-            current_step: 19,
-            percent: 100
-          },
-          status: "ok"
-        },
-        result: 0
-      }
-
-      Thing::Product::FlighttaskProgressEventsMessage.new(
-        bid: Message.generate_bid,
-        tid: Message.generate_tid,
-        data: message_data,
-        _data: message_data,
-        _method: "flighttask_progress",
-        timestamp: Message.current_timestamp
-      )
-    end
-
-    def build_flighttask_ready_events_message
-      message_data = {
-        flight_ids: [
-          SecureRandom.uuid,
-          SecureRandom.uuid
-        ]
-      }
-
-      Thing::Product::FlighttaskReadyEventsMessage.new(
-        bid: Message.generate_bid,
-        tid: Message.generate_tid,
-        data: message_data,
-        _data: message_data,
-        _method: "flighttask_ready",
-        timestamp: Message.current_timestamp
-      )
-    end
-
-    def build_highest_priority_upload_flighttask_media_events_message
-      message_data = {
-        flight_id: SecureRandom.uuid
-      }
-
-      Thing::Product::HighestPriorityUploadFlighttaskMediaEventsMessage.new(
-        bid: Message.generate_bid,
-        _data: message_data,
-        data: message_data,
-        _method: "highest_priority_upload_flighttask_media",
-        need_reply: 1,
-        tid: Message.generate_tid,
-        timestamp: Message.current_timestamp,
-        gateway: "DOCK01"
-      )
-    end
-
-    def build_offline_map_sync_progress_events_message
-      message_data = {
-        status: "failed",
-        reason: 0,
-        file: "geofence_xxx.json"
-      }
-
-      Thing::Product::OfflineMapSyncProgressEventsMessage.new(
-        bid: Message.generate_bid,
-        tid: Message.generate_tid,
-        timestamp: Message.current_timestamp,
-        _method: "offline_map_sync_progress",
-        need_reply: 1,
-        data: message_data,
-        _data: message_data
-      )
-    end
+    include EventsMessages
+    include StateMessages
 
     # OSD
 
@@ -1166,85 +946,5 @@ module DjiMqttConnect
         data: message_data
       )
     end
-
-    ### State Messages ###
-
-    def build_thing_product_live_capacity_state_message
-      message_data = {
-        live_capacity: {
-          available_video_number: 3,
-          coexist_video_number_max: 2,
-          device_list: [
-            {
-              sn: "DOCK01",
-              available_video_number: 1,
-              coexist_video_number_max: 1,
-              camera_list: [
-                {
-                  camera_index: "165-0-7",
-                  available_video_number: 1,
-                  coexist_video_number_max: 1,
-                  video_list: [
-                    {
-                      video_index: "normal-0",
-                      video_type: "normal",
-                      switchable_video_types: [
-                        "normal"
-                      ]
-                    }
-                  ]
-                }
-              ]
-            },
-            {
-              sn: "DRONE01",
-              available_video_number: 2,
-              coexist_video_number_max: 2,
-              camera_list: [
-                {
-                  camera_index: "39-0-7",
-                  available_video_number: 1,
-                  coexist_video_number_max: 1,
-                  video_list: [
-                    {
-                      video_index: "normal-0",
-                      video_type: "normal",
-                      switchable_video_types: [
-                        "normal"
-                      ]
-                    }
-                  ]
-                },
-                {
-                  camera_index: "52-0-0",
-                  available_video_number: 1,
-                  coexist_video_number_max: 1,
-                  video_list: [
-                    {
-                      video_index: "normal-0",
-                      video_type: "wide",
-                      switchable_video_types: [
-                        "wide",
-                        "zoom",
-                        "ir"
-                      ]
-                    }
-                  ]
-                }
-              ]
-            }
-          ]
-        }
-      }
-
-      Thing::Product::StateMessage.new(
-        bid: Message.generate_bid,
-        tid: Message.generate_tid,
-        timestamp: Message.current_timestamp,
-        gateway: "GATEWAY01",
-        _data: message_data,
-        data: message_data
-      )
-    end
   end
 end

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

@@ -0,0 +1,34 @@
+# 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
+
+      # 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/thing/product/events/device_log.rb

@@ -2,7 +2,7 @@
 
 module DjiMqttConnect
   module Thing::Product
-    class DeviceLogEventsMessage < ServicesReplyMessage
+    class DeviceLogEventsMessage < EventsMessage
       # BID is not always included in message
       attribute? :bid, Types::UUID
 

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

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module DjiMqttConnect
+  module Thing::Product
+    class TakeoffToPointProgressEventsMessage < EventsMessage
+      attribute :_method, Types::String.enum("takeoff_to_point_progress")
+
+      attribute :data do
+        attribute :flight_id, Types::String
+        attribute :remaining_distance, Types::Integer
+        attribute :remaining_time, Types::Integer
+        attribute :result, Types::Integer
+        attribute :status, Types::String
+        attribute :track_id, Types::String | Types::Nil
+        attribute :way_point_index, Types::Integer
+      end
+    end
+  end
+end

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

@@ -21,19 +21,7 @@ module DjiMqttConnect
       attribute :tid, Types::UUID
       attribute :timestamp, Types::Timestamp
 
-      attribute :_method, Types::String.enum(
-        "airsense_warning",
-        "device_exit_homing_notify",
-        "device_reboot",
-        "file_upload_callback",
-        "fileupload_progress",
-        "flight_areas_drone_location",
-        "flight_areas_sync_progress",
-        "flighttask_progress",
-        "flighttask_ready",
-        "highest_priority_upload_flighttask_media",
-        "offline_map_sync_progress"
-      )
+      attribute :_method, Types::String
 
       attribute :data do
         include Mixins::ResultMessage

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

@@ -82,7 +82,18 @@ module DjiMqttConnect
 
       attribute :_data, Types::Hash
 
+      # NOTE: Included in some state messages, requires a reply on the state_reply topic if true
+      attribute? :need_reply, Types::Integer.enum(0, 1)
+
+      def need_reply?
+        need_reply == 1
+      end
+
       attribute :data do
+        attribute? :geo_caging_status do
+          attribute :state, Types::Integer
+        end
+
         # Not all messages will have a live_capacity attribute
         attribute? :live_capacity do
           attribute :available_video_number, Types::Integer
@@ -103,6 +114,65 @@ module DjiMqttConnect
             end
           end
         end
+
+        attribute? :live_status, Types::Array do
+          attribute :video_id, Types::String
+          attribute :video_type, Types::String
+          attribute :video_quality, Types::Integer
+          attribute :status, Types::Integer
+          attribute :error_status, Types::Integer
+        end
+
+        attribute? :payloads, Types::Array do
+          attribute :control_source, Types::String
+          attribute? :firmware_version, Types::String
+          attribute :payload_index, Types::String
+          attribute? :sn, Types::String
+        end
+
+        attribute? :rtcm_info do
+          attribute :host, Types::String
+          attribute :mount_point, Types::String
+          attribute :port, Types::String
+          attribute :rtcm_device_type, Types::Integer
+          attribute :source_type, Types::Integer
+        end
+
+        attribute? :wireless_link_topo do
+          attribute :center_node do
+            attribute :sdr_id, Types::Integer
+            attribute :sn, Types::String
+          end
+
+          attribute :leaf_nodes, Types::Array do
+            attribute :control_source_index, Types::Integer
+            attribute :sdr_id, Types::Integer
+            attribute :sn, Types::String
+            attribute :valid, Types::Bool
+          end
+
+          attribute :secret_code, Types::Array.of(Types::Integer)
+        end
+
+        attribute? :ar_info_switch, Types::Integer
+        attribute? :commander_flight_height, Types::Integer
+        attribute? :commander_flight_mode, Types::Integer
+        attribute? :commander_mode_lost_action, Types::Integer
+        attribute? :control_source, Types::String
+        attribute? :current_commander_flight_mode, Types::Integer
+        attribute? :current_rth_mode, Types::Integer
+        attribute? :flysafe_database_version, Types::String
+        attribute? :home_latitude, Types::Latitude
+        attribute? :home_longitude, Types::Longitude
+        attribute? :locked, Types::Bool
+        attribute? :mode_code_reason, Types::Integer
+        attribute? :offline_map_enable, Types::Bool
+        attribute? :rth_mode, Types::Integer
+        attribute? :uom_real_name_state, Types::Integer
+        attribute? :wpmz_version, Types::String
+
+        attribute? :low_battery_warning_threshold, Types::Integer
+        attribute? :serious_low_battery_warning_threshold, Types::Integer
       end
     end
   end

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

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module DjiMqttConnect
+  module Thing::Product
+    class StateReplyMessage < Message
+      # a result of 0 means we approve of this action
+      def self.build_for(events_message, result: 0)
+        new(
+          tid: events_message.tid,
+          bid: events_message.bid,
+          timestamp: current_timestamp,
+          data: {
+            result: result
+          }
+        )
+      end
+
+      attribute :bid, Types::UUID
+      attribute :tid, 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/topics/thing/product/events.rb

@@ -25,6 +25,9 @@ module DjiMqttConnect
             event_name = message.class.name.demodulize.sub(/sMessage\z/, "").underscore.to_sym
             broadcast(event_name, device_sn, message)
           end
+
+          # Broadcast a generic received events message event
+          broadcast(:received_events_message, device_sn, message)
         rescue ParseError => error
           broadcast(:parse_error, error, topic, raw_message)
         end

data/lib/dji_mqtt_connect/topics/thing/product/osd.rb

@@ -3,7 +3,7 @@
 module DjiMqttConnect
   module Thing::Product
     class OsdTopicRepository < TopicRepository
-      OSD_TOPIC_REGEX = /\Athing\/product\/(?<device_identifier>.+)\/osd\z/
+      OSD_TOPIC_REGEX = /\Athing\/product\/(?<device_sn>.+)\/osd\z/
 
       def listen!
         listen_to_topic("thing/product/+/osd") do |topic, raw_message|
@@ -12,10 +12,10 @@ module DjiMqttConnect
           matched_topic = OSD_TOPIC_REGEX.match(topic)
           raise Error, "Unknown topic: #{topic}" unless matched_topic
 
-          device_identifier = matched_topic[:device_identifier]
+          device_sn = matched_topic[:device_sn]
           message = OsdMarshal.load(raw_message)
 
-          logger.info("Received #{message} from #{device_identifier}")
+          logger.info("Received #{message} from #{device_sn}")
 
           if message.instance_of?(OsdMessage)
             # Broadcast an unsupported message event
@@ -23,8 +23,11 @@ module DjiMqttConnect
           else
             # Build event name and broadcast (i.e. ::RemoteOsdMessage => remote_osd_update)
             event_name = message.class.name.demodulize.sub(/Message\z/, "Update").underscore.to_sym
-            broadcast(event_name, device_identifier, message)
+            broadcast(event_name, device_sn, message)
           end
+
+          # Broadcast a generic received osd message event
+          broadcast(:received_osd_message, device_sn, message)
         rescue ParseError => error
           broadcast(:parse_error, error, topic, raw_message)
         end

data/lib/dji_mqtt_connect/topics/thing/product/requests.rb

@@ -24,6 +24,9 @@ module DjiMqttConnect
             # Build event name and broadcast (i.e. ::ConfigRequestsMessage => config)
             broadcast(message._method.to_sym, gateway_sn, message)
           end
+
+          # Broadcast a generic received requests message event
+          broadcast(:received_requests_message, gateway_sn, message)
         rescue ParseError => error
           broadcast(:parse_error, error, topic, raw_message)
         end

data/lib/dji_mqtt_connect/topics/thing/product/services_reply.rb

@@ -25,6 +25,9 @@ module DjiMqttConnect
             event_name = "#{message._method.to_sym}_reply"
             broadcast(event_name, gateway_sn, message)
           end
+
+          # Broadcast a generic received services reply message event
+          broadcast(:received_services_reply_message, gateway_sn, message)
         rescue ParseError => error
           broadcast(:parse_error, error, topic, raw_message)
         end

data/lib/dji_mqtt_connect/topics/thing/product/state.rb

@@ -3,7 +3,7 @@
 module DjiMqttConnect
   module Thing::Product
     class StateTopicRepository < TopicRepository
-      STATE_TOPIC_REGEX = /\Athing\/product\/(?<gateway_sn>.+)\/state\z/
+      STATE_TOPIC_REGEX = /\Athing\/product\/(?<device_sn>.+)\/state\z/
 
       def listen!
         listen_to_topic("thing/product/+/state") do |topic, raw_message|
@@ -12,13 +12,13 @@ module DjiMqttConnect
           matched_topic = STATE_TOPIC_REGEX.match(topic)
           raise Error, "Unknown topic: #{topic}" unless matched_topic
 
-          gateway_sn = matched_topic[:gateway_sn]
+          device_sn = matched_topic[:device_sn]
           message = state_marshal.load(raw_message)
 
-          logger.info("Received #{message} from #{gateway_sn}")
+          logger.info("Received #{message} from #{device_sn}")
 
-          # Broadcast the state update
-          broadcast(:state_update, gateway_sn, message)
+          # Broadcast a generic received state message event
+          broadcast(:received_state_message, device_sn, message)
         rescue ParseError => error
           broadcast(:parse_error, error, topic, raw_message)
         end

data/lib/dji_mqtt_connect/topics/thing/product/state_reply.rb

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

data/lib/dji_mqtt_connect/version.rb

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

data/lib/dji_mqtt_connect.rb

@@ -51,6 +51,7 @@ module DjiMqttConnect
       autoload :OfflineMapSyncProgressEventsMessage, "dji_mqtt_connect/messages/thing/product/events/offline_map_sync_progress"
       autoload :ReturnHomeInfoEventsMessage, "dji_mqtt_connect/messages/thing/product/events/return_home_info"
       autoload :StatusCodeEventsMessage, "dji_mqtt_connect/messages/thing/product/events/status_code"
+      autoload :TakeoffToPointProgressEventsMessage, "dji_mqtt_connect/messages/thing/product/events/takeoff_to_point_progress"
       autoload :TrackEventsMessage, "dji_mqtt_connect/messages/thing/product/events/track"
       autoload :EventsMessage, "dji_mqtt_connect/messages/thing/product/events_message"
 
@@ -119,6 +120,7 @@ module DjiMqttConnect
       autoload :ReturnHomeCancelServicesReplyMessage, "dji_mqtt_connect/messages/thing/product/services_reply/return_home_cancel"
 
       autoload :StateMessage, "dji_mqtt_connect/messages/thing/product/state_message"
+      autoload :StateReplyMessage, "dji_mqtt_connect/messages/thing/product/state_reply_message"
 
       # Topics
       autoload :EventsTopicRepository, "dji_mqtt_connect/topics/thing/product/events"
@@ -129,6 +131,7 @@ module DjiMqttConnect
       autoload :ServicesTopicRepository, "dji_mqtt_connect/topics/thing/product/services"
       autoload :ServicesReplyTopicRepository, "dji_mqtt_connect/topics/thing/product/services_reply"
       autoload :StateTopicRepository, "dji_mqtt_connect/topics/thing/product/state"
+      autoload :StateReplyTopicRepository, "dji_mqtt_connect/topics/thing/product/state_reply"
 
       # Marshals
       autoload :EventsMarshal, "dji_mqtt_connect/marshals/thing/product/events_marshal"
@@ -143,6 +146,7 @@ module DjiMqttConnect
       autoload :ServicesReplyMarshal, "dji_mqtt_connect/marshals/thing/product/services_reply_marshal"
 
       autoload :StateMarshal, "dji_mqtt_connect/marshals/thing/product/state_marshal"
+      autoload :StateReplyMarshal, "dji_mqtt_connect/marshals/thing/product/state_reply_marshal"
     end
   end