Skip to content

Library for use of all the JoyPi Note hardware components on Raspberry Pi

Notifications You must be signed in to change notification settings

Appstun/JoyPiNoteBetterLib

Repository files navigation

JoyPiNoteBetterLib

A Python library for the JoyPi Note – making hardware modules easy to use.

Installation

Warning

Using sudo pip install can affect system packages. Use virtual environments if possible.

# Clone the repository
git clone https://github.com/Appstun/JoyPiNoteBetterLib.git
cd JoyPiNoteBetterLib

# Install the library
sudo pip install . --break-system-packages # install globally
# OR
pip install . # install in existing virtual environment

Modules supported

See Modules.md for full documentation.

Module Description
ButtonMatrix 4x4 keypad
Buzzer Sound output
HumTemp Temperature & humidity
Joystick Analog stick
LcdDisplay 16x2 LCD
LedMatrix 8x8 RGB LEDs (needs sudo)
LightSensor Brightness in Lux
Nfc NFC/RFID reader
Relay Electrical switch
Seg7x4 7-segment display
Servomotor 0-180° rotation
SoundSensor Sound detection
Stepmotor Precise rotation
TiltSensor Tilt detection
TouchSensor Touch detection
Ultrasonic Distance measurement
Vibrator Vibration motor

Important

Some modules (e.g., LedMatrix) require root privileges:

sudo python3 your_script.py

For examples how you can use the library, explore the demo folder.

Reinstallation

If you want to update first, from the repository root run:

# Get latest changes
git pull

If you need to reinstall the library, from the repository root run:

# reinstall in virtual environment:
pip uninstall JoyPiNoteBetterLib
rm -rf JoyPiNoteBetterLib.egg-info
pip install . --break-system-packages
# OR
# reinstall globally:
sudo pip uninstall JoyPiNoteBetterLib --break-system-packages
sudo rm -rf JoyPiNoteBetterLib.egg-info
sudo pip install . --break-system-packages

About

Library for use of all the JoyPi Note hardware components on Raspberry Pi

Topics

Resources

Stars

Watchers

Forks

Languages