Oakrey.ASRockService.Client 2.0.5

Oakrey.ASRockService.Client

Project overview

Oakrey.ASRockService.Client is a .NET library that provides a strongly-typed client for the ASRockService Windows service. It connects to the service over two channels: a SignalR hub (MessagePack protocol) for write/control operations, and a plain HTTP REST API for state reads. The primary entry point for consumers is the static AsRockFactory class.

Main features

Transport split

• Write operations (SetPsu, SetOut, SetGpioOutState, SetGpioInput, ReleaseDevice) � SignalR hub invocation
• Read operations (GetPsuState, GetOutState, GetPinState, IsPinInput) � HTTP GET to the REST API

Architecture

graph TD
    Consumer --> AsRockFactory
    AsRockFactory --> ASRockClient
    ASRockClient -->|SignalR MessagePack<br>port 4753 /devicehub| Service[ASRockService\nWindows Service]
    ASRockClient -->|HTTP GET<br>port 4753 /api/devicelist| Service

Requirements

• .NET 10
• ASRockService Windows service running and reachable on localhost:4753
• NuGet dependencies: Microsoft.AspNetCore.SignalR.Client, Microsoft.AspNetCore.SignalR.Protocols.MessagePack, Oakrey.ASRockService.Common, Oakrey.Log

Installation

.NET CLI

dotnet add package Oakrey.ASRockService.Client

Package Manager Console

Install-Package Oakrey.ASRockService.Client

NuGet Package Manager

Search for Oakrey.ASRockService.Client in Tools > NuGet Package Manager > Manage NuGet Packages for Solution.

Example usage

Connect and control

using Oakrey.ASRockService.Client;

// Connect � throws InvalidOperationException if the service is not reachable
await using IASRockClient client = await AsRockFactory.GetDevice(CancellationToken.None);

// Read state via HTTP
bool psuOn  = await client.GetPsuState(CancellationToken.None);
bool outOn  = await client.GetOutState(CancellationToken.None);
bool pinOn  = await client.GetPinState(71, CancellationToken.None);
bool isIn   = await client.IsPinInput(71, CancellationToken.None);

// Write via SignalR
await client.SetPsu(true, CancellationToken.None);
await client.SetOut(false, CancellationToken.None);
await client.SetGpioOutState(72, true, CancellationToken.None);
await client.SetGpioInput(73, CancellationToken.None);

// Release the device (stops the SignalR connection)
await client.ReleaseDevice(CancellationToken.None);

Cancellation and timeout

using CancellationTokenSource cts = new(TimeSpan.FromSeconds(5));
await using IASRockClient client = await AsRockFactory.GetDevice(cts.Token);
await client.SetPsu(true, cts.Token);

Development notes

• ASRockClient has an internal constructor � instantiate only via AsRockFactory.GetDevice.
• The host is hardcoded to localhost and the port to 4753. There is no public constructor or options class to override these; changing them requires modifying ASRockClient directly.
• The HTTP client uses a 2000 ms timeout. Ensure the service is fully started before calling GetDevice.
• IASRockClient is decorated with [Guid, ComVisible(true)] and can be consumed from COM clients.
• Dispose on ASRockClient calls ReleaseDevice synchronously with a 2000 ms timeout; prefer calling ReleaseDevice explicitly before disposal in async code.

License

MIT � Copyright (c) Oakrey 2016-present

• Author: Oakrey
• Repository: https://dev.azure.com/oakrey/OpenPackages/_git/Drivers
• Project URL: http://www.oakrey.cz/opkg_drivers_asrock