forked from microsoft/devicescript
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathsideprotocol.ts
More file actions
133 lines (117 loc) · 3.06 KB
/
Copy pathsideprotocol.ts
File metadata and controls
133 lines (117 loc) · 3.06 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
import type { CompilationResult } from "@devicescript/compiler"
import { ConnectionState } from "jacdac-ts"
import type { BuildOptions } from "./build"
export interface SideReq<T extends string = string> {
req: T
seq?: number
data: any
}
export interface SideResp<T extends string = string> {
resp: T
seq?: number
data: any
}
export interface SideEvent<T extends string = string> {
ev: T
data: any
}
export interface SideErrorResp extends SideResp<"error"> {
data: {
message: string
stack?: string
}
}
// enable/disable reception of {bcast:true} packets
export interface SideBcastReq extends SideReq<"bcast"> {
data: { enabled: boolean }
}
export interface SideBuildReq extends SideReq<"build"> {
data: BuildReqArgs
}
export interface SideBuildResp extends SideResp<"build"> {
data: BuildStatus
}
export interface SideKillReq extends SideReq<"kill"> {
}
export interface SideKillResp extends SideResp<"kill"> {
data: void
}
export interface SideWatchReq extends SideReq<"watch"> {
data: BuildReqArgs
}
export interface SideWatchResp extends SideResp<"watch"> {
// no real response
data: void
}
// but will get events every now and then
export interface SideWatchEvent extends SideEvent<"watch"> {
data: BuildStatus
}
export interface SideConnectReq extends SideReq<"connect"> {
data: ConnectReqArgs
}
export interface SideSpecsReq extends SideReq<"specs"> {
data: {}
}
export interface SideSpecsResp extends SideResp<"specs"> {
data: {
specs: jdspec.ServiceSpec[]
version: string
runtimeVersion: string
nodeVersion: string
}
}
export interface SideStartVmReq extends SideReq<"startVM"> {
data: VmReqArgs
}
export interface SideStartVmResp extends SideResp<"startVM"> {
data: {}
}
export interface SideStopVmReq extends SideReq<"stopVM"> {
data: {}
}
export interface SideStopVmResp extends SideResp<"stopVM"> {
data: void
}
export interface SideTransportEvent extends SideEvent<"transport"> {
data: TransportStatus
}
export interface TransportStatus {
autoConnect?: boolean
transports: {
type: string
connectionState: ConnectionState
description?: string
}[]
}
export interface SideTransportResp extends SideResp<"transport"> {
data: TransportStatus
}
export type OutputFrom = "vm" | "vm-err" | "dev" | "verbose"
export interface SideOutputEvent extends SideEvent<"output"> {
data: {
from: OutputFrom
lines: string[]
}
}
export type BuildStatus = CompilationResult & { deployStatus: string }
export interface BuildReqArgs {
filename: string
buildOptions?: BuildOptions
deployTo?: string // deviceId
}
export interface ConnectReqArgs {
transport?: "serial" | "usb" | "spi" | "websocket" | string
background?: boolean
resourceGroupId?: string
}
export interface WebSocketConnectReqArgs extends ConnectReqArgs {
transport: "websocket"
url: string
protocol: string
}
export interface VmReqArgs {
nativePath?: string
deviceId?: string
gcStress?: boolean
}