dji_mqtt_connect 0.1.1.4 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d7418cbbd6b891b0d72ea6d8e47f9b7f813b9de2dffd97f7bae249292a73f510
-  data.tar.gz: 6f2047ad8fcb7db0eff553c8c4dde862d2dbaa8b0820cd240a400d276470e51f
+  metadata.gz: 824a4b8942fc65705e25588a32df620e49602573b1eb14ed6f1b2c34c98023cd
+  data.tar.gz: 7f9dc5c06e40c04862baed3c41b8342da77a9fbedb083ab7432b9173180ebce1
 SHA512:
-  metadata.gz: d1d174f8a9475a59f1e5ed31835903a49dbc1100464fbf9da910b47f7219ed348ab710aee3baef7c1da75d17ef4e5340203e033650a50257018fa7499fae67b1
-  data.tar.gz: 9c9795cea856dd583733174aa9fd0871c50772b23d438bfb3d1608dd913187df62e4e7cb9468c6ad4beba336c60d163f9887a8c635714cf1dd0853ab25789f69
+  metadata.gz: 58ccec055d15866882fd93521c5d312719012c10e8778e18b99191c2bb48a7173ac0283f7f18daf21fb950d0472c02b3cb861cd1d07b0da0584e62278d62554c
+  data.tar.gz: ac4f30aa186b37fa04dbadbc49d813648c08ca031809a7c3b73d97fb0d6f7489cc680d74e0a3a83015ebcf77d26d25386c7f8dbecdb4e04e337308bc3a1f7a6c

data/.rubocop/rspec.yml

@@ -48,8 +48,8 @@ RSpec/ReceiveCounts:
 Capybara/CurrentPathExpectation:
   Enabled: true
 
-RSpec/FactoryBot/AttributeDefinedStatically:
+FactoryBot/AttributeDefinedStatically:
   Enabled: true
 
-RSpec/FactoryBot/CreateList:
+FactoryBot/CreateList:
   Enabled: true

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    dji_mqtt_connect (0.1.1.4)
+    dji_mqtt_connect (0.1.2)
       activesupport (>= 6.0, <= 8)
       dry-struct (~> 1.6)
       dry-transformer (~> 1.0)
@@ -46,15 +46,16 @@ GEM
       zeitwerk (~> 2.6)
     globalid (1.1.0)
       activesupport (>= 5.0)
-    i18n (1.12.0)
+    i18n (1.13.0)
       concurrent-ruby (~> 1.0)
     ice_nine (0.11.2)
     json (2.6.3)
     language_server-protocol (3.17.0.3)
+    lint_roller (1.0.0)
     minitest (5.18.0)
     mqtt (0.6.0)
     parallel (1.23.0)
-    parser (3.2.2.0)
+    parser (3.2.2.1)
       ast (~> 2.4.1)
     rainbow (3.1.1)
     rake (13.0.6)
@@ -66,7 +67,7 @@ GEM
       rspec-mocks (~> 3.12.0)
     rspec-core (3.12.2)
       rspec-support (~> 3.12.0)
-    rspec-expectations (3.12.2)
+    rspec-expectations (3.12.3)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.12.0)
     rspec-mocks (3.12.5)
@@ -83,18 +84,21 @@ GEM
       rubocop-ast (>= 1.28.0, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 2.4.0, < 3.0)
-    rubocop-ast (1.28.0)
+    rubocop-ast (1.28.1)
       parser (>= 3.2.1.0)
-    rubocop-capybara (2.17.1)
+    rubocop-capybara (2.18.0)
       rubocop (~> 1.41)
+    rubocop-factory_bot (2.22.0)
+      rubocop (~> 1.33)
     rubocop-performance (1.16.0)
       rubocop (>= 1.7.0, < 2.0)
       rubocop-ast (>= 0.4.0)
     rubocop-rake (0.6.0)
       rubocop (~> 1.0)
-    rubocop-rspec (2.20.0)
+    rubocop-rspec (2.22.0)
       rubocop (~> 1.33)
       rubocop-capybara (~> 2.17)
+      rubocop-factory_bot (~> 2.22)
     ruby-progressbar (1.13.0)
     simplecov (0.22.0)
       docile (~> 1.1)
@@ -102,16 +106,23 @@ GEM
       simplecov_json_formatter (~> 0.1)
     simplecov-html (0.12.3)
     simplecov_json_formatter (0.1.4)
-    standard (1.27.0)
+    standard (1.28.2)
       language_server-protocol (~> 3.17.0.2)
+      lint_roller (~> 1.0)
       rubocop (~> 1.50.2)
+      standard-custom (~> 1.0.0)
+      standard-performance (~> 1.0.1)
+    standard-custom (1.0.0)
+      lint_roller (~> 1.0)
+    standard-performance (1.0.1)
+      lint_roller (~> 1.0)
       rubocop-performance (~> 1.16.0)
     tzinfo (2.0.6)
       concurrent-ruby (~> 1.0)
     unicode-display_width (2.4.2)
     wisper (2.0.1)
     wisper-rspec (1.1.0)
-    zeitwerk (2.6.7)
+    zeitwerk (2.6.8)
 
 PLATFORMS
   x86_64-darwin-21

data/dji_mqtt_connect.gemspec

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+require_relative "lib/dji_mqtt_connect/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "dji_mqtt_connect"
+  spec.version = DjiMqttConnect::VERSION
+  spec.authors = ["Sphere Drones"]
+  spec.email = ["projects@spheregroup.com.au"]
+
+  spec.summary = "Manages MQTT Connections with DJI Drones"
+  # spec.description = "TODO: Write a longer description or delete this line."
+  spec.homepage = "https://github.com/sphere-drones/dji_mqtt_connect"
+  spec.required_ruby_version = ">= 3.1.0"
+
+  # spec.metadata["allowed_push_host"] = "TODO: Set to your gem server 'https://example.com'"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/sphere-drones/dji_mqtt_connect"
+  spec.metadata["changelog_uri"] = "https://github.com/sphere-drones/dji_mqtt_connect/main/CHANGELOG.md"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(__dir__) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (f == __FILE__) || f.match(%r{\A(?:(?:bin|test|spec|features)/|\.(?:git|circleci)|appveyor)})
+    end
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  # Use Active Support for inflection and logging
+  spec.add_dependency "activesupport", ">= 6.0", "<= 8"
+
+  # Use Dry-rb for valid POROs
+  spec.add_dependency "dry-struct", "~> 1.6"
+  spec.add_dependency "dry-transformer", "~> 1.0"
+
+  # Use MQTT as a client for receiving/sending messages
+  spec.add_dependency "mqtt", "~> 0.6.0"
+
+  # Use Whisper for events
+  spec.add_dependency "wisper", "~> 2.0"
+
+  # For more information and examples about making a new gem, check out our
+  # guide at: https://bundler.io/guides/creating_gem.html
+end

data/lib/dji_mqtt_connect/factories.rb

@@ -114,5 +114,70 @@ module DjiMqttConnect
         end
       )
     end
+
+    def build_thing_product_airport_organization_get_requests_message
+      message_data = {
+        device_binding_code: "device_binding_code",
+        organization_id: "organization_id"
+      }
+
+      Thing::Product::AirportOrganizationGetRequestsMessage.new(
+        _method: "airport_organization_get",
+        _data: message_data,
+        tid: "3093aad5-bb98-5026-685a-cea540eb9267",
+        bid: "479533e0-cb01-933c-3758-22f2a82abeb8",
+        timestamp: 1679380233000,
+        data: message_data
+      )
+    end
+
+    def build_thing_product_airport_organization_get_requests_reply_message
+      airport_organization_get_request = build_thing_product_airport_organization_get_requests_message
+
+      Thing::Product::AirportOrganizationGetRequestsReplyMessage.build_for(
+        airport_organization_get_request,
+        result: 0,
+        output: {
+          organization_name: "12345"
+        }
+      )
+    end
+
+    def build_thing_product_storage_config_get_requests_message
+      message_data = {
+        module: 0
+      }
+
+      Thing::Product::StorageConfigGetRequestsMessage.new(
+        _method: "storage_config_get",
+        _data: message_data,
+        tid: "3093aad5-bb98-5026-685a-cea540eb9267",
+        bid: "479533e0-cb01-933c-3758-22f2a82abeb8",
+        timestamp: 1679380233000,
+        data: message_data
+      )
+    end
+
+    def build_thing_product_storage_config_get_requests_reply_message
+      storage_config_get_request = build_thing_product_storage_config_get_requests_message
+
+      Thing::Product::StorageConfigGetRequestsReplyMessage.build_for(
+        storage_config_get_request,
+        result: 0,
+        output: {
+          bucket: "bucket_name",
+          credentials: {
+            access_key_id: "access_key_id",
+            access_key_secret: "access_key_secret",
+            expire: 3600,
+            security_token: "security_token"
+          },
+          endpoint: "https://oss-cn-hangzhou.aliyuncs.com",
+          object_key_prefix: "b4cfaae6-bd9d-4cd0-8472-63b608c3c581",
+          provider: "ali",
+          region: "hz"
+        }
+      )
+    end
   end
 end

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

@@ -12,10 +12,15 @@ module DjiMqttConnect
         import Dry::Transformer::HashTransformations
 
         define! do
+          # Ensure there is a data element
+          map_value "data", ->(data) { data || {} }
+
+          # Create a backup for unsupported attributes
           copy_keys "data" => "_data"
 
           map_value "data" do
-            guard ->(data) { data&.key?("wireless_link") } do
+            # Rename the invalid (for Ruby) wireless link attributes
+            guard ->(data) { data.key?("wireless_link") } do
               # Translate wireless_link 4g keys (from remote payload)
               map_value "wireless_link" do
                 rename_keys "4g_freq_band" => "_4g_freq_band",
@@ -38,6 +43,8 @@ module DjiMqttConnect
           DroneOsdMessage
         elsif remote_osd_data_attributes.all? { |attribute| message_data.key?(attribute.to_s) }
           RemoteOsdMessage
+        elsif dock_osd_data_attributes.any? { |attribute| message_data.key?(attribute.to_s) }
+          DockOsdMessage
         else
           OsdMessage
         end
@@ -57,12 +64,19 @@ module DjiMqttConnect
         @attribute_transformer ||= AttributeTransformer.new
       end
 
+      def dock_osd_data_attributes
+        @dock_osd_data_attributes ||= DockOsdMessage::STABLE_DATA_ATTRIBUTES.map(&:to_s)
+      end
+
       def drone_osd_data_attributes
-        @drone_osd_data_attributes ||= DjiMqttConnect::Thing::Product::DroneOsdMessage::Data.schema.keys.map(&:name)
+        @drone_osd_data_attributes ||= DroneOsdMessage::STABLE_DATA_ATTRIBUTES.map(&:to_s)
       end
 
       def remote_osd_data_attributes
-        @remote_osd_data_attributes ||= DjiMqttConnect::Thing::Product::RemoteOsdMessage::Data.schema.keys.map(&:name)
+        @remote_osd_data_attributes ||= begin
+          data_keys = DjiMqttConnect::Thing::Product::RemoteOsdMessage::Data.schema.keys
+          data_keys.select(&:required?).map(&:name)
+        end
       end
     end
   end

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

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module DjiMqttConnect
+  module Thing::Product
+    # https://developer.dji.com/doc/cloud-api-tutorial/en/server-api-reference/mqtt/thing-model/gateway/dock/organization.html#search-for-the-organization-information-that-device-bound-to
+    class AirportOrganizationGetRequestsMessage < RequestsMessage
+      attribute :_method, Types::String.enum("airport_organization_get")
+
+      attribute :data do
+        attribute :device_binding_code, Types::String
+        attribute :organization_id, Types::String
+      end
+    end
+  end
+end

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

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module DjiMqttConnect
+  module Thing::Product
+    # https://developer.dji.com/doc/cloud-api-tutorial/en/server-api-reference/mqtt/thing-model/gateway/dock/organization.html#search-for-the-organization-information-that-device-bound-to
+    class AirportOrganizationGetRequestsReplyMessage < Message
+      def self.build_for(airport_organization_get_message, output:, result: 0)
+        new(
+          _method: airport_organization_get_message._method,
+          tid: airport_organization_get_message.tid,
+          bid: airport_organization_get_message.bid,
+          timestamp: Time.now.strftime("%s%L").to_i,
+          data: {
+            result: result,
+            output: output
+          }
+        )
+      end
+
+      attribute :tid, Types::UUID
+      attribute :bid, Types::UUID
+      attribute :timestamp, Types::Timestamp
+
+      attribute :_method, Types::String.enum("airport_organization_get")
+
+      attribute :data do
+        attribute :result, Types::Integer
+        attribute :output do
+          attribute :organization_name, Types::String
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,199 @@
+# frozen_string_literal: true
+
+module DjiMqttConnect
+  module Thing::Product
+    class DockOsdMessage < OsdMessage
+      schema schema.strict
+
+      STABLE_DATA_ATTRIBUTES = %i[
+        drc_state
+        drone_in_dock
+        job_number
+      ]
+
+      attribute :data do
+        include Mixins::LatitudeConditional
+        include Mixins::LongitudeConditional
+        include Mixins::TemperatureConditional
+
+        attribute? :acc_time, Types::Integer
+        attribute? :activation_time, Types::Integer
+
+        attribute? :backup_battery do
+          include Mixins::TemperatureConditional
+
+          attribute :switch, Types::Integer.enum(0, 1)
+          attribute :voltage, Types::Integer
+          attribute :temperature, Types::Temperature
+        end
+
+        # {"0":"Disconnected","1":"Connecting","2":"Connected"}
+        attribute? :drc_state, Types::Integer.enum(0, 1, 2)
+
+        attribute? :drone_battery_maintenance_info do
+          attribute :batteries, Types::Array do
+            include Mixins::TemperatureConditional
+
+            attribute :index, Types::Integer
+            attribute :capacity_percent, Types::Integer
+            attribute :voltage, Types::Integer
+            attribute :temperature, Types::Temperature
+          end
+
+          # {"0":"Battery is not in heating or insulation","1":"Battery is in heating","2":"Battery is in insulation"}
+          attribute? :heat_state, Types::Integer.enum(0, 1, 2)
+
+          # {"0":"No need to maintenance","1":"Need maintenance","2":"Under maintenance"}
+          attribute? :maintenance_state, Types::Integer
+          attribute? :maintenance_time_left, Types::Integer
+        end
+
+        attribute? :drone_charge_state do
+          # {"0":"not charging","1":"charging"}
+          attribute :state, Types::Integer.enum(0, 1)
+
+          # {"min":"0","max":"100"}
+          attribute :capacity_percent, Types::Integer.constrained(gteq: 0, lteq: 100)
+        end
+        attribute? :drone_in_dock, Types::Integer.enum(0, 1)
+
+        attribute? :electric_supply_voltage, Types::Integer
+
+        attribute? :flighttask_prepare_capacity, Types::Integer
+        attribute? :flighttask_step_code, Types::Integer
+
+        attribute? :job_number, Types::Integer
+
+        attribute? :latitude, Types::Latitude
+        attribute? :longitude, Types::Longitude
+
+        attribute? :maintain_status do
+          attribute :maintain_status_array, Types::Array do
+            # {"0":"No maintenance","1":"Under maintenance"}
+            attribute :state, Types::Integer
+
+            # {"0":"No maintenance","1":"Drone basic maintenance","2":"Drone routine maintenance","3":"Drone deep maintenance","17":"Dock maintenance"}
+            attribute :last_maintain_type, Types::Integer
+
+            attribute :last_maintain_time, Types::Integer
+            attribute :last_maintain_work_sorties, Types::Integer
+          end
+        end
+
+        attribute? :media_file_detail do
+          attribute :remain_upload, Types::Integer
+        end
+
+        attribute? :network_state do
+          attribute :type, Types::Integer
+          attribute :quality, Types::Integer
+          attribute :rate, Types::JSON::Decimal
+        end
+
+        attribute? :sdr do
+          attribute :down_quality, Types::Integer
+          attribute :frequency_band, Types::JSON::Decimal
+          attribute :up_quality, Types::Integer
+        end
+
+        attribute? :wireless_link do
+          attribute :_4g_freq_band, Types::JSON::Decimal
+          attribute :_4g_gnd_quality, Types::Integer
+          attribute :_4g_link_state, Types::Integer
+          attribute :_4g_quality, Types::Integer
+          attribute :_4g_uav_quality, Types::Integer
+          attribute :dongle_number, Types::Integer
+          attribute :link_workmode, Types::Integer
+          attribute :sdr_freq_band, Types::JSON::Decimal
+          attribute :sdr_link_state, Types::Integer
+          attribute :sdr_quality, Types::Integer
+        end
+
+        attribute? :working_current, Types::Integer
+        attribute? :working_voltage, Types::Integer
+
+        # Weather
+
+        attribute? :height, Types::JSON::Decimal
+        attribute? :humidity, Types::Integer
+        attribute? :rainfall, Types::JSON::Decimal
+        attribute? :temperature, Types::Temperature
+        attribute? :wind_speed, Types::JSON::Decimal
+        attribute? :environment_temperature, Types::Temperature
+
+        attribute? :alternate_land_point do
+          attribute :latitude, Types::Latitude
+          attribute :longitude, Types::Longitude
+          attribute :height, Types::JSON::Decimal
+          attribute :safe_land_height, Types::JSON::Decimal
+          attribute :is_configured, Types::Integer.enum(0, 1)
+        end
+
+        attribute? :first_power_on, Types::Integer
+
+        attribute? :position_state do
+          # {"0":"Not calibrated","1":"Calibrated"}
+          attribute :is_calibration, Types::Integer.enum(0, 1)
+
+          # {"0":"Not start","1":"fixing","2":"fix successfully","3":"fix failed"}
+          attribute :is_fixed, Types::Integer.enum(0, 1, 2, 3)
+
+          attribute :quality, Types::Integer.constrained(gteq: 0, lteq: 5)
+          attribute :gps_number, Types::Integer
+          attribute :rtk_number, Types::Integer
+        end
+
+        attribute? :storage do
+          attribute :total, Types::Integer
+          attribute :used, Types::Integer
+        end
+
+        # {"0":"Idle","1":"On-site debugging","2":"Remote debugging","3":"Firmware upgrading","4":"Working"}
+        attribute? :mode_code, Types::Integer.enum(0, 1, 2, 3, 4)
+
+        attribute? :air_conditioner do
+          # {"0":"Idle mode (No cooling, heating, and dehumidification)","1":"Cooling mode","2":"Heating mode","3":"Dehumidification mode","4":"Cooling exit mode","5":"Heating exit mode","6":"Dehumidification exit mode","7":"Cooling preparation mode","8":"Heating preparation mode","9":"Dehumidification preparation mode"}
+          attribute :air_conditioner_state, Types::Integer.enum(0, 1, 2, 3, 4, 5, 6, 7, 8, 9)
+          attribute :switch_time, Types::Integer
+        end
+
+        # {"0":"Closed","1":"Opened"}
+        attribute? :alarm_state, Types::Integer.enum(0, 1)
+
+        # {"1":"Planned storage strategy of battery","2":"Emergency storage strategy of battery"}
+        attribute? :battery_store_mode, Types::Integer.enum(1, 2)
+
+        # {"0":"Closed","1":"Opened","2":"Half-open","3":"Cover state is abnormal"}
+        attribute? :cover_state, Types::Integer.enum(0, 1, 2, 3)
+
+        # {"0":"Closed","1":"Opened"}
+        attribute? :emergency_stop_state, Types::Integer.enum(0, 1)
+
+        # {"0":"Closed","1":"Opened","2":"Half-open","3":"Putter state is abnormal"}
+        attribute? :putter_state, Types::Integer.enum(0, 1, 2, 3)
+
+        # {"0":"Closed","1":"Opened"}
+        attribute? :supplement_light_state, Types::Integer.enum(0, 1)
+
+        attribute? :sub_device do
+          attribute? :device_sn, Types::String
+          attribute? :device_model_key, Types::String
+
+          # {"0":"Offline","1":"Online"}
+          attribute :device_online_status, Types::Integer.enum(0, 1)
+
+          # {"0":"Not paired","1":"Paired"}
+          attribute :device_paired, Types::Integer.enum(0, 1)
+        end
+
+        def drone_in_dock?
+          drone_in_dock == 1
+        end
+
+        def environment_temperature?
+          environment_temperature && !Types::InvalidTemperature.valid?(environment_temperature)
+        end
+      end
+    end
+  end
+end

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

@@ -3,19 +3,42 @@
 module DjiMqttConnect
   module Thing::Product
     class DroneOsdMessage < OsdMessage
+      STABLE_DATA_ATTRIBUTES = %i[
+        mode_code
+        gear
+        horizontal_speed
+        vertical_speed
+        latitude
+        longitude
+        height
+        elevation
+        attitude_head
+        attitude_pitch
+        attitude_roll
+        home_distance
+        wind_direction
+        wind_speed
+      ]
+
       attribute :data do
+        include Mixins::LatitudeConditional
+        include Mixins::LongitudeConditional
+
         attribute :attitude_head, Types::JSON::Decimal
         attribute :attitude_pitch, Types::JSON::Decimal
         attribute :attitude_roll, Types::JSON::Decimal
         attribute :battery do
           attribute :batteries, Types::Array do
+            include Mixins::TemperatureConditional
+
             attribute :capacity_percent, Types::Integer
             attribute :firmware_version, Types::String
+            attribute? :high_voltage_storage_days, Types::Integer
             attribute :index, Types::Integer
             attribute :loop_times, Types::Integer
             attribute :sn, Types::String
             attribute :sub_type, Types::DeviceSubType
-            attribute :temperature, Types::JSON::Decimal
+            attribute :temperature, Types::Temperature
             attribute :type, Types::DeviceType
             attribute :voltage, Types::Integer
           end
@@ -24,15 +47,21 @@ module DjiMqttConnect
           attribute :remain_flight_time, Types::Integer
           attribute :return_home_power, Types::Integer
         end
-        attribute :distance_limit_status do
+        attribute? :distance_limit_status do
           attribute :distance_limit, Types::Integer
-          attribute :state, Types::Integer
+
+          # {"0":"Not reached","1":"Reached"}
+          attribute? :is_near_distance_limit, Types::Integer.enum(0, 1)
+
+          # {"0":"Not set","1":"Have been set"}
+          attribute :state, Types::Integer.enum(0, 1)
         end
         attribute :elevation, Types::JSON::Decimal
+
         attribute :firmware_version, Types::String
         attribute :gear, Types::Integer
         attribute :height, Types::JSON::Decimal
-        attribute :height_limit, Types::JSON::Decimal
+        attribute? :height_limit, Types::JSON::Decimal
         attribute :home_distance, Types::JSON::Decimal
         attribute :horizontal_speed, Types::JSON::Decimal
         attribute :latitude, Types::Latitude
@@ -44,24 +73,99 @@ module DjiMqttConnect
           attribute :quality, Types::Integer
           attribute :rtk_number, Types::Integer
         end
-        attribute :storage do
+        attribute? :storage do
           attribute :total, Types::Integer
           attribute :used, Types::Integer
         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
         attribute :vertical_speed, Types::JSON::Decimal
         attribute :wind_direction, Types::JSON::Decimal
         attribute :wind_speed, Types::JSON::Decimal
 
-        def latitude?
-          !Types::NullInteger.valid?(latitude)
+        # M30 Fields
+
+        attribute? :cameras, Types::Array do
+          # {"0":"Photo taking","1":"Recording"}
+          attribute :camera_mode, Types::Integer.enum(0, 1)
+
+          # {"min":2,"max":20}
+          attribute :ir_zoom_factor, Types::JSON::Decimal
+
+          attribute :liveview_world_region do
+            attribute :bottom, Types::JSON::Decimal.constrained(gteq: 0, lteq: 1)
+            attribute :left, Types::JSON::Decimal.constrained(gteq: 0, lteq: 1)
+            attribute :right, Types::JSON::Decimal.constrained(gteq: 0, lteq: 1)
+            attribute :top, Types::JSON::Decimal.constrained(gteq: 0, lteq: 1)
+          end
+
+          attribute :payload_index, Types::String
+
+          # {"0":"Idle","1":"Taking photo"}
+          attribute :photo_state, Types::Integer.enum(0, 1)
+
+          # {"0":"Idle","1":"Recording"}
+          attribute :recording_state, Types::Integer.enum(0, 1)
+
+          # {"unit":"s"}
+          attribute :record_time, Types::Integer
+
+          attribute :remain_photo_num, Types::Integer
+
+          # {"unit":"s"}
+          attribute :remain_record_duration, Types::Integer
+
+          # {"min":2,"max":200}
+          attribute :zoom_factor, Types::JSON::Decimal
         end
 
-        def longitude?
-          !Types::NullInteger.valid?(longitude)
+        # {"0":"Continue to execute 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)
+
+        attribute? :is_near_area_limit, Types::Integer.enum(0, 1)
+
+        # {"0":"Not reached","1":"Reached"}
+        attribute? :is_near_height_limit, Types::Integer.enum(0, 1)
+
+        attribute? :maintain_status do
+          attribute :maintain_status_array, Types::Array do
+            attribute :last_maintain_flight_sorties, Types::Integer
+
+            # {"unit":"hour"}
+            attribute :last_maintain_flight_time, Types::Integer
+
+            attribute :last_maintain_time, Types::Integer
+
+            # {"0":"No maintenance","1":"Drone basic maintenance","2":"Drone routine maintenance","3":"Drone deep maintenance","17":"Dock maintenance"}
+            attribute :last_maintain_type, Types::Integer.enum(0, 1, 2, 3, 17)
+
+            # {"0":"No maintenance","1":"Under maintenance"}
+            attribute :state, Types::Integer.enum(0, 1)
+          end
         end
+
+        # {"0":"Off","1":"On"}
+        attribute? :night_lights_state, Types::Integer.enum(0, 1)
+
+        attribute? :obstacle_avoidance do
+          # {"0":"Close","1":"Open"}
+          attribute :horizon, Types::Integer.enum(0, 1)
+
+          # {"0":"Close","1":"Open"}
+          attribute :upside, Types::Integer.enum(0, 1)
+
+          # {"0":"Close","1":"Open"}
+          attribute :downside, Types::Integer.enum(0, 1)
+        end
+
+        # {"0":"Hovering","1":"Landing","2":"Returning to home"}
+        attribute? :rc_lost_action, Types::Integer.enum(0, 1, 2)
+
+        # {"unit":"m","min":20,"max":500}
+        attribute? :rth_altitude, Types::Integer
+
+        attribute? :total_flight_sorties, Types::Integer
       end
     end
   end

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

@@ -4,6 +4,9 @@ module DjiMqttConnect
   module Thing::Product
     class RemoteOsdMessage < OsdMessage
       attribute :data do
+        include Mixins::LatitudeConditional
+        include Mixins::LongitudeConditional
+
         attribute :capacity_percent, Types::Integer
         attribute :latitude, Types::Latitude
         attribute :live_status do
@@ -14,7 +17,7 @@ module DjiMqttConnect
         end
         attribute :longitude, Types::Longitude
         attribute :transmission_signal_quality, Types::Integer
-        attribute :wireless_link do
+        attribute? :wireless_link do
           attribute :_4g_freq_band, Types::JSON::Decimal
           attribute :_4g_gnd_quality, Types::Integer
           attribute :_4g_link_state, Types::Integer
@@ -31,14 +34,6 @@ module DjiMqttConnect
           attribute :frequency_band, Types::Integer
           attribute :upward_quality, Types::Integer
         end
-
-        def latitude?
-          !Types::NullInteger.valid?(latitude)
-        end
-
-        def longitude?
-          !Types::NullInteger.valid?(longitude)
-        end
       end
     end
   end

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

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module DjiMqttConnect
+  module Thing::Product
+    # https://developer.dji.com/doc/cloud-api-tutorial/en/server-api-reference/mqtt/thing-model/gateway/dock/file.html#obtain-upload-temporary-credentials
+    class StorageConfigGetRequestsMessage < RequestsMessage
+      attribute :_method, Types::String.enum("storage_config_get")
+
+      attribute :data do
+        attribute :module, Types::Integer.enum(0)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module DjiMqttConnect
+  module Thing::Product
+    # https://developer.dji.com/doc/cloud-api-tutorial/en/server-api-reference/mqtt/thing-model/gateway/dock/file.html#obtain-upload-temporary-credentials
+    class StorageConfigGetRequestsReplyMessage < Message
+      def self.build_for(storage_config_get_message, output:, result: 0)
+        new(
+          _method: storage_config_get_message._method,
+          tid: storage_config_get_message.tid,
+          bid: storage_config_get_message.bid,
+          timestamp: Time.now.strftime("%s%L").to_i,
+          data: {
+            result: result,
+            output: output
+          }
+        )
+      end
+
+      attribute :tid, Types::UUID
+      attribute :bid, Types::UUID
+      attribute :timestamp, Types::Timestamp
+
+      attribute :_method, Types::String.enum("storage_config_get")
+
+      attribute :data do
+        attribute :result, Types::Integer
+        attribute :output do
+          attribute :bucket, Types::String
+          attribute :credentials do
+            attribute :access_key_id, Types::String
+            attribute :access_key_secret, Types::String
+            attribute :expire, Types::Integer
+            attribute :security_token, Types::String
+          end
+          attribute :endpoint, Types::String
+          attribute :provider, Types::String
+          attribute :region, Types::String
+          attribute :object_key_prefix, Types::String
+        end
+      end
+    end
+  end
+end

data/lib/dji_mqtt_connect/mixins/latitude_conditional.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module DjiMqttConnect
+  module Mixins
+    # Provides a conditional that returns false for nil for invalid latitude values
+    module LatitudeConditional
+      def latitude?
+        latitude && !Types::NullInteger.valid?(latitude)
+      end
+    end
+  end
+end

data/lib/dji_mqtt_connect/mixins/longitude_conditional.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module DjiMqttConnect
+  module Mixins
+    # Provides a conditional that returns false for nil for invalid longitude values
+    module LongitudeConditional
+      def longitude?
+        longitude && !Types::NullInteger.valid?(longitude)
+      end
+    end
+  end
+end

data/lib/dji_mqtt_connect/mixins/temperature_conditional.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module DjiMqttConnect
+  module Mixins
+    # Provides a conditional that returns false for nil or excessive values (invalid data)
+    module TemperatureConditional
+      def temperature?
+        temperature && !Types::InvalidTemperature.valid?(temperature)
+      end
+    end
+  end
+end

data/lib/dji_mqtt_connect/topics/sys/product/status.rb

@@ -16,7 +16,14 @@ module DjiMqttConnect
           message = status_marshal.load(raw_message)
 
           logger.info("Received #{message} from #{device_identifier}")
-          broadcast(message._method.to_sym, device_identifier, message)
+
+          if message.instance_of?(StatusMessage)
+            # Broadcast an unsupported message event
+            broadcast(:unsupported_message, topic, raw_message)
+          else
+            # Build event name and broadcast (i.e. ::UpdateTopoStatusMessage => update_topo)
+            broadcast(message._method.to_sym, device_identifier, message)
+          end
         rescue ParseError => error
           broadcast(:parse_error, error, topic, raw_message)
         end

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

@@ -17,9 +17,14 @@ module DjiMqttConnect
 
           logger.info("Received #{message} from #{device_identifier}")
 
-          # 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)
+          if message.instance_of?(OsdMessage)
+            # Broadcast an unsupported message event
+            broadcast(:unsupported_message, topic, raw_message)
+          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)
+          end
         rescue ParseError => error
           broadcast(:parse_error, error, topic, raw_message)
         end

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

@@ -16,7 +16,14 @@ module DjiMqttConnect
           message = requests_marshal.load(raw_message)
 
           logger.info("Received #{message} from #{gateway_sn}")
-          broadcast(message._method.to_sym, gateway_sn, message)
+
+          if message.instance_of?(RequestsMessage)
+            # Broadcast an unsupported message event
+            broadcast(:unsupported_message, topic, raw_message)
+          else
+            # Build event name and broadcast (i.e. ::ConfigRequestsMessage => config)
+            broadcast(message._method.to_sym, gateway_sn, message)
+          end
         rescue ParseError => error
           broadcast(:parse_error, error, topic, raw_message)
         end

data/lib/dji_mqtt_connect/types.rb

@@ -24,5 +24,8 @@ module DjiMqttConnect
     DeviceDomain = Types::Coercible::Integer # dock returns this value as string
     DeviceType = Types::Integer
     DeviceSubType = Types::Integer
+
+    InvalidTemperature = Types::Integer.constrained(gteq: 1300) # maximum temp of k-type thermocouple, errors are usually 30K+
+    Temperature = InvalidTemperature | Types::JSON::Decimal
   end
 end

data/lib/dji_mqtt_connect/utils/message_sanitizer.rb

@@ -0,0 +1,90 @@
+# frozen_string_literal: true
+
+require "active_support/core_ext/hash/keys"
+
+module DjiMqttConnect
+  module Utils
+    # Sanitizes MQTT messages to remove any personally-identifiable information
+    class MessageSanitizer
+      DEFAULT_LATITUDE = "-33.865143"
+      DEFAULT_LONGITUDE = "151.209900"
+
+      SECRET_KEYS = %w[app_id app_key app_license callsign device_secret nonce]
+
+      SERIAL_NUMBER_KEYS = %w[device_sn gateway sn]
+
+      TOPIC_REGEX = /\A.+\/.+\/(.+)\/.+/
+
+      def initialize(latitude: DEFAULT_LATITUDE, longitude: DEFAULT_LONGITUDE, secret_keys: SECRET_KEYS, serial_number_keys: SERIAL_NUMBER_KEYS, serial_number_aliases: {})
+        @latitude = latitude
+        @longitude = longitude
+
+        @secret_keys = secret_keys
+        @serial_number_keys = serial_number_keys
+
+        serial_aliases = serial_number_aliases.stringify_keys
+        @serial_number_generator = Hash.new do |h, k|
+          return "" if k.length == 0
+          h[k] = serial_aliases.fetch(k) { sprintf("%s%02d", "SERIAL", h.length + 1) }
+        end
+        serial_aliases.keys.each { |k| serial_number_generator[k] }
+      end
+
+      def sanitize_topic(topic)
+        topic.sub(TOPIC_REGEX) { |topic_match| topic_match.sub($1, serial_number_generator[$1]) }
+      end
+
+      def sanitize_message(message)
+        sanitized_message = sanitize_object(message)
+        strip_serial_numbers(sanitized_message)
+      end
+
+      private
+
+      attr_reader :latitude, :longitude
+      attr_reader :secret_keys, :serial_number_keys, :serial_number_generator
+
+      def sanitize_object(object)
+        case object
+        when Hash
+          serial_number_keys.each do |key|
+            if object.key?(key) && object[key].length > 0
+              object[key] = serial_number_generator[object[key]]
+            end
+          end
+          secret_keys.each do |key|
+            object[key] = key.upcase if object.key?(key)
+          end
+          if object.key?("latitude")
+            obj_latitude = object["latitude"]
+            object["latitude"] = (obj_latitude.is_a?(Integer) && obj_latitude.zero?) ? 0 : latitude
+          end
+          if object.key?("longitude")
+            obj_longitude = object["longitude"]
+            object["longitude"] = (obj_longitude.is_a?(Integer) && obj_longitude.zero?) ? 0 : longitude
+          end
+
+          object.transform_values { |v| sanitize_object(v) }
+        when Array
+          object.map { |v| sanitize_object(v) }
+        else
+          object
+        end
+      end
+
+      # Strips known serial numbers from an object
+      def strip_serial_numbers(object)
+        case object
+        when Hash
+          object.transform_values { |v| strip_serial_numbers(v) }
+        when Array
+          object.map { |v| strip_serial_numbers(v) }
+        when String
+          object.split("-").map { |s| serial_number_generator.fetch(s, s) }.join("-")
+        else
+          object
+        end
+      end
+    end
+  end
+end

data/lib/dji_mqtt_connect/utils/message_schema_generator.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+require "active_support/core_ext/array/wrap"
+
+module DjiMqttConnect
+  module Utils
+    # Generates a simple message schema from a mqtt message
+    #
+    # Schema is simply the class name of any element that is not a Hash or Array
+    class MessageSchemaGenerator
+      def initialize(retain_attributes: [])
+        @retain_attributes = Array.wrap(retain_attributes)
+      end
+
+      def generate(message)
+        case message
+        when Hash
+          retain_values = retain_attributes.each_with_object({}) do |attribute, hash|
+            next unless message.key?(attribute)
+
+            attribute_value = message[attribute]
+            next if attribute_value.is_a?(Hash) || attribute_value.is_a?(Array)
+
+            hash[attribute] = "#{attribute_value.class.name}:#{attribute_value}"
+          end
+          message.transform_values { |v| generate(v) }.merge(retain_values)
+        when Array
+          message.map { |v| generate(v) }
+        else
+          message.class.name
+        end
+      end
+
+      private
+
+      attr_reader :retain_attributes
+    end
+  end
+end

data/lib/dji_mqtt_connect/utils/mqttx_fixture_data_generator.rb

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+
+require "stringio"
+
+module DjiMqttConnect
+  module Utils
+    # Generates anonymised fixture data from MQTTX JSON Export Dumps
+    class MqttxFixtureDataGenerator
+      def self.from_file(file_path, **sanitizer_args)
+        raw_data = File.read(file_path)
+        new JSON.parse(raw_data), message_sanitizer: MessageSanitizer.new(**sanitizer_args)
+      end
+
+      def initialize(mqttx_data, message_sanitizer:)
+        @mqttx_data = mqttx_data
+        @message_sanitizer = message_sanitizer
+      end
+
+      # Generates fixture data using ALL found messages in the MQTTX export
+      #
+      # # Output is:
+      # <topic 1>: <message 1 as json>
+      # <topic 1>: <message 2 as json>
+      def generate
+        extracted_messages.each_with_object(StringIO.new) do |(topic, message), builder|
+          builder.puts [topic, message.to_json].join(": ")
+        end.string
+      end
+
+      # Generates fixture data using unique found messages in the MQTTX export
+      #
+      # A message is considered unique if the topic and schema does not match any other messages
+      #
+      # # Output is:
+      # <topic 1>: <message 1 as json>
+      def generate_unique(**schema_generator_args)
+        message_schema_generator = MessageSchemaGenerator.new(**schema_generator_args)
+
+        unique_messages = extracted_messages.each_with_object({}) do |(topic, message), found|
+          message_schema = message_schema_generator.generate(message)
+          found[[topic, message_schema]] ||= [topic, message]
+        end.values
+
+        unique_messages.each_with_object(StringIO.new) do |(topic, message), builder|
+          builder.puts [topic, message.to_json].join(": ")
+        end.string
+      end
+
+      private
+
+      attr_reader :mqttx_data, :message_sanitizer
+
+      def extracted_messages
+        return enum_for(:extracted_messages) unless block_given?
+
+        mqttx_data.each do |client_output|
+          client_messages = client_output["messages"]
+
+          client_messages.each do |message|
+            message_topic = message_sanitizer.sanitize_topic(message.fetch("topic"))
+            message_payload = JSON.parse message.fetch("payload")
+            yield(message_topic, message_sanitizer.sanitize_message(message_payload))
+          end
+        end
+      end
+    end
+  end
+end

data/lib/dji_mqtt_connect/version.rb

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

data/lib/dji_mqtt_connect.rb

@@ -34,15 +34,20 @@ module DjiMqttConnect
     module Product
       # Messages
       autoload :OsdMessage, "dji_mqtt_connect/messages/thing/product/osd_message"
+      autoload :DockOsdMessage, "dji_mqtt_connect/messages/thing/product/dock_osd_message"
       autoload :DroneOsdMessage, "dji_mqtt_connect/messages/thing/product/drone_osd_message"
       autoload :RemoteOsdMessage, "dji_mqtt_connect/messages/thing/product/remote_osd_message"
 
       autoload :AirportBindStatusRequestsMessage, "dji_mqtt_connect/messages/thing/product/airport_bind_status_requests_message"
+      autoload :AirportOrganizationGetRequestsMessage, "dji_mqtt_connect/messages/thing/product/airport_organization_get_requests_message"
       autoload :ConfigRequestsMessage, "dji_mqtt_connect/messages/thing/product/config_requests_message"
+      autoload :StorageConfigGetRequestsMessage, "dji_mqtt_connect/messages/thing/product/storage_config_get_requests_message"
       autoload :RequestsMessage, "dji_mqtt_connect/messages/thing/product/requests_message"
 
       autoload :AirportBindStatusRequestsReplyMessage, "dji_mqtt_connect/messages/thing/product/airport_bind_status_requests_reply_message"
+      autoload :AirportOrganizationGetRequestsReplyMessage, "dji_mqtt_connect/messages/thing/product/airport_organization_get_requests_reply_message"
       autoload :ConfigRequestsReplyMessage, "dji_mqtt_connect/messages/thing/product/config_requests_reply_message"
+      autoload :StorageConfigGetRequestsReplyMessage, "dji_mqtt_connect/messages/thing/product/storage_config_get_requests_reply_message"
 
       # Topics
       autoload :OsdTopicRepository, "dji_mqtt_connect/topics/thing/product/osd"
@@ -57,9 +62,19 @@ module DjiMqttConnect
     end
   end
 
+  # Mixinx
+  module Mixins
+    autoload :LatitudeConditional, "dji_mqtt_connect/mixins/latitude_conditional"
+    autoload :LongitudeConditional, "dji_mqtt_connect/mixins/longitude_conditional"
+    autoload :TemperatureConditional, "dji_mqtt_connect/mixins/temperature_conditional"
+  end
+
   # Utils
   module Utils
     autoload :MessageParsing, "dji_mqtt_connect/utils/message_parsing"
+    autoload :MessageSanitizer, "dji_mqtt_connect/utils/message_sanitizer"
+    autoload :MessageSchemaGenerator, "dji_mqtt_connect/utils/message_schema_generator"
+    autoload :MqttxFixtureDataGenerator, "dji_mqtt_connect/utils/mqttx_fixture_data_generator"
   end
 
   # Railties

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dji_mqtt_connect
 version: !ruby/object:Gem::Version
-  version: 0.1.1.4
+  version: 0.1.2
 platform: ruby
 authors:
 - Sphere Drones
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-05-05 00:00:00.000000000 Z
+date: 2023-05-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -103,6 +103,7 @@ files:
 - Gemfile.lock
 - README.md
 - Rakefile
+- dji_mqtt_connect.gemspec
 - lib/dji_mqtt_connect.rb
 - lib/dji_mqtt_connect/client.rb
 - lib/dji_mqtt_connect/error.rb
@@ -119,12 +120,20 @@ files:
 - lib/dji_mqtt_connect/messages/sys/product/update_topo_status_reply_message.rb
 - lib/dji_mqtt_connect/messages/thing/product/airport_bind_status_requests_message.rb
 - lib/dji_mqtt_connect/messages/thing/product/airport_bind_status_requests_reply_message.rb
+- lib/dji_mqtt_connect/messages/thing/product/airport_organization_get_requests_message.rb
+- lib/dji_mqtt_connect/messages/thing/product/airport_organization_get_requests_reply_message.rb
 - lib/dji_mqtt_connect/messages/thing/product/config_requests_message.rb
 - lib/dji_mqtt_connect/messages/thing/product/config_requests_reply_message.rb
+- lib/dji_mqtt_connect/messages/thing/product/dock_osd_message.rb
 - lib/dji_mqtt_connect/messages/thing/product/drone_osd_message.rb
 - lib/dji_mqtt_connect/messages/thing/product/osd_message.rb
 - lib/dji_mqtt_connect/messages/thing/product/remote_osd_message.rb
 - lib/dji_mqtt_connect/messages/thing/product/requests_message.rb
+- lib/dji_mqtt_connect/messages/thing/product/storage_config_get_requests_message.rb
+- lib/dji_mqtt_connect/messages/thing/product/storage_config_get_requests_reply_message.rb
+- lib/dji_mqtt_connect/mixins/latitude_conditional.rb
+- lib/dji_mqtt_connect/mixins/longitude_conditional.rb
+- lib/dji_mqtt_connect/mixins/temperature_conditional.rb
 - lib/dji_mqtt_connect/railtie.rb
 - lib/dji_mqtt_connect/railties/message_serializer.rb
 - lib/dji_mqtt_connect/topic_repository.rb
@@ -135,6 +144,9 @@ files:
 - lib/dji_mqtt_connect/topics/thing/product/requests_reply.rb
 - lib/dji_mqtt_connect/types.rb
 - lib/dji_mqtt_connect/utils/message_parsing.rb
+- lib/dji_mqtt_connect/utils/message_sanitizer.rb
+- lib/dji_mqtt_connect/utils/message_schema_generator.rb
+- lib/dji_mqtt_connect/utils/mqttx_fixture_data_generator.rb
 - lib/dji_mqtt_connect/version.rb
 - sig/dji_mqtt_connect.rbs
 homepage: https://github.com/sphere-drones/dji_mqtt_connect