diff --git a/bak/API_Documents/PowerMode/Class PMClass.rst b/bak/API_Documents/PowerMode/Class PMClass.rst deleted file mode 100644 index fa6a387..0000000 --- a/bak/API_Documents/PowerMode/Class PMClass.rst +++ /dev/null @@ -1,103 +0,0 @@ -**PMClass Class** - -| **Description** -| A class used for PowerMode control. - -**Syntax** - -class PMClass - -**Members** - -+-----------------------------------+-----------------------------------+ -| **Public Constructors** | | -+===================================+===================================+ -| PMClass::PMClass | Constructs an PMClass object. | -+-----------------------------------+-----------------------------------+ -| | | -+-----------------------------------+-----------------------------------+ -| **Public Methods** | | -+-----------------------------------+-----------------------------------+ -| PMClass::begin | Initializes the PowerMode | -| | settings for device, include type | -| | of the mode, wake up sources and | -| | related source settings. | -+-----------------------------------+-----------------------------------+ -| PMClass::start | Start the PowerMode of device. | -+-----------------------------------+-----------------------------------+ - - -**PMClass::begin** - -| **Description** -| Initializes the PowerMode settings for device, include type of the - mode, wake up sources and related source settings. - -| **Syntax** -| void begin(uint32_t sleep_mode, int wakeup_source, uint32_t - wakeup_setting = 0); - -| **Parameters** -| sleep_mode: Power Mode selection. Deepsleep mode: DEEPSLEEP_MODE; - Standby mode: STANDBY_MODE - -wakeup_source: Wake up source selection. AON timer, AON GPIO, RTC, PON -GPIO, UART/Serial1, and Gtimer0 set by 0 to 5. - -wakeup_setting: Settings for different wakeup sources and default is 0. - -For AON time, it is a pointer to an array that stores clock(1:4MHz; -0:100kHz) and duration(by seconds). - -For AON GPIO, it is pin number 21 or 22. - -For RTC, it is a pointer to an array that stores time duration as day, -hour, min and sec(0, 0:0:0, to 365, 23:59:59). - -For PON GPIO, it is pin number 0 to 11. - -For Gtimer0, it is time duration in seconds. (start from 1s) - -| **Returns** -| NA - -| **Example Code** -| Example: DeepSleepMode, StandbyMode - -| **Notes and Warnings** -| “PowerMode.h” must be included to use the class function.\ ** - -**PMClass::start** - -| **Description** -| Start the PowerMode of device. - -| **Syntax** -| void start(void); - -void start(int year, int month, int day, int hour, int min, int sec); - -| **Parameters** -| Optional when wake up source is RTC. Default start time is 1970.1.1 - 00:00:00. - -year: Start time by year. Starts from 1900. - -month: Start time by month. 0 to 11. - -day: Start time by day. 1 to 365. - -hour: Start time by hour. 0 to 23. - -min: Start time by min. 0 to 59. - -sec: Start time by sec. 0 to 59. - -| **Returns** -| NA - -| **Example Code** -| Example: DeepSleepMode, StandbyMode - -| **Notes and Warnings** -| “PowerMode.h” must be included to use the class function. diff --git a/bak/API_Documents/RTC/Class RTCClass.rst b/bak/API_Documents/RTC/Class RTCClass.rst deleted file mode 100644 index 0aa6f40..0000000 --- a/bak/API_Documents/RTC/Class RTCClass.rst +++ /dev/null @@ -1,231 +0,0 @@ -**RTCClass Class** - -| **Description** -| A class used for initializing, starting, stopping, and setting alarm - with RTC. - -**Syntax** - -class WDT - -**Members** - -+-----------------------------------+-----------------------------------+ -| **Public Constructors** | | -+===================================+===================================+ -| RTCClass:: RTCClass | Constructs an RTC object. | -+-----------------------------------+-----------------------------------+ -| | | -+-----------------------------------+-----------------------------------+ -| **Public Methods** | | -+-----------------------------------+-----------------------------------+ -| RTCClass::Init | Initializes the RTC device, | -| | include clock, RTC registers and | -| | function. | -+-----------------------------------+-----------------------------------+ -| RTCClass::DeInit | Deinitializes the RTC device. | -+-----------------------------------+-----------------------------------+ -| RTCClass::Write | Set the specified timestamp in | -| | seconds to RTC. | -+-----------------------------------+-----------------------------------+ -| RTCClass::Read | Get current timestamp in seconds | -| | from RTC. | -+-----------------------------------+-----------------------------------+ -| RTCClass::Wait | Wait for seconds. A delay | -| | function. | -+-----------------------------------+-----------------------------------+ -| RTCClass::SetEpoch | Convert human readable time to | -| | epoch time. | -+-----------------------------------+-----------------------------------+ -| RTCClass::EnableAlarm | Enable the RTC alarm. | -+-----------------------------------+-----------------------------------+ -| RTCClass::DisableAlarm | Disable the RTC alarm. | -+-----------------------------------+-----------------------------------+ - - -**RTCClass::Init** - -| **Description** -| Initializes the RTC device, include clock, RTC registers and function. - -**Syntax** - -void Init(void); - -| **Parameters** -| NA - -| **Returns** -| NA - -| **Example Code** -| Example: Simple_RTC, Simple_RTC_Alarm - -| **Notes and Warnings** -| “rtc.h” must be included to use the class function.\ ** - -**RTCClass::DeInit** - -| **Description** -| Deinitializes the RTC device. - -| **Syntax** -| void DeInit(void); - -| **Parameters** -| NA - -| **Returns** -| NA - -| **Example Code** -| Example: Simple_RTC, Simple_RTC_Alarm - -| **Notes and Warnings** -| “rtc.h” must be included to use the class function.\ ** - -**RTCClass::Write** - -| **Description** -| Set the specified timestamp in seconds to RTC. - -| **Syntax** -| void Write(long long t); - -| **Parameters** -| t: Seconds from 1970.1.1 00:00:00 to specified data and time which is - to be set. - -| **Returns** -| NA - -| **Example Code** -| Example: Simple_RTC, Simple_RTC_Alarm - -| **Notes and Warnings** -| “rtc.h” must be included to use the class function.\ ** - -**RTCClass::Read** - -| **Description** -| Get current timestamp in seconds from RTC. - -| **Syntax** -| long long Read(void); - -| **Parameters** -| NA - -| **Returns** -| The current timestamp in seconds which is calculated from 1970.1.1 - 00:00:00. - -| **Example Code** -| Example: Simple_RTC, Simple_RTC_Alarm - -| **Notes and Warnings** -| “rtc.h” must be included to use the class function.\ ** - -**RTCClass::Wait** - -| **Description** -| Wait for seconds. A delay function. - -**Syntax** - -void Wait(int s); - -| **Parameters** -| s: delay time in seconds. - -| **Returns** -| NA - -| **Example Code** -| Example: Simple_RTC, Simple_RTC_Alarm - -| **Notes and Warnings** -| “rtc.h” must be included to use the class function. - -**RTCClass::SetEpoch** - -| **Description** -| Convert human readable time to epoch time. - -**Syntax** - -long long SetEpoch(int year, int month, int day, int hour, int min, int -sec); - -| **Parameters** -| year: Input time in year. Start from 1900. - -month: Input time in month. 0 to 11 - -day: Input time unit in day. 1 to 31. - -hour: Input time unit in hour. 0 to 23. - -min: Input time unit in min. 0 to 59. - -sec: Input time unit in sec. 0 to 59. - -| **Returns** -| The epoch time of the input date. - -| **Example Code** -| Example: Simple_RTC, Simple_RTC_Alarm - -| **Notes and Warnings** -| “rtc.h” must be included to use the class function. - -**RTCClass::EnableAlarm** - -| **Description** -| Enable the RTC alarm. - -**Syntax** - -void EnableAlarm(int day, int hour, int min, int sec, void -(\*rtc_handler)(void)); - -| **Parameters** -| day: Alarm time unit in day. 1 to 31. - -hour: Alarm time unit in hour. 0 to 23. - -min: Alarm time unit in min. 0 to 59. - -sec: Alarm time unit in sec. 0 to 59. - -rtc_handler: the callback function for rtc alarm interrupt. - -| **Returns** -| NA - -| **Example Code** -| Example: Simple_RTC, Simple_RTC_Alarm - -| **Notes and Warnings** -| “rtc.h” must be included to use the class function. - -**RTCClass::DisableAlarm** - -| **Description** -| Disable the RTC alarm. - -**Syntax** - -void DisableAlarm(void); - -| **Parameters** -| NA - -| **Returns** -| NA - -| **Example Code** -| Example: Simple_RTC, Simple_RTC_Alarm - -| **Notes and Warnings** -| “rtc.h” must be included to use the class function. diff --git a/bak/Example_Guides/E-Paper - 7.5-inch e-Book with MicroSD card/E-Paper - 7.5-inch e-Book with MicroSD card.rst b/bak/Example_Guides/E-Paper - 7.5-inch e-Book with MicroSD card/E-Paper - 7.5-inch e-Book with MicroSD card.rst deleted file mode 100644 index 87b69a9..0000000 --- a/bak/Example_Guides/E-Paper - 7.5-inch e-Book with MicroSD card/E-Paper - 7.5-inch e-Book with MicroSD card.rst +++ /dev/null @@ -1,129 +0,0 @@ -Materials - -- AmebaPro2 [AMB82 MINI] x 1 - -- Waveshare E-Paper [7.5-inch E-Ink display HAT] x1 - -- Button x 1 - -- MicroSD card x 1 - -- 330 Ohm resistor x1 - -Introduction - -In this example, we will be connecting Ameba Pro2 board to Waveshare -7.5-inch e-Paper module to be used as an e-Book. The 7.5” active area -contains 800 x 480 pixels and has 1-bit white/black full display -capabilities. An integrated circuit contains gate buffer, source buffer, -interface, timing control logic, oscillator, etc. are supplied with each -panel. You may refer to [7.5inch-e-paper-specification] -(https://www.waveshare.com/w/upload/6/60/7.5inch_e-Paper_V2_Specification.pdf) -for more information about this e-Paper module. - -Procedure - -**AMB82-Mini wiring diagram:** - -Do note that Display Config should be set to B and Interface Config -should be set to 0. - -|image1| - -|image2| - -| Next, download the Eink zip library, AmebaEink.zip, - at https://github.com/ambiot/ambpro2_arduino/tree/dev/Arduino_zip_libraries -| Then install the AmebaEink.zip by navigating to “Sketch” -> “Include - Library” -> “Add .ZIP Library…”. - -After AmebaEink.zip is installed, Open the “Eink_7in5_Ebook” example by -selecting “File” -> “Examples” -> “AmebaEink” -> “EPD_7in5” -> -“Eink_7in5_Ebook”. - -|image3| - -Next, insert the MicroSD card into your computer and create a new text -file named “User_Ebook.txt”. Then, save the content that you would like -to display in the text file (Note: do only include words). The content -of “User_Ebook.txt” shown below is for illustration purposes only. - -|image4| - -|image5| - -Alternatively, if you prefer another filename for your text file, you -can modify the highlighted code snippet in the sketch with the new -filename. - -|image6| - -Once the file is created, insert the MicroSD card into the onboard SD -card reader on AMB82 Mini. Upload the code and press the reset button -once the uploading is done. When the reset button is pressed, the -e-Paper display will refresh and display a cover page. - -|image7| - -By pressing the button, the content in the selected text file saved in -MicroSD card will be read and displayed onto the e-Paper display. The -content will be split into pages. - -To proceed to the next page, press the button once more. The page number -will be shown at the bottom right-hand corner as the page changes. You -will see the following in either portrait or landscape mode based on -your orientation choice after button is pressed: - -|image8| |image9| - -You can modify the highlighted code snippet to change the font size or -orientation of the displayed text. - -| Supported font size: 16, 20, 24 -| Supported orientation: 0 degree – 0 (landscape), 90 degree – 1 - (portrait), 180 degree- 2 (landscape), 270 degree – 3 (portrait) - -|image10| - -Code Reference - -| [1] We use waveshare 7.5-inch e-Paper display module/ 800×480 - Resolution driver code to get e-Paper successfully display: -| https://github.com/waveshare/e-Paper/tree/master/Arduino/epd7in5_V2 - -[2] EPD libraries can be obtained from: -https://github.com/waveshare/e-Paper - -| [3] Text Wrap function was written reference to: -| https://www.cprogramming.com/snippets/source-code/word-wrap-in-c - -.. |image1| image:: ../../_static/Example_Guides/E-Paper_-_7.5-inch_e-Book_with_MicroSD_card/E-Paper_-_7.5-inch_e-Book_with_MicroSD_card_images/image01.png - :width: 3.63575in - :height: 4.66995in -.. |image2| image:: ../../_static/Example_Guides/E-Paper_-_7.5-inch_e-Book_with_MicroSD_card/E-Paper_-_7.5-inch_e-Book_with_MicroSD_card_images/image02.png - :width: 6.25347in - :height: 3.36389in -.. |image3| image:: ../../_static/Example_Guides/E-Paper_-_7.5-inch_e-Book_with_MicroSD_card/E-Paper_-_7.5-inch_e-Book_with_MicroSD_card_images/image03.png - :width: 3.696in - :height: 4.00332in -.. |image4| image:: ../../_static/Example_Guides/E-Paper_-_7.5-inch_e-Book_with_MicroSD_card/E-Paper_-_7.5-inch_e-Book_with_MicroSD_card_images/image04.png - :width: 4.09722in - :height: 1.06292in -.. |image5| image:: ../../_static/Example_Guides/E-Paper_-_7.5-inch_e-Book_with_MicroSD_card/E-Paper_-_7.5-inch_e-Book_with_MicroSD_card_images/image05.png - :width: 4.32639in - :height: 0.92571in -.. |image6| image:: ../../_static/Example_Guides/E-Paper_-_7.5-inch_e-Book_with_MicroSD_card/E-Paper_-_7.5-inch_e-Book_with_MicroSD_card_images/image06.png - :width: 4.11435in - :height: 4.456in -.. |image7| image:: ../../_static/Example_Guides/E-Paper_-_7.5-inch_e-Book_with_MicroSD_card/E-Paper_-_7.5-inch_e-Book_with_MicroSD_card_images/image7.jpeg - :width: 2.6495in - :height: 3.536in -.. |image8| image:: ../../_static/Example_Guides/E-Paper_-_7.5-inch_e-Book_with_MicroSD_card/E-Paper_-_7.5-inch_e-Book_with_MicroSD_card_images/image8.jpeg - :width: 2.64931in - :height: 3.53574in -.. |image9| image:: ../../_static/Example_Guides/E-Paper_-_7.5-inch_e-Book_with_MicroSD_card/E-Paper_-_7.5-inch_e-Book_with_MicroSD_card_images/image9.jpeg - :width: 3.368in - :height: 2.7056in -.. |image10| image:: ../../_static/Example_Guides/E-Paper_-_7.5-inch_e-Book_with_MicroSD_card/E-Paper_-_7.5-inch_e-Book_with_MicroSD_card_images/image10.png - :width: 4.12913in - :height: 4.472in diff --git a/bak/Example_Guides/E-Paper - 7.5-inch e-Book with MicroSD card/E-paper - Display Images.rst b/bak/Example_Guides/E-Paper - 7.5-inch e-Book with MicroSD card/E-paper - Display Images.rst deleted file mode 100644 index fead225..0000000 --- a/bak/Example_Guides/E-Paper - 7.5-inch e-Book with MicroSD card/E-paper - Display Images.rst +++ /dev/null @@ -1,145 +0,0 @@ -Materials - -- AmebaPro2 [AMB82 MINI] x 1 - -- Waveshare E-Paper [2.9inch E-Paper HAT (D)/ 2.9inch E-Paper V2/ - 2.9inch e-Paper Module (B)/ 4.2inch e-Paper Module/ 7.5-inch E-Ink - display HAT] x1 - -Example - -Introduction -============ - -In this example, Ameba Pro2 board will be used to connect to a Waveshare -e-Paper module (2.9inch/ 4.2inch/ 7.5inch) to display images. The -display uses the flexible substrate as base plate, with an interface and -a reference system design. You may refer to the -official `datasheet `__ to -know more information about these modules. - -Procedure -========= - -**AMB82-Mini wiring diagram:** - -*2.9inch HAT (D) e-Paper Module* - -|image1| - -*2.9inch E-Paper V2 e-Paper Module/ 2.9inch e-Paper Module (B)* - -|image2| - -*4.2inch e-Paper Module* - -|image3| - -*7.5-inch e-Paper Module* - -Do note that Display Config should be set to B and Interface Config -should be set to 0. - -|image4| - -Firstly, prepare a picture/photo and resize the image based on the -e-Paper display that you are using. You can look for a photo resizing -tool online, for example, the `Online Image -Resizer `__. Simply follow the instructions on -the website to resize the picture and download the resized image in JPEG -format. - -2.9” e-Paper module: 296×128 pixels - -4.2” e-Paper module: 400x300 pixels - -7.5” e-Paper module: 800x480 pixels - -Secondly, -use `Image2LCD `__ tool -to convert the resized JPEG image into hexadecimal codes. You can visit -this `YouTube `__ link -to learn more about how to use the Image2LCD tool. - -| Next, download the Eink zip library, AmebaEink.zip, - at https://github.com/ambiot/ambpro2_arduino/tree/dev/Arduino_zip_libraries -| Then install the AmebaEink.zip by navigating to “Sketch” -> “Include - Library” -> “Add .ZIP Library…”. - -Eink examples are categorised based on the size and modules of the -e-Paper display. - -|image5| - -Open one of the “EinkDisplayImages” examples. For example, “File” → -“Examples” → “AmebaEink” → “EPD_2in9v2”-> “EinkDisplayImages”: - -|image6| - -You may choose any GPIO pins for Busy, Reset and DC pin. You can refer -to -https://www.amebaiot.com/en/amebapro2-amb82-mini-arduino-getting-started/ -for AMB82-Mini’s pinmap. - -|A screenshot of a computer Description automatically generated| - -Upload the code to the board and press the reset button after uploading -is done. Wait for around 1-2 seconds for the e-Paper module to refresh -its screen. Images will start to loop on the e-Paper display, each image -will be displaying for 4 seconds. - -|image7| |image8| - -The 2.9-inch e-Paper Module (B) supports three colours—red, black, and -white. You may refer to the example for 2.9-inch e-Paper Module (B) to -learn how to display red images by navigating to “File” → “Examples” → -“AmebaEink” → “EPD_2in9b”-> “EinkDisplayImages”. - -Red image displaying on 2.9-inch Module (B) e-Paper display is shown -below. - -|image9| - -Code Reference - -| [1] We use Good Display GDEH029A1 2.9 Inch / 296×128 Resolution / - Partial Refresh Arduino Sample Code to get the e-Paper successfully - Display: -| http://www.good-display.com/product/201.html - -[2] EPD libraries can be obtained from: -https://github.com/waveshare/e-Paper - -| [3] Generate a QR code on the E-paper module: -| https://eugeniopace.org/qrcode/arduino/eink/2019/07/01/qrcode-on-arduino.html - -.. |image1| image:: ../../_static/Example_Guides/E-paper_-_Display_Images/E-paper_-_Display_Images_images/image01.png - :width: 4.99828in - :height: 2.48in -.. |image2| image:: ../../_static/Example_Guides/E-paper_-_Display_Images/E-paper_-_Display_Images_images/image02.png - :width: 5.112in - :height: 2.3361in -.. |image3| image:: ../../_static/Example_Guides/E-paper_-_Display_Images/E-paper_-_Display_Images_images/image03.png - :width: 4.64935in - :height: 2.68645in -.. |image4| image:: ../../_static/Example_Guides/E-paper_-_Display_Images/E-paper_-_Display_Images_images/image04.png - :width: 4.53247in - :height: 3.07025in -.. |image5| image:: ../../_static/Example_Guides/E-paper_-_Display_Images/E-paper_-_Display_Images_images/image05.png - :width: 3.76736in - :height: 4.24392in -.. |image6| image:: ../../_static/Example_Guides/E-paper_-_Display_Images/E-paper_-_Display_Images_images/image06.png - :width: 3.76736in - :height: 4.24392in -.. |A screenshot of a computer Description automatically generated| image:: ../../_static/Example_Guides/E-paper_-_Display_Images/E-paper_-_Display_Images_images/image07.png - :width: 3.37392in - :height: 3.79781in -.. |image7| image:: ../../_static/Example_Guides/E-paper_-_Display_Images/E-paper_-_Display_Images_images/image8.jpeg - :width: 2.98067in - :height: 3.784in -.. |image8| image:: ../../_static/Example_Guides/E-paper_-_Display_Images/E-paper_-_Display_Images_images/image9.jpeg - :width: 2.83714in - :height: 3.78642in -.. |image9| image:: ../../_static/Example_Guides/E-paper_-_Display_Images/E-paper_-_Display_Images_images/image10.jpeg - :width: 4.32in - :height: 3.23724in diff --git a/bak/Example_Guides/E-Paper - 7.5-inch e-Book with MicroSD card/E-paper - Display Text.rst b/bak/Example_Guides/E-Paper - 7.5-inch e-Book with MicroSD card/E-paper - Display Text.rst deleted file mode 100644 index 8906222..0000000 --- a/bak/Example_Guides/E-Paper - 7.5-inch e-Book with MicroSD card/E-paper - Display Text.rst +++ /dev/null @@ -1,123 +0,0 @@ -Materials - -- AmebaPro2 [AMB82 MINI] x 1 - -- Waveshare E-Paper [2.9inch E-Paper HAT (D)/ 2.9inch E-Paper V2/ - 2.9inch e-Paper Module (B)/ 4.2inch e-Paper Module/ 7.5-inch E-Ink - display HAT] x1 - -Example - -Introduction -============ - -In this example, Ameba Pro2 board will be used to connect to a Waveshare -e-Paper module (2.9inch/ 4.2inch/ 7.5inch) to display texts. The display -uses the flexible substrate as base plate, with an interface and a -reference system design. You may refer to the -official `datasheet `__ to -know more information about these modules. - -Procedure -========= - -**AMB82-Mini wiring diagram:** - -*2.9inch HAT (D) e-Paper Module* - -|A picture containing text, rectangle, screenshot, design Description -automatically generated| - -*2.9inch E-Paper V2 e-Paper Module/ 2.9inch e-Paper Module (B)* - -|A picture containing text, screenshot, rectangle Description -automatically generated| - -*4.2inch e-Paper Module* - -|A picture containing electronics, text, circuit, electronic component -Description automatically generated| - -*7.5-inch e-Paper Module* - -Do note that Display Config should be set to B and Interface Config -should be set to 0. - -|A picture containing text, screenshot, electronic engineering, -electronics Description automatically generated| - -| Next, download the Eink zip library, AmebaEink.zip, - at https://github.com/ambiot/ambpro2_arduino/tree/dev/Arduino_zip_libraries -| Then install the AmebaEink.zip by navigating to “Sketch” -> “Include - Library” -> “Add .ZIP Library…”. - -Eink examples are categorised based on the size and modules of the -e-Paper display. - -|A screenshot of a computer Description automatically generated| - -Open one of the “EinkDisplayText” examples. For example, “File” → -“Examples” → “AmebaEink” → “EPD_2in9v2”-> “EinkDisplayText”: - -|image1| - -You may choose any GPIO pins for Busy, Reset and DC pin. You can refer -to -https://www.amebaiot.com/en/amebapro2-amb82-mini-arduino-getting-started/ -for AMB82-Mini’s pinmap. - -|image2| - -Upload the code to the board and press the reset button after uploading -is done. You will find these texts displayed on the boards: - -The 2.9-inch e-Paper Module (B) supports three colours—red, black, and -white. Therefore, it can display red on the e-Paper display shown on the -most left. - -|image3| - -|image4| - -|image5| - -Code Reference - -| [1] We use Good Display GDEH029A1 2.9 Inch / 296×128 Resolution / - Partial Refresh Arduino Sample Code to get the e-Paper successfully - Display: -| http://www.good-display.com/product/201.html - -[2] EPD libraries can be obtained from: -https://github.com/waveshare/e-Paper - -.. |A picture containing text, rectangle, screenshot, design Description automatically generated| image:: ../../_static/Example_Guides/E-paper_-_Display_Text/E-paper_-_Display_Text_images/image01.png - :width: 4.99828in - :height: 2.48in -.. |A picture containing text, screenshot, rectangle Description automatically generated| image:: ../../_static/Example_Guides/E-paper_-_Display_Text/E-paper_-_Display_Text_images/image02.png - :width: 5.112in - :height: 2.3361in -.. |A picture containing electronics, text, circuit, electronic component Description automatically generated| image:: ../../_static/Example_Guides/E-paper_-_Display_Text/E-paper_-_Display_Text_images/image03.png - :width: 4.64935in - :height: 2.68645in -.. |A picture containing text, screenshot, electronic engineering, electronics Description automatically generated| image:: ../../_static/Example_Guides/E-paper_-_Display_Text/E-paper_-_Display_Text_images/image04.png - :width: 4.53247in - :height: 3.07025in -.. |A screenshot of a computer Description automatically generated| image:: ../../_static/Example_Guides/E-paper_-_Display_Text/E-paper_-_Display_Text_images/image05.png - :width: 3.76736in - :height: 4.24392in -.. |image1| image:: ../../_static/Example_Guides/E-paper_-_Display_Text/E-paper_-_Display_Text_images/image06.png - :width: 4.14334in - :height: 4.38679in -.. |image2| image:: ../../_static/Example_Guides/E-paper_-_Display_Text/E-paper_-_Display_Text_images/image07.png - :width: 4.03641in - :height: 4.27358in -.. |image3| image:: ../../_static/Example_Guides/E-paper_-_Display_Text/E-paper_-_Display_Text_images/image8.jpeg - :width: 2.80117in - :height: 3.73779in -.. |image4| image:: ../../_static/Example_Guides/E-paper_-_Display_Text/E-paper_-_Display_Text_images/image9.jpeg - :width: 2.97575in - :height: 3.97075in -.. |image5| image:: ../../_static/Example_Guides/E-paper_-_Display_Text/E-paper_-_Display_Text_images/image10.jpeg - :width: 3.96626in - :height: 5.29245in diff --git a/source/API_Documents/PowerMode/Class PMClass.rst b/source/API_Documents/PowerMode/Class PMClass.rst new file mode 100644 index 0000000..bc70933 --- /dev/null +++ b/source/API_Documents/PowerMode/Class PMClass.rst @@ -0,0 +1,132 @@ +Class PMClass +============= + +.. contents:: + :local: + :depth: 2 + + +**PMClass Class** +----------------- + +**Description** +~~~~~~~~~~~~~~~~~ + +A class used for PowerMode control. + +**Syntax** +~~~~~~~~~~ + +.. code-block:: c++ + + class PMClass + +**Members** +~~~~~~~~~~~ + ++-----------------------------------+-----------------------------------+ +| **Public Constructors** | | ++===================================+===================================+ +| PMClass::PMClass | Constructs an PMClass object. | ++-----------------------------------+-----------------------------------+ +| **Public Methods** | | ++-----------------------------------+-----------------------------------+ +| PMClass::begin | Initializes the PowerMode | +| | settings for device, include type | +| | of the mode, wake up sources and | +| | related source settings. | ++-----------------------------------+-----------------------------------+ +| PMClass::start | Start the PowerMode of device. | ++-----------------------------------+-----------------------------------+ + + +**PMClass::begin** +~~~~~~~~~~~~~~~~~~ + +**Description** +~~~~~~~~~~~~~~~ + +Initializes the PowerMode settings for device, include type of the mode, wake up sources and related source settings. + +**Syntax** +~~~~~~~~~~ + +.. code-block:: c++ + + void begin(uint32_t sleep_mode, int wakeup_source, uint32_t wakeup_setting = 0); + +**Parameters** +~~~~~~~~~~~~~~ + +sleep_mode: Power Mode selection. Deepsleep mode: DEEPSLEEP_MODE; Standby mode: STANDBY_MODE + +wakeup_source: Wake up source selection. AON timer, AON GPIO, RTC, PON GPIO, UART/Serial1, and Gtimer0 set by 0 to 5. + +wakeup_setting: Settings for different wakeup sources and default is 0. + +For AON time, it is a pointer to an array that stores clock(1:4MHz; 0:100kHz) and duration(by seconds). + +For AON GPIO, it is pin number 21 or 22. + +For RTC, it is a pointer to an array that stores time duration as day, hour, min and sec(0, 0:0:0, to 365, 23:59:59). + +For PON GPIO, it is pin number 0 to 11. + +For Gtimer0, it is time duration in seconds. (start from 1s) + +**Returns** +~~~~~~~~~~~ + +| NA + +**Example Code** +~~~~~~~~~~~~~~~~ + +Example: `DeepSleepMode `_, `StandbyMode `_ + +.. note :: “PowerMode.h” must be included to use the class function. + +**PMClass::start** +------------------ + +**Description** +~~~~~~~~~~~~~~~ + +Start the PowerMode of device. + +**Syntax** +~~~~~~~~~~ + +.. code-block:: c++ + + void start(void); + + void start(int year, int month, int day, int hour, int min, int sec); + +**Parameters** +~~~~~~~~~~~~~~ +Optional when wake up source is RTC. Default start time is 1970.1.100:00:00. + +year: Start time by year. Starts from 1900. + +month: Start time by month. 0 to 11. + +day: Start time by day. 1 to 365. + +hour: Start time by hour. 0 to 23. + +min: Start time by min. 0 to 59. + +sec: Start time by sec. 0 to 59. + +**Returns** +~~~~~~~~~~~ + +NA + +**Example Code** +~~~~~~~~~~~~~~~~ + +Example: `DeepSleepMode `_, `StandbyMode `_ + +.. note :: “PowerMode.h” must be included to use the class function. diff --git a/bak/API_Documents/PowerMode/index.rst b/source/API_Documents/PowerMode/index.rst similarity index 100% rename from bak/API_Documents/PowerMode/index.rst rename to source/API_Documents/PowerMode/index.rst diff --git a/source/API_Documents/RTC/Class RTCClass.rst b/source/API_Documents/RTC/Class RTCClass.rst new file mode 100644 index 0000000..9433ec6 --- /dev/null +++ b/source/API_Documents/RTC/Class RTCClass.rst @@ -0,0 +1,325 @@ +Class RTC +========== + +.. contents:: + :local: + :depth: 2 + +**RTCClass Class** +------------------ + +**Description** +~~~~~~~~~~~~~~~ +| A class used for initializing, starting, stopping, and setting alarm with RTC. + +**Syntax** +~~~~~~~~~~ + +.. code-block:: c++ + + class WDT + +**Members** +~~~~~~~~~~~ + ++-----------------------------------+-----------------------------------+ +| **Public Constructors** | | ++===================================+===================================+ +| RTCClass:: RTCClass | Constructs an RTC object. | ++-----------------------------------+-----------------------------------+ +| **Public Methods** | | ++-----------------------------------+-----------------------------------+ +| RTCClass::Init | Initializes the RTC device, | +| | include clock, RTC registers and | +| | function. | ++-----------------------------------+-----------------------------------+ +| RTCClass::DeInit | Deinitializes the RTC device. | ++-----------------------------------+-----------------------------------+ +| RTCClass::Write | Set the specified timestamp in | +| | seconds to RTC. | ++-----------------------------------+-----------------------------------+ +| RTCClass::Read | Get current timestamp in seconds | +| | from RTC. | ++-----------------------------------+-----------------------------------+ +| RTCClass::Wait | Wait for seconds. A delay | +| | function. | ++-----------------------------------+-----------------------------------+ +| RTCClass::SetEpoch | Convert human readable time to | +| | epoch time. | ++-----------------------------------+-----------------------------------+ +| RTCClass::EnableAlarm | Enable the RTC alarm. | ++-----------------------------------+-----------------------------------+ +| RTCClass::DisableAlarm | Disable the RTC alarm. | ++-----------------------------------+-----------------------------------+ + + +**RTCClass::Init** +------------------ + +**Description** +~~~~~~~~~~~~~~~ + +Initializes the RTC device, include clock, RTC registers and function. + +**Syntax** +~~~~~~~~~~ + +.. code-block:: c++ + + void Init(void); + +**Parameters** +~~~~~~~~~~~~~~ + +NA + +**Returns** +~~~~~~~~~~~ + +NA + +**Example Code** +~~~~~~~~~~~~~~~~ + +Example: `Simple_RTC `_, `Simple_RTC_Alarm `_ + +.. note :: "rtc.h” must be included to use the class function. + +**RTCClass::DeInit** +-------------------- + +**Description** +~~~~~~~~~~~~~~~ + +Deinitializes the RTC device. + +**Syntax** +~~~~~~~~~~ + +.. code-block:: c++ + + void DeInit(void); + +**Parameters** +~~~~~~~~~~~~~~ + +NA + +**Returns** +~~~~~~~~~~~ + +NA + +**Example Code** +~~~~~~~~~~~~~~~~ + +Example: `Simple_RTC `_, `Simple_RTC_Alarm `_ + +.. note :: “rtc.h” must be included to use the class function. + +**RTCClass::Write** +------------------- + +**Description** +~~~~~~~~~~~~~~~ + +Set the specified timestamp in seconds to RTC. + +**Syntax** +~~~~~~~~~~ + +.. code-block:: c++ + + void Write(long long t); + +**Parameters** +~~~~~~~~~~~~~~ + +t: Seconds from 1970.1.1 00:00:00 to specified data and time which is to be set. + +**Returns** +~~~~~~~~~~~ + +NA + +**Example Code** +~~~~~~~~~~~~~~~~ + +Example: `Simple_RTC `_, `Simple_RTC_Alarm `_ + +.. note :: “rtc.h” must be included to use the class function. + +**RTCClass::Read** +------------------ + +**Description** +~~~~~~~~~~~~~~~ + +Get current timestamp in seconds from RTC. + +**Syntax** +~~~~~~~~~~ +.. code-block:: c++ + + long long Read(void); + +**Parameters** +~~~~~~~~~~~~~~ + +NA + +**Returns** +~~~~~~~~~~~ + +The current timestamp in seconds which is calculated from 1970.1.100:00:00. + +**Example Code** +~~~~~~~~~~~~~~~~ + +Example: `Simple_RTC `_, `Simple_RTC_Alarm `_ + +.. note :: “rtc.h” must be included to use the class function. + +**RTCClass::Wait** +------------------ + +**Description** +~~~~~~~~~~~~~~~ + +Wait for seconds. A delay function. + +**Syntax** +~~~~~~~~~~ + +.. code-block:: c++ + + void Wait(int s); + +**Parameters** +~~~~~~~~~~~~~~ + +s: delay time in seconds. + +**Returns** +~~~~~~~~~~~ + +NA + +**Example Code** +~~~~~~~~~~~~~~~~ + +Example: `Simple_RTC `_, `Simple_RTC_Alarm `_ + +.. note :: “rtc.h” must be included to use the class function. + +**RTCClass::SetEpoch** +---------------------- + +**Description** +~~~~~~~~~~~~~~~ + +Convert human readable time to epoch time. + +**Syntax** +~~~~~~~~~~ + +long long SetEpoch(int year, int month, int day, int hour, int min, int sec); + +**Parameters** +~~~~~~~~~~~~~~ + +year: Input time in year. Start from 1900. + +month: Input time in month. 0 to 11 + +day: Input time unit in day. 1 to 31. + +hour: Input time unit in hour. 0 to 23. + +min: Input time unit in min. 0 to 59. + +sec: Input time unit in sec. 0 to 59. + +**Returns** +~~~~~~~~~~~ + +The epoch time of the input date. + +**Example Code** +~~~~~~~~~~~~~~~~ + +Example: `Simple_RTC `_, `Simple_RTC_Alarm `_ + +.. note :: “rtc.h” must be included to use the class function. + +**RTCClass::EnableAlarm** +------------------------- + +**Description** +~~~~~~~~~~~~~~~ + +Enable the RTC alarm. + +**Syntax** +~~~~~~~~~~ + +.. code-block:: c++ + + void EnableAlarm(int day, int hour, int min, int sec, void(*rtc_handler)(void)); + +**Parameters** +~~~~~~~~~~~~~~ + +day: Alarm time unit in day. 1 to 31. + +hour: Alarm time unit in hour. 0 to 23. + +min: Alarm time unit in min. 0 to 59. + +sec: Alarm time unit in sec. 0 to 59. + +rtc_handler: the callback function for rtc alarm interrupt. + +**Returns** +~~~~~~~~~~~ + +NA + +**Example Code** +~~~~~~~~~~~~~~~~ + +Example: `Simple_RTC `_, `Simple_RTC_Alarm `_ + +.. note :: “rtc.h” must be included to use the class function. + +**RTCClass::DisableAlarm** +-------------------------- + +**Description** +~~~~~~~~~~~~~~~ + +Disable the RTC alarm. + +**Syntax** +~~~~~~~~~~ + +.. code-block:: c++ + + void DisableAlarm(void); + +**Parameters** +~~~~~~~~~~~~~~ + +NA + +**Returns** +~~~~~~~~~~~ + +NA + +**Example Code** +~~~~~~~~~~~~~~~~ + +Example: `Simple_RTC `_, `Simple_RTC_Alarm `_ + +.. note :: “rtc.h” must be included to use the class function. diff --git a/bak/API_Documents/RTC/index.rst b/source/API_Documents/RTC/index.rst similarity index 100% rename from bak/API_Documents/RTC/index.rst rename to source/API_Documents/RTC/index.rst diff --git a/source/API_Documents/index.rst b/source/API_Documents/index.rst index 3e1f6e8..d4bd6ed 100644 --- a/source/API_Documents/index.rst +++ b/source/API_Documents/index.rst @@ -10,6 +10,8 @@ API Documents NeuralNetwork/index NTPClient/index OTA/index + PowerMode/index + RTC/index USB/index Watchdog/index WiFi/index diff --git a/source/Example_Guides/E-Paper/7.5-inch e-Book with MicroSD card.rst b/source/Example_Guides/E-Paper/7.5-inch e-Book with MicroSD card.rst new file mode 100644 index 0000000..4b5f6e1 --- /dev/null +++ b/source/Example_Guides/E-Paper/7.5-inch e-Book with MicroSD card.rst @@ -0,0 +1,108 @@ +7.5-inch e-Book with MicroSD card +================================= + +.. contents:: + :local: + :depth: 2 + +Materials +--------- + +- `AMB82-mini `_ x 1 + +- Waveshare E-Paper [7.5-inch E-Ink display HAT] x1 + +- Button x 1 + +- MicroSD card x 1 + +- 330 Ohm resistor x1 + +Introduction +------------ + +In this example, we will be connecting Ameba Pro2 board to Waveshare 7.5-inch e-Paper module to be used as an e-Book. The 7.5” active area contains 800 x 480 pixels and has 1-bit white/black full display capabilities. An integrated circuit contains gate buffer, source buffer, interface, timing control logic, oscillator, etc. are supplied with each panel. You may refer to [7.5inch-e-paper-specification] `https://www.waveshare.com/w/upload/6/60/7.5inch_e-Paper_V2_Specification.pdf `_ for more information about this e-Paper module. + +Procedure +--------- + +**AMB82-Mini wiring diagram:** + +Do note that Display Config should be set to B and Interface Config should be set to 0. + +|image01| + +|image02| + +Next, download the Eink zip library, AmebaEink.zip, at `https://github.com/ambiot/ambpro2_arduino/tree/dev/Arduino_zip_libraries `_ +Then install the AmebaEink.zip by navigating to “Sketch” -> “Include Library” -> “Add .ZIP Library…”. + +After AmebaEink.zip is installed, Open the “Eink_7in5_Ebook” example by +selecting “File” -> “Examples” -> “AmebaEink” -> “EPD_7in5” -> +“Eink_7in5_Ebook”. + +|image03| + +Next, insert the MicroSD card into your computer and create a new text file named “User_Ebook.txt”. Then, save the content that you would like to display in the text file (Note: do only include words). The contentof “User_Ebook.txt” shown below is for illustration purposes only. + +|image04| + +|image05| + +Alternatively, if you prefer another filename for your text file, you can modify the highlighted code snippet in the sketch with the new filename. + +|image06| + +Once the file is created, insert the MicroSD card into the onboard SD card reader on AMB82 Mini. Upload the code and press the reset button once the uploading is done. When the reset button is pressed, the e-Paper display will refresh and display a cover page. + +|image07| + +By pressing the button, the content in the selected text file saved in MicroSD card will be read and displayed onto the e-Paper display. The content will be split into pages. + +To proceed to the next page, press the button once more. The page number +will be shown at the bottom right-hand corner as the page changes. You +will see the following in either portrait or landscape mode based on +your orientation choice after button is pressed: + +|image08| + +|image09| + +You can modify the highlighted code snippet to change the font size or +orientation of the displayed text. + +Supported font size: 16, 20, 24 +Supported orientation: 0 degree – 0 (landscape), 90 degree – 1 (portrait), 180 degree- 2 (landscape), 270 degree – 3 (portrait) + +|image10| + +.. |image01| image:: ../../_static/Example_Guides/E-Paper/7.5-inch_e-Book_with_MicroSD_card/image01.png + :width: 732 px + :height: 481 px +.. |image02| image:: ../../_static/Example_Guides/E-Paper/7.5-inch_e-Book_with_MicroSD_card/image02.png + :width: 1349 px + :height: 725 px +.. |image03| image:: ../../_static/Example_Guides/E-Paper/7.5-inch_e-Book_with_MicroSD_card/image03.png + :width: 960 px + :height: 1040 px +.. |image04| image:: ../../_static/Example_Guides/E-Paper/7.5-inch_e-Book_with_MicroSD_card/image04.png + :width: 755 px + :height: 196 px +.. |image05| image:: ../../_static/Example_Guides/E-Paper/7.5-inch_e-Book_with_MicroSD_card/image05.png + :width: 1114 px + :height: 238 px +.. |image06| image:: ../../_static/Example_Guides/E-Paper/7.5-inch_e-Book_with_MicroSD_card/image06.png + :width: 960 px + :height: 900 px +.. |image07| image:: ../../_static/Example_Guides/E-Paper/7.5-inch_e-Book_with_MicroSD_card/image07.png + :width: 1082 px + :height: 1006 px +.. |image08| image:: ../../_static/Example_Guides/E-Paper/7.5-inch_e-Book_with_MicroSD_card/image08.png + :width: 882 px + :height: 1076 px +.. |image09| image:: ../../_static/Example_Guides/E-Paper/7.5-inch_e-Book_with_MicroSD_card/image09.png + :width: 895 px + :height: 1043 px +.. |image10| image:: ../../_static/Example_Guides/E-Paper/7.5-inch_e-Book_with_MicroSD_card/image10.png + :width: 960 px + :height: 900 px diff --git a/source/Example_Guides/E-Paper/Display Images.rst b/source/Example_Guides/E-Paper/Display Images.rst new file mode 100644 index 0000000..cd3cb16 --- /dev/null +++ b/source/Example_Guides/E-Paper/Display Images.rst @@ -0,0 +1,139 @@ +Display Images +============== + +.. contents:: + :local: + :depth: 2 + +Materials +--------- + +- `AMB82-mini `_ x 1 + +- Waveshare E-Paper [2.9inch E-Paper HAT (D)/ 2.9inch E-Paper V2/ 2.9inch e-Paper Module (B)/ 4.2inch e-Paper Module/ 7.5-inch E-Ink display HAT] x1 + +Example +------- + +Introduction +------------ + +In this example, Ameba Pro2 board will be used to connect to a Waveshare +e-Paper module (2.9inch/ 4.2inch/ 7.5inch) to display images. The +display uses the flexible substrate as base plate, with an interface and +a reference system design. You may refer to the +official `datasheet `__ to +know more information about these modules. + +Procedure +--------- + +**AMB82-Mini wiring diagram:** + +2.9inch HAT (D) e-Paper Module + +|image01| + +2.9inch E-Paper V2 e-Paper Module/ 2.9inch e-Paper Module (B) + +|image02| + +4.2inch e-Paper Module + +|image03| + +7.5-inch e-Paper Module + +Do note that Display Config should be set to B and Interface Config +should be set to 0. + +|image04| + +Firstly, prepare a picture/photo and resize the image based on the +e-Paper display that you are using. You can look for a photo resizing +tool online, for example, the `Online Image +Resizer `__. Simply follow the instructions on +the website to resize the picture and download the resized image in JPEG +format. + +2.9” e-Paper module: 296x128 pixels + +4.2” e-Paper module: 400x300 pixels + +7.5” e-Paper module: 800x480 pixels + +Secondly, +use `Image2LCD `_ tool +to convert the resized JPEG image into hexadecimal codes. You can visit +this `YouTube `_ link +to learn more about how to use the Image2LCD tool. + +Next, download the Eink zip library, AmebaEink.zip, +at `https://github.com/ambiot/ambpro2_arduino/tree/dev/Arduino_zip_libraries `_ +Then install the AmebaEink.zip by navigating to “Sketch” -> “Include +Library” -> “Add .ZIP Library…”. + +Eink examples are categorised based on the size and modules of the +e-Paper display. + +|image05| + +Open one of the “EinkDisplayImages” examples. For example, “File” → +“Examples” → “AmebaEink” → “EPD_2in9v2”-> “EinkDisplayImages”: + +|image06| + +You may choose any GPIO pins for Busy, Reset and DC pin. You can refer +to for AMB82-Mini's `pinmap `_. + +|image07| + +Upload the code to the board and press the reset button after uploading +is done. Wait for around 1-2 seconds for the e-Paper module to refresh +its screen. Images will start to loop on the e-Paper display, each image +will be displaying for 4 seconds. + +|image08| + +|image09| + +The 2.9-inch e-Paper Module (B) supports three colours—red, black, and +white. You may refer to the example for 2.9-inch e-Paper Module (B) to +learn how to display red images by navigating to “File” → “Examples” → +“AmebaEink” → “EPD_2in9b”-> “EinkDisplayImages”. + +Red image displaying on 2.9-inch Module (B) e-Paper display is shown +below. + +|image10| + +.. |image01| image:: ../../_static/Example_Guides/E-Paper/Display_Images/image01.png + :width: 1257 px + :height: 624 px +.. |image02| image:: ../../_static/Example_Guides/E-Paper/Display_Images/image02.png + :width: 1212 px + :height: 554 px +.. |image03| image:: ../../_static/Example_Guides/E-Paper/Display_Images/image03.png + :width: 1194 px + :height: 690 px +.. |image04| image:: ../../_static/Example_Guides/E-Paper/Display_Images/image04.png + :width: 1015 px + :height: 688 px +.. |image05| image:: ../../_static/Example_Guides/E-Paper/Display_Images/image05.png + :width: 924 px + :height: 750 px +.. |image06| image:: ../../_static/Example_Guides/E-Paper/Display_Images/image06.png + :width: 924 px + :height: 750 px +.. |image07| image:: ../../_static/Example_Guides/E-Paper/Display_Images/image07.png + :width: 924 px + :height: 750 px +.. |image08| image:: ../../_static/Example_Guides/E-Paper/Display_Images/image08.png + :width: 1049 px + :height: 1200 px +.. |image09| image:: ../../_static/Example_Guides/E-Paper/Display_Images/image09.png + :width: 1049 px + :height: 1365 px +.. |image10| image:: ../../_static/Example_Guides/E-Paper/Display_Images/image10.png + :width: 1302 px + :height: 1224 px diff --git a/source/Example_Guides/E-Paper/Display Text.rst b/source/Example_Guides/E-Paper/Display Text.rst new file mode 100644 index 0000000..9a119ee --- /dev/null +++ b/source/Example_Guides/E-Paper/Display Text.rst @@ -0,0 +1,116 @@ +Display Text +============== + +.. contents:: + :local: + :depth: 2 + +Materials +--------- + +- `AMB82-mini `_ x 1 + +- Waveshare E-Paper [2.9inch E-Paper HAT (D)/ 2.9inch E-Paper V2/ + 2.9inch e-Paper Module (B)/ 4.2inch e-Paper Module/ 7.5-inch E-Ink + display HAT] x1 + +Example +------- + +Introduction +------------ + +In this example, Ameba Pro2 board will be used to connect to a Waveshare +e-Paper module (2.9inch/ 4.2inch/ 7.5inch) to display texts. The display +uses the flexible substrate as base plate, with an interface and a +reference system design. You may refer to the +official `datasheet `__ to +know more information about these modules. + +Procedure +--------- + +**AMB82-Mini wiring diagram:** + +2.9inch HAT (D) e-Paper Module + +|image01| + +2.9inch E-Paper V2 e-Paper Module/ 2.9inch e-Paper Module (B) + +|image02| + +4.2inch e-Paper Module + +|image03| + +7.5-inch e-Paper Module + +Do note that Display Config should be set to B and Interface Config +should be set to 0. + +|image04| + +Next, download the Eink zip library, AmebaEink.zip, +at `https://github.com/ambiot/ambpro2_arduino/tree/dev/Arduino_zip_libraries `_ +Then install the AmebaEink.zip by navigating to “Sketch” -> “Include +Library” -> “Add .ZIP Library…”. + +Eink examples are categorised based on the size and modules of the +e-Paper display. + +|image05| + +Open one of the “EinkDisplayText” examples. For example, “File” → +“Examples” → “AmebaEink” → “EPD_2in9v2”-> “EinkDisplayText”: + +|image06| + +You may choose any GPIO pins for Busy, Reset and DC pin. You can refer +to for AMB82-Mini's `pinmap `_. + +|image07| + +Upload the code to the board and press the reset button after uploading +is done. You will find these texts displayed on the boards: + +The 2.9-inch e-Paper Module (B) supports three colours—red, black, and +white. Therefore, it can display red on the e-Paper display shown on the +most left. + +|image08| + +|image09| + +|image10| + +.. |image01| image:: ../../_static/Example_Guides/E-Paper/Display_Text/image01.png + :width: 1257 px + :height: 624 px +.. |image02| image:: ../../_static/Example_Guides/E-Paper/Display_Text/image02.png + :width: 1214 px + :height: 554 px +.. |image03| image:: ../../_static/Example_Guides/E-Paper/Display_Text/image03.png + :width: 1194 px + :height: 690 px +.. |image04| image:: ../../_static/Example_Guides/E-Paper/Display_Text/image04.png + :width: 1015 px + :height: 688 px +.. |image05| image:: ../../_static/Example_Guides/E-Paper/Display_Text/image05.png + :width: 924 px + :height: 1040 px +.. |image06| image:: ../../_static/Example_Guides/E-Paper/Display_Text/image06.png + :width: 982 px + :height: 1040 px +.. |image07| image:: ../../_static/Example_Guides/E-Paper/Display_Text/image07.png + :width: 982 px + :height: 1040 px +.. |image08| image:: ../../_static/Example_Guides/E-Paper/Display_Text/image08.png + :width: 1257 px + :height: 1024 px +.. |image09| image:: ../../_static/Example_Guides/E-Paper/Display_Text/image09.png + :width: 1257 px + :height: 1024 px +.. |image10| image:: ../../_static/Example_Guides/E-Paper/Display_Text/image10.png + :width: 1057 px + :height: 1324 px diff --git a/source/Example_Guides/E-Paper/index.rst b/source/Example_Guides/E-Paper/index.rst new file mode 100644 index 0000000..919cc5b --- /dev/null +++ b/source/Example_Guides/E-Paper/index.rst @@ -0,0 +1,9 @@ +E-Paper +========= + +.. toctree:: + :maxdepth: 1 + + Display Images + Display Text + 7.5-inch e-Book with MicroSD card diff --git a/source/Example_Guides/index.rst b/source/Example_Guides/index.rst index 09169c4..6ef4380 100644 --- a/source/Example_Guides/index.rst +++ b/source/Example_Guides/index.rst @@ -5,6 +5,7 @@ Example Guides :maxdepth: 2 Basic/index + E-Paper/index Flash Memory/index GPIO/index GTimer/index diff --git a/source/_static/Example_Guides/E-Paper/Display_Text/image05.png b/source/_static/Example_Guides/E-Paper/Display_Text/image05.png index 5ba1ef4..6285ee4 100644 Binary files a/source/_static/Example_Guides/E-Paper/Display_Text/image05.png and b/source/_static/Example_Guides/E-Paper/Display_Text/image05.png differ diff --git a/source/_static/Example_Guides/E-Paper/Display_Text/image06.png b/source/_static/Example_Guides/E-Paper/Display_Text/image06.png index 26744e0..5ba1ef4 100644 Binary files a/source/_static/Example_Guides/E-Paper/Display_Text/image06.png and b/source/_static/Example_Guides/E-Paper/Display_Text/image06.png differ diff --git a/source/_static/Example_Guides/E-Paper/Display_Text/image07.png b/source/_static/Example_Guides/E-Paper/Display_Text/image07.png index e6256b0..26744e0 100644 Binary files a/source/_static/Example_Guides/E-Paper/Display_Text/image07.png and b/source/_static/Example_Guides/E-Paper/Display_Text/image07.png differ diff --git a/source/_static/Example_Guides/E-Paper/Display_Text/image08.png b/source/_static/Example_Guides/E-Paper/Display_Text/image08.png index 17a1a7a..e6256b0 100644 Binary files a/source/_static/Example_Guides/E-Paper/Display_Text/image08.png and b/source/_static/Example_Guides/E-Paper/Display_Text/image08.png differ diff --git a/source/_static/Example_Guides/E-Paper/Display_Text/image09.png b/source/_static/Example_Guides/E-Paper/Display_Text/image09.png index f9c6ea3..17a1a7a 100644 Binary files a/source/_static/Example_Guides/E-Paper/Display_Text/image09.png and b/source/_static/Example_Guides/E-Paper/Display_Text/image09.png differ diff --git a/source/_static/Example_Guides/E-Paper/Display_Text/image10.png b/source/_static/Example_Guides/E-Paper/Display_Text/image10.png new file mode 100644 index 0000000..f9c6ea3 Binary files /dev/null and b/source/_static/Example_Guides/E-Paper/Display_Text/image10.png differ