tsi2c.h

Go to the documentation of this file.

/*
  Created by Fabrizio Di Vittorio (fdivitto2013@gmail.com) - <http://www.fabgl.com>
  Copyright (c) 2019-2022 Fabrizio Di Vittorio.
  All rights reserved.
 
 
* Please contact fdivitto2013@gmail.com if you need a commercial license.
 
 
* This library and related software is available under GPL v3.
 
  FabGL is free software: you can redistribute it and/or modify
  it under the terms of the GNU General Public License as published by
  the Free Software Foundation, either version 3 of the License, or
  (at your option) any later version.
 
  FabGL is distributed in the hope that it will be useful,
  but WITHOUT ANY WARRANTY; without even the implied warranty of
  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  GNU General Public License for more details.
 
  You should have received a copy of the GNU General Public License
  along with FabGL.  If not, see <http://www.gnu.org/licenses/>.
 */
 
 
#pragma once
 
 
#ifdef ARDUINO
 
 
#include <stdint.h>
#include <stddef.h>
 
#include "freertos/FreeRTOS.h"
#include "freertos/queue.h"
#include "freertos/semphr.h"
 
#include "esp32-hal.h"
 
#include "fabutils.h"
#include "fabglconf.h"
 
 
 
namespace fabgl {
 
 
struct I2CJobInfo {
  int32_t   frequency;
  uint8_t * buffer;
  uint8_t   address;
  uint16_t  size;
  uint16_t  timeout;
  uint32_t  readCount;
  #if FABGL_ESP_IDF_VERSION < FABGL_ESP_IDF_VERSION_VAL(4, 4, 0)
  i2c_err_t lastError;
  #else
  esp_err_t lastError;
  #endif
};
 
 
class I2C {
 
public:
 
  I2C(int bus = 0);
 
  ~I2C();
 
  bool begin(gpio_num_t SDAGPIO, gpio_num_t SCLGPIO);
 
  void end();
 
  bool write(int address, uint8_t * buffer, int size, int frequency = 100000, int timeOutMS = 50);
 
  int read(int address, uint8_t * buffer, int size, int frequency = 100000, int timeOutMS = 50);
 
  int getMaxBufferLength() { return 128; }
 
 
private:
 
  static void commTaskFunc(void * pvParameters);
 
  #if FABGL_ESP_IDF_VERSION < FABGL_ESP_IDF_VERSION_VAL(4, 4, 0)
  i2c_t *            m_i2c;
  #endif
  
  bool               m_i2cAvailable;
 
  uint8_t            m_bus;
  gpio_num_t         m_SDAGPIO;
  gpio_num_t         m_SCLGPIO;
 
  TaskHandle_t       m_commTaskHandle;
 
  EventGroupHandle_t m_eventGroup;
 
  I2CJobInfo         m_jobInfo;
};
 
 
 
 
 
 
 
 
 
 
} // end of namespace
 
 
 
#endif // #ifdef ARDUINO