Signal K
    Preparing search index...

    Interface ControlDefinitionV5

    Control definition describing a radar control.

    interface ControlDefinitionV5 {
        category: "base" | "extended";
        description: string;
        id: string;
        name: string;
        type: "number" | "boolean" | "enum" | "compound";
        default?: any;
        defaultMode?: "auto" | "manual";
        modes?: ("auto" | "manual")[];
        properties?: Record<string, any>;
        range?: { max: number; min: number; step?: number; unit?: string };
        readOnly?: boolean;
        values?: { label: string; value: string | number; description?: string }[];
    }
    Index

    Properties

    category description id name type default? defaultMode? modes? properties? range? readOnly? values?

    Properties

    category: "base" | "extended"

    Category: base controls all radars have, extended are model-specific

    description: string

    Description for tooltips

    id: string

    Semantic control ID (e.g., "gain", "beamSharpening")

    name: string

    Human-readable name

    type: "number" | "boolean" | "enum" | "compound"

    Control value type

    default?: any

    Default value

    defaultMode?: "auto" | "manual"

    Default mode

    modes?: ("auto" | "manual")[]

    Supported modes (auto/manual)

    properties?: Record<string, any>

    For type: "compound" - property definitions

    range?: { max: number; min: number; step?: number; unit?: string }

    For type: "number" - value range constraints

    readOnly?: boolean

    Whether this control is read-only

    values?: { label: string; value: string | number; description?: string }[]

    For type: "enum" - allowed values

    On This Page

    Properties