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

Fixes sigmaDeltaAttach() when another peripheral is already attached using the same pin #9268

Merged
merged 1 commit into from
Feb 21, 2024

Conversation

SuGlider
Copy link
Collaborator

Description of Change

If a pin is attached to another peripheral and it is latter attached to SigmaDelta, it won't correctly detach the previous peripheral.
This PR fixes it, including when the DeltaSigma frequency is changed.

Tests scenarios

ESP32

#define PIN 2
void setup() {
  // Peripheral Manager will attach pin 2 UART (RX) - TX is the UART0 default pin.
  Serial.begin(115200, SERIAL_8N1, PIN);
  Serial.println("Serial pins - RX (pin 2) and TX (default) are attached");
  delay(1000);

  //Peripheral manage will detach pin 2 from UART (TX) and attach it to LEDC
  analogWrite(PIN, 100); // by default it will use 1KHz, 8 bits resolution
  Serial.println("Pin 2 is attached to LEDC");
  delay(5000);

  // Peripheral manager will detach pin 2 from LEDC and attach it to SigmaDelta
  sigmaDeltaAttach(PIN, 312500);
  sigmaDeltaWrite(PIN, 10);     // Start SigmaDelta
  Serial.println("Pin 2 is attached to SigmaDelta");
  delay(5000);
}

void loop() {}

Related links

#9257 (comment)

@SuGlider SuGlider added the Type: Bug 🐛 All bugs label Feb 20, 2024
@SuGlider SuGlider added this to the 3.0.0-RC1 milestone Feb 20, 2024
@SuGlider SuGlider self-assigned this Feb 20, 2024
Copy link
Contributor

github-actions bot commented Feb 20, 2024

Warnings
⚠️

Some issues found for the commit messages in this PR:

  • the commit message "Fix(sigmaDelta): fixes sigmaDeltaAttach() when another peripheral is already attached":
    • scope/component should be lowercase without whitespace, allowed special characters are _ / . , * - .
    • type/action should start with a lowercase letter
    • type/action should be one of [change, ci, docs, feat, fix, refactor, remove, revert, test]

Please fix these commit messages - here are some basic tips:

  • follow Conventional Commits style
  • correct format of commit message should be: <type/action>(<scope/component>): <summary>, for example fix(esp32): Fixed startup timeout issue
  • allowed types are: change,ci,docs,feat,fix,refactor,remove,revert,test
  • sufficiently descriptive message summary should be between 20 to 72 characters and start with upper case letter
  • avoid Jira references in commit messages (unavailable/irrelevant for our customers)

TIP: Install pre-commit hooks and run this check when committing (uses the Conventional Precommit Linter).

⚠️

The source branch "sigmaDelta-Attach-patch" incorrect format:

  • contains uppercase letters. This can cause troubles on case-insensitive file systems (macOS).
    Please rename your branch.

👋 Hello SuGlider, we appreciate your contribution to this project!


Click to see more instructions ...


This automated output is generated by the PR linter DangerJS, which checks if your Pull Request meets the project's requirements and helps you fix potential issues.

DangerJS is triggered with each push event to a Pull Request and modify the contents of this comment.

Please consider the following:
- Danger mainly focuses on the PR structure and formatting and can't understand the meaning behind your code or changes.
- Danger is not a substitute for human code reviews; it's still important to request a code review from your colleagues.
- Resolve all warnings (⚠️ ) before requesting a review from human reviewers - they will appreciate it.
- To manually retry these Danger checks, please navigate to the Actions tab and re-run last Danger workflow.

Review and merge process you can expect ...


We do welcome contributions in the form of bug reports, feature requests and pull requests.

1. An internal issue has been created for the PR, we assign it to the relevant engineer.
2. They review the PR and either approve it or ask you for changes or clarifications.
3. Once the GitHub PR is approved we do the final review, collect approvals from core owners and make sure all the automated tests are passing.
- At this point we may do some adjustments to the proposed change, or extend it by adding tests or documentation.
4. If the change is approved and passes the tests it is merged into the default branch.

Generated by 🚫 dangerJS against ecd67f5

@P-R-O-C-H-Y P-R-O-C-H-Y added Area: Peripherals API Relates to peripheral's APIs. Status: Pending Merge Pull Request is ready to be merged labels Feb 21, 2024
@me-no-dev me-no-dev merged commit f2a5041 into master Feb 21, 2024
54 of 57 checks passed
@me-no-dev me-no-dev deleted the sigmaDelta-Attach-patch branch February 21, 2024 14:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Area: Peripherals API Relates to peripheral's APIs. Status: Pending Merge Pull Request is ready to be merged Type: Bug 🐛 All bugs
Projects
Development

Successfully merging this pull request may close these issues.

4 participants