CanKit.Adapter.ZLG 0.3.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.
There is a newer version of this package available.
See the version list below for details. 
dotnet add package CanKit.Adapter.ZLG --version 0.3.1
                    


                    

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


                            Directory.Packages.props
                        

                    

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


                            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.ZLG --version 0.3.1
                    


                    

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


                            Install as a Cake Addin
                        

                    

                
#tool nuget:?package=CanKit.Adapter.ZLG&version=0.3.1
                    


                            Install as a Cake Tool

CanKit.Adapter.ZLG

ZLG adapter for CanKit. Provides a unified .NET API to access ZLG USBCAN/PCIe devices (CAN and CAN FD) via zlgcan.dll.

Requirements

  • Windows with ZLG drivers installed (zlgcan runtime, typically installed with ZLGCAN or USBCAN FD package).
  • Ensure zlgcan.dll is available on PATH or next to your app.
  • It is strongly recommended to compile as an x86 application. For some older devices (e.g., USBCAN1/2), not enabling this may prevent the device from starting properly.

简体中文

  • Windows，需要已安装周立功 ZLG CAN 驱动（含 zlgcan.dll）。
  • 请保证运行时能加载到 zlgcan.dll（放到程序目录或加入 PATH）。
  • 强烈建议编译为x86程序，对于一部分老设备（USBCAN1/2等）不开启会导致无法正常开启设备。

Install

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

Endpoint Formats

  • zlg://USBCANFD-200U?index=0#ch1
  • zlg://ZCAN_USBCANFD_200U?index=0#ch1
  • zlg://ZLG.ZCAN_USBCANFD_200U?index=0#ch1

Notes

  • index selects the device index (0-based).
  • #chX selects the channel index (e.g., #ch0, #ch1).

中文说明

  • index 为设备索引（从 0 开始）。
  • 片段部分 #chX 表示通道索引（如 #ch0、#ch1）。

Quick Start

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

// Open device USBCANFD-200U, device index 0, channel 1; set CAN FD 500k/2M
using var bus = CanBus.Open(
    "zlg://USBCANFD-200U?index=0#ch1",
    cfg => cfg.Fd(500_000, 2_000_000)
);

// Transmit a classic CAN frame (ID 0x123)
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}");
}

Discover Endpoints

You can enumerate discoverable endpoints when drivers are present:

using CanKit.Core.Endpoints;

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

Support Devices

  • UUSBCAN-I/I+、USBCAN-I-MINI
  • USBCAN-II/II+、MiniPCIeCAN-II
  • PCI-9820、PCI-9820I
  • PCI-5010-U、PCI-5020-U、USBCAN-E-U、USBCAN-2E-U、USBCAN-4E-U、USBCAN-8E-U
  • USBCANDTU-100UR、CANDTU-200UR
  • USBCANFD-100U、USBCANFD-200U、USBCANFD-400U、USBCANFD-800U、USBCANFD-MINI
  • PCIE-CANFD-100U, PCIE-CANFD-200U-EX,PCIE-CANFD-400U, M/2CANFD, MiniPCIeCANFD
  • PCIE_CANFD_200U

Notes

  • Configure bitrate either via cfg.Baud(...) for Classical CAN or cfg.Fd(abit, dbit, ...) for CAN FD.
  • Actual bitrate acceptance and timing depend on device and driver capability.
  • For application packaging, include zlgcan.dll if it is not globally installed.
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.