https://github.com/einride/can-go
Controller Area Network (CAN) SDK for Go.
https://github.com/einride/can-go
autonomous-vehicles can canbus dbc go golang socketcan
Last synced: about 1 month ago
JSON representation
Controller Area Network (CAN) SDK for Go.
- Host: GitHub
- URL: https://github.com/einride/can-go
- Owner: einride
- License: mit
- Created: 2019-10-01T23:23:25.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2025-03-31T03:33:41.000Z (about 2 months ago)
- Last Synced: 2025-04-03T23:11:19.706Z (about 2 months ago)
- Topics: autonomous-vehicles, can, canbus, dbc, go, golang, socketcan
- Language: Go
- Homepage:
- Size: 354 KB
- Stars: 201
- Watchers: 27
- Forks: 40
- Open Issues: 22
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Codeowners: .github/CODEOWNERS
- Security: SECURITY.md
Awesome Lists containing this project
README
# :electric_plug: go.einride.tech/can
[](https://pkg.go.dev/go.einride.tech/can)
[](https://goreportcard.com/report/go.einride.tech/can)
[](https://codecov.io/gh/einride/can-go)
CAN toolkit for Go programmers.
can-go makes use of the Linux SocketCAN abstraction for CAN communication. (See
the [SocketCAN](https://www.kernel.org/doc/Documentation/networking/can.txt)
documentation for more details).
## Installation
```
go get -u go.einride.tech/can
```
## Examples
### Setting up a CAN interface
```go
import "go.einride.tech/can/pkg/candevice"
func main() {
// Error handling omitted to keep example simple
d, _ := candevice.New("can0")
_ := d.SetBitrate(250000)
_ := d.SetUp()
defer d.SetDown()
}
```
### Receiving CAN frames
Receiving CAN frames from a socketcan interface.
```go
import "go.einride.tech/can/pkg/socketcan"
func main() {
// Error handling omitted to keep example simple
conn, _ := socketcan.DialContext(context.Background(), "can", "can0")
recv := socketcan.NewReceiver(conn)
for recv.Receive() {
frame := recv.Frame()
fmt.Println(frame.String())
}
}
```
### Sending CAN frames/messages
Sending CAN frames to a socketcan interface.
```go
import "go.einride.tech/can/pkg/socketcan"
func main() {
// Error handling omitted to keep example simple
conn, _ := socketcan.DialContext(context.Background(), "can", "can0")
frame := can.Frame{}
tx := socketcan.NewTransmitter(conn)
_ = tx.TransmitFrame(context.Background(), frame)
}
```
### Generating Go code from a DBC file
It is possible to generate Go code from a `.dbc` file.
```
$ go run go.einride.tech/can/cmd/cantool generate
```
In order to generate Go code that makes sense, we currently perform some
validations when parsing the DBC file so there may need to be some changes on
the DBC file to make it work
After generating Go code we can marshal a message to a frame:
```go
// import etruckcan "github.com/myproject/myrepo/gen"
auxMsg := etruckcan.NewAuxiliary().SetHeadLights(etruckcan.Auxiliary_HeadLights_LowBeam)
frame := auxMsg.Frame()
```
Or unmarshal a frame to a message:
```go
// import etruckcan "github.com/myproject/myrepo/gen"
// Error handling omitted for simplicity
_ := recv.Receive()
frame := recv.Frame()
var auxMsg *etruckcan.Auxiliary
_ = auxMsg.UnmarshalFrame(frame)
```
## Running integration tests
Building the tests:
```shell
$ make build-integration-tests
```
Built tests are placed in build/tests.
The candevice test requires access to physical HW, so run it using sudo.
Example:
```shell
$ sudo ./build/tests/candevice.test
> PASS
```