canbus

package module

v0.0.0-...-b14e35a Latest Latest Go to latest Published: Nov 24, 2022 License: MIT Imports: 9 Imported by: 1

Details

Golang Canbus library

View Source

const DefaultBitRate = 250000

DefaultBitRate is the bitrate that Channel defaults to using.

This section is empty.

This section is empty.

type Channel struct {
	ChannelOptions ChannelOptions
	// contains filtered or unexported fields
}

func NewChannel(ctx context.Context, log *logrus.Logger, ChannelOptions ChannelOptions, opts ...ChannelOption) (*Channel, error)

func (c *Channel) Close(ctx context.Context) error

func (c *Channel) WriteFrame(frame can.Frame) error

type ChannelOption func(*Channel)

ChannelOption is the type used to apply function options to Channel.

func WithBitRate(br int32) ChannelOption

WithBitRate overrides the DefaultBitRate set on Channel.

type ChannelOptions struct {
	CanInterfaceName string
	MessageHandler   can.HandlerFunc
}

ChannelOptions is a type that contains required options on a Channel.