CanKit.Adapter.ControlCAN 0.5.0

.NET 8.0 This package targets .NET 8.0. The package is compatible with this framework or higher. .NET Standard 2.0 This package targets .NET Standard 2.0. The package is compatible with this framework or higher.
There is a newer version of this package available.
See the version list below for details. 
dotnet add package CanKit.Adapter.ControlCAN --version 0.5.0
                    


                    

                
NuGet\Install-Package CanKit.Adapter.ControlCAN -Version 0.5.0
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package. 
<PackageReference Include="CanKit.Adapter.ControlCAN" Version="0.5.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package. 
<PackageVersion Include="CanKit.Adapter.ControlCAN" Version="0.5.0" />
                    


                            Directory.Packages.props
                        

                    

                
<PackageReference Include="CanKit.Adapter.ControlCAN" />
                    


                            Project file
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package. 
paket add CanKit.Adapter.ControlCAN --version 0.5.0
                    


                    

                
#r "nuget: CanKit.Adapter.ControlCAN, 0.5.0"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package. 
#:package CanKit.Adapter.ControlCAN@0.5.0
#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package. 
#addin nuget:?package=CanKit.Adapter.ControlCAN&version=0.5.0
                    


                            Install as a Cake Addin
                        

                    

                
#tool nuget:?package=CanKit.Adapter.ControlCAN&version=0.5.0
                    


                            Install as a Cake Tool

CanKit.Adapter.ControlCAN

用于 CanKit 的 ControlCAN 适配器。通过 ControlCAN.dll 为使用 ControlCAN API 的设备（例如 GCAN/广成、CHX/创芯、ZLG/周立功 等）提供统一的 .NET API。

  • 包：CanKit.Adapter.ControlCAN
  • 依赖：CanKit.Core

系统要求

  • 需要在 Windows 上安装厂商提供的 ControlCAN 运行时（ControlCAN.dll）。
  • 确保 ControlCAN.dll 在系统 PATH 中，或与应用程序放在同一目录。
  • 进程位数需与 DLL 匹配（x86/x64）。部分老设备只提供 32 位库；如不确定，请以 x86 为目标。

安装

dotnet add package CanKit.Core
dotnet add package CanKit.Adapter.ControlCAN

端点格式

  • controlcan://USBCAN2?index=0#ch1
  • controlcan://VCI_USBCAN2?index=0#ch1
  • controlcan://?type=USBCAN2&index=0#ch1

说明

  • index 选择设备索引（从 0 开始）。
  • #chX 选择通道索引（例如 #ch0、#ch1）。
  • type 映射到 ControlCAN 的设备类型。若省略，默认 USBCAN2。

快速上手

using CanKit.Core;
using CanKit.Core.Definitions;

// 以 500 kbps（经典 CAN）打开 USBCAN2 设备索引 0 的通道 1
using var bus = CanBus.Open("controlcan://USBCAN2?index=0#ch1",
    cfg => cfg.Baud(500_000));

// 发送
bus.Transmit(CanFrame.Classic(0x321, new byte[] { 0xAA, 0xBB }));

// 接收（带超时，单位：毫秒）
foreach (var rx in bus.Receive(1, 100))
{
    var f = rx.CanFrame;
    Console.WriteLine($"RX 0x{f.ID:X} dlc={f.Dlc}");
}

备注

  • 仅支持经典 CAN；ControlCAN 适配器不支持 CAN FD。
  • 硬件过滤为基于掩码。若需按 ID 区间过滤，请启用软件兜底并添加区间规则，例如：
using var bus = CanBus.Open("controlcan://USBCAN2?index=0#ch0", cfg =>
    cfg.SoftwareFeaturesFallBack(CanFeature.RangeFilter)
       .RangeFilter(0x100, 0x200));
  • 不支持读取总线使用率（bus load）。
  • ErrorCounters() 通过 VCI_ReadErrInfo 读取；可用性和准确性可能因设备/驱动而异。
  • 如需可调整轮询间隔：cfg.Custom("PollingInterval", 10)（毫秒）。
Product Compatible and additional computed target framework versions.
.NET net5.0 was computed.  net5.0-windows was computed.  net6.0 was computed.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 was computed.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 is compatible.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed.  net8.0-windows7.0 is compatible.  net9.0 was computed.  net9.0-android was computed.  net9.0-browser was computed.  net9.0-ios was computed.  net9.0-maccatalyst was computed.  net9.0-macos was computed.  net9.0-tvos was computed.  net9.0-windows was computed.  net10.0 was computed.  net10.0-android was computed.  net10.0-browser was computed.  net10.0-ios was computed.  net10.0-maccatalyst was computed.  net10.0-macos was computed.  net10.0-tvos was computed.  net10.0-windows was computed. 
.NET Core netcoreapp2.0 was computed.  netcoreapp2.1 was computed.  netcoreapp2.2 was computed.  netcoreapp3.0 was computed.  netcoreapp3.1 was computed. 
.NET Standard netstandard2.0 is compatible.  netstandard2.1 was computed. 
.NET Framework net461 was computed.  net462 was computed.  net463 was computed.  net47 was computed.  net471 was computed.  net472 was computed.  net48 was computed.  net481 was computed. 
MonoAndroid monoandroid was computed. 
MonoMac monomac was computed. 
MonoTouch monotouch was computed. 
Tizen tizen40 was computed.  tizen60 was computed. 
Xamarin.iOS xamarinios was computed. 
Xamarin.Mac xamarinmac was computed. 
Xamarin.TVOS xamarintvos was computed. 
Xamarin.WatchOS xamarinwatchos was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last Updated
0.5.4 185 12/14/2025
0.5.3 367 12/8/2025
0.5.2 695 12/2/2025
0.5.1 279 11/10/2025
0.5.0 146 11/1/2025
0.4.0 212 10/27/2025

## 0.5.0

### Added

* **CanKit.Abstractions**: New project with a corresponding NuGet package.
* **Receive payload allocator**: `CanBus` receive path now supports an `IBufferAllocator` for `CanFrame` payloads to optimize memory usage and reduce GC. Two default implementations are included: `ArrayPoolBufferAllocator` and `DefaultBufferAllocator`.
* **Queued transmission**: Introduced `QueuedCanBus` that adds a TX queue to any existing bus. Create via `ICanBus.WithQueuedTx(QueuedCanBusOptions)`.

### Changed

* **Timing source**: ZLG and SocketCAN adapters now use `Stopwatch` instead of `Environment.TickCount` for more stable timing.

### Performance

* **Lower allocations on receive** via the allocator-based payload path.
* **Fewer conversions in hot paths** thanks to a unified frame type (see breaking changes).

### Breaking changes

* **Unified frame type**: Removed `ICanFrame`, `CanClassicFrame`, and `CanFdFrame`. Introduced a single `CanFrame` for all CAN frame kinds. Create frames using `CanFrame.Classic(...)`, `CanFrame.Fd(...)`, or `CanFrame.Create(...)`.

 * **Primary motivation**: Eliminate the boxing/unboxing and back-and-forth conversions between `ICanFrame` and concrete frame types, which previously added per-frame CPU overhead and extra allocations in hot paths. Unifying to `CanFrame` removes those interface–concrete transitions and reduces GC pressure.