oss-slu / pi4micronaut Goto Github PK

Need to add code to allow for use of a Photoresistor.

From pull request #87
@SwindleA noticed that after the merge of develop to main (with the intention of removing develop branch), we need to update he asciidoc-build.yml so that the documentation is built when changes are pushed to main.

As discussed with Jeff, all contributors to the project should have to sign a CLA stating their guidelines for contribution. An example of this be found at Micronaut's website and they use cla-assistant to implement theirs. Completion of this issue also includes directions on how to fill out the CLA in the "Contributing to the Library" section of the docs

Includes the need for a circuit, breadboard diagram, and functioning code to integrate the component with Micronaut

Build is failing, if we setup this to run for main or develop. Need to fix the build-library-jar.yml along with
build.gradle

Includes the need for a circuit, breadboard diagram, and functioning code to integrate the component with Micronaut

Will likely be a PWM device but not certain.

At https://github.com/oss-slu/Pi4Micronaut/blob/a1feb7122dd89032fd1c12c24d9e512d73efc018/micronautpi4j-utils/gradle.properties are presently sonatype credentials.

The build should probably be reconfigured so those credentials are not kept in source code. For GitHub actions, configuring those as GitHub Secrets (docs.github.com/en/actions/security-guides/using-secrets-in-github-actions) might be the best option.

Create and implement an 'Improve this Doc' button which, when inserted into our documentation, allows the user to create a pull request suggesting changes to our documentation. An example can be found in the top right corner of the Micronaut Guide

Includes the need for a circuit, breadboard diagram, and functioning code to integrate the component with Micronaut

7 Segment display is an I2C device, may be able to leverage included CrowPi library to expedite the process

Need implementation for the light sensor which is also called as photo resistor. We already have a dummy light sensor controller.

Improve documentation and setup circuit.

Will be a multipin DigitalOutput device, supporting code already exists and should be able to be applied

Includes the need for a circuit, breadboard diagram, and functioning code to integrate the component with Micronaut

Add support for the micro switch component. Most likely should be a DigitalInput device and quite similar to slide switch

Create a detailed guide on how a developer would go about creating support for one of our already-supported hardware components. This should walk a potential developer through the exact steps they would need to take to mark a components support as completed. This should include 1. Circuit Building 2. Python testing 3. Java Implementation 4. Micronaut Integration 5. Controller Implementation 6. Documentation. This guide should be included in the "Contributing to the Library" section of our documentation. This would be a great first issue for any new developers joining the project to get quickly up to speed with the development process.

Seems to have gone missing somewhere along the line. This would be Jeff's controller and helper for the photosensor

Document the circuit process of RGB LED setup like what components are used (with details), pin configuration (clearly label the pins on the RGB LED and other components). Use pictures and circuit diagrams.

May be an SPI component, may be I2C, may be DigitalOutput, answer is unclear. Unfortunately CrowPi does not have support for this component so code will have to be handled manually

As part of our documentation, create (or copy from Micronaut's Example) a set of community guidelines for those who wish to participate in the contribution/discussion of our library

Need documentation along with the circuit diagram and other necessary information. Improve the pushButton.adoc file.

The repository has a develop branch that has many commits that are not in main. This needs to be resolved, we don't want to have long-lived develop branches. Instead, the main branch should have the latest and greatest work. Feature branches (off main) should be used to develop new features and resolve bugs.

Improve the Document for LED (4.3.1) and create the controller code.

Includes the need for a circuit, breadboard diagram, and functioning code to integrate the component with Micronaut

Includes the need for a circuit, breadboard diagram, and functioning code to integrate the component with Micronaut.

Potentiometer will likely be a large undertaking

Improving documentation and setting up the circuit.

Most likely a PWM component, possibly a multipin PWM. Either way, supporting code should be in place

Create and implement a template so that when users of our library attempt to submit an issue, they are in a more legible and concise format. If you attempt to submit an issue on Micronaut's Website it will ask for several options. Let's start by creating templates for a Bug Report and a Feature Request

Need to add support for a thermistor, possibly a DigitalInput device but uncertain.

Several instances of referencing Java code and it not showing up properly in the documentation.

Includes the need for a circuit, breadboard diagram, and functioning code to integrate the component with Micronaut

Need proper documentation for LCD

Properly document the slide switch. The main task is to create the test circuit for the slide switch and reformat the documentation.

Need proper documentation along with circuit diagrams and all necessary information.

This repository needs a major cleanup. I found a lot of compiler-generated files (.class) files that got checked into the repo in the develop branch. For example, files in the components/bin/main/com/opensourcewithslu/components/controllers directory. In fact, it seems that the entire bin directory should not be part of the repository (bin, indicates binary, meaning generated files).

Please remove these files from the repo and update the .gitignore file to no longer allow such files into the repo.

Create documentation that will help new contributors add a new component to the framework.

In RGBLEDHelper, finish the methods to take in a hex value and convert it to color intensities

Includes the need for a circuit, breadboard diagram, and functioning code to integrate the component with Micronaut

Will be an SPI device, may be able to leverage included CrowPi library to expedite

Includes the need for a circuit, breadboard diagram, and functioning code to integrate the component with Micronaut

Should be fairly similar to the slide switch in implementation