Signal K
    Preparing search index...

    Interface Navigation

    Navigation data including Position, Course to next WP information, etc.

    interface Navigation {
        anchor?: Anchor;
        attitude?: Attitude;
        closestApproach?: CommonValueFields & {
            value?: { distance?: number; timeTo?: number; [k: string]: unknown };
            values?: {
                [k: string]: {
                    pgn?: number;
                    sentence?: string;
                    timestamp?: string;
                    value?: { distance?: number; timeTo?: number; [k: string]: unknown };
                    [k: string]: unknown;
                };
            };
            [k: string]: unknown;
        };
        courseGreatCircle?: Course;
        courseOverGroundMagnetic?: NumberValue;
        courseOverGroundTrue?: NumberValue;
        courseRhumbline?: Course;
        datetime?: CommonValueFields & {
            gnssTimeSource?: | "GPS"
            | "GLONASS"
            | "Galileo"
            | "Beidou"
            | "IRNSS"
            | "Radio Signal"
            | "Internet"
            | "Local clock";
            value?: string;
            [k: string]: unknown;
        };
        destination?: Destination;
        gnss?: Gnss;
        headingCompass?: NumberValue;
        headingMagnetic?: NumberValue;
        headingTrue?: NumberValue;
        leewayAngle?: NumberValue;
        lights?: NavigationLights;
        log?: NumberValue;
        magneticDeviation?: NumberValue;
        magneticVariation?: NumberValue;
        magneticVariationAgeOfService?: NumberValue;
        maneuver?: CommonValueFields & string;
        position?: Position;
        racing?: {
            distanceStartline?: NumberValue;
            layline?: {
                distance?: NumberValue;
                time?: NumberValue;
                [k: string]: unknown;
            };
            oppositeLayline?: {
                distance?: NumberValue;
                time?: NumberValue;
                [k: string]: unknown;
            };
            startLinePort?: Position;
            startLineStb?: Position;
            timePortDown?: NumberValue;
            timePortUp?: NumberValue;
            timeStbdDown?: NumberValue;
            timeStbdUp?: NumberValue;
            timeToStart?: NumberValue;
            [k: string]: unknown;
        };
        rateOfTurn?: NumberValue;
        speedOverGround?: NumberValue;
        speedThroughWater?: NumberValue;
        speedThroughWaterLongitudinal?: NumberValue;
        speedThroughWaterTransverse?: NumberValue;
        state?: State;
        trip?: {
            lastReset?: DatetimeValue;
            log?: NumberValue;
            [k: string]: unknown;
        };
        [k: string]: unknown;
    }

    Indexable

    • [k: string]: unknown
    Index

    Properties

    anchor? attitude? closestApproach? courseGreatCircle? courseOverGroundMagnetic? courseOverGroundTrue? courseRhumbline? datetime? destination? gnss? headingCompass? headingMagnetic? headingTrue? leewayAngle? lights? log? magneticDeviation? magneticVariation? magneticVariationAgeOfService? maneuver? position? racing? rateOfTurn? speedOverGround? speedThroughWater? speedThroughWaterLongitudinal? speedThroughWaterTransverse? state? trip?

    Properties

    anchor?: Anchor
    attitude?: Attitude
    closestApproach?: CommonValueFields & {
        value?: { distance?: number; timeTo?: number; [k: string]: unknown };
        values?: {
            [k: string]: {
                pgn?: number;
                sentence?: string;
                timestamp?: string;
                value?: { distance?: number; timeTo?: number; [k: string]: unknown };
                [k: string]: unknown;
            };
        };
        [k: string]: unknown;
    }

    Calculated values for other vessels, e.g. from AIS

    Type declaration

    • [k: string]: unknown
    • Optionalvalue?: { distance?: number; timeTo?: number; [k: string]: unknown }
      • Optionaldistance?: number

        Closest Point of Approach (CPA), distance between own vessel and other vessel, based on current speeds, headings and positions

      • OptionaltimeTo?: number

        Time to Closest Point of Approach (TCPA), between own vessel and other vessel, based on current speeds, headings and positions

    • Optionalvalues?: {
          [k: string]: {
              pgn?: number;
              sentence?: string;
              timestamp?: string;
              value?: { distance?: number; timeTo?: number; [k: string]: unknown };
              [k: string]: unknown;
          };
      }
    courseGreatCircle?: Course
    courseOverGroundMagnetic?: NumberValue
    courseOverGroundTrue?: NumberValue
    courseRhumbline?: Course
    datetime?: CommonValueFields & {
        gnssTimeSource?:
            | "GPS"
            | "GLONASS"
            | "Galileo"
            | "Beidou"
            | "IRNSS"
            | "Radio Signal"
            | "Internet"
            | "Local clock";
        value?: string;
        [k: string]: unknown;
    }

    Time and Date from the GNSS Positioning System

    Type declaration

    • [k: string]: unknown
    • OptionalgnssTimeSource?:
          | "GPS"
          | "GLONASS"
          | "Galileo"
          | "Beidou"
          | "IRNSS"
          | "Radio Signal"
          | "Internet"
          | "Local clock"

      Source of GNSS Date and Time

    • Optionalvalue?: string

      GNSS Time and Date in RFC 3339 (UTC only without local offset) format

    destination?: Destination
    gnss?: Gnss
    headingCompass?: NumberValue
    headingMagnetic?: NumberValue
    headingTrue?: NumberValue
    leewayAngle?: NumberValue
    lights?: NavigationLights
    log?: NumberValue
    magneticDeviation?: NumberValue
    magneticVariation?: NumberValue
    magneticVariationAgeOfService?: NumberValue
    maneuver?: CommonValueFields & string

    Special maneuver such as regional passing arrangement. (from ais)

    position?: Position
    racing?: {
        distanceStartline?: NumberValue;
        layline?: {
            distance?: NumberValue;
            time?: NumberValue;
            [k: string]: unknown;
        };
        oppositeLayline?: {
            distance?: NumberValue;
            time?: NumberValue;
            [k: string]: unknown;
        };
        startLinePort?: Position;
        startLineStb?: Position;
        timePortDown?: NumberValue;
        timePortUp?: NumberValue;
        timeStbdDown?: NumberValue;
        timeStbdUp?: NumberValue;
        timeToStart?: NumberValue;
        [k: string]: unknown;
    }

    Specific navigational data related to yacht racing.

    Type declaration

    rateOfTurn?: NumberValue
    speedOverGround?: NumberValue
    speedThroughWater?: NumberValue
    speedThroughWaterLongitudinal?: NumberValue
    speedThroughWaterTransverse?: NumberValue
    state?: State
    trip?: { lastReset?: DatetimeValue; log?: NumberValue; [k: string]: unknown }

    Trip data

    On This Page

    Properties