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

Enabled Deep sleep for Esp32_H2 #2981

Merged
merged 1 commit into from
Jul 19, 2024
Merged

Enabled Deep sleep for Esp32_H2 #2981

merged 1 commit into from
Jul 19, 2024

Conversation

AdrianSoundy
Copy link
Member

@AdrianSoundy AdrianSoundy commented Jul 19, 2024

Description

  • Enabled deep sleep for esp32_h2r
  • Updated hardware.esp32 header after change
  • Renamed variable from a previous PR rename

Motivation and Context

How Has This Been Tested?

Locally

Types of changes

  • Improvement (non-breaking change that improves a feature, code or algorithm)
  • Bug fix (non-breaking change which fixes an issue with code or algorithm)
  • New feature (non-breaking change which adds functionality to code)
  • Breaking change (fix or feature that would cause existing functionality to change)
  • Config and build (change in the configuration and build system, has no impact on code or features)
  • Dev Containers (changes related with Dev Containers, has no impact on code or features)
  • Dependencies/declarations (update dependencies or assembly declarations and changes associated, has no impact on code or features)
  • Documentation (changes or updates in the documentation, has no impact on code or features)

Checklist

  • My code follows the code style of this project (only if there are changes in source code).
  • My changes require an update to the documentation (there are changes that require the docs website to be updated).
  • I have updated the documentation accordingly (the changes require an update on the docs in this repo).
  • I have read the CONTRIBUTING document.
  • I have tested everything locally and all new and existing tests passed (only if there are changes in source code).

Summary by CodeRabbit

  • New Features

    • Expanded GPIO pin options for wake-up events, adding multiple new pins for enhanced control (Pin1, Pin3, Pin5, Pin6, Pin7, Pin8, Pin9, Pin10, Pin11, Pin16, Pin17, Pin18, Pin19, Pin20, Pin21).
  • Improvements

    • Renamed GpioChangePolarity to GpioPulsePolarity for clearer understanding of GPIO pulse behavior.
    • Updated logic for GPIO pulse counting to use the new GpioPulsePolarity terminology, improving code clarity and maintainability.
    • Simplified power mode control by removing conditional compilation, making power mode management more consistent across different hardware targets.

Update hardware esp32 header

Updated code from previous rename
Copy link

coderabbitai bot commented Jul 19, 2024

Walkthrough:

The changes primarily involve expanding the GPIO pin options and renaming an enumeration for GPIO pulse polarity in the ESP32 hardware library. Additional modifications include updating function parameters to reflect the new enumeration and removing a conditional compilation directive to simplify power mode management.

Changes:

File Path Change Summary
.../nanoFramework_hardware_esp32_native.h Expanded Sleep_WakeupGpioPin enumeration with additional GPIO pins and renamed GpioChangePolarity to GpioPulsePolarity.
.../nanoFramework_hardware_esp32_native_System_Device_Gpio_GpioPulseCounter.cpp Updated function signatures and logic to use the new GpioPulsePolarity enum.
.../targetHAL_Power.c Removed conditional compilation directive to unconditionally define the CPU_SetPowerMode function for all power levels.

Sequence Diagram(s):

sequenceDiagram
    participant User
    participant GpioPulseCounter
    participant Esp32Hardware
    User->>GpioPulseCounter: Initialize Edge and Actions with GpioPulsePolarity
    GpioPulseCounter->>Esp32Hardware: Set up GPIO Pulse Polarity
    Esp32Hardware-->>GpioPulseCounter: Confirmation
    GpioPulseCounter-->>User: Initialization Complete
Loading

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share
Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 9252f96 and bef1dd9.

Files selected for processing (3)
  • targets/ESP32/_nanoCLR/nanoFramework.Hardware.ESP32/nanoFramework_hardware_esp32_native.h (2 hunks)
  • targets/ESP32/_nanoCLR/nanoFramework.Hardware.ESP32/nanoFramework_hardware_esp32_native_System_Device_Gpio_GpioPulseCounter.cpp (3 hunks)
  • targets/ESP32/_nanoCLR/targetHAL_Power.c (2 hunks)
Additional comments not posted (6)
targets/ESP32/_nanoCLR/targetHAL_Power.c (1)

Line range hint 23-37:
LGTM! But verify the handling of other power levels.

The code changes are approved.

However, ensure that the default case handling other power levels is intentional and verify if additional power levels need to be managed.

targets/ESP32/_nanoCLR/nanoFramework.Hardware.ESP32/nanoFramework_hardware_esp32_native_System_Device_Gpio_GpioPulseCounter.cpp (3)

Line range hint 308-358:
LGTM!

The function initializes the GPIO pulse counter and reserves the pins for counter use. No changes were made to this function.


423-423: LGTM!

The function starts the GPIO pulse counter and initializes the edge and actions using the new parameter type GpioPulsePolarity.


Line range hint 162-186:
LGTM! But verify the usage of InitialiseEdgeAndActions with the new parameter type.

The code changes are approved.

However, ensure that all calls to InitialiseEdgeAndActions are updated to use the new parameter type GpioPulsePolarity.

Verification successful

LGTM! But verify the usage of InitialiseEdgeAndActions with the new parameter type.

The code changes are approved.

Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Verify all calls to `InitialiseEdgeAndActions` use the new parameter type `GpioPulsePolarity`.

# Test: Search for the function usage. Expect: Only occurances of the new parameter type.
rg --type cpp -A 5 $'InitialiseEdgeAndActions'

Length of output: 2003


Script:

#!/bin/bash
# Description: Verify all calls to `InitialiseEdgeAndActions` use the new parameter type `GpioPulsePolarity`.

# Test: Search for the function usage across the entire codebase. Expect: Only occurrences of the new parameter type.
rg --type cpp --word InitialiseEdgeAndActions

Length of output: 485


Script:

#!/bin/bash
# Description: Verify all calls to `InitialiseEdgeAndActions` use the new parameter type `GpioPulsePolarity`.

# Test: Search for the function usage across the entire codebase. Expect: Only occurrences of the new parameter type.
rg --type cpp --word-regexp InitialiseEdgeAndActions

Length of output: 466

targets/ESP32/_nanoCLR/nanoFramework.Hardware.ESP32/nanoFramework_hardware_esp32_native.h (2)

71-91: LGTM!

The enumeration Sleep_WakeupGpioPin has been expanded to include multiple new GPIO pin options, enhancing the functionality of the GPIO pin management in the ESP32 framework.


244-249: LGTM!

The enumeration GpioChangePolarity has been renamed to GpioPulsePolarity, aligning with the updated design principles or clarity in usage. The enumeration values remain unchanged.

Copy link
Member

@Ellerbach Ellerbach left a comment

Choose a reason for hiding this comment

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

Looks good!

@josesimoes josesimoes added Platform: ESP32 Everything related specifically with ESP32 platform and removed Type: bug labels Jul 19, 2024
@AdrianSoundy AdrianSoundy merged commit 1236b8b into nanoframework:main Jul 19, 2024
17 checks passed
TerryFogg pushed a commit to TerryFogg/nf-interpreter that referenced this pull request Dec 3, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Platform: ESP32 Everything related specifically with ESP32 platform Type: bug
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants