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

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

export declare const courseAsyncApiDoc: {
    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: {
        'navigation.course': {
            address: string;
            description: string;
            messages: {
                startTime: {
                    name: string;
                    title: string;
                    summary: string;
                    contentType: string;
                    payload: import("@sinclair/typebox").TUnion<[import("@sinclair/typebox").TString, import("@sinclair/typebox").TNull]>;
                };
                targetArrivalTime: {
                    name: string;
                    title: string;
                    summary: string;
                    contentType: string;
                    payload: import("@sinclair/typebox").TUnion<[import("@sinclair/typebox").TString, import("@sinclair/typebox").TNull]>;
                };
                activeRoute: {
                    name: string;
                    title: string;
                    summary: string;
                    contentType: string;
                    payload: import("@sinclair/typebox").TUnion<[import("@sinclair/typebox").TObject<{
                        href: import("@sinclair/typebox").TString;
                        name: import("@sinclair/typebox").TString;
                        pointIndex: import("@sinclair/typebox").TNumber;
                        pointTotal: import("@sinclair/typebox").TNumber;
                        reverse: import("@sinclair/typebox").TBoolean;
                    }>, import("@sinclair/typebox").TNull]>;
                };
                arrivalCircle: {
                    name: string;
                    title: string;
                    summary: string;
                    contentType: string;
                    payload: import("@sinclair/typebox").TNumber;
                };
                previousPoint: {
                    name: string;
                    title: string;
                    summary: string;
                    contentType: string;
                    payload: import("@sinclair/typebox").TUnion<[import("@sinclair/typebox").TObject<{
                        href: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
                        type: import("@sinclair/typebox").TString;
                        position: import("@sinclair/typebox").TObject<{
                            latitude: import("@sinclair/typebox").TNumber;
                            longitude: import("@sinclair/typebox").TNumber;
                            altitude: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TNumber>;
                        }>;
                        name: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
                    }>, import("@sinclair/typebox").TNull]>;
                };
                nextPoint: {
                    name: string;
                    title: string;
                    summary: string;
                    contentType: string;
                    payload: import("@sinclair/typebox").TUnion<[import("@sinclair/typebox").TObject<{
                        href: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
                        type: import("@sinclair/typebox").TString;
                        position: import("@sinclair/typebox").TObject<{
                            latitude: import("@sinclair/typebox").TNumber;
                            longitude: import("@sinclair/typebox").TNumber;
                            altitude: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TNumber>;
                        }>;
                        name: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
                    }>, import("@sinclair/typebox").TNull]>;
                };
            };
        };
        'navigation.courseGreatCircle': {
            address: string;
            description: string;
            messages: {
                activeRouteHref: {
                    name: string;
                    title: string;
                    contentType: string;
                    payload: import("@sinclair/typebox").TUnion<[import("@sinclair/typebox").TString, import("@sinclair/typebox").TNull]>;
                };
                activeRouteStartTime: {
                    name: string;
                    title: string;
                    contentType: string;
                    payload: import("@sinclair/typebox").TUnion<[import("@sinclair/typebox").TString, import("@sinclair/typebox").TNull]>;
                };
                nextPointHref: {
                    name: string;
                    title: string;
                    contentType: string;
                    payload: import("@sinclair/typebox").TUnion<[import("@sinclair/typebox").TString, import("@sinclair/typebox").TNull]>;
                };
                nextPointType: {
                    name: string;
                    title: string;
                    contentType: string;
                    payload: import("@sinclair/typebox").TUnion<[import("@sinclair/typebox").TUnion<[import("@sinclair/typebox").TLiteral<"VesselPosition">, import("@sinclair/typebox").TLiteral<"RoutePoint">, import("@sinclair/typebox").TLiteral<"Location">]>, import("@sinclair/typebox").TNull]>;
                };
                nextPointPosition: {
                    name: string;
                    title: string;
                    contentType: string;
                    payload: import("@sinclair/typebox").TUnion<[import("@sinclair/typebox").TObject<{
                        latitude: import("@sinclair/typebox").TNumber;
                        longitude: import("@sinclair/typebox").TNumber;
                        altitude: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TNumber>;
                    }>, import("@sinclair/typebox").TNull]>;
                };
                nextPointArrivalCircle: {
                    name: string;
                    title: string;
                    contentType: string;
                    payload: import("@sinclair/typebox").TNumber;
                };
                previousPointPosition: {
                    name: string;
                    title: string;
                    contentType: string;
                    payload: import("@sinclair/typebox").TUnion<[import("@sinclair/typebox").TObject<{
                        latitude: import("@sinclair/typebox").TNumber;
                        longitude: import("@sinclair/typebox").TNumber;
                        altitude: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TNumber>;
                    }>, import("@sinclair/typebox").TNull]>;
                };
                previousPointType: {
                    name: string;
                    title: string;
                    contentType: string;
                    payload: import("@sinclair/typebox").TUnion<[import("@sinclair/typebox").TUnion<[import("@sinclair/typebox").TLiteral<"VesselPosition">, import("@sinclair/typebox").TLiteral<"RoutePoint">, import("@sinclair/typebox").TLiteral<"Location">]>, import("@sinclair/typebox").TNull]>;
                };
            };
        };
        'navigation.courseRhumbline': {
            address: string;
            description: string;
            messages: {
                activeRouteHref: {
                    name: string;
                    title: string;
                    contentType: string;
                    payload: import("@sinclair/typebox").TUnion<[import("@sinclair/typebox").TString, import("@sinclair/typebox").TNull]>;
                };
                activeRouteStartTime: {
                    name: string;
                    title: string;
                    contentType: string;
                    payload: import("@sinclair/typebox").TUnion<[import("@sinclair/typebox").TString, import("@sinclair/typebox").TNull]>;
                };
                nextPointHref: {
                    name: string;
                    title: string;
                    contentType: string;
                    payload: import("@sinclair/typebox").TUnion<[import("@sinclair/typebox").TString, import("@sinclair/typebox").TNull]>;
                };
                nextPointType: {
                    name: string;
                    title: string;
                    contentType: string;
                    payload: import("@sinclair/typebox").TUnion<[import("@sinclair/typebox").TUnion<[import("@sinclair/typebox").TLiteral<"VesselPosition">, import("@sinclair/typebox").TLiteral<"RoutePoint">, import("@sinclair/typebox").TLiteral<"Location">]>, import("@sinclair/typebox").TNull]>;
                };
                nextPointPosition: {
                    name: string;
                    title: string;
                    contentType: string;
                    payload: import("@sinclair/typebox").TUnion<[import("@sinclair/typebox").TObject<{
                        latitude: import("@sinclair/typebox").TNumber;
                        longitude: import("@sinclair/typebox").TNumber;
                        altitude: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TNumber>;
                    }>, import("@sinclair/typebox").TNull]>;
                };
                nextPointArrivalCircle: {
                    name: string;
                    title: string;
                    contentType: string;
                    payload: import("@sinclair/typebox").TNumber;
                };
                previousPointPosition: {
                    name: string;
                    title: string;
                    contentType: string;
                    payload: import("@sinclair/typebox").TUnion<[import("@sinclair/typebox").TObject<{
                        latitude: import("@sinclair/typebox").TNumber;
                        longitude: import("@sinclair/typebox").TNumber;
                        altitude: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TNumber>;
                    }>, import("@sinclair/typebox").TNull]>;
                };
                previousPointType: {
                    name: string;
                    title: string;
                    contentType: string;
                    payload: import("@sinclair/typebox").TUnion<[import("@sinclair/typebox").TUnion<[import("@sinclair/typebox").TLiteral<"VesselPosition">, import("@sinclair/typebox").TLiteral<"RoutePoint">, import("@sinclair/typebox").TLiteral<"Location">]>, import("@sinclair/typebox").TNull]>;
                };
            };
        };
    };
    operations: {
        receiveCourseV2: {
            action: string;
            channel: {
                $ref: string;
            };
            summary: string;
            description: string;
        };
        receiveCourseGreatCircle: {
            action: string;
            channel: {
                $ref: string;
            };
            summary: string;
        };
        receiveCourseRhumbline: {
            action: string;
            channel: {
                $ref: string;
            };
            summary: string;
        };
    };
};
//# sourceMappingURL=asyncApi.d.ts.map