Oakrey.Applications.Ohm.CAN 0.6.0-beta

Oakrey.Applications.Ohm.CAN

A .NET library that provides a service layer for managing CAN bus hardware devices and channels. It wraps Oakrey.HardwareManager.Client.CAN with a higher-level abstraction that covers device discovery, connection lifecycle, reactive data streams, configuration persistence, and USB hot-plug support.

Main features

• Enumerate and manage multiple CAN devices and their channels via ICanDeviceService
• Reactive IObservable<CanReceivedData> stream for received CAN frames
• Reactive IObservable<DeviceStatus> stream for connection state changes
• Per-channel transmit support via ICanChannel.Transmit
• Persistent user configuration saved as JSON (userDevicesCan.json)
• USB hot-plug detection through IUsbNotifyingService
• Configurable channel aliases, enabled/disabled state, and trace selection
• Clean-config keyboard shortcut at startup

Architecture

classDiagram
    class ICanDeviceService {
        +AsyncObservableCollection~ICanDevice~ Devices
        +IObservable~CanReceivedData~ Received
        +IObservable~DeviceStatus~ Status
        +Connect(CancellationToken)
        +Disconnect()
        +RefreshAvailableDevices(CancellationToken)
        +SaveDevicesConfig()
        +LoadDevicesConfig()
    }
    class ICanDevice {
        +string SerialNumber
        +CanChannelCollection Channels
        +IObservable~CanReceivedData~ Received
        +IObservable~DeviceStatus~ Status
        +ConnectAllChannels(CancellationToken)
        +DisconnectAllChannels()
    }
    class ICanChannel {
        +int ChannelNumber
        +bool Enabled
        +bool Traced
        +IObservable~CanReceivedData~ Received
        +Connect(CancellationToken)
        +Disconnect()
        +Transmit(CanMessage, CancellationToken)
    }
    ICanDeviceService "1" --> "*" ICanDevice
    ICanDevice "1" --> "*" ICanChannel

Key types

Requirements

• .NET 10 or higher
• Oakrey.HardwareManager.Client.CAN 4.0.0
• Oakrey.HardwareManager.Client.Common 4.0.0
• Oakrey.ViewModels 2.1.0
• Oakrey.Log 2.0.0

Installation

.NET CLI

dotnet add package Oakrey.Applications.Ohm.CAN

Package Manager Console

Install-Package Oakrey.Applications.Ohm.CAN

NuGet Package Manager

Search for Oakrey.Applications.Ohm.CAN in Tools > NuGet Package Manager > Manage NuGet Packages for Solution.

Configuration

User device settings are automatically saved to and loaded from:

<UserSettingsPath>\userDevicesCan.json

UserSettingsPath is provided via IApplicationInfo at construction time.

To reset the configuration, hold the clean-config keyboard combination while starting the application. The combination is resolved by KeyboardExtension.IsCleanConfigCombinationPressed().

Example usage

Register the service with your DI container:

services.AddSingleton<ICanDeviceService, CanDeviceService>();

Discover devices and connect:

await canDeviceService.RefreshAvailableDevices(cancellationToken);
await canDeviceService.Connect(cancellationToken);

Subscribe to received CAN frames:

canDeviceService.Received.Subscribe(data =>
{
    Console.WriteLine($"Frame received on {data.ChannelName}");
});

Transmit a CAN message on a specific channel:

ICanChannel channel = canDeviceService.GetDevice(serialNumber, channelNumber);
await channel.Transmit(new CanMessage { /* ... */ }, cancellationToken);

Save and load device configuration:

canDeviceService.SaveDevicesConfig();
canDeviceService.LoadDevicesConfig();

Development notes

• CanDeviceService implements IPreLoadable, allowing it to participate in application pre-load sequences.
• All async methods accept a CancellationToken and must not be blocked with .Wait() or .Result.
• CanDeviceService is IDisposable; ensure it is disposed when the application shuts down to release hardware resources and Rx subscriptions.

Project information

• Author: Oakrey
• License: MIT
• Repository: ApplicationServices
• Package URL: NuGet - Oakrey.Applications.Ohm.CAN

License

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