Merge pull request #462 from Pi4J/spi_chipselect_max

Further improved SpiSelect

Author: FDelporte

pi4j-core/src/main/java/com/pi4j/io/spi/SpiChipSelect.java

@@ -25,6 +25,9 @@
  * #L%
  */
 
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
 /**
  * <p>SpiChipSelect class.</p>
  *
@@ -35,6 +38,7 @@
 public enum SpiChipSelect {
     CS_0(0), CS_1(1), CS_2(2), CS_3(3), CS_4(4), CS_5(5), CS_6(6), CS_7(7), CS_8(8), CS_9(9), CS_10(10);
 
+    private static final Logger log = LoggerFactory.getLogger(SpiChipSelect.class);
     private final int address;
 
     private SpiChipSelect(int address) {
@@ -57,7 +61,7 @@ public int getChipSelect() {
      * @return a {@link SpiChipSelect} object.
      */
     public static SpiChipSelect getByNumber(short address){
-        return getByNumber((int)address);
+        return getByNumber((int) address);
     }
 
     /**
@@ -67,8 +71,8 @@ public static SpiChipSelect getByNumber(short address){
      * @return a {@link SpiChipSelect} object.
      */
     public static SpiChipSelect getByNumber(int address){
-        for(var item : SpiChipSelect.values()){
-            if(item.getChipSelect() == address){
+        for (var item : SpiChipSelect.values()){
+            if (item.getChipSelect() == address){
                 return item;
             }
         }
@@ -82,17 +86,17 @@ public static SpiChipSelect getByNumber(int address){
      * @return a {@link SpiChipSelect} object.
      */
     public static SpiChipSelect parse(String bus) {
-        if(bus.equalsIgnoreCase("0")) return SpiChipSelect.CS_0;
-        if(bus.equalsIgnoreCase("1")) return SpiChipSelect.CS_1;
-        if(bus.equalsIgnoreCase("2")) return SpiChipSelect.CS_2;
-        if(bus.equalsIgnoreCase("3")) return SpiChipSelect.CS_3;
-        if(bus.equalsIgnoreCase("4")) return SpiChipSelect.CS_4;
-        if(bus.equalsIgnoreCase("5")) return SpiChipSelect.CS_5;
-        if(bus.equalsIgnoreCase("6")) return SpiChipSelect.CS_6;
-        if(bus.equalsIgnoreCase("7")) return SpiChipSelect.CS_7;
-        if(bus.equalsIgnoreCase("8")) return SpiChipSelect.CS_8;
-        if(bus.equalsIgnoreCase("9")) return SpiChipSelect.CS_9;
-        if(bus.equalsIgnoreCase("10")) return SpiChipSelect.CS_10;
+        for (SpiChipSelect item : SpiChipSelect.values()) {
+            try {
+                if (item.getChipSelect() == Integer.parseInt(bus)) {
+                    return item;
+                }
+            } catch (NumberFormatException e) {
+                log.warn("Unable to parse chip select bus as number: {}. Returning default {}.", bus, Spi.DEFAULT_CHIP_SELECT);
+                return Spi.DEFAULT_CHIP_SELECT;
+            }
+        }
+        log.warn("Didn't find matching chip select bus for: {}. Returning default {}.", bus, Spi.DEFAULT_CHIP_SELECT);
         return Spi.DEFAULT_CHIP_SELECT;
     }
 }

pi4j-core/src/test/java/com/pi4j/io/spi/SpiChipSelectTest.java

@@ -0,0 +1,46 @@
+package com.pi4j.io.spi;
+
+import org.junit.jupiter.api.Test;
+
+import static org.junit.jupiter.api.Assertions.assertEquals;
+
+class SpiChipSelectTest {
+
+    @Test
+    void shouldReturnDefaultForString() {
+        assertEquals(Spi.DEFAULT_CHIP_SELECT, SpiChipSelect.parse(""));
+        assertEquals(Spi.DEFAULT_CHIP_SELECT, SpiChipSelect.parse("A"));
+        assertEquals(Spi.DEFAULT_CHIP_SELECT, SpiChipSelect.parse("*"));
+        assertEquals(Spi.DEFAULT_CHIP_SELECT, SpiChipSelect.parse("none"));
+    }
+
+    @Test
+    void shouldReturnDefaultForUndefinedNumber() {
+        assertEquals(Spi.DEFAULT_CHIP_SELECT, SpiChipSelect.parse("11"));
+        assertEquals(Spi.DEFAULT_CHIP_SELECT, SpiChipSelect.parse("99"));
+    }
+
+    @Test
+    void shouldReturnCorrectSpiChipSelectFromString() {
+        assertEquals(SpiChipSelect.CS_0, SpiChipSelect.parse("0"));
+        assertEquals(SpiChipSelect.CS_1, SpiChipSelect.parse("1"));
+        assertEquals(SpiChipSelect.CS_5, SpiChipSelect.parse("5"));
+        assertEquals(SpiChipSelect.CS_10, SpiChipSelect.parse("10"));
+    }
+
+    @Test
+    void shouldReturnCorrectSpiChipSelectFromShort() {
+        assertEquals(SpiChipSelect.CS_0, SpiChipSelect.getByNumber((short) 0));
+        assertEquals(SpiChipSelect.CS_1, SpiChipSelect.getByNumber((short) 1));
+        assertEquals(SpiChipSelect.CS_5, SpiChipSelect.getByNumber((short) 5));
+        assertEquals(SpiChipSelect.CS_10, SpiChipSelect.getByNumber((short) 10));
+    }
+
+    @Test
+    void shouldReturnCorrectSpiChipSelectFromInt() {
+        assertEquals(SpiChipSelect.CS_0, SpiChipSelect.getByNumber(0));
+        assertEquals(SpiChipSelect.CS_1, SpiChipSelect.getByNumber(1));
+        assertEquals(SpiChipSelect.CS_5, SpiChipSelect.getByNumber(5));
+        assertEquals(SpiChipSelect.CS_10, SpiChipSelect.getByNumber(10));
+    }
+}

plugins/pi4j-plugin-linuxfs/src/main/java/com/pi4j/plugin/linuxfs/provider/spi/LinuxFsSpi.java

@@ -68,7 +68,6 @@ public class LinuxFsSpi extends SpiBase implements Spi {
     private final static byte SIZE_OF_INT = 4;
 
     private static int SPI_IOC_MESSAGE(int n) {
-
         // Even though we will pass the structure to ioctl as a pointer, the command needs to know
         // the actual size of the structure (i.e. sizeof). Therefore, we use the ByValue interface
         // when getting the struct size.
@@ -155,6 +154,7 @@ public void open() {
         //    character special device, major number 153 with a dynamically chosen minor device number.
         //    This is the node that userspace programs will open, created by “udev” or “mdev”.
         String spiDev = SPI_DEVICE_BASE + config().bus().getBus() + "." + config().address();
+        LOG.info("Opening SPI bus {}, address {}", config().bus().getBus(), config().address());
         fd = libc.open(spiDev, LinuxLibC.O_RDWR);
         if (fd < 0) {
             throw new RuntimeException("Failed to open SPI device " + spiDev);
@@ -234,8 +234,6 @@ public void open() {
             libc.close(fd);
             throw new RuntimeException("Could not write the SPI SHIFT write.");
         }
-
-
    }
 
     @Override