deploy: c6918a5

oss-slu · Oct 22, 2023 · e6ac577 · e6ac577
1 parent f6982f5
commit e6ac577
Show file tree

Hide file tree

Showing 26 changed files with 181 additions and 33 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-21 14:50:16 UTC
+Last updated 2023-10-22 15:43:37 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-21 14:50:16 UTC
+Last updated 2023-10-22 15:43:37 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-21 14:50:16 UTC
+Last updated 2023-10-22 15:43:37 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-21 14:50:16 UTC
+Last updated 2023-10-22 15:43:37 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-21 14:50:16 UTC
+Last updated 2023-10-22 15:43:37 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-21 14:50:16 UTC
+Last updated 2023-10-22 15:43:37 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-21 14:50:16 UTC
+Last updated 2023-10-22 15:43:37 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-21 14:50:16 UTC
+Last updated 2023-10-22 15:43:37 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-21 14:50:16 UTC
+Last updated 2023-10-22 15:43:37 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-21 14:50:16 UTC
+Last updated 2023-10-22 15:43:37 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-21 14:50:16 UTC
+Last updated 2023-10-22 15:43:37 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-21 14:50:16 UTC
+Last updated 2023-10-22 15:43:37 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-21 14:50:16 UTC
+Last updated 2023-10-22 15:43:37 UTC
 </div>
 </div>
 </body>

diff --git a/components/inputComponents/pushButton.html b/components/inputComponents/pushButton.html
@@ -325,7 +325,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-21 14:50:16 UTC
+Last updated 2023-10-22 15:43:37 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-21 14:50:16 UTC
+Last updated 2023-10-22 15:43:37 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-21 14:50:16 UTC
+Last updated 2023-10-22 15:43:37 UTC
 </div>
 </div>
 </body>

diff --git a/components/inputComponents/slideSwitch.html b/components/inputComponents/slideSwitch.html
@@ -183,18 +183,92 @@ <h4 id="_slide_switch">Slide Switch</h4>
 <p><a href="https://github.com/oss-slu/Pi4Micronaut/edit/develop/micronautpi4j-utils/src/docs/asciidoc/components/inputComponents/slideSwitch.adoc">Improve this doc</a></p>
 </div>
 <div class="sect4">
+<h5 id="_overview">Overview</h5>
+<div class="paragraph">
+<p>This section provides the details of the Slide Switch circuit, including its components, assembly instructions, and functionality.</p>
+</div>
+</div>
+<div class="sect4">
+<h5 id="_components">Components</h5>
+<div class="ulist">
+<ul>
+<li>
+<p>Slide Switch</p>
+</li>
+<li>
+<p>1 x 10Ω resistor</p>
+</li>
+<li>
+<p>1 x Capacitor 104</p>
+</li>
+<li>
+<p>Breadboard</p>
+</li>
+<li>
+<p>7 x Jumper Wires</p>
+</li>
+<li>
+<p>Power source (appropriate voltage, typically 3.3V or 5V)</p>
+</li>
+</ul>
+</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://github.com/oss-slu/Pi4Micronaut/tree/main/micronautpi4j-utils/src/docs/asciidoc/img/slideSwitch_circuit.jpg" alt="slideSwitch circuit">
+</div>
+</div>
+</div>
+<div class="sect4">
+<h5 id="_testing_the_circuit">Testing the Circuit:</h5>
+<div class="paragraph">
+<p>Use: <code>curl <a href="http://localhost:8080/slideSwitch/switch1" class="bare">http://localhost:8080/slideSwitch/switch1</a></code> to test the switch. This will either return true,if the switch is on, and false if the switch is off. Flip the switch and run the command again to see the opposite result of the first call.</p>
+</div>
+</div>
+<div class="sect4">
+<h5 id="_yaml">YAML</h5>
+<div class="paragraph">
+<p>The slide switch as it appears in the application.yml:</p>
+</div>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight"><code class="language-yaml" data-lang="yaml">    slide-switch-input:
+      name: Slide Switch Input
+      address: 18
+      pull: PULL_DOWN
+      debounce: 3000
+      provider: pigpio-digital-input
+
+    slide-switch-input-2:
+      name: Slide Switch Input
+      address: 22
+      pull: PULL_DOWN
+      debounce: 3000
+      provider: pigpio-digital-input</code></pre>
+</div>
+</div>
+<div class="paragraph">
+<p>Note that there are two slide switches, one that uses GPIO 18 and the other uses GPIO 22.</p>
+</div>
+</div>
+<div class="sect4">
 <h5 id="_constructors">Constructors</h5>
 <div class="listingblock">
 <div class="content">
-<pre class="highlight"><code class="language-java" data-lang="java">Unresolved directive in slideSwitch.adoc - include::../../../../../../micronautpi4j-utils/src/main/java/com/opensourcewithslu/inputDevices/SlideSwitchHelper.java[tag=const]</code></pre>
+<pre class="highlight"><code class="language-java" data-lang="java">Unresolved directive in slideSwitch.adoc - include::../../../../main/java/com/opensourcewithslu/inputDevices/SlideSwitchHelper.java[tag=const]</code></pre>
 </div>
 </div>
 </div>
 <div class="sect4">
 <h5 id="_methods">Methods</h5>
 <div class="listingblock">
 <div class="content">
-<pre class="highlight"><code class="language-java" data-lang="java">Unresolved directive in slideSwitch.adoc - include::../../../../../../micronautpi4j-utils/src/main/java/com/opensourcewithslu/inputDevices/SlideSwitchHelper.java[tags=method]</code></pre>
+<pre class="highlight"><code class="language-java" data-lang="java">Unresolved directive in slideSwitch.adoc - include::../../../../main/java/com/opensourcewithslu/inputDevices/SlideSwitchHelper.java[tags=method]</code></pre>
 </div>
 </div>
 </div>
@@ -214,7 +288,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-21 14:50:16 UTC
+Last updated 2023-10-22 15:43:37 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-21 14:50:16 UTC
+Last updated 2023-10-22 15:43:37 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-21 14:50:16 UTC
+Last updated 2023-10-22 15:43:37 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-21 14:50:16 UTC
+Last updated 2023-10-22 15:43:37 UTC
 </div>
 </div>
 </body>

diff --git a/components/outputComponents/rgbLed.html b/components/outputComponents/rgbLed.html
@@ -369,7 +369,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-21 14:50:16 UTC
+Last updated 2023-10-22 15:43:37 UTC
 </div>
 </div>
 </body>

diff --git a/contribute/newComponent.html b/contribute/newComponent.html
@@ -279,7 +279,7 @@ <h3 id="_how_to_create_a_new_component">How to Create a New Component</h3>
 <div id="footer">
 <div id="footer-text">
 Version v1.0.0<br>
-Last updated 2023-10-21 14:50:16 UTC
+Last updated 2023-10-22 15:43:37 UTC
 </div>
 </div>
 </body>

diff --git a/howContribute.html b/howContribute.html
@@ -293,7 +293,7 @@ <h3 id="_how_to_create_a_new_component">How to Create a New Component</h3>
 <div id="footer">
 <div id="footer-text">
 Version v1.0.0<br>
-Last updated 2023-10-21 14:50:16 UTC
+Last updated 2023-10-22 15:43:37 UTC
 </div>
 </div>
 </body>