diff --git a/README.md b/README.md index 4e8f1756..990ee894 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,15 @@ +# ⚠️ ARCHIVE NOTICE ⚠️ + +This documentation is being split up, and transferred to other sites: + +- ArduSub is being moved to the [ArduPilot wiki](https://ardupilot.org/sub) ([GitHub](https://github.com/ArduPilot/ardupilot_wiki/tree/master/sub)) +- The Blue Robotics Companion Software has been replaced by [BlueOS](https://blueos.cloud/docs) ([GitHub](https://github.com/bluerobotics/BlueOS-docs)) +- Control Station Software (GCS) documentation can be found at + - [QGroundControl](https://docs.qgroundcontrol.com/Stable_V4.3/en/qgc-user-guide/) ([GitHub](https://github.com/mavlink/qgroundcontrol/tree/master/docs)) + - [Cockpit](https://blueos.cloud/cockpit/docs/) ([GitHub](https://github.com/bluerobotics/Cockpit-docs)) + +--- + # Overview > **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). @@ -19,4 +31,4 @@ This book is an on-going work in progress to document the ArduSub software as we ## License - The ArduSub and ArduPilot code are released under the [GPLv3](https://raw.githubusercontent.com/ArduPilot/ardupilot/master/COPYING.txt) License. -- This book is released under the [CC-NC-SA 4.0](https://creativecommons.org/licenses/by-nc-sa/4.0/) License. \ No newline at end of file +- This book is released under the [CC-NC-SA 4.0](https://creativecommons.org/licenses/by-nc-sa/4.0/) License. diff --git a/archive-notice.html b/archive-notice.html new file mode 100644 index 00000000..8ef0b40e --- /dev/null +++ b/archive-notice.html @@ -0,0 +1,12 @@ +
+

⚠️ ARCHIVE NOTICE ⚠️

+

This documentation is no longer being maintained!

+ +
+
+ +
diff --git a/developers/building-docs.md b/developers/building-docs.md index 5a73fd0e..049c7d52 100644 --- a/developers/building-docs.md +++ b/developers/building-docs.md @@ -1,3 +1,5 @@ +{% include "../archive-notice.html" %} + # Serve Docs Locally ## Install npm diff --git a/developers/developers.md b/developers/developers.md index 52645c6c..5ae013ec 100755 --- a/developers/developers.md +++ b/developers/developers.md @@ -1,3 +1,5 @@ +{% include "../archive-notice.html" %} + # Developers ## How to Get the Code diff --git a/developers/dvl-integration.md b/developers/dvl-integration.md index 0c26be0d..96fba9de 100755 --- a/developers/dvl-integration.md +++ b/developers/dvl-integration.md @@ -1,3 +1,5 @@ +{% include "../archive-notice.html" %} + # DVL integration (BETA) The DVL integration with ArduSub is in a BETA stage and is currently unsupported for normal use. This document is provided to instruct beta testers and developers how to test the BETA stage integration. There is no guarantee that the DVL integration will work for any particular application. diff --git a/developers/full-parameter-list.md b/developers/full-parameter-list.md index c1df778b..76805cfb 100644 --- a/developers/full-parameter-list.md +++ b/developers/full-parameter-list.md @@ -1,3 +1,12 @@ +{% include "../archive-notice.html" %} + + + +# This documentation has been moved to [https://ardupilot.org/sub/docs/parameters.html](https://ardupilot.org/sub/docs/parameters.html). + +## You should be automatically redirected. + +--- This is a complete list of the parameters which can be set via the MAVLink protocol in the EEPROM of your APM to control vehicle behaviour. This list is automatically generated from the latest ardupilot source code, and so may contain parameters which are not yet in the stable released versions of the code. Some parameters may only be available for developers, and are enabled at compile-time. @@ -11995,4 +12004,4 @@ Stream rate of PARAM_VALUE to ground station - Range: 0 10 -- Increment: 1 \ No newline at end of file +- Increment: 1 diff --git a/developers/gps-positioning.md b/developers/gps-positioning.md index 116097ca..f84e7787 100755 --- a/developers/gps-positioning.md +++ b/developers/gps-positioning.md @@ -1,3 +1,5 @@ +{% include "../archive-notice.html" %} + # GPS Positioning The ROV autopilot is capable of utilizing an external positioning system to perform autonomous maneuvers like station keeping, 'click to go here', transects, and pre-planned waypoint missions. All GPS/positioning functionality in ArduSub is IN DEVELOPMENT. The **position-enabled** flight modes are not considered stable. However, a positioning system may be integrated in order to display the position of the vehicle on the Ground Control Station map. This can be done without making use of the position-enabled flight modes, and this sort of operation is considered stable. diff --git a/developers/opencv.md b/developers/opencv.md index 63eca72d..654954c7 100644 --- a/developers/opencv.md +++ b/developers/opencv.md @@ -1,3 +1,5 @@ +{% include "../archive-notice.html" %} + # OpenCV OpenCV (Open Source Computer Vision) is a library to help the development of computer vision software. diff --git a/developers/pymavlink.md b/developers/pymavlink.md index 66981c3d..890b8076 100644 --- a/developers/pymavlink.md +++ b/developers/pymavlink.md @@ -1,3 +1,5 @@ +{% include "../archive-notice.html" %} + # Pymavlink ArduSub communicates with a protocol called MAVLink. Pymavlink is a python implementation of the MAVLink protocol. With pymavlink, it is possible to create a python script to read sensor data and send commands to an ArduSub vehicle. diff --git a/developers/rc-input-and-output.md b/developers/rc-input-and-output.md index 41346e02..5c8c6adf 100644 --- a/developers/rc-input-and-output.md +++ b/developers/rc-input-and-output.md @@ -1,3 +1,5 @@ +{% include "../archive-notice.html" %} + # RC input and output ArduSub is designed around two independent concepts of *RC Input* and *RC Output*. RC Input is an array of control channels representing pilot inputs like forward and yaw commands. RC Output is an array of channels representing the pulse widths to write to individual servo output pins. Although ArduSub does not support the use of RC receivers, the logic is the same and is applied to joystick inputs instead. Joystick input and RC Input are synonymous in ArduSub. diff --git a/developers/sitl.md b/developers/sitl.md index 83caee14..b65efcd8 100644 --- a/developers/sitl.md +++ b/developers/sitl.md @@ -1,3 +1,5 @@ +{% include "../archive-notice.html" %} + # S.I.T.L (Software In The Loop) SITL is a simulator that allows you to run ArduSub without any hardware. It is a build of the autopilot code using an ordinary C++ compiler, giving you a native executable that allows you to test the behaviour of the vehicle. diff --git a/developers/software-components.md b/developers/software-components.md index 40a68fb2..3cf9db83 100755 --- a/developers/software-components.md +++ b/developers/software-components.md @@ -1,3 +1,5 @@ +{% include "../archive-notice.html" %} + # Software Components There are three major software components involved in the operation of ArduSub: diff --git a/developers/wireless-topside.md b/developers/wireless-topside.md index 5927b31f..04127017 100644 --- a/developers/wireless-topside.md +++ b/developers/wireless-topside.md @@ -1,3 +1,5 @@ +{% include "../archive-notice.html" %} + # Wireless Topside Connection These instructions assume that you have already set up your ROV to the surface computer via the tether and static IP of 192.168.2.1 on the surface computer, according to the directions in the [Network Setup](/quick-start/installing-companion.md#network-setup) section. These instructions were compiled using the [TP-LINK TL-WR802N](http://www.tp-link.com/us/products/details/cat-5506_TL-WR802N.html) router. diff --git a/getting-started/initial-setup.md b/getting-started/initial-setup.md index a930da7e..b4758a14 100755 --- a/getting-started/initial-setup.md +++ b/getting-started/initial-setup.md @@ -1,3 +1,5 @@ +{% include "../archive-notice.html" %} + # Initial Setup After the software is installed on the electronics, the electronics need to be wired and the software needs to be configured. mounting the controller to the vehicle, connecting it to the tether, power, and motors, and then performing initial configuration and calibration. diff --git a/getting-started/installation-MDONLY.md b/getting-started/installation-MDONLY.md index 8d1c4af5..2f3e812e 100644 --- a/getting-started/installation-MDONLY.md +++ b/getting-started/installation-MDONLY.md @@ -1,3 +1,5 @@ +{% include "../archive-notice.html" %} + diff --git a/getting-started/installation.md b/getting-started/installation.md index 6537263f..69030648 100755 --- a/getting-started/installation.md +++ b/getting-started/installation.md @@ -1,3 +1,5 @@ +{% include "../archive-notice.html" %} + # Installation ## QGroundControl diff --git a/hardware/components.md b/hardware/components.md index 34b963ef..05eff515 100755 --- a/hardware/components.md +++ b/hardware/components.md @@ -1,3 +1,5 @@ +{% include "../archive-notice.html" %} + # Hardware Components We will divide the hardware required to run ArduSub into three categories: diff --git a/introduction/applications.md b/introduction/applications.md index c38829a0..cab69ddc 100644 --- a/introduction/applications.md +++ b/introduction/applications.md @@ -1,3 +1,5 @@ +{% include "../archive-notice.html" %} + # Applications ArduSub provides the functionality needed for a wide variety of applications from simple observation-class ROVs to sophisticated research-class ROVs. Here's a short list of applications that ArduSub-powered ROVs can be used for: diff --git a/introduction/features.md b/introduction/features.md index 24e7abcc..f7adb241 100755 --- a/introduction/features.md +++ b/introduction/features.md @@ -1,3 +1,5 @@ +{% include "../archive-notice.html" %} + # Features ArduSub has many features including: diff --git a/introduction/hardware-options.md b/introduction/hardware-options.md index 52fe4157..27f5c125 100644 --- a/introduction/hardware-options.md +++ b/introduction/hardware-options.md @@ -1,3 +1,5 @@ +{% include "../archive-notice.html" %} + # Hardware Options The following sections detail all the available harware options for ArduSub. If a specific device or component is not mentioned, please ask in the [ArduSub category](https://discuss.bluerobotics.com/c/bluerov2-ardusub/ardusub/16) of the Blue Robotics forums. diff --git a/introduction/hardware-options/additional-peripheral-devices.md b/introduction/hardware-options/additional-peripheral-devices.md index f3fe1e22..9fe8ebe0 100644 --- a/introduction/hardware-options/additional-peripheral-devices.md +++ b/introduction/hardware-options/additional-peripheral-devices.md @@ -1,3 +1,5 @@ +{% include "../../archive-notice.html" %} + # Additional Peripheral Devices The following components and devices are **not** required to be installed for a functioning control system, but add additional functionality and customization to the underwater vehicle. diff --git a/introduction/hardware-options/additional-peripheral-devices/grippers-and-manipulators.md b/introduction/hardware-options/additional-peripheral-devices/grippers-and-manipulators.md index 8324a612..9f25ebf7 100644 --- a/introduction/hardware-options/additional-peripheral-devices/grippers-and-manipulators.md +++ b/introduction/hardware-options/additional-peripheral-devices/grippers-and-manipulators.md @@ -1,3 +1,5 @@ +{% include "../../../archive-notice.html" %} + # Grippers and Manipulators A gripper is a useful tool for picking up small objects, attaching recovery lines, or freeing a snagged tether. Other manipulators may be useful in cleaning, inspection, or repair tasks. diff --git a/introduction/hardware-options/additional-peripheral-devices/leak-sensor.md b/introduction/hardware-options/additional-peripheral-devices/leak-sensor.md index 2bc706f0..0a3e3fa5 100644 --- a/introduction/hardware-options/additional-peripheral-devices/leak-sensor.md +++ b/introduction/hardware-options/additional-peripheral-devices/leak-sensor.md @@ -1,3 +1,5 @@ +{% include "../../../archive-notice.html" %} + # Leak Sensor Leak sensors are an important addition for saving an electronics enclosure should a leak occur. diff --git a/introduction/hardware-options/additional-peripheral-devices/relays.md b/introduction/hardware-options/additional-peripheral-devices/relays.md index 5f4c7b45..9f2a42e2 100644 --- a/introduction/hardware-options/additional-peripheral-devices/relays.md +++ b/introduction/hardware-options/additional-peripheral-devices/relays.md @@ -1,3 +1,5 @@ +{% include "../../../archive-notice.html" %} + # Relays Relays are useful for turning higher voltage (>5V DC) auxiliary equipment on and off. diff --git a/introduction/hardware-options/additional-peripheral-devices/servos.md b/introduction/hardware-options/additional-peripheral-devices/servos.md index 6f72d250..e30ad692 100644 --- a/introduction/hardware-options/additional-peripheral-devices/servos.md +++ b/introduction/hardware-options/additional-peripheral-devices/servos.md @@ -1,3 +1,5 @@ +{% include "../../../archive-notice.html" %} + # Servos Servos are a useful addition to any underwater vehicle build where a component needs to be actuated or rotated. Normal servos can be installed inside the watertight enclosures to rotate things such as cameras. Depth rated servos can be used outside of enclosures. diff --git a/introduction/hardware-options/additional-peripheral-devices/sonars.md b/introduction/hardware-options/additional-peripheral-devices/sonars.md index aacc0ff9..5116538d 100644 --- a/introduction/hardware-options/additional-peripheral-devices/sonars.md +++ b/introduction/hardware-options/additional-peripheral-devices/sonars.md @@ -1,3 +1,5 @@ +{% include "../../../archive-notice.html" %} + # Sonars Sonars are useful pieces of equipment in situations where visibility is low. Sonars can help get ranges to surfaces or acoustically image targets to better understand their shape. diff --git a/introduction/hardware-options/additional-peripheral-devices/temperature-sensor.md b/introduction/hardware-options/additional-peripheral-devices/temperature-sensor.md index e1ee085d..93aade58 100644 --- a/introduction/hardware-options/additional-peripheral-devices/temperature-sensor.md +++ b/introduction/hardware-options/additional-peripheral-devices/temperature-sensor.md @@ -1,3 +1,5 @@ +{% include "../../../archive-notice.html" %} + # Temperature Sensor An auxiliary external temperature sensor may be added for obtaining faster and more accurate readings than those from the integrated pressure sensors. Only one sensor may be connected at a time. diff --git a/introduction/hardware-options/additional-peripheral-devices/underwater-positioning.md b/introduction/hardware-options/additional-peripheral-devices/underwater-positioning.md index 1872db7a..9b5e66c6 100644 --- a/introduction/hardware-options/additional-peripheral-devices/underwater-positioning.md +++ b/introduction/hardware-options/additional-peripheral-devices/underwater-positioning.md @@ -1,3 +1,5 @@ +{% include "../../../archive-notice.html" %} + # Underwater Positioning and GPS A positioning system is a useful addition to an ArduSub vehicle either for displaying numerical location coordinates or the position of the vehicle on a map in QGroundControl. diff --git a/introduction/hardware-options/connection-diagrams.md b/introduction/hardware-options/connection-diagrams.md index 142c5a0b..11d425e9 100644 --- a/introduction/hardware-options/connection-diagrams.md +++ b/introduction/hardware-options/connection-diagrams.md @@ -1,3 +1,5 @@ +{% include "../../archive-notice.html" %} + # Connection Diagrams The following connection diagrams show how to connect devices to the ArduSub control system. diff --git a/introduction/hardware-options/recommended-extras.md b/introduction/hardware-options/recommended-extras.md index e27e06c4..b02c5cbe 100644 --- a/introduction/hardware-options/recommended-extras.md +++ b/introduction/hardware-options/recommended-extras.md @@ -1,3 +1,5 @@ +{% include "../../archive-notice.html" %} + # Recommended Extra Hardware The following components are **not** required to have a working control system, but are highly recommended to expand functionality and utility. diff --git a/introduction/hardware-options/recommended-extras/camera-gimbal.md b/introduction/hardware-options/recommended-extras/camera-gimbal.md index 62a8838f..979d4d1e 100644 --- a/introduction/hardware-options/recommended-extras/camera-gimbal.md +++ b/introduction/hardware-options/recommended-extras/camera-gimbal.md @@ -1,3 +1,5 @@ +{% include "../../../archive-notice.html" %} + # Camera Gimbal ArduSub supports control and attitude atabilization for up to 3-axis gimbals. The most common gimbal type for underwater vehicles is a 1-axis tilt mount, since the majority of standard ROV frames have control over the other Degrees of Freedom (DoF). diff --git a/introduction/hardware-options/recommended-extras/lights.md b/introduction/hardware-options/recommended-extras/lights.md index 365b3180..4e7d4fec 100644 --- a/introduction/hardware-options/recommended-extras/lights.md +++ b/introduction/hardware-options/recommended-extras/lights.md @@ -1,3 +1,5 @@ +{% include "../../../archive-notice.html" %} + # Lights Lights are an integral component of any marine vehicle where optical inspection is being conducted. ArduSub has the ability to control lights that use Pulse Width Modulation (PWM) signals. Two independent light sets may be controlled by two different output channels. diff --git a/introduction/hardware-options/recommended-extras/pressure-sensor.md b/introduction/hardware-options/recommended-extras/pressure-sensor.md index 7bebed10..d516db54 100644 --- a/introduction/hardware-options/recommended-extras/pressure-sensor.md +++ b/introduction/hardware-options/recommended-extras/pressure-sensor.md @@ -1,3 +1,5 @@ +{% include "../../../archive-notice.html" %} + # Pressure Sensor An external pressure sensor is required for obtaining depth readings and enabling [Depth Hold](/reference/ardusub/features-while-in-operation.md#flight-modes) functionality. Only one sensor may be connected at a time. diff --git a/introduction/hardware-options/required-hardware.md b/introduction/hardware-options/required-hardware.md index d11d3e66..c06b48b2 100644 --- a/introduction/hardware-options/required-hardware.md +++ b/introduction/hardware-options/required-hardware.md @@ -1,3 +1,5 @@ +{% include "../../archive-notice.html" %} + # Required Hardware The following pages detail the minimum required hardware to have a functioning control system. Where applicable, alternate options are provided when they have been tested and confirmed to work. diff --git a/introduction/hardware-options/required-hardware/autopilot.md b/introduction/hardware-options/required-hardware/autopilot.md index fa86a525..df0be50e 100644 --- a/introduction/hardware-options/required-hardware/autopilot.md +++ b/introduction/hardware-options/required-hardware/autopilot.md @@ -1,3 +1,5 @@ +{% include "../../../archive-notice.html" %} + # Autopilot In the ArduSub control system, the autopilot board (also known as a flight controller) is the component which the ArduSub firmware is loaded onto. The autopilot processes the pilot input and sensor data, and controls the motors, lights, servos, and relays on the vehicle. diff --git a/introduction/hardware-options/required-hardware/camera.md b/introduction/hardware-options/required-hardware/camera.md index 1b97f3ca..f2d3c64d 100644 --- a/introduction/hardware-options/required-hardware/camera.md +++ b/introduction/hardware-options/required-hardware/camera.md @@ -1,3 +1,5 @@ +{% include "../../../archive-notice.html" %} + # Camera The Companion Computer software contains a series of drivers which will stream FHD video from the vehicle to the Ground Control Station (GCS) at the surface. Only one camera may be connected to the Companion at a time. Support for multiple camera streams is planned, but not implemented at this time. diff --git a/introduction/hardware-options/required-hardware/companion-computer.md b/introduction/hardware-options/required-hardware/companion-computer.md index e1718935..cb0a17f2 100644 --- a/introduction/hardware-options/required-hardware/companion-computer.md +++ b/introduction/hardware-options/required-hardware/companion-computer.md @@ -1,3 +1,5 @@ +{% include "../../../archive-notice.html" %} + # Companion Computer Companion Computers are usually small single board computers (SBCs) which can be connected to an autopilot board and communicate using the [MAVLink protocol](https://ardupilot.org/dev/docs/mavlink-basics.html). A Companion Computer will take in MAVLink telemetry from the [autopilot](/introduction/hardware-options/required-hardware/autopilot.md) and can route or process the telemetry data. diff --git a/introduction/hardware-options/required-hardware/escs.md b/introduction/hardware-options/required-hardware/escs.md index 72e766f8..99f95a69 100644 --- a/introduction/hardware-options/required-hardware/escs.md +++ b/introduction/hardware-options/required-hardware/escs.md @@ -1,3 +1,5 @@ +{% include "../../../archive-notice.html" %} + # Electronic Speed Controls (ESCs) ArduSub is designed to work with brushless and brushed Electronic Speed Controls (ESCs) to control motors and [thrusters](/introduction/hardware-options/required-hardware/thrusters.md). A corresponding ESC will need to be used for a similar motor type. For example if a brushless thruster is used, then a brushless ESC will be needed. diff --git a/introduction/hardware-options/required-hardware/joystick.md b/introduction/hardware-options/required-hardware/joystick.md index 70e54abb..92ff341c 100644 --- a/introduction/hardware-options/required-hardware/joystick.md +++ b/introduction/hardware-options/required-hardware/joystick.md @@ -1,3 +1,5 @@ +{% include "../../../archive-notice.html" %} + # Joystick A joystick (also known as a hand controller, gamepad, etc) when connected to the topside computer is how the user provides control inputs to the vehicle. These inputs may be in the form of movement (stick control) or action items (button presses). diff --git a/introduction/hardware-options/required-hardware/power-sensing-module.md b/introduction/hardware-options/required-hardware/power-sensing-module.md index 3144eedb..64b72bf4 100644 --- a/introduction/hardware-options/required-hardware/power-sensing-module.md +++ b/introduction/hardware-options/required-hardware/power-sensing-module.md @@ -1,3 +1,5 @@ +{% include "../../../archive-notice.html" %} + # Power Sensing Module A power sensing module provides analog current and voltage sensing to an autopilot onboard the vehicle. ArduSub supports various modules in the firmware and when properly set, QGroundControl will give visual indications of battery level and current consumption. diff --git a/introduction/hardware-options/required-hardware/power-supply.md b/introduction/hardware-options/required-hardware/power-supply.md index 87c169f6..48f14064 100644 --- a/introduction/hardware-options/required-hardware/power-supply.md +++ b/introduction/hardware-options/required-hardware/power-supply.md @@ -1,3 +1,5 @@ +{% include "../../../archive-notice.html" %} + # Power Supply A stable power supply and power distribution system is an integral part of any underwater vehicle. The power supply needs to be able to power all the onboard electronics and keep up with the current draw of the thrusters. diff --git a/introduction/hardware-options/required-hardware/tether.md b/introduction/hardware-options/required-hardware/tether.md index ecd7dacb..eab207ee 100644 --- a/introduction/hardware-options/required-hardware/tether.md +++ b/introduction/hardware-options/required-hardware/tether.md @@ -1,3 +1,5 @@ +{% include "../../../archive-notice.html" %} + # Tether A tether is a length of cable which connects the [Companion Computer](/introduction/hardware-options/required-hardware/companion-computer.md) to the [Topside Computer](/introduction/hardware-options/required-hardware/topside-computer.md). Radio frequency (RF) waves do not travel far through water and acoustic modems have limited bandwidth, so a tether is a critical component to connect the vehicle to a surface computer. diff --git a/introduction/hardware-options/required-hardware/thrusters.md b/introduction/hardware-options/required-hardware/thrusters.md index c9c6b34e..3691dbf1 100644 --- a/introduction/hardware-options/required-hardware/thrusters.md +++ b/introduction/hardware-options/required-hardware/thrusters.md @@ -1,3 +1,5 @@ +{% include "../../../archive-notice.html" %} + # Thrusters Thrusters are necessary to maneuver an underwater vehicle around. The number and orientation of thrusters on a vehicle determines the number of degrees of freedom (DoF) it may maneuver in. diff --git a/introduction/hardware-options/required-hardware/topside-computer.md b/introduction/hardware-options/required-hardware/topside-computer.md index b3913265..9014c6e5 100644 --- a/introduction/hardware-options/required-hardware/topside-computer.md +++ b/introduction/hardware-options/required-hardware/topside-computer.md @@ -1,3 +1,5 @@ +{% include "../../../archive-notice.html" %} + # Topside Computer The topside computer runs the QGroundControl application and is the device in which the [Companion Computer](/introduction/hardware-options/required-hardware/companion-computer.md) on the vehicle is connected to. The topside computer is where the live video feed and telemetry information is observed. A [joystick](/introduction/hardware-options/required-hardware/joystick.md) must be plugged in for manual control. diff --git a/introduction/required-software.md b/introduction/required-software.md index d27c9faf..2393700e 100644 --- a/introduction/required-software.md +++ b/introduction/required-software.md @@ -1,3 +1,5 @@ +{% include "../archive-notice.html" %} + # Required Software The ArduSub control system is made up of three major software components: diff --git a/introduction/required-software/ardusub-autopilot-firmware.md b/introduction/required-software/ardusub-autopilot-firmware.md index 79845580..43e9ffde 100644 --- a/introduction/required-software/ardusub-autopilot-firmware.md +++ b/introduction/required-software/ardusub-autopilot-firmware.md @@ -1,3 +1,5 @@ +{% include "../../archive-notice.html" %} + # ArduSub Autopilot Firmware The ArduSub firmware is a binary file that is loaded on to the internal memory of a compatible [autopilot](/introduction/hardware-options/required-hardware/autopilot.md) board. The firmware contains the necessary logic processes to control the specified vehicle type, Sub in this case. Some autopilots (eg. Pixhawk) have an SD card that is used to store data logs. Note that the autopilot firmware is NOT located on the SD card. diff --git a/introduction/required-software/companion-computer-software.md b/introduction/required-software/companion-computer-software.md index 3076a8ea..09f48010 100644 --- a/introduction/required-software/companion-computer-software.md +++ b/introduction/required-software/companion-computer-software.md @@ -1,3 +1,5 @@ +{% include "../../archive-notice.html" %} + # Companion Computer Software The Companion Computer software image is a modified version of [Raspbian](https://www.raspberrypi.org/software/operating-systems/#raspberry-pi-os-32-bit) that is written onto a microSD card and installed in the [Companion Computer](/introduction/hardware-options/required-hardware/companion-computer.md). diff --git a/introduction/required-software/qgroundcontrol-software.md b/introduction/required-software/qgroundcontrol-software.md index 7ee60b62..914f4d80 100644 --- a/introduction/required-software/qgroundcontrol-software.md +++ b/introduction/required-software/qgroundcontrol-software.md @@ -1,3 +1,5 @@ +{% include "../../archive-notice.html" %} + # QGroundControl Software QGroundControl (QGC) is the Graphical User Interface (GUI) for ArduSub, which provides setup and control functionality. QGC runs on Windows, OS X, and Linux platforms. diff --git a/operators-manual/outputs.md b/operators-manual/outputs.md index d72a6390..87aeb9dd 100644 --- a/operators-manual/outputs.md +++ b/operators-manual/outputs.md @@ -1,3 +1,5 @@ +{% include "../archive-notice.html" %} + # Configuring Outputs The Pixhawk has 14 servo output channels which are configured via the [SERVOn_* parameters](/operators-manual/full-parameter-list.html#servon-parameters) and the [BRD_PWM_COUNT](/operators-manual/full-parameter-list.html#brdpwmcount-auxiliary-pin-config) parameter. diff --git a/quick-start/first-dive.md b/quick-start/first-dive.md index 5fa5d3fc..530151e6 100644 --- a/quick-start/first-dive.md +++ b/quick-start/first-dive.md @@ -1,3 +1,5 @@ +{% include "../archive-notice.html" %} + # Getting Ready for Your First Dive Before putting the vehicle in the water, there are a few things which will need to be checked. diff --git a/quick-start/installing-ardusub.md b/quick-start/installing-ardusub.md index 8aa49d7b..13fdda44 100644 --- a/quick-start/installing-ardusub.md +++ b/quick-start/installing-ardusub.md @@ -1,3 +1,5 @@ +{% include "../archive-notice.html" %} + # Installing ArduSub >**Note** The current Stable version of ArduSub is **v4.0.3**. If your firmware is out of date, it may be updated by following one of the methods below. diff --git a/quick-start/installing-companion.md b/quick-start/installing-companion.md index 17bd2825..d686f263 100644 --- a/quick-start/installing-companion.md +++ b/quick-start/installing-companion.md @@ -1,3 +1,5 @@ +{% include "../archive-notice.html" %} + # Installing the Companion Computer Software Image >**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). diff --git a/quick-start/installing-qgc.md b/quick-start/installing-qgc.md index 116afba1..60b05ee5 100644 --- a/quick-start/installing-qgc.md +++ b/quick-start/installing-qgc.md @@ -1,3 +1,5 @@ +{% include "../archive-notice.html" %} + # QGroundControl Installation >**Note** The latest recommended version of QGroundControl is **v4.2.3**. If your software is out of date, please uninstall the QGC application and download the latest version below. diff --git a/quick-start/vehicle-frame.md b/quick-start/vehicle-frame.md index fa6cd722..9df30678 100644 --- a/quick-start/vehicle-frame.md +++ b/quick-start/vehicle-frame.md @@ -1,3 +1,5 @@ +{% include "../archive-notice.html" %} + # Building a Vehicle Frame ## Frame Selection diff --git a/reference/ardusub-configuration.md b/reference/ardusub-configuration.md index 16b6123b..6b953f21 100644 --- a/reference/ardusub-configuration.md +++ b/reference/ardusub-configuration.md @@ -1,3 +1,5 @@ +{% include "../archive-notice.html" %} + # ArduSub Configuration and Features When an autopilot board with ArduSub firmware is connected, the default QGC interface changes to a customized one for ArduSub vehicles. A few pages on the [Vehicle Setup View](/reference/qgroundcontrol/vehicle-setup-view.md) are different from other ArduPilot vehicle types and any setting or section labeled "PX4 Only" will not apply. diff --git a/reference/ardusub/camera-mount-setup-page.md b/reference/ardusub/camera-mount-setup-page.md index 90f69abf..6824e3a6 100644 --- a/reference/ardusub/camera-mount-setup-page.md +++ b/reference/ardusub/camera-mount-setup-page.md @@ -1,3 +1,5 @@ +{% include "../../archive-notice.html" %} + # Camera Mount Setup Page The Camera Mount Setup Page allows for the configuration of an installed camera pan/tilt/roll mount. diff --git a/reference/ardusub/features-while-in-operation.md b/reference/ardusub/features-while-in-operation.md index 2d757ea6..3b71a653 100644 --- a/reference/ardusub/features-while-in-operation.md +++ b/reference/ardusub/features-while-in-operation.md @@ -1,3 +1,5 @@ +{% include "../../archive-notice.html" %} + # Features While in Operation ## Joystick Button Functions diff --git a/reference/ardusub/firmware-page.md b/reference/ardusub/firmware-page.md index f04771ee..230b8126 100644 --- a/reference/ardusub/firmware-page.md +++ b/reference/ardusub/firmware-page.md @@ -1,3 +1,5 @@ +{% include "../../archive-notice.html" %} + # Firmware Page The Firmware Page allows ArduSub firmware to be downloaded from the internet and directly installed onto Pixhawk-family flight-controller boards. By default QGC will install the current stable version, but you can also choose to install beta builds, daily builds, or custom firmware files. diff --git a/reference/ardusub/frame-setup-page.md b/reference/ardusub/frame-setup-page.md index 43a6080a..f6e83251 100644 --- a/reference/ardusub/frame-setup-page.md +++ b/reference/ardusub/frame-setup-page.md @@ -1,3 +1,5 @@ +{% include "../../archive-notice.html" %} + # Frame Setup Page The Frame Setup page configures the MAIN Outputs of the autopilot board to coincide with how many and in which orientation thrusters have been installed on a vehicle frame. diff --git a/reference/ardusub/joystick-setup-page.md b/reference/ardusub/joystick-setup-page.md index bba0a4f8..b90cc3a4 100644 --- a/reference/ardusub/joystick-setup-page.md +++ b/reference/ardusub/joystick-setup-page.md @@ -1,3 +1,5 @@ +{% include "../../archive-notice.html" %} + # Joystick Setup Page When a compatible [joystick](/introduction/hardware-options/required-hardware/joystick.md) is plugged into the [topside computer](/introduction/hardware-options/required-hardware/topside-computer.md), the Joystick Setup page will become active and a small red icon will appear in the top toolbar. After the calibration process is complete and the joystick is enabled, this icon will turn white. diff --git a/reference/ardusub/lights-setup-page.md b/reference/ardusub/lights-setup-page.md index e2fe8814..bf37c083 100644 --- a/reference/ardusub/lights-setup-page.md +++ b/reference/ardusub/lights-setup-page.md @@ -1,3 +1,5 @@ +{% include "../../archive-notice.html" %} + # Lights Setup Page ArduSub supports controlling up to two independent lights channels. diff --git a/reference/ardusub/motors-setup-page.md b/reference/ardusub/motors-setup-page.md index cac24b20..6bdd9316 100644 --- a/reference/ardusub/motors-setup-page.md +++ b/reference/ardusub/motors-setup-page.md @@ -1,3 +1,5 @@ +{% include "../../archive-notice.html" %} + # Motors Setup Page **The direction that the motors will spin depends on how the vehicle and motors were assembled, so each motor's forward/reverse direction must be configured in software.** diff --git a/reference/ardusub/parameters-page.md b/reference/ardusub/parameters-page.md index 038675e3..b5412d4c 100644 --- a/reference/ardusub/parameters-page.md +++ b/reference/ardusub/parameters-page.md @@ -1,3 +1,5 @@ +{% include "../../archive-notice.html" %} + # Parameters Page The Parameters page allows users to find and modify any of the parameters associated with the vehicle. diff --git a/reference/ardusub/power-setup-page.md b/reference/ardusub/power-setup-page.md index 9a33f74a..2367fe76 100644 --- a/reference/ardusub/power-setup-page.md +++ b/reference/ardusub/power-setup-page.md @@ -1,3 +1,5 @@ +{% include "../../archive-notice.html" %} + # Power Setup Page The Power Setup page is used to configure power sensing module parameters. diff --git a/reference/ardusub/safety-setup-page.md b/reference/ardusub/safety-setup-page.md index 6f171cbd..3bce7dd3 100644 --- a/reference/ardusub/safety-setup-page.md +++ b/reference/ardusub/safety-setup-page.md @@ -1,3 +1,5 @@ +{% include "../../archive-notice.html" %} + # Safety Setup Page (Failsafes) The Safety Setup page allows you to configure the failsafe settings. diff --git a/reference/ardusub/sensors-setup-page.md b/reference/ardusub/sensors-setup-page.md index 45cd3b09..ecc98c79 100644 --- a/reference/ardusub/sensors-setup-page.md +++ b/reference/ardusub/sensors-setup-page.md @@ -1,3 +1,5 @@ +{% include "../../archive-notice.html" %} + # Sensors Setup Page The Sensors Setup page allows users to calibrate the vehicle's accelerometer, compass, pressure sensor. diff --git a/reference/ardusub/summary-page.md b/reference/ardusub/summary-page.md index 4fbf8aeb..ecffaf68 100644 --- a/reference/ardusub/summary-page.md +++ b/reference/ardusub/summary-page.md @@ -1,3 +1,5 @@ +{% include "../../archive-notice.html" %} + # Summary Page This page provides an overview of all the important configuration settings for an ArduSub vehicle. Similar to the individual setup buttons, the summary blocks show a red indicator when those settings are not fully configured. diff --git a/reference/ardusub/tuning-setup-page.md b/reference/ardusub/tuning-setup-page.md index 35194fc6..0ff29e5c 100644 --- a/reference/ardusub/tuning-setup-page.md +++ b/reference/ardusub/tuning-setup-page.md @@ -1,3 +1,5 @@ +{% include "../../archive-notice.html" %} + # Tuning Setup Page This page allows changing the PID controller gains to better suit your vehicle and application. Changing these may help you get a snappier response for more precise movements, or a smoother response for recording cinematic footages. diff --git a/reference/companion-web-ui.md b/reference/companion-web-ui.md index b7769393..6509fff1 100644 --- a/reference/companion-web-ui.md +++ b/reference/companion-web-ui.md @@ -1,3 +1,5 @@ +{% include "../archive-notice.html" %} + # Companion Web Interface The Companion computer([Install instructions](/quick-start/installing-companion.md)) hosts a useful web-interface with different pages for accessing parameters and functionalities associated with Companion. When a Companion computer is connected to a ground computer, a user can access the web-interface on [192.168.2.2:2770](http://192.168.2.2:2770). Users can access Network, System, Camera and Routing pages alongside a number of other user friendly options as described below. diff --git a/reference/companion/camera.md b/reference/companion/camera.md index 65e5a23f..dfee57a4 100644 --- a/reference/companion/camera.md +++ b/reference/companion/camera.md @@ -1,3 +1,5 @@ +{% include "../../archive-notice.html" %} + # Camera The [Camera](http://192.168.2.2:2770/camera) page allows the user to view and make changes to: diff --git a/reference/companion/file-system.md b/reference/companion/file-system.md index 13c588e4..b8224ba3 100644 --- a/reference/companion/file-system.md +++ b/reference/companion/file-system.md @@ -1,3 +1,5 @@ +{% include "../../archive-notice.html" %} + # File System Access [File Manager](http://192.168.2.2:7777) page can be used to: diff --git a/reference/companion/git.md b/reference/companion/git.md index 45879155..475ac2a9 100644 --- a/reference/companion/git.md +++ b/reference/companion/git.md @@ -1,3 +1,5 @@ +{% include "../../archive-notice.html" %} + # Git [Git](http://192.168.2.2:2770/git) page is used for: diff --git a/reference/companion/mavlink-rest.md b/reference/companion/mavlink-rest.md index 63fb0525..bcb9d43f 100644 --- a/reference/companion/mavlink-rest.md +++ b/reference/companion/mavlink-rest.md @@ -1,3 +1,5 @@ +{% include "../../archive-notice.html" %} + # MAVLink REST API Starting from companion 0.0.19, a MAVLink REST API ([http://192.168.2.2:4777/mavlink](http://192.168.2.2:4777/mavlink)) endpoint is available. diff --git a/reference/companion/mavproxy.md b/reference/companion/mavproxy.md index cf9d4a49..6b01f41c 100644 --- a/reference/companion/mavproxy.md +++ b/reference/companion/mavproxy.md @@ -1,3 +1,5 @@ +{% include "../../archive-notice.html" %} + # MAVProxy [MAVProxy](http://192.168.2.2:2770/mavproxy) page allows the user to: diff --git a/reference/companion/network.md b/reference/companion/network.md index 7da01a2f..16865c93 100644 --- a/reference/companion/network.md +++ b/reference/companion/network.md @@ -1,3 +1,5 @@ +{% include "../../archive-notice.html" %} + # Network The web interface by default opens at the [Network](http://192.168.2.2:2770/network) page. This page allows users to: diff --git a/reference/companion/routing.md b/reference/companion/routing.md index 9776ab44..7738a427 100644 --- a/reference/companion/routing.md +++ b/reference/companion/routing.md @@ -1,3 +1,5 @@ +{% include "../../archive-notice.html" %} + # Routing The [Routing](http://192.168.2.2:2770/routing) page can be used to route serial communications between serial devices and network ports. It can be used to create one-to-one, and one-to-many connections. The configuration on this page is persistent and loaded at boot. The configuration is stored in the file `~/routing.conf`. diff --git a/reference/companion/system.md b/reference/companion/system.md index d8edb52a..58174367 100644 --- a/reference/companion/system.md +++ b/reference/companion/system.md @@ -1,3 +1,5 @@ +{% include "../../archive-notice.html" %} + # System The [System](http://192.168.2.2:2770/system) page provides the following functionalities and features: diff --git a/reference/companion/terminal-over-browser.md b/reference/companion/terminal-over-browser.md index 92162eb8..9088929f 100644 --- a/reference/companion/terminal-over-browser.md +++ b/reference/companion/terminal-over-browser.md @@ -1,3 +1,5 @@ +{% include "../../archive-notice.html" %} + # Terminal over browser [Terminal](http://192.168.2.2:8088) page can be used to: diff --git a/reference/companion/waterlinked.md b/reference/companion/waterlinked.md index 060e8725..5293b4c7 100644 --- a/reference/companion/waterlinked.md +++ b/reference/companion/waterlinked.md @@ -1,3 +1,5 @@ +{% include "../../archive-notice.html" %} + # Water Linked [Waterlinked](http://192.168.2.2:2770/waterlinked) page can be used to: diff --git a/reference/companion/web-ui.md b/reference/companion/web-ui.md index 6886ee73..672d0824 100644 --- a/reference/companion/web-ui.md +++ b/reference/companion/web-ui.md @@ -1,3 +1,5 @@ +{% include "../../archive-notice.html" %} + # Companion Web Interface The Companion computer([Install instructions](/getting-started/installation.md#raspberry-pi)) hosts a useful web-interface with different pages for accessing parameters and functionalities associated with Companion. When a Companion computer is connected to a ground computer, a user can access the web-interface on [192.168.2.2:2770](http://192.168.2.2:2770). Users can access Network, System, Camera and Routing pages alongside a number of other user friendly options as described below. diff --git a/reference/data-logging.md b/reference/data-logging.md index 9a1a7bb0..d0d93e98 100644 --- a/reference/data-logging.md +++ b/reference/data-logging.md @@ -1,3 +1,5 @@ +{% include "../archive-notice.html" %} + # Logging There are two types of logs that can be used to diagnose problems while running ArduSub, or to retrieve data for post-processing. diff --git a/reference/features-while-in-operation.md b/reference/features-while-in-operation.md index 00b6b6c6..ecb78934 100644 --- a/reference/features-while-in-operation.md +++ b/reference/features-while-in-operation.md @@ -1,3 +1,5 @@ +{% include "../archive-notice.html" %} + # Features While in Operation ## Joystick Button Functions diff --git a/reference/qgc-configuration.md b/reference/qgc-configuration.md index 4f10a4ae..5ea303a4 100644 --- a/reference/qgc-configuration.md +++ b/reference/qgc-configuration.md @@ -1,3 +1,5 @@ +{% include "../archive-notice.html" %} + # QGroundControl Features and Configuration QGroundControl (QGC) is the Graphical User Interface (GUI) for ArduSub, which provides setup and control functionality. It is installed on the [Topside Computer](/introduction/hardware-options/required-hardware/topside-computer.md). diff --git a/reference/qgroundcontrol/analyze-view.md b/reference/qgroundcontrol/analyze-view.md index 5ae0f27d..9763006f 100644 --- a/reference/qgroundcontrol/analyze-view.md +++ b/reference/qgroundcontrol/analyze-view.md @@ -1,3 +1,5 @@ +{% include "../../archive-notice.html" %} + # Analyze View ## Log Download Page diff --git a/reference/qgroundcontrol/application-settings-view.md b/reference/qgroundcontrol/application-settings-view.md index ca1df990..facaad43 100644 --- a/reference/qgroundcontrol/application-settings-view.md +++ b/reference/qgroundcontrol/application-settings-view.md @@ -1,3 +1,5 @@ +{% include "../../archive-notice.html" %} + # Application Settings View The _Application Settings View_ is used to configure the settings for the QGroundControl application (rather than a specific vehicle). You do not have to have a vehicle connected to change these values. diff --git a/reference/qgroundcontrol/fly-view.md b/reference/qgroundcontrol/fly-view.md index 33fd5c5e..c0a105a8 100644 --- a/reference/qgroundcontrol/fly-view.md +++ b/reference/qgroundcontrol/fly-view.md @@ -1,3 +1,5 @@ +{% include "../../archive-notice.html" %} + # Fly View The Fly View is used to control and monitor the vehicle when diving. diff --git a/reference/qgroundcontrol/main-toolbar.md b/reference/qgroundcontrol/main-toolbar.md index 738b6a4e..854b1f49 100644 --- a/reference/qgroundcontrol/main-toolbar.md +++ b/reference/qgroundcontrol/main-toolbar.md @@ -1,3 +1,5 @@ +{% include "../../archive-notice.html" %} + # Main Toolbar The main menu/tool bar provides access to the different application views, and high level status information for the connected vehicle. The menu is the same in all views except for "Plan View" (which has a single icon to take you back to "Fly" view). diff --git a/reference/qgroundcontrol/other-features.md b/reference/qgroundcontrol/other-features.md index a39c60dd..dcd5e64f 100644 --- a/reference/qgroundcontrol/other-features.md +++ b/reference/qgroundcontrol/other-features.md @@ -1,3 +1,5 @@ +{% include "../../archive-notice.html" %} + # Other Features ## Video Overlay diff --git a/reference/qgroundcontrol/plan-view.md b/reference/qgroundcontrol/plan-view.md index 0e3cfa95..d2d5582d 100644 --- a/reference/qgroundcontrol/plan-view.md +++ b/reference/qgroundcontrol/plan-view.md @@ -1,3 +1,5 @@ +{% include "../../archive-notice.html" %} + # Plan View The Plan View is used to plan autonomous missions for your vehicle, and upload them to the vehicle. Once the mission is planned and sent to the vehicle, you switch to the [Fly View]() to run the mission. diff --git a/reference/qgroundcontrol/vehicle-setup-view.md b/reference/qgroundcontrol/vehicle-setup-view.md index 3aed7079..f380c305 100644 --- a/reference/qgroundcontrol/vehicle-setup-view.md +++ b/reference/qgroundcontrol/vehicle-setup-view.md @@ -1,3 +1,5 @@ +{% include "../../archive-notice.html" %} + # Vehicle Setup View The Vehicle Setup View is used to configure a new ArduSub vehicle prior to first use and tune a configured vehicle. diff --git a/reference/troubleshooting.md b/reference/troubleshooting.md index cf2e84e5..17f7e962 100644 --- a/reference/troubleshooting.md +++ b/reference/troubleshooting.md @@ -1,3 +1,5 @@ +{% include "../archive-notice.html" %} + # Troubleshooting This page shares issues that users have run into and how they were resolved. Hopefully this will help to solves issues for others. diff --git a/resources/community.md b/resources/community.md index 0573a85b..ee84a2a1 100755 --- a/resources/community.md +++ b/resources/community.md @@ -1,3 +1,5 @@ +{% include "../archive-notice.html" %} + # Community ## Blue Robotics Forum diff --git a/resources/downloads.md b/resources/downloads.md index c9cc8637..2a830ed2 100755 --- a/resources/downloads.md +++ b/resources/downloads.md @@ -1,3 +1,5 @@ +{% include "../archive-notice.html" %} + # Downloads ## ArduSub Firmware Files diff --git a/resources/further-reading.md b/resources/further-reading.md index 010ff937..a04115fa 100644 --- a/resources/further-reading.md +++ b/resources/further-reading.md @@ -1,3 +1,5 @@ +{% include "../archive-notice.html" %} + # Further Reading The following websites and resources have more information on specific components or pieces of documentation. Some are just cool to keep tabs on like the blogs! diff --git a/software/ardusub-firmware.md b/software/ardusub-firmware.md index 83698d82..c0b3a8cb 100755 --- a/software/ardusub-firmware.md +++ b/software/ardusub-firmware.md @@ -1,3 +1,5 @@ +{% include "../archive-notice.html" %} + # ArduSub Firmware ## Versioning diff --git a/software/mavlink.md b/software/mavlink.md index 78e8e366..e024d351 100644 --- a/software/mavlink.md +++ b/software/mavlink.md @@ -1,3 +1,5 @@ +{% include "../archive-notice.html" %} + # MAVLink You can check the official website for more information about it [here](https://mavlink.io).