Merge pull request #428 from sbera13/fix-379

Refactoring Thermistor component to use ADC0834Converter

Author: leandrumartin

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

@@ -1,7 +1,8 @@
 package com.opensourcewithslu.components.controllers;
 
-import com.pi4j.io.spi.Spi;
 import com.opensourcewithslu.inputdevices.ADC0834ConverterHelper;
+import com.pi4j.context.Context;
+import com.pi4j.io.spi.SpiConfig;
 import io.micronaut.http.annotation.Controller;
 import io.micronaut.http.annotation.Get;
 import jakarta.inject.Named;
@@ -19,10 +20,11 @@ public class ADC0834ConverterController {
     /**
      * Constructor for ADC0834ConverterController.
      *
-     * @param spi SPI interface
+     * @param spiConfig A Pi4J SPIConfig object which holds the SPI configuration.
+     * @param pi4jContext The Pi4J context object.
      */
-    public ADC0834ConverterController(@Named("adc0834") Spi spi) {
-        this.adcConverterHelper = new ADC0834ConverterHelper(spi);
+    public ADC0834ConverterController(@Named("adc0834") SpiConfig spiConfig, Context pi4jContext) {
+        this.adcConverterHelper = new ADC0834ConverterHelper(spiConfig, pi4jContext);
         log.info("ADC0834ConverterController initialized with SPI");
     }
 
@@ -52,4 +54,4 @@ public double readVoltage(int channel, double referenceVoltage) {
         log.info("Voltage retrieved from ADC0834 channel {}: {}V", channel, voltage);
         return voltage;
     }
-}
+}

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

@@ -1,40 +1,44 @@
 package com.opensourcewithslu.components.controllers;
 
+import com.opensourcewithslu.inputdevices.ADC0834ConverterHelper;
 import com.opensourcewithslu.inputdevices.ThermistorHelper;
 import com.pi4j.context.Context;
-import com.pi4j.io.gpio.digital.DigitalInput;
+import com.pi4j.io.spi.SpiConfig;
 import io.micronaut.http.annotation.Controller;
 import io.micronaut.http.annotation.Get;
-import jakarta.inject.Inject;
 import jakarta.inject.Named;
 
 @Controller("/thermistor")
 public class ThermistorController {
 
     private final ThermistorHelper thermistorHelper;
-
-    // Inject Pi4J Context and digital pins for the thermistor
-    @Inject
-    public ThermistorController(Context pi4jContext) {
-
-        // Initialize the ThermistorHelper with SPI configuration
-        this.thermistorHelper = new ThermistorHelper(pi4jContext);
+    private final ADC0834ConverterHelper adcConverterHelper;
+
+    /**
+     * Constructor for ThermistorController.
+     *
+     * @param spiConfig A Pi4J SPIConfig object which holds the SPI configuration for the ADC0834.
+     * @param pi4jContext The Pi4J context object.
+     */
+    public ThermistorController(@Named("adc0834") SpiConfig spiConfig, Context pi4jContext) {
+        adcConverterHelper = new ADC0834ConverterHelper(spiConfig, pi4jContext);
+        thermistorHelper = new ThermistorHelper( adcConverterHelper );
     }
 
     // Endpoint to get temperature in Celsius
-    @Get("/temperature/celsius")
-    public double getTemperatureCelsius() {
-        return thermistorHelper.getTemperatureInCelsius();
+    @Get("/temperature/celsius/{channel}")
+    public double getTemperatureCelsius(int channel) {
+        return thermistorHelper.getTemperatureInCelsius( channel );
     }
 
     // Endpoint to get temperature in Fahrenheit
-    @Get("/temperature/fahrenheit")
-    public double getTemperatureFahrenheit() {
-        return thermistorHelper.getTemperatureInFahrenheit();
+    @Get("/temperature/fahrenheit/{channel}")
+    public double getTemperatureFahrenheit(int channel) {
+        return thermistorHelper.getTemperatureInFahrenheit( channel );
     }
 
-    @Get("/rawValue")
-    public double readADCValue(){
-        return thermistorHelper.readADCValue();
+    @Get("/rawValue/{channel}")
+    public double readADCValue(int channel){
+        return thermistorHelper.readADCValue( channel );
     }
 }

components/src/main/resources/application.yml

@@ -14,7 +14,7 @@ pi4j:
       name: ADC0834  # <1>
       address: 17            # <2> # SPI channel 0
       baud: 1000000         # <3> # 1 MHz SPI clock speed
-      mode: SPI_MODE_0
+      reset-pin: 27
   # end::spi[]
 
   # tag::pwm[]

pi4micronaut-utils/src/main/java/com/opensourcewithslu/inputdevices/ADC0834ConverterHelper.java

@@ -1,6 +1,8 @@
 package com.opensourcewithslu.inputdevices;
 
+import com.pi4j.context.Context;
 import com.pi4j.io.spi.Spi;
+import com.pi4j.io.spi.SpiConfig;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
@@ -14,13 +16,23 @@ public class ADC0834ConverterHelper {
 
     /**
      * Constructor for ADC0834ConverterHelper.
-     * @param spi The SPI interface.
+     * @param spiConfig A Pi4J SPIConfig object which holds the SPI configuration.
+     * @param pi4jContext The Pi4J context object.
      */
-    public ADC0834ConverterHelper(Spi spi) {
-        this.spi = spi;
+    public ADC0834ConverterHelper(SpiConfig spiConfig, Context pi4jContext) {
+        this.spi = pi4jContext.create(spiConfig);
         log.info("ADC0834ConverterHelper initialized with SPI");
     }
 
+
+    /* Gets the SPI interface used by this class.
+    * 
+    * @return the SPI interface
+    */
+    Spi getSpi() {  
+        return spi;
+    }
+
     /**
      * Reads the digital value from the specified channel (0-3) of the ADC0834.
      * @param channel The ADC channel to read (0-3).
@@ -67,4 +79,4 @@ public double readVoltage(int channel, double referenceVoltage) {
         log.info("Channel {} voltage: {}V (raw = {}, ref = {}V)", channel, voltage, rawValue, referenceVoltage);
         return voltage;
     }
-}
+}

pi4micronaut-utils/src/main/java/com/opensourcewithslu/inputdevices/ThermistorHelper.java

@@ -1,23 +1,27 @@
 package com.opensourcewithslu.inputdevices;
 
-import com.pi4j.context.Context;
 import com.pi4j.io.spi.Spi;
-import com.pi4j.io.spi.SpiConfig;
-import com.pi4j.io.spi.SpiMode;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
 public class ThermistorHelper {
     private static final Logger log = LoggerFactory.getLogger(ThermistorHelper.class);
     private final Spi spi; // SPI interface for ADC communication
+    private final ADC0834ConverterHelper adcConverterHelper;
 
     // Constants for Steinhart-Hart equation (example values; replace with actual thermistor constants)
     private static final double A = 0.001129148;
     private static final double B = 0.000234125;
     private static final double C = 0.0000000876741;
 
-    public ThermistorHelper(Context pi4j) {
-        this.spi = initializeADC(pi4j);
+    /**
+     * Constructor for ThermistorHelper.
+     * @param adcConverterHelper The ADC0834ConverterHelper object.
+     */
+    public ThermistorHelper( ADC0834ConverterHelper adcConverterHelper ) {
+        this.adcConverterHelper = adcConverterHelper;
+        this.spi = adcConverterHelper.getSpi();
+        log.info("SPI and ADCConverter for thermistor initialized.");
     }
 
     /**
@@ -30,65 +34,23 @@ Spi getSpi() {
     return spi;
     }
 
-    /**
-     * Initialize SPI and ADC settings specific to ADC0834.
-     */
-    private Spi initializeADC(Context pi4j) {
-        try {
-            // Create SPI configuration for the ADC0834
-            SpiConfig spiConfig = Spi.newConfigBuilder(pi4j)
-                    .id("ADC0834")
-                    .name("Thermistor ADC")
-                    .address(17) // SPI channel 0
-                    .baud(1000000) // 1 MHz SPI clock speed
-                    .mode(SpiMode.MODE_0)
-                    .build();
-
-            Spi spi = pi4j.create(spiConfig);
-            log.info("SPI and ADC for thermistor initialized.");
-            return spi;
-
-        } catch (Exception e) {
-            log.error("Failed to initialize SPI for ADC0834", e);
-            throw new RuntimeException("SPI initialization failed", e);
-        }
-    }
-
     /**
      * Reads the raw value from the thermistor via ADC and converts it to resistance.
+     * @param channel The ADC channel to read (0-3).
      * @return the resistance value of the thermistor
      */
-    public double getResistance() {
-        double rawValue = readADCValue();
+    public double getResistance(int channel) {
+        double rawValue = readADCValue(channel);
         return convertRawToResistance(rawValue);
     }
 
     /**
      * Reads the ADC value from the thermistor on ADC0834.
+     * @param channel The ADC channel to read (0-3).
      * @return the raw ADC value as a double
      */
-    public double readADCValue() {
-        byte[] packet = new byte[3];
-        byte[] response = new byte[3]; // To store the response from ADC0834
-
-        // ADC0834 requires sending a "start" bit sequence to initiate the read
-        packet[0] = 0x01; // Start bit
-        packet[1] = (byte) (0x80); // Single-ended mode and channel selection (channel 0 for thermistor)
-        packet[2] = 0x00; // Placeholder byte to read data
-
-        try {
-            // Send the command packet and receive response from ADC0834
-            spi.write(packet); // Send the packet
-            spi.read(response); // Read the response into the response array
-
-            // Process the response to extract ADC value (10-bit resolution for ADC0834)
-            int rawValue = ((response[1] & 0x03) << 8) + (response[2] & 0xFF); // Combine bits for 10-bit ADC result
-            log.info("Raw ADC Value: {}", rawValue);
-            return rawValue;
-        } catch (Exception e) {
-            log.error("Failed to read from ADC0834", e);
-            return -1; // Return a flag value indicating an error
-        }
+    public double readADCValue( int channel ) {
+        return adcConverterHelper.readValue(channel);
     }
 
 
@@ -107,10 +69,11 @@ private double convertRawToResistance(double rawValue) {
 
     /**
      * Calculates the temperature in Celsius using the Steinhart-Hart equation.
+     * @param channel The ADC channel to read (0-3).
      * @return temperature in Celsius.
      */
-    public double getTemperatureInCelsius() {
-        double resistance = getResistance();
+    public double getTemperatureInCelsius(int channel) {
+        double resistance = getResistance(channel);
         double temperatureInKelvin = 1.0 / (A + B * Math.log(resistance) + C * Math.pow(Math.log(resistance), 3));
         double temperatureCelsius = temperatureInKelvin - 273.15;
         log.info("Temperature in Celsius: {}", temperatureCelsius);
@@ -119,10 +82,11 @@ public double getTemperatureInCelsius() {
 
     /**
      * Converts temperature in Celsius to Fahrenheit.
+     * @param channel The ADC channel to read (0-3).
      * @return temperature in Fahrenheit.
      */
-    public double getTemperatureInFahrenheit() {
-        double temperatureFahrenheit = getTemperatureInCelsius() * 9 / 5 + 32;
+    public double getTemperatureInFahrenheit(int channel) {
+        double temperatureFahrenheit = getTemperatureInCelsius(channel) * 9 / 5 + 32;
         log.info("Temperature in Fahrenheit: {}", temperatureFahrenheit);
         return temperatureFahrenheit;
     }

pi4micronaut-utils/src/test/java/com/opensourcewithslu/inputdevices/ADC0834ConverterHelperTest.java

@@ -17,15 +17,17 @@ public class ADC0834ConverterHelperTest {
     private static final Logger log = LoggerFactory.getLogger(ADC0834ConverterHelperTest.class);
 
     private Context mockContext;
+    private SpiConfig mockSpiConfig;
     private Spi mockSpi;
     private ADC0834ConverterHelper adc;
 
     @BeforeEach
     public void setUp() {
         mockContext = Mockito.mock(Context.class);
         mockSpi = Mockito.mock(Spi.class);
+        mockSpiConfig = Mockito.mock(SpiConfig.class);
         when(mockContext.create(any(SpiConfig.class))).thenReturn(mockSpi);
-        adc = new ADC0834ConverterHelper(mockSpi);
+        adc = new ADC0834ConverterHelper(mockSpiConfig, mockContext);
     }
 
     @Test