nmea_plus 1.0.5 → 1.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 251cdb1544954d1179dff46abba2e708882eec35
-  data.tar.gz: 4df1f9c37c1a9be4e02320dfd40beee2c9379597
+  metadata.gz: ab50fa5e587f895b72ed894cf0c4e3f280956146
+  data.tar.gz: 923806c46670760a1f3832b23ae93f37001f4c80
 SHA512:
-  metadata.gz: 8f988a24f2ad6692c03d4aaa9ddd5dd9ab648aa145be95bcd7f31a888c3786476f4bd02ab467ecbb9c236cb557ebfe88a27e16055c7f910c26980c30e508d654
-  data.tar.gz: e4ce7609e89711a59753ea91931dfe64ad80cf5fec83eaa3fa86ea0682e5f3cd178f7bdc58ac78a8d71a3bef61fb06b78c011988c3bb75ca06a0bcc2a4cee7ff
+  metadata.gz: b59b0f3ea335e74df47fd85587e88907d41e61052a5a2da22f7d3fc9882fbf30a6294cad1d95cbc65774eafb6a35cb30e73293cbf547b12de916423c0c6444df
+  data.tar.gz: 2e572c97ed129692c193ebefa13bd20598e1e49b29fe23c99000cd669e30bab93599dac69757cb27a0a5a27d1406e3a182fd0f43ba9adfce581b5d7396c8a67c

data/README.md

@@ -2,7 +2,7 @@
 
 [![Gem Version](https://badge.fury.io/rb/nmea_plus.svg)](https://rubygems.org/gems/nmea_plus)
 [![Build Status](https://travis-ci.org/ifreecarve/nmea_plus.svg)](https://travis-ci.org/ifreecarve/nmea_plus)
-[![Documentation](http://img.shields.io/badge/docs-rdoc.info-blue.svg)](http://rubydoc.org/gems/nmea_plus/frames)
+[![Documentation](http://img.shields.io/badge/docs-rdoc.info-blue.svg)](http://www.rubydoc.info/gems/nmea_plus/1.0.6)
 
 [NMEA Plus](https://github.com/ifreecarve/nmea_plus) is a Ruby gem for parsing and decoding "GPS" messages: NMEA, AIS, and any other similar formats of short messaging typically used by marine equipment.  It provides convenient access (by name) to the fields of each message type, and a stream reader designed for use with Ruby Blocks.
 
@@ -97,7 +97,7 @@ Because the message types are standard, if no override is found for a particular
 Additionally, AIS message type definitions were implemented from the unofficial spec found here:
 http://catb.org/gpsd/AIVDM.html
 
-> Currently AIVDM messages types 1, 2, 3, 5, and 8 are implemented.
+> Currently AIVDM messages types 1, 2, 3, 4, 5, 8, 9, 12, 14, 18, 19, and 21 are implemented.
 
 Support for proprietary messages is also possible.  PASHR is included as proof-of-concept.
 

data/lib/nmea_plus/message/ais/vdm.rb

@@ -17,9 +17,15 @@ end
 
 =end
 
-require_relative "vdm_payload/vdm_msg1"
+require_relative "vdm_payload/vdm_msg1" # also incldues 2 and 3
+require_relative "vdm_payload/vdm_msg4"
 require_relative "vdm_payload/vdm_msg5"
 require_relative "vdm_payload/vdm_msg8"
+require_relative "vdm_payload/vdm_msg9"
+require_relative "vdm_payload/vdm_msg12"
+require_relative "vdm_payload/vdm_msg14"
+require_relative "vdm_payload/vdm_msg18" # also includes 19
+require_relative "vdm_payload/vdm_msg21"
 
 module NMEAPlus
   module Message

data/lib/nmea_plus/message/ais/vdm_payload/vdm_msg.rb

@@ -6,7 +6,7 @@ module NMEAPlus
     module AIS
       # There are many VDM payload types, and this is their container.  See {VDMMsg}.
       module VDMPayload
-        # The base class for the AIS payload (of {NMEAPlus::Message::AIS::VDM}) which can be of many types.
+        # The base class for the AIS payload (of {NMEAPlus::Message::AIS::VDM}), which uses its own encoding for its own subtypes
         class VDMMsg
           # @return [String] The raw "armored payload" in the original message
           attr_accessor :payload_bitstring
@@ -115,7 +115,7 @@ module NMEAPlus
           # scale an integer by dividing it by 10^decimal_places
           # @param start [Integer] The index of the first bit in the payload field
           # @param length [Integer] The number of bits in the payload field
-          # @param decimal_places [Integer] The power of ten to use in scaling the result
+          # @param decimal_places [Integer] The power of ten to use in scaling down the result
           # @return [Integer] an integer value
           def _6b_integer_scaled(start, length, decimal_places)
             _6b_integer(start, length).to_f / (10 ** decimal_places)
@@ -156,6 +156,75 @@ module NMEAPlus
           alias_method :_t, :_6b_string_nullterminated
           alias_method :_d, :_2b_data_string
 
+          # The ship cargo type description lookup table
+          # @param code [Integer] The cargo type id
+          # @return [String] Cargo type description
+          def get_ship_cargo_type_description(code)
+            case code
+            when 0 then return nil
+            when 1...19 then return "(future use)"
+            when 20 then return "WIG (any)"
+            when 21 then return "WIG Hazardous category A"
+            when 22 then return "WIG Hazardous category B"
+            when 23 then return "WIG Hazardous category C"
+            when 24 then return "WIG Hazardous category D"
+            when 25...29 then return "WIG (future use)"
+            when 30 then return "Fishing"
+            when 31 then return "Towing"
+            when 32 then return "Towing (large)"
+            when 33 then return "Dredging/underwater ops"
+            when 34 then return "Diving ops"
+            when 35 then return "Military ops"
+            when 36 then return "Sailing"
+            when 37 then return "Pleasure craft"
+            when 38, 39 then return "Reserved"
+            when 40 then return "High Speed Craft"
+            when 41 then return "HSC Hazardous category A"
+            when 42 then return "HSC Hazardous category B"
+            when 43 then return "HSC Hazardous category C"
+            when 44 then return "HSC Hazardous category D"
+            when 45...48 then return "HSC (reserved)"
+            when 49 then return "HSC (no additional information)"
+            when 50 then return "Pilot Vessel"
+            when 51 then return "Search and Rescue Vessel"
+            when 52 then return "Tug"
+            when 53 then return "Port Tender"
+            when 54 then return "Anti-pollution equipment"
+            when 55 then return "Law Enforcement"
+            when 56, 57 then return "Spare - Local Vessel"
+            when 58 then return "Medical Transport"
+            when 59 then return "Noncombatant ship according to RR Resolution No. 18"
+            when 60 then return "Passenger"
+            when 61 then return "Passenger, Hazardous category A"
+            when 62 then return "Passenger, Hazardous category B"
+            when 63 then return "Passenger, Hazardous category C"
+            when 64 then return "Passenger, Hazardous category D"
+            when 65..68 then return "Passenger, Reserved for future use"
+            when 69 then return "Passenger, No additional information"
+            when 70 then return "Cargo"
+            when 71 then return "Cargo, Hazardous category A"
+            when 72 then return "Cargo, Hazardous category B"
+            when 73 then return "Cargo, Hazardous category C"
+            when 74 then return "Cargo, Hazardous category D"
+            when 75..78 then return "Cargo, Reserved for future use"
+            when 79 then return "Cargo, No additional information"
+            when 80 then return "Tanker"
+            when 81 then return "Tanker, Hazardous category A"
+            when 82 then return "Tanker, Hazardous category B"
+            when 83 then return "Tanker, Hazardous category C"
+            when 84 then return "Tanker, Hazardous category D"
+            when 85.88 then return "Tanker, Reserved for future use"
+            when 89 then return "Tanker, No additional information"
+            when 90 then return "Other Type"
+            when 91 then return "Other Type, Hazardous category A"
+            when 92 then return "Other Type, Hazardous category B"
+            when 93 then return "Other Type, Hazardous category C"
+            when 94 then return "Other Type, Hazardous category D"
+            when 95..98 then return "Other Type, Reserved for future use"
+            when 99 then return "Other Type, no additional information"
+            end
+          end
+
         end
 
         # We haven't defined all the AIS payload types, so this is a catch-all

data/lib/nmea_plus/message/ais/vdm_payload/vdm_msg1.rb

@@ -12,6 +12,7 @@ module NMEAPlus
           # @!parse attr_reader :navigational_status_description
           # @return [String] the human-readable description of navigational status
           def navigational_status_description
+            return nil if navigational_status.nil?
             case navigational_status
             when 0 then return "Under way using engine"
             when 1 then return "At anchor"
@@ -68,8 +69,13 @@ module NMEAPlus
 
         end
 
+        # Position report class A, which is really {VDMMsgCNB}
         class VDMMsg1 < VDMMsgCNB; end
+
+        # Position report class A, which is really {VDMMsgCNB}
         class VDMMsg2 < VDMMsgCNB; end
+
+        # Position report class A, which is really {VDMMsgCNB}
         class VDMMsg3 < VDMMsgCNB; end
       end
     end

data/lib/nmea_plus/message/ais/vdm_payload/vdm_msg12.rb

@@ -0,0 +1,20 @@
+require_relative 'vdm_msg'
+
+module NMEAPlus
+  module Message
+    module AIS
+      module VDMPayload
+        # Type 12: Addressed Safety-Related Message
+        class VDMMsg12 < NMEAPlus::Message::AIS::VDMPayload::VDMMsg
+
+          payload_reader :sequence_number, 38, 2, :_u
+          payload_reader :destination_mmsi, 40, 30, :_u
+          payload_reader :retransmit?, 70, 1, :_b
+
+          # Safety message
+          payload_reader :text, 72, 936, :_t
+        end
+      end
+    end
+  end
+end

data/lib/nmea_plus/message/ais/vdm_payload/vdm_msg14.rb

@@ -0,0 +1,16 @@
+require_relative 'vdm_msg'
+
+module NMEAPlus
+  module Message
+    module AIS
+      module VDMPayload
+        # Type 14: Safety-Related Broadcast Message
+        class VDMMsg14 < NMEAPlus::Message::AIS::VDMPayload::VDMMsg
+
+          # Safety message
+          payload_reader :text, 40, 968, :_t
+        end
+      end
+    end
+  end
+end

data/lib/nmea_plus/message/ais/vdm_payload/vdm_msg18.rb

@@ -0,0 +1,75 @@
+require_relative 'vdm_msg'
+
+module NMEAPlus
+  module Message
+    module AIS
+      module VDMPayload
+
+        # Base class for "Class B CS Position Report" messages (18 and 19)
+        class VDMMsgClassBCSPosition < NMEAPlus::Message::AIS::VDMPayload::VDMMsg
+
+          payload_reader :speed_over_ground, 46, 10, :_U, 1
+          payload_reader :position_10m_accuracy?, 56, 1, :_b
+
+          # @!parse attr_reader :longitude
+          # @return [Float]
+          def longitude
+            _I(57, 28, 4) / 60
+          end
+
+          # @!parse attr_reader :latitude
+          # @return [Float]
+          def latitude
+            _U(85, 27, 4) / 60
+          end
+
+          payload_reader :course_over_ground, 112, 12, :_U, 1
+
+          # @!parse attr_reader :true_heading
+          # @return [Float]
+          def true_heading
+            ret = _u(124, 9)
+            return nil if ret == 511  # means "not available"
+            ret
+          end
+
+          payload_reader :time_stamp, 133, 6, :_u
+
+        end
+
+        # Type 18: Standard Class B CS Position Report
+        class VDMMsg18 < VDMMsgClassBCSPosition
+          payload_reader :cs_unit?, 141, 1, :_b
+          payload_reader :display?, 142, 1, :_b
+          payload_reader :dsc?, 143, 1, :_b
+          payload_reader :band?, 144, 1, :_b
+          payload_reader :accept_message_22?, 145, 1, :_b
+          payload_reader :assigned?, 146, 1, :_b
+          payload_reader :raim?, 147, 1, :_b
+        end
+
+        # Type 19: Extended Class B CS Position Report
+        class VDMMsg19 < VDMMsgClassBCSPosition
+          payload_reader :name, 143, 120, :_t
+          payload_reader :ship_cargo_type, 263, 8, :_e
+          payload_reader :ship_dimension_to_bow, 271, 9, :_u
+          payload_reader :ship_dimension_to_stern, 280, 9, :_u
+          payload_reader :ship_dimension_to_port, 289, 6, :_u
+          payload_reader :ship_dimension_to_starboard, 295, 6, :_u
+          payload_reader :epfd_type, 301, 4, :_e
+          payload_reader :raim?, 305, 1, :_b
+          payload_reader :dte?, 306, 1, :_b
+          payload_reader :assigned?, 307, 1, :_b
+
+          # @!parse attr_reader :ship_cargo_type_description
+          # @return [String] Cargo type description
+          def ship_cargo_type_description
+            get_ship_cargo_type_description(ship_cargo_type)
+          end
+
+        end
+
+      end
+    end
+  end
+end

data/lib/nmea_plus/message/ais/vdm_payload/vdm_msg21.rb

@@ -0,0 +1,45 @@
+require_relative 'vdm_msg'
+
+module NMEAPlus
+  module Message
+    module AIS
+      module VDMPayload
+        # Type 21: Aid-to-Navigation Report
+        class VDMMsg21 < NMEAPlus::Message::AIS::VDMPayload::VDMMsg
+
+          payload_reader :aid_type, 38, 5, :_e
+          payload_reader :name, 43, 120, :_t
+
+          payload_reader :position_10m_accuracy?, 163, 1, :_b
+
+          # @!parse attr_reader :longitude
+          # @return [Float]
+          def longitude
+            _I(164, 28, 4) / 60
+          end
+
+          # @!parse attr_reader :latitude
+          # @return [Float]
+          def latitude
+            _U(192, 27, 4) / 60
+          end
+
+          payload_reader :ship_dimension_to_bow, 219, 9, :_u
+          payload_reader :ship_dimension_to_stern, 228, 9, :_u
+          payload_reader :ship_dimension_to_port, 237, 6, :_u
+          payload_reader :ship_dimension_to_starboard, 243, 6, :_u
+          payload_reader :epfd_type, 249, 4, :_e
+          payload_reader :time_stamp, 253, 6, :_u
+          payload_reader :off_position?, 259, 1, :_b
+
+          payload_reader :raim?, 268, 1, :_b
+          payload_reader :virtual_aid?, 269, 1, :_b
+          payload_reader :assigned?, 270, 1, :_b
+
+          payload_reader :name_extension, 272, 88, :_t
+
+        end
+      end
+    end
+  end
+end

data/lib/nmea_plus/message/ais/vdm_payload/vdm_msg4.rb

@@ -0,0 +1,42 @@
+require_relative 'vdm_msg'
+
+module NMEAPlus
+  module Message
+    module AIS
+      module VDMPayload
+        # Type 4: Base Station Report
+        class VDMMsg4 < NMEAPlus::Message::AIS::VDMPayload::VDMMsg
+
+          # @!parse attr_reader :current_time
+          # @return [Time] current time
+          def current_time
+            Time.new(_u(38, 14),
+                     _u(52, 4),
+                     _u(56, 5),
+                     _u(61, 5),
+                     _u(66, 6),
+                     _u(72, 6))
+          end
+
+          payload_reader :position_10m_accuracy?, 78, 1, :_b
+
+          # @!parse attr_reader :longitude
+          # @return [Float]
+          def longitude
+            _I(79, 28, 4) / 60
+          end
+
+          # @!parse attr_reader :latitude
+          # @return [Float]
+          def latitude
+            _U(107, 27, 4) / 60
+          end
+
+          payload_reader :epfd_type, 134, 4, :_e
+          payload_reader :raim?, 148, 1, :_b
+
+        end
+      end
+    end
+  end
+end

data/lib/nmea_plus/message/ais/vdm_payload/vdm_msg5.rb

@@ -4,6 +4,7 @@ module NMEAPlus
   module Message
     module AIS
       module VDMPayload
+        # Type 5: Static and Voyage Related Data
         class VDMMsg5 < NMEAPlus::Message::AIS::VDMPayload::VDMMsg
 
           payload_reader :ais_version, 38, 2, :_u
@@ -17,6 +18,8 @@ module NMEAPlus
           payload_reader :ship_dimension_to_starboard, 264, 6, :_u
           payload_reader :epfd_type, 270, 4, :_e
 
+          # @!parse attr_reader :eta
+          # @return [Time] ETA
           def eta
             now = Time.now
             Time.new(now.year,
@@ -31,70 +34,10 @@ module NMEAPlus
           payload_reader :destination, 302, 120, :_t
           payload_reader :dte?, 422, 1, :_b
 
+          # @!parse attr_reader :ship_cargo_type_description
+          # @return [String] Cargo type description
           def ship_cargo_type_description
-            case ship_cargo_type
-            when 0 then return nil
-            when 1...19 then return "(future use)"
-            when 20 then return "WIG (any)"
-            when 21 then return "WIG Hazardous category A"
-            when 22 then return "WIG Hazardous category B"
-            when 23 then return "WIG Hazardous category C"
-            when 24 then return "WIG Hazardous category D"
-            when 25...29 then return "WIG (future use)"
-            when 30 then return "Fishing"
-            when 31 then return "Towing"
-            when 32 then return "Towing (large)"
-            when 33 then return "Dredging/underwater ops"
-            when 34 then return "Diving ops"
-            when 35 then return "Military ops"
-            when 36 then return "Sailing"
-            when 37 then return "Pleasure craft"
-            when 38, 39 then return "Reserved"
-            when 40 then return "High Speed Craft"
-            when 41 then return "HSC Hazardous category A"
-            when 42 then return "HSC Hazardous category B"
-            when 43 then return "HSC Hazardous category C"
-            when 44 then return "HSC Hazardous category D"
-            when 45...48 then return "HSC (reserved)"
-            when 49 then return "HSC (no additional information)"
-            when 50 then return "Pilot Vessel"
-            when 51 then return "Search and Rescue Vessel"
-            when 52 then return "Tug"
-            when 53 then return "Port Tender"
-            when 54 then return "Anti-pollution equipment"
-            when 55 then return "Law Enforcement"
-            when 56, 57 then return "Spare - Local Vessel"
-            when 58 then return "Medical Transport"
-            when 59 then return "Noncombatant ship according to RR Resolution No. 18"
-            when 60 then return "Passenger"
-            when 61 then return "Passenger, Hazardous category A"
-            when 62 then return "Passenger, Hazardous category B"
-            when 63 then return "Passenger, Hazardous category C"
-            when 64 then return "Passenger, Hazardous category D"
-            when 65..68 then return "Passenger, Reserved for future use"
-            when 69 then return "Passenger, No additional information"
-            when 70 then return "Cargo"
-            when 71 then return "Cargo, Hazardous category A"
-            when 72 then return "Cargo, Hazardous category B"
-            when 73 then return "Cargo, Hazardous category C"
-            when 74 then return "Cargo, Hazardous category D"
-            when 75..78 then return "Cargo, Reserved for future use"
-            when 79 then return "Cargo, No additional information"
-            when 80 then return "Tanker"
-            when 81 then return "Tanker, Hazardous category A"
-            when 82 then return "Tanker, Hazardous category B"
-            when 83 then return "Tanker, Hazardous category C"
-            when 84 then return "Tanker, Hazardous category D"
-            when 85.88 then return "Tanker, Reserved for future use"
-            when 89 then return "Tanker, No additional information"
-            when 90 then return "Other Type"
-            when 91 then return "Other Type, Hazardous category A"
-            when 92 then return "Other Type, Hazardous category B"
-            when 93 then return "Other Type, Hazardous category C"
-            when 94 then return "Other Type, Hazardous category D"
-            when 95..98 then return "Other Type, Reserved for future use"
-            when 99 then return "Other Type, no additional information"
-            end
+            get_ship_cargo_type_description(ship_cargo_type)
           end
 
         end

data/lib/nmea_plus/message/ais/vdm_payload/vdm_msg8.rb

@@ -4,6 +4,7 @@ module NMEAPlus
   module Message
     module AIS
       module VDMPayload
+        # Type 8: Binary Broadcast Message
         class VDMMsg8 < NMEAPlus::Message::AIS::VDMPayload::VDMMsg
           payload_reader :designated_area_code, 40, 10, :_u
           payload_reader :functional_id, 50, 6, :_u
@@ -11,33 +12,6 @@ module NMEAPlus
           payload_reader :application_data_6b, 56, 952, :_6b_string
           payload_reader :application_data_8b, 56, 952, :_8b_data_string
 
-          payload_reader :ais_version, 38, 2, :_u
-          payload_reader :imo_number, 40, 30, :_u
-          payload_reader :callsign, 70, 42, :_t
-          payload_reader :name, 112, 120, :_t
-          payload_reader :ship_cargo_type, 232, 8, :_e
-          payload_reader :ship_dimension_to_bow, 240, 9, :_u
-          payload_reader :ship_dimension_to_stern, 249, 9, :_u
-          payload_reader :ship_dimension_to_port, 258, 6, :_u
-          payload_reader :ship_dimension_to_starboard, 264, 6, :_u
-          payload_reader :epfd_type, 270, 4, :_e
-
-          # @!parse attr_reader :eta
-          # @return [Time]
-          def eta
-            now = Time.now
-            Time.new(now.year,
-                     _u(274, 4),
-                     _u(278, 5),
-                     _u(283, 5),
-                     _u(288, 6),
-                     0)
-          end
-
-          payload_reader :static_draught, 294, 8, :_U, 1
-          payload_reader :destination, 302, 120, :_t
-          payload_reader :dte?, 422, 1, :_b
-
         end
       end
     end

data/lib/nmea_plus/message/ais/vdm_payload/vdm_msg9.rb

@@ -0,0 +1,38 @@
+require_relative 'vdm_msg'
+
+module NMEAPlus
+  module Message
+    module AIS
+      module VDMPayload
+        # Type 9: Standard SAR Aircraft Position Report
+        class VDMMsg9 < NMEAPlus::Message::AIS::VDMPayload::VDMMsg
+
+          payload_reader :altitude_meters, 38, 12, :_u
+
+          payload_reader :speed_over_ground, 50, 10, :_U, 1
+          payload_reader :position_10m_accuracy?, 60, 1, :_b
+
+          # @!parse attr_reader :longitude
+          # @return [Float]
+          def longitude
+            _I(61, 28, 4) / 60
+          end
+
+          # @!parse attr_reader :latitude
+          # @return [Float]
+          def latitude
+            _U(89, 27, 4) / 60
+          end
+
+          payload_reader :course_over_ground, 116, 12, :_U, 1
+          payload_reader :time_stamp, 128, 6, :_u
+          payload_reader :dte?, 142, 1, :_b
+
+          payload_reader :assigned?, 146, 1, :_b
+          payload_reader :raim?, 147, 1, :_b
+
+        end
+      end
+    end
+  end
+end

data/lib/nmea_plus/version.rb

@@ -1,3 +1,3 @@
 module NMEAPlus
-  VERSION = '1.0.5'
+  VERSION = '1.0.6'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: nmea_plus
 version: !ruby/object:Gem::Version
-  version: 1.0.5
+  version: 1.0.6
 platform: ruby
 authors:
 - Ian Katz
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-12-01 00:00:00.000000000 Z
+date: 2015-12-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: racc
@@ -198,8 +198,14 @@ files:
 - lib/nmea_plus/message/ais/vdm.rb
 - lib/nmea_plus/message/ais/vdm_payload/vdm_msg.rb
 - lib/nmea_plus/message/ais/vdm_payload/vdm_msg1.rb
+- lib/nmea_plus/message/ais/vdm_payload/vdm_msg12.rb
+- lib/nmea_plus/message/ais/vdm_payload/vdm_msg14.rb
+- lib/nmea_plus/message/ais/vdm_payload/vdm_msg18.rb
+- lib/nmea_plus/message/ais/vdm_payload/vdm_msg21.rb
+- lib/nmea_plus/message/ais/vdm_payload/vdm_msg4.rb
 - lib/nmea_plus/message/ais/vdm_payload/vdm_msg5.rb
 - lib/nmea_plus/message/ais/vdm_payload/vdm_msg8.rb
+- lib/nmea_plus/message/ais/vdm_payload/vdm_msg9.rb
 - lib/nmea_plus/message/base.rb
 - lib/nmea_plus/message/nmea/aam.rb
 - lib/nmea_plus/message/nmea/alm.rb