Oakrey.Applications.Dashboards.CAN 1.0.1

Oakrey.Applications.Dashboards.CAN

A .NET 10 Windows library for building persistent WPF dashboards from CAN signals decoded with DBC definitions. It connects Oakrey.Applications.DecodingServices.CAN with the shared Oakrey dashboard infrastructure.

Main features

• Represents a dashboard entry as a validated DBC SignalValue binding.
• Assigns decoded signals by source device, CAN channel, message identifier, and signal name.
• Automatically binds an unassigned dashboard item to the first matching CAN source.
• Prevents duplicate dashboard entries.
• Loads, appends, saves, and clears JSON dashboard configurations.
• Publishes configuration-load and collection-change notifications.
• Provides WPF commands and connection-state notifications through DashboardViewModel.
• Supports gauge, digital value, bulb, graph, and histogram views.

Architecture

flowchart LR
    Decoder[ICANDecodingService] -->|ReceivedCanMessage| Dashboard[DashboardItemCollection]
    Dashboard --> Items[DashboardItem]
    JSON[IJsonService] <--> Dashboard
    CAN[ICanDeviceService] --> ViewModel[DashboardViewModel]
    Dashboard --> ViewModel

Key types

Requirements

• .NET 10 for Windows 10, version 1809 or later
• WPF
• A configured ICANDecodingService from Oakrey.Applications.DecodingServices.CAN
• A configured ICanDeviceService from Oakrey.Applications.Ohm.CAN
• Configured IJsonService and IAppConfigPath implementations

Installation

.NET CLI

dotnet add package Oakrey.Applications.Dashboards.CAN

Package Manager Console

Install-Package Oakrey.Applications.Dashboards.CAN

NuGet Package Manager

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

Registration

Register one collection instance for both the concrete and interface service types:

services.AddSingleton<DashboardItemCollection>();
services.AddSingleton<IDashboardService>(provider =>
    provider.GetRequiredService<DashboardItemCollection>());
services.AddTransient<DashboardViewModel>();

Example usage

Create an unassigned item and feed decoded CAN updates into the dashboard:

dashboardService.Add(signal);

IDisposable updateSubscription = decodingService.MessageUpdated.Subscribe(
    dashboardService.AssignMessageSignalsToItems);

The first matching message binds an unassigned item to its device and channel. Later messages update only the item with the same device, channel, DBC message ID, and signal name. To pin an item immediately, provide the device serial number and channel when adding it:

dashboardService.Add(signal, relatedDevice: "device-serial", relatedChannel: 0);

Load the default configuration or observe items loaded during preload:

IDisposable loadedSubscription = dashboardService.ItemsLoaded.Subscribe(items =>
{
    Console.WriteLine($"Loaded {items.Count} CAN dashboard items.");
});

await dashboardService.LoadDashboardConfig(cancellationToken);

The default configuration is stored as userDashboardCan.json below the configured application-data path. Dispose subscriptions when no longer needed and dispose the dashboard collection during application shutdown.

Project information

License

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