Skip to content

Fix readme #10

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jun 3, 2022
Merged

Fix readme #10

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 3 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,8 +20,7 @@ The application is designed to be as agnostic as possible regarding how and wher

### Config Parameters

The Serial Plotter Web App is initialized by passing a number of parameters in the URL, in the form of a QueryString (eg: http://localhost:3000?currentBaudrate=2400&baudrates=300,1200,2400,4800,9600,19200,38400,57600,74880,115200,230400,250000,500000,1000000,2000000&darkTheme=true&wsPort=5000&connected=true&interpolate=true&generate=true).

The Serial Plotter Web App is initialized by passing a number of parameters in the URL, in the form of a QueryString (eg: http://localhost:3000?darkTheme=true&wsPort=5000&generate=true).

It is possible to update the state of the serial plotter by sending configuration via WebSocket in the form of a JSON-stringified object see the [Command](#websocket-communication-protocol) section below.

Expand Down Expand Up @@ -82,7 +81,7 @@ There are 4 different messages that can be sent/received:

#### Monitor Settings

Settings changes, sent and received in the Serial Plotter App, must follow the following object structure
Settings changes, sent and received in the Serial Plotter App, must have the following object structure

```
Partial<MonitorSettings> = {
Expand All @@ -91,7 +90,7 @@ Partial<MonitorSettings> = {
}
```

That means a Setting Message can container `pluggableMonitorSettings` and/or `monitorUISettings`.
That means a Setting Message can contain `pluggableMonitorSettings` and/or `monitorUISettings`.

Let's take a look at the difference between the two:

Expand Down
2 changes: 1 addition & 1 deletion package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "arduino-serial-plotter-webapp",
"version": "0.0.18",
"version": "0.1.0",
"dependencies": {},
"license": "AGPL",
"scripts": {
Expand Down