dji_mqtt_connect 0.1.21 → 0.1.22

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7c7dcc1c840ccf9aaee09ac40525e54250b00543951b3adf3fc2535fead82529
-  data.tar.gz: 768cbfdd365db52896838434a319742e55dbd82ad021d0a3aa6c76f07d94f8ac
+  metadata.gz: 7027ac9b38e9e7b0a0927e4fd9b6419c910d8c6fb3b531fdf70f5384a8f924b1
+  data.tar.gz: e8ebff861fe60c9f97d6ab1123c557c606d9ff1c7fac4585b119d8810de334ae
 SHA512:
-  metadata.gz: 530a33ad82c122710f9a8421553768cd7eff877099722d2ce34918d434703c7fa429fdad587030db3fca04953c5c26411d3665d9bd61e468d4e6ddfc4feafee5
-  data.tar.gz: 01df1da7273ba9b2492cd799c6eb08d8d20bb022c90f3860acd528abc32af4e2d759f6d8ec4a0ed922035db58bd0e7ef9cf68e2f668d68aaa97d00d4532282a7
+  metadata.gz: '0508e79e10728091f78602a32b4c5af879952c042f6ca2c9feb82f9141fb63ee2184f1d43e0ff484108139b8e0f3e591d8d60b29338732732b83a401ed6a5e4c'
+  data.tar.gz: 913b5ea242a5f96f3f5e0331fe55cc123632d5baa7db91016cb932233fc3322e0ae1b8a88e8fda32f7b6ed21aca6e26cf9e38e8dc9b599a811c7672246ce6fe1

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    dji_mqtt_connect (0.1.21)
+    dji_mqtt_connect (0.1.22)
       activesupport (>= 6.0, <= 8)
       dry-struct (~> 1.6)
       dry-transformer (~> 1.0)
@@ -144,6 +144,7 @@ GEM
 
 PLATFORMS
   arm64-darwin-22
+  arm64-darwin-23
   x86_64-darwin-21
   x86_64-linux
 

data/lib/dji_mqtt_connect/factories.rb

@@ -644,6 +644,29 @@ module DjiMqttConnect
       )
     end
 
+    def build_thing_product_offline_map_get_requests_message
+      message_data = {}
+
+      Thing::Product::OfflineMapGetRequestsMessage.new(
+        _method: "offline_map_get",
+        _data: message_data,
+        tid: Message.generate_tid,
+        bid: Message.generate_bid,
+        timestamp: Message.current_timestamp,
+        gateway: "gatewaysn",
+        data: message_data
+      )
+    end
+
+    def build_thing_product_offline_map_get_requests_reply_message
+      request_message = build_thing_product_offline_map_get_requests_message
+
+      Thing::Product::OfflineMapGetRequestsReplyMessage.build_for(
+        request_message,
+        result: 0
+      )
+    end
+
     def build_thing_product_storage_config_get_requests_message
       message_data = {
         module: 0

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

@@ -21,7 +21,7 @@ module DjiMqttConnect
       # Attempts to look a the method attribute, and builds a specific Message class for the message
       def load(raw_message)
         # Parse the message from JSON
-        parsed_message = JSON.parse(raw_message)
+        parsed_message = parse_json(raw_message)
 
         # Transform the message
         transformed_message = attribute_transformer.call(parsed_message)
@@ -29,11 +29,7 @@ module DjiMqttConnect
 
         # Build an instance of the class, or a generic message from the current class
         message_class = message_class_from_message_method(message_method, StatusMessage)
-        message_class.new transformed_message
-      rescue JSON::ParserError => e
-        raise ParseError.new(e, "Unable to parse message as JSON")
-      rescue Dry::Struct::Error => e
-        raise ParseError.new(e, "Unexpected #{message_class} payload")
+        build_message(message_class, transformed_message)
       end
 
       private

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

@@ -62,7 +62,7 @@ module DjiMqttConnect
       # Attempts to look a the method attribute, and builds a specific Message class for the message
       def load(raw_message)
         # Parse the message from JSON
-        parsed_message = JSON.parse(raw_message)
+        parsed_message = parse_json(raw_message)
 
         # Transform the message
         transformed_message = attribute_transformer.call(parsed_message)
@@ -70,11 +70,7 @@ module DjiMqttConnect
 
         # Build an instance of the class, or a generic message from the current class
         message_class = message_class_from_message_method(message_method, EventsMessage)
-        message_class.new transformed_message
-      rescue JSON::ParserError => e
-        raise ParseError.new(e, "Unable to parse message as JSON")
-      rescue Dry::Struct::Error => e
-        raise ParseError.new(e, "Unexpected #{message_class} payload")
+        build_message(message_class, transformed_message)
       end
 
       private

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

@@ -6,6 +6,8 @@ require "json"
 module DjiMqttConnect
   module Thing::Product
     class OsdMarshal < MessageMarshal
+      include Utils::MessageParsing
+
       # Make a copy of the raw data
       class AttributeTransformer < Dry::Transformer::Pipe
         import Dry::Transformer::Conditional
@@ -36,7 +38,7 @@ module DjiMqttConnect
 
       # Parse message from Device > Cloud Server
       def load(raw_message)
-        parsed_message = JSON.parse(raw_message)
+        parsed_message = parse_json(raw_message)
 
         message_data = parsed_message.fetch("data", {})
 
@@ -53,11 +55,7 @@ module DjiMqttConnect
 
         transformed_message = attribute_transformer.call(parsed_message)
 
-        message_class.new(transformed_message)
-      rescue JSON::ParserError => e
-        raise ParseError.new(e, "Unable to parse message as JSON")
-      rescue Dry::Struct::Error => e
-        raise ParseError.new(e, "Invalid #{message_class} payload")
+        build_message(message_class, transformed_message)
       end
 
       private

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

@@ -22,7 +22,7 @@ module DjiMqttConnect
       # Attempts to look a the method attribute, and builds a specific Message class for the message
       def load(raw_message)
         # Parse the message from JSON
-        parsed_message = JSON.parse(raw_message)
+        parsed_message = parse_json(raw_message)
 
         # Transform the message
         transformed_message = attribute_transformer.call(parsed_message)
@@ -30,11 +30,7 @@ module DjiMqttConnect
 
         # Build an instance of the class, or a generic message from the current class
         message_class = message_class_from_message_method(message_method, RequestsMessage)
-        message_class.new transformed_message
-      rescue JSON::ParserError => e
-        raise ParseError.new(e, "Unable to parse message as JSON")
-      rescue Dry::Struct::Error => e
-        raise ParseError.new(e, "Unexpected #{message_class} payload")
+        build_message(message_class, transformed_message)
       end
 
       private

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

@@ -22,7 +22,7 @@ module DjiMqttConnect
       # Attempts to look a the method attribute, and builds a specific Message class for the message
       def load(raw_message)
         # Parse the message from JSON
-        parsed_message = JSON.parse(raw_message)
+        parsed_message = parse_json(raw_message)
 
         # Transform the message
         transformed_message = attribute_transformer.call(parsed_message)
@@ -30,11 +30,7 @@ module DjiMqttConnect
 
         # Build an instance of the class, or a generic message from the current class
         message_class = message_class_from_message_method(message_method, ServicesReplyMessage)
-        message_class.new transformed_message
-      rescue JSON::ParserError => e
-        raise ParseError.new(e, "Unable to parse message as JSON")
-      rescue Dry::Struct::Error => e
-        raise ParseError.new(e, "Unexpected #{message_class} payload")
+        build_message(message_class, transformed_message)
       end
 
       private

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

@@ -21,17 +21,13 @@ module DjiMqttConnect
       # Attempts to look a the method attribute, and builds a specific Message class for the message
       def load(raw_message)
         # Parse the message from JSON
-        parsed_message = JSON.parse(raw_message)
+        parsed_message = parse_json(raw_message)
 
         # Transform the message
         transformed_message = attribute_transformer.call(parsed_message)
 
         # Build an instance of the class, or a generic message from the current class
-        StateMessage.new transformed_message
-      rescue JSON::ParserError => e
-        raise ParseError.new(e, "Unable to parse message as JSON")
-      rescue Dry::Struct::Error => e
-        raise ParseError.new(e, "Unexpected #{StateMessage} payload")
+        build_message(StateMessage, transformed_message)
       end
 
       private

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

@@ -13,7 +13,7 @@ module DjiMqttConnect
         attribute :file do
           attribute :object_key, Types::String
 
-          attribute :path, Types::String
+          attribute :path, Types::String | Types::Nil
 
           attribute :name, Types::String
 
@@ -35,7 +35,7 @@ module DjiMqttConnect
 
             attribute :relative_altitude, Types::JSON::Decimal
 
-            attribute :created_time, Types::JSON::DateTime
+            attribute :created_time, Types::JSON::DateTime | Types::Nil
 
             attribute :shoot_position do
               include Mixins::LatitudeConditional

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

@@ -16,7 +16,7 @@ module DjiMqttConnect
           attribute :ext do
             attribute :current_waypoint_index, Types::Integer
             attribute? :media_count, Types::Integer
-            attribute :track_id, Types::String
+            attribute :track_id, Types::String | Types::Nil
             attribute :flight_id, Types::String
 
             attribute? :break_point do

data/lib/dji_mqtt_connect/messages/thing/product/osd/drone.rb

@@ -32,11 +32,11 @@ module DjiMqttConnect
             include Mixins::TemperatureConditional
 
             attribute :capacity_percent, Types::Integer
-            attribute :firmware_version, Types::String
+            attribute :firmware_version, Types::String | Types::Nil
             attribute? :high_voltage_storage_days, Types::Integer
             attribute :index, Types::Integer
             attribute :loop_times, Types::Integer
-            attribute :sn, Types::String
+            attribute :sn, Types::String | Types::Nil
             attribute :sub_type, Types::DeviceSubType
             attribute :temperature, Types::Temperature
             attribute :type, Types::DeviceType
@@ -58,7 +58,7 @@ module DjiMqttConnect
         end
         attribute :elevation, Types::JSON::Decimal
 
-        attribute? :firmware_version, Types::String
+        attribute? :firmware_version, Types::String | Types::Nil
         attribute :gear, Types::Integer
         attribute :height, Types::JSON::Decimal
         attribute? :height_limit, Types::JSON::Decimal
@@ -79,7 +79,7 @@ module DjiMqttConnect
         end
         attribute :total_flight_distance, Types::JSON::Decimal
         attribute :total_flight_time, Types::JSON::Decimal
-        attribute? :track_id, Types::String
+        attribute? :track_id, Types::String | Types::Nil
         attribute :vertical_speed, Types::JSON::Decimal
         attribute :wind_direction, Types::JSON::Decimal
         attribute :wind_speed, Types::JSON::Decimal

data/lib/dji_mqtt_connect/messages/thing/product/osd/remote.rb

@@ -15,7 +15,7 @@ module DjiMqttConnect
         attribute? :live_status do
           attribute :live_time, Types::Integer
           attribute :live_trendline, Types::Integer
-          attribute :video_id, Types::String
+          attribute :video_id, Types::String | Types::Nil
           attribute :video_quality, Types::Integer
         end
         attribute? :transmission_signal_quality, Types::Integer

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

@@ -8,9 +8,9 @@ module DjiMqttConnect
 
       attribute :data do
         attribute :bind_devices, Types::Array do
-          attribute :device_binding_code, Types::String
-          attribute :organization_id, Types::String
-          attribute :device_callsign, Types::String
+          attribute :device_binding_code, Types::String | Types::Nil
+          attribute :organization_id, Types::String | Types::Nil
+          attribute :device_callsign, Types::String | Types::Nil
           attribute :sn, Types::String
           attribute :device_model_key, Types::String
           attribute :device_nonce, Types::String

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

@@ -7,8 +7,8 @@ module DjiMqttConnect
       attribute :_method, Types::String.enum("airport_organization_get")
 
       attribute :data do
-        attribute :device_binding_code, Types::String
-        attribute :organization_id, Types::String
+        attribute :device_binding_code, Types::String | Types::Nil
+        attribute :organization_id, Types::String | Types::Nil
       end
     end
   end

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

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module DjiMqttConnect
+  module Thing::Product
+    # Get the offline map data
+    # https://developer.dji.com/doc/cloud-api-tutorial/en/faq.html#why-does-the-third-party-platform-experience-prolonged-wait-time-when-executing-one-key-takeoff-or-wayline-missions-on-the-dock
+    class OfflineMapGetRequestsMessage < RequestsMessage
+      attribute :_method, Types::String.enum("offline_map_get")
+
+      attribute :data, Types::Hash
+    end
+  end
+end

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

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module DjiMqttConnect
+  module Thing::Product
+    # https://developer.dji.com/doc/cloud-api-tutorial/en/faq.html#why-does-the-third-party-platform-experience-prolonged-wait-time-when-executing-one-key-takeoff-or-wayline-missions-on-the-dock
+    class OfflineMapGetRequestsReplyMessage < Message
+      def self.build_for(offline_map_get, result: 0)
+        new(
+          _method: offline_map_get._method,
+          data: {
+            result: result
+          },
+          tid: offline_map_get.tid,
+          bid: offline_map_get.bid,
+          timestamp: current_timestamp
+        )
+      end
+
+      attribute :tid, Types::UUID
+      attribute :bid, Types::UUID
+      attribute :timestamp, Types::Timestamp
+
+      attribute :_method, Types::String.enum("offline_map_get")
+      attribute :data do
+        attribute :result, Types::ResultCode
+      end
+    end
+  end
+end

data/lib/dji_mqtt_connect/utils/message_parsing.rb

@@ -5,6 +5,47 @@ module DjiMqttConnect
     module MessageParsing
       private
 
+      def parse_json(raw_message)
+        parsed_message = JSON.parse(raw_message)
+        strip_blank_strings(parsed_message)
+      rescue JSON::ParserError => e
+        raise ParseError.new(e, "Unable to parse message as JSON (#{e.message})")
+      end
+
+      def strip_blank_strings(object)
+        case object
+        when Hash
+          object.transform_values(&method(:strip_blank_strings))
+        when Array
+          object.map(&method(:strip_blank_strings))
+        when String
+          object.strip.presence
+        else
+          object
+        end
+      end
+
+      def build_message(message_class, transformed_message)
+        message_class.new transformed_message
+      rescue Dry::Struct::Error => e
+        # Get the source of the error and the error message (without the source)
+        source = e.message.include?(".new] ") ? e.message.split(".new] ").first.sub(/\A\[/, "") : message_class.name
+        error_message = e.message.split(".new] ").last
+
+        case e.cause
+        when Dry::Types::SchemaError
+          # Clean up the error message to be more developer-friendly
+          # e.message: [DjiMqttConnect::Sys::Product::StatusMessage.new] nil (NilClass) has invalid type for :_data violates constraints (type?(Hash, nil) failed)
+          # e.cause.message: nil (NilClass) has invalid type for :_data violates constraints (type?(Hash, nil) failed)
+          cause_key = e.cause.key.to_s.sub("_data", "data")
+          cause_message = "#{e.cause.value.inspect} (#{e.cause.value.class.name}) is invalid type for :#{cause_key}"
+          # cause_message: nil (NilClass) is invalid type for :data
+          raise ParseError.new(e, "Unexpected #{source} payload (#{cause_message})")
+        else
+          raise ParseError.new(e, "Unexpected #{source} payload (#{error_message})")
+        end
+      end
+
       def message_class_from_message_method(message_method, generic_class)
         return generic_class if message_method.blank?
 

data/lib/dji_mqtt_connect/version.rb

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

data/lib/dji_mqtt_connect.rb

@@ -66,6 +66,7 @@ module DjiMqttConnect
       autoload :ConfigRequestsMessage, "dji_mqtt_connect/messages/thing/product/requests/config"
       autoload :FlightAreasGetRequestsMessage, "dji_mqtt_connect/messages/thing/product/requests/flight_areas_get"
       autoload :FlighttaskResourceGetRequestsMessage, "dji_mqtt_connect/messages/thing/product/requests/flighttask_resource_get"
+      autoload :OfflineMapGetRequestsMessage, "dji_mqtt_connect/messages/thing/product/requests/offline_map_get"
       autoload :StorageConfigGetRequestsMessage, "dji_mqtt_connect/messages/thing/product/requests/storage_config_get"
       autoload :RequestsMessage, "dji_mqtt_connect/messages/thing/product/requests_message"
 
@@ -75,6 +76,7 @@ module DjiMqttConnect
       autoload :FlightAreasGetRequestsReplyMessage, "dji_mqtt_connect/messages/thing/product/requests_reply/flight_areas_get"
       autoload :ConfigRequestsReplyMessage, "dji_mqtt_connect/messages/thing/product/requests_reply/config"
       autoload :FlighttaskResourceGetRequestsReplyMessage, "dji_mqtt_connect/messages/thing/product/requests_reply/flighttask_resource_get"
+      autoload :OfflineMapGetRequestsReplyMessage, "dji_mqtt_connect/messages/thing/product/requests_reply/offline_map_get"
       autoload :StorageConfigGetRequestsReplyMessage, "dji_mqtt_connect/messages/thing/product/requests_reply/storage_config_get"
 
       autoload :ServicesMessage, "dji_mqtt_connect/messages/thing/product/services_message"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dji_mqtt_connect
 version: !ruby/object:Gem::Version
-  version: 0.1.21
+  version: 0.1.22
 platform: ruby
 authors:
 - Sphere Drones
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-04-12 00:00:00.000000000 Z
+date: 2024-08-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -157,6 +157,7 @@ files:
 - lib/dji_mqtt_connect/messages/thing/product/requests/config.rb
 - lib/dji_mqtt_connect/messages/thing/product/requests/flight_areas_get.rb
 - lib/dji_mqtt_connect/messages/thing/product/requests/flighttask_resource_get.rb
+- lib/dji_mqtt_connect/messages/thing/product/requests/offline_map_get.rb
 - lib/dji_mqtt_connect/messages/thing/product/requests/storage_config_get.rb
 - lib/dji_mqtt_connect/messages/thing/product/requests_message.rb
 - lib/dji_mqtt_connect/messages/thing/product/requests_reply/airport_bind_status.rb
@@ -165,6 +166,7 @@ files:
 - lib/dji_mqtt_connect/messages/thing/product/requests_reply/config.rb
 - lib/dji_mqtt_connect/messages/thing/product/requests_reply/flight_areas_get.rb
 - lib/dji_mqtt_connect/messages/thing/product/requests_reply/flighttask_resource_get.rb
+- lib/dji_mqtt_connect/messages/thing/product/requests_reply/offline_map_get.rb
 - lib/dji_mqtt_connect/messages/thing/product/requests_reply/storage_config_get.rb
 - lib/dji_mqtt_connect/messages/thing/product/services/alarm_state_switch.rb
 - lib/dji_mqtt_connect/messages/thing/product/services/cover_close.rb
@@ -251,7 +253,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.4
+rubygems_version: 3.5.15
 signing_key:
 specification_version: 4
 summary: Manages MQTT Connections with DJI Drones