Skip to content

Commit 980bf45

Browse files
committed
First commit of readme.
1 parent 684d54e commit 980bf45

File tree

1 file changed

+24
-1
lines changed

1 file changed

+24
-1
lines changed

Diff for: README.md

+24-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,27 @@
11
serial-port-json-server
22
=======================
33

4-
A serial port JSON websocket & web server that runs in your system tray on Windows, Mac, or Linux that lets you communicate with your serial port from a web application. This enables web apps to be written that can communicate with your local serial device such as an Arduino, CNC controller, or any device that communicates over the serial port.
4+
A serial port JSON websocket & web server that runs in your system tray on
5+
Windows, Mac, or Linux that lets you communicate with your serial port from a
6+
web application. This enables web apps to be written that can communicate with
7+
your local serial device such as an Arduino, CNC controller, or any device that
8+
communicates over the serial port.
9+
10+
The app is written in Go. It has an embedded web server and websocket server.
11+
The server runs on the standard port of localhost:8999. You can connect to
12+
it locally with your browser to interact.
13+
14+
The app is one executable with everything you need and is available ready-to-go
15+
for every major platform.
16+
17+
If you are a web developer and want to write a web application that connects
18+
to somebody's local serial port server, then you simply need to create a new DNS entry
19+
under your domain called something like serialjson.mydomain.com and map it to
20+
127.0.0.1 to solve for the cross-domain Ajax policy. Then simply create a websocket
21+
connection to serialjson.mydomain.com and you will be directly interacting with
22+
that user's serial port.
23+
24+
For example, if you wanted to create a Gcode Sender web app to enable people to send
25+
3D print or milling commands from your site, this would be a perfect use case. Or if
26+
you've created an oscilloscope web app that connects to an Arduino, it would be another
27+
great use case. Finally you can write web apps that interact with a user's local hardware.

0 commit comments

Comments
 (0)