uEEPROMLib.h

Go to the documentation of this file.

 
#ifndef UEEPROMLIB
    #define UEEPROMLIB
    #include "Arduino.h"
    #ifndef UEEPROMLIB_WIRE
        #if defined(ARDUINO_attiny) || defined(ARDUINO_AVR_ATTINYX4) || defined(ARDUINO_AVR_ATTINYX5) || defined(ARDUINO_AVR_ATTINYX7) || defined(ARDUINO_AVR_ATTINYX8) || defined(ARDUINO_AVR_ATTINYX61) || defined(ARDUINO_AVR_ATTINY43) || defined(ARDUINO_AVR_ATTINY828) || defined(ARDUINO_AVR_ATTINY1634) || defined(ARDUINO_AVR_ATTINYX313)
            #include <TinyWireM.h>                  // I2C Master lib for ATTinys which use USI
            #define UEEPROMLIB_WIRE TinyWireM
        #else
            #include <Wire.h>
            #define UEEPROMLIB_WIRE Wire
        #endif
    #endif
 
    #define UEEPROMLIB_ADDRESS 0x57
 
    // ESP yield function (ESP32 has no need for that on dual core, but it has on single core version)
    #if ARDUINO_ARCH_ESP8266
        #define uEEPROMLIB_YIELD yield();
    #else
        #if ARDUINO_ARCH_ESP32
            #define uEEPROMLIB_YIELD yield();
        #else
            #define uEEPROMLIB_YIELD
        #endif
    #endif
 
 
    #define uEEPROMLIB_WIRE_DELAY 6
 
    #define uEEPROMLIB_WIRE_SHORT_DELAY 1
 
    // BUFFER_LENGTH should come from Wire library
     #ifdef BUFFER_LENGTH
        #define UEEPROMLIB_WIRE_MAX_RBUFFER (BUFFER_LENGTH - 2)
    #else
        #define UEEPROMLIB_WIRE_MAX_RBUFFER 32
    #endif
        #define UEEPROMLIB_WIRE_MAX_WBUFFER (UEEPROMLIB_WIRE_MAX_RBUFFER - 2)
 
 
    class uEEPROMLib {
        public:
            // Constructors
            uEEPROMLib();
            uEEPROMLib(const int);
            uEEPROMLib(bool);
            uEEPROMLib(bool, const int);
 
            void set_address(const uint8_t);
            // EEPROM read functions
            bool eeprom_read(const unsigned int, byte *, unsigned int);
            template <typename TR> void eeprom_read(const unsigned int, TR *);
            byte eeprom_read(const unsigned int);
 
            // EEPROM write functions
            bool eeprom_write(const unsigned int, void *, const unsigned int);
            bool eeprom_write(const unsigned int, char);
            bool eeprom_write(const unsigned int, unsigned char);
            template <typename TW> bool eeprom_write(const unsigned int, const TW);
 
            uint8_t page_size = 32; // common size, as AT24C32 (datasheet on extras)
 
        private:
            bool _eeprom_read_sub(const unsigned int, byte *, const uint8_t);
            bool _eeprom_write_sub(const unsigned int, byte *, const uint8_t);
 
            // Addresses
            int _ee_address = UEEPROMLIB_ADDRESS;
 
            // EEPROM read and write private functions - works with bytes
            byte _eeprom_read(const unsigned int);
            bool _eeprom_write(const unsigned int, const byte);
            // Fix for 1st write error
            bool init = false;
            #define uEEPROMLIB_STM32_INIT_FIX() { if (!init) { init = true;  _eeprom_read(0); delay(10); } }
    };
 
 
    // Templates must be here because Arduino compiler incompatibility to declare them on .cpp file
 
    template <typename TW> bool uEEPROMLib::eeprom_write(const unsigned int address, const TW data) {
        return eeprom_write(address, (void *) &data, sizeof(TW));
    }
 
 
    template <typename TR> void uEEPROMLib::eeprom_read(const unsigned int address, TR *data) {
        eeprom_read(address, (byte *) data, sizeof(TR));
    }
#endif