nmea_plus 1.0.8 → 1.0.9

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

@@ -19,9 +19,10 @@ module NMEAPlus
           # @!parse attr_reader :rate_of_turn
           # @return [Float]
           def rate_of_turn
-            ret = _i(42, 8)
+            ret = _i(42, 8) # spec is wrong, we don't use I3
             return nil if ret == -128
-            (_I(42, 8, 3) / 4.733)**2
+            negative = ret < 0
+            (ret / 4.733)**2 * (negative ? -1 : 1)
           end
 
           payload_reader :speed_over_ground, 50, 10, :_U, 10
@@ -64,13 +65,13 @@ module NMEAPlus
 
         end
 
-        # Position report class A, which is really {VDMMsgCNB}
+        # AIS Type 1: Position report class A, which is really {VDMMsgCNB}
         class VDMMsg1 < VDMMsgCNB; end
 
-        # Position report class A, which is really {VDMMsgCNB}
+        # AIS Type 2: Position report class A, which is really {VDMMsgCNB}
         class VDMMsg2 < VDMMsgCNB; end
 
-        # Position report class A, which is really {VDMMsgCNB}
+        # AIS Type 3: 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

@@ -4,15 +4,18 @@ module NMEAPlus
   module Message
     module AIS
       module VDMPayload
-        # Type 12: Addressed Safety-Related Message
+        # AIS 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
+          # Safety message as a null-terminated string
           payload_reader :text, 72, 936, :_t
+
+          # Safety message as data
+          payload_reader :data, 72, 936, :_tt
         end
       end
     end

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

@@ -4,7 +4,7 @@ module NMEAPlus
   module Message
     module AIS
       module VDMPayload
-        # Type 14: Safety-Related Broadcast Message
+        # AIS Type 14: Safety-Related Broadcast Message
         class VDMMsg14 < NMEAPlus::Message::AIS::VDMPayload::VDMMsg
 
           # Safety message

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

@@ -6,6 +6,8 @@ module NMEAPlus
       module VDMPayload
 
         # Base class for "Class B CS Position Report" messages (18 and 19)
+        # @see NMEAPlus::Message::AIS::VDMPayload::VDMMsg18
+        # @see NMEAPlus::Message::AIS::VDMPayload::VDMMsg19
         class VDMMsgClassBCSPosition < NMEAPlus::Message::AIS::VDMPayload::VDMMsg
 
           payload_reader :speed_over_ground, 46, 10, :_U, 10
@@ -18,7 +20,7 @@ module NMEAPlus
 
         end
 
-        # Type 18: Standard Class B CS Position Report
+        # AIS Type 18: Standard Class B CS Position Report
         class VDMMsg18 < VDMMsgClassBCSPosition
           payload_reader :cs_unit?, 141, 1, :_b
           payload_reader :display?, 142, 1, :_b
@@ -29,7 +31,7 @@ module NMEAPlus
           payload_reader :raim?, 147, 1, :_b
         end
 
-        # Type 19: Extended Class B CS Position Report
+        # AIS 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
@@ -39,7 +41,7 @@ module NMEAPlus
           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 :dte_ready?, 306, 1, :_nb
           payload_reader :assigned?, 307, 1, :_b
 
           # @!parse attr_reader :ship_cargo_type_description

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

@@ -4,7 +4,8 @@ module NMEAPlus
   module Message
     module AIS
       module VDMPayload
-        # Type 20 Data Link Management Message
+
+        # AIS Type 20 Data Link Management Message
         class VDMMsg20 < NMEAPlus::Message::AIS::VDMPayload::VDMMsg
           payload_reader :offset1, 40, 12, :_u
           payload_reader :reserved_slots1, 52, 4, :_u

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

@@ -4,7 +4,8 @@ module NMEAPlus
   module Message
     module AIS
       module VDMPayload
-        # Type 21: Aid-to-Navigation Report
+
+        # AIS Type 21: Aid-to-Navigation Report
         class VDMMsg21 < NMEAPlus::Message::AIS::VDMPayload::VDMMsg
 
           # TODO: Navaid type descriptions (there are 32 of them)

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

@@ -4,7 +4,8 @@ module NMEAPlus
   module Message
     module AIS
       module VDMPayload
-        # Type 24: Static Data Report
+
+        # AIS Type 24: Static Data Report
         class VDMMsg24 < NMEAPlus::Message::AIS::VDMPayload::VDMMsg
 
           payload_reader :part_number, 38, 2, :_u

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

@@ -4,7 +4,8 @@ module NMEAPlus
   module Message
     module AIS
       module VDMPayload
-        # Type 27: Long Range AIS Broadcast message
+
+        # AIS Type 27: Long Range AIS Broadcast message
         class VDMMsg27 < NMEAPlus::Message::AIS::VDMPayload::VDMMsg
 
           payload_reader :position_10m_accuracy?, 38, 1, :_b

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

@@ -4,8 +4,11 @@ module NMEAPlus
   module Message
     module AIS
       module VDMPayload
-        # Type 4: Base Station Report
-        class VDMMsg4 < NMEAPlus::Message::AIS::VDMPayload::VDMMsg
+
+        # Base class for station reports
+        # @see VDMMsg4
+        # @see VDMMsg11
+        class VDMMsgStationReport < NMEAPlus::Message::AIS::VDMPayload::VDMMsg
 
           # @!parse attr_reader :current_time
           # @return [Time] current time
@@ -25,6 +28,16 @@ module NMEAPlus
           payload_reader :raim?, 148, 1, :_b
 
         end
+
+        # AIS Type 4: Base Station Report
+        # @see VDMMsgStationReport
+        class VDMMsg4 < VDMMsgStationReport; end
+
+        # AIS Type 11: UTC/Date Response
+        # According to the unoffical spec: "Identical to message 4, with the semantics of a response to inquiry."
+        # @see VDMMsgStationReport
+        class VDMMsg11 < VDMMsgStationReport; end
+
       end
     end
   end

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

@@ -4,7 +4,8 @@ module NMEAPlus
   module Message
     module AIS
       module VDMPayload
-        # Type 5: Static and Voyage Related Data
+
+        # AIS Type 5: Static and Voyage Related Data
         class VDMMsg5 < NMEAPlus::Message::AIS::VDMPayload::VDMMsg
 
           payload_reader :ais_version, 38, 2, :_u
@@ -32,7 +33,7 @@ module NMEAPlus
 
           payload_reader :static_draught, 294, 8, :_U, 10
           payload_reader :destination, 302, 120, :_t
-          payload_reader :dte?, 422, 1, :_b
+          payload_reader :dte_ready?, 422, 1, :_nb
 
           # @!parse attr_reader :ship_cargo_type_description
           # @return [String] Cargo type description

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

@@ -0,0 +1,55 @@
+require_relative 'vdm_msg'
+require_relative 'vdm_msg6d235f10'
+require_relative 'vdm_msg6d1022f61'
+
+module NMEAPlus
+  module Message
+    module AIS
+      module VDMPayload
+
+        # AIS Type 6: Binary Addressed Message
+        class VDMMsg6 < NMEAPlus::Message::AIS::VDMPayload::VDMMsg
+
+          payload_reader :sequence_number, 38, 2, :_u
+          payload_reader :destination_mmsi, 40, 30, :_u
+          payload_reader :retransmitted?, 70, 1, :_b
+          payload_reader :designated_area_code, 72, 10, :_u
+          payload_reader :functional_id, 82, 6, :_u
+
+          # 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]
+          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::VDMMsg6d#{designated_area_code}f#{functional_id}"
+            ret = _object_by_name(class_identifier)
+            return ret unless ret.nil?
+
+            _object_by_name("NMEAPlus::Message::AIS::VDMPayload::VDMMsg8Undefined") # 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
+end

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

@@ -0,0 +1,122 @@
+require_relative 'vdm_msg'
+
+module NMEAPlus
+  module Message
+    module AIS
+      module VDMPayload
+
+        # 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
+
+          def initialize
+            super
+            @fields = []
+          end
+
+          # The raw payload: comma separated ascii fields
+          # @return [String]
+          payload_reader :application_data, 88, 384, :_T   # not actually sure if 384 is enough length
+
+          # Override default bitstring setting to automatically load up a fields array for easier access
+          def payload_bitstring=(val)
+            super
+            @fields = application_data.split(",")
+          end
+
+          # Return a bit from the 8 bits in field 0
+          # @param position [Integer] the bit position: 0=MSB, 7=LSB
+          # @return [bool]
+          def _field0_bit(position)
+            return nil if @fields[1].nil?
+            mask = 1 << (7 - position)
+            @fields[0].hex & mask == mask
+          end
+
+          # Enable a shortcut syntax for bit field attributes, in the style of `attr_accessor` metaprogramming.
+          # This is used to create a named field pointing to a specific bit in the first field of the payload
+          # @param name [String] What the accessor will be called
+          # @param position [Integer] The bit position in this field
+          # @return [void]
+          # @macro [attach] bit_reader
+          #   @!attribute [r] $1
+          #   @return [bool] The value in bit $2 of the status field
+          def self.bit_reader(name, position)
+            self.class_eval("def #{name};_field0_bit(#{position});end")
+          end
+
+          bit_reader :supply_fail?, 0
+          bit_reader :gps_off_station?, 1
+          bit_reader :light_sensor_dark?, 2
+          bit_reader :gps_sync_valid?, 3
+          bit_reader :gps_valid?, 4
+          bit_reader :temperature_sensor_hot?, 5
+          bit_reader :battery_flat?, 6
+          bit_reader :battery_low?, 7
+
+          # @!parse attr_reader :operation_mode
+          # @return [Integer]
+          def operation_mode
+            return nil if @fields[1].nil?
+            @fields[1].hex >> 6
+          end
+
+          # A human-readable description of the operation mode
+          # @!parse attr_reader :operation_mode_description
+          # @return [String]
+          def operation_mode_description
+            case operation_mode
+            when 1 then "Standby"
+            when 2 then "Always on"
+            else
+              "description n/a" # TODO
+            end
+          end
+
+          # This field seems to be a 0-100% value encoded as 6-bit.
+          # The test cases seem to indicate that it is offset by +1.5625, which may mean that "3F" is a special case.
+          # But I have no data on that.
+          # @!parse attr_reader :intensity_percent
+          # @return [Float]
+          def intensity_percent
+            return nil if @fields[1].nil?
+            (1 + (@fields[1].hex & "3F".hex)) * (100.0 / 2**6)
+          end
+
+          # A vendor-specific code
+          # @!parse attr_reader :flash_code
+          # @return [String]
+          def flash_code
+            @fields[2].nil? ? nil : @fields[2].hex
+          end
+
+          # The battery voltage in volts
+          # @!parse attr_reader :battery_voltage
+          # @return [Float]
+          def battery_voltage
+            @fields[3].nil? ? nil : @fields[3].to_f
+          end
+
+          # Latitude
+          # @!parse attr_reader :latitude
+          # @return [Float]
+          def latitude
+            parts = @fields[4]
+            return nil if parts.nil?
+            NMEAPlus::Message::Base.degrees_minutes_to_decimal(parts[0..-1], parts[-1])
+          end
+
+          # Longitude
+          # @!parse attr_reader :longitude
+          # @return [Float]
+          def longitude
+            parts = @fields[5]
+            return nil if parts.nil?
+            NMEAPlus::Message::Base.degrees_minutes_to_decimal(parts[0..-1], parts[-1])
+          end
+
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,54 @@
+require_relative 'vdm_msg'
+
+module NMEAPlus
+  module Message
+    module AIS
+      module VDMPayload
+
+        # Type 6: Binary Addressed Message Subtype: GLA Aid to Navigation Monitoring Data
+        class VDMMsg6d235f10 < NMEAPlus::Message::AIS::VDMPayload::VDMMsg
+
+          payload_reader :analog_internal, 88, 10, :_U, 20, 0
+          payload_reader :analog_external1, 98, 10, :_U, 20, 0
+          payload_reader :analog_external2, 108, 10, :_U, 20, 0
+          payload_reader :racon_status, 118, 2, :_u
+
+          # RACON status description
+          # @!parse attr_reader :racon_status_description
+          # @return [String] RACON status description
+          def racon_status_description
+            case racon_status
+            when 0 then "no RACON installed"
+            when 1 then "RACON not monitored"
+            when 2 then "RACON operational"
+            when 3 then "RACON ERROR"
+            end
+          end
+
+          payload_reader :racon_light_status, 120, 2, :_u
+
+          # @!parse attr_reader :racon_light_status_description
+          # @return [String] RACON light status description
+          def racon_light_status_description
+            case racon_light_status
+            when 0 then "no light or monitoring"
+            when 1 then "ON"
+            when 2 then "OFF"
+            when 3 then "ERROR"
+            end
+          end
+
+          payload_reader :racon_alarm?, 122, 1, :_b
+          payload_reader :digital_input7?, 123, 1, :_b
+          payload_reader :digital_input6?, 124, 1, :_b
+          payload_reader :digital_input5?, 125, 1, :_b
+          payload_reader :digital_input4?, 126, 1, :_b
+          payload_reader :digital_input3?, 127, 1, :_b
+          payload_reader :digital_input2?, 128, 1, :_b
+          payload_reader :digital_input1?, 129, 1, :_b
+          payload_reader :digital_input0?, 130, 1, :_b
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,36 @@
+require_relative 'vdm_msg'
+
+module NMEAPlus
+  module Message
+    module AIS
+      module VDMPayload
+
+        # Base class for binary acknowledgement messages
+        # @see VDMMsg7
+        # @see VDMMsg13
+        class VDMMsgBinaryAcknowledgement < NMEAPlus::Message::AIS::VDMPayload::VDMMsg
+
+          payload_reader :ack1_mmsi, 40, 30, :_u
+          payload_reader :ack1_sequence_number, 70, 2, :_u
+          payload_reader :ack2_mmsi, 72, 30, :_u
+          payload_reader :ack2_sequence_number, 102, 2, :_u
+          payload_reader :ack3_mmsi, 104, 30, :_u
+          payload_reader :ack3_sequence_number, 134, 2, :_u
+          payload_reader :ack4_mmsi, 136, 30, :_u
+          payload_reader :ack4_sequence_number, 166, 2, :_u
+
+        end
+
+        # AIS Type 7: Binary Acknowledge
+        # @see VDMMsgBinaryAcknowledgement
+        class VDMMsg7 < VDMMsgBinaryAcknowledgement; end
+
+        # AIS Type 13: Safety-Related Acknowledgement
+        # According to the unoffical spec: "The message layout is identical to a type 7 Binary Acknowledge."
+        # @see VDMMsgBinaryAcknowledgement
+        class VDMMsg13 < VDMMsgBinaryAcknowledgement; end
+
+      end
+    end
+  end
+end