Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fixes #221 Joss Paper #222

Closed
wants to merge 66 commits into from
Closed

Fixes #221 Joss Paper #222

wants to merge 66 commits into from

Conversation

adelgadoj3
Copy link
Collaborator

Created the foundation for the JOSS Submission. We can add or remove sections as needed.

joefol and others added 30 commits March 6, 2024 16:15
* 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 javadoc errors

* removed javadoc from .gitignore
* 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]>
* 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
* 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

* Working ultra sonic sensor

* added javadocs for ultra sonic sensor classes

---------

Co-authored-by: ruthvikm <[email protected]>
Co-authored-by: Ruthvik Mannem <[email protected]>
* 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]>
added documentation for ultrasonic sensor / fixes issue w other files
Touch Switch Documentation Issue #199
* update architecture diagram in readme

* include file in readme

* actually include file in readme

* actually include file in readme
Copy link
Collaborator

@ruthvikm ruthvikm left a comment

Choose a reason for hiding this comment

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

Talk about the Raspberry Pi GPIO and how we are providing support for different hardware components. Significance of Pi4Micronaut is missing, explain how Pi4Micronaut application provides API interaction for each component and the different functionalities that we provide for hardware components. Also, talk about python dependency when it comes to Raspberry Pi GPIO interactions.

@SwindleA
Copy link
Collaborator

Talk about the Raspberry Pi GPIO and how we are providing support for different hardware components. Significance of Pi4Micronaut is missing, explain how Pi4Micronaut application provides API interaction for each component and the different functionalities that we provide for hardware components. Also, talk about python dependency when it comes to Raspberry Pi GPIO interactions.

@ruthvikm The submission guidelines specifically say that the purpose of the software should be described for a non-specialist audience. So, talking about GPIO, API, and python versus java would be to specific towards programmers. Let me know if you disagree.

Submission information:, see the section titled "What should my paper contain?".

@ruthvikm
Copy link
Collaborator

Talk about the Raspberry Pi GPIO and how we are providing support for different hardware components. Significance of Pi4Micronaut is missing, explain how Pi4Micronaut application provides API interaction for each component and the different functionalities that we provide for hardware components. Also, talk about python dependency when it comes to Raspberry Pi GPIO interactions.

@ruthvikm The submission guidelines specifically say that the purpose of the software should be described for a non-specialist audience. So, talking about GPIO, API, and python versus java would be to specific towards programmers. Let me know if you disagree.

Submission information:, see the section titled "What should my paper contain?".

@SwindleA - Guidelines says, summary should have a High-Level information focus for non-specialist audience. I think we can use statement of work section to write it up clearly. So that, the reviewers can understand our project. Get into the reviewer shoes and read the paper, you can feel what things are lacking in the paper to show it's significance.

joss/paper.md Show resolved Hide resolved
joss/paper.md Outdated Show resolved Hide resolved
joss/paper.md Show resolved Hide resolved
joss/paper.md Show resolved Hide resolved
@SwindleA SwindleA requested review from ruthvikm and removed request for kungfuchicken April 18, 2024 22:43
Copy link
Contributor

@kate-holdener kate-holdener left a comment

Choose a reason for hiding this comment

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

I added some suggestions for improvement.

joss/paper.md Outdated Show resolved Hide resolved
joss/paper.md Outdated Show resolved Hide resolved
joss/paper.md Outdated Show resolved Hide resolved
joss/paper.md Outdated Show resolved Hide resolved
@ruthvikm ruthvikm self-assigned this Jul 29, 2024
@kungfuchicken
Copy link

@ruthvikm i don't want to see this go stale. checking in on readiness/progress. any concerns? it looks good to me.

Copy link

@kungfuchicken kungfuchicken left a comment

Choose a reason for hiding this comment

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

lgtm;

@ruthvikm
Copy link
Collaborator

@ruthvikm i don't want to see this go stale. checking in on readiness/progress. any concerns? it looks good to me.

Working on it. Paper need some minor tweaks. I'll close this pull request by end of this week.

@ruthvikm ruthvikm changed the base branch from develop to main September 23, 2024 19:19
@ruthvikm
Copy link
Collaborator

Closing this Pull request and deleting 221-joss-paper branch as it used develop branch as base. Working on a new branch to avoid conflicts.

@ruthvikm ruthvikm closed this Sep 23, 2024
@ruthvikm ruthvikm deleted the 221-joss-paper branch September 23, 2024 19:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Joss Paper
7 participants