Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[1.2] fix broken building #6

Merged
merged 2 commits into from
Oct 15, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 0 additions & 1 deletion content/_index.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
+++
title = "BlueOS"
description = "Documentation for the BlueOS Docker software (replaces Companion)."
date = 2021-10-20T20:30:00+00:00
template = "docs/section.html"
sort_by = "weight"
weight = 1
Expand Down
1 change: 0 additions & 1 deletion content/development/_index.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
+++
title = "Development"
description = "Documentation for the development of BlueOS."
date = 2023-02-16T16:45:00+11:00
template = "docs/section.html"
sort_by = "weight"
weight = 40
Expand Down
1 change: 0 additions & 1 deletion content/integrations/_index.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
+++
title = "Integrations"
description = "Documentation for integrations with BlueOS."
date = 2024-05-09T16:55:00+10:00
template = "docs/section.html"
sort_by = "weight"
weight = 20
Expand Down
2 changes: 0 additions & 2 deletions content/integrations/hardware/_index.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,6 @@
+++
title = "Hardware"
description = "Hardware documentation."
date = 2022-10-04T01:21:30+10:00
updated = 2022-10-04T22:00:00+10:00
sort_by = "weight"
weight = 2
template = "docs/overview-section.html"
Expand Down
1 change: 0 additions & 1 deletion content/integrations/hardware/additional/_index.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
+++
title = "Additional Components and Peripheral Devices"
description = "Useful hardware for an underwater ROV."
date = 2022-10-11T07:00:00+10:00
template = "docs/section.html"
sort_by = "weight"
weight = 3
Expand Down
1 change: 0 additions & 1 deletion content/integrations/hardware/recommended/_index.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
+++
title = "Recommended Extra Hardware"
description = "Hardware recommended for an underwater ROV."
date = 2022-10-11T07:00:00+10:00
template = "docs/section.html"
sort_by = "weight"
weight = 2
Expand Down
1 change: 0 additions & 1 deletion content/integrations/hardware/required/_index.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
+++
title = "Required Hardware"
description = "Hardware required for an underwater ROV."
date = 2022-10-04T21:45:00+10:00
template = "docs/section.html"
sort_by = "weight"
weight = 1
Expand Down
1 change: 0 additions & 1 deletion content/usage/_index.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
+++
title = "Usage"
description = "Documentation for usage of BlueOS."
date = 2024-05-09T16:45:00+10:00
template = "docs/section.html"
sort_by = "weight"
weight = 10
Expand Down
26 changes: 13 additions & 13 deletions content/usage/getting-started/index.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
+++
title = "Getting Started"
description = "BlueOS getting started instructions."
date = 2023-12-04T20:00:00+11:00
date = 2024-10-16T01:50:00+11:00
template = "docs/page.html"
sort_by = "weight"
weight = 20
Expand Down Expand Up @@ -38,34 +38,34 @@ The web interface monitors the autopilot and other main software components. It
When BlueOS is newly installed the interface provides a configuration wizard to help get things set up.

The Welcome section allows skipping the wizard if BlueOS and your vehicle have already been configured as desired:
{{ easy_image(src="wizard-welcome", width=450, center=true) }}
{{ easy_image(src="wizard-welcome", width=500, center=true) }}

To support BlueOS and autopilot firmware updates, it is recommended for BlueOS to be connected to the internet:
{{ easy_image(src="wizard-wifi", width=450, center=true) }}
{{ easy_image(src="wizard-wifi", width=500, center=true) }}

BlueOS supports multiple vehicle types, and allows selecting a quick-setup option for the most common ones:
{{ easy_image(src="wizard-vehicle", width=450, center=true) }}
{{ easy_image(src="wizard-vehicle", width=500, center=true) }}

Vehicle quick-setup involves setting appropriate parameters for the selected vehicle type and frame, as well as choosing a name for your vehicle, and changing the mDNS hostname if you would prefer to connect with something other than [http://blueos.local](http://blueos.local):
{{ easy_image(src="wizard-parameters", width=450, center=true) }}
{{ easy_image(src="wizard-parameters", width=500, center=true) }}

Progress is displayed for any selected configuration changes, and an up to date autopilot firmware is downloaded and installed (if using a standard vehicle type):
{{ easy_image(src="wizard-progress", width=450, center=true) }}
{{ easy_image(src="wizard-progress", width=500, center=true) }}

A completion window is shown once all configuration is done:
{{ easy_image(src="wizard-complete", width=450, center=true) }}
{{ easy_image(src="wizard-complete", width=500, center=true) }}

### Interface Features

When you first open the web interface, you'll see a page that looks like this:
{{ easy_image(src="../advanced-usage/interface-overview", width="600") }}
{{ easy_image(src="../advanced/interface-overview", width="600") }}

As a brief overview,
- the header contains system health indicators and notifications, and some network and display configuration options
- the sidebar allows navigating between pages, and allows restarting, freeing up space, and reporting issues
- most pages show their content within the BlueOS interface sections, but some extensions open as full pages in a separate tab

For more details see the Advanced Usage [Interface Overview](../advanced-usage/#interface-overview) section.
For more details see the Advanced Usage [Interface Overview](../advanced/#interface-overview) section.

## Updating / Releases

Expand Down Expand Up @@ -97,7 +97,7 @@ Internet connectivity is possible via either [wifi](#connect-wifi) or [passed th
- [Arch (Linux) instructions](https://wiki.archlinux.org/title/Internet_sharing)

Once the internet passthrough has been configured, the BlueOS header should
[show that it has internet connectivity](../advanced-usage/#internet-status-and-management).
[show that it has internet connectivity](../advanced/#internet-status-and-management).

### Select Version

Expand All @@ -106,12 +106,12 @@ Now that your BlueOS has an internet connection, you can perform the update to t
1. Click on the hamburger menu (if the sidebar is not already open)

![Version Menu](version-menu.png)
1. Under **Settings**, select [**BlueOS Version**](../advanced-usage/#blueos-version)
1. Under **Settings**, select [**BlueOS Version**](../advanced/#blueos-version)

![Version Chooser](version-chooser.png)
1. If you're already on the latest version, the right side of your Local Version will be blank. If not, you should see a blue **Update** button.

<img src="../advanced-usage/version-chooser-simple.png" width="550">
<img src="../advanced/version-chooser-simple.png" width="550">

1. Once the update button is clicked the update process will run.
Please wait until it finishes - it will automatically reload the webpage for you.
Expand All @@ -120,7 +120,7 @@ Now that your BlueOS has an internet connection, you can perform the update to t

BlueOS is capable of configuring and streaming multiple cameras simultaneously. The first time it boots, it will automatically detect any connected H264-capable cameras and start streaming them. If not, make sure your camera is properly connected, and that BlueOS is on the latest available version. Reset settings and restart BlueOS if necessary.

Additional information is available in the Advanced Usage [Video Streams](../advanced-usage/#video-streams) section.
Additional information is available in the Advanced Usage [Video Streams](../advanced/#video-streams) section.

## USB OTG
It is possible to connect with a Raspberry Pi 4 through its USB-C port[^1]. Once it's connected, the interface should be available though [blueos.local](http://blueos.local)[^2].
Expand Down
Binary file modified content/usage/getting-started/wizard-complete.png
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 content/usage/getting-started/wizard-parameters.png
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 content/usage/getting-started/wizard-progress.png
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 content/usage/getting-started/wizard-vehicle.png
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 content/usage/getting-started/wizard-welcome.png
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 content/usage/getting-started/wizard-wifi.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading