Oakrey.Applications.CANDecodingServices 0.8.0-beta

Oakrey.Applications.CANDecodingServices

A .NET 10 Windows library that decodes received CAN frames using the messages and signals defined in a loaded DBC file. It connects Oakrey.Applications.Ohm.CAN reception with Oakrey.Applications.FileParsing.DBC and exposes decoded messages, signal samples, unknown frames, message history, and live decoder statistics.

Main features

• Automatically tracks the message definitions from the currently loaded DBC matrix.
• Decodes frames received through ICanDeviceService into DBC-backed TaskMessage instances.
• Keeps one live ReceivedCanMessage per device, channel, and CAN message ID.
• Publishes reactive streams for created and updated messages, every processed frame, unknown frames, and statistics.
• Exposes decoded signal name, unit, and value through CanSignalSample.
• Retains the latest 50 raw-value history entries for each received message.
• Reports decoded and unknown frame totals, unique counts, and per-second rates.
• Supports standard, extended-ID, and CAN FD frame metadata.

Architecture

flowchart LR
    DBC[IDbcService] -->|DBC matrix| Decoder[CANDecodingService]
    CAN[ICanDeviceService] -->|received CAN frames| Decoder
    Decoder --> Messages[ReceivedMessages]
    Decoder --> Events[Reactive event streams]
    Decoder --> Statistics[Decoder statistics]

Key types

Requirements

• .NET 10 for Windows
• A configured IDbcService from Oakrey.Applications.FileParsing.DBC
• A configured ICanDeviceService from Oakrey.Applications.Ohm.CAN

Installation

.NET CLI

dotnet add package Oakrey.Applications.CANDecodingServices

Package Manager Console

Install-Package Oakrey.Applications.CANDecodingServices

NuGet Package Manager

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

Registration

Register the service after configuring its DBC and CAN device dependencies:

services.AddSingleton<ICANDecodingService, CANDecodingService>();

The service subscribes to DBC-file and CAN-frame streams when it is created. Loading a new DBC matrix refreshes CompatibleMessages and clears messages decoded from the previous matrix.

Example usage

Observe newly discovered messages and subsequent updates:

IDisposable createdSubscription = decodingService.MessageCreated.Subscribe(received =>
{
    Console.WriteLine($"New message: {received.Message.Name}");
});

IDisposable updatedSubscription = decodingService.MessageUpdated.Subscribe(received =>
{
    Console.WriteLine($"{received.Message.Name}: {received.MessagesPerSecond:F1} msg/s");
});

Consume a normalized result for every frame, including unknown frames:

IDisposable frameSubscription = decodingService.FrameProcessed.Subscribe(frame =>
{
    string name = frame.MessageName ?? "Unknown";
    Console.WriteLine($"{name} (0x{frame.MessageId:X}): {frame.Signals.Count} signals");
});

IDisposable unknownSubscription = decodingService.UnknownFrameReceived.Subscribe(frame =>
{
    Console.WriteLine($"Unknown CAN ID 0x{frame.MessageId:X} on channel {frame.Channel}");
});

Read the periodically published statistics:

IDisposable statisticsSubscription = decodingService.Statistic.Subscribe(statistics =>
{
    Console.WriteLine(
        $"Received: {statistics.TotalReceivedItems}, " +
        $"decoded: {statistics.ItemDecodedCount}, " +
        $"unknown: {statistics.UnknownItemsReceived}");
});

Dispose subscriptions when they are no longer needed. The decoding service itself is disposable and should normally have the same lifetime as its DBC and CAN device services.

Project information

License

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