Passive Buzzer Documentation #208

adelgadoj3 · 2024-03-20T22:14:23Z

Created passive buzzer documentation, added circuit diagram, and added link to index documentation

ruthvikm

Add example controller at the end.
Add Passive Buzzer Javadoc in the functionality section. Refer to touch switch documentation.

joefol

Looks good to me!

adelgadoj3 · 2024-03-21T18:22:14Z

Add example controller at the end.

Add Passive Buzzer Javadoc in the functionality section. Refer to touch switch documentation.

Should I incorporate the schematic diagram and/or the buzzer diagram as well?

ruthvikm

To add example controller, you need to add //tag::ex[] in passivebuzzerController class

ruthvikm · 2024-03-21T19:16:20Z

pi4micronaut-utils/src/docs/asciidoc/index.adoc

@@ -77,4 +77,6 @@ include::components/outputComponents/rgbLed.adoc[]

 include::components/outputComponents/lcd1602.adoc[]

+include :: components/outputComponents/passivebuzzer.adoc[]


Remove space here - include::components....

ruthvikm · 2024-03-21T19:24:35Z

Schematic diagram will be useful

SwindleA

other than that one possible issue. It looks good.

pi4micronaut-utils/src/docs/asciidoc/components/outputComponents/passivebuzzer.adoc

ruthvikm · 2024-03-21T19:49:46Z

pi4micronaut-utils/src/docs/asciidoc/components/outputComponents/passivebuzzer.adoc

+    * Verify that 1K resistor is used
+    * Verify all wires are in appropriate slots.
+    * When using a file, verify that the file itself is scp'd to the raspberrypi (see PassiveBuzzerController for full information).
+


Add constructors and methods senction with passiveBuzzer javadoc link.
https://oss-slu.github.io/Pi4Micronaut/javadoc/com/opensourcewithslu/outputdevices/PassiveBuzzerHelper.html

…buzzer issue. Once that is merged the img conflict should resolve here.

ruthvikm

Resolve conflicts

…be on the same line. Should resolve conflict

Signed-off-by: adelgadoj3 <[email protected]>

ruthvikm · 2024-03-24T00:16:26Z

pi4micronaut-utils/src/docs/asciidoc/components/outputComponents/passivebuzzer.adoc

+===== Circuit Diagram
+Schematic Diagram
+
+image::buzzer-SD.png[]


this image was not uploaded

I added the image in the active buzzer documentation issue.

ruthvikm

Resolve conflicts

Signed-off-by: adelgadoj3 <[email protected]>

Requested changes has been made

* PIR sensor implementation Issue #166 (#181) * start PIR sensor implementation * PIR sensor helper and controller updates * fix spelling mistake in controller * pir output to input changes * pir output to input location changes * added javadocs in helper and changed rgb colors * address changes with yml and pir controller * fix typo in pir controller * Fixed Integration Bugs (#187) * Fixed javadoc errors (#189) * Javadoc errors (#190) * Fixed javadoc errors * removed javadoc from .gitignore * Passive Buzzer Implementation (#182) * Implemented passive buzzer helper * Implemented passive buzzer controller and updated yaml to contain passive buzzer. * Created additional test functions for the passive buzzer. Modified the sequence function. * Refactored functions in helper to appropriately change frequencies. Corresponding function in the controller needs work to accept parameters from an array. * Modified setFrequencies function to accept File as parameter. Has not been tested. * Modified and tested the functionality of the Helper: setFrequencies method & Controller: defineFrequency method. Added comments for usage of the controller method to ensure ease of use. * Resolved lack of javadoc comments * Refactored function names and included appropriate javadoc comments * Added javadoc comments * resolved javadocs conflicts --------- Co-authored-by: ruthvikm <[email protected]> * Adoc Updates (#188) * updating adocs * how to use pi4micronaut * how to use pi4micronaut adoc updates * adoc updates * indent fix * adoc changes addressed * adoc changes * adoc link updates * adoc indent fix * adoc fix * adoc final updates * adoc final final updates * Fixes LCD - closes issue #116 (#184) * set lcd display to 2 rows instead of 4 rows * test solution for lcd * using i2cconfig in the lcd display constructor * 32 bit note in asciidoc, new methods and controller stuff for lcd * only working methods, and log info * Added write text to position --------- Co-authored-by: ruthvikm <[email protected]> Co-authored-by: Ruthvik Mannem <[email protected]> * outlined ultrasound sensor component (#185) * outlined ultrasound sensor component * Working ultra sonic sensor * added javadocs for ultra sonic sensor classes --------- Co-authored-by: ruthvikm <[email protected]> Co-authored-by: Ruthvik Mannem <[email protected]> * Updating develop (#193) * Adding the new components from develop (#191) * PIR sensor implementation Issue #166 (#181) * start PIR sensor implementation * PIR sensor helper and controller updates * fix spelling mistake in controller * pir output to input changes * pir output to input location changes * added javadocs in helper and changed rgb colors * address changes with yml and pir controller * fix typo in pir controller * Fixed Integration Bugs (#187) * Fixed javadoc errors (#189) * Javadoc errors (#190) * Fixed javadoc errors * removed javadoc from .gitignore * Passive Buzzer Implementation (#182) * Implemented passive buzzer helper * Implemented passive buzzer controller and updated yaml to contain passive buzzer. * Created additional test functions for the passive buzzer. Modified the sequence function. * Refactored functions in helper to appropriately change frequencies. Corresponding function in the controller needs work to accept parameters from an array. * Modified setFrequencies function to accept File as parameter. Has not been tested. * Modified and tested the functionality of the Helper: setFrequencies method & Controller: defineFrequency method. Added comments for usage of the controller method to ensure ease of use. * Resolved lack of javadoc comments * Refactored function names and included appropriate javadoc comments * Added javadoc comments * resolved javadocs conflicts --------- Co-authored-by: ruthvikm <[email protected]> * Adoc Updates (#188) * updating adocs * how to use pi4micronaut * how to use pi4micronaut adoc updates * adoc updates * indent fix * adoc changes addressed * adoc changes * adoc link updates * adoc indent fix * adoc fix * adoc final updates * adoc final final updates * Fixes LCD - closes issue #116 (#184) * set lcd display to 2 rows instead of 4 rows * test solution for lcd * using i2cconfig in the lcd display constructor * 32 bit note in asciidoc, new methods and controller stuff for lcd * only working methods, and log info * Added write text to position --------- Co-authored-by: ruthvikm <[email protected]> Co-authored-by: Ruthvik Mannem <[email protected]> * outlined ultrasound sensor component (#185) * outlined ultrasound sensor component * Working ultra sonic sensor * added javadocs for ultra sonic sensor classes --------- Co-authored-by: ruthvikm <[email protected]> Co-authored-by: Ruthvik Mannem <[email protected]> --------- Co-authored-by: Joe Folen <[email protected]> Co-authored-by: adelgadoj3 <[email protected]> Co-authored-by: Adrian Swindle <[email protected]> Co-authored-by: jyanev <[email protected]> * Fixed Signing Issue (#192) * Fixed Signing Issue * trying to fix Signing Issue * trying to fix1 Signing Issue * trying to fix2 Signing Issue * Release --------- Co-authored-by: Joe Folen <[email protected]> Co-authored-by: adelgadoj3 <[email protected]> Co-authored-by: Adrian Swindle <[email protected]> Co-authored-by: jyanev <[email protected]> * Revert "Updating develop (#193)" (#194) This reverts commit 26c0345. * added documentation for ultrasonic sensor * Starting touch switch documentation * added updated circuit images * fixed issues w documentation * further updates to touch switch documentation * further further updates to touch switch documentation * final updates to touch switch adoc * final final updates to touch switch adoc * addresses yml change in adoc * Fixed unsatisfied dependency * grammar fix * Architecture diagram update. Issue 209 (#215) * update architecture diagram in readme * include file in readme * actually include file in readme * actually include file in readme * deleted sections 4,5 from documentation; added descriptions for i2c, multipin, pwm * 197 active buzzer documentation (#214) * Created initial draft of Active Buzzer documentation, updated index.adoc with link, and added Circuit diagram * Corrected error in assembly instructions * Implemented requested changes and added schematic diagram --------- Signed-off-by: adelgadoj3 <[email protected]> * Passive Buzzer Documentation (#208) * Began process for documentation. Needs functionality information. * Added further information about functionality and overview. * Incorporated requested changes: javadoc and example controller * Implemented requested changes. buzzer-SD.png was added in with activebuzzer issue. Once that is merged the img conflict should resolve here. * left out index.adoc fix for passive adoc link. Implemented * Touch switch was not incorporated into the file.Causing two links to be on the same line. Should resolve conflict * Didn't resolve conflict. Removed link. --------- Signed-off-by: adelgadoj3 <[email protected]> * PIR Sensor Documentation- fixes issue #200 (#216) * pirsensor documentation draft * pir sensor documentation * fixed improve this doc link for pir * fix spaces per request Signed-off-by: Adrian Swindle <[email protected]> --------- Signed-off-by: Adrian Swindle <[email protected]> * added desc for debounce in digitalinput adoc * Fixes #211 Blink Functionality for LED (#220) * Implemeted blink functionality into the LEDHelper and LEDController. * Updated .adoc with functionality. * Removed comment for clarity of function * updated issue-201; made changes to adocs * updated component adocs * fixed typos * fixed typos * corrections to adocs * small edits to adocs * Config Workflow Diagram in adoc. Issue #210 (#219) * added config workflow image * added commun with hardware adoc details * added utilities description to commun adoc * addresses changes requested * final updates to adocs * Fixed few documentation bugs * Fixed few more bugs * added info for components * adjusted TOC width * beginning servo motor implementation * servo motor updates * fixed rfid adoc (#226) * servo motor updates * servo motor updates * setAngle update in helper * arm moves inaccurately * setAngle and map updates in helper * updated map logic in helper * Fixes #224 | Started basis of photoresistorSensor documentation (#227) * Started basis of photoresistorSensor documentation * Added the preliminary information for testing * Added more information to the .adoc. Still need to add the Circuit Diagram * Incorporated Circuit Diagram into .adoc, added .png file to img folder, and add ex tag to PhotoResistorController * Updated .adoc with changes. Added index.adoc file with photoresistorSensor link. * Provided accurate circuit diagram for photoresistor with help from Aswindle. Provided updated circuit diagram for LED also with help from Aswindle. Implemented further changes from comments within pull request. --------- Co-authored-by: Alex Delgado <[email protected]> Co-authored-by: Adrian Swindle <[email protected]> * servo motor works for 0 to 180 * added tag in controller * Fixes #230 | Servo Motor Documentation (#231) * Created the basis of the Servo Motor documentation * Implemented links to other files now that the controller and helper are merged. Need both Circuit Diagram & Schematic Diagram. * Implemented circuit diag. & schematic diag. into .adoc. Added both diagrams to img folder. * Implemented requested changes. * Tilt Switch implementation. Issue #40 (#232) * tilt switch controller and helper * added javadocs to helper * fixed error in TouchSwitchHelper * added comments to controller * Completes #233 :Micro Switch Implementation (#234) * touch switch logger typo fix * draft of micro switch helper, controller and application.yml * fix injection in controller micro switch * added controller comments Signed-off-by: Adrian Swindle <[email protected]> * debounced updated Signed-off-by: Adrian Swindle <[email protected]> --------- Signed-off-by: Adrian Swindle <[email protected]> * Tilt switch documentation (#236) * begin tiltSwitch docs and fix error in touchSwitch doc * adding diagrams * added assembly instructions * Updated README.md (#239) Signed-off-by: Ruthvik Mannem <[email protected]> * added micro switch documentation (#240) * Update documentation (#241) * updated added_dependency.png * doc bug fix --------- Signed-off-by: adelgadoj3 <[email protected]> Signed-off-by: Adrian Swindle <[email protected]> Signed-off-by: Ruthvik Mannem <[email protected]> Co-authored-by: Joe Folen <[email protected]> Co-authored-by: adelgadoj3 <[email protected]> Co-authored-by: Adrian Swindle <[email protected]> Co-authored-by: jyanev <[email protected]> Co-authored-by: jyanev <[email protected]> Co-authored-by: Joe Folen <[email protected]> Co-authored-by: Alex Delgado <[email protected]>

Began process for documentation. Needs functionality information.

cf45fee

adelgadoj3 linked an issue Mar 20, 2024 that may be closed by this pull request

Passive Buzzer Documentation #198

Closed

5 tasks

Added further information about functionality and overview.

e82d4f4

adelgadoj3 requested review from SwindleA, jyanev, joefol and ruthvikm March 21, 2024 15:14

ruthvikm requested changes Mar 21, 2024

View reviewed changes

ruthvikm marked this pull request as ready for review March 21, 2024 16:27

ruthvikm assigned adelgadoj3 Mar 21, 2024

Incorporated requested changes: javadoc and example controller

d5bf67f

adelgadoj3 requested a review from ruthvikm March 21, 2024 16:51

joefol approved these changes Mar 21, 2024

View reviewed changes

ruthvikm requested changes Mar 21, 2024

View reviewed changes

SwindleA previously requested changes Mar 21, 2024

View reviewed changes

pi4micronaut-utils/src/docs/asciidoc/components/outputComponents/passivebuzzer.adoc Show resolved Hide resolved

ruthvikm reviewed Mar 21, 2024

View reviewed changes

Implemented requested changes. buzzer-SD.png was added in with active…

5728c7c

…buzzer issue. Once that is merged the img conflict should resolve here.

adelgadoj3 requested review from SwindleA and ruthvikm March 21, 2024 20:32

left out index.adoc fix for passive adoc link. Implemented

dc05612

ruthvikm requested changes Mar 23, 2024

View reviewed changes

adelgadoj3 and others added 3 commits March 23, 2024 09:51

Touch switch was not incorporated into the file.Causing two links to …

0ebf42e

…be on the same line. Should resolve conflict

Didn't resolve conflict. Removed link.

ccb11db

Merge branch 'develop' into 198-passive-buzzer-documentation

578c8b4

Signed-off-by: adelgadoj3 <[email protected]>

adelgadoj3 requested a review from ruthvikm March 23, 2024 14:59

ruthvikm requested changes Mar 24, 2024

View reviewed changes

ruthvikm approved these changes Mar 24, 2024

View reviewed changes

ruthvikm requested changes Mar 25, 2024

View reviewed changes

Merge branch 'develop' into 198-passive-buzzer-documentation

617fa16

Signed-off-by: adelgadoj3 <[email protected]>

ruthvikm approved these changes Mar 25, 2024

View reviewed changes

ruthvikm merged commit ac620b3 into develop Mar 25, 2024
4 checks passed

ruthvikm deleted the 198-passive-buzzer-documentation branch March 25, 2024 00:42

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Passive Buzzer Documentation #208

Passive Buzzer Documentation #208

adelgadoj3 commented Mar 20, 2024

ruthvikm left a comment •

edited by adelgadoj3

Loading

joefol left a comment

adelgadoj3 commented Mar 21, 2024

ruthvikm left a comment

ruthvikm Mar 21, 2024

ruthvikm commented Mar 21, 2024

SwindleA left a comment

ruthvikm Mar 21, 2024

ruthvikm left a comment

ruthvikm Mar 24, 2024

adelgadoj3 Mar 24, 2024

ruthvikm left a comment

		@@ -77,4 +77,6 @@ include::components/outputComponents/rgbLed.adoc[]

		include::components/outputComponents/lcd1602.adoc[]

		include :: components/outputComponents/passivebuzzer.adoc[]

Passive Buzzer Documentation #208

Passive Buzzer Documentation #208

Conversation

adelgadoj3 commented Mar 20, 2024

ruthvikm left a comment • edited by adelgadoj3 Loading

Choose a reason for hiding this comment

joefol left a comment

Choose a reason for hiding this comment

adelgadoj3 commented Mar 21, 2024

ruthvikm left a comment

Choose a reason for hiding this comment

ruthvikm Mar 21, 2024

Choose a reason for hiding this comment

ruthvikm commented Mar 21, 2024

SwindleA left a comment

Choose a reason for hiding this comment

ruthvikm Mar 21, 2024

Choose a reason for hiding this comment

ruthvikm left a comment

Choose a reason for hiding this comment

ruthvikm Mar 24, 2024

Choose a reason for hiding this comment

adelgadoj3 Mar 24, 2024

Choose a reason for hiding this comment

ruthvikm left a comment

Choose a reason for hiding this comment

ruthvikm left a comment •

edited by adelgadoj3

Loading