dji_mqtt_connect 0.1.2 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 824a4b8942fc65705e25588a32df620e49602573b1eb14ed6f1b2c34c98023cd
-  data.tar.gz: 7f9dc5c06e40c04862baed3c41b8342da77a9fbedb083ab7432b9173180ebce1
+  metadata.gz: 3a9ba8caf2ea370ed33848df512fbebcc63dfd4b63dd07947a1a653f56fdb1a8
+  data.tar.gz: 16ec8180f911733314fc2be3dbfefc5433c758663b3a52fd9a9fe7e6c00ca370
 SHA512:
-  metadata.gz: 58ccec055d15866882fd93521c5d312719012c10e8778e18b99191c2bb48a7173ac0283f7f18daf21fb950d0472c02b3cb861cd1d07b0da0584e62278d62554c
-  data.tar.gz: ac4f30aa186b37fa04dbadbc49d813648c08ca031809a7c3b73d97fb0d6f7489cc680d74e0a3a83015ebcf77d26d25386c7f8dbecdb4e04e337308bc3a1f7a6c
+  metadata.gz: dfacde33b13c8aa12e096013273c8ca597a3ae7cf1a54fde85eaf353a6ff3c0b94bc062f0ad351e6d47bdad0f599c2c12b41f1dde9ddf91bd8ae3b666360e725
+  data.tar.gz: ac51091158d1459ca3e6d4666ec86abbae044a04b130e8f4bfc374b7b5dcf315c418b61a25e3a7b78019bc7d3aa024c025656b2de15aa1951e4e1300b82d5c88

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    dji_mqtt_connect (0.1.2)
+    dji_mqtt_connect (0.1.4)
       activesupport (>= 6.0, <= 8)
       dry-struct (~> 1.6)
       dry-transformer (~> 1.0)

data/lib/dji_mqtt_connect/client.rb

@@ -41,6 +41,11 @@ module DjiMqttConnect
       Sys::Product::StatusReplyTopicRepository.new(self)
     end
 
+    # Handles topic thing/product/#{pid}/events
+    def thing_product_events_topic
+      Thing::Product::EventsTopicRepository.new(self)
+    end
+
     # Handles topic thing/product/#{pid}/osd
     def thing_product_osd_topic
       Thing::Product::OsdTopicRepository.new(self)

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

@@ -29,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, StatusMessage)
+        message_class = message_class_from_method_value(parsed_message, StatusMessage)
         message_class.new transformed_message
       rescue JSON::ParserError => e
         raise ParseError.new(e, "Unable to parse message as JSON")

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

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+require "dry-struct"
+require "dry-transformer"
+require "json"
+
+module DjiMqttConnect
+  module Thing::Product
+    class EventsMarshal < 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_from_method_value(parsed_message, EventsMessage)
+        message_class.new transformed_message
+      rescue JSON::ParserError => e
+        raise ParseError.new(e, "Unable to parse message as JSON")
+      rescue Dry::Struct::Error => e
+        raise ParseError.new(e, "Unexpected #{message_class} payload")
+      end
+
+      private
+
+      def attribute_transformer
+        @attribute_transformer ||= AttributeTransformer.new
+      end
+    end
+  end
+end

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

@@ -30,7 +30,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, RequestsMessage)
+        message_class = message_class_from_method_value(parsed_message, RequestsMessage)
         message_class.new transformed_message
       rescue JSON::ParserError => e
         raise ParseError.new(e, "Unable to parse message as JSON")

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

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

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

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module DjiMqttConnect
+  module Thing::Product
+    class HmsEventsMessage < EventsMessage
+      attribute :_method, Types::String.enum("hms")
+
+      attribute :data do
+        attribute :list, Types::Array do
+          # {"0":"Inform","1":"Notice","2":"Alarm"}
+          attribute :level, Types::Integer.enum(0, 1, 2)
+
+          # {"0":"flight mission","1":"device management","2":"media","3":"hms"}
+          attribute :module, Types::Integer.enum(0, 1, 2, 3)
+
+          # {"0":"on the ground","1":"in the sky"}
+          attribute :in_the_sky, Types::Integer.enum(0, 1)
+
+          attribute :code, Types::String
+
+          # {"0":"No","1":"Yes"}
+          attribute :imminent, Types::Integer.enum(0, 1)
+
+          attribute :args do
+            attribute :component_index, Types::Integer
+
+            attribute :sensor_index, Types::Integer
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -30,7 +30,7 @@ module DjiMqttConnect
           attribute :credentials do
             attribute :access_key_id, Types::String
             attribute :access_key_secret, Types::String
-            attribute :expire, Types::Integer
+            attribute :expire, Types::Integer.constrained(gt: 0)
             attribute :security_token, Types::String
           end
           attribute :endpoint, Types::String

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

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module DjiMqttConnect
+  module Thing::Product
+    class EventsTopicRepository < TopicRepository
+      EVENTS_TOPIC_REGEX = /\Athing\/product\/(?<device_sn>.+)\/events\z/
+
+      def listen!
+        listen_to_topic("thing/product/+/events") do |topic, raw_message|
+          logger.debug(raw_message)
+
+          matched_topic = EVENTS_TOPIC_REGEX.match(topic)
+          raise Error, "Unknown topic: #{topic}" unless matched_topic
+
+          device_sn = matched_topic[:device_sn]
+          message = EventsMarshal.load(raw_message)
+
+          logger.info("Received #{message} from #{device_sn}")
+
+          if message.instance_of?(EventsMessage)
+            # Broadcast an unsupported message event
+            broadcast(:unsupported_message, topic, raw_message)
+          else
+            # Build event name and broadcast (i.e. ::HmsEventsMessage => hms_event)
+            event_name = message.class.name.demodulize.sub(/sMessage\z/, "").underscore.to_sym
+            broadcast(event_name, device_sn, message)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/dji_mqtt_connect/utils/message_parsing.rb

@@ -5,9 +5,12 @@ module DjiMqttConnect
     module MessageParsing
       private
 
-      def message_class_for_parsed_message(parsed_message, generic_class)
+      def message_class_from_method_value(parsed_message, generic_class)
+        message_method = parsed_message["method"]
+        return generic_class if message_method.blank?
+
         # update_topo => UpdateTopo
-        classified_method = ActiveSupport::Inflector.classify(parsed_message["method"])
+        classified_method = message_method.split("_").collect! { |w| w.capitalize }.join
 
         # UpdateTopo => DjiMqttConnect::Sys::Product::UpdateTopoStatusMessage
         module_prefix, joiner, class_suffix = generic_class.name.rpartition("::")

data/lib/dji_mqtt_connect/version.rb

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

data/lib/dji_mqtt_connect.rb

@@ -33,6 +33,9 @@ module DjiMqttConnect
   module Thing
     module Product
       # Messages
+      autoload :HmsEventsMessage, "dji_mqtt_connect/messages/thing/product/hms_events_message"
+      autoload :EventsMessage, "dji_mqtt_connect/messages/thing/product/events_message"
+
       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"
@@ -50,11 +53,14 @@ module DjiMqttConnect
       autoload :StorageConfigGetRequestsReplyMessage, "dji_mqtt_connect/messages/thing/product/storage_config_get_requests_reply_message"
 
       # Topics
+      autoload :EventsTopicRepository, "dji_mqtt_connect/topics/thing/product/events"
       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 :EventsMarshal, "dji_mqtt_connect/marshals/thing/product/events_marshal"
+
       autoload :OsdMarshal, "dji_mqtt_connect/marshals/thing/product/osd_marshal"
 
       autoload :RequestsMarshal, "dji_mqtt_connect/marshals/thing/product/requests_marshal"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dji_mqtt_connect
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.4
 platform: ruby
 authors:
 - Sphere Drones
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-05-11 00:00:00.000000000 Z
+date: 2023-05-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -110,6 +110,7 @@ files:
 - 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/events_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
@@ -126,6 +127,8 @@ files:
 - 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/events_message.rb
+- lib/dji_mqtt_connect/messages/thing/product/hms_events_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
@@ -139,6 +142,7 @@ files:
 - 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/events.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