Adding result enum

See PR junkfix/esp32-ds18b20#28

Author: mathieucarbou

src/MycilaDS18.cpp

@@ -11,8 +11,6 @@
                                                (((1ULL << (gpio_num)) & SOC_GPIO_VALID_OUTPUT_GPIO_MASK) != 0))
 #endif
 
-static const char* err_desc[] = {"", "CRC ERROR", "BAD DATA", "TIMEOUT", "DRIVER NOT INITIALIZED"};
-
 void Mycila::DS18::begin(const int8_t pin, uint8_t maxSearchCount) {
   if (_enabled)
     return;
@@ -71,14 +69,29 @@ bool Mycila::DS18::read() {
     return false;
 
   float read;
-  uint8_t err = _oneWire->getTemp(_deviceAddress, read);
+  OneWire32::Result result = _oneWire->getTemp(_deviceAddress, read);
 
   // request new reading
   _oneWire->request();
 
   // process data when no error
-  if (err) {
-    ESP_LOGW(TAG, "%s 0x%llx @ pin %d: read error: %s", _name, _deviceAddress, _pin, err_desc[err]);
+  if (result != OneWire32::Result::OK) {
+    switch (result) {
+      case OneWire32::Result::OK:
+        break;
+      case OneWire32::Result::CRC:
+        ESP_LOGW(TAG, "%s 0x%llx @ pin %d: CRC error", _name, _deviceAddress, _pin);
+        return false;
+      case OneWire32::Result::BAD_DATA:
+        ESP_LOGW(TAG, "%s 0x%llx @ pin %d: Bad data", _name, _deviceAddress, _pin);
+        return false;
+      case OneWire32::Result::TIMEOUT:
+        ESP_LOGW(TAG, "%s 0x%llx @ pin %d: Timeout", _name, _deviceAddress, _pin);
+        return false;
+      case OneWire32::Result::DRIVER:
+        ESP_LOGW(TAG, "%s 0x%llx @ pin %d: Driver not initialized", _name, _deviceAddress, _pin);
+        return false;
+    }
     return false;
   }
 

src/esp32-ds18b20/OneWireESP32.cpp

@@ -6,12 +6,6 @@
 
 #include <esp_idf_version.h>
 
-#define OWR_OK       0
-#define OWR_CRC      1
-#define OWR_BAD_DATA 2
-#define OWR_TIMEOUT  3
-#define OWR_DRIVER   4
-
 #define OW_RESET_PULSE             500
 #define OW_RESET_WAIT              200
 #define OW_RESET_PRESENCE_WAIT_MIN 15
@@ -251,44 +245,40 @@ void OneWire32::request() {
 
 const uint8_t crc_table[] = {0, 94, 188, 226, 97, 63, 221, 131, 194, 156, 126, 32, 163, 253, 31, 65, 157, 195, 33, 127, 252, 162, 64, 30, 95, 1, 227, 189, 62, 96, 130, 220, 35, 125, 159, 193, 66, 28, 254, 160, 225, 191, 93, 3, 128, 222, 60, 98, 190, 224, 2, 92, 223, 129, 99, 61, 124, 34, 192, 158, 29, 67, 161, 255, 70, 24, 250, 164, 39, 121, 155, 197, 132, 218, 56, 102, 229, 187, 89, 7, 219, 133, 103, 57, 186, 228, 6, 88, 25, 71, 165, 251, 120, 38, 196, 154, 101, 59, 217, 135, 4, 90, 184, 230, 167, 249, 27, 69, 198, 152, 122, 36, 248, 166, 68, 26, 153, 199, 37, 123, 58, 100, 134, 216, 91, 5, 231, 185, 140, 210, 48, 110, 237, 179, 81, 15, 78, 16, 242, 172, 47, 113, 147, 205, 17, 79, 173, 243, 112, 46, 204, 146, 211, 141, 111, 49, 178, 236, 14, 80, 175, 241, 19, 77, 206, 144, 114, 44, 109, 51, 209, 143, 12, 82, 176, 238, 50, 108, 142, 208, 83, 13, 239, 177, 240, 174, 76, 18, 145, 207, 45, 115, 202, 148, 118, 40, 171, 245, 23, 73, 8, 86, 180, 234, 105, 55, 213, 139, 87, 9, 235, 181, 54, 104, 138, 212, 149, 203, 41, 119, 244, 170, 72, 22, 233, 183, 85, 11, 136, 214, 52, 106, 43, 117, 151, 201, 74, 20, 246, 168, 116, 42, 200, 150, 21, 75, 169, 247, 182, 232, 10, 84, 215, 137, 107, 53};
 
-uint8_t OneWire32::getTemp(uint64_t& addr, float& temp) {
-  uint8_t error = OWR_OK;
+OneWire32::Result OneWire32::getTemp(uint64_t& addr, float& temp) {
   if (!drv) {
-    return OWR_DRIVER;
+    return Result::DRIVER;
+  }
+  if (!reset()) {
+    return Result::TIMEOUT;
+  }
+  write(0x55);
+  uint8_t* a = (uint8_t*)&addr;
+  for (uint8_t i = 0; i < 8; i++) {
+    write(a[i]);
   }
-  if (reset()) { // connected
-    write(0x55);
-    uint8_t* a = (uint8_t*)&addr;
-    for (uint8_t i = 0; i < 8; i++) {
-      write(a[i]);
+  write(0xBE); // Read
+  uint8_t data[9];
+  uint16_t zero = 0;
+  uint8_t crc = 0;
+  for (uint8_t j = 0; j < 9; j++) {
+    if (!read(data[j], 8)) {
+      data[j] = 0;
     }
-    write(0xBE); // Read
-    uint8_t data[9];
-    uint16_t zero = 0;
-    uint8_t crc = 0;
-    for (uint8_t j = 0; j < 9; j++) {
-      if (!read(data[j], 8)) {
-        data[j] = 0;
-      }
-      zero += data[j];
-      if (j < 8) {
-        crc = crc_table[crc ^ data[j]];
-      }
+    zero += data[j];
+    if (j < 8) {
+      crc = crc_table[crc ^ data[j]];
     }
-    if (zero != 0x8f7 && zero) {
-      if (data[8] == crc) { // CRC OK
-        int16_t t = (data[1] << 8) | data[0];
-        temp = ((float)t / 16.0);
-      } else {
-        error = OWR_CRC;
-      }
-    } else {
-      error = OWR_BAD_DATA;
-    }
-  } else {
-    error = OWR_TIMEOUT;
   }
-  return error;
+  if (zero == 0 || zero == 0x8f7) {
+    return Result::BAD_DATA;
+  }
+  if (data[8] != crc) {
+    return Result::CRC;
+  }
+  int16_t t = (data[1] << 8) | data[0];
+  temp = ((float)t / 16.0);
+  return Result::OK;
 }
 
 uint8_t OneWire32::search(uint64_t* addresses, uint8_t total) {

src/esp32-ds18b20/OneWireESP32.h

@@ -31,11 +31,19 @@ class OneWire32 {
     uint8_t drv = 0;
 
   public:
+    enum Result {
+      OK = 0,
+      CRC = 1,
+      BAD_DATA = 2,
+      TIMEOUT = 3,
+      DRIVER = 4
+    };
+
     OneWire32(uint8_t pin);
     ~OneWire32();
     bool reset();
     void request();
-    uint8_t getTemp(uint64_t& addr, float& temp);
+    Result getTemp(uint64_t& addr, float& temp);
     uint8_t search(uint64_t* addresses, uint8_t total);
     bool read(uint8_t& data, uint8_t len = 8);
     bool write(const uint8_t data, uint8_t len = 8);