diff --git a/components/src/main/java/com/opensourcewithslu/components/controllers/UltraSonicSensorController.java b/components/src/main/java/com/opensourcewithslu/components/controllers/UltraSonicSensorController.java
index f0023096..16296763 100644
--- a/components/src/main/java/com/opensourcewithslu/components/controllers/UltraSonicSensorController.java
+++ b/components/src/main/java/com/opensourcewithslu/components/controllers/UltraSonicSensorController.java
@@ -8,7 +8,7 @@
import io.micronaut.http.annotation.Get;
import jakarta.inject.Named;
-
+//tag::ex[]
@Controller("/ultraSound")
public class UltraSonicSensorController {
@@ -55,3 +55,4 @@ public String disableUltrasoundSensor() {
return "Ultra Sonic Sensor Disabled";
}
}
+//end::ex[]
diff --git a/pi4micronaut-utils/src/docs/asciidoc/components/inputComponents/ultraSonicSensor.adoc b/pi4micronaut-utils/src/docs/asciidoc/components/inputComponents/ultraSonicSensor.adoc
new file mode 100644
index 00000000..38e848d7
--- /dev/null
+++ b/pi4micronaut-utils/src/docs/asciidoc/components/inputComponents/ultraSonicSensor.adoc
@@ -0,0 +1,78 @@
+==== Ultrasonic Sensor
+[.text-right]
+https://github.com/oss-slu/Pi4Micronaut/edit/develop/micronautpi4j-utils/src/docs/asciidoc/components/inputComponents/ultraSonicSensor.adoc[Improve this doc]
+
+===== Overview
+This document provides details of the Ultrasonic Sensor circuit,
+including its components, assembly instructions, and functionality.
+
+===== Components
+. HC SR04
+. T-Extension Board
+. Breadboard
+. Jumper wires
+. Power source
+
+===== Circuit Diagram
+Model:
+
+image::https://docs.sunfounder.com/projects/davinci-kit/en/latest/_images/image220.png[]
+
+
+
+Circuit Diagram:
+
+image::https://docs.sunfounder.com/projects/davinci-kit/en/latest/_images/image329.png[]
+
+===== Functionality
+The Ultrasonic Sensor uses sound waves to calculate the distance from itself to the surface it is pointed at.
+The resulting measurement is accurate within 3mm and has a stable signal within 5m of the sensor,
+gradually weakening until fully it fully disappears at 7m.
+
+===== Troubleshooting
+. Distance measurements not showing: Check all connections, ensure the sensor is placed correctly,
+and check the power source.
+
+===== YAML Pin Order
+The order for declaring the Trigger Pin for the Ultrasonic Sensor is as follows:
+
+[source, yaml]
+----
+digital-input:
+ ultra-sonic-trig:
+ address: 23
+----
+So the Trigger Pin would be connected to GPIO 23.
+
+The order for declaring the Echo Pin for the Ultrasonic Sensor is as follows:
+
+[source, yaml]
+----
+digital-output:
+ ultra-sonic-echo:
+ address: 24
+----
+So the Echo Pin would be connected to GPIO 24.
+
+===== Constructors
+
+[source, java]
+----
+include::../../../../../../pi4micronaut-utils/src/main/java/com/opensourcewithslu/inputDevices/UltraSonicSensorHelper.java[tag=const]
+----
+
+===== Methods
+
+[source, java]
+----
+include::../../../../../../pi4micronaut-utils/src/main/java/com/opensourcewithslu/inputDevices/UltraSonicSensorHelper.java[tags=method]
+----
+
+===== An Example Controller
+
+====== This controller uses the push button to turn an LED on and off
+
+[source, java]
+----
+include::../../../../../../components/src/main/java/com/opensourcewithslu/components/controllers/UltraSonicSensorController.java[tag=ex]
+----
\ No newline at end of file
diff --git a/pi4micronaut-utils/src/docs/javadoc/allclasses-index.html b/pi4micronaut-utils/src/docs/javadoc/allclasses-index.html
index fef0cb67..06f01ac2 100644
--- a/pi4micronaut-utils/src/docs/javadoc/allclasses-index.html
+++ b/pi4micronaut-utils/src/docs/javadoc/allclasses-index.html
@@ -1,159 +1,149 @@
-
-
-
-
-All Classes and Interfaces (pi4micronaut-utils v1.0 API)
-
-JavaScript is disabled on your browser.
-
-
-
-
-
-
-
-
Classes
-
-
-
-
-
-
The ActiveBuzzerHelper class contains methods that pertain to the control of the active buzzer.
-
-
-
-
Runs the Micronaut framework in the Pi4Micronaut framework.
-
-
-
-
This class handles the configuration of a digital input component.
-
-
-
-
This class handles the configuration of a digital input component that has multiple pins.
-
-
-
-
This class handles the configuration of a digital output component.
-
-
-
-
This class handles the configuration of an I2C components.
-
-
-
-
This helper class, LCD1602Helper, is for controlling and interacting with an I2C LCD1602 display.
-
-
-
-
The class LEDHelper contains methods that pertain to the control of a LED.
-
-
-
-
Class for configuring multipin components.
-
-
-
-
The PassiveBuzzerHelper class contains methods that pertain to the control of the passive buzzer.
-
-
-
-
The PhotoResistorHelper class is used to work with the functionalities of a Photo Resistor.
-
-
-
-
The Pi4JFactory class is responsible for creating all the beans for components that are being used.
-
-
-
-
The Pi4JMultipinFactory class is responsible for creating all the beans for all multi pin components that are being used.
-
-
-
-
The PIRSensorHelper class is used to initialize a PIR motion sensor.
-
-
-
-
The PushButtonHelper class is used to create a listener that determines when a 4 pin button is pressed.
-
-
-
-
The PwmConfiguration class handles the configuration of a pwm component.
-
-
-
-
This class handles the configuration of a PWM device that has multiple pins.
-
-
-
-
The RFIDHelper class is for interacting with an RFID scanner.
-
-
-
-
The RBGLEDHelper class handles all interactions with a RGB LED.
-
-
-
-
The RotaryEncoderHelper class initializes a rotary encoder component and returns the value of the encoder when called upon.
-
-
-
-
The SlideSwitchHelper class is used to initialize a slide switch.
-
-
-
-
This class handles the configuration of a SPI component.
-
-
-
-
The TouchSwitchHelper class is used to initialize a touch switch.
-
-
-
-
The UltraSonicSensorHelper class initializes the Ultra Sonic Sensor and provides component functionality
-
-
-
-
-
All Classes and Interfaces (pi4micronaut-utils v1.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
Classes
+
+
+
+
+
+
The ActiveBuzzerHelper class contains methods that pertain to the control of the active buzzer.
+
+
+
+
Runs the Micronaut framework in the Pi4Micronaut framework.
+
+
+
+
This class handles the configuration of a digital input component.
+
+
+
+
This class handles the configuration of a digital input component that has multiple pins.
+
+
+
+
This class handles the configuration of a digital output component.
+
+
+
+
This class handles the configuration of an I2C components.
+
+
+
+
This helper class, LCD1602Helper, is for controlling and interacting with an I2C LCD1602 display.
+
+
+
+
The class LEDHelper contains methods that pertain to the control of a LED.
+
+
+
+
Class for configuring multipin components.
+
+
+
+
The PhotoResistorHelper class is used to work with the functionalities of a Photo Resistor.
+
+
+
+
The Pi4JFactory class is responsible for creating all the beans for components that are being used.
+
+
+
+
The Pi4JMultipinFactory class is responsible for creating all the beans for all multi pin components that are being used.
+
+
+
+
The PushButtonHelper class is used to create a listener that determines when a 4 pin button is pressed.
+
+
+
+
The PwmConfiguration class handles the configuration of a pwm component.
+
+
+
+
This class handles the configuration of a PWM device that has multiple pins.
+
+
+
+
The RFIDHelper class is for interacting with an RFID scanner.
+
+
+
+
The RBGLEDHelper class handles all interactions with a RGB LED.
+
+
+
+
The RotaryEncoderHelper class initializes a rotary encoder component and returns the value of the encoder when called upon.
+
+
+
+
The SlideSwitchHelper class is used to initialize a slide switch.
+
+
+
+
This class handles the configuration of a SPI component.
+
+
+
+
The TouchSwitchHelper class is used to initialize a touch switch.
+
+
+
+
+
+
+
All Packages (pi4micronaut-utils v1.0 API)
-
-JavaScript is disabled on your browser.
-
-
-
-
-
-
-Package Summary
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
All Packages (pi4micronaut-utils v1.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+Package Summary
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Application (pi4micronaut-utils v1.0 API)
-
-JavaScript is disabled on your browser.
-
-
-
-
-
-
-
-
-
-public class Application
-
extends Object Runs the Micronaut framework in the Pi4Micronaut framework.
-
-
-
-
-
-
-Constructor Summary
-Constructors
-
-
-
-
-
-
This is the default constructor for the Application class.
-
-
-
-
-
-
-Method Summary
-
-
All Methods Static Methods Concrete Methods
-
-
-
-
-
-
static void
-
-
-
The main entry point of the application.
-
-
-
-
-
Methods inherited from class java.lang.Object
-
clone , equals , finalize , getClass , hashCode , notify , notifyAll , toString , wait , wait , wait
-
-
-
-
-
-
-
-
-Constructor Details
-
-
-
-Application
-public Application ()
-This is the default constructor for the Application class.
- It initializes the application with default settings.
-
-
-
-
-
-
-
-
-Method Details
-
-
-
-main
-public static void main (String [] args) The main entry point of the application.
-
-Parameters:
-args - The command-line arguments passed to the application.
-
-
-
-
-
-
-
-
-
-
-
Application (pi4micronaut-utils v1.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+public class Application
+
extends Object Runs the Micronaut framework in the Pi4Micronaut framework.
+
+
+
+
+
+
+Constructor Summary
+Constructors
+
+
+
+
+
+
+Method Summary
+
+
All Methods Static Methods Concrete Methods
+
+
+
Methods inherited from class java.lang.Object
+
clone , equals , finalize , getClass , hashCode , notify , notifyAll , toString , wait , wait , wait
+
+
+
+
+
+
+
+
+Constructor Details
+
+
+
+Application
+public Application ()
+
+
+
+
+
+
+
+
+Method Details
+
+
+
+main
+public static void main (String [] args) constructor
+
+Parameters:
+args - None
+
+
+
+
+
+
+
+
+
+
+
PhotoResistorHelper (pi4micronaut-utils v1.0 API)
-
-JavaScript is disabled on your browser.
-
-
-
-
-
-
-
-
-
-public class PhotoResistorHelper
-
extends Object The PhotoResistorHelper class is used to work with the functionalities of a Photo Resistor.
-
-
-
-
-
-
-Field Summary
-Fields
-
-
-
-
-
boolean
-
-
-
To check if it is Dark.
-
-
-
-
-
-
-Constructor Summary
-Constructors
-
-
-
-
PhotoResistorHelper (com.pi4j.io.gpio.digital.DigitalInput sensorInput,
- com.pi4j.io.gpio.digital.DigitalOutput sensorOutput)
-
-
TouchSwitchHelper constructor.
-
-
-
-
-
-
-Method Summary
-
-
All Methods Instance Methods Concrete Methods
-
-
-
-
-
-
void
-
-
-
Adds an event listener to the Photo Resistor.
-
-
int
-
-
-
Returns the current value of the darknessValue variable.
-
-
void
-
-
-
Initializes the Photo Resistor and calls the updateDarkness function for every half second.
-
-
void
-
-
-
Removes the event listener from the Photo Resistor.
-
-
void
-
-
-
To set a threshold for Photo Resistor.
-
-
void
-
-
-
To set the Photo Resistor output to low for each event.
-
-
void
-
-
-
Updates the darknessValue of the Photo Resistor.
-
-
-
-
-
Methods inherited from class java.lang.Object
-
clone , equals , finalize , getClass , hashCode , notify , notifyAll , toString , wait , wait , wait
-
-
-
-
-
-
-
-
-Field Details
-
-
-
-isDark
-public boolean isDark
-To check if it is Dark.
-
-
-
-
-
-
-
-
-
-
-
-
-Method Details
-
-
-
-getDark
-public int getDark ()
-Returns the current value of the darknessValue variable.
-
-Returns:
-The current value of darknessValue.
-
-
-
-
-
-initialize
-public void initialize ()
-Initializes the Photo Resistor and calls the updateDarkness function for every half second.
-
-
-
-
-updateDark
-public void updateDark ()
-Updates the darknessValue of the Photo Resistor.
-
-
-
-
-setToLow
-public void setToLow ()
-To set the Photo Resistor output to low for each event.
-
-
-
-
-setDarknessThreshold
-public void setDarknessThreshold (int darknessThreshold)
-To set a threshold for Photo Resistor.
-
-Parameters:
-darknessThreshold - value is obtained from user.
-
-
-
-
-addEventListener
-public void addEventListener (com.pi4j.io.gpio.digital.DigitalStateChangeListener function)
-Adds an event listener to the Photo Resistor.
-
-Parameters:
-function - A Pi4J DigitalStateChangeListener object.
-
-
-
-
-removeEventListener
-public void removeEventListener ()
-Removes the event listener from the Photo Resistor.
-
-
-
-
-
-
-
-
-
-
-
PhotoResistorHelper (pi4micronaut-utils v1.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+public class PhotoResistorHelper
+
extends Object The PhotoResistorHelper class is used to work with the functionalities of a Photo Resistor.
+
+
+
+
+
+
+Field Summary
+Fields
+
+
+
+
+
boolean
+
+
+
To check if it is Dark.
+
+
+
+
+
+
+Constructor Summary
+Constructors
+
+
+
+
PhotoResistorHelper (com.pi4j.io.gpio.digital.DigitalInput sensorInput,
+ com.pi4j.io.gpio.digital.DigitalOutput sensorOutput)
+
+
TouchSwitchHelper constructor.
+
+
+
+
+
+
+Method Summary
+
+
All Methods Instance Methods Concrete Methods
+
+
+
+
+
+
void
+
+
+
Adds an event listener to the Photo Resistor.
+
+
int
+
+
+
void
+
+
+
Initializes the Photo Resistor and calls the updateDarkness function for every half second.
+
+
void
+
+
+
Removes the event listener from the Photo Resistor.
+
+
void
+
+
+
To set a threshold for Photo Resistor.
+
+
void
+
+
+
To set the Photo Resistor output to low for each event.
+
+
void
+
+
+
Updates the darknessValue of the Photo Resistor.
+
+
+
+
+
Methods inherited from class java.lang.Object
+
clone , equals , finalize , getClass , hashCode , notify , notifyAll , toString , wait , wait , wait
+
+
+
+
+
+
+
+
+Field Details
+
+
+
+isDark
+public boolean isDark
+To check if it is Dark.
+
+
+
+
+
+
+
+
+
+
+
+
+Method Details
+
+
+
+getDark
+public int getDark ()
+
+Returns:
+current darknessValue.
+
+
+
+
+
+initialize
+public void initialize ()
+Initializes the Photo Resistor and calls the updateDarkness function for every half second.
+
+
+
+
+updateDark
+public void updateDark ()
+Updates the darknessValue of the Photo Resistor.
+
+
+
+
+setToLow
+public void setToLow ()
+To set the Photo Resistor output to low for each event.
+
+
+
+
+setDarknessThreshold
+public void setDarknessThreshold (int darknessThreshold)
+To set a threshold for Photo Resistor.
+
+Parameters:
+darknessThreshold - value is obtained from user.
+
+
+
+
+addEventListener
+public void addEventListener (com.pi4j.io.gpio.digital.DigitalStateChangeListener function)
+Adds an event listener to the Photo Resistor.
+
+Parameters:
+function - A Pi4J DigitalStateChangeListener object.
+
+
+
+
+removeEventListener
+public void removeEventListener ()
+Removes the event listener from the Photo Resistor.
+
+
+
+
+
+
+
+
+
+
+
PushButtonHelper (pi4micronaut-utils v1.0 API)
-
-JavaScript is disabled on your browser.
-
-
-
-
-
-
-
-
-
-public class PushButtonHelper
-
extends Object The PushButtonHelper class is used to create a listener that determines when a 4 pin button is pressed.
-
-
-
-
-
-
-Field Summary
-Fields
-
-
-
-
-
-
-
-
Determines if the button is pressed.
-
-
-
-
-
-
-Constructor Summary
-Constructors
-
-
-
-
-
-
The PushButtonHelper constructor.
-
-
-
-
-
-
-Method Summary
-
-
All Methods Instance Methods Concrete Methods
-
-
-
-
-
-
void
-
-
-
Adds an EventListener to the PushButton.
-
-
void
-
-
-
Initializes the PushButton.
-
-
void
-
-
-
Removes an EvenListener from the button.
-
-
-
-
-
Methods inherited from class java.lang.Object
-
clone , equals , finalize , getClass , hashCode , notify , notifyAll , toString , wait , wait , wait
-
-
-
-
-
-
-
-
-Field Details
-
-
-
-isPressed
-
-Determines if the button is pressed.
-
-
-
-
-
-
-
-
-
-
-
-
-Method Details
-
-
-
-initialize
-public void initialize ()
-Initializes the PushButton. Automatically called when the PushButton is created.
-
-
-
-
-addEventListener
-public void addEventListener (com.pi4j.io.gpio.digital.DigitalStateChangeListener function)
-Adds an EventListener to the PushButton.
-
-Parameters:
-function - A DigitalStateChangeListener Object.
-
-
-
-
-removeEventListener
-public void removeEventListener (com.pi4j.io.gpio.digital.DigitalStateChangeListener function)
-Removes an EvenListener from the button.
-
-Parameters:
-function - The listener to be removed.
-
-
-
-
-
-
-
-
-
-
-
PushButtonHelper (pi4micronaut-utils v1.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+public class PushButtonHelper
+
extends Object The PushButtonHelper class is used to create a listener that determines when a 4 pin button is pressed.
+
+
+
+
+
+
+Field Summary
+Fields
+
+
+
+
+
+
+
+
Determines if the button is pressed.
+
+
+
+
+
+
+Constructor Summary
+Constructors
+
+
+
+
+
+
The PushButtonHelper constructor.
+
+
+
+
+
+
+Method Summary
+
+
All Methods Instance Methods Concrete Methods
+
+
+
+
+
+
void
+
+
+
Adds an EventListener to the PushButton.
+
+
void
+
+
+
Initializes the PushButton.
+
+
void
+
+
+
Removes an EvenListener from the button.
+
+
+
+
+
Methods inherited from class java.lang.Object
+
clone , equals , finalize , getClass , hashCode , notify , notifyAll , toString , wait , wait , wait
+
+
+
+
+
+
+
+
+Field Details
+
+
+
+isPressed
+
+Determines if the button is pressed.
+
+
+
+
+
+
+
+
+
+
+
+
+Method Details
+
+
+
+initialize
+public void initialize ()
+Initializes the PushButton. Automatically called when the PushButton is created.
+
+
+
+
+addEventListener
+public void addEventListener (com.pi4j.io.gpio.digital.DigitalStateChangeListener function)
+Adds an EventListener to the PushButton.
+
+Parameters:
+function - A DigitalStateChangeListener Object.
+
+
+
+
+removeEventListener
+public void removeEventListener (com.pi4j.io.gpio.digital.DigitalStateChangeListener function)
+Removes an EvenListener from the button.
+
+Parameters:
+function - The listener to be removed.
+
+
+
+
+
+
+
+
+
+
+
RFidHelper (pi4micronaut-utils v1.0 API)
-
-JavaScript is disabled on your browser.
-
-
-
-
-
-
-
-
-
-public class RFidHelper
-
extends Object The RFIDHelper class is for interacting with an RFID scanner.
-
-
-
-
-
-
-Constructor Summary
-Constructors
-
-
-
-
RFidHelper (com.pi4j.io.spi.SpiConfig config,
- int reset,
- com.pi4j.context.Context pi4jContext)
-
-
The RFidHelper constructor WITH the reset pin as a parameter.
-
-
RFidHelper (com.pi4j.io.spi.SpiConfig config,
- com.pi4j.context.Context pi4jContext)
-
-
The RFidHelper constructor WITHOUT the reset pin as a parameter.
-
-
-
-
-
-
-Method Summary
-
-
All Methods Instance Methods Concrete Methods
-
-
-
-
-
-
-
-
-
When called, this method waits for any RFID card/fob to be scanned.
-
-
void
-
-
-
Resets the RFID scanner.
-
-
void
-
-
-
Writes data to an RFID fob.
-
-
-
-
-
Methods inherited from class java.lang.Object
-
clone , equals , finalize , getClass , hashCode , notify , notifyAll , toString , wait , wait , wait
-
-
-
-
-
-
-
-
-Constructor Details
-
-
-
-RFidHelper
-public RFidHelper (com.pi4j.io.spi.SpiConfig config,
- int reset,
- com.pi4j.context.Context pi4jContext)
-The RFidHelper constructor WITH the reset pin as a parameter.
-
-Parameters:
-config - A Pi4J SPIConfig object which holds the SPI address and SPI Baud rate for RFID scanner.reset - Defines the reset pin for the RFID scanner.pi4jContext - The Pi4J context object.
-
-
-
-
-RFidHelper
-public RFidHelper (com.pi4j.io.spi.SpiConfig config,
- com.pi4j.context.Context pi4jContext)
-The RFidHelper constructor WITHOUT the reset pin as a parameter.
-
-Parameters:
-config - A Pi4J SPIConfig object which holds the SPI address and SPI Baud rate for RFID scanner.pi4jContext - The Pi4J context object.
-
-
-
-
-
-
-
-
-Method Details
-
-
-
-writeToCard
-public void writeToCard (Object data) Writes data to an RFID fob. This is the data that is returned when the fob is scanned by the scanner.
-
-Parameters:
-data - Data to be written to an RFID fob. Typically, a string identifying the holder of the fob such as an identification number.
-
-
-
-
-readFromCard
-
-When called, this method waits for any RFID card/fob to be scanned. The data from the card is returned.
-
-Returns:
-The data read from the card/fob.
-
-
-
-
-
-resetScanner
-public void resetScanner ()
-Resets the RFID scanner.
-
-
-
-
-
-
-
-
-
-
-
RFidHelper (pi4micronaut-utils v1.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+public class RFidHelper
+
extends Object The RFIDHelper class is for interacting with an RFID scanner.
+
+
+
+
+
+
+Constructor Summary
+Constructors
+
+
+
+
RFidHelper (com.pi4j.io.spi.SpiConfig config,
+ int reset,
+ com.pi4j.context.Context pi4jContext)
+
+
The RFidHelper constructor WITH the reset pin as a parameter.
+
+
RFidHelper (com.pi4j.io.spi.SpiConfig config,
+ com.pi4j.context.Context pi4jContext)
+
+
The RFidHelper constructor WITHOUT the reset pin as a parameter.
+
+
+
+
+
+
+Method Summary
+
+
All Methods Instance Methods Concrete Methods
+
+
+
+
+
+
+
+
+
When called, this method waits for any RFID card/fob to be scanned.
+
+
void
+
+
+
Resets the RFID scanner.
+
+
void
+
+
+
Writes data to an RFID fob.
+
+
+
+
+
Methods inherited from class java.lang.Object
+
clone , equals , finalize , getClass , hashCode , notify , notifyAll , toString , wait , wait , wait
+
+
+
+
+
+
+
+
+Constructor Details
+
+
+
+RFidHelper
+public RFidHelper (com.pi4j.io.spi.SpiConfig config,
+ int reset,
+ com.pi4j.context.Context pi4jContext)
+The RFidHelper constructor WITH the reset pin as a parameter.
+
+Parameters:
+config - A Pi4J SPIConfig object which holds the SPI address and SPI Baud rate for RFID scanner.reset - Defines the reset pin for the RFID scanner.pi4jContext - The Pi4J context object.
+
+
+
+
+RFidHelper
+public RFidHelper (com.pi4j.io.spi.SpiConfig config,
+ com.pi4j.context.Context pi4jContext)
+The RFidHelper constructor WITHOUT the reset pin as a parameter.
+
+Parameters:
+config - A Pi4J SPIConfig object which holds the SPI address and SPI Baud rate for RFID scanner.pi4jContext - The Pi4J context object.
+
+
+
+
+
+
+
+
+Method Details
+
+
+
+writeToCard
+public void writeToCard (Object data) Writes data to an RFID fob. This is the data that is returned when the fob is scanned by the scanner.
+
+Parameters:
+data - Data to be written to an RFID fob. Typically, a string identifying the holder of the fob such as an identification number.
+
+
+
+
+readFromCard
+
+When called, this method waits for any RFID card/fob to be scanned. The data from the card is returned.
+
+Returns:
+The data read from the card/fob.
+
+
+
+
+
+resetScanner
+public void resetScanner ()
+Resets the RFID scanner.
+
+
+
+
+
+
+
+
+
+
+
RotaryEncoderHelper (pi4micronaut-utils v1.0 API)
-
-JavaScript is disabled on your browser.
-
-
-
-
-
-
-
-
-
-public class RotaryEncoderHelper
-
extends Object The RotaryEncoderHelper class initializes a rotary encoder component and returns the value of the encoder when called upon.
-
-
-
-
-
-
-Constructor Summary
-Constructors
-
-
-
-
-
-
The RotaryEncoderHelper constructor.
-
-
-
-
-
-
-Method Summary
-
-
All Methods Instance Methods Concrete Methods
-
-
-
-
-
-
int
-
-
-
Gets the value of the rotary encoder.
-
-
void
-
-
-
Initializes the listener that keeps track of the rotary encoder's position.
-
-
-
-
-
Methods inherited from class java.lang.Object
-
clone , equals , finalize , getClass , hashCode , notify , notifyAll , toString , wait , wait , wait
-
-
-
-
-
-
-
-
-Constructor Details
-
-
-
-RotaryEncoderHelper
-
-The RotaryEncoderHelper constructor.
-
-Parameters:
-multiPin - A MultipinConfiguration
-
-
-
-
-
-
-
-
-Method Details
-
-
-
-initialize
-public void initialize ()
-Initializes the listener that keeps track of the rotary encoder's position. Automatically called when the RotaryEncoderHelper is instantiated.
-
-
-
-
-getEncoderValue
-public int getEncoderValue ()
-Gets the value of the rotary encoder.
-
-Returns:
-The value of the rotary encoder.
-
-
-
-
-
-
-
-
-
-
-
-
RotaryEncoderHelper (pi4micronaut-utils v1.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+public class RotaryEncoderHelper
+
extends Object The RotaryEncoderHelper class initializes a rotary encoder component and returns the value of the encoder when called upon.
+
+
+
+
+
+
+Constructor Summary
+Constructors
+
+
+
+
+
+
The RotaryEncoderHelper constructor.
+
+
+
+
+
+
+Method Summary
+
+
All Methods Instance Methods Concrete Methods
+
+
+
+
+
+
int
+
+
+
Gets the value of the rotary encoder.
+
+
void
+
+
+
Initializes the listener that keeps track of the rotary encoder's position.
+
+
+
+
+
Methods inherited from class java.lang.Object
+
clone , equals , finalize , getClass , hashCode , notify , notifyAll , toString , wait , wait , wait
+
+
+
+
+
+
+
+
+Constructor Details
+
+
+
+RotaryEncoderHelper
+
+The RotaryEncoderHelper constructor.
+
+Parameters:
+multiPin - A MultipinConfiguration
+
+
+
+
+
+
+
+
+Method Details
+
+
+
+initialize
+public void initialize ()
+Initializes the listener that keeps track of the rotary encoder's position. Automatically called when the RotaryEncoderHelper is instantiated.
+
+
+
+
+getEncoderValue
+public int getEncoderValue ()
+Gets the value of the rotary encoder.
+
+Returns:
+The value of the rotary encoder.
+
+
+
+
+
+
+
+
+
+
+
+
SlideSwitchHelper (pi4micronaut-utils v1.0 API)
-
-JavaScript is disabled on your browser.
-
-
-
-
-
-
-
-
-
-public class SlideSwitchHelper
-
extends Object The SlideSwitchHelper class is used to initialize a slide switch.
-
-
-
-
-
-
-Field Summary
-Fields
-
-
-
-
-
boolean
-
-
-
Shows if the slide switch is on.
-
-
-
-
-
-
-Constructor Summary
-Constructors
-
-
-
-
-
-
SlideSwitchHelper constructor.
-
-
-
-
-
-
-Method Summary
-
-
All Methods Instance Methods Concrete Methods
-
-
-
-
-
-
void
-
-
-
Adds an EvenListener to the slide switch.
-
-
void
-
-
-
Initializes the listener that keeps track of whether the slide switch is high/low.
-
-
void
-
-
-
Removes the EventListener from the slide switch.
-
-
-
-
-
Methods inherited from class java.lang.Object
-
clone , equals , finalize , getClass , hashCode , notify , notifyAll , toString , wait , wait , wait
-
-
-
-
-
-
-
-
-Field Details
-
-
-
-isOn
-public boolean isOn
-Shows if the slide switch is on.
-
-
-
-
-
-
-
-
-
-
-
-
-Method Details
-
-
-
-initialize
-public void initialize ()
-Initializes the listener that keeps track of whether the slide switch is high/low. Automatically called when the SlideSwitchHelper is instantiated.
-
-
-
-
-addEventListener
-public void addEventListener (com.pi4j.io.gpio.digital.DigitalStateChangeListener function)
-Adds an EvenListener to the slide switch.
-
-Parameters:
-function - A Pi4J DigitalStateChangeListener object.
-
-
-
-
-removeEventListener
-public void removeEventListener (com.pi4j.io.gpio.digital.DigitalStateChangeListener function)
-Removes the EventListener from the slide switch.
-
-Parameters:
-function - A Pi4J DigitalStateChangeListener object.
-
-
-
-
-
-
-
-
-
-
-
SlideSwitchHelper (pi4micronaut-utils v1.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+public class SlideSwitchHelper
+
extends Object The SlideSwitchHelper class is used to initialize a slide switch.
+
+
+
+
+
+
+Field Summary
+Fields
+
+
+
+
+
boolean
+
+
+
Shows if the slide switch is on.
+
+
+
+
+
+
+Constructor Summary
+Constructors
+
+
+
+
+
+
SlideSwitchHelper constructor.
+
+
+
+
+
+
+Method Summary
+
+
All Methods Instance Methods Concrete Methods
+
+
+
+
+
+
void
+
+
+
Adds an EvenListener to the slide switch.
+
+
void
+
+
+
Initializes the listener that keeps track of whether the slide switch is high/low.
+
+
void
+
+
+
Removes the EventListener from the slide switch.
+
+
+
+
+
Methods inherited from class java.lang.Object
+
clone , equals , finalize , getClass , hashCode , notify , notifyAll , toString , wait , wait , wait
+
+
+
+
+
+
+
+
+Field Details
+
+
+
+isOn
+public boolean isOn
+Shows if the slide switch is on.
+
+
+
+
+
+
+
+
+
+
+
+
+Method Details
+
+
+
+initialize
+public void initialize ()
+Initializes the listener that keeps track of whether the slide switch is high/low. Automatically called when the SlideSwitchHelper is instantiated.
+
+
+
+
+addEventListener
+public void addEventListener (com.pi4j.io.gpio.digital.DigitalStateChangeListener function)
+Adds an EvenListener to the slide switch.
+
+Parameters:
+function - A Pi4J DigitalStateChangeListener object.
+
+
+
+
+removeEventListener
+public void removeEventListener (com.pi4j.io.gpio.digital.DigitalStateChangeListener function)
+Removes the EventListener from the slide switch.
+
+Parameters:
+function - A Pi4J DigitalStateChangeListener object.
+
+
+
+
+
+
+
+
+
+
+
TouchSwitchHelper (pi4micronaut-utils v1.0 API)
-
-JavaScript is disabled on your browser.
-
-
-
-
-
-
-
-
-
-public class TouchSwitchHelper
-
extends Object The TouchSwitchHelper class is used to initialize a touch switch.
-
-
-
-
-
-
-Field Summary
-Fields
-
-
-
-
-
boolean
-
-
-
Shows if the touch switch has been touched.
-
-
-
-
-
-
-Constructor Summary
-Constructors
-
-
-
-
-
-
TouchSwitchHelper constructor.
-
-
-
-
-
-
-Method Summary
-
-
All Methods Instance Methods Concrete Methods
-
-
-
-
-
-
void
-
-
-
Adds an event listener to the touch switch.
-
-
void
-
-
-
Initializes the listener that keeps track of if the touch switch has been touched or not.
-
-
void
-
-
-
Removes the event listener from the touch switch.
-
-
-
-
-
Methods inherited from class java.lang.Object
-
clone , equals , finalize , getClass , hashCode , notify , notifyAll , toString , wait , wait , wait
-
-
-
-
-
-
-
-
-Field Details
-
-
-
-isTouched
-public boolean isTouched
-Shows if the touch switch has been touched.
-
-
-
-
-
-
-
-
-
-
-
-
-Method Details
-
-
-
-initialize
-public void initialize ()
-Initializes the listener that keeps track of if the touch switch has been touched or not. It is automatically called when the TouchSwitchHelper is instantiated.
-
-
-
-
-addEventListener
-public void addEventListener (com.pi4j.io.gpio.digital.DigitalStateChangeListener function)
-Adds an event listener to the touch switch.
-
-Parameters:
-function - A Pi4J DigitalStateChangeListener object.
-
-
-
-
-removeEventListener
-public void removeEventListener ()
-Removes the event listener from the touch switch.
-
-
-
-
-
-
-
-
-
-
-
TouchSwitchHelper (pi4micronaut-utils v1.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+public class TouchSwitchHelper
+
extends Object The TouchSwitchHelper class is used to initialize a touch switch.
+
+
+
+
+
+
+Field Summary
+Fields
+
+
+
+
+
boolean
+
+
+
Shows if the touch switch has been touched.
+
+
+
+
+
+
+Constructor Summary
+Constructors
+
+
+
+
+
+
TouchSwitchHelper constructor.
+
+
+
+
+
+
+Method Summary
+
+
All Methods Instance Methods Concrete Methods
+
+
+
+
+
+
void
+
+
+
Adds an event listener to the touch switch.
+
+
void
+
+
+
Initializes the listener that keeps track of if the touch switch has been touched or not.
+
+
void
+
+
+
Removes the event listener from the touch switch.
+
+
+
+
+
Methods inherited from class java.lang.Object
+
clone , equals , finalize , getClass , hashCode , notify , notifyAll , toString , wait , wait , wait
+
+
+
+
+
+
+
+
+Field Details
+
+
+
+isTouched
+public boolean isTouched
+Shows if the touch switch has been touched.
+
+
+
+
+
+
+
+
+
+
+
+
+Method Details
+
+
+
+initialize
+public void initialize ()
+Initializes the listener that keeps track of if the touch switch has been touched or not. It is automatically called when the TouchSwitchHelper is instantiated.
+
+
+
+
+addEventListener
+public void addEventListener (com.pi4j.io.gpio.digital.DigitalStateChangeListener function)
+Adds an event listener to the touch switch.
+
+Parameters:
+function - A Pi4J DigitalStateChangeListener object.
+
+
+
+
+removeEventListener
+public void removeEventListener ()
+Removes the event listener from the touch switch.
+
+
+
+
+
+
+
+
+
+
+
UltrasoundSensorHelper (pi4micronaut-utils v1.0 API)
-
-JavaScript is disabled on your browser.
-
-
-
-
-
-
-
-
-
-public class UltrasoundSensorHelper
-
extends Object
-
-
-
-
-
-Constructor Summary
-Constructors
-
-
-
-
UltrasoundSensorHelper (com.pi4j.io.gpio.digital.DigitalOutput triggerPin,
- com.pi4j.io.gpio.digital.DigitalInput echoPin)
-
-
-
-
-
-
-Method Summary
-
-
All Methods Instance Methods Concrete Methods
-
-
-
-
-
-
double
-
-
-
double
-
-
-
void
-
-
-
void
-
-
-
void
-
-
-
-
-
-
Methods inherited from class java.lang.Object
-
clone , equals , finalize , getClass , hashCode , notify , notifyAll , toString , wait , wait , wait
-
-
-
-
-
-
-
-
-
-
-
-
-Method Details
-
-
-
-initialize
-public void initialize ()
-
-
-
-
-startMeasuring
-public void startMeasuring ()
-
-
-
-
-getDistanceInCentimeter
-public double getDistanceInCentimeter ()
-
-
-
-
-getDistanceInMeters
-public double getDistanceInMeters ()
-
-
-
-
-stopMeasuring
-public void stopMeasuring ()
-
-
-
-
-
-
-
-
-
-
-
UltrasoundSensorHelper (pi4micronaut-utils v1.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+public class UltrasoundSensorHelper
+
extends Object
+
+
+
+
+
+Constructor Summary
+Constructors
+
+
+
+
UltrasoundSensorHelper (com.pi4j.io.gpio.digital.DigitalInput ultraSoundInput,
+ com.pi4j.io.gpio.digital.DigitalOutput ultraSoundOutput)
+
+
+
+
+
+
+Method Summary
+
+
All Methods Instance Methods Concrete Methods
+
+
+
+
+
+
void
+
+
+
void
+
+
+
+
+
+
Methods inherited from class java.lang.Object
+
clone , equals , finalize , getClass , hashCode , notify , notifyAll , toString , wait , wait , wait
+
+
+
+
+
+
+
+
+
+
+
+
+Method Details
+
+
+
+initialize
+public void initialize ()
+
+
+
+
+updateDistance
+public void updateDistance ()
+
+
+
+
+
+
+
+
+
+
+
com.opensourcewithslu.inputdevices (pi4micronaut-utils v1.0 API)
-
-JavaScript is disabled on your browser.
-
-
-
-
-
-
-package com.opensourcewithslu.inputdevices
-
-
-
-
-
-
-
-
Classes
-
-
-
-
-
-
The PhotoResistorHelper class is used to work with the functionalities of a Photo Resistor.
-
-
-
-
The PIRSensorHelper class is used to initialize a PIR motion sensor.
-
-
-
-
The PushButtonHelper class is used to create a listener that determines when a 4 pin button is pressed.
-
-
-
-
The RFIDHelper class is for interacting with an RFID scanner.
-
-
-
-
The RotaryEncoderHelper class initializes a rotary encoder component and returns the value of the encoder when called upon.
-
-
-
-
The SlideSwitchHelper class is used to initialize a slide switch.
-
-
-
-
The TouchSwitchHelper class is used to initialize a touch switch.
-
-
-
-
The UltraSonicSensorHelper class initializes the Ultra Sonic Sensor and provides component functionality
-
-
-
-
-
-
-
-
com.opensourcewithslu.inputdevices (pi4micronaut-utils v1.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+package com.opensourcewithslu.inputdevices
+
+
+
+
+
+
+
+
Classes
+
+
+
+
+
+
The PhotoResistorHelper class is used to work with the functionalities of a Photo Resistor.
+
+
+
+
The PushButtonHelper class is used to create a listener that determines when a 4 pin button is pressed.
+
+
+
+
The RFIDHelper class is for interacting with an RFID scanner.
+
+
+
+
The RotaryEncoderHelper class initializes a rotary encoder component and returns the value of the encoder when called upon.
+
+
+
+
The SlideSwitchHelper class is used to initialize a slide switch.
+
+
+
+
The TouchSwitchHelper class is used to initialize a touch switch.
+
+
+
+
+
+
+
+
+
+
com.opensourcewithslu.inputdevices Class Hierarchy (pi4micronaut-utils v1.0 API)
-
-JavaScript is disabled on your browser.
-
-
-
-
-
-
-Package Hierarchies:
-
-
-
-
-
com.opensourcewithslu.inputdevices Class Hierarchy (pi4micronaut-utils v1.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
diff --git a/pi4micronaut-utils/src/docs/javadoc/com/opensourcewithslu/outputdevices/ActiveBuzzerHelper.html b/pi4micronaut-utils/src/docs/javadoc/com/opensourcewithslu/outputdevices/ActiveBuzzerHelper.html
index a94c357f..187a8c89 100644
--- a/pi4micronaut-utils/src/docs/javadoc/com/opensourcewithslu/outputdevices/ActiveBuzzerHelper.html
+++ b/pi4micronaut-utils/src/docs/javadoc/com/opensourcewithslu/outputdevices/ActiveBuzzerHelper.html
@@ -1,265 +1,251 @@
-
-
-
-
-ActiveBuzzerHelper (pi4micronaut-utils v1.0 API)
-
-JavaScript is disabled on your browser.
-
-
-
-
-
-
-
-
-
-public class ActiveBuzzerHelper
-
extends Object The ActiveBuzzerHelper class contains methods that pertain to the control of the active buzzer.
-
- IMPORTANT NOTE: WIRING MUST BE DIRECT. USAGE OF TRANSISTOR ALTERS THE FUNCTIONALITIES OF THE HELPER.
-
-
-
-
-
-
-Field Summary
-Fields
-
-
-
-
-
protected boolean
-
-
-
To check if the buzzer is active or not
-
-
-
-
-
-
-Constructor Summary
-Constructors
-
-
-
-
-
-
BuzzerHelper constructor
-
-
-
-
-
-
-Method Summary
-
-
All Methods Instance Methods Concrete Methods
-
-
-
-
-
-
void
-
-
-
Turns the active buzzer off.
-
-
void
-
-
-
Turns the active buzzer on by setting the duty cycle is 100 and frequency to 440hz.
-
-
void
-
-
-
Beep powers on, plays a single tone from the active buzzer for 2 seconds then powers down.
-
-
void
-
-
-
Intermittent tone will play a tone for a 20 seconds duration.
-
-
void
-
-
-
Uses the active buzzer on and off function to beep the word pi in morse code.
-
-
-
-
-
Methods inherited from class java.lang.Object
-
clone , equals , finalize , getClass , hashCode , notify , notifyAll , toString , wait , wait , wait
-
-
-
-
-
-
-
-
-Field Details
-
-
-
-actBuzzCheck
-protected boolean actBuzzCheck
-To check if the buzzer is active or not
-
-
-
-
-
-
-
-
-Constructor Details
-
-
-
-ActiveBuzzerHelper
-public ActiveBuzzerHelper (com.pi4j.io.pwm.Pwm activeBuzzer)
-BuzzerHelper constructor
-
-Parameters:
-activeBuzzer - instance of a Pwm object
-
-
-
-
-
-
-
-
-Method Details
-
-
-
-activeBuzzerOn
-public void activeBuzzerOn ()
-Turns the active buzzer on by setting the duty cycle is 100 and frequency to 440hz.
-
-
-
-
-activeBuzzerOff
-public void activeBuzzerOff ()
-Turns the active buzzer off.
-
-
-
-
-beep
-public void beep ()
-Beep powers on, plays a single tone from the active buzzer for 2 seconds then powers down.
-
-
-
-
-intermittentTone
-public void intermittentTone ()
-Intermittent tone will play a tone for a 20 seconds duration. During this duration the
- buzzer will be on for 10 seconds and off for 10 seconds.
-
-
-
-
-morseCodeTone
-public void morseCodeTone ()
-Uses the active buzzer on and off function to beep the word pi in morse code.
-
-
-
-
-
-
-
-
-
-
-
ActiveBuzzerHelper (pi4micronaut-utils v1.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+public class ActiveBuzzerHelper
+
extends Object The ActiveBuzzerHelper class contains methods that pertain to the control of the active buzzer.
+
+ IMPORTANT NOTE: WIRING MUST BE DIRECT. USAGE OF TRANSISTOR ALTERS THE FUNCTIONALITIES OF THE HELPER.
+
+
+
+
+
+
+Field Summary
+Fields
+
+
+
+
+
protected boolean
+
+
+
To check if the buzzer is active or not
+
+
+
+
+
+
+Constructor Summary
+Constructors
+
+
+
+
+
+
BuzzerHelper constructor
+
+
+
+
+
+
+Method Summary
+
+
All Methods Instance Methods Concrete Methods
+
+
+
+
+
+
void
+
+
+
Turns the active buzzer off.
+
+
void
+
+
+
Turns the active buzzer on by setting the duty cycle is 100 and frequency to 440hz.
+
+
void
+
+
+
Beep powers on, plays a single tone from the active buzzer for 2 seconds then powers down.
+
+
void
+
+
+
Intermittent tone will play a tone for a 20 seconds duration.
+
+
void
+
+
+
Uses the active buzzer on and off function to beep the word pi in morse code.
+
+
+
+
+
Methods inherited from class java.lang.Object
+
clone , equals , finalize , getClass , hashCode , notify , notifyAll , toString , wait , wait , wait
+
+
+
+
+
+
+
+
+Field Details
+
+
+
+actBuzzCheck
+protected boolean actBuzzCheck
+To check if the buzzer is active or not
+
+
+
+
+
+
+
+
+Constructor Details
+
+
+
+ActiveBuzzerHelper
+public ActiveBuzzerHelper (com.pi4j.io.pwm.Pwm activeBuzzer)
+BuzzerHelper constructor
+
+Parameters:
+activeBuzzer - instance of a Pwm object
+
+
+
+
+
+
+
+
+Method Details
+
+
+
+activeBuzzerOn
+public void activeBuzzerOn ()
+Turns the active buzzer on by setting the duty cycle is 100 and frequency to 440hz.
+
+
+
+
+activeBuzzerOff
+public void activeBuzzerOff ()
+Turns the active buzzer off.
+
+
+
+
+beep
+public void beep ()
+Beep powers on, plays a single tone from the active buzzer for 2 seconds then powers down.
+
+
+
+
+intermittentTone
+public void intermittentTone ()
+Intermittent tone will play a tone for a 20 seconds duration. During this duration the
+ buzzer will be on for 10 seconds and off for 10 seconds.
+
+
+
+
+morseCodeTone
+public void morseCodeTone ()
+Uses the active buzzer on and off function to beep the word pi in morse code.
+
+
+
+
+
+
+
+
+
+
+
LCD1602Helper (pi4micronaut-utils v1.0 API)
-
-JavaScript is disabled on your browser.
-
-
-
-
-
-
-
-
-
-public class LCD1602Helper
-
extends Object This helper class, LCD1602Helper, is for controlling and interacting with an I2C LCD1602 display.
-
-
-
-
-
-
-Constructor Summary
-Constructors
-
-
-
-
LCD1602Helper (com.pi4j.io.i2c.I2CConfig i2CConfig,
- com.pi4j.context.Context pi4jContext)
-
-
The LCD1602Helper constructor.
-
-
-
-
-
-
-Method Summary
-
-
All Methods Instance Methods Concrete Methods
-
-
-
-
-
-
void
-
-
-
Clears the display of text.
-
-
void
-
-
-
Clears the text of the specified line.
-
-
void
-
-
-
Setting the backlight state of the LCD based off the boolean input.
-
-
void
-
-
-
Writes a String to the display.
-
-
void
-
-
-
Writes a String to the defined line.
-
-
-
-
-
Methods inherited from class java.lang.Object
-
clone , equals , finalize , getClass , hashCode , notify , notifyAll , toString , wait , wait , wait
-
-
-
-
-
-
-
-
-Constructor Details
-
-
-
-LCD1602Helper
-public LCD1602Helper (com.pi4j.io.i2c.I2CConfig i2CConfig,
- com.pi4j.context.Context pi4jContext)
-The LCD1602Helper constructor.
-
-Parameters:
-i2CConfig - Unused parameter.pi4jContext - Context used to create LCD display object.
-
-
-
-
-
-
-
-
-Method Details
-
-
-
-writeText
-public void writeText (String text) Writes a String to the display.
-
-Parameters:
-text - String object.
-
-
-
-
-writeTextAtLine
-public void writeTextAtLine (String text,
- int line) Writes a String to the defined line.
-
-Parameters:
-text - String object to be displayed.line - Line on which the String is written.
-
-
-
-
-setBackLight
-public void setBackLight (boolean state)
-Setting the backlight state of the LCD based off the boolean input. If true, then the backlight is set as on.
-
-Parameters:
-state - Boolean input to determine backlight state.
-
-
-
-
-clearDisplay
-public void clearDisplay ()
-Clears the display of text.
-
-
-
-
-clearLine
-public void clearLine (int line)
-Clears the text of the specified line.
-
-Parameters:
-line - The line of which text will be cleared.
-
-
-
-
-
-
-
-
-
-
-
LCD1602Helper (pi4micronaut-utils v1.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+public class LCD1602Helper
+
extends Object This helper class, LCD1602Helper, is for controlling and interacting with an I2C LCD1602 display.
+
+
+
+
+
+
+Constructor Summary
+Constructors
+
+
+
+
LCD1602Helper (com.pi4j.io.i2c.I2CConfig i2CConfig,
+ com.pi4j.context.Context pi4jContext)
+
+
The LCD1602Helper constructor.
+
+
+
+
+
+
+Method Summary
+
+
All Methods Instance Methods Concrete Methods
+
+
+
+
+
+
void
+
+
+
Clears the display of text.
+
+
void
+
+
+
Clears the text of the specified line.
+
+
void
+
+
+
Setting the backlight state of the LCD based off the boolean input.
+
+
void
+
+
+
Writes a String to the display.
+
+
void
+
+
+
Writes a String to the defined line.
+
+
+
+
+
Methods inherited from class java.lang.Object
+
clone , equals , finalize , getClass , hashCode , notify , notifyAll , toString , wait , wait , wait
+
+
+
+
+
+
+
+
+Constructor Details
+
+
+
+LCD1602Helper
+public LCD1602Helper (com.pi4j.io.i2c.I2CConfig i2CConfig,
+ com.pi4j.context.Context pi4jContext)
+The LCD1602Helper constructor.
+
+Parameters:
+i2CConfig - Unused parameter.pi4jContext - Context used to create LCD display object.
+
+
+
+
+
+
+
+
+Method Details
+
+
+
+writeText
+public void writeText (String text) Writes a String to the display.
+
+Parameters:
+text - String object.
+
+
+
+
+writeTextAtLine
+public void writeTextAtLine (String text,
+ int line) Writes a String to the defined line.
+
+Parameters:
+text - String object to be displayed.line - Line on which the String is written.
+
+
+
+
+setBackLight
+public void setBackLight (boolean state)
+Setting the backlight state of the LCD based off the boolean input. If true, then the backlight is set as on.
+
+Parameters:
+state - Boolean input to determine backlight state.
+
+
+
+
+clearDisplay
+public void clearDisplay ()
+Clears the display of text.
+
+
+
+
+clearLine
+public void clearLine (int line)
+Clears the text of the specified line.
+
+Parameters:
+line - The line of which text will be cleared.
+
+
+
+
+
+
+
+
+
+
+
LEDHelper (pi4micronaut-utils v1.0 API)
-
-JavaScript is disabled on your browser.
-
-
-
-
-
-
-
-
-
-public class LEDHelper
-
extends Object The class LEDHelper contains methods that pertain to the control of a LED.
-
-
-
-
-
-
-Constructor Summary
-Constructors
-
-
-
-
LEDHelper (com.pi4j.io.gpio.digital.DigitalOutput ledOutput)
-
-
LEGHelper constructor.
-
-
-
-
-
-
-Method Summary
-
-
All Methods Instance Methods Concrete Methods
-
-
-
-
-
-
void
-
-
-
Turns off the LED by setting the DigitalOutput object to low.
-
-
void
-
-
-
Turns on the LED by setting the DigitalOutput object to high.
-
-
void
-
-
-
Switches the state of the LED.
-
-
-
-
-
Methods inherited from class java.lang.Object
-
clone , equals , finalize , getClass , hashCode , notify , notifyAll , toString , wait , wait , wait
-
-
-
-
-
-
-
-
-Constructor Details
-
-
-
-LEDHelper
-public LEDHelper (com.pi4j.io.gpio.digital.DigitalOutput ledOutput)
-LEGHelper constructor.
-
-Parameters:
-ledOutput - An instance of a Pi4J DigitalOutput object.
-
-
-
-
-
-
-
-
-Method Details
-
-
-
-ledOn
-public void ledOn ()
-Turns on the LED by setting the DigitalOutput object to high.
-
-
-
-
-ledOff
-public void ledOff ()
-Turns off the LED by setting the DigitalOutput object to low.
-
-
-
-
-switchState
-public void switchState ()
-Switches the state of the LED. If the LED is on, the LED is turned off and vice versa.
-
-
-
-
-
-
-
-
-
-
-
LEDHelper (pi4micronaut-utils v1.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+public class LEDHelper
+
extends Object The class LEDHelper contains methods that pertain to the control of a LED.
+
+
+
+
+
+
+Constructor Summary
+Constructors
+
+
+
+
LEDHelper (com.pi4j.io.gpio.digital.DigitalOutput ledOutput)
+
+
LEGHelper constructor.
+
+
+
+
+
+
+Method Summary
+
+
All Methods Instance Methods Concrete Methods
+
+
+
+
+
+
void
+
+
+
Turns off the LED by setting the DigitalOutput object to low.
+
+
void
+
+
+
Turns on the LED by setting the DigitalOutput object to high.
+
+
void
+
+
+
Switches the state of the LED.
+
+
+
+
+
Methods inherited from class java.lang.Object
+
clone , equals , finalize , getClass , hashCode , notify , notifyAll , toString , wait , wait , wait
+
+
+
+
+
+
+
+
+Constructor Details
+
+
+
+LEDHelper
+public LEDHelper (com.pi4j.io.gpio.digital.DigitalOutput ledOutput)
+LEGHelper constructor.
+
+Parameters:
+ledOutput - An instance of a Pi4J DigitalOutput object.
+
+
+
+
+
+
+
+
+Method Details
+
+
+
+ledOn
+public void ledOn ()
+Turns on the LED by setting the DigitalOutput object to high.
+
+
+
+
+ledOff
+public void ledOff ()
+Turns off the LED by setting the DigitalOutput object to low.
+
+
+
+
+switchState
+public void switchState ()
+Switches the state of the LED. If the LED is on, the LED is turned off and vice versa.
+
+
+
+
+
+
+
+
+
+
+
RGBLEDHelper (pi4micronaut-utils v1.0 API)
-
-JavaScript is disabled on your browser.
-
-
-
-
-
-
-
-
-
-public class RGBLEDHelper
-
extends Object The RBGLEDHelper class handles all interactions with a RGB LED.
-
-
-
-
-
-
-Constructor Summary
-Constructors
-
-
-
-
-
-
The RGBLEDHelper constructor.
-
-
-
-
-
-
-Method Summary
-
-
All Methods Instance Methods Concrete Methods
-
-
-
-
-
-
void
-
-
-
Turns off the RGB LED.
-
-
void
-
-
-
Turns on the RGB LED with default RGB values of 100,100,100 and frequencies of 200 Hertz.
-
-
void
-
-
-
Sets the blue value of the LED.
-
-
void
-
-
-
Sets the blue value and frequency of the LED.
-
-
void
-
-
-
Sets the color of the LED based of inputted RGB values.
-
-
void
-
setColor (int[] colors,
- int[] frequency)
-
-
Sets the color of the LED using the array of RGB values and an array of frequencies.
-
-
void
-
-
-
Setting the color of the LED using a hexadecimal value.
-
-
void
-
-
-
Setting the color of the LED using a hexadecimal value and an array of frequencies.
-
-
void
-
-
-
Sets the green value of the LED.
-
-
void
-
-
-
Sets the green value and frequency of the LED.
-
-
void
-
-
-
Sets the red value of the LED.
-
-
void
-
setRed (int red,
- int frequency)
-
-
Sets the red value and frequency of the LED.
-
-
-
-
-
Methods inherited from class java.lang.Object
-
clone , equals , finalize , getClass , hashCode , notify , notifyAll , toString , wait , wait , wait
-
-
-
-
-
-
-
-
-
-
-
-
-Method Details
-
-
-
-setColor
-public void setColor (int[] colors)
-Sets the color of the LED based of inputted RGB values. Set with a default frequency of 200 Hertz.
-
-Parameters:
-colors - RGB values in an array. [Red,Green,Blue].
-
-
-
-
-setColor
-public void setColor (int[] colors,
- int[] frequency)
-Sets the color of the LED using the array of RGB values and an array of frequencies.
-
-Parameters:
-colors - RGB values in an array. [Red,Green,Blue].frequency - Frequency values(in Hertz) for the corresponding RGB value. [Red frequency, Green frequency, Blue frequency]
-
-
-
-
-setColorHex
-public void setColorHex (String hex) Setting the color of the LED using a hexadecimal value. Default frequency of 200 Hertz is used.
-
-Parameters:
-hex - Hexadecimal number optionally prefixed by 0x.
-
-
-
-
-setColorHex
-public void setColorHex (String hex,
- int[] frequency) Setting the color of the LED using a hexadecimal value and an array of frequencies.
-
-Parameters:
-hex - Hexadecimal number optionally prefixed by 0x.frequency - Frequency values(in Hertz) for the corresponding RGB value. [Red frequency, Green frequency, Blue frequency]
-
-
-
-
-setRed
-public void setRed (int red)
-Sets the red value of the LED. Default 200 Hertz frequency used.
-
-Parameters:
-red - Integer value representing the red in the RGB value of the LED.
-
-
-
-
-setRed
-public void setRed (int red,
- int frequency)
-Sets the red value and frequency of the LED.
-
-Parameters:
-red - Integer value representing the red in the RGB value of the LED.frequency - Frequency of the red value in Hertz.
-
-
-
-
-setBlue
-public void setBlue (int blue)
-Sets the blue value of the LED. Default 200 Hertz frequency used.
-
-Parameters:
-blue - Integer value representing the blue in the RGB value of the LED.
-
-
-
-
-setBlue
-public void setBlue (int blue,
- int frequency)
-Sets the blue value and frequency of the LED.
-
-Parameters:
-blue - Integer value representing the blue in the RGB value of the LED.frequency - Frequency of the blue value in Hertz.
-
-
-
-
-setGreen
-public void setGreen (int green)
-Sets the green value of the LED. Default 200 Hertz frequency used.
-
-Parameters:
-green - Integer value representing the green in the RGB value of the LED.
-
-
-
-
-setGreen
-public void setGreen (int green,
- int frequency)
-Sets the green value and frequency of the LED.
-
-Parameters:
-green - Integer value representing the green in the RGB value of the LED.frequency - Frequency of the green value in Hertz.
-
-
-
-
-ledOff
-public void ledOff ()
-Turns off the RGB LED.
-
-
-
-
-ledOn
-public void ledOn ()
-Turns on the RGB LED with default RGB values of 100,100,100 and frequencies of 200 Hertz.
-
-
-
-
-
-
-
-
-
-
-
RGBLEDHelper (pi4micronaut-utils v1.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+public class RGBLEDHelper
+
extends Object The RBGLEDHelper class handles all interactions with a RGB LED.
+
+
+
+
+
+
+Constructor Summary
+Constructors
+
+
+
+
+
+
The RGBLEDHelper constructor.
+
+
+
+
+
+
+Method Summary
+
+
All Methods Instance Methods Concrete Methods
+
+
+
+
+
+
void
+
+
+
Turns off the RGB LED.
+
+
void
+
+
+
Turns on the RGB LED with default RGB values of 100,100,100 and frequencies of 200 Hertz.
+
+
void
+
+
+
Sets the blue value of the LED.
+
+
void
+
+
+
Sets the blue value and frequency of the LED.
+
+
void
+
+
+
Sets the color of the LED based of inputted RGB values.
+
+
void
+
setColor (int[] colors,
+ int[] frequency)
+
+
Sets the color of the LED using the array of RGB values and an array of frequencies.
+
+
void
+
+
+
Setting the color of the LED using a hexadecimal value.
+
+
void
+
+
+
Setting the color of the LED using a hexadecimal value and an array of frequencies.
+
+
void
+
+
+
Sets the green value of the LED.
+
+
void
+
+
+
Sets the green value and frequency of the LED.
+
+
void
+
+
+
Sets the red value of the LED.
+
+
void
+
setRed (int red,
+ int frequency)
+
+
Sets the red value and frequency of the LED.
+
+
+
+
+
Methods inherited from class java.lang.Object
+
clone , equals , finalize , getClass , hashCode , notify , notifyAll , toString , wait , wait , wait
+
+
+
+
+
+
+
+
+
+
+
+
+Method Details
+
+
+
+setColor
+public void setColor (int[] colors)
+Sets the color of the LED based of inputted RGB values. Set with a default frequency of 200 Hertz.
+
+Parameters:
+colors - RGB values in an array. [Red,Green,Blue].
+
+
+
+
+setColor
+public void setColor (int[] colors,
+ int[] frequency)
+Sets the color of the LED using the array of RGB values and an array of frequencies.
+
+Parameters:
+colors - RGB values in an array. [Red,Green,Blue].frequency - Frequency values(in Hertz) for the corresponding RGB value. [Red frequency, Green frequency, Blue frequency]
+
+
+
+
+setColorHex
+public void setColorHex (String hex) Setting the color of the LED using a hexadecimal value. Default frequency of 200 Hertz is used.
+
+Parameters:
+hex - Hexadecimal number optionally prefixed by 0x.
+
+
+
+
+setColorHex
+public void setColorHex (String hex,
+ int[] frequency) Setting the color of the LED using a hexadecimal value and an array of frequencies.
+
+Parameters:
+hex - Hexadecimal number optionally prefixed by 0x.frequency - Frequency values(in Hertz) for the corresponding RGB value. [Red frequency, Green frequency, Blue frequency]
+
+
+
+
+setRed
+public void setRed (int red)
+Sets the red value of the LED. Default 200 Hertz frequency used.
+
+Parameters:
+red - Integer value representing the red in the RGB value of the LED.
+
+
+
+
+setRed
+public void setRed (int red,
+ int frequency)
+Sets the red value and frequency of the LED.
+
+Parameters:
+red - Integer value representing the red in the RGB value of the LED.frequency - Frequency of the red value in Hertz.
+
+
+
+
+setBlue
+public void setBlue (int blue)
+Sets the blue value of the LED. Default 200 Hertz frequency used.
+
+Parameters:
+blue - Integer value representing the blue in the RGB value of the LED.
+
+
+
+
+setBlue
+public void setBlue (int blue,
+ int frequency)
+Sets the blue value and frequency of the LED.
+
+Parameters:
+blue - Integer value representing the blue in the RGB value of the LED.frequency - Frequency of the blue value in Hertz.
+
+
+
+
+setGreen
+public void setGreen (int green)
+Sets the green value of the LED. Default 200 Hertz frequency used.
+
+Parameters:
+green - Integer value representing the green in the RGB value of the LED.
+
+
+
+
+setGreen
+public void setGreen (int green,
+ int frequency)
+Sets the green value and frequency of the LED.
+
+Parameters:
+green - Integer value representing the green in the RGB value of the LED.frequency - Frequency of the green value in Hertz.
+
+
+
+
+ledOff
+public void ledOff ()
+Turns off the RGB LED.
+
+
+
+
+ledOn
+public void ledOn ()
+Turns on the RGB LED with default RGB values of 100,100,100 and frequencies of 200 Hertz.
+
+
+
+
+
+
+
+
+
+
+
com.opensourcewithslu.outputdevices (pi4micronaut-utils v1.0 API)
-
-JavaScript is disabled on your browser.
-
-
-
-
-
-
-package com.opensourcewithslu.outputdevices
-
-
-
-
-
-
-
-
Classes
-
-
-
-
-
-
The ActiveBuzzerHelper class contains methods that pertain to the control of the active buzzer.
-
-
-
-
This helper class, LCD1602Helper, is for controlling and interacting with an I2C LCD1602 display.
-
-
-
-
The class LEDHelper contains methods that pertain to the control of a LED.
-
-
-
-
The PassiveBuzzerHelper class contains methods that pertain to the control of the passive buzzer.
-
-
-
-
The RBGLEDHelper class handles all interactions with a RGB LED.
-
-
-
-
-
-
-
-
com.opensourcewithslu.outputdevices (pi4micronaut-utils v1.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+package com.opensourcewithslu.outputdevices
+
+
+
+
+
+
+
+
Classes
+
+
+
+
+
+
The ActiveBuzzerHelper class contains methods that pertain to the control of the active buzzer.
+
+
+
+
This helper class, LCD1602Helper, is for controlling and interacting with an I2C LCD1602 display.
+
+
+
+
The class LEDHelper contains methods that pertain to the control of a LED.
+
+
+
+
The RBGLEDHelper class handles all interactions with a RGB LED.
+
+
+
+
+
+
+
+
com.opensourcewithslu.outputdevices Class Hierarchy (pi4micronaut-utils v1.0 API)
-
-JavaScript is disabled on your browser.
-
-
-
-
-
-
-Package Hierarchies:
-
-
-
-
-
com.opensourcewithslu.outputdevices Class Hierarchy (pi4micronaut-utils v1.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
diff --git a/pi4micronaut-utils/src/docs/javadoc/com/opensourcewithslu/package-summary.html b/pi4micronaut-utils/src/docs/javadoc/com/opensourcewithslu/package-summary.html
index 797a89f1..79ab9142 100644
--- a/pi4micronaut-utils/src/docs/javadoc/com/opensourcewithslu/package-summary.html
+++ b/pi4micronaut-utils/src/docs/javadoc/com/opensourcewithslu/package-summary.html
@@ -1,107 +1,98 @@
-
-
-
-
-com.opensourcewithslu (pi4micronaut-utils v1.0 API)
-
-JavaScript is disabled on your browser.
-
-
-
-
-
-
-package com.opensourcewithslu
-
-
-
-
-
-
-
-
Classes
-
-
-
-
-
-
Runs the Micronaut framework in the Pi4Micronaut framework.
-
-
-
-
-
-
-
-
com.opensourcewithslu (pi4micronaut-utils v1.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+package com.opensourcewithslu
+
+
+
+
+
+
+
+
Classes
+
+
+
+
+
+
Runs the Micronaut framework in the Pi4Micronaut framework.
+
+
+
+
+
+
+
+
com.opensourcewithslu Class Hierarchy (pi4micronaut-utils v1.0 API)
-
-JavaScript is disabled on your browser.
-
-
-
-
-
-
-Package Hierarchies:
-
-
-
-
-
com.opensourcewithslu Class Hierarchy (pi4micronaut-utils v1.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
diff --git a/pi4micronaut-utils/src/docs/javadoc/com/opensourcewithslu/utilities/DigitalInputConfiguration.html b/pi4micronaut-utils/src/docs/javadoc/com/opensourcewithslu/utilities/DigitalInputConfiguration.html
index 0fae3e78..dffb8341 100644
--- a/pi4micronaut-utils/src/docs/javadoc/com/opensourcewithslu/utilities/DigitalInputConfiguration.html
+++ b/pi4micronaut-utils/src/docs/javadoc/com/opensourcewithslu/utilities/DigitalInputConfiguration.html
@@ -1,349 +1,334 @@
-
-
-
-
-DigitalInputConfiguration (pi4micronaut-utils v1.0 API)
-
-JavaScript is disabled on your browser.
-
-
-
-
-
-
-
-
-
-@Prototype
-@EachProperty("pi4j.digital-input")
- public class DigitalInputConfiguration
-
extends Object This class handles the configuration of a digital input component.
-
-
-
-
-
-
-Constructor Summary
-Constructors
-
-
-
-
-
-
Constructor for the DigitalInputConfiguration.
-
-
-
-
-
-
-Method Summary
-
-
All Methods Instance Methods Concrete Methods
-
-
-
-
-
-
int
-
-
-
Gets the pin address for the component.
-
-
-
-
-
Gets the current debounce value for the component.
-
-
-
-
-
Gets the id of the component.
-
-
-
-
-
Gets the name of the component.
-
-
-
-
-
Gets the provider for the component.
-
-
com.pi4j.io.gpio.digital.PullResistance
-
-
-
Gets the pull resistance for the component.
-
-
void
-
-
-
void
-
-
-
Sets the debounce of the component.
-
-
void
-
-
-
Sets the name of the component.
-
-
void
-
-
-
void
-
setPull (com.pi4j.io.gpio.digital.PullResistance pull)
-
-
Sets the pull resistance for the component.
-
-
-
-
-
Methods inherited from class java.lang.Object
-
clone , equals , finalize , getClass , hashCode , notify , notifyAll , toString , wait , wait , wait
-
-
-
-
-
-
-
-
-Constructor Details
-
-
-
-DigitalInputConfiguration
-public DigitalInputConfiguration (@Parameter
- String id) Constructor for the DigitalInputConfiguration.
-
-Parameters:
-id - The configuration id as defined in the application.yml
-
-
-
-
-
-
-
-
-Method Details
-
-
-
-getId
-
-Gets the id of the component.
-
-Returns:
-The id of the component.
-
-
-
-
-
-getName
-
-Gets the name of the component.
-
-Returns:
-The name of the component.
-
-
-
-
-
-setName
-public void setName (String name) Sets the name of the component.
-
-Parameters:
-name - The string name to replace the existing name.
-
-
-
-
-getDebounce
-public Long getDebounce ()
Gets the current debounce value for the component.
-
-Returns:
-Long type representing the debounce of the component.
-
-
-
-
-
-setDebounce
-public void setDebounce (Long debounce) Sets the debounce of the component. Replaces existing debounce.
-
-Parameters:
-debounce - New debounce of type Long,
-
-
-
-
-getPull
-public com.pi4j.io.gpio.digital.PullResistance getPull ()
-Gets the pull resistance for the component.
-
-Returns:
-The PullResistance enumeration.
-
-
-
-
-
-setPull
-public void setPull (com.pi4j.io.gpio.digital.PullResistance pull)
-Sets the pull resistance for the component.
-
-Parameters:
-pull - The PullResistance enum that will become the new pull resistance for the component.
-
-
-
-
-getAddress
-public int getAddress ()
-Gets the pin address for the component.
-
-Returns:
-An array of the pin addresses.
-
-
-
-
-
-setAddress
-public void setAddress (int address)
-Sets the pin address.
-
-Parameters:
-address - Integer representing the new pin address.
-
-
-
-
-getProvider
-
-Gets the provider for the component.
-
-Returns:
-A String representation of the provider.
-
-
-
-
-
-setProvider
-public void setProvider (String provider) Sets the provider.
-
-Parameters:
-provider - The new provider for the component.
-
-
-
-
-
-
-
-
-
-
-
DigitalInputConfiguration (pi4micronaut-utils v1.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+@EachProperty("pi4j.digital-input")
+ public class DigitalInputConfiguration
+
extends Object This class handles the configuration of a digital input component.
+
+
+
+
+
+
+Constructor Summary
+Constructors
+
+
+
+
+
+
Constructor for the DigitalInputConfiguration.
+
+
+
+
+
+
+Method Summary
+
+
All Methods Instance Methods Concrete Methods
+
+
+
+
+
+
int
+
+
+
Gets the pin address for the component.
+
+
+
+
+
Gets the current debounce value for the component.
+
+
+
+
+
Gets the id of the component.
+
+
+
+
+
Gets the name of the component.
+
+
+
+
+
Gets the provider for the component.
+
+
com.pi4j.io.gpio.digital.PullResistance
+
+
+
Gets the pull resistance for the component.
+
+
void
+
+
+
void
+
+
+
Sets the debounce of the component.
+
+
void
+
+
+
Sets the name of the component.
+
+
void
+
+
+
void
+
setPull (com.pi4j.io.gpio.digital.PullResistance pull)
+
+
Sets the pull resistance for the component.
+
+
+
+
+
Methods inherited from class java.lang.Object
+
clone , equals , finalize , getClass , hashCode , notify , notifyAll , toString , wait , wait , wait
+
+
+
+
+
+
+
+
+Constructor Details
+
+
+
+DigitalInputConfiguration
+public DigitalInputConfiguration (@Parameter
+ String id) Constructor for the DigitalInputConfiguration.
+
+Parameters:
+id - The configuration id as defined in the application.yml
+
+
+
+
+
+
+
+
+Method Details
+
+
+
+getId
+
+Gets the id of the component.
+
+Returns:
+The id of the component.
+
+
+
+
+
+getName
+
+Gets the name of the component.
+
+Returns:
+The name of the component.
+
+
+
+
+
+setName
+public void setName (String name) Sets the name of the component.
+
+Parameters:
+name - The string name to replace the existing name.
+
+
+
+
+getDebounce
+public Long getDebounce ()
Gets the current debounce value for the component.
+
+Returns:
+Long type representing the debounce of the component.
+
+
+
+
+
+setDebounce
+public void setDebounce (Long debounce) Sets the debounce of the component. Replaces existing debounce.
+
+Parameters:
+debounce - New debounce of type Long,
+
+
+
+
+getPull
+public com.pi4j.io.gpio.digital.PullResistance getPull ()
+Gets the pull resistance for the component.
+
+Returns:
+The PullResistance enumeration.
+
+
+
+
+
+setPull
+public void setPull (com.pi4j.io.gpio.digital.PullResistance pull)
+Sets the pull resistance for the component.
+
+Parameters:
+pull - The PullResistance enum that will become the new pull resistance for the component.
+
+
+
+
+getAddress
+public int getAddress ()
+Gets the pin address for the component.
+
+Returns:
+An array of the pin addresses.
+
+
+
+
+
+setAddress
+public void setAddress (int address)
+Sets the pin address.
+
+Parameters:
+address - Integer representing the new pin address.
+
+
+
+
+getProvider
+
+Gets the provider for the component.
+
+Returns:
+A String representation of the provider.
+
+
+
+
+
+setProvider
+public void setProvider (String provider) Sets the provider.
+
+Parameters:
+provider - The new provider for the component.
+
+
+
+
+
+
+
+
+
+
+
DigitalOutputConfiguration (pi4micronaut-utils v1.0 API)
-
-JavaScript is disabled on your browser.
-
-
-
-
-
-
-
-
-
-@Prototype
-@EachProperty("pi4j.digital-output")
- public class DigitalOutputConfiguration
-
extends Object This class handles the configuration of a digital output component.
-
-
-
-
-
-
-Constructor Summary
-Constructors
-
-
-
-
-
-
The DigitalOutputConfiguration constructor.
-
-
-
-
-
-
-Method Summary
-
-
All Methods Instance Methods Concrete Methods
-
-
-
-
-
-
int
-
-
-
Gets the pin address for the component.
-
-
-
-
-
Gets the id of the component.
-
-
com.pi4j.io.gpio.digital.DigitalState
-
-
-
Gets the initial state of the component.
-
-
-
-
-
Gets the name of the component.
-
-
-
-
-
Gets the provider for the component.
-
-
com.pi4j.io.gpio.digital.DigitalState
-
-
-
Gets the shutdown state of the component.
-
-
void
-
-
-
void
-
setInitial (com.pi4j.io.gpio.digital.DigitalState initial)
-
-
Sets the initial state for the component.
-
-
void
-
-
-
Sets the name of the component.
-
-
void
-
-
-
void
-
setShutdown (com.pi4j.io.gpio.digital.DigitalState shutdown)
-
-
Sets the shutdown state for the component.
-
-
-
-
-
Methods inherited from class java.lang.Object
-
clone , equals , finalize , getClass , hashCode , notify , notifyAll , toString , wait , wait , wait
-
-
-
-
-
-
-
-
-Constructor Details
-
-
-
-DigitalOutputConfiguration
-public DigitalOutputConfiguration (@Parameter
- String id) The DigitalOutputConfiguration constructor.
-
-Parameters:
-id - The configuration id as defined in the application.yml.
-
-
-
-
-
-
-
-
-Method Details
-
-
-
-getId
-
-Gets the id of the component.
-
-Returns:
-The id of the component.
-
-
-
-
-
-getName
-
-Gets the name of the component.
-
-Returns:
-The String name of the component.
-
-
-
-
-
-setName
-public void setName (String name) Sets the name of the component.
-
-Parameters:
-name - The String that the name will be set as.
-
-
-
-
-getInitial
-public com.pi4j.io.gpio.digital.DigitalState getInitial ()
-Gets the initial state of the component.
-
-Returns:
-The initial state of the component.
-
-
-
-
-
-setInitial
-public void setInitial (com.pi4j.io.gpio.digital.DigitalState initial)
-Sets the initial state for the component.
-
-Parameters:
-initial - The Digital state that the component will start was.
-
-
-
-
-getShutdown
-public com.pi4j.io.gpio.digital.DigitalState getShutdown ()
-Gets the shutdown state of the component.
-
-Returns:
-The digital state of the component.
-
-
-
-
-
-setShutdown
-public void setShutdown (com.pi4j.io.gpio.digital.DigitalState shutdown)
-Sets the shutdown state for the component.
-
-Parameters:
-shutdown - DigitalState enum.
-
-
-
-
-getAddress
-public int getAddress ()
-Gets the pin address for the component.
-
-Returns:
-An array of the pin addresses.
-
-
-
-
-
-setAddress
-public void setAddress (int address)
-Sets the pin address.
-
-Parameters:
-address - Integer representing the new pin address.
-
-
-
-
-getProvider
-
-Gets the provider for the component.
-
-Returns:
-A String representation of the provider.
-
-
-
-
-
-setProvider
-public void setProvider (String provider) Sets the provider.
-
-Parameters:
-provider - The new provider for the component.
-
-
-
-
-
-
-
-
-
-
-
DigitalOutputConfiguration (pi4micronaut-utils v1.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+@EachProperty("pi4j.digital-output")
+ public class DigitalOutputConfiguration
+
extends Object This class handles the configuration of a digital output component.
+
+
+
+
+
+
+Constructor Summary
+Constructors
+
+
+
+
+
+
The DigitalOutputConfiguration constructor.
+
+
+
+
+
+
+Method Summary
+
+
All Methods Instance Methods Concrete Methods
+
+
+
+
+
+
int
+
+
+
Gets the pin address for the component.
+
+
+
+
+
Gets the id of the component.
+
+
com.pi4j.io.gpio.digital.DigitalState
+
+
+
Gets the initial state of the component.
+
+
+
+
+
Gets the name of the component.
+
+
+
+
+
Gets the provider for the component.
+
+
com.pi4j.io.gpio.digital.DigitalState
+
+
+
Gets the shutdown state of the component.
+
+
void
+
+
+
void
+
setInitial (com.pi4j.io.gpio.digital.DigitalState initial)
+
+
Sets the initial state for the component.
+
+
void
+
+
+
Sets the name of the component.
+
+
void
+
+
+
void
+
setShutdown (com.pi4j.io.gpio.digital.DigitalState shutdown)
+
+
Sets the shutdown state for the component.
+
+
+
+
+
Methods inherited from class java.lang.Object
+
clone , equals , finalize , getClass , hashCode , notify , notifyAll , toString , wait , wait , wait
+
+
+
+
+
+
+
+
+Constructor Details
+
+
+
+DigitalOutputConfiguration
+public DigitalOutputConfiguration (@Parameter
+ String id) The DigitalOutputConfiguration constructor.
+
+Parameters:
+id - The configuration id as defined in the application.yml.
+
+
+
+
+
+
+
+
+Method Details
+
+
+
+getId
+
+Gets the id of the component.
+
+Returns:
+The id of the component.
+
+
+
+
+
+getName
+
+Gets the name of the component.
+
+Returns:
+The String name of the component.
+
+
+
+
+
+setName
+public void setName (String name) Sets the name of the component.
+
+Parameters:
+name - The String that the name will be set as.
+
+
+
+
+getInitial
+public com.pi4j.io.gpio.digital.DigitalState getInitial ()
+Gets the initial state of the component.
+
+Returns:
+The initial state of the component.
+
+
+
+
+
+setInitial
+public void setInitial (com.pi4j.io.gpio.digital.DigitalState initial)
+Sets the initial state for the component.
+
+Parameters:
+initial - The Digital state that the component will start was.
+
+
+
+
+getShutdown
+public com.pi4j.io.gpio.digital.DigitalState getShutdown ()
+Gets the shutdown state of the component.
+
+Returns:
+The digital state of the component.
+
+
+
+
+
+setShutdown
+public void setShutdown (com.pi4j.io.gpio.digital.DigitalState shutdown)
+Sets the shutdown state for the component.
+
+Parameters:
+shutdown - DigitalState enum.
+
+
+
+
+getAddress
+public int getAddress ()
+Gets the pin address for the component.
+
+Returns:
+An array of the pin addresses.
+
+
+
+
+
+setAddress
+public void setAddress (int address)
+Sets the pin address.
+
+Parameters:
+address - Integer representing the new pin address.
+
+
+
+
+getProvider
+
+Gets the provider for the component.
+
+Returns:
+A String representation of the provider.
+
+
+
+
+
+setProvider
+public void setProvider (String provider) Sets the provider.
+
+Parameters:
+provider - The new provider for the component.
+
+
+
+
+
+
+
+
+
+
+
DigitalInputMultiPinConfiguration (pi4micronaut-utils v1.0 API)
-
-JavaScript is disabled on your browser.
-
-
-
-
-
-
-
-java.lang.Object
-
com.opensourcewithslu.utilities.MultiPinConfigs.DigitalInputMultiPinConfiguration
-
-@EachProperty("pi4j.multi-digital-input")
- public class DigitalInputMultiPinConfiguration
-
extends Object This class handles the configuration of a digital input component that has multiple pins.
-
-
-
-
-
-
-Constructor Summary
-Constructors
-
-
-
-
-
-
The DigitalInputMultiPinConfiguration constructor.
-
-
-
-
-
-
-Method Summary
-
-
All Methods Instance Methods Concrete Methods
-
-
-
-
-
-
int[]
-
-
-
Gets the pin addresses for the component.
-
-
long[]
-
-
-
Gets the current debounce values for the component.
-
-
-
-
-
Gets the id of the component.
-
-
-
-
-
Gets the name of the component.
-
-
-
-
-
Gets the provider for the component.
-
-
com.pi4j.io.gpio.digital.PullResistance[]
-
-
-
Gets the pull resistance for the component.
-
-
void
-
-
-
Sets the pin addresses for the component.
-
-
void
-
-
-
Sets the debounces for the component.
-
-
void
-
-
-
Sets the name of the component.
-
-
void
-
-
-
void
-
-
-
Sets all the pull resistance for the components.
-
-
-
-
-
Methods inherited from class java.lang.Object
-
clone , equals , finalize , getClass , hashCode , notify , notifyAll , toString , wait , wait , wait
-
-
-
-
-
-
-
-
-Constructor Details
-
-
-
-DigitalInputMultiPinConfiguration
-public DigitalInputMultiPinConfiguration (@Parameter
- String id) The DigitalInputMultiPinConfiguration constructor.
-
-Parameters:
-id - The configuration id as defined in the application.yml
-
-
-
-
-
-
-
-
-Method Details
-
-
-
-getId
-
-Gets the id of the component.
-
-Returns:
-The id of the component.
-
-
-
-
-
-getName
-
-Gets the name of the component.
-
-Returns:
-The name of the component.
-
-
-
-
-
-setName
-public void setName (String name) Sets the name of the component.
-
-Parameters:
-name - The string name to replace the existing name.
-
-
-
-
-getAddresses
-public int[] getAddresses ()
-Gets the pin addresses for the component.
-
-Returns:
-An array of the pin addresses.
-
-
-
-
-
-setAddresses
-public void setAddresses (String addresses) Sets the pin addresses for the component. All previously existing address are replaced.
-
-Parameters:
-addresses - Pin addresses separated by a comma.
-
-
-
-
-getPulls
-public com.pi4j.io.gpio.digital.PullResistance[] getPulls ()
-Gets the pull resistance for the component.
-
-Returns:
-The PullResistance enumerations.
-
-
-
-
-
-setPulls
-public void setPulls (String all_pulls) Sets all the pull resistance for the components.
-
-Parameters:
-all_pulls - String of pull resistances separated by commas. Pull down resistance should be formatted as PULL_DOWN. Pull up as PULL_UP.
-
-
-
-
-getDebounces
-public long[] getDebounces ()
-Gets the current debounce values for the component.
-
-Returns:
-The array of debounce values of type long.
-
-
-
-
-
-setDebounces
-public void setDebounces (String debounces) Sets the debounces for the component. Replaces all the existing debounces.
-
-Parameters:
-debounces - String representing the dounces for the component. Each debounce seperated by a comma.
-
-
-
-
-getProvider
-
-Gets the provider for the component.
-
-Returns:
-A String representation of the provider.
-
-
-
-
-
-setProvider
-public void setProvider (String provider) Sets the provider.
-
-Parameters:
-provider - The new provider for the component.
-
-
-
-
-
-
-
-
-
-
-
DigitalInputMultiPinConfiguration (pi4micronaut-utils v1.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+java.lang.Object
+
com.opensourcewithslu.utilities.MultiPinConfigs.DigitalInputMultiPinConfiguration
+
+@EachProperty("pi4j.multi-digital-input")
+ public class DigitalInputMultiPinConfiguration
+
extends Object This class handles the configuration of a digital input component that has multiple pins.
+
+
+
+
+
+
+Constructor Summary
+Constructors
+
+
+
+
+
+
The DigitalInputMultiPinConfiguration constructor.
+
+
+
+
+
+
+Method Summary
+
+
All Methods Instance Methods Concrete Methods
+
+
+
+
+
+
int[]
+
+
+
Gets the pin addresses for the component.
+
+
long[]
+
+
+
Gets the current debounce values for the component.
+
+
+
+
+
Gets the id of the component.
+
+
+
+
+
Gets the name of the component.
+
+
+
+
+
Gets the provider for the component.
+
+
com.pi4j.io.gpio.digital.PullResistance[]
+
+
+
Gets the pull resistance for the component.
+
+
void
+
+
+
Sets the pin addresses for the component.
+
+
void
+
+
+
Sets the debounces for the component.
+
+
void
+
+
+
Sets the name of the component.
+
+
void
+
+
+
void
+
+
+
Sets all the pull resistance for the components.
+
+
+
+
+
Methods inherited from class java.lang.Object
+
clone , equals , finalize , getClass , hashCode , notify , notifyAll , toString , wait , wait , wait
+
+
+
+
+
+
+
+
+Constructor Details
+
+
+
+DigitalInputMultiPinConfiguration
+public DigitalInputMultiPinConfiguration (@Parameter
+ String id) The DigitalInputMultiPinConfiguration constructor.
+
+Parameters:
+id - The configuration id as defined in the application.yml
+
+
+
+
+
+
+
+
+Method Details
+
+
+
+getId
+
+Gets the id of the component.
+
+Returns:
+The id of the component.
+
+
+
+
+
+getName
+
+Gets the name of the component.
+
+Returns:
+The name of the component.
+
+
+
+
+
+setName
+public void setName (String name) Sets the name of the component.
+
+Parameters:
+name - The string name to replace the existing name.
+
+
+
+
+getAddresses
+public int[] getAddresses ()
+Gets the pin addresses for the component.
+
+Returns:
+An array of the pin addresses.
+
+
+
+
+
+setAddresses
+public void setAddresses (String addresses) Sets the pin addresses for the component. All previously existing address are replaced.
+
+Parameters:
+addresses - Pin addresses separated by a comma.
+
+
+
+
+getPulls
+public com.pi4j.io.gpio.digital.PullResistance[] getPulls ()
+Gets the pull resistance for the component.
+
+Returns:
+The PullResistance enumerations.
+
+
+
+
+
+setPulls
+public void setPulls (String all_pulls) Sets all the pull resistance for the components.
+
+Parameters:
+all_pulls - String of pull resistances separated by commas. Pull down resistance should be formatted as PULL_DOWN. Pull up as PULL_UP.
+
+
+
+
+getDebounces
+public long[] getDebounces ()
+Gets the current debounce values for the component.
+
+Returns:
+The array of debounce values of type long.
+
+
+
+
+
+setDebounces
+public void setDebounces (String debounces) Sets the debounces for the component. Replaces all the existing debounces.
+
+Parameters:
+debounces - String representing the dounces for the component. Each debounce seperated by a comma.
+
+
+
+
+getProvider
+
+Gets the provider for the component.
+
+Returns:
+A String representation of the provider.
+
+
+
+
+
+setProvider
+public void setProvider (String provider) Sets the provider.
+
+Parameters:
+provider - The new provider for the component.
+
+
+
+
+
+
+
+
+
+
+
PwmMultiPinConfiguration (pi4micronaut-utils v1.0 API)
-
-JavaScript is disabled on your browser.
-
-
-
-
-
-
-
-java.lang.Object
-
com.opensourcewithslu.utilities.MultiPinConfigs.PwmMultiPinConfiguration
-
-@EachProperty("pi4j.multi-pwm")
- public class PwmMultiPinConfiguration
-
extends Object This class handles the configuration of a PWM device that has multiple pins.
-
-
-
-
-
-
-Constructor Summary
-Constructors
-
-
-
-
-
-
The PwmMultiPinConfiguration constructor.
-
-
-
-
-
-
-Method Summary
-
-
All Methods Instance Methods Concrete Methods
-
-
-
-
-
-
int[]
-
-
-
Gets the pin address for the component.
-
-
-
-
-
Gets the id of the component.
-
-
int[]
-
-
-
Gets the initial states that the component is in when first initialized.
-
-
-
-
-
Gets the name of the component.
-
-
-
-
-
Gets the provider for the component.
-
-
com.pi4j.io.pwm.PwmType[]
-
-
-
Gets the PWM types of the component.
-
-
int[]
-
-
-
Gets the shutdown states for the component.
-
-
void
-
-
-
Sets the pin addresses for the component.
-
-
void
-
-
-
Sets the initial states for the component.
-
-
void
-
-
-
Sets the name of the component.
-
-
void
-
-
-
void
-
-
-
Sets the PWM types for the component.
-
-
void
-
-
-
Sets the shutdown states for the component.
-
-
-
-
-
Methods inherited from class java.lang.Object
-
clone , equals , finalize , getClass , hashCode , notify , notifyAll , toString , wait , wait , wait
-
-
-
-
-
-
-
-
-Constructor Details
-
-
-
-PwmMultiPinConfiguration
-public PwmMultiPinConfiguration (@Parameter
- String id) The PwmMultiPinConfiguration constructor.
-
-Parameters:
-id - The configuration id as defined in the application.yml
-
-
-
-
-
-
-
-
-Method Details
-
-
-
-getId
-
-Gets the id of the component.
-
-Returns:
-The id of the component.
-
-
-
-
-
-getName
-
-Gets the name of the component.
-
-Returns:
-The name of the component.
-
-
-
-
-
-setName
-public void setName (String name) Sets the name of the component.
-
-Parameters:
-name - The string name to replace the existing name.
-
-
-
-
-getAddresses
-public int[] getAddresses ()
-Gets the pin address for the component.
-
-Returns:
-An array of the pin addresses.
-
-
-
-
-
-setAddresses
-public void setAddresses (String addresses) Sets the pin addresses for the component. All previously existing address are replaced.
-
-Parameters:
-addresses - Pin addresses separated by a comma.
-
-
-
-
-getPwmTypes
-public com.pi4j.io.pwm.PwmType[] getPwmTypes ()
-Gets the PWM types of the component.
-
-Returns:
-PWMType enum.
-
-
-
-
-
-setPwmTypes
-public void setPwmTypes (String pwmTypes) Sets the PWM types for the component.
-
-Parameters:
-pwmTypes - String of PWM types separated by commas. Software should be formatted as SOFTWARE. Hardware as HARDWARE.
-
-
-
-
-getInitals
-public int[] getInitals ()
-Gets the initial states that the component is in when first initialized.
-
-Returns:
-Array of integers representing the initial state for each pin.
-
-
-
-
-
-setInitials
-public void setInitials (String initials) Sets the initial states for the component.
-
-Parameters:
-initials - String of states separated by commas.
-
-
-
-
-getShutdowns
-public int[] getShutdowns ()
-Gets the shutdown states for the component.
-
-Returns:
-Array of integers representing the shutdowns.
-
-
-
-
-
-setShutdowns
-public void setShutdowns (String shutdowns) Sets the shutdown states for the component. Existing shutdowns are replaced.
-
-Parameters:
-shutdowns - String of shutdowns separated by commas.
-
-
-
-
-getProvider
-
-Gets the provider for the component.
-
-Returns:
-A String representation of the provider.
-
-
-
-
-
-setProvider
-public void setProvider (String provider) Sets the provider.
-
-Parameters:
-provider - The new provider for the component.
-
-
-
-
-
-
-
-
-
-
-
PwmMultiPinConfiguration (pi4micronaut-utils v1.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+java.lang.Object
+
com.opensourcewithslu.utilities.MultiPinConfigs.PwmMultiPinConfiguration
+
+@EachProperty("pi4j.multi-pwm")
+ public class PwmMultiPinConfiguration
+
extends Object This class handles the configuration of a PWM device that has multiple pins.
+
+
+
+
+
+
+Constructor Summary
+Constructors
+
+
+
+
+
+
The PwmMultiPinConfiguration constructor.
+
+
+
+
+
+
+Method Summary
+
+
All Methods Instance Methods Concrete Methods
+
+
+
+
+
+
int[]
+
+
+
Gets the pin address for the component.
+
+
+
+
+
Gets the id of the component.
+
+
int[]
+
+
+
Gets the initial states that the component is in when first initialized.
+
+
+
+
+
Gets the name of the component.
+
+
+
+
+
Gets the provider for the component.
+
+
com.pi4j.io.pwm.PwmType[]
+
+
+
Gets the PWM types of the component.
+
+
int[]
+
+
+
Gets the shutdown states for the component.
+
+
void
+
+
+
Sets the pin addresses for the component.
+
+
void
+
+
+
Sets the initial states for the component.
+
+
void
+
+
+
Sets the name of the component.
+
+
void
+
+
+
void
+
+
+
Sets the PWM types for the component.
+
+
void
+
+
+
Sets the shutdown states for the component.
+
+
+
+
+
Methods inherited from class java.lang.Object
+
clone , equals , finalize , getClass , hashCode , notify , notifyAll , toString , wait , wait , wait
+
+
+
+
+
+
+
+
+Constructor Details
+
+
+
+PwmMultiPinConfiguration
+public PwmMultiPinConfiguration (@Parameter
+ String id) The PwmMultiPinConfiguration constructor.
+
+Parameters:
+id - The configuration id as defined in the application.yml
+
+
+
+
+
+
+
+
+Method Details
+
+
+
+getId
+
+Gets the id of the component.
+
+Returns:
+The id of the component.
+
+
+
+
+
+getName
+
+Gets the name of the component.
+
+Returns:
+The name of the component.
+
+
+
+
+
+setName
+public void setName (String name) Sets the name of the component.
+
+Parameters:
+name - The string name to replace the existing name.
+
+
+
+
+getAddresses
+public int[] getAddresses ()
+Gets the pin address for the component.
+
+Returns:
+An array of the pin addresses.
+
+
+
+
+
+setAddresses
+public void setAddresses (String addresses) Sets the pin addresses for the component. All previously existing address are replaced.
+
+Parameters:
+addresses - Pin addresses separated by a comma.
+
+
+
+
+getPwmTypes
+public com.pi4j.io.pwm.PwmType[] getPwmTypes ()
+Gets the PWM types of the component.
+
+Returns:
+PWMType enum.
+
+
+
+
+
+setPwmTypes
+public void setPwmTypes (String pwmTypes) Sets the PWM types for the component.
+
+Parameters:
+pwmTypes - String of PWM types separated by commas. Software should be formatted as SOFTWARE. Hardware as HARDWARE.
+
+
+
+
+getInitals
+public int[] getInitals ()
+Gets the initial states that the component is in when first initialized.
+
+Returns:
+Array of integers representing the initial state for each pin.
+
+
+
+
+
+setInitials
+public void setInitials (String initials) Sets the initial states for the component.
+
+Parameters:
+initials - String of states separated by commas.
+
+
+
+
+getShutdowns
+public int[] getShutdowns ()
+Gets the shutdown states for the component.
+
+Returns:
+Array of integers representing the shutdowns.
+
+
+
+
+
+setShutdowns
+public void setShutdowns (String shutdowns) Sets the shutdown states for the component. Existing shutdowns are replaced.
+
+Parameters:
+shutdowns - String of shutdowns separated by commas.
+
+
+
+
+getProvider
+
+Gets the provider for the component.
+
+Returns:
+A String representation of the provider.
+
+
+
+
+
+setProvider
+public void setProvider (String provider) Sets the provider.
+
+Parameters:
+provider - The new provider for the component.
+
+
+
+
+
+
+
+
+
+
+
com.opensourcewithslu.utilities.MultiPinConfigs (pi4micronaut-utils v1.0 API)
-
-JavaScript is disabled on your browser.
-
-
-
-
-
-
-package com.opensourcewithslu.utilities.MultiPinConfigs
-
-
-
-
-
-
-
-
Classes
-
-
-
-
-
-
This class handles the configuration of a digital input component that has multiple pins.
-
-
-
-
This class handles the configuration of a PWM device that has multiple pins.
-
-
-
-
-
-
-
-
com.opensourcewithslu.utilities.MultiPinConfigs (pi4micronaut-utils v1.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+package com.opensourcewithslu.utilities.MultiPinConfigs
+
+
+
+
+
+
+
+
Classes
+
+
+
+
+
+
This class handles the configuration of a digital input component that has multiple pins.
+
+
+
+
This class handles the configuration of a PWM device that has multiple pins.
+
+
+
+
+
+
+
+
com.opensourcewithslu.utilities.MultiPinConfigs Class Hierarchy (pi4micronaut-utils v1.0 API)
-
-JavaScript is disabled on your browser.
-
-
-
-
-
-
-Package Hierarchies:
-
-
-
-
-
com.opensourcewithslu.utilities.MultiPinConfigs Class Hierarchy (pi4micronaut-utils v1.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
diff --git a/pi4micronaut-utils/src/docs/javadoc/com/opensourcewithslu/utilities/MultipinConfiguration.html b/pi4micronaut-utils/src/docs/javadoc/com/opensourcewithslu/utilities/MultipinConfiguration.html
index d1204612..0a38e04f 100644
--- a/pi4micronaut-utils/src/docs/javadoc/com/opensourcewithslu/utilities/MultipinConfiguration.html
+++ b/pi4micronaut-utils/src/docs/javadoc/com/opensourcewithslu/utilities/MultipinConfiguration.html
@@ -1,206 +1,192 @@
-
-
-
-
-MultipinConfiguration (pi4micronaut-utils v1.0 API)
-
-JavaScript is disabled on your browser.
-
-
-
-
-
-
-
-
-
-@Prototype
- public class MultipinConfiguration
-
extends Object Class for configuring multipin components.
-
-
-
-
-
-
-Constructor Summary
-Constructors
-
-
-
-
-
-
The MultipinConfiguration constructor.
-
-
-
-
-
-
-Method Summary
-
-
All Methods Instance Methods Concrete Methods
-
-
-
-
-
-
-
-
-
Gets the components that are part of the overall component.
-
-
-
-
-
Gets the id of the component.
-
-
-
-
-
Methods inherited from class java.lang.Object
-
clone , equals , finalize , getClass , hashCode , notify , notifyAll , toString , wait , wait , wait
-
-
-
-
-
-
-
-
-Constructor Details
-
-
-
-MultipinConfiguration
-public MultipinConfiguration (String id,
- Object [] components) The MultipinConfiguration constructor.
-
-Parameters:
-id - The configuration id as defined in the application.ymlcomponents - The array of components that are a part of the multipin component.
-
-
-
-
-
-
-
-
-Method Details
-
-
-
-getId
-
-Gets the id of the component.
-
-Returns:
-The id of the component.
-
-
-
-
-
-getComponents
-public Object []getComponents ()
Gets the components that are part of the overall component.
-
-Returns:
-an array of component objects.
-
-
-
-
-
-
-
-
-
-
-
-
MultipinConfiguration (pi4micronaut-utils v1.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+@Prototype
+ public class MultipinConfiguration
+
extends Object Class for configuring multipin components.
+
+
+
+
+
+
+Constructor Summary
+Constructors
+
+
+
+
+
+
The MultipinConfiguration constructor.
+
+
+
+
+
+
+Method Summary
+
+
All Methods Instance Methods Concrete Methods
+
+
+
+
+
+
+
+
+
Gets the components that are part of the overall component.
+
+
+
+
+
Gets the id of the component.
+
+
+
+
+
Methods inherited from class java.lang.Object
+
clone , equals , finalize , getClass , hashCode , notify , notifyAll , toString , wait , wait , wait
+
+
+
+
+
+
+
+
+Constructor Details
+
+
+
+MultipinConfiguration
+public MultipinConfiguration (String id,
+ Object [] components) The MultipinConfiguration constructor.
+
+Parameters:
+id - The configuration id as defined in the application.ymlcomponents - The array of components that are a part of the multipin component.
+
+
+
+
+
+
+
+
+Method Details
+
+
+
+getId
+
+Gets the id of the component.
+
+Returns:
+The id of the component.
+
+
+
+
+
+getComponents
+public Object []getComponents ()
Gets the components that are part of the overall component.
+
+Returns:
+an array of component objects.
+
+
+
+
+
+
+
+
+
+
+
+
Pi4JFactory (pi4micronaut-utils v1.0 API)
-
-JavaScript is disabled on your browser.
-
-
-
-
-
-
-
-
-
-@Factory
- public class Pi4JFactory
-
extends Object The Pi4JFactory class is responsible for creating all the beans for components that are being used.
-
-
-
-
-
-
-Constructor Summary
-Constructors
-
-
-
-
-
-
Default constructor for Pi4JFactory.
-
-
-
-
-
-
-Method Summary
-
-
All Methods Instance Methods Concrete Methods
-
-
-
-
-
-
com.pi4j.io.gpio.digital.DigitalInput
-
-
-
Creates a DigitalInput object for digital input components.
-
-
com.pi4j.io.gpio.digital.DigitalOutput
-
-
-
Creates a DigitalOutput object for digital output components.
-
-
com.pi4j.io.i2c.I2CConfig
-
-
-
Creates an I2CConfigBuilder Object for components that are I2C.
-
-
com.pi4j.context.Context
-
-
-
This creates the Pi4J Context that is used to create all the beans for the individual components.
-
-
com.pi4j.io.pwm.Pwm
-
-
-
Creates a PWM object for components that are pwm.
-
-
com.pi4j.io.spi.SpiConfig
-
-
-
Creates an SpiConfigBuilder object for components that are SPI.
-
-
-
-
-
Methods inherited from class java.lang.Object
-
clone , equals , finalize , getClass , hashCode , notify , notifyAll , toString , wait , wait , wait
-
-
-
-
-
-
-
-
-Constructor Details
-
-
-
-Pi4JFactory
-public Pi4JFactory ()
-Default constructor for Pi4JFactory.
-
-
-
-
-
-
-
-
-Method Details
-
-
-
-createPi4jContext
-@Singleton
-@Bean(preDestroy="shutdown")
- public com.pi4j.context.Context createPi4jContext ()
-This creates the Pi4J Context that is used to create all the beans for the individual components.
-
-Returns:
-A Pi4J Context
-
-
-
-
-
-createDigitalOutput
-
-Creates a DigitalOutput object for digital output components.
-
-Parameters:
-config - DigitalOutputConfigurationpi4jContext - The Pi4J Context.Returns:
-A DigitalOutput Object.
-
-
-
-
-
-createDigitalInput
-
-Creates a DigitalInput object for digital input components.
-
-Parameters:
-config - DigitalInputConfigurationpi4jContext - The Pi4J Context.Returns:
-A DigitalInput Object.
-
-
-
-
-
-createPwm
-
-Creates a PWM object for components that are pwm.
-
-Parameters:
-config - PwmConfigurationpi4jContext - The Pi4J Context.Returns:
-A PWM Object.
-
-
-
-
-
-createSpi
-
-Creates an SpiConfigBuilder object for components that are SPI.
-
-Parameters:
-config - SpiConfigurationpi4jContext - The Pi4J Context.Returns:
-A SpiConfigBuilder Object.
-
-
-
-
-
-createI2C
-
-Creates an I2CConfigBuilder Object for components that are I2C.
-
-Parameters:
-config - i2cConfigurationpi4jContext - The Pi4J Context.Returns:
-A I2CConfigBuilder Object.
-
-
-
-
-
-
-
-
-
-
-
-
Pi4JFactory (pi4micronaut-utils v1.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+@Factory
+ public class Pi4JFactory
+
extends Object The Pi4JFactory class is responsible for creating all the beans for components that are being used.
+
+
+
+
+
+
+Constructor Summary
+Constructors
+
+
+
+
+
+
+Method Summary
+
+
All Methods Instance Methods Concrete Methods
+
+
+
+
+
+
com.pi4j.io.gpio.digital.DigitalInput
+
+
+
Creates a DigitalInput object for digital input components.
+
+
com.pi4j.io.gpio.digital.DigitalOutput
+
+
+
Creates a DigitalOutput object for digital output components.
+
+
com.pi4j.io.i2c.I2CConfig
+
+
+
Creates an I2CConfigBuilder Object for components that are I2C.
+
+
com.pi4j.context.Context
+
+
+
This creates the Pi4J Context that is used to create all the beans for the individual components.
+
+
com.pi4j.io.pwm.Pwm
+
+
+
Creates a PWM object for components that are pwm.
+
+
com.pi4j.io.spi.SpiConfig
+
+
+
Creates an SpiConfigBuilder object for components that are SPI.
+
+
+
+
+
Methods inherited from class java.lang.Object
+
clone , equals , finalize , getClass , hashCode , notify , notifyAll , toString , wait , wait , wait
+
+
+
+
+
+
+
+
+Constructor Details
+
+
+
+Pi4JFactory
+public Pi4JFactory ()
+
+
+
+
+
+
+
+
+Method Details
+
+
+
+createPi4jContext
+@Singleton
+@Bean(preDestroy="shutdown")
+ public com.pi4j.context.Context createPi4jContext ()
+This creates the Pi4J Context that is used to create all the beans for the individual components.
+
+Returns:
+A Pi4J Context
+
+
+
+
+
+createDigitalOutput
+
+Creates a DigitalOutput object for digital output components.
+
+Parameters:
+config - DigitalOutputConfigurationpi4jContext - The Pi4J Context.Returns:
+A DigitalOutput Object.
+
+
+
+
+
+createDigitalInput
+
+Creates a DigitalInput object for digital input components.
+
+Parameters:
+config - DigitalInputConfigurationpi4jContext - The Pi4J Context.Returns:
+A DigitalInput Object.
+
+
+
+
+
+createPwm
+
+Creates a PWM object for components that are pwm.
+
+Parameters:
+config - PwmConfigurationpi4jContext - The Pi4J Context.Returns:
+A PWM Object.
+
+
+
+
+
+createSpi
+
+Creates an SpiConfigBuilder object for components that are SPI.
+
+Parameters:
+config - SpiConfigurationpi4jContext - The Pi4J Context.Returns:
+A SpiConfigBuilder Object.
+
+
+
+
+
+createI2C
+
+Creates an I2CConfigBuilder Object for components that are I2C.
+
+Parameters:
+config - i2cConfigurationpi4jContext - The Pi4J Context.Returns:
+A I2CConfigBuilder Object.
+
+
+
+
+
+
+
+
+
+
+
+
Pi4JMultipinFactory (pi4micronaut-utils v1.0 API)
-
-JavaScript is disabled on your browser.
-
-
-
-
-
-
-
-
-
-@Prototype
-@Factory
- public class Pi4JMultipinFactory
-
extends Object The Pi4JMultipinFactory class is responsible for creating all the beans for all multi pin components that are being used.
-
-
-
-
-
-
-Constructor Summary
-Constructors
-
-
-
-
-
-
Default constructor for Pi4JMultipinFactory.
-
-
-
-
-
-
-Method Summary
-
-
All Methods Instance Methods Concrete Methods
-
-
-
-
-
-
-
-
-
Creates a MultipinConfiguration object for a multi pin digital input component.
-
-
-
-
-
Creates a MultipinConfiguration object for a multi pin pwm component.
-
-
-
-
-
Methods inherited from class java.lang.Object
-
clone , equals , finalize , getClass , hashCode , notify , notifyAll , toString , wait , wait , wait
-
-
-
-
-
-
-
-
-Constructor Details
-
-
-
-Pi4JMultipinFactory
-public Pi4JMultipinFactory ()
-Default constructor for Pi4JMultipinFactory.
-
-
-
-
-
-
-
-
-Method Details
-
-
-
-multiPinInput
-
-Creates a MultipinConfiguration object for a multi pin digital input component.
-
-Parameters:
-config - DigitalInputMultiPinConfigurationpi4jContext - The Pi4J Context.Returns:
-A MultipinConfiguration object.
-
-
-
-
-
-multiPinPwm
-
-Creates a MultipinConfiguration object for a multi pin pwm component.
-
-Parameters:
-config - PwmMultiPinConfigurationpi4jContext - The Pi4J Context.Returns:
-A MultipinConfiguration object.
-
-
-
-
-
-
-
-
-
-
-
-
Pi4JMultipinFactory (pi4micronaut-utils v1.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+@Factory
+ public class Pi4JMultipinFactory
+
extends Object The Pi4JMultipinFactory class is responsible for creating all the beans for all multi pin components that are being used.
+
+
+
+
+
+
+Constructor Summary
+Constructors
+
+
+
+
+
+
+Method Summary
+
+
All Methods Instance Methods Concrete Methods
+
+
+
+
+
+
+
+
+
Creates a MultipinConfiguration object for a multi pin digital input component.
+
+
+
+
+
Creates a MultipinConfiguration object for a multi pin pwm component.
+
+
+
+
+
Methods inherited from class java.lang.Object
+
clone , equals , finalize , getClass , hashCode , notify , notifyAll , toString , wait , wait , wait
+
+
+
+
+
+
+
+
+Constructor Details
+
+
+
+Pi4JMultipinFactory
+public Pi4JMultipinFactory ()
+
+
+
+
+
+
+
+
+Method Details
+
+
+
+multiPinInput
+
+Creates a MultipinConfiguration object for a multi pin digital input component.
+
+Parameters:
+config - DigitalInputMultiPinConfigurationpi4jContext - The Pi4J Context.Returns:
+A MultipinConfiguration object.
+
+
+
+
+
+multiPinPwm
+
+Creates a MultipinConfiguration object for a multi pin pwm component.
+
+Parameters:
+config - PwmMultiPinConfigurationpi4jContext - The Pi4J Context.Returns:
+A MultipinConfiguration object.
+
+
+
+
+
+
+
+
+
+
+
+
PwmConfiguration (pi4micronaut-utils v1.0 API)
-
-JavaScript is disabled on your browser.
-
-
-
-
-
-
-
-
-
-@Prototype
-@EachProperty("pi4j.pwm")
- public class PwmConfiguration
-
extends Object The PwmConfiguration class handles the configuration of a pwm component.
-
-
-
-
-
-
-Constructor Summary
-Constructors
-
-
-
-
-
-
PwmConfiguration constructor.
-
-
-
-
-
-
-Method Summary
-
-
All Methods Instance Methods Concrete Methods
-
-
-
-
-
-
int
-
-
-
Gets the pin address for the component.
-
-
-
-
-
Gets the id of the component.
-
-
int
-
-
-
Gets the initial state that the component is in when first initialized.
-
-
-
-
-
Gets the name of the component.
-
-
-
-
-
Gets the provider for the component.
-
-
com.pi4j.io.pwm.PwmType
-
-
-
Gets the pwm type of the component.
-
-
int
-
-
-
Gets the shutdown state for the component.
-
-
void
-
-
-
Sets a new pin address for the component.
-
-
void
-
-
-
Sets the initial state that the component will be in when first initialized.
-
-
void
-
-
-
Sets the name of the component.
-
-
void
-
-
-
Sets the provider of the component.
-
-
void
-
-
-
void
-
-
-
Sets the shutdown state for the component.
-
-
-
-
-
Methods inherited from class java.lang.Object
-
clone , equals , finalize , getClass , hashCode , notify , notifyAll , toString , wait , wait , wait
-
-
-
-
-
-
-
-
-Constructor Details
-
-
-
-PwmConfiguration
-public PwmConfiguration (@Parameter
- String id) PwmConfiguration constructor.
-
-Parameters:
-id - The configuration id as defined in the application.yml
-
-
-
-
-
-
-
-
-Method Details
-
-
-
-getId
-
-Gets the id of the component.
-
-Returns:
-The id of the component.
-
-
-
-
-
-getName
-
-Gets the name of the component.
-
-Returns:
-The name of the component.
-
-
-
-
-
-setName
-public void setName (String name) Sets the name of the component.
-
-Parameters:
-name - The string name to replace the existing name.
-
-
-
-
-getAddress
-public int getAddress ()
-Gets the pin address for the component.
-
-Returns:
-The address as an integer.
-
-
-
-
-
-setAddress
-public void setAddress (int address)
-Sets a new pin address for the component.
-
-Parameters:
-address - An integer representing the new pin address.
-
-
-
-
-getInital
-public int getInital ()
-Gets the initial state that the component is in when first initialized.
-
-Returns:
-The state as an integer.
-
-
-
-
-
-setInital
-public void setInital (int inital)
-Sets the initial state that the component will be in when first initialized.
-
-Parameters:
-inital - The startup state as an integer.
-
-
-
-
-getShutdown
-public int getShutdown ()
-Gets the shutdown state for the component.
-
-Returns:
-The shutdown state as an integer.
-
-
-
-
-
-setShutdown
-public void setShutdown (int shutdown)
-Sets the shutdown state for the component.
-
-Parameters:
-shutdown - Integer representing the new shutdown state.
-
-
-
-
-getPwmType
-public com.pi4j.io.pwm.PwmType getPwmType ()
-Gets the pwm type of the component.
-
-Returns:
-A PwmType object.
-
-
-
-
-
-setPwmType
-public void setPwmType (String pwmType) Sets the pwm type.
-
-Parameters:
-pwmType - A string representing the new pwm type. Either SOFTWARE or HARDWARE.
-
-
-
-
-getProvider
-
-Gets the provider for the component.
-
-Returns:
-The provider as a String.
-
-
-
-
-
-setProvider
-public void setProvider (String provider) Sets the provider of the component.
-
-Parameters:
-provider - The new provider as a String.
-
-
-
-
-
-
-
-
-
-
-
PwmConfiguration (pi4micronaut-utils v1.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+@EachProperty("pi4j.pwm")
+ public class PwmConfiguration
+
extends Object The PwmConfiguration class handles the configuration of a pwm component.
+
+
+
+
+
+
+Constructor Summary
+Constructors
+
+
+
+
+
+
PwmConfiguration constructor.
+
+
+
+
+
+
+Method Summary
+
+
All Methods Instance Methods Concrete Methods
+
+
+
+
+
+
int
+
+
+
Gets the pin address for the component.
+
+
+
+
+
Gets the id of the component.
+
+
int
+
+
+
Gets the initial state that the component is in when first initialized.
+
+
+
+
+
Gets the name of the component.
+
+
+
+
+
Gets the provider for the component.
+
+
com.pi4j.io.pwm.PwmType
+
+
+
Gets the pwm type of the component.
+
+
int
+
+
+
Gets the shutdown state for the component.
+
+
void
+
+
+
Sets a new pin address for the component.
+
+
void
+
+
+
Sets the initial state that the component will be in when first initialized.
+
+
void
+
+
+
Sets the name of the component.
+
+
void
+
+
+
Sets the provider of the component.
+
+
void
+
+
+
void
+
+
+
Sets the shutdown state for the component.
+
+
+
+
+
Methods inherited from class java.lang.Object
+
clone , equals , finalize , getClass , hashCode , notify , notifyAll , toString , wait , wait , wait
+
+
+
+
+
+
+
+
+Constructor Details
+
+
+
+PwmConfiguration
+public PwmConfiguration (@Parameter
+ String id) PwmConfiguration constructor.
+
+Parameters:
+id - The configuration id as defined in the application.yml
+
+
+
+
+
+
+
+
+Method Details
+
+
+
+getId
+
+Gets the id of the component.
+
+Returns:
+The id of the component.
+
+
+
+
+
+getName
+
+Gets the name of the component.
+
+Returns:
+The name of the component.
+
+
+
+
+
+setName
+public void setName (String name) Sets the name of the component.
+
+Parameters:
+name - The string name to replace the existing name.
+
+
+
+
+getAddress
+public int getAddress ()
+Gets the pin address for the component.
+
+Returns:
+The address as an integer.
+
+
+
+
+
+setAddress
+public void setAddress (int address)
+Sets a new pin address for the component.
+
+Parameters:
+address - An integer representing the new pin address.
+
+
+
+
+getInital
+public int getInital ()
+Gets the initial state that the component is in when first initialized.
+
+Returns:
+The state as an integer.
+
+
+
+
+
+setInital
+public void setInital (int inital)
+Sets the initial state that the component will be in when first initialized.
+
+Parameters:
+inital - The startup state as an integer.
+
+
+
+
+getShutdown
+public int getShutdown ()
+Gets the shutdown state for the component.
+
+Returns:
+The shutdown state as an integer.
+
+
+
+
+
+setShutdown
+public void setShutdown (int shutdown)
+Sets the shutdown state for the component.
+
+Parameters:
+shutdown - Integer representing the new shutdown state.
+
+
+
+
+getPwmType
+public com.pi4j.io.pwm.PwmType getPwmType ()
+Gets the pwm type of the component.
+
+Returns:
+A PwmType object.
+
+
+
+
+
+setPwmType
+public void setPwmType (String pwmType) Sets the pwm type.
+
+Parameters:
+pwmType - A string representing the new pwm type. Either SOFTWARE or HARDWARE.
+
+
+
+
+getProvider
+
+Gets the provider for the component.
+
+Returns:
+The provider as a String.
+
+
+
+
+
+setProvider
+public void setProvider (String provider) Sets the provider of the component.
+
+Parameters:
+provider - The new provider as a String.
+
+
+
+
+
+
+
+
+
+
+
SpiConfiguration (pi4micronaut-utils v1.0 API)
-
-JavaScript is disabled on your browser.
-
-
-
-
-
-
-
-
-
-@Prototype
-@EachProperty("pi4j.spi")
- public class SpiConfiguration
-
extends Object This class handles the configuration of a SPI component.
-
-
-
-
-
-
-Constructor Summary
-Constructors
-
-
-
-
-
-
The SpiConfiguration constructor.
-
-
-
-
-
-
-Method Summary
-
-
All Methods Instance Methods Concrete Methods
-
-
-
-
-
-
int
-
-
-
Gets the baud rate for the component.
-
-
int
-
-
-
Gets the channel for the component.
-
-
-
-
-
Gets the id of the component.
-
-
com.pi4j.io.spi.SpiMode
-
-
-
Gets the SPI mode for the component.
-
-
-
-
-
Gets the name of the component.
-
-
void
-
-
-
Sets the baud rate for the component.
-
-
void
-
-
-
Sets a new channel for the component.
-
-
void
-
setMode (com.pi4j.io.spi.SpiMode mode)
-
-
Sets the SPI mode for the component.
-
-
void
-
-
-
Sets the name of the component.
-
-
-
-
-
Methods inherited from class java.lang.Object
-
clone , equals , finalize , getClass , hashCode , notify , notifyAll , toString , wait , wait , wait
-
-
-
-
-
-
-
-
-Constructor Details
-
-
-
-SpiConfiguration
-public SpiConfiguration (@Parameter
- String id) The SpiConfiguration constructor.
-
-Parameters:
-id - The configuration id as defined in the application.yml
-
-
-
-
-
-
-
-
-Method Details
-
-
-
-getId
-
-Gets the id of the component.
-
-Returns:
-The id of the component.
-
-
-
-
-
-getName
-
-Gets the name of the component.
-
-Returns:
-The name of the component.
-
-
-
-
-
-setName
-public void setName (String name) Sets the name of the component.
-
-Parameters:
-name - The string name to replace the existing name.
-
-
-
-
-getChannel
-public int getChannel ()
-Gets the channel for the component.
-
-Returns:
-An integer representing the channel.
-
-
-
-
-
-setChannel
-public void setChannel (int channel)
-Sets a new channel for the component.
-
-Parameters:
-channel - An integer representing the new channel.
-
-
-
-
-getMode
-public com.pi4j.io.spi.SpiMode getMode ()
-Gets the SPI mode for the component.
-
-Returns:
-A SpiMode enum.
-
-
-
-
-
-setMode
-public void setMode (com.pi4j.io.spi.SpiMode mode)
-Sets the SPI mode for the component.
-
-Parameters:
-mode - An SpiMode object.
-
-
-
-
-getBaud
-public int getBaud ()
-Gets the baud rate for the component.
-
-Returns:
-the baud rate as an integer.
-
-
-
-
-
-setBaud
-public void setBaud (int baud)
-Sets the baud rate for the component.
-
-Parameters:
-baud - Integer representing the new baud rate.
-
-
-
-
-
-
-
-
-
-
-
SpiConfiguration (pi4micronaut-utils v1.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+@EachProperty("pi4j.spi")
+ public class SpiConfiguration
+
extends Object This class handles the configuration of a SPI component.
+
+
+
+
+
+
+Constructor Summary
+Constructors
+
+
+
+
+
+
The SpiConfiguration constructor.
+
+
+
+
+
+
+Method Summary
+
+
All Methods Instance Methods Concrete Methods
+
+
+
+
+
+
int
+
+
+
Gets the baud rate for the component.
+
+
int
+
+
+
Gets the channel for the component.
+
+
+
+
+
Gets the id of the component.
+
+
com.pi4j.io.spi.SpiMode
+
+
+
Gets the SPI mode for the component.
+
+
+
+
+
Gets the name of the component.
+
+
void
+
+
+
Sets the baud rate for the component.
+
+
void
+
+
+
Sets a new channel for the component.
+
+
void
+
setMode (com.pi4j.io.spi.SpiMode mode)
+
+
Sets the SPI mode for the component.
+
+
void
+
+
+
Sets the name of the component.
+
+
+
+
+
Methods inherited from class java.lang.Object
+
clone , equals , finalize , getClass , hashCode , notify , notifyAll , toString , wait , wait , wait
+
+
+
+
+
+
+
+
+Constructor Details
+
+
+
+SpiConfiguration
+public SpiConfiguration (@Parameter
+ String id) The SpiConfiguration constructor.
+
+Parameters:
+id - The configuration id as defined in the application.yml
+
+
+
+
+
+
+
+
+Method Details
+
+
+
+getId
+
+Gets the id of the component.
+
+Returns:
+The id of the component.
+
+
+
+
+
+getName
+
+Gets the name of the component.
+
+Returns:
+The name of the component.
+
+
+
+
+
+setName
+public void setName (String name) Sets the name of the component.
+
+Parameters:
+name - The string name to replace the existing name.
+
+
+
+
+getChannel
+public int getChannel ()
+Gets the channel for the component.
+
+Returns:
+An integer representing the channel.
+
+
+
+
+
+setChannel
+public void setChannel (int channel)
+Sets a new channel for the component.
+
+Parameters:
+channel - An integer representing the new channel.
+
+
+
+
+getMode
+public com.pi4j.io.spi.SpiMode getMode ()
+Gets the SPI mode for the component.
+
+Returns:
+A SpiMode enum.
+
+
+
+
+
+setMode
+public void setMode (com.pi4j.io.spi.SpiMode mode)
+Sets the SPI mode for the component.
+
+Parameters:
+mode - An SpiMode object.
+
+
+
+
+getBaud
+public int getBaud ()
+Gets the baud rate for the component.
+
+Returns:
+the baud rate as an integer.
+
+
+
+
+
+setBaud
+public void setBaud (int baud)
+Sets the baud rate for the component.
+
+Parameters:
+baud - Integer representing the new baud rate.
+
+
+
+
+
+
+
+
+
+
+
i2cConfiguration (pi4micronaut-utils v1.0 API)
-
-JavaScript is disabled on your browser.
-
-
-
-
-
-
-
-
-
-@Prototype
-@EachProperty("pi4j.i2c")
- public class i2cConfiguration
-
extends Object This class handles the configuration of an I2C components.
-
-
-
-
-
-
-Constructor Summary
-Constructors
-
-
-
-
-
-
The i2cConfiguration constructor.
-
-
-
-
-
-
-Method Summary
-
-
All Methods Instance Methods Concrete Methods
-
-
-
-
-
-
int
-
-
-
Gets the bus pin for the component.
-
-
int
-
-
-
-
-
-
Gets the id of the component.
-
-
-
-
-
Gets the name of the component.
-
-
void
-
-
-
void
-
-
-
void
-
-
-
Sets the name of the component.
-
-
-
-
-
Methods inherited from class java.lang.Object
-
clone , equals , finalize , getClass , hashCode , notify , notifyAll , toString , wait , wait , wait
-
-
-
-
-
-
-
-
-Constructor Details
-
-
-
-i2cConfiguration
-public i2cConfiguration (@Parameter
- String id) The i2cConfiguration constructor.
-
-Parameters:
-id - The configuration id as defined in the application.yml
-
-
-
-
-
-
-
-
-Method Details
-
-
-
-getId
-
-Gets the id of the component.
-
-Returns:
-The id of the component.
-
-
-
-
-
-getName
-
-Gets the name of the component.
-
-Returns:
-The name of the component.
-
-
-
-
-
-setName
-public void setName (String name) Sets the name of the component.
-
-Parameters:
-name - The string name to replace the existing name.
-
-
-
-
-getBus
-public int getBus ()
-Gets the bus pin for the component.
-
-Returns:
-integer representing the bus.
-
-
-
-
-
-setBus
-public void setBus (int bus)
-Sets the bus pin
-
-Parameters:
-bus - integer representing the bus pin.
-
-
-
-
-getDevice
-public int getDevice ()
-Gets the device
-
-Returns:
-the device represented by an integer.
-
-
-
-
-
-setDevice
-public void setDevice (int device)
-Sets the device
-
-Parameters:
-device - The device as an integer.
-
-
-
-
-
-
-
-
-
-
-
i2cConfiguration (pi4micronaut-utils v1.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
+
+@EachProperty("pi4j.i2c")
+ public class i2cConfiguration
+
extends Object This class handles the configuration of an I2C components.
+
+
+
+
+
+
+Constructor Summary
+Constructors
+
+
+
+
+
+
The i2cConfiguration constructor.
+
+
+
+
+
+
+Method Summary
+
+
All Methods Instance Methods Concrete Methods
+
+
+
+
+
+
int
+
+
+
Gets the bus pin for the component.
+
+
int
+
+
+
+
+
+
Gets the id of the component.
+
+
+
+
+
Gets the name of the component.
+
+
void
+
+
+
void
+
+
+
void
+
+
+
Sets the name of the component.
+
+
+
+
+
Methods inherited from class java.lang.Object
+
clone , equals , finalize , getClass , hashCode , notify , notifyAll , toString , wait , wait , wait
+
+
+
+
+
+
+
+
+Constructor Details
+
+
+
+i2cConfiguration
+public i2cConfiguration (@Parameter
+ String id) The i2cConfiguration constructor.
+
+Parameters:
+id - The configuration id as defined in the application.yml
+
+
+
+
+
+
+
+
+Method Details
+
+
+
+getId
+
+Gets the id of the component.
+
+Returns:
+The id of the component.
+
+
+
+
+
+getName
+
+Gets the name of the component.
+
+Returns:
+The name of the component.
+
+
+
+
+
+setName
+public void setName (String name) Sets the name of the component.
+
+Parameters:
+name - The string name to replace the existing name.
+
+
+
+
+getBus
+public int getBus ()
+Gets the bus pin for the component.
+
+Returns:
+integer representing the bus.
+
+
+
+
+
+setBus
+public void setBus (int bus)
+Sets the bus pin
+
+Parameters:
+bus - integer representing the bus pin.
+
+
+
+
+getDevice
+public int getDevice ()
+Gets the device
+
+Returns:
+the device represented by an integer.
+
+
+
+
+
+setDevice
+public void setDevice (int device)
+Sets the device
+
+Parameters:
+device - The device as an integer.
+
+
+
+
+
+
+
+
+
+
+
com.opensourcewithslu.utilities (pi4micronaut-utils v1.0 API)
-
-JavaScript is disabled on your browser.
-
-
-
-
-
-
-package com.opensourcewithslu.utilities
-
-
-
-
-
-
-
-
Classes
-
-
-
-
-
-
This class handles the configuration of a digital input component.
-
-
-
-
This class handles the configuration of a digital output component.
-
-
-
-
This class handles the configuration of an I2C components.
-
-
-
-
Class for configuring multipin components.
-
-
-
-
The Pi4JFactory class is responsible for creating all the beans for components that are being used.
-
-
-
-
The Pi4JMultipinFactory class is responsible for creating all the beans for all multi pin components that are being used.
-
-
-
-
The PwmConfiguration class handles the configuration of a pwm component.
-
-
-
-
This class handles the configuration of a SPI component.
-
-
-
-
-
-
-
-
com.opensourcewithslu.utilities (pi4micronaut-utils v1.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+package com.opensourcewithslu.utilities
+
+
+
+
+
+
+
+
Classes
+
+
+
+
+
+
This class handles the configuration of a digital input component.
+
+
+
+
This class handles the configuration of a digital output component.
+
+
+
+
This class handles the configuration of an I2C components.
+
+
+
+
Class for configuring multipin components.
+
+
+
+
The Pi4JFactory class is responsible for creating all the beans for components that are being used.
+
+
+
+
The Pi4JMultipinFactory class is responsible for creating all the beans for all multi pin components that are being used.
+
+
+
+
The PwmConfiguration class handles the configuration of a pwm component.
+
+
+
+
This class handles the configuration of a SPI component.
+
+
+
+
+
+
+
+
com.opensourcewithslu.utilities Class Hierarchy (pi4micronaut-utils v1.0 API)
-
-JavaScript is disabled on your browser.
-
-
-
-
-
-
-Package Hierarchies:
-
-
-
-
-
com.opensourcewithslu.utilities Class Hierarchy (pi4micronaut-utils v1.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
diff --git a/pi4micronaut-utils/src/docs/javadoc/element-list b/pi4micronaut-utils/src/docs/javadoc/element-list
index 6c0109fb..3f34c929 100644
--- a/pi4micronaut-utils/src/docs/javadoc/element-list
+++ b/pi4micronaut-utils/src/docs/javadoc/element-list
@@ -1,5 +1,5 @@
-com.opensourcewithslu
-com.opensourcewithslu.inputdevices
-com.opensourcewithslu.outputdevices
-com.opensourcewithslu.utilities
-com.opensourcewithslu.utilities.MultiPinConfigs
+com.opensourcewithslu
+com.opensourcewithslu.inputdevices
+com.opensourcewithslu.outputdevices
+com.opensourcewithslu.utilities
+com.opensourcewithslu.utilities.MultiPinConfigs
diff --git a/pi4micronaut-utils/src/docs/javadoc/help-doc.html b/pi4micronaut-utils/src/docs/javadoc/help-doc.html
index 19e35bf8..83a1ff8d 100644
--- a/pi4micronaut-utils/src/docs/javadoc/help-doc.html
+++ b/pi4micronaut-utils/src/docs/javadoc/help-doc.html
@@ -1,182 +1,175 @@
-
-
-
-
-API Help (pi4micronaut-utils v1.0 API)
-
-JavaScript is disabled on your browser.
-
-
-
-
-
-JavaDoc Help
-
-
-
Navigation
-Starting from the
Overview page, you can browse the documentation using the links in each page, and in the navigation bar at the top of each page. The
Index and Search box allow you to navigate to specific declarations and summary pages, including:
All Packages ,
All Classes and Interfaces
-
-Search
-You can search for definitions of modules, packages, types, fields, methods, system properties and other terms defined in the API. These items can be searched using part or all of the name, optionally using "camelCase" abbreviations, or multiple search terms separated by whitespace. Some examples:
-
-"j.l.obj" matches "java.lang.Object""InpStr" matches "java.io.InputStream""math exact long" matches "java.lang.Math.absExact(long)"
-Refer to the Javadoc Search Specification for a full description of search features.
-
-
-
Kinds of Pages
-The following sections describe the different kinds of pages in this collection.
-
-Overview
-The Overview page is the front page of this API document and provides a list of all packages with a summary for each. This page can also contain an overall description of the set of packages.
-
-
-Package
-Each package has a page that contains a list of its classes and interfaces, with a summary for each. These pages may contain the following categories:
-
-Interfaces
-Classes
-Enum Classes
-Exception Classes
-Annotation Interfaces
-
-
-
-Class or Interface
-Each class, interface, nested class and nested interface has its own separate page. Each of these pages has three sections consisting of a declaration and description, member summary tables, and detailed member descriptions. Entries in each of these sections are omitted if they are empty or not applicable.
-
-Class Inheritance Diagram
-Direct Subclasses
-All Known Subinterfaces
-All Known Implementing Classes
-Class or Interface Declaration
-Class or Interface Description
-
-
-Nested Class Summary
-Enum Constant Summary
-Field Summary
-Property Summary
-Constructor Summary
-Method Summary
-Required Element Summary
-Optional Element Summary
-
-
-Enum Constant Details
-Field Details
-Property Details
-Constructor Details
-Method Details
-Element Details
-
-Note: Annotation interfaces have required and optional elements, but not methods. Only enum classes have enum constants. The components of a record class are displayed as part of the declaration of the record class. Properties are a feature of JavaFX.
-The summary entries are alphabetical, while the detailed descriptions are in the order they appear in the source code. This preserves the logical groupings established by the programmer.
-
-
-Other Files
-Packages and modules may contain pages with additional information related to the declarations nearby.
-
-
-Tree (Class Hierarchy)
-There is a Class Hierarchy page for all packages, plus a hierarchy for each package. Each hierarchy page contains a list of classes and a list of interfaces. Classes are organized by inheritance structure starting with java.lang.Object. Interfaces do not inherit from java.lang.Object.
-
-When viewing the Overview page, clicking on TREE displays the hierarchy for all packages.
-When viewing a particular package, class or interface page, clicking on TREE displays the hierarchy for only that package.
-
-
-
-All Packages
-The All Packages page contains an alphabetic index of all packages contained in the documentation.
-
-
-All Classes and Interfaces
-The All Classes and Interfaces page contains an alphabetic index of all classes and interfaces contained in the documentation, including annotation interfaces, enum classes, and record classes.
-
-
-
-
-
API Help (pi4micronaut-utils v1.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+JavaDoc Help
+
+
+
Navigation
+Starting from the
Overview page, you can browse the documentation using the links in each page, and in the navigation bar at the top of each page. The
Index and Search box allow you to navigate to specific declarations and summary pages, including:
All Packages ,
All Classes and Interfaces
+
+Search
+You can search for definitions of modules, packages, types, fields, methods, system properties and other terms defined in the API, using some or all of the name, optionally using "camelCase" abbreviations. For example:
+
+j.l.obj will match "java.lang.Object"InpStr will match "java.io.InputStream"HM.cK will match "java.util.HashMap.containsKey(Object)"
+Refer to the Javadoc Search Specification for a full description of search features.
+
+
+
Kinds of Pages
+The following sections describe the different kinds of pages in this collection.
+
+Overview
+The Overview page is the front page of this API document and provides a list of all packages with a summary for each. This page can also contain an overall description of the set of packages.
+
+
+Package
+Each package has a page that contains a list of its classes and interfaces, with a summary for each. These pages may contain the following categories:
+
+Interfaces
+Classes
+Enum Classes
+Exceptions
+Errors
+Annotation Interfaces
+
+
+
+Class or Interface
+Each class, interface, nested class and nested interface has its own separate page. Each of these pages has three sections consisting of a declaration and description, member summary tables, and detailed member descriptions. Entries in each of these sections are omitted if they are empty or not applicable.
+
+Class Inheritance Diagram
+Direct Subclasses
+All Known Subinterfaces
+All Known Implementing Classes
+Class or Interface Declaration
+Class or Interface Description
+
+
+Nested Class Summary
+Enum Constant Summary
+Field Summary
+Property Summary
+Constructor Summary
+Method Summary
+Required Element Summary
+Optional Element Summary
+
+
+Enum Constant Details
+Field Details
+Property Details
+Constructor Details
+Method Details
+Element Details
+
+Note: Annotation interfaces have required and optional elements, but not methods. Only enum classes have enum constants. The components of a record class are displayed as part of the declaration of the record class. Properties are a feature of JavaFX.
+The summary entries are alphabetical, while the detailed descriptions are in the order they appear in the source code. This preserves the logical groupings established by the programmer.
+
+
+Other Files
+Packages and modules may contain pages with additional information related to the declarations nearby.
+
+
+Tree (Class Hierarchy)
+There is a Class Hierarchy page for all packages, plus a hierarchy for each package. Each hierarchy page contains a list of classes and a list of interfaces. Classes are organized by inheritance structure starting with java.lang.Object. Interfaces do not inherit from java.lang.Object.
+
+When viewing the Overview page, clicking on TREE displays the hierarchy for all packages.
+When viewing a particular package, class or interface page, clicking on TREE displays the hierarchy for only that package.
+
+
+
+All Packages
+The All Packages page contains an alphabetic index of all packages contained in the documentation.
+
+
+All Classes and Interfaces
+The All Classes and Interfaces page contains an alphabetic index of all classes and interfaces contained in the documentation, including annotation interfaces, enum classes, and record classes.
+
+
+
+
+
Index (pi4micronaut-utils v1.0 API)
-
-JavaScript is disabled on your browser.
-
-
-
-
-
-
-A B C D G I L M P R S T U W All Classes and Interfaces | All Packages
-A
-
-actBuzzCheck - Variable in class com.opensourcewithslu.outputdevices.ActiveBuzzerHelper
-To check if the buzzer is active or not
-
-ActiveBuzzerHelper - Class in com.opensourcewithslu.outputdevices
-The ActiveBuzzerHelper class contains methods that pertain to the control of the active buzzer.
-
-ActiveBuzzerHelper(Pwm) - Constructor for class com.opensourcewithslu.outputdevices.ActiveBuzzerHelper
-BuzzerHelper constructor
-
-activeBuzzerOff() - Method in class com.opensourcewithslu.outputdevices.ActiveBuzzerHelper
-Turns the active buzzer off.
-
-activeBuzzerOn() - Method in class com.opensourcewithslu.outputdevices.ActiveBuzzerHelper
-Turns the active buzzer on by setting the duty cycle is 100 and frequency to 440hz.
-
-addEventListener(DigitalStateChangeListener) - Method in class com.opensourcewithslu.inputdevices.PhotoResistorHelper
-Adds an event listener to the Photo Resistor.
-
-addEventListener(DigitalStateChangeListener) - Method in class com.opensourcewithslu.inputdevices.PIRSensorHelper
-Adds an event listener to the PIR sensor.
-
-addEventListener(DigitalStateChangeListener) - Method in class com.opensourcewithslu.inputdevices.PushButtonHelper
-Adds an EventListener to the PushButton.
-
-addEventListener(DigitalStateChangeListener) - Method in class com.opensourcewithslu.inputdevices.SlideSwitchHelper
-Adds an EvenListener to the slide switch.
-
-addEventListener(DigitalStateChangeListener) - Method in class com.opensourcewithslu.inputdevices.TouchSwitchHelper
-Adds an event listener to the touch switch.
-
-Application - Class in com.opensourcewithslu
-Runs the Micronaut framework in the Pi4Micronaut framework.
-
-Application() - Constructor for class com.opensourcewithslu.Application
-This is the default constructor for the Application class.
-
-
-B
-
-beep() - Method in class com.opensourcewithslu.outputdevices.ActiveBuzzerHelper
-Beep powers on, plays a single tone from the active buzzer for 2 seconds then powers down.
-
-
-C
-
-clearDisplay() - Method in class com.opensourcewithslu.outputdevices.LCD1602Helper
-Clears the display of text.
-
-clearLine(int) - Method in class com.opensourcewithslu.outputdevices.LCD1602Helper
-Clears the text of the specified line.
-
-com.opensourcewithslu - package com.opensourcewithslu
-com.opensourcewithslu.inputdevices - package com.opensourcewithslu.inputdevices
-com.opensourcewithslu.outputdevices - package com.opensourcewithslu.outputdevices
-com.opensourcewithslu.utilities - package com.opensourcewithslu.utilities
-com.opensourcewithslu.utilities.MultiPinConfigs - package com.opensourcewithslu.utilities.MultiPinConfigs
-createDigitalInput(DigitalInputConfiguration, Context) - Method in class com.opensourcewithslu.utilities.Pi4JFactory
-Creates a DigitalInput object for digital input components.
-
-createDigitalOutput(DigitalOutputConfiguration, Context) - Method in class com.opensourcewithslu.utilities.Pi4JFactory
-Creates a DigitalOutput object for digital output components.
-
-createI2C(i2cConfiguration, Context) - Method in class com.opensourcewithslu.utilities.Pi4JFactory
-Creates an I2CConfigBuilder Object for components that are I2C.
-
-createPi4jContext() - Method in class com.opensourcewithslu.utilities.Pi4JFactory
-This creates the Pi4J Context that is used to create all the beans for the individual components.
-
-createPwm(PwmConfiguration, Context) - Method in class com.opensourcewithslu.utilities.Pi4JFactory
-Creates a PWM object for components that are pwm.
-
-createSpi(SpiConfiguration, Context) - Method in class com.opensourcewithslu.utilities.Pi4JFactory
-Creates an SpiConfigBuilder object for components that are SPI.
-
-
-D
-
-DigitalInputConfiguration - Class in com.opensourcewithslu.utilities
-This class handles the configuration of a digital input component.
-
-DigitalInputConfiguration(String) - Constructor for class com.opensourcewithslu.utilities.DigitalInputConfiguration
-Constructor for the DigitalInputConfiguration.
-
-DigitalInputMultiPinConfiguration - Class in com.opensourcewithslu.utilities.MultiPinConfigs
-This class handles the configuration of a digital input component that has multiple pins.
-
-DigitalInputMultiPinConfiguration(String) - Constructor for class com.opensourcewithslu.utilities.MultiPinConfigs.DigitalInputMultiPinConfiguration
-The DigitalInputMultiPinConfiguration constructor.
-
-DigitalOutputConfiguration - Class in com.opensourcewithslu.utilities
-This class handles the configuration of a digital output component.
-
-DigitalOutputConfiguration(String) - Constructor for class com.opensourcewithslu.utilities.DigitalOutputConfiguration
-The DigitalOutputConfiguration constructor.
-
-
-G
-
-getAddress() - Method in class com.opensourcewithslu.utilities.DigitalInputConfiguration
-Gets the pin address for the component.
-
-getAddress() - Method in class com.opensourcewithslu.utilities.DigitalOutputConfiguration
-Gets the pin address for the component.
-
-getAddress() - Method in class com.opensourcewithslu.utilities.PwmConfiguration
-Gets the pin address for the component.
-
-getAddresses() - Method in class com.opensourcewithslu.utilities.MultiPinConfigs.DigitalInputMultiPinConfiguration
-Gets the pin addresses for the component.
-
-getAddresses() - Method in class com.opensourcewithslu.utilities.MultiPinConfigs.PwmMultiPinConfiguration
-Gets the pin address for the component.
-
-getBaud() - Method in class com.opensourcewithslu.utilities.SpiConfiguration
-Gets the baud rate for the component.
-
-getBus() - Method in class com.opensourcewithslu.utilities.i2cConfiguration
-Gets the bus pin for the component.
-
-getChannel() - Method in class com.opensourcewithslu.utilities.SpiConfiguration
-Gets the channel for the component.
-
-getComponents() - Method in class com.opensourcewithslu.utilities.MultipinConfiguration
-Gets the components that are part of the overall component.
-
-getDark() - Method in class com.opensourcewithslu.inputdevices.PhotoResistorHelper
-Returns the current value of the darknessValue variable.
-
-getDebounce() - Method in class com.opensourcewithslu.utilities.DigitalInputConfiguration
-Gets the current debounce value for the component.
-
-getDebounces() - Method in class com.opensourcewithslu.utilities.MultiPinConfigs.DigitalInputMultiPinConfiguration
-Gets the current debounce values for the component.
-
-getDevice() - Method in class com.opensourcewithslu.utilities.i2cConfiguration
-Gets the device
-
-getDistanceInCentimeter() - Method in class com.opensourcewithslu.inputdevices.UltraSonicSensorHelper
-Returns the distance in centimeters.
-
-getDistanceInMeters() - Method in class com.opensourcewithslu.inputdevices.UltraSonicSensorHelper
-Returns the distance in meters.
-
-getEncoderValue() - Method in class com.opensourcewithslu.inputdevices.RotaryEncoderHelper
-Gets the value of the rotary encoder.
-
-getFrequency() - Method in class com.opensourcewithslu.outputdevices.PassiveBuzzerHelper
-Logs the passiveBuzzerFreq to the console
-
-getId() - Method in class com.opensourcewithslu.utilities.DigitalInputConfiguration
-Gets the id of the component.
-
-getId() - Method in class com.opensourcewithslu.utilities.DigitalOutputConfiguration
-Gets the id of the component.
-
-getId() - Method in class com.opensourcewithslu.utilities.i2cConfiguration
-Gets the id of the component.
-
-getId() - Method in class com.opensourcewithslu.utilities.MultiPinConfigs.DigitalInputMultiPinConfiguration
-Gets the id of the component.
-
-getId() - Method in class com.opensourcewithslu.utilities.MultiPinConfigs.PwmMultiPinConfiguration
-Gets the id of the component.
-
-getId() - Method in class com.opensourcewithslu.utilities.MultipinConfiguration
-Gets the id of the component.
-
-getId() - Method in class com.opensourcewithslu.utilities.PwmConfiguration
-Gets the id of the component.
-
-getId() - Method in class com.opensourcewithslu.utilities.SpiConfiguration
-Gets the id of the component.
-
-getInital() - Method in class com.opensourcewithslu.utilities.PwmConfiguration
-Gets the initial state that the component is in when first initialized.
-
-getInitals() - Method in class com.opensourcewithslu.utilities.MultiPinConfigs.PwmMultiPinConfiguration
-Gets the initial states that the component is in when first initialized.
-
-getInitial() - Method in class com.opensourcewithslu.utilities.DigitalOutputConfiguration
-Gets the initial state of the component.
-
-getMode() - Method in class com.opensourcewithslu.utilities.SpiConfiguration
-Gets the SPI mode for the component.
-
-getName() - Method in class com.opensourcewithslu.utilities.DigitalInputConfiguration
-Gets the name of the component.
-
-getName() - Method in class com.opensourcewithslu.utilities.DigitalOutputConfiguration
-Gets the name of the component.
-
-getName() - Method in class com.opensourcewithslu.utilities.i2cConfiguration
-Gets the name of the component.
-
-getName() - Method in class com.opensourcewithslu.utilities.MultiPinConfigs.DigitalInputMultiPinConfiguration
-Gets the name of the component.
-
-getName() - Method in class com.opensourcewithslu.utilities.MultiPinConfigs.PwmMultiPinConfiguration
-Gets the name of the component.
-
-getName() - Method in class com.opensourcewithslu.utilities.PwmConfiguration
-Gets the name of the component.
-
-getName() - Method in class com.opensourcewithslu.utilities.SpiConfiguration
-Gets the name of the component.
-
-getProvider() - Method in class com.opensourcewithslu.utilities.DigitalInputConfiguration
-Gets the provider for the component.
-
-getProvider() - Method in class com.opensourcewithslu.utilities.DigitalOutputConfiguration
-Gets the provider for the component.
-
-getProvider() - Method in class com.opensourcewithslu.utilities.MultiPinConfigs.DigitalInputMultiPinConfiguration
-Gets the provider for the component.
-
-getProvider() - Method in class com.opensourcewithslu.utilities.MultiPinConfigs.PwmMultiPinConfiguration
-Gets the provider for the component.
-
-getProvider() - Method in class com.opensourcewithslu.utilities.PwmConfiguration
-Gets the provider for the component.
-
-getPull() - Method in class com.opensourcewithslu.utilities.DigitalInputConfiguration
-Gets the pull resistance for the component.
-
-getPulls() - Method in class com.opensourcewithslu.utilities.MultiPinConfigs.DigitalInputMultiPinConfiguration
-Gets the pull resistance for the component.
-
-getPwmType() - Method in class com.opensourcewithslu.utilities.PwmConfiguration
-Gets the pwm type of the component.
-
-getPwmTypes() - Method in class com.opensourcewithslu.utilities.MultiPinConfigs.PwmMultiPinConfiguration
-Gets the PWM types of the component.
-
-getShutdown() - Method in class com.opensourcewithslu.utilities.DigitalOutputConfiguration
-Gets the shutdown state of the component.
-
-getShutdown() - Method in class com.opensourcewithslu.utilities.PwmConfiguration
-Gets the shutdown state for the component.
-
-getShutdowns() - Method in class com.opensourcewithslu.utilities.MultiPinConfigs.PwmMultiPinConfiguration
-Gets the shutdown states for the component.
-
-
-I
-
-i2cConfiguration - Class in com.opensourcewithslu.utilities
-This class handles the configuration of an I2C components.
-
-i2cConfiguration(String) - Constructor for class com.opensourcewithslu.utilities.i2cConfiguration
-The i2cConfiguration constructor.
-
-initialize() - Method in class com.opensourcewithslu.inputdevices.PhotoResistorHelper
-Initializes the Photo Resistor and calls the updateDarkness function for every half second.
-
-initialize() - Method in class com.opensourcewithslu.inputdevices.PIRSensorHelper
-Initializes the listener that keeps track of if the PIR sensor detects motion or not.
-
-initialize() - Method in class com.opensourcewithslu.inputdevices.PushButtonHelper
-Initializes the PushButton.
-
-initialize() - Method in class com.opensourcewithslu.inputdevices.RotaryEncoderHelper
-Initializes the listener that keeps track of the rotary encoder's position.
-
-initialize() - Method in class com.opensourcewithslu.inputdevices.SlideSwitchHelper
-Initializes the listener that keeps track of whether the slide switch is high/low.
-
-initialize() - Method in class com.opensourcewithslu.inputdevices.TouchSwitchHelper
-Initializes the listener that keeps track of if the touch switch has been touched or not.
-
-initialize() - Method in class com.opensourcewithslu.inputdevices.UltraSonicSensorHelper
-Initializes the Ultrasonic Sensor
-
-intermittentTone() - Method in class com.opensourcewithslu.outputdevices.ActiveBuzzerHelper
-Intermittent tone will play a tone for a 20 seconds duration.
-
-isDark - Variable in class com.opensourcewithslu.inputdevices.PhotoResistorHelper
-To check if it is Dark.
-
-isMoving - Variable in class com.opensourcewithslu.inputdevices.PIRSensorHelper
-Shows if the PIR sensor detects movement or not.
-
-isOn - Variable in class com.opensourcewithslu.inputdevices.SlideSwitchHelper
-Shows if the slide switch is on.
-
-isPressed - Variable in class com.opensourcewithslu.inputdevices.PushButtonHelper
-Determines if the button is pressed.
-
-isTouched - Variable in class com.opensourcewithslu.inputdevices.TouchSwitchHelper
-Shows if the touch switch has been touched.
-
-
-L
-
-LCD1602Helper - Class in com.opensourcewithslu.outputdevices
-This helper class, LCD1602Helper, is for controlling and interacting with an I2C LCD1602 display.
-
-LCD1602Helper(I2CConfig, Context) - Constructor for class com.opensourcewithslu.outputdevices.LCD1602Helper
-The LCD1602Helper constructor.
-
-LEDHelper - Class in com.opensourcewithslu.outputdevices
-The class LEDHelper contains methods that pertain to the control of a LED.
-
-LEDHelper(DigitalOutput) - Constructor for class com.opensourcewithslu.outputdevices.LEDHelper
-LEGHelper constructor.
-
-ledOff() - Method in class com.opensourcewithslu.outputdevices.LEDHelper
-Turns off the LED by setting the DigitalOutput object to low.
-
-ledOff() - Method in class com.opensourcewithslu.outputdevices.RGBLEDHelper
-Turns off the RGB LED.
-
-ledOn() - Method in class com.opensourcewithslu.outputdevices.LEDHelper
-Turns on the LED by setting the DigitalOutput object to high.
-
-ledOn() - Method in class com.opensourcewithslu.outputdevices.RGBLEDHelper
-Turns on the RGB LED with default RGB values of 100,100,100 and frequencies of 200 Hertz.
-
-
-M
-
-main(String[]) - Static method in class com.opensourcewithslu.Application
-The main entry point of the application.
-
-morseCodeTone() - Method in class com.opensourcewithslu.outputdevices.ActiveBuzzerHelper
-Uses the active buzzer on and off function to beep the word pi in morse code.
-
-MultipinConfiguration - Class in com.opensourcewithslu.utilities
-Class for configuring multipin components.
-
-MultipinConfiguration(String, Object[]) - Constructor for class com.opensourcewithslu.utilities.MultipinConfiguration
-The MultipinConfiguration constructor.
-
-multiPinInput(DigitalInputMultiPinConfiguration, Context) - Method in class com.opensourcewithslu.utilities.Pi4JMultipinFactory
-Creates a MultipinConfiguration object for a multi pin digital input component.
-
-multiPinPwm(PwmMultiPinConfiguration, Context) - Method in class com.opensourcewithslu.utilities.Pi4JMultipinFactory
-Creates a MultipinConfiguration object for a multi pin pwm component.
-
-
-P
-
-passBuzzDC - Variable in class com.opensourcewithslu.outputdevices.PassiveBuzzerHelper
-passBuzzDC is a protected integer variable that defines the duty cycle.
-
-passiveBuzzerFreq - Variable in class com.opensourcewithslu.outputdevices.PassiveBuzzerHelper
-passiveBuzzerFreq is a protected integer variable that defines the default frequency for the buzzer.
-
-PassiveBuzzerHelper - Class in com.opensourcewithslu.outputdevices
-The PassiveBuzzerHelper class contains methods that pertain to the control of the passive buzzer.
-
-PassiveBuzzerHelper(Pwm) - Constructor for class com.opensourcewithslu.outputdevices.PassiveBuzzerHelper
-The PassiveBuzzerHelper constructor.
-
-passiveBuzzerOff() - Method in class com.opensourcewithslu.outputdevices.PassiveBuzzerHelper
-Disables the passive buzzer.
-
-passiveBuzzerOn(int, int) - Method in class com.opensourcewithslu.outputdevices.PassiveBuzzerHelper
-Sets the passive buzzer to the desired duty cycle and frequency.
-
-passiveBuzzTone() - Method in class com.opensourcewithslu.outputdevices.PassiveBuzzerHelper
-passiveBuzzTone emits a 1 - second buzz to ensure functionality
-
-PhotoResistorHelper - Class in com.opensourcewithslu.inputdevices
-The PhotoResistorHelper class is used to work with the functionalities of a Photo Resistor.
-
-PhotoResistorHelper(DigitalInput, DigitalOutput) - Constructor for class com.opensourcewithslu.inputdevices.PhotoResistorHelper
-TouchSwitchHelper constructor.
-
-Pi4JFactory - Class in com.opensourcewithslu.utilities
-The Pi4JFactory class is responsible for creating all the beans for components that are being used.
-
-Pi4JFactory() - Constructor for class com.opensourcewithslu.utilities.Pi4JFactory
-Default constructor for Pi4JFactory.
-
-Pi4JMultipinFactory - Class in com.opensourcewithslu.utilities
-The Pi4JMultipinFactory class is responsible for creating all the beans for all multi pin components that are being used.
-
-Pi4JMultipinFactory() - Constructor for class com.opensourcewithslu.utilities.Pi4JMultipinFactory
-Default constructor for Pi4JMultipinFactory.
-
-PIRSensorHelper - Class in com.opensourcewithslu.inputdevices
-The PIRSensorHelper class is used to initialize a PIR motion sensor.
-
-PIRSensorHelper(DigitalInput) - Constructor for class com.opensourcewithslu.inputdevices.PIRSensorHelper
-PIRSensorHelper constructor
-
-piToneSequence() - Method in class com.opensourcewithslu.outputdevices.PassiveBuzzerHelper
-Tone sequence cycles through array's containing the frequencies of the first
- then digits of pi.
-
-PushButtonHelper - Class in com.opensourcewithslu.inputdevices
-The PushButtonHelper class is used to create a listener that determines when a 4 pin button is pressed.
-
-PushButtonHelper(DigitalInput) - Constructor for class com.opensourcewithslu.inputdevices.PushButtonHelper
-The PushButtonHelper constructor.
-
-PwmConfiguration - Class in com.opensourcewithslu.utilities
-The PwmConfiguration class handles the configuration of a pwm component.
-
-PwmConfiguration(String) - Constructor for class com.opensourcewithslu.utilities.PwmConfiguration
-PwmConfiguration constructor.
-
-PwmMultiPinConfiguration - Class in com.opensourcewithslu.utilities.MultiPinConfigs
-This class handles the configuration of a PWM device that has multiple pins.
-
-PwmMultiPinConfiguration(String) - Constructor for class com.opensourcewithslu.utilities.MultiPinConfigs.PwmMultiPinConfiguration
-The PwmMultiPinConfiguration constructor.
-
-
-R
-
-readFromCard() - Method in class com.opensourcewithslu.inputdevices.RFidHelper
-When called, this method waits for any RFID card/fob to be scanned.
-
-removeEventListener() - Method in class com.opensourcewithslu.inputdevices.PhotoResistorHelper
-Removes the event listener from the Photo Resistor.
-
-removeEventListener() - Method in class com.opensourcewithslu.inputdevices.PIRSensorHelper
-Removes the event listener from the PIR sensor.
-
-removeEventListener() - Method in class com.opensourcewithslu.inputdevices.TouchSwitchHelper
-Removes the event listener from the touch switch.
-
-removeEventListener(DigitalStateChangeListener) - Method in class com.opensourcewithslu.inputdevices.PushButtonHelper
-Removes an EvenListener from the button.
-
-removeEventListener(DigitalStateChangeListener) - Method in class com.opensourcewithslu.inputdevices.SlideSwitchHelper
-Removes the EventListener from the slide switch.
-
-resetScanner() - Method in class com.opensourcewithslu.inputdevices.RFidHelper
-Resets the RFID scanner.
-
-RFidHelper - Class in com.opensourcewithslu.inputdevices
-The RFIDHelper class is for interacting with an RFID scanner.
-
-RFidHelper(SpiConfig, int, Context) - Constructor for class com.opensourcewithslu.inputdevices.RFidHelper
-The RFidHelper constructor WITH the reset pin as a parameter.
-
-RFidHelper(SpiConfig, Context) - Constructor for class com.opensourcewithslu.inputdevices.RFidHelper
-The RFidHelper constructor WITHOUT the reset pin as a parameter.
-
-RGBLEDHelper - Class in com.opensourcewithslu.outputdevices
-The RBGLEDHelper class handles all interactions with a RGB LED.
-
-RGBLEDHelper(MultipinConfiguration) - Constructor for class com.opensourcewithslu.outputdevices.RGBLEDHelper
-The RGBLEDHelper constructor.
-
-RotaryEncoderHelper - Class in com.opensourcewithslu.inputdevices
-The RotaryEncoderHelper class initializes a rotary encoder component and returns the value of the encoder when called upon.
-
-RotaryEncoderHelper(MultipinConfiguration) - Constructor for class com.opensourcewithslu.inputdevices.RotaryEncoderHelper
-The RotaryEncoderHelper constructor.
-
-
-S
-
-setAddress(int) - Method in class com.opensourcewithslu.utilities.DigitalInputConfiguration
-Sets the pin address.
-
-setAddress(int) - Method in class com.opensourcewithslu.utilities.DigitalOutputConfiguration
-Sets the pin address.
-
-setAddress(int) - Method in class com.opensourcewithslu.utilities.PwmConfiguration
-Sets a new pin address for the component.
-
-setAddresses(String) - Method in class com.opensourcewithslu.utilities.MultiPinConfigs.DigitalInputMultiPinConfiguration
-Sets the pin addresses for the component.
-
-setAddresses(String) - Method in class com.opensourcewithslu.utilities.MultiPinConfigs.PwmMultiPinConfiguration
-Sets the pin addresses for the component.
-
-setBackLight(boolean) - Method in class com.opensourcewithslu.outputdevices.LCD1602Helper
-Setting the backlight state of the LCD based off the boolean input.
-
-setBaud(int) - Method in class com.opensourcewithslu.utilities.SpiConfiguration
-Sets the baud rate for the component.
-
-setBlue(int) - Method in class com.opensourcewithslu.outputdevices.RGBLEDHelper
-Sets the blue value of the LED.
-
-setBlue(int, int) - Method in class com.opensourcewithslu.outputdevices.RGBLEDHelper
-Sets the blue value and frequency of the LED.
-
-setBus(int) - Method in class com.opensourcewithslu.utilities.i2cConfiguration
-Sets the bus pin
-
-setChannel(int) - Method in class com.opensourcewithslu.utilities.SpiConfiguration
-Sets a new channel for the component.
-
-setColor(int[]) - Method in class com.opensourcewithslu.outputdevices.RGBLEDHelper
-Sets the color of the LED based of inputted RGB values.
-
-setColor(int[], int[]) - Method in class com.opensourcewithslu.outputdevices.RGBLEDHelper
-Sets the color of the LED using the array of RGB values and an array of frequencies.
-
-setColorHex(String) - Method in class com.opensourcewithslu.outputdevices.RGBLEDHelper
-Setting the color of the LED using a hexadecimal value.
-
-setColorHex(String, int[]) - Method in class com.opensourcewithslu.outputdevices.RGBLEDHelper
-Setting the color of the LED using a hexadecimal value and an array of frequencies.
-
-setDarknessThreshold(int) - Method in class com.opensourcewithslu.inputdevices.PhotoResistorHelper
-To set a threshold for Photo Resistor.
-
-setDebounce(Long) - Method in class com.opensourcewithslu.utilities.DigitalInputConfiguration
-Sets the debounce of the component.
-
-setDebounces(String) - Method in class com.opensourcewithslu.utilities.MultiPinConfigs.DigitalInputMultiPinConfiguration
-Sets the debounces for the component.
-
-setDevice(int) - Method in class com.opensourcewithslu.utilities.i2cConfiguration
-Sets the device
-
-setFrequencies(File) - Method in class com.opensourcewithslu.outputdevices.PassiveBuzzerHelper
-Allows users to pipe in a text file of frequencies separated by commas to play on the passive buzzer.
-
-setGreen(int) - Method in class com.opensourcewithslu.outputdevices.RGBLEDHelper
-Sets the green value of the LED.
-
-setGreen(int, int) - Method in class com.opensourcewithslu.outputdevices.RGBLEDHelper
-Sets the green value and frequency of the LED.
-
-setInital(int) - Method in class com.opensourcewithslu.utilities.PwmConfiguration
-Sets the initial state that the component will be in when first initialized.
-
-setInitial(DigitalState) - Method in class com.opensourcewithslu.utilities.DigitalOutputConfiguration
-Sets the initial state for the component.
-
-setInitials(String) - Method in class com.opensourcewithslu.utilities.MultiPinConfigs.PwmMultiPinConfiguration
-Sets the initial states for the component.
-
-setMode(SpiMode) - Method in class com.opensourcewithslu.utilities.SpiConfiguration
-Sets the SPI mode for the component.
-
-setName(String) - Method in class com.opensourcewithslu.utilities.DigitalInputConfiguration
-Sets the name of the component.
-
-setName(String) - Method in class com.opensourcewithslu.utilities.DigitalOutputConfiguration
-Sets the name of the component.
-
-setName(String) - Method in class com.opensourcewithslu.utilities.i2cConfiguration
-Sets the name of the component.
-
-setName(String) - Method in class com.opensourcewithslu.utilities.MultiPinConfigs.DigitalInputMultiPinConfiguration
-Sets the name of the component.
-
-setName(String) - Method in class com.opensourcewithslu.utilities.MultiPinConfigs.PwmMultiPinConfiguration
-Sets the name of the component.
-
-setName(String) - Method in class com.opensourcewithslu.utilities.PwmConfiguration
-Sets the name of the component.
-
-setName(String) - Method in class com.opensourcewithslu.utilities.SpiConfiguration
-Sets the name of the component.
-
-setProvider(String) - Method in class com.opensourcewithslu.utilities.DigitalInputConfiguration
-Sets the provider.
-
-setProvider(String) - Method in class com.opensourcewithslu.utilities.DigitalOutputConfiguration
-Sets the provider.
-
-setProvider(String) - Method in class com.opensourcewithslu.utilities.MultiPinConfigs.DigitalInputMultiPinConfiguration
-Sets the provider.
-
-setProvider(String) - Method in class com.opensourcewithslu.utilities.MultiPinConfigs.PwmMultiPinConfiguration
-Sets the provider.
-
-setProvider(String) - Method in class com.opensourcewithslu.utilities.PwmConfiguration
-Sets the provider of the component.
-
-setPull(PullResistance) - Method in class com.opensourcewithslu.utilities.DigitalInputConfiguration
-Sets the pull resistance for the component.
-
-setPulls(String) - Method in class com.opensourcewithslu.utilities.MultiPinConfigs.DigitalInputMultiPinConfiguration
-Sets all the pull resistance for the components.
-
-setPwmType(String) - Method in class com.opensourcewithslu.utilities.PwmConfiguration
-Sets the pwm type.
-
-setPwmTypes(String) - Method in class com.opensourcewithslu.utilities.MultiPinConfigs.PwmMultiPinConfiguration
-Sets the PWM types for the component.
-
-setRed(int) - Method in class com.opensourcewithslu.outputdevices.RGBLEDHelper
-Sets the red value of the LED.
-
-setRed(int, int) - Method in class com.opensourcewithslu.outputdevices.RGBLEDHelper
-Sets the red value and frequency of the LED.
-
-setShutdown(int) - Method in class com.opensourcewithslu.utilities.PwmConfiguration
-Sets the shutdown state for the component.
-
-setShutdown(DigitalState) - Method in class com.opensourcewithslu.utilities.DigitalOutputConfiguration
-Sets the shutdown state for the component.
-
-setShutdowns(String) - Method in class com.opensourcewithslu.utilities.MultiPinConfigs.PwmMultiPinConfiguration
-Sets the shutdown states for the component.
-
-setToLow() - Method in class com.opensourcewithslu.inputdevices.PhotoResistorHelper
-To set the Photo Resistor output to low for each event.
-
-SlideSwitchHelper - Class in com.opensourcewithslu.inputdevices
-The SlideSwitchHelper class is used to initialize a slide switch.
-
-SlideSwitchHelper(DigitalInput) - Constructor for class com.opensourcewithslu.inputdevices.SlideSwitchHelper
-SlideSwitchHelper constructor.
-
-SpiConfiguration - Class in com.opensourcewithslu.utilities
-This class handles the configuration of a SPI component.
-
-SpiConfiguration(String) - Constructor for class com.opensourcewithslu.utilities.SpiConfiguration
-The SpiConfiguration constructor.
-
-startMeasuring() - Method in class com.opensourcewithslu.inputdevices.UltraSonicSensorHelper
-Begins measuring distance from sensor calling triggerAndMeasureDistance function every 100 milliseconds
-
-stopMeasuring() - Method in class com.opensourcewithslu.inputdevices.UltraSonicSensorHelper
-Shuts down ultrasonic sensor
-
-switchState() - Method in class com.opensourcewithslu.outputdevices.LEDHelper
-Switches the state of the LED.
-
-
-T
-
-toneIterator() - Method in class com.opensourcewithslu.outputdevices.PassiveBuzzerHelper
-freChangeTest cycles through frequencies to verify that frequencies are changing
-
-TouchSwitchHelper - Class in com.opensourcewithslu.inputdevices
-The TouchSwitchHelper class is used to initialize a touch switch.
-
-TouchSwitchHelper(DigitalInput) - Constructor for class com.opensourcewithslu.inputdevices.TouchSwitchHelper
-TouchSwitchHelper constructor.
-
-
-U
-
-UltraSonicSensorHelper - Class in com.opensourcewithslu.inputdevices
-The UltraSonicSensorHelper class initializes the Ultra Sonic Sensor and provides component functionality
-
-UltraSonicSensorHelper(DigitalOutput, DigitalInput) - Constructor for class com.opensourcewithslu.inputdevices.UltraSonicSensorHelper
-Constructs a new UltraSonicSensorHelper instance.
-
-updateDark() - Method in class com.opensourcewithslu.inputdevices.PhotoResistorHelper
-Updates the darknessValue of the Photo Resistor.
-
-
-W
-
-writeText(String) - Method in class com.opensourcewithslu.outputdevices.LCD1602Helper
-Writes a String to the display.
-
-writeTextAtLine(String, int) - Method in class com.opensourcewithslu.outputdevices.LCD1602Helper
-Writes a String to the defined line.
-
-writeToCard(Object) - Method in class com.opensourcewithslu.inputdevices.RFidHelper
-Writes data to an RFID fob.
-
-
-A B C D G I L M P R S T U W All Classes and Interfaces | All Packages
-
-
Index (pi4micronaut-utils v1.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+A B C D G I L M P R S T U W All Classes and Interfaces | All Packages
+A
+
+actBuzzCheck - Variable in class com.opensourcewithslu.outputdevices.ActiveBuzzerHelper
+To check if the buzzer is active or not
+
+ActiveBuzzerHelper - Class in com.opensourcewithslu.outputdevices
+The ActiveBuzzerHelper class contains methods that pertain to the control of the active buzzer.
+
+ActiveBuzzerHelper(Pwm) - Constructor for class com.opensourcewithslu.outputdevices.ActiveBuzzerHelper
+BuzzerHelper constructor
+
+activeBuzzerOff() - Method in class com.opensourcewithslu.outputdevices.ActiveBuzzerHelper
+Turns the active buzzer off.
+
+activeBuzzerOn() - Method in class com.opensourcewithslu.outputdevices.ActiveBuzzerHelper
+Turns the active buzzer on by setting the duty cycle is 100 and frequency to 440hz.
+
+addEventListener(DigitalStateChangeListener) - Method in class com.opensourcewithslu.inputdevices.PhotoResistorHelper
+Adds an event listener to the Photo Resistor.
+
+addEventListener(DigitalStateChangeListener) - Method in class com.opensourcewithslu.inputdevices.PushButtonHelper
+Adds an EventListener to the PushButton.
+
+addEventListener(DigitalStateChangeListener) - Method in class com.opensourcewithslu.inputdevices.SlideSwitchHelper
+Adds an EvenListener to the slide switch.
+
+addEventListener(DigitalStateChangeListener) - Method in class com.opensourcewithslu.inputdevices.TouchSwitchHelper
+Adds an event listener to the touch switch.
+
+Application - Class in com.opensourcewithslu
+Runs the Micronaut framework in the Pi4Micronaut framework.
+
+Application() - Constructor for class com.opensourcewithslu.Application
+
+B
+
+beep() - Method in class com.opensourcewithslu.outputdevices.ActiveBuzzerHelper
+Beep powers on, plays a single tone from the active buzzer for 2 seconds then powers down.
+
+
+C
+
+clearDisplay() - Method in class com.opensourcewithslu.outputdevices.LCD1602Helper
+Clears the display of text.
+
+clearLine(int) - Method in class com.opensourcewithslu.outputdevices.LCD1602Helper
+Clears the text of the specified line.
+
+com.opensourcewithslu - package com.opensourcewithslu
+com.opensourcewithslu.inputdevices - package com.opensourcewithslu.inputdevices
+com.opensourcewithslu.outputdevices - package com.opensourcewithslu.outputdevices
+com.opensourcewithslu.utilities - package com.opensourcewithslu.utilities
+com.opensourcewithslu.utilities.MultiPinConfigs - package com.opensourcewithslu.utilities.MultiPinConfigs
+createDigitalInput(DigitalInputConfiguration, Context) - Method in class com.opensourcewithslu.utilities.Pi4JFactory
+Creates a DigitalInput object for digital input components.
+
+createDigitalOutput(DigitalOutputConfiguration, Context) - Method in class com.opensourcewithslu.utilities.Pi4JFactory
+Creates a DigitalOutput object for digital output components.
+
+createI2C(i2cConfiguration, Context) - Method in class com.opensourcewithslu.utilities.Pi4JFactory
+Creates an I2CConfigBuilder Object for components that are I2C.
+
+createPi4jContext() - Method in class com.opensourcewithslu.utilities.Pi4JFactory
+This creates the Pi4J Context that is used to create all the beans for the individual components.
+
+createPwm(PwmConfiguration, Context) - Method in class com.opensourcewithslu.utilities.Pi4JFactory
+Creates a PWM object for components that are pwm.
+
+createSpi(SpiConfiguration, Context) - Method in class com.opensourcewithslu.utilities.Pi4JFactory
+Creates an SpiConfigBuilder object for components that are SPI.
+
+
+D
+
+DigitalInputConfiguration - Class in com.opensourcewithslu.utilities
+This class handles the configuration of a digital input component.
+
+DigitalInputConfiguration(String) - Constructor for class com.opensourcewithslu.utilities.DigitalInputConfiguration
+Constructor for the DigitalInputConfiguration.
+
+DigitalInputMultiPinConfiguration - Class in com.opensourcewithslu.utilities.MultiPinConfigs
+This class handles the configuration of a digital input component that has multiple pins.
+
+DigitalInputMultiPinConfiguration(String) - Constructor for class com.opensourcewithslu.utilities.MultiPinConfigs.DigitalInputMultiPinConfiguration
+The DigitalInputMultiPinConfiguration constructor.
+
+DigitalOutputConfiguration - Class in com.opensourcewithslu.utilities
+This class handles the configuration of a digital output component.
+
+DigitalOutputConfiguration(String) - Constructor for class com.opensourcewithslu.utilities.DigitalOutputConfiguration
+The DigitalOutputConfiguration constructor.
+
+
+G
+
+getAddress() - Method in class com.opensourcewithslu.utilities.DigitalInputConfiguration
+Gets the pin address for the component.
+
+getAddress() - Method in class com.opensourcewithslu.utilities.DigitalOutputConfiguration
+Gets the pin address for the component.
+
+getAddress() - Method in class com.opensourcewithslu.utilities.PwmConfiguration
+Gets the pin address for the component.
+
+getAddresses() - Method in class com.opensourcewithslu.utilities.MultiPinConfigs.DigitalInputMultiPinConfiguration
+Gets the pin addresses for the component.
+
+getAddresses() - Method in class com.opensourcewithslu.utilities.MultiPinConfigs.PwmMultiPinConfiguration
+Gets the pin address for the component.
+
+getBaud() - Method in class com.opensourcewithslu.utilities.SpiConfiguration
+Gets the baud rate for the component.
+
+getBus() - Method in class com.opensourcewithslu.utilities.i2cConfiguration
+Gets the bus pin for the component.
+
+getChannel() - Method in class com.opensourcewithslu.utilities.SpiConfiguration
+Gets the channel for the component.
+
+getComponents() - Method in class com.opensourcewithslu.utilities.MultipinConfiguration
+Gets the components that are part of the overall component.
+
+getDark() - Method in class com.opensourcewithslu.inputdevices.PhotoResistorHelper
+getDebounce() - Method in class com.opensourcewithslu.utilities.DigitalInputConfiguration
+Gets the current debounce value for the component.
+
+getDebounces() - Method in class com.opensourcewithslu.utilities.MultiPinConfigs.DigitalInputMultiPinConfiguration
+Gets the current debounce values for the component.
+
+getDevice() - Method in class com.opensourcewithslu.utilities.i2cConfiguration
+Gets the device
+
+getEncoderValue() - Method in class com.opensourcewithslu.inputdevices.RotaryEncoderHelper
+Gets the value of the rotary encoder.
+
+getId() - Method in class com.opensourcewithslu.utilities.DigitalInputConfiguration
+Gets the id of the component.
+
+getId() - Method in class com.opensourcewithslu.utilities.DigitalOutputConfiguration
+Gets the id of the component.
+
+getId() - Method in class com.opensourcewithslu.utilities.i2cConfiguration
+Gets the id of the component.
+
+getId() - Method in class com.opensourcewithslu.utilities.MultiPinConfigs.DigitalInputMultiPinConfiguration
+Gets the id of the component.
+
+getId() - Method in class com.opensourcewithslu.utilities.MultiPinConfigs.PwmMultiPinConfiguration
+Gets the id of the component.
+
+getId() - Method in class com.opensourcewithslu.utilities.MultipinConfiguration
+Gets the id of the component.
+
+getId() - Method in class com.opensourcewithslu.utilities.PwmConfiguration
+Gets the id of the component.
+
+getId() - Method in class com.opensourcewithslu.utilities.SpiConfiguration
+Gets the id of the component.
+
+getInital() - Method in class com.opensourcewithslu.utilities.PwmConfiguration
+Gets the initial state that the component is in when first initialized.
+
+getInitals() - Method in class com.opensourcewithslu.utilities.MultiPinConfigs.PwmMultiPinConfiguration
+Gets the initial states that the component is in when first initialized.
+
+getInitial() - Method in class com.opensourcewithslu.utilities.DigitalOutputConfiguration
+Gets the initial state of the component.
+
+getMode() - Method in class com.opensourcewithslu.utilities.SpiConfiguration
+Gets the SPI mode for the component.
+
+getName() - Method in class com.opensourcewithslu.utilities.DigitalInputConfiguration
+Gets the name of the component.
+
+getName() - Method in class com.opensourcewithslu.utilities.DigitalOutputConfiguration
+Gets the name of the component.
+
+getName() - Method in class com.opensourcewithslu.utilities.i2cConfiguration
+Gets the name of the component.
+
+getName() - Method in class com.opensourcewithslu.utilities.MultiPinConfigs.DigitalInputMultiPinConfiguration
+Gets the name of the component.
+
+getName() - Method in class com.opensourcewithslu.utilities.MultiPinConfigs.PwmMultiPinConfiguration
+Gets the name of the component.
+
+getName() - Method in class com.opensourcewithslu.utilities.PwmConfiguration
+Gets the name of the component.
+
+getName() - Method in class com.opensourcewithslu.utilities.SpiConfiguration
+Gets the name of the component.
+
+getProvider() - Method in class com.opensourcewithslu.utilities.DigitalInputConfiguration
+Gets the provider for the component.
+
+getProvider() - Method in class com.opensourcewithslu.utilities.DigitalOutputConfiguration
+Gets the provider for the component.
+
+getProvider() - Method in class com.opensourcewithslu.utilities.MultiPinConfigs.DigitalInputMultiPinConfiguration
+Gets the provider for the component.
+
+getProvider() - Method in class com.opensourcewithslu.utilities.MultiPinConfigs.PwmMultiPinConfiguration
+Gets the provider for the component.
+
+getProvider() - Method in class com.opensourcewithslu.utilities.PwmConfiguration
+Gets the provider for the component.
+
+getPull() - Method in class com.opensourcewithslu.utilities.DigitalInputConfiguration
+Gets the pull resistance for the component.
+
+getPulls() - Method in class com.opensourcewithslu.utilities.MultiPinConfigs.DigitalInputMultiPinConfiguration
+Gets the pull resistance for the component.
+
+getPwmType() - Method in class com.opensourcewithslu.utilities.PwmConfiguration
+Gets the pwm type of the component.
+
+getPwmTypes() - Method in class com.opensourcewithslu.utilities.MultiPinConfigs.PwmMultiPinConfiguration
+Gets the PWM types of the component.
+
+getShutdown() - Method in class com.opensourcewithslu.utilities.DigitalOutputConfiguration
+Gets the shutdown state of the component.
+
+getShutdown() - Method in class com.opensourcewithslu.utilities.PwmConfiguration
+Gets the shutdown state for the component.
+
+getShutdowns() - Method in class com.opensourcewithslu.utilities.MultiPinConfigs.PwmMultiPinConfiguration
+Gets the shutdown states for the component.
+
+
+I
+
+i2cConfiguration - Class in com.opensourcewithslu.utilities
+This class handles the configuration of an I2C components.
+
+i2cConfiguration(String) - Constructor for class com.opensourcewithslu.utilities.i2cConfiguration
+The i2cConfiguration constructor.
+
+initialize() - Method in class com.opensourcewithslu.inputdevices.PhotoResistorHelper
+Initializes the Photo Resistor and calls the updateDarkness function for every half second.
+
+initialize() - Method in class com.opensourcewithslu.inputdevices.PushButtonHelper
+Initializes the PushButton.
+
+initialize() - Method in class com.opensourcewithslu.inputdevices.RotaryEncoderHelper
+Initializes the listener that keeps track of the rotary encoder's position.
+
+initialize() - Method in class com.opensourcewithslu.inputdevices.SlideSwitchHelper
+Initializes the listener that keeps track of whether the slide switch is high/low.
+
+initialize() - Method in class com.opensourcewithslu.inputdevices.TouchSwitchHelper
+Initializes the listener that keeps track of if the touch switch has been touched or not.
+
+initialize() - Method in class com.opensourcewithslu.inputdevices.UltrasoundSensorHelper
+intermittentTone() - Method in class com.opensourcewithslu.outputdevices.ActiveBuzzerHelper
+Intermittent tone will play a tone for a 20 seconds duration.
+
+isDark - Variable in class com.opensourcewithslu.inputdevices.PhotoResistorHelper
+To check if it is Dark.
+
+isOn - Variable in class com.opensourcewithslu.inputdevices.SlideSwitchHelper
+Shows if the slide switch is on.
+
+isPressed - Variable in class com.opensourcewithslu.inputdevices.PushButtonHelper
+Determines if the button is pressed.
+
+isTouched - Variable in class com.opensourcewithslu.inputdevices.TouchSwitchHelper
+Shows if the touch switch has been touched.
+
+
+L
+
+LCD1602Helper - Class in com.opensourcewithslu.outputdevices
+This helper class, LCD1602Helper, is for controlling and interacting with an I2C LCD1602 display.
+
+LCD1602Helper(I2CConfig, Context) - Constructor for class com.opensourcewithslu.outputdevices.LCD1602Helper
+The LCD1602Helper constructor.
+
+LEDHelper - Class in com.opensourcewithslu.outputdevices
+The class LEDHelper contains methods that pertain to the control of a LED.
+
+LEDHelper(DigitalOutput) - Constructor for class com.opensourcewithslu.outputdevices.LEDHelper
+LEGHelper constructor.
+
+ledOff() - Method in class com.opensourcewithslu.outputdevices.LEDHelper
+Turns off the LED by setting the DigitalOutput object to low.
+
+ledOff() - Method in class com.opensourcewithslu.outputdevices.RGBLEDHelper
+Turns off the RGB LED.
+
+ledOn() - Method in class com.opensourcewithslu.outputdevices.LEDHelper
+Turns on the LED by setting the DigitalOutput object to high.
+
+ledOn() - Method in class com.opensourcewithslu.outputdevices.RGBLEDHelper
+Turns on the RGB LED with default RGB values of 100,100,100 and frequencies of 200 Hertz.
+
+
+M
+
+main(String[]) - Static method in class com.opensourcewithslu.Application
+constructor
+
+morseCodeTone() - Method in class com.opensourcewithslu.outputdevices.ActiveBuzzerHelper
+Uses the active buzzer on and off function to beep the word pi in morse code.
+
+MultipinConfiguration - Class in com.opensourcewithslu.utilities
+Class for configuring multipin components.
+
+MultipinConfiguration(String, Object[]) - Constructor for class com.opensourcewithslu.utilities.MultipinConfiguration
+The MultipinConfiguration constructor.
+
+multiPinInput(DigitalInputMultiPinConfiguration, Context) - Method in class com.opensourcewithslu.utilities.Pi4JMultipinFactory
+Creates a MultipinConfiguration object for a multi pin digital input component.
+
+multiPinPwm(PwmMultiPinConfiguration, Context) - Method in class com.opensourcewithslu.utilities.Pi4JMultipinFactory
+Creates a MultipinConfiguration object for a multi pin pwm component.
+
+
+P
+
+PhotoResistorHelper - Class in com.opensourcewithslu.inputdevices
+The PhotoResistorHelper class is used to work with the functionalities of a Photo Resistor.
+
+PhotoResistorHelper(DigitalInput, DigitalOutput) - Constructor for class com.opensourcewithslu.inputdevices.PhotoResistorHelper
+TouchSwitchHelper constructor.
+
+Pi4JFactory - Class in com.opensourcewithslu.utilities
+The Pi4JFactory class is responsible for creating all the beans for components that are being used.
+
+Pi4JFactory() - Constructor for class com.opensourcewithslu.utilities.Pi4JFactory
+Pi4JMultipinFactory - Class in com.opensourcewithslu.utilities
+The Pi4JMultipinFactory class is responsible for creating all the beans for all multi pin components that are being used.
+
+Pi4JMultipinFactory() - Constructor for class com.opensourcewithslu.utilities.Pi4JMultipinFactory
+PushButtonHelper - Class in com.opensourcewithslu.inputdevices
+The PushButtonHelper class is used to create a listener that determines when a 4 pin button is pressed.
+
+PushButtonHelper(DigitalInput) - Constructor for class com.opensourcewithslu.inputdevices.PushButtonHelper
+The PushButtonHelper constructor.
+
+PwmConfiguration - Class in com.opensourcewithslu.utilities
+The PwmConfiguration class handles the configuration of a pwm component.
+
+PwmConfiguration(String) - Constructor for class com.opensourcewithslu.utilities.PwmConfiguration
+PwmConfiguration constructor.
+
+PwmMultiPinConfiguration - Class in com.opensourcewithslu.utilities.MultiPinConfigs
+This class handles the configuration of a PWM device that has multiple pins.
+
+PwmMultiPinConfiguration(String) - Constructor for class com.opensourcewithslu.utilities.MultiPinConfigs.PwmMultiPinConfiguration
+The PwmMultiPinConfiguration constructor.
+
+
+R
+
+readFromCard() - Method in class com.opensourcewithslu.inputdevices.RFidHelper
+When called, this method waits for any RFID card/fob to be scanned.
+
+removeEventListener() - Method in class com.opensourcewithslu.inputdevices.PhotoResistorHelper
+Removes the event listener from the Photo Resistor.
+
+removeEventListener() - Method in class com.opensourcewithslu.inputdevices.TouchSwitchHelper
+Removes the event listener from the touch switch.
+
+removeEventListener(DigitalStateChangeListener) - Method in class com.opensourcewithslu.inputdevices.PushButtonHelper
+Removes an EvenListener from the button.
+
+removeEventListener(DigitalStateChangeListener) - Method in class com.opensourcewithslu.inputdevices.SlideSwitchHelper
+Removes the EventListener from the slide switch.
+
+resetScanner() - Method in class com.opensourcewithslu.inputdevices.RFidHelper
+Resets the RFID scanner.
+
+RFidHelper - Class in com.opensourcewithslu.inputdevices
+The RFIDHelper class is for interacting with an RFID scanner.
+
+RFidHelper(SpiConfig, int, Context) - Constructor for class com.opensourcewithslu.inputdevices.RFidHelper
+The RFidHelper constructor WITH the reset pin as a parameter.
+
+RFidHelper(SpiConfig, Context) - Constructor for class com.opensourcewithslu.inputdevices.RFidHelper
+The RFidHelper constructor WITHOUT the reset pin as a parameter.
+
+RGBLEDHelper - Class in com.opensourcewithslu.outputdevices
+The RBGLEDHelper class handles all interactions with a RGB LED.
+
+RGBLEDHelper(MultipinConfiguration) - Constructor for class com.opensourcewithslu.outputdevices.RGBLEDHelper
+The RGBLEDHelper constructor.
+
+RotaryEncoderHelper - Class in com.opensourcewithslu.inputdevices
+The RotaryEncoderHelper class initializes a rotary encoder component and returns the value of the encoder when called upon.
+
+RotaryEncoderHelper(MultipinConfiguration) - Constructor for class com.opensourcewithslu.inputdevices.RotaryEncoderHelper
+The RotaryEncoderHelper constructor.
+
+
+S
+
+setAddress(int) - Method in class com.opensourcewithslu.utilities.DigitalInputConfiguration
+Sets the pin address.
+
+setAddress(int) - Method in class com.opensourcewithslu.utilities.DigitalOutputConfiguration
+Sets the pin address.
+
+setAddress(int) - Method in class com.opensourcewithslu.utilities.PwmConfiguration
+Sets a new pin address for the component.
+
+setAddresses(String) - Method in class com.opensourcewithslu.utilities.MultiPinConfigs.DigitalInputMultiPinConfiguration
+Sets the pin addresses for the component.
+
+setAddresses(String) - Method in class com.opensourcewithslu.utilities.MultiPinConfigs.PwmMultiPinConfiguration
+Sets the pin addresses for the component.
+
+setBackLight(boolean) - Method in class com.opensourcewithslu.outputdevices.LCD1602Helper
+Setting the backlight state of the LCD based off the boolean input.
+
+setBaud(int) - Method in class com.opensourcewithslu.utilities.SpiConfiguration
+Sets the baud rate for the component.
+
+setBlue(int) - Method in class com.opensourcewithslu.outputdevices.RGBLEDHelper
+Sets the blue value of the LED.
+
+setBlue(int, int) - Method in class com.opensourcewithslu.outputdevices.RGBLEDHelper
+Sets the blue value and frequency of the LED.
+
+setBus(int) - Method in class com.opensourcewithslu.utilities.i2cConfiguration
+Sets the bus pin
+
+setChannel(int) - Method in class com.opensourcewithslu.utilities.SpiConfiguration
+Sets a new channel for the component.
+
+setColor(int[]) - Method in class com.opensourcewithslu.outputdevices.RGBLEDHelper
+Sets the color of the LED based of inputted RGB values.
+
+setColor(int[], int[]) - Method in class com.opensourcewithslu.outputdevices.RGBLEDHelper
+Sets the color of the LED using the array of RGB values and an array of frequencies.
+
+setColorHex(String) - Method in class com.opensourcewithslu.outputdevices.RGBLEDHelper
+Setting the color of the LED using a hexadecimal value.
+
+setColorHex(String, int[]) - Method in class com.opensourcewithslu.outputdevices.RGBLEDHelper
+Setting the color of the LED using a hexadecimal value and an array of frequencies.
+
+setDarknessThreshold(int) - Method in class com.opensourcewithslu.inputdevices.PhotoResistorHelper
+To set a threshold for Photo Resistor.
+
+setDebounce(Long) - Method in class com.opensourcewithslu.utilities.DigitalInputConfiguration
+Sets the debounce of the component.
+
+setDebounces(String) - Method in class com.opensourcewithslu.utilities.MultiPinConfigs.DigitalInputMultiPinConfiguration
+Sets the debounces for the component.
+
+setDevice(int) - Method in class com.opensourcewithslu.utilities.i2cConfiguration
+Sets the device
+
+setGreen(int) - Method in class com.opensourcewithslu.outputdevices.RGBLEDHelper
+Sets the green value of the LED.
+
+setGreen(int, int) - Method in class com.opensourcewithslu.outputdevices.RGBLEDHelper
+Sets the green value and frequency of the LED.
+
+setInital(int) - Method in class com.opensourcewithslu.utilities.PwmConfiguration
+Sets the initial state that the component will be in when first initialized.
+
+setInitial(DigitalState) - Method in class com.opensourcewithslu.utilities.DigitalOutputConfiguration
+Sets the initial state for the component.
+
+setInitials(String) - Method in class com.opensourcewithslu.utilities.MultiPinConfigs.PwmMultiPinConfiguration
+Sets the initial states for the component.
+
+setMode(SpiMode) - Method in class com.opensourcewithslu.utilities.SpiConfiguration
+Sets the SPI mode for the component.
+
+setName(String) - Method in class com.opensourcewithslu.utilities.DigitalInputConfiguration
+Sets the name of the component.
+
+setName(String) - Method in class com.opensourcewithslu.utilities.DigitalOutputConfiguration
+Sets the name of the component.
+
+setName(String) - Method in class com.opensourcewithslu.utilities.i2cConfiguration
+Sets the name of the component.
+
+setName(String) - Method in class com.opensourcewithslu.utilities.MultiPinConfigs.DigitalInputMultiPinConfiguration
+Sets the name of the component.
+
+setName(String) - Method in class com.opensourcewithslu.utilities.MultiPinConfigs.PwmMultiPinConfiguration
+Sets the name of the component.
+
+setName(String) - Method in class com.opensourcewithslu.utilities.PwmConfiguration
+Sets the name of the component.
+
+setName(String) - Method in class com.opensourcewithslu.utilities.SpiConfiguration
+Sets the name of the component.
+
+setProvider(String) - Method in class com.opensourcewithslu.utilities.DigitalInputConfiguration
+Sets the provider.
+
+setProvider(String) - Method in class com.opensourcewithslu.utilities.DigitalOutputConfiguration
+Sets the provider.
+
+setProvider(String) - Method in class com.opensourcewithslu.utilities.MultiPinConfigs.DigitalInputMultiPinConfiguration
+Sets the provider.
+
+setProvider(String) - Method in class com.opensourcewithslu.utilities.MultiPinConfigs.PwmMultiPinConfiguration
+Sets the provider.
+
+setProvider(String) - Method in class com.opensourcewithslu.utilities.PwmConfiguration
+Sets the provider of the component.
+
+setPull(PullResistance) - Method in class com.opensourcewithslu.utilities.DigitalInputConfiguration
+Sets the pull resistance for the component.
+
+setPulls(String) - Method in class com.opensourcewithslu.utilities.MultiPinConfigs.DigitalInputMultiPinConfiguration
+Sets all the pull resistance for the components.
+
+setPwmType(String) - Method in class com.opensourcewithslu.utilities.PwmConfiguration
+Sets the pwm type.
+
+setPwmTypes(String) - Method in class com.opensourcewithslu.utilities.MultiPinConfigs.PwmMultiPinConfiguration
+Sets the PWM types for the component.
+
+setRed(int) - Method in class com.opensourcewithslu.outputdevices.RGBLEDHelper
+Sets the red value of the LED.
+
+setRed(int, int) - Method in class com.opensourcewithslu.outputdevices.RGBLEDHelper
+Sets the red value and frequency of the LED.
+
+setShutdown(int) - Method in class com.opensourcewithslu.utilities.PwmConfiguration
+Sets the shutdown state for the component.
+
+setShutdown(DigitalState) - Method in class com.opensourcewithslu.utilities.DigitalOutputConfiguration
+Sets the shutdown state for the component.
+
+setShutdowns(String) - Method in class com.opensourcewithslu.utilities.MultiPinConfigs.PwmMultiPinConfiguration
+Sets the shutdown states for the component.
+
+setToLow() - Method in class com.opensourcewithslu.inputdevices.PhotoResistorHelper
+To set the Photo Resistor output to low for each event.
+
+SlideSwitchHelper - Class in com.opensourcewithslu.inputdevices
+The SlideSwitchHelper class is used to initialize a slide switch.
+
+SlideSwitchHelper(DigitalInput) - Constructor for class com.opensourcewithslu.inputdevices.SlideSwitchHelper
+SlideSwitchHelper constructor.
+
+SpiConfiguration - Class in com.opensourcewithslu.utilities
+This class handles the configuration of a SPI component.
+
+SpiConfiguration(String) - Constructor for class com.opensourcewithslu.utilities.SpiConfiguration
+The SpiConfiguration constructor.
+
+switchState() - Method in class com.opensourcewithslu.outputdevices.LEDHelper
+Switches the state of the LED.
+
+
+T
+
+TouchSwitchHelper - Class in com.opensourcewithslu.inputdevices
+The TouchSwitchHelper class is used to initialize a touch switch.
+
+TouchSwitchHelper(DigitalInput) - Constructor for class com.opensourcewithslu.inputdevices.TouchSwitchHelper
+TouchSwitchHelper constructor.
+
+
+U
+
+UltrasoundSensorHelper - Class in com.opensourcewithslu.inputdevices
+UltrasoundSensorHelper(DigitalInput, DigitalOutput) - Constructor for class com.opensourcewithslu.inputdevices.UltrasoundSensorHelper
+updateDark() - Method in class com.opensourcewithslu.inputdevices.PhotoResistorHelper
+Updates the darknessValue of the Photo Resistor.
+
+updateDistance() - Method in class com.opensourcewithslu.inputdevices.UltrasoundSensorHelper
+
+W
+
+writeText(String) - Method in class com.opensourcewithslu.outputdevices.LCD1602Helper
+Writes a String to the display.
+
+writeTextAtLine(String, int) - Method in class com.opensourcewithslu.outputdevices.LCD1602Helper
+Writes a String to the defined line.
+
+writeToCard(Object) - Method in class com.opensourcewithslu.inputdevices.RFidHelper
+Writes data to an RFID fob.
+
+
+A B C D G I L M P R S T U W All Classes and Interfaces | All Packages
+
+
Overview (pi4micronaut-utils v1.0 API)
-
-JavaScript is disabled on your browser.
-
-
-
-
-
-
-
-
Packages
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
Overview (pi4micronaut-utils v1.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
+
+
+
+
Packages
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
pi4micronaut-utils v1.0 API
-
-
-
-
-
-
-JavaScript is disabled on your browser.
-
-index.html
-
-
-
+
+
+
+
+pi4micronaut-utils v1.0 API
+
+
+
+
+
+
+JavaScript is disabled on your browser.
+
+index.html
+
+
+
diff --git a/pi4micronaut-utils/src/docs/javadoc/overview-tree.html b/pi4micronaut-utils/src/docs/javadoc/overview-tree.html
index 6ade6aaa..c8c9af2c 100644
--- a/pi4micronaut-utils/src/docs/javadoc/overview-tree.html
+++ b/pi4micronaut-utils/src/docs/javadoc/overview-tree.html
@@ -1,97 +1,95 @@
-
-
-
-
-Class Hierarchy (pi4micronaut-utils v1.0 API)
-
-JavaScript is disabled on your browser.
-
-
-
-
-
-
-Package Hierarchies:
-
-
-
-
-
Class Hierarchy (pi4micronaut-utils v1.0 API)
+
+JavaScript is disabled on your browser.
+
+
+
+
diff --git a/pi4micronaut-utils/src/docs/javadoc/script-dir/jquery-ui.min.css b/pi4micronaut-utils/src/docs/javadoc/script-dir/jquery-ui.min.css
index 693327f0..d64539cb 100644
--- a/pi4micronaut-utils/src/docs/javadoc/script-dir/jquery-ui.min.css
+++ b/pi4micronaut-utils/src/docs/javadoc/script-dir/jquery-ui.min.css
@@ -1,4 +1,4 @@
-/*! jQuery UI - v1.13.2 - 2023-02-27
+/*! jQuery UI - v1.13.1 - 2022-05-12
* http://jqueryui.com
* Includes: core.css, autocomplete.css, menu.css
* Copyright jQuery Foundation and other contributors; Licensed MIT */
diff --git a/pi4micronaut-utils/src/docs/javadoc/script-dir/jquery-ui.min.js b/pi4micronaut-utils/src/docs/javadoc/script-dir/jquery-ui.min.js
index 8166a15e..55c28329 100644
--- a/pi4micronaut-utils/src/docs/javadoc/script-dir/jquery-ui.min.js
+++ b/pi4micronaut-utils/src/docs/javadoc/script-dir/jquery-ui.min.js
@@ -1,6 +1,6 @@
-/*! jQuery UI - v1.13.2 - 2023-02-27
+/*! jQuery UI - v1.13.1 - 2022-05-12
* http://jqueryui.com
* Includes: widget.js, position.js, keycode.js, unique-id.js, widgets/autocomplete.js, widgets/menu.js
* Copyright jQuery Foundation and other contributors; Licensed MIT */
-!function(t){"use strict";"function"==typeof define&&define.amd?define(["jquery"],t):t(jQuery)}(function(x){"use strict";x.ui=x.ui||{};x.ui.version="1.13.2";var n,i=0,l=Array.prototype.hasOwnProperty,a=Array.prototype.slice;x.cleanData=(n=x.cleanData,function(t){for(var e,i,s=0;null!=(i=t[s]);s++)(e=x._data(i,"events"))&&e.remove&&x(i).triggerHandler("remove");n(t)}),x.widget=function(t,i,e){var s,n,o,l={},a=t.split(".")[0],r=a+"-"+(t=t.split(".")[1]);return e||(e=i,i=x.Widget),Array.isArray(e)&&(e=x.extend.apply(null,[{}].concat(e))),x.expr.pseudos[r.toLowerCase()]=function(t){return!!x.data(t,r)},x[a]=x[a]||{},s=x[a][t],n=x[a][t]=function(t,e){if(!this||!this._createWidget)return new n(t,e);arguments.length&&this._createWidget(t,e)},x.extend(n,s,{version:e.version,_proto:x.extend({},e),_childConstructors:[]}),(o=new i).options=x.widget.extend({},o.options),x.each(e,function(e,s){function n(){return i.prototype[e].apply(this,arguments)}function o(t){return i.prototype[e].apply(this,t)}l[e]="function"==typeof s?function(){var t,e=this._super,i=this._superApply;return this._super=n,this._superApply=o,t=s.apply(this,arguments),this._super=e,this._superApply=i,t}:s}),n.prototype=x.widget.extend(o,{widgetEventPrefix:s&&o.widgetEventPrefix||t},l,{constructor:n,namespace:a,widgetName:t,widgetFullName:r}),s?(x.each(s._childConstructors,function(t,e){var i=e.prototype;x.widget(i.namespace+"."+i.widgetName,n,e._proto)}),delete s._childConstructors):i._childConstructors.push(n),x.widget.bridge(t,n),n},x.widget.extend=function(t){for(var e,i,s=a.call(arguments,1),n=0,o=s.length;n",options:{classes:{},disabled:!1,create:null},_createWidget:function(t,e){e=x(e||this.defaultElement||this)[0],this.element=x(e),this.uuid=i++,this.eventNamespace="."+this.widgetName+this.uuid,this.bindings=x(),this.hoverable=x(),this.focusable=x(),this.classesElementLookup={},e!==this&&(x.data(e,this.widgetFullName,this),this._on(!0,this.element,{remove:function(t){t.target===e&&this.destroy()}}),this.document=x(e.style?e.ownerDocument:e.document||e),this.window=x(this.document[0].defaultView||this.document[0].parentWindow)),this.options=x.widget.extend({},this.options,this._getCreateOptions(),t),this._create(),this.options.disabled&&this._setOptionDisabled(this.options.disabled),this._trigger("create",null,this._getCreateEventData()),this._init()},_getCreateOptions:function(){return{}},_getCreateEventData:x.noop,_create:x.noop,_init:x.noop,destroy:function(){var i=this;this._destroy(),x.each(this.classesElementLookup,function(t,e){i._removeClass(e,t)}),this.element.off(this.eventNamespace).removeData(this.widgetFullName),this.widget().off(this.eventNamespace).removeAttr("aria-disabled"),this.bindings.off(this.eventNamespace)},_destroy:x.noop,widget:function(){return this.element},option:function(t,e){var i,s,n,o=t;if(0===arguments.length)return x.widget.extend({},this.options);if("string"==typeof t)if(o={},t=(i=t.split(".")).shift(),i.length){for(s=o[t]=x.widget.extend({},this.options[t]),n=0;n
"),i=e.children()[0];return x("body").append(e),t=i.offsetWidth,e.css("overflow","scroll"),t===(i=i.offsetWidth)&&(i=e[0].clientWidth),e.remove(),s=t-i},getScrollInfo:function(t){var e=t.isWindow||t.isDocument?"":t.element.css("overflow-x"),i=t.isWindow||t.isDocument?"":t.element.css("overflow-y"),e="scroll"===e||"auto"===e&&t.widthC(E(s),E(n))?o.important="horizontal":o.important="vertical",c.using.call(this,t,o)}),l.offset(x.extend(u,{using:t}))})},x.ui.position={fit:{left:function(t,e){var i=e.within,s=i.isWindow?i.scrollLeft:i.offset.left,n=i.width,o=t.left-e.collisionPosition.marginLeft,l=s-o,a=o+e.collisionWidth-n-s;e.collisionWidth>n?0n?0",delay:300,options:{icons:{submenu:"ui-icon-caret-1-e"},items:"> *",menus:"ul",position:{my:"left top",at:"right top"},role:"menu",blur:null,focus:null,select:null},_create:function(){this.activeMenu=this.element,this.mouseHandled=!1,this.lastMousePosition={x:null,y:null},this.element.uniqueId().attr({role:this.options.role,tabIndex:0}),this._addClass("ui-menu","ui-widget ui-widget-content"),this._on({"mousedown .ui-menu-item":function(t){t.preventDefault(),this._activateItem(t)},"click .ui-menu-item":function(t){var e=x(t.target),i=x(x.ui.safeActiveElement(this.document[0]));!this.mouseHandled&&e.not(".ui-state-disabled").length&&(this.select(t),t.isPropagationStopped()||(this.mouseHandled=!0),e.has(".ui-menu").length?this.expand(t):!this.element.is(":focus")&&i.closest(".ui-menu").length&&(this.element.trigger("focus",[!0]),this.active&&1===this.active.parents(".ui-menu").length&&clearTimeout(this.timer)))},"mouseenter .ui-menu-item":"_activateItem","mousemove .ui-menu-item":"_activateItem",mouseleave:"collapseAll","mouseleave .ui-menu":"collapseAll",focus:function(t,e){var i=this.active||this._menuItems().first();e||this.focus(t,i)},blur:function(t){this._delay(function(){x.contains(this.element[0],x.ui.safeActiveElement(this.document[0]))||this.collapseAll(t)})},keydown:"_keydown"}),this.refresh(),this._on(this.document,{click:function(t){this._closeOnDocumentClick(t)&&this.collapseAll(t,!0),this.mouseHandled=!1}})},_activateItem:function(t){var e,i;this.previousFilter||t.clientX===this.lastMousePosition.x&&t.clientY===this.lastMousePosition.y||(this.lastMousePosition={x:t.clientX,y:t.clientY},e=x(t.target).closest(".ui-menu-item"),i=x(t.currentTarget),e[0]===i[0]&&(i.is(".ui-state-active")||(this._removeClass(i.siblings().children(".ui-state-active"),null,"ui-state-active"),this.focus(t,i))))},_destroy:function(){var t=this.element.find(".ui-menu-item").removeAttr("role aria-disabled").children(".ui-menu-item-wrapper").removeUniqueId().removeAttr("tabIndex role aria-haspopup");this.element.removeAttr("aria-activedescendant").find(".ui-menu").addBack().removeAttr("role aria-labelledby aria-expanded aria-hidden aria-disabled tabIndex").removeUniqueId().show(),t.children().each(function(){var t=x(this);t.data("ui-menu-submenu-caret")&&t.remove()})},_keydown:function(t){var e,i,s,n=!0;switch(t.keyCode){case x.ui.keyCode.PAGE_UP:this.previousPage(t);break;case x.ui.keyCode.PAGE_DOWN:this.nextPage(t);break;case x.ui.keyCode.HOME:this._move("first","first",t);break;case x.ui.keyCode.END:this._move("last","last",t);break;case x.ui.keyCode.UP:this.previous(t);break;case x.ui.keyCode.DOWN:this.next(t);break;case x.ui.keyCode.LEFT:this.collapse(t);break;case x.ui.keyCode.RIGHT:this.active&&!this.active.is(".ui-state-disabled")&&this.expand(t);break;case x.ui.keyCode.ENTER:case x.ui.keyCode.SPACE:this._activate(t);break;case x.ui.keyCode.ESCAPE:this.collapse(t);break;default:e=this.previousFilter||"",s=n=!1,i=96<=t.keyCode&&t.keyCode<=105?(t.keyCode-96).toString():String.fromCharCode(t.keyCode),clearTimeout(this.filterTimer),i===e?s=!0:i=e+i,e=this._filterMenuItems(i),(e=s&&-1!==e.index(this.active.next())?this.active.nextAll(".ui-menu-item"):e).length||(i=String.fromCharCode(t.keyCode),e=this._filterMenuItems(i)),e.length?(this.focus(t,e),this.previousFilter=i,this.filterTimer=this._delay(function(){delete this.previousFilter},1e3)):delete this.previousFilter}n&&t.preventDefault()},_activate:function(t){this.active&&!this.active.is(".ui-state-disabled")&&(this.active.children("[aria-haspopup='true']").length?this.expand(t):this.select(t))},refresh:function(){var t,e,s=this,n=this.options.icons.submenu,i=this.element.find(this.options.menus);this._toggleClass("ui-menu-icons",null,!!this.element.find(".ui-icon").length),e=i.filter(":not(.ui-menu)").hide().attr({role:this.options.role,"aria-hidden":"true","aria-expanded":"false"}).each(function(){var t=x(this),e=t.prev(),i=x("").data("ui-menu-submenu-caret",!0);s._addClass(i,"ui-menu-icon","ui-icon "+n),e.attr("aria-haspopup","true").prepend(i),t.attr("aria-labelledby",e.attr("id"))}),this._addClass(e,"ui-menu","ui-widget ui-widget-content ui-front"),(t=i.add(this.element).find(this.options.items)).not(".ui-menu-item").each(function(){var t=x(this);s._isDivider(t)&&s._addClass(t,"ui-menu-divider","ui-widget-content")}),i=(e=t.not(".ui-menu-item, .ui-menu-divider")).children().not(".ui-menu").uniqueId().attr({tabIndex:-1,role:this._itemRole()}),this._addClass(e,"ui-menu-item")._addClass(i,"ui-menu-item-wrapper"),t.filter(".ui-state-disabled").attr("aria-disabled","true"),this.active&&!x.contains(this.element[0],this.active[0])&&this.blur()},_itemRole:function(){return{menu:"menuitem",listbox:"option"}[this.options.role]},_setOption:function(t,e){var i;"icons"===t&&(i=this.element.find(".ui-menu-icon"),this._removeClass(i,null,this.options.icons.submenu)._addClass(i,null,e.submenu)),this._super(t,e)},_setOptionDisabled:function(t){this._super(t),this.element.attr("aria-disabled",String(t)),this._toggleClass(null,"ui-state-disabled",!!t)},focus:function(t,e){var i;this.blur(t,t&&"focus"===t.type),this._scrollIntoView(e),this.active=e.first(),i=this.active.children(".ui-menu-item-wrapper"),this._addClass(i,null,"ui-state-active"),this.options.role&&this.element.attr("aria-activedescendant",i.attr("id")),i=this.active.parent().closest(".ui-menu-item").children(".ui-menu-item-wrapper"),this._addClass(i,null,"ui-state-active"),t&&"keydown"===t.type?this._close():this.timer=this._delay(function(){this._close()},this.delay),(i=e.children(".ui-menu")).length&&t&&/^mouse/.test(t.type)&&this._startOpening(i),this.activeMenu=e.parent(),this._trigger("focus",t,{item:e})},_scrollIntoView:function(t){var e,i,s;this._hasScroll()&&(i=parseFloat(x.css(this.activeMenu[0],"borderTopWidth"))||0,s=parseFloat(x.css(this.activeMenu[0],"paddingTop"))||0,e=t.offset().top-this.activeMenu.offset().top-i-s,i=this.activeMenu.scrollTop(),s=this.activeMenu.height(),t=t.outerHeight(),e<0?this.activeMenu.scrollTop(i+e):s",options:{appendTo:null,autoFocus:!1,delay:300,minLength:1,position:{my:"left top",at:"left bottom",collision:"none"},source:null,change:null,close:null,focus:null,open:null,response:null,search:null,select:null},requestIndex:0,pending:0,liveRegionTimer:null,_create:function(){var i,s,n,t=this.element[0].nodeName.toLowerCase(),e="textarea"===t,t="input"===t;this.isMultiLine=e||!t&&this._isContentEditable(this.element),this.valueMethod=this.element[e||t?"val":"text"],this.isNewMenu=!0,this._addClass("ui-autocomplete-input"),this.element.attr("autocomplete","off"),this._on(this.element,{keydown:function(t){if(this.element.prop("readOnly"))s=n=i=!0;else{s=n=i=!1;var e=x.ui.keyCode;switch(t.keyCode){case e.PAGE_UP:i=!0,this._move("previousPage",t);break;case e.PAGE_DOWN:i=!0,this._move("nextPage",t);break;case e.UP:i=!0,this._keyEvent("previous",t);break;case e.DOWN:i=!0,this._keyEvent("next",t);break;case e.ENTER:this.menu.active&&(i=!0,t.preventDefault(),this.menu.select(t));break;case e.TAB:this.menu.active&&this.menu.select(t);break;case e.ESCAPE:this.menu.element.is(":visible")&&(this.isMultiLine||this._value(this.term),this.close(t),t.preventDefault());break;default:s=!0,this._searchTimeout(t)}}},keypress:function(t){if(i)return i=!1,void(this.isMultiLine&&!this.menu.element.is(":visible")||t.preventDefault());if(!s){var e=x.ui.keyCode;switch(t.keyCode){case e.PAGE_UP:this._move("previousPage",t);break;case e.PAGE_DOWN:this._move("nextPage",t);break;case e.UP:this._keyEvent("previous",t);break;case e.DOWN:this._keyEvent("next",t)}}},input:function(t){if(n)return n=!1,void t.preventDefault();this._searchTimeout(t)},focus:function(){this.selectedItem=null,this.previous=this._value()},blur:function(t){clearTimeout(this.searching),this.close(t),this._change(t)}}),this._initSource(),this.menu=x("").appendTo(this._appendTo()).menu({role:null}).hide().attr({unselectable:"on"}).menu("instance"),this._addClass(this.menu.element,"ui-autocomplete","ui-front"),this._on(this.menu.element,{mousedown:function(t){t.preventDefault()},menufocus:function(t,e){var i,s;if(this.isNewMenu&&(this.isNewMenu=!1,t.originalEvent&&/^mouse/.test(t.originalEvent.type)))return this.menu.blur(),void this.document.one("mousemove",function(){x(t.target).trigger(t.originalEvent)});s=e.item.data("ui-autocomplete-item"),!1!==this._trigger("focus",t,{item:s})&&t.originalEvent&&/^key/.test(t.originalEvent.type)&&this._value(s.value),(i=e.item.attr("aria-label")||s.value)&&String.prototype.trim.call(i).length&&(clearTimeout(this.liveRegionTimer),this.liveRegionTimer=this._delay(function(){this.liveRegion.html(x("").text(i))},100))},menuselect:function(t,e){var i=e.item.data("ui-autocomplete-item"),s=this.previous;this.element[0]!==x.ui.safeActiveElement(this.document[0])&&(this.element.trigger("focus"),this.previous=s,this._delay(function(){this.previous=s,this.selectedItem=i})),!1!==this._trigger("select",t,{item:i})&&this._value(i.value),this.term=this._value(),this.close(t),this.selectedItem=i}}),this.liveRegion=x("
",{role:"status","aria-live":"assertive","aria-relevant":"additions"}).appendTo(this.document[0].body),this._addClass(this.liveRegion,null,"ui-helper-hidden-accessible"),this._on(this.window,{beforeunload:function(){this.element.removeAttr("autocomplete")}})},_destroy:function(){clearTimeout(this.searching),this.element.removeAttr("autocomplete"),this.menu.element.remove(),this.liveRegion.remove()},_setOption:function(t,e){this._super(t,e),"source"===t&&this._initSource(),"appendTo"===t&&this.menu.element.appendTo(this._appendTo()),"disabled"===t&&e&&this.xhr&&this.xhr.abort()},_isEventTargetInWidget:function(t){var e=this.menu.element[0];return t.target===this.element[0]||t.target===e||x.contains(e,t.target)},_closeOnClickOutside:function(t){this._isEventTargetInWidget(t)||this.close()},_appendTo:function(){var t=this.options.appendTo;return t=!(t=!(t=t&&(t.jquery||t.nodeType?x(t):this.document.find(t).eq(0)))||!t[0]?this.element.closest(".ui-front, dialog"):t).length?this.document[0].body:t},_initSource:function(){var i,s,n=this;Array.isArray(this.options.source)?(i=this.options.source,this.source=function(t,e){e(x.ui.autocomplete.filter(i,t.term))}):"string"==typeof this.options.source?(s=this.options.source,this.source=function(t,e){n.xhr&&n.xhr.abort(),n.xhr=x.ajax({url:s,data:t,dataType:"json",success:function(t){e(t)},error:function(){e([])}})}):this.source=this.options.source},_searchTimeout:function(s){clearTimeout(this.searching),this.searching=this._delay(function(){var t=this.term===this._value(),e=this.menu.element.is(":visible"),i=s.altKey||s.ctrlKey||s.metaKey||s.shiftKey;t&&(e||i)||(this.selectedItem=null,this.search(null,s))},this.options.delay)},search:function(t,e){return t=null!=t?t:this._value(),this.term=this._value(),t.length
").append(x("").text(e.label)).appendTo(t)},_move:function(t,e){if(this.menu.element.is(":visible"))return this.menu.isFirstItem()&&/^previous/.test(t)||this.menu.isLastItem()&&/^next/.test(t)?(this.isMultiLine||this._value(this.term),void this.menu.blur()):void this.menu[t](e);this.search(null,e)},widget:function(){return this.menu.element},_value:function(){return this.valueMethod.apply(this.element,arguments)},_keyEvent:function(t,e){this.isMultiLine&&!this.menu.element.is(":visible")||(this._move(t,e),e.preventDefault())},_isContentEditable:function(t){if(!t.length)return!1;var e=t.prop("contentEditable");return"inherit"===e?this._isContentEditable(t.parent()):"true"===e}}),x.extend(x.ui.autocomplete,{escapeRegex:function(t){return t.replace(/[\-\[\]{}()*+?.,\\\^$|#\s]/g,"\\$&")},filter:function(t,e){var i=new RegExp(x.ui.autocomplete.escapeRegex(e),"i");return x.grep(t,function(t){return i.test(t.label||t.value||t)})}}),x.widget("ui.autocomplete",x.ui.autocomplete,{options:{messages:{noResults:"No search results.",results:function(t){return t+(1
").text(e))},100))}});x.ui.autocomplete});
\ No newline at end of file
+!function(t){"use strict";"function"==typeof define&&define.amd?define(["jquery"],t):t(jQuery)}(function(x){"use strict";x.ui=x.ui||{};x.ui.version="1.13.1";var n,i=0,l=Array.prototype.hasOwnProperty,a=Array.prototype.slice;x.cleanData=(n=x.cleanData,function(t){for(var e,i,s=0;null!=(i=t[s]);s++)(e=x._data(i,"events"))&&e.remove&&x(i).triggerHandler("remove");n(t)}),x.widget=function(t,i,e){var s,n,o,l={},a=t.split(".")[0],r=a+"-"+(t=t.split(".")[1]);return e||(e=i,i=x.Widget),Array.isArray(e)&&(e=x.extend.apply(null,[{}].concat(e))),x.expr.pseudos[r.toLowerCase()]=function(t){return!!x.data(t,r)},x[a]=x[a]||{},s=x[a][t],n=x[a][t]=function(t,e){if(!this||!this._createWidget)return new n(t,e);arguments.length&&this._createWidget(t,e)},x.extend(n,s,{version:e.version,_proto:x.extend({},e),_childConstructors:[]}),(o=new i).options=x.widget.extend({},o.options),x.each(e,function(e,s){function n(){return i.prototype[e].apply(this,arguments)}function o(t){return i.prototype[e].apply(this,t)}l[e]="function"==typeof s?function(){var t,e=this._super,i=this._superApply;return this._super=n,this._superApply=o,t=s.apply(this,arguments),this._super=e,this._superApply=i,t}:s}),n.prototype=x.widget.extend(o,{widgetEventPrefix:s&&o.widgetEventPrefix||t},l,{constructor:n,namespace:a,widgetName:t,widgetFullName:r}),s?(x.each(s._childConstructors,function(t,e){var i=e.prototype;x.widget(i.namespace+"."+i.widgetName,n,e._proto)}),delete s._childConstructors):i._childConstructors.push(n),x.widget.bridge(t,n),n},x.widget.extend=function(t){for(var e,i,s=a.call(arguments,1),n=0,o=s.length;n",options:{classes:{},disabled:!1,create:null},_createWidget:function(t,e){e=x(e||this.defaultElement||this)[0],this.element=x(e),this.uuid=i++,this.eventNamespace="."+this.widgetName+this.uuid,this.bindings=x(),this.hoverable=x(),this.focusable=x(),this.classesElementLookup={},e!==this&&(x.data(e,this.widgetFullName,this),this._on(!0,this.element,{remove:function(t){t.target===e&&this.destroy()}}),this.document=x(e.style?e.ownerDocument:e.document||e),this.window=x(this.document[0].defaultView||this.document[0].parentWindow)),this.options=x.widget.extend({},this.options,this._getCreateOptions(),t),this._create(),this.options.disabled&&this._setOptionDisabled(this.options.disabled),this._trigger("create",null,this._getCreateEventData()),this._init()},_getCreateOptions:function(){return{}},_getCreateEventData:x.noop,_create:x.noop,_init:x.noop,destroy:function(){var i=this;this._destroy(),x.each(this.classesElementLookup,function(t,e){i._removeClass(e,t)}),this.element.off(this.eventNamespace).removeData(this.widgetFullName),this.widget().off(this.eventNamespace).removeAttr("aria-disabled"),this.bindings.off(this.eventNamespace)},_destroy:x.noop,widget:function(){return this.element},option:function(t,e){var i,s,n,o=t;if(0===arguments.length)return x.widget.extend({},this.options);if("string"==typeof t)if(o={},t=(i=t.split(".")).shift(),i.length){for(s=o[t]=x.widget.extend({},this.options[t]),n=0;n
C(E(s),E(n))?o.important="horizontal":o.important="vertical",c.using.call(this,t,o)}),l.offset(x.extend(u,{using:t}))})},x.ui.position={fit:{left:function(t,e){var i=e.within,s=i.isWindow?i.scrollLeft:i.offset.left,n=i.width,o=t.left-e.collisionPosition.marginLeft,l=s-o,a=o+e.collisionWidth-n-s;e.collisionWidth>n?0n?0",delay:300,options:{icons:{submenu:"ui-icon-caret-1-e"},items:"> *",menus:"ul",position:{my:"left top",at:"right top"},role:"menu",blur:null,focus:null,select:null},_create:function(){this.activeMenu=this.element,this.mouseHandled=!1,this.lastMousePosition={x:null,y:null},this.element.uniqueId().attr({role:this.options.role,tabIndex:0}),this._addClass("ui-menu","ui-widget ui-widget-content"),this._on({"mousedown .ui-menu-item":function(t){t.preventDefault(),this._activateItem(t)},"click .ui-menu-item":function(t){var e=x(t.target),i=x(x.ui.safeActiveElement(this.document[0]));!this.mouseHandled&&e.not(".ui-state-disabled").length&&(this.select(t),t.isPropagationStopped()||(this.mouseHandled=!0),e.has(".ui-menu").length?this.expand(t):!this.element.is(":focus")&&i.closest(".ui-menu").length&&(this.element.trigger("focus",[!0]),this.active&&1===this.active.parents(".ui-menu").length&&clearTimeout(this.timer)))},"mouseenter .ui-menu-item":"_activateItem","mousemove .ui-menu-item":"_activateItem",mouseleave:"collapseAll","mouseleave .ui-menu":"collapseAll",focus:function(t,e){var i=this.active||this._menuItems().first();e||this.focus(t,i)},blur:function(t){this._delay(function(){x.contains(this.element[0],x.ui.safeActiveElement(this.document[0]))||this.collapseAll(t)})},keydown:"_keydown"}),this.refresh(),this._on(this.document,{click:function(t){this._closeOnDocumentClick(t)&&this.collapseAll(t,!0),this.mouseHandled=!1}})},_activateItem:function(t){var e,i;this.previousFilter||t.clientX===this.lastMousePosition.x&&t.clientY===this.lastMousePosition.y||(this.lastMousePosition={x:t.clientX,y:t.clientY},e=x(t.target).closest(".ui-menu-item"),i=x(t.currentTarget),e[0]===i[0]&&(i.is(".ui-state-active")||(this._removeClass(i.siblings().children(".ui-state-active"),null,"ui-state-active"),this.focus(t,i))))},_destroy:function(){var t=this.element.find(".ui-menu-item").removeAttr("role aria-disabled").children(".ui-menu-item-wrapper").removeUniqueId().removeAttr("tabIndex role aria-haspopup");this.element.removeAttr("aria-activedescendant").find(".ui-menu").addBack().removeAttr("role aria-labelledby aria-expanded aria-hidden aria-disabled tabIndex").removeUniqueId().show(),t.children().each(function(){var t=x(this);t.data("ui-menu-submenu-caret")&&t.remove()})},_keydown:function(t){var e,i,s,n=!0;switch(t.keyCode){case x.ui.keyCode.PAGE_UP:this.previousPage(t);break;case x.ui.keyCode.PAGE_DOWN:this.nextPage(t);break;case x.ui.keyCode.HOME:this._move("first","first",t);break;case x.ui.keyCode.END:this._move("last","last",t);break;case x.ui.keyCode.UP:this.previous(t);break;case x.ui.keyCode.DOWN:this.next(t);break;case x.ui.keyCode.LEFT:this.collapse(t);break;case x.ui.keyCode.RIGHT:this.active&&!this.active.is(".ui-state-disabled")&&this.expand(t);break;case x.ui.keyCode.ENTER:case x.ui.keyCode.SPACE:this._activate(t);break;case x.ui.keyCode.ESCAPE:this.collapse(t);break;default:e=this.previousFilter||"",s=n=!1,i=96<=t.keyCode&&t.keyCode<=105?(t.keyCode-96).toString():String.fromCharCode(t.keyCode),clearTimeout(this.filterTimer),i===e?s=!0:i=e+i,e=this._filterMenuItems(i),(e=s&&-1!==e.index(this.active.next())?this.active.nextAll(".ui-menu-item"):e).length||(i=String.fromCharCode(t.keyCode),e=this._filterMenuItems(i)),e.length?(this.focus(t,e),this.previousFilter=i,this.filterTimer=this._delay(function(){delete this.previousFilter},1e3)):delete this.previousFilter}n&&t.preventDefault()},_activate:function(t){this.active&&!this.active.is(".ui-state-disabled")&&(this.active.children("[aria-haspopup='true']").length?this.expand(t):this.select(t))},refresh:function(){var t,e,s=this,n=this.options.icons.submenu,i=this.element.find(this.options.menus);this._toggleClass("ui-menu-icons",null,!!this.element.find(".ui-icon").length),e=i.filter(":not(.ui-menu)").hide().attr({role:this.options.role,"aria-hidden":"true","aria-expanded":"false"}).each(function(){var t=x(this),e=t.prev(),i=x("").data("ui-menu-submenu-caret",!0);s._addClass(i,"ui-menu-icon","ui-icon "+n),e.attr("aria-haspopup","true").prepend(i),t.attr("aria-labelledby",e.attr("id"))}),this._addClass(e,"ui-menu","ui-widget ui-widget-content ui-front"),(t=i.add(this.element).find(this.options.items)).not(".ui-menu-item").each(function(){var t=x(this);s._isDivider(t)&&s._addClass(t,"ui-menu-divider","ui-widget-content")}),i=(e=t.not(".ui-menu-item, .ui-menu-divider")).children().not(".ui-menu").uniqueId().attr({tabIndex:-1,role:this._itemRole()}),this._addClass(e,"ui-menu-item")._addClass(i,"ui-menu-item-wrapper"),t.filter(".ui-state-disabled").attr("aria-disabled","true"),this.active&&!x.contains(this.element[0],this.active[0])&&this.blur()},_itemRole:function(){return{menu:"menuitem",listbox:"option"}[this.options.role]},_setOption:function(t,e){var i;"icons"===t&&(i=this.element.find(".ui-menu-icon"),this._removeClass(i,null,this.options.icons.submenu)._addClass(i,null,e.submenu)),this._super(t,e)},_setOptionDisabled:function(t){this._super(t),this.element.attr("aria-disabled",String(t)),this._toggleClass(null,"ui-state-disabled",!!t)},focus:function(t,e){var i;this.blur(t,t&&"focus"===t.type),this._scrollIntoView(e),this.active=e.first(),i=this.active.children(".ui-menu-item-wrapper"),this._addClass(i,null,"ui-state-active"),this.options.role&&this.element.attr("aria-activedescendant",i.attr("id")),i=this.active.parent().closest(".ui-menu-item").children(".ui-menu-item-wrapper"),this._addClass(i,null,"ui-state-active"),t&&"keydown"===t.type?this._close():this.timer=this._delay(function(){this._close()},this.delay),(i=e.children(".ui-menu")).length&&t&&/^mouse/.test(t.type)&&this._startOpening(i),this.activeMenu=e.parent(),this._trigger("focus",t,{item:e})},_scrollIntoView:function(t){var e,i,s;this._hasScroll()&&(i=parseFloat(x.css(this.activeMenu[0],"borderTopWidth"))||0,s=parseFloat(x.css(this.activeMenu[0],"paddingTop"))||0,e=t.offset().top-this.activeMenu.offset().top-i-s,i=this.activeMenu.scrollTop(),s=this.activeMenu.height(),t=t.outerHeight(),e<0?this.activeMenu.scrollTop(i+e):s",options:{appendTo:null,autoFocus:!1,delay:300,minLength:1,position:{my:"left top",at:"left bottom",collision:"none"},source:null,change:null,close:null,focus:null,open:null,response:null,search:null,select:null},requestIndex:0,pending:0,liveRegionTimer:null,_create:function(){var i,s,n,t=this.element[0].nodeName.toLowerCase(),e="textarea"===t,t="input"===t;this.isMultiLine=e||!t&&this._isContentEditable(this.element),this.valueMethod=this.element[e||t?"val":"text"],this.isNewMenu=!0,this._addClass("ui-autocomplete-input"),this.element.attr("autocomplete","off"),this._on(this.element,{keydown:function(t){if(this.element.prop("readOnly"))s=n=i=!0;else{s=n=i=!1;var e=x.ui.keyCode;switch(t.keyCode){case e.PAGE_UP:i=!0,this._move("previousPage",t);break;case e.PAGE_DOWN:i=!0,this._move("nextPage",t);break;case e.UP:i=!0,this._keyEvent("previous",t);break;case e.DOWN:i=!0,this._keyEvent("next",t);break;case e.ENTER:this.menu.active&&(i=!0,t.preventDefault(),this.menu.select(t));break;case e.TAB:this.menu.active&&this.menu.select(t);break;case e.ESCAPE:this.menu.element.is(":visible")&&(this.isMultiLine||this._value(this.term),this.close(t),t.preventDefault());break;default:s=!0,this._searchTimeout(t)}}},keypress:function(t){if(i)return i=!1,void(this.isMultiLine&&!this.menu.element.is(":visible")||t.preventDefault());if(!s){var e=x.ui.keyCode;switch(t.keyCode){case e.PAGE_UP:this._move("previousPage",t);break;case e.PAGE_DOWN:this._move("nextPage",t);break;case e.UP:this._keyEvent("previous",t);break;case e.DOWN:this._keyEvent("next",t)}}},input:function(t){if(n)return n=!1,void t.preventDefault();this._searchTimeout(t)},focus:function(){this.selectedItem=null,this.previous=this._value()},blur:function(t){clearTimeout(this.searching),this.close(t),this._change(t)}}),this._initSource(),this.menu=x("").appendTo(this._appendTo()).menu({role:null}).hide().attr({unselectable:"on"}).menu("instance"),this._addClass(this.menu.element,"ui-autocomplete","ui-front"),this._on(this.menu.element,{mousedown:function(t){t.preventDefault()},menufocus:function(t,e){var i,s;if(this.isNewMenu&&(this.isNewMenu=!1,t.originalEvent&&/^mouse/.test(t.originalEvent.type)))return this.menu.blur(),void this.document.one("mousemove",function(){x(t.target).trigger(t.originalEvent)});s=e.item.data("ui-autocomplete-item"),!1!==this._trigger("focus",t,{item:s})&&t.originalEvent&&/^key/.test(t.originalEvent.type)&&this._value(s.value),(i=e.item.attr("aria-label")||s.value)&&String.prototype.trim.call(i).length&&(clearTimeout(this.liveRegionTimer),this.liveRegionTimer=this._delay(function(){this.liveRegion.html(x("").text(i))},100))},menuselect:function(t,e){var i=e.item.data("ui-autocomplete-item"),s=this.previous;this.element[0]!==x.ui.safeActiveElement(this.document[0])&&(this.element.trigger("focus"),this.previous=s,this._delay(function(){this.previous=s,this.selectedItem=i})),!1!==this._trigger("select",t,{item:i})&&this._value(i.value),this.term=this._value(),this.close(t),this.selectedItem=i}}),this.liveRegion=x("
",{role:"status","aria-live":"assertive","aria-relevant":"additions"}).appendTo(this.document[0].body),this._addClass(this.liveRegion,null,"ui-helper-hidden-accessible"),this._on(this.window,{beforeunload:function(){this.element.removeAttr("autocomplete")}})},_destroy:function(){clearTimeout(this.searching),this.element.removeAttr("autocomplete"),this.menu.element.remove(),this.liveRegion.remove()},_setOption:function(t,e){this._super(t,e),"source"===t&&this._initSource(),"appendTo"===t&&this.menu.element.appendTo(this._appendTo()),"disabled"===t&&e&&this.xhr&&this.xhr.abort()},_isEventTargetInWidget:function(t){var e=this.menu.element[0];return t.target===this.element[0]||t.target===e||x.contains(e,t.target)},_closeOnClickOutside:function(t){this._isEventTargetInWidget(t)||this.close()},_appendTo:function(){var t=this.options.appendTo;return t=!(t=!(t=t&&(t.jquery||t.nodeType?x(t):this.document.find(t).eq(0)))||!t[0]?this.element.closest(".ui-front, dialog"):t).length?this.document[0].body:t},_initSource:function(){var i,s,n=this;Array.isArray(this.options.source)?(i=this.options.source,this.source=function(t,e){e(x.ui.autocomplete.filter(i,t.term))}):"string"==typeof this.options.source?(s=this.options.source,this.source=function(t,e){n.xhr&&n.xhr.abort(),n.xhr=x.ajax({url:s,data:t,dataType:"json",success:function(t){e(t)},error:function(){e([])}})}):this.source=this.options.source},_searchTimeout:function(s){clearTimeout(this.searching),this.searching=this._delay(function(){var t=this.term===this._value(),e=this.menu.element.is(":visible"),i=s.altKey||s.ctrlKey||s.metaKey||s.shiftKey;t&&(e||i)||(this.selectedItem=null,this.search(null,s))},this.options.delay)},search:function(t,e){return t=null!=t?t:this._value(),this.term=this._value(),t.length
").append(x("").text(e.label)).appendTo(t)},_move:function(t,e){if(this.menu.element.is(":visible"))return this.menu.isFirstItem()&&/^previous/.test(t)||this.menu.isLastItem()&&/^next/.test(t)?(this.isMultiLine||this._value(this.term),void this.menu.blur()):void this.menu[t](e);this.search(null,e)},widget:function(){return this.menu.element},_value:function(){return this.valueMethod.apply(this.element,arguments)},_keyEvent:function(t,e){this.isMultiLine&&!this.menu.element.is(":visible")||(this._move(t,e),e.preventDefault())},_isContentEditable:function(t){if(!t.length)return!1;var e=t.prop("contentEditable");return"inherit"===e?this._isContentEditable(t.parent()):"true"===e}}),x.extend(x.ui.autocomplete,{escapeRegex:function(t){return t.replace(/[\-\[\]{}()*+?.,\\\^$|#\s]/g,"\\$&")},filter:function(t,e){var i=new RegExp(x.ui.autocomplete.escapeRegex(e),"i");return x.grep(t,function(t){return i.test(t.label||t.value||t)})}}),x.widget("ui.autocomplete",x.ui.autocomplete,{options:{messages:{noResults:"No search results.",results:function(t){return t+(1
").text(e))},100))}});x.ui.autocomplete});
\ No newline at end of file
diff --git a/pi4micronaut-utils/src/docs/javadoc/script.js b/pi4micronaut-utils/src/docs/javadoc/script.js
index f1a0f256..ccac782e 100644
--- a/pi4micronaut-utils/src/docs/javadoc/script.js
+++ b/pi4micronaut-utils/src/docs/javadoc/script.js
@@ -1,253 +1,132 @@
-/*
- * Copyright (c) 2013, 2023, Oracle and/or its affiliates. All rights reserved.
- * ORACLE PROPRIETARY/CONFIDENTIAL. Use is subject to license terms.
- *
- *
- *
- *
- *
- *
- *
- *
- *
- *
- *
- *
- *
- *
- *
- *
- *
- *
- *
- *
- */
-
-var moduleSearchIndex;
-var packageSearchIndex;
-var typeSearchIndex;
-var memberSearchIndex;
-var tagSearchIndex;
-
-var oddRowColor = "odd-row-color";
-var evenRowColor = "even-row-color";
-var sortAsc = "sort-asc";
-var sortDesc = "sort-desc";
-var tableTab = "table-tab";
-var activeTableTab = "active-table-tab";
-
-function loadScripts(doc, tag) {
- createElem(doc, tag, 'search.js');
-
- createElem(doc, tag, 'module-search-index.js');
- createElem(doc, tag, 'package-search-index.js');
- createElem(doc, tag, 'type-search-index.js');
- createElem(doc, tag, 'member-search-index.js');
- createElem(doc, tag, 'tag-search-index.js');
-}
-
-function createElem(doc, tag, path) {
- var script = doc.createElement(tag);
- var scriptElement = doc.getElementsByTagName(tag)[0];
- script.src = pathtoroot + path;
- scriptElement.parentNode.insertBefore(script, scriptElement);
-}
-
-// Helper for making content containing release names comparable lexicographically
-function makeComparable(s) {
- return s.toLowerCase().replace(/(\d+)/g,
- function(n, m) {
- return ("000" + m).slice(-4);
- });
-}
-
-// Switches between two styles depending on a condition
-function toggleStyle(classList, condition, trueStyle, falseStyle) {
- if (condition) {
- classList.remove(falseStyle);
- classList.add(trueStyle);
- } else {
- classList.remove(trueStyle);
- classList.add(falseStyle);
- }
-}
-
-// Sorts the rows in a table lexicographically by the content of a specific column
-function sortTable(header, columnIndex, columns) {
- var container = header.parentElement;
- var descending = header.classList.contains(sortAsc);
- container.querySelectorAll("div.table-header").forEach(
- function(header) {
- header.classList.remove(sortAsc);
- header.classList.remove(sortDesc);
- }
- )
- var cells = container.children;
- var rows = [];
- for (var i = columns; i < cells.length; i += columns) {
- rows.push(Array.prototype.slice.call(cells, i, i + columns));
- }
- var comparator = function(a, b) {
- var ka = makeComparable(a[columnIndex].textContent);
- var kb = makeComparable(b[columnIndex].textContent);
- if (ka < kb)
- return descending ? 1 : -1;
- if (ka > kb)
- return descending ? -1 : 1;
- return 0;
- };
- var sorted = rows.sort(comparator);
- var visible = 0;
- sorted.forEach(function(row) {
- if (row[0].style.display !== 'none') {
- var isEvenRow = visible++ % 2 === 0;
- }
- row.forEach(function(cell) {
- toggleStyle(cell.classList, isEvenRow, evenRowColor, oddRowColor);
- container.appendChild(cell);
- })
- });
- toggleStyle(header.classList, descending, sortDesc, sortAsc);
-}
-
-// Toggles the visibility of a table category in all tables in a page
-function toggleGlobal(checkbox, selected, columns) {
- var display = checkbox.checked ? '' : 'none';
- document.querySelectorAll("div.table-tabs").forEach(function(t) {
- var id = t.parentElement.getAttribute("id");
- var selectedClass = id + "-tab" + selected;
- // if selected is empty string it selects all uncategorized entries
- var selectUncategorized = !Boolean(selected);
- var visible = 0;
- document.querySelectorAll('div.' + id)
- .forEach(function(elem) {
- if (selectUncategorized) {
- if (elem.className.indexOf(selectedClass) === -1) {
- elem.style.display = display;
- }
- } else if (elem.classList.contains(selectedClass)) {
- elem.style.display = display;
- }
- if (elem.style.display === '') {
- var isEvenRow = visible++ % (columns * 2) < columns;
- toggleStyle(elem.classList, isEvenRow, evenRowColor, oddRowColor);
- }
- });
- var displaySection = visible === 0 ? 'none' : '';
- t.parentElement.style.display = displaySection;
- document.querySelector("li#contents-" + id).style.display = displaySection;
- })
-}
-
-// Shows the elements of a table belonging to a specific category
-function show(tableId, selected, columns) {
- if (tableId !== selected) {
- document.querySelectorAll('div.' + tableId + ':not(.' + selected + ')')
- .forEach(function(elem) {
- elem.style.display = 'none';
- });
- }
- document.querySelectorAll('div.' + selected)
- .forEach(function(elem, index) {
- elem.style.display = '';
- var isEvenRow = index % (columns * 2) < columns;
- toggleStyle(elem.classList, isEvenRow, evenRowColor, oddRowColor);
- });
- updateTabs(tableId, selected);
-}
-
-function updateTabs(tableId, selected) {
- document.querySelector('div#' + tableId +' .summary-table')
- .setAttribute('aria-labelledby', selected);
- document.querySelectorAll('button[id^="' + tableId + '"]')
- .forEach(function(tab, index) {
- if (selected === tab.id || (tableId === selected && index === 0)) {
- tab.className = activeTableTab;
- tab.setAttribute('aria-selected', true);
- tab.setAttribute('tabindex',0);
- } else {
- tab.className = tableTab;
- tab.setAttribute('aria-selected', false);
- tab.setAttribute('tabindex',-1);
- }
- });
-}
-
-function switchTab(e) {
- var selected = document.querySelector('[aria-selected=true]');
- if (selected) {
- if ((e.keyCode === 37 || e.keyCode === 38) && selected.previousSibling) {
- // left or up arrow key pressed: move focus to previous tab
- selected.previousSibling.click();
- selected.previousSibling.focus();
- e.preventDefault();
- } else if ((e.keyCode === 39 || e.keyCode === 40) && selected.nextSibling) {
- // right or down arrow key pressed: move focus to next tab
- selected.nextSibling.click();
- selected.nextSibling.focus();
- e.preventDefault();
- }
- }
-}
-
-var updateSearchResults = function() {};
-
-function indexFilesLoaded() {
- return moduleSearchIndex
- && packageSearchIndex
- && typeSearchIndex
- && memberSearchIndex
- && tagSearchIndex;
-}
-// Copy the contents of the local snippet to the clipboard
-function copySnippet(button) {
- copyToClipboard(button.nextElementSibling.innerText);
- switchCopyLabel(button, button.firstElementChild);
-}
-function copyToClipboard(content) {
- var textarea = document.createElement("textarea");
- textarea.style.height = 0;
- document.body.appendChild(textarea);
- textarea.value = content;
- textarea.select();
- document.execCommand("copy");
- document.body.removeChild(textarea);
-}
-function switchCopyLabel(button, span) {
- var copied = span.getAttribute("data-copied");
- button.classList.add("visible");
- var initialLabel = span.innerHTML;
- span.innerHTML = copied;
- setTimeout(function() {
- button.classList.remove("visible");
- setTimeout(function() {
- if (initialLabel !== copied) {
- span.innerHTML = initialLabel;
- }
- }, 100);
- }, 1900);
-}
-// Workaround for scroll position not being included in browser history (8249133)
-document.addEventListener("DOMContentLoaded", function(e) {
- var contentDiv = document.querySelector("div.flex-content");
- window.addEventListener("popstate", function(e) {
- if (e.state !== null) {
- contentDiv.scrollTop = e.state;
- }
- });
- window.addEventListener("hashchange", function(e) {
- history.replaceState(contentDiv.scrollTop, document.title);
- });
- var timeoutId;
- contentDiv.addEventListener("scroll", function(e) {
- if (timeoutId) {
- clearTimeout(timeoutId);
- }
- timeoutId = setTimeout(function() {
- history.replaceState(contentDiv.scrollTop, document.title);
- }, 100);
- });
- if (!location.hash) {
- history.replaceState(contentDiv.scrollTop, document.title);
- }
-});
+/*
+ * Copyright (c) 2013, 2020, Oracle and/or its affiliates. All rights reserved.
+ * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
+ *
+ * This code is free software; you can redistribute it and/or modify it
+ * under the terms of the GNU General Public License version 2 only, as
+ * published by the Free Software Foundation. Oracle designates this
+ * particular file as subject to the "Classpath" exception as provided
+ * by Oracle in the LICENSE file that accompanied this code.
+ *
+ * This code is distributed in the hope that it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+ * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
+ * version 2 for more details (a copy is included in the LICENSE file that
+ * accompanied this code).
+ *
+ * You should have received a copy of the GNU General Public License version
+ * 2 along with this work; if not, write to the Free Software Foundation,
+ * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
+ *
+ * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
+ * or visit www.oracle.com if you need additional information or have any
+ * questions.
+ */
+
+var moduleSearchIndex;
+var packageSearchIndex;
+var typeSearchIndex;
+var memberSearchIndex;
+var tagSearchIndex;
+function loadScripts(doc, tag) {
+ createElem(doc, tag, 'search.js');
+
+ createElem(doc, tag, 'module-search-index.js');
+ createElem(doc, tag, 'package-search-index.js');
+ createElem(doc, tag, 'type-search-index.js');
+ createElem(doc, tag, 'member-search-index.js');
+ createElem(doc, tag, 'tag-search-index.js');
+}
+
+function createElem(doc, tag, path) {
+ var script = doc.createElement(tag);
+ var scriptElement = doc.getElementsByTagName(tag)[0];
+ script.src = pathtoroot + path;
+ scriptElement.parentNode.insertBefore(script, scriptElement);
+}
+
+function show(tableId, selected, columns) {
+ if (tableId !== selected) {
+ document.querySelectorAll('div.' + tableId + ':not(.' + selected + ')')
+ .forEach(function(elem) {
+ elem.style.display = 'none';
+ });
+ }
+ document.querySelectorAll('div.' + selected)
+ .forEach(function(elem, index) {
+ elem.style.display = '';
+ var isEvenRow = index % (columns * 2) < columns;
+ elem.classList.remove(isEvenRow ? oddRowColor : evenRowColor);
+ elem.classList.add(isEvenRow ? evenRowColor : oddRowColor);
+ });
+ updateTabs(tableId, selected);
+}
+
+function updateTabs(tableId, selected) {
+ document.querySelector('div#' + tableId +' .summary-table')
+ .setAttribute('aria-labelledby', selected);
+ document.querySelectorAll('button[id^="' + tableId + '"]')
+ .forEach(function(tab, index) {
+ if (selected === tab.id || (tableId === selected && index === 0)) {
+ tab.className = activeTableTab;
+ tab.setAttribute('aria-selected', true);
+ tab.setAttribute('tabindex',0);
+ } else {
+ tab.className = tableTab;
+ tab.setAttribute('aria-selected', false);
+ tab.setAttribute('tabindex',-1);
+ }
+ });
+}
+
+function switchTab(e) {
+ var selected = document.querySelector('[aria-selected=true]');
+ if (selected) {
+ if ((e.keyCode === 37 || e.keyCode === 38) && selected.previousSibling) {
+ // left or up arrow key pressed: move focus to previous tab
+ selected.previousSibling.click();
+ selected.previousSibling.focus();
+ e.preventDefault();
+ } else if ((e.keyCode === 39 || e.keyCode === 40) && selected.nextSibling) {
+ // right or down arrow key pressed: move focus to next tab
+ selected.nextSibling.click();
+ selected.nextSibling.focus();
+ e.preventDefault();
+ }
+ }
+}
+
+var updateSearchResults = function() {};
+
+function indexFilesLoaded() {
+ return moduleSearchIndex
+ && packageSearchIndex
+ && typeSearchIndex
+ && memberSearchIndex
+ && tagSearchIndex;
+}
+
+// Workaround for scroll position not being included in browser history (8249133)
+document.addEventListener("DOMContentLoaded", function(e) {
+ var contentDiv = document.querySelector("div.flex-content");
+ window.addEventListener("popstate", function(e) {
+ if (e.state !== null) {
+ contentDiv.scrollTop = e.state;
+ }
+ });
+ window.addEventListener("hashchange", function(e) {
+ history.replaceState(contentDiv.scrollTop, document.title);
+ });
+ contentDiv.addEventListener("scroll", function(e) {
+ var timeoutID;
+ if (!timeoutID) {
+ timeoutID = setTimeout(function() {
+ history.replaceState(contentDiv.scrollTop, document.title);
+ timeoutID = null;
+ }, 100);
+ }
+ });
+ if (!location.hash) {
+ history.replaceState(contentDiv.scrollTop, document.title);
+ }
+});
diff --git a/pi4micronaut-utils/src/docs/javadoc/search.js b/pi4micronaut-utils/src/docs/javadoc/search.js
index 4ca95577..3f826c7b 100644
--- a/pi4micronaut-utils/src/docs/javadoc/search.js
+++ b/pi4micronaut-utils/src/docs/javadoc/search.js
@@ -1,458 +1,354 @@
-/*
- * Copyright (c) 2015, 2023, Oracle and/or its affiliates. All rights reserved.
- * ORACLE PROPRIETARY/CONFIDENTIAL. Use is subject to license terms.
- *
- *
- *
- *
- *
- *
- *
- *
- *
- *
- *
- *
- *
- *
- *
- *
- *
- *
- *
- *
- */
-"use strict";
-const messages = {
- enterTerm: "Enter a search term",
- noResult: "No results found",
- oneResult: "Found one result",
- manyResults: "Found {0} results",
- loading: "Loading search index...",
- searching: "Searching...",
- redirecting: "Redirecting to first result...",
- linkIcon: "Link icon",
- linkToSection: "Link to this section"
-}
-const categories = {
- modules: "Modules",
- packages: "Packages",
- types: "Classes and Interfaces",
- members: "Members",
- searchTags: "Search Tags"
-};
-const highlight = "$& ";
-const NO_MATCH = {};
-const MAX_RESULTS = 300;
-function checkUnnamed(name, separator) {
- return name === "" || !name ? "" : name + separator;
-}
-function escapeHtml(str) {
- return str.replace(//g, ">");
-}
-function getHighlightedText(str, boundaries, from, to) {
- var start = from;
- var text = "";
- for (var i = 0; i < boundaries.length; i += 2) {
- var b0 = boundaries[i];
- var b1 = boundaries[i + 1];
- if (b0 >= to || b1 <= from) {
- continue;
- }
- text += escapeHtml(str.slice(start, Math.max(start, b0)));
- text += "";
- text += escapeHtml(str.slice(Math.max(start, b0), Math.min(to, b1)));
- text += " ";
- start = Math.min(to, b1);
- }
- text += escapeHtml(str.slice(start, to));
- return text;
-}
-function getURLPrefix(item, category) {
- var urlPrefix = "";
- var slash = "/";
- if (category === "modules") {
- return item.l + slash;
- } else if (category === "packages" && item.m) {
- return item.m + slash;
- } else if (category === "types" || category === "members") {
- if (item.m) {
- urlPrefix = item.m + slash;
- } else {
- $.each(packageSearchIndex, function(index, it) {
- if (it.m && item.p === it.l) {
- urlPrefix = it.m + slash;
- }
- });
- }
- }
- return urlPrefix;
-}
-function getURL(item, category) {
- if (item.url) {
- return item.url;
- }
- var url = getURLPrefix(item, category);
- if (category === "modules") {
- url += "module-summary.html";
- } else if (category === "packages") {
- if (item.u) {
- url = item.u;
- } else {
- url += item.l.replace(/\./g, '/') + "/package-summary.html";
- }
- } else if (category === "types") {
- if (item.u) {
- url = item.u;
- } else {
- url += checkUnnamed(item.p, "/").replace(/\./g, '/') + item.l + ".html";
- }
- } else if (category === "members") {
- url += checkUnnamed(item.p, "/").replace(/\./g, '/') + item.c + ".html" + "#";
- if (item.u) {
- url += item.u;
- } else {
- url += item.l;
- }
- } else if (category === "searchTags") {
- url += item.u;
- }
- item.url = url;
- return url;
-}
-function createMatcher(term, camelCase) {
- if (camelCase && !isUpperCase(term)) {
- return null; // no need for camel-case matcher for lower case query
- }
- var pattern = "";
- var upperCase = [];
- term.trim().split(/\s+/).forEach(function(w, index, array) {
- var tokens = w.split(/(?=[A-Z,.()<>?[\/])/);
- for (var i = 0; i < tokens.length; i++) {
- var s = tokens[i];
- // ',' and '?' are the only delimiters commonly followed by space in java signatures
- pattern += "(" + $.ui.autocomplete.escapeRegex(s).replace(/[,?]/g, "$&\\s*?") + ")";
- upperCase.push(false);
- var isWordToken = /\w$/.test(s);
- if (isWordToken) {
- if (i === tokens.length - 1 && index < array.length - 1) {
- // space in query string matches all delimiters
- pattern += "(.*?)";
- upperCase.push(isUpperCase(s[0]));
- } else {
- if (!camelCase && isUpperCase(s) && s.length === 1) {
- pattern += "()";
- } else {
- pattern += "([a-z0-9$<>?[\\]]*?)";
- }
- upperCase.push(isUpperCase(s[0]));
- }
- } else {
- pattern += "()";
- upperCase.push(false);
- }
- }
- });
- var re = new RegExp(pattern, "gi");
- re.upperCase = upperCase;
- return re;
-}
-function findMatch(matcher, input, startOfName, endOfName) {
- var from = startOfName;
- matcher.lastIndex = from;
- var match = matcher.exec(input);
- // Expand search area until we get a valid result or reach the beginning of the string
- while (!match || match.index + match[0].length < startOfName || endOfName < match.index) {
- if (from === 0) {
- return NO_MATCH;
- }
- from = input.lastIndexOf(".", from - 2) + 1;
- matcher.lastIndex = from;
- match = matcher.exec(input);
- }
- var boundaries = [];
- var matchEnd = match.index + match[0].length;
- var score = 5;
- var start = match.index;
- var prevEnd = -1;
- for (var i = 1; i < match.length; i += 2) {
- var isUpper = isUpperCase(input[start]);
- var isMatcherUpper = matcher.upperCase[i];
- // capturing groups come in pairs, match and non-match
- boundaries.push(start, start + match[i].length);
- // make sure groups are anchored on a left word boundary
- var prevChar = input[start - 1] || "";
- var nextChar = input[start + 1] || "";
- if (start !== 0 && !/[\W_]/.test(prevChar) && !/[\W_]/.test(input[start])) {
- if (isUpper && (isLowerCase(prevChar) || isLowerCase(nextChar))) {
- score -= 0.1;
- } else if (isMatcherUpper && start === prevEnd) {
- score -= isUpper ? 0.1 : 1.0;
- } else {
- return NO_MATCH;
- }
- }
- prevEnd = start + match[i].length;
- start += match[i].length + match[i + 1].length;
-
- // lower score for parts of the name that are missing
- if (match[i + 1] && prevEnd < endOfName) {
- score -= rateNoise(match[i + 1]);
- }
- }
- // lower score if a type name contains unmatched camel-case parts
- if (input[matchEnd - 1] !== "." && endOfName > matchEnd)
- score -= rateNoise(input.slice(matchEnd, endOfName));
- score -= rateNoise(input.slice(0, Math.max(startOfName, match.index)));
-
- if (score <= 0) {
- return NO_MATCH;
- }
- return {
- input: input,
- score: score,
- boundaries: boundaries
- };
-}
-function isUpperCase(s) {
- return s !== s.toLowerCase();
-}
-function isLowerCase(s) {
- return s !== s.toUpperCase();
-}
-function rateNoise(str) {
- return (str.match(/([.(])/g) || []).length / 5
- + (str.match(/([A-Z]+)/g) || []).length / 10
- + str.length / 20;
-}
-function doSearch(request, response) {
- var term = request.term.trim();
- var maxResults = request.maxResults || MAX_RESULTS;
- if (term.length === 0) {
- return this.close();
- }
- var matcher = {
- plainMatcher: createMatcher(term, false),
- camelCaseMatcher: createMatcher(term, true)
- }
- var indexLoaded = indexFilesLoaded();
-
- function getPrefix(item, category) {
- switch (category) {
- case "packages":
- return checkUnnamed(item.m, "/");
- case "types":
- return checkUnnamed(item.p, ".");
- case "members":
- return checkUnnamed(item.p, ".") + item.c + ".";
- default:
- return "";
- }
- }
- function useQualifiedName(category) {
- switch (category) {
- case "packages":
- return /[\s/]/.test(term);
- case "types":
- case "members":
- return /[\s.]/.test(term);
- default:
- return false;
- }
- }
- function searchIndex(indexArray, category) {
- var matches = [];
- if (!indexArray) {
- if (!indexLoaded) {
- matches.push({ l: messages.loading, category: category });
- }
- return matches;
- }
- $.each(indexArray, function (i, item) {
- var prefix = getPrefix(item, category);
- var simpleName = item.l;
- var qualifiedName = prefix + simpleName;
- var useQualified = useQualifiedName(category);
- var input = useQualified ? qualifiedName : simpleName;
- var startOfName = useQualified ? prefix.length : 0;
- var endOfName = category === "members" && input.indexOf("(", startOfName) > -1
- ? input.indexOf("(", startOfName) : input.length;
- var m = findMatch(matcher.plainMatcher, input, startOfName, endOfName);
- if (m === NO_MATCH && matcher.camelCaseMatcher) {
- m = findMatch(matcher.camelCaseMatcher, input, startOfName, endOfName);
- }
- if (m !== NO_MATCH) {
- m.indexItem = item;
- m.prefix = prefix;
- m.category = category;
- if (!useQualified) {
- m.input = qualifiedName;
- m.boundaries = m.boundaries.map(function(b) {
- return b + prefix.length;
- });
- }
- matches.push(m);
- }
- return true;
- });
- return matches.sort(function(e1, e2) {
- return e2.score - e1.score;
- }).slice(0, maxResults);
- }
-
- var result = searchIndex(moduleSearchIndex, "modules")
- .concat(searchIndex(packageSearchIndex, "packages"))
- .concat(searchIndex(typeSearchIndex, "types"))
- .concat(searchIndex(memberSearchIndex, "members"))
- .concat(searchIndex(tagSearchIndex, "searchTags"));
-
- if (!indexLoaded) {
- updateSearchResults = function() {
- doSearch(request, response);
- }
- } else {
- updateSearchResults = function() {};
- }
- response(result);
-}
-// JQuery search menu implementation
-$.widget("custom.catcomplete", $.ui.autocomplete, {
- _create: function() {
- this._super();
- this.widget().menu("option", "items", "> .result-item");
- // workaround for search result scrolling
- this.menu._scrollIntoView = function _scrollIntoView( item ) {
- var borderTop, paddingTop, offset, scroll, elementHeight, itemHeight;
- if ( this._hasScroll() ) {
- borderTop = parseFloat( $.css( this.activeMenu[ 0 ], "borderTopWidth" ) ) || 0;
- paddingTop = parseFloat( $.css( this.activeMenu[ 0 ], "paddingTop" ) ) || 0;
- offset = item.offset().top - this.activeMenu.offset().top - borderTop - paddingTop;
- scroll = this.activeMenu.scrollTop();
- elementHeight = this.activeMenu.height() - 26;
- itemHeight = item.outerHeight();
-
- if ( offset < 0 ) {
- this.activeMenu.scrollTop( scroll + offset );
- } else if ( offset + itemHeight > elementHeight ) {
- this.activeMenu.scrollTop( scroll + offset - elementHeight + itemHeight );
- }
- }
- };
- },
- _renderMenu: function(ul, items) {
- var currentCategory = "";
- var widget = this;
- widget.menu.bindings = $();
- $.each(items, function(index, item) {
- if (item.category && item.category !== currentCategory) {
- ul.append("" + categories[item.category] + " ");
- currentCategory = item.category;
- }
- var li = widget._renderItemData(ul, item);
- if (item.category) {
- li.attr("aria-label", categories[item.category] + " : " + item.l);
- } else {
- li.attr("aria-label", item.l);
- }
- li.attr("class", "result-item");
- });
- ul.append("Go to search page
").appendTo(li);
- var label = item.l
- ? item.l
- : getHighlightedText(item.input, item.boundaries, 0, item.input.length);
- var idx = item.indexItem;
- if (item.category === "searchTags" && idx && idx.h) {
- if (idx.d) {
- div.html(label + " (" + idx.h + ") "
- + idx.d + " (" + idx.h + ") ");
- }
- } else {
- div.html(label);
- }
- return li;
- }
-});
-$(function() {
- var expanded = false;
- var windowWidth;
- function collapse() {
- if (expanded) {
- $("div#navbar-top").removeAttr("style");
- $("button#navbar-toggle-button")
- .removeClass("expanded")
- .attr("aria-expanded", "false");
- expanded = false;
- }
- }
- $("button#navbar-toggle-button").click(function (e) {
- if (expanded) {
- collapse();
- } else {
- var navbar = $("div#navbar-top");
- navbar.height(navbar.prop("scrollHeight"));
- $("button#navbar-toggle-button")
- .addClass("expanded")
- .attr("aria-expanded", "true");
- expanded = true;
- windowWidth = window.innerWidth;
- }
- });
- $("ul.sub-nav-list-small li a").click(collapse);
- $("input#search-input").focus(collapse);
- $("main").click(collapse);
- $("section[id] > :header, :header[id], :header:has(a[id])").each(function(idx, el) {
- // Create anchor links for headers with an associated id attribute
- var hdr = $(el);
- var id = hdr.attr("id") || hdr.parent("section").attr("id") || hdr.children("a").attr("id");
- if (id) {
- hdr.append(" $& ";
+var searchPattern = "";
+var fallbackPattern = "";
+var RANKING_THRESHOLD = 2;
+var NO_MATCH = 0xffff;
+var MIN_RESULTS = 3;
+var MAX_RESULTS = 500;
+var UNNAMED = "";
+function escapeHtml(str) {
+ return str.replace(//g, ">");
+}
+function getHighlightedText(item, matcher, fallbackMatcher) {
+ var escapedItem = escapeHtml(item);
+ var highlighted = escapedItem.replace(matcher, highlight);
+ if (highlighted === escapedItem) {
+ highlighted = escapedItem.replace(fallbackMatcher, highlight)
+ }
+ return highlighted;
+}
+function getURLPrefix(ui) {
+ var urlPrefix="";
+ var slash = "/";
+ if (ui.item.category === catModules) {
+ return ui.item.l + slash;
+ } else if (ui.item.category === catPackages && ui.item.m) {
+ return ui.item.m + slash;
+ } else if (ui.item.category === catTypes || ui.item.category === catMembers) {
+ if (ui.item.m) {
+ urlPrefix = ui.item.m + slash;
+ } else {
+ $.each(packageSearchIndex, function(index, item) {
+ if (item.m && ui.item.p === item.l) {
+ urlPrefix = item.m + slash;
+ }
+ });
+ }
+ }
+ return urlPrefix;
+}
+function createSearchPattern(term) {
+ var pattern = "";
+ var isWordToken = false;
+ term.replace(/,\s*/g, ", ").trim().split(/\s+/).forEach(function(w, index) {
+ if (index > 0) {
+ // whitespace between identifiers is significant
+ pattern += (isWordToken && /^\w/.test(w)) ? "\\s+" : "\\s*";
+ }
+ var tokens = w.split(/(?=[A-Z,.()<>[\/])/);
+ for (var i = 0; i < tokens.length; i++) {
+ var s = tokens[i];
+ if (s === "") {
+ continue;
+ }
+ pattern += $.ui.autocomplete.escapeRegex(s);
+ isWordToken = /\w$/.test(s);
+ if (isWordToken) {
+ pattern += "([a-z0-9_$<>\\[\\]]*?)";
+ }
+ }
+ });
+ return pattern;
+}
+function createMatcher(pattern, flags) {
+ var isCamelCase = /[A-Z]/.test(pattern);
+ return new RegExp(pattern, flags + (isCamelCase ? "" : "i"));
+}
+var watermark = 'Search';
+$(function() {
+ var search = $("#search-input");
+ var reset = $("#reset-button");
+ search.val('');
+ search.prop("disabled", false);
+ reset.prop("disabled", false);
+ search.val(watermark).addClass('watermark');
+ search.blur(function() {
+ if ($(this).val().length === 0) {
+ $(this).val(watermark).addClass('watermark');
+ }
+ });
+ search.on('click keydown paste', function() {
+ if ($(this).val() === watermark) {
+ $(this).val('').removeClass('watermark');
+ }
+ });
+ reset.click(function() {
+ search.val('').focus();
+ });
+ search.focus()[0].setSelectionRange(0, 0);
+});
+$.widget("custom.catcomplete", $.ui.autocomplete, {
+ _create: function() {
+ this._super();
+ this.widget().menu("option", "items", "> :not(.ui-autocomplete-category)");
+ },
+ _renderMenu: function(ul, items) {
+ var rMenu = this;
+ var currentCategory = "";
+ rMenu.menu.bindings = $();
+ $.each(items, function(index, item) {
+ var li;
+ if (item.category && item.category !== currentCategory) {
+ ul.append("" + item.category + " ");
+ currentCategory = item.category;
+ }
+ li = rMenu._renderItemData(ul, item);
+ if (item.category) {
+ li.attr("aria-label", item.category + " : " + item.l);
+ li.attr("class", "result-item");
+ } else {
+ li.attr("aria-label", item.l);
+ li.attr("class", "result-item");
+ }
+ });
+ },
+ _renderItem: function(ul, item) {
+ var label = "";
+ var matcher = createMatcher(escapeHtml(searchPattern), "g");
+ var fallbackMatcher = new RegExp(fallbackPattern, "gi")
+ if (item.category === catModules) {
+ label = getHighlightedText(item.l, matcher, fallbackMatcher);
+ } else if (item.category === catPackages) {
+ label = getHighlightedText(item.l, matcher, fallbackMatcher);
+ } else if (item.category === catTypes) {
+ label = (item.p && item.p !== UNNAMED)
+ ? getHighlightedText(item.p + "." + item.l, matcher, fallbackMatcher)
+ : getHighlightedText(item.l, matcher, fallbackMatcher);
+ } else if (item.category === catMembers) {
+ label = (item.p && item.p !== UNNAMED)
+ ? getHighlightedText(item.p + "." + item.c + "." + item.l, matcher, fallbackMatcher)
+ : getHighlightedText(item.c + "." + item.l, matcher, fallbackMatcher);
+ } else if (item.category === catSearchTags) {
+ label = getHighlightedText(item.l, matcher, fallbackMatcher);
+ } else {
+ label = item.l;
+ }
+ var li = $("
").appendTo(li);
+ if (item.category === catSearchTags && item.h) {
+ if (item.d) {
+ div.html(label + " (" + item.h + ") "
+ + item.d + " (" + item.h + ") ");
+ }
+ } else {
+ if (item.m) {
+ div.html(item.m + "/" + label);
+ } else {
+ div.html(label);
+ }
+ }
+ return li;
+ }
+});
+function rankMatch(match, category) {
+ if (!match) {
+ return NO_MATCH;
+ }
+ var index = match.index;
+ var input = match.input;
+ var leftBoundaryMatch = 2;
+ var periferalMatch = 0;
+ // make sure match is anchored on a left word boundary
+ if (index === 0 || /\W/.test(input[index - 1]) || "_" === input[index]) {
+ leftBoundaryMatch = 0;
+ } else if ("_" === input[index - 1] || (input[index] === input[index].toUpperCase() && !/^[A-Z0-9_$]+$/.test(input))) {
+ leftBoundaryMatch = 1;
+ }
+ var matchEnd = index + match[0].length;
+ var leftParen = input.indexOf("(");
+ var endOfName = leftParen > -1 ? leftParen : input.length;
+ // exclude peripheral matches
+ if (category !== catModules && category !== catSearchTags) {
+ var delim = category === catPackages ? "/" : ".";
+ if (leftParen > -1 && leftParen < index) {
+ periferalMatch += 2;
+ } else if (input.lastIndexOf(delim, endOfName) >= matchEnd) {
+ periferalMatch += 2;
+ }
+ }
+ var delta = match[0].length === endOfName ? 0 : 1; // rank full match higher than partial match
+ for (var i = 1; i < match.length; i++) {
+ // lower ranking if parts of the name are missing
+ if (match[i])
+ delta += match[i].length;
+ }
+ if (category === catTypes) {
+ // lower ranking if a type name contains unmatched camel-case parts
+ if (/[A-Z]/.test(input.substring(matchEnd)))
+ delta += 5;
+ if (/[A-Z]/.test(input.substring(0, index)))
+ delta += 5;
+ }
+ return leftBoundaryMatch + periferalMatch + (delta / 200);
+
+}
+function doSearch(request, response) {
+ var result = [];
+ searchPattern = createSearchPattern(request.term);
+ fallbackPattern = createSearchPattern(request.term.toLowerCase());
+ if (searchPattern === "") {
+ return this.close();
+ }
+ var camelCaseMatcher = createMatcher(searchPattern, "");
+ var fallbackMatcher = new RegExp(fallbackPattern, "i");
+
+ function searchIndexWithMatcher(indexArray, matcher, category, nameFunc) {
+ if (indexArray) {
+ var newResults = [];
+ $.each(indexArray, function (i, item) {
+ item.category = category;
+ var ranking = rankMatch(matcher.exec(nameFunc(item)), category);
+ if (ranking < RANKING_THRESHOLD) {
+ newResults.push({ranking: ranking, item: item});
+ }
+ return newResults.length <= MAX_RESULTS;
+ });
+ return newResults.sort(function(e1, e2) {
+ return e1.ranking - e2.ranking;
+ }).map(function(e) {
+ return e.item;
+ });
+ }
+ return [];
+ }
+ function searchIndex(indexArray, category, nameFunc) {
+ var primaryResults = searchIndexWithMatcher(indexArray, camelCaseMatcher, category, nameFunc);
+ result = result.concat(primaryResults);
+ if (primaryResults.length <= MIN_RESULTS && !camelCaseMatcher.ignoreCase) {
+ var secondaryResults = searchIndexWithMatcher(indexArray, fallbackMatcher, category, nameFunc);
+ result = result.concat(secondaryResults.filter(function (item) {
+ return primaryResults.indexOf(item) === -1;
+ }));
+ }
+ }
+
+ searchIndex(moduleSearchIndex, catModules, function(item) { return item.l; });
+ searchIndex(packageSearchIndex, catPackages, function(item) {
+ return (item.m && request.term.indexOf("/") > -1)
+ ? (item.m + "/" + item.l) : item.l;
+ });
+ searchIndex(typeSearchIndex, catTypes, function(item) {
+ return request.term.indexOf(".") > -1 ? item.p + "." + item.l : item.l;
+ });
+ searchIndex(memberSearchIndex, catMembers, function(item) {
+ return request.term.indexOf(".") > -1
+ ? item.p + "." + item.c + "." + item.l : item.l;
+ });
+ searchIndex(tagSearchIndex, catSearchTags, function(item) { return item.l; });
+
+ if (!indexFilesLoaded()) {
+ updateSearchResults = function() {
+ doSearch(request, response);
+ }
+ result.unshift(loading);
+ } else {
+ updateSearchResults = function() {};
+ }
+ response(result);
+}
+$(function() {
+ $("#search-input").catcomplete({
+ minLength: 1,
+ delay: 300,
+ source: doSearch,
+ response: function(event, ui) {
+ if (!ui.content.length) {
+ ui.content.push(noResult);
+ } else {
+ $("#search-input").empty();
+ }
+ },
+ autoFocus: true,
+ focus: function(event, ui) {
+ return false;
+ },
+ position: {
+ collision: "flip"
+ },
+ select: function(event, ui) {
+ if (ui.item.category) {
+ var url = getURLPrefix(ui);
+ if (ui.item.category === catModules) {
+ url += "module-summary.html";
+ } else if (ui.item.category === catPackages) {
+ if (ui.item.u) {
+ url = ui.item.u;
+ } else {
+ url += ui.item.l.replace(/\./g, '/') + "/package-summary.html";
+ }
+ } else if (ui.item.category === catTypes) {
+ if (ui.item.u) {
+ url = ui.item.u;
+ } else if (ui.item.p === UNNAMED) {
+ url += ui.item.l + ".html";
+ } else {
+ url += ui.item.p.replace(/\./g, '/') + "/" + ui.item.l + ".html";
+ }
+ } else if (ui.item.category === catMembers) {
+ if (ui.item.p === UNNAMED) {
+ url += ui.item.c + ".html" + "#";
+ } else {
+ url += ui.item.p.replace(/\./g, '/') + "/" + ui.item.c + ".html" + "#";
+ }
+ if (ui.item.u) {
+ url += ui.item.u;
+ } else {
+ url += ui.item.l;
+ }
+ } else if (ui.item.category === catSearchTags) {
+ url += ui.item.u;
+ }
+ if (top !== window) {
+ parent.classFrame.location = pathtoroot + url;
+ } else {
+ window.location.href = pathtoroot + url;
+ }
+ $("#search-input").focus();
+ }
+ }
+ });
+});
diff --git a/pi4micronaut-utils/src/docs/javadoc/stylesheet.css b/pi4micronaut-utils/src/docs/javadoc/stylesheet.css
index f71489f8..93810d9a 100644
--- a/pi4micronaut-utils/src/docs/javadoc/stylesheet.css
+++ b/pi4micronaut-utils/src/docs/javadoc/stylesheet.css
@@ -1,1272 +1,869 @@
-/*
- * Javadoc style sheet
- */
-
-@import url('resources/fonts/dejavu.css');
-
-/*
- * These CSS custom properties (variables) define the core color and font
- * properties used in this stylesheet.
- */
-:root {
- /* body, block and code fonts */
- --body-font-family: 'DejaVu Sans', Arial, Helvetica, sans-serif;
- --block-font-family: 'DejaVu Serif', Georgia, "Times New Roman", Times, serif;
- --code-font-family: 'DejaVu Sans Mono', monospace;
- /* Base font sizes for body and code elements */
- --body-font-size: 14px;
- --code-font-size: 14px;
- /* Text colors for body and block elements */
- --body-text-color: #353833;
- --block-text-color: #474747;
- /* Background colors for various structural elements */
- --body-background-color: #ffffff;
- --section-background-color: #f8f8f8;
- --detail-background-color: #ffffff;
- /* Colors for navigation bar and table captions */
- --navbar-background-color: #4D7A97;
- --navbar-text-color: #ffffff;
- /* Background color for subnavigation and various headers */
- --subnav-background-color: #dee3e9;
- /* Background and text colors for selected tabs and navigation items */
- --selected-background-color: #f8981d;
- --selected-text-color: #253441;
- --selected-link-color: #1f389c;
- /* Background colors for generated tables */
- --even-row-color: #ffffff;
- --odd-row-color: #eeeeef;
- /* Text color for page title */
- --title-color: #2c4557;
- /* Text colors for links */
- --link-color: #4A6782;
- --link-color-active: #bb7a2a;
- /* Snippet colors */
- --snippet-background-color: #ebecee;
- --snippet-text-color: var(--block-text-color);
- --snippet-highlight-color: #f7c590;
- /* Border colors for structural elements and user defined tables */
- --border-color: #ededed;
- --table-border-color: #000000;
- /* Search input colors */
- --search-input-background-color: #ffffff;
- --search-input-text-color: #000000;
- --search-input-placeholder-color: #909090;
- /* Highlight color for active search tag target */
- --search-tag-highlight-color: #ffff00;
- /* Adjustments for icon and active background colors of copy-to-clipboard buttons */
- --copy-icon-brightness: 100%;
- --copy-button-background-color-active: rgba(168, 168, 176, 0.3);
- /* Colors for invalid tag notifications */
- --invalid-tag-background-color: #ffe6e6;
- --invalid-tag-text-color: #000000;
-}
-/*
- * Styles for individual HTML elements.
- *
- * These are styles that are specific to individual HTML elements. Changing them affects the style of a particular
- * HTML element throughout the page.
- */
-body {
- background-color:var(--body-background-color);
- color:var(--body-text-color);
- font-family:var(--body-font-family);
- font-size:var(--body-font-size);
- margin:0;
- padding:0;
- height:100%;
- width:100%;
-}
-iframe {
- margin:0;
- padding:0;
- height:100%;
- width:100%;
- overflow-y:scroll;
- border:none;
-}
-a:link, a:visited {
- text-decoration:none;
- color:var(--link-color);
-}
-a[href]:hover, a[href]:focus {
- text-decoration:none;
- color:var(--link-color-active);
-}
-pre {
- font-family:var(--code-font-family);
- font-size:1em;
-}
-h1 {
- font-size:1.428em;
-}
-h2 {
- font-size:1.285em;
-}
-h3 {
- font-size:1.14em;
-}
-h4 {
- font-size:1.072em;
-}
-h5 {
- font-size:1.001em;
-}
-h6 {
- font-size:0.93em;
-}
-/* Disable font boosting for selected elements */
-h1, h2, h3, h4, h5, h6, div.member-signature {
- max-height: 1000em;
-}
-ul {
- list-style-type:disc;
-}
-code, tt {
- font-family:var(--code-font-family);
-}
-:not(h1, h2, h3, h4, h5, h6) > code,
-:not(h1, h2, h3, h4, h5, h6) > tt {
- font-size:var(--code-font-size);
- padding-top:4px;
- margin-top:8px;
- line-height:1.4em;
-}
-dt code {
- font-family:var(--code-font-family);
- font-size:1em;
- padding-top:4px;
-}
-.summary-table dt code {
- font-family:var(--code-font-family);
- font-size:1em;
- vertical-align:top;
- padding-top:4px;
-}
-sup {
- font-size:8px;
-}
-button {
- font-family: var(--body-font-family);
- font-size: 1em;
-}
-/*
- * Styles for HTML generated by javadoc.
- *
- * These are style classes that are used by the standard doclet to generate HTML documentation.
- */
-
-/*
- * Styles for document title and copyright.
- */
-.about-language {
- float:right;
- padding:0 21px 8px 8px;
- font-size:0.915em;
- margin-top:-9px;
- height:2.9em;
-}
-.legal-copy {
- margin-left:.5em;
-}
-/*
- * Styles for navigation bar.
- */
-@media screen {
- div.flex-box {
- position:fixed;
- display:flex;
- flex-direction:column;
- height: 100%;
- width: 100%;
- }
- header.flex-header {
- flex: 0 0 auto;
- }
- div.flex-content {
- flex: 1 1 auto;
- overflow-y: auto;
- }
-}
-.top-nav {
- background-color:var(--navbar-background-color);
- color:var(--navbar-text-color);
- float:left;
- width:100%;
- clear:right;
- min-height:2.8em;
- padding:10px 0 0 0;
- overflow:hidden;
- font-size:0.857em;
-}
-button#navbar-toggle-button {
- display:none;
-}
-ul.sub-nav-list-small {
- display: none;
-}
-.sub-nav {
- background-color:var(--subnav-background-color);
- float:left;
- width:100%;
- overflow:hidden;
- font-size:0.857em;
-}
-.sub-nav div {
- clear:left;
- float:left;
- padding:6px;
- text-transform:uppercase;
-}
-.sub-nav .sub-nav-list {
- padding-top:4px;
-}
-ul.nav-list {
- display:block;
- margin:0 25px 0 0;
- padding:0;
-}
-ul.sub-nav-list {
- float:left;
- margin:0 25px 0 0;
- padding:0;
-}
-ul.nav-list li {
- list-style:none;
- float:left;
- padding: 5px 6px;
- text-transform:uppercase;
-}
-.sub-nav .nav-list-search {
- float:right;
- margin:0;
- padding:6px;
- clear:none;
- text-align:right;
- position:relative;
-}
-ul.sub-nav-list li {
- list-style:none;
- float:left;
-}
-.top-nav a:link, .top-nav a:active, .top-nav a:visited {
- color:var(--navbar-text-color);
- text-decoration:none;
- text-transform:uppercase;
-}
-.top-nav a:hover {
- color:var(--link-color-active);
-}
-.nav-bar-cell1-rev {
- background-color:var(--selected-background-color);
- color:var(--selected-text-color);
- margin: auto 5px;
-}
-.skip-nav {
- position:absolute;
- top:auto;
- left:-9999px;
- overflow:hidden;
-}
-/*
- * Hide navigation links and search box in print layout
- */
-@media print {
- ul.nav-list, div.sub-nav {
- display:none;
- }
-}
-/*
- * Styles for page header.
- */
-.title {
- color:var(--title-color);
- margin:10px 0;
-}
-.sub-title {
- margin:5px 0 0 0;
-}
-ul.contents-list {
- margin: 0 0 15px 0;
- padding: 0;
- list-style: none;
-}
-ul.contents-list li {
- font-size:0.93em;
-}
-/*
- * Styles for headings.
- */
-body.class-declaration-page .summary h2,
-body.class-declaration-page .details h2,
-body.class-use-page h2,
-body.module-declaration-page .block-list h2 {
- font-style: italic;
- padding:0;
- margin:15px 0;
-}
-body.class-declaration-page .summary h3,
-body.class-declaration-page .details h3,
-body.class-declaration-page .summary .inherited-list h2 {
- background-color:var(--subnav-background-color);
- border:1px solid var(--border-color);
- margin:0 0 6px -8px;
- padding:7px 5px;
-}
-/*
- * Styles for page layout containers.
- */
-main {
- clear:both;
- padding:10px 20px;
- position:relative;
-}
-dl.notes > dt {
- font-family: var(--body-font-family);
- font-size:0.856em;
- font-weight:bold;
- margin:10px 0 0 0;
- color:var(--body-text-color);
-}
-dl.notes > dd {
- margin:5px 10px 10px 0;
- font-size:1em;
- font-family:var(--block-font-family)
-}
-dl.name-value > dt {
- margin-left:1px;
- font-size:1.1em;
- display:inline;
- font-weight:bold;
-}
-dl.name-value > dd {
- margin:0 0 0 1px;
- font-size:1.1em;
- display:inline;
-}
-/*
- * Styles for lists.
- */
-li.circle {
- list-style:circle;
-}
-ul.horizontal li {
- display:inline;
- font-size:0.9em;
-}
-div.inheritance {
- margin:0;
- padding:0;
-}
-div.inheritance div.inheritance {
- margin-left:2em;
-}
-ul.block-list,
-ul.details-list,
-ul.member-list,
-ul.summary-list {
- margin:10px 0 10px 0;
- padding:0;
-}
-ul.block-list > li,
-ul.details-list > li,
-ul.member-list > li,
-ul.summary-list > li {
- list-style:none;
- margin-bottom:15px;
- line-height:1.4;
-}
-ul.ref-list {
- padding:0;
- margin:0;
-}
-ul.ref-list > li {
- list-style:none;
-}
-.summary-table dl, .summary-table dl dt, .summary-table dl dd {
- margin-top:0;
- margin-bottom:1px;
-}
-ul.tag-list, ul.tag-list-long {
- padding-left: 0;
- list-style: none;
-}
-ul.tag-list li {
- display: inline;
-}
-ul.tag-list li:not(:last-child):after,
-ul.tag-list-long li:not(:last-child):after
-{
- content: ", ";
- white-space: pre-wrap;
-}
-ul.preview-feature-list {
- list-style: none;
- margin:0;
- padding:0.1em;
- line-height: 1.6em;
-}
-/*
- * Styles for tables.
- */
-.summary-table, .details-table {
- width:100%;
- border-spacing:0;
- border:1px solid var(--border-color);
- border-top:0;
- padding:0;
-}
-.caption {
- position:relative;
- text-align:left;
- background-repeat:no-repeat;
- color:var(--selected-text-color);
- clear:none;
- overflow:hidden;
- padding: 10px 0 0 1px;
- margin:0;
-}
-.caption a:link, .caption a:visited {
- color:var(--selected-link-color);
-}
-.caption a:hover,
-.caption a:active {
- color:var(--navbar-text-color);
-}
-.caption span {
- font-weight:bold;
- white-space:nowrap;
- padding:5px 12px 7px 12px;
- display:inline-block;
- float:left;
- background-color:var(--selected-background-color);
- border: none;
- height:16px;
-}
-div.table-tabs {
- padding:10px 0 0 1px;
- margin:10px 0 0 0;
-}
-div.table-tabs > button {
- border: none;
- cursor: pointer;
- padding: 5px 12px 7px 12px;
- font-weight: bold;
- margin-right: 8px;
-}
-div.table-tabs > .active-table-tab {
- background: var(--selected-background-color);
- color: var(--selected-text-color);
-}
-div.table-tabs > button.table-tab {
- background: var(--navbar-background-color);
- color: var(--navbar-text-color);
-}
-.two-column-search-results {
- display: grid;
- grid-template-columns: minmax(400px, max-content) minmax(400px, auto);
-}
-div.checkboxes {
- line-height: 2em;
-}
-div.checkboxes > span {
- margin-left: 10px;
-}
-div.checkboxes > label {
- margin-left: 8px;
- white-space: nowrap;
-}
-div.checkboxes > label > input {
- margin: 0 2px;
-}
-.two-column-summary {
- display: grid;
- grid-template-columns: minmax(25%, max-content) minmax(25%, auto);
-}
-.three-column-summary {
- display: grid;
- grid-template-columns: minmax(15%, max-content) minmax(20%, max-content) minmax(20%, auto);
-}
-.three-column-release-summary {
- display: grid;
- grid-template-columns: minmax(40%, max-content) minmax(10%, max-content) minmax(40%, auto);
-}
-.four-column-summary {
- display: grid;
- grid-template-columns: minmax(10%, max-content) minmax(15%, max-content) minmax(15%, max-content) minmax(15%, auto);
-}
-@media screen and (max-width: 1000px) {
- .four-column-summary {
- display: grid;
- grid-template-columns: minmax(15%, max-content) minmax(15%, auto);
- }
-}
-@media screen and (max-width: 800px) {
- .two-column-search-results {
- display: grid;
- grid-template-columns: minmax(40%, max-content) minmax(40%, auto);
- }
- .three-column-summary {
- display: grid;
- grid-template-columns: minmax(10%, max-content) minmax(25%, auto);
- }
- .three-column-release-summary {
- display: grid;
- grid-template-columns: minmax(70%, max-content) minmax(30%, max-content)
- }
- .three-column-summary .col-last,
- .three-column-release-summary .col-last{
- grid-column-end: span 2;
- }
-}
-@media screen and (max-width: 600px) {
- .two-column-summary {
- display: grid;
- grid-template-columns: 1fr;
- }
-}
-.summary-table > div, .details-table > div {
- text-align:left;
- padding: 8px 3px 3px 7px;
- overflow-x: auto;
- scrollbar-width: thin;
-}
-.col-first, .col-second, .col-last, .col-constructor-name, .col-summary-item-name {
- vertical-align:top;
- padding-right:0;
- padding-top:8px;
- padding-bottom:3px;
-}
-.table-header {
- background:var(--subnav-background-color);
- font-weight: bold;
-}
-/* Sortable table columns */
-.table-header[onclick] {
- cursor: pointer;
-}
-.table-header[onclick]::after {
- content:"";
- display:inline-block;
- background-image:url('data:image/svg+xml; utf8, \
- \
- ');
- background-size:100% 100%;
- width:9px;
- height:14px;
- margin-left:4px;
- margin-bottom:-3px;
-}
-.table-header[onclick].sort-asc::after {
- background-image:url('data:image/svg+xml; utf8, \
- \
- ');
-
-}
-.table-header[onclick].sort-desc::after {
- background-image:url('data:image/svg+xml; utf8, \
- \
- ');
-}
-.col-first, .col-first {
- font-size:0.93em;
-}
-.col-second, .col-second, .col-last, .col-constructor-name, .col-summary-item-name, .col-last {
- font-size:0.93em;
-}
-.col-first, .col-second, .col-constructor-name {
- vertical-align:top;
- overflow: auto;
-}
-.col-last {
- white-space:normal;
-}
-.col-first a:link, .col-first a:visited,
-.col-second a:link, .col-second a:visited,
-.col-first a:link, .col-first a:visited,
-.col-second a:link, .col-second a:visited,
-.col-constructor-name a:link, .col-constructor-name a:visited,
-.col-summary-item-name a:link, .col-summary-item-name a:visited {
- font-weight:bold;
-}
-.even-row-color, .even-row-color .table-header {
- background-color:var(--even-row-color);
-}
-.odd-row-color, .odd-row-color .table-header {
- background-color:var(--odd-row-color);
-}
-/*
- * Styles for contents.
- */
-div.block {
- font-size:var(--body-font-size);
- font-family:var(--block-font-family);
-}
-.col-last div {
- padding-top:0;
-}
-.col-last a {
- padding-bottom:3px;
-}
-.module-signature,
-.package-signature,
-.type-signature,
-.member-signature {
- font-family:var(--code-font-family);
- font-size:1em;
- margin:14px 0;
- white-space: pre-wrap;
-}
-.module-signature,
-.package-signature,
-.type-signature {
- margin-top: 0;
-}
-.member-signature .type-parameters-long,
-.member-signature .parameters,
-.member-signature .exceptions {
- display: inline-block;
- vertical-align: top;
- white-space: pre;
-}
-.member-signature .type-parameters {
- white-space: normal;
-}
-/*
- * Styles for formatting effect.
- */
-.source-line-no {
- /* Color of line numbers in source pages can be set via custom property below */
- color:var(--source-linenumber-color, green);
- padding:0 30px 0 0;
-}
-.block {
- display:block;
- margin:0 10px 5px 0;
- color:var(--block-text-color);
-}
-.deprecated-label, .description-from-type-label, .implementation-label, .member-name-link,
-.module-label-in-package, .module-label-in-type, .package-label-in-type,
-.package-hierarchy-label, .type-name-label, .type-name-link, .search-tag-link, .preview-label {
- font-weight:bold;
-}
-.deprecation-comment, .help-footnote, .preview-comment {
- font-style:italic;
-}
-.deprecation-block {
- font-size:1em;
- font-family:var(--block-font-family);
- border-style:solid;
- border-width:thin;
- border-radius:10px;
- padding:10px;
- margin-bottom:10px;
- margin-right:10px;
- display:inline-block;
-}
-.preview-block {
- font-size:1em;
- font-family:var(--block-font-family);
- border-style:solid;
- border-width:thin;
- border-radius:10px;
- padding:10px;
- margin-bottom:10px;
- margin-right:10px;
- display:inline-block;
-}
-div.block div.deprecation-comment {
- font-style:normal;
-}
-details.invalid-tag, span.invalid-tag {
- font-size:1em;
- font-family:var(--block-font-family);
- color: var(--invalid-tag-text-color);
- background: var(--invalid-tag-background-color);
- border: thin solid var(--table-border-color);
- border-radius:2px;
- padding: 2px 4px;
- display:inline-block;
-}
-details summary {
- cursor: pointer;
-}
-/*
- * Styles specific to HTML5 elements.
- */
-main, nav, header, footer, section {
- display:block;
-}
-/*
- * Styles for javadoc search.
- */
-.ui-state-active {
- /* Overrides the color of selection used in jQuery UI */
- background: var(--selected-background-color);
- border: 1px solid var(--selected-background-color);
- color: var(--selected-text-color);
-}
-.ui-autocomplete-category {
- font-weight:bold;
- font-size:15px;
- padding:7px 0 7px 3px;
- background-color:var(--navbar-background-color);
- color:var(--navbar-text-color);
-}
-.ui-autocomplete {
- max-height:85%;
- max-width:65%;
- overflow-y:auto;
- overflow-x:auto;
- scrollbar-width: thin;
- white-space:nowrap;
- box-shadow: 0 3px 6px rgba(0,0,0,0.16), 0 3px 6px rgba(0,0,0,0.23);
-}
-ul.ui-autocomplete {
- position:fixed;
- z-index:1;
- background-color: var(--body-background-color);
-}
-ul.ui-autocomplete li {
- float:left;
- clear:both;
- min-width:100%;
-}
-ul.ui-autocomplete li.ui-static-link {
- position:sticky;
- bottom:0;
- left:0;
- background: var(--subnav-background-color);
- padding: 5px 0;
- font-family: var(--body-font-family);
- font-size: 0.93em;
- font-weight: bolder;
- z-index: 2;
-}
-li.ui-static-link a, li.ui-static-link a:visited {
- text-decoration:none;
- color:var(--link-color);
- float:right;
- margin-right:20px;
-}
-.ui-autocomplete .result-item {
- font-size: inherit;
-}
-.ui-autocomplete .result-highlight {
- font-weight:bold;
-}
-#search-input, #page-search-input {
- background-image:url('resources/glass.png');
- background-size:13px;
- background-repeat:no-repeat;
- background-position:2px 3px;
- background-color: var(--search-input-background-color);
- color: var(--search-input-text-color);
- border-color: var(--border-color);
- padding-left:20px;
- width: 250px;
- margin: 0;
-}
-#search-input {
- margin-left: 4px;
-}
-#reset-button {
- background-color: transparent;
- background-image:url('resources/x.png');
- background-repeat:no-repeat;
- background-size:contain;
- border:0;
- border-radius:0;
- width:12px;
- height:12px;
- position:absolute;
- right:12px;
- top:10px;
- font-size:0;
-}
-::placeholder {
- color:var(--search-input-placeholder-color);
- opacity: 1;
-}
-.search-tag-desc-result {
- font-style:italic;
- font-size:11px;
-}
-.search-tag-holder-result {
- font-style:italic;
- font-size:12px;
-}
-.search-tag-result:target {
- background-color:var(--search-tag-highlight-color);
-}
-details.page-search-details {
- display: inline-block;
-}
-div#result-container {
- font-size: 1em;
-}
-div#result-container a.search-result-link {
- padding: 0;
- margin: 4px 0;
- width: 100%;
-}
-#result-container .result-highlight {
- font-weight:bolder;
-}
-.page-search-info {
- background-color: var(--subnav-background-color);
- border-radius: 3px;
- border: 0 solid var(--border-color);
- padding: 0 8px;
- overflow: hidden;
- height: 0;
- transition: all 0.2s ease;
-}
-div.table-tabs > button.table-tab {
- background: var(--navbar-background-color);
- color: var(--navbar-text-color);
-}
-.page-search-header {
- padding: 5px 12px 7px 12px;
- font-weight: bold;
- margin-right: 3px;
- background-color:var(--navbar-background-color);
- color:var(--navbar-text-color);
- display: inline-block;
-}
-button.page-search-header {
- border: none;
- cursor: pointer;
-}
-span#page-search-link {
- text-decoration: underline;
-}
-.module-graph span, .sealed-graph span {
- display:none;
- position:absolute;
-}
-.module-graph:hover span, .sealed-graph:hover span {
- display:block;
- margin: -100px 0 0 100px;
- z-index: 1;
-}
-.inherited-list {
- margin: 10px 0 10px 0;
-}
-section.class-description {
- line-height: 1.4;
-}
-.summary section[class$="-summary"], .details section[class$="-details"],
-.class-uses .detail, .serialized-class-details {
- padding: 0 20px 5px 10px;
- border: 1px solid var(--border-color);
- background-color: var(--section-background-color);
-}
-.inherited-list, section[class$="-details"] .detail {
- padding:0 0 5px 8px;
- background-color:var(--detail-background-color);
- border:none;
-}
-.vertical-separator {
- padding: 0 5px;
-}
-ul.help-section-list {
- margin: 0;
-}
-ul.help-subtoc > li {
- display: inline-block;
- padding-right: 5px;
- font-size: smaller;
-}
-ul.help-subtoc > li::before {
- content: "\2022" ;
- padding-right:2px;
-}
-.help-note {
- font-style: italic;
-}
-/*
- * Indicator icon for external links.
- */
-main a[href*="://"]::after {
- content:"";
- display:inline-block;
- background-image:url('data:image/svg+xml; utf8, \
- \
- ');
- background-size:100% 100%;
- width:7px;
- height:7px;
- margin-left:2px;
- margin-bottom:4px;
-}
-main a[href*="://"]:hover::after,
-main a[href*="://"]:focus::after {
- background-image:url('data:image/svg+xml; utf8, \
- \
- ');
-}
-/*
- * Styles for header/section anchor links
- */
-a.anchor-link {
- opacity: 0;
- transition: opacity 0.1s;
-}
-:hover > a.anchor-link {
- opacity: 80%;
-}
-a.anchor-link:hover,
-a.anchor-link:focus-visible,
-a.anchor-link.visible {
- opacity: 100%;
-}
-a.anchor-link > img {
- width: 0.9em;
- height: 0.9em;
-}
-/*
- * Styles for copy-to-clipboard buttons
- */
-button.copy {
- opacity: 70%;
- border: none;
- border-radius: 3px;
- position: relative;
- background:none;
- transition: opacity 0.3s;
- cursor: pointer;
-}
-:hover > button.copy {
- opacity: 80%;
-}
-button.copy:hover,
-button.copy:active,
-button.copy:focus-visible,
-button.copy.visible {
- opacity: 100%;
-}
-button.copy img {
- position: relative;
- background: none;
- filter: brightness(var(--copy-icon-brightness));
-}
-button.copy:active {
- background-color: var(--copy-button-background-color-active);
-}
-button.copy span {
- color: var(--body-text-color);
- position: relative;
- top: -0.1em;
- transition: all 0.1s;
- font-size: 0.76rem;
- line-height: 1.2em;
- opacity: 0;
-}
-button.copy:hover span,
-button.copy:focus-visible span,
-button.copy.visible span {
- opacity: 100%;
-}
-/* search page copy button */
-button#page-search-copy {
- margin-left: 0.4em;
- padding:0.3em;
- top:0.13em;
-}
-button#page-search-copy img {
- width: 1.2em;
- height: 1.2em;
- padding: 0.01em 0;
- top: 0.15em;
-}
-button#page-search-copy span {
- color: var(--body-text-color);
- line-height: 1.2em;
- padding: 0.2em;
- top: -0.18em;
-}
-div.page-search-info:hover button#page-search-copy span {
- opacity: 100%;
-}
-/* snippet copy button */
-button.snippet-copy {
- position: absolute;
- top: 6px;
- right: 6px;
- height: 1.7em;
- padding: 2px;
-}
-button.snippet-copy img {
- width: 18px;
- height: 18px;
- padding: 0.05em 0;
-}
-button.snippet-copy span {
- line-height: 1.2em;
- padding: 0.2em;
- position: relative;
- top: -0.5em;
-}
-div.snippet-container:hover button.snippet-copy span {
- opacity: 100%;
-}
-/*
- * Styles for user-provided tables.
- *
- * borderless:
- * No borders, vertical margins, styled caption.
- * This style is provided for use with existing doc comments.
- * In general, borderless tables should not be used for layout purposes.
- *
- * plain:
- * Plain borders around table and cells, vertical margins, styled caption.
- * Best for small tables or for complex tables for tables with cells that span
- * rows and columns, when the "striped" style does not work well.
- *
- * striped:
- * Borders around the table and vertical borders between cells, striped rows,
- * vertical margins, styled caption.
- * Best for tables that have a header row, and a body containing a series of simple rows.
- */
-
-table.borderless,
-table.plain,
-table.striped {
- margin-top: 10px;
- margin-bottom: 10px;
-}
-table.borderless > caption,
-table.plain > caption,
-table.striped > caption {
- font-weight: bold;
- font-size: smaller;
-}
-table.borderless th, table.borderless td,
-table.plain th, table.plain td,
-table.striped th, table.striped td {
- padding: 2px 5px;
-}
-table.borderless,
-table.borderless > thead > tr > th, table.borderless > tbody > tr > th, table.borderless > tr > th,
-table.borderless > thead > tr > td, table.borderless > tbody > tr > td, table.borderless > tr > td {
- border: none;
-}
-table.borderless > thead > tr, table.borderless > tbody > tr, table.borderless > tr {
- background-color: transparent;
-}
-table.plain {
- border-collapse: collapse;
- border: 1px solid var(--table-border-color);
-}
-table.plain > thead > tr, table.plain > tbody tr, table.plain > tr {
- background-color: transparent;
-}
-table.plain > thead > tr > th, table.plain > tbody > tr > th, table.plain > tr > th,
-table.plain > thead > tr > td, table.plain > tbody > tr > td, table.plain > tr > td {
- border: 1px solid var(--table-border-color);
-}
-table.striped {
- border-collapse: collapse;
- border: 1px solid var(--table-border-color);
-}
-table.striped > thead {
- background-color: var(--subnav-background-color);
-}
-table.striped > thead > tr > th, table.striped > thead > tr > td {
- border: 1px solid var(--table-border-color);
-}
-table.striped > tbody > tr:nth-child(even) {
- background-color: var(--odd-row-color)
-}
-table.striped > tbody > tr:nth-child(odd) {
- background-color: var(--even-row-color)
-}
-table.striped > tbody > tr > th, table.striped > tbody > tr > td {
- border-left: 1px solid var(--table-border-color);
- border-right: 1px solid var(--table-border-color);
-}
-table.striped > tbody > tr > th {
- font-weight: normal;
-}
-/**
- * Tweak style for small screens.
- */
-@media screen and (max-width: 920px) {
- header.flex-header {
- max-height: 100vh;
- overflow-y: auto;
- }
- div#navbar-top {
- height: 2.8em;
- transition: height 0.35s ease;
- }
- ul.nav-list {
- display: block;
- width: 40%;
- float:left;
- clear: left;
- margin: 10px 0 0 0;
- padding: 0;
- }
- ul.nav-list li {
- float: none;
- padding: 6px;
- margin-left: 10px;
- margin-top: 2px;
- }
- ul.sub-nav-list-small {
- display:block;
- height: 100%;
- width: 50%;
- float: right;
- clear: right;
- background-color: var(--subnav-background-color);
- color: var(--body-text-color);
- margin: 6px 0 0 0;
- padding: 0;
- }
- ul.sub-nav-list-small ul {
- padding-left: 20px;
- }
- ul.sub-nav-list-small a:link, ul.sub-nav-list-small a:visited {
- color:var(--link-color);
- }
- ul.sub-nav-list-small a:hover {
- color:var(--link-color-active);
- }
- ul.sub-nav-list-small li {
- list-style:none;
- float:none;
- padding: 6px;
- margin-top: 1px;
- text-transform:uppercase;
- }
- ul.sub-nav-list-small > li {
- margin-left: 10px;
- }
- ul.sub-nav-list-small li p {
- margin: 5px 0;
- }
- div#navbar-sub-list {
- display: none;
- }
- .top-nav a:link, .top-nav a:active, .top-nav a:visited {
- display: block;
- }
- button#navbar-toggle-button {
- width: 3.4em;
- height: 2.8em;
- background-color: transparent;
- display: block;
- float: left;
- border: 0;
- margin: 0 10px;
- cursor: pointer;
- font-size: 10px;
- }
- button#navbar-toggle-button .nav-bar-toggle-icon {
- display: block;
- width: 24px;
- height: 3px;
- margin: 1px 0 4px 0;
- border-radius: 2px;
- transition: all 0.1s;
- background-color: var(--navbar-text-color);
- }
- button#navbar-toggle-button.expanded span.nav-bar-toggle-icon:nth-child(1) {
- transform: rotate(45deg);
- transform-origin: 10% 10%;
- width: 26px;
- }
- button#navbar-toggle-button.expanded span.nav-bar-toggle-icon:nth-child(2) {
- opacity: 0;
- }
- button#navbar-toggle-button.expanded span.nav-bar-toggle-icon:nth-child(3) {
- transform: rotate(-45deg);
- transform-origin: 10% 90%;
- width: 26px;
- }
-}
-@media screen and (max-width: 800px) {
- .about-language {
- padding-right: 16px;
- }
- ul.nav-list li {
- margin-left: 5px;
- }
- ul.sub-nav-list-small > li {
- margin-left: 5px;
- }
- main {
- padding: 10px;
- }
- .summary section[class$="-summary"], .details section[class$="-details"],
- .class-uses .detail, .serialized-class-details {
- padding: 0 8px 5px 8px;
- }
- body {
- -webkit-text-size-adjust: none;
- }
-}
-@media screen and (max-width: 400px) {
- .about-language {
- font-size: 10px;
- padding-right: 12px;
- }
-}
-@media screen and (max-width: 400px) {
- .nav-list-search {
- width: 94%;
- }
- #search-input, #page-search-input {
- width: 70%;
- }
-}
-@media screen and (max-width: 320px) {
- .nav-list-search > label {
- display: none;
- }
- .nav-list-search {
- width: 90%;
- }
- #search-input, #page-search-input {
- width: 80%;
- }
-}
-
-pre.snippet {
- background-color: var(--snippet-background-color);
- color: var(--snippet-text-color);
- padding: 10px;
- margin: 12px 0;
- overflow: auto;
- white-space: pre;
-}
-div.snippet-container {
- position: relative;
-}
-@media screen and (max-width: 800px) {
- pre.snippet {
- padding-top: 26px;
- }
- button.snippet-copy {
- top: 4px;
- right: 4px;
- }
-}
-pre.snippet .italic {
- font-style: italic;
-}
-pre.snippet .bold {
- font-weight: bold;
-}
-pre.snippet .highlighted {
- background-color: var(--snippet-highlight-color);
- border-radius: 10%;
-}
+/*
+ * Javadoc style sheet
+ */
+
+@import url('resources/fonts/dejavu.css');
+
+/*
+ * Styles for individual HTML elements.
+ *
+ * These are styles that are specific to individual HTML elements. Changing them affects the style of a particular
+ * HTML element throughout the page.
+ */
+
+body {
+ background-color:#ffffff;
+ color:#353833;
+ font-family:'DejaVu Sans', Arial, Helvetica, sans-serif;
+ font-size:14px;
+ margin:0;
+ padding:0;
+ height:100%;
+ width:100%;
+}
+iframe {
+ margin:0;
+ padding:0;
+ height:100%;
+ width:100%;
+ overflow-y:scroll;
+ border:none;
+}
+a:link, a:visited {
+ text-decoration:none;
+ color:#4A6782;
+}
+a[href]:hover, a[href]:focus {
+ text-decoration:none;
+ color:#bb7a2a;
+}
+a[name] {
+ color:#353833;
+}
+pre {
+ font-family:'DejaVu Sans Mono', monospace;
+ font-size:14px;
+}
+h1 {
+ font-size:20px;
+}
+h2 {
+ font-size:18px;
+}
+h3 {
+ font-size:16px;
+}
+h4 {
+ font-size:15px;
+}
+h5 {
+ font-size:14px;
+}
+h6 {
+ font-size:13px;
+}
+ul {
+ list-style-type:disc;
+}
+code, tt {
+ font-family:'DejaVu Sans Mono', monospace;
+}
+:not(h1, h2, h3, h4, h5, h6) > code,
+:not(h1, h2, h3, h4, h5, h6) > tt {
+ font-size:14px;
+ padding-top:4px;
+ margin-top:8px;
+ line-height:1.4em;
+}
+dt code {
+ font-family:'DejaVu Sans Mono', monospace;
+ font-size:14px;
+ padding-top:4px;
+}
+.summary-table dt code {
+ font-family:'DejaVu Sans Mono', monospace;
+ font-size:14px;
+ vertical-align:top;
+ padding-top:4px;
+}
+sup {
+ font-size:8px;
+}
+button {
+ font-family: 'DejaVu Sans', Arial, Helvetica, sans-serif;
+ font-size: 14px;
+}
+/*
+ * Styles for HTML generated by javadoc.
+ *
+ * These are style classes that are used by the standard doclet to generate HTML documentation.
+ */
+
+/*
+ * Styles for document title and copyright.
+ */
+.clear {
+ clear:both;
+ height:0;
+ overflow:hidden;
+}
+.about-language {
+ float:right;
+ padding:0 21px 8px 8px;
+ font-size:11px;
+ margin-top:-9px;
+ height:2.9em;
+}
+.legal-copy {
+ margin-left:.5em;
+}
+.tab {
+ background-color:#0066FF;
+ color:#ffffff;
+ padding:8px;
+ width:5em;
+ font-weight:bold;
+}
+/*
+ * Styles for navigation bar.
+ */
+@media screen {
+ .flex-box {
+ position:fixed;
+ display:flex;
+ flex-direction:column;
+ height: 100%;
+ width: 100%;
+ }
+ .flex-header {
+ flex: 0 0 auto;
+ }
+ .flex-content {
+ flex: 1 1 auto;
+ overflow-y: auto;
+ }
+}
+.top-nav {
+ background-color:#4D7A97;
+ color:#FFFFFF;
+ float:left;
+ padding:0;
+ width:100%;
+ clear:right;
+ min-height:2.8em;
+ padding-top:10px;
+ overflow:hidden;
+ font-size:12px;
+}
+.sub-nav {
+ background-color:#dee3e9;
+ float:left;
+ width:100%;
+ overflow:hidden;
+ font-size:12px;
+}
+.sub-nav div {
+ clear:left;
+ float:left;
+ padding:0 0 5px 6px;
+ text-transform:uppercase;
+}
+.sub-nav .nav-list {
+ padding-top:5px;
+}
+ul.nav-list {
+ display:block;
+ margin:0 25px 0 0;
+ padding:0;
+}
+ul.sub-nav-list {
+ float:left;
+ margin:0 25px 0 0;
+ padding:0;
+}
+ul.nav-list li {
+ list-style:none;
+ float:left;
+ padding: 5px 6px;
+ text-transform:uppercase;
+}
+.sub-nav .nav-list-search {
+ float:right;
+ margin:0 0 0 0;
+ padding:5px 6px;
+ clear:none;
+}
+.nav-list-search label {
+ position:relative;
+ right:-16px;
+}
+ul.sub-nav-list li {
+ list-style:none;
+ float:left;
+ padding-top:10px;
+}
+.top-nav a:link, .top-nav a:active, .top-nav a:visited {
+ color:#FFFFFF;
+ text-decoration:none;
+ text-transform:uppercase;
+}
+.top-nav a:hover {
+ text-decoration:none;
+ color:#bb7a2a;
+ text-transform:uppercase;
+}
+.nav-bar-cell1-rev {
+ background-color:#F8981D;
+ color:#253441;
+ margin: auto 5px;
+}
+.skip-nav {
+ position:absolute;
+ top:auto;
+ left:-9999px;
+ overflow:hidden;
+}
+/*
+ * Hide navigation links and search box in print layout
+ */
+@media print {
+ ul.nav-list, div.sub-nav {
+ display:none;
+ }
+}
+/*
+ * Styles for page header and footer.
+ */
+.title {
+ color:#2c4557;
+ margin:10px 0;
+}
+.sub-title {
+ margin:5px 0 0 0;
+}
+.header ul {
+ margin:0 0 15px 0;
+ padding:0;
+}
+.header ul li, .footer ul li {
+ list-style:none;
+ font-size:13px;
+}
+/*
+ * Styles for headings.
+ */
+body.class-declaration-page .summary h2,
+body.class-declaration-page .details h2,
+body.class-use-page h2,
+body.module-declaration-page .block-list h2 {
+ font-style: italic;
+ padding:0;
+ margin:15px 0;
+}
+body.class-declaration-page .summary h3,
+body.class-declaration-page .details h3,
+body.class-declaration-page .summary .inherited-list h2 {
+ background-color:#dee3e9;
+ border:1px solid #d0d9e0;
+ margin:0 0 6px -8px;
+ padding:7px 5px;
+}
+/*
+ * Styles for page layout containers.
+ */
+main {
+ clear:both;
+ padding:10px 20px;
+ position:relative;
+}
+dl.notes > dt {
+ font-family: 'DejaVu Sans', Arial, Helvetica, sans-serif;
+ font-size:12px;
+ font-weight:bold;
+ margin:10px 0 0 0;
+ color:#4E4E4E;
+}
+dl.notes > dd {
+ margin:5px 10px 10px 0;
+ font-size:14px;
+ font-family:'DejaVu Serif', Georgia, "Times New Roman", Times, serif;
+}
+dl.name-value > dt {
+ margin-left:1px;
+ font-size:1.1em;
+ display:inline;
+ font-weight:bold;
+}
+dl.name-value > dd {
+ margin:0 0 0 1px;
+ font-size:1.1em;
+ display:inline;
+}
+/*
+ * Styles for lists.
+ */
+li.circle {
+ list-style:circle;
+}
+ul.horizontal li {
+ display:inline;
+ font-size:0.9em;
+}
+div.inheritance {
+ margin:0;
+ padding:0;
+}
+div.inheritance div.inheritance {
+ margin-left:2em;
+}
+ul.block-list,
+ul.details-list,
+ul.member-list,
+ul.summary-list {
+ margin:10px 0 10px 0;
+ padding:0;
+}
+ul.block-list > li,
+ul.details-list > li,
+ul.member-list > li,
+ul.summary-list > li {
+ list-style:none;
+ margin-bottom:15px;
+ line-height:1.4;
+}
+.summary-table dl, .summary-table dl dt, .summary-table dl dd {
+ margin-top:0;
+ margin-bottom:1px;
+}
+ul.see-list, ul.see-list-long {
+ padding-left: 0;
+ list-style: none;
+}
+ul.see-list li {
+ display: inline;
+}
+ul.see-list li:not(:last-child):after,
+ul.see-list-long li:not(:last-child):after {
+ content: ", ";
+ white-space: pre-wrap;
+}
+/*
+ * Styles for tables.
+ */
+.summary-table, .details-table {
+ width:100%;
+ border-spacing:0;
+ border-left:1px solid #EEE;
+ border-right:1px solid #EEE;
+ border-bottom:1px solid #EEE;
+ padding:0;
+}
+.caption {
+ position:relative;
+ text-align:left;
+ background-repeat:no-repeat;
+ color:#253441;
+ font-weight:bold;
+ clear:none;
+ overflow:hidden;
+ padding:0;
+ padding-top:10px;
+ padding-left:1px;
+ margin:0;
+ white-space:pre;
+}
+.caption a:link, .caption a:visited {
+ color:#1f389c;
+}
+.caption a:hover,
+.caption a:active {
+ color:#FFFFFF;
+}
+.caption span {
+ white-space:nowrap;
+ padding-top:5px;
+ padding-left:12px;
+ padding-right:12px;
+ padding-bottom:7px;
+ display:inline-block;
+ float:left;
+ background-color:#F8981D;
+ border: none;
+ height:16px;
+}
+div.table-tabs {
+ padding:10px 0 0 1px;
+ margin:0;
+}
+div.table-tabs > button {
+ border: none;
+ cursor: pointer;
+ padding: 5px 12px 7px 12px;
+ font-weight: bold;
+ margin-right: 3px;
+}
+div.table-tabs > button.active-table-tab {
+ background: #F8981D;
+ color: #253441;
+}
+div.table-tabs > button.table-tab {
+ background: #4D7A97;
+ color: #FFFFFF;
+}
+.two-column-summary {
+ display: grid;
+ grid-template-columns: minmax(15%, max-content) minmax(15%, auto);
+}
+.three-column-summary {
+ display: grid;
+ grid-template-columns: minmax(10%, max-content) minmax(15%, max-content) minmax(15%, auto);
+}
+.four-column-summary {
+ display: grid;
+ grid-template-columns: minmax(10%, max-content) minmax(10%, max-content) minmax(10%, max-content) minmax(10%, auto);
+}
+@media screen and (max-width: 600px) {
+ .two-column-summary {
+ display: grid;
+ grid-template-columns: 1fr;
+ }
+}
+@media screen and (max-width: 800px) {
+ .three-column-summary {
+ display: grid;
+ grid-template-columns: minmax(10%, max-content) minmax(25%, auto);
+ }
+ .three-column-summary .col-last {
+ grid-column-end: span 2;
+ }
+}
+@media screen and (max-width: 1000px) {
+ .four-column-summary {
+ display: grid;
+ grid-template-columns: minmax(15%, max-content) minmax(15%, auto);
+ }
+}
+.summary-table > div, .details-table > div {
+ text-align:left;
+ padding: 8px 3px 3px 7px;
+}
+.col-first, .col-second, .col-last, .col-constructor-name, .col-summary-item-name {
+ vertical-align:top;
+ padding-right:0;
+ padding-top:8px;
+ padding-bottom:3px;
+}
+.table-header {
+ background:#dee3e9;
+ font-weight: bold;
+}
+.col-first, .col-first {
+ font-size:13px;
+}
+.col-second, .col-second, .col-last, .col-constructor-name, .col-summary-item-name, .col-last {
+ font-size:13px;
+}
+.col-first, .col-second, .col-constructor-name {
+ vertical-align:top;
+ overflow: auto;
+}
+.col-last {
+ white-space:normal;
+}
+.col-first a:link, .col-first a:visited,
+.col-second a:link, .col-second a:visited,
+.col-first a:link, .col-first a:visited,
+.col-second a:link, .col-second a:visited,
+.col-constructor-name a:link, .col-constructor-name a:visited,
+.col-summary-item-name a:link, .col-summary-item-name a:visited,
+.constant-values-container a:link, .constant-values-container a:visited,
+.all-classes-container a:link, .all-classes-container a:visited,
+.all-packages-container a:link, .all-packages-container a:visited {
+ font-weight:bold;
+}
+.table-sub-heading-color {
+ background-color:#EEEEFF;
+}
+.even-row-color, .even-row-color .table-header {
+ background-color:#FFFFFF;
+}
+.odd-row-color, .odd-row-color .table-header {
+ background-color:#EEEEEF;
+}
+/*
+ * Styles for contents.
+ */
+.deprecated-content {
+ margin:0;
+ padding:10px 0;
+}
+div.block {
+ font-size:14px;
+ font-family:'DejaVu Serif', Georgia, "Times New Roman", Times, serif;
+}
+.col-last div {
+ padding-top:0;
+}
+.col-last a {
+ padding-bottom:3px;
+}
+.module-signature,
+.package-signature,
+.type-signature,
+.member-signature {
+ font-family:'DejaVu Sans Mono', monospace;
+ font-size:14px;
+ margin:14px 0;
+ white-space: pre-wrap;
+}
+.module-signature,
+.package-signature,
+.type-signature {
+ margin-top: 0;
+}
+.member-signature .type-parameters-long,
+.member-signature .parameters,
+.member-signature .exceptions {
+ display: inline-block;
+ vertical-align: top;
+ white-space: pre;
+}
+.member-signature .type-parameters {
+ white-space: normal;
+}
+/*
+ * Styles for formatting effect.
+ */
+.source-line-no {
+ color:green;
+ padding:0 30px 0 0;
+}
+h1.hidden {
+ visibility:hidden;
+ overflow:hidden;
+ font-size:10px;
+}
+.block {
+ display:block;
+ margin:0 10px 5px 0;
+ color:#474747;
+}
+.deprecated-label, .descfrm-type-label, .implementation-label, .member-name-label, .member-name-link,
+.module-label-in-package, .module-label-in-type, .override-specify-label, .package-label-in-type,
+.package-hierarchy-label, .type-name-label, .type-name-link, .search-tag-link, .preview-label {
+ font-weight:bold;
+}
+.deprecation-comment, .help-footnote, .preview-comment {
+ font-style:italic;
+}
+.deprecation-block {
+ font-size:14px;
+ font-family:'DejaVu Serif', Georgia, "Times New Roman", Times, serif;
+ border-style:solid;
+ border-width:thin;
+ border-radius:10px;
+ padding:10px;
+ margin-bottom:10px;
+ margin-right:10px;
+ display:inline-block;
+}
+.preview-block {
+ font-size:14px;
+ font-family:'DejaVu Serif', Georgia, "Times New Roman", Times, serif;
+ border-style:solid;
+ border-width:thin;
+ border-radius:10px;
+ padding:10px;
+ margin-bottom:10px;
+ margin-right:10px;
+ display:inline-block;
+}
+div.block div.deprecation-comment {
+ font-style:normal;
+}
+/*
+ * Styles specific to HTML5 elements.
+ */
+main, nav, header, footer, section {
+ display:block;
+}
+/*
+ * Styles for javadoc search.
+ */
+.ui-autocomplete-category {
+ font-weight:bold;
+ font-size:15px;
+ padding:7px 0 7px 3px;
+ background-color:#4D7A97;
+ color:#FFFFFF;
+}
+.result-item {
+ font-size:13px;
+}
+.ui-autocomplete {
+ max-height:85%;
+ max-width:65%;
+ overflow-y:scroll;
+ overflow-x:scroll;
+ white-space:nowrap;
+ box-shadow: 0 3px 6px rgba(0,0,0,0.16), 0 3px 6px rgba(0,0,0,0.23);
+}
+ul.ui-autocomplete {
+ position:fixed;
+ z-index:999999;
+ background-color: #FFFFFF;
+}
+ul.ui-autocomplete li {
+ float:left;
+ clear:both;
+ width:100%;
+}
+.result-highlight {
+ font-weight:bold;
+}
+.ui-autocomplete .result-item {
+ font-size: inherit;
+}
+#search-input {
+ background-image:url('resources/glass.png');
+ background-size:13px;
+ background-repeat:no-repeat;
+ background-position:2px 3px;
+ padding-left:20px;
+ position:relative;
+ right:-18px;
+ width:400px;
+}
+#reset-button {
+ background-color: rgb(255,255,255);
+ background-image:url('resources/x.png');
+ background-position:center;
+ background-repeat:no-repeat;
+ background-size:12px;
+ border:0 none;
+ width:16px;
+ height:16px;
+ position:relative;
+ left:-4px;
+ top:-4px;
+ font-size:0px;
+}
+.watermark {
+ color:#545454;
+}
+.search-tag-desc-result {
+ font-style:italic;
+ font-size:11px;
+}
+.search-tag-holder-result {
+ font-style:italic;
+ font-size:12px;
+}
+.search-tag-result:target {
+ background-color:yellow;
+}
+.module-graph span {
+ display:none;
+ position:absolute;
+}
+.module-graph:hover span {
+ display:block;
+ margin: -100px 0 0 100px;
+ z-index: 1;
+}
+.inherited-list {
+ margin: 10px 0 10px 0;
+}
+section.class-description {
+ line-height: 1.4;
+}
+.summary section[class$="-summary"], .details section[class$="-details"],
+.class-uses .detail, .serialized-class-details {
+ padding: 0px 20px 5px 10px;
+ border: 1px solid #ededed;
+ background-color: #f8f8f8;
+}
+.inherited-list, section[class$="-details"] .detail {
+ padding:0 0 5px 8px;
+ background-color:#ffffff;
+ border:none;
+}
+.vertical-separator {
+ padding: 0 5px;
+}
+ul.help-section-list {
+ margin: 0;
+}
+ul.help-subtoc > li {
+ display: inline-block;
+ padding-right: 5px;
+ font-size: smaller;
+}
+ul.help-subtoc > li::before {
+ content: "\2022" ;
+ padding-right:2px;
+}
+span.help-note {
+ font-style: italic;
+}
+/*
+ * Indicator icon for external links.
+ */
+main a[href*="://"]::after {
+ content:"";
+ display:inline-block;
+ background-image:url('data:image/svg+xml; utf8, \
+ \
+ ');
+ background-size:100% 100%;
+ width:7px;
+ height:7px;
+ margin-left:2px;
+ margin-bottom:4px;
+}
+main a[href*="://"]:hover::after,
+main a[href*="://"]:focus::after {
+ background-image:url('data:image/svg+xml; utf8, \
+ \
+ ');
+}
+
+/*
+ * Styles for user-provided tables.
+ *
+ * borderless:
+ * No borders, vertical margins, styled caption.
+ * This style is provided for use with existing doc comments.
+ * In general, borderless tables should not be used for layout purposes.
+ *
+ * plain:
+ * Plain borders around table and cells, vertical margins, styled caption.
+ * Best for small tables or for complex tables for tables with cells that span
+ * rows and columns, when the "striped" style does not work well.
+ *
+ * striped:
+ * Borders around the table and vertical borders between cells, striped rows,
+ * vertical margins, styled caption.
+ * Best for tables that have a header row, and a body containing a series of simple rows.
+ */
+
+table.borderless,
+table.plain,
+table.striped {
+ margin-top: 10px;
+ margin-bottom: 10px;
+}
+table.borderless > caption,
+table.plain > caption,
+table.striped > caption {
+ font-weight: bold;
+ font-size: smaller;
+}
+table.borderless th, table.borderless td,
+table.plain th, table.plain td,
+table.striped th, table.striped td {
+ padding: 2px 5px;
+}
+table.borderless,
+table.borderless > thead > tr > th, table.borderless > tbody > tr > th, table.borderless > tr > th,
+table.borderless > thead > tr > td, table.borderless > tbody > tr > td, table.borderless > tr > td {
+ border: none;
+}
+table.borderless > thead > tr, table.borderless > tbody > tr, table.borderless > tr {
+ background-color: transparent;
+}
+table.plain {
+ border-collapse: collapse;
+ border: 1px solid black;
+}
+table.plain > thead > tr, table.plain > tbody tr, table.plain > tr {
+ background-color: transparent;
+}
+table.plain > thead > tr > th, table.plain > tbody > tr > th, table.plain > tr > th,
+table.plain > thead > tr > td, table.plain > tbody > tr > td, table.plain > tr > td {
+ border: 1px solid black;
+}
+table.striped {
+ border-collapse: collapse;
+ border: 1px solid black;
+}
+table.striped > thead {
+ background-color: #E3E3E3;
+}
+table.striped > thead > tr > th, table.striped > thead > tr > td {
+ border: 1px solid black;
+}
+table.striped > tbody > tr:nth-child(even) {
+ background-color: #EEE
+}
+table.striped > tbody > tr:nth-child(odd) {
+ background-color: #FFF
+}
+table.striped > tbody > tr > th, table.striped > tbody > tr > td {
+ border-left: 1px solid black;
+ border-right: 1px solid black;
+}
+table.striped > tbody > tr > th {
+ font-weight: normal;
+}
+/**
+ * Tweak font sizes and paddings for small screens.
+ */
+@media screen and (max-width: 1050px) {
+ #search-input {
+ width: 300px;
+ }
+}
+@media screen and (max-width: 800px) {
+ #search-input {
+ width: 200px;
+ }
+ .top-nav,
+ .bottom-nav {
+ font-size: 11px;
+ padding-top: 6px;
+ }
+ .sub-nav {
+ font-size: 11px;
+ }
+ .about-language {
+ padding-right: 16px;
+ }
+ ul.nav-list li,
+ .sub-nav .nav-list-search {
+ padding: 6px;
+ }
+ ul.sub-nav-list li {
+ padding-top: 5px;
+ }
+ main {
+ padding: 10px;
+ }
+ .summary section[class$="-summary"], .details section[class$="-details"],
+ .class-uses .detail, .serialized-class-details {
+ padding: 0 8px 5px 8px;
+ }
+ body {
+ -webkit-text-size-adjust: none;
+ }
+}
+@media screen and (max-width: 500px) {
+ #search-input {
+ width: 150px;
+ }
+ .top-nav,
+ .bottom-nav {
+ font-size: 10px;
+ }
+ .sub-nav {
+ font-size: 10px;
+ }
+ .about-language {
+ font-size: 10px;
+ padding-right: 12px;
+ }
+}
diff --git a/pi4micronaut-utils/src/docs/javadoc/type-search-index.js b/pi4micronaut-utils/src/docs/javadoc/type-search-index.js
index d2062864..4c122ca3 100644
--- a/pi4micronaut-utils/src/docs/javadoc/type-search-index.js
+++ b/pi4micronaut-utils/src/docs/javadoc/type-search-index.js
@@ -1 +1 @@
-typeSearchIndex = [{"p":"com.opensourcewithslu.outputdevices","l":"ActiveBuzzerHelper"},{"l":"All Classes and Interfaces","u":"allclasses-index.html"},{"p":"com.opensourcewithslu","l":"Application"},{"p":"com.opensourcewithslu.utilities","l":"DigitalInputConfiguration"},{"p":"com.opensourcewithslu.utilities.MultiPinConfigs","l":"DigitalInputMultiPinConfiguration"},{"p":"com.opensourcewithslu.utilities","l":"DigitalOutputConfiguration"},{"p":"com.opensourcewithslu.utilities","l":"i2cConfiguration"},{"p":"com.opensourcewithslu.outputdevices","l":"LCD1602Helper"},{"p":"com.opensourcewithslu.outputdevices","l":"LEDHelper"},{"p":"com.opensourcewithslu.utilities","l":"MultipinConfiguration"},{"p":"com.opensourcewithslu.outputdevices","l":"PassiveBuzzerHelper"},{"p":"com.opensourcewithslu.inputdevices","l":"PhotoResistorHelper"},{"p":"com.opensourcewithslu.utilities","l":"Pi4JFactory"},{"p":"com.opensourcewithslu.utilities","l":"Pi4JMultipinFactory"},{"p":"com.opensourcewithslu.inputdevices","l":"PIRSensorHelper"},{"p":"com.opensourcewithslu.inputdevices","l":"PushButtonHelper"},{"p":"com.opensourcewithslu.utilities","l":"PwmConfiguration"},{"p":"com.opensourcewithslu.utilities.MultiPinConfigs","l":"PwmMultiPinConfiguration"},{"p":"com.opensourcewithslu.inputdevices","l":"RFidHelper"},{"p":"com.opensourcewithslu.outputdevices","l":"RGBLEDHelper"},{"p":"com.opensourcewithslu.inputdevices","l":"RotaryEncoderHelper"},{"p":"com.opensourcewithslu.inputdevices","l":"SlideSwitchHelper"},{"p":"com.opensourcewithslu.utilities","l":"SpiConfiguration"},{"p":"com.opensourcewithslu.inputdevices","l":"TouchSwitchHelper"},{"p":"com.opensourcewithslu.inputdevices","l":"UltraSonicSensorHelper"}];updateSearchResults();
\ No newline at end of file
+typeSearchIndex = [{"p":"com.opensourcewithslu.outputdevices","l":"ActiveBuzzerHelper"},{"l":"All Classes and Interfaces","u":"allclasses-index.html"},{"p":"com.opensourcewithslu","l":"Application"},{"p":"com.opensourcewithslu.utilities","l":"DigitalInputConfiguration"},{"p":"com.opensourcewithslu.utilities.MultiPinConfigs","l":"DigitalInputMultiPinConfiguration"},{"p":"com.opensourcewithslu.utilities","l":"DigitalOutputConfiguration"},{"p":"com.opensourcewithslu.utilities","l":"i2cConfiguration"},{"p":"com.opensourcewithslu.outputdevices","l":"LCD1602Helper"},{"p":"com.opensourcewithslu.outputdevices","l":"LEDHelper"},{"p":"com.opensourcewithslu.utilities","l":"MultipinConfiguration"},{"p":"com.opensourcewithslu.inputdevices","l":"PhotoResistorHelper"},{"p":"com.opensourcewithslu.utilities","l":"Pi4JFactory"},{"p":"com.opensourcewithslu.utilities","l":"Pi4JMultipinFactory"},{"p":"com.opensourcewithslu.inputdevices","l":"PushButtonHelper"},{"p":"com.opensourcewithslu.utilities","l":"PwmConfiguration"},{"p":"com.opensourcewithslu.utilities.MultiPinConfigs","l":"PwmMultiPinConfiguration"},{"p":"com.opensourcewithslu.inputdevices","l":"RFidHelper"},{"p":"com.opensourcewithslu.outputdevices","l":"RGBLEDHelper"},{"p":"com.opensourcewithslu.inputdevices","l":"RotaryEncoderHelper"},{"p":"com.opensourcewithslu.inputdevices","l":"SlideSwitchHelper"},{"p":"com.opensourcewithslu.utilities","l":"SpiConfiguration"},{"p":"com.opensourcewithslu.inputdevices","l":"TouchSwitchHelper"},{"p":"com.opensourcewithslu.inputdevices","l":"UltrasoundSensorHelper"}];updateSearchResults();
\ No newline at end of file
diff --git a/pi4micronaut-utils/src/main/java/com/opensourcewithslu/inputdevices/UltraSonicSensorHelper.java b/pi4micronaut-utils/src/main/java/com/opensourcewithslu/inputdevices/UltraSonicSensorHelper.java
index bc2d4a28..09cc06a4 100644
--- a/pi4micronaut-utils/src/main/java/com/opensourcewithslu/inputdevices/UltraSonicSensorHelper.java
+++ b/pi4micronaut-utils/src/main/java/com/opensourcewithslu/inputdevices/UltraSonicSensorHelper.java
@@ -23,7 +23,10 @@ public class UltraSonicSensorHelper {
* @param triggerPin The DigitalOutput pin for triggering the ultrasonic sensor.
* @param echoPin The DigitalInput pin for receiving the echo from the ultrasonic sensor.
*/
- public UltraSonicSensorHelper(DigitalOutput triggerPin, DigitalInput echoPin) {
+ //tag::const[]
+ public UltraSonicSensorHelper(DigitalOutput triggerPin, DigitalInput echoPin)
+ //end::const[]
+ {
this.triggerPin = triggerPin;
this.echoPin = echoPin;
initialize();
@@ -32,7 +35,10 @@ public UltraSonicSensorHelper(DigitalOutput triggerPin, DigitalInput echoPin) {
/**
* Initializes the Ultrasonic Sensor
*/
- public void initialize() {
+ //tag::method[]
+ public void initialize()
+ //end::method[]
+ {
log.info("Ultrasonic Sensor Initialized");
sensorActive = true;
// TriggerPin is low initially
@@ -42,7 +48,10 @@ public void initialize() {
/**
* Begins measuring distance from sensor calling triggerAndMeasureDistance function every 100 milliseconds
*/
- public void startMeasuring() {
+ //tag::method[]
+ public void startMeasuring()
+ //end::method[]
+ {
if (!sensorActive) {
return;
}
@@ -110,7 +119,10 @@ private void calculateDistance(long durationInNano) {
*
* @return The distance value in centimeters.
*/
- public double getDistanceInCentimeter() {
+ //tag::method[]
+ public double getDistanceInCentimeter()
+ //end::method[]
+ {
return distance;
}
@@ -119,14 +131,20 @@ public double getDistanceInCentimeter() {
*
* @return The distance value in meters.
*/
- public double getDistanceInMeters() {
+ //tag::method[]
+ public double getDistanceInMeters()
+ //end::method[]
+ {
return distance/100;
}
/**
* Shuts down ultrasonic sensor
*/
- public void stopMeasuring() {
+ //tag::method[]
+ public void stopMeasuring()
+ //end::method[]
+ {
sensorActive = false;
if (!executorService.isShutdown()) {
executorService.shutdownNow();
![" + messages.linkIcon +"](" + pathtoroot + "link.svg){kind=small}