@signalk/server-api 2.0.0-beta.1 → 2.0.0-beta.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/autopilot.d.ts +28 -0
- package/dist/autopilot.js +2 -0
- package/dist/index.d.ts +26 -1
- package/package.json +1 -1
- package/tsconfig.tsbuildinfo +3475 -0
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
export interface AutopilotApi {
|
|
2
|
+
register: (pluginId: string, provider: AutopilotProvider) => void;
|
|
3
|
+
unRegister: (pluginId: string) => void;
|
|
4
|
+
getStates: () => Promise<[string]>;
|
|
5
|
+
setState: (state: string) => Promise<void>;
|
|
6
|
+
getModes: () => Promise<[string]>;
|
|
7
|
+
setMode: (mode: string) => Promise<void>;
|
|
8
|
+
setTarget: (value: number) => Promise<void>;
|
|
9
|
+
adjustTarget: (value: number) => Promise<void>;
|
|
10
|
+
tack: (port: boolean) => Promise<void>;
|
|
11
|
+
}
|
|
12
|
+
export interface AutopilotProvider {
|
|
13
|
+
pilotType: string;
|
|
14
|
+
methods: AutopilotProviderMethods;
|
|
15
|
+
}
|
|
16
|
+
export interface AutopilotProviderMethods {
|
|
17
|
+
pluginId?: string;
|
|
18
|
+
getStates: () => Promise<[string]>;
|
|
19
|
+
setState: (state: string) => Promise<void>;
|
|
20
|
+
getModes: () => Promise<[string]>;
|
|
21
|
+
setMode: (mode: string) => Promise<void>;
|
|
22
|
+
setTarget: (value: number) => Promise<void>;
|
|
23
|
+
adjustTarget: (value: number) => Promise<void>;
|
|
24
|
+
tack: (port: boolean) => Promise<void>;
|
|
25
|
+
}
|
|
26
|
+
export interface AutopilotProviderRegistry {
|
|
27
|
+
registerAutopilotProvider: (provider: AutopilotProvider) => void;
|
|
28
|
+
}
|
package/dist/index.d.ts
CHANGED
|
@@ -45,6 +45,31 @@ export interface ResourceProviderMethods {
|
|
|
45
45
|
export interface ResourceProviderRegistry {
|
|
46
46
|
registerResourceProvider: (provider: ResourceProvider) => void;
|
|
47
47
|
}
|
|
48
|
+
export interface AutopilotApi {
|
|
49
|
+
register: (pluginId: string, provider: AutopilotProvider) => void;
|
|
50
|
+
unRegister: (pluginId: string) => void;
|
|
51
|
+
}
|
|
52
|
+
export interface AutopilotProvider {
|
|
53
|
+
pilotType: string;
|
|
54
|
+
methods: AutopilotProviderMethods;
|
|
55
|
+
}
|
|
56
|
+
export interface AutopilotProviderMethods {
|
|
57
|
+
pluginId?: string;
|
|
58
|
+
engage: (enable: boolean) => Promise<void>;
|
|
59
|
+
getConfig: () => Promise<{
|
|
60
|
+
[key: string]: any;
|
|
61
|
+
}>;
|
|
62
|
+
getState: () => Promise<string>;
|
|
63
|
+
setState: (state: string) => Promise<void>;
|
|
64
|
+
getMode: () => Promise<string>;
|
|
65
|
+
setMode: (mode: string) => Promise<void>;
|
|
66
|
+
setTarget: (value: number) => Promise<void>;
|
|
67
|
+
adjustTarget: (value: number) => Promise<void>;
|
|
68
|
+
tack: (port: boolean) => Promise<void>;
|
|
69
|
+
}
|
|
70
|
+
export interface AutopilotProviderRegistry {
|
|
71
|
+
registerAutopilotProvider: (provider: AutopilotProvider) => void;
|
|
72
|
+
}
|
|
48
73
|
declare type Unsubscribe = () => {};
|
|
49
74
|
export interface PropertyValuesEmitter {
|
|
50
75
|
emitPropertyValue: (name: string, value: any) => void;
|
|
@@ -56,7 +81,7 @@ export interface PropertyValuesEmitter {
|
|
|
56
81
|
*
|
|
57
82
|
* INCOMPLETE, work in progress.
|
|
58
83
|
*/
|
|
59
|
-
export interface PluginServerApp extends PropertyValuesEmitter, ResourceProviderRegistry {
|
|
84
|
+
export interface PluginServerApp extends PropertyValuesEmitter, ResourceProviderRegistry, AutopilotProviderRegistry {
|
|
60
85
|
}
|
|
61
86
|
/**
|
|
62
87
|
* This is the API that a [server plugin](https://github.com/SignalK/signalk-server/blob/master/SERVERPLUGINS.md) must implement.
|
package/package.json
CHANGED