2.8.0 GENERATED FILE - DO NOT EDIT. Generated by keel from the YAML database in database/; edit database/pgns/*.yaml and run 'make generated'. See https://github.com/canboat/canboat for the full source code Canboat NMEA2000 Analyzer Apache License Version 2.0 9.2.0 CANboat version v9.2.0 (C) 2009-2026, Kees Verruijt, Harlingen, The Netherlands. For more information see https://github.com/canboat/canboat This file is part of CANboat. Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. quick Electrical current https://en.wikipedia.org/wiki/Electric_current Ampere A Electrical charge https://en.wikipedia.org/wiki/Electric_charge Coulomb C Electrical energy The amount of electricity used or stored. The base unit used in NMEA 2000 is the Kilo Watt Hour (kWh) which is equivalent to 3.6e6 J (Joules). https://en.wikipedia.org/wiki/Electrical_energy Kilo Watt Hour kWh Electrical power The amount of energy transferred or converted per unit time. https://en.wikipedia.org/wiki/Electrical_power Watt W AC apparent power The amount of power transferred where the current and voltage are in phase. https://en.wikipedia.org/wiki/Volt-ampere Volt Ampere VA AC reactive power The amount of power transferred where the current and voltage are not in phase. https://en.wikipedia.org/wiki/Volt-ampere#Reactive Volt Ampere Reactive VAR Potential difference https://en.wikipedia.org/wiki/Voltage Volt V Power Factor Used in AC circuits only, the ratio of the real power absorbed by the load to the apparent power flowing in the circuit. If less than one, the voltage and current are not in phase. https://en.wikipedia.org/wiki/Power_factor Cos(Phi) Cos Phi Length The physical size in one dimension of an object. https://en.wikipedia.org/wiki/Length Meter m Distance The amount of separation between two objects. https://en.wikipedia.org/wiki/Distance meter m Speed The velocity, or length per unit of time. https://en.wikipedia.org/wiki/Speed meter per second m/s Angle All standardized PGNs seen so far all use radians, but some manufacturer specific PGNs use degrees (deg). https://en.wikipedia.org/wiki/Angle radian rad Angular velocity The speed at which a measured angle changes https://en.wikipedia.org/wiki/Angular_velocity radians per second rad/s Volume A measure of occupied three-dimensional space. https://en.wikipedia.org/wiki/Volume liter L Volumetric flow The volume of fluid which passes per unit time. https://en.wikipedia.org/wiki/Volumetric_flow_rate liter per hour L/h Magnetic field https://en.wikipedia.org/wiki/Magnetic_field Tesla T Frequency https://en.wikipedia.org/wiki/Radio_frequency Hertz Hz Date A calendar date is a reference to a particular day in time, in NMEA 2000 expressed as the number of days since 1970-01-01 (UNIX epoch). https://en.wikipedia.org/wiki/Calendar_date days d Time Time is what clocks measure. We use time to place events in sequence one after the other, and we use time to compare how long events last. Absolute times in NMEA2000 are expressed as seconds since midnight(in an undefined timezone) https://en.wikipedia.org/wiki/Time Second s Duration of an event or interval between two points in time Second s Geographical latitude Combined with a geographical longitude the two fields form a unique point on earth, when height is disregarded. https://en.wikipedia.org/wiki/Geographic_coordinate_system degree deg Geographical longitude Combined with a geographical latitude the two fields form a unique point on earth, when height is disregarded. https://en.wikipedia.org/wiki/Geographic_coordinate_system degree deg Temperature https://en.wikipedia.org/wiki/Temperature Kelvin K Pressure https://en.wikipedia.org/wiki/Pressure Pascal Pa Pressure rate How the pressure changes over time. https://en.wikipedia.org/wiki/Pressure Pascal per hour Pa/hr Concentration of one substance in another, in this marine context usually the amount of salts in water https://www.engineeringtoolbox.com/water-salinity-d_1251.html parts per million ppm Dimensionless ratio A ratio of two quantities with the same dimension, yielding a unitless number. Includes percentages, eccentricity (m/m), clock drift (s/s), and similar. https://en.wikipedia.org/wiki/Dimensionless_quantity ratio ratio Square root of length Used in GPS/GNSS almanac data for the square root of the semi-major axis of satellite orbits. https://en.wikipedia.org/wiki/Semi-major_and_semi-minor_axes sqrt(m) sqrt(m) Signal strength expressed in dB with respect to 1 uV/m https://en.wikipedia.org/wiki/Signal_strength_in_telecommunications decibel dB Signal-to-noise ratio https://en.wikipedia.org/wiki/Signal-to-noise_ratio decibel dB Number Binary numbers are little endian. Number fields that are at least two bits in length use the highest positive value to represent unknown. Number fields with at least 7 as maximum (3 bits unsigned, 4 bits signed) use the highest value minus one as an error indicator. This is likely also true for numbers where 3 is the maximum value, but there are few fields that have this length -- certainly as a number, there are a lot of lookup fields of two bits length. For signed numbers the maximum values are the maximum positive value and that minus 1, not the all-ones bit encoding which is the maximum negative value. https://en.wikipedia.org/wiki/Binary_number TopOfRange 32 bit IEEE-754 floating point number https://en.wikipedia.org/wiki/IEEE_754 32 true NaN An unsigned numeric value where each byte holds the binary value of two decimal digits (0..99) Each byte contains the binary value of two decimal digits, so 1234 is represented by 2 bytes containing 0x0c (=12) and 0x22 (=34). This is NOT BCD. A value with an odd number of digits is padded with a trailing zero, e.g. the 9-digit MMSI 512000953 is encoded as 5120009530 (5 bytes), as a DSC call sends it (ITU-R M.585); a trailing zero is taken as that padding and dropped, so it decodes as 512000953, the same as an MMSI field. The leading zeros of a group (0MIDXXXXX) or coast station (00MIDXXXX) MMSI are part of it and stay. A decoder must not drop the trailing zero when the field has TrailingZeroIsDigitField and TrailingZeroIsDigitValue and the field with that order holds that value, as the last digit is then part of the value. PGN 129808's DSC Message Address does this for a call to a geographical area (DSC Format 102), whose ten digits all count. A byte that is not a digit pair (above 99), or a field the packet ends inside, makes the whole value not available. false None Number value where each value encodes for a distinct meaning Each lookup has a LookupEnumeration defining what the possible values mean For almost all lookups the list of values is known with some precision, but it is quite possible that a value occurs that has no corresponding textual explanation. Generally the same special values for Error (max value - 1) and Unknown (max value) that are used for plain numbers are also valid for lookups, but some lookups define a lookup key/value pair for the maximum possible value in that field. In fact, recent additions to PGNs such as alerts have two bit lookup fields that specify four actual valid values. This makes it impossible to send an unknown value for these fields. false TopOfRange Number value where each value encodes for a distinct meaning but the meaning also depends on the value in another field Each lookup has a LookupIndirectEnumeration defining what the possible values mean For almost all lookups the list of values is known with some precision, but it is quite possible that a value occurs that has no corresponding textual explanation. false TopOfRange Number value where each bit value encodes for a distinct meaning Each LookupBit has a LookupBitEnumeration defining what the possible values mean. A bitfield can have any combination of bits set. For almost all lookups the list of values is known with some precision, but it is quite possible that a value occurs that has no corresponding textual explanation. None Number value where each value encodes for a distinct meaning including a fieldtype of the next variable field; generally followed by an optional DYNAMIC_FIELD_LENGTH and a DYNAMIC_FIELD_VALUE field; when there is no DYNAMIC_FIELD_LENGTH field the length is contained in the lookup table Each lookup has a LookupFieldTypeEnumeration defining what the possible values mean These values have been determined by reverse engineering, given the known values it is anticipated that there are unknown enumeration values and some known values have incorrect datatypes false TopOfRange Number value that indicates the length of the following DYNAMIC_FIELD_VALUE field false TopOfRange Variable field whose type and length is dynamic The type definition of the field is defined by an earlier LookupFieldTypeEnumeration field. The length is defined by the preceding length field or the length determined by the lookup value. Variable Time https://en.wikipedia.org/wiki/Time s TopOfRange Duration s TopOfRange Date The date, in days since 1 January 1970. https://en.wikipedia.org/wiki/Calendar_date 16 d false TopOfRange Parameter Group Number A 24 bit number referring to a PGN None ISO NAME field A 64 bit field containing the ISO name, e.g. all fields produced by PGN 60928. Use the definition of PGN 60928 to explain the subfields. 64 false None A fixed length string containing single byte codepoints. This always takes up as many bytes as defined in the field definition. Three end-of-string characters are seen: 0xff (255), the standard NMEA 2000 "Unknown" value. '@', the standard AIS "Unknown" value for strings. 0x00, the standard C end-of-string marker. It is encouraged to stop the string at the first such character (and not make it part of the string). An empty string can be considered to make the entire field "Unknown". The character encoding is not defined by NMEA 2000. Bytes below 0x80 are ASCII, but above that devices differ, so CANboat decodes the content as UTF-8 when the bytes form well-formed UTF-8 and as ISO 8859-1 (Latin-1) otherwise. See the STRING_LAU comment for the observations behind this. EmptyString A varying length string containing single byte codepoints encoded with a length byte and terminating zero. The length of the string is determined by a starting length byte. It also contains a terminating zero byte. The length byte includes neither the zero byte or itself, and it counts bytes rather than characters, so a multi-byte character contributes more than one. For the character encoding see the comment. This type of string is found only in SonicHub and Fusion brand specific PGNs. SonicHub is no longer produced. The use of the Fusion specific PGNs is no longer very prevalent now that there are generic PGNs for audio/media devices. Fusion devices have been observed sending UTF-8 here, including characters that ISO 8859-1 cannot represent at all (see samples/fusion-130820-utf8.raw). CANboat decodes the content as UTF-8 when the bytes form well-formed UTF-8 and as ISO 8859-1 (Latin-1) otherwise. true EmptyString A varying length string containing double or single byte codepoints encoded with a length byte. The length of the string is determined by a starting length byte. This count includes the length and type bytes, so any empty string contains count 2. The 2nd byte contains 0 for UNICODE (UTF-16) or 1 for ASCII. In practice the ASCII encoding is not restricted to 7-bit ASCII; bytes above 0x7f do occur, and what they mean depends on the sending device. See the comment. Observed on a single bus: a Fusion sends UTF-8 under control byte 1 (bytes C5 AB for U+016B, see samples/fusion-126998-utf8.raw) while a B&G sends ISO 8859-1 (byte E6 for U+00E6, see samples/bandg-129285-latin1.raw) -- the same field type under the same control byte. The encoding therefore follows from neither the field type nor the control byte, and CANboat decodes the content as UTF-8 when the bytes form well-formed UTF-8 and as ISO 8859-1 (Latin-1) otherwise. The two devices also frame the field differently: the B&G appends a zero byte and counts it in the length, the Fusion does neither. Control byte 0 has so far only been seen on fields that were empty. true EmptyString Binary field Unspecified content consisting of any number of bits. None Reserved field All reserved bits shall be 1 NMEA reserved for future expansion and/or to align next data on byte boundary None Spare field All spare bits shall be 0 This is like a reserved field but originates from other sources where unused fields shall be 0, like the AIS ITU-1371 standard. None MMSI The MMSI is encoded as a 32 bit number, but is always printed as a 9 digit number and should be considered as a string. The first three or four digits are special, see the USCG link for a detailed explanation. The top three 32-bit values are reserved, as for any number (see below); in addition 0 is not a valid MMSI (no station holds MID 000) and devices send it for "none", so 0 is also treated as not available. https://navcen.uscg.gov/maritime-mobile-service-identity 32 false TopOfRange Variable The definition of the field is that of the reference PGN and reference field, this is totally variable. true None Field Index Index of the specified field in the PGN referenced. 8 false TopOfRange NMEA 2000 / J1939 network address One byte holding the bus address of a device. Every value is meaningful, so there are no top-of-range sentinels -- 0..253 are claimable device addresses, 254 is the null address (a device that has not claimed, or cannot claim, an address) and 255 is the global address, meaning broadcast / all devices. https://en.wikipedia.org/wiki/SAE_J1939 8 false None The list of fields is incomplete; some fields maybe be missing or their attributes may be incorrect The length of one or more fields is likely incorrect The resolution of one or more fields is likely incorrect One or more of the lookup fields contain missing or incorrect values The PGN has not been seen in any logfiles yet The default transmission interval is not known The manufacturer specific PGN seems to not contain the mandatory Company and Industry fields; this is likely a bug or at least incompatibility in the device 0 standardCanFrame 11-bit CAN frame An 11-bit CAN identifier with no definition. An 11-bit identifier is only a message type and carries no manufacturer, so nothing says which device or protocol sent it; its payload is shown as is. Single true true 1 8 true 1 data Data 64 0 0 1 BINARY 1728 quickUnknown6c0 Quick: Unknown 0x6C0 Sent by a Quick windlass alongside Chain Count (0x6C1). Its payload did not change in the one capture we have, so what it carries is not known. Single false Fields FieldLengths Resolution Interval 2 8 1 talkerId Talker ID The same 16 bits start every Quick message from a device; see Chain Count 16 0 0 1 false 0 65532 65535 65534 65533 NUMBER 2 data Data 48 16 0 1 BINARY 1729 quickChainCount Quick: Chain Count A Quick windlass's chain counter, about twice a second. Single false Resolution Lookups Interval 3 8 1 talkerId Talker ID The same 16 bits start every Quick message from a device 16 0 0 1 false 0 65532 65535 65534 65533 NUMBER 2 chainCounter Chain Counter Chain paid out, counted in the unit that Units names 32 16 0 1 false 0 4294967292 4294967295 4294967294 4294967293 NUMBER 3 units Units The unit Chain Counter counts in 16 48 0 1 false 0 65532 65535 65534 65533 LOOKUP QUICK_CHAIN_UNITS 1730 quickUnknown6c2 Quick: Unknown 0x6C2 Sent by a Quick windlass alongside Chain Count (0x6C1). Its payload did not change in the one capture we have, so what it carries is not known. Single false Fields FieldLengths Resolution Interval 2 8 1 talkerId Talker ID The same 16 bits start every Quick message from a device; see Chain Count 16 0 0 1 false 0 65532 65535 65534 65533 NUMBER 2 data Data 48 16 0 1 BINARY 1731 quickUnknown6c3 Quick: Unknown 0x6C3 Sent by a Quick windlass alongside Chain Count (0x6C1). Its payload did not change in the one capture we have, so what it carries is not known. Single false Fields FieldLengths Resolution Interval 2 8 1 talkerId Talker ID The same 16 bits start every Quick message from a device; see Chain Count 16 0 0 1 false 0 65532 65535 65534 65533 NUMBER 2 data Data 48 16 0 1 BINARY