Architecture diagram update. Issue 209 #215
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
ruthvikm
added a commit
that referenced
this pull request
May 10, 2024
* 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 <ruthviknathchowdary@gmail.com> * 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 <ruthviknathchowdary@gmail.com> Co-authored-by: Ruthvik Mannem <116761292+ruthvikm@users.noreply.github.com> * outlined ultrasound sensor component (#185) * outlined ultrasound sensor component * Working ultra sonic sensor * added javadocs for ultra sonic sensor classes --------- Co-authored-by: ruthvikm <ruthviknathchowdary@gmail.com> Co-authored-by: Ruthvik Mannem <116761292+ruthvikm@users.noreply.github.com> * 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 <ruthviknathchowdary@gmail.com> * 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 <ruthviknathchowdary@gmail.com> Co-authored-by: Ruthvik Mannem <116761292+ruthvikm@users.noreply.github.com> * outlined ultrasound sensor component (#185) * outlined ultrasound sensor component * Working ultra sonic sensor * added javadocs for ultra sonic sensor classes --------- Co-authored-by: ruthvikm <ruthviknathchowdary@gmail.com> Co-authored-by: Ruthvik Mannem <116761292+ruthvikm@users.noreply.github.com> --------- Co-authored-by: Joe Folen <96354144+joefol@users.noreply.github.com> Co-authored-by: adelgadoj3 <123115416+adelgadoj3@users.noreply.github.com> Co-authored-by: Adrian Swindle <adrian.swindle@slu.edu> Co-authored-by: jyanev <74617990+jyanev@users.noreply.github.com> * 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 <96354144+joefol@users.noreply.github.com> Co-authored-by: adelgadoj3 <123115416+adelgadoj3@users.noreply.github.com> Co-authored-by: Adrian Swindle <adrian.swindle@slu.edu> Co-authored-by: jyanev <74617990+jyanev@users.noreply.github.com> * 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 <123115416+adelgadoj3@users.noreply.github.com> * 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 <123115416+adelgadoj3@users.noreply.github.com> * 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 <adrian.swindle@slu.edu> --------- Signed-off-by: Adrian Swindle <adrian.swindle@slu.edu> * 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 <84727733+sonnyA-6@users.noreply.github.com> Co-authored-by: Adrian Swindle <adrian.swindle@slu.edu> * 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 <adrian.swindle@slu.edu> * debounced updated Signed-off-by: Adrian Swindle <adrian.swindle@slu.edu> --------- Signed-off-by: Adrian Swindle <adrian.swindle@slu.edu> * 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 <116761292+ruthvikm@users.noreply.github.com> * added micro switch documentation (#240) * Update documentation (#241) * updated added_dependency.png * doc bug fix --------- Signed-off-by: adelgadoj3 <123115416+adelgadoj3@users.noreply.github.com> Signed-off-by: Adrian Swindle <adrian.swindle@slu.edu> Signed-off-by: Ruthvik Mannem <116761292+ruthvikm@users.noreply.github.com> Co-authored-by: Joe Folen <96354144+joefol@users.noreply.github.com> Co-authored-by: adelgadoj3 <123115416+adelgadoj3@users.noreply.github.com> Co-authored-by: Adrian Swindle <adrian.swindle@slu.edu> Co-authored-by: jyanev <74617990+jyanev@users.noreply.github.com> Co-authored-by: jyanev <jyanev1@gmail.com> Co-authored-by: Joe Folen <joe.folen@gmail.com> Co-authored-by: Alex Delgado <84727733+sonnyA-6@users.noreply.github.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.