BMSnet.Client 3.2.0

BMSnet.Client

A .NET client library for accessing BMSnet APIs, including entity and time series operations through a unified client interface.

Version 3

Version 3 has moved to .NET 10.

Latest time series values

GetLastTimeSeriesAsync now accepts a count parameter, so you can request multiple latest values.

var options = new BMSnetClientOptions
{
    ClientId = "your-client-id",
    ClientSecret = "your-client-secret",
    Scope = BMSnetClientOptions.DataApiScope
};

using var client = new BMSnetClient(options);

var entityId = Guid.Parse("12345678-1234-1234-1234-123456789abc");
var latestValue = await client.GetLastTimeSeriesAsync(entityId);
var latestTenValues = await client.GetLastTimeSeriesAsync(entityId, count: 10);

Getting started

Installation

Add the package to your project and target .NET 10 for version 3.

Configuration

The library uses the options pattern. You must provide OAuth credentials and can optionally override the default endpoints and scope.

var options = new BMSnetClientOptions
{
    ClientId = "your-client-id",
    ClientSecret = "your-client-secret",
    Scope = BMSnetClientOptions.DataApiScope
};

Dependency injection

The simplest approach reads from IConfiguration already registered in the DI container. Options are validated at startup — the app will fail to start with a clear message if ClientId or ClientSecret are missing.

// Program.cs
builder.Services.AddBMSnetClient();

With a matching appsettings.json:

{
  "BMSnetClient": {
    "ClientId": "your-client-id",
    "ClientSecret": "your-client-secret"
  }
}

Or configure options manually (useful in console apps and tests):

services.AddBMSnetClient(options =>
{
    options.ClientId = "your-client-id";
    options.ClientSecret = "your-client-secret";
});

Configuration options

Scope constants

• BMSnetClientOptions.DataApiScope = "bmsnetdataapi"
• BMSnetClientOptions.DataApiReadOnlyScope = "bmsnetdataapi_readonly"

Time series examples

Get the latest value

var latest = await client.GetLastTimeSeriesAsync(entityId);

Get the latest 10 values

var latestTen = await client.GetLastTimeSeriesAsync(entityId, count: 10);

Get a time range

var series = await client.GetTimeSeriesAsync(
    entityId,
    from: DateTime.UtcNow.AddHours(-24),
    to: DateTime.UtcNow,
    interval: "PT15M");  // ISO 8601 duration

Entity caching

Entity caching can be enabled to avoid repeated API calls for the same entity. Cache entries are invalidated when an entity is updated or deleted. Enable it via options:

{ "BMSnetClient": { "EnableEntityCache": true } }

or programmatically:

services.AddBMSnetClient(options => options.EnableEntityCache = true);
// or when constructing directly:
var options = new BMSnetClientOptions { ..., EnableEntityCache = true };

Thread safety

BMSnetClient is thread-safe. Token refresh is protected by internal locking, so it is safe to register as a singleton in web apps and Azure Functions.

Migration from version 2.x

• Update your project to target .NET 10 for version 3
• GetLastTimeSeriesAsync now supports an optional count parameter

Migration from version 3.1.x

• The enableEntityCache constructor parameter has been removed — set options.EnableEntityCache = true instead
• AddBMSnetClient overloads have been simplified: use AddBMSnetClient() (reads from DI-registered IConfiguration) or AddBMSnetClient(Action<BMSnetClientOptions>)

License

MIT