CanKit.Adapter.SocketCAN 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.SocketCAN --version 0.5.0
                    


                    

                
NuGet\Install-Package CanKit.Adapter.SocketCAN -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.SocketCAN" 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.SocketCAN" Version="0.5.0" />
                    


                            Directory.Packages.props
                        

                    

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


                            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.SocketCAN --version 0.5.0
                    


                    

                
#r "nuget: CanKit.Adapter.SocketCAN, 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.SocketCAN@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.SocketCAN&version=0.5.0
                    


                            Install as a Cake Addin
                        

                    

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


                            Install as a Cake Tool

CanKit.Adapter.SocketCAN

SocketCAN adapter for CanKit. Provides a unified .NET API to Linux SocketCAN interfaces.

Requirements

  • Linux with SocketCAN enabled (can, vcan, vxcan).
  • Ensure libsocketcan/netlink is installed.

简体中文

  • 仅支持 Linux（SocketCAN）。
  • 需安装 libsocketcan。

Install

# Core + SocketCAN adapter
dotnet add package CanKit.Core
dotnet add package CanKit.Adapter.SocketCAN

Endpoint Formats

  • socketcan://can0
  • socketcan://vcan0
  • socketcan://can0#netlink (enable netlink-based configuration)
  • socketcan://can0?rcvbuf=1048576 (set receive buffer)

Quick Start

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

// Open can0, set 500 kbps
using var bus = CanBus.Open("socketcan://can0", cfg => cfg.Baud(500_000));

var tx = CanFrame.Classic(0x123, new byte[] { 1, 2, 3 });
bus.Transmit(tx);

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

Discover Endpoints

using CanKit.Core.Endpoints;

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

Notes

  • When using #netlink, the adapter may attempt to set bitrate via libsocketcan; otherwise, ensure the interface is pre-configured (e.g., ip link set can0 up type can bitrate 500000).
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.1 92 11/10/2025
0.5.0 108 11/1/2025
0.4.0 168 10/27/2025
0.3.3.1 163 10/23/2025
0.3.3 169 10/23/2025
0.3.2 157 10/21/2025
0.3.1 109 10/18/2025
0.2.1 192 10/13/2025 0.2.1 is deprecated because it has critical bugs.
0.2.0 180 10/12/2025 0.2.0 is deprecated because it has critical bugs.
0.1.0 281 10/8/2025 0.1.0 is deprecated because it has critical bugs.

## 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.