Skip to content
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.

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

Update 'WakeupCause' enum to match IDF #92

Merged
merged 2 commits into from
Feb 27, 2020

Conversation

oleneveu
Copy link
Contributor

@oleneveu oleneveu commented Feb 26, 2020

Description

Added 3 missing entries in the enum 'WakeUpCause':

  • WakeupCause.All
  • WakeupCause.Gpio
  • WakeupCause.Uart

These entries are declared in the original C enum 'esp_sleep_source_t', but were missing in C#.
The 2 last entries comes at the end of the enum and have no effect on the integer value of the enum entries, but 'WakeupCause.All' comes in second position of the enum and changes the ordinal of all following entries.

Motivation and Context

When returning from sleep, the enum value returned by 'Sleep.GetWakeupCause()' does not match the actual cause of the sleep.

How Has This Been Tested?

Basic test: Using the sample project 'HardwareEsp32', the return value of 'Sleep.GetWakeupCause()' was casted to the new declaration of the enum with success.

Types of changes

  • Improvement (non-breaking change that improves a feature, code or algorithm)
  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)

Checklist:

  • My code follows the code style of this project.
  • My change requires a change to the documentation.
  • I have updated the documentation accordingly.
  • I have read the CONTRIBUTING document.
  • I have added tests to cover my changes.
  • All new and existing tests passed.

Signed-off-by: oleneveu oleneveu@gmail.com

@nfbot
Copy link
Member

nfbot commented Feb 26, 2020

Hi @oleneveu,

I'm nanoFramework bot.
Thank you for your contribution!

A human will be reviewing it shortly. 😉

@claassistantio
Copy link

claassistantio commented Feb 26, 2020

CLA assistant check
All committers have signed the CLA.

@josesimoes josesimoes changed the title Fixed the enum 'WakeupCause' that did not match the original C enum '… Update 'WakeupCause' enum to match IDF Feb 27, 2020
- Remove ALL from enum as it's not an wakeup cause.
- Minor tweek in documentation comments.
Copy link
Member

@josesimoes josesimoes left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could you please test the changes I've made? Should be OK, but better be safe...

@sonarcloud
Copy link

sonarcloud bot commented Feb 27, 2020

Kudos, SonarCloud Quality Gate passed!

Bug A 0 Bugs
Vulnerability A 0 Vulnerabilities (and Security Hotspot 0 Security Hotspots to review)
Code Smell A 0 Code Smells

No Coverage information No Coverage information
0.0% 0.0% Duplication

Copy link
Contributor Author

@oleneveu oleneveu left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Confirmed to work on my test project.

@josesimoes josesimoes merged commit db9eeec into nanoframework:develop Feb 27, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants