Skip to content

Commit 1cac04d

Browse files
fstasiAlberto Iannaccone
fstasi
authored and
Alberto Iannaccone
committed
plotter communication
1 parent 8b65d2a commit 1cac04d

File tree

9 files changed

+95
-33
lines changed

9 files changed

+95
-33
lines changed

‎arduino-ide-extension/package.json‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@
1919
"test:watch": "mocha --watch --watch-files lib \"./lib/test/**/*.test.js\""
2020
},
2121
"dependencies": {
22-
"arduino-serial-plotter-webapp": "0.0.2",
22+
"arduino-serial-plotter-webapp": "0.0.3",
2323
"@grpc/grpc-js": "^1.3.7",
2424
"@theia/application-package": "1.18.0",
2525
"@theia/core": "1.18.0",

‎arduino-ide-extension/src/browser/monitor/monitor-connection.ts‎

Lines changed: 23 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,7 @@ import {
2020
import { BoardsConfig } from '../boards/boards-config';
2121
import { MonitorModel } from './monitor-model';
2222
import { NotificationCenter } from '../notification-center';
23+
import { ThemeService } from '@theia/core/lib/browser/theming';
2324
import { nls } from '@theia/core/lib/browser/nls';
2425

2526
export enum SerialType {
@@ -56,6 +57,9 @@ export class MonitorConnection {
5657
@inject(MonitorModel)
5758
protected readonly model: MonitorModel;
5859

60+
@inject(ThemeService)
61+
protected readonly themeService: ThemeService;
62+
5963
protected _state: MonitorConnection.State = [];
6064
protected _connected: boolean;
6165

@@ -90,21 +94,27 @@ export class MonitorConnection {
9094
protected init(): void {
9195
this.monitorServiceClient.onWebSocketChanged(
9296
this.handleWebSocketChanged.bind(this)
93-
),
94-
this.monitorServiceClient.onError(this.handleError.bind(this)),
95-
this.boardsServiceProvider.onBoardsConfigChanged(
96-
this.handleBoardConfigChange.bind(this)
97-
),
98-
this.notificationCenter.onAttachedBoardsChanged(
99-
this.handleAttachedBoardsChanged.bind(this)
100-
);
97+
);
98+
this.monitorServiceClient.onError(this.handleError.bind(this));
99+
this.boardsServiceProvider.onBoardsConfigChanged(
100+
this.handleBoardConfigChange.bind(this)
101+
);
102+
this.notificationCenter.onAttachedBoardsChanged(
103+
this.handleAttachedBoardsChanged.bind(this)
104+
);
101105
// Handles the `baudRate` changes by reconnecting if required.
102106
this.monitorModel.onChange(({ property }) => {
103107
if (property === 'baudRate' && this.connected) {
104108
const { boardsConfig } = this.boardsServiceProvider;
105109
this.handleBoardConfigChange(boardsConfig);
106110
}
107111
});
112+
113+
this.themeService.onDidColorThemeChange((theme) => {
114+
this.monitorService.updateWsConfigParam({
115+
darkTheme: theme.newTheme.type === 'dark',
116+
});
117+
});
108118
}
109119

110120
protected setConfig(newConfig: Partial<MonitorConfig>): void {
@@ -411,7 +421,7 @@ export class MonitorConnection {
411421
}
412422
return new Promise<Status>((resolve) => {
413423
this.monitorService
414-
.send(data + this.monitorModel.lineEnding)
424+
.sendMessageToSerial(data + this.monitorModel.lineEnding)
415425
.then(() => resolve(Status.OK));
416426
});
417427
}
@@ -438,6 +448,10 @@ export class MonitorConnection {
438448
if (ports.some((port) => Port.equals(port, boardsConfig.selectedPort))) {
439449
const { selectedBoard: board, selectedPort: port } = boardsConfig;
440450
const { baudRate } = this.monitorModel;
451+
// update the baudrate on the config
452+
this.monitorService.updateWsConfigParam({
453+
currentBaudrate: baudRate,
454+
});
441455
const newConfig: MonitorConfig = { board, port, baudRate };
442456
this.setConfig(newConfig);
443457
}

‎arduino-ide-extension/src/browser/plotter/plotter-frontend-contribution.ts‎

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
import { ThemeService } from '@theia/core/lib/browser/theming';
12
import { injectable, inject } from 'inversify';
23
import {
34
Command,
@@ -37,6 +38,9 @@ export class PlotterFrontendContribution extends Contribution {
3738
@inject(MonitorModel)
3839
protected readonly model: MonitorModel;
3940

41+
@inject(ThemeService)
42+
protected readonly themeService: ThemeService;
43+
4044
@inject(MonitorConnection)
4145
protected readonly monitorConnection: MonitorConnection;
4246

@@ -90,7 +94,8 @@ export class PlotterFrontendContribution extends Contribution {
9094
const initConfig: SerialPlotter.Config = {
9195
baudrates: MonitorConfig.BaudRates.map((b) => b),
9296
currentBaudrate: this.model.baudRate,
93-
darkTheme: true,
97+
currentLineEnding: this.model.lineEnding,
98+
darkTheme: this.themeService.getCurrentTheme().type === 'dark',
9499
wsPort,
95100
};
96101
const urlWithParams = queryString.stringifyUrl(

‎arduino-ide-extension/src/browser/plotter/protocol.ts‎

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,18 +2,17 @@ export namespace SerialPlotter {
22
export type Config = {
33
currentBaudrate: number;
44
baudrates: number[];
5+
currentLineEnding: string;
56
darkTheme: boolean;
67
wsPort: number;
78
generate?: boolean;
89
};
910
export namespace Protocol {
1011
export enum Command {
11-
PLOTTER_REQUEST_CONFIG = 'PLOTTER_REQUEST_CONFIG',
12-
PLOTTER_READY = 'PLOTTER_READY',
1312
PLOTTER_SET_BAUDRATE = 'PLOTTER_SET_BAUDRATE',
1413
PLOTTER_SET_LINE_ENDING = 'PLOTTER_SET_LINE_ENDING',
1514
PLOTTER_SEND_MESSAGE = 'PLOTTER_SEND_MESSAGE',
16-
PARENT_SET_CONFIG = 'PARENT_SET_CONFIG',
15+
MIDDLEWARE_CONFIG_CHANGED = 'MIDDLEWARE_CONFIG_CHANGED',
1716
}
1817
export type Message = {
1918
command: SerialPlotter.Protocol.Command;

‎arduino-ide-extension/src/common/protocol/monitor-service.ts‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
import { JsonRpcServer } from '@theia/core/lib/common/messaging/proxy-factory';
22
import { Board, Port } from './boards-service';
33
import { Event } from '@theia/core/lib/common/event';
4+
import { SerialPlotter } from '../../browser/plotter/protocol';
45

56
export interface Status {}
67
export type OK = Status;
@@ -23,7 +24,8 @@ export const MonitorService = Symbol('MonitorService');
2324
export interface MonitorService extends JsonRpcServer<MonitorServiceClient> {
2425
connect(config: MonitorConfig): Promise<Status>;
2526
disconnect(): Promise<Status>;
26-
send(message: string): Promise<Status>;
27+
sendMessageToSerial(message: string): Promise<Status>;
28+
updateWsConfigParam(config: Partial<SerialPlotter.Config>): Promise<void>;
2729
}
2830

2931
export interface MonitorConfig {

‎arduino-ide-extension/src/node/monitor/monitor-service-impl.ts‎

Lines changed: 46 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,7 @@ import {
1919
import { MonitorClientProvider } from './monitor-client-provider';
2020
import { Board, Port } from '../../common/protocol/boards-service';
2121
import { WebSocketService } from '../web-socket/web-socket-service';
22+
import { SerialPlotter } from '../../browser/plotter/protocol';
2223

2324
interface ErrorWithCode extends Error {
2425
readonly code: number;
@@ -71,7 +72,7 @@ export class MonitorServiceImpl implements MonitorService {
7172
protected readonly webSocketService: WebSocketService;
7273

7374
protected client?: MonitorServiceClient;
74-
protected connection?: {
75+
protected serialConnection?: {
7576
duplex: ClientDuplexStream<StreamingOpenRequest, StreamingOpenResponse>;
7677
config: MonitorConfig;
7778
};
@@ -84,20 +85,30 @@ export class MonitorServiceImpl implements MonitorService {
8485

8586
dispose(): void {
8687
this.logger.info('>>> Disposing monitor service...');
87-
if (this.connection) {
88+
if (this.serialConnection) {
8889
this.disconnect();
8990
}
9091
this.logger.info('<<< Disposed monitor service.');
9192
this.client = undefined;
9293
}
9394

95+
async updateWsConfigParam(
96+
config: Partial<SerialPlotter.Config>
97+
): Promise<void> {
98+
const msg: SerialPlotter.Protocol.Message = {
99+
command: SerialPlotter.Protocol.Command.MIDDLEWARE_CONFIG_CHANGED,
100+
data: config,
101+
};
102+
this.webSocketService.sendMessage(JSON.stringify(msg));
103+
}
104+
94105
async connect(config: MonitorConfig): Promise<Status> {
95106
this.logger.info(
96107
`>>> Creating serial monitor connection for ${Board.toString(
97108
config.board
98109
)} on port ${Port.toString(config.port)}...`
99110
);
100-
if (this.connection) {
111+
if (this.serialConnection) {
101112
return Status.ALREADY_CONNECTED;
102113
}
103114
const client = await this.monitorClientProvider.client();
@@ -108,7 +119,7 @@ export class MonitorServiceImpl implements MonitorService {
108119
return { message: client.message };
109120
}
110121
const duplex = client.streamingOpen();
111-
this.connection = { duplex, config };
122+
this.serialConnection = { duplex, config };
112123

113124
duplex.on(
114125
'error',
@@ -137,6 +148,27 @@ export class MonitorServiceImpl implements MonitorService {
137148
}
138149
};
139150

151+
this.webSocketService.onMessageReceived((msg: string) => {
152+
try {
153+
const message: SerialPlotter.Protocol.Message = JSON.parse(msg);
154+
155+
switch (message.command) {
156+
case SerialPlotter.Protocol.Command.PLOTTER_SEND_MESSAGE:
157+
this.sendMessageToSerial(message.data);
158+
break;
159+
160+
case SerialPlotter.Protocol.Command.PLOTTER_SET_BAUDRATE:
161+
break;
162+
163+
case SerialPlotter.Protocol.Command.PLOTTER_SET_LINE_ENDING:
164+
break;
165+
166+
default:
167+
break;
168+
}
169+
} catch (error) {}
170+
});
171+
140172
// empty the queue every 16ms (~60fps)
141173
setInterval(flushMessagesToFrontend, 32);
142174

@@ -187,8 +219,8 @@ export class MonitorServiceImpl implements MonitorService {
187219
req.setConfig(monitorConfig);
188220

189221
return new Promise<Status>((resolve) => {
190-
if (this.connection) {
191-
this.connection.duplex.write(req, () => {
222+
if (this.serialConnection) {
223+
this.serialConnection.duplex.write(req, () => {
192224
this.logger.info(
193225
`<<< Serial monitor connection created for ${Board.toString(
194226
config.board,
@@ -206,40 +238,40 @@ export class MonitorServiceImpl implements MonitorService {
206238
async disconnect(reason?: MonitorError): Promise<Status> {
207239
try {
208240
if (
209-
!this.connection &&
241+
!this.serialConnection &&
210242
reason &&
211243
reason.code === MonitorError.ErrorCodes.CLIENT_CANCEL
212244
) {
213245
return Status.OK;
214246
}
215247
this.logger.info('>>> Disposing monitor connection...');
216-
if (!this.connection) {
248+
if (!this.serialConnection) {
217249
this.logger.warn('<<< Not connected. Nothing to dispose.');
218250
return Status.NOT_CONNECTED;
219251
}
220-
const { duplex, config } = this.connection;
252+
const { duplex, config } = this.serialConnection;
221253
duplex.cancel();
222254
this.logger.info(
223255
`<<< Disposed monitor connection for ${Board.toString(config.board, {
224256
useFqbn: false,
225257
})} on port ${Port.toString(config.port)}.`
226258
);
227-
this.connection = undefined;
259+
this.serialConnection = undefined;
228260
return Status.OK;
229261
} finally {
230262
this.messages.length = 0;
231263
}
232264
}
233265

234-
async send(message: string): Promise<Status> {
235-
if (!this.connection) {
266+
async sendMessageToSerial(message: string): Promise<Status> {
267+
if (!this.serialConnection) {
236268
return Status.NOT_CONNECTED;
237269
}
238270
const req = new StreamingOpenRequest();
239271
req.setData(new TextEncoder().encode(message));
240272
return new Promise<Status>((resolve) => {
241-
if (this.connection) {
242-
this.connection.duplex.write(req, () => {
273+
if (this.serialConnection) {
274+
this.serialConnection.duplex.write(req, () => {
243275
resolve(Status.OK);
244276
});
245277
return;

‎arduino-ide-extension/src/node/web-socket/web-socket-service-impl.ts‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
import { Emitter } from '@theia/core';
12
import { injectable } from 'inversify';
23
import * as WebSocket from 'ws';
34
import { WebSocketService } from './web-socket-service';
@@ -7,6 +8,9 @@ export default class WebSocketServiceImpl implements WebSocketService {
78
protected wsClients: WebSocket[];
89
protected server: WebSocket.Server;
910

11+
protected readonly onMessage = new Emitter<string>();
12+
public readonly onMessageReceived = this.onMessage.event;
13+
1014
constructor() {
1115
this.server = new WebSocket.Server({ port: 0 });
1216
this.server.on('connection', this.addClient.bind(this));
@@ -18,6 +22,10 @@ export default class WebSocketServiceImpl implements WebSocketService {
1822
ws.onclose = () => {
1923
this.wsClients.splice(this.wsClients.indexOf(ws), 1);
2024
};
25+
26+
ws.onmessage = (res) => {
27+
this.onMessage.fire(res.data.toString());
28+
};
2129
}
2230

2331
getAddress(): WebSocket.AddressInfo {

‎arduino-ide-extension/src/node/web-socket/web-socket-service.ts‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,9 @@
1+
import { Event } from '@theia/core/lib/common/event';
12
import * as WebSocket from 'ws';
23

34
export const WebSocketService = Symbol('WebSocketService');
45
export interface WebSocketService {
56
getAddress(): WebSocket.AddressInfo;
67
sendMessage(message: string): void;
8+
onMessageReceived: Event<string>;
79
}

‎yarn.lock‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4109,10 +4109,10 @@ archive-type@^4.0.0:
41094109
dependencies:
41104110
file-type "^4.2.0"
41114111

4112-
[email protected].2:
4113-
version "0.0.2"
4114-
resolved "https://registry.yarnpkg.com/arduino-serial-plotter-webapp/-/arduino-serial-plotter-webapp-0.0.2.tgz#491950c30b5d29c0169e2b90047c9dcd6f90c5b3"
4115-
integrity sha512-nP1G8F+i2WeGzoNlkuEZiQnFvPfHfK1z5y5lEfa3rTXH18OGrpejmfK2SPBiBMuSirNOni9/FmTxGHIyxaxzDA==
4112+
[email protected].3:
4113+
version "0.0.3"
4114+
resolved "https://registry.yarnpkg.com/arduino-serial-plotter-webapp/-/arduino-serial-plotter-webapp-0.0.3.tgz#ff7136676fa1cf23950751ea6a675372b3d1eb25"
4115+
integrity sha512-qGxok+UQsuOVk5aOPxGjcXorQYHBNPA5fUgwMt/EbusqOnwphMHDeC3wJ3K82bNwcjg1Yf2xNJI4bRLRv+tNxw==
41164116

41174117
are-we-there-yet@~1.1.2:
41184118
version "1.1.5"

0 commit comments

Comments
 (0)