Skip to content

Commit

Permalink
Re-order Readme
Browse files Browse the repository at this point in the history
  • Loading branch information
vroland authored Jan 15, 2021
1 parent 65aee01 commit 9f49923
Showing 1 changed file with 28 additions and 27 deletions.
55 changes: 28 additions & 27 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,34 @@ EPDiy is a driver board which talks to affordable E-Paper (or E-Ink) screens, wh

Ready-made DIY modules for this size and with 4bpp (16 Grayscale) color support are currently quite expensive. This project uses Kindle replacement screens, which are available for 20$ (small) / 30$ (large) on ebay!

The EPDiy driver board targets multiple E-Paper displays. As the driving method for all matrix-based E-ink displays seems to be more or less the same, only the right connector and timings are needed. The EPDiy PCB features a 33pin and a 39pin connector, which allow to drive the following display types: ED097OC4, ED060SC4, ED097TC2
The EPDiy driver board targets multiple E-Paper displays. As the driving method for all matrix-based E-ink displays seems to be more or less the same, only the right connector and timings are needed. The EPDiy PCB v4 features a 33pin and a 39pin connector, which allow to drive the following display types: ED097OC4, ED060SC4, ED097TC2. With the upcoming revision v5, even more display types will be supported! For details, refer to the table below.


Building It
-----------

If you want to build a board right now, there are two possible routes:
- Use the new v2 PCB (`hardware/epaper-breakout/gerbers_v4.zip`). This is a bit more fresh, but should work.
The BOM is available at (`hardware/epaper-breakout/BOM.csv`).
Positioning files for SMT assembly are available at (`hardware/epaper-breakout/gerbers/epaper-breakout-top-pos.csv`).
Please double check the part positioning and Rotation with your assembly service!

Make sure to select the `V4` board revision in `idf.py menuconfig` when building the examples.
- Use the original v2 PCB (`hardware/epaper-breakout/gerbers_v2_rev0.zip`).
However, you might run into issue #3 with some selections of parts.

Make sure to select the `v2/v3` board revision in `idf.py menuconfig` when building the examples.

Gettings Started
----------------

For instructions and more information visit the [documentation](https://epdiy.readthedocs.io/en/latest/getting_started.html)!

Join the Discussion
----------------

- [![Matrix](https://img.shields.io/matrix/epdiy-general:matrix.vroland.de?label=Join%20Matrix)](https://matrix.to/#/!GUXWriqsBKkWyXzsBK:matrix.vroland.de?via=matrix.vroland.de) Matrix Community: +epdiy:matrix.vroland.de
- [![JoinSlack](https://img.shields.io/badge/Join%20us-on%20Slack-blueviolet.svg)](https://join.slack.com/t/epdiy/shared_invite/zt-kx2yqjxg-BSlEOBC_QN7IKI5RYlrXkA)

Displays
--------
Expand Down Expand Up @@ -43,32 +70,6 @@ Displays

**Please note that board revision v5 is still in prototype stage!**

Building It
-----------

If you want to build a board right now, there are two possible routes:
- Use the new v2 PCB (`hardware/epaper-breakout/gerbers_v4.zip`). This is a bit more fresh, but should work.
The BOM is available at (`hardware/epaper-breakout/BOM.csv`).
Positioning files for SMT assembly are available at (`hardware/epaper-breakout/gerbers/epaper-breakout-top-pos.csv`).
Please double check the part positioning and Rotation with your assembly service!

Make sure to select the `V4` board revision in `idf.py menuconfig` when building the examples.
- Use the original v2 PCB (`hardware/epaper-breakout/gerbers_v2_rev0.zip`).
However, you might run into issue #3 with some selections of parts.

Make sure to select the `v2/v3` board revision in `idf.py menuconfig` when building the examples.

Gettings Started
----------------

For instructions and more information visit the [documentation](https://epdiy.readthedocs.io/en/latest/getting_started.html)!

Join discussion on EPDiy Slack channel
----------------

[![Matrix](https://img.shields.io/matrix/epdiy-general:matrix.vroland.de?label=Join%20Matrix)](https://matrix.to/#/!GUXWriqsBKkWyXzsBK:matrix.vroland.de?via=matrix.vroland.de) Matrix Community: +epdiy:matrix.vroland.de
[![JoinSlack](https://img.shields.io/badge/Join%20us-on%20Slack-blueviolet.svg)](https://join.slack.com/t/epdiy/shared_invite/zt-kx2yqjxg-BSlEOBC_QN7IKI5RYlrXkA)

Troubleshooting
---------------

Expand Down

0 comments on commit 9f49923

Please sign in to comment.