dji_mqtt_connect 0.1.24.1 → 0.1.25

data/lib/dji_mqtt_connect/factories/services_messages.rb

@@ -0,0 +1,190 @@
+# frozen_string_literal: true
+
+module DjiMqttConnect
+  module Factories::ServicesMessages
+    def build_thing_product_alarm_state_switch_services_message
+      Thing::Product::AlarmStateSwitchServicesMessage.build(action: Thing::Product::AlarmStateSwitchServicesMessage::ACTION_OPEN)
+    end
+
+    def build_thing_product_cover_close_services_message
+      Thing::Product::CoverCloseServicesMessage.build
+    end
+
+    def build_thing_product_cover_open_services_message
+      Thing::Product::CoverOpenServicesMessage.build
+    end
+
+    def build_thing_product_debug_mode_close_services_message
+      Thing::Product::DebugModeCloseServicesMessage.build
+    end
+
+    def build_thing_product_debug_mode_open_services_message
+      Thing::Product::DebugModeOpenServicesMessage.build
+    end
+
+    def build_thing_product_fileupload_list_services_message
+      Thing::Product::FileuploadListServicesMessage.build(
+        module_list: [0, 3]
+      )
+    end
+
+    def build_thing_product_fileupload_start_services_message
+      timestamp = Message.current_timestamp
+      Thing::Product::FileuploadStartServicesMessage.build(
+        data: {
+          bucket: "stg-dji-service-hz-ksd7",
+          region: "hz",
+          credentials: {
+            access_key_id: "STS.access_key_id",
+            access_key_secret: "access_key_secret",
+            expire: 3600,
+            security_token: "security_token"
+          },
+          endpoint: "https://oss-cn-hangzhou.aliyuncs.com",
+          params: {
+            files: [
+              {
+                list: [
+                  {
+                    boot_index: 1111,
+                    end_time: timestamp - 3000,
+                    size: 33789,
+                    start_time: timestamp - 4000
+                  },
+                  {
+                    boot_index: 22222,
+                    end_time: timestamp - 1000,
+                    size: 33789,
+                    start_time: timestamp - 2000
+                  }
+                ],
+                module: "3",
+                object_key: "object_key"
+              }
+            ]
+          },
+          provider: "ali"
+        }
+      )
+    end
+
+    def build_thing_product_flighttask_execute_services_message
+      Thing::Product::FlighttaskExecuteServicesMessage.build(flight_id: SecureRandom.uuid)
+    end
+
+    def build_thing_product_flighttask_pause_services_message
+      Thing::Product::FlighttaskPauseServicesMessage.build
+    end
+
+    def build_thing_product_flighttask_prepare_services_message
+      Thing::Product::FlighttaskPrepareServicesMessage.build(
+        data: {
+          execute_time: 1234567890123,
+          flight_id: "xxxxxxx",
+          task_type: 2,
+          file: {
+            url: "https://xxx.com/xxxx",
+            fingerprint: "xxxx"
+          },
+          ready_conditions: {
+            battery_capacity: 90,
+            begin_time: 1234567890123,
+            end_time: 1234567890123
+          },
+          executable_conditions: {
+            storage_capacity: 1000
+          },
+          break_point: {
+            index: 1,
+            state: 0,
+            progress: 0.34,
+            wayline_id: 0
+          },
+          rth_altitude: 100,
+          rth_mode: 1,
+          out_of_control_action: 0,
+          exit_wayline_when_rc_lost: 0,
+          wayline_precision_type: 0
+        }
+      )
+    end
+
+    def build_thing_product_flighttask_recovery_services_message
+      Thing::Product::FlighttaskRecoveryServicesMessage.build
+    end
+
+    def build_thing_product_flighttask_progress_get_services_message
+      Thing::Product::FlighttaskProgressGetServicesMessage.build(
+        data: {
+          sn: "SN1234567890"
+        }
+      )
+    end
+
+    def build_thing_product_flighttask_stop_services_message
+      Thing::Product::FlighttaskStopServicesMessage.build(
+        data: {
+          flight_id: SecureRandom.uuid,
+          reason: 0
+        }
+      )
+    end
+
+    def build_thing_product_flighttask_undo_services_message
+      Thing::Product::FlighttaskUndoServicesMessage.build(
+        flight_ids: [SecureRandom.uuid, SecureRandom.uuid]
+      )
+    end
+
+    ### Live Stream (Services Messages) ###
+
+    def build_thing_product_live_lens_change_services_message
+      Thing::Product::LiveLensChangeServicesMessage.build(
+        data: {
+          video_id: "1ZNDH1D0010098/39-0-7/normal-0",
+          video_type: "wide"
+        }
+      )
+    end
+
+    def build_thing_product_live_set_quality_services_message
+      Thing::Product::LiveSetQualityServicesMessage.build(
+        data: {
+          video_id: "1ZNDH1D0010098/39-0-7/normal-0",
+          video_quality: 0
+        }
+      )
+    end
+
+    def build_thing_product_live_start_push_services_message
+      Thing::Product::LiveStartPushServicesMessage.build(
+        data: {
+          url: "channel=1ZNDH1D0010098_39-0-7&sn=1ZNDH1D0010098&token=006dca67721582a48768ec4d817b7b25a86IADk%2Fcm%2Fdv%2BHY6qT%2FAKM6y7TcUe4lXNvZpycH7vUMAlM6pFALUKF2zyCIgA82pQE8cCoYAQAAQDxwKhgAgDxwKhgAwDxwKhgBADxwKhg&uid=50000",
+          url_type: 0,
+          video_id: "1ZNDH1D0010098/39-0-7/normal-0",
+          video_quality: 0
+        }
+      )
+    end
+
+    def build_thing_product_live_stop_push_services_message
+      Thing::Product::LiveStopPushServicesMessage.build(
+        data: {
+          video_id: "1ZNDH1D0010098/39-0-7/normal-0"
+        }
+      )
+    end
+
+    def build_thing_product_return_home_services_message
+      Thing::Product::ReturnHomeServicesMessage.build
+    end
+
+    def build_thing_product_return_home_cancel_services_message
+      Thing::Product::ReturnHomeCancelServicesMessage.build
+    end
+
+    def build_thing_product_return_specific_home_services_message(home_dock_sn: "SN1234567890")
+      Thing::Product::ReturnSpecificHomeServicesMessage.build(home_dock_sn: home_dock_sn)
+    end
+  end
+end

data/lib/dji_mqtt_connect/factories/state_messages.rb

@@ -4,7 +4,7 @@ module DjiMqttConnect
   module Factories::StateMessages
     ### Gateway Messages ###
 
-    def build_thing_product_firmware_version_state_message
+    def build_thing_product_state_message_with_firmware_version
       message_data = {
         firmware_version: "10.01.1607",
         compatible_status: 0,
@@ -21,7 +21,7 @@ module DjiMqttConnect
       )
     end
 
-    def build_thing_product_gateway_live_capacity_state_message
+    def build_thing_product_state_message_with_live_capacity
       message_data = {
         live_capacity: {
           available_video_number: 3,
@@ -99,7 +99,7 @@ module DjiMqttConnect
       )
     end
 
-    def build_thing_product_gateway_live_status_state_message
+    def build_thing_product_state_message_with_live_status
       message_data = {
 
         live_status: [
@@ -130,7 +130,7 @@ module DjiMqttConnect
       )
     end
 
-    def build_thing_product_gateway_rtcm_info_state_message
+    def build_thing_product_state_message_with_rtcm_info
       message_data = {
         rtcm_info: {
           host: "192.168.0.1",
@@ -153,7 +153,7 @@ module DjiMqttConnect
 
     ### Payload Messages ###
 
-    def build_thing_product_payload_ar_info_switch_state_message
+    def build_thing_product_state_message_with_ar_info_switch
       message_data = {
         ar_info_switch: 1
       }
@@ -168,7 +168,7 @@ module DjiMqttConnect
       )
     end
 
-    def build_thing_product_payload_commander_flight_height_state_message
+    def build_thing_product_state_message_with_commander_flight_height
       message_data = {
         commander_flight_height: 50
       }
@@ -183,7 +183,7 @@ module DjiMqttConnect
       )
     end
 
-    def build_thing_product_payload_commander_flight_mode_state_message
+    def build_thing_product_state_message_with_commander_flight_mode
       message_data = {
         commander_flight_mode: 0
       }
@@ -198,7 +198,7 @@ module DjiMqttConnect
       )
     end
 
-    def build_thing_product_payload_commander_mode_lost_action_state_message
+    def build_thing_product_state_message_with_commander_mode_lost_action
       message_data = {
         commander_mode_lost_action: 1
       }
@@ -213,7 +213,7 @@ module DjiMqttConnect
       )
     end
 
-    def build_thing_product_payload_current_commander_flight_mode_state_message
+    def build_thing_product_state_message_with_current_commander_flight_mode
       message_data = {
         current_commander_flight_mode: 0
       }
@@ -228,7 +228,7 @@ module DjiMqttConnect
       )
     end
 
-    def build_thing_proudct_current_rth_mode_state_message
+    def build_thing_product_state_message_with_current_rth_mode
       message_data = {
         current_rth_mode: 1
       }
@@ -243,7 +243,7 @@ module DjiMqttConnect
       )
     end
 
-    def build_thing_product_payload_flysafe_database_version_state_message
+    def build_thing_product_state_message_with_flysafe_database_version
       message_data = {
         flysafe_database_version: "01.00.01.35"
       }
@@ -258,7 +258,7 @@ module DjiMqttConnect
       )
     end
 
-    def build_thing_product_payload_geo_caging_status_state_message
+    def build_thing_product_state_message_with_geo_caging_status
       message_data = {
         geo_caging_status: {
           state: 0
@@ -275,7 +275,7 @@ module DjiMqttConnect
       )
     end
 
-    def build_thing_product_payload_mode_code_reason_state_message
+    def build_thing_product_state_message_with_mode_code_reason
       message_data = {
         mode_code_reason: 0
       }
@@ -290,7 +290,7 @@ module DjiMqttConnect
       )
     end
 
-    def build_thing_product_payload_offline_map_enable_state_message
+    def build_thing_product_state_message_with_offline_map_enable
       message_data = {
         offline_map_enable: true
       }
@@ -305,7 +305,7 @@ module DjiMqttConnect
       )
     end
 
-    def build_thing_product_payload_payloads_state_message
+    def build_thing_product_state_message_with_payloads
       message_data = {
         payloads: [
           {
@@ -325,7 +325,7 @@ module DjiMqttConnect
       )
     end
 
-    def build_thing_proudct_rth_mode_state_message
+    def build_thing_proudct_state_message_with_rth_mode
       message_data = {
         rth_mode: 1
       }
@@ -340,7 +340,7 @@ module DjiMqttConnect
       )
     end
 
-    def build_thing_product_payload_uom_real_name_state_state_message
+    def build_thing_product_state_message_with_uom_real_name_state
       message_data = {
         uom_real_name_state: 11
       }
@@ -355,7 +355,7 @@ module DjiMqttConnect
       )
     end
 
-    def build_thing_product_payload_wireless_link_topo_state_message
+    def build_thing_product_state_message_with_wireless_link_topo
       message_data = {
         wireless_link_topo: {
           center_node: {
@@ -389,7 +389,7 @@ module DjiMqttConnect
       )
     end
 
-    def build_thing_product_payload_wpmz_version_state_message
+    def build_thing_product_state_message_with_wpmz_version
       message_data = {
         wpmz_version: "1.0.6"
       }

data/lib/dji_mqtt_connect/factories.rb

@@ -5,9 +5,11 @@ module DjiMqttConnect
   # Do not include this in your production code
   module Factories
     autoload :EventsMessages, "dji_mqtt_connect/factories/events_messages"
+    autoload :ServicesMessages, "dji_mqtt_connect/factories/services_messages"
     autoload :StateMessages, "dji_mqtt_connect/factories/state_messages"
 
     include EventsMessages
+    include ServicesMessages
     include StateMessages
 
     # OSD
@@ -74,7 +76,7 @@ module DjiMqttConnect
         tid: Message.generate_tid,
         bid: Message.generate_bid,
         timestamp: Message.current_timestamp,
-        gateway: "gatewaysn",
+        gateway: "GATEWAYSN",
         data: message_data,
         _data: message_data
       )
@@ -125,7 +127,7 @@ module DjiMqttConnect
         tid: Message.generate_tid,
         bid: Message.generate_bid,
         timestamp: Message.current_timestamp,
-        gateway: "gatewaysn",
+        gateway: "GATEWAYSN",
         data: message_data,
         _data: message_data
       )
@@ -162,7 +164,7 @@ module DjiMqttConnect
         tid: Message.generate_tid,
         bid: Message.generate_bid,
         timestamp: Message.current_timestamp,
-        gateway: "gatewaysn",
+        gateway: "GATEWAYSN",
         data: message_data,
         _data: message_data
       )
@@ -170,7 +172,7 @@ module DjiMqttConnect
 
     # Status
 
-    def build_device_online_update_topo_message
+    def build_thing_product_update_topo_message_with_online_device
       message_data = {
         type: 98,
         sub_type: 0,
@@ -179,7 +181,7 @@ module DjiMqttConnect
         version: 1,
         sub_devices: [
           {
-            sn: "drone001",
+            sn: "SUBDEVICESN",
             type: 116,
             sub_type: 0,
             index: "A",
@@ -200,7 +202,7 @@ module DjiMqttConnect
       )
     end
 
-    def build_update_topo_status_reply_message
+    def build_thing_product_update_topo_status_reply_message
       Sys::Product::UpdateTopoStatusReplyMessage.new(
         _method: "update_topo",
         tid: Message.generate_tid,
@@ -225,7 +227,7 @@ module DjiMqttConnect
         tid: Message.generate_tid,
         bid: Message.generate_bid,
         timestamp: Message.current_timestamp,
-        gateway: "gatewaysn",
+        gateway: "GATEWAYSN",
         data: message_data,
         _data: message_data.deep_stringify_keys
       )
@@ -247,10 +249,10 @@ module DjiMqttConnect
       message_data = {
         devices: [
           {
-            sn: "drone-sn"
+            sn: "DRONESN"
           },
           {
-            sn: "dock-sn"
+            sn: "DOCKSN"
           }
         ]
       }
@@ -404,7 +406,7 @@ module DjiMqttConnect
         tid: Message.generate_tid,
         bid: Message.generate_bid,
         timestamp: Message.current_timestamp,
-        gateway: "gatewaysn",
+        gateway: "GATEWAYSN",
         data: message_data,
         _data: message_data.deep_stringify_keys
       )
@@ -451,7 +453,7 @@ module DjiMqttConnect
         tid: Message.generate_tid,
         bid: Message.generate_bid,
         timestamp: Message.current_timestamp,
-        gateway: "gatewaysn",
+        gateway: "GATEWAYSN",
         data: message_data
       )
     end
@@ -502,171 +504,7 @@ module DjiMqttConnect
       )
     end
 
-    # Services
-
-    def build_thing_product_alarm_state_switch_services_message
-      Thing::Product::AlarmStateSwitchServicesMessage.build(action: Thing::Product::AlarmStateSwitchServicesMessage::ACTION_OPEN)
-    end
-
-    def build_thing_product_cover_close_services_message
-      Thing::Product::CoverCloseServicesMessage.build
-    end
-
-    def build_thing_product_cover_open_services_message
-      Thing::Product::CoverOpenServicesMessage.build
-    end
-
-    def build_thing_product_debug_mode_close_services_message
-      Thing::Product::DebugModeCloseServicesMessage.build
-    end
-
-    def build_thing_product_debug_mode_open_services_message
-      Thing::Product::DebugModeOpenServicesMessage.build
-    end
-
-    def build_thing_product_fileupload_list_services_message
-      Thing::Product::FileuploadListServicesMessage.build(
-        module_list: [0, 3]
-      )
-    end
-
-    def build_thing_product_fileupload_start_services_message
-      timestamp = Message.current_timestamp
-      Thing::Product::FileuploadStartServicesMessage.build(
-        data: {
-          bucket: "stg-dji-service-hz-ksd7",
-          region: "hz",
-          credentials: {
-            access_key_id: "STS.access_key_id",
-            access_key_secret: "access_key_secret",
-            expire: 3600,
-            security_token: "security_token"
-          },
-          endpoint: "https://oss-cn-hangzhou.aliyuncs.com",
-          params: {
-            files: [
-              {
-                list: [
-                  {
-                    boot_index: 1111,
-                    end_time: timestamp - 3000,
-                    size: 33789,
-                    start_time: timestamp - 4000
-                  },
-                  {
-                    boot_index: 22222,
-                    end_time: timestamp - 1000,
-                    size: 33789,
-                    start_time: timestamp - 2000
-                  }
-                ],
-                module: "3",
-                object_key: "object_key"
-              }
-            ]
-          },
-          provider: "ali"
-        }
-      )
-    end
-
-    def build_thing_product_flighttask_execute_services_message
-      Thing::Product::FlighttaskExecuteServicesMessage.build(flight_id: SecureRandom.uuid)
-    end
-
-    def build_thing_product_flighttask_pause_services_message
-      Thing::Product::FlighttaskPauseServicesMessage.build
-    end
-
-    def build_thing_product_flighttask_prepare_services_message
-      Thing::Product::FlighttaskPrepareServicesMessage.build(
-        data: {
-          execute_time: 1234567890123,
-          flight_id: "xxxxxxx",
-          task_type: 2,
-          wayline_type: 0,
-          file: {
-            url: "https://xxx.com/xxxx",
-            fingerprint: "xxxx"
-          },
-          ready_conditions: {
-            battery_capacity: 90,
-            begin_time: 1234567890123,
-            end_time: 1234567890123
-          },
-          executable_conditions: {
-            storage_capacity: 1000
-          },
-          break_point: {
-            index: 1,
-            state: 0,
-            progress: 0.34,
-            wayline_id: 0
-          },
-          rth_altitude: 100,
-          rth_mode: 1,
-          out_of_control_action: 0,
-          exit_wayline_when_rc_lost: 0
-        }
-      )
-    end
-
-    def build_thing_product_flighttask_recovery_services_message
-      Thing::Product::FlighttaskRecoveryServicesMessage.build
-    end
-
-    def build_thing_product_flighttask_undo_services_message
-      Thing::Product::FlighttaskUndoServicesMessage.build(
-        flight_ids: [SecureRandom.uuid, SecureRandom.uuid]
-      )
-    end
-
-    ### Live Stream (Services Messages) ###
-
-    def build_thing_product_live_lens_change_services_message
-      Thing::Product::LiveLensChangeServicesMessage.build(
-        data: {
-          video_id: "1ZNDH1D0010098/39-0-7/normal-0",
-          video_type: "wide"
-        }
-      )
-    end
-
-    def build_thing_product_live_set_quality_services_message
-      Thing::Product::LiveSetQualityServicesMessage.build(
-        data: {
-          video_id: "1ZNDH1D0010098/39-0-7/normal-0",
-          video_quality: 0
-        }
-      )
-    end
-
-    def build_thing_product_live_start_push_services_message
-      Thing::Product::LiveStartPushServicesMessage.build(
-        data: {
-          url: "channel=1ZNDH1D0010098_39-0-7&sn=1ZNDH1D0010098&token=006dca67721582a48768ec4d817b7b25a86IADk%2Fcm%2Fdv%2BHY6qT%2FAKM6y7TcUe4lXNvZpycH7vUMAlM6pFALUKF2zyCIgA82pQE8cCoYAQAAQDxwKhgAgDxwKhgAwDxwKhgBADxwKhg&uid=50000",
-          url_type: 0,
-          video_id: "1ZNDH1D0010098/39-0-7/normal-0",
-          video_quality: 0
-        }
-      )
-    end
-
-    def build_thing_product_live_stop_push_services_message
-      Thing::Product::LiveStopPushServicesMessage.build(
-        data: {
-          video_id: "1ZNDH1D0010098/39-0-7/normal-0"
-        }
-      )
-    end
-
-    def build_thing_product_return_home_services_message
-      Thing::Product::ReturnHomeServicesMessage.build
-    end
-
-    def build_thing_product_return_home_cancel_services_message
-      Thing::Product::ReturnHomeCancelServicesMessage.build
-    end
+    # Services Replies
 
     def build_thing_product_alarm_state_switch_services_reply_message
       message_data = {

data/lib/dji_mqtt_connect/marshals/sys/product/status_reply_marshal.rb

@@ -1,34 +1,20 @@
 # frozen_string_literal: true
 
-require "dry-transformer"
 require "json"
 
 module DjiMqttConnect
   module Sys::Product
     class StatusReplyMarshal < MessageMarshal
-      # Removes the `_data` attribute  from output
-      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/events_marshal.rb

@@ -10,12 +10,19 @@ 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 EventsTransformer < Dry::Transformer::Pipe
         import Dry::Transformer::Conditional
         import Dry::Transformer::ArrayTransformations
         import Dry::Transformer::HashTransformations
 
         define! do
+          # Fix the airsense_warning message
+          guard ->(message) { message["data"].is_a?(Array) } do
+            # data is an array of hashes, we need to wrap it in a list key
+            rename_keys "data" => "list"
+            nest "data", ["list"]
+          end
+
           # Keep a copy of the original data hash
           copy_keys "data" => "_data"
 
@@ -65,7 +72,7 @@ module DjiMqttConnect
         parsed_message = parse_json(raw_message)
 
         # Transform the message
-        transformed_message = attribute_transformer.call(parsed_message)
+        transformed_message = events_transformer.call(parsed_message)
         message_method = transformed_message["_method"]
 
         # Build an instance of the class, or a generic message from the current class
@@ -75,8 +82,8 @@ module DjiMqttConnect
 
       private
 
-      def attribute_transformer
-        @attribute_transformer ||= AttributeTransformer.new
+      def events_transformer
+        @events_transformer ||= EventsTransformer.new
       end
     end
   end