n2k

package module

Go to main page

Versions in this module

v1

v1.0.0

Jul 19, 2026

Changes in this version

+ const DirectionReceived

+ const DirectionTransmitted

+ const DirectionUnknown

+ const ObservationDecodeError

+ const ObservationFrame

+ const ObservationMessage

+ var ErrObservationOverflow = errors.New("n2k: observation buffer overflow")

+ var ErrProtocolQueueFull = errors.New("n2k: protocol write queue full")

+ func Observe(ctx context.Context, opts ...Option) iter.Seq2[Observation, error]

type Client

+ func (c *Client) Observations() iter.Seq2[Observation, error]

type ClientStatus

+ ApplicationWritesAccepted uint64

+ ApplicationWritesCompleted uint64

+ ApplicationWritesFailed uint64

+ ApplicationWritesRejected uint64

+ Connected bool

+ ConnectionEpoch uint64

+ DecodeErrorsObserved uint64

+ FramesReceived uint64

+ FramesTransmitted uint64

+ MessagesObserved uint64

+ ObservationSubscribers int

+ ProtocolAdvisoryQueueCapacity int

+ ProtocolAdvisoryQueueDepth int

+ ProtocolRequiredQueueCapacity int

+ ProtocolRequiredQueueDepth int

+ ProtocolWritesAccepted uint64

+ ProtocolWritesCompleted uint64

+ ProtocolWritesFailed uint64

+ ProtocolWritesRejected uint64

+ Rejoining bool

+ type ConnectionLifecycleBus interface

+ SetConnectionObserver func(observer func(connected bool, epoch uint64))

+ type Direction = raw.Direction

+ type Observation = raw.Observation

+ type ObservationBus interface

+ RunObservations func(ctx context.Context, handler func(raw.Observation)) error

+ type ObservationKind = raw.Kind

type Option

+ func ReplayObservations(observations []Observation) Option

v0

v0.3.0

Jul 19, 2026

Changes in this version

+ var ErrClientClosed = errors.New("n2k: client closed")

+ var ErrReceiveOverflow = errors.New("n2k: receive buffer overflow")

+ var ErrWriteQueueFull = errors.New("n2k: write queue full")

type Client

+ func (c *Client) BroadcastPGN(pgnNum uint32, interval time.Duration, provide func() pgn.Message) (stop func())

+ func (c *Client) Err() error

+ func (c *Client) Status() ClientStatus

+ type ClientStatus struct

+ Address uint8

+ AddressClaimed bool

+ Closed bool

+ ReceiveSubscribers int

+ TerminalError error

+ WriteQueueCapacity int

+ WriteQueueDepth int

type Option

+ func WithPreferredAddress(addr uint8) Option

+ func WithReceiveBuffer(size int) Option

+ func WithWriteQueue(size int) Option

+ type ReadyBus interface

+ Ready func() <-chan struct{}

type Scanner

+ func (s *Scanner) Close() error

type WriteResult

+ func (r *WriteResult) WaitContext(ctx context.Context) error

v0.2.2

Jul 18, 2026

v0.2.1

Jul 16, 2026

v0.2.0

Jul 16, 2026

Changes in this version

type Option

+ func WithReconnect(policy ReconnectPolicy) Option

+ type ReconnectPolicy struct

+ InitialBackoff time.Duration

+ MaxBackoff time.Duration

v0.1.3

Jul 15, 2026

v0.1.2

Jul 15, 2026

v0.1.1

Jul 15, 2026

v0.1.0

Jul 14, 2026

Changes in this version

+ 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 interface

+ Close func() error

+ Run func(ctx context.Context, handler func(can.Frame)) error

+ WriteFrame func(frame can.Frame) error

+ type Client struct

+ 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 struct

+ InstallationDescription1 string

+ InstallationDescription2 string

+ ManufacturerInformation string

+ type Device struct

+ Address uint8

+ ConfigInfo *pgn.ConfigurationInformation

+ LastSeen time.Time

+ Name DeviceName

+ ProductInfo *pgn.ProductInformation

+ RawName uint64

+ type DeviceName struct

+ DeviceClass uint8

+ DeviceFunction uint8

+ DeviceInstance uint8

+ IdentityNumber uint32

+ IndustryGroup uint8

+ ManufacturerCode uint16

+ SystemInstance uint8

+ func DefaultDeviceName() DeviceName

+ func UnpackDeviceName(name uint64) DeviceName

+ func (d DeviceName) Pack(arbitraryAddressCapable bool) uint64

+ func (d DeviceName) Validate() error

+ type FileOption interface

+ func OriginalTiming() FileOption

+ type MessageWriter interface

+ WriteMessage func(pgnNum uint32, priority, source, destination uint8, payload []byte) error

+ type Option interface

+ 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 WithSourceAddress(addr uint8) Option

+ type ProductInfo struct

+ CertificationLevel uint8

+ LoadEquivalency uint8

+ ModelID string

+ ModelVersion string

+ N2KVersion uint16

+ ProductCode uint16

+ SerialNumber string

+ SoftwareVersion string

+ type Scanner struct

+ 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 int

+ const FormatActisense

+ const FormatYDRaw

+ type WriteResult struct

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

+ func (r *WriteResult) Wait() error

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL