Skip to content

Commit 4087e5e

Browse files
committed
Renamed Slave to Peripheral mode.
1 parent ef1a7f7 commit 4087e5e

File tree

3 files changed

+15
-13
lines changed

3 files changed

+15
-13
lines changed

README.md

Lines changed: 12 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,7 @@ In order to get a head start with Inkplate 6, follow these steps:
1717
### Code examples
1818

1919
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.
2021

2122
1. **Basic Inkplate Functionality**
2223

@@ -38,35 +39,37 @@ There are many examples in the library that you demonstrate how to use any of th
3839

3940
2.4. Touchpads - get readings from onboard touch pads
4041

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
4243

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
4445

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
4647

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
4849

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
5053

5154
3. **Others**
5255

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
5457

5558
3.2. Screen Cleaning - clean the screen in case of image burn-in
5659

5760
### Using Inkplate 6 with another microcontroller
5861

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.
6063

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 here https://inkplate.readthedocs.io/en/latest/peripheral-mode.html.
6265

6366
### Battery power
6467

6568
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.
6669

6770
### Micropython
6871

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
7073

7174
### License
7275

examples/Others/Inkplate_Slave_Mode/Inkplate_Slave_Mode.ino renamed to examples/Others/Inkplate_Peripheral_Mode/Inkplate_Peripheral_Mode.ino

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
Inkplate_Slave_Mode sketch for e-radionica.com Inkplate 6
2+
Inkplate_Peripheral_Mode sketch for e-radionica.com Inkplate 6
33
Select "Inkplate 6(ESP32)" from Tools -> Board menu.
44
Don't have "Inkplate 6(ESP32)" option? Follow our tutorial and add it:
55
https://e-radionica.com/en/blog/add-inkplate-6-to-arduino-ide/
@@ -11,9 +11,9 @@
1111
Because it uses UART, it's little bit slower and it's not recommended to send bunch of
1212
drawPixel command to draw some image. Instead, load bitmaps and pictures on SD card and load image from SD.
1313
If we missed some function, you can modify this and make yor own.
14-
Also, every Inkplate comes with this slave mode right from the factory.
14+
Also, every Inkplate comes with this peripheral mode right from the factory.
1515
16-
Learn more about Slave Mode in this update:
16+
Learn more about Peripheral Mode in this update:
1717
https://www.crowdsupply.com/e-radionica/inkplate-6/updates/successfully-funded-also-third-party-master-controllers-and-partial-updates
1818
1919
UART settings are: 115200 baud, standard parity, ending with "\n\r" (both)

examples/Others/Inkplate_Slave_Mode/Inkplate_slave_mode_documentation.txt

Lines changed: 0 additions & 1 deletion
This file was deleted.

0 commit comments

Comments
 (0)