Skip to content

Commit

Permalink
first batch of API docs for cgse-common
Browse files Browse the repository at this point in the history
  • Loading branch information
@rhuygen
rhuygen committed Feb 27, 2025
1 parent b412364 commit d49aaf9
Show file tree
Hide file tree
Showing 2 changed files with 212 additions and 20 deletions.
230 changes: 211 additions & 19 deletions api/bits/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2669,12 +2669,77 @@ <h2 id="egse.bits.clear_bits" class="doc doc-heading">

<div class="doc doc-contents ">

<p>Set the given bits in value to 0.
Args:
value (int): the value where the given bits shall be changed
bits (tuple): a tuple with start and stop bits
Returns:
the changed value</p>
<p>Set the given bits in value to 0.</p>


<p><span class="doc-section-title">Parameters:</span></p>
<table>
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Description</th>
<th>Default</th>
</tr>
</thead>
<tbody>
<tr class="doc-section-item">
<td>
<code>value</code>
</td>
<td>
<code><span title="int">int</span></code>
</td>
<td>
<div class="doc-md-description">
<p>the value where the given bits shall be changed</p>
</div>
</td>
<td>
<em>required</em>
</td>
</tr>
<tr class="doc-section-item">
<td>
<code>bits</code>
</td>
<td>
<code><span title="tuple">tuple</span></code>
</td>
<td>
<div class="doc-md-description">
<p>a tuple with start and stop bits</p>
</div>
</td>
<td>
<em>required</em>
</td>
</tr>
</tbody>
</table>


<p><span class="doc-section-title">Returns:</span></p>
<table>
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr class="doc-section-item">
<td>
<code><span title="int">int</span></code>
</td>
<td>
<div class="doc-md-description">
<p>the changed value</p>
</div>
</td>
</tr>
</tbody>
</table>

</div>

Expand All @@ -2696,13 +2761,6 @@ <h2 id="egse.bits.crc_calc" class="doc doc-heading">
<p>Calculate the checksum for (part of) the data.</p>


<details class="reference" open>
<summary>Reference</summary>
<p>The description of the CRC calculation for RMAP is given in the ECSS document
<em>Space Engineering: SpaceWire - Remote Memory Access Protocol</em>, section A.3
on page 80 [ECSS‐E‐ST‐50‐52C].</p>
</details>

<p><span class="doc-section-title">Parameters:</span></p>
<table>
<thead>
Expand Down Expand Up @@ -2787,6 +2845,13 @@ <h2 id="egse.bits.crc_calc" class="doc doc-heading">
</tbody>
</table>


<details class="reference" open>
<summary>Reference</summary>
<p>The description of the CRC calculation for RMAP is given in the ECSS document
<em>Space Engineering: SpaceWire - Remote Memory Access Protocol</em>, section A.3
on page 80 [ECSS‐E‐ST‐50‐52C].</p>
</details>
</div>

</div>
Expand Down Expand Up @@ -3058,6 +3123,37 @@ <h2 id="egse.bits.s16" class="doc doc-heading">
<p>Return the signed equivalent of a hex or binary number.</p>


<p><span class="doc-section-title">Parameters:</span></p>
<table>
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Description</th>
<th>Default</th>
</tr>
</thead>
<tbody>
<tr class="doc-section-item">
<td>
<code>value</code>
</td>
<td>
<code><span title="int">int</span></code>
</td>
<td>
<div class="doc-md-description">
<p>an integer value.</p>
</div>
</td>
<td>
<em>required</em>
</td>
</tr>
</tbody>
</table>


<p><span class="doc-section-title">Returns:</span></p>
<table>
<thead>
Expand Down Expand Up @@ -3125,6 +3221,37 @@ <h2 id="egse.bits.s32" class="doc doc-heading">
<p>Return the signed equivalent of a hex or binary number.</p>


<p><span class="doc-section-title">Parameters:</span></p>
<table>
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Description</th>
<th>Default</th>
</tr>
</thead>
<tbody>
<tr class="doc-section-item">
<td>
<code>value</code>
</td>
<td>
<code><span title="int">int</span></code>
</td>
<td>
<div class="doc-md-description">
<p>an integer value.</p>
</div>
</td>
<td>
<em>required</em>
</td>
</tr>
</tbody>
</table>


<p><span class="doc-section-title">Returns:</span></p>
<table>
<thead>
Expand Down Expand Up @@ -3264,12 +3391,77 @@ <h2 id="egse.bits.set_bits" class="doc doc-heading">

<div class="doc doc-contents ">

<p>Set the given bits in value to 1.
Args:
value (int): the value where the given bits shall be changed
bits (tuple): a tuple with start and stop bits
Returns:
the changed value</p>
<p>Set the given bits in value to 1.</p>


<p><span class="doc-section-title">Parameters:</span></p>
<table>
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Description</th>
<th>Default</th>
</tr>
</thead>
<tbody>
<tr class="doc-section-item">
<td>
<code>value</code>
</td>
<td>
<code><span title="int">int</span></code>
</td>
<td>
<div class="doc-md-description">
<p>the value where the given bits shall be changed</p>
</div>
</td>
<td>
<em>required</em>
</td>
</tr>
<tr class="doc-section-item">
<td>
<code>bits</code>
</td>
<td>
<code><span title="tuple">tuple</span></code>
</td>
<td>
<div class="doc-md-description">
<p>a tuple with start and stop bits</p>
</div>
</td>
<td>
<em>required</em>
</td>
</tr>
</tbody>
</table>


<p><span class="doc-section-title">Returns:</span></p>
<table>
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr class="doc-section-item">
<td>
<code><span title="int">int</span></code>
</td>
<td>
<div class="doc-md-description">
<p>the changed value.</p>
</div>
</td>
</tr>
</tbody>
</table>

</div>

Expand Down
2 changes: 1 addition & 1 deletion search/search_index.json
View file

Large diffs are not rendered by default.

0 comments on commit d49aaf9

Please sign in to comment.