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

41 seven segement display documentation #284

Open
wants to merge 13 commits into
base: 41-seven-segment-display
Choose a base branch
from

Conversation

Ed0827
Copy link
Collaborator

@Ed0827 Ed0827 commented Nov 11, 2024

Overview: Introduction to the Seven Segment Display component and its purpose.
Components: List of required hardware components.
Circuit Setup: Step-by-step guide for setting up the display on a breadboard.
Circuit and Schematic Diagrams: Visual references for wiring.
YAML Configuration: Detailed YAML setup for integrating the display with Raspberry Pi via I2C.
Functionality and Testing: Instructions for displaying numbers and controlling segments.
Troubleshooting: Common issues and solutions.

* 1 x Seven Segment Display
* Jumper wires
* Breadboard
* Power source
Copy link
Collaborator

Choose a reason for hiding this comment

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

Some of the other documentation files mention the amount of power needed by the power source. It could be helpful to add it here.

===== Circuit Setup

1. Place the Seven Segment Display on the breadboard.
2. Connect each segment of the display to its respective GPIO pin as specified in the YAML configuration.
Copy link
Collaborator

Choose a reason for hiding this comment

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

Maybe this should be more detailed and describe where the wiring should go.


===== Circuit Diagram

image::/Users/jeongseyun7/Desktop/Capston1/Sprint4/Refreshed/Pi4Micronaut/Circuit_Diagram.png[]
Copy link
Collaborator

Choose a reason for hiding this comment

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

This should be a relative file path, not a local one. This won't show up on any computer but yours!

Instead, this line should look like:

image::Circuit_Diagram.png[]

The image should be placed inside pi4micronaut-utils/src/docs/asciidoc/img. It looks like the images aren't added and committed yet, so be sure to do that as well.

1. Place the Seven Segment Display on the breadboard.
2. Connect each segment of the display to its respective GPIO pin as specified in the YAML configuration.
3. Use a common ground to connect the display to the Raspberry Pi.
4. Refer to the circuit diagram for detailed wiring instructions.
Copy link
Collaborator

Choose a reason for hiding this comment

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

I do like this reminder to refer to the circuit diagram!


[source, java]
----
package com.opensourcewithslu.components.controllers;
Copy link
Collaborator

Choose a reason for hiding this comment

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

The code here should be linked to the SevenSegmentController.java file instead of being hardcoded and rewritten here.

Copy link
Collaborator

@yrlmanoharreddy yrlmanoharreddy left a comment

Choose a reason for hiding this comment

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

Your pull request includes helper functionality, controller, and YAML configuration changes that were already pushed in the previous sprint. Since that pull request is still pending, you should push updates into the existing one instead. This current pull request should only contain files modified under the docs section. Please remove all unrelated files to keep the changes focused and maintain a clean commit history

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.

3 participants