Skip to content

A high level library for interacting with the Pimoroni Blinkt.

License

Notifications You must be signed in to change notification settings

speratus/Blinkter

Repository files navigation

README

PyPI - Python Version Documentation Status GitHub release PyPI GitHub license codecov Build Status

Gitter Discord

Blinkter makes using the Pimoroni Blinkt! even easier by making the library object oriented and adding several convenience methods. The intuitive objects that Blinkter layers on top of the Blinkt! python library greatly improve ease of use and reduce development times.

Installation

Easy Way

pip install blinkter

Harder way

If you want to play around with the Blinkter code, the following steps will guide you through getting the repository and installing the library from your code.

  1. Make sure that setuptools is installed.
pip install setuptools
  1. Next, clone this repository with
git clone https://github.com/speratus/Blinkter.git
  1. Once the repository is downloaded, install it using this command:
python setup.py install

That's all there is to it. You should be ready to go in no time at all.

Installing into a virtual environment.

Installing Blinkter into a virtual environment is not much harder than a regular installation of Blinkter. Follow steps 1 and 2 as you normally would, but before executing step 3, make sure that your virtual environment is activated.

Linux

In linux (and Raspbian), the command is,

source <ENVIRONMENT_NAME>/bin/activate

Windows

On windows this is achieved using the command: NOTE: Blinkter will not run on Windows. It works exclusively on the Raspberry pi.

<ENVIRONMENT_NAME>\Scripts\activate

Doing this will ensure that Blinkter is installed into the appropriate environment.

Usage

import blinkter

board = blinkter.BlinktBoard()
pixel = board.get_pixel(0)  #Or whatever pixel you want to manipulate
pixel.red() #Or pixel.blue(), or whatever else you want.

Discussion

You can ask questions on the Discord Server or the Gitter chat room.

Links