CanKit.Core 0.2.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.
Suggested Alternatives

CanKit.Core 0.3.1

There is a newer version of this package available.
See the version list below for details. 
dotnet add package CanKit.Core --version 0.2.0
                    


                    

                
NuGet\Install-Package CanKit.Core -Version 0.2.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.Core" Version="0.2.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package. 
<PackageVersion Include="CanKit.Core" Version="0.2.0" />
                    


                            Directory.Packages.props
                        

                    

                
<PackageReference Include="CanKit.Core" />
                    


                            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.Core --version 0.2.0
                    


                    

                
#r "nuget: CanKit.Core, 0.2.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.Core@0.2.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.Core&version=0.2.0
                    


                            Install as a Cake Addin
                        

                    

                
#tool nuget:?package=CanKit.Core&version=0.2.0
                    


                            Install as a Cake Tool

CanKit.Core

Core abstractions and utilities for CanKit: unified CAN bus API, endpoints, frames, filters, timing, and helpers.

This package defines the common interfaces and helpers. To talk to real hardware, install an adapter package such as:

  • CanKit.Adapter.SocketCAN (Linux)
  • CanKit.Adapter.PCAN (PEAK PCAN-Basic)
  • CanKit.Adapter.Kvaser (Kvaser CANlib)
  • CanKit.Adapter.ZLG (ZLGCAN)
  • CanKit.Adapter.Virtual (no hardware, for testing)

简体中文

  • 该包提供核心抽象与工具。要访问实际硬件，请安装对应适配器包（如 SocketCAN/PCAN/Kvaser/ZLG/Virtual）。

Install

dotnet add package CanKit.Core

Quick Start

Below uses the Virtual adapter for a minimal example. Replace the endpoint with your adapter’s scheme (e.g., socketcan://can0, pcan://PCAN_USBBUS1).

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

// Open a bus by endpoint; configure bitrate at open
using var bus = CanBus.Open("virtual://demo/0", cfg => cfg.Baud(500_000));

// Transmit a classic CAN frame
var tx = new CanClassicFrame(0x123, new byte[] { 1, 2, 3 });
bus.Transmit(new[] { tx });

// Receive with timeout (ms)
foreach (var rx in bus.Receive(1, 100))
{
    var f = rx.CanFrame;
    Console.WriteLine($"RX id=0x{f.ID:X}, dlc={f.Dlc}");
}

For CAN FD, configure both arbitration/data bitrates:

using var fdBus = CanBus.Open("virtual://demo/1", cfg => cfg.Fd(500_000, 2_000_000));

Enumerate Endpoints

List endpoints exposed by installed adapters:

using CanKit.Core.Endpoints;

foreach (var ep in BusEndpointEntry.Enumerate())
{
    Console.WriteLine($"{ep.Title}: {ep.Endpoint}");
}

Filter by scheme/vendor:

foreach (var ep in BusEndpointEntry.Enumerate("socketcan", "pcan", "kvaser", "zlg", "virtual"))
{
    Console.WriteLine(ep.Endpoint);
}

Notes

  • Bit timing helpers: cfg.Baud(...) for Classical CAN, cfg.Fd(abit, dbit, ...) for CAN FD.
  • Received frames expose CanReceiveData.CanFrame. Build frames with CanClassicFrame or other implementations.
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 (5)

Showing the top 5 NuGet packages that depend on CanKit.Core:

Package Downloads
CanKit.Adapter.ZLG

ZLG adapter for CanKit, enabling unified access to ZLG USBCAN/PCIe CAN/CAN FD devices (zlgcan.dll).
CanKit.Adapter.Virtual

Virtual in-process CAN adapter for CanKit for development, testing, and simulation.
CanKit.Adapter.PCAN

Peak PCAN (PCAN-Basic) adapter for CanKit, providing unified bus access to PCAN hardware on Windows.
CanKit.Adapter.SocketCAN

SocketCAN adapter for CanKit, offering unified CAN/CAN FD access on Linux via kernel CAN.
CanKit.Adapter.Kvaser

Kvaser CANlib adapter for CanKit, enabling unified CAN/CAN FD access to Kvaser devices.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last Updated
0.3.3.1 145 10/23/2025
0.3.3 140 10/23/2025
0.3.2 327 10/21/2025
0.3.1 296 10/18/2025
0.2.1 366 10/13/2025 0.2.1 is deprecated because it has critical bugs.
0.2.0 411 10/12/2025 0.2.0 is deprecated because it has critical bugs.

0.2.0
- Performance: reduced GC pressure in transmit/receive across all adapters.
- Performance: improved receive path for Kvaser and PCAN to increase throughput.
- API: adjusted public APIs to better match common usage patterns.
- API: added Custom(key, value) to pass adapter-specific parameters directly.