CanKit.Adapter.SocketCAN
0.5.1
.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.
dotnet add package CanKit.Adapter.SocketCAN --version 0.5.1
NuGet\Install-Package CanKit.Adapter.SocketCAN -Version 0.5.1
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.1" />
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.1" />
<PackageReference Include="CanKit.Adapter.SocketCAN" />
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.1
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
#r "nuget: CanKit.Adapter.SocketCAN, 0.5.1"
#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.1
#: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.1
#tool nuget:?package=CanKit.Adapter.SocketCAN&version=0.5.1
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
CanKit.Adapter.SocketCAN
SocketCAN adapter for CanKit. Provides a unified .NET API to Linux SocketCAN interfaces.
- Repository: https://github.com/pkuyo/CanKit
- Package:
CanKit.Adapter.SocketCAN - Depends on:
CanKit.Core
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://can0socketcan://vcan0socketcan://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 | Versions 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.
-
.NETStandard 2.0
- CanKit.Core (>= 0.5.1)
-
net8.0
- CanKit.Core (>= 0.5.1)
-
net8.0-windows7.0
- CanKit.Core (>= 0.5.1)
NuGet packages
This package is not used by any NuGet packages.
GitHub repositories
This package is not used by any popular GitHub repositories.
## 0.5.1
### Added
* **Vector device enumeration**: Added helpers to query available Vector devices (filters by AppName `"CANoe"`).
### Changed
* **`SocketCanBus` TX path**: Optimized the send logic to reduce GC allocations and overhead.
* **Adapter registration**: Refactored registration patterns and entry points to leave room for upcoming Transport/Protocol layers (ISO-TP work in progress).
### Fixed
* **`VectorBus` `accessMask`**: Corrected the way the `accessMask` is obtained.
### Performance
* **Lower allocations on transmit** via the optimized `SocketCanBus` send path.
### Breaking changes
* None.