Skip to content

Commit

Permalink
Add references to other main pages from Quick Start
Browse files Browse the repository at this point in the history
  • Loading branch information
ErikUmble committed May 1, 2024
1 parent 23ff8f8 commit 8c4033a
Show file tree
Hide file tree
Showing 5 changed files with 22 additions and 4 deletions.
2 changes: 2 additions & 0 deletions docs/source/bluetooth.rst
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
.. _Bluetooth:

Bluetooth
=========
Using Bluetooth Low Energy (BLE) to communicate with the NanoNav.
Expand Down
1 change: 1 addition & 0 deletions docs/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -16,5 +16,6 @@ Contents
usage
bluetooth
movement
sensors
faq

2 changes: 2 additions & 0 deletions docs/source/movement.rst
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
.. _Movement:

Movement
=========
Working with NanoNav's motors.
Expand Down
6 changes: 6 additions & 0 deletions docs/source/sensors.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
.. _Sensors:

Sensors
=======

To best interact with its environment, your NanoNav kit comes with infrared sensors that can be used for detecting how reflective the surface under it is.
15 changes: 11 additions & 4 deletions docs/source/usage.rst
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ Or copy the code below into a file called nanonav.py
Workflow
--------
Here is how you can program your Arduino. You will need a file called `main.py` that contains your MicroPython code - you can create other files
and import them as usual, but `main.py` is the one that will be run on the Arduino. For getting started quickly, we recommend downloading this installation check
and import them as usual, but `main.py` is the one that will be run on the Arduino. We'll explain a bit more about :ref:`MicroPython` below. For getting started quickly, we recommend downloading this installation check
:download:`main.py </../../tests/installation_check/main.py>` to verify that everything is working correctly so far. Alternatively, copy the following into a file called `main.py`:

.. raw:: html
Expand All @@ -49,8 +49,7 @@ We recommend creating a folder that you will use for your MicroPython code - put
Connect your Arduino to your computer using a USB cable. Click the "Connect" button in the bottom left of OpenMV IDE. The arrow below it should turn green when connected. Click that arrow to run
your code on the Arduino. If all worked well, you should see :red:`TODO`.

.. note::
We recommend testing your
We recognize that OpenMV IDE is not a very nice editor to write code in, so feel free to open `main.py` in your favorite editor (such as VS Code) for editing and run them from OpenMV IDE.

.. _MicroPython:

Expand All @@ -62,4 +61,12 @@ packages, which are different from the PyPi packages you may be used to (if you
interact with the Arduino, Bluetooth, and peripherals, and just about anything you can do in Python 3.11 can also be done in MicroPython, but note that you will not have access to the full standard Python library. For instance, you can import `time` since this has been added to
MicroPython's library, but you cannot import `Queue` or other familiar packages. If ever in doubt about whether MicroPython supports a particular package, simply google "MicroPython [package name]",
and you will likely find the information you need.
You can find the MicroPython documentation `here <https://docs.micropython.org/en/latest/>`_.
You can find the MicroPython documentation `here <https://docs.micropython.org/en/latest/>`_.

.. _NextSteps:

Next Steps
----------

Now that you have your Arduino set up and running MicroPython, you can start writing your own code. Feel free to take a look at and modify the `main.py` we provided earlier to see a few ways of interacting with
the Arduino using the `nanonav` library. When you are ready to learn more, take a look at our guides to using :ref:`Bluetooth`, controling :ref:`Movement`, and reading :ref:`Sensors`.

0 comments on commit 8c4033a

Please sign in to comment.