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.

Sign up for GitHub

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

Jump to bottom

README: Add information about BlueOS #257

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
+7 −2
Open

README: Add information about BlueOS #257

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f74981b
README: Add information about BlueOS
patrickelectric Sep 12, 2024
6bda3f9
quick-start: installing-companion: Add note about BlueOS
patrickelectric Sep 12, 2024
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
6 changes: 4 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,11 @@
# Overview
> **Warning** If you are using BlueOS, please follow the [new documentation](https://blueos.cloud/docs).

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
> **Warning** If you are using BlueOS, please follow the [new documentation](https://blueos.cloud/docs).
> ⚠️ **Warning** ⚠️ The Companion onboard computer software is no longer being developed or supported. New projects and vehicles are recommended to use [BlueOS](https://blueos.cloud/docs/blueos/latest/) instead.

> **Note** The information in this guide applies to ArduSub V3.5 and up. If you are running an older version, you should [update](/quick-start/installing-ardusub.md).
# Overview

## ArduSub and the ArduPilot Project

> **Note** The information in this guide applies to ArduSub V3.5 and up. If you are running an older version, you should [update](/quick-start/installing-ardusub.md).

The ArduSub project is a fully-featured open-source solution for remotely operated underwater vehicles (ROVs) and autonomous underwater vehicles (AUVs). ArduSub is a part of the [ArduPilot project](http://ardupilot.org/), and was originally derived from the ArduCopter code. ArduSub has extensive capabilities out of the box including feedback stability control, depth and heading hold, and autonomous navigation.

ArduSub is designed to be safe, feature-rich, open-ended, and easy to use even for novice users.
Expand Down
3 changes: 3 additions & 0 deletions quick-start/installing-companion.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
> **Warning** If you are using BlueOS, please follow the [new documentation](https://blueos.cloud/docs).
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
> **Warning** If you are using BlueOS, please follow the [new documentation](https://blueos.cloud/docs).
> ⚠️ **Warning** ⚠️ The ArduSub Companion software is no longer being developed or supported. New projects and vehicles are recommended to use [BlueOS](https://blueos.cloud/docs/blueos/latest/) instead.


# Installing the Companion Computer Software Image

## SD card
>**Note** The current version of Companion is **v0.0.31**. If your system is out of date you can update by either installing a fresh image with the instructions below or connecting to Wi-Fi and performing a [Software Update](#software-update).

The operating system and supporting software is installed by writing a pre-configured `.img` file to an SD Card which is then inserted into the Companion Computer (Raspberry Pi).
Expand Down
Loading