Completes Issue 83 and fixes bug with PushButtonController. #84
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
joefol
changed the title
SwindleA
reviewed
Oct 21, 2023
| @@ -2,6 +2,62 @@ | |||
| [.text-right] | |||
| https://github.com/oss-slu/Pi4Micronaut/edit/develop/micronautpi4j-utils/src/docs/asciidoc/components/inputComponents/pushButton.adoc[Improve this doc] | |||
|
|
|||
| ===== Overview | |||
| This document provides details of the Push Button circuit, | |||
There was a problem hiding this comment.
Small detail but maybe change "This document" to "This section"
ruthvikm
approved these changes
Oct 21, 2023
ruthvikm
added a commit
that referenced
this pull request
Feb 24, 2024
* Update README.md * Merging develop into main (#87) * Completes #47 (#73) * allow setting led color via hex value * set controller endpoint for setting RGB via hex * fixed spacing error in url for hex converter with frequencies --------- Co-authored-by: Adrian Swindle <[email protected]> * Added documentation for RGB LED circuit guide. Issue 74 (#79) * Added location for RGB LED circuit guide. * Added diagrams and link for hardware setup * Addresses requested changes * Changed default frequency to 200 --------- Co-authored-by: ruthvikm <[email protected]> --------- Co-authored-by: jyanev <[email protected]> Co-authored-by: Adrian Swindle <[email protected]> Co-authored-by: Joe Folen <[email protected]> * Completes Issue #71 (#72) * adding a new component adoc file * started outlining the things needed for a new component and controller example * more notes on new components The document is just notes at this point. It will need to be cleaned up once we learn more about the framework. * outline of how to add new component The outline is more clean than before but still lacks precise information. Will need to double check if all the appropriate steps are there and get the specific information. * completed outlining how to add a new componenet in the documentation * updated workflows for main (#90) * updated workfkows for main * reverted changes in build-library-jar.yml * test for documentation error unresolve directive * reverting changes from last fix attempt * changed included paths to go all the way back to the root before going back down to the file * Completes Issue 83 and fixes bug with PushButtonController. (#84) * Completes #47 (#73) * allow setting led color via hex value * set controller endpoint for setting RGB via hex * fixed spacing error in url for hex converter with frequencies --------- Co-authored-by: Adrian Swindle <[email protected]> * Added start for Push Button documentation. Issue 83. * Added start for Push Button documentation. Issue 83. * Fixed bug with push button controller and updated YML. * Updated documentation adoc. --------- Co-authored-by: jyanev <[email protected]> Co-authored-by: Adrian Swindle <[email protected]> * Slide switch Documentation (#94) * slide switch documentation and cirucuit image * set default frequencies in rgbhelper to be 200 * Issue 54 - Added Contributor License Agreement (#70) * added draft of Contributer License Agreement for Pi4J * added draft of Contributer License Agreement for Pi4J * Configured CLA and added documentation #issue-54 * added contributingToLibrary * Fixes issue-54 * Fixes issue-54 * Final Fix issue-54 --------- Co-authored-by: ruthvikm <[email protected]> * Documentation for rotary encoder. Issue 98 (#100) * Started updating documentation. Issue 98 * Continuing on issue 98 * Added diagram and finished doc * Added assembly instructions * Added info about value returned * Need to improve LED documentation (#102) * Need to improve and add further information for this doc * Updated the file with the requested changes. Still need to include the path for the controller. * Made the requested changes to the .adoc file (Testing section with curl commands) & added path for the controller. Also created the LEDController.java file in the controllers directory. * Provided the requested changes: bullet points, omegas, and corrected image path. Added a second method to the LEDController to take care of Led2. Added LED_circuit.png to the img file. * Reverted change made to LEDController. Previously added a check for Led2, now removed. * Deleted the :omega: variable at the top of the .adoc. Incorporated the preferred syntax for the image. * Fixed the path for the image in the circuit diagram section. * Changed led to LEDOn to resolve issue --------- Co-authored-by: Ruthvik Mannem <[email protected]> * Testing image for rotary encoder (#105) * RFID documentation (#101) * Initial outline of RFID documentaion Still need to test the circuit, add a circuit diagram, and outline how to test the circuit. * Example commands for rfidscanner * fix slide switch png * added rfid circuit image * added assembly instructions, troubleshooting, and functionalities sections * added assembly instructions, functionality, and troubleshooting sections * renamed images folder back to img --------- Co-authored-by: Ruthvik Mannem <[email protected]> * Fixing image issue in gh_pages (#106) * Testing image for rotary encoder * Copying img directory to gh-pages * Fixing Image issue in gh_pages (#107) * Testing image for rotary encoder * Copying img directory to gh-pages * updated asciidoc-build * Fixing Image issue in gh_pages (#108) * Testing image for rotary encoder * Copying img directory to gh-pages * updated asciidoc-build * reverting back changes * Fixes gh-pages image issue (#110) * reverted changes to asciidoc-build.yml * Fixed gh-pages images * added controller endpoints for ledoff and switch state (#117) * created outline for LCD documentation (#103) * Update lcdScreen.adoc Signed-off-by: jyanev <[email protected]> * Update lcdScreen.adoc Signed-off-by: jyanev <[email protected]> * Update lcdScreen.adoc Signed-off-by: jyanev <[email protected]> * Add files via upload Signed-off-by: jyanev <[email protected]> * Update lcdScreen.adoc Signed-off-by: jyanev <[email protected]> * Update lcdScreen.adoc Signed-off-by: jyanev <[email protected]> * Update lcdScreen.adoc Signed-off-by: jyanev <[email protected]> * Update lcdScreen.adoc Signed-off-by: jyanev <[email protected]> * Update lcdScreen.adoc Signed-off-by: jyanev <[email protected]> * Update lcdScreen.adoc Signed-off-by: jyanev <[email protected]> * Update lcdScreen.adoc Signed-off-by: jyanev <[email protected]> * Update lcdScreen.adoc Signed-off-by: jyanev <[email protected]> * Update lcdScreen.adoc Signed-off-by: jyanev <[email protected]> * Update lcdScreen.adoc Signed-off-by: jyanev <[email protected]> * Update lcdScreen.adoc Signed-off-by: jyanev <[email protected]> * Update lcdScreen.adoc Signed-off-by: jyanev <[email protected]> * Update lcdScreen.adoc Signed-off-by: jyanev <[email protected]> * Update lcdScreen.adoc Signed-off-by: jyanev <[email protected]> * Update lcdScreen.adoc Signed-off-by: jyanev <[email protected]> * Update lcdScreen.adoc Signed-off-by: jyanev <[email protected]> * Update lcdScreen.adoc Signed-off-by: jyanev <[email protected]> * Update lcdScreen.adoc Signed-off-by: jyanev <[email protected]> * Update lcdScreen.adoc Signed-off-by: jyanev <[email protected]> * Update lcdScreen.adoc Signed-off-by: jyanev <[email protected]> * Update lcdScreen.adoc Signed-off-by: jyanev <[email protected]> * Update lcdScreen.adoc Signed-off-by: jyanev <[email protected]> * Update lcdScreen.adoc Signed-off-by: jyanev <[email protected]> * Update lcdScreen.adoc Signed-off-by: jyanev <[email protected]> * Update lcdScreen.adoc Signed-off-by: jyanev <[email protected]> * Update lcdScreen.adoc Signed-off-by: jyanev <[email protected]> * Update lcdScreen.adoc Signed-off-by: jyanev <[email protected]> * Update lcdScreen.adoc Signed-off-by: jyanev <[email protected]> * Update lcdScreen.adoc Signed-off-by: jyanev <[email protected]> * Update lcdScreen.adoc Signed-off-by: jyanev <[email protected]> * Delete micronautpi4j-utils/src/docs/asciidoc/img/lcd-circuit.png Signed-off-by: jyanev <[email protected]> * Add files via upload Signed-off-by: jyanev <[email protected]> * Update lcdScreen.adoc Signed-off-by: jyanev <[email protected]> * added yaml section --------- Signed-off-by: jyanev <[email protected]> Co-authored-by: Joe Folen <[email protected]> Co-authored-by: ruthvikm <[email protected]> * fixes issue 111 (#122) * Fixes #119 (#123) * Made preliminary changes for easier readability. * No further changes, attempts to modify doc further yielded undesirable format. Current file has been improved from the original for clarity. * Fixes 127 (#130) * Resolved table of contents and image improvements, image does need to black rather than white. * Resolved white bar on bottom. Resolved improve doc link. Added a placeholder image with black background. * Clarity changes * Additional clarity. * Final image and whitespace reductions * Pi4Micronaut Logo * Possibly resolved issue with content becoming hidden behind header * Removed unused, commented code. * Update issue templates (#131) * Update issue templates Create a Bug report and New feature request templates * Configured issue-templates * Cleaning up code (#138) * LED controller and helper updates * input devices controller and helper updates * output devices controller and helper and MultiCompController updates * addresses lambda changes * addresses RGBLED controller and helper comments * addresses rotary encoder changes * Creating JavaDocs - Closes Issue #129 (#139) * start on javadocs * updates to javadoc * finished javadoc for the helper classes * javadoc generated files, open index.html in browser to view * javadoc comments added to the utility files * first full draft of javadocs * filled out remaining javadoc, remaining errors are due to micronait annotation * second versino of javadoc * added link to api reference * fixed api reference link Signed-off-by: Adrian Swindle <[email protected]> --------- Signed-off-by: Adrian Swindle <[email protected]> * Created workflow to publish javadoc to gh-pages (#145) * Javadoc publish (#147) * Created workflow to publish javadoc to gh-pages * testing workflow --------- Signed-off-by: Ruthvik Mannem <[email protected]> * reverting build changes (#149) * added adoc for setting up pi4m on raspberry pi (#141) * added getting starting asciidoc for getting pi4micronaut working with raspberry pi * asciidoc for setting up raspberry pi * updated gettingStarted adoc * updated gettingStarted.adoc to close issue-133 * updated gettingStarted.adoc to close issue-133 + added new images * added gettingStarted.adoc to index.adoc * Touch Switch Implementation Issue 144 (#152) * begin implementing touch switch helper and controller * added yml changes and initController method changes * added disableController method changes * testing changes for touch switch * added removeEventListener * adding javadoc comments for touch switch helper --------- Co-authored-by: Ruthvik Mannem <[email protected]> Co-authored-by: ruthvikm <[email protected]> * Ready for Release (#159) --------- Signed-off-by: jyanev <[email protected]> Signed-off-by: Adrian Swindle <[email protected]> Signed-off-by: Ruthvik Mannem <[email protected]> Co-authored-by: Greih Murray <[email protected]> Co-authored-by: jyanev <[email protected]> Co-authored-by: Adrian Swindle <[email protected]> Co-authored-by: Joe Folen <[email protected]> Co-authored-by: adelgadoj3 <[email protected]>
ruthvikm
added a commit
that referenced
this pull request
Feb 26, 2024
* Update README.md * Merging develop into main (#87) * Completes #47 (#73) * allow setting led color via hex value * set controller endpoint for setting RGB via hex * fixed spacing error in url for hex converter with frequencies --------- Co-authored-by: Adrian Swindle <[email protected]> * Added documentation for RGB LED circuit guide. Issue 74 (#79) * Added location for RGB LED circuit guide. * Added diagrams and link for hardware setup * Addresses requested changes * Changed default frequency to 200 --------- Co-authored-by: ruthvikm <[email protected]> --------- Co-authored-by: jyanev <[email protected]> Co-authored-by: Adrian Swindle <[email protected]> Co-authored-by: Joe Folen <[email protected]> * Completes Issue #71 (#72) * adding a new component adoc file * started outlining the things needed for a new component and controller example * more notes on new components The document is just notes at this point. It will need to be cleaned up once we learn more about the framework. * outline of how to add new component The outline is more clean than before but still lacks precise information. Will need to double check if all the appropriate steps are there and get the specific information. * completed outlining how to add a new componenet in the documentation * updated workflows for main (#90) * updated workfkows for main * reverted changes in build-library-jar.yml * test for documentation error unresolve directive * reverting changes from last fix attempt * changed included paths to go all the way back to the root before going back down to the file * Completes Issue 83 and fixes bug with PushButtonController. (#84) * Completes #47 (#73) * allow setting led color via hex value * set controller endpoint for setting RGB via hex * fixed spacing error in url for hex converter with frequencies --------- Co-authored-by: Adrian Swindle <[email protected]> * Added start for Push Button documentation. Issue 83. * Added start for Push Button documentation. Issue 83. * Fixed bug with push button controller and updated YML. * Updated documentation adoc. --------- Co-authored-by: jyanev <[email protected]> Co-authored-by: Adrian Swindle <[email protected]> * Slide switch Documentation (#94) * slide switch documentation and cirucuit image * set default frequencies in rgbhelper to be 200 * Issue 54 - Added Contributor License Agreement (#70) * added draft of Contributer License Agreement for Pi4J * added draft of Contributer License Agreement for Pi4J * Configured CLA and added documentation #issue-54 * added contributingToLibrary * Fixes issue-54 * Fixes issue-54 * Final Fix issue-54 --------- Co-authored-by: ruthvikm <[email protected]> * Documentation for rotary encoder. Issue 98 (#100) * Started updating documentation. Issue 98 * Continuing on issue 98 * Added diagram and finished doc * Added assembly instructions * Added info about value returned * Need to improve LED documentation (#102) * Need to improve and add further information for this doc * Updated the file with the requested changes. Still need to include the path for the controller. * Made the requested changes to the .adoc file (Testing section with curl commands) & added path for the controller. Also created the LEDController.java file in the controllers directory. * Provided the requested changes: bullet points, omegas, and corrected image path. Added a second method to the LEDController to take care of Led2. Added LED_circuit.png to the img file. * Reverted change made to LEDController. Previously added a check for Led2, now removed. * Deleted the :omega: variable at the top of the .adoc. Incorporated the preferred syntax for the image. * Fixed the path for the image in the circuit diagram section. * Changed led to LEDOn to resolve issue --------- Co-authored-by: Ruthvik Mannem <[email protected]> * Testing image for rotary encoder (#105) * RFID documentation (#101) * Initial outline of RFID documentaion Still need to test the circuit, add a circuit diagram, and outline how to test the circuit. * Example commands for rfidscanner * fix slide switch png * added rfid circuit image * added assembly instructions, troubleshooting, and functionalities sections * added assembly instructions, functionality, and troubleshooting sections * renamed images folder back to img --------- Co-authored-by: Ruthvik Mannem <[email protected]> * Fixing image issue in gh_pages (#106) * Testing image for rotary encoder * Copying img directory to gh-pages * Fixing Image issue in gh_pages (#107) * Testing image for rotary encoder * Copying img directory to gh-pages * updated asciidoc-build * Fixing Image issue in gh_pages (#108) * Testing image for rotary encoder * Copying img directory to gh-pages * updated asciidoc-build * reverting back changes * Fixes gh-pages image issue (#110) * reverted changes to asciidoc-build.yml * Fixed gh-pages images * added controller endpoints for ledoff and switch state (#117) * created outline for LCD documentation (#103) * Update lcdScreen.adoc Signed-off-by: jyanev <[email protected]> * Update lcdScreen.adoc Signed-off-by: jyanev <[email protected]> * Update lcdScreen.adoc Signed-off-by: jyanev <[email protected]> * Add files via upload Signed-off-by: jyanev <[email protected]> * Update lcdScreen.adoc Signed-off-by: jyanev <[email protected]> * Update lcdScreen.adoc Signed-off-by: jyanev <[email protected]> * Update lcdScreen.adoc Signed-off-by: jyanev <[email protected]> * Update lcdScreen.adoc Signed-off-by: jyanev <[email protected]> * Update lcdScreen.adoc Signed-off-by: jyanev <[email protected]> * Update lcdScreen.adoc Signed-off-by: jyanev <[email protected]> * Update lcdScreen.adoc Signed-off-by: jyanev <[email protected]> * Update lcdScreen.adoc Signed-off-by: jyanev <[email protected]> * Update lcdScreen.adoc Signed-off-by: jyanev <[email protected]> * Update lcdScreen.adoc Signed-off-by: jyanev <[email protected]> * Update lcdScreen.adoc Signed-off-by: jyanev <[email protected]> * Update lcdScreen.adoc Signed-off-by: jyanev <[email protected]> * Update lcdScreen.adoc Signed-off-by: jyanev <[email protected]> * Update lcdScreen.adoc Signed-off-by: jyanev <[email protected]> * Update lcdScreen.adoc Signed-off-by: jyanev <[email protected]> * Update lcdScreen.adoc Signed-off-by: jyanev <[email protected]> * Update lcdScreen.adoc Signed-off-by: jyanev <[email protected]> * Update lcdScreen.adoc Signed-off-by: jyanev <[email protected]> * Update lcdScreen.adoc Signed-off-by: jyanev <[email protected]> * Update lcdScreen.adoc Signed-off-by: jyanev <[email protected]> * Update lcdScreen.adoc Signed-off-by: jyanev <[email protected]> * Update lcdScreen.adoc Signed-off-by: jyanev <[email protected]> * Update lcdScreen.adoc Signed-off-by: jyanev <[email protected]> * Update lcdScreen.adoc Signed-off-by: jyanev <[email protected]> * Update lcdScreen.adoc Signed-off-by: jyanev <[email protected]> * Update lcdScreen.adoc Signed-off-by: jyanev <[email protected]> * Update lcdScreen.adoc Signed-off-by: jyanev <[email protected]> * Update lcdScreen.adoc Signed-off-by: jyanev <[email protected]> * Update lcdScreen.adoc Signed-off-by: jyanev <[email protected]> * Update lcdScreen.adoc Signed-off-by: jyanev <[email protected]> * Delete micronautpi4j-utils/src/docs/asciidoc/img/lcd-circuit.png Signed-off-by: jyanev <[email protected]> * Add files via upload Signed-off-by: jyanev <[email protected]> * Update lcdScreen.adoc Signed-off-by: jyanev <[email protected]> * added yaml section --------- Signed-off-by: jyanev <[email protected]> Co-authored-by: Joe Folen <[email protected]> Co-authored-by: ruthvikm <[email protected]> * fixes issue 111 (#122) * Fixes #119 (#123) * Made preliminary changes for easier readability. * No further changes, attempts to modify doc further yielded undesirable format. Current file has been improved from the original for clarity. * Fixes 127 (#130) * Resolved table of contents and image improvements, image does need to black rather than white. * Resolved white bar on bottom. Resolved improve doc link. Added a placeholder image with black background. * Clarity changes * Additional clarity. * Final image and whitespace reductions * Pi4Micronaut Logo * Possibly resolved issue with content becoming hidden behind header * Removed unused, commented code. * Update issue templates (#131) * Update issue templates Create a Bug report and New feature request templates * Configured issue-templates * Cleaning up code (#138) * LED controller and helper updates * input devices controller and helper updates * output devices controller and helper and MultiCompController updates * addresses lambda changes * addresses RGBLED controller and helper comments * addresses rotary encoder changes * Creating JavaDocs - Closes Issue #129 (#139) * start on javadocs * updates to javadoc * finished javadoc for the helper classes * javadoc generated files, open index.html in browser to view * javadoc comments added to the utility files * first full draft of javadocs * filled out remaining javadoc, remaining errors are due to micronait annotation * second versino of javadoc * added link to api reference * fixed api reference link Signed-off-by: Adrian Swindle <[email protected]> --------- Signed-off-by: Adrian Swindle <[email protected]> * Created workflow to publish javadoc to gh-pages (#145) * Javadoc publish (#147) * Created workflow to publish javadoc to gh-pages * testing workflow --------- Signed-off-by: Ruthvik Mannem <[email protected]> * reverting build changes (#149) * added adoc for setting up pi4m on raspberry pi (#141) * added getting starting asciidoc for getting pi4micronaut working with raspberry pi * asciidoc for setting up raspberry pi * updated gettingStarted adoc * updated gettingStarted.adoc to close issue-133 * updated gettingStarted.adoc to close issue-133 + added new images * added gettingStarted.adoc to index.adoc * Touch Switch Implementation Issue 144 (#152) * begin implementing touch switch helper and controller * added yml changes and initController method changes * added disableController method changes * testing changes for touch switch * added removeEventListener * adding javadoc comments for touch switch helper --------- Co-authored-by: Ruthvik Mannem <[email protected]> Co-authored-by: ruthvikm <[email protected]> * Ready for Release (#159) * Active Buzzer (#160) * Link to Buzzer issue. Helper and Controller classes have been tested and functionality is verified. * Resolved javadoc comments and messages. Removed errant commented code. Tested and verified functionality on pi with jdk 17 * Fixed comments in both files. Comments didn't provide an accuarate description. * Fixed the comment at the top of the file so it will be recognized as a javadoc comment. * issue-80 added light sensor compatibility (#168) * added light sensor compatibility * added PhotoResistor helper class --------- Co-authored-by: Ruthvik Mannem <[email protected]> * Readme changes Issue 121 (#169) * Readme changes * Readme changes with architecture diagram * fixed links in readme * Update README.md (#170) Signed-off-by: Ruthvik Mannem <[email protected]> * updated develop --------- Signed-off-by: jyanev <[email protected]> Signed-off-by: Adrian Swindle <[email protected]> Signed-off-by: Ruthvik Mannem <[email protected]> Co-authored-by: Greih Murray <[email protected]> Co-authored-by: jyanev <[email protected]> Co-authored-by: Adrian Swindle <[email protected]> Co-authored-by: Joe Folen <[email protected]> Co-authored-by: adelgadoj3 <[email protected]>
ruthvikm
added a commit
that referenced
this pull request
Feb 26, 2024
* Completes #47 (#73) * allow setting led color via hex value * set controller endpoint for setting RGB via hex * fixed spacing error in url for hex converter with frequencies --------- Co-authored-by: Adrian Swindle <[email protected]> * Added documentation for RGB LED circuit guide. Issue 74 (#79) * Added location for RGB LED circuit guide. * Added diagrams and link for hardware setup * Addresses requested changes * Changed default frequency to 200 --------- Co-authored-by: ruthvikm <[email protected]> * Update develop (#161) * Update README.md * Merging develop into main (#87) * Completes #47 (#73) * allow setting led color via hex value * set controller endpoint for setting RGB via hex * fixed spacing error in url for hex converter with frequencies --------- Co-authored-by: Adrian Swindle <[email protected]> * Added documentation for RGB LED circuit guide. Issue 74 (#79) * Added location for RGB LED circuit guide. * Added diagrams and link for hardware setup * Addresses requested changes * Changed default frequency to 200 --------- Co-authored-by: ruthvikm <[email protected]> --------- Co-authored-by: jyanev <[email protected]> Co-authored-by: Adrian Swindle <[email protected]> Co-authored-by: Joe Folen <[email protected]> * Completes Issue #71 (#72) * adding a new component adoc file * started outlining the things needed for a new component and controller example * more notes on new components The document is just notes at this point. It will need to be cleaned up once we learn more about the framework. * outline of how to add new component The outline is more clean than before but still lacks precise information. Will need to double check if all the appropriate steps are there and get the specific information. * completed outlining how to add a new componenet in the documentation * updated workflows for main (#90) * updated workfkows for main * reverted changes in build-library-jar.yml * test for documentation error unresolve directive * reverting changes from last fix attempt * changed included paths to go all the way back to the root before going back down to the file * Completes Issue 83 and fixes bug with PushButtonController. (#84) * Completes #47 (#73) * allow setting led color via hex value * set controller endpoint for setting RGB via hex * fixed spacing error in url for hex converter with frequencies --------- Co-authored-by: Adrian Swindle <[email protected]> * Added start for Push Button documentation. Issue 83. * Added start for Push Button documentation. Issue 83. * Fixed bug with push button controller and updated YML. * Updated documentation adoc. --------- Co-authored-by: jyanev <[email protected]> Co-authored-by: Adrian Swindle <[email protected]> * Slide switch Documentation (#94) * slide switch documentation and cirucuit image * set default frequencies in rgbhelper to be 200 * Issue 54 - Added Contributor License Agreement (#70) * added draft of Contributer License Agreement for Pi4J * added draft of Contributer License Agreement for Pi4J * Configured CLA and added documentation #issue-54 * added contributingToLibrary * Fixes issue-54 * Fixes issue-54 * Final Fix issue-54 --------- Co-authored-by: ruthvikm <[email protected]> * Documentation for rotary encoder. Issue 98 (#100) * Started updating documentation. Issue 98 * Continuing on issue 98 * Added diagram and finished doc * Added assembly instructions * Added info about value returned * Need to improve LED documentation (#102) * Need to improve and add further information for this doc * Updated the file with the requested changes. Still need to include the path for the controller. * Made the requested changes to the .adoc file (Testing section with curl commands) & added path for the controller. Also created the LEDController.java file in the controllers directory. * Provided the requested changes: bullet points, omegas, and corrected image path. Added a second method to the LEDController to take care of Led2. Added LED_circuit.png to the img file. * Reverted change made to LEDController. Previously added a check for Led2, now removed. * Deleted the :omega: variable at the top of the .adoc. Incorporated the preferred syntax for the image. * Fixed the path for the image in the circuit diagram section. * Changed led to LEDOn to resolve issue --------- Co-authored-by: Ruthvik Mannem <[email protected]> * Testing image for rotary encoder (#105) * RFID documentation (#101) * Initial outline of RFID documentaion Still need to test the circuit, add a circuit diagram, and outline how to test the circuit. * Example commands for rfidscanner * fix slide switch png * added rfid circuit image * added assembly instructions, troubleshooting, and functionalities sections * added assembly instructions, functionality, and troubleshooting sections * renamed images folder back to img --------- Co-authored-by: Ruthvik Mannem <[email protected]> * Fixing image issue in gh_pages (#106) * Testing image for rotary encoder * Copying img directory to gh-pages * Fixing Image issue in gh_pages (#107) * Testing image for rotary encoder * Copying img directory to gh-pages * updated asciidoc-build * Fixing Image issue in gh_pages (#108) * Testing image for rotary encoder * Copying img directory to gh-pages * updated asciidoc-build * reverting back changes * Fixes gh-pages image issue (#110) * reverted changes to asciidoc-build.yml * Fixed gh-pages images * added controller endpoints for ledoff and switch state (#117) * created outline for LCD documentation (#103) * Update lcdScreen.adoc Signed-off-by: jyanev <[email protected]> * Update lcdScreen.adoc Signed-off-by: jyanev <[email protected]> * Update lcdScreen.adoc Signed-off-by: jyanev <[email protected]> * Add files via upload Signed-off-by: jyanev <[email protected]> * Update lcdScreen.adoc Signed-off-by: jyanev <[email protected]> * Update lcdScreen.adoc Signed-off-by: jyanev <[email protected]> * Update lcdScreen.adoc Signed-off-by: jyanev <[email protected]> * Update lcdScreen.adoc Signed-off-by: jyanev <[email protected]> * Update lcdScreen.adoc Signed-off-by: jyanev <[email protected]> * Update lcdScreen.adoc Signed-off-by: jyanev <[email protected]> * Update lcdScreen.adoc Signed-off-by: jyanev <[email protected]> * Update lcdScreen.adoc Signed-off-by: jyanev <[email protected]> * Update lcdScreen.adoc Signed-off-by: jyanev <[email protected]> * Update lcdScreen.adoc Signed-off-by: jyanev <[email protected]> * Update lcdScreen.adoc Signed-off-by: jyanev <[email protected]> * Update lcdScreen.adoc Signed-off-by: jyanev <[email protected]> * Update lcdScreen.adoc Signed-off-by: jyanev <[email protected]> * Update lcdScreen.adoc Signed-off-by: jyanev <[email protected]> * Update lcdScreen.adoc Signed-off-by: jyanev <[email protected]> * Update lcdScreen.adoc Signed-off-by: jyanev <[email protected]> * Update lcdScreen.adoc Signed-off-by: jyanev <[email protected]> * Update lcdScreen.adoc Signed-off-by: jyanev <[email protected]> * Update lcdScreen.adoc Signed-off-by: jyanev <[email protected]> * Update lcdScreen.adoc Signed-off-by: jyanev <[email protected]> * Update lcdScreen.adoc Signed-off-by: jyanev <[email protected]> * Update lcdScreen.adoc Signed-off-by: jyanev <[email protected]> * Update lcdScreen.adoc Signed-off-by: jyanev <[email protected]> * Update lcdScreen.adoc Signed-off-by: jyanev <[email protected]> * Update lcdScreen.adoc Signed-off-by: jyanev <[email protected]> * Update lcdScreen.adoc Signed-off-by: jyanev <[email protected]> * Update lcdScreen.adoc Signed-off-by: jyanev <[email protected]> * Update lcdScreen.adoc Signed-off-by: jyanev <[email protected]> * Update lcdScreen.adoc Signed-off-by: jyanev <[email protected]> * Update lcdScreen.adoc Signed-off-by: jyanev <[email protected]> * Delete micronautpi4j-utils/src/docs/asciidoc/img/lcd-circuit.png Signed-off-by: jyanev <[email protected]> * Add files via upload Signed-off-by: jyanev <[email protected]> * Update lcdScreen.adoc Signed-off-by: jyanev <[email protected]> * added yaml section --------- Signed-off-by: jyanev <[email protected]> Co-authored-by: Joe Folen <[email protected]> Co-authored-by: ruthvikm <[email protected]> * fixes issue 111 (#122) * Fixes #119 (#123) * Made preliminary changes for easier readability. * No further changes, attempts to modify doc further yielded undesirable format. Current file has been improved from the original for clarity. * Fixes 127 (#130) * Resolved table of contents and image improvements, image does need to black rather than white. * Resolved white bar on bottom. Resolved improve doc link. Added a placeholder image with black background. * Clarity changes * Additional clarity. * Final image and whitespace reductions * Pi4Micronaut Logo * Possibly resolved issue with content becoming hidden behind header * Removed unused, commented code. * Update issue templates (#131) * Update issue templates Create a Bug report and New feature request templates * Configured issue-templates * Cleaning up code (#138) * LED controller and helper updates * input devices controller and helper updates * output devices controller and helper and MultiCompController updates * addresses lambda changes * addresses RGBLED controller and helper comments * addresses rotary encoder changes * Creating JavaDocs - Closes Issue #129 (#139) * start on javadocs * updates to javadoc * finished javadoc for the helper classes * javadoc generated files, open index.html in browser to view * javadoc comments added to the utility files * first full draft of javadocs * filled out remaining javadoc, remaining errors are due to micronait annotation * second versino of javadoc * added link to api reference * fixed api reference link Signed-off-by: Adrian Swindle <[email protected]> --------- Signed-off-by: Adrian Swindle <[email protected]> * Created workflow to publish javadoc to gh-pages (#145) * Javadoc publish (#147) * Created workflow to publish javadoc to gh-pages * testing workflow --------- Signed-off-by: Ruthvik Mannem <[email protected]> * reverting build changes (#149) * added adoc for setting up pi4m on raspberry pi (#141) * added getting starting asciidoc for getting pi4micronaut working with raspberry pi * asciidoc for setting up raspberry pi * updated gettingStarted adoc * updated gettingStarted.adoc to close issue-133 * updated gettingStarted.adoc to close issue-133 + added new images * added gettingStarted.adoc to index.adoc * Touch Switch Implementation Issue 144 (#152) * begin implementing touch switch helper and controller * added yml changes and initController method changes * added disableController method changes * testing changes for touch switch * added removeEventListener * adding javadoc comments for touch switch helper --------- Co-authored-by: Ruthvik Mannem <[email protected]> Co-authored-by: ruthvikm <[email protected]> * Ready for Release (#159) --------- Signed-off-by: jyanev <[email protected]> Signed-off-by: Adrian Swindle <[email protected]> Signed-off-by: Ruthvik Mannem <[email protected]> Co-authored-by: Greih Murray <[email protected]> Co-authored-by: jyanev <[email protected]> Co-authored-by: Adrian Swindle <[email protected]> Co-authored-by: Joe Folen <[email protected]> Co-authored-by: adelgadoj3 <[email protected]> * Includes javadocs in the gh-pages branch (#164) * includes javadocs with gh-pages * I think this should link the javadocs * getting javadocs through the directory route * getting javadocs through the directory route fixed * Revert "Includes javadocs in the gh-pages branch (#164)" (#167) This reverts commit ff6cfda. * Revert "Update develop (#161)" (#171) This reverts commit 921c65e. * Update develop (#173) * Update README.md * Merging develop into main (#87) * Completes #47 (#73) * allow setting led color via hex value * set controller endpoint for setting RGB via hex * fixed spacing error in url for hex converter with frequencies --------- Co-authored-by: Adrian Swindle <[email protected]> * Added documentation for RGB LED circuit guide. Issue 74 (#79) * Added location for RGB LED circuit guide. * Added diagrams and link for hardware setup * Addresses requested changes * Changed default frequency to 200 --------- Co-authored-by: ruthvikm <[email protected]> --------- Co-authored-by: jyanev <[email protected]> Co-authored-by: Adrian Swindle <[email protected]> Co-authored-by: Joe Folen <[email protected]> * Completes Issue #71 (#72) * adding a new component adoc file * started outlining the things needed for a new component and controller example * more notes on new components The document is just notes at this point. It will need to be cleaned up once we learn more about the framework. * outline of how to add new component The outline is more clean than before but still lacks precise information. Will need to double check if all the appropriate steps are there and get the specific information. * completed outlining how to add a new componenet in the documentation * updated workflows for main (#90) * updated workfkows for main * reverted changes in build-library-jar.yml * test for documentation error unresolve directive * reverting changes from last fix attempt * changed included paths to go all the way back to the root before going back down to the file * Completes Issue 83 and fixes bug with PushButtonController. (#84) * Completes #47 (#73) * allow setting led color via hex value * set controller endpoint for setting RGB via hex * fixed spacing error in url for hex converter with frequencies --------- Co-authored-by: Adrian Swindle <[email protected]> * Added start for Push Button documentation. Issue 83. * Added start for Push Button documentation. Issue 83. * Fixed bug with push button controller and updated YML. * Updated documentation adoc. --------- Co-authored-by: jyanev <[email protected]> Co-authored-by: Adrian Swindle <[email protected]> * Slide switch Documentation (#94) * slide switch documentation and cirucuit image * set default frequencies in rgbhelper to be 200 * Issue 54 - Added Contributor License Agreement (#70) * added draft of Contributer License Agreement for Pi4J * added draft of Contributer License Agreement for Pi4J * Configured CLA and added documentation #issue-54 * added contributingToLibrary * Fixes issue-54 * Fixes issue-54 * Final Fix issue-54 --------- Co-authored-by: ruthvikm <[email protected]> * Documentation for rotary encoder. Issue 98 (#100) * Started updating documentation. Issue 98 * Continuing on issue 98 * Added diagram and finished doc * Added assembly instructions * Added info about value returned * Need to improve LED documentation (#102) * Need to improve and add further information for this doc * Updated the file with the requested changes. Still need to include the path for the controller. * Made the requested changes to the .adoc file (Testing section with curl commands) & added path for the controller. Also created the LEDController.java file in the controllers directory. * Provided the requested changes: bullet points, omegas, and corrected image path. Added a second method to the LEDController to take care of Led2. Added LED_circuit.png to the img file. * Reverted change made to LEDController. Previously added a check for Led2, now removed. * Deleted the :omega: variable at the top of the .adoc. Incorporated the preferred syntax for the image. * Fixed the path for the image in the circuit diagram section. * Changed led to LEDOn to resolve issue --------- Co-authored-by: Ruthvik Mannem <[email protected]> * Testing image for rotary encoder (#105) * RFID documentation (#101) * Initial outline of RFID documentaion Still need to test the circuit, add a circuit diagram, and outline how to test the circuit. * Example commands for rfidscanner * fix slide switch png * added rfid circuit image * added assembly instructions, troubleshooting, and functionalities sections * added assembly instructions, functionality, and troubleshooting sections * renamed images folder back to img --------- Co-authored-by: Ruthvik Mannem <[email protected]> * Fixing image issue in gh_pages (#106) * Testing image for rotary encoder * Copying img directory to gh-pages * Fixing Image issue in gh_pages (#107) * Testing image for rotary encoder * Copying img directory to gh-pages * updated asciidoc-build * Fixing Image issue in gh_pages (#108) * Testing image for rotary encoder * Copying img directory to gh-pages * updated asciidoc-build * reverting back changes * Fixes gh-pages image issue (#110) * reverted changes to asciidoc-build.yml * Fixed gh-pages images * added controller endpoints for ledoff and switch state (#117) * created outline for LCD documentation (#103) * Update lcdScreen.adoc Signed-off-by: jyanev <[email protected]> * Update lcdScreen.adoc Signed-off-by: jyanev <[email protected]> * Update lcdScreen.adoc Signed-off-by: jyanev <[email protected]> * Add files via upload Signed-off-by: jyanev <[email protected]> * Update lcdScreen.adoc Signed-off-by: jyanev <[email protected]> * Update lcdScreen.adoc Signed-off-by: jyanev <[email protected]> * Update lcdScreen.adoc Signed-off-by: jyanev <[email protected]> * Update lcdScreen.adoc Signed-off-by: jyanev <[email protected]> * Update lcdScreen.adoc Signed-off-by: jyanev <[email protected]> * Update lcdScreen.adoc Signed-off-by: jyanev <[email protected]> * Update lcdScreen.adoc Signed-off-by: jyanev <[email protected]> * Update lcdScreen.adoc Signed-off-by: jyanev <[email protected]> * Update lcdScreen.adoc Signed-off-by: jyanev <[email protected]> * Update lcdScreen.adoc Signed-off-by: jyanev <[email protected]> * Update lcdScreen.adoc Signed-off-by: jyanev <[email protected]> * Update lcdScreen.adoc Signed-off-by: jyanev <[email protected]> * Update lcdScreen.adoc Signed-off-by: jyanev <[email protected]> * Update lcdScreen.adoc Signed-off-by: jyanev <[email protected]> * Update lcdScreen.adoc Signed-off-by: jyanev <[email protected]> * Update lcdScreen.adoc Signed-off-by: jyanev <[email protected]> * Update lcdScreen.adoc Signed-off-by: jyanev <[email protected]> * Update lcdScreen.adoc Signed-off-by: jyanev <[email protected]> * Update lcdScreen.adoc Signed-off-by: jyanev <[email protected]> * Update lcdScreen.adoc Signed-off-by: jyanev <[email protected]> * Update lcdScreen.adoc Signed-off-by: jyanev <[email protected]> * Update lcdScreen.adoc Signed-off-by: jyanev <[email protected]> * Update lcdScreen.adoc Signed-off-by: jyanev <[email protected]> * Update lcdScreen.adoc Signed-off-by: jyanev <[email protected]> * Update lcdScreen.adoc Signed-off-by: jyanev <[email protected]> * Update lcdScreen.adoc Signed-off-by: jyanev <[email protected]> * Update lcdScreen.adoc Signed-off-by: jyanev <[email protected]> * Update lcdScreen.adoc Signed-off-by: jyanev <[email protected]> * Update lcdScreen.adoc Signed-off-by: jyanev <[email protected]> * Update lcdScreen.adoc Signed-off-by: jyanev <[email protected]> * Delete micronautpi4j-utils/src/docs/asciidoc/img/lcd-circuit.png Signed-off-by: jyanev <[email protected]> * Add files via upload Signed-off-by: jyanev <[email protected]> * Update lcdScreen.adoc Signed-off-by: jyanev <[email protected]> * added yaml section --------- Signed-off-by: jyanev <[email protected]> Co-authored-by: Joe Folen <[email protected]> Co-authored-by: ruthvikm <[email protected]> * fixes issue 111 (#122) * Fixes #119 (#123) * Made preliminary changes for easier readability. * No further changes, attempts to modify doc further yielded undesirable format. Current file has been improved from the original for clarity. * Fixes 127 (#130) * Resolved table of contents and image improvements, image does need to black rather than white. * Resolved white bar on bottom. Resolved improve doc link. Added a placeholder image with black background. * Clarity changes * Additional clarity. * Final image and whitespace reductions * Pi4Micronaut Logo * Possibly resolved issue with content becoming hidden behind header * Removed unused, commented code. * Update issue templates (#131) * Update issue templates Create a Bug report and New feature request templates * Configured issue-templates * Cleaning up code (#138) * LED controller and helper updates * input devices controller and helper updates * output devices controller and helper and MultiCompController updates * addresses lambda changes * addresses RGBLED controller and helper comments * addresses rotary encoder changes * Creating JavaDocs - Closes Issue #129 (#139) * start on javadocs * updates to javadoc * finished javadoc for the helper classes * javadoc generated files, open index.html in browser to view * javadoc comments added to the utility files * first full draft of javadocs * filled out remaining javadoc, remaining errors are due to micronait annotation * second versino of javadoc * added link to api reference * fixed api reference link Signed-off-by: Adrian Swindle <[email protected]> --------- Signed-off-by: Adrian Swindle <[email protected]> * Created workflow to publish javadoc to gh-pages (#145) * Javadoc publish (#147) * Created workflow to publish javadoc to gh-pages * testing workflow --------- Signed-off-by: Ruthvik Mannem <[email protected]> * reverting build changes (#149) * added adoc for setting up pi4m on raspberry pi (#141) * added getting starting asciidoc for getting pi4micronaut working with raspberry pi * asciidoc for setting up raspberry pi * updated gettingStarted adoc * updated gettingStarted.adoc to close issue-133 * updated gettingStarted.adoc to close issue-133 + added new images * added gettingStarted.adoc to index.adoc * Touch Switch Implementation Issue 144 (#152) * begin implementing touch switch helper and controller * added yml changes and initController method changes * added disableController method changes * testing changes for touch switch * added removeEventListener * adding javadoc comments for touch switch helper --------- Co-authored-by: Ruthvik Mannem <[email protected]> Co-authored-by: ruthvikm <[email protected]> * Ready for Release (#159) * Active Buzzer (#160) * Link to Buzzer issue. Helper and Controller classes have been tested and functionality is verified. * Resolved javadoc comments and messages. Removed errant commented code. Tested and verified functionality on pi with jdk 17 * Fixed comments in both files. Comments didn't provide an accuarate description. * Fixed the comment at the top of the file so it will be recognized as a javadoc comment. * issue-80 added light sensor compatibility (#168) * added light sensor compatibility * added PhotoResistor helper class --------- Co-authored-by: Ruthvik Mannem <[email protected]> * Readme changes Issue 121 (#169) * Readme changes * Readme changes with architecture diagram * fixed links in readme * Update README.md (#170) Signed-off-by: Ruthvik Mannem <[email protected]> * updated develop --------- Signed-off-by: jyanev <[email protected]> Signed-off-by: Adrian Swindle <[email protected]> Signed-off-by: Ruthvik Mannem <[email protected]> Co-authored-by: Greih Murray <[email protected]> Co-authored-by: jyanev <[email protected]> Co-authored-by: Adrian Swindle <[email protected]> Co-authored-by: Joe Folen <[email protected]> Co-authored-by: adelgadoj3 <[email protected]> * Stable Version * Build Javadocs --------- Signed-off-by: jyanev <[email protected]> Signed-off-by: Adrian Swindle <[email protected]> Signed-off-by: Ruthvik Mannem <[email protected]> Co-authored-by: jyanev <[email protected]> Co-authored-by: Adrian Swindle <[email protected]> Co-authored-by: Joe Folen <[email protected]> Co-authored-by: Greih Murray <[email protected]> Co-authored-by: adelgadoj3 <[email protected]>
ruthvikm
added a commit
that referenced
this pull request
Feb 27, 2024
* Completes #47 (#73) * allow setting led color via hex value * set controller endpoint for setting RGB via hex * fixed spacing error in url for hex converter with frequencies --------- Co-authored-by: Adrian Swindle <[email protected]> * Added documentation for RGB LED circuit guide. Issue 74 (#79) * Added location for RGB LED circuit guide. * Added diagrams and link for hardware setup * Addresses requested changes * Changed default frequency to 200 --------- Co-authored-by: ruthvikm <[email protected]> * Update develop (#161) * Update README.md * Merging develop into main (#87) * Completes #47 (#73) * allow setting led color via hex value * set controller endpoint for setting RGB via hex * fixed spacing error in url for hex converter with frequencies --------- Co-authored-by: Adrian Swindle <[email protected]> * Added documentation for RGB LED circuit guide. Issue 74 (#79) * Added location for RGB LED circuit guide. * Added diagrams and link for hardware setup * Addresses requested changes * Changed default frequency to 200 --------- Co-authored-by: ruthvikm <[email protected]> --------- Co-authored-by: jyanev <[email protected]> Co-authored-by: Adrian Swindle <[email protected]> Co-authored-by: Joe Folen <[email protected]> * Completes Issue #71 (#72) * adding a new component adoc file * started outlining the things needed for a new component and controller example * more notes on new components The document is just notes at this point. It will need to be cleaned up once we learn more about the framework. * outline of how to add new component The outline is more clean than before but still lacks precise information. Will need to double check if all the appropriate steps are there and get the specific information. * completed outlining how to add a new componenet in the documentation * updated workflows for main (#90) * updated workfkows for main * reverted changes in build-library-jar.yml * test for documentation error unresolve directive * reverting changes from last fix attempt * changed included paths to go all the way back to the root before going back down to the file * Completes Issue 83 and fixes bug with PushButtonController. (#84) * Completes #47 (#73) * allow setting led color via hex value * set controller endpoint for setting RGB via hex * fixed spacing error in url for hex converter with frequencies --------- Co-authored-by: Adrian Swindle <[email protected]> * Added start for Push Button documentation. Issue 83. * Added start for Push Button documentation. Issue 83. * Fixed bug with push button controller and updated YML. * Updated documentation adoc. --------- Co-authored-by: jyanev <[email protected]> Co-authored-by: Adrian Swindle <[email protected]> * Slide switch Documentation (#94) * slide switch documentation and cirucuit image * set default frequencies in rgbhelper to be 200 * Issue 54 - Added Contributor License Agreement (#70) * added draft of Contributer License Agreement for Pi4J * added draft of Contributer License Agreement for Pi4J * Configured CLA and added documentation #issue-54 * added contributingToLibrary * Fixes issue-54 * Fixes issue-54 * Final Fix issue-54 --------- Co-authored-by: ruthvikm <[email protected]> * Documentation for rotary encoder. Issue 98 (#100) * Started updating documentation. Issue 98 * Continuing on issue 98 * Added diagram and finished doc * Added assembly instructions * Added info about value returned * Need to improve LED documentation (#102) * Need to improve and add further information for this doc * Updated the file with the requested changes. Still need to include the path for the controller. * Made the requested changes to the .adoc file (Testing section with curl commands) & added path for the controller. Also created the LEDController.java file in the controllers directory. * Provided the requested changes: bullet points, omegas, and corrected image path. Added a second method to the LEDController to take care of Led2. Added LED_circuit.png to the img file. * Reverted change made to LEDController. Previously added a check for Led2, now removed. * Deleted the :omega: variable at the top of the .adoc. Incorporated the preferred syntax for the image. * Fixed the path for the image in the circuit diagram section. * Changed led to LEDOn to resolve issue --------- Co-authored-by: Ruthvik Mannem <[email protected]> * Testing image for rotary encoder (#105) * RFID documentation (#101) * Initial outline of RFID documentaion Still need to test the circuit, add a circuit diagram, and outline how to test the circuit. * Example commands for rfidscanner * fix slide switch png * added rfid circuit image * added assembly instructions, troubleshooting, and functionalities sections * added assembly instructions, functionality, and troubleshooting sections * renamed images folder back to img --------- Co-authored-by: Ruthvik Mannem <[email protected]> * Fixing image issue in gh_pages (#106) * Testing image for rotary encoder * Copying img directory to gh-pages * Fixing Image issue in gh_pages (#107) * Testing image for rotary encoder * Copying img directory to gh-pages * updated asciidoc-build * Fixing Image issue in gh_pages (#108) * Testing image for rotary encoder * Copying img directory to gh-pages * updated asciidoc-build * reverting back changes * Fixes gh-pages image issue (#110) * reverted changes to asciidoc-build.yml * Fixed gh-pages images * added controller endpoints for ledoff and switch state (#117) * created outline for LCD documentation (#103) * Update lcdScreen.adoc Signed-off-by: jyanev <[email protected]> * Update lcdScreen.adoc Signed-off-by: jyanev <[email protected]> * Update lcdScreen.adoc Signed-off-by: jyanev <[email protected]> * Add files via upload Signed-off-by: jyanev <[email protected]> * Update lcdScreen.adoc Signed-off-by: jyanev <[email protected]> * Update lcdScreen.adoc Signed-off-by: jyanev <[email protected]> * Update lcdScreen.adoc Signed-off-by: jyanev <[email protected]> * Update lcdScreen.adoc Signed-off-by: jyanev <[email protected]> * Update lcdScreen.adoc Signed-off-by: jyanev <[email protected]> * Update lcdScreen.adoc Signed-off-by: jyanev <[email protected]> * Update lcdScreen.adoc Signed-off-by: jyanev <[email protected]> * Update lcdScreen.adoc Signed-off-by: jyanev <[email protected]> * Update lcdScreen.adoc Signed-off-by: jyanev <[email protected]> * Update lcdScreen.adoc Signed-off-by: jyanev <[email protected]> * Update lcdScreen.adoc Signed-off-by: jyanev <[email protected]> * Update lcdScreen.adoc Signed-off-by: jyanev <[email protected]> * Update lcdScreen.adoc Signed-off-by: jyanev <[email protected]> * Update lcdScreen.adoc Signed-off-by: jyanev <[email protected]> * Update lcdScreen.adoc Signed-off-by: jyanev <[email protected]> * Update lcdScreen.adoc Signed-off-by: jyanev <[email protected]> * Update lcdScreen.adoc Signed-off-by: jyanev <[email protected]> * Update lcdScreen.adoc Signed-off-by: jyanev <[email protected]> * Update lcdScreen.adoc Signed-off-by: jyanev <[email protected]> * Update lcdScreen.adoc Signed-off-by: jyanev <[email protected]> * Update lcdScreen.adoc Signed-off-by: jyanev <[email protected]> * Update lcdScreen.adoc Signed-off-by: jyanev <[email protected]> * Update lcdScreen.adoc Signed-off-by: jyanev <[email protected]> * Update lcdScreen.adoc Signed-off-by: jyanev <[email protected]> * Update lcdScreen.adoc Signed-off-by: jyanev <[email protected]> * Update lcdScreen.adoc Signed-off-by: jyanev <[email protected]> * Update lcdScreen.adoc Signed-off-by: jyanev <[email protected]> * Update lcdScreen.adoc Signed-off-by: jyanev <[email protected]> * Update lcdScreen.adoc Signed-off-by: jyanev <[email protected]> * Update lcdScreen.adoc Signed-off-by: jyanev <[email protected]> * Delete micronautpi4j-utils/src/docs/asciidoc/img/lcd-circuit.png Signed-off-by: jyanev <[email protected]> * Add files via upload Signed-off-by: jyanev <[email protected]> * Update lcdScreen.adoc Signed-off-by: jyanev <[email protected]> * added yaml section --------- Signed-off-by: jyanev <[email protected]> Co-authored-by: Joe Folen <[email protected]> Co-authored-by: ruthvikm <[email protected]> * fixes issue 111 (#122) * Fixes #119 (#123) * Made preliminary changes for easier readability. * No further changes, attempts to modify doc further yielded undesirable format. Current file has been improved from the original for clarity. * Fixes 127 (#130) * Resolved table of contents and image improvements, image does need to black rather than white. * Resolved white bar on bottom. Resolved improve doc link. Added a placeholder image with black background. * Clarity changes * Additional clarity. * Final image and whitespace reductions * Pi4Micronaut Logo * Possibly resolved issue with content becoming hidden behind header * Removed unused, commented code. * Update issue templates (#131) * Update issue templates Create a Bug report and New feature request templates * Configured issue-templates * Cleaning up code (#138) * LED controller and helper updates * input devices controller and helper updates * output devices controller and helper and MultiCompController updates * addresses lambda changes * addresses RGBLED controller and helper comments * addresses rotary encoder changes * Creating JavaDocs - Closes Issue #129 (#139) * start on javadocs * updates to javadoc * finished javadoc for the helper classes * javadoc generated files, open index.html in browser to view * javadoc comments added to the utility files * first full draft of javadocs * filled out remaining javadoc, remaining errors are due to micronait annotation * second versino of javadoc * added link to api reference * fixed api reference link Signed-off-by: Adrian Swindle <[email protected]> --------- Signed-off-by: Adrian Swindle <[email protected]> * Created workflow to publish javadoc to gh-pages (#145) * Javadoc publish (#147) * Created workflow to publish javadoc to gh-pages * testing workflow --------- Signed-off-by: Ruthvik Mannem <[email protected]> * reverting build changes (#149) * added adoc for setting up pi4m on raspberry pi (#141) * added getting starting asciidoc for getting pi4micronaut working with raspberry pi * asciidoc for setting up raspberry pi * updated gettingStarted adoc * updated gettingStarted.adoc to close issue-133 * updated gettingStarted.adoc to close issue-133 + added new images * added gettingStarted.adoc to index.adoc * Touch Switch Implementation Issue 144 (#152) * begin implementing touch switch helper and controller * added yml changes and initController method changes * added disableController method changes * testing changes for touch switch * added removeEventListener * adding javadoc comments for touch switch helper --------- Co-authored-by: Ruthvik Mannem <[email protected]> Co-authored-by: ruthvikm <[email protected]> * Ready for Release (#159) --------- Signed-off-by: jyanev <[email protected]> Signed-off-by: Adrian Swindle <[email protected]> Signed-off-by: Ruthvik Mannem <[email protected]> Co-authored-by: Greih Murray <[email protected]> Co-authored-by: jyanev <[email protected]> Co-authored-by: Adrian Swindle <[email protected]> Co-authored-by: Joe Folen <[email protected]> Co-authored-by: adelgadoj3 <[email protected]> * Includes javadocs in the gh-pages branch (#164) * includes javadocs with gh-pages * I think this should link the javadocs * getting javadocs through the directory route * getting javadocs through the directory route fixed * Revert "Includes javadocs in the gh-pages branch (#164)" (#167) This reverts commit ff6cfda. * Revert "Update develop (#161)" (#171) This reverts commit 921c65e. * Update develop (#173) * Update README.md * Merging develop into main (#87) * Completes #47 (#73) * allow setting led color via hex value * set controller endpoint for setting RGB via hex * fixed spacing error in url for hex converter with frequencies --------- Co-authored-by: Adrian Swindle <[email protected]> * Added documentation for RGB LED circuit guide. Issue 74 (#79) * Added location for RGB LED circuit guide. * Added diagrams and link for hardware setup * Addresses requested changes * Changed default frequency to 200 --------- Co-authored-by: ruthvikm <[email protected]> --------- Co-authored-by: jyanev <[email protected]> Co-authored-by: Adrian Swindle <[email protected]> Co-authored-by: Joe Folen <[email protected]> * Completes Issue #71 (#72) * adding a new component adoc file * started outlining the things needed for a new component and controller example * more notes on new components The document is just notes at this point. It will need to be cleaned up once we learn more about the framework. * outline of how to add new component The outline is more clean than before but still lacks precise information. Will need to double check if all the appropriate steps are there and get the specific information. * completed outlining how to add a new componenet in the documentation * updated workflows for main (#90) * updated workfkows for main * reverted changes in build-library-jar.yml * test for documentation error unresolve directive * reverting changes from last fix attempt * changed included paths to go all the way back to the root before going back down to the file * Completes Issue 83 and fixes bug with PushButtonController. (#84) * Completes #47 (#73) * allow setting led color via hex value * set controller endpoint for setting RGB via hex * fixed spacing error in url for hex converter with frequencies --------- Co-authored-by: Adrian Swindle <[email protected]> * Added start for Push Button documentation. Issue 83. * Added start for Push Button documentation. Issue 83. * Fixed bug with push button controller and updated YML. * Updated documentation adoc. --------- Co-authored-by: jyanev <[email protected]> Co-authored-by: Adrian Swindle <[email protected]> * Slide switch Documentation (#94) * slide switch documentation and cirucuit image * set default frequencies in rgbhelper to be 200 * Issue 54 - Added Contributor License Agreement (#70) * added draft of Contributer License Agreement for Pi4J * added draft of Contributer License Agreement for Pi4J * Configured CLA and added documentation #issue-54 * added contributingToLibrary * Fixes issue-54 * Fixes issue-54 * Final Fix issue-54 --------- Co-authored-by: ruthvikm <[email protected]> * Documentation for rotary encoder. Issue 98 (#100) * Started updating documentation. Issue 98 * Continuing on issue 98 * Added diagram and finished doc * Added assembly instructions * Added info about value returned * Need to improve LED documentation (#102) * Need to improve and add further information for this doc * Updated the file with the requested changes. Still need to include the path for the controller. * Made the requested changes to the .adoc file (Testing section with curl commands) & added path for the controller. Also created the LEDController.java file in the controllers directory. * Provided the requested changes: bullet points, omegas, and corrected image path. Added a second method to the LEDController to take care of Led2. Added LED_circuit.png to the img file. * Reverted change made to LEDController. Previously added a check for Led2, now removed. * Deleted the :omega: variable at the top of the .adoc. Incorporated the preferred syntax for the image. * Fixed the path for the image in the circuit diagram section. * Changed led to LEDOn to resolve issue --------- Co-authored-by: Ruthvik Mannem <[email protected]> * Testing image for rotary encoder (#105) * RFID documentation (#101) * Initial outline of RFID documentaion Still need to test the circuit, add a circuit diagram, and outline how to test the circuit. * Example commands for rfidscanner * fix slide switch png * added rfid circuit image * added assembly instructions, troubleshooting, and functionalities sections * added assembly instructions, functionality, and troubleshooting sections * renamed images folder back to img --------- Co-authored-by: Ruthvik Mannem <[email protected]> * Fixing image issue in gh_pages (#106) * Testing image for rotary encoder * Copying img directory to gh-pages * Fixing Image issue in gh_pages (#107) * Testing image for rotary encoder * Copying img directory to gh-pages * updated asciidoc-build * Fixing Image issue in gh_pages (#108) * Testing image for rotary encoder * Copying img directory to gh-pages * updated asciidoc-build * reverting back changes * Fixes gh-pages image issue (#110) * reverted changes to asciidoc-build.yml * Fixed gh-pages images * added controller endpoints for ledoff and switch state (#117) * created outline for LCD documentation (#103) * Update lcdScreen.adoc Signed-off-by: jyanev <[email protected]> * Update lcdScreen.adoc Signed-off-by: jyanev <[email protected]> * Update lcdScreen.adoc Signed-off-by: jyanev <[email protected]> * Add files via upload Signed-off-by: jyanev <[email protected]> * Update lcdScreen.adoc Signed-off-by: jyanev <[email protected]> * Update lcdScreen.adoc Signed-off-by: jyanev <[email protected]> * Update lcdScreen.adoc Signed-off-by: jyanev <[email protected]> * Update lcdScreen.adoc Signed-off-by: jyanev <[email protected]> * Update lcdScreen.adoc Signed-off-by: jyanev <[email protected]> * Update lcdScreen.adoc Signed-off-by: jyanev <[email protected]> * Update lcdScreen.adoc Signed-off-by: jyanev <[email protected]> * Update lcdScreen.adoc Signed-off-by: jyanev <[email protected]> * Update lcdScreen.adoc Signed-off-by: jyanev <[email protected]> * Update lcdScreen.adoc Signed-off-by: jyanev <[email protected]> * Update lcdScreen.adoc Signed-off-by: jyanev <[email protected]> * Update lcdScreen.adoc Signed-off-by: jyanev <[email protected]> * Update lcdScreen.adoc Signed-off-by: jyanev <[email protected]> * Update lcdScreen.adoc Signed-off-by: jyanev <[email protected]> * Update lcdScreen.adoc Signed-off-by: jyanev <[email protected]> * Update lcdScreen.adoc Signed-off-by: jyanev <[email protected]> * Update lcdScreen.adoc Signed-off-by: jyanev <[email protected]> * Update lcdScreen.adoc Signed-off-by: jyanev <[email protected]> * Update lcdScreen.adoc Signed-off-by: jyanev <[email protected]> * Update lcdScreen.adoc Signed-off-by: jyanev <[email protected]> * Update lcdScreen.adoc Signed-off-by: jyanev <[email protected]> * Update lcdScreen.adoc Signed-off-by: jyanev <[email protected]> * Update lcdScreen.adoc Signed-off-by: jyanev <[email protected]> * Update lcdScreen.adoc Signed-off-by: jyanev <[email protected]> * Update lcdScreen.adoc Signed-off-by: jyanev <[email protected]> * Update lcdScreen.adoc Signed-off-by: jyanev <[email protected]> * Update lcdScreen.adoc Signed-off-by: jyanev <[email protected]> * Update lcdScreen.adoc Signed-off-by: jyanev <[email protected]> * Update lcdScreen.adoc Signed-off-by: jyanev <[email protected]> * Update lcdScreen.adoc Signed-off-by: jyanev <[email protected]> * Delete micronautpi4j-utils/src/docs/asciidoc/img/lcd-circuit.png Signed-off-by: jyanev <[email protected]> * Add files via upload Signed-off-by: jyanev <[email protected]> * Update lcdScreen.adoc Signed-off-by: jyanev <[email protected]> * added yaml section --------- Signed-off-by: jyanev <[email protected]> Co-authored-by: Joe Folen <[email protected]> Co-authored-by: ruthvikm <[email protected]> * fixes issue 111 (#122) * Fixes #119 (#123) * Made preliminary changes for easier readability. * No further changes, attempts to modify doc further yielded undesirable format. Current file has been improved from the original for clarity. * Fixes 127 (#130) * Resolved table of contents and image improvements, image does need to black rather than white. * Resolved white bar on bottom. Resolved improve doc link. Added a placeholder image with black background. * Clarity changes * Additional clarity. * Final image and whitespace reductions * Pi4Micronaut Logo * Possibly resolved issue with content becoming hidden behind header * Removed unused, commented code. * Update issue templates (#131) * Update issue templates Create a Bug report and New feature request templates * Configured issue-templates * Cleaning up code (#138) * LED controller and helper updates * input devices controller and helper updates * output devices controller and helper and MultiCompController updates * addresses lambda changes * addresses RGBLED controller and helper comments * addresses rotary encoder changes * Creating JavaDocs - Closes Issue #129 (#139) * start on javadocs * updates to javadoc * finished javadoc for the helper classes * javadoc generated files, open index.html in browser to view * javadoc comments added to the utility files * first full draft of javadocs * filled out remaining javadoc, remaining errors are due to micronait annotation * second versino of javadoc * added link to api reference * fixed api reference link Signed-off-by: Adrian Swindle <[email protected]> --------- Signed-off-by: Adrian Swindle <[email protected]> * Created workflow to publish javadoc to gh-pages (#145) * Javadoc publish (#147) * Created workflow to publish javadoc to gh-pages * testing workflow --------- Signed-off-by: Ruthvik Mannem <[email protected]> * reverting build changes (#149) * added adoc for setting up pi4m on raspberry pi (#141) * added getting starting asciidoc for getting pi4micronaut working with raspberry pi * asciidoc for setting up raspberry pi * updated gettingStarted adoc * updated gettingStarted.adoc to close issue-133 * updated gettingStarted.adoc to close issue-133 + added new images * added gettingStarted.adoc to index.adoc * Touch Switch Implementation Issue 144 (#152) * begin implementing touch switch helper and controller * added yml changes and initController method changes * added disableController method changes * testing changes for touch switch * added removeEventListener * adding javadoc comments for touch switch helper --------- Co-authored-by: Ruthvik Mannem <[email protected]> Co-authored-by: ruthvikm <[email protected]> * Ready for Release (#159) * Active Buzzer (#160) * Link to Buzzer issue. Helper and Controller classes have been tested and functionality is verified. * Resolved javadoc comments and messages. Removed errant commented code. Tested and verified functionality on pi with jdk 17 * Fixed comments in both files. Comments didn't provide an accuarate description. * Fixed the comment at the top of the file so it will be recognized as a javadoc comment. * issue-80 added light sensor compatibility (#168) * added light sensor compatibility * added PhotoResistor helper class --------- Co-authored-by: Ruthvik Mannem <[email protected]> * Readme changes Issue 121 (#169) * Readme changes * Readme changes with architecture diagram * fixed links in readme * Update README.md (#170) Signed-off-by: Ruthvik Mannem <[email protected]> * updated develop --------- Signed-off-by: jyanev <[email protected]> Signed-off-by: Adrian Swindle <[email protected]> Signed-off-by: Ruthvik Mannem <[email protected]> Co-authored-by: Greih Murray <[email protected]> Co-authored-by: jyanev <[email protected]> Co-authored-by: Adrian Swindle <[email protected]> Co-authored-by: Joe Folen <[email protected]> Co-authored-by: adelgadoj3 <[email protected]> * Stable Version * Build Javadocs * Fixing Javadocs --------- Signed-off-by: jyanev <[email protected]> Signed-off-by: Adrian Swindle <[email protected]> Signed-off-by: Ruthvik Mannem <[email protected]> Co-authored-by: jyanev <[email protected]> Co-authored-by: Adrian Swindle <[email protected]> Co-authored-by: Joe Folen <[email protected]> Co-authored-by: Greih Murray <[email protected]> Co-authored-by: adelgadoj3 <[email protected]>
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.
Need to fill in blanks and figure out if a YAML config is needed.