candevice

Documentation

Index

• Constants
• type BitTiming
• type BitTimingConst
• type BusErrorCounters
• type CanDevice
• type Clock
• type CtrlMode
• type Device
  • func New(deviceName string) (*Device, error)
  • func (d *Device) Bitrate() (uint32, error)
  • func (d *Device) Info() (Info, error)
  • func (d *Device) IsUp() (bool, error)
  • func (d *Device) SetBitrate(bitrate uint32) error
  • func (d *Device) SetDown() error
  • func (d *Device) SetListenOnlyMode(mode bool) error
  • func (d *Device) SetUp() error
• type Info
• type Stats

Constants

const (
	CanLinkType  = "can"
	VcanLinkType = "vcan"
)

const (
	StateErrorActive  = unix.CAN_STATE_ERROR_ACTIVE
	StateErrorWarning = unix.CAN_STATE_ERROR_WARNING
	StateErrorPassive = unix.CAN_STATE_ERROR_PASSIVE
	StateBusOff       = unix.CAN_STATE_BUS_OFF
	StateStopped      = unix.CAN_STATE_STOPPED
	StateSleeping     = unix.CAN_STATE_SLEEPING
	StateMax          = unix.CAN_STATE_MAX
)

Types

type BitTiming

type BitTiming struct {
	unix.CANBitTiming
}

type BitTimingConst

type BitTimingConst struct {
	unix.CANBitTimingConst
}

type BusErrorCounters

type BusErrorCounters struct {
	unix.CANBusErrorCounters
}

type CanDevice

type CanDevice interface {
	Bitrate() (uint32, error)
	Info() (Info, error)
	IsUp() (bool, error)
	SetBitrate(uint32) error
	SetDown() error
	SetListenOnlyMode(bool) error
	SetUp() error
}

type Clock

type Clock struct {
	unix.CANClock
}

type CtrlMode

type CtrlMode struct {
	unix.CANCtrlMode
}

type Device

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

func New

func New(deviceName string) (*Device, error)

Creates a handle to a CAN device specified by name, e.g. can0.

func (*Device) Bitrate

func (d *Device) Bitrate() (uint32, error)

func (*Device) Info

func (d *Device) Info() (Info, error)

func (*Device) IsUp

func (d *Device) IsUp() (bool, error)

func (*Device) SetBitrate

func (d *Device) SetBitrate(bitrate uint32) error

func (*Device) SetDown

func (d *Device) SetDown() error

Corresponds to "ip link set down".

func (*Device) SetListenOnlyMode

func (d *Device) SetListenOnlyMode(mode bool) error

func (*Device) SetUp

func (d *Device) SetUp() error

Corresponds to "ip link set up".

type Info

type Info struct {
	BitTiming        BitTiming
	BitTimingConst   BitTimingConst
	Clock            Clock
	CtrlMode         CtrlMode
	BusErrorCounters BusErrorCounters
	Type             string

	State     uint32
	RestartMs uint32
}

type Stats

type Stats struct {
	unix.CANDeviceStats
}