aeterlink-dev · gkuga · Aug 31, 2025 · Feb 11, 2024 · Feb 16, 2024 · Feb 16, 2024
diff --git a/.github/ISSUE_TEMPLATE/bug-report.yml b/.github/ISSUE_TEMPLATE/bug-report.yml
@@ -0,0 +1,78 @@
+# Source: https://github.com/arduino/tooling-project-assets/blob/main/issue-templates/forms/platform-dependent/bug-report.yml
+# See: https://docs.github.com/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-issue-forms
+
+name: Bug report
+description: Report a problem with the code or documentation in this repository.
+labels:
+  - bug
+body:
+  - type: textarea
+    id: description
+    attributes:
+      label: Describe the problem
+    validations:
+      required: true
+  - type: textarea
+    id: reproduce
+    attributes:
+      label: To reproduce
+      description: |
+        Provide the specific set of steps we can follow to reproduce the
+        problem in particular the exact golang source code you used.
+    validations:
+      required: true
+  - type: checkboxes
+    id: checklist-reproduce
+    attributes:
+      label: |
+        Please double-check that you have reported each of the following
+        before submitting the issue.
+      options:
+        - label: I've provided the FULL source code that causes the problem
+          required: true
+        - label: I've provided all the actions required to reproduce the problem
+          required: true
+  - type: textarea
+    id: expected
+    attributes:
+      label: Expected behavior
+      description: |
+        What would you expect to happen after following those instructions?
+    validations:
+      required: true
+  - type: input
+    id: os
+    attributes:
+      label: Operating system and version
+      description: |
+        Which operating system(s) version are you using on your computer?
+    validations:
+      required: true
+  - type: textarea
+    id: boards
+    attributes:
+      label: Please describe your hardware setup
+      description: |
+        Arduino boards, USB dongles, hubs or embedded devices you are using and how they
+        are connected together.
+  - type: textarea
+    id: additional
+    attributes:
+      label: Additional context
+      description: |
+        Add here any additional information that you think might be relevant to
+        the problem.
+    validations:
+      required: false
+  - type: checkboxes
+    id: checklist
+    attributes:
+      label: Issue checklist
+      description: |
+        Please double-check that you have done each of the following things before
+        submitting the issue.
+      options:
+        - label: I searched for previous requests in [the issue tracker](https://github.com/bugst/go-serial/issues)
+          required: true
+        - label: My request contains all necessary details
+          required: true
diff --git a/.github/ISSUE_TEMPLATE/feature-request.yml b/.github/ISSUE_TEMPLATE/feature-request.yml
@@ -0,0 +1,29 @@
+# Source: https://github.com/arduino/tooling-project-assets/blob/main/issue-templates/forms/platform-dependent/feature-request.yml
+# See: https://docs.github.com/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-issue-forms
+
+name: Feature request
+description: Suggest an enhancement to this project.
+labels:
+  - "type: enhancement"
+body:
+  - type: textarea
+    id: description
+    attributes:
+      label: Describe the new feature or change suggestion
+    validations:
+      required: true
+  - type: textarea
+    id: additional
+    attributes:
+      label: Additional context
+      description: Add any additional information about the feature request here.
+  - type: checkboxes
+    id: checklist
+    attributes:
+      label: Issue checklist
+      description: Please double-check that you have done each of the following things before submitting the issue.
+      options:
+        - label: I searched for previous requests in [the issue tracker](https://github.com/bugst/go-serial/issues)
+          required: true
+        - label: My request contains all necessary details
+          required: true
diff --git a/.github/workflows/test.yaml b/.github/workflows/test.yaml
@@ -10,18 +10,28 @@ jobs:
   native-os-build:
     strategy:
       matrix:
-        os: [ubuntu-latest, windows-latest, macOS-latest]
+        # os: [ubuntu-latest, windows-latest, macOS-latest]
+        os: [ubuntu-latest]
 
     runs-on: ${{ matrix.os }}
 
     steps:
-      - uses: actions/checkout@v1
-      - uses: actions/setup-go@v1
+      - uses: actions/checkout@v4
+      - uses: actions/setup-go@v5
         with:
-          go-version: "1.17"
-      - name: Build native
+          go-version: "1.22"
+      - name: Setup CGO Environment
+        run: |
+          if [ ${{ matrix.os }} == 'macOS-latest' ] ; then
+            echo "CGO_ENABLED=1" >> "$GITHUB_ENV"
+          fi
+        shell: bash
+      - name: Build AMD64
         run: GOARCH=amd64 go build -v ./...
         shell: bash
+      - name: Build ARM64
+        run: GOARCH=arm64 go build -v ./...
+        shell: bash
       - name: Install socat
         if: matrix.os == 'ubuntu-latest'
         run: sudo apt-get install socat
@@ -42,19 +52,19 @@ jobs:
     strategy:
       matrix:
         go-os-pairs:
-          - "freebsd amd64"
-          - "openbsd amd64"
-          - "openbsd 386"
-          - "openbsd arm"
+          # - "freebsd amd64"
+          # - "openbsd amd64"
+          # - "openbsd 386"
+          # - "openbsd arm"
           - "linux ppc64le"
 
     runs-on: "ubuntu-latest"
 
     steps:
-      - uses: actions/checkout@v1
-      - uses: actions/setup-go@v1
+      - uses: actions/checkout@v4
+      - uses: actions/setup-go@v5
         with:
-          go-version: "1.17"
+          go-version: "1.22"
       - name: Cross-build
         run: |
           set ${{ matrix.go-os-pairs }}

diff --git a/LICENSE b/LICENSE
@@ -1,5 +1,5 @@
 
-Copyright (c) 2014-2023, Cristian Maglie.
+Copyright (c) 2014-2024, Cristian Maglie.
 All rights reserved.
 
 Redistribution and use in source and binary forms, with or without

diff --git a/README.md b/README.md
@@ -2,25 +2,25 @@
 
 # go.bug.st/serial
 
-A cross-platform serial library for go-lang.
+A cross-platform serial port library for Go.
 
 ## Documentation and examples
 
-See the godoc here: https://godoc.org/go.bug.st/serial
+See the package documentation here: https://pkg.go.dev/go.bug.st/serial
 
 ## go.mod transition
 
-This library now support `go.mod` with the import `go.bug.st/serial`.
+This library supports `go.mod` with the import `go.bug.st/serial`.
 
-If you came from the pre-`go.mod` era please update your import paths from `go.bug.st/serial.v1` to `go.bug.st/serial` to receive new updates. Anyway, the latest `v1` release should still be avaiable using the old import.
+If you came from the pre-`go.mod` era please update your import paths from `go.bug.st/serial.v1` to `go.bug.st/serial` to receive updates. The latest `v1` release is still available using the old import path.
 
 ## Credits
 
 :sparkles: Thanks to all awesome [contributors]! :sparkles:
 
 ## License
 
-The software is release under a [BSD 3-clause license]
+This software is released under the [BSD 3-clause license].
 
 [contributors]: https://github.com/bugst/go-serial/graphs/contributors
 [BSD 3-clause license]: https://github.com/bugst/go-serial/blob/master/LICENSE

diff --git a/doc.go b/doc.go
@@ -1,5 +1,5 @@
 //
-// Copyright 2014-2023 Cristian Maglie. All rights reserved.
+// Copyright 2014-2024 Cristian Maglie. All rights reserved.
 // Use of this source code is governed by a BSD-style
 // license that can be found in the LICENSE file.
 //

diff --git a/enumerator/doc.go b/enumerator/doc.go
@@ -1,5 +1,5 @@
 //
-// Copyright 2014-2023 Cristian Maglie. All rights reserved.
+// Copyright 2014-2024 Cristian Maglie. All rights reserved.
 // Use of this source code is governed by a BSD-style
 // license that can be found in the LICENSE file.
 //

diff --git a/enumerator/enumerator.go b/enumerator/enumerator.go
@@ -1,5 +1,5 @@
 //
-// Copyright 2014-2023 Cristian Maglie. All rights reserved.
+// Copyright 2014-2024 Cristian Maglie. All rights reserved.
 // Use of this source code is governed by a BSD-style
 // license that can be found in the LICENSE file.
 //

diff --git a/enumerator/example_getdetailedportlist_test.go b/enumerator/example_getdetailedportlist_test.go
@@ -1,5 +1,5 @@
 //
-// Copyright 2014-2023 Cristian Maglie. All rights reserved.
+// Copyright 2014-2024 Cristian Maglie. All rights reserved.
 // Use of this source code is governed by a BSD-style
 // license that can be found in the LICENSE file.
 //

diff --git a/enumerator/usb_darwin.go b/enumerator/usb_darwin.go
@@ -1,5 +1,5 @@
 //
-// Copyright 2014-2023 Cristian Maglie. All rights reserved.
+// Copyright 2014-2024 Cristian Maglie. All rights reserved.
 // Use of this source code is governed by a BSD-style
 // license that can be found in the LICENSE file.
 //

diff --git a/enumerator/usb_freebsd.go b/enumerator/usb_freebsd.go
@@ -1,5 +1,5 @@
 //
-// Copyright 2014-2023 Cristian Maglie. All rights reserved.
+// Copyright 2014-2024 Cristian Maglie. All rights reserved.
 // Use of this source code is governed by a BSD-style
 // license that can be found in the LICENSE file.
 //

diff --git a/enumerator/usb_linux.go b/enumerator/usb_linux.go
@@ -1,5 +1,5 @@
 //
-// Copyright 2014-2023 Cristian Maglie. All rights reserved.
+// Copyright 2014-2024 Cristian Maglie. All rights reserved.
 // Use of this source code is governed by a BSD-style
 // license that can be found in the LICENSE file.
 //

diff --git a/enumerator/usb_openbsd.go b/enumerator/usb_openbsd.go
@@ -1,5 +1,5 @@
 //
-// Copyright 2014-2023 Cristian Maglie. All rights reserved.
+// Copyright 2014-2024 Cristian Maglie. All rights reserved.
 // Use of this source code is governed by a BSD-style
 // license that can be found in the LICENSE file.
 //

diff --git a/enumerator/usb_wasm.go b/enumerator/usb_wasm.go
@@ -0,0 +1,11 @@
+//
+// Copyright 2014-2024 Cristian Maglie. All rights reserved.
+// Use of this source code is governed by a BSD-style
+// license that can be found in the LICENSE file.
+//
+
+package enumerator
+
+func nativeGetDetailedPortsList() ([]*PortDetails, error) {
+	return nil, &PortEnumerationError{}
+}
diff --git a/enumerator/usb_windows.go b/enumerator/usb_windows.go
@@ -1,5 +1,5 @@
 //
-// Copyright 2014-2023 Cristian Maglie. All rights reserved.
+// Copyright 2014-2024 Cristian Maglie. All rights reserved.
 // Use of this source code is governed by a BSD-style
 // license that can be found in the LICENSE file.
 //
@@ -98,7 +98,7 @@ const (
 	spdrpUpperFilters                            = 0x00000011 // UpperFilters = R/W
 	spdrpLowerFilters                            = 0x00000012 // LowerFilters = R/W
 	spdrpBusTypeGUID                             = 0x00000013 // BusTypeGUID = R
-	spdrpLegactBusType                           = 0x00000014 // LegacyBusType = R
+	spdrpLegacyBusType                           = 0x00000014 // LegacyBusType = R
 	spdrpBusNumber                               = 0x00000015 // BusNumber = R
 	spdrpEnumeratorName                          = 0x00000016 // Enumerator Name = R
 	spdrpSecurity                                = 0x00000017 // Security = R/W, binary form

diff --git a/enumerator/usb_windows_test.go b/enumerator/usb_windows_test.go
@@ -1,5 +1,5 @@
 //
-// Copyright 2014-2023 Cristian Maglie. All rights reserved.
+// Copyright 2014-2024 Cristian Maglie. All rights reserved.
 // Use of this source code is governed by a BSD-style
 // license that can be found in the LICENSE file.
 //

diff --git a/enumerator_wasm.go b/enumerator_wasm.go
@@ -0,0 +1,15 @@
+//
+// Copyright 2014-2024 Cristian Maglie. All rights reserved.
+// Use of this source code is governed by a BSD-style
+// license that can be found in the LICENSE file.
+//
+
+package serial
+
+import (
+	"errors"
+)
+
+func nativeGetPortsList() ([]string, error) {
+	return nil, errors.New("nativeGetPortsList is not supported on wasm")
+}
diff --git a/example_getportlist_test.go b/example_getportlist_test.go
@@ -1,5 +1,5 @@
 //
-// Copyright 2014-2023 Cristian Maglie. All rights reserved.
+// Copyright 2014-2024 Cristian Maglie. All rights reserved.
 // Use of this source code is governed by a BSD-style
 // license that can be found in the LICENSE file.
 //

diff --git a/example_modem_bits_test.go b/example_modem_bits_test.go
@@ -1,5 +1,5 @@
 //
-// Copyright 2014-2023 Cristian Maglie. All rights reserved.
+// Copyright 2014-2024 Cristian Maglie. All rights reserved.
 // Use of this source code is governed by a BSD-style
 // license that can be found in the LICENSE file.
 //
@@ -14,7 +14,7 @@ import (
 	"github.com/aeterlink-dev/serial"
 )
 
-func ExampleGetSetModemBits() {
+func ExamplePort_GetModemStatusBits() {
 	// Open the first serial port detected at 9600bps N81
 	mode := &serial.Mode{
 		BaudRate: 9600,

diff --git a/example_serialport_test.go b/example_serialport_test.go
@@ -1,5 +1,5 @@
 //
-// Copyright 2014-2023 Cristian Maglie. All rights reserved.
+// Copyright 2014-2024 Cristian Maglie. All rights reserved.
 // Use of this source code is governed by a BSD-style
 // license that can be found in the LICENSE file.
 //
@@ -13,7 +13,7 @@ import (
 	"github.com/aeterlink-dev/serial"
 )
 
-func ExampleSerialPort_SetMode() {
+func ExamplePort_SetMode() {
 	port, err := serial.Open("/dev/ttyACM0", &serial.Mode{})
 	if err != nil {
 		log.Fatal(err)

diff --git a/example_test.go b/example_test.go
@@ -1,5 +1,5 @@
 //
-// Copyright 2014-2023 Cristian Maglie. All rights reserved.
+// Copyright 2014-2024 Cristian Maglie. All rights reserved.
 // Use of this source code is governed by a BSD-style
 // license that can be found in the LICENSE file.
 //

diff --git a/portlist/portlist.go b/portlist/portlist.go
@@ -1,5 +1,5 @@
 //
-// Copyright 2014-2023 Cristian Maglie. All rights reserved.
+// Copyright 2014-2024 Cristian Maglie. All rights reserved.
 // Use of this source code is governed by a BSD-style
 // license that can be found in the LICENSE file.
 //

diff --git a/serial.go b/serial.go
@@ -1,5 +1,5 @@
 //
-// Copyright 2014-2023 Cristian Maglie. All rights reserved.
+// Copyright 2014-2024 Cristian Maglie. All rights reserved.
 // Use of this source code is governed by a BSD-style
 // license that can be found in the LICENSE file.
 //
@@ -164,7 +164,7 @@ const (
 	PortNotFound
 	// InvalidSerialPort the requested port is not a serial port
 	InvalidSerialPort
-	// PermissionDenied the user doesn't have enough priviledges
+	// PermissionDenied the user doesn't have enough privileges
 	PermissionDenied
 	// InvalidSpeed the requested speed is not valid or not supported
 	InvalidSpeed

diff --git a/serial_bsd.go b/serial_bsd.go
@@ -1,5 +1,5 @@
 //
-// Copyright 2014-2023 Cristian Maglie. All rights reserved.
+// Copyright 2014-2024 Cristian Maglie. All rights reserved.
 // Use of this source code is governed by a BSD-style
 // license that can be found in the LICENSE file.
 //