Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
helgibbons authored Jun 25, 2024
1 parent bb9ddb9 commit 6f23c19
Showing 1 changed file with 31 additions and 8 deletions.
39 changes: 31 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,31 +5,54 @@
[![PyPi Package](https://img.shields.io/pypi/v/icm20948.svg)](https://pypi.python.org/pypi/icm20948)
[![Python Versions](https://img.shields.io/pypi/pyversions/icm20948.svg)](https://pypi.python.org/pypi/icm20948)

Detect movement in nine different ranges of motion: 3-axis acceleration, 3-axis gyroscopic motion, and 3-axis compass heading.

## Where to buy

* [ICM20948 9DoF Motion Sensor Breakout](https://shop.pimoroni.com/products/icm20948)

# Installing

If you've already set up a Python virtual environment, you can also install the stable library manually from PyPi:
## Full install (recommended):

```
pip install icm20948
```
We've created an easy installation script that will install all pre-requisites and get you up and running with minimal efforts. To run it, fire up Terminal which you'll find in Menu -> Accessories -> Terminal on your Raspberry Pi desktop, as illustrated below:

Otherwise our install script will set one up for you.
![Finding the terminal](http://get.pimoroni.com/resources/github-repo-terminal.png)

Stable library from GitHub:
In the new terminal window type the commands exactly as it appears below (check for typos) and follow the on-screen instructions:

```
git clone https://github.com/pimoroni/icm20948-python
cd icm20948-python
./install.sh
```

Latest/development library from GitHub:
**Note** Libraries will be installed in the "pimoroni" virtual environment, you will need to activate it to run examples:

```
source ~/.virtualenvs/pimoroni/bin/activate
```

## Development:

If you want to contribute, or like living on the edge of your seat by having the latest code, you can install the development version like so:

```
git clone https://github.com/pimoroni/icm20948-python
cd icm20948-python
./install.sh --unstable
```

**Note** Libraries will be installed in the "pimoroni" virtual environment, you will need to activate it to run examples:
## Install stable library from PyPi and configure manually

* Set up a virtual environment: `python3 -m venv --system-site-packages $HOME/.virtualenvs/pimoroni`
* Switch to the virtual environment: `source ~/.virtualenvs/pimoroni/bin/activate`
* Install the library: `pip install icm20948`

In some cases you may need to us `sudo` or install pip with: `sudo apt install python3-pip`.

This will not make any configuration changes, so you may also need to enable:

* i2c: `sudo raspi-config nonint do_i2c 0`

You can optionally run `sudo raspi-config` or the graphical Raspberry Pi Configuration UI to enable interfaces.

0 comments on commit 6f23c19

Please sign in to comment.