deploy: 1291e9c

oss-slu · Oct 16, 2023 · 80d7be3 · 80d7be3
1 parent cc6de52
commit 80d7be3
Show file tree

Hide file tree

Showing 25 changed files with 326 additions and 36 deletions.
diff --git a/Introduction/exampleApplications.html b/Introduction/exampleApplications.html
@@ -196,7 +196,7 @@ <h4 id="_remote_mointoring_check_in_system">Remote Mointoring Check-In System</h
 <div id="footer">
 <div id="footer-text">
 Version v1.0.0<br>
-Last updated 2023-10-11 18:40:52 UTC
+Last updated 2023-10-16 02:57:26 UTC
 </div>
 </div>
 </body>

diff --git a/Introduction/supportedHardware.html b/Introduction/supportedHardware.html
@@ -221,7 +221,7 @@ <h3 id="_currently_supported_hardware">Currently Supported Hardware</h3>
 <div id="footer">
 <div id="footer-text">
 Version v1.0.0<br>
-Last updated 2023-10-11 18:40:52 UTC
+Last updated 2023-10-16 02:57:26 UTC
 </div>
 </div>
 </body>

diff --git a/adding_creating_App.html b/adding_creating_App.html
@@ -193,7 +193,7 @@ <h2 id="_adding_tocreating_an_application">Adding to/Creating an Application</h2
 <div id="footer">
 <div id="footer-text">
 Version v1.0.0<br>
-Last updated 2023-10-11 18:40:52 UTC
+Last updated 2023-10-16 02:57:26 UTC
 </div>
 </div>
 </body>

diff --git a/components.html b/components.html
@@ -189,7 +189,7 @@ <h2 id="_components">Components</h2>
 <div id="footer">
 <div id="footer-text">
 Version v1.0.0<br>
-Last updated 2023-10-11 18:40:52 UTC
+Last updated 2023-10-16 02:57:26 UTC
 </div>
 </div>
 </body>

diff --git a/components/commun_WithHardware.html b/components/commun_WithHardware.html
@@ -191,7 +191,7 @@ <h3 id="_communicating_with_a_hardware_component">Communicating with a Hardware
 <div id="footer">
 <div id="footer-text">
 Version v1.0.0<br>
-Last updated 2023-10-11 18:40:52 UTC
+Last updated 2023-10-16 02:57:26 UTC
 </div>
 </div>
 </body>

diff --git a/components/commun_WithHardware/digitalInput.html b/components/commun_WithHardware/digitalInput.html
@@ -237,7 +237,7 @@ <h4 id="_digital_input">Digital Input</h4>
 <div id="footer">
 <div id="footer-text">
 Version v1.0.0<br>
-Last updated 2023-10-11 18:40:52 UTC
+Last updated 2023-10-16 02:57:26 UTC
 </div>
 </div>
 </body>

diff --git a/components/commun_WithHardware/digitalOutput.html b/components/commun_WithHardware/digitalOutput.html
@@ -237,7 +237,7 @@ <h4 id="_digital_output">Digital Output</h4>
 <div id="footer">
 <div id="footer-text">
 Version v1.0.0<br>
-Last updated 2023-10-11 18:40:52 UTC
+Last updated 2023-10-16 02:57:26 UTC
 </div>
 </div>
 </body>

diff --git a/components/commun_WithHardware/i2c.html b/components/commun_WithHardware/i2c.html
@@ -211,7 +211,7 @@ <h4 id="_i2c">I2C</h4>
 <div id="footer">
 <div id="footer-text">
 Version v1.0.0<br>
-Last updated 2023-10-11 18:40:52 UTC
+Last updated 2023-10-16 02:57:26 UTC
 </div>
 </div>
 </body>

diff --git a/components/commun_WithHardware/multipinConfig.html b/components/commun_WithHardware/multipinConfig.html
@@ -262,7 +262,7 @@ <h4 id="_multipin_configurations">Multipin Configurations</h4>
 <div id="footer">
 <div id="footer-text">
 Version v1.0.0<br>
-Last updated 2023-10-11 18:40:52 UTC
+Last updated 2023-10-16 02:57:26 UTC
 </div>
 </div>
 </body>

diff --git a/components/commun_WithHardware/pwm.html b/components/commun_WithHardware/pwm.html
@@ -237,7 +237,7 @@ <h4 id="_pwm">PWM</h4>
 <div id="footer">
 <div id="footer-text">
 Version v1.0.0<br>
-Last updated 2023-10-11 18:40:52 UTC
+Last updated 2023-10-16 02:57:26 UTC
 </div>
 </div>
 </body>

diff --git a/components/commun_WithHardware/spi.html b/components/commun_WithHardware/spi.html
@@ -214,7 +214,7 @@ <h4 id="_spi">SPI</h4>
 <div id="footer">
 <div id="footer-text">
 Version v1.0.0<br>
-Last updated 2023-10-11 18:40:52 UTC
+Last updated 2023-10-16 02:57:26 UTC
 </div>
 </div>
 </body>

diff --git a/components/inputComponents.html b/components/inputComponents.html
@@ -187,7 +187,7 @@ <h3 id="_input_components">Input Components</h3>
 <div id="footer">
 <div id="footer-text">
 Version v1.0.0<br>
-Last updated 2023-10-11 18:40:52 UTC
+Last updated 2023-10-16 02:57:26 UTC
 </div>
 </div>
 </body>

diff --git a/components/inputComponents/photosensor.html b/components/inputComponents/photosensor.html
@@ -190,7 +190,7 @@ <h4 id="_photosensor">Photosensor</h4>
 <div id="footer">
 <div id="footer-text">
 Version v1.0.0<br>
-Last updated 2023-10-11 18:40:52 UTC
+Last updated 2023-10-16 02:57:26 UTC
 </div>
 </div>
 </body>

diff --git a/components/inputComponents/pushButton.html b/components/inputComponents/pushButton.html
@@ -214,7 +214,7 @@ <h6 id="_this_controller_uses_the_push_button_to_turn_an_led_on_and_off">This co
 <div id="footer">
 <div id="footer-text">
 Version v1.0.0<br>
-Last updated 2023-10-11 18:40:52 UTC
+Last updated 2023-10-16 02:57:26 UTC
 </div>
 </div>
 </body>

diff --git a/components/inputComponents/rfidScanner.html b/components/inputComponents/rfidScanner.html
@@ -214,7 +214,7 @@ <h6 id="_this_controller_uses_the_rfid_scanner_to_write_and_read_to_a_card">This
 <div id="footer">
 <div id="footer-text">
 Version v1.0.0<br>
-Last updated 2023-10-11 18:40:52 UTC
+Last updated 2023-10-16 02:57:26 UTC
 </div>
 </div>
 </body>

diff --git a/components/inputComponents/rotaryEncoder.html b/components/inputComponents/rotaryEncoder.html
@@ -236,7 +236,7 @@ <h6 id="_this_controller_sets_up_two_rotary_encoders">This controller sets up tw
 <div id="footer">
 <div id="footer-text">
 Version v1.0.0<br>
-Last updated 2023-10-11 18:40:52 UTC
+Last updated 2023-10-16 02:57:26 UTC
 </div>
 </div>
 </body>

diff --git a/components/inputComponents/slideSwitch.html b/components/inputComponents/slideSwitch.html
@@ -214,7 +214,7 @@ <h6 id="_this_controller_sets_up_two_slide_switches">This controller sets up two
 <div id="footer">
 <div id="footer-text">
 Version v1.0.0<br>
-Last updated 2023-10-11 18:40:52 UTC
+Last updated 2023-10-16 02:57:26 UTC
 </div>
 </div>
 </body>

diff --git a/components/outputComponents.html b/components/outputComponents.html
@@ -187,7 +187,7 @@ <h3 id="_output_components">Output Components</h3>
 <div id="footer">
 <div id="footer-text">
 Version v1.0.0<br>
-Last updated 2023-10-11 18:40:52 UTC
+Last updated 2023-10-16 02:57:26 UTC
 </div>
 </div>
 </body>

diff --git a/components/outputComponents/lcdScreen.html b/components/outputComponents/lcdScreen.html
@@ -211,7 +211,7 @@ <h5 id="_an_example_controller">An Example Controller</h5>
 <div id="footer">
 <div id="footer-text">
 Version v1.0.0<br>
-Last updated 2023-10-11 18:40:52 UTC
+Last updated 2023-10-16 02:57:26 UTC
 </div>
 </div>
 </body>

diff --git a/components/outputComponents/led.html b/components/outputComponents/led.html
@@ -212,7 +212,7 @@ <h6 id="_this_controller_turns_the_led_on_and_off">This controller turns the LED
 <div id="footer">
 <div id="footer-text">
 Version v1.0.0<br>
-Last updated 2023-10-11 18:40:52 UTC
+Last updated 2023-10-16 02:57:26 UTC
 </div>
 </div>
 </body>

diff --git a/components/outputComponents/rgbLed.html b/components/outputComponents/rgbLed.html
@@ -177,10 +177,147 @@
 <div id="header">
 </div>
 <div id="content">
-<div class="sect3">
-<h4 id="_rgb_led">RGB LED</h4>
+<div class="sect1">
+<h2 id="_rgb_led">RGB LED</h2>
+<div class="sectionbody">
 <div class="paragraph text-right">
 <p><a href="https://github.com/oss-slu/Pi4Micronaut/edit/develop/micronautpi4j-utils/src/docs/asciidoc/components/outputComponents/rgbLed.adoc">Improve this doc</a></p>
+</div>
+<div class="sect4">
+<h5 id="_overview">Overview</h5>
+<div class="paragraph">
+<p>This document provides details of the RGB (Red-Green-Blue) LED circuit,
+including its components, assembly instructions, and functionality.</p>
+</div>
+</div>
+<div class="sect4">
+<h5 id="_components">Components</h5>
+<div class="olist arabic">
+<ol class="arabic">
+<li>
+<p>RGB LED</p>
+</li>
+<li>
+<p>3 x 220Ω resistors (for current limiting)</p>
+</li>
+<li>
+<p>Breadboard</p>
+</li>
+<li>
+<p>Jumper wires</p>
+</li>
+<li>
+<p>Power source (appropriate voltage, typically 3.3V or 5V)</p>
+</li>
+</ol>
+</div>
+</div>
+<div class="sect4">
+<h5 id="_assembly_instructions">Assembly Instructions</h5>
+<div class="olist arabic">
+<ol class="arabic">
+<li>
+<p>Place the RGB LED on the Breadboard. The LED has four pins - one for each of the
+colors (Red, Green, and Blue) and one common pin (either cathode or anode).</p>
+</li>
+<li>
+<p>Connect the Resistors. Attach a 220Ω resistor to each of the RGB pins of the LED.
+This is to limit the current and protect the LED.</p>
+</li>
+<li>
+<p>Power Connections:</p>
+<div class="ulist">
+<ul>
+<li>
+<p>If using a common cathode RGB LED, connect the common pin directly to the
+ground (GND) and the other ends of the resistors to the respective positive
+terminals (like GPIO pins of a microcontroller or direct power source).</p>
+</li>
+<li>
+<p>If using a common anode RGB LED, connect the common pin directly to the
+positive voltage source (VCC) and the other ends of the resistors to the respective
+negative terminals (like GPIO pins set to OUTPUT and LOW on a microcontroller).</p>
+</li>
+</ul>
+</div>
+</li>
+</ol>
+</div>
+</div>
+<div class="sect4">
+<h5 id="_circuit_diagram">Circuit Diagram</h5>
+<div class="paragraph">
+<p>Model:</p>
+</div>
+<div class="imageblock">
+<div class="content">
+<img src="https://docs.sunfounder.com/projects/raphael-kit/en/latest/_images/image61.png" alt="image61">
+</div>
+</div>
+<div class="paragraph">
+<p>Circuit Diagram:</p>
+</div>
+<div class="imageblock">
+<div class="content">
+<img src="https://docs.sunfounder.com/projects/raphael-kit/en/latest/_images/rgb_led_schematic.png" alt="rgb led schematic">
+</div>
+</div>
+</div>
+<div class="sect4">
+<h5 id="_functionality">Functionality</h5>
+<div class="paragraph">
+<p>The RGB LED can produce a wide range of colors by mixing different intensities of
+Red, Green, and Blue. By adjusting the power to each pin, various colors can be
+produced. For instance:</p>
+</div>
+<div class="ulist">
+<ul>
+<li>
+<p>Red: Power the Red pin while keeping Green and Blue off.</p>
+</li>
+<li>
+<p>Green: Power the Green pin while keeping Red and Blue off.</p>
+</li>
+<li>
+<p>Blue: Power the Blue pin while keeping Red and Green off.</p>
+</li>
+<li>
+<p>Yellow: Power both Red and Green pins while keeping Blue off.</p>
+</li>
+<li>
+<p>Cyan: Power both Green and Blue pins while keeping Red off.</p>
+</li>
+<li>
+<p>Magenta: Power both Red and Blue pins while keeping Green off.</p>
+</li>
+<li>
+<p>White: Power all three pins</p>
+</li>
+</ul>
+</div>
+</div>
+<div class="sect4">
+<h5 id="_troubleshooting">Troubleshooting</h5>
+<div class="olist arabic">
+<ol class="arabic">
+<li>
+<p>LED not lighting up: Check all connections, ensure the LED is placed correctly,
+and check the power source.</p>
+</li>
+<li>
+<p>Only one color is working: One of the pins might have a loose connection. Verify
+each color pin&#8217;s connection.</p>
+</li>
+<li>
+<p>LED is too dim: The resistor value might be too high. Ensure you&#8217;re using 220Ω or
+adjust according to your power source and LED specifications</p>
+</li>
+</ol>
+</div>
+</div>
+<div class="sect4">
+<h5 id="_note_the_hex_value_format_must_start_with_0x_not_while_passing_it_as_a_parameter_of_setcolorhex_method_for_example_use_0x0000ff_for_blue">Note: The Hex value format must start with "0x" not "#" while passing it as a parameter of "setColorHex()" method. For example, use "0x0000ff" for blue.</h5>
+
 </div>
 <div class="sect4">
 <h5 id="_yaml_pin_order">YAML Pin Order</h5>
@@ -230,10 +367,11 @@ <h5 id="_an_example_controller">An Example Controller</h5>
 </div>
 </div>
 </div>
+</div>
 <div id="footer">
 <div id="footer-text">
 Version v1.0.0<br>
-Last updated 2023-10-11 18:40:52 UTC
+Last updated 2023-10-16 02:57:26 UTC
 </div>
 </div>
 </body>

diff --git a/howContribute.html b/howContribute.html
@@ -192,7 +192,7 @@ <h2 id="_contributing_to_the_library">Contributing to the Library</h2>
 <div id="footer">
 <div id="footer-text">
 Version v1.0.0<br>
-Last updated 2023-10-11 18:40:52 UTC
+Last updated 2023-10-16 02:57:26 UTC
 </div>
 </div>
 </body>