signalk-server/dist/api/autopilot/asyncApi.d.ts

An implementation of a [Signal K](http://signalk.org) server for boats.

export declare const autopilotAsyncApiDoc: {
    asyncapi: string;
    info: {
        title: string;
        version: string;
        description: string;
        license: {
            name: string;
            url: string;
        };
    };
    servers: {
        signalk: {
            host: string;
            protocol: string;
            description: string;
            pathname: string;
        };
    };
    channels: {
        'steering.autopilot': {
            address: string;
            description: string;
            messages: {
                mode: {
                    name: string;
                    title: string;
                    summary: string;
                    contentType: string;
                    payload: import("@sinclair/typebox").TUnion<[import("@sinclair/typebox").TString, import("@sinclair/typebox").TNull]>;
                };
                state: {
                    name: string;
                    title: string;
                    summary: string;
                    contentType: string;
                    payload: import("@sinclair/typebox").TUnion<[import("@sinclair/typebox").TString, import("@sinclair/typebox").TNull]>;
                };
                target: {
                    name: string;
                    title: string;
                    summary: string;
                    contentType: string;
                    payload: import("@sinclair/typebox").TUnion<[import("@sinclair/typebox").TNumber, import("@sinclair/typebox").TNull]>;
                };
                engaged: {
                    name: string;
                    title: string;
                    summary: string;
                    contentType: string;
                    payload: import("@sinclair/typebox").TBoolean;
                };
                availableActions: {
                    name: string;
                    title: string;
                    summary: string;
                    contentType: string;
                    payload: import("@sinclair/typebox").TArray<import("@sinclair/typebox").TString>;
                };
                defaultPilot: {
                    name: string;
                    title: string;
                    summary: string;
                    contentType: string;
                    payload: import("@sinclair/typebox").TUnion<[import("@sinclair/typebox").TString, import("@sinclair/typebox").TNull]>;
                };
            };
        };
        'notifications.steering.autopilot': {
            address: string;
            description: string;
            messages: {
                alarm: {
                    name: string;
                    title: string;
                    summary: string;
                    contentType: string;
                    payload: import("@sinclair/typebox").TObject<{
                        state: import("@sinclair/typebox").TString;
                        method: import("@sinclair/typebox").TArray<import("@sinclair/typebox").TString>;
                        message: import("@sinclair/typebox").TString;
                    }>;
                };
            };
        };
    };
    operations: {
        receiveAutopilot: {
            action: string;
            channel: {
                $ref: string;
            };
            summary: string;
        };
        receiveAutopilotAlarms: {
            action: string;
            channel: {
                $ref: string;
            };
            summary: string;
        };
    };
    components: {
        schemas: {
            AutopilotInfo: import("@sinclair/typebox").TObject<{
                options: import("@sinclair/typebox").TObject<{
                    states: import("@sinclair/typebox").TArray<import("@sinclair/typebox").TObject<{
                        name: import("@sinclair/typebox").TString;
                        engaged: import("@sinclair/typebox").TBoolean;
                    }>>;
                    modes: import("@sinclair/typebox").TArray<import("@sinclair/typebox").TString>;
                    actions: import("@sinclair/typebox").TArray<import("@sinclair/typebox").TObject<{
                        id: import("@sinclair/typebox").TUnion<[import("@sinclair/typebox").TLiteral<"dodge">, import("@sinclair/typebox").TLiteral<"tack">, import("@sinclair/typebox").TLiteral<"gybe">, import("@sinclair/typebox").TLiteral<"courseCurrentPoint">, import("@sinclair/typebox").TLiteral<"courseNextPoint">]>;
                        name: import("@sinclair/typebox").TString;
                        available: import("@sinclair/typebox").TBoolean;
                    }>>;
                }>;
                target: import("@sinclair/typebox").TUnion<[import("@sinclair/typebox").TNumber, import("@sinclair/typebox").TNull]>;
                mode: import("@sinclair/typebox").TUnion<[import("@sinclair/typebox").TString, import("@sinclair/typebox").TNull]>;
                state: import("@sinclair/typebox").TUnion<[import("@sinclair/typebox").TString, import("@sinclair/typebox").TNull]>;
                engaged: import("@sinclair/typebox").TBoolean;
            }>;
        };
    };
};
//# sourceMappingURL=asyncApi.d.ts.map