Skip to content

Update and Add AmebaD Example Guides #35

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 6 commits into from
Mar 11, 2025
Merged

Update and Add AmebaD Example Guides #35

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
d994272
Update and Add AmebaD Example Guides
pammyleong Mar 11, 2025
b53c43e
Merge branch 'Ameba-AIoT:main' into main
pammyleong Mar 11, 2025
6119ab7
correct spelling
pammyleong Mar 11, 2025
42b1eca
Merge branch 'main' of https://github.com/pammyleong/ameba-arduino-doc
pammyleong Mar 11, 2025
3c03138
Merge branch 'Ameba-AIoT:main' into main
pammyleong Mar 11, 2025
600a049
Merge branch 'Ameba-AIoT:main' into main
pammyleong Mar 11, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
156 changes: 156 additions & 0 deletions source/_common/ameba_d/Example_Guides/Power Save/Power Save - Deep Sleep Mode.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,156 @@
Power Save - Deep Sleep Mode
=============================

.. contents::
:local:
:depth: 2

Materials
---------

- AmebaD [AMB21 / AMB22 / AMB23 / AMB25 / AMB26 / BW16 / AW-CU488 Thing Plus] x 1

Example
-------

AmebaD supports 2 low power modes which are deep sleep mode and sleep mode. Deep Sleep mode turns off more power domain than sleep mode. The power consumptions of Deep Sleep mode is around 7μA to 8μA as compared to normal state which is around 22mA. This example describes how to enter Deep Sleep mode and configure the wakeup source.

Open “File” -> “Examples” -> “AmebaPowerSave” -> “DeepSleepMode”

|image01|

Set condition values as below.
“DS_WAKEUP_SOURCE” is used to set the wakeup source, user can choose 3 wakeup sources,
AON Timer (SET_DS_AON_TIMER_WAKEUP);
AON GPIO pins (SET_AON_GPIO_WAKEUP_PAxx) with xx being the pin no.(e.g. SET_AON_GPIO_WAKEUP_PA25);
RTC Timer(SET_DS_RTC_WAKEUP);

**Using AON Timer as wakeup source**

AON Timer can be set from 0 to 32760000ms range by AON_TIMER_SLEEP_DURATION.

**Using AON GPIO pins as wake up source**

For AMB21, there are 5 pins that can be set as AON pins and active high for wakeup, PA25(D16), PA26(D17), PA21(D26), PA20(D27), PA(D28).

For AMB23, there are 8 pins that can be set as AON pins and active high for wakeup, PA12(D9), PA13(D10), PA14(D11), PA15(D12), PA16(D13), PA18(D15), PA19(D16), PA21(D18).

For BW16/BW16 type C, there is only 6 pins that can be set as AON pin and active high for wakeup, PA_25 (D7), PA_26 (D8), PA_15 (D9), PA_14 (D10), PA_13 (D11), PA_12 (D12).

For AW-CU488 Thing Plus, there is only 10 pins that can be set as AON pin and active high for wakeup, PA_18(D0), PA_16(D1), PA_17(D2), PA_13(D3), PA_12(D4), PA_26(D5), PA_25(D6), PA_19(D8), PA_15(D28), PA_14(D29).

For AMB25 and AMB26, there is only 6 pins that can be set as AON pin and active high for wakeup, PA12(D3), PA13(D2), PA14(D1), PA15(D0), PA25(D7), PA26(D6).

**Wiring Diagram**

.. only:: amb21

|image02|

.. only:: end amb21

.. only:: amb23

|image03|

.. only:: end amb23

.. only:: amb25

|image07|

.. only:: end amb25

.. only:: amb26

|image08|

.. only:: end amb26

.. only:: bw16-typeb

|image04|

.. only:: end bw16-typeb

.. only:: bw16-typec

|image05|

.. only:: end bw16-typec

.. only:: aw-cu488

|image06|

.. only:: end aw-cu488

These AON pins can be set by using SET_AON_GPIO_WAKEUP_PA25 or the pin that you want to use as shown in the picture below.

|image09|

**Using RTC Timer as wakeup source**

RTC Timer wakeup source can wake up the RTOS from deep sleep mode using the time set in the RTC alarm, which including day, hour, minute, and sec. All 4 values can be set by DS_RTC_ALARM_DAY, DS_RTC_ALARM_HOUR, DS_RTC_ALARM_MIN, and DS_RTC_ALARM_SEC.

|image10|

When all the condition values are set, the system will run and switch between normal and deep sleep mode which is controlled by the wakeup source. The serial monitor will display the switching log as shown below.

**AON Timer**

|image11|

**AON GPIO Pin**

|image12|

**RTC Timer**

|image13|

Code Reference
---------------

Please refer to the `API Documents <https://ameba-doc-arduino-sdk.readthedocs-hosted.com/en/latest/amb21/API_Documents/index.html>`_ PowerSave section for detail description of all API.


.. |image01| image:: ../../../../_static/amebad/Example_Guides/PowerSave/Power_Save_Deep_Sleep_Mode/image01.png
:width: 689 px
:height: 704 px
.. |image02| image:: ../../../../_static/amebad/Example_Guides/PowerSave/Power_Save_Deep_Sleep_Mode/image02.png
:width: 699 px
:height: 669 px
.. |image03| image:: ../../../../_static/amebad/Example_Guides/PowerSave/Power_Save_Deep_Sleep_Mode/image03.png
:width: 729 px
:height: 694 px
.. |image04| image:: ../../../../_static/amebad/Example_Guides/PowerSave/Power_Save_Deep_Sleep_Mode/image04.png
:width: 423 px
:height: 535 px
.. |image05| image:: ../../../../_static/amebad/Example_Guides/PowerSave/Power_Save_Deep_Sleep_Mode/image05.png
:width: 376 px
:height: 392 px
.. |image06| image:: ../../../../_static/amebad/Example_Guides/PowerSave/Power_Save_Deep_Sleep_Mode/image06.png
:width: 235 px
:height: 400 px
.. |image07| image:: ../../../../_static/amebad/Example_Guides/PowerSave/Power_Save_Deep_Sleep_Mode/image07.png
:width: 391 px
:height: 400 px
.. |image08| image:: ../../../../_static/amebad/Example_Guides/PowerSave/Power_Save_Deep_Sleep_Mode/image08.png
:width: 450 px
:height: 400 px
.. |image09| image:: ../../../../_static/amebad/Example_Guides/PowerSave/Power_Save_Deep_Sleep_Mode/image09.png
:width: 903 px
:height: 651 px
.. |image10| image:: ../../../../_static/amebad/Example_Guides/PowerSave/Power_Save_Deep_Sleep_Mode/image10.png
:width: 665 px
:height: 262 px
.. |image11| image:: ../../../../_static/amebad/Example_Guides/PowerSave/Power_Save_Deep_Sleep_Mode/image11.png
:width: 859 px
:height: 369 px
.. |image12| image:: ../../../../_static/amebad/Example_Guides/PowerSave/Power_Save_Deep_Sleep_Mode/image12.png
:width: 1004 px
:height: 461 px
.. |image13| image:: ../../../../_static/amebad/Example_Guides/PowerSave/Power_Save_Deep_Sleep_Mode/image13.png
:width: 860 px
:height: 370 px
210 changes: 210 additions & 0 deletions ...eba_d/Example_Guides/Power Save/Power Save - Deep Sleep for DHT and E-Paper.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,210 @@
Power Save - Deep Sleep for DHT and E-Paper
============================================

.. contents::
:local:
:depth: 2

Materials
---------

- AmebaD [AMB21 / AMB22 / AMB23 / AMB25 / AMB26 / BW16 / AW-CU488 Thing Plus] x 1

- DHT11 or DHT22 or DHT21 x 1

- Waveshare 2.9inch E-Paper HAT (D) x 1

Example
--------

Ameba-D supports low power modes which are deepsleep mode. Deepsleep mode turns off most of the system power domain. The power consumptions of core module in DeepSleep Mode are around 7uA to 8uA compared to normal state around 22mA. This example gives demo of system switch between “working” and “sleep”(power save).Using DHT sensor to read data and display on Eink screen when system is awake. After 5 seconds system auto enter DeepSleep Mode for power save. System will wake up by wakeup source.( Aon timer, Aon Pins or RTC timer).

There are 2 versions of DHT sensor, one with 4 pins and another one with 3 pins mounted to a small PCB. The PCB mounted version has included a 10K Ohm pull up resistor for the signal line. Take note that if you are using a DHT sensor that is not mounted on a PCB, you will have to add in a 10K Ohm pull up resistor. You may refer to the wiring diagrams below.

.. only:: amb21

**DHT sensor not mounted on PCB board**

|image01|

**DHT sensor mounted on PCB board**

|image02|

.. only:: end amb21

.. only:: amb23

**DHT sensor not mounted on PCB board**

|image03|

**DHT sensor mounted on PCB board**

|image04|

.. only:: end amb23

.. only:: amb25

**DHT sensor not mounted on PCB board**

|image05|

**DHT sensor mounted on PCB board**

|image06|

.. only:: end amb25

.. only:: amb26

**DHT sensor not mounted on PCB board**

|image07|

**DHT sensor mounted on PCB board**

|image08|

.. only:: end amb26

.. only:: bw16-typeb

**DHT sensor not mounted on PCB board**

|image09|

**DHT sensor mounted on PCB board**

|image10|

.. only:: end bw16-typeb

.. only:: bw16-typec

**DHT sensor not mounted on PCB board**

|image11|

**DHT sensor mounted on PCB board**

|image12|

.. only:: end bw16-typec

.. only:: aw-cu488

**DHT sensor not mounted on PCB board**

|image13|

**DHT sensor mounted on PCB board**

|image14|

.. only:: end aw-cu488

Download the Eink zip library, AmebaEink.zip, at https://github.com/ambiot/ambd_arduino/tree/master/Arduino_zip_libraries. Then install the AmebaEink.zip.

Open “File” -> “Examples” -> “AmebaPowerSave” -> “DeepSleep_DHT_Eink_Example”

|image15|

Set condition values as picture below.

“DS_WAKEUP_SOURCE” is used to set the wake-up source, user can choose from 3 wake up sources,

- AON Timer (SET_DS_AON_TIMER_WAKEUP);
- AON GPIO pins (SET_AON_WAKEPIN_WAKEUP);
- RTC Timer(SET_DS_RTC_WAKEUP);

**Using AON Timer as wakeup source**

AON timer can be set from 0 to 32760000 range (unit ms) by AON_TIMER_SLEEP_DURATION.

**Using AON GPIO pins as wake up source**

For AMB21/AMB22, there are 5 pins that can be set as AON pins and active high for wakeup, GPIOA25(D16), GPIOA26(D17), GPIOA21(D26), GPIOA20(D27), GPIOA(D28).

For AMB23, there are 8 pins that can be set as AON pins and active high for wakeup, GPIOA12(D9), GPIOA13(D10), GPIOA14(D11), GPIOA15(D12), GPIOA16(D13), GPIOA18(D15), GPIOA19(D16), GPIOA21(D18).

For BW16/BW16-TypeC, there is only 6 pins that can be set as AON pin and active high for wakeup, GPIOA_25 (D7), GPIOA_26 (D8), GPIOA_15 (D9), GPIOA_14 (D10), GPIOA_13 (D11), GPIOA_12 (D12).

For AW-CU488 Thing Plus, there is only 10 pins that can be set as AON pin and active high for wakeup, GPIOA_18(D0), GPIOA_16(D1), GPIOA_17(D2), GPIOA_13(D3), GPIOA_12(D4), GPIOA_26(D5), GPIOA_25(D6), GPIOA_19(D8), GPIOA_15(D28), GPIOA_14(D29).

For AMB25, there is only 6 pins that can be set as AON pin and active high for wakeup, GPIOA_12(D3), GPIOA_13(D2), GPIOA_14(D1), GPIOA_15(D0), GPIOA_25(D7), GPIOA_26(D6).

These AON pins can be set by using SET_AON_GPIO_WAKEUP_GPIOA25 or the pin that you want to use as shown in the picture below.

|image16|

**Using RTC Timer as wakeup source**

RTC Timer wakeup system is by setting alarm. The alarm has 4 values to be set, day, hour, min and sec. All 4 values can be set by DS_RTC_ALARM_DAY, DS_RTC_ALARM_HOUR, DS_RTC_ALARM_MIN, and DS_RTC_ALARM_SEC.

DHTPIN is used to set DHT sensor data pin. User can choose any GPIO pins.

DHTTYPE is used to set DHT sensor type. (DHT11, DHT22 and DHT33)

|image17|

When finished the condition values setting, system will run and switch between normal working mode and deepsleep mode controlled by wakeup source. Eink screen will display the temperature and humidity data measured from DHT sensor when system is awake.

Code Reference
---------------

Please refer to the `API Documents <https://ameba-doc-arduino-sdk.readthedocs-hosted.com/en/latest/amb21/API_Documents/index.html>`_ PowerSave section for detail description of all API.


.. |image01| image:: ../../../../_static/amebad/Example_Guides/PowerSave/Power_Save_Deep_Sleep_For_DHT_Epaper/image01.png
:width: 988 px
:height: 400 px
.. |image02| image:: ../../../../_static/amebad/Example_Guides/PowerSave/Power_Save_Deep_Sleep_For_DHT_Epaper/image02.png
:width: 800 px
:height: 400 px
.. |image03| image:: ../../../../_static/amebad/Example_Guides/PowerSave/Power_Save_Deep_Sleep_For_DHT_Epaper/image03.png
:width: 1105 px
:height: 382 px
.. |image04| image:: ../../../../_static/amebad/Example_Guides/PowerSave/Power_Save_Deep_Sleep_For_DHT_Epaper/image04.png
:width: 875 px
:height: 400 px
.. |image05| image:: ../../../../_static/amebad/Example_Guides/PowerSave/Power_Save_Deep_Sleep_For_DHT_Epaper/image05.png
:width: 1189 px
:height: 572 px
.. |image06| image:: ../../../../_static/amebad/Example_Guides/PowerSave/Power_Save_Deep_Sleep_For_DHT_Epaper/image06.png
:width: 835 px
:height: 400 px
.. |image07| image:: ../../../../_static/amebad/Example_Guides/PowerSave/Power_Save_Deep_Sleep_For_DHT_Epaper/image07.png
:width: 1099 px
:height: 477 px
.. |image08| image:: ../../../../_static/amebad/Example_Guides/PowerSave/Power_Save_Deep_Sleep_For_DHT_Epaper/image08.png
:width: 993 px
:height: 496 px
.. |image09| image:: ../../../../_static/amebad/Example_Guides/PowerSave/Power_Save_Deep_Sleep_For_DHT_Epaper/image09.png
:width: 962 px
:height: 328 px
.. |image10| image:: ../../../../_static/amebad/Example_Guides/PowerSave/Power_Save_Deep_Sleep_For_DHT_Epaper/image10.png
:width: 975 px
:height: 320 px
.. |image11| image:: ../../../../_static/amebad/Example_Guides/PowerSave/Power_Save_Deep_Sleep_For_DHT_Epaper/image11.png
:width: 975 px
:height: 402 px
.. |image12| image:: ../../../../_static/amebad/Example_Guides/PowerSave/Power_Save_Deep_Sleep_For_DHT_Epaper/image12.png
:width: 908 px
:height: 400 px
.. |image13| image:: ../../../../_static/amebad/Example_Guides/PowerSave/Power_Save_Deep_Sleep_For_DHT_Epaper/image13.png
:width: 940 px
:height: 473 px
.. |image14| image:: ../../../../_static/amebad/Example_Guides/PowerSave/Power_Save_Deep_Sleep_For_DHT_Epaper/image14.png
:width: 606 px
:height: 400 px
.. |image15| image:: ../../../../_static/amebad/Example_Guides/PowerSave/Power_Save_Deep_Sleep_For_DHT_Epaper/image15.png
:width: 689 px
:height: 704 px
.. |image16| image:: ../../../../_static/amebad/Example_Guides/PowerSave/Power_Save_Deep_Sleep_For_DHT_Epaper/image16.png
:width: 957 px
:height: 647 px
.. |image17| image:: ../../../../_static/amebad/Example_Guides/PowerSave/Power_Save_Deep_Sleep_For_DHT_Epaper/image17.png
:width: 767 px
:height: 624 px
Loading