Merge pull request #266 from Tinyu-Zhao/master

Tinyu-Zhao · web-flow · commit cd7915ff1e73 · 2021-10-23T22:59:14.000+08:00
Ezdata
diff --git a/README.md b/README.md
@@ -6,9 +6,9 @@ English | [中文](docs/getting_started_cn.md) | [日本語](docs/getting_starte
 
 <img src="https://static-cdn.m5stack.com/resource/docs/static/assets/img/product_pics/core/basic/basic_01.webp" alt="basic" width="350" height="350">
 
-* **For the Detailed documentation of Gray, please [Click here](https://docs.m5stack.com/#/en/core/m5stickc)**
-
-* **For the Detailed documentation of Basic, please [Click here](https://docs.m5stack.com/#/en/core/m5stickc)**
+* **For the Detailed documentation of Gray, please [Click here](https://docs.m5stack.com/#/en/core/basic)**
+  
+* **For the Detailed documentation of Basic, please [Click here](https://docs.m5stack.com/#/en/core/gray)**
 
 * **In order to buy Basic, please [Click here](https://www.aliexpress.com/item/32837164440.html?spm=a2g0o.store_pc_groupList.8148356.11.38a9361bR9o79U)**
 
diff --git a/examples/Advanced/EzData/EzData.ino b/examples/Advanced/EzData/EzData.ino
@@ -0,0 +1,86 @@
+/*
+*******************************************************************************
+* Copyright (c) 2021 by M5Stack
+*                  Equipped with M5Core sample source code
+*                          配套  M5Core 示例源代码
+* Visit the website for more information：https://docs.m5stack.com/en/core/gray
+* 获取更多资料请访问：https://docs.m5stack.com/zh_CN/core/gray
+*
+* describe：EzData.
+* date：2021/10/17
+*******************************************************************************
+*/
+#include "M5Stack.h"
+#include "M5_EzData.h"
+
+// Configure the name and password of the connected wifi and your token.  配置所连接wifi的名称、密码以及你的token
+const char* ssid = "Explore-F";
+const char* password = "xingchentansuo123";
+const char* token = "";
+
+void setup() {
+  M5.begin();   //Initialize M5Stack
+  M5.Power.begin();
+  if(setupWifi(ssid,password)){ //Connect to wifi.  连接到wifi
+    M5.Lcd.printf("Success connecting to %s\n",ssid);
+  }else{
+    M5.Lcd.printf("Connecting to %s failed\n",ssid);
+  }
+}
+
+void loop() {
+   //Save the data 20 to the top of the testData topic queue.  保存数据20至 testData 队列首位
+  if(setData(token,"testData",20)){
+    M5.Lcd.printf("Success sending data to the topic\n");
+  }else{
+    M5.Lcd.print("Fail to save data\n");
+  }
+  delay(5000);
+
+  //Save 3 data in sequence to the first place of testList.  依次保存3个数据至 testList首位
+  for(int i=0;i<3;i++){
+    if(addToList(token,"testList",i)){
+      M5.Lcd.printf("Success sending %d to the list\n",i);
+    }else{
+      M5.Lcd.print("Fail to save data\n");
+    }
+    delay(100);
+  }
+  delay(5000);
+
+  //Get a piece of data from a topic and store the value in result.  从一个 topic中获取一个数据,并将值存储在 result
+  int result=0;
+  if(getData(token,"testData",result)){
+    M5.Lcd.printf("Success get data %d\n",result);
+  }else{
+    M5.Lcd.print("Fail to get data\n");
+  }
+  delay(5000);
+
+//Get a set of data from a list and store the values in the Array array.  从一个 list中获取一组数据,并将值存储在 Array数组中
+  int Array[3]={};
+  if(getData(token,"testList",Array,0,3)){
+    M5.Lcd.print("Success get list\n");
+    for(int i=0;i<3;i++){
+      M5.Lcd.printf("Array[%d]=%d,",i,Array[i]);
+    }
+    M5.Lcd.println("");
+  }else{
+    M5.Lcd.println("Fail to get data");
+  }
+  delay(5000);
+
+  //Remove data
+  if(removeData(token,"testData"))
+    M5.Lcd.printf("Success remove data\n");
+  else
+    M5.Lcd.println("Fail to remove data");
+
+  if(removeData(token,"testList"))
+    M5.Lcd.printf("Success remove data from the list\n");
+  else
+    M5.Lcd.println("Fail to remove data");
+  delay(5000);
+  M5.Lcd.fillScreen(BLACK);
+  M5.Lcd.setCursor(0,0);
+}
diff --git a/examples/Advanced/WIFI/BasicHttpClient/BasicHttpClient.ino b/examples/Advanced/WIFI/BasicHttpClient/BasicHttpClient.ino
@@ -48,5 +48,5 @@ void loop() {
     M5.Lcd.print("connect failed");
   }
   delay(5000);
-  M5.Lcd.createSprite(); //clear the screen.  清除屏幕
+  M5.Lcd.clear(); //clear the screen.  清除屏幕
 }
diff --git a/examples/Unit/VMeter_ADS1115/voltmeter.cpp b/examples/Unit/VMeter_ADS1115/voltmeter.cpp
@@ -0,0 +1,286 @@
+#include "voltmeter.h"
+#include "Wire.h"
+
+void Voltmeter::i2cBegin() {
+  // Wire.begin();
+}
+
+bool Voltmeter::i2cReadBytes(uint8_t addr, uint8_t reg_addr, uint8_t* buff, uint16_t len) {
+  Wire.beginTransmission(addr);
+  Wire.write(reg_addr);
+  uint8_t i = 0;
+  if (Wire.endTransmission(false) == 0 && Wire.requestFrom(addr, (uint8_t)len)) {
+    while (Wire.available()) {
+      buff[i++] = Wire.read();
+    }
+    return true;
+  }
+
+  return false;
+}
+
+bool Voltmeter::i2cWriteBytes(uint8_t addr, uint8_t reg_addr, uint8_t* buff, uint16_t len) {
+  bool function_result = false;
+
+  Wire.beginTransmission(addr);
+  Wire.write(reg_addr);                 
+  for(int i = 0; i < len; i++) {
+    Wire.write(*(buff+i));
+  }
+  function_result = (Wire.endTransmission() == 0);
+  return function_result;
+}
+
+bool Voltmeter::i2cReadU16(uint8_t addr, uint8_t reg_addr, uint16_t* value) {
+  uint8_t read_buf[2] = {0x00, 0x00};
+  bool result = i2cReadBytes(addr, reg_addr, read_buf, 2);
+  *value = (read_buf[0] << 8) | read_buf[1];
+  return result;
+}
+
+bool Voltmeter::i2cWriteU16(uint8_t addr, uint8_t reg_addr, uint16_t value) {
+  uint8_t write_buf[2];
+  write_buf[0] = value >> 8;
+  write_buf[1] = value & 0xff;
+  return i2cWriteBytes(addr, reg_addr, write_buf, 2);
+}
+
+float Voltmeter::getResolution(voltmeterGain_t gain) {
+  switch (gain) {
+    case PAG_6144:
+      return ADS1115_MV_6144 / VOLTMETER_PRESSURE_COEFFICIENT;
+    case PAG_4096:
+      return ADS1115_MV_4096 / VOLTMETER_PRESSURE_COEFFICIENT;
+    case PAG_2048:
+      return ADS1115_MV_2048 / VOLTMETER_PRESSURE_COEFFICIENT;
+    case PAG_1024:
+      return ADS1115_MV_1024 / VOLTMETER_PRESSURE_COEFFICIENT;
+    case PAG_512:
+      return ADS1115_MV_512 / VOLTMETER_PRESSURE_COEFFICIENT;
+    case PAG_256:
+      return ADS1115_MV_256 / VOLTMETER_PRESSURE_COEFFICIENT;
+    default:
+      return ADS1115_MV_256 / VOLTMETER_PRESSURE_COEFFICIENT;
+  };
+}
+
+uint8_t Voltmeter::getPGAEEEPROMAddr(voltmeterGain_t gain) {
+  switch (gain) {
+    case PAG_6144:
+      return VOLTMETER_PAG_6144_CAL_ADDR;
+    case PAG_4096:
+      return VOLTMETER_PAG_4096_CAL_ADDR;
+    case PAG_2048:
+      return VOLTMETER_PAG_2048_CAL_ADDR;
+    case PAG_1024:
+      return VOLTMETER_PAG_1024_CAL_ADDR;
+    case PAG_512:
+      return VOLTMETER_PAG_512_CAL_ADDR;
+    case PAG_256:
+      return VOLTMETER_PAG_256_CAL_ADDR;
+    default:
+      return 0x00;
+  };
+}
+
+uint16_t Voltmeter::getCoverTime(voltmeterRate_t rate) {
+  switch (rate) {
+    case RATE_8:
+      return 1000 / 8;
+    case RATE_16:
+      return 1000 / 16;
+    case RATE_32:
+      return 1000 / 32;
+    case RATE_64:
+      return 1000 / 64;
+    case RATE_128:
+      return 1000 / 128;
+    case RATE_250:
+      return 1000 / 250;
+    case RATE_475:
+      return 1000 / 475;
+    case RATE_860:
+      return 1000 / 860;
+    default:
+      return 1000 / 128;
+  };
+}
+
+Voltmeter::Voltmeter(uint8_t ads1115_addr, uint8_t eeprom_addr) {
+  _ads1115_addr = ads1115_addr;
+  _eeprom_addr = eeprom_addr;
+  _gain = PAG_2048;
+  _mode = SINGLESHOT;
+  _rate = RATE_128;
+  calibration_factor = 1;
+  adc_raw = 0;
+  resolution = getResolution(_gain);
+  cover_time = getCoverTime(_rate);
+}
+
+void Voltmeter::setGain(voltmeterGain_t gain) {
+  uint16_t reg_value = 0;
+  bool result = i2cReadU16(_ads1115_addr, ADS1115_RA_CONFIG, &reg_value);
+ 
+  if (result == false) {
+    return;
+  }
+
+  reg_value &= ~(0b0111 << 9);
+  reg_value |= gain << 9;
+
+  result = i2cWriteU16(_ads1115_addr, ADS1115_RA_CONFIG, reg_value);
+
+  if (result) {
+    _gain = gain;
+    resolution = getResolution(gain);
+    int16_t hope = 1;
+    int16_t actual = 1;
+    if (readCalibrationFromEEPROM(gain, &hope, &actual)) {
+      calibration_factor = (double)hope / actual;
+    }
+  }
+}
+
+void Voltmeter::setRate(voltmeterRate_t rate) {
+  uint16_t reg_value = 0;
+  bool result = i2cReadU16(_ads1115_addr, ADS1115_RA_CONFIG, &reg_value);
+  if (result == false) {
+    return;
+  }
+
+  reg_value &= ~(0b0111 << 5);
+  reg_value |= rate << 5;
+
+  result = i2cWriteU16(_ads1115_addr, ADS1115_RA_CONFIG, reg_value);
+
+  if (result) {
+    _rate = rate;
+    cover_time = getCoverTime(_rate);
+  }
+
+  return;
+}
+
+void Voltmeter::setMode(voltmeterMode_t mode) {
+  uint16_t reg_value = 0;
+  bool result = i2cReadU16(_ads1115_addr, ADS1115_RA_CONFIG, &reg_value);
+  if (result == false) {
+    return;
+  }
+
+  reg_value &= ~(0b0001 << 8);
+  reg_value |= mode << 8;
+
+  result = i2cWriteU16(_ads1115_addr, ADS1115_RA_CONFIG, reg_value);
+  if (result) {
+    _mode = mode;
+  }
+
+  return;
+}
+
+bool Voltmeter::isInConversion() {
+  uint16_t value = 0x00;
+  i2cReadU16(_ads1115_addr, ADS1115_RA_CONFIG, &value);
+
+  return (value & (1 << 15)) ? false : true;
+}
+
+void Voltmeter::startSingleConversion() {
+  uint16_t reg_value = 0;
+  bool result = i2cReadU16(_ads1115_addr, ADS1115_RA_CONFIG, &reg_value);
+
+  if (result == false) {
+    return;
+  }
+
+  reg_value &= ~(0b0001 << 15);
+  reg_value |= 0x01 << 15;
+
+  i2cWriteU16(_ads1115_addr, ADS1115_RA_CONFIG, reg_value);
+}
+
+float Voltmeter::getVoltage(bool calibration) {
+  if (calibration) {
+    return resolution * calibration_factor * getConversion() * VOLTMETER_MEASURING_DIR;
+  } else {
+    return resolution * getConversion() * VOLTMETER_MEASURING_DIR;
+  }
+}
+
+int16_t Voltmeter::getAdcRaw() {
+  uint16_t value = 0x00;
+  i2cReadU16(_ads1115_addr, ADS1115_RA_CONVERSION, &value);
+  adc_raw = value;
+  return value;
+}
+
+int16_t Voltmeter::getConversion(uint16_t timeout) {
+  if (_mode == SINGLESHOT) {
+    startSingleConversion();
+    delay(cover_time);
+    uint64_t time = millis() + timeout;
+    while (time > millis() && isInConversion());
+  }
+
+  return getAdcRaw();
+}
+
+bool Voltmeter::EEPORMWrite(uint8_t address, uint8_t* buff, uint8_t len) {
+  return i2cWriteBytes(_eeprom_addr, address, buff, len);
+}
+
+bool Voltmeter::EEPORMRead(uint8_t address, uint8_t* buff, uint8_t len) {
+  return i2cReadBytes(_eeprom_addr, address, buff, len);
+}
+
+bool Voltmeter::saveCalibration2EEPROM(voltmeterGain_t gain, int16_t hope, int16_t actual) {
+  if (hope == 0 || actual == 0) {
+    return false;
+  }
+
+  uint8_t buff[8];
+  memset(buff, 0, 8);
+  buff[0] = gain;
+  buff[1] = hope >> 8;
+  buff[2] = hope & 0xFF;
+
+  buff[3] = actual >> 8;
+  buff[4] = actual & 0xFF;
+
+  for (uint8_t i = 0; i < 5; i++) {
+    buff[5] ^= buff[i];
+  }
+
+  uint8_t addr = getPGAEEEPROMAddr(gain);
+  return EEPORMWrite(addr, buff, 8);
+}
+
+bool Voltmeter::readCalibrationFromEEPROM(voltmeterGain_t gain, int16_t* hope, int16_t* actual) {
+  uint8_t addr = getPGAEEEPROMAddr(gain);
+  uint8_t buff[8];
+  memset(buff, 0, 8);
+
+  *hope = 1;
+  *actual = 1;
+
+  bool result = EEPORMRead(addr, buff, 8);
+  
+  if (result == false) {
+    return false;
+  }
+
+  uint8_t xor_result = 0x00;
+  for (uint8_t i = 0; i < 5; i++) {
+    xor_result ^= buff[i];
+  }
+
+  if (xor_result != buff[5]) {
+    return false;
+  }
+
+  *hope = (buff[1] << 8) | buff[2];
+  *actual = (buff[3] << 8) | buff[4];
+  return true;
+}
diff --git a/examples/Unit/VMeter_ADS1115/voltmeter.h b/examples/Unit/VMeter_ADS1115/voltmeter.h
diff --git a/library.properties b/library.properties

Original file line number	Diff line number	Diff line change
`@@ -48,5 +48,5 @@ void loop() {`
`48`	`48`	`M5.Lcd.print("connect failed");`
`49`	`49`	`}`
`50`	`50`	`delay(5000);`
`51`		`- M5.Lcd.createSprite(); //clear the screen. 清除屏幕`
	`51`	`+ M5.Lcd.clear(); //clear the screen. 清除屏幕`
`52`	`52`	`}`