Refactoring hardware bus manager support

mikaelpatel · Oct 10, 2017 · d710ca5 · d710ca5
1 parent 4d6cfe1
commit d710ca5
Show file tree

Hide file tree

Showing 11 changed files with 100 additions and 475 deletions.
diff --git a/README.md b/README.md
@@ -5,23 +5,21 @@ based software and DS2482 based hardware bus manager, and device
 driver for DS18B20.
 
 The examples directory contains device search, bus scanner,
-thermometer alarm search, and example sketches for DS18B20, DS1990A
-and DS2482.
+thermometer alarm search, and example sketches for DS18B20 and
+DS1990A.
 
-Version: 1.6
+Version: 1.7
 
 ## Classes
 
 * [Abstract One-Wire Bus Manager and Device Interface, OWI](./src/OWI.h)
 * [Software One-Wire Bus Manager, GPIO, Software::OWI](./src/Software/OWI.h)
-* [Hardware One-Wire Bus Manager, DS2482, Hardware::OWI](./src/Hardware/OWI.h)
 * [Programmable Resolution 1-Wire Digital Thermometer, DS18B20](./src/Driver/DS18B20.h)
 
 ## Example Sketches
 
 * [DS18B20](./examples/DS18B20)
 * [DS1990A](./examples/DS1990A)
-* [DS2482](./examples/DS2482)
 * [Alarm](./examples/Alarm)
 * [Scanner](./examples/Scanner)
 * [Search](./examples/Search)

diff --git a/examples/Alarm/Alarm.ino b/examples/Alarm/Alarm.ino
@@ -9,12 +9,17 @@
 Software::OWI<BOARD::D7> owi;
 
 #else
+#include "TWI.h"
 #include "Hardware/OWI.h"
 // Configure: Software/Hardware TWI Bus Manager
 // #define USE_SOFTWARE_TWI
 #if defined(USE_SOFTWARE_TWI)
 #include "Software/TWI.h"
+#if defined(SAM)
+Software::TWI<BOARD::D8,BOARD::D9> twi;
+#else
 Software::TWI<BOARD::D18,BOARD::D19> twi;
+#endif
 #else
 #include "Hardware/TWI.h"
 Hardware::TWI twi;
@@ -24,6 +29,16 @@ Hardware::OWI owi(twi);
 
 DS18B20 sensor(owi);
 
+#define ASSERT(expr)							\
+  do {									\
+    if (!(expr)) {							\
+      Serial.print(__LINE__);						\
+      Serial.println(F(":assert:" #expr));				\
+      Serial.flush();							\
+      exit(0);								\
+    }									\
+  } while (0)
+
 void setup()
 {
   Serial.begin(57600);
@@ -38,7 +53,7 @@ void setup()
     if (last == owi.ERROR) break;
     sensor.resolution(10);
     sensor.set_trigger(20, 25);
-    sensor.write_scratchpad();
+    ASSERT(sensor.write_scratchpad());
   } while (last != owi.LAST);
 }
 
@@ -50,16 +65,14 @@ void loop()
 
   int8_t last = owi.FIRST;
   uint8_t* rom = sensor.rom();
-  bool triggered = false;
   static uint16_t timestamp = 0;
   uint8_t id = 0;
   if (!sensor.convert_request(true)) return;
   delay(sensor.conversion_time());
   do {
     last = owi.alarm_search(rom, last);
     if (last == owi.ERROR) break;
-    triggered = true;
-    sensor.read_scratchpad(false);
+    ASSERT(sensor.read_scratchpad(false));
     Serial.print(timestamp);
     Serial.print('.');
     Serial.print(id++);

diff --git a/examples/DS18B20/DS18B20.ino b/examples/DS18B20/DS18B20.ino
@@ -9,12 +9,17 @@
 Software::OWI<BOARD::D7> owi;
 
 #else
-#include "Hardware/OWI.h"
 // Configure: Software/Hardware TWI Bus Manager
 // #define USE_SOFTWARE_TWI
+#include "TWI.h"
+#include "Hardware/OWI.h"
 #if defined(USE_SOFTWARE_TWI)
 #include "Software/TWI.h"
+#if defined(SAM)
+Software::TWI<BOARD::D8,BOARD::D9> twi;
+#else
 Software::TWI<BOARD::D18,BOARD::D19> twi;
+#endif
 #else
 #include "Hardware/TWI.h"
 Hardware::TWI twi;
@@ -24,6 +29,16 @@ Hardware::OWI owi(twi);
 
 DS18B20 sensor(owi);
 
+#define ASSERT(expr)							\
+  do {									\
+    if (!(expr)) {							\
+      Serial.print(__LINE__);						\
+      Serial.println(F(":assert:" #expr));				\
+      Serial.flush();							\
+      exit(0);								\
+    }									\
+  } while (0)
+
 void setup()
 {
   Serial.begin(57600);
@@ -47,7 +62,7 @@ void loop()
     if (last == owi.ERROR) break;
 
     // Read the scratchpad with current temperature, tiggers, etc
-    sensor.read_scratchpad(false);
+    ASSERT(sensor.read_scratchpad(false));
     int8_t low, high;
     sensor.get_trigger(low, high);
 

diff --git a/examples/DS2482/DS2482.ino b/examples/DS2482/DS2482.ino
diff --git a/examples/Scanner/Scanner.ino b/examples/Scanner/Scanner.ino
@@ -8,12 +8,17 @@
 Software::OWI<BOARD::D7> owi;
 
 #else
-#include "Hardware/OWI.h"
 // Configure: Software/Hardware TWI Bus Manager
 // #define USE_SOFTWARE_TWI
+#include "TWI.h"
+#include "Hardware/OWI.h"
 #if defined(USE_SOFTWARE_TWI)
 #include "Software/TWI.h"
+#if defined(SAM)
+Software::TWI<BOARD::D8,BOARD::D9> twi;
+#else
 Software::TWI<BOARD::D18,BOARD::D19> twi;
+#endif
 #else
 #include "Hardware/TWI.h"
 Hardware::TWI twi;

diff --git a/examples/Search/Search.ino b/examples/Search/Search.ino
@@ -8,12 +8,17 @@
 Software::OWI<BOARD::D7> owi;
 
 #else
-#include "Hardware/OWI.h"
 // Configure: Software/Hardware TWI Bus Manager
 // #define USE_SOFTWARE_TWI
+#include "TWI.h"
+#include "Hardware/OWI.h"
 #if defined(USE_SOFTWARE_TWI)
 #include "Software/TWI.h"
+#if defined(SAM)
+Software::TWI<BOARD::D8,BOARD::D9> twi;
+#else
 Software::TWI<BOARD::D18,BOARD::D19> twi;
+#endif
 #else
 #include "Hardware/TWI.h"
 Hardware::TWI twi;

diff --git a/library.properties b/library.properties
@@ -1,5 +1,5 @@
 name=Arduino-OWI
-version=1.6
+version=1.7
 author=Mikael Patel
 maintainer=Mikael Patel <[email protected]>
 sentence=One-Wire Interface (OWI) library for Arduino.

diff --git a/mainpage.dox b/mainpage.dox
@@ -5,7 +5,7 @@ The OWI library has been developed to support the implementation of
 based Software::OWI bus manager, DS2482 based Hardware::OWI bus
 manager, and device driver for DS18B20.
 
-Version: 1.6
+Version: 1.7
 */
 
 /** @page License