Deployed cbde057b to dev with MkDocs 1.6.1 and mike 2.1.3

This commit is contained in:
github-actions[bot]
2026-02-10 20:05:29 +00:00
parent d4088a78b8
commit 79aa0d5b4f
5 changed files with 398 additions and 57 deletions
+154 -3
View File
@@ -1520,6 +1520,45 @@
</label>
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
<li class="md-nav__item">
<a href="#gpsgnss-receivers" class="md-nav__link">
<span class="md-ellipsis">
GPS/GNSS Receivers
</span>
</a>
<nav class="md-nav" aria-label="GPS/GNSS Receivers">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#current-status" class="md-nav__link">
<span class="md-ellipsis">
Current status
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#configure-gps-receiver" class="md-nav__link">
<span class="md-ellipsis">
Configure GPS receiver
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#usb-ports" class="md-nav__link">
<span class="md-ellipsis">
@@ -1533,7 +1572,7 @@
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#current-status" class="md-nav__link">
<a href="#current-status_1" class="md-nav__link">
<span class="md-ellipsis">
Current status
@@ -2281,6 +2320,45 @@
</label>
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
<li class="md-nav__item">
<a href="#gpsgnss-receivers" class="md-nav__link">
<span class="md-ellipsis">
GPS/GNSS Receivers
</span>
</a>
<nav class="md-nav" aria-label="GPS/GNSS Receivers">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#current-status" class="md-nav__link">
<span class="md-ellipsis">
Current status
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#configure-gps-receiver" class="md-nav__link">
<span class="md-ellipsis">
Configure GPS receiver
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#usb-ports" class="md-nav__link">
<span class="md-ellipsis">
@@ -2294,7 +2372,7 @@
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#current-status" class="md-nav__link">
<a href="#current-status_1" class="md-nav__link">
<span class="md-ellipsis">
Current status
@@ -2402,6 +2480,79 @@
<h1 id="hardware-information-and-status">Hardware Information and Status<a class="headerlink" href="#hardware-information-and-status" title="Permanent link"></a></h1>
<p>The hardware infomation and status is handled by the YANG model <a href="https://www.rfc-editor.org/rfc/rfc8348.html">IETF
hardware</a>, with deviations and augmentations in <em>infix-hardware</em>.</p>
<h2 id="gpsgnss-receivers">GPS/GNSS Receivers<a class="headerlink" href="#gpsgnss-receivers" title="Permanent link"></a></h2>
<p>Infix supports GPS/GNSS receivers for hardware status monitoring and NTP
time synchronization. USB GPS receivers using the USB ACM interface are
supported (e.g., u-blox). When connected, devices are automatically
discovered and named <code>gps0</code>, <code>gps1</code>, etc.</p>
<h3 id="current-status">Current status<a class="headerlink" href="#current-status" title="Permanent link"></a></h3>
<pre class="cli"><code>admin@example:/&gt; <b>show hardware</b>
<span class="header">HARDWARE COMPONENTS </span>
──────────────────────────────────────────────────────────────
<span class="title">GPS/GNSS Receivers </span>
Name : gps0
Device : /dev/gps0
Driver : u-blox
Status : Active
Fix : 3D
Satellites : 10/15 (used/visible)
Position : 59.334567N 18.063456E 42.3m
PPS : Available
</code></pre>
<p>Available information per receiver:</p>
<table>
<thead>
<tr>
<th>Field</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>Name</td>
<td>Component name (<code>gps0</code>, <code>gps1</code>, ...)</td>
</tr>
<tr>
<td>Device</td>
<td>Device path (<code>/dev/gps0</code>)</td>
</tr>
<tr>
<td>Driver</td>
<td>Protocol driver (e.g., <code>u-blox</code>, <code>NMEA</code>, <code>SiRF</code>)</td>
</tr>
<tr>
<td>Status</td>
<td><code>Active</code> or <code>Inactive</code></td>
</tr>
<tr>
<td>Fix</td>
<td><code>NONE</code>, <code>2D</code>, or <code>3D</code></td>
</tr>
<tr>
<td>Satellites</td>
<td>Used/visible count</td>
</tr>
<tr>
<td>Position</td>
<td>Latitude, longitude, altitude (when fix acquired)</td>
</tr>
<tr>
<td>PPS</td>
<td>Pulse Per Second signal availability</td>
</tr>
</tbody>
</table>
<h3 id="configure-gps-receiver">Configure GPS receiver<a class="headerlink" href="#configure-gps-receiver" title="Permanent link"></a></h3>
<p>GPS receivers are hardware components with class <code>gps</code>. The class is
auto-inferred from the component name, similar to WiFi radios (<code>radioN</code>):</p>
<pre class="cli"><code>admin@example:/&gt; <b>configure</b>
admin@example:/config/&gt; <b>set hardware component gps0</b>
admin@example:/config/&gt; <b>leave</b>
</code></pre>
<p>To use a GPS receiver as an NTP reference clock source, see
<a href="../ntp/#gps-reference-clock">NTP — GPS Reference Clock</a>.</p>
<h2 id="usb-ports">USB Ports<a class="headerlink" href="#usb-ports" title="Permanent link"></a></h2>
<p>For Infix to be able to control USB port(s), a device tree modification
is needed (see <em>alder.dtsi</em> for full example).</p>
@@ -2424,7 +2575,7 @@ bus, here is an example:</p>
<div class="highlight"><pre><span></span><code><a id="__codelineno-2-1" name="__codelineno-2-1" href="#__codelineno-2-1"></a><span class="c1"># Enable a device plugged into usb1</span>
<a id="__codelineno-2-2" name="__codelineno-2-2" href="#__codelineno-2-2"></a><span class="nb">echo</span><span class="w"> </span><span class="m">1</span><span class="w"> </span>&gt;<span class="w"> </span>/sys/bus/usb/devices/usb1/1-1/authorized
</code></pre></div>
<h3 id="current-status">Current status<a class="headerlink" href="#current-status" title="Permanent link"></a></h3>
<h3 id="current-status_1">Current status<a class="headerlink" href="#current-status_1" title="Permanent link"></a></h3>
<pre class="cli"><code>admin@example:/&gt; <b>show hardware</b>
<span class="header">HARDWARE COMPONENTS </span>
──────────────────────────────────────────────────────────────
+193 -3
View File
@@ -1343,6 +1343,56 @@
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#gps-reference-clock" class="md-nav__link">
<span class="md-ellipsis">
GPS Reference Clock
</span>
</a>
<nav class="md-nav" aria-label="GPS Reference Clock">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#basic-setup" class="md-nav__link">
<span class="md-ellipsis">
Basic setup
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#pps-pulse-per-second" class="md-nav__link">
<span class="md-ellipsis">
PPS (Pulse Per Second)
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#monitoring" class="md-nav__link">
<span class="md-ellipsis">
Monitoring
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
@@ -1424,7 +1474,7 @@
</li>
<li class="md-nav__item">
<a href="#monitoring" class="md-nav__link">
<a href="#monitoring_1" class="md-nav__link">
<span class="md-ellipsis">
Monitoring
@@ -2351,6 +2401,56 @@
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#gps-reference-clock" class="md-nav__link">
<span class="md-ellipsis">
GPS Reference Clock
</span>
</a>
<nav class="md-nav" aria-label="GPS Reference Clock">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#basic-setup" class="md-nav__link">
<span class="md-ellipsis">
Basic setup
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#pps-pulse-per-second" class="md-nav__link">
<span class="md-ellipsis">
PPS (Pulse Per Second)
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#monitoring" class="md-nav__link">
<span class="md-ellipsis">
Monitoring
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
@@ -2432,7 +2532,7 @@
</li>
<li class="md-nav__item">
<a href="#monitoring" class="md-nav__link">
<a href="#monitoring_1" class="md-nav__link">
<span class="md-ellipsis">
Monitoring
@@ -2547,6 +2647,96 @@ admin@example:/config/ntp/&gt; <b>set refclock-master master-stratum 10</b>
admin@example:/config/ntp/&gt; <b>leave</b>
</code></pre>
<h2 id="gps-reference-clock">GPS Reference Clock<a class="headerlink" href="#gps-reference-clock" title="Permanent link"></a></h2>
<p>A GPS/GNSS receiver can be used as an NTP reference clock source,
providing stratum 1 time derived from the GPS satellite constellation.
This requires a GPS hardware component to be configured first, see
<a href="../hardware/#gpsgnss-receivers">Hardware — GPS/GNSS Receivers</a>.</p>
<h3 id="basic-setup">Basic setup<a class="headerlink" href="#basic-setup" title="Permanent link"></a></h3>
<p>Add a GPS receiver as a reference clock source:</p>
<pre class="cli"><code>admin@example:/config/&gt; <b>edit ntp</b>
admin@example:/config/ntp/&gt; <b>edit refclock-master source gps0</b>
admin@example:/config/ntp/refclock-master/source/gps0/&gt; <b>set poll 2</b>
admin@example:/config/ntp/refclock-master/source/gps0/&gt; <b>set precision 0.1</b>
admin@example:/config/ntp/refclock-master/source/gps0/&gt; <b>end</b>
admin@example:/config/ntp/&gt; <b>leave</b>
</code></pre>
<p>Tunable parameters:</p>
<table>
<thead>
<tr>
<th>Parameter</th>
<th style="text-align: right;">Default</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>poll</code></td>
<td style="text-align: right;"><code>2</code></td>
<td>Polling interval in log2 seconds (2 = 4s)</td>
</tr>
<tr>
<td><code>precision</code></td>
<td style="text-align: right;"><code>0.1</code></td>
<td>Assumed precision in seconds (0.1 = 100ms)</td>
</tr>
<tr>
<td><code>refid</code></td>
<td style="text-align: right;"><code>"GPS"</code></td>
<td>Reference identifier (e.g., <code>GPS</code>, <code>GNSS</code>, <code>GLO</code>)</td>
</tr>
<tr>
<td><code>prefer</code></td>
<td style="text-align: right;"><code>false</code></td>
<td>Prefer this source over other reference clocks</td>
</tr>
<tr>
<td><code>pps</code></td>
<td style="text-align: right;"><code>false</code></td>
<td>Enable PPS for microsecond-level accuracy</td>
</tr>
<tr>
<td><code>offset</code></td>
<td style="text-align: right;"><code>0.0</code></td>
<td>Constant offset correction in seconds</td>
</tr>
<tr>
<td><code>delay</code></td>
<td style="text-align: right;"><code>0.0</code></td>
<td>Assumed maximum delay from the receiver</td>
</tr>
</tbody>
</table>
<h3 id="pps-pulse-per-second">PPS (Pulse Per Second)<a class="headerlink" href="#pps-pulse-per-second" title="Permanent link"></a></h3>
<p>When the GPS receiver provides a PPS signal, enable the <code>pps</code> option for
microsecond-level accuracy. With PPS, the GPS time provides the initial
lock and the PPS edges discipline the clock:</p>
<pre class="cli"><code>admin@example:/config/ntp/&gt; <b>edit refclock-master source gps0</b>
admin@example:/config/ntp/refclock-master/source/gps0/&gt; <b>set pps true</b>
admin@example:/config/ntp/refclock-master/source/gps0/&gt; <b>set precision 0.000001</b>
admin@example:/config/ntp/refclock-master/source/gps0/&gt; <b>end</b>
admin@example:/config/ntp/&gt; <b>leave</b>
</code></pre>
<h3 id="monitoring">Monitoring<a class="headerlink" href="#monitoring" title="Permanent link"></a></h3>
<p>The <code>show ntp</code> command shows the GPS receiver as the reference clock source:</p>
<pre class="cli"><code>admin@example:/&gt; <b>show ntp</b>
Mode : Server (GPS reference clock: gps0)
Port : 123
Stratum : 1
Ref time (UTC) : Sun Feb 08 19:44:36 2026
</code></pre>
<p>Use <code>show ntp source</code> to see GPS reference clock details:</p>
<pre class="cli"><code>admin@example:/&gt; <b>show ntp source</b>
Reference Clock : gps0 (u-blox)
Status : selected
Fix Mode : 3D
Satellites : 9/17 (used/visible)
</code></pre>
<h2 id="server-mode">Server Mode<a class="headerlink" href="#server-mode" title="Permanent link"></a></h2>
<p>Synchronize from upstream NTP servers while serving time to clients:</p>
<pre class="cli"><code>admin@example:/config/&gt; <b>edit ntp</b>
@@ -2635,7 +2825,7 @@ admin@example:/config/ntp/makestep/&gt; <b>end</b>
</ul>
<p>With these defaults, a device booting at epoch time (1970-01-01) will sync to
correct time within seconds instead of hours.</p>
<h2 id="monitoring">Monitoring<a class="headerlink" href="#monitoring" title="Permanent link"></a></h2>
<h2 id="monitoring_1">Monitoring<a class="headerlink" href="#monitoring_1" title="Permanent link"></a></h2>
<p>For a quick overview:</p>
<p>To view the sources being used by the NTP client, run:</p>
<pre class="cli"><code>admin@example:/&gt; <b>show ntp</b>
File diff suppressed because one or more lines are too long
+50 -50
View File
@@ -2,202 +2,202 @@
<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
<url>
<loc>https://kernelkit.github.io/infix/dev/</loc>
<lastmod>2026-02-07</lastmod>
<lastmod>2026-02-10</lastmod>
</url>
<url>
<loc>https://kernelkit.github.io/infix/dev/boot/</loc>
<lastmod>2026-02-07</lastmod>
<lastmod>2026-02-10</lastmod>
</url>
<url>
<loc>https://kernelkit.github.io/infix/dev/branding/</loc>
<lastmod>2026-02-07</lastmod>
<lastmod>2026-02-10</lastmod>
</url>
<url>
<loc>https://kernelkit.github.io/infix/dev/bridging/</loc>
<lastmod>2026-02-07</lastmod>
<lastmod>2026-02-10</lastmod>
</url>
<url>
<loc>https://kernelkit.github.io/infix/dev/container/</loc>
<lastmod>2026-02-07</lastmod>
<lastmod>2026-02-10</lastmod>
</url>
<url>
<loc>https://kernelkit.github.io/infix/dev/developers-guide/</loc>
<lastmod>2026-02-07</lastmod>
<lastmod>2026-02-10</lastmod>
</url>
<url>
<loc>https://kernelkit.github.io/infix/dev/dhcp/</loc>
<lastmod>2026-02-07</lastmod>
<lastmod>2026-02-10</lastmod>
</url>
<url>
<loc>https://kernelkit.github.io/infix/dev/discovery/</loc>
<lastmod>2026-02-07</lastmod>
<lastmod>2026-02-10</lastmod>
</url>
<url>
<loc>https://kernelkit.github.io/infix/dev/eth-counters/</loc>
<lastmod>2026-02-07</lastmod>
<lastmod>2026-02-10</lastmod>
</url>
<url>
<loc>https://kernelkit.github.io/infix/dev/ethernet/</loc>
<lastmod>2026-02-07</lastmod>
<lastmod>2026-02-10</lastmod>
</url>
<url>
<loc>https://kernelkit.github.io/infix/dev/firewall/</loc>
<lastmod>2026-02-07</lastmod>
<lastmod>2026-02-10</lastmod>
</url>
<url>
<loc>https://kernelkit.github.io/infix/dev/hardware/</loc>
<lastmod>2026-02-07</lastmod>
<lastmod>2026-02-10</lastmod>
</url>
<url>
<loc>https://kernelkit.github.io/infix/dev/iface/</loc>
<lastmod>2026-02-07</lastmod>
<lastmod>2026-02-10</lastmod>
</url>
<url>
<loc>https://kernelkit.github.io/infix/dev/ip/</loc>
<lastmod>2026-02-07</lastmod>
<lastmod>2026-02-10</lastmod>
</url>
<url>
<loc>https://kernelkit.github.io/infix/dev/keystore/</loc>
<lastmod>2026-02-07</lastmod>
<lastmod>2026-02-10</lastmod>
</url>
<url>
<loc>https://kernelkit.github.io/infix/dev/lag/</loc>
<lastmod>2026-02-07</lastmod>
<lastmod>2026-02-10</lastmod>
</url>
<url>
<loc>https://kernelkit.github.io/infix/dev/license/</loc>
<lastmod>2026-02-07</lastmod>
<lastmod>2026-02-10</lastmod>
</url>
<url>
<loc>https://kernelkit.github.io/infix/dev/management/</loc>
<lastmod>2026-02-07</lastmod>
<lastmod>2026-02-10</lastmod>
</url>
<url>
<loc>https://kernelkit.github.io/infix/dev/nacm/</loc>
<lastmod>2026-02-07</lastmod>
<lastmod>2026-02-10</lastmod>
</url>
<url>
<loc>https://kernelkit.github.io/infix/dev/netboot/</loc>
<lastmod>2026-02-07</lastmod>
<lastmod>2026-02-10</lastmod>
</url>
<url>
<loc>https://kernelkit.github.io/infix/dev/networking/</loc>
<lastmod>2026-02-07</lastmod>
<lastmod>2026-02-10</lastmod>
</url>
<url>
<loc>https://kernelkit.github.io/infix/dev/ntp/</loc>
<lastmod>2026-02-07</lastmod>
<lastmod>2026-02-10</lastmod>
</url>
<url>
<loc>https://kernelkit.github.io/infix/dev/override-package/</loc>
<lastmod>2026-02-07</lastmod>
<lastmod>2026-02-10</lastmod>
</url>
<url>
<loc>https://kernelkit.github.io/infix/dev/qos/</loc>
<lastmod>2026-02-07</lastmod>
<lastmod>2026-02-10</lastmod>
</url>
<url>
<loc>https://kernelkit.github.io/infix/dev/routing/</loc>
<lastmod>2026-02-07</lastmod>
<lastmod>2026-02-10</lastmod>
</url>
<url>
<loc>https://kernelkit.github.io/infix/dev/scripting-netconf/</loc>
<lastmod>2026-02-07</lastmod>
<lastmod>2026-02-10</lastmod>
</url>
<url>
<loc>https://kernelkit.github.io/infix/dev/scripting-prod/</loc>
<lastmod>2026-02-07</lastmod>
<lastmod>2026-02-10</lastmod>
</url>
<url>
<loc>https://kernelkit.github.io/infix/dev/scripting-restconf/</loc>
<lastmod>2026-02-07</lastmod>
<lastmod>2026-02-10</lastmod>
</url>
<url>
<loc>https://kernelkit.github.io/infix/dev/scripting-sysrepocfg/</loc>
<lastmod>2026-02-07</lastmod>
<lastmod>2026-02-10</lastmod>
</url>
<url>
<loc>https://kernelkit.github.io/infix/dev/scripting/</loc>
<lastmod>2026-02-07</lastmod>
<lastmod>2026-02-10</lastmod>
</url>
<url>
<loc>https://kernelkit.github.io/infix/dev/support/</loc>
<lastmod>2026-02-07</lastmod>
<lastmod>2026-02-10</lastmod>
</url>
<url>
<loc>https://kernelkit.github.io/infix/dev/syslog/</loc>
<lastmod>2026-02-07</lastmod>
<lastmod>2026-02-10</lastmod>
</url>
<url>
<loc>https://kernelkit.github.io/infix/dev/system/</loc>
<lastmod>2026-02-07</lastmod>
<lastmod>2026-02-10</lastmod>
</url>
<url>
<loc>https://kernelkit.github.io/infix/dev/test-arch/</loc>
<lastmod>2026-02-07</lastmod>
<lastmod>2026-02-10</lastmod>
</url>
<url>
<loc>https://kernelkit.github.io/infix/dev/testing/</loc>
<lastmod>2026-02-07</lastmod>
<lastmod>2026-02-10</lastmod>
</url>
<url>
<loc>https://kernelkit.github.io/infix/dev/tunnels/</loc>
<lastmod>2026-02-07</lastmod>
<lastmod>2026-02-10</lastmod>
</url>
<url>
<loc>https://kernelkit.github.io/infix/dev/upgrade/</loc>
<lastmod>2026-02-07</lastmod>
<lastmod>2026-02-10</lastmod>
</url>
<url>
<loc>https://kernelkit.github.io/infix/dev/virtual/</loc>
<lastmod>2026-02-07</lastmod>
<lastmod>2026-02-10</lastmod>
</url>
<url>
<loc>https://kernelkit.github.io/infix/dev/vpd/</loc>
<lastmod>2026-02-07</lastmod>
<lastmod>2026-02-10</lastmod>
</url>
<url>
<loc>https://kernelkit.github.io/infix/dev/vpn-wireguard/</loc>
<lastmod>2026-02-07</lastmod>
<lastmod>2026-02-10</lastmod>
</url>
<url>
<loc>https://kernelkit.github.io/infix/dev/vpn/</loc>
<lastmod>2026-02-07</lastmod>
<lastmod>2026-02-10</lastmod>
</url>
<url>
<loc>https://kernelkit.github.io/infix/dev/wifi/</loc>
<lastmod>2026-02-07</lastmod>
<lastmod>2026-02-10</lastmod>
</url>
<url>
<loc>https://kernelkit.github.io/infix/dev/cli/configure/</loc>
<lastmod>2026-02-07</lastmod>
<lastmod>2026-02-10</lastmod>
</url>
<url>
<loc>https://kernelkit.github.io/infix/dev/cli/introduction/</loc>
<lastmod>2026-02-07</lastmod>
<lastmod>2026-02-10</lastmod>
</url>
<url>
<loc>https://kernelkit.github.io/infix/dev/cli/keybindings/</loc>
<lastmod>2026-02-07</lastmod>
<lastmod>2026-02-10</lastmod>
</url>
<url>
<loc>https://kernelkit.github.io/infix/dev/cli/netcalc/</loc>
<lastmod>2026-02-07</lastmod>
<lastmod>2026-02-10</lastmod>
</url>
<url>
<loc>https://kernelkit.github.io/infix/dev/cli/quick/</loc>
<lastmod>2026-02-07</lastmod>
<lastmod>2026-02-10</lastmod>
</url>
<url>
<loc>https://kernelkit.github.io/infix/dev/cli/tcpdump/</loc>
<lastmod>2026-02-07</lastmod>
<lastmod>2026-02-10</lastmod>
</url>
<url>
<loc>https://kernelkit.github.io/infix/dev/cli/text-editor/</loc>
<lastmod>2026-02-07</lastmod>
<lastmod>2026-02-10</lastmod>
</url>
<url>
<loc>https://kernelkit.github.io/infix/dev/cli/upgrade/</loc>
<lastmod>2026-02-07</lastmod>
<lastmod>2026-02-10</lastmod>
</url>
</urlset>
Binary file not shown.