Initial Commit

Author: JonathanBout

.github/workflows/go-release.yml

@@ -0,0 +1,41 @@
+name: Build Go Project & Attach exe to release
+
+on:
+  push:
+    tags: [ 'v*.*.*' ]
+
+permissions:
+  contents: write
+
+jobs:
+  publish:
+    name: Publish for ${{ matrix.os }}
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        include:
+          - os: ubuntu-24.04
+            asset_name: ssc-linux-amd64
+          - os: ubuntu-24.04-arm
+            asset_name: ssc-linux-arm64
+          - os: windows-2025
+            asset_name: ssc-windows-amd64.exe
+
+    steps:
+    - uses: actions/checkout@v4
+    - name: Set up Go
+      uses: actions/setup-go@v4
+      with:
+        go-version: '1.24'
+        check-latest: true
+        cache-dependency-path: "**/*.sum"
+
+    - name: Build
+      run: go build -v -o ssc
+    - name: Upload binaries to release
+      uses: svenstaro/upload-release-action@v2
+      with:
+        repo_token: ${{ github.token }}
+        file: ssc
+        asset_name: ${{ matrix.asset_name }}
+        tag: ${{ github.ref }}

.github/workflows/go.yml

@@ -0,0 +1,25 @@
+# This workflow will build a golang project
+# For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-go
+
+name: Go
+
+on:
+  push:
+    branches: [ "main" ]
+  pull_request:
+    branches: [ "main" ]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v4
+    - name: Set up Go
+      uses: actions/setup-go@v4
+      with:
+        go-version: '1.24'
+        check-latest: true
+        cache-dependency-path: "**/*.sum"
+
+    - name: Build
+      run: go build -v .

.gitignore

@@ -0,0 +1,2 @@
+simple-serial-console
+simple-serial-console.exe

README.md

@@ -0,0 +1,13 @@
+# Simple Serial Console
+_replace `ssc` with the name of your binary, e.g. `ssc-windows-amd64`_
+
+## Usage
+```
+ssc <port> [<baud rate>]
+```
+### `<port>`
+#### Windows
+A COM Port `COMX` where X is a number
+
+#### Linux
+A USB TTY, usually something like `/dev/ttyUSBX` where X is a number

go.mod

@@ -0,0 +1,7 @@
+module jonathanbout/simple-serial-console
+
+go 1.18
+
+require github.com/tarm/serial v0.0.0-20180830185346-98f6abe2eb07
+
+require golang.org/x/sys v0.0.0-20220829200755-d48e67d00261 // indirect

go.sum

@@ -0,0 +1,4 @@
+github.com/tarm/serial v0.0.0-20180830185346-98f6abe2eb07 h1:UyzmZLoiDWMRywV4DUYb9Fbt8uiOSooupjTq10vpvnU=
+github.com/tarm/serial v0.0.0-20180830185346-98f6abe2eb07/go.mod h1:kDXzergiv9cbyO7IOYJZWg1U88JhDg3PB6klq9Hg2pA=
+golang.org/x/sys v0.0.0-20220829200755-d48e67d00261 h1:v6hYoSR9T5oet+pMXwUWkbiVqx/63mlHjefrHmxwfeY=
+golang.org/x/sys v0.0.0-20220829200755-d48e67d00261/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=

main.go

@@ -0,0 +1,122 @@
+package main
+
+import (
+	"bufio"
+	"fmt"
+	"os"
+	"strconv"
+	"strings"
+
+	"github.com/tarm/serial"
+)
+
+func main() {
+	// args[0] is the exe path, which we don't need
+	args := os.Args[1:]
+
+	inputPort := ""
+	inputBaudRate := 115200
+
+	// the first argument has to be the USB/Serial Device
+	if len(args) > 0 {
+		// find args[0] in serialPorts
+		inputPort = args[0]
+	} else {
+		criticalError("Provide a port name")
+	}
+
+	// Optionally, the second argument can be the baud rate.
+	// Default rate is 115200
+	if len(args) > 1 {
+		i, err := strconv.Atoi(args[1])
+
+		if err != nil {
+			fmt.Println(err)
+			criticalError("Invalid baud rate")
+		}
+
+		if i < 0 {
+			criticalError("Invalid baud rate")
+		}
+
+		inputBaudRate = i
+	}
+
+	begin(inputPort, inputBaudRate)
+}
+
+// Opens a new connection on the specified port at the specified baud rate
+func begin(portName string, baudRate int) {
+	config := &serial.Config{
+		Baud: baudRate,
+		Name: portName,
+	}
+
+	port, err := serial.OpenPort(config)
+	if err != nil {
+		criticalError("Error opening serial port: " + err.Error())
+	}
+
+	// close the port when this method exits
+	defer func(port *serial.Port) {
+		err := port.Close()
+		if err != nil {
+			criticalError("Error closing serial port: " + err.Error() + ". The connection might stay open.")
+		}
+	}(port)
+
+	// asynchronously read input
+	go userInput(port)
+
+	// while also receiving data from the serial device
+	buf := make([]byte, 1024)
+	fmt.Println("Output Ready!")
+
+	for {
+		n, err := port.Read(buf)
+
+		if err != nil {
+			criticalError("Error reading from serial port: " + err.Error())
+		}
+
+		fmt.Printf("%s", string(buf[:n]))
+	}
+}
+
+// reads the standard input until the next EOF,
+// or until the input line equals "exit"
+func userInput(port *serial.Port) {
+	reader := bufio.NewReader(os.Stdin)
+	fmt.Println("Input Ready!")
+	for {
+		input, err := reader.ReadString('\n')
+
+		if err != nil {
+			if err.Error() == "EOF" {
+				os.Exit(0)
+			}
+
+			criticalError("Error reading input: " + err.Error())
+		}
+
+		if len(input) == 0 {
+			continue
+		}
+
+		input = strings.TrimSpace(input)
+
+		// write the input data to the port,
+		// after appending a newline character to it
+		_, err = port.Write([]byte(input + "\n"))
+
+		if err != nil {
+			criticalError("Error writing to serial port: " + err.Error())
+		}
+	}
+}
+
+// helper method to print a critical error and exit with code 1
+func criticalError(message string) {
+	fmt.Println(message)
+	os.Exit(1)
+}