nmea_plus 1.0.9 → 1.0.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8b9332e5d45ba59ff6572c20801c15205fcfc674
-  data.tar.gz: ddc8d5117a0b4c4774eb5ffe552b07a1ce2873ed
+  metadata.gz: 4995804e2eba3842192e6ca02309efe1867b439a
+  data.tar.gz: ff77b5f6dee8dc838fd7a62c321c0655f4c81033
 SHA512:
-  metadata.gz: 4163c6ee8e9d1ba684cd30f18a94e4d8b42b11c5401a23c57ff0d82b27ce18b9b0ce2a21090e95f9fe96316bda9034f4224ae1b0d12176e75b90309f4369e09b
-  data.tar.gz: 538f7e47902a954c116d1c7d630c51b32a821b5d2cdc1b95e54ad9148ddb3e4b6ef2546b550bda734680e6f0da806d0bf3a87edc947d67ebdc47f1b2ce2d15d5
+  metadata.gz: c0354acd88c7ca3c349d12d6be23e127ec8468e3db846eb99156ce8a15be2b6f461a60d3cd4473542f0ce6303ebdd6f15dcbcc8ac1aa9c0c27f6306843cf88a3
+  data.tar.gz: fdbdb7dfbbc1164242a9226d0d19583f25180141b554db6681c4573219039a9a7fa0ec4198b1684dea6f8d47b86e9ea90935b2dbcd39a2a6cbfac434bda0f4ad

data/.yardopts

@@ -1 +1 @@
-lib/nmea_plus.rb lib/nmea_plus/message/nmea/base_nmea.rb lib/nmea_plus/message/ais/vdm_payload/vdm_msg.rb lib/**/*.rb
+lib/nmea_plus.rb lib/nmea_plus/message/nmea/base_nmea.rb lib/nmea_plus/message/ais/vdm_payload/payload.rb lib/nmea_plus/message/ais/vdm_payload/*_dynamic_payload.rb lib/nmea_plus/message/ais/vdm_payload/subarea.rb lib/**/*.rb

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://www.rubydoc.info/gems/nmea_plus/1.0.9)
+[![Documentation](http://img.shields.io/badge/docs-rdoc.info-blue.svg)](http://www.rubydoc.info/gems/nmea_plus/1.0.10)
 
 [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.
 
@@ -89,7 +89,7 @@ end
 This gem was coded to accept the standard NMEA messages defined in the unoffical spec found here:
 http://www.catb.org/gpsd/NMEA.txt
 
-Because the message types are standard, if no override is found for a particular talker ID then the message will parse according to the command (the last 3 characters) of the data type.  In other words, $GPGLL will use the general GLL message type.  Currently, the following standard message types are supported:
+Because the message types are standard, if no override is found for a particular talker ID then the message will parse according to the command (the last 3 characters) of the data type.  In other words, `$GPGLL` will use the general `GLL` message type.  Currently, the following standard message types are supported:
 
 > AAM, ALM, APA, APB, BOD, BWC, BWR, BWW, DBK, DBS, DBT, DCN, DPT, DTM, FSI, GBS, GGA, GLC, GLL, GNS, GRS, GSA, GST, GSV, GTD, GXA, HDG, HDM, HDT, HFB, HSC, ITS, LCD, MSK, MSS, MTW, MWV, OLN, OSD, R00, RMA, RMB, RMC, ROT, RPM, RSA, RSD, RTE, SFI, STN, TDS, TFI, TPC, TPR, TPT, TRF, TTM, VBW, VDR, VHW, VLW, VPW, VTG, VWR, WCV, WNC, WPL, XDR, XTE, XTR, ZDA, ZFO, ZTG
 
@@ -101,18 +101,18 @@ Support for proprietary NMEA messages is also possible.  PASHR is included as pr
 AIS message type definitions were implemented from the unofficial spec found here:
 http://catb.org/gpsd/AIVDM.html
 
-The AIS payload can be found in the AIVDM message's payload field.  Currently, the following AIS message types are supported:
+The AIS payload can be found in the payload field of a `VDM` message (aka `!AIVDM`, `!ABVDM`, `!SAVDM`).  Currently, the following AIS message types are supported:
 
 > 1, 2, 3, 4, 5, 6, 7, 8, 9, 11, 12, 13, 14, 18, 19, 20, 21, 24, 27
 
 > Type 6 subtypes for DAC/FID: 235/10, 1022/61
 
-> Type 8 subtypes for DAC/FID: 1/31, 366/56, 366/57
+> Type 8 subtypes for DAC/FID: 1/22, 1/31, 366/56, 366/57
 
 
 ## Disclaimer
 
-This module was written from information scraped together on the web, not from testing on actual devices.  A lack of test cases -- especially for more obscure message types -- is a barrier to completeness.  Please don't entrust your life or the safety of a ship to this code without doing your own rigorous testing.
+This module was written primarily from information scraped together on the web, with minimal testing on an actual device (an SR161 AIS receiver).  A lack of test cases -- especially for more obscure message types -- is a barrier to completeness.  Please don't entrust your life or the safety of a ship to this code without doing your own rigorous testing.
 
 
 ## Author

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

@@ -2,6 +2,9 @@
 module NMEAPlus
   module Message
     module AIS
+
+      # This module contains all the VDM payload types and subtypes.
+      # @see VDMMsg
       module VDMPayload
         # Basic tools for interpreting the armored (binary) payload encoding of AIS.
         # This class provides convenience functions for accessing the fields as the appropriate data type,

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

@@ -0,0 +1,140 @@
+
+module NMEAPlus
+  module Message
+    module AIS
+      module VDMPayload
+        # A sub-structure in a payload: 87 bits describing a shape
+        class SubArea < Payload
+
+          payload_reader :shape_id, 0, 3, :_e
+
+          # @!parse attr_reader :shape_description
+          # @return [String] Shape description
+          def shape_description
+            case shape_id
+            when 0 then "Circle or point"
+            when 1 then "Rectangle"
+            when 2 then "Sector"
+            when 3 then "Polyline"
+            when 4 then "Polygon"
+            when 5 then "Associated text"
+            when 6, 7 then "Reserved"
+            end
+          end
+
+        end
+
+        # Catch-all for undefined shape IDs
+        class SubAreaUndefined < SubArea; end
+
+        # SubArea structure base type for a region with scale
+        class SubAreaScaled < SubArea
+          payload_reader :scale_factor, 3, 2, :_u
+
+          # @!parse attr_reader :scale_meters
+          # @return [Integer] Scale factor represented in meters to multiply by
+          def scale_meters
+            10**scale_factor
+          end
+        end
+
+        # SubArea structure base type for a region anchored to a point
+        class SubAreaAnchored < SubAreaScaled
+          payload_reader :longitude, 5, 25, :_I, 60 * 10**3, 181
+          payload_reader :latitude, 30, 24, :_I, 60 * 10**3, 91
+          payload_reader :precision, 54, 3, :_u
+        end
+
+        # SubArea structure type 0: Circle or point
+        class SubArea0 < SubAreaAnchored
+          payload_reader :radius, 57, 12, :_u
+
+          # @!parse attr_reader :radius_meters
+          # @return [Integer] Radius in meters, according to scale factor
+          def radius_meters
+            radius * scale_meters
+          end
+        end
+
+        # SubArea structure type 1: Rectangle
+        class SubArea1 < SubAreaAnchored
+          payload_reader :dimension_east, 57, 8, :_u
+          payload_reader :dimension_north, 65, 8, :_u
+
+          payload_reader :orientation, 73, 9, :_u
+
+          # @!parse attr_reader :dimension_east_meters
+          # @return [Integer] Box dimension in meters, according to scale factor
+          def dimension_east_meters
+            dimension_east * scale_meters
+          end
+
+          # @!parse attr_reader :dimension_east_meters
+          # @return [Integer] Box dimension in meters, according to scale factor
+          def dimension_north_meters
+            dimension_north * scale_meters
+          end
+        end
+
+        # SubArea structure type 2: Sector
+        class SubArea2 < SubAreaAnchored
+          payload_reader :radius, 57, 12, :_u
+          payload_reader :boundary_left, 69, 9, :_u
+          payload_reader :boundary_right, 78, 9, :_u
+
+          # @!parse attr_reader :radius_meters
+          # @return [Integer] Radius in meters, according to scale factor
+          def radius_meters
+            radius * scale_meters
+          end
+
+        end
+
+        # SubArea structure type 3: Polyline
+        class SubArea3 < SubAreaScaled
+
+          payload_reader :bearing1, 5, 10, :_u, 720
+          payload_reader :distance1, 15, 10, :_u
+          payload_reader :bearing2, 25, 10, :_u, 720
+          payload_reader :distance2, 35, 10, :_u
+          payload_reader :bearing3, 45, 10, :_u, 720
+          payload_reader :distance3, 55, 10, :_u
+          payload_reader :bearing4, 65, 10, :_u, 720
+          payload_reader :distance4, 75, 10, :_u
+
+          class ShapePoint
+            attr_accessor :bearing
+            attr_accessor :distance
+            attr_accessor :distance_meters
+          end
+
+          # @!parse attr_reader :points
+          # @return [Array] Array of points
+          def points
+            ret = []
+
+            # load up from existing properties
+            (1..4).each do |i|
+              d = send("distance#{i}")
+              sp = ShapePoint.new
+              sp.bearing = send("bearing#{i}")
+              sp.distance = d
+              sp.distance_meters = d * scale_meters
+              ret << sp
+            end
+            ret
+          end
+        end
+
+        # SubArea structure type 4: Polygon
+        class SubArea4 < SubArea3; end
+
+        # SubArea structure type 5: Associated text
+        class SubArea5 < SubArea
+          payload_reader :text, 3, 84, :_t
+        end
+
+      end
+    end
+  end
+end

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

@@ -3,8 +3,6 @@ require_relative "payload"
 module NMEAPlus
   module Message
     module AIS
-      # This module contains all the VDM payload types and subtypes.
-      # @see {VDMMsg}
       module VDMPayload
 
         # The base class for the {NMEAPlus::Message::AIS::VDM#ais AIS payload}, which uses its own encoding for its own subtypes

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

@@ -19,7 +19,7 @@ module NMEAPlus
           # Dynamic Payload containing fields for the appropriate message 6 subtype.
           # This is a factory method for the container class
           # @!parse attr_reader :dp
-          # @return [VDMPayload::VDMMsg::VDMMsg8DynamicPayload]
+          # @return [VDMMsg6DynamicPayload]
           def dp
             ret = _dynamic_payload_container
             ret.payload_bitstring = payload_bitstring
@@ -34,21 +34,10 @@ module NMEAPlus
             ret = _object_by_name(class_identifier)
             return ret unless ret.nil?
 
-            _object_by_name("NMEAPlus::Message::AIS::VDMPayload::VDMMsg8Undefined") # generic
+            _object_by_name("NMEAPlus::Message::AIS::VDMPayload::VDMMsg6Undefined") # generic
           end
 
         end
-
-        # Base class for dynamic payloads (subtypes) of AIS VDM message 6
-        class VDMMsg6DynamicPayload < NMEAPlus::Message::AIS::VDMPayload::Payload; end
-
-        # Placeholder for undefined message 8 payload subtypes
-        class VDMMsg6Undefined < NMEAPlus::Message::AIS::VDMPayload::VDMMsg6DynamicPayload
-          payload_reader :application_data_2b, 56, 952, :_d
-          payload_reader :application_data_6b, 56, 952, :_6b_string
-          payload_reader :application_data_8b, 56, 952, :_8b_data_string
-        end
-
       end
     end
   end

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

@@ -0,0 +1,21 @@
+require_relative 'payload'
+
+module NMEAPlus
+  module Message
+    module AIS
+      module VDMPayload
+
+        # Base class for dynamic payloads (subtypes) of AIS VDM message 6
+        class VDMMsg6DynamicPayload < NMEAPlus::Message::AIS::VDMPayload::Payload; end
+
+        # Placeholder for undefined message 6 payload subtypes
+        class VDMMsg6Undefined < NMEAPlus::Message::AIS::VDMPayload::VDMMsg6DynamicPayload
+          payload_reader :application_data_2b, 56, 952, :_d
+          payload_reader :application_data_6b, 56, 952, :_6b_string
+          payload_reader :application_data_8b, 56, 952, :_8b_data_string
+        end
+
+      end
+    end
+  end
+end

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

@@ -1,4 +1,4 @@
-require_relative 'vdm_msg'
+require_relative 'vdm_msg6_dynamic_payload'
 
 module NMEAPlus
   module Message
@@ -7,7 +7,7 @@ module NMEAPlus
 
         # Type 6: Binary Addressed Message Subtype: Sealite SL125 Lantern or 155 Apollo Lantern
         # This message has an ascii CSV payload wrapped in an armored AIS payload, wrapped in the NMEA CSV payload.
-        class VDMMsg6d1022f61 < NMEAPlus::Message::AIS::VDMPayload::VDMMsg
+        class VDMMsg6d1022f61 < NMEAPlus::Message::AIS::VDMPayload::VDMMsg6DynamicPayload
 
           def initialize
             super

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

@@ -1,4 +1,4 @@
-require_relative 'vdm_msg'
+require_relative 'vdm_msg6_dynamic_payload'
 
 module NMEAPlus
   module Message
@@ -6,7 +6,7 @@ module NMEAPlus
       module VDMPayload
 
         # Type 6: Binary Addressed Message Subtype: GLA Aid to Navigation Monitoring Data
-        class VDMMsg6d235f10 < NMEAPlus::Message::AIS::VDMPayload::VDMMsg
+        class VDMMsg6d235f10 < NMEAPlus::Message::AIS::VDMPayload::VDMMsg6DynamicPayload
 
           payload_reader :analog_internal, 88, 10, :_U, 20, 0
           payload_reader :analog_external1, 98, 10, :_U, 20, 0

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

@@ -1,4 +1,5 @@
 require_relative 'vdm_msg'
+require_relative 'vdm_msg8d1f22'
 require_relative 'vdm_msg8d1f31'
 require_relative 'vdm_msg8d366f56'
 
@@ -16,7 +17,7 @@ module NMEAPlus
           # Dynamic Payload containing fields for the appropriate message 8 subtype.
           # This is a factory method for the container class
           # @!parse attr_reader :dp
-          # @return [VDMPayload::VDMMsg::VDMMsg8DynamicPayload]
+          # @return [VDMMsg8DynamicPayload]
           def dp
             ret = _dynamic_payload_container
             ret.payload_bitstring = payload_bitstring
@@ -26,6 +27,7 @@ module NMEAPlus
 
           # Dynamically calculate what message subtype to use
           # which depends on the designated_area_code and functional_id
+          # @private
           def _dynamic_payload_container
             class_identifier = "NMEAPlus::Message::AIS::VDMPayload::VDMMsg8d#{designated_area_code}f#{functional_id}"
             ret = _object_by_name(class_identifier)
@@ -42,17 +44,6 @@ module NMEAPlus
           end
 
         end
-
-        # Base class for {VDMMsg8#dp dynamic payload}s (subtypes) of {VDMMsg8 AIS VDM message 8}
-        class VDMMsg8DynamicPayload < NMEAPlus::Message::AIS::VDMPayload::Payload; end
-
-        # Placeholder for undefined message 8 payload subtypes
-        class VDMMsg8Undefined < NMEAPlus::Message::AIS::VDMPayload::VDMMsg8DynamicPayload
-          payload_reader :application_data_2b, 56, 952, :_d
-          payload_reader :application_data_6b, 56, 952, :_6b_string
-          payload_reader :application_data_8b, 56, 952, :_8b_data_string
-        end
-
       end
     end
   end

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

@@ -0,0 +1,21 @@
+require_relative 'payload'
+
+module NMEAPlus
+  module Message
+    module AIS
+      module VDMPayload
+
+        # Base class for {VDMMsg8#dp dynamic payload}s (subtypes) of {VDMMsg8 AIS VDM message 8}
+        class VDMMsg8DynamicPayload < NMEAPlus::Message::AIS::VDMPayload::Payload; end
+
+        # Placeholder for undefined message 8 payload subtypes
+        class VDMMsg8Undefined < VDMMsg8DynamicPayload
+          payload_reader :application_data_2b, 56, 952, :_d
+          payload_reader :application_data_6b, 56, 952, :_6b_string
+          payload_reader :application_data_8b, 56, 952, :_8b_data_string
+        end
+
+      end
+    end
+  end
+end

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

@@ -0,0 +1,210 @@
+require_relative 'vdm_msg8_dynamic_payload'
+require_relative 'sub_area'
+
+module NMEAPlus
+  module Message
+    module AIS
+      module VDMPayload
+        # Type 8: Binary Broadcast Message Subtype: Area Notice (addressed)
+        class VDMMsg8d1f22 < NMEAPlus::Message::AIS::VDMPayload::VDMMsg8DynamicPayload
+
+          def initialize
+            super
+            @sub_areas = []
+          end
+
+          def payload_bitstring=(val)
+            # Override default bitstring setting to dynamically calculate what SubArea fields belong in this message
+            super
+
+            @sub_areas = []
+            (111...val.length).step(87).each do |pos|
+              shape_id = _u(pos, 3)  # 3 bits at the beginning form the shape ID
+              container = _dynamic_subarea_container(shape_id)
+              container.payload_bitstring = payload_bitstring[pos..(pos + 87)]
+              @sub_areas << container
+            end
+          end
+
+          # Dynamically calculate what subarea type to use
+          # which depends on the designated_area_code and functional_id
+          # @private
+          def _dynamic_subarea_container(shape_id)
+            class_identifier = "NMEAPlus::Message::AIS::VDMPayload::SubArea#{shape_id}"
+            ret = _object_by_name(class_identifier)
+            return ret unless ret.nil?
+
+            _object_by_name("NMEAPlus::Message::AIS::VDMPayload::SubAreaUndefined") # generic
+          end
+
+          payload_reader :linkage_id, 56, 10, :_u
+          payload_reader :notice_id, 66, 7, :_u
+
+          # @!parse attr_reader :notice_description
+          # @return [String] Area notice description
+          def notice_description
+            case notice_id
+            when 0 then "Caution Area: Marine mammals habitat"
+            when 1 then "Caution Area: Marine mammals in area - reduce speed"
+            when 2 then "Caution Area: Marine mammals in area - stay clear"
+            when 3 then "Caution Area: Marine mammals in area - report sightings"
+            when 4 then "Caution Area: Protected habitat - reduce speed"
+            when 5 then "Caution Area: Protected habitat - stay clear"
+            when 6 then "Caution Area: Protected habitat - no fishing or anchoring"
+            when 7 then "Caution Area: Derelicts (drifting objects)"
+            when 8 then "Caution Area: Traffic congestion"
+            when 9 then "Caution Area: Marine event"
+            when 10 then "Caution Area: Divers down"
+            when 11 then "Caution Area: Swim area"
+            when 12 then "Caution Area: Dredge operations"
+            when 13 then "Caution Area: Survey operations"
+            when 14 then "Caution Area: Underwater operation"
+            when 15 then "Caution Area: Seaplane operations"
+            when 16 then "Caution Area: Fishery - nets in water"
+            when 17 then "Caution Area: Cluster of fishing vessels"
+            when 18 then "Caution Area: Fairway closed"
+            when 19 then "Caution Area: Harbour closed"
+            when 20 then "Caution Area: Risk (define in associated text field)"
+            when 21 then "Caution Area: Underwater vehicle operation"
+            when 22 then "(reserved for future use)"
+            when 23 then "Environmental Caution Area: Storm front (line squall)"
+            when 24 then "Environmental Caution Area: Hazardous sea ice"
+            when 25 then "Environmental Caution Area: Storm warning (storm cell or line of storms)"
+            when 26 then "Environmental Caution Area: High wind"
+            when 27 then "Environmental Caution Area: High waves"
+            when 28 then "Environmental Caution Area: Restricted visibility (fog, rain, etc.)"
+            when 29 then "Environmental Caution Area: Strong currents"
+            when 30 then "Environmental Caution Area: Heavy icing"
+            when 31 then "(reserved for future use)"
+            when 32 then "Restricted Area: Fishing prohibited"
+            when 33 then "Restricted Area: No anchoring."
+            when 34 then "Restricted Area: Entry approval required prior to transit"
+            when 35 then "Restricted Area: Entry prohibited"
+            when 36 then "Restricted Area: Active military OPAREA"
+            when 37 then "Restricted Area: Firing - danger area."
+            when 38 then "Restricted Area: Drifting Mines"
+            when 39 then "(reserved for future use)"
+            when 40 then "Anchorage Area: Anchorage open"
+            when 41 then "Anchorage Area: Anchorage closed"
+            when 42 then "Anchorage Area: Anchorage prohibited"
+            when 43 then "Anchorage Area: Deep draft anchorage"
+            when 44 then "Anchorage Area: Shallow draft anchorage"
+            when 45 then "Anchorage Area: Vessel transfer operations"
+            when 46 then "(reserved for future use)"
+            when 47 then "(reserved for future use)"
+            when 48 then "(reserved for future use)"
+            when 49 then "(reserved for future use)"
+            when 50 then "(reserved for future use)"
+            when 51 then "(reserved for future use)"
+            when 52 then "(reserved for future use)"
+            when 53 then "(reserved for future use)"
+            when 54 then "(reserved for future use)"
+            when 55 then "(reserved for future use)"
+            when 56 then "Security Alert - Level 1"
+            when 57 then "Security Alert - Level 2"
+            when 57 then "Security Alert - Level 3"
+            when 59 then "(reserved for future use)"
+            when 60 then "(reserved for future use)"
+            when 61 then "(reserved for future use)"
+            when 62 then "(reserved for future use)"
+            when 63 then "(reserved for future use)"
+            when 64 then "Distress Area: Vessel disabled and adrift"
+            when 65 then "Distress Area: Vessel sinking"
+            when 66 then "Distress Area: Vessel abandoning ship"
+            when 67 then "Distress Area: Vessel requests medical assistance"
+            when 68 then "Distress Area: Vessel flooding"
+            when 69 then "Distress Area: Vessel fire/explosion"
+            when 70 then "Distress Area: Vessel grounding"
+            when 71 then "Distress Area: Vessel collision"
+            when 72 then "Distress Area: Vessel listing/capsizing"
+            when 73 then "Distress Area: Vessel under assault"
+            when 74 then "Distress Area: Person overboard"
+            when 75 then "Distress Area: SAR area"
+            when 76 then "Distress Area: Pollution response area"
+            when 77 then "(reserved for future use)"
+            when 78 then "(reserved for future use)"
+            when 79 then "(reserved for future use)"
+            when 80 then "Instruction: Contact VTS at this point/juncture"
+            when 81 then "Instruction: Contact Port Administration at this point/juncture"
+            when 82 then "Instruction: Do not proceed beyond this point/juncture"
+            when 83 then "Instruction: Await instructions prior to proceeding beyond this point/juncture"
+            when 84 then "Proceed to this location - await instructions"
+            when 85 then "Clearance granted - proceed to berth"
+            when 86 then "(reserved for future use)"
+            when 87 then "(reserved for future use)"
+            when 88 then "Information: Pilot boarding position"
+            when 89 then "Information: Icebreaker waiting area"
+            when 90 then "Information: Places of refuge"
+            when 91 then "Information: Position of icebreakers"
+            when 92 then "Information: Location of response units"
+            when 93 then "VTS active target"
+            when 94 then "Rogue or suspicious vessel"
+            when 95 then "Vessel requesting non-distress assistance"
+            when 96 then "Chart Feature: Sunken vessel"
+            when 97 then "Chart Feature: Submerged object"
+            when 98 then "Chart Feature:Semi-submerged object"
+            when 99 then "Chart Feature: Shoal area"
+            when 100 then "Chart Feature: Shoal area due north"
+            when 101 then "Chart Feature: Shoal area due east"
+            when 102 then "Chart Feature: Shoal area due south"
+            when 103 then "Chart Feature: Shoal area due west"
+            when 104 then "Chart Feature: Channel obstruction"
+            when 105 then "Chart Feature: Reduced vertical clearance"
+            when 106 then "Chart Feature: Bridge closed"
+            when 107 then "Chart Feature: Bridge partially open"
+            when 108 then "Chart Feature: Bridge fully open"
+            when 109 then "(reserved for future use)"
+            when 110 then "(reserved for future use)"
+            when 111 then "(reserved for future use)"
+            when 112 then "Report from ship: Icing info"
+            when 113 then "(reserved for future use)"
+            when 114 then "Report from ship: Miscellaneous information - define in associated text field"
+            when 115 then "(reserved for future use)"
+            when 116 then "(reserved for future use)"
+            when 117 then "(reserved for future use)"
+            when 118 then "(reserved for future use)"
+            when 119 then "(reserved for future use)"
+            when 120 then "Route: Recommended route"
+            when 121 then "Route: Alternative route"
+            when 122 then "Route: Recommended route through ice"
+            when 123 then "(reserved for future use)"
+            when 124 then "(reserved for future use)"
+            when 125 then "Other - Define in associated text field"
+            when 126 then "Cancellation - cancel area as identified by Message Linkage ID"
+            when 127 then "Undefined (default)"
+            end
+          end
+
+          # @!parse attr_reader :utc_time
+          # @return [Time] utc time
+          def utc_time
+            now = Time.now
+            month = _u(73, 4)
+            day = _u(77, 5)
+            hour = _u(82, 5)
+            minute = _u(87, 6)
+            return nil if 0 == month
+            return nil if 24 == hour
+            return nil if 60 == minute
+            Time.new(now.year, month, day, hour, minute, 0)
+          end
+
+          payload_reader :duration, 93, 18, :_u, 262_143
+
+          # Sub-areas defined by this message
+          # @return [Array] An array of {SubArea} objects
+          attr_accessor :sub_areas
+
+          # @!parse attr_reader :sub_area_text
+          # @return [String] The concatenated text of all subarea texts
+          def sub_area_text
+            texts = sub_areas.select { |a| a.shape_id == 5 }
+            return nil if texts.empty?
+            texts.collect(&:text).join
+          end
+
+        end
+      end
+    end
+  end
+end

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

@@ -1,11 +1,11 @@
-require_relative 'vdm_msg'
+require_relative 'vdm_msg8_dynamic_payload'
 
 module NMEAPlus
   module Message
     module AIS
       module VDMPayload
         # Type 8: Binary Broadcast Message Subtype: Meteorological and Hydrological Data (IMO289)
-        class VDMMsg8d1f31 < NMEAPlus::Message::AIS::VDMPayload::VDMMsg
+        class VDMMsg8d1f31 < NMEAPlus::Message::AIS::VDMPayload::VDMMsg8DynamicPayload
 
           payload_reader :longitude, 56, 25, :_I, 60 * 10**3, 181
           payload_reader :latitude, 81, 24, :_I, 60 * 10**3, 91

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

@@ -1,28 +1,25 @@
-require_relative 'vdm_msg'
+require_relative 'vdm_msg8_dynamic_payload'
 
 module NMEAPlus
   module Message
     module AIS
       module VDMPayload
-        class VDMMsg8USCGEncrypted < NMEAPlus::Message::AIS::VDMPayload::VDMMsg
+
+        # Basic decoding of "blue force" encrypted binary messages.
+        # Note that this module is incapable of decrypting the messages. It can only deocde and return
+        # the encrypted payload to be decrypted elsewhere.
+        class VDMMsg8USCGEncrypted < VDMMsg8DynamicPayload
           payload_reader :encrypted_data_2b, 56, 952, :_d
           payload_reader :encrypted_data_6b, 56, 952, :_6b_string
           payload_reader :encrypted_data_8b, 56, 952, :_8b_data_string
         end
 
         # Type 8: Binary Broadcast Message Subtype: US Coast Guard (USCG) blue force encrypted position report
-        class VDMMsg8d366f56 < VDMMsg8USCGEncrypted
-          payload_reader :encrypted_data_2b, 56, 952, :_d
-          payload_reader :encrypted_data_6b, 56, 952, :_6b_string
-          payload_reader :encrypted_data_8b, 56, 952, :_8b_data_string
-        end
+        class VDMMsg8d366f56 < VDMMsg8USCGEncrypted; end
 
         # Type 8: Binary Broadcast Message Subtype: US Coast Guard (USCG) blue force encrypted data
-        class VDMMsg8d366f57 < VDMMsg8USCGEncrypted
-          payload_reader :encrypted_data_2b, 56, 952, :_d
-          payload_reader :encrypted_data_6b, 56, 952, :_6b_string
-          payload_reader :encrypted_data_8b, 56, 952, :_8b_data_string
-        end
+        class VDMMsg8d366f57 < VDMMsg8USCGEncrypted; end
+
       end
     end
   end

data/lib/nmea_plus/version.rb

@@ -1,3 +1,3 @@
 module NMEAPlus
-  VERSION = '1.0.9'
+  VERSION = '1.0.10'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: nmea_plus
 version: !ruby/object:Gem::Version
-  version: 1.0.9
+  version: 1.0.10
 platform: ruby
 authors:
 - Ian Katz
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-01-13 00:00:00.000000000 Z
+date: 2016-01-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: racc
@@ -197,6 +197,7 @@ files:
 - lib/nmea_plus/message/ais/base_ais.rb
 - lib/nmea_plus/message/ais/vdm.rb
 - lib/nmea_plus/message/ais/vdm_payload/payload.rb
+- lib/nmea_plus/message/ais/vdm_payload/sub_area.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
@@ -209,10 +210,13 @@ files:
 - 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_msg6.rb
+- lib/nmea_plus/message/ais/vdm_payload/vdm_msg6_dynamic_payload.rb
 - lib/nmea_plus/message/ais/vdm_payload/vdm_msg6d1022f61.rb
 - lib/nmea_plus/message/ais/vdm_payload/vdm_msg6d235f10.rb
 - lib/nmea_plus/message/ais/vdm_payload/vdm_msg7.rb
 - lib/nmea_plus/message/ais/vdm_payload/vdm_msg8.rb
+- lib/nmea_plus/message/ais/vdm_payload/vdm_msg8_dynamic_payload.rb
+- lib/nmea_plus/message/ais/vdm_payload/vdm_msg8d1f22.rb
 - lib/nmea_plus/message/ais/vdm_payload/vdm_msg8d1f31.rb
 - lib/nmea_plus/message/ais/vdm_payload/vdm_msg8d366f56.rb
 - lib/nmea_plus/message/ais/vdm_payload/vdm_msg9.rb