Fixes #221 Joss Paper

.gitignore

@@ -15,5 +15,5 @@ out/
 .classpath
 .factorypath
 *@*
-Workflow.png
+Workflow_Diagram.png
 Pi4Micronaut_logo.png

README.md

@@ -36,7 +36,7 @@ The existence of Pi4Micronaut is justified by the need for a robust, scalable, a
 - [API Reference](https://oss-slu.github.io/Pi4Micronaut/javadoc/index.html)
 
 ### Architecture Diagram
-![Pi4Micronaut.png](Workflow.png)
+![Pi4Micronaut.png](Workflow_Diagram.png)
 
 ## Micronaut 3.7.3
 - [Micronaut 3.7.3 User Guide](https://micronaut-projects.github.io/micronaut-docs-mn3/3.7.3/guide/index.html)

components/src/main/java/com/opensourcewithslu/components/controllers/ActiveBuzzerController.java

@@ -6,6 +6,7 @@
 import io.micronaut.http.annotation.Get;
 import jakarta.inject.Named;
 
+//tag::ex[]
 @Controller("/active-buzzer")
 public class ActiveBuzzerController {
 
@@ -37,7 +38,7 @@ public void disableActiveBuzzer(){
     }
 
     /**
-     * Emits an beep sound from the active buzzer.
+     * Emits a beep sound from the active buzzer.
      */
     @Get("/beepTone")
     public void playBeepTone(){
@@ -65,4 +66,5 @@ public void morseCodeTest(){
 
         activeBuzzerHelper.morseCodeTone();
     }
-}
+}
+//end::ex[]

components/src/main/java/com/opensourcewithslu/components/controllers/LEDController.java

@@ -6,6 +6,7 @@
 import io.micronaut.http.annotation.Get;
 import jakarta.inject.Named;
 
+//tag::ex[]
 @Controller("/led")
 public class LEDController {
     private final LEDHelper ledHelper;
@@ -28,4 +29,10 @@ public void ledOff(){
     public void switchState(){
         ledHelper.switchState();
     }
+
+    @Get("/blink/{duration}/")
+    public void blink(int duration){
+        ledHelper.blink(duration);
+    }
 }
+//end::ex[]

components/src/main/java/com/opensourcewithslu/components/controllers/PIRSensorController.java

@@ -2,7 +2,7 @@
 
 import com.opensourcewithslu.inputdevices.PIRSensorHelper;
 import com.opensourcewithslu.outputdevices.RGBLEDHelper;
-import com.opensourcewithslu.utilities.MultipinConfiguration;
+import com.opensourcewithslu.utilities.MultiPinConfiguration;
 import com.pi4j.io.gpio.digital.DigitalInput;
 import io.micronaut.http.annotation.Controller;
 import io.micronaut.http.annotation.Get;
@@ -11,33 +11,28 @@
 /**
  * The PIRSensorController class is used with the PIRSensorHelper class and RGBHelper class to implement a PIR motion sensor with an RGB LED light.
  */
+
+//tag::ex[]
 @Controller("/pirSensor")
 public class PIRSensorController {
-
     private final PIRSensorHelper pirSensorHelper;
-
     private final RGBLEDHelper rgbledHelper;
-
     /**
      * The PirSensorController constructor.
      * @param pirSensor A Pi4J DigitalInput object.
      * @param rgbLed A MultiPinConfiguration object.
      */
-    public PIRSensorController(@Named("pir-sensor")DigitalInput pirSensor,
-                               @Named("rgb-led-2")MultipinConfiguration rgbLed) {
+    public PIRSensorController(@Named("pir-sensor") DigitalInput pirSensor, @Named("rgb-led-2") MultiPinConfiguration rgbLed) {
         this.pirSensorHelper = new PIRSensorHelper(pirSensor);
         this.rgbledHelper = new RGBLEDHelper(rgbLed);
     }
-
     /**
      * Enables the PIR sensor by adding an event listener which sets the RGB LED to red when movement is detected and green otherwise.
      */
     @Get("/enable")
     public void enablePIRSensor() {
-
         int[] red = {255,0,0};
         int[] green = {0,255,0};
-
         pirSensorHelper.addEventListener(e -> {
             if (pirSensorHelper.isMoving) {
                 rgbledHelper.setColor(red);
@@ -47,7 +42,6 @@ public void enablePIRSensor() {
             }
         });
     }
-
     /**
      * Disables the controller by removing the event listener and turning off the RGB LED.
      */
@@ -56,5 +50,5 @@ public void disablePIRSensor() {
         pirSensorHelper.removeEventListener();
         rgbledHelper.ledOff();
     }
-
-}
+}
+//end::ex[]

components/src/main/java/com/opensourcewithslu/components/controllers/PassiveBuzzerController.java

@@ -6,6 +6,7 @@
 import jakarta.inject.Named;
 import java.io.File;
 
+//tag::ex[]
 @Controller("/passive-buzzer")
 public class PassiveBuzzerController {
 
@@ -94,4 +95,5 @@ public void playPiTone(){
         passiveBuzzerHelper.piToneSequence();
 
     }
-}
+}
+//end::ex[]

components/src/main/java/com/opensourcewithslu/components/controllers/RotaryEncoderController.java

@@ -1,7 +1,7 @@
 package com.opensourcewithslu.components.controllers;
 
 import com.opensourcewithslu.inputdevices.RotaryEncoderHelper;
-import com.opensourcewithslu.utilities.MultipinConfiguration;
+import com.opensourcewithslu.utilities.MultiPinConfiguration;
 import io.micronaut.http.annotation.Controller;
 import io.micronaut.http.annotation.Get;
 import jakarta.inject.Named;
@@ -11,7 +11,7 @@
 public class RotaryEncoderController {
     private final RotaryEncoderHelper encoderHelper;
 
-    public RotaryEncoderController(@Named("rotary-encoder")MultipinConfiguration rotaryEncoder){
+    public RotaryEncoderController(@Named("rotary-encoder") MultiPinConfiguration rotaryEncoder){
         this.encoderHelper = new RotaryEncoderHelper(rotaryEncoder);
     }
 

components/src/main/java/com/opensourcewithslu/components/controllers/TouchSwitchController.java

@@ -8,6 +8,7 @@
 import io.micronaut.http.annotation.Get;
 import jakarta.inject.Named;
 
+//tag::ex[]
 @Controller("/touchSwitch")
 public class TouchSwitchController {
 
@@ -37,4 +38,5 @@ public void enableTouchSwitch() {
     public void disableTouchSwitch() {
         touchSwitchHelper.removeEventListener();
     }
-}
+}
+//end::ex[]

components/src/main/java/com/opensourcewithslu/components/controllers/UltraSonicSensorController.java

@@ -9,6 +9,7 @@
 import jakarta.inject.Named;
 
 
+//tag::ex[]
 @Controller("/ultraSound")
 public class UltraSonicSensorController {
 
@@ -55,3 +56,4 @@ public String disableUltrasoundSensor() {
         return "Ultra Sonic Sensor Disabled";
     }
 }
+//end::ex[]

components/src/main/java/com/opensourcewithslu/components/controllers/lcdController.java

@@ -11,6 +11,7 @@
 /**
  * Controller for managing LCD1602 display operations via HTTP requests.
  */
+//tag::ex[]
 @Controller("/lcd")
 public class lcdController {
     private final LCD1602Helper lcdHelper;
@@ -37,10 +38,10 @@ public String writeDataAtPos(@PathVariable String text, @PathVariable int line,
         return "Text written at line " + line + ", position " + pos + ": " + text + "\n";
     }
 
-    @Get("/write/character/{charvalue}")
-    public String writeCharacter(@PathVariable char charvalue) {
-        lcdHelper.writeCharacter(charvalue);
-        return "Character '" + charvalue + "' written to LCD\n";
+    @Get("/write/character/{charValue}")
+    public String writeCharacter(@PathVariable char charValue) {
+        lcdHelper.writeCharacter(charValue);
+        return "Character '" + charValue + "' written to LCD\n";
     }
 
     @Get("/backlight/{state}")
@@ -68,3 +69,4 @@ public String turnOff() {
         return "Display turned off\n";
     }
 }
+//end::ex[]

components/src/main/java/com/opensourcewithslu/components/controllers/rgbController.java

@@ -1,7 +1,7 @@
 package com.opensourcewithslu.components.controllers;
 
 import com.opensourcewithslu.outputdevices.RGBLEDHelper;
-import com.opensourcewithslu.utilities.MultipinConfiguration;
+import com.opensourcewithslu.utilities.MultiPinConfiguration;
 import io.micronaut.http.annotation.Controller;
 import io.micronaut.http.annotation.Get;
 import jakarta.inject.Named;
@@ -11,7 +11,7 @@
 public class rgbController {
     private final RGBLEDHelper rgbledHelper;
 
-    public rgbController(@Named("rgb-led") MultipinConfiguration rgbLed){
+    public rgbController(@Named("rgb-led") MultiPinConfiguration rgbLed){
         this.rgbledHelper = new RGBLEDHelper(rgbLed);
     }
 

components/src/main/resources/application.yml

@@ -14,34 +14,13 @@ pi4j:
 
   # tag::pwm[]
   pwm:
-    red-pwm:                  # <1>
-      name: red               # <2>
-      address: 17             # <3>
-      pwmType: SOFTWARE       # <4>
-      provider: pigpio-pwm    # <5>
-      initial: 0              # <6>
-      shutdown: 0             # <7>
-    blue-pwm:
-      name: blue
-      address: 18
-      pwmType: SOFTWARE
-      provider: pigpio-pwm
-      initial: 0
-      shutdown: 0
-    green-pwm:
-      name: green
-      address: 27
-      pwmType: SOFTWARE
-      provider: pigpio-pwm
-      initial: 0
-      shutdown: 0
-    active-buzzer:
-      name: active-buzzer
-      address: 17
-      pwmType: SOFTWARE
-      provider: pigpio-pwm
-      initial: 0
-      shutdown: 0
+    active-buzzer:               # <1>
+      name: active-buzzer        # <2>
+      address: 17                # <3>
+      pwmType: SOFTWARE          # <4>
+      provider: pigpio-pwm       # <5>
+      initial: 0                 # <6>
+      shutdown: 0                # <7>
     passive-buzzer:
       name: passive-buzzer
       address: 17
@@ -165,7 +144,7 @@ pi4j:
       provider: pigpio-digital-input
   # end::multiInput[]
 
-  # tag::multipwm[]
+  # tag::multiPWM[]
   multi-pwm:
     rgb-led:                                    # <.>
       name: RGB LED                             # <.>
@@ -181,22 +160,5 @@ pi4j:
       provider: pigpio-pwm
       initials: 0, 0, 0
       shutdowns: 0, 0, 0
-  # end::multipwm[]
-
+  # end::multiPWM[]
 
-#  clk:
-#    name: CLK Output
-#    address: 23
-#    debounce: 500
-#    pull: PULL_UP
-#    shutdown: LOW
-#    initial: HIGH
-#    provider: pigpio-digital-input
-#  dt:
-#    name: DT Output
-#    address: 24
-#    debounce: 500
-#    pull: PULL_UP
-#    shutdown: LOW
-#    initial: HIGH
-#    provider: pigpio-digital-input

joss/paper.bib

@@ -0,0 +1,31 @@
+@article{Jolles,
+    author  = {Jolles, Jolle W.},
+    journal = {Methods in Ecology and Evolution},
+    title   = {Broad‐scale applications of the Raspberry Pi: A Review and guide for Biologists.},
+    year    = {2021},
+    pages   = {1562-1579},
+    volume  = {12},
+    doi     = {10.1111/2041-210X.13652}
+
+}
+
+@article{Longley,
+    author  = {Longley, Matthew, et al.},
+    journal = {PeerJ},
+    title   = {An open source device for operant licking in rats.},
+    year    = {2017},
+    volume  = {5},
+    doi     = {10.7717/peerj.2981.}
+}
+
+
+@article{Shah,
+    author  ={ Shah, Neel P., and Priyang Bhatt},
+    journal ={International Journal of Advanced Research in Computer Science},
+    title   = {Greenhouse Automation and Monitoring System Design and Implementation},
+    year    = {2017},
+    pages   = {468-471},
+    volume  = {8},
+    doi     = {10.26483/ijarcs.v8i9.4981}
+
+}