Skip to content

matrix-io/matrix-lite-py

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

MATRIX-Lite-Py

MATRIX Lite Python is a library that allows users of varying skill levels to easily program their MATRIX Device.

Roadmap

  • Leds
  • Sensors
    • IMU
    • Humidity
    • Pressure
    • UV
  • GPIO
  • Microphones
  • NFC (separate library)

Installation

Ensure you have a Raspberry Pi, attached with a MATRIX device, that's flashed with Raspbian.

1. Install MATRIX HAL

https://matrix-io.github.io/matrix-documentation/matrix-hal/getting-started/installation-package/

2. Install Python 3

To call your scripts with python 3, use python3 YOUR_SCRIPT.py

sudo apt-get install python3-pip 

3. Upgrade PIP

python3 -m pip install --upgrade pip 

4. Install matrix-lite-py

python3 -m pip install --user matrix-lite 

Usage

The matrix-lite package contains a matrix_lite & _matrix_hal Python module. _matrix_hal is the direct HAL implementation. matrix_lite contains small abstractions for _matrix_hal.

Everloop

from matrix_lite import led import time # Get LED count print('This device has ' + str(led.length) + ' Leds') # A single string, object, or tuple will set all LEDs # Below are different ways of expressing a color (number values are from 0-255) led.set('blue') led.set('#0000ff') # Objects and tuples can utilize the white LED led.set({'r':0, 'g':0, 'b':255, 'w':0 }) led.set((0,0,255,0)) # LEDs off led.set('black') led.set([]) led.set() led.set({}) # Arrays set individual LEDs led.set(['red', 'gold', 'purple', {}, 'black', '#6F41C1', 'blue', {'g':255}]) # Arrays can simulate motion everloop = ['black'] * led.length everloop[0] = {'b':100} while True: everloop.append(everloop.pop(0)) led.set(everloop) time.sleep(0.050)

Sensors

from matrix_lite import sensors import time # Sensors will update with each .read() call while True: # Each .read() returns a dictionary print(sensors.imu.read()) print(sensors.uv.read()) print(sensors.humidity.read()) print(sensors.pressure.read()) time.sleep(5/1000)

GPIO

from matrix_lite import gpio # Read GPIO pin 0 (digital) gpio.setFunction(0, 'DIGITAL') gpio.setMode(0, 'input') print('Pin 0 is: ' + str(gpio.getDigital(0))) # Set GPIO pin 1 (digital) gpio.setFunction(1, 'DIGITAL') gpio.setMode(1, 'output') gpio.setDigital(1, 'ON') # Set GPIO pin 2 (PWM) gpio.setFunction(2, 'PWM') gpio.setMode(2, 'output') gpio.setPWM({ "pin": 2, "percentage": 25, "frequency": 50, # min 36 }) # Set Servo Angle pin 3 gpio.setFunction(3, 'PWM') gpio.setMode(3, 'output') gpio.setServoAngle({ "pin": 3, "angle": 90, # min_pulse_ms (minimum pulse width for a PWM wave in milliseconds) "min_pulse_ms": 0.8, })

Building Locally For Development

Make sure you have MATRIX HAL & Python 3 installed.

If you want to contribute to matrix-lite-py, below are the steps to build locally. Each step should take place on your Raspberry Pi.

Download the repository.

git clone https://github.com/matrix-io/matrix-lite-py 

Install pybind11.

sudo python3 -m pip install pybind11 

Compile and install the matrix_lite python package with your changes.

cd matrix-lite-py sudo python3 -m pip install ./