diff --git a/pi4micronaut-utils/.gitignore b/pi4micronaut-utils/.gitignore index c72da8f3..5dacd506 100644 --- a/pi4micronaut-utils/.gitignore +++ b/pi4micronaut-utils/.gitignore @@ -5,7 +5,6 @@ bin/ build/ target/ out/ -src/docs/javadoc .micronaut/ .idea *.iml diff --git a/pi4micronaut-utils/build.gradle b/pi4micronaut-utils/build.gradle index 5a2e1e40..a7655821 100644 --- a/pi4micronaut-utils/build.gradle +++ b/pi4micronaut-utils/build.gradle @@ -95,7 +95,7 @@ publishing { mavenJava(MavenPublication) { groupId = 'io.github.oss-slu' artifactId = 'pi4micronaut-utils' - version = '1.0' + version = 'v1.0' from components.java artifact sourcesJar diff --git a/pi4micronaut-utils/src/docs/javadoc/allclasses-index.html b/pi4micronaut-utils/src/docs/javadoc/allclasses-index.html new file mode 100644 index 00000000..eca19578 --- /dev/null +++ b/pi4micronaut-utils/src/docs/javadoc/allclasses-index.html @@ -0,0 +1,151 @@ + + + + +All Classes and Interfaces (pi4micronaut-utils v1.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

All Classes and Interfaces

+
+
+
Classes
+
+
Class
+
Description
+
ActiveBuzzerHelper
+
+
The ActiveBuzzerHelper class contains methods that pertain to the control of the active buzzer.
+
+
Application
+
+
Runs the Micronaut framework in the Pi4Micronaut framework.
+
+
DigitalInputConfiguration
+
+
This class handles the configuration of a digital input component.
+
+
DigitalInputMultiPinConfiguration
+
+
This class handles the configuration of a digital input component that has multiple pins.
+
+
DigitalOutputConfiguration
+
+
This class handles the configuration of a digital output component.
+
+
i2cConfiguration
+
+
This class handles the configuration of an I2C components.
+
+
LCD1602Helper
+
+
This helper class, LCD1602Helper, is for controlling and interacting with an I2C LCD1602 display.
+
+
LEDHelper
+
+
The class LEDHelper contains methods that pertain to the control of a LED.
+
+
MultipinConfiguration
+
+
Class for configuring multipin components.
+
+
PhotoResistorHelper
+
+
The PhotoResistorHelper class is used to work with the functionalities of a Photo Resistor.
+
+
Pi4JFactory
+
+
The Pi4JFactory class is responsible for creating all the beans for components that are being used.
+
+
Pi4JMultipinFactory
+
+
The Pi4JMultipinFactory class is responsible for creating all the beans for all multi pin components that are being used.
+
+
PIRSensorHelper
+
+
The PIRSensorHelper class is used to initialize a PIR motion sensor.
+
+
PushButtonHelper
+
+
The PushButtonHelper class is used to create a listener that determines when a 4 pin button is pressed.
+
+
PwmConfiguration
+
+
The PwmConfiguration class handles the configuration of a pwm component.
+
+
PwmMultiPinConfiguration
+
+
This class handles the configuration of a PWM device that has multiple pins.
+
+
RFidHelper
+
+
The RFIDHelper class is for interacting with an RFID scanner.
+
+
RGBLEDHelper
+
+
The RBGLEDHelper class handles all interactions with a RGB LED.
+
+
RotaryEncoderHelper
+
+
The RotaryEncoderHelper class initializes a rotary encoder component and returns the value of the encoder when called upon.
+
+
SlideSwitchHelper
+
+
The SlideSwitchHelper class is used to initialize a slide switch.
+
+
SpiConfiguration
+
+
This class handles the configuration of a SPI component.
+
+
TouchSwitchHelper
+
+
The TouchSwitchHelper class is used to initialize a touch switch.
+
+
+
+
+
+
+ + diff --git a/pi4micronaut-utils/src/docs/javadoc/allpackages-index.html b/pi4micronaut-utils/src/docs/javadoc/allpackages-index.html new file mode 100644 index 00000000..0cbebf57 --- /dev/null +++ b/pi4micronaut-utils/src/docs/javadoc/allpackages-index.html @@ -0,0 +1,71 @@ + + + + +All Packages (pi4micronaut-utils v1.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

All Packages

+
+
Package Summary
+
+
Package
+
Description
+
com.opensourcewithslu
+
 
+
com.opensourcewithslu.inputdevices
+
 
+
com.opensourcewithslu.outputdevices
+
 
+
com.opensourcewithslu.utilities
+
 
+
com.opensourcewithslu.utilities.MultiPinConfigs
+
 
+
+
+
+
+ + diff --git a/pi4micronaut-utils/src/docs/javadoc/com/opensourcewithslu/Application.html b/pi4micronaut-utils/src/docs/javadoc/com/opensourcewithslu/Application.html new file mode 100644 index 00000000..16cdbae7 --- /dev/null +++ b/pi4micronaut-utils/src/docs/javadoc/com/opensourcewithslu/Application.html @@ -0,0 +1,179 @@ + + + + +Application (pi4micronaut-utils v1.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Package com.opensourcewithslu
+

Class Application

+
+
java.lang.Object +
com.opensourcewithslu.Application
+
+
+
+
public class Application +extends Object
+
Runs the Micronaut framework in the Pi4Micronaut framework.
+
+
+ +
+
+
    + +
  • +
    +

    Constructor Details

    +
      +
    • +
      +

      Application

      +
      public Application()
      +
      +
      • +
    +
    +
    • + +
  • +
    +

    Method Details

    +
      +
    • +
      +

      main

      +
      public static void main(String[] args)
      +
      constructor
      +
      +
      Parameters:
      +
      args - None
      +
      +
      +
      • +
    +
    +
    • +
+
+ +
+
+
+ + diff --git a/pi4micronaut-utils/src/docs/javadoc/com/opensourcewithslu/inputdevices/PIRSensorHelper.html b/pi4micronaut-utils/src/docs/javadoc/com/opensourcewithslu/inputdevices/PIRSensorHelper.html new file mode 100644 index 00000000..9b7775b4 --- /dev/null +++ b/pi4micronaut-utils/src/docs/javadoc/com/opensourcewithslu/inputdevices/PIRSensorHelper.html @@ -0,0 +1,242 @@ + + + + +PIRSensorHelper (pi4micronaut-utils v1.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Package com.opensourcewithslu.inputdevices
+

Class PIRSensorHelper

+
+
java.lang.Object +
com.opensourcewithslu.inputdevices.PIRSensorHelper
+
+
+
+
public class PIRSensorHelper +extends Object
+
The PIRSensorHelper class is used to initialize a PIR motion sensor.
+
+
+
    + +
  • +
    +

    Field Summary

    +
    Fields
    +
    +
    Modifier and Type
    +
    Field
    +
    Description
    +
    boolean
    +
    isMoving
    +
    +
    Shows if the PIR sensor detects movement or not.
    +
    +
    +
    +
    • + +
  • +
    +

    Constructor Summary

    +
    Constructors
    +
    +
    Constructor
    +
    Description
    +
    PIRSensorHelper(com.pi4j.io.gpio.digital.DigitalInput pirSensorOutput)
    +
    +
    PIRSensorHelper constructor
    +
    +
    +
    +
    • + +
  • +
    +

    Method Summary

    +
    +
    +
    +
    +
    Modifier and Type
    +
    Method
    +
    Description
    +
    void
    +
    addEventListener(com.pi4j.io.gpio.digital.DigitalStateChangeListener function)
    +
    +
    Adds an event listener to the PIR sensor.
    +
    +
    void
    +
    initialize()
    +
    +
    Initializes the listener that keeps track of if the PIR sensor detects motion or not.
    +
    +
    void
    +
    removeEventListener()
    +
    +
    Removes the event listener from the PIR sensor.
    +
    +
    +
    +
    +
    +

    Methods inherited from class java.lang.Object

    +clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +
    +
    • +
+
+
+
    + +
  • +
    +

    Field Details

    +
      +
    • +
      +

      isMoving

      +
      public boolean isMoving
      +
      Shows if the PIR sensor detects movement or not.
      +
      +
      • +
    +
    +
    • + +
  • +
    +

    Constructor Details

    +
      +
    • +
      +

      PIRSensorHelper

      +
      public PIRSensorHelper(com.pi4j.io.gpio.digital.DigitalInput pirSensorOutput)
      +
      PIRSensorHelper constructor
      +
      +
      Parameters:
      +
      pirSensorOutput - A Pi4J DigitalInput object.
      +
      +
      +
      • +
    +
    +
    • + +
  • +
    +

    Method Details

    +
      +
    • +
      +

      initialize

      +
      public void initialize()
      +
      Initializes the listener that keeps track of if the PIR sensor detects motion or not. It is automatically called when the PIRSensorHelper is instantiated.
      +
      +
      • +
    • +
      +

      addEventListener

      +
      public void addEventListener(com.pi4j.io.gpio.digital.DigitalStateChangeListener function)
      +
      Adds an event listener to the PIR sensor.
      +
      +
      Parameters:
      +
      function - A Pi4J DigitalStateChangeListener object.
      +
      +
      +
      • +
    • +
      +

      removeEventListener

      +
      public void removeEventListener()
      +
      Removes the event listener from the PIR sensor.
      +
      +
      • +
    +
    +
    • +
+
+ +
+
+
+ + diff --git a/pi4micronaut-utils/src/docs/javadoc/com/opensourcewithslu/inputdevices/PhotoResistorHelper.html b/pi4micronaut-utils/src/docs/javadoc/com/opensourcewithslu/inputdevices/PhotoResistorHelper.html new file mode 100644 index 00000000..3d060ba4 --- /dev/null +++ b/pi4micronaut-utils/src/docs/javadoc/com/opensourcewithslu/inputdevices/PhotoResistorHelper.html @@ -0,0 +1,298 @@ + + + + +PhotoResistorHelper (pi4micronaut-utils v1.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Package com.opensourcewithslu.inputdevices
+

Class PhotoResistorHelper

+
+
java.lang.Object +
com.opensourcewithslu.inputdevices.PhotoResistorHelper
+
+
+
+
public class PhotoResistorHelper +extends Object
+
The PhotoResistorHelper class is used to work with the functionalities of a Photo Resistor.
+
+
+
    + +
  • +
    +

    Field Summary

    +
    Fields
    +
    +
    Modifier and Type
    +
    Field
    +
    Description
    +
    boolean
    +
    isDark
    +
    +
    To check if it is Dark.
    +
    +
    +
    +
    • + +
  • +
    +

    Constructor Summary

    +
    Constructors
    +
    +
    Constructor
    +
    Description
    +
    PhotoResistorHelper(com.pi4j.io.gpio.digital.DigitalInput sensorInput, + com.pi4j.io.gpio.digital.DigitalOutput sensorOutput)
    +
    +
    TouchSwitchHelper constructor.
    +
    +
    +
    +
    • + +
  • +
    +

    Method Summary

    +
    +
    +
    +
    +
    Modifier and Type
    +
    Method
    +
    Description
    +
    void
    +
    addEventListener(com.pi4j.io.gpio.digital.DigitalStateChangeListener function)
    +
    +
    Adds an event listener to the Photo Resistor.
    +
    +
    int
    +
    getDark()
    +
     
    +
    void
    +
    initialize()
    +
    +
    Initializes the Photo Resistor and calls the updateDarkness function for every half second.
    +
    +
    void
    +
    removeEventListener()
    +
    +
    Removes the event listener from the Photo Resistor.
    +
    +
    void
    +
    setDarknessThreshold(int darknessThreshold)
    +
    +
    To set a threshold for Photo Resistor.
    +
    +
    void
    +
    setToLow()
    +
    +
    To set the Photo Resistor output to low for each event.
    +
    +
    void
    +
    updateDark()
    +
    +
    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.
      +
      +
      • +
    +
    +
    • + +
  • +
    +

    Constructor Details

    +
      +
    • +
      +

      PhotoResistorHelper

      +
      public PhotoResistorHelper(com.pi4j.io.gpio.digital.DigitalInput sensorInput, + com.pi4j.io.gpio.digital.DigitalOutput sensorOutput)
      +
      TouchSwitchHelper constructor.
      +
      +
      Parameters:
      +
      sensorInput - - A Pi4J DigitalInput object.
      +
      sensorOutput - - A Pi4J DigitalOutput object.
      +
      +
      +
      • +
    +
    +
    • + +
  • +
    +

    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.
      +
      +
      • +
    +
    +
    • +
+
+ +
+
+
+ + diff --git a/pi4micronaut-utils/src/docs/javadoc/com/opensourcewithslu/inputdevices/PushButtonHelper.html b/pi4micronaut-utils/src/docs/javadoc/com/opensourcewithslu/inputdevices/PushButtonHelper.html new file mode 100644 index 00000000..172306c1 --- /dev/null +++ b/pi4micronaut-utils/src/docs/javadoc/com/opensourcewithslu/inputdevices/PushButtonHelper.html @@ -0,0 +1,246 @@ + + + + +PushButtonHelper (pi4micronaut-utils v1.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Package com.opensourcewithslu.inputdevices
+

Class PushButtonHelper

+
+
java.lang.Object +
com.opensourcewithslu.inputdevices.PushButtonHelper
+
+
+
+
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
    +
    +
    Modifier and Type
    +
    Field
    +
    Description
    +
    Boolean
    +
    isPressed
    +
    +
    Determines if the button is pressed.
    +
    +
    +
    +
    • + +
  • +
    +

    Constructor Summary

    +
    Constructors
    +
    +
    Constructor
    +
    Description
    +
    PushButtonHelper(com.pi4j.io.gpio.digital.DigitalInput buttonInput)
    +
    +
    The PushButtonHelper constructor.
    +
    +
    +
    +
    • + +
  • +
    +

    Method Summary

    +
    +
    +
    +
    +
    Modifier and Type
    +
    Method
    +
    Description
    +
    void
    +
    addEventListener(com.pi4j.io.gpio.digital.DigitalStateChangeListener function)
    +
    +
    Adds an EventListener to the PushButton.
    +
    +
    void
    +
    initialize()
    +
    +
    Initializes the PushButton.
    +
    +
    void
    +
    removeEventListener(com.pi4j.io.gpio.digital.DigitalStateChangeListener function)
    +
    +
    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

      +
      public Boolean isPressed
      +
      Determines if the button is pressed.
      +
      +
      • +
    +
    +
    • + +
  • +
    +

    Constructor Details

    +
      +
    • +
      +

      PushButtonHelper

      +
      public PushButtonHelper(com.pi4j.io.gpio.digital.DigitalInput buttonInput)
      +
      The PushButtonHelper constructor.
      +
      +
      Parameters:
      +
      buttonInput - A Pi4J DigitalInput Object.
      +
      +
      +
      • +
    +
    +
    • + +
  • +
    +

    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.
      +
      +
      +
      • +
    +
    +
    • +
+
+ +
+
+
+ + diff --git a/pi4micronaut-utils/src/docs/javadoc/com/opensourcewithslu/inputdevices/RFidHelper.html b/pi4micronaut-utils/src/docs/javadoc/com/opensourcewithslu/inputdevices/RFidHelper.html new file mode 100644 index 00000000..b4febcfd --- /dev/null +++ b/pi4micronaut-utils/src/docs/javadoc/com/opensourcewithslu/inputdevices/RFidHelper.html @@ -0,0 +1,238 @@ + + + + +RFidHelper (pi4micronaut-utils v1.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Package com.opensourcewithslu.inputdevices
+

Class RFidHelper

+
+
java.lang.Object +
com.opensourcewithslu.inputdevices.RFidHelper
+
+
+
+
public class RFidHelper +extends Object
+
The RFIDHelper class is for interacting with an RFID scanner.
+
+
+
    + +
  • +
    +

    Constructor Summary

    +
    Constructors
    +
    +
    Constructor
    +
    Description
    +
    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

    +
    +
    +
    +
    +
    Modifier and Type
    +
    Method
    +
    Description
    +
    Object
    +
    readFromCard()
    +
    +
    When called, this method waits for any RFID card/fob to be scanned.
    +
    +
    void
    +
    resetScanner()
    +
    +
    Resets the RFID scanner.
    +
    +
    void
    +
    writeToCard(Object data)
    +
    +
    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

      +
      public Object 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.
      +
      +
      • +
    +
    +
    • +
+
+ +
+
+
+ + diff --git a/pi4micronaut-utils/src/docs/javadoc/com/opensourcewithslu/inputdevices/RotaryEncoderHelper.html b/pi4micronaut-utils/src/docs/javadoc/com/opensourcewithslu/inputdevices/RotaryEncoderHelper.html new file mode 100644 index 00000000..702005d7 --- /dev/null +++ b/pi4micronaut-utils/src/docs/javadoc/com/opensourcewithslu/inputdevices/RotaryEncoderHelper.html @@ -0,0 +1,198 @@ + + + + +RotaryEncoderHelper (pi4micronaut-utils v1.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Package com.opensourcewithslu.inputdevices
+

Class RotaryEncoderHelper

+
+
java.lang.Object +
com.opensourcewithslu.inputdevices.RotaryEncoderHelper
+
+
+
+
public class RotaryEncoderHelper +extends Object
+
The RotaryEncoderHelper class initializes a rotary encoder component and returns the value of the encoder when called upon.
+
+
+ +
+
+
    + +
  • +
    +

    Constructor Details

    + +
    +
    • + +
  • +
    +

    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.
      +
      +
      +
      • +
    +
    +
    • +
+
+ +
+
+
+ + diff --git a/pi4micronaut-utils/src/docs/javadoc/com/opensourcewithslu/inputdevices/SlideSwitchHelper.html b/pi4micronaut-utils/src/docs/javadoc/com/opensourcewithslu/inputdevices/SlideSwitchHelper.html new file mode 100644 index 00000000..f40e77ea --- /dev/null +++ b/pi4micronaut-utils/src/docs/javadoc/com/opensourcewithslu/inputdevices/SlideSwitchHelper.html @@ -0,0 +1,246 @@ + + + + +SlideSwitchHelper (pi4micronaut-utils v1.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Package com.opensourcewithslu.inputdevices
+

Class SlideSwitchHelper

+
+
java.lang.Object +
com.opensourcewithslu.inputdevices.SlideSwitchHelper
+
+
+
+
public class SlideSwitchHelper +extends Object
+
The SlideSwitchHelper class is used to initialize a slide switch.
+
+
+
    + +
  • +
    +

    Field Summary

    +
    Fields
    +
    +
    Modifier and Type
    +
    Field
    +
    Description
    +
    boolean
    +
    isOn
    +
    +
    Shows if the slide switch is on.
    +
    +
    +
    +
    • + +
  • +
    +

    Constructor Summary

    +
    Constructors
    +
    +
    Constructor
    +
    Description
    +
    SlideSwitchHelper(com.pi4j.io.gpio.digital.DigitalInput slideSwitchInput)
    +
    +
    SlideSwitchHelper constructor.
    +
    +
    +
    +
    • + +
  • +
    +

    Method Summary

    +
    +
    +
    +
    +
    Modifier and Type
    +
    Method
    +
    Description
    +
    void
    +
    addEventListener(com.pi4j.io.gpio.digital.DigitalStateChangeListener function)
    +
    +
    Adds an EvenListener to the slide switch.
    +
    +
    void
    +
    initialize()
    +
    +
    Initializes the listener that keeps track of whether the slide switch is high/low.
    +
    +
    void
    +
    removeEventListener(com.pi4j.io.gpio.digital.DigitalStateChangeListener function)
    +
    +
    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.
      +
      +
      • +
    +
    +
    • + +
  • +
    +

    Constructor Details

    +
      +
    • +
      +

      SlideSwitchHelper

      +
      public SlideSwitchHelper(com.pi4j.io.gpio.digital.DigitalInput slideSwitchInput)
      +
      SlideSwitchHelper constructor.
      +
      +
      Parameters:
      +
      slideSwitchInput - A Pi4J DigitalInput Object.
      +
      +
      +
      • +
    +
    +
    • + +
  • +
    +

    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.
      +
      +
      +
      • +
    +
    +
    • +
+
+ +
+
+
+ + diff --git a/pi4micronaut-utils/src/docs/javadoc/com/opensourcewithslu/inputdevices/TouchSwitchHelper.html b/pi4micronaut-utils/src/docs/javadoc/com/opensourcewithslu/inputdevices/TouchSwitchHelper.html new file mode 100644 index 00000000..c02ad6d0 --- /dev/null +++ b/pi4micronaut-utils/src/docs/javadoc/com/opensourcewithslu/inputdevices/TouchSwitchHelper.html @@ -0,0 +1,242 @@ + + + + +TouchSwitchHelper (pi4micronaut-utils v1.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Package com.opensourcewithslu.inputdevices
+

Class TouchSwitchHelper

+
+
java.lang.Object +
com.opensourcewithslu.inputdevices.TouchSwitchHelper
+
+
+
+
public class TouchSwitchHelper +extends Object
+
The TouchSwitchHelper class is used to initialize a touch switch.
+
+
+
    + +
  • +
    +

    Field Summary

    +
    Fields
    +
    +
    Modifier and Type
    +
    Field
    +
    Description
    +
    boolean
    +
    isTouched
    +
    +
    Shows if the touch switch has been touched.
    +
    +
    +
    +
    • + +
  • +
    +

    Constructor Summary

    +
    Constructors
    +
    +
    Constructor
    +
    Description
    +
    TouchSwitchHelper(com.pi4j.io.gpio.digital.DigitalInput touchSwitchInput)
    +
    +
    TouchSwitchHelper constructor.
    +
    +
    +
    +
    • + +
  • +
    +

    Method Summary

    +
    +
    +
    +
    +
    Modifier and Type
    +
    Method
    +
    Description
    +
    void
    +
    addEventListener(com.pi4j.io.gpio.digital.DigitalStateChangeListener function)
    +
    +
    Adds an event listener to the touch switch.
    +
    +
    void
    +
    initialize()
    +
    +
    Initializes the listener that keeps track of if the touch switch has been touched or not.
    +
    +
    void
    +
    removeEventListener()
    +
    +
    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.
      +
      +
      • +
    +
    +
    • + +
  • +
    +

    Constructor Details

    +
      +
    • +
      +

      TouchSwitchHelper

      +
      public TouchSwitchHelper(com.pi4j.io.gpio.digital.DigitalInput touchSwitchInput)
      +
      TouchSwitchHelper constructor.
      +
      +
      Parameters:
      +
      touchSwitchInput - A Pi4J DigitalInput object.
      +
      +
      +
      • +
    +
    +
    • + +
  • +
    +

    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.
      +
      +
      • +
    +
    +
    • +
+
+ +
+
+
+ + diff --git a/pi4micronaut-utils/src/docs/javadoc/com/opensourcewithslu/inputdevices/package-summary.html b/pi4micronaut-utils/src/docs/javadoc/com/opensourcewithslu/inputdevices/package-summary.html new file mode 100644 index 00000000..7d89f387 --- /dev/null +++ b/pi4micronaut-utils/src/docs/javadoc/com/opensourcewithslu/inputdevices/package-summary.html @@ -0,0 +1,131 @@ + + + + +com.opensourcewithslu.inputdevices (pi4micronaut-utils v1.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Package com.opensourcewithslu.inputdevices

+
+
+
package com.opensourcewithslu.inputdevices
+
+ +
+
+
+
+ + diff --git a/pi4micronaut-utils/src/docs/javadoc/com/opensourcewithslu/inputdevices/package-tree.html b/pi4micronaut-utils/src/docs/javadoc/com/opensourcewithslu/inputdevices/package-tree.html new file mode 100644 index 00000000..3ff1e156 --- /dev/null +++ b/pi4micronaut-utils/src/docs/javadoc/com/opensourcewithslu/inputdevices/package-tree.html @@ -0,0 +1,76 @@ + + + + +com.opensourcewithslu.inputdevices Class Hierarchy (pi4micronaut-utils v1.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Hierarchy For Package com.opensourcewithslu.inputdevices

+
+Package Hierarchies: + +
+

Class Hierarchy

+ +
+
+
+
+ + diff --git a/pi4micronaut-utils/src/docs/javadoc/com/opensourcewithslu/outputdevices/ActiveBuzzerHelper.html b/pi4micronaut-utils/src/docs/javadoc/com/opensourcewithslu/outputdevices/ActiveBuzzerHelper.html new file mode 100644 index 00000000..a94c357f --- /dev/null +++ b/pi4micronaut-utils/src/docs/javadoc/com/opensourcewithslu/outputdevices/ActiveBuzzerHelper.html @@ -0,0 +1,265 @@ + + + + +ActiveBuzzerHelper (pi4micronaut-utils v1.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Package com.opensourcewithslu.outputdevices
+

Class ActiveBuzzerHelper

+
+
java.lang.Object +
com.opensourcewithslu.outputdevices.ActiveBuzzerHelper
+
+
+
+
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
    +
    +
    Modifier and Type
    +
    Field
    +
    Description
    +
    protected boolean
    +
    actBuzzCheck
    +
    +
    To check if the buzzer is active or not
    +
    +
    +
    +
    • + +
  • +
    +

    Constructor Summary

    +
    Constructors
    +
    +
    Constructor
    +
    Description
    +
    ActiveBuzzerHelper(com.pi4j.io.pwm.Pwm activeBuzzer)
    +
    +
    BuzzerHelper constructor
    +
    +
    +
    +
    • + +
  • +
    +

    Method Summary

    +
    +
    +
    +
    +
    Modifier and Type
    +
    Method
    +
    Description
    +
    void
    +
    activeBuzzerOff()
    +
    +
    Turns the active buzzer off.
    +
    +
    void
    +
    activeBuzzerOn()
    +
    +
    Turns the active buzzer on by setting the duty cycle is 100 and frequency to 440hz.
    +
    +
    void
    +
    beep()
    +
    +
    Beep powers on, plays a single tone from the active buzzer for 2 seconds then powers down.
    +
    +
    void
    +
    intermittentTone()
    +
    +
    Intermittent tone will play a tone for a 20 seconds duration.
    +
    +
    void
    +
    morseCodeTone()
    +
    +
    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.
      +
      +
      • +
    +
    +
    • +
+
+ +
+
+
+ + diff --git a/pi4micronaut-utils/src/docs/javadoc/com/opensourcewithslu/outputdevices/LCD1602Helper.html b/pi4micronaut-utils/src/docs/javadoc/com/opensourcewithslu/outputdevices/LCD1602Helper.html new file mode 100644 index 00000000..9b9bd055 --- /dev/null +++ b/pi4micronaut-utils/src/docs/javadoc/com/opensourcewithslu/outputdevices/LCD1602Helper.html @@ -0,0 +1,252 @@ + + + + +LCD1602Helper (pi4micronaut-utils v1.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Package com.opensourcewithslu.outputdevices
+

Class LCD1602Helper

+
+
java.lang.Object +
com.opensourcewithslu.outputdevices.LCD1602Helper
+
+
+
+
public class LCD1602Helper +extends Object
+
This helper class, LCD1602Helper, is for controlling and interacting with an I2C LCD1602 display.
+
+
+
    + +
  • +
    +

    Constructor Summary

    +
    Constructors
    +
    +
    Constructor
    +
    Description
    +
    LCD1602Helper(com.pi4j.io.i2c.I2CConfig i2CConfig, + com.pi4j.context.Context pi4jContext)
    +
    +
    The LCD1602Helper constructor.
    +
    +
    +
    +
    • + +
  • +
    +

    Method Summary

    +
    +
    +
    +
    +
    Modifier and Type
    +
    Method
    +
    Description
    +
    void
    +
    clearDisplay()
    +
    +
    Clears the display of text.
    +
    +
    void
    +
    clearLine(int line)
    +
    +
    Clears the text of the specified line.
    +
    +
    void
    +
    setBackLight(boolean state)
    +
    +
    Setting the backlight state of the LCD based off the boolean input.
    +
    +
    void
    +
    writeText(String text)
    +
    +
    Writes a String to the display.
    +
    +
    void
    +
    writeTextAtLine(String text, + int line)
    +
    +
    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.
      +
      +
      +
      • +
    +
    +
    • +
+
+ +
+
+
+ + diff --git a/pi4micronaut-utils/src/docs/javadoc/com/opensourcewithslu/outputdevices/LEDHelper.html b/pi4micronaut-utils/src/docs/javadoc/com/opensourcewithslu/outputdevices/LEDHelper.html new file mode 100644 index 00000000..cc847812 --- /dev/null +++ b/pi4micronaut-utils/src/docs/javadoc/com/opensourcewithslu/outputdevices/LEDHelper.html @@ -0,0 +1,206 @@ + + + + +LEDHelper (pi4micronaut-utils v1.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Package com.opensourcewithslu.outputdevices
+

Class LEDHelper

+
+
java.lang.Object +
com.opensourcewithslu.outputdevices.LEDHelper
+
+
+
+
public class LEDHelper +extends Object
+
The class LEDHelper contains methods that pertain to the control of a LED.
+
+
+
    + +
  • +
    +

    Constructor Summary

    +
    Constructors
    +
    +
    Constructor
    +
    Description
    +
    LEDHelper(com.pi4j.io.gpio.digital.DigitalOutput ledOutput)
    +
    +
    LEGHelper constructor.
    +
    +
    +
    +
    • + +
  • +
    +

    Method Summary

    +
    +
    +
    +
    +
    Modifier and Type
    +
    Method
    +
    Description
    +
    void
    +
    ledOff()
    +
    +
    Turns off the LED by setting the DigitalOutput object to low.
    +
    +
    void
    +
    ledOn()
    +
    +
    Turns on the LED by setting the DigitalOutput object to high.
    +
    +
    void
    +
    switchState()
    +
    +
    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.
      +
      +
      • +
    +
    +
    • +
+
+ +
+
+
+ + diff --git a/pi4micronaut-utils/src/docs/javadoc/com/opensourcewithslu/outputdevices/RGBLEDHelper.html b/pi4micronaut-utils/src/docs/javadoc/com/opensourcewithslu/outputdevices/RGBLEDHelper.html new file mode 100644 index 00000000..fdf75d2a --- /dev/null +++ b/pi4micronaut-utils/src/docs/javadoc/com/opensourcewithslu/outputdevices/RGBLEDHelper.html @@ -0,0 +1,369 @@ + + + + +RGBLEDHelper (pi4micronaut-utils v1.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Package com.opensourcewithslu.outputdevices
+

Class RGBLEDHelper

+
+
java.lang.Object +
com.opensourcewithslu.outputdevices.RGBLEDHelper
+
+
+
+
public class RGBLEDHelper +extends Object
+
The RBGLEDHelper class handles all interactions with a RGB LED.
+
+
+
    + +
  • +
    +

    Constructor Summary

    +
    Constructors
    +
    +
    Constructor
    +
    Description
    +
    RGBLEDHelper(MultipinConfiguration pwm)
    +
    +
    The RGBLEDHelper constructor.
    +
    +
    +
    +
    • + +
  • +
    +

    Method Summary

    +
    +
    +
    +
    +
    Modifier and Type
    +
    Method
    +
    Description
    +
    void
    +
    ledOff()
    +
    +
    Turns off the RGB LED.
    +
    +
    void
    +
    ledOn()
    +
    +
    Turns on the RGB LED with default RGB values of 100,100,100 and frequencies of 200 Hertz.
    +
    +
    void
    +
    setBlue(int blue)
    +
    +
    Sets the blue value of the LED.
    +
    +
    void
    +
    setBlue(int blue, + int frequency)
    +
    +
    Sets the blue value and frequency of the LED.
    +
    +
    void
    +
    setColor(int[] colors)
    +
    +
    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
    +
    setColorHex(String hex)
    +
    +
    Setting the color of the LED using a hexadecimal value.
    +
    +
    void
    +
    setColorHex(String hex, + int[] frequency)
    +
    +
    Setting the color of the LED using a hexadecimal value and an array of frequencies.
    +
    +
    void
    +
    setGreen(int green)
    +
    +
    Sets the green value of the LED.
    +
    +
    void
    +
    setGreen(int green, + int frequency)
    +
    +
    Sets the green value and frequency of the LED.
    +
    +
    void
    +
    setRed(int red)
    +
    +
    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
    +
    +
    • +
+
+
+
    + +
  • +
    +

    Constructor Details

    + +
    +
    • + +
  • +
    +

    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.
      +
      +
      • +
    +
    +
    • +
+
+ +
+
+
+ + diff --git a/pi4micronaut-utils/src/docs/javadoc/com/opensourcewithslu/outputdevices/package-summary.html b/pi4micronaut-utils/src/docs/javadoc/com/opensourcewithslu/outputdevices/package-summary.html new file mode 100644 index 00000000..6c2094e5 --- /dev/null +++ b/pi4micronaut-utils/src/docs/javadoc/com/opensourcewithslu/outputdevices/package-summary.html @@ -0,0 +1,119 @@ + + + + +com.opensourcewithslu.outputdevices (pi4micronaut-utils v1.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Package com.opensourcewithslu.outputdevices

+
+
+
package com.opensourcewithslu.outputdevices
+
+ +
+
+
+
+ + diff --git a/pi4micronaut-utils/src/docs/javadoc/com/opensourcewithslu/outputdevices/package-tree.html b/pi4micronaut-utils/src/docs/javadoc/com/opensourcewithslu/outputdevices/package-tree.html new file mode 100644 index 00000000..ad80d8aa --- /dev/null +++ b/pi4micronaut-utils/src/docs/javadoc/com/opensourcewithslu/outputdevices/package-tree.html @@ -0,0 +1,73 @@ + + + + +com.opensourcewithslu.outputdevices Class Hierarchy (pi4micronaut-utils v1.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Hierarchy For Package com.opensourcewithslu.outputdevices

+
+Package Hierarchies: + +
+

Class Hierarchy

+ +
+
+
+
+ + diff --git a/pi4micronaut-utils/src/docs/javadoc/com/opensourcewithslu/package-summary.html b/pi4micronaut-utils/src/docs/javadoc/com/opensourcewithslu/package-summary.html new file mode 100644 index 00000000..797a89f1 --- /dev/null +++ b/pi4micronaut-utils/src/docs/javadoc/com/opensourcewithslu/package-summary.html @@ -0,0 +1,107 @@ + + + + +com.opensourcewithslu (pi4micronaut-utils v1.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Package com.opensourcewithslu

+
+
+
package com.opensourcewithslu
+
+ +
+
+
+
+ + diff --git a/pi4micronaut-utils/src/docs/javadoc/com/opensourcewithslu/package-tree.html b/pi4micronaut-utils/src/docs/javadoc/com/opensourcewithslu/package-tree.html new file mode 100644 index 00000000..1de68afb --- /dev/null +++ b/pi4micronaut-utils/src/docs/javadoc/com/opensourcewithslu/package-tree.html @@ -0,0 +1,70 @@ + + + + +com.opensourcewithslu Class Hierarchy (pi4micronaut-utils v1.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Hierarchy For Package com.opensourcewithslu

+
+Package Hierarchies: + +
+

Class Hierarchy

+ +
+
+
+
+ + diff --git a/pi4micronaut-utils/src/docs/javadoc/com/opensourcewithslu/utilities/DigitalInputConfiguration.html b/pi4micronaut-utils/src/docs/javadoc/com/opensourcewithslu/utilities/DigitalInputConfiguration.html new file mode 100644 index 00000000..0fae3e78 --- /dev/null +++ b/pi4micronaut-utils/src/docs/javadoc/com/opensourcewithslu/utilities/DigitalInputConfiguration.html @@ -0,0 +1,349 @@ + + + + +DigitalInputConfiguration (pi4micronaut-utils v1.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Package com.opensourcewithslu.utilities
+

Class DigitalInputConfiguration

+
+
java.lang.Object +
com.opensourcewithslu.utilities.DigitalInputConfiguration
+
+
+
+
@Prototype +@EachProperty("pi4j.digital-input") +public class DigitalInputConfiguration +extends Object
+
This class handles the configuration of a digital input component.
+
+
+
    + +
  • +
    +

    Constructor Summary

    +
    Constructors
    +
    +
    Constructor
    +
    Description
    +
    DigitalInputConfiguration(String id)
    +
    +
    Constructor for the DigitalInputConfiguration.
    +
    +
    +
    +
    • + +
  • +
    +

    Method Summary

    +
    +
    +
    +
    +
    Modifier and Type
    +
    Method
    +
    Description
    +
    int
    +
    getAddress()
    +
    +
    Gets the pin address for the component.
    +
    +
    Long
    +
    getDebounce()
    +
    +
    Gets the current debounce value for the component.
    +
    +
    String
    +
    getId()
    +
    +
    Gets the id of the component.
    +
    +
    String
    +
    getName()
    +
    +
    Gets the name of the component.
    +
    +
    String
    +
    getProvider()
    +
    +
    Gets the provider for the component.
    +
    +
    com.pi4j.io.gpio.digital.PullResistance
    +
    getPull()
    +
    +
    Gets the pull resistance for the component.
    +
    +
    void
    +
    setAddress(int address)
    +
    +
    Sets the pin address.
    +
    +
    void
    +
    setDebounce(Long debounce)
    +
    +
    Sets the debounce of the component.
    +
    +
    void
    +
    setName(String name)
    +
    +
    Sets the name of the component.
    +
    +
    void
    +
    setProvider(String provider)
    +
    +
    Sets the provider.
    +
    +
    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

      +
      public String getId()
      +
      Gets the id of the component.
      +
      +
      Returns:
      +
      The id of the component.
      +
      +
      +
      • +
    • +
      +

      getName

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

      +
      public String 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.
      +
      +
      +
      • +
    +
    +
    • +
+
+ +
+
+
+ + diff --git a/pi4micronaut-utils/src/docs/javadoc/com/opensourcewithslu/utilities/DigitalOutputConfiguration.html b/pi4micronaut-utils/src/docs/javadoc/com/opensourcewithslu/utilities/DigitalOutputConfiguration.html new file mode 100644 index 00000000..787295f0 --- /dev/null +++ b/pi4micronaut-utils/src/docs/javadoc/com/opensourcewithslu/utilities/DigitalOutputConfiguration.html @@ -0,0 +1,349 @@ + + + + +DigitalOutputConfiguration (pi4micronaut-utils v1.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Package com.opensourcewithslu.utilities
+

Class DigitalOutputConfiguration

+
+
java.lang.Object +
com.opensourcewithslu.utilities.DigitalOutputConfiguration
+
+
+
+
@Prototype +@EachProperty("pi4j.digital-output") +public class DigitalOutputConfiguration +extends Object
+
This class handles the configuration of a digital output component.
+
+
+
    + +
  • +
    +

    Constructor Summary

    +
    Constructors
    +
    +
    Constructor
    +
    Description
    +
    DigitalOutputConfiguration(String id)
    +
    +
    The DigitalOutputConfiguration constructor.
    +
    +
    +
    +
    • + +
  • +
    +

    Method Summary

    +
    +
    +
    +
    +
    Modifier and Type
    +
    Method
    +
    Description
    +
    int
    +
    getAddress()
    +
    +
    Gets the pin address for the component.
    +
    +
    String
    +
    getId()
    +
    +
    Gets the id of the component.
    +
    +
    com.pi4j.io.gpio.digital.DigitalState
    +
    getInitial()
    +
    +
    Gets the initial state of the component.
    +
    +
    String
    +
    getName()
    +
    +
    Gets the name of the component.
    +
    +
    String
    +
    getProvider()
    +
    +
    Gets the provider for the component.
    +
    +
    com.pi4j.io.gpio.digital.DigitalState
    +
    getShutdown()
    +
    +
    Gets the shutdown state of the component.
    +
    +
    void
    +
    setAddress(int address)
    +
    +
    Sets the pin address.
    +
    +
    void
    +
    setInitial(com.pi4j.io.gpio.digital.DigitalState initial)
    +
    +
    Sets the initial state for the component.
    +
    +
    void
    +
    setName(String name)
    +
    +
    Sets the name of the component.
    +
    +
    void
    +
    setProvider(String provider)
    +
    +
    Sets the provider.
    +
    +
    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

      +
      public String getId()
      +
      Gets the id of the component.
      +
      +
      Returns:
      +
      The id of the component.
      +
      +
      +
      • +
    • +
      +

      getName

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

      +
      public String 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.
      +
      +
      +
      • +
    +
    +
    • +
+
+ +
+
+
+ + diff --git a/pi4micronaut-utils/src/docs/javadoc/com/opensourcewithslu/utilities/MultiPinConfigs/DigitalInputMultiPinConfiguration.html b/pi4micronaut-utils/src/docs/javadoc/com/opensourcewithslu/utilities/MultiPinConfigs/DigitalInputMultiPinConfiguration.html new file mode 100644 index 00000000..98a6870f --- /dev/null +++ b/pi4micronaut-utils/src/docs/javadoc/com/opensourcewithslu/utilities/MultiPinConfigs/DigitalInputMultiPinConfiguration.html @@ -0,0 +1,348 @@ + + + + +DigitalInputMultiPinConfiguration (pi4micronaut-utils v1.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Package com.opensourcewithslu.utilities.MultiPinConfigs
+

Class DigitalInputMultiPinConfiguration

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

    +
      +
    • +
      +

      DigitalInputMultiPinConfiguration

      +
      public DigitalInputMultiPinConfiguration(@Parameter + String id)
      +
      The DigitalInputMultiPinConfiguration constructor.
      +
      +
      Parameters:
      +
      id - The configuration id as defined in the application.yml
      +
      +
      +
      • +
    +
    +
    • + +
  • +
    +

    Method Details

    +
      +
    • +
      +

      getId

      +
      public String getId()
      +
      Gets the id of the component.
      +
      +
      Returns:
      +
      The id of the component.
      +
      +
      +
      • +
    • +
      +

      getName

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

      +
      public String 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.
      +
      +
      +
      • +
    +
    +
    • +
+
+ +
+
+
+ + diff --git a/pi4micronaut-utils/src/docs/javadoc/com/opensourcewithslu/utilities/MultiPinConfigs/PwmMultiPinConfiguration.html b/pi4micronaut-utils/src/docs/javadoc/com/opensourcewithslu/utilities/MultiPinConfigs/PwmMultiPinConfiguration.html new file mode 100644 index 00000000..1c2380c8 --- /dev/null +++ b/pi4micronaut-utils/src/docs/javadoc/com/opensourcewithslu/utilities/MultiPinConfigs/PwmMultiPinConfiguration.html @@ -0,0 +1,380 @@ + + + + +PwmMultiPinConfiguration (pi4micronaut-utils v1.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Package com.opensourcewithslu.utilities.MultiPinConfigs
+

Class PwmMultiPinConfiguration

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

    +
      +
    • +
      +

      PwmMultiPinConfiguration

      +
      public PwmMultiPinConfiguration(@Parameter + String id)
      +
      The PwmMultiPinConfiguration constructor.
      +
      +
      Parameters:
      +
      id - The configuration id as defined in the application.yml
      +
      +
      +
      • +
    +
    +
    • + +
  • +
    +

    Method Details

    +
      +
    • +
      +

      getId

      +
      public String getId()
      +
      Gets the id of the component.
      +
      +
      Returns:
      +
      The id of the component.
      +
      +
      +
      • +
    • +
      +

      getName

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

      +
      public String 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.
      +
      +
      +
      • +
    +
    +
    • +
+
+ +
+
+
+ + diff --git a/pi4micronaut-utils/src/docs/javadoc/com/opensourcewithslu/utilities/MultiPinConfigs/package-summary.html b/pi4micronaut-utils/src/docs/javadoc/com/opensourcewithslu/utilities/MultiPinConfigs/package-summary.html new file mode 100644 index 00000000..00d5c56f --- /dev/null +++ b/pi4micronaut-utils/src/docs/javadoc/com/opensourcewithslu/utilities/MultiPinConfigs/package-summary.html @@ -0,0 +1,107 @@ + + + + +com.opensourcewithslu.utilities.MultiPinConfigs (pi4micronaut-utils v1.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Package com.opensourcewithslu.utilities.MultiPinConfigs

+
+
+
package com.opensourcewithslu.utilities.MultiPinConfigs
+
+ +
+
+
+
+ + diff --git a/pi4micronaut-utils/src/docs/javadoc/com/opensourcewithslu/utilities/MultiPinConfigs/package-tree.html b/pi4micronaut-utils/src/docs/javadoc/com/opensourcewithslu/utilities/MultiPinConfigs/package-tree.html new file mode 100644 index 00000000..fc6b9f22 --- /dev/null +++ b/pi4micronaut-utils/src/docs/javadoc/com/opensourcewithslu/utilities/MultiPinConfigs/package-tree.html @@ -0,0 +1,71 @@ + + + + +com.opensourcewithslu.utilities.MultiPinConfigs Class Hierarchy (pi4micronaut-utils v1.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Hierarchy For Package com.opensourcewithslu.utilities.MultiPinConfigs

+
+Package Hierarchies: + +
+

Class Hierarchy

+ +
+
+
+
+ + diff --git a/pi4micronaut-utils/src/docs/javadoc/com/opensourcewithslu/utilities/MultipinConfiguration.html b/pi4micronaut-utils/src/docs/javadoc/com/opensourcewithslu/utilities/MultipinConfiguration.html new file mode 100644 index 00000000..d1204612 --- /dev/null +++ b/pi4micronaut-utils/src/docs/javadoc/com/opensourcewithslu/utilities/MultipinConfiguration.html @@ -0,0 +1,206 @@ + + + + +MultipinConfiguration (pi4micronaut-utils v1.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Package com.opensourcewithslu.utilities
+

Class MultipinConfiguration

+
+
java.lang.Object +
com.opensourcewithslu.utilities.MultipinConfiguration
+
+
+
+
@Prototype +public class MultipinConfiguration +extends Object
+
Class for configuring multipin components.
+
+
+ +
+
+
    + +
  • +
    +

    Constructor Details

    +
      +
    • +
      +

      MultipinConfiguration

      +
      public MultipinConfiguration(String id, + Object[] components)
      +
      The MultipinConfiguration constructor.
      +
      +
      Parameters:
      +
      id - The configuration id as defined in the application.yml
      +
      components - The array of components that are a part of the multipin component.
      +
      +
      +
      • +
    +
    +
    • + +
  • +
    +

    Method Details

    +
      +
    • +
      +

      getId

      +
      public String 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.
      +
      +
      +
      • +
    +
    +
    • +
+
+ +
+
+
+ + diff --git a/pi4micronaut-utils/src/docs/javadoc/com/opensourcewithslu/utilities/Pi4JFactory.html b/pi4micronaut-utils/src/docs/javadoc/com/opensourcewithslu/utilities/Pi4JFactory.html new file mode 100644 index 00000000..58f64459 --- /dev/null +++ b/pi4micronaut-utils/src/docs/javadoc/com/opensourcewithslu/utilities/Pi4JFactory.html @@ -0,0 +1,297 @@ + + + + +Pi4JFactory (pi4micronaut-utils v1.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Package com.opensourcewithslu.utilities
+

Class Pi4JFactory

+
+
java.lang.Object +
com.opensourcewithslu.utilities.Pi4JFactory
+
+
+
+
@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
    +
    +
    Constructor
    +
    Description
    +
    Pi4JFactory()
    +
     
    +
    +
    +
    • + +
  • +
    +

    Method Summary

    +
    +
    +
    +
    +
    Modifier and Type
    +
    Method
    +
    Description
    +
    com.pi4j.io.gpio.digital.DigitalInput
    +
    createDigitalInput(DigitalInputConfiguration config, + com.pi4j.context.Context pi4jContext)
    +
    +
    Creates a DigitalInput object for digital input components.
    +
    +
    com.pi4j.io.gpio.digital.DigitalOutput
    +
    createDigitalOutput(DigitalOutputConfiguration config, + com.pi4j.context.Context pi4jContext)
    +
    +
    Creates a DigitalOutput object for digital output components.
    +
    +
    com.pi4j.io.i2c.I2CConfig
    +
    createI2C(i2cConfiguration config, + com.pi4j.context.Context pi4jContext)
    +
    +
    Creates an I2CConfigBuilder Object for components that are I2C.
    +
    +
    com.pi4j.context.Context
    +
    createPi4jContext()
    +
    +
    This creates the Pi4J Context that is used to create all the beans for the individual components.
    +
    +
    com.pi4j.io.pwm.Pwm
    +
    createPwm(PwmConfiguration config, + com.pi4j.context.Context pi4jContext)
    +
    +
    Creates a PWM object for components that are pwm.
    +
    +
    com.pi4j.io.spi.SpiConfig
    +
    createSpi(SpiConfiguration config, + com.pi4j.context.Context pi4jContext)
    +
    +
    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

      +
      @Singleton +@EachBean(DigitalOutputConfiguration.class) +public com.pi4j.io.gpio.digital.DigitalOutput createDigitalOutput(DigitalOutputConfiguration config, + com.pi4j.context.Context pi4jContext)
      +
      Creates a DigitalOutput object for digital output components.
      +
      +
      Parameters:
      +
      config - DigitalOutputConfiguration Object.
      +
      pi4jContext - The Pi4J Context.
      +
      Returns:
      +
      A DigitalOutput Object.
      +
      +
      +
      • +
    • +
      +

      createDigitalInput

      +
      @Singleton +@EachBean(DigitalInputConfiguration.class) +public com.pi4j.io.gpio.digital.DigitalInput createDigitalInput(DigitalInputConfiguration config, + com.pi4j.context.Context pi4jContext)
      +
      Creates a DigitalInput object for digital input components.
      +
      +
      Parameters:
      +
      config - DigitalInputConfiguration Object.
      +
      pi4jContext - The Pi4J Context.
      +
      Returns:
      +
      A DigitalInput Object.
      +
      +
      +
      • +
    • +
      +

      createPwm

      +
      @Singleton +@EachBean(PwmConfiguration.class) +public com.pi4j.io.pwm.Pwm createPwm(PwmConfiguration config, + com.pi4j.context.Context pi4jContext)
      +
      Creates a PWM object for components that are pwm.
      +
      +
      Parameters:
      +
      config - PwmConfiguration Object.
      +
      pi4jContext - The Pi4J Context.
      +
      Returns:
      +
      A PWM Object.
      +
      +
      +
      • +
    • +
      +

      createSpi

      +
      @Singleton +@EachBean(SpiConfiguration.class) +public com.pi4j.io.spi.SpiConfig createSpi(SpiConfiguration config, + com.pi4j.context.Context pi4jContext)
      +
      Creates an SpiConfigBuilder object for components that are SPI.
      +
      +
      Parameters:
      +
      config - SpiConfiguration Object.
      +
      pi4jContext - The Pi4J Context.
      +
      Returns:
      +
      A SpiConfigBuilder Object.
      +
      +
      +
      • +
    • +
      +

      createI2C

      +
      @Singleton +@EachBean(i2cConfiguration.class) +public com.pi4j.io.i2c.I2CConfig createI2C(i2cConfiguration config, + com.pi4j.context.Context pi4jContext)
      +
      Creates an I2CConfigBuilder Object for components that are I2C.
      +
      +
      Parameters:
      +
      config - i2cConfiguration Object.
      +
      pi4jContext - The Pi4J Context.
      +
      Returns:
      +
      A I2CConfigBuilder Object.
      +
      +
      +
      • +
    +
    +
    • +
+
+ +
+
+
+ + diff --git a/pi4micronaut-utils/src/docs/javadoc/com/opensourcewithslu/utilities/Pi4JMultipinFactory.html b/pi4micronaut-utils/src/docs/javadoc/com/opensourcewithslu/utilities/Pi4JMultipinFactory.html new file mode 100644 index 00000000..a6b89ecf --- /dev/null +++ b/pi4micronaut-utils/src/docs/javadoc/com/opensourcewithslu/utilities/Pi4JMultipinFactory.html @@ -0,0 +1,209 @@ + + + + +Pi4JMultipinFactory (pi4micronaut-utils v1.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Package com.opensourcewithslu.utilities
+

Class Pi4JMultipinFactory

+
+
java.lang.Object +
com.opensourcewithslu.utilities.Pi4JMultipinFactory
+
+
+
+
@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.
+
+
+ +
+
+ +
+ +
+
+
+ + diff --git a/pi4micronaut-utils/src/docs/javadoc/com/opensourcewithslu/utilities/PwmConfiguration.html b/pi4micronaut-utils/src/docs/javadoc/com/opensourcewithslu/utilities/PwmConfiguration.html new file mode 100644 index 00000000..6b4c61eb --- /dev/null +++ b/pi4micronaut-utils/src/docs/javadoc/com/opensourcewithslu/utilities/PwmConfiguration.html @@ -0,0 +1,381 @@ + + + + +PwmConfiguration (pi4micronaut-utils v1.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Package com.opensourcewithslu.utilities
+

Class PwmConfiguration

+
+
java.lang.Object +
com.opensourcewithslu.utilities.PwmConfiguration
+
+
+
+
@Prototype +@EachProperty("pi4j.pwm") +public class PwmConfiguration +extends Object
+
The PwmConfiguration class handles the configuration of a pwm component.
+
+
+
    + +
  • +
    +

    Constructor Summary

    +
    Constructors
    +
    +
    Constructor
    +
    Description
    +
    PwmConfiguration(String id)
    +
    +
    PwmConfiguration constructor.
    +
    +
    +
    +
    • + +
  • +
    +

    Method Summary

    +
    +
    +
    +
    +
    Modifier and Type
    +
    Method
    +
    Description
    +
    int
    +
    getAddress()
    +
    +
    Gets the pin address for the component.
    +
    +
    String
    +
    getId()
    +
    +
    Gets the id of the component.
    +
    +
    int
    +
    getInital()
    +
    +
    Gets the initial state that the component is in when first initialized.
    +
    +
    String
    +
    getName()
    +
    +
    Gets the name of the component.
    +
    +
    String
    +
    getProvider()
    +
    +
    Gets the provider for the component.
    +
    +
    com.pi4j.io.pwm.PwmType
    +
    getPwmType()
    +
    +
    Gets the pwm type of the component.
    +
    +
    int
    +
    getShutdown()
    +
    +
    Gets the shutdown state for the component.
    +
    +
    void
    +
    setAddress(int address)
    +
    +
    Sets a new pin address for the component.
    +
    +
    void
    +
    setInital(int inital)
    +
    +
    Sets the initial state that the component will be in when first initialized.
    +
    +
    void
    +
    setName(String name)
    +
    +
    Sets the name of the component.
    +
    +
    void
    +
    setProvider(String provider)
    +
    +
    Sets the provider of the component.
    +
    +
    void
    +
    setPwmType(String pwmType)
    +
    +
    Sets the pwm type.
    +
    +
    void
    +
    setShutdown(int 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

    +
      +
    • +
      +

      PwmConfiguration

      +
      public PwmConfiguration(@Parameter + String id)
      +
      PwmConfiguration constructor.
      +
      +
      Parameters:
      +
      id - The configuration id as defined in the application.yml
      +
      +
      +
      • +
    +
    +
    • + +
  • +
    +

    Method Details

    +
      +
    • +
      +

      getId

      +
      public String getId()
      +
      Gets the id of the component.
      +
      +
      Returns:
      +
      The id of the component.
      +
      +
      +
      • +
    • +
      +

      getName

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

      +
      public String 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.
      +
      +
      +
      • +
    +
    +
    • +
+
+ +
+
+
+ + diff --git a/pi4micronaut-utils/src/docs/javadoc/com/opensourcewithslu/utilities/SpiConfiguration.html b/pi4micronaut-utils/src/docs/javadoc/com/opensourcewithslu/utilities/SpiConfiguration.html new file mode 100644 index 00000000..eeaab827 --- /dev/null +++ b/pi4micronaut-utils/src/docs/javadoc/com/opensourcewithslu/utilities/SpiConfiguration.html @@ -0,0 +1,317 @@ + + + + +SpiConfiguration (pi4micronaut-utils v1.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Package com.opensourcewithslu.utilities
+

Class SpiConfiguration

+
+
java.lang.Object +
com.opensourcewithslu.utilities.SpiConfiguration
+
+
+
+
@Prototype +@EachProperty("pi4j.spi") +public class SpiConfiguration +extends Object
+
This class handles the configuration of a SPI component.
+
+
+
    + +
  • +
    +

    Constructor Summary

    +
    Constructors
    +
    +
    Constructor
    +
    Description
    +
    SpiConfiguration(String id)
    +
    +
    The SpiConfiguration constructor.
    +
    +
    +
    +
    • + +
  • +
    +

    Method Summary

    +
    +
    +
    +
    +
    Modifier and Type
    +
    Method
    +
    Description
    +
    int
    +
    getBaud()
    +
    +
    Gets the baud rate for the component.
    +
    +
    int
    +
    getChannel()
    +
    +
    Gets the channel for the component.
    +
    +
    String
    +
    getId()
    +
    +
    Gets the id of the component.
    +
    +
    com.pi4j.io.spi.SpiMode
    +
    getMode()
    +
    +
    Gets the SPI mode for the component.
    +
    +
    String
    +
    getName()
    +
    +
    Gets the name of the component.
    +
    +
    void
    +
    setBaud(int baud)
    +
    +
    Sets the baud rate for the component.
    +
    +
    void
    +
    setChannel(int channel)
    +
    +
    Sets a new channel for the component.
    +
    +
    void
    +
    setMode(com.pi4j.io.spi.SpiMode mode)
    +
    +
    Sets the SPI mode for the component.
    +
    +
    void
    +
    setName(String name)
    +
    +
    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

      +
      public String getId()
      +
      Gets the id of the component.
      +
      +
      Returns:
      +
      The id of the component.
      +
      +
      +
      • +
    • +
      +

      getName

      +
      public String 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.
      +
      +
      +
      • +
    +
    +
    • +
+
+ +
+
+
+ + diff --git a/pi4micronaut-utils/src/docs/javadoc/com/opensourcewithslu/utilities/i2cConfiguration.html b/pi4micronaut-utils/src/docs/javadoc/com/opensourcewithslu/utilities/i2cConfiguration.html new file mode 100644 index 00000000..24dc5f65 --- /dev/null +++ b/pi4micronaut-utils/src/docs/javadoc/com/opensourcewithslu/utilities/i2cConfiguration.html @@ -0,0 +1,285 @@ + + + + +i2cConfiguration (pi4micronaut-utils v1.0 API) + + + + + + + + + + + + + +
+ +
+
+ +
+
Package com.opensourcewithslu.utilities
+

Class i2cConfiguration

+
+
java.lang.Object +
com.opensourcewithslu.utilities.i2cConfiguration
+
+
+
+
@Prototype +@EachProperty("pi4j.i2c") +public class i2cConfiguration +extends Object
+
This class handles the configuration of an I2C components.
+
+
+ +
+
+
    + +
  • +
    +

    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

      +
      public String getId()
      +
      Gets the id of the component.
      +
      +
      Returns:
      +
      The id of the component.
      +
      +
      +
      • +
    • +
      +

      getName

      +
      public String 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.
      +
      +
      +
      • +
    +
    +
    • +
+
+ +
+
+
+ + diff --git a/pi4micronaut-utils/src/docs/javadoc/com/opensourcewithslu/utilities/package-summary.html b/pi4micronaut-utils/src/docs/javadoc/com/opensourcewithslu/utilities/package-summary.html new file mode 100644 index 00000000..6a3e7ed6 --- /dev/null +++ b/pi4micronaut-utils/src/docs/javadoc/com/opensourcewithslu/utilities/package-summary.html @@ -0,0 +1,137 @@ + + + + +com.opensourcewithslu.utilities (pi4micronaut-utils v1.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Package com.opensourcewithslu.utilities

+
+
+
package com.opensourcewithslu.utilities
+
+ +
+
+
+
+ + diff --git a/pi4micronaut-utils/src/docs/javadoc/com/opensourcewithslu/utilities/package-tree.html b/pi4micronaut-utils/src/docs/javadoc/com/opensourcewithslu/utilities/package-tree.html new file mode 100644 index 00000000..ceaa1588 --- /dev/null +++ b/pi4micronaut-utils/src/docs/javadoc/com/opensourcewithslu/utilities/package-tree.html @@ -0,0 +1,77 @@ + + + + +com.opensourcewithslu.utilities Class Hierarchy (pi4micronaut-utils v1.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Hierarchy For Package com.opensourcewithslu.utilities

+
+Package Hierarchies: + +
+

Class Hierarchy

+ +
+
+
+
+ + diff --git a/pi4micronaut-utils/src/docs/javadoc/copy.svg b/pi4micronaut-utils/src/docs/javadoc/copy.svg new file mode 100644 index 00000000..d435f6c3 --- /dev/null +++ b/pi4micronaut-utils/src/docs/javadoc/copy.svg @@ -0,0 +1,33 @@ + + + + + + + + diff --git a/pi4micronaut-utils/src/docs/javadoc/element-list b/pi4micronaut-utils/src/docs/javadoc/element-list new file mode 100644 index 00000000..6c0109fb --- /dev/null +++ b/pi4micronaut-utils/src/docs/javadoc/element-list @@ -0,0 +1,5 @@ +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 new file mode 100644 index 00000000..19e35bf8 --- /dev/null +++ b/pi4micronaut-utils/src/docs/javadoc/help-doc.html @@ -0,0 +1,182 @@ + + + + +API Help (pi4micronaut-utils v1.0 API) + + + + + + + + + + + + + +
+ +
+
+

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

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.

+
+
+

Index

+

The Index contains an alphabetic index of all classes, interfaces, constructors, methods, and fields in the documentation, as well as summary pages such as All Packages, All Classes and Interfaces.

+
+
+
+This help file applies to API documentation generated by the standard doclet.
+
+
+ + diff --git a/pi4micronaut-utils/src/docs/javadoc/index-all.html b/pi4micronaut-utils/src/docs/javadoc/index-all.html new file mode 100644 index 00000000..bdbe5ade --- /dev/null +++ b/pi4micronaut-utils/src/docs/javadoc/index-all.html @@ -0,0 +1,845 @@ + + + + +Index (pi4micronaut-utils v1.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Index

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

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

+
+
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
+
+
+ + diff --git a/pi4micronaut-utils/src/docs/javadoc/index.html b/pi4micronaut-utils/src/docs/javadoc/index.html new file mode 100644 index 00000000..203eed4e --- /dev/null +++ b/pi4micronaut-utils/src/docs/javadoc/index.html @@ -0,0 +1,73 @@ + + + + +Overview (pi4micronaut-utils v1.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

pi4micronaut-utils v1.0 API

+
+ +
+
+
+ + diff --git a/pi4micronaut-utils/src/docs/javadoc/legal/COPYRIGHT b/pi4micronaut-utils/src/docs/javadoc/legal/COPYRIGHT new file mode 100644 index 00000000..ca74fffd --- /dev/null +++ b/pi4micronaut-utils/src/docs/javadoc/legal/COPYRIGHT @@ -0,0 +1 @@ +Please see ..\java.base\COPYRIGHT diff --git a/pi4micronaut-utils/src/docs/javadoc/legal/LICENSE b/pi4micronaut-utils/src/docs/javadoc/legal/LICENSE new file mode 100644 index 00000000..4ad9fe40 --- /dev/null +++ b/pi4micronaut-utils/src/docs/javadoc/legal/LICENSE @@ -0,0 +1 @@ +Please see ..\java.base\LICENSE diff --git a/pi4micronaut-utils/src/docs/javadoc/legal/jquery.md b/pi4micronaut-utils/src/docs/javadoc/legal/jquery.md new file mode 100644 index 00000000..d468b318 --- /dev/null +++ b/pi4micronaut-utils/src/docs/javadoc/legal/jquery.md @@ -0,0 +1,72 @@ +## jQuery v3.6.1 + +### jQuery License +``` +jQuery v 3.6.1 +Copyright OpenJS Foundation and other contributors, https://openjsf.org/ + +Permission is hereby granted, free of charge, to any person obtaining +a copy of this software and associated documentation files (the +"Software"), to deal in the Software without restriction, including +without limitation the rights to use, copy, modify, merge, publish, +distribute, sublicense, and/or sell copies of the Software, and to +permit persons to whom the Software is furnished to do so, subject to +the following conditions: + +The above copyright notice and this permission notice shall be +included in all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, +EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF +MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND +NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE +LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION +OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION +WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. + +****************************************** + +The jQuery JavaScript Library v3.6.1 also includes Sizzle.js + +Sizzle.js includes the following license: + +Copyright JS Foundation and other contributors, https://js.foundation/ + +This software consists of voluntary contributions made by many +individuals. For exact contribution history, see the revision history +available at https://github.com/jquery/sizzle + +The following license applies to all parts of this software except as +documented below: + +==== + +Permission is hereby granted, free of charge, to any person obtaining +a copy of this software and associated documentation files (the +"Software"), to deal in the Software without restriction, including +without limitation the rights to use, copy, modify, merge, publish, +distribute, sublicense, and/or sell copies of the Software, and to +permit persons to whom the Software is furnished to do so, subject to +the following conditions: + +The above copyright notice and this permission notice shall be +included in all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, +EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF +MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND +NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE +LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION +OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION +WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. + +==== + +All files located in the node_modules and external directories are +externally maintained libraries used by this software which have their +own licenses; we recommend you read them, as their terms may differ from +the terms above. + +********************* + +``` diff --git a/pi4micronaut-utils/src/docs/javadoc/legal/jqueryUI.md b/pi4micronaut-utils/src/docs/javadoc/legal/jqueryUI.md new file mode 100644 index 00000000..8bda9d7a --- /dev/null +++ b/pi4micronaut-utils/src/docs/javadoc/legal/jqueryUI.md @@ -0,0 +1,49 @@ +## jQuery UI v1.13.2 + +### jQuery UI License +``` +Copyright jQuery Foundation and other contributors, https://jquery.org/ + +This software consists of voluntary contributions made by many +individuals. For exact contribution history, see the revision history +available at https://github.com/jquery/jquery-ui + +The following license applies to all parts of this software except as +documented below: + +==== + +Permission is hereby granted, free of charge, to any person obtaining +a copy of this software and associated documentation files (the +"Software"), to deal in the Software without restriction, including +without limitation the rights to use, copy, modify, merge, publish, +distribute, sublicense, and/or sell copies of the Software, and to +permit persons to whom the Software is furnished to do so, subject to +the following conditions: + +The above copyright notice and this permission notice shall be +included in all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, +EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF +MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND +NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE +LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION +OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION +WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. + +==== + +Copyright and related rights for sample code are waived via CC0. Sample +code is defined as all source code contained within the demos directory. + +CC0: http://creativecommons.org/publicdomain/zero/1.0/ + +==== + +All files located in the node_modules and external directories are +externally maintained libraries used by this software which have their +own licenses; we recommend you read them, as their terms may differ from +the terms above. + +``` diff --git a/pi4micronaut-utils/src/docs/javadoc/link.svg b/pi4micronaut-utils/src/docs/javadoc/link.svg new file mode 100644 index 00000000..dadef51c --- /dev/null +++ b/pi4micronaut-utils/src/docs/javadoc/link.svg @@ -0,0 +1,31 @@ + + + + + + + + diff --git a/pi4micronaut-utils/src/docs/javadoc/member-search-index.js b/pi4micronaut-utils/src/docs/javadoc/member-search-index.js new file mode 100644 index 00000000..e278f622 --- /dev/null +++ b/pi4micronaut-utils/src/docs/javadoc/member-search-index.js @@ -0,0 +1 @@ +memberSearchIndex = [{"p":"com.opensourcewithslu.outputdevices","c":"ActiveBuzzerHelper","l":"actBuzzCheck"},{"p":"com.opensourcewithslu.outputdevices","c":"ActiveBuzzerHelper","l":"ActiveBuzzerHelper(Pwm)","u":"%3Cinit%3E(com.pi4j.io.pwm.Pwm)"},{"p":"com.opensourcewithslu.outputdevices","c":"ActiveBuzzerHelper","l":"activeBuzzerOff()"},{"p":"com.opensourcewithslu.outputdevices","c":"ActiveBuzzerHelper","l":"activeBuzzerOn()"},{"p":"com.opensourcewithslu.inputdevices","c":"PhotoResistorHelper","l":"addEventListener(DigitalStateChangeListener)","u":"addEventListener(com.pi4j.io.gpio.digital.DigitalStateChangeListener)"},{"p":"com.opensourcewithslu.inputdevices","c":"PIRSensorHelper","l":"addEventListener(DigitalStateChangeListener)","u":"addEventListener(com.pi4j.io.gpio.digital.DigitalStateChangeListener)"},{"p":"com.opensourcewithslu.inputdevices","c":"PushButtonHelper","l":"addEventListener(DigitalStateChangeListener)","u":"addEventListener(com.pi4j.io.gpio.digital.DigitalStateChangeListener)"},{"p":"com.opensourcewithslu.inputdevices","c":"SlideSwitchHelper","l":"addEventListener(DigitalStateChangeListener)","u":"addEventListener(com.pi4j.io.gpio.digital.DigitalStateChangeListener)"},{"p":"com.opensourcewithslu.inputdevices","c":"TouchSwitchHelper","l":"addEventListener(DigitalStateChangeListener)","u":"addEventListener(com.pi4j.io.gpio.digital.DigitalStateChangeListener)"},{"p":"com.opensourcewithslu","c":"Application","l":"Application()","u":"%3Cinit%3E()"},{"p":"com.opensourcewithslu.outputdevices","c":"ActiveBuzzerHelper","l":"beep()"},{"p":"com.opensourcewithslu.outputdevices","c":"LCD1602Helper","l":"clearDisplay()"},{"p":"com.opensourcewithslu.outputdevices","c":"LCD1602Helper","l":"clearLine(int)"},{"p":"com.opensourcewithslu.utilities","c":"Pi4JFactory","l":"createDigitalInput(DigitalInputConfiguration, Context)","u":"createDigitalInput(com.opensourcewithslu.utilities.DigitalInputConfiguration,com.pi4j.context.Context)"},{"p":"com.opensourcewithslu.utilities","c":"Pi4JFactory","l":"createDigitalOutput(DigitalOutputConfiguration, Context)","u":"createDigitalOutput(com.opensourcewithslu.utilities.DigitalOutputConfiguration,com.pi4j.context.Context)"},{"p":"com.opensourcewithslu.utilities","c":"Pi4JFactory","l":"createI2C(i2cConfiguration, Context)","u":"createI2C(com.opensourcewithslu.utilities.i2cConfiguration,com.pi4j.context.Context)"},{"p":"com.opensourcewithslu.utilities","c":"Pi4JFactory","l":"createPi4jContext()"},{"p":"com.opensourcewithslu.utilities","c":"Pi4JFactory","l":"createPwm(PwmConfiguration, Context)","u":"createPwm(com.opensourcewithslu.utilities.PwmConfiguration,com.pi4j.context.Context)"},{"p":"com.opensourcewithslu.utilities","c":"Pi4JFactory","l":"createSpi(SpiConfiguration, Context)","u":"createSpi(com.opensourcewithslu.utilities.SpiConfiguration,com.pi4j.context.Context)"},{"p":"com.opensourcewithslu.utilities","c":"DigitalInputConfiguration","l":"DigitalInputConfiguration(String)","u":"%3Cinit%3E(java.lang.String)"},{"p":"com.opensourcewithslu.utilities.MultiPinConfigs","c":"DigitalInputMultiPinConfiguration","l":"DigitalInputMultiPinConfiguration(String)","u":"%3Cinit%3E(java.lang.String)"},{"p":"com.opensourcewithslu.utilities","c":"DigitalOutputConfiguration","l":"DigitalOutputConfiguration(String)","u":"%3Cinit%3E(java.lang.String)"},{"p":"com.opensourcewithslu.utilities","c":"DigitalInputConfiguration","l":"getAddress()"},{"p":"com.opensourcewithslu.utilities","c":"DigitalOutputConfiguration","l":"getAddress()"},{"p":"com.opensourcewithslu.utilities","c":"PwmConfiguration","l":"getAddress()"},{"p":"com.opensourcewithslu.utilities.MultiPinConfigs","c":"DigitalInputMultiPinConfiguration","l":"getAddresses()"},{"p":"com.opensourcewithslu.utilities.MultiPinConfigs","c":"PwmMultiPinConfiguration","l":"getAddresses()"},{"p":"com.opensourcewithslu.utilities","c":"SpiConfiguration","l":"getBaud()"},{"p":"com.opensourcewithslu.utilities","c":"i2cConfiguration","l":"getBus()"},{"p":"com.opensourcewithslu.utilities","c":"SpiConfiguration","l":"getChannel()"},{"p":"com.opensourcewithslu.utilities","c":"MultipinConfiguration","l":"getComponents()"},{"p":"com.opensourcewithslu.inputdevices","c":"PhotoResistorHelper","l":"getDark()"},{"p":"com.opensourcewithslu.utilities","c":"DigitalInputConfiguration","l":"getDebounce()"},{"p":"com.opensourcewithslu.utilities.MultiPinConfigs","c":"DigitalInputMultiPinConfiguration","l":"getDebounces()"},{"p":"com.opensourcewithslu.utilities","c":"i2cConfiguration","l":"getDevice()"},{"p":"com.opensourcewithslu.inputdevices","c":"RotaryEncoderHelper","l":"getEncoderValue()"},{"p":"com.opensourcewithslu.utilities","c":"DigitalInputConfiguration","l":"getId()"},{"p":"com.opensourcewithslu.utilities","c":"DigitalOutputConfiguration","l":"getId()"},{"p":"com.opensourcewithslu.utilities","c":"i2cConfiguration","l":"getId()"},{"p":"com.opensourcewithslu.utilities.MultiPinConfigs","c":"DigitalInputMultiPinConfiguration","l":"getId()"},{"p":"com.opensourcewithslu.utilities.MultiPinConfigs","c":"PwmMultiPinConfiguration","l":"getId()"},{"p":"com.opensourcewithslu.utilities","c":"MultipinConfiguration","l":"getId()"},{"p":"com.opensourcewithslu.utilities","c":"PwmConfiguration","l":"getId()"},{"p":"com.opensourcewithslu.utilities","c":"SpiConfiguration","l":"getId()"},{"p":"com.opensourcewithslu.utilities","c":"PwmConfiguration","l":"getInital()"},{"p":"com.opensourcewithslu.utilities.MultiPinConfigs","c":"PwmMultiPinConfiguration","l":"getInitals()"},{"p":"com.opensourcewithslu.utilities","c":"DigitalOutputConfiguration","l":"getInitial()"},{"p":"com.opensourcewithslu.utilities","c":"SpiConfiguration","l":"getMode()"},{"p":"com.opensourcewithslu.utilities","c":"DigitalInputConfiguration","l":"getName()"},{"p":"com.opensourcewithslu.utilities","c":"DigitalOutputConfiguration","l":"getName()"},{"p":"com.opensourcewithslu.utilities","c":"i2cConfiguration","l":"getName()"},{"p":"com.opensourcewithslu.utilities.MultiPinConfigs","c":"DigitalInputMultiPinConfiguration","l":"getName()"},{"p":"com.opensourcewithslu.utilities.MultiPinConfigs","c":"PwmMultiPinConfiguration","l":"getName()"},{"p":"com.opensourcewithslu.utilities","c":"PwmConfiguration","l":"getName()"},{"p":"com.opensourcewithslu.utilities","c":"SpiConfiguration","l":"getName()"},{"p":"com.opensourcewithslu.utilities","c":"DigitalInputConfiguration","l":"getProvider()"},{"p":"com.opensourcewithslu.utilities","c":"DigitalOutputConfiguration","l":"getProvider()"},{"p":"com.opensourcewithslu.utilities.MultiPinConfigs","c":"DigitalInputMultiPinConfiguration","l":"getProvider()"},{"p":"com.opensourcewithslu.utilities.MultiPinConfigs","c":"PwmMultiPinConfiguration","l":"getProvider()"},{"p":"com.opensourcewithslu.utilities","c":"PwmConfiguration","l":"getProvider()"},{"p":"com.opensourcewithslu.utilities","c":"DigitalInputConfiguration","l":"getPull()"},{"p":"com.opensourcewithslu.utilities.MultiPinConfigs","c":"DigitalInputMultiPinConfiguration","l":"getPulls()"},{"p":"com.opensourcewithslu.utilities","c":"PwmConfiguration","l":"getPwmType()"},{"p":"com.opensourcewithslu.utilities.MultiPinConfigs","c":"PwmMultiPinConfiguration","l":"getPwmTypes()"},{"p":"com.opensourcewithslu.utilities","c":"DigitalOutputConfiguration","l":"getShutdown()"},{"p":"com.opensourcewithslu.utilities","c":"PwmConfiguration","l":"getShutdown()"},{"p":"com.opensourcewithslu.utilities.MultiPinConfigs","c":"PwmMultiPinConfiguration","l":"getShutdowns()"},{"p":"com.opensourcewithslu.utilities","c":"i2cConfiguration","l":"i2cConfiguration(String)","u":"%3Cinit%3E(java.lang.String)"},{"p":"com.opensourcewithslu.inputdevices","c":"PhotoResistorHelper","l":"initialize()"},{"p":"com.opensourcewithslu.inputdevices","c":"PIRSensorHelper","l":"initialize()"},{"p":"com.opensourcewithslu.inputdevices","c":"PushButtonHelper","l":"initialize()"},{"p":"com.opensourcewithslu.inputdevices","c":"RotaryEncoderHelper","l":"initialize()"},{"p":"com.opensourcewithslu.inputdevices","c":"SlideSwitchHelper","l":"initialize()"},{"p":"com.opensourcewithslu.inputdevices","c":"TouchSwitchHelper","l":"initialize()"},{"p":"com.opensourcewithslu.outputdevices","c":"ActiveBuzzerHelper","l":"intermittentTone()"},{"p":"com.opensourcewithslu.inputdevices","c":"PhotoResistorHelper","l":"isDark"},{"p":"com.opensourcewithslu.inputdevices","c":"PIRSensorHelper","l":"isMoving"},{"p":"com.opensourcewithslu.inputdevices","c":"SlideSwitchHelper","l":"isOn"},{"p":"com.opensourcewithslu.inputdevices","c":"PushButtonHelper","l":"isPressed"},{"p":"com.opensourcewithslu.inputdevices","c":"TouchSwitchHelper","l":"isTouched"},{"p":"com.opensourcewithslu.outputdevices","c":"LCD1602Helper","l":"LCD1602Helper(I2CConfig, Context)","u":"%3Cinit%3E(com.pi4j.io.i2c.I2CConfig,com.pi4j.context.Context)"},{"p":"com.opensourcewithslu.outputdevices","c":"LEDHelper","l":"LEDHelper(DigitalOutput)","u":"%3Cinit%3E(com.pi4j.io.gpio.digital.DigitalOutput)"},{"p":"com.opensourcewithslu.outputdevices","c":"LEDHelper","l":"ledOff()"},{"p":"com.opensourcewithslu.outputdevices","c":"RGBLEDHelper","l":"ledOff()"},{"p":"com.opensourcewithslu.outputdevices","c":"LEDHelper","l":"ledOn()"},{"p":"com.opensourcewithslu.outputdevices","c":"RGBLEDHelper","l":"ledOn()"},{"p":"com.opensourcewithslu","c":"Application","l":"main(String[])","u":"main(java.lang.String[])"},{"p":"com.opensourcewithslu.outputdevices","c":"ActiveBuzzerHelper","l":"morseCodeTone()"},{"p":"com.opensourcewithslu.utilities","c":"MultipinConfiguration","l":"MultipinConfiguration(String, Object[])","u":"%3Cinit%3E(java.lang.String,java.lang.Object[])"},{"p":"com.opensourcewithslu.utilities","c":"Pi4JMultipinFactory","l":"multiPinInput(DigitalInputMultiPinConfiguration, Context)","u":"multiPinInput(com.opensourcewithslu.utilities.MultiPinConfigs.DigitalInputMultiPinConfiguration,com.pi4j.context.Context)"},{"p":"com.opensourcewithslu.utilities","c":"Pi4JMultipinFactory","l":"multiPinPwm(PwmMultiPinConfiguration, Context)","u":"multiPinPwm(com.opensourcewithslu.utilities.MultiPinConfigs.PwmMultiPinConfiguration,com.pi4j.context.Context)"},{"p":"com.opensourcewithslu.inputdevices","c":"PhotoResistorHelper","l":"PhotoResistorHelper(DigitalInput, DigitalOutput)","u":"%3Cinit%3E(com.pi4j.io.gpio.digital.DigitalInput,com.pi4j.io.gpio.digital.DigitalOutput)"},{"p":"com.opensourcewithslu.utilities","c":"Pi4JFactory","l":"Pi4JFactory()","u":"%3Cinit%3E()"},{"p":"com.opensourcewithslu.utilities","c":"Pi4JMultipinFactory","l":"Pi4JMultipinFactory()","u":"%3Cinit%3E()"},{"p":"com.opensourcewithslu.inputdevices","c":"PIRSensorHelper","l":"PIRSensorHelper(DigitalInput)","u":"%3Cinit%3E(com.pi4j.io.gpio.digital.DigitalInput)"},{"p":"com.opensourcewithslu.inputdevices","c":"PushButtonHelper","l":"PushButtonHelper(DigitalInput)","u":"%3Cinit%3E(com.pi4j.io.gpio.digital.DigitalInput)"},{"p":"com.opensourcewithslu.utilities","c":"PwmConfiguration","l":"PwmConfiguration(String)","u":"%3Cinit%3E(java.lang.String)"},{"p":"com.opensourcewithslu.utilities.MultiPinConfigs","c":"PwmMultiPinConfiguration","l":"PwmMultiPinConfiguration(String)","u":"%3Cinit%3E(java.lang.String)"},{"p":"com.opensourcewithslu.inputdevices","c":"RFidHelper","l":"readFromCard()"},{"p":"com.opensourcewithslu.inputdevices","c":"PhotoResistorHelper","l":"removeEventListener()"},{"p":"com.opensourcewithslu.inputdevices","c":"PIRSensorHelper","l":"removeEventListener()"},{"p":"com.opensourcewithslu.inputdevices","c":"TouchSwitchHelper","l":"removeEventListener()"},{"p":"com.opensourcewithslu.inputdevices","c":"PushButtonHelper","l":"removeEventListener(DigitalStateChangeListener)","u":"removeEventListener(com.pi4j.io.gpio.digital.DigitalStateChangeListener)"},{"p":"com.opensourcewithslu.inputdevices","c":"SlideSwitchHelper","l":"removeEventListener(DigitalStateChangeListener)","u":"removeEventListener(com.pi4j.io.gpio.digital.DigitalStateChangeListener)"},{"p":"com.opensourcewithslu.inputdevices","c":"RFidHelper","l":"resetScanner()"},{"p":"com.opensourcewithslu.inputdevices","c":"RFidHelper","l":"RFidHelper(SpiConfig, Context)","u":"%3Cinit%3E(com.pi4j.io.spi.SpiConfig,com.pi4j.context.Context)"},{"p":"com.opensourcewithslu.inputdevices","c":"RFidHelper","l":"RFidHelper(SpiConfig, int, Context)","u":"%3Cinit%3E(com.pi4j.io.spi.SpiConfig,int,com.pi4j.context.Context)"},{"p":"com.opensourcewithslu.outputdevices","c":"RGBLEDHelper","l":"RGBLEDHelper(MultipinConfiguration)","u":"%3Cinit%3E(com.opensourcewithslu.utilities.MultipinConfiguration)"},{"p":"com.opensourcewithslu.inputdevices","c":"RotaryEncoderHelper","l":"RotaryEncoderHelper(MultipinConfiguration)","u":"%3Cinit%3E(com.opensourcewithslu.utilities.MultipinConfiguration)"},{"p":"com.opensourcewithslu.utilities","c":"DigitalInputConfiguration","l":"setAddress(int)"},{"p":"com.opensourcewithslu.utilities","c":"DigitalOutputConfiguration","l":"setAddress(int)"},{"p":"com.opensourcewithslu.utilities","c":"PwmConfiguration","l":"setAddress(int)"},{"p":"com.opensourcewithslu.utilities.MultiPinConfigs","c":"DigitalInputMultiPinConfiguration","l":"setAddresses(String)","u":"setAddresses(java.lang.String)"},{"p":"com.opensourcewithslu.utilities.MultiPinConfigs","c":"PwmMultiPinConfiguration","l":"setAddresses(String)","u":"setAddresses(java.lang.String)"},{"p":"com.opensourcewithslu.outputdevices","c":"LCD1602Helper","l":"setBackLight(boolean)"},{"p":"com.opensourcewithslu.utilities","c":"SpiConfiguration","l":"setBaud(int)"},{"p":"com.opensourcewithslu.outputdevices","c":"RGBLEDHelper","l":"setBlue(int)"},{"p":"com.opensourcewithslu.outputdevices","c":"RGBLEDHelper","l":"setBlue(int, int)","u":"setBlue(int,int)"},{"p":"com.opensourcewithslu.utilities","c":"i2cConfiguration","l":"setBus(int)"},{"p":"com.opensourcewithslu.utilities","c":"SpiConfiguration","l":"setChannel(int)"},{"p":"com.opensourcewithslu.outputdevices","c":"RGBLEDHelper","l":"setColor(int[])"},{"p":"com.opensourcewithslu.outputdevices","c":"RGBLEDHelper","l":"setColor(int[], int[])","u":"setColor(int[],int[])"},{"p":"com.opensourcewithslu.outputdevices","c":"RGBLEDHelper","l":"setColorHex(String)","u":"setColorHex(java.lang.String)"},{"p":"com.opensourcewithslu.outputdevices","c":"RGBLEDHelper","l":"setColorHex(String, int[])","u":"setColorHex(java.lang.String,int[])"},{"p":"com.opensourcewithslu.inputdevices","c":"PhotoResistorHelper","l":"setDarknessThreshold(int)"},{"p":"com.opensourcewithslu.utilities","c":"DigitalInputConfiguration","l":"setDebounce(Long)","u":"setDebounce(java.lang.Long)"},{"p":"com.opensourcewithslu.utilities.MultiPinConfigs","c":"DigitalInputMultiPinConfiguration","l":"setDebounces(String)","u":"setDebounces(java.lang.String)"},{"p":"com.opensourcewithslu.utilities","c":"i2cConfiguration","l":"setDevice(int)"},{"p":"com.opensourcewithslu.outputdevices","c":"RGBLEDHelper","l":"setGreen(int)"},{"p":"com.opensourcewithslu.outputdevices","c":"RGBLEDHelper","l":"setGreen(int, int)","u":"setGreen(int,int)"},{"p":"com.opensourcewithslu.utilities","c":"PwmConfiguration","l":"setInital(int)"},{"p":"com.opensourcewithslu.utilities","c":"DigitalOutputConfiguration","l":"setInitial(DigitalState)","u":"setInitial(com.pi4j.io.gpio.digital.DigitalState)"},{"p":"com.opensourcewithslu.utilities.MultiPinConfigs","c":"PwmMultiPinConfiguration","l":"setInitials(String)","u":"setInitials(java.lang.String)"},{"p":"com.opensourcewithslu.utilities","c":"SpiConfiguration","l":"setMode(SpiMode)","u":"setMode(com.pi4j.io.spi.SpiMode)"},{"p":"com.opensourcewithslu.utilities","c":"DigitalInputConfiguration","l":"setName(String)","u":"setName(java.lang.String)"},{"p":"com.opensourcewithslu.utilities","c":"DigitalOutputConfiguration","l":"setName(String)","u":"setName(java.lang.String)"},{"p":"com.opensourcewithslu.utilities","c":"i2cConfiguration","l":"setName(String)","u":"setName(java.lang.String)"},{"p":"com.opensourcewithslu.utilities.MultiPinConfigs","c":"DigitalInputMultiPinConfiguration","l":"setName(String)","u":"setName(java.lang.String)"},{"p":"com.opensourcewithslu.utilities.MultiPinConfigs","c":"PwmMultiPinConfiguration","l":"setName(String)","u":"setName(java.lang.String)"},{"p":"com.opensourcewithslu.utilities","c":"PwmConfiguration","l":"setName(String)","u":"setName(java.lang.String)"},{"p":"com.opensourcewithslu.utilities","c":"SpiConfiguration","l":"setName(String)","u":"setName(java.lang.String)"},{"p":"com.opensourcewithslu.utilities","c":"DigitalInputConfiguration","l":"setProvider(String)","u":"setProvider(java.lang.String)"},{"p":"com.opensourcewithslu.utilities","c":"DigitalOutputConfiguration","l":"setProvider(String)","u":"setProvider(java.lang.String)"},{"p":"com.opensourcewithslu.utilities.MultiPinConfigs","c":"DigitalInputMultiPinConfiguration","l":"setProvider(String)","u":"setProvider(java.lang.String)"},{"p":"com.opensourcewithslu.utilities.MultiPinConfigs","c":"PwmMultiPinConfiguration","l":"setProvider(String)","u":"setProvider(java.lang.String)"},{"p":"com.opensourcewithslu.utilities","c":"PwmConfiguration","l":"setProvider(String)","u":"setProvider(java.lang.String)"},{"p":"com.opensourcewithslu.utilities","c":"DigitalInputConfiguration","l":"setPull(PullResistance)","u":"setPull(com.pi4j.io.gpio.digital.PullResistance)"},{"p":"com.opensourcewithslu.utilities.MultiPinConfigs","c":"DigitalInputMultiPinConfiguration","l":"setPulls(String)","u":"setPulls(java.lang.String)"},{"p":"com.opensourcewithslu.utilities","c":"PwmConfiguration","l":"setPwmType(String)","u":"setPwmType(java.lang.String)"},{"p":"com.opensourcewithslu.utilities.MultiPinConfigs","c":"PwmMultiPinConfiguration","l":"setPwmTypes(String)","u":"setPwmTypes(java.lang.String)"},{"p":"com.opensourcewithslu.outputdevices","c":"RGBLEDHelper","l":"setRed(int)"},{"p":"com.opensourcewithslu.outputdevices","c":"RGBLEDHelper","l":"setRed(int, int)","u":"setRed(int,int)"},{"p":"com.opensourcewithslu.utilities","c":"DigitalOutputConfiguration","l":"setShutdown(DigitalState)","u":"setShutdown(com.pi4j.io.gpio.digital.DigitalState)"},{"p":"com.opensourcewithslu.utilities","c":"PwmConfiguration","l":"setShutdown(int)"},{"p":"com.opensourcewithslu.utilities.MultiPinConfigs","c":"PwmMultiPinConfiguration","l":"setShutdowns(String)","u":"setShutdowns(java.lang.String)"},{"p":"com.opensourcewithslu.inputdevices","c":"PhotoResistorHelper","l":"setToLow()"},{"p":"com.opensourcewithslu.inputdevices","c":"SlideSwitchHelper","l":"SlideSwitchHelper(DigitalInput)","u":"%3Cinit%3E(com.pi4j.io.gpio.digital.DigitalInput)"},{"p":"com.opensourcewithslu.utilities","c":"SpiConfiguration","l":"SpiConfiguration(String)","u":"%3Cinit%3E(java.lang.String)"},{"p":"com.opensourcewithslu.outputdevices","c":"LEDHelper","l":"switchState()"},{"p":"com.opensourcewithslu.inputdevices","c":"TouchSwitchHelper","l":"TouchSwitchHelper(DigitalInput)","u":"%3Cinit%3E(com.pi4j.io.gpio.digital.DigitalInput)"},{"p":"com.opensourcewithslu.inputdevices","c":"PhotoResistorHelper","l":"updateDark()"},{"p":"com.opensourcewithslu.outputdevices","c":"LCD1602Helper","l":"writeText(String)","u":"writeText(java.lang.String)"},{"p":"com.opensourcewithslu.outputdevices","c":"LCD1602Helper","l":"writeTextAtLine(String, int)","u":"writeTextAtLine(java.lang.String,int)"},{"p":"com.opensourcewithslu.inputdevices","c":"RFidHelper","l":"writeToCard(Object)","u":"writeToCard(java.lang.Object)"}];updateSearchResults(); \ No newline at end of file diff --git a/pi4micronaut-utils/src/docs/javadoc/module-search-index.js b/pi4micronaut-utils/src/docs/javadoc/module-search-index.js new file mode 100644 index 00000000..0d59754f --- /dev/null +++ b/pi4micronaut-utils/src/docs/javadoc/module-search-index.js @@ -0,0 +1 @@ +moduleSearchIndex = [];updateSearchResults(); \ No newline at end of file diff --git a/pi4micronaut-utils/src/docs/javadoc/overview-summary.html b/pi4micronaut-utils/src/docs/javadoc/overview-summary.html new file mode 100644 index 00000000..abdf857b --- /dev/null +++ b/pi4micronaut-utils/src/docs/javadoc/overview-summary.html @@ -0,0 +1,25 @@ + + + + +pi4micronaut-utils v1.0 API + + + + + + + + + + +
+ +

index.html

+
+ + diff --git a/pi4micronaut-utils/src/docs/javadoc/overview-tree.html b/pi4micronaut-utils/src/docs/javadoc/overview-tree.html new file mode 100644 index 00000000..123c143c --- /dev/null +++ b/pi4micronaut-utils/src/docs/javadoc/overview-tree.html @@ -0,0 +1,95 @@ + + + + +Class Hierarchy (pi4micronaut-utils v1.0 API) + + + + + + + + + + + + + +
+ +
+
+
+

Hierarchy For All Packages

+
+Package Hierarchies: + +
+

Class Hierarchy

+ +
+
+
+
+ + diff --git a/pi4micronaut-utils/src/docs/javadoc/package-search-index.js b/pi4micronaut-utils/src/docs/javadoc/package-search-index.js new file mode 100644 index 00000000..babb6f0a --- /dev/null +++ b/pi4micronaut-utils/src/docs/javadoc/package-search-index.js @@ -0,0 +1 @@ +packageSearchIndex = [{"l":"All Packages","u":"allpackages-index.html"},{"l":"com.opensourcewithslu"},{"l":"com.opensourcewithslu.inputdevices"},{"l":"com.opensourcewithslu.outputdevices"},{"l":"com.opensourcewithslu.utilities"},{"l":"com.opensourcewithslu.utilities.MultiPinConfigs"}];updateSearchResults(); \ No newline at end of file diff --git a/pi4micronaut-utils/src/docs/javadoc/resources/glass.png b/pi4micronaut-utils/src/docs/javadoc/resources/glass.png new file mode 100644 index 00000000..a7f591f4 Binary files /dev/null and b/pi4micronaut-utils/src/docs/javadoc/resources/glass.png differ diff --git a/pi4micronaut-utils/src/docs/javadoc/resources/x.png b/pi4micronaut-utils/src/docs/javadoc/resources/x.png new file mode 100644 index 00000000..30548a75 Binary files /dev/null and b/pi4micronaut-utils/src/docs/javadoc/resources/x.png differ diff --git a/pi4micronaut-utils/src/docs/javadoc/script-dir/jquery-3.6.1.min.js b/pi4micronaut-utils/src/docs/javadoc/script-dir/jquery-3.6.1.min.js new file mode 100644 index 00000000..2c69bc90 --- /dev/null +++ b/pi4micronaut-utils/src/docs/javadoc/script-dir/jquery-3.6.1.min.js @@ -0,0 +1,2 @@ +/*! jQuery v3.6.1 | (c) OpenJS Foundation and other contributors | jquery.org/license */ +!function(e,t){"use strict";"object"==typeof module&&"object"==typeof module.exports?module.exports=e.document?t(e,!0):function(e){if(!e.document)throw new Error("jQuery requires a window with a document");return t(e)}:t(e)}("undefined"!=typeof window?window:this,function(C,e){"use strict";var t=[],r=Object.getPrototypeOf,s=t.slice,g=t.flat?function(e){return t.flat.call(e)}:function(e){return t.concat.apply([],e)},u=t.push,i=t.indexOf,n={},o=n.toString,y=n.hasOwnProperty,a=y.toString,l=a.call(Object),v={},m=function(e){return"function"==typeof e&&"number"!=typeof e.nodeType&&"function"!=typeof e.item},x=function(e){return null!=e&&e===e.window},E=C.document,c={type:!0,src:!0,nonce:!0,noModule:!0};function b(e,t,n){var r,i,o=(n=n||E).createElement("script");if(o.text=e,t)for(r in c)(i=t[r]||t.getAttribute&&t.getAttribute(r))&&o.setAttribute(r,i);n.head.appendChild(o).parentNode.removeChild(o)}function w(e){return null==e?e+"":"object"==typeof e||"function"==typeof e?n[o.call(e)]||"object":typeof e}var f="3.6.1",S=function(e,t){return new S.fn.init(e,t)};function p(e){var t=!!e&&"length"in e&&e.length,n=w(e);return!m(e)&&!x(e)&&("array"===n||0===t||"number"==typeof t&&0+~]|"+M+")"+M+"*"),U=new RegExp(M+"|>"),X=new RegExp(F),V=new RegExp("^"+I+"$"),G={ID:new RegExp("^#("+I+")"),CLASS:new RegExp("^\\.("+I+")"),TAG:new RegExp("^("+I+"|[*])"),ATTR:new RegExp("^"+W),PSEUDO:new RegExp("^"+F),CHILD:new RegExp("^:(only|first|last|nth|nth-last)-(child|of-type)(?:\\("+M+"*(even|odd|(([+-]|)(\\d*)n|)"+M+"*(?:([+-]|)"+M+"*(\\d+)|))"+M+"*\\)|)","i"),bool:new RegExp("^(?:"+R+")$","i"),needsContext:new RegExp("^"+M+"*[>+~]|:(even|odd|eq|gt|lt|nth|first|last)(?:\\("+M+"*((?:-\\d)?\\d*)"+M+"*\\)|)(?=[^-]|$)","i")},Y=/HTML$/i,Q=/^(?:input|select|textarea|button)$/i,J=/^h\d$/i,K=/^[^{]+\{\s*\[native \w/,Z=/^(?:#([\w-]+)|(\w+)|\.([\w-]+))$/,ee=/[+~]/,te=new RegExp("\\\\[\\da-fA-F]{1,6}"+M+"?|\\\\([^\\r\\n\\f])","g"),ne=function(e,t){var n="0x"+e.slice(1)-65536;return t||(n<0?String.fromCharCode(n+65536):String.fromCharCode(n>>10|55296,1023&n|56320))},re=/([\0-\x1f\x7f]|^-?\d)|^-$|[^\0-\x1f\x7f-\uFFFF\w-]/g,ie=function(e,t){return t?"\0"===e?"\ufffd":e.slice(0,-1)+"\\"+e.charCodeAt(e.length-1).toString(16)+" ":"\\"+e},oe=function(){T()},ae=be(function(e){return!0===e.disabled&&"fieldset"===e.nodeName.toLowerCase()},{dir:"parentNode",next:"legend"});try{H.apply(t=O.call(p.childNodes),p.childNodes),t[p.childNodes.length].nodeType}catch(e){H={apply:t.length?function(e,t){L.apply(e,O.call(t))}:function(e,t){var n=e.length,r=0;while(e[n++]=t[r++]);e.length=n-1}}}function se(t,e,n,r){var i,o,a,s,u,l,c,f=e&&e.ownerDocument,p=e?e.nodeType:9;if(n=n||[],"string"!=typeof t||!t||1!==p&&9!==p&&11!==p)return n;if(!r&&(T(e),e=e||C,E)){if(11!==p&&(u=Z.exec(t)))if(i=u[1]){if(9===p){if(!(a=e.getElementById(i)))return n;if(a.id===i)return n.push(a),n}else if(f&&(a=f.getElementById(i))&&v(e,a)&&a.id===i)return n.push(a),n}else{if(u[2])return H.apply(n,e.getElementsByTagName(t)),n;if((i=u[3])&&d.getElementsByClassName&&e.getElementsByClassName)return H.apply(n,e.getElementsByClassName(i)),n}if(d.qsa&&!N[t+" "]&&(!y||!y.test(t))&&(1!==p||"object"!==e.nodeName.toLowerCase())){if(c=t,f=e,1===p&&(U.test(t)||z.test(t))){(f=ee.test(t)&&ve(e.parentNode)||e)===e&&d.scope||((s=e.getAttribute("id"))?s=s.replace(re,ie):e.setAttribute("id",s=S)),o=(l=h(t)).length;while(o--)l[o]=(s?"#"+s:":scope")+" "+xe(l[o]);c=l.join(",")}try{return H.apply(n,f.querySelectorAll(c)),n}catch(e){N(t,!0)}finally{s===S&&e.removeAttribute("id")}}}return g(t.replace(B,"$1"),e,n,r)}function ue(){var r=[];return function e(t,n){return r.push(t+" ")>b.cacheLength&&delete e[r.shift()],e[t+" "]=n}}function le(e){return e[S]=!0,e}function ce(e){var t=C.createElement("fieldset");try{return!!e(t)}catch(e){return!1}finally{t.parentNode&&t.parentNode.removeChild(t),t=null}}function fe(e,t){var n=e.split("|"),r=n.length;while(r--)b.attrHandle[n[r]]=t}function pe(e,t){var n=t&&e,r=n&&1===e.nodeType&&1===t.nodeType&&e.sourceIndex-t.sourceIndex;if(r)return r;if(n)while(n=n.nextSibling)if(n===t)return-1;return e?1:-1}function de(t){return function(e){return"input"===e.nodeName.toLowerCase()&&e.type===t}}function he(n){return function(e){var t=e.nodeName.toLowerCase();return("input"===t||"button"===t)&&e.type===n}}function ge(t){return function(e){return"form"in e?e.parentNode&&!1===e.disabled?"label"in e?"label"in e.parentNode?e.parentNode.disabled===t:e.disabled===t:e.isDisabled===t||e.isDisabled!==!t&&ae(e)===t:e.disabled===t:"label"in e&&e.disabled===t}}function ye(a){return le(function(o){return o=+o,le(function(e,t){var n,r=a([],e.length,o),i=r.length;while(i--)e[n=r[i]]&&(e[n]=!(t[n]=e[n]))})})}function ve(e){return e&&"undefined"!=typeof e.getElementsByTagName&&e}for(e in d=se.support={},i=se.isXML=function(e){var t=e&&e.namespaceURI,n=e&&(e.ownerDocument||e).documentElement;return!Y.test(t||n&&n.nodeName||"HTML")},T=se.setDocument=function(e){var t,n,r=e?e.ownerDocument||e:p;return r!=C&&9===r.nodeType&&r.documentElement&&(a=(C=r).documentElement,E=!i(C),p!=C&&(n=C.defaultView)&&n.top!==n&&(n.addEventListener?n.addEventListener("unload",oe,!1):n.attachEvent&&n.attachEvent("onunload",oe)),d.scope=ce(function(e){return a.appendChild(e).appendChild(C.createElement("div")),"undefined"!=typeof e.querySelectorAll&&!e.querySelectorAll(":scope fieldset div").length}),d.attributes=ce(function(e){return e.className="i",!e.getAttribute("className")}),d.getElementsByTagName=ce(function(e){return e.appendChild(C.createComment("")),!e.getElementsByTagName("*").length}),d.getElementsByClassName=K.test(C.getElementsByClassName),d.getById=ce(function(e){return a.appendChild(e).id=S,!C.getElementsByName||!C.getElementsByName(S).length}),d.getById?(b.filter.ID=function(e){var t=e.replace(te,ne);return function(e){return e.getAttribute("id")===t}},b.find.ID=function(e,t){if("undefined"!=typeof t.getElementById&&E){var n=t.getElementById(e);return n?[n]:[]}}):(b.filter.ID=function(e){var n=e.replace(te,ne);return function(e){var t="undefined"!=typeof e.getAttributeNode&&e.getAttributeNode("id");return t&&t.value===n}},b.find.ID=function(e,t){if("undefined"!=typeof t.getElementById&&E){var n,r,i,o=t.getElementById(e);if(o){if((n=o.getAttributeNode("id"))&&n.value===e)return[o];i=t.getElementsByName(e),r=0;while(o=i[r++])if((n=o.getAttributeNode("id"))&&n.value===e)return[o]}return[]}}),b.find.TAG=d.getElementsByTagName?function(e,t){return"undefined"!=typeof t.getElementsByTagName?t.getElementsByTagName(e):d.qsa?t.querySelectorAll(e):void 0}:function(e,t){var n,r=[],i=0,o=t.getElementsByTagName(e);if("*"===e){while(n=o[i++])1===n.nodeType&&r.push(n);return r}return o},b.find.CLASS=d.getElementsByClassName&&function(e,t){if("undefined"!=typeof t.getElementsByClassName&&E)return t.getElementsByClassName(e)},s=[],y=[],(d.qsa=K.test(C.querySelectorAll))&&(ce(function(e){var t;a.appendChild(e).innerHTML="",e.querySelectorAll("[msallowcapture^='']").length&&y.push("[*^$]="+M+"*(?:''|\"\")"),e.querySelectorAll("[selected]").length||y.push("\\["+M+"*(?:value|"+R+")"),e.querySelectorAll("[id~="+S+"-]").length||y.push("~="),(t=C.createElement("input")).setAttribute("name",""),e.appendChild(t),e.querySelectorAll("[name='']").length||y.push("\\["+M+"*name"+M+"*="+M+"*(?:''|\"\")"),e.querySelectorAll(":checked").length||y.push(":checked"),e.querySelectorAll("a#"+S+"+*").length||y.push(".#.+[+~]"),e.querySelectorAll("\\\f"),y.push("[\\r\\n\\f]")}),ce(function(e){e.innerHTML="";var t=C.createElement("input");t.setAttribute("type","hidden"),e.appendChild(t).setAttribute("name","D"),e.querySelectorAll("[name=d]").length&&y.push("name"+M+"*[*^$|!~]?="),2!==e.querySelectorAll(":enabled").length&&y.push(":enabled",":disabled"),a.appendChild(e).disabled=!0,2!==e.querySelectorAll(":disabled").length&&y.push(":enabled",":disabled"),e.querySelectorAll("*,:x"),y.push(",.*:")})),(d.matchesSelector=K.test(c=a.matches||a.webkitMatchesSelector||a.mozMatchesSelector||a.oMatchesSelector||a.msMatchesSelector))&&ce(function(e){d.disconnectedMatch=c.call(e,"*"),c.call(e,"[s!='']:x"),s.push("!=",F)}),y=y.length&&new RegExp(y.join("|")),s=s.length&&new RegExp(s.join("|")),t=K.test(a.compareDocumentPosition),v=t||K.test(a.contains)?function(e,t){var n=9===e.nodeType?e.documentElement:e,r=t&&t.parentNode;return e===r||!(!r||1!==r.nodeType||!(n.contains?n.contains(r):e.compareDocumentPosition&&16&e.compareDocumentPosition(r)))}:function(e,t){if(t)while(t=t.parentNode)if(t===e)return!0;return!1},j=t?function(e,t){if(e===t)return l=!0,0;var n=!e.compareDocumentPosition-!t.compareDocumentPosition;return n||(1&(n=(e.ownerDocument||e)==(t.ownerDocument||t)?e.compareDocumentPosition(t):1)||!d.sortDetached&&t.compareDocumentPosition(e)===n?e==C||e.ownerDocument==p&&v(p,e)?-1:t==C||t.ownerDocument==p&&v(p,t)?1:u?P(u,e)-P(u,t):0:4&n?-1:1)}:function(e,t){if(e===t)return l=!0,0;var n,r=0,i=e.parentNode,o=t.parentNode,a=[e],s=[t];if(!i||!o)return e==C?-1:t==C?1:i?-1:o?1:u?P(u,e)-P(u,t):0;if(i===o)return pe(e,t);n=e;while(n=n.parentNode)a.unshift(n);n=t;while(n=n.parentNode)s.unshift(n);while(a[r]===s[r])r++;return r?pe(a[r],s[r]):a[r]==p?-1:s[r]==p?1:0}),C},se.matches=function(e,t){return se(e,null,null,t)},se.matchesSelector=function(e,t){if(T(e),d.matchesSelector&&E&&!N[t+" "]&&(!s||!s.test(t))&&(!y||!y.test(t)))try{var n=c.call(e,t);if(n||d.disconnectedMatch||e.document&&11!==e.document.nodeType)return n}catch(e){N(t,!0)}return 0":{dir:"parentNode",first:!0}," ":{dir:"parentNode"},"+":{dir:"previousSibling",first:!0},"~":{dir:"previousSibling"}},preFilter:{ATTR:function(e){return e[1]=e[1].replace(te,ne),e[3]=(e[3]||e[4]||e[5]||"").replace(te,ne),"~="===e[2]&&(e[3]=" "+e[3]+" "),e.slice(0,4)},CHILD:function(e){return e[1]=e[1].toLowerCase(),"nth"===e[1].slice(0,3)?(e[3]||se.error(e[0]),e[4]=+(e[4]?e[5]+(e[6]||1):2*("even"===e[3]||"odd"===e[3])),e[5]=+(e[7]+e[8]||"odd"===e[3])):e[3]&&se.error(e[0]),e},PSEUDO:function(e){var t,n=!e[6]&&e[2];return G.CHILD.test(e[0])?null:(e[3]?e[2]=e[4]||e[5]||"":n&&X.test(n)&&(t=h(n,!0))&&(t=n.indexOf(")",n.length-t)-n.length)&&(e[0]=e[0].slice(0,t),e[2]=n.slice(0,t)),e.slice(0,3))}},filter:{TAG:function(e){var t=e.replace(te,ne).toLowerCase();return"*"===e?function(){return!0}:function(e){return e.nodeName&&e.nodeName.toLowerCase()===t}},CLASS:function(e){var t=m[e+" "];return t||(t=new RegExp("(^|"+M+")"+e+"("+M+"|$)"))&&m(e,function(e){return t.test("string"==typeof e.className&&e.className||"undefined"!=typeof e.getAttribute&&e.getAttribute("class")||"")})},ATTR:function(n,r,i){return function(e){var t=se.attr(e,n);return null==t?"!="===r:!r||(t+="","="===r?t===i:"!="===r?t!==i:"^="===r?i&&0===t.indexOf(i):"*="===r?i&&-1:\x20\t\r\n\f]*)[\x20\t\r\n\f]*\/?>(?:<\/\1>|)$/i;function j(e,n,r){return m(n)?S.grep(e,function(e,t){return!!n.call(e,t,e)!==r}):n.nodeType?S.grep(e,function(e){return e===n!==r}):"string"!=typeof n?S.grep(e,function(e){return-1)[^>]*|#([\w-]+))$/;(S.fn.init=function(e,t,n){var r,i;if(!e)return this;if(n=n||D,"string"==typeof e){if(!(r="<"===e[0]&&">"===e[e.length-1]&&3<=e.length?[null,e,null]:q.exec(e))||!r[1]&&t)return!t||t.jquery?(t||n).find(e):this.constructor(t).find(e);if(r[1]){if(t=t instanceof S?t[0]:t,S.merge(this,S.parseHTML(r[1],t&&t.nodeType?t.ownerDocument||t:E,!0)),N.test(r[1])&&S.isPlainObject(t))for(r in t)m(this[r])?this[r](t[r]):this.attr(r,t[r]);return this}return(i=E.getElementById(r[2]))&&(this[0]=i,this.length=1),this}return e.nodeType?(this[0]=e,this.length=1,this):m(e)?void 0!==n.ready?n.ready(e):e(S):S.makeArray(e,this)}).prototype=S.fn,D=S(E);var L=/^(?:parents|prev(?:Until|All))/,H={children:!0,contents:!0,next:!0,prev:!0};function O(e,t){while((e=e[t])&&1!==e.nodeType);return e}S.fn.extend({has:function(e){var t=S(e,this),n=t.length;return this.filter(function(){for(var e=0;e\x20\t\r\n\f]*)/i,he=/^$|^module$|\/(?:java|ecma)script/i;ce=E.createDocumentFragment().appendChild(E.createElement("div")),(fe=E.createElement("input")).setAttribute("type","radio"),fe.setAttribute("checked","checked"),fe.setAttribute("name","t"),ce.appendChild(fe),v.checkClone=ce.cloneNode(!0).cloneNode(!0).lastChild.checked,ce.innerHTML="",v.noCloneChecked=!!ce.cloneNode(!0).lastChild.defaultValue,ce.innerHTML="",v.option=!!ce.lastChild;var ge={thead:[1,"","
"],col:[2,"","
"],tr:[2,"","
"],td:[3,"","
"],_default:[0,"",""]};function ye(e,t){var n;return n="undefined"!=typeof e.getElementsByTagName?e.getElementsByTagName(t||"*"):"undefined"!=typeof e.querySelectorAll?e.querySelectorAll(t||"*"):[],void 0===t||t&&A(e,t)?S.merge([e],n):n}function ve(e,t){for(var n=0,r=e.length;n",""]);var me=/<|&#?\w+;/;function xe(e,t,n,r,i){for(var o,a,s,u,l,c,f=t.createDocumentFragment(),p=[],d=0,h=e.length;d\s*$/g;function je(e,t){return A(e,"table")&&A(11!==t.nodeType?t:t.firstChild,"tr")&&S(e).children("tbody")[0]||e}function De(e){return e.type=(null!==e.getAttribute("type"))+"/"+e.type,e}function qe(e){return"true/"===(e.type||"").slice(0,5)?e.type=e.type.slice(5):e.removeAttribute("type"),e}function Le(e,t){var n,r,i,o,a,s;if(1===t.nodeType){if(Y.hasData(e)&&(s=Y.get(e).events))for(i in Y.remove(t,"handle events"),s)for(n=0,r=s[i].length;n").attr(n.scriptAttrs||{}).prop({charset:n.scriptCharset,src:n.url}).on("load error",i=function(e){r.remove(),i=null,e&&t("error"===e.type?404:200,e.type)}),E.head.appendChild(r[0])},abort:function(){i&&i()}}});var Ut,Xt=[],Vt=/(=)\?(?=&|$)|\?\?/;S.ajaxSetup({jsonp:"callback",jsonpCallback:function(){var e=Xt.pop()||S.expando+"_"+Ct.guid++;return this[e]=!0,e}}),S.ajaxPrefilter("json jsonp",function(e,t,n){var r,i,o,a=!1!==e.jsonp&&(Vt.test(e.url)?"url":"string"==typeof e.data&&0===(e.contentType||"").indexOf("application/x-www-form-urlencoded")&&Vt.test(e.data)&&"data");if(a||"jsonp"===e.dataTypes[0])return r=e.jsonpCallback=m(e.jsonpCallback)?e.jsonpCallback():e.jsonpCallback,a?e[a]=e[a].replace(Vt,"$1"+r):!1!==e.jsonp&&(e.url+=(Et.test(e.url)?"&":"?")+e.jsonp+"="+r),e.converters["script json"]=function(){return o||S.error(r+" was not called"),o[0]},e.dataTypes[0]="json",i=C[r],C[r]=function(){o=arguments},n.always(function(){void 0===i?S(C).removeProp(r):C[r]=i,e[r]&&(e.jsonpCallback=t.jsonpCallback,Xt.push(r)),o&&m(i)&&i(o[0]),o=i=void 0}),"script"}),v.createHTMLDocument=((Ut=E.implementation.createHTMLDocument("").body).innerHTML="
",2===Ut.childNodes.length),S.parseHTML=function(e,t,n){return"string"!=typeof e?[]:("boolean"==typeof t&&(n=t,t=!1),t||(v.createHTMLDocument?((r=(t=E.implementation.createHTMLDocument("")).createElement("base")).href=E.location.href,t.head.appendChild(r)):t=E),o=!n&&[],(i=N.exec(e))?[t.createElement(i[1])]:(i=xe([e],t,o),o&&o.length&&S(o).remove(),S.merge([],i.childNodes)));var r,i,o},S.fn.load=function(e,t,n){var r,i,o,a=this,s=e.indexOf(" ");return-1").append(S.parseHTML(e)).find(r):e)}).always(n&&function(e,t){a.each(function(){n.apply(this,o||[e.responseText,t,e])})}),this},S.expr.pseudos.animated=function(t){return S.grep(S.timers,function(e){return t===e.elem}).length},S.offset={setOffset:function(e,t,n){var r,i,o,a,s,u,l=S.css(e,"position"),c=S(e),f={};"static"===l&&(e.style.position="relative"),s=c.offset(),o=S.css(e,"top"),u=S.css(e,"left"),("absolute"===l||"fixed"===l)&&-1<(o+u).indexOf("auto")?(a=(r=c.position()).top,i=r.left):(a=parseFloat(o)||0,i=parseFloat(u)||0),m(t)&&(t=t.call(e,n,S.extend({},s))),null!=t.top&&(f.top=t.top-s.top+a),null!=t.left&&(f.left=t.left-s.left+i),"using"in t?t.using.call(e,f):c.css(f)}},S.fn.extend({offset:function(t){if(arguments.length)return void 0===t?this:this.each(function(e){S.offset.setOffset(this,t,e)});var e,n,r=this[0];return r?r.getClientRects().length?(e=r.getBoundingClientRect(),n=r.ownerDocument.defaultView,{top:e.top+n.pageYOffset,left:e.left+n.pageXOffset}):{top:0,left:0}:void 0},position:function(){if(this[0]){var e,t,n,r=this[0],i={top:0,left:0};if("fixed"===S.css(r,"position"))t=r.getBoundingClientRect();else{t=this.offset(),n=r.ownerDocument,e=r.offsetParent||n.documentElement;while(e&&(e===n.body||e===n.documentElement)&&"static"===S.css(e,"position"))e=e.parentNode;e&&e!==r&&1===e.nodeType&&((i=S(e).offset()).top+=S.css(e,"borderTopWidth",!0),i.left+=S.css(e,"borderLeftWidth",!0))}return{top:t.top-i.top-S.css(r,"marginTop",!0),left:t.left-i.left-S.css(r,"marginLeft",!0)}}},offsetParent:function(){return this.map(function(){var e=this.offsetParent;while(e&&"static"===S.css(e,"position"))e=e.offsetParent;return e||re})}}),S.each({scrollLeft:"pageXOffset",scrollTop:"pageYOffset"},function(t,i){var o="pageYOffset"===i;S.fn[t]=function(e){return B(this,function(e,t,n){var r;if(x(e)?r=e:9===e.nodeType&&(r=e.defaultView),void 0===n)return r?r[i]:e[t];r?r.scrollTo(o?r.pageXOffset:n,o?n:r.pageYOffset):e[t]=n},t,e,arguments.length)}}),S.each(["top","left"],function(e,n){S.cssHooks[n]=_e(v.pixelPosition,function(e,t){if(t)return t=Be(e,n),Pe.test(t)?S(e).position()[n]+"px":t})}),S.each({Height:"height",Width:"width"},function(a,s){S.each({padding:"inner"+a,content:s,"":"outer"+a},function(r,o){S.fn[o]=function(e,t){var n=arguments.length&&(r||"boolean"!=typeof e),i=r||(!0===e||!0===t?"margin":"border");return B(this,function(e,t,n){var r;return x(e)?0===o.indexOf("outer")?e["inner"+a]:e.document.documentElement["client"+a]:9===e.nodeType?(r=e.documentElement,Math.max(e.body["scroll"+a],r["scroll"+a],e.body["offset"+a],r["offset"+a],r["client"+a])):void 0===n?S.css(e,t,i):S.style(e,t,n,i)},s,n?e:void 0,n)}})}),S.each(["ajaxStart","ajaxStop","ajaxComplete","ajaxError","ajaxSuccess","ajaxSend"],function(e,t){S.fn[t]=function(e){return this.on(t,e)}}),S.fn.extend({bind:function(e,t,n){return this.on(e,null,t,n)},unbind:function(e,t){return this.off(e,null,t)},delegate:function(e,t,n,r){return this.on(t,e,n,r)},undelegate:function(e,t,n){return 1===arguments.length?this.off(e,"**"):this.off(t,e||"**",n)},hover:function(e,t){return this.mouseenter(e).mouseleave(t||e)}}),S.each("blur focus focusin focusout resize scroll click dblclick mousedown mouseup mousemove mouseover mouseout mouseenter mouseleave change select submit keydown keypress keyup contextmenu".split(" "),function(e,n){S.fn[n]=function(e,t){return 0",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 diff --git a/pi4micronaut-utils/src/docs/javadoc/script.js b/pi4micronaut-utils/src/docs/javadoc/script.js new file mode 100644 index 00000000..f1a0f256 --- /dev/null +++ b/pi4micronaut-utils/src/docs/javadoc/script.js @@ -0,0 +1,253 @@ +/* + * 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); + } +}); diff --git a/pi4micronaut-utils/src/docs/javadoc/search-page.js b/pi4micronaut-utils/src/docs/javadoc/search-page.js new file mode 100644 index 00000000..e4da097d --- /dev/null +++ b/pi4micronaut-utils/src/docs/javadoc/search-page.js @@ -0,0 +1,284 @@ +/* + * Copyright (c) 2022, 2023, Oracle and/or its affiliates. All rights reserved. + * ORACLE PROPRIETARY/CONFIDENTIAL. Use is subject to license terms. + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + */ + +"use strict"; +$(function() { + var copy = $("#page-search-copy"); + var expand = $("#page-search-expand"); + var searchLink = $("span#page-search-link"); + var redirect = $("input#search-redirect"); + function setSearchUrlTemplate() { + var href = document.location.href.split(/[#?]/)[0]; + href += "?q=" + "%s"; + if (redirect.is(":checked")) { + href += "&r=1"; + } + searchLink.html(href); + copy[0].onmouseenter(); + } + function copyLink(e) { + copyToClipboard(this.previousSibling.innerText); + switchCopyLabel(this, this.lastElementChild); + } + copy.click(copyLink); + copy[0].onmouseenter = function() {}; + redirect.click(setSearchUrlTemplate); + setSearchUrlTemplate(); + copy.prop("disabled", false); + redirect.prop("disabled", false); + expand.click(function (e) { + var searchInfo = $("div.page-search-info"); + if(this.parentElement.hasAttribute("open")) { + searchInfo.attr("style", "border-width: 0;"); + } else { + searchInfo.attr("style", "border-width: 1px;").height(searchInfo.prop("scrollHeight")); + } + }); +}); +$(window).on("load", function() { + var input = $("#page-search-input"); + var reset = $("#page-search-reset"); + var notify = $("#page-search-notify"); + var resultSection = $("div#result-section"); + var resultContainer = $("div#result-container"); + var searchTerm = ""; + var activeTab = ""; + var fixedTab = false; + var visibleTabs = []; + var feelingLucky = false; + function renderResults(result) { + if (!result.length) { + notify.html(messages.noResult); + } else if (result.length === 1) { + notify.html(messages.oneResult); + } else { + notify.html(messages.manyResults.replace("{0}", result.length)); + } + resultContainer.empty(); + var r = { + "types": [], + "members": [], + "packages": [], + "modules": [], + "searchTags": [] + }; + for (var i in result) { + var item = result[i]; + var arr = r[item.category]; + arr.push(item); + } + if (!activeTab || r[activeTab].length === 0 || !fixedTab) { + Object.keys(r).reduce(function(prev, curr) { + if (r[curr].length > 0 && r[curr][0].score > prev) { + activeTab = curr; + return r[curr][0].score; + } + return prev; + }, 0); + } + if (feelingLucky && activeTab) { + notify.html(messages.redirecting) + var firstItem = r[activeTab][0]; + window.location = getURL(firstItem.indexItem, firstItem.category); + return; + } + if (result.length > 20) { + if (searchTerm[searchTerm.length - 1] === ".") { + if (activeTab === "types" && r["members"].length > r["types"].length) { + activeTab = "members"; + } else if (activeTab === "packages" && r["types"].length > r["packages"].length) { + activeTab = "types"; + } + } + } + var categoryCount = Object.keys(r).reduce(function(prev, curr) { + return prev + (r[curr].length > 0 ? 1 : 0); + }, 0); + visibleTabs = []; + var tabContainer = $("
    ").appendTo(resultContainer); + for (var key in r) { + var id = "#result-tab-" + key.replace("searchTags", "search_tags"); + if (r[key].length) { + var count = r[key].length >= 1000 ? "999+" : r[key].length; + if (result.length > 20 && categoryCount > 1) { + var button = $("").appendTo(tabContainer); + button.click(key, function(e) { + fixedTab = true; + renderResult(e.data, $(this)); + }); + visibleTabs.push(key); + } else { + $("" + categories[key] + + " (" + count + ")").appendTo(tabContainer); + renderTable(key, r[key]).appendTo(resultContainer); + tabContainer = $("
    ").appendTo(resultContainer); + + } + } + } + if (activeTab && result.length > 20 && categoryCount > 1) { + $("button#result-tab-" + activeTab).addClass("active-table-tab"); + renderTable(activeTab, r[activeTab]).appendTo(resultContainer); + } + resultSection.show(); + function renderResult(category, button) { + activeTab = category; + setSearchUrl(); + resultContainer.find("div.summary-table").remove(); + renderTable(activeTab, r[activeTab]).appendTo(resultContainer); + button.siblings().removeClass("active-table-tab"); + button.addClass("active-table-tab"); + } + } + function selectTab(category) { + $("button#result-tab-" + category).click(); + } + function renderTable(category, items) { + var table = $("
    ") + .addClass(category === "modules" + ? "one-column-search-results" + : "two-column-search-results"); + var col1, col2; + if (category === "modules") { + col1 = "Module"; + } else if (category === "packages") { + col1 = "Module"; + col2 = "Package"; + } else if (category === "types") { + col1 = "Package"; + col2 = "Class" + } else if (category === "members") { + col1 = "Class"; + col2 = "Member"; + } else if (category === "searchTags") { + col1 = "Location"; + col2 = "Name"; + } + $("
    " + col1 + "
    ").appendTo(table); + if (category !== "modules") { + $("
    " + col2 + "
    ").appendTo(table); + } + $.each(items, function(index, item) { + var rowColor = index % 2 ? "odd-row-color" : "even-row-color"; + renderItem(item, table, rowColor); + }); + return table; + } + function renderItem(item, table, rowColor) { + var label = getHighlightedText(item.input, item.boundaries, item.prefix.length, item.input.length); + var link = $("") + .attr("href", getURL(item.indexItem, item.category)) + .attr("tabindex", "0") + .addClass("search-result-link") + .html(label); + var container = getHighlightedText(item.input, item.boundaries, 0, item.prefix.length - 1); + if (item.category === "searchTags") { + container = item.indexItem.h || ""; + } + if (item.category !== "modules") { + $("
    ").html(container).addClass("col-plain").addClass(rowColor).appendTo(table); + } + $("
    ").html(link).addClass("col-last").addClass(rowColor).appendTo(table); + } + var timeout; + function schedulePageSearch() { + if (timeout) { + clearTimeout(timeout); + } + timeout = setTimeout(function () { + doPageSearch() + }, 100); + } + function doPageSearch() { + setSearchUrl(); + var term = searchTerm = input.val().trim(); + if (term === "") { + notify.html(messages.enterTerm); + activeTab = ""; + fixedTab = false; + resultContainer.empty(); + resultSection.hide(); + } else { + notify.html(messages.searching); + doSearch({ term: term, maxResults: 1200 }, renderResults); + } + } + function setSearchUrl() { + var query = input.val().trim(); + var url = document.location.pathname; + if (query) { + url += "?q=" + encodeURI(query); + if (activeTab && fixedTab) { + url += "&c=" + activeTab; + } + } + history.replaceState({query: query}, "", url); + } + input.on("input", function(e) { + feelingLucky = false; + schedulePageSearch(); + }); + $(document).keydown(function(e) { + if ((e.ctrlKey || e.metaKey) && (e.key === "ArrowLeft" || e.key === "ArrowRight")) { + if (activeTab && visibleTabs.length > 1) { + var idx = visibleTabs.indexOf(activeTab); + idx += e.key === "ArrowLeft" ? visibleTabs.length - 1 : 1; + selectTab(visibleTabs[idx % visibleTabs.length]); + return false; + } + } + }); + reset.click(function() { + notify.html(messages.enterTerm); + resultSection.hide(); + activeTab = ""; + fixedTab = false; + resultContainer.empty(); + input.val('').focus(); + setSearchUrl(); + }); + input.prop("disabled", false); + reset.prop("disabled", false); + + var urlParams = new URLSearchParams(window.location.search); + if (urlParams.has("q")) { + input.val(urlParams.get("q")) + } + if (urlParams.has("c")) { + activeTab = urlParams.get("c"); + fixedTab = true; + } + if (urlParams.get("r")) { + feelingLucky = true; + } + if (input.val()) { + doPageSearch(); + } else { + notify.html(messages.enterTerm); + } + input.select().focus(); +}); diff --git a/pi4micronaut-utils/src/docs/javadoc/search.html b/pi4micronaut-utils/src/docs/javadoc/search.html new file mode 100644 index 00000000..e2e83df0 --- /dev/null +++ b/pi4micronaut-utils/src/docs/javadoc/search.html @@ -0,0 +1,71 @@ + + + + +Search (pi4micronaut-utils v1.0 API) + + + + + + + + + + + + + +
    + +
    +
    +

    Search

    +
    + + +
    +Additional resources +
    +
    +
    +

    The help page provides an introduction to the scope and syntax of JavaDoc search.

    +

    You can use the <ctrl> or <cmd> keys in combination with the left and right arrow keys to switch between result tabs in this page.

    +

    The URL template below may be used to configure this page as a search engine in browsers that support this feature. It has been tested to work in Google Chrome and Mozilla Firefox. Note that other browsers may not support this feature or require a different URL format.

    +link +

    + +

    +
    +

    Loading search index...

    + +
    +
    +
    + + diff --git a/pi4micronaut-utils/src/docs/javadoc/search.js b/pi4micronaut-utils/src/docs/javadoc/search.js new file mode 100644 index 00000000..4ca95577 --- /dev/null +++ b/pi4micronaut-utils/src/docs/javadoc/search.js @@ -0,0 +1,458 @@ +/* + * 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
    • "); + }, + _renderItem: function(ul, item) { + var li = $("
  • ").appendTo(ul); + var div = $("
    ").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 + "
    "); + } else { + div.html(label + " (" + 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(" " + messages.linkIcon +""); + } + }); + $(window).on("orientationchange", collapse).on("resize", function(e) { + if (expanded && windowWidth !== window.innerWidth) collapse(); + }); + var search = $("#search-input"); + var reset = $("#reset-button"); + search.catcomplete({ + minLength: 1, + delay: 200, + source: doSearch, + response: function(event, ui) { + if (!ui.content.length) { + ui.content.push({ l: messages.noResult }); + } else { + $("#search-input").empty(); + } + }, + autoFocus: true, + focus: function(event, ui) { + return false; + }, + position: { + collision: "flip" + }, + select: function(event, ui) { + if (ui.item.indexItem) { + var url = getURL(ui.item.indexItem, ui.item.category); + window.location.href = pathtoroot + url; + $("#search-input").focus(); + } + } + }); + search.val(''); + search.prop("disabled", false); + reset.prop("disabled", false); + reset.click(function() { + search.val('').focus(); + }); + search.focus(); +}); diff --git a/pi4micronaut-utils/src/docs/javadoc/stylesheet.css b/pi4micronaut-utils/src/docs/javadoc/stylesheet.css new file mode 100644 index 00000000..f71489f8 --- /dev/null +++ b/pi4micronaut-utils/src/docs/javadoc/stylesheet.css @@ -0,0 +1,1272 @@ +/* + * 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%; +} diff --git a/pi4micronaut-utils/src/docs/javadoc/tag-search-index.js b/pi4micronaut-utils/src/docs/javadoc/tag-search-index.js new file mode 100644 index 00000000..0367dae6 --- /dev/null +++ b/pi4micronaut-utils/src/docs/javadoc/tag-search-index.js @@ -0,0 +1 @@ +tagSearchIndex = [];updateSearchResults(); \ No newline at end of file diff --git a/pi4micronaut-utils/src/docs/javadoc/type-search-index.js b/pi4micronaut-utils/src/docs/javadoc/type-search-index.js new file mode 100644 index 00000000..1f7ac61c --- /dev/null +++ b/pi4micronaut-utils/src/docs/javadoc/type-search-index.js @@ -0,0 +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.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"}];updateSearchResults(); \ No newline at end of file