Hsm.Bluetooth.Writer 1.0.0-beta.1

Abstract

Hagleitner provides this library for writing device-settings to devices produced by Hagleitner. This document introduces what the libary can do and how to use it. The library Hsm.Bluetooth.Writer is abailiable on nuget.org

Capabilities

The library handles device discovery and configuring of devices to specific usage scenarios.

Device discovery

Device discovery is needed to be able to connect to bluetooth devices. For device discovery there are two options:

1. Discovery can be requested on demand (lazyLoading)
2. Discovery can be continuously be performed in the background (eagerLoading) All performed scans will cache the discovered devices in the background for better performance. For performance reasons it is recommended to use eagerLoading.

Device verification

Before writing it is ensured that the device belongs to the OEM-partner for which this library has been compiled. If it does not it will return the ErrorCode OemTypeSettingsNotAllowed

Configuring device to a usage scenario

To configure a device to a specific usage scenario mulitple values are written to the device. The library is designed to support specific usage scenarios for specific device types. The values for a specific usage scenario are predefined by the library. The values will be read after writing to ensure a successful transmission.

Currently the following device types and usage scenarios are supported:

• Level Unit Hybrid
  • IBluetoothDeviceWriter.WriteLevelUnitConfigurationOne
    • Maximum Distance: 450mm
    • Threshold 0 Distance: 210mm
    • Threshold 1 Distance: 450mm
    • Operation Mode: OPERATION_MODE_VACANCY_DETECTION_2 (full/low/empty)
    • TimeSecondsSetting: 100s

Usage

The library supports logging via ILogger interface. Logs of the library have to be stored so that hagleitner can support in case of problems. Logging level has to be at least of level Information.

Instances of IBluetoothDeviceWriters should be disposed after a single write-function execution.

Usages on write-functions must not be concurrent. Concurrent usage might lead to corrupted data.

Sample Application

    private static async Task Main(string[] args)
    {
        var host = Host.CreateDefaultBuilder(args)
            .ConfigureServices((_, services) =>
            {
                services.AddLogging();
                //Register Bluetooth Services
                services.RegisterBluetoothWriterServices(true);
            }).Build();

        await host.StartAsync();
        var logger = host.Services.GetRequiredService<ILogger<Program>>();
        logger.LogInformation("Starting...");

        var qrCodeString = "50-02-2008-411120940000\r\n220114ML10042\r\na42f277c9544aaa7";

        if (!QrCodeFactory.TryCreateQrCode(qrCodeString, out var qrCode) || qrCode is not IEuiQrCode euiQrCode)
        {
            //Handle Error
            return;
        }

        await WriteToDeviceAsync(host, euiQrCode.Eui, default);

        logger.LogInformation("Completed");
        await host.StopAsync();
    }

    private static async Task WriteToDeviceAsync(IHost host, IEui eui, CancellationToken cancellationToken)
    {
        //use one scope per bluetoothDevice-Request and dispose it after use
        await using var scope = host.Services.CreateAsyncScope();
        var bluetoothWriter = scope.ServiceProvider.GetRequiredService<IBluetoothDeviceWriter>();

        //Write to the Device
        var completionResult = await bluetoothWriter.WriteLevelUnitConfigurationOneAsync(eui, cancellationToken);

        if (!completionResult.IsSuccessStatusCode())
        {
            //Writing to the device failed
            //the error code gives information about what issue occurred.
            var isTimeOutError = completionResult.ContainsErrorOfType(ErrorCode.TimeOutError);
        }
    }

If the application is using .NET6 it needs to target the Framework net6.0-windows10.0.19041 in the .csproj

  <PropertyGroup>
    <TargetFramework>net6.0-windows10.0.19041</TargetFramework>
  </PropertyGroup>

System Setup

The system should run only using the Laird BT820 Bluetooth Dongle. For this reason existing Bluetooth-Adapters need to be disalbed.

To disable a internal bluetoothadapter:

1. Disable bluetooth in the bluetoothsettings
2. Disable the bluetooth adapter in the devicemanager

After that you can plug in the dongle and start your application.

Requirements

• Windows10 (build 10.0.19041 or later)
• Bluetooth LE with Laird BT820
• .NET 6 (net6.0-windows10.0.19041), .NET Core3.1 or .NET Framework 4.6.1
• A Microsoft.Extensions.DependencyInjection.IServiceCollection for DependencyInjection