expanded docs

Jaapdedood · Jul 10, 2020 · aa5087f · aa5087f
1 parent 0eac03f
commit aa5087f
Show file tree

Hide file tree

Showing 106 changed files with 21,119 additions and 24 deletions.
diff --git a/docs/_build/doctrees/arduino.doctree b/docs/_build/doctrees/arduino.doctree
diff --git a/docs/_build/doctrees/environment.pickle b/docs/_build/doctrees/environment.pickle
diff --git a/docs/_build/doctrees/hardware.doctree b/docs/_build/doctrees/hardware.doctree
diff --git a/docs/_build/doctrees/index.doctree b/docs/_build/doctrees/index.doctree
diff --git a/docs/_build/doctrees/robopilot.doctree b/docs/_build/doctrees/robopilot.doctree
diff --git a/docs/_build/html/.buildinfo b/docs/_build/html/.buildinfo
@@ -0,0 +1,4 @@
+# Sphinx build info version 1
+# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
+config: aca8bc3b9df4b3cc04d68db64ed2f085
+tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/docs/_build/html/_sources/arduino.rst.txt b/docs/_build/html/_sources/arduino.rst.txt
@@ -0,0 +1,79 @@
+Getting Started
+===============
+
+The Arduino IDE is the most popular beginner method for programming compatible microcontrollers.
+
+Download the Arduino IDE from the Arduino website:
+
+https://www.arduino.cc/en/Main/Software
+
+Adding the 3DoT Board to Arduino
+--------------------------------
+
+1. Navigate to File / Preferences
+
+.. image:: https://www.arxterra.com/wp-content/uploads/2018/09/Getting-Started-3DoT-IDE-preference-window.png
+    :alt: preferences pane
+
+2. Paste the following link into Additional Board Manager URLs:
+   https://arxterra.com/downloads/package_3DoT_index.json
+
+3. Close the preferences window and navigate to Tools / Board: / Boards Manager…
+
+.. image:: https://www.arxterra.com/wp-content/uploads/2018/09/Getting-Started-3DoT-board-manager.png
+    :alt: boards manager
+
+4. Type “3DoT” in the search bar. The board Should show up.
+
+.. image:: https://www.arxterra.com/wp-content/uploads/2018/09/bootloader4.png
+    :alt: 3DoT in boards manager
+
+5. Click inside of the box that contains the text “3DoT by Arxterra” and the “Install” button should appear. Click Install.
+
+.. image:: https://www.arxterra.com/wp-content/uploads/2018/09/bootloader5.png
+    :alt: 3DoT installed in boards manager
+
+Installing the 3DoT Arduino Library
+-----------------------------------
+
+In the Arduino IDE, navigate to
+
+Sketch > Include Library > Manage Libraries..
+
+Search for ArxRobot Library and click install. Done!
+
+.. image:: https://www.arxterra.com/wp-content/uploads/2018/04/Screenshot-from-2020-03-24-09-59-41.png
+    :alt: ArxRobot Library in Arduino library manager
+
+Uploading Your First Sketch
+---------------------------
+
+With the Library Installed, navigate to File > Examples > ArxRobot Library and click on ArxRobot_Basic
+
+.. image:: https://www.arxterra.com/wp-content/uploads/2018/04/examples.png
+    :alt: Basic Example location
+
+The ArxRobot_Basic example is a barebones sketch that handles all the background robot operations, including Bluetooth commands. **This means that uploading the Basic example code will make your robot ready to connect to Bluetooth and go!**
+
+
+Select a COM port
+^^^^^^^^^^^^^^^^^^^^
+
+1. Set the 3DoT to PRG mode and connect your 3DoT to your computer with a USB cable
+
+2. Navigate to Tools > Port and select the port labeled as a 3DoT board.
+
+.. image:: https://www.arxterra.com/wp-content/uploads/2018/04/port.jpg
+    :alt: 3Dot com port
+
+
+Then, simply hit the Upload button in the Arduino IDE.
+
+.. note::
+   If a sketch fails to upload, check the COM port selected again. Your computer may change the COM port number as the board is turned off/on
+
+Next Steps
+----------
+
+Congratulations! You uploaded your first sketch to the 3DoT Board. Click the next button to learn how to send commands to your 3DoT using the RoboPilot app.
+
diff --git a/docs/_build/html/_sources/hardware.rst.txt b/docs/_build/html/_sources/hardware.rst.txt
@@ -0,0 +1,57 @@
+The 3DoT Board
+==============
+
+Battery
+-------
+
+When you first get your board, the battery will be at an ~80% charge, or about 3.7V. Plug in a usb cord connected to a computer or USB wall charger to charge the battery. The 3DoT Board will automatically stop charging at 4.2V, the maximum safe charge voltage.
+
+.. attention::
+
+   Do not let the battery discharge below 3.2V, as this could cause permanent damage to the battery's chemistry and significantly reduce battery life.
+
+ON - PRG - RUN Switch
+---------------------
+
+Next to the USB port, the 3-position switch on the 3DoT board is designed to allow you to set the board to programming mode, take your time programming the board, and then switch the board to ON when you are ready to run the code.
+
+.. note::
+
+   In order to go from ON to programming the board, you must first turn the board OFF, then switch back to PRG.
+
+.. figure:: https://www.arxterra.com/wp-content/uploads/2018/04/Getting-Started-SW-square-e1572375117922.png
+    :align: center
+
+    ON - PRG -OFF Switch
+
+
+Motors
+------
+
+The 3DoT motor driver supplies 0-5V to the on-board motor connectors. Any 3-6V motors will work, as long as they are not too large (no-load current above ~200mA).
+
+We highly recommend `micro-metal gear motors <https://www.humansforrobots.com/product/micro-metal-gear-motor-6v-200rpm/>`__.
+
+Servos
+------
+
+Servos on the 3DoT are powered from the same VM net as the motor drivers. Again, any 3-6V servos should work, but be careful with amount of current that can be drawn from the on-board battery.
+
+We recommend any kind of "micro-servo".
+
+External Battery Connector
+--------------------------
+
+Depending on the motors and servos used, the amount of torque required from them, current drawn by shields etc. you may hit the 3DoT battery's 2A limit. You can alleviate this problem by desoldering the marked solder bridge on the bottom of the board and connecting an external battery or other power supply (4V - 18V) to the external battery connector.This will allow the internal electronics of the board to run from the on-board battery, and supply your battery's power directly to the "VM" net, which is accessible from the top header, and powers the motor driver. 
+
+Shields
+-------
+
+Shields add functionality to your 3DoT board, such as extra motor connectors or sensors, and are available to purchase on the `Humans for Robots store <https://www.humansforrobots.com/store/>`__, or your can make your own.
+
+To make your own, try free PCB CAD software such as KiCad or EAGLE and use the 3DoT PCB CAD files below as a reference.
+
+PCB CAD Files
+-------------
+
+Updated files to be released soon.
diff --git a/docs/_build/html/_sources/index.rst.txt b/docs/_build/html/_sources/index.rst.txt
@@ -0,0 +1,16 @@
+.. ArxRobot-Library documentation master file, created by
+   sphinx-quickstart on Mon Jun 29 17:18:02 2020.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+Welcome to the 3DoT Documentation Site!
+=======================================
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents:
+
+   Hardware <hardware>
+   Getting Started <arduino>
+   RoboPilot App <robopilot>
+   Library Refernce <libref>
diff --git a/docs/_build/html/_sources/robopilot.rst.txt b/docs/_build/html/_sources/robopilot.rst.txt
@@ -0,0 +1,28 @@
+RoboPilot
+=========
+
+Download
+--------
+
+Download the RoboPilot app on the Google Play Store:
+
+https://play.google.com/store/apps/details?id=com.HumansforRobots.RoboPilot&hl=en_US
+
+or from the App Store:
+##
+
+Connecting to Your Robot
+------------------------
+
+Ensure the ArxRobot_Basic sketch, or your own similar code, is uploaded to the 3DoT Board (see previous section).
+
+Turn on the 3DoT Board and load up the app.
+
+Tap "Scan" to look for your 3DoT. If nothing shows up, tap it again after a few seconds.
+
+Click "Connect".
+
+Once connected, try out the default controls to drive your robot's motors!
+
+Adding Custom Commands
+----------------------