Skip to content

Commit

Permalink
Updated documentation again
Browse files Browse the repository at this point in the history
  • Loading branch information
chrishamm committed May 28, 2024
1 parent e0d882c commit 27ed22c
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 2 deletions.
6 changes: 6 additions & 0 deletions src/DuetAPI/ObjectModel/Fans/FanThermostaticControl.cs
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,9 @@ public sealed class FanThermostaticControl : ModelObject
/// <summary>
/// List of heaters to monitor (indices)
/// </summary>
/// <remarks>
/// This is a bitmap represented as an array
/// </remarks>
[Obsolete("Use Sensors instead")]
public ModelCollection<int> Heaters { get; } = new ModelCollection<int>();

Expand All @@ -36,6 +39,9 @@ public float? LowTemperature
/// <summary>
/// List of sensors to monitor (indices)
/// </summary>
/// <remarks>
/// This is a bitmap represented as an array
/// </remarks>
public ModelCollection<int> Sensors { get; } = new ModelCollection<int>();
}
}
7 changes: 5 additions & 2 deletions src/DuetAPI/ObjectModel/Tools/Tool.cs
Original file line number Diff line number Diff line change
Expand Up @@ -12,15 +12,15 @@ public sealed class Tool : ModelObject

/// <summary>
/// Associated axes. At present only X and Y can be mapped per tool.
/// Note that each int[] array is actually a bitmap!
/// </summary>
/// <remarks>
/// The order is the same as the visual axes, so by default the layout is
/// [
/// [0], // X
/// [1] // Y
/// ]
/// Make sure to set each item individually so the change events are called
/// Make sure to set each item individually so the change events are called.
/// Each item is a bitmap represented as an array
/// </remarks>
public ModelCollection<int[]> Axes { get; } = new ModelCollection<int[]>();

Expand All @@ -32,6 +32,9 @@ public sealed class Tool : ModelObject
/// <summary>
/// List of associated fans (indices)
/// </summary>
/// <remarks>
/// This is a bitmap represented as an array
/// </remarks>
public ModelCollection<int> Fans { get; } = new ModelCollection<int>();

/// <summary>
Expand Down

0 comments on commit 27ed22c

Please sign in to comment.