Preparing search index...

    Interface LogEntry

    A log entry resource — a line in the vessel's logbook, time-anchored by datetime and optionally place-anchored by position, carrying an optional snapshot of Signal K paths observed at that moment. Open content model: consumers must ignore unknown fields and providers must preserve them on write; extension fields should be namespaced by the writing application (e.g. x-stylusapp-ink).

    interface LogEntry {
        text: string;
        author?: string;
        category?: string;
        datetime?: string;
        id?: string;
        origin?: string;
        position?: Position;
        schemaVersion?: number;
        telemetry?: LogEntryTelemetryValue[];
        [key: string]: unknown;
    }

    Indexable

    • [key: string]: unknown
    Index
    text author? category? datetime? id? origin? position? schemaVersion? telemetry?

    text

    text: string

    The log line itself.

    author?: string

    Crew member the line is attributed to. Free text, not an audit identity: delegation is a feature.

    category?: string

    Entry category. Open enumeration; the recommended vocabulary is navigation, engine, radio and maintenance.

    datetime?: string

    RFC 3339 UTC datetime of the entry, the chronological sort key. Defaults to now on create and is preserved on replace.

    id?: string

    Entry UUID. Equals the resource id; the resource id is canonical.

    origin?: string

    How the line came to be. Open enumeration; the recommended vocabulary is manual (typed in a UI), auto (trigger/hourly/notification) and agent (machine writing on behalf of a human).

    position?: Position

    Vessel position at the entry datetime. Entries not anchored to a place omit it; telemetry may additionally carry a navigation.position snapshot of the same moment. Storage only: the standard listing API defines no spatial query.

    schemaVersion?: number

    Reserved for future revisions of the entry schema; absent = 1. Other writers must not use the name for anything else.

    telemetry?: LogEntryTelemetryValue[]

    Snapshot of Signal K paths observed at the entry datetime.

    On This Page
    Properties