You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+7-4Lines changed: 7 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -22,12 +22,15 @@ The following clients are also available:
22
22
|[ArduinoSerialToTCPBridgeClient](https://github.com/RoanBrand/ArduinoSerialToTCPBridgeClient)| Arduino | C++ |
23
23
|[STM32SerialToTCPBridgeClient](https://github.com/RoanBrand/STM32SerialToTCPBridgeClient)| STM32 | C |
24
24
25
-
#### Build and Run
25
+
#### Get and Run
26
+
- Check the releases page for the latest built binaries.
27
+
- Get and configure `config.json`. The serial port in Linux for the Arduino Uno is something like `/dev/ttyACM0`.
28
+
29
+
#### Development and Building
26
30
- Install [Go](https://go.dev/dl/) for your system.
27
-
- Run `go install github.com/RoanBrand/SerialToTCPBridgeProtocol@latest` in a terminal.
28
-
- Copy *config.json* from the repository and the installed executable `~/go/bin/SerialToTCPBridgeProtocol` to a new folder.
31
+
- Clone this repository.
29
32
- Edit your local `config.json` and set it according to your Serial port configuration.
30
-
-Run the `SerialToTCPBridgeProtocol` executable.
33
+
-Debug `example.go` in your IDE, or run `go run example.go` or `go build` for a binary.
31
34
32
35
#### Details
33
36
- The protocol provides the app an in order, duplicates free and error checked byte stream by adding a CRC32 and simple retry mechanism. See [this](https://en.wikibooks.org/wiki/Serial_Programming/Error_Correction_Methods) for background.
0 commit comments