1
0
mirror of https://github.com/DarthAffe/RGB.NET.git synced 2025-12-12 17:48:31 +00:00

(MAJOR) Added success-indication to device updates and forced flushes after nonsuccessful ones.

Added exception handling the last missing queues.
This commit is contained in:
Darth Affe 2023-03-05 18:04:50 +01:00
parent 37e4954583
commit 30ccfdcd85
21 changed files with 151 additions and 50 deletions

View File

@ -111,7 +111,7 @@ public abstract class AbstractRGBDevice<TDeviceInfo> : Placeable, IRGBDevice<TDe
/// </summary>
/// <param name="flushLeds">Forces all LEDs to be treated as dirty.</param>
/// <returns>The collection LEDs to update.</returns>
protected virtual IEnumerable<Led> GetLedsToUpdate(bool flushLeds) => ((RequiresFlush || flushLeds) ? LedMapping.Values : LedMapping.Values.Where(x => x.IsDirty)).Where(led => led.RequestedColor?.A > 0);
protected virtual IEnumerable<Led> GetLedsToUpdate(bool flushLeds) => ((RequiresFlush || flushLeds || UpdateQueue.RequiresFlush) ? LedMapping.Values : LedMapping.Values.Where(x => x.IsDirty)).Where(led => led.RequestedColor?.A > 0);
/// <summary>
/// Gets an enumerable of a custom data and color tuple for the specified leds.

View File

@ -11,6 +11,11 @@ namespace RGB.NET.Core;
public interface IUpdateQueue<TIdentifier, TData> : IDisposable
where TIdentifier : notnull
{
/// <summary>
/// Gets a bool indicating if the queue requires a flush of all data due to an internal error.
/// </summary>
bool RequiresFlush { get; }
/// <summary>
/// Sets or merges the provided data set in the current dataset and notifies the trigger that there is new data available.
/// </summary>

View File

@ -19,6 +19,8 @@ public abstract class UpdateQueue<TIdentifier, TData> : IUpdateQueue<TIdentifier
private readonly IDeviceUpdateTrigger _updateTrigger;
private readonly Dictionary<TIdentifier, TData> _currentDataSet = new();
public bool RequiresFlush { get; private set; }
#endregion
#region Constructors
@ -62,7 +64,7 @@ public abstract class UpdateQueue<TIdentifier, TData> : IUpdateQueue<TIdentifier
_currentDataSet.Clear();
}
Update(data);
RequiresFlush = !Update(data);
ArrayPool<(TIdentifier, TData)>.Shared.Return(dataSet);
}
@ -78,7 +80,7 @@ public abstract class UpdateQueue<TIdentifier, TData> : IUpdateQueue<TIdentifier
/// Performs the update this queue is responsible for.
/// </summary>
/// <param name="dataSet">The set of data that needs to be updated.</param>
protected abstract void Update(in ReadOnlySpan<(TIdentifier key, TData color)> dataSet);
protected abstract bool Update(in ReadOnlySpan<(TIdentifier key, TData color)> dataSet);
/// <summary>
/// Sets or merges the provided data set in the current dataset and notifies the trigger that there is new data available.

View File

@ -43,14 +43,14 @@ public class AsusUpdateQueue : UpdateQueue
#region Methods
/// <inheritdoc />
protected override void Update(in ReadOnlySpan<(object key, Color color)> dataSet)
protected override bool Update(in ReadOnlySpan<(object key, Color color)> dataSet)
{
try
{
if ((Device.Type == (uint)AsusDeviceType.KEYBOARD_RGB) || (Device.Type == (uint)AsusDeviceType.NB_KB_RGB))
{
if (Device is not IAuraSyncKeyboard keyboard)
return;
return true;
foreach ((object customData, Color value) in dataSet)
{
@ -88,12 +88,16 @@ public class AsusUpdateQueue : UpdateQueue
}
Device.Apply();
return true;
}
catch (Exception ex)
{
AsusDeviceProvider.Instance.Throw(ex, true);
AsusDeviceProvider.Instance.Throw(ex);
}
}
return false;
}
#endregion
}

View File

@ -37,7 +37,7 @@ public class CoolerMasterUpdateQueue : UpdateQueue
#region Methods
/// <inheritdoc />
protected override void Update(in ReadOnlySpan<(object key, Color color)> dataSet)
protected override bool Update(in ReadOnlySpan<(object key, Color color)> dataSet)
{
try
{
@ -48,11 +48,15 @@ public class CoolerMasterUpdateQueue : UpdateQueue
}
_CoolerMasterSDK.SetAllLedColor(_deviceMatrix, _deviceIndex);
return true;
}
catch (Exception ex)
{
CoolerMasterDeviceProvider.Instance.Throw(ex, true);
CoolerMasterDeviceProvider.Instance.Throw(ex);
}
return false;
}
#endregion

View File

@ -38,10 +38,12 @@ public class CorsairDeviceUpdateQueue : UpdateQueue
#region Methods
/// <inheritdoc />
protected override unsafe void Update(in ReadOnlySpan<(object key, Color color)> dataSet)
protected override unsafe bool Update(in ReadOnlySpan<(object key, Color color)> dataSet)
{
try
{
if (!_CUESDK.IsConnected) return false;
Span<_CorsairLedColor> colors = new((void*)_colorPtr, dataSet.Length);
for (int i = 0; i < colors.Length; i++)
{
@ -53,11 +55,15 @@ public class CorsairDeviceUpdateQueue : UpdateQueue
CorsairError error = _CUESDK.CorsairSetLedColors(_device.id!, dataSet.Length, _colorPtr);
if (error != CorsairError.Success)
throw new RGBDeviceException($"Failed to update device '{_device.id}'. (ErrorCode: {error})");
return true;
}
catch (Exception ex)
{
CorsairDeviceProvider.Instance.Throw(ex, true);
CorsairDeviceProvider.Instance.Throw(ex);
}
return false;
}
/// <inheritdoc />

View File

@ -59,7 +59,7 @@ public class E131UpdateQueue : UpdateQueue
}
/// <inheritdoc />
protected override void Update(in ReadOnlySpan<(object key, Color color)> dataSet)
protected override bool Update(in ReadOnlySpan<(object key, Color color)> dataSet)
{
try
{
@ -73,11 +73,15 @@ public class E131UpdateQueue : UpdateQueue
}
_socket.Send(DataPacket, DataPacket.Length);
return true;
}
catch (Exception ex)
{
DMXDeviceProvider.Instance.Throw(ex, true);
DMXDeviceProvider.Instance.Throw(ex);
}
return false;
}
/// <summary>

View File

@ -15,7 +15,7 @@ internal class DebugDeviceUpdateQueue : UpdateQueue
#region Methods
protected override void Update(in ReadOnlySpan<(object key, Color color)> dataSet) { }
protected override bool Update(in ReadOnlySpan<(object key, Color color)> dataSet) => true;
#endregion
}

View File

@ -25,7 +25,7 @@ public class LogitechPerDeviceUpdateQueue : UpdateQueue
#region Methods
/// <inheritdoc />
protected override void Update(in ReadOnlySpan<(object key, Color color)> dataSet)
protected override bool Update(in ReadOnlySpan<(object key, Color color)> dataSet)
{
try
{
@ -35,11 +35,15 @@ public class LogitechPerDeviceUpdateQueue : UpdateQueue
_LogitechGSDK.LogiLedSetLighting((int)Math.Round(color.R * 100),
(int)Math.Round(color.G * 100),
(int)Math.Round(color.B * 100));
return true;
}
catch (Exception ex)
{
LogitechDeviceProvider.Instance.Throw(ex, true);
LogitechDeviceProvider.Instance.Throw(ex);
}
return false;
}
#endregion

View File

@ -25,7 +25,7 @@ public class LogitechPerKeyUpdateQueue : UpdateQueue
#region Methods
/// <inheritdoc />
protected override void Update(in ReadOnlySpan<(object key, Color color)> dataSet)
protected override bool Update(in ReadOnlySpan<(object key, Color color)> dataSet)
{
try
{
@ -40,11 +40,15 @@ public class LogitechPerKeyUpdateQueue : UpdateQueue
(int)MathF.Round(color.G * 100),
(int)MathF.Round(color.B * 100));
}
return true;
}
catch (Exception ex)
{
LogitechDeviceProvider.Instance.Throw(ex, true);
LogitechDeviceProvider.Instance.Throw(ex);
}
return false;
}
#endregion

View File

@ -33,18 +33,29 @@ public class LogitechZoneUpdateQueue : UpdateQueue
#region Methods
/// <inheritdoc />
protected override void Update(in ReadOnlySpan<(object key, Color color)> dataSet)
protected override bool Update(in ReadOnlySpan<(object key, Color color)> dataSet)
{
_LogitechGSDK.LogiLedSetTargetDevice(LogitechDeviceCaps.All);
foreach ((object key, Color color) in dataSet)
try
{
int zone = (int)key;
_LogitechGSDK.LogiLedSetLightingForTargetZone(_deviceType, zone,
(int)MathF.Round(color.R * 100),
(int)MathF.Round(color.G * 100),
(int)MathF.Round(color.B * 100));
_LogitechGSDK.LogiLedSetTargetDevice(LogitechDeviceCaps.All);
foreach ((object key, Color color) in dataSet)
{
int zone = (int)key;
_LogitechGSDK.LogiLedSetLightingForTargetZone(_deviceType, zone,
(int)MathF.Round(color.R * 100),
(int)MathF.Round(color.G * 100),
(int)MathF.Round(color.B * 100));
}
return true;
}
catch (Exception ex)
{
LogitechDeviceProvider.Instance.Throw(ex);
}
return false;
}
#endregion

View File

@ -34,17 +34,21 @@ public class MsiDeviceUpdateQueue : UpdateQueue
#region Methods
/// <inheritdoc />
protected override void Update(in ReadOnlySpan<(object key, Color color)> dataSet)
protected override bool Update(in ReadOnlySpan<(object key, Color color)> dataSet)
{
try
{
foreach ((object key, Color color) in dataSet)
_MsiSDK.SetLedColor(_deviceType, (int)key, color.GetR(), color.GetG(), color.GetB());
return true;
}
catch (Exception ex)
{
MsiDeviceProvider.Instance.Throw(ex, true);
MsiDeviceProvider.Instance.Throw(ex);
}
return false;
}
#endregion

View File

@ -35,17 +35,21 @@ public abstract class MidiUpdateQueue : UpdateQueue
#region Methods
/// <inheritdoc />
protected override void Update(in ReadOnlySpan<(object key, Color color)> dataSet)
protected override bool Update(in ReadOnlySpan<(object key, Color color)> dataSet)
{
try
{
foreach ((object key, Color color) in dataSet)
SendMessage(CreateMessage(key, color));
return true;
}
catch (Exception ex)
{
NovationDeviceProvider.Instance.Throw(ex, true);
NovationDeviceProvider.Instance.Throw(ex);
}
return false;
}
/// <summary>

View File

@ -49,7 +49,7 @@ public class OpenRGBUpdateQueue : UpdateQueue
#region Methods
/// <inheritdoc />
protected override void Update(in ReadOnlySpan<(object key, Color color)> dataSet)
protected override bool Update(in ReadOnlySpan<(object key, Color color)> dataSet)
{
try
{
@ -57,11 +57,15 @@ public class OpenRGBUpdateQueue : UpdateQueue
_colors[(int)key] = new OpenRGBColor(color.GetR(), color.GetG(), color.GetB());
_openRGB.UpdateLeds(_deviceid, _colors);
return true;
}
catch (Exception ex)
{
OpenRGBDeviceProvider.Instance.Throw(ex, true);
OpenRGBDeviceProvider.Instance.Throw(ex);
}
return false;
}
#endregion

View File

@ -44,7 +44,7 @@ public class PicoPiBulkUpdateQueue : UpdateQueue
#region Methods
/// <inheritdoc />
protected override void Update(in ReadOnlySpan<(object key, Color color)> dataSet)
protected override bool Update(in ReadOnlySpan<(object key, Color color)> dataSet)
{
try
{
@ -62,11 +62,15 @@ public class PicoPiBulkUpdateQueue : UpdateQueue
}
_sdk.SendBulkUpdate(buffer, _channel);
return true;
}
catch (Exception ex)
{
PicoPiDeviceProvider.Instance.Throw(ex, true);
PicoPiDeviceProvider.Instance.Throw(ex);
}
return false;
}
#endregion

View File

@ -41,7 +41,7 @@ public class PicoPiHIDUpdateQueue : UpdateQueue
#region Methods
/// <inheritdoc />
protected override void Update(in ReadOnlySpan<(object key, Color color)> dataSet)
protected override bool Update(in ReadOnlySpan<(object key, Color color)> dataSet)
{
try
{
@ -59,11 +59,15 @@ public class PicoPiHIDUpdateQueue : UpdateQueue
}
_sdk.SendHidUpdate(buffer, _channel);
return true;
}
catch (Exception ex)
{
PicoPiDeviceProvider.Instance.Throw(ex, true);
PicoPiDeviceProvider.Instance.Throw(ex);
}
return false;
}
#endregion

View File

@ -30,7 +30,7 @@ public abstract class RazerUpdateQueue : UpdateQueue
#region Methods
/// <inheritdoc />
protected override void Update(in ReadOnlySpan<(object key, Color color)> dataSet)
protected override bool Update(in ReadOnlySpan<(object key, Color color)> dataSet)
{
try
{
@ -44,11 +44,15 @@ public abstract class RazerUpdateQueue : UpdateQueue
_RazerSDK.DeleteEffect(_lastEffect.Value);
_lastEffect = effectId;
return true;
}
catch (Exception ex)
{
RazerDeviceProvider.Instance.Throw(ex, true);
RazerDeviceProvider.Instance.Throw(ex);
}
return false;
}
/// <summary>

View File

@ -46,13 +46,26 @@ internal class SteelSeriesDeviceUpdateQueue : UpdateQueue
}
catch (Exception ex)
{
SteelSeriesDeviceProvider.Instance.Throw(ex, true);
SteelSeriesDeviceProvider.Instance.Throw(ex);
}
}
/// <inheritdoc />
protected override void Update(in ReadOnlySpan<(object key, Color color)> dataSet)
=> SteelSeriesSDK.UpdateLeds(_deviceType, dataSet.ToArray().Select(x => (((SteelSeriesLedId)x.key).GetAPIName(), x.color.ToIntArray())).Where(x => x.Item1 != null).ToList()!);
protected override bool Update(in ReadOnlySpan<(object key, Color color)> dataSet)
{
try
{
SteelSeriesSDK.UpdateLeds(_deviceType, dataSet.ToArray().Select(x => (((SteelSeriesLedId)x.key).GetAPIName(), x.color.ToIntArray())).Where(x => x.Item1 != null).ToList()!);
return true;
}
catch (Exception ex)
{
SteelSeriesDeviceProvider.Instance.Throw(ex);
}
return false;
}
#endregion
}

View File

@ -56,7 +56,7 @@ public abstract class SerialConnectionUpdateQueue<TData> : UpdateQueue
}
/// <inheritdoc />
protected override void Update(in ReadOnlySpan<(object key, Color color)> dataSet)
protected override bool Update(in ReadOnlySpan<(object key, Color color)> dataSet)
{
try
{
@ -65,11 +65,15 @@ public abstract class SerialConnectionUpdateQueue<TData> : UpdateQueue
SerialConnection.ReadTo(Prompt);
SendCommand(command);
}
return true;
}
catch (Exception ex)
{
WS281XDeviceProvider.Instance.Throw(ex, true);
WS281XDeviceProvider.Instance.Throw(ex);
}
return false;
}
/// <summary>

View File

@ -77,13 +77,25 @@ public class NodeMCUWS2812USBUpdateQueue : UpdateQueue
}
/// <inheritdoc />
protected override void Update(in ReadOnlySpan<(object key, Color color)> dataSet)
protected override bool Update(in ReadOnlySpan<(object key, Color color)> dataSet)
{
foreach (IGrouping<int, ((int channel, int key), Color color)> channelData in dataSet.ToArray().Select(x => (((int channel, int key))x.key, x.color)).GroupBy(x => x.Item1.channel))
try
{
byte[] buffer = GetBuffer(channelData);
_sendDataAction(buffer);
foreach (IGrouping<int, ((int channel, int key), Color color)> channelData in dataSet.ToArray()
.Select(x => (((int channel, int key))x.key, x.color)).GroupBy(x => x.Item1.channel))
{
byte[] buffer = GetBuffer(channelData);
_sendDataAction(buffer);
}
return true;
}
catch (Exception ex)
{
WS281XDeviceProvider.Instance.Throw(ex);
}
return false;
}
private void SendHttp(byte[] buffer)

View File

@ -31,7 +31,7 @@ public class WootingUpdateQueue : UpdateQueue
#region Methods
/// <inheritdoc />
protected override void Update(in ReadOnlySpan<(object key, Color color)> dataSet)
protected override bool Update(in ReadOnlySpan<(object key, Color color)> dataSet)
{
try
{
@ -47,11 +47,15 @@ public class WootingUpdateQueue : UpdateQueue
_WootingSDK.ArrayUpdateKeyboard();
}
return true;
}
catch (Exception ex)
{
WootingDeviceProvider.Instance.Throw(ex, true);
WootingDeviceProvider.Instance.Throw(ex);
}
return false;
}
#endregion