From e6ac577d7c0a8481c450eee8d6327466d9abf1d5 Mon Sep 17 00:00:00 2001 From: ruthvikm Date: Sun, 22 Oct 2023 15:44:15 +0000 Subject: [PATCH] deploy: c6918a5022e4e93e853b377f2ea817dafd91305c --- Introduction/exampleApplications.html | 2 +- Introduction/supportedHardware.html | 2 +- adding_creating_App.html | 2 +- components.html | 2 +- components/commun_WithHardware.html | 2 +- .../commun_WithHardware/digitalInput.html | 2 +- .../commun_WithHardware/digitalOutput.html | 2 +- components/commun_WithHardware/i2c.html | 2 +- .../commun_WithHardware/multipinConfig.html | 2 +- components/commun_WithHardware/pwm.html | 2 +- components/commun_WithHardware/spi.html | 2 +- components/inputComponents.html | 2 +- components/inputComponents/photosensor.html | 2 +- components/inputComponents/pushButton.html | 2 +- components/inputComponents/rfidScanner.html | 2 +- components/inputComponents/rotaryEncoder.html | 2 +- components/inputComponents/slideSwitch.html | 80 ++++++++++++++++- components/outputComponents.html | 2 +- components/outputComponents/lcdScreen.html | 2 +- components/outputComponents/led.html | 2 +- components/outputComponents/rgbLed.html | 2 +- contribute/newComponent.html | 2 +- howContribute.html | 2 +- index.html | 86 +++++++++++++++++-- introduction.html | 2 +- usingLibrary.html | 2 +- 26 files changed, 181 insertions(+), 33 deletions(-) diff --git a/Introduction/exampleApplications.html b/Introduction/exampleApplications.html index ee4a3ef9..32443312 100644 --- a/Introduction/exampleApplications.html +++ b/Introduction/exampleApplications.html @@ -196,7 +196,7 @@

Remote Mointoring Check-In System
Version v1.0.0
-Last updated 2023-10-21 14:50:16 UTC +Last updated 2023-10-22 15:43:37 UTC
diff --git a/Introduction/supportedHardware.html b/Introduction/supportedHardware.html index 40f12ee0..87587381 100644 --- a/Introduction/supportedHardware.html +++ b/Introduction/supportedHardware.html @@ -221,7 +221,7 @@

Currently Supported Hardware

diff --git a/adding_creating_App.html b/adding_creating_App.html index 8e0a3dfc..c38e361b 100644 --- a/adding_creating_App.html +++ b/adding_creating_App.html @@ -193,7 +193,7 @@

Adding to/Creating an Application

Version v1.0.0
-Last updated 2023-10-21 14:50:16 UTC +Last updated 2023-10-22 15:43:37 UTC
diff --git a/components.html b/components.html index db863152..28269824 100644 --- a/components.html +++ b/components.html @@ -189,7 +189,7 @@

Components

diff --git a/components/commun_WithHardware.html b/components/commun_WithHardware.html index 0b4a4dca..45b6bbb3 100644 --- a/components/commun_WithHardware.html +++ b/components/commun_WithHardware.html @@ -191,7 +191,7 @@

Communicating with a Hardware diff --git a/components/commun_WithHardware/digitalInput.html b/components/commun_WithHardware/digitalInput.html index e7146c7a..4cd83da5 100644 --- a/components/commun_WithHardware/digitalInput.html +++ b/components/commun_WithHardware/digitalInput.html @@ -237,7 +237,7 @@

Digital Input

diff --git a/components/commun_WithHardware/digitalOutput.html b/components/commun_WithHardware/digitalOutput.html index 5ba396e6..cf87935b 100644 --- a/components/commun_WithHardware/digitalOutput.html +++ b/components/commun_WithHardware/digitalOutput.html @@ -237,7 +237,7 @@

Digital Output

diff --git a/components/commun_WithHardware/i2c.html b/components/commun_WithHardware/i2c.html index 6c7b357a..ee193fa5 100644 --- a/components/commun_WithHardware/i2c.html +++ b/components/commun_WithHardware/i2c.html @@ -211,7 +211,7 @@

I2C

diff --git a/components/commun_WithHardware/multipinConfig.html b/components/commun_WithHardware/multipinConfig.html index 0a7048db..0e1ab598 100644 --- a/components/commun_WithHardware/multipinConfig.html +++ b/components/commun_WithHardware/multipinConfig.html @@ -262,7 +262,7 @@

Multipin Configurations

diff --git a/components/commun_WithHardware/pwm.html b/components/commun_WithHardware/pwm.html index cd353dec..d65b54f0 100644 --- a/components/commun_WithHardware/pwm.html +++ b/components/commun_WithHardware/pwm.html @@ -237,7 +237,7 @@

PWM

diff --git a/components/commun_WithHardware/spi.html b/components/commun_WithHardware/spi.html index 17a7875c..c07e066a 100644 --- a/components/commun_WithHardware/spi.html +++ b/components/commun_WithHardware/spi.html @@ -214,7 +214,7 @@

SPI

diff --git a/components/inputComponents.html b/components/inputComponents.html index 0c82bdc8..846ebce7 100644 --- a/components/inputComponents.html +++ b/components/inputComponents.html @@ -187,7 +187,7 @@

Input Components

diff --git a/components/inputComponents/photosensor.html b/components/inputComponents/photosensor.html index 9ffbc69e..aada1851 100644 --- a/components/inputComponents/photosensor.html +++ b/components/inputComponents/photosensor.html @@ -190,7 +190,7 @@

Photosensor

diff --git a/components/inputComponents/pushButton.html b/components/inputComponents/pushButton.html index e29c49d6..c630768a 100644 --- a/components/inputComponents/pushButton.html +++ b/components/inputComponents/pushButton.html @@ -325,7 +325,7 @@
This co diff --git a/components/inputComponents/rfidScanner.html b/components/inputComponents/rfidScanner.html index 2de49915..97839d41 100644 --- a/components/inputComponents/rfidScanner.html +++ b/components/inputComponents/rfidScanner.html @@ -214,7 +214,7 @@
This diff --git a/components/inputComponents/rotaryEncoder.html b/components/inputComponents/rotaryEncoder.html index d6433057..7170fc85 100644 --- a/components/inputComponents/rotaryEncoder.html +++ b/components/inputComponents/rotaryEncoder.html @@ -236,7 +236,7 @@
This controller sets up tw diff --git a/components/inputComponents/slideSwitch.html b/components/inputComponents/slideSwitch.html index 8794b77a..91c85b3c 100644 --- a/components/inputComponents/slideSwitch.html +++ b/components/inputComponents/slideSwitch.html @@ -183,10 +183,84 @@

Slide Switch

Improve this doc

+
Overview
+
+

This section provides the details of the Slide Switch circuit, including its components, assembly instructions, and functionality.

+
+
+
+
Components
+
+
    +
  • +

    Slide Switch

    +
    • +
  • +

    1 x 10Ω resistor

    +
    • +
  • +

    1 x Capacitor 104

    +
    • +
  • +

    Breadboard

    +
    • +
  • +

    7 x Jumper Wires

    +
    • +
  • +

    Power source (appropriate voltage, typically 3.3V or 5V)

    +
    • +
+
+
+
+
Circuit Diagram
+
+

Model:

+
+
+
+slideSwitch circuit +
+
+
+
+
Testing the Circuit:
+
+

Use: curl http://localhost:8080/slideSwitch/switch1 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.

+
+
+
+
YAML
+
+

The slide switch as it appears in the application.yml:

+
+
+
+
    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
+
+
+
+

Note that there are two slide switches, one that uses GPIO 18 and the other uses GPIO 22.

+
+
+
Constructors
-
Unresolved directive in slideSwitch.adoc - include::../../../../../../micronautpi4j-utils/src/main/java/com/opensourcewithslu/inputDevices/SlideSwitchHelper.java[tag=const]
+
Unresolved directive in slideSwitch.adoc - include::../../../../main/java/com/opensourcewithslu/inputDevices/SlideSwitchHelper.java[tag=const]
@@ -194,7 +268,7 @@
Constructors
Methods
-
Unresolved directive in slideSwitch.adoc - include::../../../../../../micronautpi4j-utils/src/main/java/com/opensourcewithslu/inputDevices/SlideSwitchHelper.java[tags=method]
+
Unresolved directive in slideSwitch.adoc - include::../../../../main/java/com/opensourcewithslu/inputDevices/SlideSwitchHelper.java[tags=method]
@@ -214,7 +288,7 @@
This controller sets up two diff --git a/components/outputComponents.html b/components/outputComponents.html index e7cc305e..feeec7de 100644 --- a/components/outputComponents.html +++ b/components/outputComponents.html @@ -187,7 +187,7 @@

Output Components

diff --git a/components/outputComponents/lcdScreen.html b/components/outputComponents/lcdScreen.html index 643c91b8..92f41e52 100644 --- a/components/outputComponents/lcdScreen.html +++ b/components/outputComponents/lcdScreen.html @@ -211,7 +211,7 @@
An Example Controller
diff --git a/components/outputComponents/led.html b/components/outputComponents/led.html index 2c07558a..cbd90f1a 100644 --- a/components/outputComponents/led.html +++ b/components/outputComponents/led.html @@ -212,7 +212,7 @@
This controller turns the LED diff --git a/components/outputComponents/rgbLed.html b/components/outputComponents/rgbLed.html index 672249ea..311012e5 100644 --- a/components/outputComponents/rgbLed.html +++ b/components/outputComponents/rgbLed.html @@ -369,7 +369,7 @@
An Example Controller
diff --git a/contribute/newComponent.html b/contribute/newComponent.html index 2e1bbe0c..d29db6a9 100644 --- a/contribute/newComponent.html +++ b/contribute/newComponent.html @@ -279,7 +279,7 @@

How to Create a New Component

diff --git a/howContribute.html b/howContribute.html index 7ae10d3e..4e7db71f 100644 --- a/howContribute.html +++ b/howContribute.html @@ -293,7 +293,7 @@

How to Create a New Component

diff --git a/index.html b/index.html index 87c8ac49..d3a3b702 100644 --- a/index.html +++ b/index.html @@ -920,10 +920,84 @@

4.2.2. Slide

Improve this doc

+
Overview
+
+

This section provides the details of the Slide Switch circuit, including its components, assembly instructions, and functionality.

+
+
+
+
Components
+
+
    +
  • +

    Slide Switch

    +
    • +
  • +

    1 x 10Ω resistor

    +
    • +
  • +

    1 x Capacitor 104

    +
    • +
  • +

    Breadboard

    +
    • +
  • +

    7 x Jumper Wires

    +
    • +
  • +

    Power source (appropriate voltage, typically 3.3V or 5V)

    +
    • +
+
+
+
+
Circuit Diagram
+
+

Model:

+
+
+
+slideSwitch circuit +
+
+
+
+
Testing the Circuit:
+
+

Use: curl http://localhost:8080/slideSwitch/switch1 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.

+
+
+
+
YAML
+
+

The slide switch as it appears in the application.yml:

+
+
+
+
    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
+
+
+
+

Note that there are two slide switches, one that uses GPIO 18 and the other uses GPIO 22.

+
+
+
Constructors
-
Unresolved directive in components/inputComponents/slideSwitch.adoc - include::../../../../../../micronautpi4j-utils/src/main/java/com/opensourcewithslu/inputDevices/SlideSwitchHelper.java[tag=const]
+
Unresolved directive in components/inputComponents/slideSwitch.adoc - include::../../../../main/java/com/opensourcewithslu/inputDevices/SlideSwitchHelper.java[tag=const]
@@ -931,7 +1005,7 @@

Construct
Methods
-
Unresolved directive in components/inputComponents/slideSwitch.adoc - include::../../../../../../micronautpi4j-utils/src/main/java/com/opensourcewithslu/inputDevices/SlideSwitchHelper.java[tags=method]
+
Unresolved directive in components/inputComponents/slideSwitch.adoc - include::../../../../main/java/com/opensourcewithslu/inputDevices/SlideSwitchHelper.java[tags=method]
@@ -1122,14 +1196,14 @@

4.3.2. RGB LED

Improve this doc

-
Overview
+
Overview

This document provides details of the RGB (Red-Green-Blue) LED circuit, including its components, assembly instructions, and functionality.

-
Components
+
Components
  1. @@ -1183,7 +1257,7 @@
-
Circuit Diagram
+
Circuit Diagram

Model:

@@ -1562,7 +1636,7 @@

Version v1.0.0
-Last updated 2023-10-21 14:50:16 UTC +Last updated 2023-10-22 15:43:37 UTC