n2k

README

n2k

n2k is a standalone Go library and CLI for NMEA 2000 (N2K) — the CAN-based network that connects marine instruments (GPS, depth, wind, engine, autopilot) on boats. It reads, writes, filters, and replays bus traffic from CAN hardware, USB-CAN adapters, WiFi gateways, and capture files, decoding messages into strongly typed Go structs while preserving byte-exact wire payloads for re-encoding.

It is the Go foundation for NMEA 2000 software — the bus toolkit itself, not a plugin or companion layer for another app. Use it directly in telemetry collectors, loggers, gateways, test rigs, monitoring services, automation, and any Go program that needs to understand or participate on an N2K bus.

Why n2k

• ~600 typed PGN message types. A PGN (Parameter Group Number) is NMEA 2000's message-type identifier; n2k decodes ~600 of them into Go structs (348 distinct numbers, including manufacturer-proprietary variants), generated from the community-maintained canboat schema — the reference database for open NMEA 2000 decoding. Every numeric field with a physical interpretation gets a generated SI-unit accessor (heading.HeadingValue() → radians) over raw wire ticks.
• Byte-perfect re-encode. Decode → re-encode round trips preserve the original payload bytes, verified against real captures — because decoded numeric fields keep their raw wire ticks underneath.
• A real bus node, not just a decoder. NewClient claims an address per ISO 11783, heartbeats, answers product/configuration info and ISO requests, and handles NMEA group functions (transmit / retime / pause) — the protocol behavior NMEA 2000 requires of a transmitting device, handled for you.
• Pure Go, CGO-free, cross-compiles to Linux, macOS, and Windows.

Quick Start — No Boat Required

The repo bundles a real six-second capture from a sailing vessel (testdata/sample.log), so your first run works at a desk:

git clone https://github.com/open-ships/n2k && cd n2k
go run ./cmd/n2k sniff -file testdata/sample.log | jq .

Or in code — it runs as-is:

package main

import (
	"context"
	"fmt"
	"log"

	"github.com/open-ships/n2k"
	"github.com/open-ships/n2k/pgn"
)

func main() {
	ctx := context.Background()

	for msg, err := range n2k.Receive(ctx, n2k.File("testdata/sample.log")) {
		if err != nil {
			log.Fatal(err)
		}
		if heading, ok := msg.(*pgn.VesselHeading); ok {
			if rad, present := heading.HeadingValue(); present {
				fmt.Printf("heading: %.4f rad\n", rad)
			}
		}
	}
}

On a boat, only the source option changes:

n2k.CAN("can0")                            // SocketCAN (Linux)
n2k.USB("/dev/ttyUSB0")                    // USB-CAN serial adapter
n2k.TCP("192.168.4.1:1457", n2k.FormatYDRaw)  // Yacht Devices WiFi gateway
n2k.UDP(":1457", n2k.FormatYDRaw)          // same gateway, UDP broadcast
n2k.TCP("10.0.0.5:2000", n2k.FormatActisense) // Actisense-format streams

The TCP/UDP sources mean you can develop on your laptop against your boat's WiFi gateway — no CAN interface, no Linux, no cross-compiling until you deploy. TCP works for the write path too: NewClient over a Yacht Devices gateway in RAW mode is a full bus node, address claiming included, over the WiFi gateway.

Add it to your project

go get github.com/open-ships/n2k                    # library
go install github.com/open-ships/n2k/cmd/n2k@latest # CLI

Prebuilt CLI binaries for Linux, macOS, and Windows are on the releases page.

Releases follow semver with a v0 major (v0.x.y). Every green build on main automatically cuts a patch release (with prebuilt CLI binaries); minor bumps are tagged manually when the API moves. While the major version is 0, minor releases may contain breaking API changes — pin accordingly.

The n2k CLI

Once installed (see Add it to your project):

# Yacht Devices WiFi gateway (RAW server mode) -- decoded JSON in one command
n2k sniff -tcp 192.168.4.1:1457

# SocketCAN (Linux), USB-CAN serial, UDP, or capture replay
n2k sniff -i can0
n2k sniff -u /dev/ttyUSB0
n2k sniff -udp :1457
n2k sniff -file capture.log            # add -timing to replay at real speed

# CEL filtering, unknown PGNs, jq-friendly output
n2k sniff -i can0 -f 'pgn == 127250' -unknown | jq .

The CLI currently ships sniff and version; the Go API provides the full read/write client, replay, request/response, registry, and broadcast features.

Using n2k

Everything the library does, mapped to its API:

Area	Functionality	API / command
Read decoded traffic	Decode live or recorded NMEA 2000 frames into typed PGN structs.	Receive, NewScanner, n2k sniff
Write PGNs	Encode PGN structs back to byte-preserving CAN frames or gateway messages.	NewClient, Client.Write
Act as a bus node	Claim an address, heartbeat, answer product/configuration info and ISO requests, and handle group functions.	NewClient, WithName, WithProductInfo, WithConfigInfo
Schedule transmissions	Broadcast PGNs periodically and let other devices retime or pause them through group functions.	Client.Broadcast
Request data	Send typed ISO requests and await typed replies.	Request[T]
Discover devices	Track observed devices by stable 64-bit NAME and current source address.	Client.Devices, Client.DeviceAt
Read many sources	Use SocketCAN, USB-CAN serial adapters, TCP/UDP gateways, candump logs, or in-memory frames.	CAN, USB, TCP, UDP, File, Replay
Gateway formats	Speak Yacht Devices RAW and Actisense-format gateway streams.	FormatYDRaw, FormatActisense
Physical values	Keep raw wire ticks while exposing generated SI-unit accessors.	<Field>Value, Set<Field>Value, pgn.PhysicalValue
Filter traffic	Filter by PGN metadata or decoded fields with CEL; metadata-only filters avoid decode work.	Filter
Preserve unknowns	Drop undecoded PGNs by default or surface them for logging/research.	IncludeUnknown, *pgn.UnknownPGN
Test without hardware	Replay bundled or custom captures and inspect written frames in tests.	File, OriginalTiming, Replay, WrittenFrames

Reading and Writing

Client provides read and write access to NMEA 2000. Use it when you need to transmit messages in addition to receiving them.

ctx, stop := signal.NotifyContext(context.Background(), os.Interrupt)
defer stop()

client, err := n2k.NewClient(ctx,
    n2k.CAN("can0"),
    n2k.WithSourceAddress(42),
)
if err != nil {
    panic(err)
}
defer client.Close()

// Write a message. The struct knows its own PGN number.
// Priority defaults to 6, destination defaults to broadcast (255).
heading := &pgn.VesselHeading{}
heading.SetHeadingValue(1.5708) // radians; stored as raw wire ticks
result := client.Write(heading)
if err := result.Wait(); err != nil {
    log.Printf("write failed: %v", err)
}

// Explicitly set priority and destination
heading2 := &pgn.VesselHeading{
    Info: pgn.MessageInfo{Priority: pgn.Priority(2), TargetId: pgn.Target(42)},
}
heading2.SetHeadingValue(1.5708)
client.Write(heading2)

// Read messages (same as top-level API)
for msg, err := range client.Receive() {
    if err != nil {
        panic(err)
    }
    fmt.Printf("Msg: %v\n", msg)
}

Address Claiming

Every device that transmits on NMEA 2000 must claim a unique bus address (1–253) using the ISO 11783 address claim protocol (PGN 60928). NewClient handles this automatically — it broadcasts an address claim, waits for contention, and only returns once a valid address is secured.

How contention works: Each device has a 64-bit NAME. When two devices claim the same address, the lower NAME wins and keeps the address; the loser must yield. The client supports two modes:

// Auto mode (default) — starts at address 253 and negotiates downward on
// contention. If all addresses are exhausted, NewClient returns an error.
client, err := n2k.NewClient(ctx, n2k.CAN("can0"))

// Explicit mode — uses a fixed address. If another device with a lower NAME
// contests it, NewClient returns an error instead of retrying.
client, err := n2k.NewClient(ctx,
    n2k.CAN("can0"),
    n2k.WithSourceAddress(42),
)

Device NAME: The NAME determines who wins contention. Lower NAME = higher priority. Customize it to control your device's identity and arbitration priority on the bus:

client, err := n2k.NewClient(ctx,
    n2k.CAN("can0"),
    n2k.WithName(n2k.DeviceName{
        IndustryGroup:    4,     // 3 bits: 4 = Marine
        ManufacturerCode: 2000,  // 11 bits: unassigned/experimental range
        DeviceClass:      25,    // 7 bits: 25 = Internetwork Device
        DeviceFunction:   130,   // 8 bits: 130 = PC Gateway
        DeviceInstance:   0,     // 8 bits
        SystemInstance:   0,     // 4 bits
        IdentityNumber:   12345, // 21 bits: unique per physical device
    }),
)

When WithName is not set, DefaultDeviceName() is used — it randomizes the identity number so multiple clients from the same binary can coexist on one bus.

Claim timeout: NewClient blocks for up to 1500ms (the default) to allow the network to respond to the initial claim. On heavily contested buses, increase it:

client, err := n2k.NewClient(ctx,
    n2k.CAN("can0"),
    n2k.WithClaimTimeout(3 * time.Second),
)

Read-only

Iterator API

ctx, stop := signal.NotifyContext(context.Background(), os.Interrupt)
defer stop()

for msg, err := range n2k.Receive(ctx, n2k.CAN("can0")) {
    if err != nil {
        panic(err)
    }
    fmt.Printf("Msg: %v\n", msg)
}

Scanner API

s := n2k.NewScanner(ctx, n2k.CAN("can0"))
for s.Next() {
    fmt.Printf("Msg: %v\n", s.Message())
}
if err := s.Err(); err != nil {
    ...
}

Multiple Networks

Read from multiple CAN interfaces simultaneously:

for msg, err := range n2k.Receive(ctx,
    n2k.CAN("can0"),
    n2k.CAN("can1"),
    n2k.USB("/dev/ttyUSB0"),
) {
    // messages from all sources, interleaved by arrival
}

Log Files and Network Gateways

Frames don't have to come from local CAN hardware:

// Replay a candump -L / -l capture, as fast as possible...
for msg, err := range n2k.Receive(ctx, n2k.File("testdata/sample.log")) { ... }

// ...or paced by the log's own timestamps.
for msg, err := range n2k.Receive(ctx, n2k.File("capture.log", n2k.OriginalTiming())) { ... }

// Yacht Devices YDWG-02 (RAW server mode) over TCP or UDP.
for msg, err := range n2k.Receive(ctx, n2k.TCP("192.168.4.1:1457", n2k.FormatYDRaw)) { ... }
for msg, err := range n2k.Receive(ctx, n2k.UDP(":1457", n2k.FormatYDRaw)) { ... }

// Actisense-format streams (W2K-1 gateways, or an NGT-1 behind a TCP
// bridge). Messages arrive pre-assembled and are re-framed internally so
// they flow through the same decode pipeline.
for msg, err := range n2k.Receive(ctx, n2k.TCP("10.0.0.5:2000", n2k.FormatActisense)) { ... }

File and UDP are read-only (use them with Receive/NewScanner). TCP also works with NewClient for full read/write bus access:

// A complete bus device over the boat's WiFi gateway. RAW mode is
// frame-level in both directions, so address claiming, heartbeats, and
// group functions behave exactly as on CAN hardware. The gateway echoes
// transmitted frames back, so the client also observes its own traffic.
client, err := n2k.NewClient(ctx, n2k.TCP("192.168.4.1:1457", n2k.FormatYDRaw))

// Writing over Actisense-format connections also works, with one caveat:
// the protocol is message-oriented and carries no source address on sends,
// so the gateway transmits under its own claimed address and does its own
// fast-packet fragmentation.
client, err := n2k.NewClient(ctx, n2k.TCP("10.0.0.5:2000", n2k.FormatActisense))

Source support by platform

Source	Linux	macOS	Windows	Write access
CAN (SocketCAN)	✅	❌	❌	✅
USB (serial CAN adapter)	✅	✅	✅	✅
TCP (Yacht Devices RAW)	✅	✅	✅	✅ full frame-level control
TCP (Actisense format)	✅	✅	✅	✅ gateway stamps its own source address
UDP (both formats)	✅	✅	✅	❌ read-only
File (candump -L/-l)	✅	✅	✅	❌ read-only
Replay (in-memory frames)	✅	✅	✅	✅ writes captured via WrittenFrames

Filter Messages using Common Expression Language

Filter messages using CEL expressions.

n2k automatically optimizes filters — metadata-only expressions skip decoding entirely.

// Only vessel heading messages
for msg, err := range n2k.Receive(ctx,
    n2k.CAN("can0"),
    n2k.Filter("pgn == 127250"),
) { ... }

// Filter on decoded fields -- decoded numeric fields hold raw wire ticks,
// not physical units (see "Physical Values" below); Heading is in
// 0.0001-radian ticks, so 31416 here is > pi rad.
for msg, err := range n2k.Receive(ctx,
    n2k.CAN("can0"),
    n2k.Filter("pgn == 127250 && msg.Heading > 31416"),
) { ... }

// Filter by source address
for msg, err := range n2k.Receive(ctx,
    n2k.CAN("can0"),
    n2k.Filter("source == 3"),
) { ... }

Filter variables:

Variable	Type	Description
pgn	int	Parameter Group Number
source	int	Source address (1-253)
priority	int	Message priority (0-7)
destination	int	Destination address (255 = broadcast)
msg.<field>	varies	Decoded struct field (case-insensitive), in raw wire ticks

Repeating-group slice fields (Repeating1/Repeating2) are not addressable in filter expressions.

Options

Option	Description
n2k.CAN(iface)	SocketCAN source (e.g., "can0")
n2k.USB(port)	USB-CAN serial source (e.g., "/dev/ttyUSB0")
n2k.File(path, ...opts)	candump -L/-l log file source (read-only); n2k.OriginalTiming() paces frames by log timestamps
n2k.TCP(addr, format)	Network gateway over TCP (read/write); format is n2k.FormatYDRaw or n2k.FormatActisense
n2k.UDP(listenAddr, format)	Network gateway datagrams (read-only), same formats
n2k.Replay(frames)	Replay source for testing
n2k.Filter(expr)	CEL filter expression
n2k.IncludeUnknown()	Include undecodable messages as *pgn.UnknownPGN
n2k.WithLogger(l)	Override default slog.Logger
n2k.WithSourceAddress(addr)	Explicit source address for writes (contention is fatal)
n2k.WithName(name)	ISO 11783 device NAME for address claiming
n2k.WithProductInfo(p)	Product identity reported via PGN 126996
n2k.WithConfigInfo(ci)	Installation description reported via PGN 126998
n2k.WithHeartbeatInterval(d)	Heartbeat (PGN 126993) cadence; default 60s, 0 disables
n2k.WithReconnect(policy)	Auto-reconnect dropped TCP gateway connections with exponential backoff (ReconnectPolicy{InitialBackoff, MaxBackoff}; zero values default to 500ms/30s)
n2k.WithBus(bus)	Inject a pre-constructed n2k.Bus (custom transport or test fake) instead of CAN/USB sources

A Complete Bus Node

Beyond claiming an address, a bus client implements the protocol behavior NMEA 2000 requires of a transmitting device:

• Heartbeat (PGN 126993) — sent every 60 seconds automatically (tune or disable with WithHeartbeatInterval).
• Product & configuration info (PGNs 126996/126998) — requests from other devices (chartplotters, analyzers) are answered automatically. Set your identity with WithProductInfo / WithConfigInfo; without them a generic software-gateway identity is reported so the device never shows up blank.
• ISO requests (PGN 59904) — requests for supported PGNs are answered; requests addressed to us for anything else are refused with an ISO acknowledgement NAK, per ISO 11783-3.
• Group functions (PGN 126208) — request group functions can transmit, retime, pause (interval 0), or restore (interval 0xFFFFFFFE) any PGN the client transmits, including scheduled broadcasts. Unsupported group functions (commands, read/write fields) are acknowledged with the proper error codes.

All of this runs on a dedicated decode path, so a Filter(...) expression never breaks protocol behavior.

Request/response — ask another device for a PGN and await its typed reply (default timeout 1250ms, the ISO 11783 response time):

pi, err := n2k.Request[*pgn.ProductInformation](ctx, client, 0x23)
if err == nil {
    fmt.Println(pi.ModelId, pi.SoftwareVersionCode)
}

Periodic broadcasts — transmit a PGN on a schedule; the provider runs on every tick (return nil to skip a tick):

stop := client.Broadcast(time.Second, func() pgn.Message {
    heading := &pgn.VesselHeading{}
    heading.SetHeadingValue(currentHeadingRadians())
    return heading
})
defer stop()

Other devices can retime or pause the broadcast with a request group function naming its PGN.

Device Registry

Bus clients passively map the network: every address claim, product info, and configuration info message updates a registry keyed by 64-bit NAME (addresses are dynamic — the NAME is the stable identity). On first sight of a device the client requests its product and configuration info, and at startup it broadcasts an address-claim request so the whole bus announces itself.

for _, d := range client.Devices() {
    model := "(no product info yet)"
    if d.ProductInfo != nil {
        model = d.ProductInfo.ModelId
    }
    fmt.Printf("addr %d: %s (manufacturer %d, last seen %s)\n",
        d.Address, model, d.Name.ManufacturerCode, d.LastSeen)
}

// Correlate a decoded message with the device that sent it.
if vh, ok := msg.(*pgn.VesselHeading); ok {
    if dev, found := client.DeviceAt(vh.Info.SourceId); found {
        fmt.Printf("heading from %016X\n", dev.RawName)
    }
}

Testing with Replay

frames := []can.Frame{
    {ID: 0x09F10D01, Length: 8, Data: [8]uint8{1, 2, 3, 4, 5, 6, 7, 8}},
}

for msg, err := range n2k.Receive(ctx, n2k.Replay(frames)) {
    // test your message handling
}

PGN Types

All decoded messages implement the pgn.Message interface and are pointers to typed structs in the pgn package. Use a type switch to handle specific message types. PGN structs are organized across category files — system.go, navigation.go, engine.go, etc.

type Message interface {
    PGNNumber() uint32
}

Every struct carries a pgn.MessageInfo field with wire metadata:

type MessageInfo struct {
    Timestamp time.Time
    Priority  *uint8
    PGN       uint32
    SourceId  uint8
    TargetId  *uint8
}

When writing, Priority and TargetId default to 6 and 255 respectively when nil. When reading, they are populated from the wire. Use the helpers pgn.Priority(v) and pgn.Target(v) for concise literal construction:

info := pgn.MessageInfo{
    PGN:      126996,
    SourceId:  3,
    Priority: pgn.Priority(2),
    TargetId: pgn.Target(42),
}

Physical Values

Numeric struct fields hold raw wire ticks (*uint64/*int64), which is what makes byte-perfect re-encoding possible. Every numeric field with a physical interpretation also gets generated typed accessors that do the unit math — SI units in, SI units out, raw ticks underneath:

heading := &pgn.VesselHeading{}
heading.SetHeadingValue(1.5708)      // radians -> stored as 15708 raw ticks

rad, ok := heading.HeadingValue()    // 1.5708, true
_ = heading.Heading                  // *uint64 raw ticks, still there

depth := decoded.(*pgn.WaterDepth)
meters, ok := depth.DepthValue()     // e.g. 2.70 m from raw 270

The accessor's bool is false when the field is nil — the wire sent the field's null/out-of-range sentinel, or the payload ended before reaching it. Each accessor documents its unit and conversion (value = raw * resolution + offset); the units are the schema's SI units (rad, m/s, K, V, ...).

For dynamic, metadata-driven access — when the field is only known at runtime — pgn.PhysicalValue(msg, fieldOrder) performs the same conversion by field source order and also returns the unit label:

v, unit, ok, err := pgn.PhysicalValue(heading, 2) // field order 2 = Heading
// v = 1.5708, unit = "rad"

PhysicalValue returns an error for unknown fields, non-numeric fields (strings, binary, FLOAT, match selectors), and fields inside repeating groups — for those, decode the group slice and use the element structs' accessors instead (they're generated too).

Unit Types

The units package provides type-safe quantity wrappers (Distance, Velocity, Pressure, ...) with built-in unit conversion. It is independent of the PGN decode path: decoded structs keep raw wire ticks, and the generated accessors above return plain float64 values in each field's native schema unit. Wrapping those values into units types is left to the caller; wiring units directly into decoding would require changing generated PGN struct fields from raw-tick *uint64/*int64 values to quantity types, which is deliberately deferred (see the units package doc comment).

Comparison

As of July 2026, these are relevant projects that document NMEA 2000 support. Go projects come first because n2k is for Go applications; non-Go projects follow to show the broader ecosystem. NMEA 0183-only parsers are excluded.

Legend: ✅ first-class documented support · 🟡 partial, lower-level, or workflow-specific · ❓ capability may exist but isn't documented · ❌ not present or not applicable.

Project	Lang	Go app API	Typed PGNs	Byte-preserving encode	Bus-node behavior	Group functions	Best fit
open-ships/n2k	Go	✅ direct top-level API	✅ ~600 generated structs	✅ tested round trips	✅ claim, heartbeat, info, requests	✅ transmit / retime / pause	Go production apps, gateways, loggers, automation
boatkit-io/n2k	Go	✅ endpoint/service/node packages	✅ generated structs	🟡 documented encode/write	✅ node claim + heartbeat	❓ not documented	Go apps built around its service/node architecture
aldas/go-nmea-client	Go	🟡 lower-level reader APIs	❌ no typed structs	🟡 raw/message oriented	🟡 basic node mapping	❓ not documented	Raw ingestion and format conversion
canboat/canboat	C	❌ not Go	❌ analyzer output only	🟡 tooling-oriented	❌ analysis suite	❌ not a bus-node library	Shell analysis, reverse engineering, schema reference
ttlappalainen/NMEA2000	C++	❌ not Go	🟡 hand-authored helpers	🟡 message helpers	✅ mandatory device behavior	🟡 device-oriented support	Embedded C++ NMEA 2000 devices
canboat/canboatjs	TypeScript	❌ not Go	🟡 TypeScript definitions	✅ documented encode/transmit	🟡 device integration	🟡 plugin/provider-specific	Node.js, Signal K, TypeScript integrations
tomer-w/nmea2000	Python	❌ not Go	🟡 generated Python fields	✅ generated encode/decode	❓ not documented	❓ not documented	Python automation and Home Assistant
fard-draf/korri-n2k	Rust	❌ not Go	✅ generated structs	🟡 generated serialization	✅ address claiming + fast packet	❌ roadmap gap	Embedded Rust with selectable PGN sets

For a Go application, open-ships/n2k is the only library here with first-class support across the whole surface — typed decoding, byte-preserving writes, real bus-node behavior, group functions, gateway/file sources, and CLI workflows.

Known Limitations

• Cross-field validation is not yet implemented.
• One physical bus per client.
• Address claiming uses a 1500ms default timeout; on heavily contested buses, increase via WithClaimTimeout.
• File and UDP sources are read-only; writing requires CAN, USB, TCP, or Replay.
• Over Actisense-format TCP connections the gateway stamps its own source address on transmissions (the protocol carries none), so the client's claimed address is not authoritative on the wire.
• Gateway TCP connections do not auto-reconnect by default; a dropped connection ends the read loop. Pass WithReconnect to re-dial dropped connections with backoff. A transparent transport reconnect does not re-run NMEA 2000 address claiming, so a gateway that itself rebooted may still need a fresh client.

License

MIT — see LICENSE.

Acknowledgments

• canboat — maintains the open PGN schema this library's decoders are generated from. The decoded-message breadth here is theirs.
• boatkit-io/n2k — the Go project that inspired this one.

Documentation

Overview

Package n2k is a standalone Go toolkit for NMEA 2000 marine networks. It reads and writes messages from CAN hardware, USB-CAN adapters, network gateways, and capture/replay sources, decoding PGNs into strongly typed Go structs from package pgn.

Index

• func Receive(ctx context.Context, opts ...Option) iter.Seq2[pgn.Message, error]
• func Request[T pgn.Message](ctx context.Context, c *Client, target uint8) (T, error)
• type Bus
• type Client
  • func NewClient(ctx context.Context, opts ...Option) (*Client, error)
  • func (c *Client) Broadcast(interval time.Duration, provide func() pgn.Message) (stop func())
  • func (c *Client) Close() error
  • func (c *Client) DeviceAt(source uint8) (Device, bool)
  • func (c *Client) Devices() []Device
  • func (c *Client) Receive() iter.Seq2[pgn.Message, error]
  • func (c *Client) Scanner() *Scanner
  • func (c *Client) Write(msg pgn.Message) *WriteResult
  • func (c *Client) WrittenFrames() []can.Frame
• type ConfigInfo
• type Device
• type DeviceName
  • func DefaultDeviceName() DeviceName
  • func UnpackDeviceName(name uint64) DeviceName
  • func (d DeviceName) Pack(arbitraryAddressCapable bool) uint64
  • func (d DeviceName) Validate() error
• type FileOption
  • func OriginalTiming() FileOption
• type MessageWriter
• type Option
  • func CAN(iface string) Option
  • func File(path string, opts ...FileOption) Option
  • func Filter(expr string) Option
  • func IncludeUnknown() Option
  • func Replay(frames []can.Frame) Option
  • func TCP(addr string, format StreamFormat) Option
  • func UDP(listenAddr string, format StreamFormat) Option
  • func USB(port string) Option
  • func WithBus(bus Bus) Option
  • func WithClaimTimeout(d time.Duration) Option
  • func WithConfigInfo(ci ConfigInfo) Option
  • func WithHeartbeatInterval(d time.Duration) Option
  • func WithLogger(l *slog.Logger) Option
  • func WithName(name DeviceName) Option
  • func WithProductInfo(p ProductInfo) Option
  • func WithReconnect(policy ReconnectPolicy) Option
  • func WithSourceAddress(addr uint8) Option
• type ProductInfo
• type ReconnectPolicy
• type Scanner
  • func NewScanner(ctx context.Context, opts ...Option) *Scanner
  • func (s *Scanner) Err() error
  • func (s *Scanner) Message() pgn.Message
  • func (s *Scanner) Next() bool
• type StreamFormat
• type WriteResult
  • func (r *WriteResult) Done() <-chan struct{}
  • func (r *WriteResult) Wait() error

Examples

• NewClient
• NewScanner
• Receive
• Receive (Filter)

Functions

func Receive

func Receive(ctx context.Context, opts ...Option) iter.Seq2[pgn.Message, error]

Receive returns an iterator of decoded NMEA 2000 messages from the configured sources. Each yielded value is a pointer to a PGN struct (e.g., *pgn.VesselHeading) or *pgn.UnknownPGN if IncludeUnknown() is set.

Example

Replay the bundled capture file -- no hardware required. Swap n2k.File(...) for n2k.CAN("can0"), n2k.TCP("192.168.4.1:1457", n2k.FormatYDRaw), or n2k.USB("/dev/ttyUSB0") to read a live bus.

package main

import (
	"context"
	"fmt"
	"log"

	"github.com/open-ships/n2k"
	"github.com/open-ships/n2k/pgn"
)

func main() {
	ctx := context.Background()

	for msg, err := range n2k.Receive(ctx, n2k.File("testdata/sample.log")) {
		if err != nil {
			log.Fatal(err)
		}
		if heading, ok := msg.(*pgn.VesselHeading); ok {
			if rad, present := heading.HeadingValue(); present {
				fmt.Printf("heading: %.4f rad\n", rad)
				return
			}
		}
	}
}

Output:
heading: 1.9624 rad

Example (Filter)

Filter messages with a CEL expression; metadata-only expressions skip decoding entirely.

package main

import (
	"context"
	"fmt"
	"log"

	"github.com/open-ships/n2k"
	"github.com/open-ships/n2k/pgn"
)

func main() {
	ctx := context.Background()

	for msg, err := range n2k.Receive(ctx,
		n2k.File("testdata/sample.log"),
		n2k.Filter("pgn == 128267"),
	) {
		if err != nil {
			log.Fatal(err)
		}
		if depth, ok := msg.(*pgn.WaterDepth); ok {
			if meters, present := depth.DepthValue(); present {
				fmt.Printf("water depth: %.2f m\n", meters)
				return
			}
		}
	}
}

Output:
water depth: 2.70 m

func Request

func Request[T pgn.Message](ctx context.Context, c *Client, target uint8) (T, error)

Request sends an ISO Request (PGN 59904) for T's PGN to target and waits for the first matching reply. T names the expected response struct, e.g.

pi, err := n2k.Request[*pgn.ProductInformation](ctx, client, 0x23)

target 255 broadcasts the request and accepts a reply from any device. When ctx has no deadline, a default of 1250 ms (the ISO 11783 response time) is applied. Request works on bus clients only.

Types

type Bus

type Bus interface {
	// Run opens the bus and delivers every incoming frame to handler until
	// ctx is cancelled or an unrecoverable error occurs.
	Run(ctx context.Context, handler func(can.Frame)) error
	// WriteFrame sends one frame.
	WriteFrame(frame can.Frame) error
	// Close releases resources. Safe to call even if Run was never called.
	Close() error
}

Bus is a physical or virtual CAN bus. External callers can implement Bus to inject fake hardware for testing, or to adapt transports this library does not ship. Pass an implementation via WithBus.

type Client

type Client struct {
	// contains filtered or unexported fields
}

Client is a read/write NMEA 2000 bus node. It composes address claiming, transport protocol, encoding, and framing into a single type that can both receive and transmit PGN messages.

func NewClient

func NewClient(ctx context.Context, opts ...Option) (*Client, error)

NewClient creates a Client that can read and write NMEA 2000 messages. Provide CAN, USB, TCP, Replay, or WithBus for writable clients; File and UDP are read-only sources for Receive/NewScanner.

Example

NewClient claims a bus address and provides write access. Not runnable without CAN hardware, so this example is compile-only.

package main

import (
	"context"
	"log"

	"github.com/open-ships/n2k"
	"github.com/open-ships/n2k/pgn"
)

func main() {
	ctx := context.Background()

	client, err := n2k.NewClient(ctx, n2k.CAN("can0"))
	if err != nil {
		log.Fatal(err)
	}
	defer func() { _ = client.Close() }()

	heading := &pgn.VesselHeading{}
	heading.SetHeadingValue(1.5708) // radians in, raw wire ticks underneath
	if err := client.Write(heading).Wait(); err != nil {
		log.Fatal(err)
	}
}

func (*Client) Broadcast

func (c *Client) Broadcast(interval time.Duration, provide func() pgn.Message) (stop func())

Broadcast schedules periodic transmission of a PGN. provide is called on each tick to build the message; returning nil skips that tick (data not available yet). The first transmission happens as soon as the client's address claim completes.

provide is called once immediately to learn the PGN it produces; if it returns nil there, the PGN is learned from its first non-nil message instead. Scheduling the same PGN again replaces the earlier schedule. The returned stop function halts transmission and is safe to call repeatedly; Close also stops all broadcasters.

Another device can retime or pause a broadcast at runtime by sending a request group function (PGN 126208) naming the broadcast PGN.

func (*Client) Close

func (c *Client) Close() error

Close shuts down the client, cancels the context, and releases resources. It is safe to call Close multiple times.

func (*Client) DeviceAt

func (c *Client) DeviceAt(source uint8) (Device, bool)

DeviceAt resolves a bus source address to the device currently holding it. Use it to correlate a message's SourceId with a stable device identity:

if dev, ok := client.DeviceAt(msg.MessageInfo().SourceId); ok { ... }

func (*Client) Devices

func (c *Client) Devices() []Device

Devices returns a snapshot of every device observed on the bus, sorted by address. The client builds this map passively from address claims, product information, and configuration information; it also requests those PGNs from newly seen devices and enumerates the bus once at startup. Replay clients always return an empty list.

func (*Client) Receive

func (c *Client) Receive() iter.Seq2[pgn.Message, error]

Receive returns an iterator of decoded NMEA 2000 messages. For bus clients it reads from the internal message channel; for replay clients it builds a fresh Scanner over the client's config so each call gets a full replay.

func (*Client) Scanner

func (c *Client) Scanner() *Scanner

Scanner creates a new Scanner that reads from this client. For bus clients it reads from the internal message channel; for replay clients it builds a fresh Scanner over the client's config.

func (*Client) Write

func (c *Client) Write(msg pgn.Message) *WriteResult

Write asynchronously encodes and transmits a PGN message. The message must be a pointer to a PGN struct (e.g. *pgn.VesselHeading). The returned WriteResult can be used to wait for completion and check for errors. Writes are serialized through a single goroutine to guarantee FIFO ordering.

func (*Client) WrittenFrames

func (c *Client) WrittenFrames() []can.Frame

WrittenFrames returns a copy of all CAN frames written through this client. This is primarily useful in replay/testing mode to inspect what was sent.

type ConfigInfo

type ConfigInfo struct {
	InstallationDescription1 string
	InstallationDescription2 string
	ManufacturerInformation  string
}

ConfigInfo describes this installation of the device (PGN 126998). All three fields are free-form strings.

type Device

type Device struct {
	// RawName is the packed 64-bit ISO 11783 NAME from the device's address
	// claim.
	RawName uint64
	// Name is the decoded NAME.
	Name DeviceName
	// Address is the device's most recently claimed bus address.
	Address uint8
	// LastSeen is when the device last transmitted anything.
	LastSeen time.Time
	// ProductInfo is the device's PGN 126996 payload, nil until observed.
	ProductInfo *pgn.ProductInformation
	// ConfigInfo is the device's PGN 126998 payload, nil until observed.
	ConfigInfo *pgn.ConfigurationInformation
}

Device is one node observed on the NMEA 2000 bus. Devices are identified by their 64-bit ISO 11783 NAME — bus addresses are dynamic and can change under address contention, so RawName is the stable key.

type DeviceName

type DeviceName struct {
	IdentityNumber   uint32 // 21 bits (0-20)
	ManufacturerCode uint16 // 11 bits (21-31)
	DeviceInstance   uint8  // 8 bits: lower 3 (32-34) + upper 5 (35-39)
	DeviceFunction   uint8  // 8 bits (40-47)
	DeviceClass      uint8  // 7 bits (49-55), bit 48 is reserved
	SystemInstance   uint8  // 4 bits (56-59)
	IndustryGroup    uint8  // 3 bits (60-62)
}

DeviceName represents the ISO 11783 / NMEA 2000 64-bit NAME that uniquely identifies a device on a CAN bus network. The NAME is used during address claiming (PGN 60928) to arbitrate bus addresses.

func DefaultDeviceName

func DefaultDeviceName() DeviceName

DefaultDeviceName returns a DeviceName pre-configured for a PC-based software gateway operating on an NMEA 2000 marine network. The identity number is randomized so that multiple processes using the same binary can coexist on the same bus without NAME collisions during address claiming.

func UnpackDeviceName

func UnpackDeviceName(name uint64) DeviceName

UnpackDeviceName extracts a DeviceName from the 64-bit NAME integer defined by ISO 11783. The arbitraryAddressCapable flag (bit 63) is not stored in the struct; callers can check it directly via (name >> 63) & 1.

func (DeviceName) Pack

func (d DeviceName) Pack(arbitraryAddressCapable bool) uint64

Pack encodes the DeviceName into the 64-bit NAME integer defined by ISO 11783. The arbitraryAddressCapable flag sets bit 63, indicating the device can participate in dynamic address negotiation.

64-bit NAME layout (LSB-first):

Bits  0-20:  Identity Number (21 bits)
Bits 21-31:  Manufacturer Code (11 bits)
Bits 32-34:  Device Instance Lower (3 bits)
Bits 35-39:  Device Instance Upper (5 bits)
Bits 40-47:  Device Function (8 bits)
Bit  48:     Reserved (0)
Bits 49-55:  Device Class (7 bits)
Bits 56-59:  System Instance (4 bits)
Bits 60-62:  Industry Group (3 bits)
Bit  63:     Arbitrary Address Capable (1 bit)

func (DeviceName) Validate

func (d DeviceName) Validate() error

Validate checks that each field fits within its bit width as defined by the ISO 11783 NAME specification. DeviceInstance and DeviceFunction are uint8 and always fit their 8-bit fields.

type FileOption

type FileOption interface {
	// contains filtered or unexported methods
}

FileOption configures a File source.

func OriginalTiming

func OriginalTiming() FileOption

OriginalTiming replays frames paced by the log's own timestamps instead of as fast as they can be read. Frames without timestamps are delivered immediately.

type MessageWriter

type MessageWriter interface {
	WriteMessage(pgnNum uint32, priority, source, destination uint8, payload []byte) error
}

MessageWriter is optionally implemented by Bus implementations that transmit whole assembled PGN messages rather than raw CAN frames — message-oriented gateways such as Actisense-format streams, where the gateway performs fast-packet fragmentation itself. When a client's bus implements MessageWriter, writes that fit in one message (payloads up to 223 bytes) bypass CAN framing and use WriteMessage; larger ISO-TP transfers and protocol frames (address claims, ISO requests) still go frame-by-frame through WriteFrame.

Implementations may not be able to honor the source address (an Actisense gateway stamps its own claimed address); it is provided so implementations that can control it (custom transports) have it.

type Option

type Option interface {
	// contains filtered or unexported methods
}

Option configures the behavior of Receive and NewScanner.

func CAN

func CAN(iface string) Option

CAN adds a SocketCAN source for the given Linux CAN interface (e.g., "can0").

func File

func File(path string, opts ...FileOption) Option

File adds a source that replays CAN frames from a candump -L / -l log file. By default frames are delivered as fast as they can be read; pass OriginalTiming() to pace them by the log's timestamps. File sources are read-only: they work with Receive and NewScanner but not NewClient.

func Filter

func Filter(expr string) Option

Filter sets a CEL expression to filter messages. The expression is automatically partitioned into pre-decode (metadata) and post-decode (struct field) stages.

func IncludeUnknown

func IncludeUnknown() Option

IncludeUnknown includes undecodable messages as *pgn.UnknownPGN in the output stream. By default, unknown PGNs are dropped and logged at debug level.

func Replay

func Replay(frames []can.Frame) Option

Replay adds a source that replays the given CAN frames. Useful for testing.

func TCP

func TCP(addr string, format StreamFormat) Option

TCP adds a source that dials a network gateway (e.g. a Yacht Devices YDWG-02 in RAW server mode, or an Actisense gateway) at addr ("host:port"). TCP works with Receive/NewScanner and can also back NewClient for writes. RAW gateways provide frame-level read/write access; Actisense-format gateways send assembled messages and stamp their own source address.

func UDP

func UDP(listenAddr string, format StreamFormat) Option

UDP adds a source that listens on listenAddr (e.g. ":1457" or "0.0.0.0:1457") for datagrams broadcast by a network gateway. UDP sources are read-only: they work with Receive and NewScanner but not NewClient.

func USB

func USB(port string) Option

USB adds a USB-CAN Analyzer source for the given serial port (e.g., "/dev/ttyUSB0").

func WithBus

func WithBus(bus Bus) Option

WithBus provides a pre-constructed Bus for the client to use — either a custom transport not shipped by this library, or a fake for testing. When set, the client uses this bus directly instead of constructing one from CAN/USB sources.

func WithClaimTimeout

func WithClaimTimeout(d time.Duration) Option

WithClaimTimeout sets how long NewClient blocks waiting for address claiming to complete on a real CAN bus. Default is 1500ms. This allows time for the initial 250ms claim window plus several rounds of contention renegotiation.

func WithConfigInfo

func WithConfigInfo(ci ConfigInfo) Option

WithConfigInfo sets the installation description (PGN 126998) this client reports when another device requests it.

func WithHeartbeatInterval

func WithHeartbeatInterval(d time.Duration) Option

WithHeartbeatInterval sets the cadence of the client's automatic heartbeat (PGN 126993). The NMEA 2000 standard requires every device to heartbeat at least every 60 seconds, which is the default. Pass 0 to disable automatic heartbeats. Only bus clients heartbeat; replay clients never do.

func WithLogger

func WithLogger(l *slog.Logger) Option

WithLogger overrides the default slog.Default() logger.

func WithName

func WithName(name DeviceName) Option

WithName sets the ISO 11783 device NAME used for address claiming. The NAME is a 64-bit identifier that uniquely identifies this device on the NMEA 2000 network. In address contention, the device with the lower NAME wins. When not set, a default NAME is used (see DefaultDeviceName).

func WithProductInfo

func WithProductInfo(p ProductInfo) Option

WithProductInfo sets the product identity (PGN 126996) this client reports when another device requests it. Without it, a generic software-gateway identity is reported. String fields longer than 32 bytes are truncated on the wire.

func WithReconnect

func WithReconnect(policy ReconnectPolicy) Option

WithReconnect enables automatic reconnection for TCP gateway sources. After a connection drops, the source re-dials with exponential backoff (starting at InitialBackoff, capped at MaxBackoff) until it reconnects or the context is cancelled. Without this option, a dropped TCP connection ends the read loop and surfaces as an error (the historical behavior).

Reconnection covers connections that drop mid-session; the initial connection must still succeed (for NewClient, within the claim timeout). It applies only to TCP sources — CAN, USB, UDP, file, and replay sources are unaffected. On a bus client, a transparent transport reconnect does not re-run NMEA 2000 address claiming, so a gateway that itself rebooted may require a fresh client.

func WithSourceAddress

func WithSourceAddress(addr uint8) Option

WithSourceAddress sets an explicit NMEA 2000 source address for the client. When set, the client uses this address and treats contention as a fatal error. When not set (default), the client uses auto mode — starting at address 253 and working downward if contention occurs.

type ProductInfo

type ProductInfo struct {
	// N2KVersion is the supported NMEA 2000 standard version in thousandths,
	// e.g. 2101 means version 2.101. Zero means the default (2101).
	N2KVersion uint16
	// ProductCode is the manufacturer-assigned product code.
	ProductCode uint16
	// ModelID names the product (at most 32 bytes on the wire).
	ModelID string
	// SoftwareVersion is the software version string (at most 32 bytes).
	SoftwareVersion string
	// ModelVersion is the model version string (at most 32 bytes).
	ModelVersion string
	// SerialNumber is the device serial code (at most 32 bytes).
	SerialNumber string
	// CertificationLevel is the NMEA 2000 certification level lookup value.
	CertificationLevel uint8
	// LoadEquivalency is the device's bus load in units of 50 mA.
	LoadEquivalency uint8
}

ProductInfo describes this client as an NMEA 2000 product. Other devices (chartplotters, network analyzers) request it via PGN 126996 and display it in their device lists.

type ReconnectPolicy

type ReconnectPolicy struct {
	// InitialBackoff is the delay before the first reconnect attempt after a
	// drop, and the delay restored after any successful connection. Defaults
	// to 500ms when zero.
	InitialBackoff time.Duration
	// MaxBackoff caps the exponentially growing delay between attempts while
	// the gateway stays unreachable. Defaults to 30s when zero.
	MaxBackoff time.Duration
}

ReconnectPolicy configures automatic reconnection for network gateway (TCP) sources after a dropped connection. The zero value is valid: both fields fall back to their defaults.

type Scanner

type Scanner struct {
	// contains filtered or unexported fields
}

Scanner reads decoded NMEA 2000 messages one at a time. Call Next() to advance, Message() to get the current message, and Err() for errors.

func NewScanner

func NewScanner(ctx context.Context, opts ...Option) *Scanner

NewScanner creates a Scanner that reads from the configured sources.

Example

The Scanner API is an alternative to the iterator.

package main

import (
	"context"
	"fmt"
	"log"

	"github.com/open-ships/n2k"
)

func main() {
	ctx := context.Background()

	scanner := n2k.NewScanner(ctx, n2k.File("testdata/sample.log"))
	messages := 0
	for scanner.Next() {
		messages++
	}
	if err := scanner.Err(); err != nil {
		log.Fatal(err)
	}
	fmt.Printf("decoded over 900 messages: %t\n", messages > 900)
}

Output:
decoded over 900 messages: true

func (*Scanner) Err

func (s *Scanner) Err() error

Err returns the first error encountered by the scanner.

func (*Scanner) Message

func (s *Scanner) Message() pgn.Message

Message returns the most recently scanned message.

func (*Scanner) Next

func (s *Scanner) Next() bool

Next advances the scanner to the next message. Returns false when no more messages are available (source exhausted or error occurred). Check Err() after Next returns false.

type StreamFormat

type StreamFormat int

StreamFormat identifies the wire format spoken by a network gateway.

const (
	// FormatYDRaw is the Yacht Devices RAW ASCII line protocol (YDWG-02 and
	// compatible gateways).
	FormatYDRaw StreamFormat = iota
	// FormatActisense is the Actisense binary stream protocol (NGT-1 and
	// compatible gateways). Messages arrive fully assembled and are re-framed
	// internally so they flow through the same decode pipeline as CAN frames.
	FormatActisense
)

type WriteResult

type WriteResult struct {
	// contains filtered or unexported fields
}

WriteResult represents the outcome of an asynchronous write operation. The zero value is safe to use and behaves as a completed, successful write.

func (*WriteResult) Done

func (r *WriteResult) Done() <-chan struct{}

Done returns a channel that is closed when the write is complete. On a zero-value WriteResult, Done returns an already-closed channel.

func (*WriteResult) Wait

func (r *WriteResult) Wait() error

Wait blocks until the write is complete, then returns the error (or nil). On a zero-value WriteResult, Wait returns nil immediately.