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

Need to improve LED documentation #102

Merged
merged 10 commits into from
Nov 6, 2023
Merged
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
package com.opensourcewithslu.components.controllers;

import com.opensourcewithslu.outputdevices.LEDHelper;
import com.pi4j.io.gpio.digital.DigitalOutput;
import io.micronaut.http.annotation.Controller;
import io.micronaut.http.annotation.Get;
import jakarta.inject.Named;


@Controller("/led")
public class LEDController {
private final LEDHelper ledHelper;

public LEDController(@Named("Led")DigitalOutput led){
this.ledHelper = new LEDHelper(led);
}

@Get("/led")
Copy link
Collaborator

Choose a reason for hiding this comment

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

The documentation says that this should be LEDOn. Change this to be @Get("/LEDOn")

Copy link
Collaborator

Choose a reason for hiding this comment

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

Also make use all of the LED helper methods in the controller. We have deviceOn, deviceOff and switchState.

public void checkLed(){
Copy link
Collaborator

Choose a reason for hiding this comment

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

Have this match what is in the @get

/*deviceOff method turns on the LED after checking the output. This
will turn on the LED
*/

ledHelper.deviceOff();
}

}
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
==== LED
:icons: //Icons attribute is needed for the Omega symbol
:omega: //Attribute is needed for the Omega symbol
Copy link
Collaborator

Choose a reason for hiding this comment

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

Use :omega: Ω so that where ever you use :omega: it will show up the Ω symbol

[.text-right]
https://github.com/oss-slu/Pi4Micronaut/edit/develop/micronautpi4j-utils/src/docs/asciidoc/components/outputComponents/led.adoc[Improve this doc]

===== Overview
This document provides details of the LED, including its components and assembly instructions.
This section provides details of the LED, including its components and assembly instructions.

===== Components
- 1 x RaspberryPi
Expand All @@ -18,17 +18,20 @@ This document provides details of the LED, including its components and assembly
===== Assembly
Copy link
Collaborator

Choose a reason for hiding this comment

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

Break down the following paragraph into points using bullets

- To assemble, place a single LED onto the Breadboard. The LED will have two pins, a cathode and an anode. Place a 220:omega: resistor on the positive side of the Breadboard to the anode (the long pin of the LED),
then the resistor to 3.3V, and connect the cathode (the short pin) of the LED to GPIO 17 of the RaspberryPi. In addition, there need to be two jumper cables connected to
separate positions on the Breadboard and T-Extension Board. The first will go from the GPIO17 pin to the cathode. Then place the second wire from the 3.3V pin to the positve side
separate positions on the Breadboard and T-Extension Board. The first will go from the GPIO17 pin to the cathode. Then place the second wire from the 3.3V pin to the positive side
of the Breadboard.


===== Circuit Diagram

image::https://github.com/oss-slu/Pi4Micronaut/tree/main/micronautpi4j-utils/src/docs/asciidoc/image49.png
Copy link
Collaborator

@ruthvikm ruthvikm Nov 2, 2023

Choose a reason for hiding this comment

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

Upload the image file after renaming it as "LED_Circuit". Make sure you provide the correct path here to display the image here.


===== Testing

Use: `curl http://localhost:8080/LED/LEDOn` to test the component. This will cause the LED to light.

===== Troubleshooting
- LED not lighting: Check the connections, and ensure the LED is placed correctly. Double check the power source.
- LED not lighting: Check the connections, and ensure the LED is placed correctly. Double-check the power source.
- LED is too dim: Resistor value may be too high. Verify you're using 220:omega: or adjust according to the power source your using
as well as the LED specifications.

Copy link
Collaborator

Choose a reason for hiding this comment

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

We have two LED YML configurations led and led2. please add it here

Expand Down Expand Up @@ -60,3 +63,6 @@ include::../../../../../../micronautpi4j-utils/src/main/java/com/opensourcewiths
===== An Example Controller

[source, java]
----
include:: ../../../../../../components/src/main/java/com/opensourcewithslu/components/controllers/LEDController.java[tags=method]
----