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

feat: added documentation for Power Source #157

Merged
merged 1 commit into from
Mar 23, 2025

Conversation

Tejasgarg
Copy link
Contributor

@Tejasgarg Tejasgarg commented Mar 20, 2025

  • Please check if the PR fulfills these requirements
  • The commit message follows our guidelines
  • Tests for the changes have been added (for bug fixes / features)
  • Docs have been added / updated (for bug fixes / features)
  • What kind of change does this PR introduce? (Bug fix, feature, docs update, ...)
  • Bug fix
  • Feature implementation
  • Doc updates
  • What changes have you introduced?
    Added documentation for Power Source.

  • Does this PR introduce a breaking change?
    No.

Summary by Sourcery

Documentation:

  • Adds documentation for the Power Source feature, including information on voltage and current source ranges, usage instructions, and example experiments for powering an LED and a buzzer.

Copy link

sourcery-ai bot commented Mar 20, 2025

Reviewer's Guide by Sourcery

This pull request introduces comprehensive documentation for the Power Source feature of PSLab. It explains what a power source is, details the current power source ranges available in PSLab, and provides step-by-step instructions on how to use the power sources. The documentation includes two experiments: powering an LED and powering a buzzer, both using the PSLab's inbuilt power supply.

No diagrams generated as the changes look simple and do not need a visual representation.

File-Level Changes

Change Details Files
Added documentation explaining what a power source is and listing the available voltage and current source ranges in PSLab.
  • Defined what a power source is.
  • Listed the voltage source ranges: PV1 (± 5 V), PV2 (± 3.3 V), PV3 (0-3 V).
  • Listed the current source range: PCS (0 - 3.3 mA).
tutorials/powersource.md
Provided instructions on how to use the variable power supply, including connecting terminals and setting desired values.
  • Explained how to connect the terminals from the PSLab board to the output node.
  • Outlined the procedure for supplying power, including selecting the power source and setting the desired value.
tutorials/powersource.md
Included a detailed experiment on powering an LED with PSLab, covering the goal, materials required, procedure, observations, and conclusion.
  • Defined the goal of the experiment: to power an LED using the PSLab inbuilt power supply.
  • Listed the materials required: Android phone, PSLab Android App, and a white LED.
  • Provided a step-by-step procedure for powering the LED using Voltage Source 2 (PV2).
  • Included observations and a conclusion confirming the successful powering of the LED.
tutorials/powersource.md
Added a detailed experiment on powering a buzzer with PSLab, covering the goal, materials required, procedure, observations, and conclusion.
  • Defined the goal of the experiment: to power a buzzer using the PSLab inbuilt power supply.
  • Listed the materials required: Android phone, PSLab Android App, and a buzzer.
  • Provided a step-by-step procedure for powering the buzzer using Voltage Source 1 (PV1).
  • Included observations and a conclusion confirming the successful powering of the buzzer.
tutorials/powersource.md
Added a section on important features of the power source, highlighting the relationships between PV1 and PV3, and PV2 and PCS.
  • Stated that PV1 and PV3 are proportional to each other.
  • Stated that PV2 and PCS are inversely proportional.
tutorials/powersource.md

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!
  • Generate a plan of action for an issue: Comment @sourcery-ai plan on
    an issue to generate a plan of action for it.

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

Copy link

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

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

Hey @Tejasgarg - I've reviewed your changes - here's some feedback:

Overall Comments:

  • Consider adding a brief introduction to the PSLab and its purpose for readers unfamiliar with the project.
  • It would be helpful to include a diagram or schematic illustrating how to connect the PSLab to the LED and buzzer.
Here's what I looked at during the review
  • 🟢 General issues: all looks good
  • 🟢 Security: all looks good
  • 🟢 Testing: all looks good
  • 🟢 Complexity: all looks good
  • 🟢 Documentation: all looks good

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

@Tejasgarg Tejasgarg force-pushed the power_source_improvements branch from 52d58c4 to b0ffb72 Compare March 20, 2025 12:25
@AsCress AsCress requested a review from bessman March 20, 2025 12:27
Copy link
Contributor

@bessman bessman left a comment

Choose a reason for hiding this comment

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

Excellent addition, thank you!

@bessman bessman merged commit 4694a74 into fossasia:master Mar 23, 2025
1 check passed
@Tejasgarg
Copy link
Contributor Author

thank you sir

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants