dji_mqtt_connect 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 286e565c906b968d00df2865b04ab56f7edad331f603f059900d5d2ba0884e5f
-  data.tar.gz: 1f1e18bf29b660f9d68a7bc2b3a888a967782ee284872eab52af3c40cc780230
+  metadata.gz: 480a31f560b51a7180e845294de0e25fb2668005051b76d88207ec5a7e2c2199
+  data.tar.gz: f03b528efc73a514a910c31f16cc824e6ca2287176916ceaa168eb90c6489b00
 SHA512:
-  metadata.gz: 31e6ff2f90df68713a207cb3e70b8cb9c7aed4a4294ee70b3867b8f4a37390eb3d91931b0f533bac6361e2adac5dc307e3cb8544da762b9a9934949258f03c98
-  data.tar.gz: 55f3e73e77128f8f6c97f6fcf9425975eb11497ede3c55db6df57e06dd95e1713aa2c7bdf2adf76766e9d949c2c7133f8d9dc00106bf5a1922e5a4c77e1e0d90
+  metadata.gz: fca3a2a03f9c700c4ca94e31cc247c198205523e3c5595f969238c1600b51fd5ee9381ba8325bedb56e99b135122db338ce38d239fe8abb0d0b1af3da66c42f0
+  data.tar.gz: 2a4ee86eebc3704c059d93f652383870c8f6d4b09f6e952879db5fa515ca5282e451496713134054a69acb15a211ca7fbb6902ea54f2be36b6b51ce8735850e6

data/README.md

@@ -6,15 +6,13 @@ See also: https://developer.dji.com/doc/cloud-api-tutorial/en/server-api-referen
 
 ## 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
+    $ bundle add dji_mqtt_connect
 
 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
+    $ gem install dji_mqtt_connect
 
 ## Usage
 

data/lib/dji_mqtt_connect/factories.rb

@@ -45,5 +45,74 @@ module DjiMqttConnect
         }
       )
     end
+
+    def build_thing_product_config_requests_message
+      message_data = {
+        config_type: "json",
+        config_scope: "product"
+      }
+
+      Thing::Product::ConfigRequestsMessage.new(
+        _method: "config",
+        tid: "3093aad5-bb98-5026-685a-cea540eb9267",
+        bid: "479533e0-cb01-933c-3758-22f2a82abeb8",
+        timestamp: 1679380233000,
+        gateway: "gatewaysn",
+        data: message_data,
+        _data: message_data.deep_stringify_keys
+      )
+    end
+
+    def build_thing_product_config_requests_reply_message
+      request_message = build_thing_product_config_requests_message
+      reply_data = {
+        ntp_server_host: "http://time.google.com/",
+        app_id: "123456",
+        app_key: "app_key",
+        app_license: "app_license"
+      }
+
+      Thing::Product::ConfigRequestsReplyMessage.build_for(request_message, data: reply_data)
+    end
+
+    def build_thing_product_airport_bind_status_requests_message
+      message_data = {
+        devices: [
+          {
+            sn: "drone-sn"
+          },
+          {
+            sn: "dock-sn"
+          }
+        ]
+      }
+
+      Thing::Product::AirportBindStatusRequestsMessage.new(
+        _method: "airport_bind_status",
+        _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_bind_status_requests_reply_message
+      airport_bind_status_request = build_thing_product_airport_bind_status_requests_message
+
+      Thing::Product::AirportBindStatusRequestsReplyMessage.build_for(
+        airport_bind_status_request,
+        result: 0,
+        bind_status: airport_bind_status_request.data.devices.map.with_index do |device, index|
+          {
+            sn: device.sn,
+            is_device_bind_organization: (index % 2).zero?,
+            organization_id: "12345678",
+            organization_name: "12345",
+            device_callsign: "Device organization callsign"
+          }
+        end
+      )
+    end
   end
 end

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

@@ -6,6 +6,8 @@ require "json"
 module DjiMqttConnect
   module Sys::Product
     class StatusMarshal < MessageMarshal
+      include Utils::MessageParsing
+
       # Rename pesky `method` argument to `_method` and makes a copy of the raw data
       class AttributeTransformer < Dry::Transformer::Pipe
         import Dry::Transformer::HashTransformations
@@ -27,7 +29,7 @@ module DjiMqttConnect
         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 = message_class_for_parsed_message(parsed_message, StatusMessage)
         message_class.new transformed_message
       rescue JSON::ParserError => e
         raise ParseError.new(e, "Unable to parse message as JSON")
@@ -40,18 +42,6 @@ module DjiMqttConnect
       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/thing/product/requests_marshal.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+require "dry-struct"
+require "dry-transformer"
+require "json"
+
+module DjiMqttConnect
+  module Thing::Product
+    class RequestsMarshal < MessageMarshal
+      include Utils::MessageParsing
+
+      # 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, 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")
+      end
+
+      private
+
+      def attribute_transformer
+        @attribute_transformer ||= AttributeTransformer.new
+      end
+    end
+  end
+end

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

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require "dry-transformer"
+require "json"
+
+module DjiMqttConnect
+  module Thing::Product
+    class RequestsReplyMarshal < MessageMarshal
+      # Renames the method attribute
+      class HashTransformer < Dry::Transformer::Pipe
+        import Dry::Transformer::HashTransformations
+
+        define! do
+          rename_keys _method: :method
+        end
+      end
+
+      # Converts a message for transmission via MQTT
+      def dump(message)
+        # Fix up the hash representation
+        transformed_message = hash_transformer.call(message)
+
+        # Convert the transformed message into JSON
+        JSON.generate(transformed_message)
+      end
+
+      private
+
+      def hash_transformer
+        @hash_transformer ||= HashTransformer.new
+      end
+    end
+  end
+end

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

@@ -17,7 +17,7 @@ module DjiMqttConnect
         )
       end
 
-      attribute :_method, Types::String
+      attribute :_method, Types::String.enum("update_topo")
 
       attribute :tid, Types::String
       attribute :bid, Types::String

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

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module DjiMqttConnect
+  module Thing::Product
+    class AirportBindStatusRequestsMessage < RequestsMessage
+      attribute :_method, Types::String.enum("airport_bind_status")
+
+      attribute :data do
+        attribute :devices, Types::Array do
+          attribute :sn, Types::String
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module DjiMqttConnect
+  module Thing::Product
+    class AirportBindStatusRequestsReplyMessage < Message
+      def self.build_for(airport_bind_status_message, bind_status:, result: 0)
+        new(
+          _method: airport_bind_status_message._method,
+          tid: airport_bind_status_message.tid,
+          bid: airport_bind_status_message.bid,
+          timestamp: Time.now.strftime("%s%L").to_i,
+          data: {
+            result: result,
+            output: {
+              bind_status: bind_status
+            }
+          }
+        )
+      end
+
+      attribute :tid, Types::UUID
+      attribute :bid, Types::UUID
+      attribute :timestamp, Types::Timestamp
+
+      attribute :_method, Types::String.enum("airport_bind_status")
+
+      attribute :data do
+        attribute :result, Types::Integer
+        attribute :output do
+          attribute :bind_status, Types::Array do
+            attribute :sn, Types::String
+            attribute :is_device_bind_organization, Types::Bool
+            attribute :organization_id, Types::String
+            attribute :organization_name, Types::String
+            attribute :device_callsign, Types::String
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module DjiMqttConnect
+  module Thing::Product
+    class ConfigRequestsMessage < RequestsMessage
+      attribute :gateway, Types::String
+      attribute :_method, Types::String.enum("config")
+
+      attribute :data do
+        attribute :config_type, Types::String.enum("json")
+        attribute :config_scope, Types::String.enum("product")
+      end
+    end
+  end
+end

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

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module DjiMqttConnect
+  module Thing::Product
+    class ConfigRequestsReplyMessage < Message
+      def self.build_for(config_request_message, data:)
+        new(
+          _method: config_request_message._method,
+          data: data,
+          tid: config_request_message.tid,
+          bid: config_request_message.bid,
+          timestamp: Time.now.strftime("%s%L").to_i,
+          gateway: config_request_message.gateway
+        )
+      end
+
+      attribute :tid, Types::UUID
+      attribute :bid, Types::UUID
+      attribute :timestamp, Types::Timestamp
+      attribute :gateway, Types::String
+
+      attribute :_method, Types::String.enum("config")
+      attribute :data do
+        attribute :ntp_server_host, Types::String
+        attribute :app_id, Types::String
+        attribute :app_key, Types::String
+        attribute :app_license, Types::String
+      end
+    end
+  end
+end

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

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module DjiMqttConnect
+  module Thing::Product
+    class RequestsMessage < 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?(RequestsMessage) ? "#{super}[#{_method}]" : super
+      end
+    end
+  end
+end

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

@@ -17,6 +17,8 @@ module DjiMqttConnect
 
           logger.info("Received #{message} from #{device_identifier}")
           broadcast(message._method.to_sym, device_identifier, message)
+        rescue ParseError => error
+          broadcast(:parse_error, error, raw_message)
         end
       end
 

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

@@ -20,6 +20,8 @@ module DjiMqttConnect
           # 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)
+        rescue ParseError => error
+          broadcast(:parse_error, error, raw_message)
         end
       end
     end

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

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module DjiMqttConnect
+  module Thing::Product
+    class RequestsTopicRepository < TopicRepository
+      REQUESTS_TOPIC_REGEX = /\Athing\/product\/(?<gateway_sn>.+)\/requests\z/
+
+      def listen!
+        listen_to_topic("thing/product/+/requests") do |topic, raw_message|
+          logger.debug(raw_message)
+
+          matched_topic = REQUESTS_TOPIC_REGEX.match(topic)
+          raise Error, "Unknown topic: #{topic}" unless matched_topic
+
+          gateway_sn = matched_topic[:gateway_sn]
+          message = requests_marshal.load(raw_message)
+
+          logger.info("Received #{message} from #{gateway_sn}")
+          broadcast(message._method.to_sym, gateway_sn, message)
+        rescue ParseError => error
+          broadcast(:parse_error, error, raw_message)
+        end
+      end
+
+      private
+
+      def requests_marshal
+        @requests_marshal ||= RequestsMarshal.new
+      end
+    end
+  end
+end

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

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

data/lib/dji_mqtt_connect/utils/message_parsing.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module DjiMqttConnect
+  module Utils
+    module MessageParsing
+      private
+
+      def message_class_for_parsed_message(parsed_message, generic_class)
+        # update_topo => UpdateTopo
+        classified_method = ActiveSupport::Inflector.classify(parsed_message["method"])
+
+        # UpdateTopo => DjiMqttConnect::Sys::Product::UpdateTopoStatusMessage
+        module_prefix, joiner, class_suffix = generic_class.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) || generic_class
+      end
+    end
+  end
+end

data/lib/dji_mqtt_connect/version.rb

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

data/lib/dji_mqtt_connect.rb

@@ -37,14 +37,31 @@ module DjiMqttConnect
       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 :ConfigRequestsMessage, "dji_mqtt_connect/messages/thing/product/config_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 :ConfigRequestsReplyMessage, "dji_mqtt_connect/messages/thing/product/config_requests_reply_message"
+
       # Topics
       autoload :OsdTopicRepository, "dji_mqtt_connect/topics/thing/product/osd"
+      autoload :RequestsTopicRepository, "dji_mqtt_connect/topics/thing/product/requests"
+      autoload :RequestsReplyTopicRepository, "dji_mqtt_connect/topics/thing/product/requests_reply"
 
       # Marshals
       autoload :OsdMarshal, "dji_mqtt_connect/marshals/thing/product/osd_marshal"
+
+      autoload :RequestsMarshal, "dji_mqtt_connect/marshals/thing/product/requests_marshal"
+      autoload :RequestsReplyMarshal, "dji_mqtt_connect/marshals/thing/product/requests_reply_marshal"
     end
   end
 
+  # Utils
+  module Utils
+    autoload :MessageParsing, "dji_mqtt_connect/utils/message_parsing"
+  end
+
   # Railties
   module Railties
     autoload :MessageSerializer, "dji_mqtt_connect/railties/message_serializer"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dji_mqtt_connect
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Sphere Drones
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-05-03 00:00:00.000000000 Z
+date: 2023-05-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -110,21 +110,31 @@ files:
 - 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/marshals/thing/product/requests_marshal.rb
+- lib/dji_mqtt_connect/marshals/thing/product/requests_reply_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/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/config_requests_message.rb
+- lib/dji_mqtt_connect/messages/thing/product/config_requests_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/messages/thing/product/requests_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/topics/thing/product/requests.rb
+- 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/version.rb
 - sig/dji_mqtt_connect.rbs
 homepage: https://github.com/sphere-drones/dji_mqtt_connect