Interfaces

Abstract type for Interfaces.

send(interface::T<:AbstractCANInterface, frame::AbstractFrame)

Abstract function for send message.

Common behavior of concrete implements:

• When send successed, return nothing.
• When send failed, throws error.

recv(interface::T<:AbstractCANInterface)

Abstract function for receive message.

Common behavior of concrete implements:

• non-blocking
• When receive successed, returns Frame or FDFrame.
• When receive queue is empty, returns nothing.
• When fails to receive in other reasons, throws error.

shutdown(interface::T<:AbstractCANInterface)

Abstract function for shutdown interface. Always returns nothing.

AcceptanceFilter(code_id, mask)

Struct for accept filter.

If this struct is set to Interface, the id is accepted when <received_id> & mask == code_id & mask or (<received_id> xor code_id) & mask == 0. Those are equivalent.

KvaserInterface(channel::Int, bitrate::Int;
    silent::Bool, stdfilter::AcceptanceFilter, extfilter::AcceptanceFilter)

Setup Kvaser interface

• channel: channel number in integer.
• bitrate: bitrate as bit/s in integer.
• silent(optional): listen only flag in bool.
• stdfilter(optional): standard ID filter in AcceptanceFilter struct.
• extfilter(optional): extended ID filter in AcceptanceFilter struct.

KvaserFDInterface(channel::Int, bitrate::Int, datarate::Int;
    non_iso::Bool, silent::Bool, stdfilter::AcceptanceFilter, extfilter::AcceptanceFilter)

Setup Kvaser interface for CAN FD.

• channel: channel number in integer.
• bitrate: bitrate as bit/s in integer.
• datarate: datarate as bit/s in integer.
• non_iso(optional): use non-iso version of CAN FD
• silent(optional): listen only flag in bool.
• stdfilter(optional): standard ID filter in AcceptanceFilter struct.
• extfilter(optional): extended ID filter in AcceptanceFilter struct.

SocketCANInterface(channel::String; filters::Vector{AcceptanceFilter})

Setup SocketCAN interface.

• channel: channel name string, e.g. "can0"
• filters(optional): list of filters. experimental.

SocketCANFDInterface(channel::String; filters::Vector{AcceptanceFilter})

Setup SocketCAN for CAN FD.

• channel: channel name string, e.g. "can0"
• filters(optional): list of filters. experimental.

VectorInterface(channel::Int, bitrate::Int, appname::String)

Setup Vector interface.

• channel: channel number in integer.
• bitrate: bitrate as bit/s in integer.
• apppname: Application Name string in Vector Hardware Manager.
• silent(optional): listen only flag in bool.
• stdfilter(optional): standard ID filter in AcceptanceFilter struct.
• extfilter(optional): extended ID filter in AcceptanceFilter struct.

VectorFDInterface(channel::Int, bitrate::Int, datarate::Int, appname::String)

Setup Vector interface for CAN FD.

• channel: channel number in integer.
• bitrate: bitrate as bit/s in integer.
• datarate: datarate as bit/s in integer.
• apppname: Application Name string in Vector Hardware Manager.
• non_iso(optional): use non-iso version of CAN FD
• silent(optional): listen only flag in bool.
• stdfilter(optional): standard ID filter in AcceptanceFilter struct.
• extfilter(optional): extended ID filter in AcceptanceFilter struct.