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


                    

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


                            Directory.Packages.props
                        

                    

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


                            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.Vector --version 0.5.1
                    


                    

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


                            Install as a Cake Addin
                        

                    

                
#tool nuget:?package=CanKit.Adapter.Vector&version=0.5.1
                    


                            Install as a Cake Tool

CanKit.Adapter.Vector

  • Implements Vector XL Driver (vxlapi) interop via P/Invoke
  • Supports Classic CAN and CAN FD (tx/rx, error frames, bitrate configuration)
  • Manages driver lifetime with reference-counted open/close
  • Applies mask-based hardware filters with software fallbacks
  • Enumerates channels via VectorEndpoint.Enumerate() for discovery
  • Handles x86/x64 by resolving to vxlapi.dll/vxlapi64.dll at runtime

Requirements

  • Windows with Vector XL Driver installed (vxlapi runtime).
  • Ensure vxlapi.dll/vxlapi64.dll are discoverable via PATH or placed beside your app.

Install

dotnet add package CanKit.Core
dotnet add package CanKit.Adapter.Vector

Endpoint Formats

  • vector://<appName>/<channelIndex> (e.g., vector://CanKit/0)
    • <appName> is the Vector XL application name used by xlOpenPort.
    • <channelIndex> maps to the app channel index; internally resolved to global channel.
  • FAKE builds: vector://virtual/0, vector://virtual/1 (connected pair).

vQuick Start

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

// Open Vector channel 0 with CAN FD 500k/2M
using var bus = CanBus.Open("vector://CanKit/0", cfg => cfg.Fd(500_000, 2_000_000));

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

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

Bus State & Error Counters

  • VectorBus updates BusState and ErrorCounters upon receiving a chip-state event.
  • Call RequestBusState() first, then wait briefly before reading:
var vbus = (CanKit.Adapter.Vector.VectorBus)bus;
vbus.RequestBusState();
await Task.Delay(200); // allow vxlapi to deliver state event
var state = vbus.BusState;
var counters = vbus.ErrorCounters();

Notes

  • Hardware filters are mask-based; range filters can be emulated via software fallback if enabled.
  • If xlOpenPort returns no configuration permission, initial timing and output mode may not be applied.
  • Bus usage (bus load) is not supported via this adapter.
  • x86/x64 runtime is auto-resolved (vxlapi.dll / vxlapi64.dll).
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.4 175 12/14/2025
0.5.3 359 12/8/2025
0.5.2 694 12/2/2025
0.5.1 292 11/10/2025
0.5.0 158 11/1/2025
0.4.0 208 10/27/2025

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