Open Solo 3.0.0 Documentation Update

OpenSolo · Dec 31, 2017 · 01b84b2 · 01b84b2
1 parent 0d048ff
commit 01b84b2
Show file tree

Hide file tree

Showing 6 changed files with 127 additions and 37 deletions.
diff --git a/README.md b/README.md
@@ -1,16 +1,25 @@
 # Open Solo Releases For Users #
-The team working on safe, reliable releases of Open Solo publishes them here. You can read all the details in the release notes, and link directly to installation instructions. These are the "official" instructions. These instructions superceed any other older instructions, videos, and wikis that came before Open Solo.
+***INFORMATION CURRENT FOR STABLE RELEASE v3.0.0 ON JANUARY 1, 2018***
+
+The team working on safe, reliable releases of Open Solo publishes them here. You can read all the details in the release notes, and link directly to installation instructions. These are the "official" instructions. These instructions supersede any other older instructions, videos, and wikis that came before Open Solo.
 
 ### _Release notes and instructions_ ###
-- [Open Solo Release Notes](https://github.com/OpenSolo/documentation/releases)
+
+- Release notes for each version:
+  - [Current stable release: v3.0.0](https://github.com/OpenSolo/documentation/releases/tag/v3.0.0)
+  - [All releases including old betas](https://github.com/OpenSolo/documentation/releases/)
+
 - For _stock solos and previously installed and working green cubes_, go straight to the Open Solo installation procedures:
   - [Install using the Solex app on Android](../master/install_solex.md)
   - [Install using SidePilot app on iOS](../master/initial_sidepilot.md)
-  - Install using SSH/SFTP on widows or mac (No procedure has been created yet)
+  - [Install using SSH/SFTP on widows or mac](../master/initial_ssh.md)
+  - [Install / recovery with SD card images](../master/install_sdimage.md)
+
 - For a _brand new Green Cube installation_ please follow these updated instructions!
   - [New green cube installation procedure](../master/green_cube_install.md)
 
 ### _Support, Social Media, and other useful links_ ###
+
 * [Solo Beta Test](https://www.facebook.com/groups/617648671719759/) group on Facebook (primary Open Solo and Green Cube support group!!)
 * [Solo Mod Club](https://www.facebook.com/groups/3DRSOLOModClub/) group on Facebook
 * [Solex Users](https://www.facebook.com/groups/176789056089526/) group on Facebook
@@ -25,8 +34,24 @@ The team working on safe, reliable releases of Open Solo publishes them here. Yo
 * [Filezilla](https://filezilla-project.org/download.php?type=client) for moving files to/from the companion computer
 * [WinSCP](https://winscp.net/eng/download.php) for moving files to/from the companion computer
 
+## Tech and Contributors ##
+If you're the geeky type that wants to read all the commits to see what has been changed in Open Solo, they can all be found in the Open Solo github repositories.
+
+- **The Build System** compiles all the code from all the repositories into functioning binaries to be loaded onto the Solo and Controller. This was a HUGE lift to make work outside of 3DR's environment. David Buzz (@davidbuzz) was the brains behind the move of _everything_ from 3DR, setup of new repos and servers, build system engineering, and a new AWS based auto-build system. The AWS system can compile from scratch in 1hr, whereas a home PC takes up to 5hrs.
+  - [Meta-3DR](https://github.com/OpenSolo/meta-3dr/commits/master) is all the Yocto bitbake recipes.
+  - [Solo-Builder](https://github.com/OpenSolo/solo-builder/commits/master) is the virtual machine and scripts to carry out the build.
+
+- **The Flight Code** has numerous components that got fixes and new features. Matt Lawrence (@Pedals2Paddles) worked most of these changes.  Other contributors to the code were Tim (@FLYBYME), Morten Enholm (@Spawn32), and Hugh Eaves (@hugheaves),
+  - [Sololink](https://github.com/OpenSolo/sololink/commits/master) is mostly behind the scenes stuff related to booting, networking connections, firmware loading, etc. This compiles into a version for both the Copter and Controller's IMX companion computers.
+  - [Shotmanager](https://github.com/OpenSolo/shotmanager/commits/master) is all the smart shots, button and control handling, camera stuff, and most other user facing operational stuff. This compiles primarily into the Copter's IMX companion computer.
+  - [Artoo](https://github.com/OpenSolo/artoo/commits/master) is the controller's STM32 firmware for the screen, buttons, and sticks.
+  - [Mavlink-Solo](https://github.com/OpenSolo/mavlink-solo/commits/master) is a rather old fork of Mavlink. The flight modes were brought up to current enumerations.
+  - [Sololink-python](https://github.com/OpenSolo/sololink-python/commits/master) is some misc helper python files.
+  - [ArduPilot-solo](https://github.com/OpenSolo/ardupilot-solo/commits/master) is 3DR's fork of ArduCopter used on the stock Solo pixhawk 2.0 cube.
+
+
 
-# Building Open Solo For Developers #
+# For Developers #
 ***FOR DEVELOPERS!! Not for general users that just want to put Open Solo releases on their solo!!!***
 
 ## [Building Open Solo (everything)](https://github.com/OpenSolo/documentation/blob/master/SOLO-BUILDER.md)

diff --git a/initial_sidepilot.md b/initial_sidepilot.md
@@ -1,27 +1,26 @@
 ## Detailed Install Using The SidePilot App ##
 
-1. **Download packages:** With your device connected to the internet, go into the SidePilot 'Help & Settings' menu, and tap the '3DR Solo Firmware Upgrade' menu and download the Open Solo Clean Install packages (solo and controller). You can do this either before or after connecting to Solo's WiFi_.  The installation packages are 75MB each, so it will take a little longer to download than you may be used to. If you don't see the Firmware Updates menu, make sure you have 3DR Solo selected as your connection type.
+1. **Download packages:** With your device connected to the Internet, go into the SidePilot 'Help & Settings' menu, and tap the '3DR Solo Firmware Upgrade' menu and download the Open Solo Clean Install packages (solo and controller). You can do this either before or after connecting to Solo's WiFi_.  The installation packages are 75MB each, so it will take a little longer to download than you may be used to. If you don't see the Firmware Updates menu, make sure you have 3DR Solo selected as your connection type.
 
 2. **Connect:** Once you've downloaded both, connect your mobile device to the Solo WiFi and tap the connect button in the top right corner of the SidePilot main screen. Ensure you begin receiving telemetry data before continuing. Again, your solo and controller must be fully charged, powered on, paired, connected, and not malfunctioning. 
 
 3. **Install:** From the firmware updates menu in SidePilot, tap the _Open Solo 2.5-RC1 Clean Install_ package that you previously downloaded. Read the instructions and continue with the installation by tapping the 'Install' button. Again, be patient while numerous large files are extracted and scripts execute. Do not push buttons, exit the app, mess with the Solo, etc. Let it do its thing. Do this for both the controller package and the copter package. The process the same. You must do both.
 
-4. **Reboot:** Power cycle the Solo and controller once the SidePilot installation packages have both completed successfully. When they power back on, they will automatically begin a factory reset procedure. Since we just installed Open Solo on the recovery partitions, they are factory resetting to Open Solo! They will then automatically execute a second update procedure, cleanly installing Open Solo on the system partition.
-    - You will likely hear the Pixhawk reboot tones twice. You may hear the firmware success happy tones from the pixhawk as well. All normal.
+4. **Reboot:** Power cycle the Solo and controller once the Solex installation packages have both completed successfully. When they power back on, they will automatically begin a factory reset procedure. Since we just installed Open Solo on the recovery partitions, they are factory resetting to Open Solo! They will then automatically execute a second update procedure, cleanly installing Open Solo on the system partition.
+    - You will likely hear the Pixhawk reboot 2-3 times. This is normal.
     - You will likely see the controller reboot and say update success twice. This is also normal.
-    - It is difficult to know exactly what stage it is at since it can't speak and isn't telepathic. The process takes about 8-10 minutes on both the solo and the controller.  So just wait about 10 minutes.
-    - If you have a green cube, the lights will not accurately indicate what is going on! They will be "stuck" blinking whatever they were last doing, probably the disco lights. This is normal, because the driver is not enabled until after loading parameters later. It's ok.
+    - It is difficult to know exactly what stage it is at since it can't speak and isn't telepathic. The process takes about 6 minutes on both the solo and the controller.  So just wait about 6 minutes.
 
 5. **Pair:** Hit the pair button under the Solo with a small pointy poking apparatus like a paper clip for 2 seconds to get the controller and solo re-paired. When the controller tells you it has detected the solo, hold the A and B button for 3 seconds... which is the second set of vibrations... until the the screen says pairing in progress.
 
 6. **Reconnect mobile device:** You will need to reconnect your mobile device to Solo's WiFi now.  Since it did a factory reset, the Solo and controller are using their default WiFi SSID and password (the default password is `sololink`).
 
-7. **Load applicable parameter packages:** If you have a Green Cube, and/or a HERE GPS/Compass, and/or Ian's landing gear mod, you will need to install some applicable parameter packages now.  If you have none of these modifications, you can skip this step.
-   - Tap each package in the SidePilot Firmware Updates menu to install the parameters. You do not need to reboot after each one. Install all the applicable packages in this order, then reboot the Solo at the end.
-   - If you have a green cube, load the _ArduCopter 3.5.x Parameters_ package first before any others.
+7. **Load applicable parameter packages:** If you have a HERE GPS/Compass or a retractable landing gear mod, you will need to install some applicable parameter packages now.  If you have none of these modifications, you can skip this step.
+   - Tap each package in the SidePilot Firmware Updates menu to install the parameters. You do not need to reboot after each one.
    - If you have the HERE gps/compass, load the _HERE Parameters_ package.
    - If you have the landing gear mod, load the _Landing Gear Parameters__ package.
-   - Reboot the solo after loading all the applicable packages.
+   - You do _not_ need to load the ArduCopter parameters or ArduCopter firmware packages!!!
+   - Reboot the solo after loading all the applicable parameter packages.
 
 ### Installation Complete! ### 
 Proceed to the [post-installation instructions!](../master/install_post.md)
diff --git a/initial_ssh.md b/initial_ssh.md
@@ -5,7 +5,7 @@ This procedure is for users that want to install Open Solo manually using variou
 
 
 ### SETUP ##
-1. **Download** the Open_Solo_XXX.zip file from the release attachments and unzip somewhere convenient on your computer.
+1. **Download** the `Open Solo x.x.x.zip` file from the release attachments and unzip somewhere convenient on your computer.
 
 2. **Power up** the copter and controller. Both should be fully charged, paired, connected, and working normally.
 
@@ -77,9 +77,9 @@ This procedure is for users that want to install Open Solo manually using variou
 From this point forward, it is the same as any other installation method.
 
 4. **Reboot:** Power cycle the Solo and controller once the Copter and Controller steps above are complete. When they power back on, they will automatically begin a factory reset procedure. Since we just installed Open Solo on the recovery partitions, they are factory resetting to Open Solo! They will then automatically execute a second update procedure, cleanly installing Open Solo on the system partition.
-    - You will likely hear the Pixhawk reboot tones twice. You may hear the firmware success happy tones from the pixhawk as well. All normal.
+    - You will likely hear the Pixhawk reboot tones 2-3 times.  This is normal.
     - You will likely see the controller reboot and say update success twice. This is also normal.
-    - It is difficult to know exactly what stage it is at since it can't speak and isn't telepathic. The process takes about 8-10 minutes on both the solo and the controller.  So just wait about 10 minutes.
+    - It is difficult to know exactly what stage it is at since it can't speak and isn't telepathic. The process takes about 6 minutes on both the solo and the controller. So just wait about 6 minutes.
 
 5. **Pair:** Hit the pair button under the Solo with a small pointy poking apparatus like a paper clip for 2 seconds to get the controller and solo re-paired. When the controller tells you it has detected the solo, hold the A and B button for 3 seconds... which is the second set of vibrations... until the the screen says pairing in progress. If the copter and controller are not pairing, reboot both. They may have timed out.
 

diff --git a/install_post.md b/install_post.md
@@ -1,20 +1,19 @@
 ## Open Solo - Post Installation Instructions ##
-Regardless of installation method, this is what you will need to do next, leading up to flight.
+Regardless of installation method, this is what you will need to do next, leading up to flight. Consequently, this is also what you need to do after a parameter reset in the future if you need to.
 
 1. **Level Calibration:** Use the _IMU Calibration_ function in the Solex app, or the _level calibration_ function in the 3DR or SidePilot apps, or the _3D Accel Calibration_ in Mission Planner, or the _Accelerometer Calibration_ in the Tower app to do the level calibration. They all do the same thing and just give it different names.  Reboot when complete.
    - The level calibration must be done on a solid, stable, level surface like a table or hard floor.
    - For each axis you calibrate, wait about 10 seconds after putting it down before pressing the button.
    - Make sure the solo is _perfectly still_ when you push the button each time.
    - The first step where it is right side up needs to be both _perfectly still and as level as you can make it_. The rest do not require perfect leveling.  Just being still.
-   - Reboot when complete. The apps may not tell you to reboot. They may tell you to go fly. Trust me. Reboot.
+   - Reboot when complete. The apps may not tell you to reboot. They may tell you to go fly. Reboot.
 
 2. **Compass Calibration:** Use the _Compass Calibration_ function in The Solex app, SidePilot or 3DR app. Or use the _Onboard Compass Calibration_ in Mission Planner. They all do the same thing and just give it different names.  Reboot when complete.
    - Must be done outdoors
    - Must be done in an open area away from buildings, vehicles, reinforced concrete slabs, power lines, MRI machines, metal fencing, etc.
    - Remove any magnetic jewelry or steel accessories you may be wearing
-   - Rotate the solo around each of its axes: Right side up, both sides, nose up, nose down, upside-down, etc. If you just spin it around level, it will fail.
-   - Reboot when when complete. The apps may not tell you to reboot. They may tell you to go fly. Trust me. Reboot.
-   - If you have the HERE GPS/Compass, please wait 30 seconds before powering it back on during reboots before and after compass calibration. In other words, rebooting before calibration and after calibration should be power off, wait 30 seconds, power on.
+   - Rotate the solo around each of its axes: Right side up, both sides, nose up, nose down, upside-down, etc. If you just spin it around level, it will fail. Keep spinning it around until it completes.
+   - Reboot when when complete. The apps may not tell you to reboot. They may tell you to go fly. Reboot.
 
 3. **Settings and Options:** Go through the _Vehicle Settings_ menu in Solex or the Solo settings in the 3DR app to set and verify all your settings and options.  You will need to set your RTH altitude, A & B buttons, geofence, max altitude, speed sliders, etc.  You can also change the WiFi SSID and password.