Signal K
    Preparing search index...

    Interface Environment

    Environmental data measured locally including Depth, Wind, Temp, etc.

    interface Environment {
        current?: Current;
        depth?: Depth;
        heave?: NumberValue;
        inside?: { [k: string]: ZoneObject } & ZoneObject;
        mode?: {
            source?: Source;
            timestamp?: string;
            value?: "day" | "night" | "restricted visibility";
            [k: string]: unknown;
        };
        outside?: {
            airDensity?: NumberValue;
            apparentWindChillTemperature?: NumberValue;
            dewPointTemperature?: NumberValue;
            heatIndexTemperature?: NumberValue;
            humidity?: NumberValue;
            illuminance?: NumberValue;
            pressure?: NumberValue;
            relativeHumidity?: NumberValue;
            temperature?: NumberValue;
            theoreticalWindChillTemperature?: NumberValue;
            [k: string]: unknown;
        };
        tide?: Tide;
        time?: {
            millis?: number;
            source?: Source;
            timestamp?: string;
            timezoneOffset?: number;
            timezoneRegion?: string;
            [k: string]: unknown;
        };
        water?: {
            salinity?: NumberValue;
            temperature?: NumberValue;
            [k: string]: unknown;
        };
        wind?: Wind;
        [k: string]: unknown;
    }

    Indexable

    • [k: string]: unknown
    Index

    Properties

    current? depth? heave? inside? mode? outside? tide? time? water? wind?

    Properties

    current?: Current
    depth?: Depth
    heave?: NumberValue
    inside?: { [k: string]: ZoneObject } & ZoneObject

    Environmental conditions inside the vessel's hull

    mode?: {
        source?: Source;
        timestamp?: string;
        value?: "day" | "night" | "restricted visibility";
        [k: string]: unknown;
    }

    Mode of the vessel based on the current conditions. Can be combined with navigation.state to control vessel signals eg switch to night mode for instrumentation and lights, or make sound signals for fog.

    Type declaration

    • [k: string]: unknown
    • Optionalsource?: Source
    • Optionaltimestamp?: string

      RFC 3339 (UTC only without local offset) string representing date and time.

      This interface was referenced by undefined's JSON-Schema definition via the patternProperty "^[A-Z][A-Z][A-Z]$".

      This interface was referenced by undefined's JSON-Schema definition via the patternProperty "[0-9]*".

    • Optionalvalue?: "day" | "night" | "restricted visibility"
    outside?: {
        airDensity?: NumberValue;
        apparentWindChillTemperature?: NumberValue;
        dewPointTemperature?: NumberValue;
        heatIndexTemperature?: NumberValue;
        humidity?: NumberValue;
        illuminance?: NumberValue;
        pressure?: NumberValue;
        relativeHumidity?: NumberValue;
        temperature?: NumberValue;
        theoreticalWindChillTemperature?: NumberValue;
        [k: string]: unknown;
    }

    Environmental conditions outside of the vessel's hull

    tide?: Tide
    time?: {
        millis?: number;
        source?: Source;
        timestamp?: string;
        timezoneOffset?: number;
        timezoneRegion?: string;
        [k: string]: unknown;
    }

    A time reference for the vessel. All clocks on the vessel dispaying local time should use the timezone offset here. If a timezoneRegion is supplied the timezone must also be supplied. If timezoneRegion is supplied that should be displayed by UIs in preference to simply timezone. ie 12:05 (Europe/London) should be displayed in preference to 12:05 (UTC+01:00)

    Type declaration

    • [k: string]: unknown
    • Optionalmillis?: number
    • Optionalsource?: Source
    • Optionaltimestamp?: string

      RFC 3339 (UTC only without local offset) string representing date and time.

      This interface was referenced by undefined's JSON-Schema definition via the patternProperty "^[A-Z][A-Z][A-Z]$".

      This interface was referenced by undefined's JSON-Schema definition via the patternProperty "[0-9]*".

    • OptionaltimezoneOffset?: number
    • OptionaltimezoneRegion?: string
    water?: {
        salinity?: NumberValue;
        temperature?: NumberValue;
        [k: string]: unknown;
    }

    Environmental conditions of the water that the vessel is sailing in

    wind?: Wind

    On This Page

    Properties