Skip to content

Commit

Permalink
version bump
Browse files Browse the repository at this point in the history
added waveshare driver disclaimer
  • Loading branch information
robweber committed Nov 13, 2023
1 parent 78bfa95 commit ba8c946
Show file tree
Hide file tree
Showing 3 changed files with 9 additions and 4 deletions.
5 changes: 4 additions & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,16 +4,19 @@ All notable changes to this project will be documented in this file.

The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)

## Version Unreleased
## Version 0.4.0

### Added

- support for Raspberry Pi OS 12 (Bookworm) and Python 3.11 through some dependency fixes
- information regarding Python virtual environment usage
- disclaimer on status of official Waveshare repo support with Bookworm

### Changed

- updated IT8951 repo link to build from source with RPI dependencies
- Waveshare drivers now loaded from [forked repo](https://github.com/mendhak/waveshare-epaper-sample) to fix Bookworm Rpi detection
- `setup.cfg` information merged into `pyproject.toml`

## Version 0.3.5

Expand Down
6 changes: 4 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@

An EPD (electronic paper display) class abstraction to simplify communications across multiple display types.

There are several great EPD projects all over the internet, many in written in Python. The problem with a lot of these is that the code is often for one specific type of display, or perhaps a family of displays. This project abstracts the EPD communications into a common interface so a variety of displays can be interchangeably used in the same project. It also adds a lot of [helpful conveniences](#advanced-epd-control) such as the ability to automatically to rotate, add contrast, or dither images on their way to the display. This gives more control to end users without having to add extra features in your upstream project.
There are several great EPD projects all over the internet, many in written in Python. The problem with a lot of these is that the code is often for one specific type of display, or perhaps a family of displays. This project abstracts the EPD communications into a common interface so a variety of displays can be interchangeably used in the same project. It also adds a lot of [helpful conveniences](#advanced-epd-control) such as the ability to automatically rotate, add contrast, or dither images on their way to the display. This gives more control to end users without having to add extra features in your upstream project.

For EPD project builders this expands the number of displays you can use for your project without having to code around each one. To utilize this in your project read the usage instructions. For a list of (known) projects that use this abstraction see the [list below](#displays-implmented).

Expand Down Expand Up @@ -206,7 +206,9 @@ If installing Inky manually be sure that SPI and I2C are enabled via `sudo raspi

__Waveshare__

The [Waveshare device library](https://github.com/waveshareteam/e-Paper) requires that [SPI support](https://www.raspberrypi-spy.co.uk/2014/08/enabling-the-spi-interface-on-the-raspberry-pi/) be enabled on your system prior to use. The `waveshare-epd` module is automatically downloaded and installed as a dependency of this module.
The [Waveshare device library](https://github.com/waveshareteam/e-Paper) requires that [SPI support](https://www.raspberrypi-spy.co.uk/2014/08/enabling-the-spi-interface-on-the-raspberry-pi/) be enabled on your system prior to use. The `waveshare-epd` module is automatically downloaded and installed as a dependency of this module.

__Please note:__ The version of the Waveshare repo used by this library is a [fork](https://github.com/mendhak/waveshare-epaper-sample) of the official repository. This is due to the official repo not having [correct detection support](https://github.com/waveshareteam/e-Paper/pull/307/) for Raspberry Pi OS 12 (Bookworm). Once the official repo is updated the source for the Waveshare drivers will be moved back to the official repo.

__IT8951__

Expand Down
2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ build-backend = "setuptools.build_meta"

[project]
name = "omni_epd"
version = "0.3.6b1"
version = "0.4.0"
requires-python = ">=3.7"
authors = [
{name = "Rob Weber", email = "[email protected]"}
Expand Down

0 comments on commit ba8c946

Please sign in to comment.