You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+12-9Lines changed: 12 additions & 9 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -17,6 +17,7 @@ In order to get a head start with Inkplate 6, follow these steps:
17
17
### Code examples
18
18
19
19
There are many examples in the library that you demonstrate how to use any of the Inkplate functionality.
20
+
More are added daily, such as projects or community contributions, so here are just the basic ones.
20
21
21
22
1.**Basic Inkplate Functionality**
22
23
@@ -38,35 +39,37 @@ There are many examples in the library that you demonstrate how to use any of th
38
39
39
40
2.4. Touchpads - get readings from onboard touch pads
40
41
41
-
2.5. SD BMP Pictures - show .bmp images from the SD card on the screen
42
+
2.5. SD Pictures - show .bmp, .jpg and .png images from the SD card on the screen
42
43
43
-
2.6. Inkplate SD TXT File - read .txt file from the SD card and show it on the screen
44
+
2.6. Web Pictures - show .bmp, .jpg and .png images from the web
44
45
45
-
2.7. easyC - use easyC ecosystem (I2C) and read a sensor value
46
+
2.7. Inkplate SD TXT File - read .txt file from the SD card and show it on the screen
46
47
47
-
2.8. MCP23017 Expander - use onboard MCP23017 expander for your own external devices
48
+
2.8. easyC - use easyC ecosystem (I2C) and read a sensor value
48
49
49
-
2.9. Web Server - make Inkplate a web server
50
+
2.9. MCP23017 Expander - use onboard MCP23017 expander for your own external devices
51
+
52
+
2.10. Web Server - make Inkplate a web server
50
53
51
54
3.**Others**
52
55
53
-
3.1. Slave Mode - mode that enables control of the screen from any external device using UART
56
+
3.1. Peripheral Mode - mode that enables control of the screen from any external device using UART
54
57
55
58
3.2. Screen Cleaning - clean the screen in case of image burn-in
56
59
57
60
### Using Inkplate 6 with another microcontroller
58
61
59
-
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 "Slave Mode" (unpopular name right now, we are aware and will change) enables this. All brand new Inkplates come pre-programmed with slave mode and can be used right away.
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.
60
63
61
-
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 very basic documentation for using it [here](https://github.com/e-radionicacom/Inkplate-6-Arduino-library/blob/master/examples/4.%20Others/1-Inkplate_Slave_Mode/Inkplate_slave_mode_documentation.txt).
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 herehttps://inkplate.readthedocs.io/en/latest/peripheral-mode.html.
62
65
63
66
### Battery power
64
67
65
68
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.
66
69
67
70
### Micropython
68
71
69
-
If you are looking for micropython support, it is still work in progress - we are new with it! :) When it's ready, we will let you know with new project update.
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
0 commit comments