Oakrey.Peak.Can.Wrapper 1.0.0

Oakrey.Peak.Can.Wrapper

Overview

The Oakrey.Peak.Can.Wrapper project is a .NET library designed to provide a high-level interface for interacting with Peak CAN devices. It simplifies the process of configuring and controlling CAN communication, including support for CAN FD, message filtering, and advanced logging and tracing functionalities.

Features

CAN Communication:

Supports standard and extended CAN communication with classes like Message, MessageFD, and MessageContainer. Provides methods for sending and receiving CAN messages through PeakCanWrapper.Messages.

CAN FD Support:

Includes FdMessageContainer and FdBitRateParameters for managing CAN FD communication.

Device Configuration:

Offers configuration capabilities with ChannelInformation, ChannelCapability, and HardwareType. Manages baud rates and other parameters using BaudRateCode and LookupParameters.

Message Filtering:

Implements filtering mechanisms with Filter and FilterMode for precise message control.

Logging and Tracing:

Provides advanced logging capabilities with LogType and PeakCanWrapper.Logging. Supports tracing of CAN messages and events using TraceType and PeakCanWrapper.Tracing.

Error Handling:

Includes robust error handling with PeakCanException and Status classes.

Native Interfacing:

Utilizes native methods (PeakCanNativeMethods) for low-level operations, including client management, message handling, and parameter configuration.

Extensibility:

Designed with extensible wrappers and utilities for advanced use cases, such as special behaviors and identification.

Installation

You can install the package via NuGet Package Manager, Package Manager Console or the .NET CLI.

NuGet Package Manager

1. Open your project in Visual Studio.
2. Navigate to Tools > NuGet Package Manager > Manage NuGet Packages for Solution....
3. Search for Oakrey.Peak.Can.Wrapper and click Install.

.NET CLI

Run the following command in your terminal:

dotnet add package Oakrey.Peak.Can.Wrapper

Package Manager Console

Run the following command in your Package Manager Console:

Install-Package Oakrey.Peak.Can.Wrapper

Requirements

• .NET 8 or higher

Project Information

• Author: Oakrey
• Company: Oakrey
• License: MIT
• Repository: Git Repository
• Project URL: Project Website

Contributing

Contributions are welcome! Feel free to open issues or submit pull requests to improve the package.

License

This project is licensed under the MIT License. See the LICENSE file for details.