Class CanCtrl

Namespace

Iot.Device.Mcp25xxx.Register.CanControl

Assembly

Iot.Device.Mcp25xxx.dll

CAN Control Register.

public class CanCtrl : IRegister

Inheritance

object

CanCtrl

Implements

IRegister

Constructors

CanCtrl(PinPrescaler, bool, bool, bool, OperationMode)

Initializes a new instance of the CanCtrl class.

public CanCtrl(CanCtrl.PinPrescaler clkOutPinPrescaler, bool clkOutPinEnable, bool oneShotMode, bool abortAllPendingTransmissions, OperationMode requestOperationMode)

Parameters

clkOutPinPrescaler CanCtrl.PinPrescaler

CLKPRE[1:0]: CLKOUT Pin Prescaler bits.

clkOutPinEnable bool

CLKEN: CLKOUT Pin Enable bit. True = CLKOUT pin is enabled. False = CLKOUT pin is disabled(pin is in a high-impedance state).

oneShotMode bool

OSM: One-Shot Mode bit. True = Enabled: Message will only attempt to transmit one time. False = Disabled: Messages will reattempt transmission if required.

abortAllPendingTransmissions bool

ABAT: Abort All Pending Transmissions bit. True = Requests abort of all pending transmit buffers. False = Terminates request to abort all transmissions.

requestOperationMode OperationMode

REQOP[2:0]: Request Operation mode bits.

CanCtrl(byte)

Initializes a new instance of the CanCtrl class.

public CanCtrl(byte value)

Parameters

value byte

The value that represents the register contents.

Properties

AbortAllPendingTransmissions

ABAT: Abort All Pending Transmissions bit. True = Requests abort of all pending transmit buffers. False = Terminates request to abort all transmissions.

public bool AbortAllPendingTransmissions { get; }

Property Value

bool

Address

Gets the address of the register.

public Address Address { get; }

Property Value

Address

The address of the register.

ClkOutPinEnable

CLKEN: CLKOUT Pin Enable bit. True = CLKOUT pin is enabled. False = CLKOUT pin is disabled (pin is in a high-impedance state).

public bool ClkOutPinEnable { get; }

Property Value

bool

ClkOutPinPrescaler

CLKPRE[1:0]: CLKOUT Pin Prescaler bits.

public CanCtrl.PinPrescaler ClkOutPinPrescaler { get; }

Property Value

CanCtrl.PinPrescaler

OneShotMode

OSM: One-Shot Mode bit. True = Enabled: Message will only attempt to transmit one time. False = Disabled: Messages will reattempt transmission if required.

public bool OneShotMode { get; }

Property Value

bool

RequestOperationMode

REQOP[2:0]: Request Operation mode bits.

public OperationMode RequestOperationMode { get; }

Property Value

OperationMode

Methods

ToByte()

Converts register contents to a byte.

public byte ToByte()

Returns

byte

The byte that represent the register contents.