Skip to content

Commit c847528

Browse files
authored
Merge pull request #209 from pycom/AnkithB2020-patch-1
Update _index.md: pin_deepsleep_wakeup() renamed
2 parents 6a3f037 + a2d5481 commit c847528

File tree

2 files changed

+5
-117
lines changed

2 files changed

+5
-117
lines changed

content/firmwareapi/pycom/machine/README.md

Lines changed: 0 additions & 111 deletions
This file was deleted.

content/firmwareapi/pycom/machine/_index.md

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -50,17 +50,17 @@ Gates the clock to the CPU, useful to reduce power consumption at any time durin
5050

5151
Stops the CPU and all peripherals, including the networking interfaces (except for LTE). Execution is resumed from the main script, just as with a reset. If a value in milliseconds is given then the device will wake up after that period of time, otherwise it will remain in deep sleep until the reset button is pressed.
5252

53-
The products with LTE connectivity (FiPy, GPy, G01), require the LTE radio to be disabled separately via the LTE class before entering deepsleep. This is required due to the LTE radio being powered independently and allowing use cases which require the system to be taken out from deepsleep by an event from the LTE network (data or SMS received for instance).
53+
Products with LTE connectivity, such as the FiPy, GPy, G01, need to have the LTE radio disabled separately via the LTE class before entering deepsleep. This is necessary because the LTE radio is powered independently, which allows for use cases that wake the system from deepsleep by an event from the LTE network, for example receiving data or an SMS.
5454

55-
#### machine.pin\_deepsleep\_wakeup(pins, mode, enable\_pull)
55+
#### machine.pin\_sleep\_wakeup(pins, mode, enable\_pull)
5656

57-
Configure pins to wake up from deep sleep mode. The pins which have this capability are: `P2, P3, P4, P6, P8 to P10 and P13 to P23`.
57+
Configure pins to wake up from sleep mode. The pins which have this capability are: `P2, P3, P4, P6, P8 to P10 and P13 to P23`.
5858

5959
The arguments are:
6060

61-
* `pins` a list or tuple containing the `GPIO` to setup for deepsleep wakeup.
61+
* `pins` a list or tuple containing the `GPIO` to setup for sleep wakeup.
6262
* `mode` selects the way the configure `GPIO`s can wake up the module. The possible values are: `machine.WAKEUP_ALL_LOW` and `machine.WAKEUP_ANY_HIGH`.
63-
* `enable_pull` if set to `True` keeps the pull up or pull down resistors enabled during deep sleep. If this variable is set to `True`, then `ULP` or capacitive touch wakeup cannot be used in combination with `GPIO` wakeup.
63+
* `enable_pull` if set to `True` keeps the pull up or pull down resistors enabled during sleep. If this variable is set to `True`, then `ULP` or capacitive touch wakeup cannot be used in combination with `GPIO` wakeup.
6464

6565
#### machine.wake\_reason()
6666

@@ -107,4 +107,3 @@ Returns the high water mark of the stack associated with various system tasks, i
107107
### Pin Wakeup Modes
108108

109109
`machine.WAKEUP_ALL_LOW`, `machine.WAKEUP_ANY_HIGH`
110-

0 commit comments

Comments
 (0)