Skip to content

Commit

Permalink
Updated documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
@chrishamm
chrishamm committed Jul 28, 2023
1 parent 9df0773 commit aa6c0e0
Show file tree
Hide file tree
Showing 10 changed files with 606 additions and 521 deletions.
2 changes: 1 addition & 1 deletion docs/api/DuetAPI.ObjectModel.Probe.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1791,7 +1791,7 @@ <h5 class="propertyValue">Property Value</h5>
</table>
<a id="DuetAPI_ObjectModel_Probe_TravelSpeed_" data-uid="DuetAPI.ObjectModel.Probe.TravelSpeed*"></a>
<h4 id="DuetAPI_ObjectModel_Probe_TravelSpeed" data-uid="DuetAPI.ObjectModel.Probe.TravelSpeed">TravelSpeed</h4>
<div class="markdown level1 summary"><p>Travel speed when probing multiple points (in mm/s)</p>
<div class="markdown level1 summary"><p>Travel speed when probing multiple points (in mm/min)</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
Expand Down
24 changes: 0 additions & 24 deletions docs/api/DuetAPI.ObjectModel.RestorePoint.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1593,30 +1593,6 @@ <h5 class="propertyValue">Property Value</h5>
</tr>
</tbody>
</table>
<a id="DuetAPI_ObjectModel_RestorePoint_SpindleSpeeds_" data-uid="DuetAPI.ObjectModel.RestorePoint.SpindleSpeeds*"></a>
<h4 id="DuetAPI_ObjectModel_RestorePoint_SpindleSpeeds" data-uid="DuetAPI.ObjectModel.RestorePoint.SpindleSpeeds">SpindleSpeeds</h4>
<div class="markdown level1 summary"><p>The spindle RPMs that were set, negative if anticlockwise direction</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public ModelCollection&lt;float&gt; SpindleSpeeds { get; }</code></pre>
</div>
<h5 class="propertyValue">Property Value</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><a class="xref" href="DuetAPI.ObjectModel.ModelCollection-1.html">ModelCollection</a>&lt;<span class="xref">System.Single</span>&gt;</td>
<td></td>
</tr>
</tbody>
</table>
<a id="DuetAPI_ObjectModel_RestorePoint_ToolNumber_" data-uid="DuetAPI.ObjectModel.RestorePoint.ToolNumber*"></a>
<h4 id="DuetAPI_ObjectModel_RestorePoint_ToolNumber" data-uid="DuetAPI.ObjectModel.RestorePoint.ToolNumber">ToolNumber</h4>
<div class="markdown level1 summary"><p>The tool number that was active</p>
Expand Down
72 changes: 72 additions & 0 deletions docs/api/DuetAPIClient.BaseCommandConnection.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2514,6 +2514,78 @@ <h5 id="DuetAPIClient_BaseCommandConnection_InstallSystemPackage_System_String_S
<div class="seealso">
<div><a class="xref" href="DuetAPI.Utility.SbcPermissions.html#DuetAPI_Utility_SbcPermissions_SuperUser">SuperUser</a></div>
</div>
<a id="DuetAPIClient_BaseCommandConnection_InvalidateChannel_" data-uid="DuetAPIClient.BaseCommandConnection.InvalidateChannel*"></a>
<h4 id="DuetAPIClient_BaseCommandConnection_InvalidateChannel_DuetAPI_CodeChannel_System_Threading_CancellationToken_" data-uid="DuetAPIClient.BaseCommandConnection.InvalidateChannel(DuetAPI.CodeChannel,System.Threading.CancellationToken)">InvalidateChannel(CodeChannel, CancellationToken)</h4>
<div class="markdown level1 summary"><p>Invalidate all pending codes and files on the given channel</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public Task InvalidateChannel(CodeChannel channel, CancellationToken cancellationToken = default(CancellationToken))</code></pre>
</div>
<h5 class="parameters">Parameters</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><a class="xref" href="DuetAPI.CodeChannel.html">CodeChannel</a></td>
<td><span class="parametername">channel</span></td>
<td><p>Code channel where everything is supposed to be invalidated</p>
</td>
</tr>
<tr>
<td><span class="xref">System.Threading.CancellationToken</span></td>
<td><span class="parametername">cancellationToken</span></td>
<td><p>Optional cancellation token</p>
</td>
</tr>
</tbody>
</table>
<h5 class="returns">Returns</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.Threading.Tasks.Task</span></td>
<td><p>Asynchronous task</p>
</td>
</tr>
</tbody>
</table>
<h5 id="DuetAPIClient_BaseCommandConnection_InvalidateChannel_DuetAPI_CodeChannel_System_Threading_CancellationToken__remarks">Remarks</h5>
<div class="markdown level1 remarks"><p>This does NOT cancel the current code being executed by RRF!</p>
</div>
<h5 class="exceptions">Exceptions</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Condition</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.Net.Sockets.SocketException</span></td>
<td><p>Command could not be processed</p>
</td>
</tr>
</tbody>
</table>
<h5 id="DuetAPIClient_BaseCommandConnection_InvalidateChannel_DuetAPI_CodeChannel_System_Threading_CancellationToken__seealso">See Also</h5>
<div class="seealso">
<div><a class="xref" href="DuetAPI.Utility.SbcPermissions.html#DuetAPI_Utility_SbcPermissions_SuperUser">SuperUser</a></div>
</div>
<a id="DuetAPIClient_BaseCommandConnection_LockMachineModel_" data-uid="DuetAPIClient.BaseCommandConnection.LockMachineModel*"></a>
<h4 id="DuetAPIClient_BaseCommandConnection_LockMachineModel_System_Threading_CancellationToken_" data-uid="DuetAPIClient.BaseCommandConnection.LockMachineModel(System.Threading.CancellationToken)">LockMachineModel(CancellationToken)</h4>
<div class="markdown level1 summary"><p>Lock the machine model for read/write access.
Expand Down
3 changes: 3 additions & 0 deletions docs/api/DuetAPIClient.CommandConnection.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1423,6 +1423,9 @@ <h5>Inherited Members</h5>
<div>
<a class="xref" href="DuetAPIClient.BaseCommandConnection.html#DuetAPIClient_BaseCommandConnection_InstallSystemPackage_System_String_System_Threading_CancellationToken_">BaseCommandConnection.InstallSystemPackage(String, CancellationToken)</a>
</div>
<div>
<a class="xref" href="DuetAPIClient.BaseCommandConnection.html#DuetAPIClient_BaseCommandConnection_InvalidateChannel_DuetAPI_CodeChannel_System_Threading_CancellationToken_">BaseCommandConnection.InvalidateChannel(CodeChannel, CancellationToken)</a>
</div>
<div>
<a class="xref" href="DuetAPIClient.BaseCommandConnection.html#DuetAPIClient_BaseCommandConnection_LockMachineModel_System_Threading_CancellationToken_">BaseCommandConnection.LockMachineModel(CancellationToken)</a>
</div>
Expand Down
3 changes: 3 additions & 0 deletions docs/api/DuetAPIClient.InterceptConnection.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1423,6 +1423,9 @@ <h5>Inherited Members</h5>
<div>
<a class="xref" href="DuetAPIClient.BaseCommandConnection.html#DuetAPIClient_BaseCommandConnection_InstallSystemPackage_System_String_System_Threading_CancellationToken_">BaseCommandConnection.InstallSystemPackage(String, CancellationToken)</a>
</div>
<div>
<a class="xref" href="DuetAPIClient.BaseCommandConnection.html#DuetAPIClient_BaseCommandConnection_InvalidateChannel_DuetAPI_CodeChannel_System_Threading_CancellationToken_">BaseCommandConnection.InvalidateChannel(CodeChannel, CancellationToken)</a>
</div>
<div>
<a class="xref" href="DuetAPIClient.BaseCommandConnection.html#DuetAPIClient_BaseCommandConnection_LockMachineModel_System_Threading_CancellationToken_">BaseCommandConnection.LockMachineModel(CancellationToken)</a>
</div>
Expand Down
22 changes: 20 additions & 2 deletions docs/api/DuetControlServer.SPI.Channel.Manager.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1513,14 +1513,32 @@ <h5 class="returns">Returns</h5>
</tbody>
</table>
<a id="DuetControlServer_SPI_Channel_Manager_GetIdleChannel_" data-uid="DuetControlServer.SPI.Channel.Manager.GetIdleChannel*"></a>
<h4 id="DuetControlServer_SPI_Channel_Manager_GetIdleChannel" data-uid="DuetControlServer.SPI.Channel.Manager.GetIdleChannel">GetIdleChannel()</h4>
<h4 id="DuetControlServer_SPI_Channel_Manager_GetIdleChannel_DuetAPI_CodeChannel_" data-uid="DuetControlServer.SPI.Channel.Manager.GetIdleChannel(DuetAPI.CodeChannel)">GetIdleChannel(CodeChannel)</h4>
<div class="markdown level1 summary"><p>Get a channel that is currently idle in order to process a priority code</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public async Task&lt;CodeChannel&gt; GetIdleChannel()</code></pre>
<pre><code class="lang-csharp hljs">public async Task&lt;CodeChannel&gt; GetIdleChannel(CodeChannel preferredChannel)</code></pre>
</div>
<h5 class="parameters">Parameters</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><a class="xref" href="DuetAPI.CodeChannel.html">CodeChannel</a></td>
<td><span class="parametername">preferredChannel</span></td>
<td><p>Preferred code channel</p>
</td>
</tr>
</tbody>
</table>
<h5 class="returns">Returns</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
Expand Down
22 changes: 20 additions & 2 deletions docs/api/DuetControlServer.SPI.Interface.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1715,14 +1715,32 @@ <h5 class="returns">Returns</h5>
</tbody>
</table>
<a id="DuetControlServer_SPI_Interface_GetIdleChannel_" data-uid="DuetControlServer.SPI.Interface.GetIdleChannel*"></a>
<h4 id="DuetControlServer_SPI_Interface_GetIdleChannel" data-uid="DuetControlServer.SPI.Interface.GetIdleChannel">GetIdleChannel()</h4>
<h4 id="DuetControlServer_SPI_Interface_GetIdleChannel_DuetAPI_CodeChannel_" data-uid="DuetControlServer.SPI.Interface.GetIdleChannel(DuetAPI.CodeChannel)">GetIdleChannel(CodeChannel)</h4>
<div class="markdown level1 summary"><p>Get a channel that is currently idle in order to process a priority code</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static Task&lt;CodeChannel&gt; GetIdleChannel()</code></pre>
<pre><code class="lang-csharp hljs">public static Task&lt;CodeChannel&gt; GetIdleChannel(CodeChannel preferredChannel)</code></pre>
</div>
<h5 class="parameters">Parameters</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><a class="xref" href="DuetAPI.CodeChannel.html">CodeChannel</a></td>
<td><span class="parametername">preferredChannel</span></td>
<td><p>Preferred code channel</p>
</td>
</tr>
</tbody>
</table>
<h5 class="returns">Returns</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
Expand Down
67 changes: 36 additions & 31 deletions docs/api/DuetWebServer.Controllers.MachineController.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2484,6 +2484,42 @@ <h5 class="returns">Returns</h5>
(500) Generic error occurred
(502) Incompatible DCS version
(503) DCS is unavailable</p>
</td>
</tr>
</tbody>
</table>
<a id="DuetWebServer_Controllers_MachineController_Model_" data-uid="DuetWebServer.Controllers.MachineController.Model*"></a>
<h4 id="DuetWebServer_Controllers_MachineController_Model" data-uid="DuetWebServer.Controllers.MachineController.Model">Model()</h4>
<div class="markdown level1 summary"><p>GET /machine/model</p>
<ul>
<li>and -
GET /machine/status
Retrieve the full object model as JSON.</li>
</ul>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">[HttpGet(&quot;model&quot;)]
[HttpGet(&quot;status&quot;)]
public async Task&lt;IActionResult&gt; Model()</code></pre>
</div>
<h5 class="returns">Returns</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.Threading.Tasks.Task</span>&lt;<span class="xref">Microsoft.AspNetCore.Mvc.IActionResult</span>&gt;</td>
<td><p>HTTP status code:
(200) Object model as application/json
(500) Generic error
(502) Incompatible DCS version
(503) DCS is unavailable</p>
</td>
</tr>
</tbody>
Expand Down Expand Up @@ -2639,37 +2675,6 @@ <h5 class="returns">Returns</h5>
(500) Generic error occurred
(502) Incompatible DCS version
(503) DCS is unavailable</p>
</td>
</tr>
</tbody>
</table>
<a id="DuetWebServer_Controllers_MachineController_Status_" data-uid="DuetWebServer.Controllers.MachineController.Status*"></a>
<h4 id="DuetWebServer_Controllers_MachineController_Status" data-uid="DuetWebServer.Controllers.MachineController.Status">Status()</h4>
<div class="markdown level1 summary"><p>GET /machine/status
Retrieve the full object model as JSON.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">[HttpGet(&quot;status&quot;)]
public async Task&lt;IActionResult&gt; Status()</code></pre>
</div>
<h5 class="returns">Returns</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.Threading.Tasks.Task</span>&lt;<span class="xref">Microsoft.AspNetCore.Mvc.IActionResult</span>&gt;</td>
<td><p>HTTP status code:
(200) Machine object model as application/json
(500) Generic error
(502) Incompatible DCS version
(503) DCS is unavailable</p>
</td>
</tr>
</tbody>
Expand Down
Loading

0 comments on commit aa6c0e0

Please sign in to comment.