images show up and other .adoc changes

Author: ThomasPautler952194

pi4micronaut-utils/src/docs/asciidoc/components/inputComponents/IRObstacleAvoidance.adoc

@@ -13,31 +13,32 @@ endif::rootpath[]
 https://github.com/oss-slu/Pi4Micronaut/edit/develop/pi4micronaut-utils/src/docs/asciidoc/components/inputComponents/irObstacleAvoidanceSensor.adoc[Improve this doc]
 
 ===== Overview
-This section provides the details of the IR Obstacle Avoidance Sensor, including its components, assembly instructions, and functionality.
+This section provides details for the IR Obstacle Avoidance Sensor, including its components, assembly instructions, and functionality.
 
 The IR (Infrared) Obstacle Avoidance Module is a proximity sensor that detects objects and obstacles within a short distance (2-30cm) using infrared reflection. It is commonly used in robotics for collision avoidance, object detection, and boundary sensing. The module features adjustable sensitivity via a potentiometer, digital output for easy integration, fast response time, low power consumption, and operates on 3.3V to 5V power supplies.
 
 ===== Components
-* 1 x Raspberry Pi (Pi 3, 4, or Zero recommended)
+* 1 x Raspberry Pi 4
 * 1 x IR Obstacle Avoidance Module
-* 3 x Jumper Wires (Female-to-Male or appropriate connectors)
-* 1 x Breadboard (optional, for prototyping)
+* 5 x Male-to-Male Jumper Wires
+* 1 x Breadboard
 * Power supply for Raspberry Pi
 
 ===== Assembly Instructions
-* Place the IR Obstacle Avoidance Module onto the breadboard or connect directly to the Raspberry Pi.
-* Connect the **VCC** pin of the IR module to **5V** on the Raspberry Pi (Physical Pin 2 or 4).
-* Connect the **GND** pin of the IR module to **Ground** on the Raspberry Pi (Physical Pin 6, 9, 14, 20, 25, 30, 34, or 39).
-* Connect the **OUT** (or **DO**) pin of the IR module to **GPIO 17** on the Raspberry Pi (Physical Pin 11).
+* Place the IR Obstacle Avoidance Module onto the breadboard.
+* Connect the **VCC** pin of the IR module to **3.3V** on the Raspberry Pi.
+* Connect the **GND** pin of the IR module to **Ground** on the Raspberry Pi.
+* Connect the **OUT** (or **DO**) pin of the IR module to **GPIO 17** on the Raspberry Pi.
+* Use the remaining two jumper wires to secure the module to the breadboard, following the provided circuit diagram.
 * Verify connections to ensure no loose wires or short circuits.
-* Adjust the potentiometer (small blue or orange screw) to set detection sensitivity:
-  - Turn **clockwise** to increase sensitivity (detect closer objects).
-  - Turn **counter-clockwise** to decrease sensitivity (detect farther objects).
+* Adjust the potentiometer to set detection sensitivity:
+  - Turn **clockwise** to increase sensitivity.
+  - Turn **counter-clockwise** to decrease sensitivity.
 
-> **Tip**: Use 5V for better detection range and performance, though 3.3V is supported. Ensure the module's IR LEDs face forward.
+> **Tip**: Use 3.3V for compatibility with Raspberry Pi GPIO. Ensure the module's IR LEDs face forward.
 
 ===== Circuit Diagram
-image::irObstacleAvoidance-CD.png.png[]
+image::irObstacleAvoidance-CD.png[]
 
 ===== Schematic Diagram
 image::irObstacleAvoidance-SD.png[]
@@ -50,27 +51,39 @@ Use the following commands to test the component:
 
 [source, bash]
 ----
-$curl http://localhost:8080/irObstacleAvoidance/isObstacleDetected
+$curl http://localhost:8080/ir-obstacle/status
 ----
-* `/isObstacleDetected` - Returns `true` if an obstacle is detected, `false` if the path is clear.
+* `/status` - Returns `true` if an obstacle is detected, `false` if the path is clear.
 
 [source, bash]
 ----
-$curl http://localhost:8080/irObstacleAvoidance/getState
+$curl http://localhost:8080/ir-obstacle/state
 ----
-* `/getState` - Returns the raw digital state (`HIGH` or `LOW`).
+* `/state` - Returns the raw digital state (`HIGH` or `LOW`).
 
 [source, bash]
 ----
-$curl http://localhost:8080/irObstacleAvoidance/getStatusMessage
+$curl http://localhost:8080/ir-obstacle/message
 ----
-* `/getStatusMessage` - Returns a human-readable status (`"Obstacle detected"` or `"No obstacle"`).
+* `/message` - Returns a human-readable status (`"Obstacle detected"` or `"No obstacle"`).
+
+[source, bash]
+----
+$curl http://localhost:8080/ir-obstacle/wait/{timeoutMillis}
+----
+* `/wait/{timeoutMillis}` - Waits for obstacle detection within the specified timeout (in milliseconds) and returns `true` if detected, `false` otherwise.
+
+[source, bash]
+----
+$curl http://localhost:8080/ir-obstacle/init
+----
+* `/init` - Initializes the sensor and adds an event listener to print `"Obstacle Detected"` or `"No Obstacle"` to the console when the sensor state changes.
 
 ===== Troubleshooting
 **Sensor Always Reports Obstacle Detected**:
 * Adjust potentiometer counter-clockwise to decrease sensitivity.
 * Ensure the module is not facing a reflective surface.
-* Verify VCC is connected to 5V, not 3.3V.
+* Verify VCC is connected to 3.3V.
 * Test with a white object to confirm detection.
 * Check GPIO state with `gpio readall`.
 
@@ -79,7 +92,7 @@ $curl http://localhost:8080/irObstacleAvoidance/getStatusMessage
 * Verify OUT pin is connected to GPIO 17.
 * Confirm `application.yml` has the correct GPIO address.
 * Test with a reflective object (e.g., white or shiny surface).
-* Measure OUT pin voltage with a multimeter (should switch between 0V and 5V).
+* Measure OUT pin voltage with a multimeter (should switch between 0V and 3.3V).
 
 **Inconsistent Detection**:
 * Increase debounce time in `application.yml` to 20000 (20ms).
@@ -89,7 +102,7 @@ $curl http://localhost:8080/irObstacleAvoidance/getStatusMessage
 * Add a 100µF capacitor across VCC and GND near the module.
 
 **Module Won't Power On**:
-* Verify 5V at VCC with a multimeter.
+* Verify 3.3V at VCC with a multimeter.
 * Check GND connections.
 * Ensure `application.yml` is correctly configured.
 * Test GPIO manually with `gpio mode 17 in` and `gpio read 17`.