Files
ThingsGateway/src/Foundation/ThingsGateway.Foundation/Device/DeviceExtension.cs
2025-10-18 03:18:45 +08:00

231 lines
10 KiB
C#
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

//------------------------------------------------------------------------------
// 此代码版权声明为全文件覆盖,如有原作者特别声明,会在下方手动补充
// 此代码版权除特别声明外的代码归作者本人Diego所有
// 源代码使用协议遵循本仓库的开源协议及附加协议
// Gitee源代码仓库https://gitee.com/diego2098/ThingsGateway
// Github源代码仓库https://github.com/kimdiego2098/ThingsGateway
// 使用文档https://thingsgateway.cn/
// QQ群605534569
//------------------------------------------------------------------------------
namespace ThingsGateway.Foundation;
/// <summary>
/// 协议基类
/// </summary>
public static partial class DeviceExtension
{
#region
/// <inheritdoc/>
public static async ValueTask<OperResult<Boolean>> ReadBooleanAsync(this IDevice device, string address, CancellationToken cancellationToken = default)
{
var result = await device.ReadBooleanAsync(address, 1, null, cancellationToken).ConfigureAwait(false);
return result.OperResultFrom(() => result.Content[0]);
}
/// <inheritdoc/>
public static async ValueTask<OperResult<Double>> ReadDoubleAsync(this IDevice device, string address, CancellationToken cancellationToken = default)
{
var result = await device.ReadDoubleAsync(address, 1, null, cancellationToken).ConfigureAwait(false);
return result.OperResultFrom(() => result.Content[0]);
}
/// <inheritdoc/>
public static async ValueTask<OperResult<Int16>> ReadInt16Async(this IDevice device, string address, CancellationToken cancellationToken = default)
{
var result = await device.ReadInt16Async(address, 1, null, cancellationToken).ConfigureAwait(false);
return result.OperResultFrom(() => result.Content[0]);
}
/// <inheritdoc/>
public static async ValueTask<OperResult<Int32>> ReadInt32Async(this IDevice device, string address, CancellationToken cancellationToken = default)
{
var result = await device.ReadInt32Async(address, 1, null, cancellationToken).ConfigureAwait(false);
return result.OperResultFrom(() => result.Content[0]);
}
/// <inheritdoc/>
public static async ValueTask<OperResult<Int64>> ReadInt64Async(this IDevice device, string address, CancellationToken cancellationToken = default)
{
var result = await device.ReadInt64Async(address, 1, null, cancellationToken).ConfigureAwait(false);
return result.OperResultFrom(() => result.Content[0]);
}
/// <inheritdoc/>
public static async ValueTask<OperResult<Single>> ReadSingleAsync(this IDevice device, string address, CancellationToken cancellationToken = default)
{
var result = await device.ReadSingleAsync(address, 1, null, cancellationToken).ConfigureAwait(false);
return result.OperResultFrom(() => result.Content[0]);
}
/// <inheritdoc/>
public static async ValueTask<OperResult<String>> ReadStringAsync(this IDevice device, string address, CancellationToken cancellationToken = default)
{
var result = await device.ReadStringAsync(address, 1, null, cancellationToken).ConfigureAwait(false);
return result.OperResultFrom(() => result.Content[0]);
}
/// <inheritdoc/>
public static async ValueTask<OperResult<UInt16>> ReadUInt16Async(this IDevice device, string address, CancellationToken cancellationToken = default)
{
var result = await device.ReadUInt16Async(address, 1, null, cancellationToken).ConfigureAwait(false);
return result.OperResultFrom(() => result.Content[0]);
}
/// <inheritdoc/>
public static async ValueTask<OperResult<UInt32>> ReadUInt32Async(this IDevice device, string address, CancellationToken cancellationToken = default)
{
var result = await device.ReadUInt32Async(address, 1, null, cancellationToken).ConfigureAwait(false);
return result.OperResultFrom(() => result.Content[0]);
}
/// <inheritdoc/>
public static async ValueTask<OperResult<UInt64>> ReadUInt64Async(this IDevice device, string address, CancellationToken cancellationToken = default)
{
var result = await device.ReadUInt64Async(address, 1, null, cancellationToken).ConfigureAwait(false);
return result.OperResultFrom(() => result.Content[0]);
}
#endregion
/// <summary>
/// 在返回的字节数组中解析每个变量的值
/// 根据每个变量的<see cref="IVariable.Index"/>
/// 不支持变长字符串类型变量不能存在于变量List中
/// </summary>
/// <param name="device">设备</param>
/// <param name="variables">设备变量List</param>
/// <param name="buffer">返回的字节数组</param>
/// <param name="exWhenAny">任意一个失败时抛出异常</param>
/// <returns>解析结果</returns>
public static OperResult PraseStructContent<T>(this IEnumerable<T> variables, IDevice device, ReadOnlySpan<byte> buffer, bool exWhenAny) where T : IVariable
{
var time = DateTime.Now;
if (variables is IList<T> collection)
{
return PraseCollection(collection, device, buffer, exWhenAny, time);
}
else
{
return PraseEnumerable(variables, device, buffer, exWhenAny, time);
}
static OperResult PraseEnumerable(IEnumerable<T> variables, IDevice device, ReadOnlySpan<byte> buffer, bool exWhenAny, DateTime time)
{
foreach (var variable in variables)
{
IThingsGatewayBitConverter byteConverter = variable.ThingsGatewayBitConverter;
var dataType = variable.DataType;
int index = variable.Index;
try
{
var changed = byteConverter.GetChangedDataFormBytes(device, variable.RegisterAddress, buffer, index, dataType, variable.ArrayLength ?? 1, variable.RawValue, out var data);
if (changed)
{
var result = variable.SetValue(data, time);
if (exWhenAny)
if (!result.IsSuccess)
return result;
}
else
{
variable.SetNoChangedValue(time);
}
}
catch (Exception ex)
{
return new OperResult($"Error parsing byte array, address: {variable.RegisterAddress}, array length: {buffer.Length}, index: {index}, type: {dataType}", ex);
}
}
return OperResult.Success;
}
static OperResult PraseCollection(IList<T> variables, IDevice device, ReadOnlySpan<byte> buffer, bool exWhenAny, DateTime time)
{
for (int i = 0; i < variables.Count; i++)
{
var variable = variables[i];
IThingsGatewayBitConverter byteConverter = variable.ThingsGatewayBitConverter;
var dataType = variable.DataType;
int index = variable.Index;
try
{
var changed = byteConverter.GetChangedDataFormBytes(device, variable.RegisterAddress, buffer, index, dataType, variable.ArrayLength ?? 1, variable.RawValue, out var data);
if (changed)
{
var result = variable.SetValue(data, time);
if (exWhenAny)
if (!result.IsSuccess)
return result;
}
else
{
variable.SetNoChangedValue(time);
}
}
catch (Exception ex)
{
return new OperResult($"Error parsing byte array, address: {variable.RegisterAddress}, array length: {buffer.Length}, index: {index}, type: {dataType}", ex);
}
}
return OperResult.Success;
}
}
/// <summary>
/// 当状态不是<see cref="WaitDataStatus.Success"/>时返回异常。
/// </summary>
public static OperResult Check(this AsyncWaitData<MessageBase> waitDataAsync, bool timeout)
{
switch (waitDataAsync.Status)
{
case WaitDataStatus.Success:
return new();
case WaitDataStatus.Canceled:
if (timeout)
{
if (waitDataAsync.CompletedData != null)
{
waitDataAsync.CompletedData.Exception = new TimeoutException();
if (waitDataAsync.CompletedData.IsSuccess) waitDataAsync.CompletedData.OperCode = 999;
if (waitDataAsync.CompletedData.ErrorMessage.IsNullOrEmpty()) waitDataAsync.CompletedData.ErrorMessage = "Timeout";
return new(waitDataAsync.CompletedData);
}
else
{
return new(new TimeoutException());
}
}
else
{
return new(new OperationCanceledException());
}
case WaitDataStatus.Overtime:
{
if (waitDataAsync.CompletedData != null)
{
waitDataAsync.CompletedData.Exception = new TimeoutException();
if (waitDataAsync.CompletedData.IsSuccess) waitDataAsync.CompletedData.OperCode = 999;
if (waitDataAsync.CompletedData.ErrorMessage.IsNullOrEmpty()) waitDataAsync.CompletedData.ErrorMessage = "Timeout";
return new(waitDataAsync.CompletedData);
}
else
{
return new(new TimeoutException());
}
}
case WaitDataStatus.Disposed:
case WaitDataStatus.Default:
default:
{
return waitDataAsync.CompletedData == null ? new(new Exception(AppResource.UnknownError)) : new(waitDataAsync.CompletedData);
}
}
}
}