diff --git a/docs/source/bluetooth.rst b/docs/source/bluetooth.rst index cb8c6ca..ff6e091 100644 --- a/docs/source/bluetooth.rst +++ b/docs/source/bluetooth.rst @@ -1,3 +1,5 @@ +.. _Bluetooth: + Bluetooth ========= Using Bluetooth Low Energy (BLE) to communicate with the NanoNav. diff --git a/docs/source/index.rst b/docs/source/index.rst index 4a3ec66..350b5a8 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -16,5 +16,6 @@ Contents usage bluetooth movement + sensors faq diff --git a/docs/source/movement.rst b/docs/source/movement.rst index 6d873b9..c23c6b5 100644 --- a/docs/source/movement.rst +++ b/docs/source/movement.rst @@ -1,3 +1,5 @@ +.. _Movement: + Movement ========= Working with NanoNav's motors. diff --git a/docs/source/sensors.rst b/docs/source/sensors.rst new file mode 100644 index 0000000..0428441 --- /dev/null +++ b/docs/source/sensors.rst @@ -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. \ No newline at end of file diff --git a/docs/source/usage.rst b/docs/source/usage.rst index 4979f72..7ff6f1b 100644 --- a/docs/source/usage.rst +++ b/docs/source/usage.rst @@ -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 ` to verify that everything is working correctly so far. Alternatively, copy the following into a file called `main.py`: .. raw:: html @@ -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: @@ -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 `_. \ No newline at end of file +You can find the MicroPython documentation `here `_. + +.. _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`. \ No newline at end of file