CanKit.Adapter.PCAN 0.3.1

dotnet add package CanKit.Adapter.PCAN --version 0.3.1
                    
NuGet\Install-Package CanKit.Adapter.PCAN -Version 0.3.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.PCAN" Version="0.3.1" />
                    
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="CanKit.Adapter.PCAN" Version="0.3.1" />
                    
Directory.Packages.props
<PackageReference Include="CanKit.Adapter.PCAN" />
                    
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.PCAN --version 0.3.1
                    
#r "nuget: CanKit.Adapter.PCAN, 0.3.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.PCAN@0.3.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.PCAN&version=0.3.1
                    
Install as a Cake Addin
#tool nuget:?package=CanKit.Adapter.PCAN&version=0.3.1
                    
Install as a Cake Tool

CanKit.Adapter.PCAN

PEAK PCAN-Basic adapter for CanKit. Provides a unified .NET API to PCAN hardware on Windows via PCAN-Basic.

Requirements

  • Install PEAK PCAN-Basic runtime/drivers.
  • Ensure PCANBasic.dll can be loaded (installed in system or alongside your app).

简体中文

  • 需要安装 PEAK PCAN-Basic 驱动/运行库。
  • 请确认运行时可加载 PCANBasic.dll(系统已安装或放到程序目录)。

Install

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

Endpoint Formats

  • pcan://PCAN_USBBUS1
  • pcan://?ch=PCAN_PCIBUS1
  • pcan:PCAN_USBBUS2

Quick Start

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

// Open a PCAN channel by name (see PCAN-Basic docs), 500 kbps
using var bus = CanBus.Open("pcan://PCAN_USBBUS1", cfg => cfg.Baud(500_000));

var tx = new CanClassicFrame(0x700, new byte[] { 0x01 });
bus.Transmit(new[] { 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("pcan"))
{
    Console.WriteLine($"{ep.Title}: {ep.Endpoint}");
}

Notes

  • Classical and FD support depend on hardware and PCAN-Basic capabilities.
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.

0.3.0

**Feature**
- Added Fake Backend: Introduced a mock backend implementation for easier unit testing and integration simulation.

- Added `NativeHandle` in `ICanBus`: Allows direct access to the underlying native handle for advanced scenarios and custom native library calls.

- Added uint overload for `AccMask` in IBusInitOptionsConfigurator: Provides more flexibility in CAN bus initialization options.

**Improvements**
- Expanded and improved unit test coverage for better reliability and maintainability.
- Optimized ZLG adapter and SocketCAN adapter performance for faster and more stable communication.

**Fixes**

- Fixed multiple issues across all adapters, improving overall stability and compatibility.

**API Stability Notice**

Starting from this release, the API is considered stable.
Future updates will not introduce breaking changes unless explicitly marked as `BREAKING` in the release notes.