Signal K
    Preparing search index...

    Sails data

    interface Sails {
        area?: {
            active?: NumberValue;
            total?: NumberValue;
            [k: string]: unknown;
        };
        inventory?: {
            [k: string]: {
                active: boolean;
                area: number;
                name: string;
                type: string;
                _attr?: _AttrSchema;
                brand?: string;
                material?: string;
                maximumWind?: number;
                meta?: MetaSchema;
                minimumWind?: number;
                reducedState?: {
                    furledRatio?: number;
                    reduced?: boolean;
                    reefs?: number;
                    [k: string]: unknown;
                };
                source?: Source;
                timestamp?: string;
                [k: string]: unknown;
            };
        };
        [k: string]: unknown;
    }

    Indexable

    • [k: string]: unknown
    Index

    Properties

    Properties

    area?: { active?: NumberValue; total?: NumberValue; [k: string]: unknown }

    An object containing information about the vessels' sails.

    inventory?: {
        [k: string]: {
            active: boolean;
            area: number;
            name: string;
            type: string;
            _attr?: _AttrSchema;
            brand?: string;
            material?: string;
            maximumWind?: number;
            meta?: MetaSchema;
            minimumWind?: number;
            reducedState?: {
                furledRatio?: number;
                reduced?: boolean;
                reefs?: number;
                [k: string]: unknown;
            };
            source?: Source;
            timestamp?: string;
            [k: string]: unknown;
        };
    }

    An object containing a description of each sail available to the vessel crew

    Type declaration

    • [k: string]: {
          active: boolean;
          area: number;
          name: string;
          type: string;
          _attr?: _AttrSchema;
          brand?: string;
          material?: string;
          maximumWind?: number;
          meta?: MetaSchema;
          minimumWind?: number;
          reducedState?: {
              furledRatio?: number;
              reduced?: boolean;
              reefs?: number;
              [k: string]: unknown;
          };
          source?: Source;
          timestamp?: string;
          [k: string]: unknown;
      }

      'sail' data type.

      This interface was referenced by undefined's JSON-Schema definition via the patternProperty "(^[a-zA-Z0-9]+$)".

      Type declaration

      • [k: string]: unknown
      • active: boolean

        Indicates wether this sail is currently in use or not

      • area: number

        The total area of this sail in square meters

      • name: string

        An unique identifier by which the crew identifies a sail

      • type: string

        The type of sail

      • Optional_attr?: _AttrSchema
      • Optionalbrand?: string

        The brand of the sail (optional)

      • Optionalmaterial?: string

        The material the sail is made from (optional)

      • OptionalmaximumWind?: number

        The maximum wind speed this sail can be used with

      • Optionalmeta?: MetaSchema
      • OptionalminimumWind?: number

        The minimum wind speed this sail can be used with

      • OptionalreducedState?: {
            furledRatio?: number;
            reduced?: boolean;
            reefs?: number;
            [k: string]: unknown;
        }

        An object describing reduction of sail area

        • OptionalfurledRatio?: number

          Ratio of sail reduction, 0 means full and 1 is completely furled in

        • Optionalreduced?: boolean

          describes whether the sail is reduced or not

        • Optionalreefs?: number

          Number of reefs set, 0 means full

      • 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]*".