SDI12_boards.h

Go to the documentation of this file.

 
/* ======================== Arduino SDI-12 =================================
An Arduino library for SDI-12 communication with a wide variety of environmental
sensors. This library provides a general software solution, without requiring
   ======================== Arduino SDI-12 =================================*/
 
#ifndef SRC_SDI12_BOARDS_H_
#define SRC_SDI12_BOARDS_H_
 
#include <Arduino.h>
 
#if defined(ESP32) || defined(ESP8266)
typedef uint32_t sdi12timer_t;
#else
typedef uint8_t sdi12timer_t;
#endif
 
class SDI12Timer {
 public:
  SDI12Timer();
  void configSDI12TimerPrescale(void);
  void resetSDI12TimerPrescale(void);
 
// Most 'standard' AVR boards
//
#if defined(__AVR_ATmega168__) || defined(__AVR_ATmega328P__) || \
  defined(__AVR_ATmega1280__) || defined(__AVR_ATmega2560__) ||  \
  defined(__AVR_ATmega644P__) || defined(__AVR_ATmega644__) ||   \
  defined(__AVR_ATmega1284P__) || defined(__AVR_ATmega1284__)
 
#define TIMER_IN_USE_STR "TCNT1"
#define TCNTX TCNT1  // Using Timer 1
 
#if F_CPU == 16000000L
#define PRESCALE_IN_USE_STR "1024"
#define TICKS_PER_BIT 13
#define BITS_PER_TICK_Q10 79
#define RX_WINDOW_FUDGE 2
 
#elif F_CPU == 12000000L
#define PRESCALE_IN_USE_STR "1024"
#define TICKS_PER_BIT 10
#define BITS_PER_TICK_Q10 105
#define RX_WINDOW_FUDGE 2
 
#elif F_CPU == 8000000L
#define PRESCALE_IN_USE_STR "256"
#define TICKS_PER_BIT 26
#define BITS_PER_TICK_Q10 39
#define RX_WINDOW_FUDGE 10
 
  // #define PRESCALE_IN_USE_STR "1024"
  // #define TICKS_PER_BIT 6
  //     // 8MHz / 1024 prescaler = 31250 'ticks'/sec = 128 µs / 'tick'
  //     // (1 sec/1200 bits) * (1 tick/128 µs) = 6.5104166667 ticks/bit
  // #define BITS_PER_TICK_Q10 157
  //     // 1/(6.5104166667 ticks/bit) * 2^10 = 157.2864
  // #define RX_WINDOW_FUDGE 5
 
#endif
 
 
// ATtiny boards (ie, adafruit trinket)
//
#elif defined(__AVR_ATtiny25__) || defined(__AVR_ATtiny45__) || defined(__AVR_ATtiny85__)
 
#define TIMER_IN_USE_STR "TCNT1"
#define TCNTX TCNT1  // Using Timer 1
 
#if F_CPU == 16000000L
#define PRESCALE_IN_USE_STR "1024"
#define TICKS_PER_BIT 13
#define BITS_PER_TICK_Q10 79
#define RX_WINDOW_FUDGE 2
 
#elif F_CPU == 8000000L
#define PRESCALE_IN_USE_STR "512"
#define TICKS_PER_BIT 13
#define BITS_PER_TICK_Q10 79
#define RX_WINDOW_FUDGE 5
 
#endif
 
 
// Arduino Leonardo & Yun and other 32U4 boards
//
#elif defined(ARDUINO_AVR_YUN) || defined(ARDUINO_AVR_LEONARDO) || \
  defined(__AVR_ATmega32U4__)
 
#define TIMER_IN_USE_STR "TCNT4"
#define TCNTX TCNT4  // Using Timer 4
 
#if F_CPU == 16000000L
#define PRESCALE_IN_USE_STR "1024"
#define TICKS_PER_BIT 13
#define BITS_PER_TICK_Q10 79
#define RX_WINDOW_FUDGE 2
 
#elif F_CPU == 8000000L
#define PRESCALE_IN_USE_STR "512"
#define TICKS_PER_BIT 13
#define BITS_PER_TICK_Q10 79
#define RX_WINDOW_FUDGE 5
 
#endif
 
 
// Arduino Zero other SAMD21 boards
//
#elif defined(ARDUINO_SAMD_ZERO) || defined(ARDUINO_ARCH_SAMD) || \
  defined(__SAMD21G18A__) || defined(__SAMD21J18A__) || defined(__SAMD21E18A__)
 
#define TIMER_IN_USE_STR "GCLK4-TC3"
#define TCNTX REG_TC3_COUNT8_COUNT  // Using Timer 3 with generic clock 4
 
#define PRESCALE_IN_USE_STR "3x1024"
#define TICKS_PER_BIT 13
#define BITS_PER_TICK_Q10 79
#define RX_WINDOW_FUDGE 2
 
// Espressif ESP32/ESP8266 boards
//
#elif defined(ESP32) || defined(ESP8266)
  sdi12timer_t SDI12TimerRead(void);
 
#define TICKS_PER_BIT 13
#define BITS_PER_TICK_Q10 79
#define RX_WINDOW_FUDGE 2
 
// Unknown board
#else
#error "Please define your board timer and pins"
#endif
};
 
#endif  // SRC_SDI12_BOARDS_H_