Oakrey.Applications.Ohm.Abstractions 2.0.0

Oakrey.Applications.Ohm

Shared contracts, configuration models, collections, and lifecycle base classes for Oakrey hardware-bus integrations.

The package contains the protocol-independent foundation used by Oakrey.Applications.Ohm.CAN and Oakrey.Applications.Ohm.LIN. It can also be used to implement another channel-based transport without duplicating synchronization, reactive-stream, configuration, discovery, or disposal logic.

Features

• Common IChannel, IDevice, and IDeviceService contracts
• Strongly typed generic variants for messages, configurations, clients, devices, and channel collections
• Thread-safe channel connection and disconnection
• Synchronized reactive streams for received messages and DeviceStatus changes
• Deterministic, idempotent cleanup of clients, subscriptions, devices, and services
• Device discovery serialized through a refresh gate
• Debounced and cancellable USB hot-plug refresh
• JSON configuration loading, saving, validation, and clean-start support
• Reusable channel collections and serializable configuration base types

Installation

dotnet add package Oakrey.Applications.Ohm

The library targets .NET 10 for Windows.

Architecture

IChannel                         IDevice                         IDeviceService
   │                                │                                  │
   ├─ IChannel<T...>                ├─ IDevice<TChannel>               └─ IDeviceService<T...>
   │                                ├─ IReceivingDevice<T...>                    │
   └─ ChannelBase<T...>             ├─ IDevice<T...>                            └─ DeviceServiceBase<T...>
                                    └─ DeviceBase<T...>

Protocol packages derive their concrete implementations from the three base classes:

ChannelBase     ──► CanChannel / LinChannel
DeviceBase      ──► CanDevice / LinDevice
DeviceServiceBase ─► CanDeviceService / LinDeviceService

Main types

Lifecycle guarantees

ChannelBase serializes Connect and Disconnect. Repeated connection attempts do not replace an active client, failed or cancelled attempts clean up temporary clients, and receive-stream failures publish DeviceStatus.Error.

DeviceBase aggregates channel messages and statuses. Channel refresh and disposal cannot run concurrently, and old subscriptions and channels are disposed before a refreshed collection becomes active.

DeviceServiceBase serializes discovery, removes unavailable devices safely, owns per-device subscriptions, and coalesces bursts of USB notifications into one delayed refresh. Public operations validate their inputs and reject use after disposal.

All base classes implement deterministic disposal. Register device services with a DI lifetime that disposes them during application shutdown, normally singleton.

Implementing another protocol

A protocol adapter normally supplies:

1. A channel interface derived from IChannel<TDevice,TReceived,TConfig>.
2. A client-specific class derived from ChannelBase implementing client creation, connectivity detection, and its receive observable.
3. A device class derived from DeviceBase implementing channel construction and hardware discovery.
4. A service derived from DeviceServiceBase implementing device construction, connection, disconnection, and configuration mapping.

Keep transport-specific send operations on the protocol channel interface; the common channel contract intentionally models only behavior shared by all transports.

Configuration

ChannelConfig and DeviceConfig expose parameterless construction for System.Text.Json. Derived configuration types should retain a public parameterless constructor and may add a constructor that captures a live channel or device.

The service stores its configuration beside IApplicationInfo.UserSettingsPath. The concrete protocol selects the filename.

License

MIT