Skip to main content

Library for the Pimoroni Inventor HAT Mini

Project description

Inventor HAT Mini

Build Status Coverage Status PyPi Package Python Versions

A versatile motor, servo and audio driver HAT for Raspberry Pi. Bring your mechanical inventions, creations and contraptions to life!

Buy it from: https://shop.pimoroni.com/products/inventor-hat-mini

Getting the Library

Stable library only (no examples) from PyPi:

  • Just run sudo python3 -m pip install inventorhatmini

This will install the library under the root user. This is required to use Inventor HAT Mini's RGB LEDs, which rely on the rpi_ws281x package.

In some cases you may need to install pip with: sudo apt install python3-pip

Stable library, with latest examples from GitHub:

  • git clone https://github.com/pimoroni/inventorhatmini-python
  • cd inventorhatmini-python
  • ./install.sh

Latest/development library and examples from GitHub:

  • git clone https://github.com/pimoroni/inventorhatmini-python
  • cd inventorhatmini-python
  • ./install.sh --unstable

Configuring your Raspberry Pi

Enable I2C

In order to use the motor, servo, and IO features of Inventor HAT Mini, you need to enable the I2C interface of your Raspberry Pi. This can be done in the terminal by running:

  • sudo raspi-config nonint do_i2c 0

Alternatively, you can enable the I2C interface by:

  • running sudo raspi-config and enabling the option under Interfacing Options.
  • opening the graphical Raspberry Pi Configuration application from the Preferences menu.

You may need to reboot after enabling I2C for the change to take effect.

Increase I2C Baudrate

To get the most out of your Inventor HAT Mini it is recommended to run your Raspberry Pi with a higher I2C baudrate than the default 100KHz. This can be done by modifying your Pi's configuration file. To do this run sudo nano /boot/config.txt to open a terminal text editor.

Within the editor navigate to the line dtparam=i2c_arm=on. If this says off or is commented out with a #, use this opportunity to change it. Now insert the following line below it, dtparam=i2c_baudrate=400000 to increase the baudrate.

When you are finished modifying the file, press CTRL+X on your keyboard, then when asked to Save modified buffer? press Y.

Reboot after this for the change to take effect.

Enable Audio

To use the audio output of your Inventor HAT Mini you will need to modifying your Pi's configuration file. To do this run sudo nano /boot/config.txt to open a terminal text editor.

Within the editor navigate to the bottom of the file and include the lines dtoverlay=hifiberry-dac and gpio=25=op,dh. The first line switches the audio to use the GPIO header of your Pi for audio output, and the second line will cause your Pi to enable the audio output on boot, by setting pin BCM 25 to high. Then navigate up to the line dtparam=i2s=on. If this says off or is commented out with a #, uncomment it and change it to on.

Depending on your setup, you may also need to disable other audio outputs of your Pi (for example audio over HDMI). Look through the file for any existing mention to dtparam=audio=on and change it to dtparam=audio=off. There may the line dtoverlay=vc4-kms-v3d. Modify this to be dtoverlay=vc4-kms-v3d,noaudio.

When you are finished modifying the file, press CTRL+X on your keyboard, then when asked to Save modified buffer? press Y.

Reboot after this for the change to take effect.

Examples and Usage

There are many examples to get you started with your Inventor HAT Mini. With the library installed on your Raspberry Pi, these can be found in the ~/Pimoroni/inventorhatmini/examples directory. Details about what each one does can be found in the examples readme.

To take Inventor HAT Mini further, the full API is described in the library reference.

Removing the Library

To uninstall the library only (keeping all examples):

  • Just run sudo python3 -m pip uninstall inventorhatmini

Or if you have grabbed the library from Github:

  • cd inventorhatmini-python
  • ./uninstall.sh

1.0.0

  • Port to gpiod/gpiodevice for Pi 5
  • Use dummy LEDs for Pi 5

0.0.1

  • Initial Release

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

inventorhatmini-1.0.0.tar.gz (199.4 kB view details)

Uploaded Source

Built Distribution

inventorhatmini-1.0.0-py3-none-any.whl (215.5 kB view details)

Uploaded Python 3

File details

Details for the file inventorhatmini-1.0.0.tar.gz.

File metadata

  • Download URL: inventorhatmini-1.0.0.tar.gz
  • Upload date:
  • Size: 199.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.11.2

File hashes

Hashes for inventorhatmini-1.0.0.tar.gz
Algorithm Hash digest
SHA256 e6662d56755ba37d5f3ae3dcd7ad5b0b00d5c283f424905c026143f3f4c70ea3
MD5 50e225ee860dbcbb99b011c1a63b919e
BLAKE2b-256 8c9bebe0885e6018b5454741873d442bf29d3ac28238c2e0090579738364d737

See more details on using hashes here.

Provenance

File details

Details for the file inventorhatmini-1.0.0-py3-none-any.whl.

File metadata

File hashes

Hashes for inventorhatmini-1.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 52be9533864c842b90d1ec35337834d44467c67e9162052e5ef3358908a80093
MD5 c05f009e43eedc04d79f867fc180dd6a
BLAKE2b-256 37b0041e2e10a65d3bed9d965189d37597388c6cac1d53c2a20cc84b34d65448

See more details on using hashes here.

Provenance

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page