Signal K
    Preparing search index...

    Type Alias SignalK

    SignalK: { [k: string]: unknown } & {
        self: string;
        version: string;
        aircraft?: { [k: string]: Aircraft };
        aton?: { [k: string]: AidToNavigation };
        resources?: Resources;
        sar?: { [k: string]: SearchAndRescueBeacons };
        sources?: Sources;
        vessels?: { [k: string]: Vessel };
        [k: string]: unknown;
    }

    Root schema of Signal K. Contains the list of vessels plus a reference to the local boat (also contained in the vessels list).

    Type declaration

    • [k: string]: unknown
    • [k: string]: unknown
    • self: string

      This holds the context (prefix + UUID, MMSI or URL in dot notation) of the server's self object.

    • version: string

      Version of the schema and APIs that this data is using in Canonical format i.e. V1.5.0.

    • Optionalaircraft?: { [k: string]: Aircraft }

      A wrapper object for aircraft, primarily intended for SAR aircraft in relation to marine search and rescue. For clarity about seaplanes etc, if it CAN fly, its an aircraft.

    • Optionalaton?: { [k: string]: AidToNavigation }

      A wrapper object for Aids to Navigation (aton's)

    • Optionalresources?: Resources
    • Optionalsar?: { [k: string]: SearchAndRescueBeacons }

      A wrapper object for Search And Rescue (SAR) MMSI's usied in transponders. MOB, EPIRBS etc

    • Optionalsources?: Sources
    • Optionalvessels?: { [k: string]: Vessel }

      A wrapper object for vessel objects, each describing vessels in range, including this vessel.