Skip to content

Commit

Permalink
Adding RPi Bookworm note
Browse files Browse the repository at this point in the history
  • Loading branch information
SparkFun-Documentation-Team committed Jul 3, 2024
1 parent d894333 commit 67773cb
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 1 deletion.
6 changes: 5 additions & 1 deletion docs/examples-Python.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,10 @@ icon: simple/python
This first example just does some basic measurements to make sure everything is hooked up correctly.


Navigate to the qwiic_otos\examples directory in your Python installation (ex: mine is at c:\Python\Lib\site-packages\qwiic\drivers\)



<figure markdown>
[![Optical Tracking Odometry Sensor Python Example 1](assets/img/){ width="600" }](assets/img/ "Click to enlarge")
<figcaption markdown>Finding Example 1</figcaption>
Expand Down Expand Up @@ -151,7 +155,7 @@ Alternatively, you can expand the link below and copy and paste the code into a

??? "Example 4 Arduino Code"
```
--8<-- "https://raw.githubusercontent.com/sparkfun/SparkFun_Qwiic_OTOS_Arduino_Library/main/examples/Example4_SetOffsetAndPosition/Example4_SetOffsetAndPosition.ino"
--8<-- "https://raw.githubusercontent.com/sparkfun/Qwiic_OTOS_Py/master/examples/qwiic_otos_ex4_set_offsets_and_position.py"
```


Expand Down
12 changes: 12 additions & 0 deletions docs/software_setup-Python.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,9 @@ icon: simple/python
!!! attention
If this is your first time working with Python, there are quite a few useful tutorials on getting started. The [Python Programming Section](https://learn.sparkfun.com/tutorials/python-programming-tutorial-getting-started-with-the-raspberry-pi/programming-in-python) of our Getting Started with the Raspberry Pi Tutorial has some good basic information and resources for getting started with Python.




We've written a python package to get you started with the SparkFun Optical Tracking Odometry Sensor. It's been included in the SparkFun Qwiic Python package, which aggregates all Python Qwiic drivers/modules to provide a single entity for Qwiic within a Python environment. The [Qwiic_Py GitHub Library ReadMe](https://github.com/sparkfun/Qwiic_Py) has more information on the Qwiic Python package.

If you already have your Qwiic Python package installed, you can update it with the following command:
Expand Down Expand Up @@ -43,6 +46,13 @@ If you prefer downloading the code to build and install the package manually, yo



!!! attention
If you are working with a Raspberry Pi and are using the new Bookworm distribution of the Raspberry Pi OS, refer to [these instructions](https://www.raspberrypi.com/documentation/computers/os.html#python-on-raspberry-pi) to setup a virtual environment.

Make sure to include the --system-site-packages flag:python3 -m venv <name of virtual environment> --system-site-packages

Then it is possible to install the packages using pip.



In addition to the package provided here, we have written a Python script that allows you to visualize the XRP in real time. Download via the button below.
Expand All @@ -57,3 +67,5 @@ In addition to the package provided here, we have written a Python script that a
[![Visualization Script in Action](assets/img/SEN-24904-Action-GIF-1.gif){ width="600" }](assets/img/SEN-24904-Action-GIF-1.gif "Click to enlarge")
<figcaption markdown>Visualization Script in Action</figcaption>
</figure>


0 comments on commit 67773cb

Please sign in to comment.