Update documentation (#241)

* updated added_dependency.png * doc bug fix
oss-slu · May 9, 2024 · 390fa0d · 390fa0d
1 parent 8448293
commit 390fa0d
Show file tree

Hide file tree

Showing 8 changed files with 13 additions and 5 deletions.
diff --git a/pi4micronaut-utils/src/docs/asciidoc/Introduction/exampleApplications.adoc b/pi4micronaut-utils/src/docs/asciidoc/Introduction/exampleApplications.adoc
@@ -10,3 +10,6 @@ https://github.com/oss-slu/SLU_OSS_CheckIn
 
 ==== Home Automation
 https://github.com/oss-slu/Pi4Micronaut/tree/Home_Automation
+
+==== Lab Automation
+https://github.com/oss-slu/Pi4Micronaut/tree/Lab_Automation
diff --git a/pi4micronaut-utils/src/docs/asciidoc/Introduction/howToUsePi4Micronaut.adoc b/pi4micronaut-utils/src/docs/asciidoc/Introduction/howToUsePi4Micronaut.adoc
@@ -30,7 +30,7 @@ image:Using_Micronaut.png[]
 +
 [source, gradle]
 ----
-implementation("io.github.oss-slu:pi4micronaut-utils:v1.0:all")
+implementation("io.github.oss-slu:pi4micronaut-utils:v1.1:all")
 ----
 +
 It should look like:

diff --git a/pi4micronaut-utils/src/docs/asciidoc/Introduction/supportedHardware.adoc b/pi4micronaut-utils/src/docs/asciidoc/Introduction/supportedHardware.adoc
@@ -18,4 +18,7 @@ We plan on offering support for many more hardware components in the future. If
 * Active Buzzer
 * Passive Buzzer
 * PIR Motion Sensor
-* Ultrasonic Sensor
+* Ultrasonic Sensor
+* Servo Motor
+* Tilt Switch
+* Micro Switch
diff --git a/pi4micronaut-utils/src/docs/asciidoc/components/commun_WithHardware.adoc b/pi4micronaut-utils/src/docs/asciidoc/components/commun_WithHardware.adoc
@@ -21,7 +21,7 @@ which determines how the circuit is created by utilizing the I2C pins of the GPI
 Based on the pins and communication type, you have to define the configuration in the yml file accordingly.
 If a user wants to implement multiple hardware components then the configuration should be defined in the snake yml structure.
 
-==== YAML Configuration Workflow:
+==== YAML Configuration Workflow
 
 - The specifications in the yml file are given to the component in the controller through the use of the @Named() annotation.
 - The controller passes on the configuration to the helper through the object.

diff --git a/pi4micronaut-utils/src/docs/asciidoc/components/inputComponents/microSwitch.adoc b/pi4micronaut-utils/src/docs/asciidoc/components/inputComponents/microSwitch.adoc
@@ -15,7 +15,7 @@ https://github.com/oss-slu/Pi4Micronaut/edit/develop/pi4micronaut-utils/src/docs
 
 ===== Overview
 
-This section provides details of a Micro Switch sensor implementation, including its circuit diagram, schematic diagram,
+This section provides details of a Micro Switch implementation, including its circuit diagram, schematic diagram,
 required hardware components, assembly instructions, and functionality.
 
 ===== Components

diff --git a/pi4micronaut-utils/src/docs/asciidoc/components/inputComponents/tiltSwitch.adoc b/pi4micronaut-utils/src/docs/asciidoc/components/inputComponents/tiltSwitch.adoc
@@ -15,7 +15,7 @@ https://github.com/oss-slu/Pi4Micronaut/edit/develop/pi4micronaut-utils/src/docs
 
 ===== Overview
 
-This section provides details of a tilt switch sensor implementation, including its circuit diagram,
+This section provides details of a tilt switch implementation, including its circuit diagram,
 required hardware components, assembly instructions, and functionality.
 
 ===== Components

diff --git a/pi4micronaut-utils/src/docs/asciidoc/img/Adding_Dependency.png b/pi4micronaut-utils/src/docs/asciidoc/img/Adding_Dependency.png
diff --git a/pi4micronaut-utils/src/docs/asciidoc/introduction.adoc b/pi4micronaut-utils/src/docs/asciidoc/introduction.adoc
@@ -11,6 +11,8 @@ Welcome to the **Pi4Micronaut Documentation**!
 
 Pi4Micronaut is an Open Source Java library which utilizes the Micronaut Framework and Pi4J to streamline the process of creating custom IoT applications that require hardware connectivity to Raspberry Pi's.
 
+**Note:** Pi4Micronaut doesn't work with the latest Raspberry Pi 5 because of its whole new architecture. Pi4J and pigpio libraries doesn't provide support for Pi 5 yet. Look out for the latest version of Pi4J to work with Pi5's in the future.
+
 By reading through our documentation, you will learn how to implement our library into your application.