Skip to content

Commit 6cc00d4

Browse files
authored
Merge branch 'master' into revision
2 parents 9e06e35 + ff4ad5a commit 6cc00d4

File tree

1 file changed

+8
-8
lines changed

1 file changed

+8
-8
lines changed

README.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
![](https://www.crowdsupply.com/img/040a/inkplate-6-angle-01_png_project-main.jpg)
44

5-
Arduino library for all-in-one e-paper display Inkplate 6 can be found in this repo. Inkplate 6 is a powerful, Wi-Fi enabled ESP32 based six-inch e-paper display – recycled from a Kindle e-reader. Its main feature is simplicity. Just plug in a USB cable, open Arduino IDE, and change the contents of the screen with few lines of code. Learn more about Inkplate 6 on [Crowd Supply](https://www.crowdsupply.com/e-radionica/inkplate-6).
5+
Arduino library for all-in-one e-paper display Inkplate 6 can be found in this repo. Inkplate 6 is a powerful, Wi-Fi enabled ESP32 based six-inch e-paper display – recycled from a Kindle e-reader. Its main feature is simplicity. Just plug in a USB cable, open Arduino IDE, and change the contents of the screen with few lines of code. Learn more about Inkplate 6 on [official website](https://inkplate.io/). Inkplate was crowdfunded on [Crowd Supply](https://www.crowdsupply.com/e-radionica/inkplate-6).
66

77
### Setting up Inkplate 6 in Arduino IDE
88

@@ -11,8 +11,7 @@ In order to get a head start with Inkplate 6, follow these steps:
1111
1. [Install Inkplate 6 board definition](https://e-radionica.com/en/blog/add-inkplate-6-to-arduino-ide/) - add Inkplate 6 as a board into your Arduino IDE. Follow the instructions on the [link](https://e-radionica.com/en/blog/add-inkplate-6-to-arduino-ide/).
1212
2. Install CH340 drivers (if you don't have them yet) - instructions [here](https://e-radionica.com/en/blog/ch340-driver-installation-croduino-basic3-nova2/)
1313
3. Install Inkplate 6 Arduino library - install the library from this repo into your Arduino IDE. If you don't know how, check our [tutorial](https://e-radionica.com/en/blog/arduino-library/#Kako%20instaliraty%20library?).
14-
4. Install [custom SdFat library](https://github.com/e-radionicacom/Inkplate-6-SDFat-Arduino-Library) into your Arduino IDE.
15-
5. You are ready to get started! Select Tools -> Board -> Inkplate 6, as well as correct COM port and upload!
14+
4. You are ready to get started! Select Tools -> Board -> Inkplate 6, as well as correct COM port and upload!
1615

1716
### Code examples
1817

@@ -57,23 +56,23 @@ More are added daily, such as projects or community contributions, so here are j
5756

5857
3.2. Screen Cleaning - clean the screen in case of image burn-in
5958

60-
### Using Inkplate 6 with another microcontroller
59+
### Using Inkplate 6 with another microcontroller - Peripheral mode
6160

62-
As promised in an [early update](https://www.crowdsupply.com/e-radionica/inkplate-6/updates/successfully-funded-also-third-party-master-controllers-and-partial-updates), Inkplate 6's screen contents can be updated using 3rd controller (such as Raspberry Pi or another microcontroller). The "Peripheral Mode" (unpopular name right now, we are aware and will change) enables this. All brand new Inkplates come pre-programmed with peripheral mode and can be used right away.
61+
As promised in an [early update](https://www.crowdsupply.com/e-radionica/inkplate-6/updates/successfully-funded-also-third-party-master-controllers-and-partial-updates), Inkplate 6's screen contents can be updated using 3rd controller (such as Raspberry Pi or another microcontroller). The Peripheral mode enables this. All brand new Inkplates come pre-programmed with slave mode and can be used right away.
6362

64-
It is based on UART (serial) communication - connect the Inkplate to "master" board either via USB cable or directly via ESP32 RX and TX pins. Using standard UART at 115200 baud, you can send commands to change screen contents. For example, send \*#H(000,000,"/img.bmp")\*\* to show image img.bmp from SD card on the screen. Find documentation, see our readthedocs page here https://inkplate.readthedocs.io/en/latest/peripheral-mode.html.
63+
It is based on UART (serial) communication - connect the Inkplate to "Controller" ("Master", if using old terminology) board either via USB cable or directly via ESP32 RX and TX pins. Using standard UART at 115200 baud, you can send commands to change screen contents. For example, send \*#H(000,000,"/img.bmp")\*\* to show image img.bmp from SD card on the screen. Find very documentation for using it [here](https://inkplate.readthedocs.io/en/latest/slave-mode.html).
6564

6665
### Battery power
6766

6867
Inkplate 6 has two options for powering it. First one is obvious - USB port at side of the board. Just plug any micro USB cable and you are good to go. Second option is battery. Supported batteries are standard Li-Ion/Li-Poly batteries with 3.7V nominal voltage. Connector for the battery is standard 2.00mm pitch JST connector. The onboard charger will charge the battery with 500mA when USB is plugged at the same time. You can use battery of any size or capacity if you don't have a enclosure. If you are using our enclosure, battery size shouldn't exceed 90mm x 40mm (3.5 x 1.57 inch) and 5mm (0.19 inch) in height. [This battery](https://e-radionica.com/en/li-ion-baterija-1200mah.html) is good fit for the Inkplate.
6968

7069
### Micropython
7170

72-
If you are looking for micropython support, see our docs showing how to set it up here: https://inkplate.readthedocs.io/en/latest/get-started.html#micropython
71+
If you are looking for micropython support, please find all details [here](https://github.com/e-radionicacom/Inkplate-6-micropython).
7372

7473
### License
7574

76-
This repo uses the source code from Adafruit libraries: [MCP23017](https://github.com/adafruit/Adafruit-MCP23017-Arduino-Library), [Adafruit GFX](https://github.com/adafruit/Adafruit-GFX-Library).
75+
This repo uses the source code from another repositories. All their license files are located in "licences" folder.
7776

7877
### Where to buy & other
7978

@@ -83,6 +82,7 @@ Inkplate 6 is available for purchase via:
8382
- [Crowd Supply](https://www.crowdsupply.com/e-radionica/inkplate-6)
8483
- [Mouser](https://hr.mouser.com/Search/Refine?Keyword=inkplate)
8584
- [Sparkfun](https://www.sparkfun.com/search/results?term=inkplate)
85+
- [Pimoroni](https://shop.pimoroni.com/products/inkplate-6)
8686

8787
Inkplate 6 is open-source. If you are looking for hardware design of the board, check the [Hardware repo](https://github.com/e-radionicacom/Inkplate-6-hardware). You will find 3D printable [enclosure](https://github.com/e-radionicacom/Inkplate-6-hardware/tree/master/3D%20printable%20case) there, as well as [detailed dimensions](https://github.com/e-radionicacom/Inkplate-6-hardware/tree/master/Technical%20drawings). In this repo you will find code for driving the ED060SC7 e-paper display used by Inkplate.
8888

0 commit comments

Comments
 (0)