Skip to content

Added onewire to S3_BLE and S3_ALL firmwares #3039

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

Merged
merged 1 commit into from
Nov 15, 2024

Conversation

AdrianSoundy
Copy link
Member

@AdrianSoundy AdrianSoundy commented Nov 15, 2024

Description

Add onewire to ESP32_S3_BLE & ESP32_S3_ALL firmwares

Motivation and Context

How Has This Been Tested?

Built locally and checked onewire present

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
    • Enabled OneWire API support for ESP32 S3 configurations.
    • Activated I2C slave functionality in both ESP32 S3 presets.
    • Added support for graphics in ESP32 S3 configurations.
    • Allocated 1MB of SPIRAM for IDF usage in both ESP32 S3 presets.

Copy link

coderabbitai bot commented Nov 15, 2024

Walkthrough

The changes in this pull request involve modifications to the CMakePresets.json file for ESP32 targets, specifically adding and updating cache variables related to the OneWire API, I2C slave functionality, graphics support, and SPIRAM allocation. The updates apply to both the ESP32_S3_BLE and ESP32_S3_ALL presets, enabling new functionalities and memory configurations for the ESP32 S3 platform.

Changes

File Change Summary
targets/ESP32/CMakePresets.json - Added API_nanoFramework.Device.OneWire set to "ON" in ESP32_S3_BLE and ESP32_S3_ALL presets.
- Updated API_System.Device.I2c.Slave set to "ON" in both presets.
- Updated API_nanoFramework.Graphics set to "ON" in both presets.
- Added ESP32_SPIRAM_FOR_IDF_ALLOCATION set to "1024 * 1024" in both presets.

Assessment against linked issues

Objective Addressed Explanation
Add OneWire functionality to ESP32-S3 (1546)

Possibly related PRs

  • Add Generic display to ESP32_S3_BLE #2946: This PR modifies the CMakePresets.json file, adding the API_nanoFramework.Graphics variable and configuring ESP32_SPIRAM_FOR_IDF_ALLOCATION, which relates to the main PR's changes.
  • Fix UART config at OneWire init #3035: This PR focuses on the OneWire API, which is relevant since the main PR introduces the API_nanoFramework.Device.OneWire variable, indicating a connection to the OneWire functionality.

Suggested labels

Platform: ESP32


📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 2a109b0 and 1159077.

📒 Files selected for processing (1)
  • targets/ESP32/CMakePresets.json (2 hunks)
🔇 Additional comments (2)
targets/ESP32/CMakePresets.json (2)

Line range hint 386-394: LGTM! Configuration matches ESP32_S3_BLE preset.

The changes mirror those in ESP32_S3_BLE, maintaining consistency across related presets. This is the expected behavior as both presets should support the same feature set.


Line range hint 359-367: LGTM! Verify SPIRAM allocation size.

The OneWire API addition aligns with the PR objective. Additional features (I2C slave, Graphics) follow the pattern seen in other ESP32 presets. The SPIRAM allocation of 1MB matches other presets like M5Core2 and ESP32_PSRAM_BLE_GenericGraphic_REV3.

Run the following script to verify SPIRAM allocation consistency:

✅ Verification successful

SPIRAM allocation of 1MB is consistent with other graphics-enabled presets

The verification confirms that all ESP32 presets with graphics support consistently use 1MB SPIRAM allocation (1024 * 1024). This is the standard configuration across multiple presets in the codebase, making the current changes aligned with the established pattern.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Check SPIRAM allocation across different presets
# Expected: Most presets with graphics support use 1MB SPIRAM

# Search for SPIRAM allocation in presets with graphics enabled
rg -B 5 "ESP32_SPIRAM_FOR_IDF_ALLOCATION.*1024 \* 1024" | rg -B 5 "API_nanoFramework.Graphics.*ON"

Length of output: 1988


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>, please review it.
    • 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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @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 using 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.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

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.

@AdrianSoundy AdrianSoundy merged commit 395658b into nanoframework:main Nov 15, 2024
18 checks passed
@AdrianSoundy AdrianSoundy deleted the onewre branch November 15, 2024 03:28
@josesimoes josesimoes added Platform: ESP32 Everything related specifically with ESP32 platform and removed Type: enhancement labels Nov 15, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Area: Config-and-Build Platform: ESP32 Everything related specifically with ESP32 platform
Projects
None yet
Development

Successfully merging this pull request may close these issues.

ESP32-S3 Add OneWire
3 participants