canbus

package module

Go to main page

Versions in this module

v0

v0.10.0

Nov 14, 2026

v0.9.1

Nov 12, 2026

v0.9.0

Nov 8, 2026

v0.8.0

Nov 4, 2026

v0.7.2

Oct 31, 2026

v0.7.1

Oct 30, 2026

v0.7.0

Oct 28, 2026

Changes in this version

+ func XLKernelID(x *XLFrame) uint32

type Bus

+ func (b *Bus) SendXL(ctx context.Context, x *XLFrame) error

type Filter

+ func (f Filter) MatchXL(x *XLFrame) bool

type FilterSet

+ func (s *FilterSet) MatchXL(x *XLFrame) bool

type NopMetrics

+ func (NopMetrics) OnXLFrameReceived(string, *XLFrame)

+ func (NopMetrics) OnXLFrameSent(string, *XLFrame)

type SubscribeOption

+ func WithXL() SubscribeOption

type Subscription

+ func (s *Subscription) ReceiveAny(ctx context.Context, f *Frame, x *XLFrame) (xl bool, err error)

+ func (s *Subscription) ReceiveXL(ctx context.Context) (XLFrame, error)

type XLFrame

+ func (f *XLFrame) Clone() XLFrame

+ type XLMetrics interface

+ OnXLFrameReceived func(iface string, x *XLFrame)

+ OnXLFrameSent func(iface string, x *XLFrame)

+ type XLTransport interface

+ ReceiveAny func(ctx context.Context, f *Frame, x *XLFrame) (xl bool, err error)

+ SendXL func(ctx context.Context, x *XLFrame) error

v0.6.1

Oct 28, 2026

v0.6.0

Oct 28, 2026

v0.5.0

Oct 28, 2026

Changes in this version

+ const MaxXLLen

+ const MaxXLPriority

+ const MinXLLen

+ func IsXLText(s string) bool

type Capabilities

+ XL bool

+ type XLFlags uint8

+ const XLRRS

+ const XLSEC

+ func (f XLFlags) String() string

+ type XLFrame struct

+ AF uint32

+ Data []byte

+ Echo bool

+ Flags XLFlags

+ Interface string

+ Priority uint16

+ SDT uint8

+ Timestamp time.Time

+ VCID uint8

+ func ParseXLFrame(s string) (XLFrame, error)

+ func (f *XLFrame) Validate() error

+ func (f XLFrame) String() string

v0.4.0

Oct 28, 2026

v0.3.0

Oct 28, 2026

v0.2.2

Oct 28, 2026

Changes in this version

type Option

+ func WithStartOnSubscribe() Option

v0.2.1

Oct 28, 2026

v0.2.0

Oct 28, 2026

v0.1.0

Oct 27, 2026

Changes in this version

+ const DefaultQueueSize

+ const MaxClassicalLen

+ const MaxFDLen

+ var ErrBufferOverflow = errors.New("canbus: buffer overflow")

+ var ErrClosed = errors.New("canbus: closed")

+ var ErrInterfaceDown = errors.New("canbus: interface down")

+ var ErrInvalidFrame = errors.New("canbus: invalid frame")

+ var ErrInvalidOption = errors.New("canbus: invalid option")

+ var ErrQueueFull = errors.New("canbus: queue full")

+ var ErrTimeout = errors.New("canbus: timeout")

+ var ErrUnsupported = errors.New("canbus: unsupported")

+ func DLCToLen(dlc uint8, fd bool) int

+ func KernelID(fr *Frame) uint32

+ func LenToDLC(n int) uint8

+ func PadFD(data []byte, pad byte) []byte

+ func RoundUpFDLen(n int) int

+ func ValidFDLen(n int) bool

+ type Bus struct

+ func NewBus(t Transport, opts ...Option) (*Bus, error)

+ func (b *Bus) Close() error

+ func (b *Bus) Done() <-chan struct{}

+ func (b *Bus) Err() error

+ func (b *Bus) Name() string

+ func (b *Bus) Send(ctx context.Context, f *Frame) error

+ func (b *Bus) State() State

+ func (b *Bus) Stats() Stats

+ func (b *Bus) Subscribe(opts ...SubscribeOption) (*Subscription, error)

+ func (b *Bus) Transport() Transport

+ type Capabilitier interface

+ Capabilities func() Capabilities

+ type Capabilities struct

+ ErrorFrames bool

+ FD bool

+ KernelFilters bool

+ Physical bool

+ RecvOwn bool

+ Timestamps bool

+ type ControllerStatus uint8

+ const CtrlActive

+ const CtrlRxOverflow

+ const CtrlRxPassive

+ const CtrlRxWarning

+ const CtrlTxOverflow

+ const CtrlTxPassive

+ const CtrlTxWarning

+ func (s ControllerStatus) String() string

+ type DropCounter interface

+ Drops func() (total uint64, reason DropReason)

+ type DropReason uint8

+ const DropFault

+ const DropFiltered

+ const DropKernelOverflow

+ const DropQueueFull

+ func (r DropReason) String() string

+ type ErrorClass uint32

+ const ErrClassAll

+ const ErrClassBusError

+ const ErrClassBusOff

+ const ErrClassController

+ const ErrClassCounters

+ const ErrClassLostArbitration

+ const ErrClassNoAck

+ const ErrClassProtocol

+ const ErrClassRestarted

+ const ErrClassTransceiver

+ const ErrClassTxTimeout

+ func (c ErrorClass) String() string

+ type ErrorInfo struct

+ ArbitrationBit uint8

+ Class ErrorClass

+ Controller ControllerStatus

+ ControllerSpecific uint8

+ CountersValid bool

+ Protocol ProtocolViolation

+ ProtocolLocation uint8

+ RxErrors uint8

+ Transceiver uint8

+ TxErrors uint8

+ func ParseError(f *Frame) (ErrorInfo, bool)

+ func (e ErrorInfo) String() string

+ type Filter struct

+ Format Format

+ ID ID

+ Invert bool

+ Mask ID

+ Remote RemoteMatch

+ func ExactExtended(id ID) Filter

+ func ExactStandard(id ID) Filter

+ func ParseFilter(s string) (Filter, error)

+ func (f Filter) Kernel() (id, mask uint32)

+ func (f Filter) Match(fr *Frame) bool

+ func (f Filter) String() string

+ type FilterSet struct

+ ErrorMask ErrorClass

+ Filters []Filter

+ Join bool

+ func (s *FilterSet) Match(fr *Frame) bool

+ type Filterer interface

+ SetFilters func(FilterSet) error

+ type Flags uint8

+ const FlagBRS

+ const FlagESI

+ const FlagError

+ const FlagExtended

+ const FlagFD

+ const FlagRemote

+ func (f Flags) String() string

+ type Format uint8

+ const FormatAny

+ const FormatExtended

+ const FormatStandard

+ type Frame struct

+ Data [MaxFDLen]byte

+ Echo bool

+ Flags Flags

+ ID ID

+ Interface string

+ Len uint8

+ Len8DLC uint8

+ Timestamp time.Time

+ func NewErrorFrame(info ErrorInfo) Frame

+ func NewExtended(id ID, data []byte) (Frame, error)

+ func NewFD(id ID, extended, brs bool, data []byte) (Frame, error)

+ func NewRemote(id ID, extended bool, dlc uint8) (Frame, error)

+ func NewStandard(id ID, data []byte) (Frame, error)

+ func (f *Frame) DLC() uint8

+ func (f *Frame) IsError() bool

+ func (f *Frame) IsExtended() bool

+ func (f *Frame) IsFD() bool

+ func (f *Frame) IsRemote() bool

+ func (f *Frame) Payload() []byte

+ func (f *Frame) SetPayload(data []byte)

+ func (f *Frame) Validate() error

+ func (f Frame) String() string

+ type FrameError struct

+ Frame Frame

+ Reason string

+ func (e *FrameError) Error() string

+ func (e *FrameError) Unwrap() error

+ type ID uint32

+ const MaxExtendedID

+ const MaxStandardID

+ type Metrics interface

+ OnDrop func(iface string, reason DropReason, n uint64)

+ OnError func(iface, op string, err error)

+ OnFrameReceived func(iface string, f *Frame)

+ OnFrameSent func(iface string, f *Frame)

+ OnQueue func(iface string, depth, capacity int)

+ OnStateChange func(iface string, from, to State)

+ type Namer interface

+ Name func() string

+ type NopMetrics struct

+ func (NopMetrics) OnDrop(string, DropReason, uint64)

+ func (NopMetrics) OnError(string, string, error)

+ func (NopMetrics) OnFrameReceived(string, *Frame)

+ func (NopMetrics) OnFrameSent(string, *Frame)

+ func (NopMetrics) OnQueue(string, int, int)

+ func (NopMetrics) OnStateChange(string, State, State)

+ type OpError struct

+ Err error

+ Interface string

+ Op string

+ func (e *OpError) Error() string

+ func (e *OpError) Unwrap() error

+ type Option func(*Bus) error

+ func WithInterfaceName(name string) Option

+ func WithLogger(l *slog.Logger) Option

+ func WithMetrics(m Metrics) Option

+ type Overflow uint8

+ const Block

+ const DropNewest

+ const DropOldest

+ type ProtocolViolation uint8

+ const ProtActive

+ const ProtBit

+ const ProtBit0

+ const ProtBit1

+ const ProtForm

+ const ProtOverload

+ const ProtStuff

+ const ProtTx

+ func (p ProtocolViolation) String() string

+ type RemoteMatch uint8

+ const RemoteAny

+ const RemoteDataOnly

+ const RemoteOnly

+ type State uint8

+ const StateActive

+ const StateBusOff

+ const StateClosed

+ const StateDown

+ const StatePassive

+ const StateUnknown

+ const StateWarning

+ func (s State) String() string

+ type Stats struct

+ Dropped uint64

+ RxBytes uint64

+ RxErrors uint64

+ RxFailure uint64

+ RxFrames uint64

+ TxBytes uint64

+ TxErrors uint64

+ TxFrames uint64

+ type Statser interface

+ Stats func() Stats

+ type SubscribeOption func(*Subscription)

+ func WithFilters(fs FilterSet) SubscribeOption

+ func WithOverflow(o Overflow) SubscribeOption

+ func WithQueueSize(n int) SubscribeOption

+ func WithoutEcho() SubscribeOption

+ type Subscription struct

+ func (s *Subscription) Close() error

+ func (s *Subscription) Done() <-chan struct{}

+ func (s *Subscription) Dropped() uint64

+ func (s *Subscription) Err() error

+ func (s *Subscription) Frames() <-chan Frame

+ func (s *Subscription) Receive(ctx context.Context) (Frame, error)

+ func (s *Subscription) Received() uint64

+ type Transport interface

+ Close func() error

+ Receive func(ctx context.Context, f *Frame) error

+ Send func(ctx context.Context, f *Frame) error

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