Table of Contents

Class CanController

Namespace
nanoFramework.Device.Can
Assembly
nanoFramework.Device.Can.dll

Represents a CAN controller on the system.

public sealed class CanController : IDisposable
Inheritance
CanController
Implements
Inherited Members
Extension Methods

Fields

ControllerId

Controller ID for this CanController.

public readonly string ControllerId

Field Value

string

Methods

Dispose()

Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.

public void Dispose()

Finalize() 

protected override void Finalize()

FromId(string, CanSettings)

Opens a CAN bus with the settings provided.

public static CanController FromId(string controllerId, CanSettings settings)

Parameters

controllerId string

The id of the bus.

settings CanSettings

The bus settings.

Returns

CanController

The CAN controller requested.

GetMessage()

Get next CanMessage available in the _CanController internal buffer. If there are no more messages available null will be returned.

public CanMessage GetMessage()

Returns

CanMessage

A CanMessage or null if there are no more messages available.

WriteMessage(CanMessage)

Write message to CAN Bus.

public void WriteMessage(CanMessage message)

Parameters

message CanMessage

CAN mesage to write in CAN Bus.

Events

MessageReceived

Indicates that a message has been received through a CanController object.

public event CanMessageReceivedEventHandler MessageReceived

Event Type

CanMessageReceivedEventHandler