The GBALib_Potentiometer library provides a straightforward interface to manage potentiometer inputs connected to an Arduino. It allows for reading raw analog values, converting them to voltages, and mapping the readings to specified ranges with optional step increments.

The library is included in the Arduino Library Manager. You can install it either by using the Library Manager or manually by following the steps below.

1. Download the Library:

   • Click on the "Code" button in the GitHub repository.
   • Select "Download ZIP" to download the library as a ZIP file.

2. Extract the ZIP File:

   • Extract the contents of the ZIP file to your Arduino libraries directory.

3. Restart the Arduino IDE:

   • Restart the Arduino IDE to ensure that the library is recognized.

1. Include the Library:

   #include <GBALib_Potentiometer.h>

2. Instantiate the Pot object:

   // Specify the pin to which the potentiometer is connected
   Pot pot(A1); 

• Purpose: Initializes the potentiometer object with the specified pin.
• Parameters:
  • pin (uint8_t): The analog pin number to which the potentiometer is connected.
• Example:

  Pot potentiometer(A0);

• Purpose: Initializes the potentiometer object with the specified pin and range.
• Parameters:
  • pin (uint8_t): The analog pin number to which the potentiometer is connected.
  • min (int): The minimum value for the potentiometer range.
  • max (int): The maximum value for the potentiometer range.
• Example:

  Pot potentiometer(A0, 0, 100); // Maps readings between 0 and 100.

• Purpose: Initializes the potentiometer object with the specified pin and range and step.
• Parameters:
  • pin (uint8_t): The analog pin number to which the potentiometer is connected.
  • min (int): The minimum value for the potentiometer range.
  • max (int): The maximum value for the potentiometer range.
  • step (int): The step size for the mapped output values.
• Example:

  Pot potentiometer(A0, 0, 100, 5); // Maps readings between 0 and 100. Increments values by steps of 5.

• Purpose: Sets the default range for potentiometer readings.
• Parameters:
  • min (int): The minimum value for the potentiometer range.
  • max (int): The maximum value for the potentiometer range.
• Example:

  potentiometer.range(0, 100); // Maps readings between 0 and 100.

• Purpose: Sets the default step size for mapped potentiometer readings.
• Parameters:
  • step (int): The step size for the mapped output values.
• Example:

  potentiometer.step(5); // Increments values by steps of 5.

• Purpose: Reads the raw potentiometer input value from the specified analog pin.
• Returns: The average of several analog readings ranging between 0 and 1023.
• Example:

  int rawValue = potentiometer.input();

• Purpose: Calculates the voltage based on the potentiometer input.
• Returns: The voltage value in the range of 0V to 5V.
• Example:

  float voltage = potentiometer.voltage();

• Purpose: Reads and maps the potentiometer value to a defined range [vMin, vMax] with a specified step size. If the step size is greater than 0, the mapped value is adjusted to the nearest step.
• Returns: The mapped and adjusted potentiometer value within the default range.
• Example:

  int mappedValue = potentiometer.value();

• Purpose: Reads and maps the potentiometer value to a custom range [min, max]. This method ignores the default range set previously.
• Parameters:
  • min (int): The minimum value for the custom range.
  • max (int): The maximum value for the custom range.
• Returns: The mapped potentiometer value within the custom range.
• Example:

  int customValue = potentiometer.valueToCustomRange(50, 150);

• Purpose: Reads and maps the potentiometer value to a custom range [min, max] with a specified step size. This method ignores the default range and step size set previously.
• Parameters:
  • min (int): The minimum value for the custom range.
  • max (int): The maximum value for the custom range.
  • step (int): The step size for the mapped output values.
• Returns: The mapped and adjusted potentiometer value within the custom range.
• Example:

  int customSteppedValue = potentiometer.valueToCustomRange(0, 200, 10);

#include <GBALib_Potentiometer.h>  // Include the GBALib_Potentiometer library

// Create an instance of the Pot class to manage the potentiometer
// Arguments: pin A0 (analog input), minimum mapped value (0), maximum mapped value (255)
Pot myPot(A0, 0, 255);

void setup() {
  Serial.begin(9600);  // Initialize serial communication at 9600 baud
}

void loop() {
  // Read the raw potentiometer input value (range 0-1023)
  int pval = myPot.input();

  // Map the raw input to the defined range (0-255 in this case)
  int mval = myPot.value();

  // Calculate the voltage value based on the input (0-5V for a default reference voltage)
  float voltage = myPot.voltage();

  // Print the raw value, mapped value, and voltage to the Serial Monitor
  Serial.print("Real Value = ");  // Label for the raw input value
  Serial.print(pval);             // Print the raw value
  Serial.print("    Mapped Value = ");  // Label for the mapped value
  Serial.print(mval);                     // Print the mapped value
  Serial.print("    Voltage = ");  // Label for the voltage
  Serial.print(voltage);           // Print the calculated voltage
  Serial.println("V");             // Add the unit "V" and move to the next line

  delay(200);  // Wait for 200 milliseconds before the next reading
}

• Ensure that the potentiometer is correctly connected to the specified analog pin.
• Use range() and step() to set default mapping and step values, and utilize custom range methods when you need specific mappings.

This library is released under the GNU License. See the LICENSE file for more information.