particle-iot / particle-iot/docs

What causes wake-up from System.sleep(uint16_t wakeUpPin, uint16_t edgeTriggerMode, long seconds)

Open
#428 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement firmware
Dominant language
JavaScript
Stars
148
Forks
266
Avg merge
14h 41m
Merged PRs (30d)
16

Description

The Electron documentation states that:

"System.sleep(uint16_t wakeUpPin, uint16_t edgeTriggerMode, long seconds) can be used to put the entire device into a stop mode with wakeup on interrupt or wakeup after specified seconds. In this particular mode, the device shuts network subsystem and puts the microcontroller in a stop mode with configurable wakeup pin and edge triggered interrupt or wakeup after the specified seconds. When the specific interrupt arrives or upon reaching the configured timeout"

"When the specific interrupt arrives" is incorrect. The Electron will wake-up on the given pin but also on an edge from the WKP pin or, as far as I know, any other interrupt source. This should be made absolutely clear. Based on the information provided I have a design with something wired to the 'WKP' pin, just in case I decided it was good to be woken up, and assuming that if I decided otherwise I could simply specify some other pin in the above call to remove the feature. It seems that is actually not possible.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Find the Electron documentation entry for System.sleep(uint16_t wakeUpPin, uint16_t edgeTriggerMode, long seconds) and read the surrounding wake-up behavior description. Revise the wording so it clearly covers the wake sources reported in this issue, including the given pin and other interrupt sources, then verify the resulting documentation is unambiguous.

Written by the indexing model from the issue text.

Assessment

Domain
documentation, embedded-iot
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
38/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.