/// <summary>
/// Creates a <see cref="IDeviceFactory"/> for Windows Hid devices
/// </summary>
/// <param name="filterDeviceDefinition">Devices must match this</param>
/// <param name="loggerFactory"><see href="https://docs.microsoft.com/en-us/dotnet/api/microsoft.extensions.logging.iloggerfactory"/></param>
/// <param name="hidApiService">Abstraction for Hid interaction</param>
/// <param name="classGuid">Filters by specified class guid</param>
/// <param name="readBufferSize">Override the input report size</param>
/// <param name="writeBufferSize">Override the output report size</param>
/// <param name="writeReportTransform">Given the data supplied, allow you to divide the data in to a <see cref="Report"/></param>
/// <param name="getConnectedDeviceDefinitionsAsync">Override the default call for getting definitions</param>
/// <param name="readReportTransform">Allows you to manually convert the <see cref="Report"/> in to a <see cref="TransferResult"/> so that the Report Id is not discarded on ReadAsync. By default, this inserts the Report Id at index zero of the array.</param>
/// <param name="readTransferTransform">Exposes the raw data from the device (including Report Id) on reads and allows you to format the returned <see cref="TransferResult"/></param>
/// <param name="writeTransferTransform">Given the Report Id and data supplied for the write, allow you to format the raw data that is sent to the device</param>
/// <returns>A factory which enumerates and instantiates devices</returns>
public static IDeviceFactory CreateWindowsHidDeviceFactory(
this FilterDeviceDefinition filterDeviceDefinition,
ILoggerFactory loggerFactory = null,
IHidApiService hidApiService = null,
Guid?classGuid = null,
ushort?readBufferSize = null,
ushort?writeBufferSize = null,
GetConnectedDeviceDefinitionsAsync getConnectedDeviceDefinitionsAsync = null,
Func <Report, TransferResult> readReportTransform = null,
Func <TransferResult, Report> readTransferTransform = null,
Func <byte[], byte, byte[]> writeTransferTransform = null,
WriteReportTransform writeReportTransform = null)
{
return(CreateWindowsHidDeviceFactory(
new ReadOnlyCollection <FilterDeviceDefinition>(new List <FilterDeviceDefinition> {
filterDeviceDefinition
}),
loggerFactory,
hidApiService,
classGuid,
readBufferSize,
writeBufferSize,
getConnectedDeviceDefinitionsAsync,
readReportTransform,
readTransferTransform,
writeTransferTransform,
writeReportTransform));
}
public WindowsHidDeviceFactory(ILogger logger, ITracer tracer, IHidApiService hidService) : base(logger, tracer)
{
HidService = hidService;
if (HidService == null)
{
HidService = new WindowsHidApiService(logger);
}
}
/// <summary>
/// Creates a factory Hid devices
/// </summary>
/// <param name="filterDeviceDefinitions">Devices must match these</param>
/// <param name="loggerFactory"><see href="https://docs.microsoft.com/en-us/dotnet/api/microsoft.extensions.logging.iloggerfactory"/></param>
/// <param name="hidApiService">Abstraction for Hid interaction</param>
/// <param name="classGuid">Filters by specified class guid</param>
/// <param name="readBufferSize">Override the input report size</param>
/// <param name="writeBufferSize">Override the output report size</param>
/// <param name="getConnectedDeviceDefinitionsAsync">Override the default call for getting definitions</param>
/// <param name="readReportTransform">Allows you to manually convert the <see cref="Report"/> in to a <see cref="TransferResult"/> so that the Report Id is not discarded on ReadAsync. By default, this inserts the Report Id at index zero of the array.</param>
/// <param name="readTransferTransform">Exposes the raw data from the device (including Report Id) on reads and allows you to format the returned <see cref="TransferResult"/></param>
/// <param name="writeTransferTransform">Given the Report Id and data supplied for the write, allow you to format the raw data that is sent to the device</param>
/// <param name="writeReportTransform">Given the data supplied, allow you to divide the data in to a <see cref="Report"/></param>
/// <returns>A factory which enumerates and instantiates devices</returns>
public static IDeviceFactory CreateWindowsHidDeviceFactory(
this IEnumerable <FilterDeviceDefinition> filterDeviceDefinitions,
ILoggerFactory loggerFactory = null,
IHidApiService hidApiService = null,
Guid?classGuid = null,
ushort?readBufferSize = null,
ushort?writeBufferSize = null,
GetConnectedDeviceDefinitionsAsync getConnectedDeviceDefinitionsAsync = null,
Func <Report, TransferResult> readReportTransform = null,
Func <TransferResult, Report> readTransferTransform = null,
Func <byte[], byte, byte[]> writeTransferTransform = null,
WriteReportTransform writeReportTransform = null)
{
if (filterDeviceDefinitions == null)
{
throw new ArgumentNullException(nameof(filterDeviceDefinitions));
}
loggerFactory ??= NullLoggerFactory.Instance;
var selectedHidApiService = hidApiService ?? new WindowsHidApiService(loggerFactory);
classGuid ??= selectedHidApiService.GetHidGuid();
if (getConnectedDeviceDefinitionsAsync == null)
{
var windowsDeviceEnumerator = new WindowsDeviceEnumerator(
loggerFactory.CreateLogger <WindowsDeviceEnumerator>(),
classGuid.Value,
(d, guid) => GetDeviceDefinition(d, selectedHidApiService, loggerFactory.CreateLogger(nameof(WindowsHidDeviceFactoryExtensions))),
c => Task.FromResult(!filterDeviceDefinitions.Any() || filterDeviceDefinitions.FirstOrDefault(f => f.IsDefinitionMatch(c, DeviceType.Hid)) != null)
);
getConnectedDeviceDefinitionsAsync = windowsDeviceEnumerator.GetConnectedDeviceDefinitionsAsync;
}
return(new DeviceFactory(
loggerFactory,
getConnectedDeviceDefinitionsAsync,
(c, cancellationToken) => Task.FromResult <IDevice>(new HidDevice
(
new WindowsHidHandler(
c.DeviceId,
writeBufferSize,
readBufferSize,
hidApiService,
loggerFactory,
readTransferTransform,
writeTransferTransform),
loggerFactory,
readReportTransform,
writeReportTransform
)),
(c, cancellationToken) => Task.FromResult(c.DeviceType == DeviceType.Hid)));
}
public WindowsHidHandler(
string deviceId,
ushort?writeBufferSize = null,
ushort?readBufferSize = null,
IHidApiService hidApiService = null,
ILoggerFactory loggerFactory = null,
Func <TransferResult, Report> readTransferTransform = null,
Func <byte[], byte, byte[]> writeTransferTransform = null)
{
_logger = (loggerFactory ?? NullLoggerFactory.Instance).CreateLogger <WindowsHidHandler>();
DeviceId = deviceId ?? throw new ArgumentNullException(nameof(deviceId));
_readTransferTransform = readTransferTransform ??
new Func <TransferResult, Report>((tr) => tr.ToReadReport(_logger));
_writeTransferTransform = writeTransferTransform ??
new Func <byte[], byte, byte[]>(
(data, reportId) => data.InsertReportIdAtIndexZero(reportId, _logger));
_hidService = hidApiService ?? new WindowsHidApiService(loggerFactory);
WriteBufferSize = writeBufferSize;
ReadBufferSize = readBufferSize;
}
public WindowsHidDevice(string deviceId, ushort?writeBufferSize, ushort?readBufferSize, ILogger logger, ITracer tracer, IHidApiService hidService) : base(deviceId, logger, tracer)
{
_WriteBufferSize = writeBufferSize;
_ReadBufferSize = readBufferSize;
HidService = hidService ?? new WindowsHidApiService(logger);
}
private static ConnectedDeviceDefinition GetDeviceDefinition(string deviceId, IHidApiService HidService, ILogger logger)
{
logger ??= NullLogger.Instance;
using var logScope = logger.BeginScope("DeviceId: {deviceId} Call: {call}", deviceId, nameof(GetDeviceDefinition));
try
{
using var safeFileHandle = HidService.CreateReadConnection(deviceId, FileAccessRights.None);
if (safeFileHandle.IsInvalid)
{
throw new DeviceException($"{nameof(HidService.CreateReadConnection)} call with Id of {deviceId} failed.");
}
logger.LogDebug(Messages.InformationMessageFoundDevice);
return(HidService.GetDeviceDefinition(deviceId, safeFileHandle));
}
catch (Exception ex)
{
logger.LogError(ex, Messages.ErrorMessageCouldntGetDevice);
return(null);
}
}
