dji_mqtt_connect 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 286e565c906b968d00df2865b04ab56f7edad331f603f059900d5d2ba0884e5f
+  data.tar.gz: 1f1e18bf29b660f9d68a7bc2b3a888a967782ee284872eab52af3c40cc780230
+SHA512:
+  metadata.gz: 31e6ff2f90df68713a207cb3e70b8cb9c7aed4a4294ee70b3867b8f4a37390eb3d91931b0f533bac6361e2adac5dc307e3cb8544da762b9a9934949258f03c98
+  data.tar.gz: 55f3e73e77128f8f6c97f6fcf9425975eb11497ede3c55db6df57e06dd95e1713aa2c7bdf2adf76766e9d949c2c7133f8d9dc00106bf5a1922e5a4c77e1e0d90

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop/rspec.yml

@@ -0,0 +1,55 @@
+require:
+  - rubocop-rspec
+
+# Disable all cops by default,
+# only enable those defined explcitly in this configuration file
+RSpec:
+  Enabled: false
+
+RSpec/Focus:
+  Enabled: true
+
+RSpec/EmptyExampleGroup:
+  Enabled: true
+
+RSpec/EmptyLineAfterExampleGroup:
+  Enabled: true
+
+RSpec/EmptyLineAfterFinalLet:
+  Enabled: true
+
+RSpec/EmptyLineAfterHook:
+  Enabled: true
+
+RSpec/EmptyLineAfterSubject:
+  Enabled: true
+
+RSpec/HookArgument:
+  Enabled: true
+
+RSpec/HooksBeforeExamples:
+  Enabled: true
+
+RSpec/ImplicitExpect:
+  Enabled: true
+
+RSpec/IteratedExpectation:
+  Enabled: true
+
+RSpec/LetBeforeExamples:
+  Enabled: true
+
+RSpec/MissingExampleGroupArgument:
+  Enabled: true
+
+RSpec/ReceiveCounts:
+  Enabled: true
+
+Capybara/CurrentPathExpectation:
+  Enabled: true
+
+RSpec/FactoryBot/AttributeDefinedStatically:
+  Enabled: true
+
+RSpec/FactoryBot/CreateList:
+  Enabled: true

data/.rubocop/strict.yml

@@ -0,0 +1,7 @@
+Lint/Debugger: # don't leave binding.pry
+  Enabled: true
+  Exclude: []
+
+RSpec/Focus: # run ALL tests on CI
+  Enabled: true
+  Exclude: []

data/.rubocop/style.yml

@@ -0,0 +1,6 @@
+Style/FrozenStringLiteralComment: # Use frozen literal comments for performance
+  Enabled: true
+  EnforcedStyle: always
+  Include:
+    - app/**/*
+    - lib/**/*

data/.rubocop.yml

@@ -0,0 +1,20 @@
+inherit_mode:
+  merge:
+    - Exclude
+
+require:
+  - rubocop-rake
+  - standard
+
+inherit_gem:
+  standard: config/base.yml
+
+inherit_from:
+  - .rubocop/style.yml
+  - .rubocop/rspec.yml
+  - .rubocop/strict.yml
+
+AllCops:
+  NewCops: disable
+  SuggestExtensions: true
+  TargetRubyVersion: 3.1

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2023-04-14
+
+- Initial release

data/Gemfile

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in dji_mqtt_connect.gemspec
+gemspec
+
+gem "activejob", require: false
+
+gem "rake", "~> 13.0"
+
+gem "rspec", "~> 3.0"
+
+gem "rubocop", "~> 1.21"
+
+gem "rubocop-rake"
+
+gem "rubocop-rspec"
+
+gem "simplecov", require: false
+
+gem "standard", "~> 1.0"
+
+gem "wisper-rspec"

data/Gemfile.lock

@@ -0,0 +1,133 @@
+PATH
+  remote: .
+  specs:
+    dji_mqtt_connect (0.1.0)
+      activesupport (>= 6.0, <= 8)
+      dry-struct (~> 1.6)
+      dry-transformer (~> 1.0)
+      mqtt (~> 0.6.0)
+      wisper (~> 2.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activejob (7.0.4.3)
+      activesupport (= 7.0.4.3)
+      globalid (>= 0.3.6)
+    activesupport (7.0.4.3)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+    ast (2.4.2)
+    concurrent-ruby (1.2.2)
+    diff-lcs (1.5.0)
+    docile (1.4.0)
+    dry-core (1.0.0)
+      concurrent-ruby (~> 1.0)
+      zeitwerk (~> 2.6)
+    dry-inflector (1.0.0)
+    dry-logic (1.5.0)
+      concurrent-ruby (~> 1.0)
+      dry-core (~> 1.0, < 2)
+      zeitwerk (~> 2.6)
+    dry-struct (1.6.0)
+      dry-core (~> 1.0, < 2)
+      dry-types (>= 1.7, < 2)
+      ice_nine (~> 0.11)
+      zeitwerk (~> 2.6)
+    dry-transformer (1.0.1)
+      zeitwerk (~> 2.6)
+    dry-types (1.7.1)
+      concurrent-ruby (~> 1.0)
+      dry-core (~> 1.0)
+      dry-inflector (~> 1.0)
+      dry-logic (~> 1.4)
+      zeitwerk (~> 2.6)
+    globalid (1.1.0)
+      activesupport (>= 5.0)
+    i18n (1.12.0)
+      concurrent-ruby (~> 1.0)
+    ice_nine (0.11.2)
+    json (2.6.3)
+    language_server-protocol (3.17.0.3)
+    minitest (5.18.0)
+    mqtt (0.6.0)
+    parallel (1.23.0)
+    parser (3.2.2.0)
+      ast (~> 2.4.1)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    regexp_parser (2.8.0)
+    rexml (3.2.5)
+    rspec (3.12.0)
+      rspec-core (~> 3.12.0)
+      rspec-expectations (~> 3.12.0)
+      rspec-mocks (~> 3.12.0)
+    rspec-core (3.12.2)
+      rspec-support (~> 3.12.0)
+    rspec-expectations (3.12.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-mocks (3.12.5)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-support (3.12.0)
+    rubocop (1.50.2)
+      json (~> 2.3)
+      parallel (~> 1.10)
+      parser (>= 3.2.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.28.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.28.0)
+      parser (>= 3.2.1.0)
+    rubocop-capybara (2.17.1)
+      rubocop (~> 1.41)
+    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 (~> 1.33)
+      rubocop-capybara (~> 2.17)
+    ruby-progressbar (1.13.0)
+    simplecov (0.22.0)
+      docile (~> 1.1)
+      simplecov-html (~> 0.11)
+      simplecov_json_formatter (~> 0.1)
+    simplecov-html (0.12.3)
+    simplecov_json_formatter (0.1.4)
+    standard (1.27.0)
+      language_server-protocol (~> 3.17.0.2)
+      rubocop (~> 1.50.2)
+      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)
+
+PLATFORMS
+  x86_64-darwin-21
+  x86_64-linux
+
+DEPENDENCIES
+  activejob
+  dji_mqtt_connect!
+  rake (~> 13.0)
+  rspec (~> 3.0)
+  rubocop (~> 1.21)
+  rubocop-rake
+  rubocop-rspec
+  simplecov
+  standard (~> 1.0)
+  wisper-rspec
+
+BUNDLED WITH
+   2.4.6

data/README.md

@@ -0,0 +1,31 @@
+# DjiMqttConnect
+
+Manages MQTT Connections with DJI Drones
+
+See also: https://developer.dji.com/doc/cloud-api-tutorial/en/server-api-reference/mqtt/topic-definition.html
+
+## Installation
+
+TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/sphere-drones/dji_mqtt_connect.

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/lib/dji_mqtt_connect/client.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+require "mqtt"
+
+module DjiMqttConnect
+  # Client for communicating with DJI Cloud API MQTT Messages
+  # see: https://developer.dji.com/doc/cloud-api-tutorial/en/server-api-reference/mqtt/topic-definition.html
+  class Client
+    def self.build(mqtt_address, username:, password:, &block)
+      mqtt_url = URI.parse(mqtt_address)
+      mqtt_host = mqtt_url.host
+      mqtt_port = mqtt_url.port.to_i
+      mqtt_scheme = mqtt_url.scheme
+
+      DjiMqttConnect.logger.tagged(name) do
+        DjiMqttConnect.logger.info("Connecting to #{mqtt_scheme}://#{mqtt_host}:#{mqtt_port}...")
+
+        mqtt_client = MQTT::Client.connect(
+          host: mqtt_host,
+          port: mqtt_port,
+          client_id: DjiMqttConnect.client_id,
+          username: username,
+          password: password,
+          ssl: !%w[tcp mqtt ws].include?(mqtt_scheme)
+        )
+        new(mqtt_client)
+      end
+    end
+
+    def initialize(mqtt_client)
+      @mqtt_client = mqtt_client
+    end
+
+    # Handles topic sys/product/#{pid}/status
+    def sys_product_status_topic
+      Sys::Product::StatusTopicRepository.new(self)
+    end
+
+    # Handles topic sys/product/#{pid}/status_reply
+    def sys_product_status_reply_topic
+      Sys::Product::StatusReplyTopicRepository.new(self)
+    end
+
+    # Handles topic thing/product/#{pid}/osd
+    def thing_product_osd_topic
+      Thing::Product::OsdTopicRepository.new(self)
+    end
+
+    attr_reader :mqtt_client
+  end
+end

data/lib/dji_mqtt_connect/error.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module DjiMqttConnect
+  # Represents an Error caused when communicatng via MQTT
+  class Error < StandardError
+    attr_reader :wrapped_exception
+
+    def initialize(error, message = nil)
+      @wrapped_exception, msg = error_and_message(error, message)
+      super(msg)
+    end
+
+    def backtrace
+      if @wrapped_exception
+        @wrapped_exception.backtrace
+      else
+        super
+      end
+    end
+
+    def inspect
+      if @wrapped_exception
+        inner = +""
+        inner += ": #{message}," if !message.empty? && @wrapped_exception.message != message
+        inner << " wrapped=#{@wrapped_exception.inspect}"
+        %(#<#{self.class}#{inner}>)
+      else
+        super
+      end
+    end
+
+    private
+
+    # Pulls out potential parent exception and response hash.
+    def error_and_message(exc, message)
+      return [exc, message || exc.message] if exc.respond_to?(:backtrace)
+
+      [nil, exc.to_s]
+    end
+  end
+
+  # Indicates a problem parsing a response
+  class ParseError < Error
+  end
+end

data/lib/dji_mqtt_connect/factories.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+module DjiMqttConnect
+  # Factories for building example messages
+  # Do not include this in your production code
+  module Factories
+    def build_device_online_update_topo_message
+      message_data = {
+        type: 98,
+        sub_type: 0,
+        device_secret: "secret",
+        nonce: "nonce",
+        version: 1,
+        sub_devices: [
+          {
+            sn: "drone001",
+            type: 116,
+            sub_type: 0,
+            index: "A",
+            device_secret: "secret",
+            nonce: "nonce",
+            version: 1
+          }
+        ]
+      }
+
+      Sys::Product::UpdateTopoStatusMessage.new(
+        _method: "update_topo",
+        tid: "12345678-1234-1234-1234-A00000000001",
+        bid: "12345678-1234-1234-1234-B00000000001",
+        timestamp: 1234567890123,
+        data: message_data,
+        _data: message_data.deep_stringify_keys
+      )
+    end
+
+    def build_update_topo_status_reply_message
+      Sys::Product::UpdateTopoStatusReplyMessage.new(
+        _method: "update_topo",
+        tid: "3093aad5-bb98-5026-685a-cea540eb9267",
+        bid: "479533e0-cb01-933c-3758-22f2a82abeb8",
+        timestamp: 1679380233000,
+        data: {
+          result: 0
+        }
+      )
+    end
+  end
+end

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

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+require "dry-transformer"
+require "json"
+
+module DjiMqttConnect
+  module Sys::Product
+    class StatusMarshal < MessageMarshal
+      # Rename pesky `method` argument to `_method` and makes a copy of the raw data
+      class AttributeTransformer < Dry::Transformer::Pipe
+        import Dry::Transformer::HashTransformations
+
+        define! do
+          symbolize_keys
+
+          copy_keys data: :_data
+          rename_keys method: :_method
+        end
+      end
+
+      # 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)
+
+        # Transform the message
+        transformed_message = attribute_transformer.call(parsed_message)
+
+        # Build an instance of the class, or a generic message from the current class
+        message_class = message_class_for_parsed_message(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, "Unexpected #{message_class} payload")
+      end
+
+      private
+
+      def attribute_transformer
+        @attribute_transformer ||= AttributeTransformer.new
+      end
+
+      def message_class_for_parsed_message(parsed_message)
+        # update_topo => UpdateTopo
+        classified_method = ActiveSupport::Inflector.classify(parsed_message["method"])
+
+        # UpdateTopo => DjiMqttConnect::Sys::Product::UpdateTopoStatusMessage
+        module_prefix, joiner, class_suffix = StatusMessage.name.rpartition("::")
+        message_class_name = [module_prefix, joiner, classified_method, class_suffix].join
+
+        # Constantize an instance of the message-specific class, or fallback to a generic message
+        ActiveSupport::Inflector.safe_constantize(message_class_name) || StatusMessage
+      end
+    end
+  end
+end

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

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

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+require "dry-transformer"
+require "json"
+
+module DjiMqttConnect
+  module Thing::Product
+    class OsdMarshal < MessageMarshal
+      # Make a copy of the raw data
+      class AttributeTransformer < Dry::Transformer::Pipe
+        import Dry::Transformer::Conditional
+        import Dry::Transformer::HashTransformations
+
+        define! do
+          copy_keys "data" => "_data"
+
+          map_value "data" do
+            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",
+                  "4g_gnd_quality" => "_4g_gnd_quality",
+                  "4g_link_state" => "_4g_link_state",
+                  "4g_quality" => "_4g_quality",
+                  "4g_uav_quality" => "_4g_uav_quality"
+              end
+            end
+          end
+        end
+      end
+
+      # Parse message from Device > Cloud Server
+      def load(raw_message)
+        parsed_message = JSON.parse(raw_message)
+
+        message_data = parsed_message.fetch("data", {})
+        message_class = if drone_osd_data_attributes.all? { |attribute| message_data.key?(attribute.to_s) }
+          DroneOsdMessage
+        elsif remote_osd_data_attributes.all? { |attribute| message_data.key?(attribute.to_s) }
+          RemoteOsdMessage
+        else
+          OsdMessage
+        end
+
+        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")
+      end
+
+      private
+
+      def attribute_transformer
+        @attribute_transformer ||= AttributeTransformer.new
+      end
+
+      def drone_osd_data_attributes
+        @drone_osd_data_attributes ||= DjiMqttConnect::Thing::Product::DroneOsdMessage::Data.schema.keys.map(&:name)
+      end
+
+      def remote_osd_data_attributes
+        @remote_osd_data_attributes ||= DjiMqttConnect::Thing::Product::RemoteOsdMessage::Data.schema.keys.map(&:name)
+      end
+    end
+  end
+end

data/lib/dji_mqtt_connect/message.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require "dry-struct"
+
+module DjiMqttConnect
+  class Message < Dry::Struct
+    transform_keys(&:to_sym)
+
+    def to_s
+      self.class.name
+    end
+  end
+end

data/lib/dji_mqtt_connect/message_marshal.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module DjiMqttConnect
+  class MessageMarshal
+    class << self
+      delegate :load, :dump, to: :new
+    end
+
+    # Parse message loaded from a topic
+    def load(_raw_string)
+      raise NotImplementedError
+    end
+
+    # Serialize message for sending via a topic
+    def dump(_message)
+      raise NotImplementedError
+    end
+  end
+end

data/lib/dji_mqtt_connect/messages/sys/product/status_message.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module DjiMqttConnect
+  module Sys::Product
+    # {"tid":"3093aad5-bb98-5026-685a-cea540eb9267","bid":"479533e0-cb01-933c-3758-22f2a82abeb8","timestamp":1679380232398,"method":"update_topo","data":{"domain":2,"type":144,"sub_type":0,"device_secret":"0d180c84ddbe76ee32ad2e48eab3c994","nonce":"83ad8038363b4d5387cbf106d1517718","version":1,"sub_devices":[]}}
+    class StatusMessage < DjiMqttConnect::Message
+      attribute :tid, Types::UUID
+      attribute :bid, Types::UUID
+      attribute :timestamp, Types::Timestamp
+
+      attribute :_data, Types::Hash
+      attribute :_method, Types::String
+
+      def to_s
+        # Include data method for Generic messages
+        instance_of?(StatusMessage) ? "#{super}[#{_method}]" : super
+      end
+    end
+  end
+end

data/lib/dji_mqtt_connect/messages/sys/product/update_topo_status_message.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module DjiMqttConnect
+  module Sys::Product
+    class UpdateTopoStatusMessage < StatusMessage
+      attribute :data do
+        attribute :type, Types::Integer
+        attribute :sub_type, Types::Integer
+        attribute :device_secret, Types::String
+        attribute? :domain, Types::Integer
+        attribute :nonce, Types::String
+        attribute :version, Types::Integer
+        attribute :sub_devices, Types::Array do
+          attribute :sn, Types::String
+          attribute :type, Types::Integer
+          attribute :sub_type, Types::Integer
+          attribute :index,	Types::String
+          attribute :device_secret, Types::String
+          attribute :nonce, Types::String
+          attribute :version, Types::Integer
+        end
+      end
+    end
+  end
+end

data/lib/dji_mqtt_connect/messages/sys/product/update_topo_status_reply_message.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module DjiMqttConnect
+  module Sys::Product
+    class UpdateTopoStatusReplyMessage < Message
+      # Builds a reply for an update_topo status message
+      # a result of 0 means we approve of this action
+      def self.build_for(update_topo_status_message, result: 0)
+        new(
+          _method: update_topo_status_message._method,
+          tid: update_topo_status_message.tid,
+          bid: update_topo_status_message.bid,
+          timestamp: Time.now.strftime("%s%L").to_i,
+          data: {
+            result: result
+          }
+        )
+      end
+
+      attribute :_method, Types::String
+
+      attribute :tid, Types::String
+      attribute :bid, Types::String
+      attribute :timestamp, Types::Integer
+      attribute :data do
+        attribute :result, Types::Integer
+      end
+    end
+  end
+end

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

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+
+module DjiMqttConnect
+  module Thing::Product
+    class DroneOsdMessage < OsdMessage
+      attribute :data do
+        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
+            attribute :capacity_percent, Types::Integer
+            attribute :firmware_version, Types::String
+            attribute :index, Types::Integer
+            attribute :loop_times, Types::Integer
+            attribute :sn, Types::String
+            attribute :sub_type, Types::Integer
+            attribute :temperature, Types::JSON::Decimal
+            attribute :type, Types::Integer
+            attribute :voltage, Types::Integer
+          end
+          attribute :capacity_percent, Types::Integer
+          attribute :landing_power, Types::Integer
+          attribute :remain_flight_time, Types::Integer
+          attribute :return_home_power, Types::Integer
+        end
+        attribute :distance_limit_status do
+          attribute :distance_limit, Types::Integer
+          attribute :state, Types::Integer
+        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 :home_distance, Types::JSON::Decimal
+        attribute :horizontal_speed, Types::JSON::Decimal
+        attribute :latitude, Types::Latitude
+        attribute :longitude, Types::Longitude
+        attribute :mode_code, Types::Integer
+        attribute :position_state do
+          attribute :gps_number, Types::Integer
+          attribute :is_fixed, Types::Integer
+          attribute :quality, Types::Integer
+          attribute :rtk_number, Types::Integer
+        end
+        attribute :storage do
+          attribute :total, Types::Integer
+          attribute :used, Types::Integer
+        end
+        attribute :total_flight_distance, Types::Integer
+        attribute :total_flight_time, Types::Integer
+        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)
+        end
+
+        def longitude?
+          !Types::NullInteger.valid?(longitude)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require "dry-transformer"
+
+module DjiMqttConnect
+  module Thing::Product
+    class OsdMessage < Message
+      attribute :tid, Types::UUID
+      attribute :bid, Types::UUID
+      attribute :timestamp, Types::Timestamp
+      attribute :gateway, Types::String
+
+      # Backup of received data
+      attribute :_data, Types::Hash
+    end
+  end
+end

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

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module DjiMqttConnect
+  module Thing::Product
+    class RemoteOsdMessage < OsdMessage
+      attribute :data do
+        attribute :capacity_percent, Types::Integer
+        attribute :latitude, Types::Latitude
+        attribute :live_status do
+          attribute :live_time, Types::Integer
+          attribute :live_trendline, Types::Integer
+          attribute :video_id, Types::String
+          attribute :video_quality, Types::Integer
+        end
+        attribute :longitude, Types::Longitude
+        attribute :transmission_signal_quality, Types::Integer
+        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 :wireless_link_state do
+          attribute :download_quality, Types::Integer
+          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
+end

data/lib/dji_mqtt_connect/railtie.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module DjiMqttConnect
+  class Railtie < Rails::Railtie
+    # Allow ActiveJob to serialize DjiMqttConnect::Message objects
+    config.active_job.custom_serializers << Railties::MessageSerializer
+
+    # Replace default logger with Rails logger
+    initializer "dji_mqtt_connect.configure_logger" do
+      DjiMqttConnect.logger = Rails.logger
+    end
+  end
+end

data/lib/dji_mqtt_connect/railties/message_serializer.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module DjiMqttConnect
+  module Railties
+    class MessageSerializer < ActiveJob::Serializers::ObjectSerializer
+      def serialize(message)
+        stringified_hash = message.to_h.deep_stringify_keys
+
+        # Strip the extra data element
+        stringified_hash.delete("_data")
+
+        super(
+          "type" => message.class.name,
+          "payload" => stringified_hash
+        )
+      end
+
+      def deserialize(hash)
+        # Rebuild the message, re-insert the data hash
+        message_class = hash["type"].constantize
+        message_payload = hash["payload"].merge("_data" => {})
+        message_class.new(message_payload)
+      end
+
+      private
+
+      def klass
+        DjiMqttConnect::Message
+      end
+    end
+  end
+end

data/lib/dji_mqtt_connect/topic_repository.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+require "wisper"
+
+module DjiMqttConnect
+  class TopicRepository
+    include Wisper::Publisher
+
+    def initialize(client)
+      @client = client
+    end
+
+    private
+
+    attr_reader :client
+
+    def logger
+      @logger ||= DjiMqttConnect.logger.tagged(self.class.name.sub(/Repository\z/, ""))
+    end
+
+    def listen_to_topic(topic, &block)
+      logger.info("Listening to #{topic}...")
+
+      client.mqtt_client.get(topic, &block)
+    rescue Interrupt
+      # Allow safe exiting after interrupts
+      logger.info("Disconnected")
+    end
+
+    def publish_to_topic(topic, message, marshal:)
+      logger.info("Publishing #{message.class} to #{topic}")
+
+      message_data = marshal.dump(message)
+      logger.debug(message_data)
+
+      client.mqtt_client.publish(topic, message_data)
+
+      broadcast(:publish_to_topic, topic, message)
+    end
+  end
+end

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

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module DjiMqttConnect
+  module Sys::Product
+    class StatusTopicRepository < TopicRepository
+      STATUS_TOPIC_REGEX = /\Asys\/product\/(?<device_identifier>.+)\/status\z/
+
+      def listen!
+        listen_to_topic("sys/product/+/status") do |topic, raw_message|
+          logger.debug(raw_message)
+
+          matched_topic = STATUS_TOPIC_REGEX.match(topic)
+          raise Error, "Unknown topic: #{topic}" unless matched_topic
+
+          device_identifier = matched_topic[:device_identifier]
+          message = status_marshal.load(raw_message)
+
+          logger.info("Received #{message} from #{device_identifier}")
+          broadcast(message._method.to_sym, device_identifier, message)
+        end
+      end
+
+      private
+
+      def status_marshal
+        @status_marshal ||= StatusMarshal.new
+      end
+    end
+  end
+end

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

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module DjiMqttConnect
+  module Sys::Product
+    class StatusReplyTopicRepository < TopicRepository
+      # Publishes a message to device_identifier on the "sys/product/+/status_reply" topic.
+      def publish_to_device(device_identifier, status_reply_message)
+        publish_to_topic(
+          "sys/product/#{device_identifier}/status_reply",
+          status_reply_message,
+          marshal: StatusReplyMarshal
+        )
+      end
+    end
+  end
+end

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

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module DjiMqttConnect
+  module Thing::Product
+    class OsdTopicRepository < TopicRepository
+      OSD_TOPIC_REGEX = /\Athing\/product\/(?<device_identifier>.+)\/osd\z/
+
+      def listen!
+        listen_to_topic("thing/product/+/osd") do |topic, raw_message|
+          logger.debug(raw_message)
+
+          matched_topic = OSD_TOPIC_REGEX.match(topic)
+          raise Error, "Unknown topic: #{topic}" unless matched_topic
+
+          device_identifier = matched_topic[:device_identifier]
+          message = OsdMarshal.load(raw_message)
+
+          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)
+        end
+      end
+    end
+  end
+end

data/lib/dji_mqtt_connect/types.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require "dry-types"
+
+module DjiMqttConnect
+  # Types binding for dry-types
+  module Types
+    include Dry::Types()
+
+    # DJI does not like null, so it returns Integer 0 instead of a Decimal...
+    NullInteger = Types::Strict::Integer.constrained(eql: 0)
+
+    # Not a Strict UUID format... turns out DJI doesn't follow one
+    UUID = Strict::String.constrained(format: /\A[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}\z/i)
+
+    # Just make sure Timestamps are positive
+    Timestamp = Types::Integer.constrained(gteq: 0)
+
+    # lat/lng coordinates
+    Latitude = NullInteger | Types::JSON::Decimal.constrained(gteq: -90, lteq: 90)
+    Longitude = NullInteger | Types::JSON::Decimal.constrained(gteq: -180, lteq: 180)
+  end
+end

data/lib/dji_mqtt_connect/version.rb

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

data/lib/dji_mqtt_connect.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+require "active_support"
+require "mqtt"
+
+require_relative "dji_mqtt_connect/version"
+require_relative "dji_mqtt_connect/error"
+
+module DjiMqttConnect
+  autoload :Client, "dji_mqtt_connect/client"
+  autoload :Message, "dji_mqtt_connect/message"
+  autoload :MessageMarshal, "dji_mqtt_connect/message_marshal"
+  autoload :TopicRepository, "dji_mqtt_connect/topic_repository"
+  autoload :Types, "dji_mqtt_connect/types"
+
+  module Sys
+    module Product
+      # Messages
+      autoload :StatusMessage, "dji_mqtt_connect/messages/sys/product/status_message"
+      autoload :UpdateTopoStatusMessage, "dji_mqtt_connect/messages/sys/product/update_topo_status_message"
+      autoload :UpdateTopoStatusReplyMessage, "dji_mqtt_connect/messages/sys/product/update_topo_status_reply_message"
+
+      # Topics
+      autoload :StatusTopicRepository, "dji_mqtt_connect/topics/sys/product/status"
+      autoload :StatusReplyTopicRepository, "dji_mqtt_connect/topics/sys/product/status_reply"
+
+      # Marshals
+      autoload :StatusMarshal, "dji_mqtt_connect/marshals/sys/product/status_marshal"
+      autoload :StatusReplyMarshal, "dji_mqtt_connect/marshals/sys/product/status_reply_marshal"
+    end
+  end
+
+  module Thing
+    module Product
+      # Messages
+      autoload :OsdMessage, "dji_mqtt_connect/messages/thing/product/osd_message"
+      autoload :DroneOsdMessage, "dji_mqtt_connect/messages/thing/product/drone_osd_message"
+      autoload :RemoteOsdMessage, "dji_mqtt_connect/messages/thing/product/remote_osd_message"
+
+      # Topics
+      autoload :OsdTopicRepository, "dji_mqtt_connect/topics/thing/product/osd"
+
+      # Marshals
+      autoload :OsdMarshal, "dji_mqtt_connect/marshals/thing/product/osd_marshal"
+    end
+  end
+
+  # Railties
+  module Railties
+    autoload :MessageSerializer, "dji_mqtt_connect/railties/message_serializer"
+  end
+
+  cattr_accessor :client_id, default: MQTT::Client.generate_client_id(name)
+  cattr_accessor :logger, default: ActiveSupport::TaggedLogging.new(ActiveSupport::Logger.new($stdout)).tap { |logger| logger.level = Logger::INFO }
+end
+
+require "dji_mqtt_connect/railtie" if defined?(Rails::Railtie)

data/sig/dji_mqtt_connect.rbs

@@ -0,0 +1,4 @@
+module DjiMqttConnect
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,155 @@
+--- !ruby/object:Gem::Specification
+name: dji_mqtt_connect
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Sphere Drones
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2023-05-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.0'
+    - - "<="
+      - !ruby/object:Gem::Version
+        version: '8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.0'
+    - - "<="
+      - !ruby/object:Gem::Version
+        version: '8'
+- !ruby/object:Gem::Dependency
+  name: dry-struct
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: dry-transformer
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: mqtt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.6.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.6.0
+- !ruby/object:Gem::Dependency
+  name: wisper
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+description:
+email:
+- projects@spheregroup.com.au
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- ".rubocop/rspec.yml"
+- ".rubocop/strict.yml"
+- ".rubocop/style.yml"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- lib/dji_mqtt_connect.rb
+- lib/dji_mqtt_connect/client.rb
+- lib/dji_mqtt_connect/error.rb
+- lib/dji_mqtt_connect/factories.rb
+- lib/dji_mqtt_connect/marshals/sys/product/status_marshal.rb
+- lib/dji_mqtt_connect/marshals/sys/product/status_reply_marshal.rb
+- lib/dji_mqtt_connect/marshals/thing/product/osd_marshal.rb
+- lib/dji_mqtt_connect/message.rb
+- lib/dji_mqtt_connect/message_marshal.rb
+- lib/dji_mqtt_connect/messages/sys/product/status_message.rb
+- lib/dji_mqtt_connect/messages/sys/product/update_topo_status_message.rb
+- lib/dji_mqtt_connect/messages/sys/product/update_topo_status_reply_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/railtie.rb
+- lib/dji_mqtt_connect/railties/message_serializer.rb
+- lib/dji_mqtt_connect/topic_repository.rb
+- lib/dji_mqtt_connect/topics/sys/product/status.rb
+- lib/dji_mqtt_connect/topics/sys/product/status_reply.rb
+- lib/dji_mqtt_connect/topics/thing/product/osd.rb
+- lib/dji_mqtt_connect/types.rb
+- lib/dji_mqtt_connect/version.rb
+- sig/dji_mqtt_connect.rbs
+homepage: https://github.com/sphere-drones/dji_mqtt_connect
+licenses: []
+metadata:
+  homepage_uri: https://github.com/sphere-drones/dji_mqtt_connect
+  source_code_uri: https://github.com/sphere-drones/dji_mqtt_connect
+  changelog_uri: https://github.com/sphere-drones/dji_mqtt_connect/main/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.1.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.12
+signing_key:
+specification_version: 4
+summary: Manages MQTT Connections with DJI Drones
+test_files: []