CanHub.Abstractions 1.0.1

CanHub.Abstractions

简体中文

CanHub.Abstractions contains the dependency-free contracts shared by every CanHub package. Reference it when a library needs to exchange CAN/CAN FD frames, describe device capabilities, or define adapter-facing interfaces without depending on DI, Core, or vendor runtimes.

Install

dotnet add package CanHub.Abstractions

Target framework: net10.0.

What Is Included

Frame Model

CanFrame is a readonly struct with inline payload storage for classic CAN and CAN FD frames. It avoids heap allocation for normal frame creation and exposes payload data through span-based APIs.

using CanHub;

var classic = CanFrame.CreateData(
    CanId.Standard(0x123),
    new byte[] { 0x01, 0x02, 0x03 });

var fd = CanFrame.CreateFdData(
    CanId.Extended(0x18DAF110),
    stackalloc byte[] { 0x10, 0x14, 0x62, 0xF1, 0x90 },
    bitrateSwitch: true);

Span<byte> buffer = stackalloc byte[64];
fd.CopyPayloadTo(buffer);

byte[] payload = fd.ToPayloadArray();
string hex = fd.ToPayloadHexString();

Use CopyPayloadTo(Span<byte>) or TryCopyPayloadTo for allocation-conscious code. ToPayloadArray() and ToPayloadHexString() are convenience helpers for diagnostics and UI code where explicit allocation is acceptable.

Transmission Contract

ICanBus.SendAsync reports local submission. It does not promise that another node accepted the frame. Bus-level outcomes, receive frames, and faults are emitted as CanFrameEvent values, usually with the same CorrelationId when the adapter can map the event back to a submission.

Recovery Policy

Automatic bus recovery is opt-in. CanOpenOptions.Recovery defaults to CanRecoveryOptions.Disabled, so adapters report faults through StatusChanged without closing or reopening the channel unless the caller selects a policy. ResetOnFault means one immediate close/reopen using the original open context; ReopenWithBackoff uses the same close/reopen mechanism with delay and attempt limits.

Adapter Manifests

Each adapter exposes a CanAdapterManifest so tools can inspect platform support, endpoint schemes, scan support, capabilities, and exclusivity behavior without loading vendor-specific details.

License

This package is licensed under the MIT License.