From d192996896afa688654c25f5407bd1374521dd86 Mon Sep 17 00:00:00 2001 From: David Zovko Date: Wed, 15 Jul 2020 16:31:45 +0200 Subject: [PATCH 1/5] Update README.md --- README.md | 20 +++++++++++++++++--- 1 file changed, 17 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 02a2e5b..09ba885 100644 --- a/README.md +++ b/README.md @@ -2,8 +2,22 @@ ![](https://www.crowdsupply.com/img/040a/inkplate-6-angle-01_png_project-main.jpg) -Arduino library for e-paper display Inkplate 6 can be found in this repo. The library is still work-in-progress. +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). -Inkplate 6 is currently available via [Crowd Supply](https://www.crowdsupply.com/e-radionica/inkplate-6). +#### Setting up Inkplate 6 in Arduino IDE +In order to get a head start with Inkplate 6, follow these steps: +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/). +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/) +3. Install Inkplate 6 Arduino library - install 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?). +4. You are ready to get started! Select Tools -> Board -> Inkplate 6, as well as correct COM port and upload! -Documentation License: CC BY-SA 4.0 International. +Extra: if you are planning to use the SD card funcionality, install [custom SdFat library](https://github.com/e-radionicacom/Inkplate-6-SDFat-Arduino-Library) into your Arduino IDE. +#### Misc +Inkplate 6 is available for purchase via: +- [Crowd Supply](https://www.crowdsupply.com/e-radionica/inkplate-6) +- more distributors coming soon (e-radionica.com, Mouser, etc) + +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. + +For all questions and issues, please open an issue or thread on [our forums](http://forum.e-radionica.com/en/). +For sales & collaboration, please reach us via [e-mail](mailto:kontakt@e-radionica.com). From b9891ff477bd677faea3e2d0d8de44c5ffc89b86 Mon Sep 17 00:00:00 2001 From: David Zovko Date: Wed, 15 Jul 2020 23:10:47 +0200 Subject: [PATCH 2/5] Update README.md --- README.md | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 09ba885..1941cfc 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,4 @@ + # Inkplate 6 Arduino library ![](https://www.crowdsupply.com/img/040a/inkplate-6-angle-01_png_project-main.jpg) @@ -8,14 +9,14 @@ Arduino library for all-in-one e-paper display Inkplate 6 can be found in this r In order to get a head start with Inkplate 6, follow these steps: 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/). 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/) -3. Install Inkplate 6 Arduino library - install 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?). +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?). 4. You are ready to get started! Select Tools -> Board -> Inkplate 6, as well as correct COM port and upload! -Extra: if you are planning to use the SD card funcionality, install [custom SdFat library](https://github.com/e-radionicacom/Inkplate-6-SDFat-Arduino-Library) into your Arduino IDE. +Optional: if you are planning to use the SD card funcionality, install [custom SdFat library](https://github.com/e-radionicacom/Inkplate-6-SDFat-Arduino-Library) into your Arduino IDE. #### Misc Inkplate 6 is available for purchase via: - [Crowd Supply](https://www.crowdsupply.com/e-radionica/inkplate-6) -- more distributors coming soon (e-radionica.com, Mouser, etc) +- [Mouser](https://hr.mouser.com/Search/Refine?Keyword=inkplate) 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. From aca0d461c7c449a7e8e8b671cefc7c867727f23a Mon Sep 17 00:00:00 2001 From: David Zovko Date: Wed, 15 Jul 2020 23:23:48 +0200 Subject: [PATCH 3/5] Update README.md --- README.md | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) diff --git a/README.md b/README.md index 1941cfc..cf0048a 100644 --- a/README.md +++ b/README.md @@ -13,6 +13,27 @@ In order to get a head start with Inkplate 6, follow these steps: 4. You are ready to get started! Select Tools -> Board -> Inkplate 6, as well as correct COM port and upload! Optional: if you are planning to use the SD card funcionality, install [custom SdFat library](https://github.com/e-radionicacom/Inkplate-6-SDFat-Arduino-Library) into your Arduino IDE. + +#### Code examples +There are many examples in the library that you demonstrate how to use any of the Inkplate functionality. +1. Basic Inkplate Functionality +1.1. Basic Monochrome - use the screen in monochrome mode (graphics & text) +1.2. Basic Grayscale - use the screen in grayscale mode (graphics & text) +1.3. Basic Partial Update - do a partial update of the screen on Inkplate 6 +1.4. Basic Custom Fonts - add custom fonts and use them to write text on the screen +2. Advanced Inkplate Functionality +2.1. WiFi HTTP Request - make HTTP request while connected too WiFi +2.2. Low Power - put Inkplate in sleep in order to save battery +2.3. Battery Voltage And Temperature - measure battery voltage and temperature of the board +2.4. Touchpads - get readings from onboard touch pads +2.5. SD BMP Pictures - show .bmp images from the SD card on the screen +2.6. Inkplate SD TXT File - read .txt file from the SD card and show it on the screen +2.7. easyC - use easyC ecosystem (I2C) and read a sensor value +2.8. MCP23017 Expander - use onboard MCP23017 expander for your own external devices +2.9. Web Server - make Inkplate a web server +3. Others +3.1. Slave Mode - mode that enables control of the screen from any external device using UART + #### Misc Inkplate 6 is available for purchase via: - [Crowd Supply](https://www.crowdsupply.com/e-radionica/inkplate-6) From 15863b809c4c0232c9f1242488ff17f58ad08d3e Mon Sep 17 00:00:00 2001 From: David Zovko Date: Wed, 15 Jul 2020 23:30:01 +0200 Subject: [PATCH 4/5] Update README.md --- README.md | 51 ++++++++++++++++++++++++++++++++++----------------- 1 file changed, 34 insertions(+), 17 deletions(-) diff --git a/README.md b/README.md index cf0048a..33669d1 100644 --- a/README.md +++ b/README.md @@ -16,23 +16,40 @@ Optional: if you are planning to use the SD card funcionality, install [custom #### Code examples There are many examples in the library that you demonstrate how to use any of the Inkplate functionality. -1. Basic Inkplate Functionality -1.1. Basic Monochrome - use the screen in monochrome mode (graphics & text) -1.2. Basic Grayscale - use the screen in grayscale mode (graphics & text) -1.3. Basic Partial Update - do a partial update of the screen on Inkplate 6 -1.4. Basic Custom Fonts - add custom fonts and use them to write text on the screen -2. Advanced Inkplate Functionality -2.1. WiFi HTTP Request - make HTTP request while connected too WiFi -2.2. Low Power - put Inkplate in sleep in order to save battery -2.3. Battery Voltage And Temperature - measure battery voltage and temperature of the board -2.4. Touchpads - get readings from onboard touch pads -2.5. SD BMP Pictures - show .bmp images from the SD card on the screen -2.6. Inkplate SD TXT File - read .txt file from the SD card and show it on the screen -2.7. easyC - use easyC ecosystem (I2C) and read a sensor value -2.8. MCP23017 Expander - use onboard MCP23017 expander for your own external devices -2.9. Web Server - make Inkplate a web server -3. Others -3.1. Slave Mode - mode that enables control of the screen from any external device using UART + +1. **Basic Inkplate Functionality** + + 1.1. Basic Monochrome - use the screen in monochrome mode (graphics & text) + + 1.2. Basic Grayscale - use the screen in grayscale mode (graphics & text) + + 1.3. Basic Partial Update - do a partial update of the screen on Inkplate 6 + + 1.4. Basic Custom Fonts - add custom fonts and use them to write text on the screen + +2. **Advanced Inkplate Functionality** + + 2.1. WiFi HTTP Request - make HTTP request while connected too WiFi + + 2.2. Low Power - put Inkplate in sleep in order to save battery + + 2.3. Battery Voltage And Temperature - measure battery voltage and temperature of the board + + 2.4. Touchpads - get readings from onboard touch pads + + 2.5. SD BMP Pictures - show .bmp images from the SD card on the screen + + 2.6. Inkplate SD TXT File - read .txt file from the SD card and show it on the screen + + 2.7. easyC - use easyC ecosystem (I2C) and read a sensor value + + 2.8. MCP23017 Expander - use onboard MCP23017 expander for your own external devices + + 2.9. Web Server - make Inkplate a web server + +3. **Others** + + 3.1. Slave Mode - mode that enables control of the screen from any external device using UART #### Misc Inkplate 6 is available for purchase via: From 9782a33570fb2eb0f25a6127c77a233ed7ccc47f Mon Sep 17 00:00:00 2001 From: David Zovko Date: Thu, 16 Jul 2020 00:17:47 +0200 Subject: [PATCH 5/5] Update README.md --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 33669d1..50c557b 100644 --- a/README.md +++ b/README.md @@ -5,7 +5,7 @@ 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). -#### Setting up Inkplate 6 in Arduino IDE +### Setting up Inkplate 6 in Arduino IDE In order to get a head start with Inkplate 6, follow these steps: 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/). 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,7 +14,7 @@ In order to get a head start with Inkplate 6, follow these steps: Optional: if you are planning to use the SD card funcionality, install [custom SdFat library](https://github.com/e-radionicacom/Inkplate-6-SDFat-Arduino-Library) into your Arduino IDE. -#### Code examples +### Code examples There are many examples in the library that you demonstrate how to use any of the Inkplate functionality. 1. **Basic Inkplate Functionality** @@ -51,7 +51,7 @@ There are many examples in the library that you demonstrate how to use any of th 3.1. Slave Mode - mode that enables control of the screen from any external device using UART -#### Misc +### Misc Inkplate 6 is available for purchase via: - [Crowd Supply](https://www.crowdsupply.com/e-radionica/inkplate-6) - [Mouser](https://hr.mouser.com/Search/Refine?Keyword=inkplate)