dot3k 1.8.1

# dot3k

## Hardware Requirements

You'll need to enable spi.

```bash
sudo raspi-config
```

Then head into `Advanced Options -> SPI -> Yes`.

And i2c.

```bash
sudo nano /etc/modprobe.d/raspi-blacklist.conf
```

And comment out (place a `#` before):

```
blacklist i2c-bcm2708
```

And also:

```bash
sudo nano /etc/modules
```

Add the line:

```
i2c-dev
```

Reboot to make these changes take effect:

```bash
sudo reboot
```

## Software Requirements

Next you should install python-smbus and python-dev via apt:

```bash
sudo apt-get install python-smbus python-dev
```

And pip, if you don't have it:

```bash
sudo apt-get install python-pip
```

Then install st7036 and sn3218 using pip:

```bash
sudo pip install st7036 sn3218
```

You can run the `requirements.sh` file to do this for you!

## Usage

### LCD

```python
from dot3k import lcd
lcd.write('Hello World!')
```

### Backlight

```python
from dot3k import backlight
backlight.sweep(0.5)
backlight.update()
```

### Joystick

```python
from dot3k import joystick
@joystick.on(joystick.UP)
def handle_joystick_up(pin):
print("Joystick up!")
```
Changelog
---------

1.8.1
-----

* Backlight now has off() method shortcut for turning lights off
* Added a use_brg() method for old Dot3ks with different pixel order

1.8.0
-----

* Significant, possibly breaking, change to __init__.py to remove redundant imports
* lcd and joystick should work with Python 3, backlight still requires smbus

1.7.1
-----

* Sane defaults for write_option(), now no longer defauts to 1 margin and blank icon

1.7
---

* Added input handling plugin support
* Remapped parameters to args/kwargs to make menu initialisation less mystifying

1.6.1
-----

* Fixed bug in set_bar which cased the left blue backlight to light

1.6
---

* Added support for an "idle" plugin which shows after a customisable amount of seconds

1.5
---

* Fixed joystick repeat using delta timing instead of delays

1.4
---

* Bugfix of menu.py line-endings
* Attempt to fix joystick.repeat to prevent multiple repeats firing at once

1.3
---

* Removed plugins from dot3k.menu into examples/plugins folder

1.2
---

* Breaking changes with plugin compatibility vs version 1.1
* Many fixes to redraw calls
* Plugin redraw method is now passed the "menu" instance

1.1
---

* Fix for joystick on Rev 1 Pi

1.0dev
------

* Initial Release