@jbroll/nmea-simple/codecs/VHW.ts

NMEA 0183 sentence parser and encoder

/*
 * === VHW – Water speed and heading ===
 *
 * ------------------------------------------------------------------------------
 *        1   2 3   4 5   6 7   8 9
 *        |   | |   | |   | |   | |
 * $--VHW,x.x,T,x.x,M,x.x,N,x.x,K*hh<CR><LF>
 * ------------------------------------------------------------------------------
 *
 * Field Number:
 * 1. Degress True
 * 2. T = True
 * 3. Degrees Magnetic
 * 4. M = Magnetic
 * 5. Knots (speed of vessel relative to the water)
 * 6. N = Knots
 * 7. Kilometers (speed of vessel relative to the water)
 * 8. K = Kilometers
 * 9. Checksum
 */

import { parseFloatSafe } from "../helpers";
import { initStubFields, PacketStub } from "./PacketStub";


export const sentenceId: "VHW" = "VHW";
export const sentenceName = "Water speed and heading";


export interface VHWPacket extends PacketStub<typeof sentenceId> {
    degreesTrue: number;
    degreesMagnetic: number;
    speedKnots: number;
    speedKmph: number;
}


export function decodeSentence(stub: PacketStub, fields: string[]): VHWPacket {
    return {
        ...initStubFields(stub, sentenceId, sentenceName),
        degreesTrue: parseFloatSafe(fields[1]),
        degreesMagnetic: parseFloatSafe(fields[3]),
        speedKnots: parseFloatSafe(fields[5]),
        speedKmph: parseFloatSafe(fields[7])
    };
}