nmea_plus 1.0.7 → 1.0.8

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

@@ -12,21 +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"
-            when 2 then return "Not under command"
-            when 3 then return "Restricted manoeuverability"
-            when 4 then return "Constrained by her draught"
-            when 5 then return "Moored"
-            when 6 then return "Aground"
-            when 7 then return "Engaged in Fishing"
-            when 8 then return "Under way sailing"
-            when 14 then return "AIS-SART active"
-            else
-              return "undefined"
-            end
+            get_navigational_status_description(navigational_status)
           end
 
           # The rate of turn in degrees per minute
@@ -35,35 +21,44 @@ module NMEAPlus
           def rate_of_turn
             ret = _i(42, 8)
             return nil if ret == -128
-            (_I(42, 8, 3) / 4.733) ** 2
+            (_I(42, 8, 3) / 4.733)**2
           end
 
-          payload_reader :speed_over_ground, 50, 10, :_U, 1
+          payload_reader :speed_over_ground, 50, 10, :_U, 10
           payload_reader :position_10m_accuracy?, 60, 1, :_b
+          payload_reader :longitude, 61, 28, :_I, 60 * 10**4, 181
+          payload_reader :latitude, 89, 27, :_I, 60 * 10**4, 91
+          payload_reader :course_over_ground, 116, 12, :_U, 10, 3600
+          payload_reader :true_heading, 128, 9, :_u, 511
 
-          # @!parse attr_reader :longitude
-          # @return [Float]
-          def longitude
-            _I(61, 28, 4) / 60
+          # @!visibility private
+          payload_reader :_time_stamp, 137, 6, :_u
+
+          # @!parse attr_reader :time_stamp
+          # @return [Integer]
+          def time_stamp
+            ret = _time_stamp
+            59 < ret ? nil : ret
           end
 
-          # @!parse attr_reader :latitude
-          # @return [Float]
-          def latitude
-            _U(89, 27, 4) / 60
+          # @!parse attr_reader :position_manual_input?
+          # @return [bool]
+          def position_manual_input?
+            61 == _time_stamp
           end
 
-          payload_reader :course_over_ground, 116, 12, :_U, 1
+          # @!parse attr_reader :position_estimated?
+          # @return [bool]
+          def position_estimated?
+            62 == _time_stamp
+          end
 
-          # @!parse attr_reader :true_heading
-          # @return [Float]
-          def true_heading
-            ret = _u(128, 9)
-            return nil if ret == 511  # means "not available"
-            ret
+          # @!parse attr_reader :position_inoperative?
+          # @return [bool]
+          def position_inoperative?
+            63 == _time_stamp
           end
 
-          payload_reader :time_stamp, 137, 6, :_u
           payload_reader :special_manoeuvre, 143, 2, :_e
           payload_reader :raim?, 148, 1, :_b
 

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

@@ -8,31 +8,12 @@ module NMEAPlus
         # 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 :speed_over_ground, 46, 10, :_U, 10
           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 :longitude, 57, 28, :_I, 60 * 10**4, 181
+          payload_reader :latitude, 85, 27, :_I, 60 * 10**4, 91
+          payload_reader :course_over_ground, 112, 12, :_U, 10
+          payload_reader :true_heading, 124, 9, :_u, 511
           payload_reader :time_stamp, 133, 6, :_u
 
         end

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

@@ -12,18 +12,8 @@ module NMEAPlus
           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 :longitude, 164, 28, :_I, 60 * 10**4, 181
+          payload_reader :latitude, 192, 27, :_I, 60 * 10**4, 91
 
           payload_reader :ship_dimension_to_bow, 219, 9, :_u
           payload_reader :ship_dimension_to_stern, 228, 9, :_u

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

@@ -0,0 +1,30 @@
+require_relative 'vdm_msg'
+
+module NMEAPlus
+  module Message
+    module AIS
+      module VDMPayload
+        # Type 27: Long Range AIS Broadcast message
+        class VDMMsg27 < NMEAPlus::Message::AIS::VDMPayload::VDMMsg
+
+          payload_reader :position_10m_accuracy?, 38, 1, :_b
+          payload_reader :raim?, 39, 1, :_b
+          payload_reader :navigational_status, 40, 4, :_u
+
+          # @!parse attr_reader :navigational_status_description
+          # @return [String] the human-readable description of navigational status
+          def navigational_status_description
+            get_navigational_status_description(navigational_status)
+          end
+
+          payload_reader :longitude, 44, 18, :_I, 60 * 10, 181
+          payload_reader :latitude, 62, 17, :_I, 60 * 10, 91
+          payload_reader :speed_over_ground, 79, 6, :_u
+          payload_reader :course_over_ground, 85, 9, :_u, 511
+          payload_reader :gnss?, 94, 1, :_b
+
+        end
+      end
+    end
+  end
+end

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

@@ -19,19 +19,8 @@ module NMEAPlus
           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 :longitude, 79, 28, :_I, 60 * 10**4, 181
+          payload_reader :latitude, 107, 27, :_I, 60 * 10**4, 91
           payload_reader :epfd_type, 134, 4, :_e
           payload_reader :raim?, 148, 1, :_b
 

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

@@ -30,7 +30,7 @@ module NMEAPlus
                      0)
           end
 
-          payload_reader :static_draught, 294, 8, :_U, 1
+          payload_reader :static_draught, 294, 8, :_U, 10
           payload_reader :destination, 302, 120, :_t
           payload_reader :dte?, 422, 1, :_b
 

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

@@ -1,18 +1,65 @@
 require_relative 'vdm_msg'
+require_relative 'vdm_msg8d1f31'
+require_relative 'vdm_msg8d366f56'
 
 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
+
+          # 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]
+          def dp
+            ret = _dynamic_payload_container
+            ret.payload_bitstring = payload_bitstring
+            ret.fill_bits = fill_bits
+            ret
+          end
+
+          # Dynamically calculate what message subtype to use
+          # which depends on the designated_area_code and functional_id
+          def _dynamic_payload_container
+            class_identifier = "NMEAPlus::Message::AIS::VDMPayload::VDMMsg8d#{designated_area_code}f#{functional_id}"
+            ret = _object_by_name(class_identifier)
+            return ret unless ret.nil?
+
+            # 316 / 366
+            if designated_area_code == 316
+              class_identifier = "NMEAPlus::Message::AIS::VDMPayload::VDMMsg8d366f#{functional_id}"
+              ret = _object_by_name(class_identifier)
+              return ret unless ret.nil?
+            end
+
+            _object_by_name("NMEAPlus::Message::AIS::VDMPayload::VDMMsg8Undefined") # generic
+          end
+
+          # Return an object by its class name, or nil if it isn't defined
+          def _object_by_name(class_identifier)
+            Object::const_get(class_identifier).new
+          rescue ::NameError
+            nil
+          end
+
+        end
+
+        # Base class for dynamic payloads (subtypes) of 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_msg8d1f31.rb

@@ -0,0 +1,139 @@
+require_relative 'vdm_msg'
+
+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
+
+          payload_reader :longitude, 56, 25, :_I, 60 * 10**3, 181
+          payload_reader :latitude, 81, 24, :_I, 60 * 10**3, 91
+          payload_reader :position_10m_accuracy?, 105, 1, :_b
+
+          # @!parse attr_reader :current_time
+          # @return [Time] current time
+          def current_time
+            now = Time.now
+            day = _u(106, 5)
+            hour = _u(111, 5)
+            minute = _u(116, 6)
+            return nil if 0 == day
+            return nil if 24 == hour
+            return nil if 60 == minute
+            Time.new(now.year, now.month, day, hour, minute, 0)
+          end
+
+          payload_reader :wind_speed_average, 122, 7, :_u, 127
+          payload_reader :wind_speed_gust, 129, 7, :_u, 127
+          payload_reader :wind_direction, 136, 9, :_u, 360
+          payload_reader :wind_direction_gust, 145, 9, :_u, 360
+          payload_reader :air_temperature, 154, 11, :_I, 10, -1024
+          payload_reader :relative_humidity, 165, 7, :_u, 101
+          payload_reader :dew_point, 172, 10, :_I, 10, 501
+          payload_reader :air_pressure_hpa, 182, 9, :_UU, 1, 799, 511
+          payload_reader :air_pressure_tendency, 191, 2, :_u, 3
+
+          # @!parse attr_reader :air_pressure_tendency_description
+          # @return [String] pressure tendency description
+          def air_pressure_tendency_description
+            trend_description(air_pressure_tendency)
+          end
+
+          payload_reader :visibility_greater_than, 193, 1, :_b
+          payload_reader :horizontal_visibility, 194, 8, :_U, 10, 255
+          payload_reader :water_level, 201, 12, :_UU, 10**2, -10, 4001
+          payload_reader :water_level_tendency, 213, 2, :_u, 3
+
+          # @!parse attr_reader :water_level_tendency_description
+          # @return [String] water level tendency description
+          def water_level_tendency_description
+            trend_description(water_level_tendency)
+          end
+
+          payload_reader :water_current_speed1, 215, 8, :_U, 10, 255
+          payload_reader :water_current_direction1, 223, 9, :_u, 360
+
+          # surface water current
+          # @!parse attr_reader :water_current_depth1
+          # @return [Float] depth of measurement
+          def water_current_depth1
+            0
+          end
+
+          payload_reader :water_current_speed2, 232, 8, :_U, 10, 255
+          payload_reader :water_current_direction2, 240, 9, :_u, 360
+          payload_reader :water_current_depth2, 249, 5, :_U, 10, 31
+
+          payload_reader :water_current_speed3, 254, 8, :_U, 10, 255
+          payload_reader :water_current_direction3, 262, 9, :_u, 360
+          payload_reader :water_current_depth3, 271, 5, :_U, 10, 31
+
+          payload_reader :wave_height, 276, 8, :_U, 10, 255
+          payload_reader :wave_period, 284, 6, :_u, 63
+          payload_reader :wave_direction, 290, 9, :_u, 360
+          payload_reader :swell_height, 299, 8, :_U, 10, 255
+          payload_reader :swell_period, 307, 6, :_u, 63
+          payload_reader :swell_direction, 313, 9, :_u, 360
+          payload_reader :sea_state_beaufort, 322, 4, :_e
+
+          payload_reader :water_temperature, 326, 10, :_I, 1, 501
+          payload_reader :precipitation_type, 336, 3, :_u, 7
+
+          # precipitation type description
+          # @param [Integer] code The code for precipitation
+          # @return [String] the description
+          def precipitation_description
+            case precipitation_type
+            when 0 then return "Reserved"
+            when 1 then return "Rain"
+            when 2 then return "Thunderstorm"
+            when 3 then return "Freezing rain"
+            when 4 then return "Mixed/ice"
+            when 5 then return "Snow"
+            when 6 then return "Reserved"
+              # 7 is nil
+            end
+          end
+
+          # @!parse attr_reader :salinity
+          # @return [Float] salinity
+          def salinity
+            ret = _U(339, 9, 10)
+            return nil if ret > 51.0 # 51.1 for sensor not available, otherwise n/a
+          end
+
+          # @!parse attr_reader :salinity_sensor_unavailable?
+          # @return [bool]
+          def salinity_sensor_unavailable?
+            _u(339, 9) == 511
+          end
+
+          payload_reader :ice_code, 348, 2, :_u, 3
+
+          # @param [Integer] code The code for ice
+          # @return [String] the description
+          def ice_description
+            case ice_code
+            when 0 then return "No"
+            when 1 then return "Yes"
+            when 2 then return "(reserved)"
+            end
+          end
+
+          # trend description
+          # @param [Integer] code The trend code
+          # @return [String] the description
+          def trend_description(code)
+            case code
+            when 0 then return "steady"
+            when 1 then return "decreasing"
+            when 2 then return "increasing"
+            end
+          end
+
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,29 @@
+require_relative 'vdm_msg'
+
+module NMEAPlus
+  module Message
+    module AIS
+      module VDMPayload
+        class VDMMsg8USCGEncrypted < NMEAPlus::Message::AIS::VDMPayload::VDMMsg
+          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
+
+        # 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
+      end
+    end
+  end
+end