Skip to content

Commit 536e3de

Browse files
authored
Update README for Inkplate 6PLUS
1 parent db35ba3 commit 536e3de

File tree

1 file changed

+12
-46
lines changed

1 file changed

+12
-46
lines changed

README.md

Lines changed: 12 additions & 46 deletions
Original file line numberDiff line numberDiff line change
@@ -2,59 +2,25 @@
22

33
![](https://www.crowdsupply.com/img/cf95/compare-peripheral_jpg_project-body.jpg)
44

5-
Arduino library for all-in-one e-paper displays named Inkplate can be found in this repo. Inkplate is a series of powerful, Wi-Fi enabled ESP32-based e-paper display products. 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. Inkplate currently includes Inkplate 10 and Inkplate 6 - learn more about Inkplates on [official website](https://inkplate.io/).
6-
Inkplate 6 was crowdfunded on [Crowd Supply](https://www.crowdsupply.com/e-radionica/inkplate-6), as well as [Inkplate 10](https://www.crowdsupply.com/e-radionica/inkplate-10).
5+
Arduino library for all-in-one e-paper display family named Inkplate can be found in this repo. Inkplate is a series of powerful, Wi-Fi enabled ESP32-based e-paper display products. 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. Inkplate family currently includes Inkplate 10, Inkplate 6 and Inkplate 6PLUS - learn more about Inkplates on [official website](https://inkplate.io/).
6+
Inkplate 6 was crowdfunded on [Crowd Supply](https://www.crowdsupply.com/e-radionica/inkplate-6), as well as [Inkplate 10]([https://www.crowdsupply.com/e-radionica/inkplate-10). [Inkplate 6PLUS](https://www.crowdsupply.com/e-radionica/inkplate-6plus) is funding now.
77

8-
### Setting up Inkplate 6 in Arduino IDE
8+
### Setting up Inkplate in Arduino IDE
99

10-
In order to get a head start with Inkplate 6, follow these steps:
10+
In order to get a head start with Inkplate (any), follow these steps:
1111

12-
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/).
12+
1. [Install Inkplate board definition](https://github.com/e-radionicacom/Croduino-Board-Definitions-for-Arduino-IDE/blob/master/README.md) - add Inkplate 6/10/6PLUS 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/).
1313
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/)
14-
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?).
15-
4. You are ready to get started! Select Tools -> Board -> Inkplate 6, as well as correct COM port and upload!
14+
3. Install Inkplate 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?).
15+
4. You are ready to get started! Select Tools -> Board -> Inkplate (pick correct one), as well as correct COM port and upload!
1616

1717
### Code examples
1818

19-
There are many examples in the library that you demonstrate how to use any of the Inkplate functionality. Use Basic folder to get familiar with principles of using the Inkplate, such as modes (BW and Gray), how to write graphics and text. In Advanced folder, you'll learn how to make HTTP/HTTPS requests, utilise low power, use touchpads or SD card. Finally, get easily started on some projects. More are added daily, such as projects or community contributions.
19+
There are many examples in the library that you demonstrate how to use any of the Inkplate functionality. Use Basic folder to get familiar with principles of using the Inkplate, such as modes (BW and Gray), how to write graphics and text or just basic capabilites such as touchscreen or front lighting (if your Inkplate supports it). In Advanced folder, you'll learn how to make HTTP/HTTPS requests, utilise low power, use touchpads or SD card. Finally, get easily started on some projects. More are added regularly, such as projects or community contributions.
2020

2121
### Documentation
2222

23-
24-
Find Inkplate documentation [here](https://inkplate.readthedocs.io/en/latest/get-started.html).
25-
1.1. Basic BW - use the screen in BW mode (graphics & text)
26-
27-
1.2. Basic Gray - use the screen in gray mode (graphics & text)
28-
29-
1.3. Basic Partial Update - do a partial update of the screen on Inkplate 6
30-
31-
1.4. Basic Custom Fonts - add custom fonts and use them to write text on the screen
32-
33-
2. **Advanced Inkplate Functionality**
34-
35-
2.1. WiFi HTTP Request - make HTTP request while connected too WiFi
36-
37-
2.2. Low Power - put Inkplate in sleep in order to save battery
38-
39-
2.3. Battery Voltage And Temperature - measure battery voltage and temperature of the board
40-
41-
2.4. Touchpads - get readings from onboard touch pads
42-
43-
2.5. SD Pictures - show .bmp, .jpg and .png images from the SD card on the screen
44-
45-
2.6. Web Pictures - show .bmp, .jpg and .png images from the web
46-
47-
2.7. Inkplate SD TXT File - read .txt file from the SD card and show it on the screen
48-
49-
2.8. easyC - use easyC ecosystem (I2C) and read a sensor value
50-
51-
2.9. MCP23017 Expander - use onboard MCP23017 expander for your own external devices
52-
53-
2.10. Web Server - make Inkplate a web server
54-
55-
3. **Others**
56-
57-
3.1. Peripheral Mode - mode that enables control of the screen from any external device using UART
23+
Find Inkplate documentation [here](https://inkplate.readthedocs.io/en/latest/arduino.html).
5824

5925

6026
### Using Inkplate 6 with another microcontroller - Peripheral mode
@@ -79,7 +45,7 @@ apt install python-is-python3
7945

8046
### Micropython
8147

82-
If you are looking for micropython support, please find all details [here](https://github.com/e-radionicacom/Inkplate-6-micropython).
48+
If you are looking for micropython support, please find all details [here](https://github.com/e-radionicacom/Inkplate-micropython).
8349

8450
### License
8551

@@ -90,9 +56,9 @@ This repo uses the source code from another repositories. All their license file
9056
All of Inkplate-related development is open-sourced:
9157

9258
- [Arduino library](https://github.com/e-radionicacom/Inkplate-6-Arduino-library)
93-
- [Inkplate 6 hardware](https://github.com/e-radionicacom/Inkplate-6-hardware)
59+
- Hardware design: [Inkplate 6](https://github.com/e-radionicacom/Inkplate-6-hardware), [Inkplate 10](https://github.com/e-radionicacom/Inkplate-10-hardware)
9460
- [micropython Inkplate](https://github.com/e-radionicacom/Inkplate-6-micropython)
95-
- [OSHWA certificate](https://certification.oshwa.org/hr000003.html)
61+
- OSHWA cerfiticate: [Inkplate 6](https://certification.oshwa.org/hr000003.html), [Inkplate 10](https://certification.oshwa.org/hr000006.html)
9662

9763
### Where to buy & other
9864

0 commit comments

Comments
 (0)