Skip to content

Commit

Permalink
Deploying to gh-pages from @ 7448bdb 🚀
Browse files Browse the repository at this point in the history
  • Loading branch information
@ES-Alexander
ES-Alexander committed Apr 17, 2024
1 parent c3805c6 commit e4b3094
Show file tree
Hide file tree
Showing 14 changed files with 490 additions and 70 deletions.
2 changes: 1 addition & 1 deletion search_index.en.js
View file

Large diffs are not rendered by default.

8 changes: 4 additions & 4 deletions sitemap.xml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -191,30 +191,30 @@
</url>
<url>
<loc>https://docs.bluerobotics.com/ardusub-zola/software/onboard/BlueOS-1.1/advanced-usage/</loc>
<lastmod>2023-03-08T12:30:00+11:00</lastmod>
<lastmod>2024-04-05T01:20:00+11:00</lastmod>
</url>
<url>
<loc>https://docs.bluerobotics.com/ardusub-zola/software/onboard/BlueOS-1.1/development/</loc>
</url>
<url>
<loc>https://docs.bluerobotics.com/ardusub-zola/software/onboard/BlueOS-1.1/development/bootstrap/</loc>
<lastmod>2023-06-02T18:30:00+11:00</lastmod>
<lastmod>2023-12-04T19:30:00+11:00</lastmod>
</url>
<url>
<loc>https://docs.bluerobotics.com/ardusub-zola/software/onboard/BlueOS-1.1/development/core/</loc>
<lastmod>2023-06-01T19:30:00+11:00</lastmod>
</url>
<url>
<loc>https://docs.bluerobotics.com/ardusub-zola/software/onboard/BlueOS-1.1/development/extensions/</loc>
<lastmod>2023-03-08T12:30:00+11:00</lastmod>
<lastmod>2024-04-13T17:50:00+10:00</lastmod>
</url>
<url>
<loc>https://docs.bluerobotics.com/ardusub-zola/software/onboard/BlueOS-1.1/development/overview/</loc>
<lastmod>2023-06-01T19:30:00+11:00</lastmod>
</url>
<url>
<loc>https://docs.bluerobotics.com/ardusub-zola/software/onboard/BlueOS-1.1/getting-started/</loc>
<lastmod>2023-02-23T23:15:00+11:00</lastmod>
<lastmod>2023-12-04T20:00:00+11:00</lastmod>
</url>
<url>
<loc>https://docs.bluerobotics.com/ardusub-zola/software/onboard/BlueOS-1.1/installation/</loc>
Expand Down
56 changes: 38 additions & 18 deletions software/onboard/BlueOS-1.1/advanced-usage/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -494,8 +494,10 @@ <h3 id="interface-overview">Interface Overview</h3>
</div>
<h4 id="header-indicators-and-blueos-configuration">Header: Indicators and BlueOS Configuration</h4>
<p>On the left side of the header there is space for widgets, which can be accessed by
right clicking and selecting the desired widgets to display. This system is very new,
so the available widget options are currently quite limited.</p>
right clicking and selecting the desired widgets to display. Widgets can be reordered
by clicking and dragging.</p>
<p>There are currently widgets available for displaying the CPU and Disk (storage) usage
as percentages, which are periodically updated during operation.</p>
<div style="padding-bottom:15px;">
<img src="widgets.png" alt="Widgets" width=300 >
</div>
Expand All @@ -512,7 +514,7 @@ <h5 id="notifications">Notifications</h5>
<h5 id="wired-network-management-ethernet-usb-otg">Wired network management (ethernet / USB-OTG)</h5>
<div class="pirate" style="color:grey;display:block;">
<em>
<p><strong>Based On:</strong> <a href="https://github.com/bluerobotics/BlueOS/tree/1.1.0-beta.23/core/services/cable_guy">Cable Guy</a> | Port:<code>9090</code></p>
<p><strong>Based On:</strong> <a href="https://github.com/bluerobotics/BlueOS/tree/1.1.1/core/services/cable_guy">Cable Guy</a> | Port:<code>9090</code></p>
</em>
</div>
<p>For each interface, choose between:</p>
Expand All @@ -531,7 +533,7 @@ <h5 id="wired-network-management-ethernet-usb-otg">Wired network management (eth
<h5 id="wifi-hotspot-network-management">Wifi + Hotspot network management</h5>
<div class="pirate" style="color:grey;display:block;">
<em>
<p><strong>Based On:</strong> <a href="https://github.com/bluerobotics/BlueOS/tree/1.1.0-beta.23/core/services/wifi">Wifi Manager</a> | Port:<code>9000</code></p>
<p><strong>Based On:</strong> <a href="https://github.com/bluerobotics/BlueOS/tree/1.1.1/core/services/wifi">Wifi Manager</a> | Port:<code>9000</code></p>
</em>
</div>
<ul>
Expand Down Expand Up @@ -574,7 +576,7 @@ <h5 id="wifi-hotspot-network-management">Wifi + Hotspot network management</h5>
</div>
<h5 id="internet-status-and-management">Internet Status and Management</h5>
<ul>
<li>See whether the vehicle is connected to the internet</li>
<li>See whether the vehicle is connected to the internet (updates every 20 seconds)</li>
</ul>
<div style="padding-bottom:15px;text-align:center;">
<img src="internet.png" alt="Internet" width=50 >
Expand Down Expand Up @@ -629,6 +631,7 @@ <h5 id="system-status">System status</h5>
<li>CPU throttling</li>
<li>CPU under voltage</li>
<li>Connected wirelessly (instead of through a tether)</li>
<li>BlueOS cannot connect to its host computer</li>
</ul>
</li>
</ul>
Expand Down Expand Up @@ -742,7 +745,7 @@ <h2 id="blueos-service-pages">BlueOS Service Pages</h2>
<h3 id="autopilot-firmware">Autopilot Firmware</h3>
<div class="pirate" style="color:grey;display:block;">
<em>
<p><strong>Based On:</strong> <a href="https://github.com/bluerobotics/BlueOS/tree/1.1.0-beta.23/core/services/ardupilot_manager">ArduPilot Manager</a> | Port:<code>8000</code></p>
<p><strong>Based On:</strong> <a href="https://github.com/bluerobotics/BlueOS/tree/1.1.1/core/services/ardupilot_manager">ArduPilot Manager</a> | Port:<code>8000</code></p>
</em>
</div>
<p>The Autopilot Firmware page provides basic information about the active
Expand Down Expand Up @@ -842,7 +845,7 @@ <h3 id="bag-editor">Bag Editor</h3>
</div>
<div class="pirate" style="color:grey;display:block;">
<em>
<p><strong>Based On:</strong> <a href="https://github.com/bluerobotics/BlueOS/tree/1.1.0-beta.23/core/services/bag_of_holding">Bag of Holding</a> | Port:<code>9101</code></p>
<p><strong>Based On:</strong> <a href="https://github.com/bluerobotics/BlueOS/tree/1.1.1/core/services/bag_of_holding">Bag of Holding</a> | Port:<code>9101</code></p>
</em>
</div>
<div class="pirate" style="color:grey;display:block;">
Expand All @@ -855,7 +858,7 @@ <h3 id="bag-editor">Bag Editor</h3>
<h3 id="blueos-version">BlueOS Version</h3>
<div class="pirate" style="color:grey;display:block;">
<em>
<p><strong>Based On:</strong> <a href="https://github.com/bluerobotics/BlueOS/tree/1.1.0-beta.23/core/services/versionchooser">Version Chooser</a> | Port:<code>8081</code></p>
<p><strong>Based On:</strong> <a href="https://github.com/bluerobotics/BlueOS/tree/1.1.1/core/services/versionchooser">Version Chooser</a> | Port:<code>8081</code></p>
</em>
</div>
<p>The Version Chooser is a major component in the robust backbone of BlueOS. It
Expand Down Expand Up @@ -948,7 +951,7 @@ <h3 id="mavlink-endpoints">MAVLink Endpoints</h3>
</div>
<div class="pirate" style="color:grey;display:block;">
<em>
<p><strong>Based On:</strong> <a href="https://github.com/bluerobotics/BlueOS/tree/1.1.0-beta.23/core/services/ardupilot_manager">ArduPilot Manager</a> | Port:<code>8000</code></p>
<p><strong>Based On:</strong> <a href="https://github.com/bluerobotics/BlueOS/tree/1.1.1/core/services/ardupilot_manager">ArduPilot Manager</a> | Port:<code>8000</code></p>
</em>
</div>
<div class="pirate" style="color:grey;display:block;">
Expand Down Expand Up @@ -1016,7 +1019,7 @@ <h3 id="mavlink-inspector">MAVLink Inspector</h3>
<h3 id="network-test">Network Test</h3>
<div class="pirate" style="color:grey;display:block;">
<em>
<p><strong>Based On:</strong> <a href="https://github.com/bluerobotics/BlueOS/tree/1.1.0-beta.23/core/services/pardal">Pardal</a> | Port:<code>9120</code></p>
<p><strong>Based On:</strong> <a href="https://github.com/bluerobotics/BlueOS/tree/1.1.1/core/services/pardal">Pardal</a> | Port:<code>9120</code></p>
</em>
</div>
<p>The Local Network Test measures real-time latency between BlueOS and the surface
Expand All @@ -1035,7 +1038,7 @@ <h3 id="nmea-injector">NMEA Injector</h3>
</div>
<div class="pirate" style="color:grey;display:block;">
<em>
<p><strong>Based On:</strong> <a href="https://github.com/bluerobotics/BlueOS/tree/1.1.0-beta.23/core/services/nmea_injector">NMEA Injector</a> | Port:<code>2748</code></p>
<p><strong>Based On:</strong> <a href="https://github.com/bluerobotics/BlueOS/tree/1.1.1/core/services/nmea_injector">NMEA Injector</a> | Port:<code>2748</code></p>
</em>
</div>
<div class="pirate" style="color:grey;display:block;">
Expand All @@ -1058,7 +1061,7 @@ <h3 id="nmea-injector">NMEA Injector</h3>
<h3 id="ping-sonar-devices">Ping Sonar Devices</h3>
<div class="pirate" style="color:grey;display:block;">
<em>
<p><strong>Based On:</strong> <a href="https://github.com/bluerobotics/BlueOS/tree/1.1.0-beta.23/core/services/ping">Ping Service</a> | Port:<code>9110</code></p>
<p><strong>Based On:</strong> <a href="https://github.com/bluerobotics/BlueOS/tree/1.1.1/core/services/ping">Ping Service</a> | Port:<code>9110</code></p>
</em>
</div>
<p><code>New in 1.1</code></p>
Expand All @@ -1083,7 +1086,7 @@ <h3 id="serial-bridges">Serial Bridges</h3>
</div>
<div class="pirate" style="color:grey;display:block;">
<em>
<p><strong>Based On:</strong> <a href="https://github.com/bluerobotics/BlueOS/tree/1.1.0-beta.23/core/services/bridget">Bridget</a> | Port:<code>27353</code></p>
<p><strong>Based On:</strong> <a href="https://github.com/bluerobotics/BlueOS/tree/1.1.1/core/services/bridget">Bridget</a> | Port:<code>27353</code></p>
</em>
</div>
<div class="pirate" style="color:grey;display:block;">
Expand All @@ -1098,14 +1101,16 @@ <h3 id="serial-bridges">Serial Bridges</h3>
</div>
<div class="pirate" style="color:grey;display:block;">
<ul>
<li>NOTE: UDP-based systems do not guarantee packet delivery or sequential alignment</li>
<li><strong>NOTE:</strong> UDP-based systems do not guarantee packet delivery or sequential alignment</li>
<li>Bridges to the <a href="https://docs.bluerobotics.com/ardusub-zola/hardware/required/control-computer/">Control Station Computer</a>
will generally use the localhost IP <code>0.0.0.0</code>, which creates a UDP server that waits
for a UDP client on the control computer to connect to it
<ul>
<li>other IP addesses create a UDP client on the onboard computer, which expects the
serial device to initiate communication before the connected UDP server (on the
control computer) can respond</li>
<li><strong>NOTE:</strong> a client should communicate with the server at least once every 10 seconds
to avoid being disconnected</li>
</ul>
</li>
<li>Bridges to internal programs can use the loopback IP <code>127.0.0.1</code>, which creates a
Expand Down Expand Up @@ -1347,7 +1352,7 @@ <h3 id="extensions-manager">Extensions Manager</h3>
<p><code>New in 1.1</code></p>
<div class="pirate" style="color:grey;display:block;">
<em>
<p><strong>Based On:</strong> <a href="https://github.com/bluerobotics/BlueOS/tree/1.1.0-beta.23/core/services/kraken">Kraken</a> | Port:<code>9134</code></p>
<p><strong>Based On:</strong> <a href="https://github.com/bluerobotics/BlueOS/tree/1.1.1/core/services/kraken">Kraken</a> | Port:<code>9134</code></p>
</em>
</div>
<p>The Extensions Manager is in charge of fetching, installing, updating, and managing
Expand Down Expand Up @@ -1392,11 +1397,26 @@ <h4 id="vehicle-name-and-mdns-hostname">Vehicle Name and mDNS Hostname</h4>
<li>the vehicle name makes it easier to determine which vehicle you are connected to</li>
<li>changing the mDNS hostname changes the address you connect to for the browser interface
<ul>
<li>ethernet tether -&gt; <a href="http://custom.local">http://custom.local</a></li>
<li>wired connection (ethernet tether / USB-OTG) -&gt; <a href="http://custom.local">http://custom.local</a></li>
<li>wifi connection -&gt; <a href="http://custom-wifi.local">http://custom-wifi.local</a></li>
<li>BlueOS hotspot -&gt; <a href="http://custom-hotspot.local">http://custom-hotspot.local</a></li>
<li><a href="http://blueos.local">http://blueos.local</a> will still be available for direct ethernet
connections, as a fallback in case the custom name is forgotten</li>
<li><a href="http://blueos.local">http://blueos.local</a> will still be available for wired connections,
as a fallback in case the custom name is forgotten</li>
<li><a href="http://blueos-avahi.local">http://blueos-avahi.local</a> is broadcast to all interfaces,
for connecting when you're not sure which interface(s) are available</li>
<li>IP addresses are always available for
<a href="https://docs.bluerobotics.com/ardusub-zola/software/onboard/BlueOS-1.1/advanced-usage/#wired-network-management-ethernet-usb-otg">the interfaces they're configured for</a>, but
they're less intuitive to remember than mDNS names</li>
<li><strong>NOTE:</strong> mDNS is available on most modern operating systems, but
<ul>
<li>for Windows older than Windows 10, <a href="https://support.apple.com/kb/dl999">install Bonjour</a></li>
<li>for Linux run <code>avahi-discover</code> on the terminal to see if the avahi service is running
<ul>
<li>For reference: <a href="https://wiki.debian.org/Avahi">Debian</a>, <a href="https://wiki.archlinux.org/title/avahi">Arch</a></li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
</ul>
Expand Down
Binary file modified software/onboard/BlueOS-1.1/advanced-usage/network-test-local.png
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified software/onboard/BlueOS-1.1/advanced-usage/power-pirate.png
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified software/onboard/BlueOS-1.1/advanced-usage/power-simple.png
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
3 changes: 3 additions & 0 deletions software/onboard/BlueOS-1.1/development/bootstrap/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -301,6 +301,9 @@ <h2 id="codebase">Codebase</h2>
<p>BlueOS is set up with a <a href="https://docs.github.com/en/actions">GitHub Action</a> that <a href="https://github.com/bluerobotics/BlueOS/blob/master/.github/workflows/test-and-deploy.yml#L90">automatically builds and deploys</a> a BlueOS-bootstrap image when changes are pushed to the GitHub repository.
If you want to make use of that functionality you'll need a <a href="https://hub.docker.com">DockerHub</a> account, and will need to specify your DockerHub username (<code>DOCKER_USERNAME</code>) and password (<code>DOCKER_PASSWORD</code>) in your fork's <a href="https://docs.github.com/en/actions/security-guides/encrypted-secrets">GitHub secrets</a>.</p>
<h2 id="updating">Updating</h2>
<blockquote>
<p>⚠️ BlueOS-bootstrap is a critical component of running BlueOS, and can significantly affect the system stability. It should only be updated when necessary, and preferably at times where the onboard computer hardware is accessible in case something goes wrong. For normal users it is strongly recommended to only update BlueOS-bootstrap to match stable releases of BlueOS, and even then only if there is a known issue an update is expected to fix or improve.</p>
</blockquote>
<p>BlueOS-bootstrap versions are built at the same time as BlueOS-core versions, and they get bundled together in the Raspberry Pi images that can be flashed onto an SD card to install BlueOS onto it. For official BlueOS releases it is possible to update the BlueOS-bootstrap image to match the BlueOS release through the <a href="../../advanced-usage#blueos-version">BlueOS Version</a> chooser, and is the recommended process.</p>
<p>Manually updating to a non-matched and/or custom bootstrap image requires using the <a href="../../advanced-usage#terminal">Terminal</a>:</p>
<pre data-lang="sh" style="background-color:#2b303b;color:#c0c5ce;" class="language-sh "><code class="language-sh" data-lang="sh"><span style="color:#65737e;"># drop down from blueos-core into the underlying operating system:
Expand Down
Binary file added software/onboard/BlueOS-1.1/development/extensions/anatomy.png
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added software/onboard/BlueOS-1.1/development/extensions/backend-process.png
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added software/onboard/BlueOS-1.1/development/extensions/frontend-backend.png
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added software/onboard/BlueOS-1.1/development/extensions/github-workflow-dispatch.png
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading

0 comments on commit e4b3094

Please sign in to comment.