Document update

Author: Heltec-Aaron-Lee

README.md

@@ -4,7 +4,7 @@ English | [简体中文](#简体中文)
 
 **This library must work with [Heltec ESP32 develop framework](https://github.com/Heltec-Aaron-Lee/WiFi_Kit_series)! A detail document about how to install Heltec ESP32 development framework and this library available here:**
 
-**[http://docs.heltec.cn/#/en/user_manual/how_to_install_esp32_Arduino](http://docs.heltec.cn/#/en/user_manual/how_to_install_esp32_Arduino)**
+**[https://heltec-automation-docs.readthedocs.io/en/latest/esp32/quick_start.html](https://heltec-automation-docs.readthedocs.io/en/latest/esp32/quick_start.html)**
 
 ## CONTENT
 
@@ -18,12 +18,7 @@ English | [简体中文](#简体中文)
 
 3. [API Reference](#api-reference)
 
-4. [Hardware Reference](#hardware-reference)
-
-	- [PinoutDiagram](#pinoutdiagram)
-
-	- [Schematic Diagram](#schematic-diagram)
-
+4. [Relevant Resources](#relevant-resources)
 
 ***
 
@@ -34,14 +29,17 @@ English | [简体中文](#简体中文)
 ### Use Arduino Library Manager
 Open Arduino IDE, then Select `Sketch`->`Include Library`->`Manage Libraries...`
 Search `Heltec ESP32` and install it.
-<img src="http://docs.heltec.cn/img/how_to_install_esp32_Arduino/06.png">
-<img src="http://docs.heltec.cn/img/how_to_install_esp32_Arduino/07.jpg">
+![image](img/01.png)
+
+&nbsp;
+
+![image](img/02.png)
 
 ### Use Git
 
-*Firstly, make sure git and the Arduino IDE have been installed first. If not, please refer [How to install Git and Arduino](http://docs.heltec.cn/#/en/user_manual/how_to_install_git_and_arduino). When Arduino is installed correctly, you will find a folder in "Username/Documents/Arduino/Library". **this library must in this path!***
+*Firstly, make sure git and the Arduino IDE have been installed first. If not, please refer [How to install Git and Arduino](https://heltec-automation-docs.readthedocs.io/en/latest/general/how_to_install_git_and_arduino.html). When Arduino is installed correctly, you will find a folder in "Username/Documents/Arduino/Library". **this library must in this path!***
 
-Open "Git bash" in path "Username/Documents/Arduino/Library", and input:
+Open "Git bash" in path `Username/Documents/Arduino/Library`, and input:
 
     git clone https://github.com/HelTecAutomation/Heltec_ESP32.git
 
@@ -52,29 +50,32 @@ You will see such a new folder in your library path, install done.
 
 ## How to use this library
 
-**`This library requires the [Heltec ESP32 develop framework](https://github.com/Heltec-Aaron-Lee/WiFi_Kit_series)!`**
+**This library requires the [Heltec ESP32 develop framework](https://github.com/Heltec-Aaron-Lee/WiFi_Kit_series)!**
 
 A detailed step by step instructions to execute some examples available here:
 
-[http://docs.heltec.cn/#/en/user_manual/how_to_install_esp32_Arduino?id=_1-execute-a-example-likes-factorytestino](http://docs.heltec.cn/#/en/user_manual/how_to_install_esp32_Arduino?id=_1-execute-a-example-likes-factorytestino)
+[https://heltec-automation-docs.readthedocs.io/en/latest/esp32/quick_start.html#example](https://heltec-automation-docs.readthedocs.io/en/latest/esp32/quick_start.html#example)
 
 ## API Reference
-[OLED API](https://github.com/HelTecAutomation/Heltec_ESP32/blob/master/src/oled/OLEDDisplay.h)
+[OLED API](src/oled/API.md)
 
 [LoRa API](src/lora/API.md)
 
-## Hardware Reference
+## Relevant Resources
 
-### Pinout Diagram
-[https://github.com/Heltec-Aaron-Lee/WiFi_Kit_series/tree/master/PinoutDiagram](https://github.com/Heltec-Aaron-Lee/WiFi_Kit_series/tree/master/PinoutDiagram)
-### Schematic Diagram
-[https://github.com/Heltec-Aaron-Lee/WiFi_Kit_series/tree/master/SchematicDiagram](https://github.com/Heltec-Aaron-Lee/WiFi_Kit_series/tree/master/SchematicDiagram)
+- [WiFi Kit 32](https://resource.heltec.cn/download/WiFi_Kit_32)
+- [WiFi LoRa 32](https://resource.heltec.cn/download/WiFi_LoRa_32)
+- [Wireless Stick](https://resource.heltec.cn/download/Wireless_Stick)
+- [Wireless Stick Lite](https://resource.heltec.cn/download/Wireless_Stick_Lite)
+- [Wireless Shell](https://resource.heltec.cn/download/Wireless_Shell)
+
+If there is a "Limited" folder in the resources page, it means the product have limited resources that not public by default, refer to this document to download: [Get Limited Technical Resources](https://heltec-automation-docs.readthedocs.io/en/latest/general/view_limited_technical_data.html).
 
 
 #### Note:
-* ESP series chips are faster to download, please make sure to use the high-quality Micro USB cable, it will be easier to download with.
+Please make sure use a high-quality Micro USB cable, it will reduce many problems.
 
-[Summary of common problems](http://www.heltec.cn/summary-of-common-problems-in-wifi-kit-series-continuous-update/?lang=en)
+[Summary of common problems](https://heltec-automation-docs.readthedocs.io/en/latest/esp32/frequently_asked_questions.html)
 
 &nbsp;
 ***
@@ -85,7 +86,7 @@ A detailed step by step instructions to execute some examples available here:
 
 **这个Arduino库必须配合[Heltec ESP32编译环境](https://github.com/Heltec-Aaron-Lee/WiFi_Kit_series)一起使用！完整的“编译环境 + 库”的的教程可以参考这里：**
 
-**[http://docs.heltec.cn/#/en/user_manual/how_to_install_esp32_Arduino](http://docs.heltec.cn/#/en/user_manual/how_to_install_esp32_Arduino)**
+**[https://heltec-automation-docs.readthedocs.io/en/latest/esp32/quick_start.html](https://heltec-automation-docs.readthedocs.io/en/latest/esp32/quick_start.html)**
 
 ***
 
@@ -101,12 +102,7 @@ A detailed step by step instructions to execute some examples available here:
 
 3. [API参考](#API参考)
 
-4. [硬件设计参考](#硬件设计参考)
-
-	- [引脚图](#引脚图)
-
-	- [原理图](#原理图)
-
+4. [相关资源](#相关资源)
 
 ***
 
@@ -117,12 +113,17 @@ A detailed step by step instructions to execute some examples available here:
 ### 通过Arduino库管理器安装
 打开Arduino IDE, 选择`项目`->`加载库`->`管理库...`，打开“库管理器”
 搜索`Heltec ESP32`并安装.
-<img src="http://docs.heltec.cn/img/how_to_install_esp32_Arduino/06.png">
-<img src="http://docs.heltec.cn/img/how_to_install_esp32_Arduino/07.jpg">
+![image](img/01.png)
+
+&nbsp;
+
+![image](img/02.png)
+
+
 
 ### 通过Git进行安装
 
-*首先,请确保`Git`和`Arduino IDE`都已经正确安装。如果没有，请参考这里的安装方法[How to install Git and Arduino](http://docs.heltec.cn/#/en/user_manual/how_to_install_git_and_arduino)。 *
+*首先,请确保`Git`和`Arduino IDE`都已经正确安装。如果没有，请参考这里的安装方法[怎样安装Git和Arduino IDE](https://heltec-automation.readthedocs.io/zh_CN/latest/general/how_to_install_git_and_arduino.html)。 *
 
 **强调一下：这个库的路径必须位于操作系统的“文档/Arduino/libraries”文件夹内！！！文档文件夹是操作系统自带的，必须！必须！必须！**
 
@@ -139,20 +140,21 @@ A detailed step by step instructions to execute some examples available here:
 
 如何运行一个例程？详细的使用指南：:
 
-[http://docs.heltec.cn/#/en/user_manual/how_to_install_esp32_Arduino?id=_1-execute-a-example-likes-factorytestino](http://docs.heltec.cn/#/en/user_manual/how_to_install_esp32_Arduino?id=_1-execute-a-example-likes-factorytestino)
+[https://heltec-automation.readthedocs.io/zh_CN/latest/esp32/quick_start.html#id1](https://heltec-automation.readthedocs.io/zh_CN/latest/esp32/quick_start.html#id1)
 
 ## API参考
-[OLED API](https://github.com/HelTecAutomation/Heltec_ESP32/blob/master/src/oled/OLEDDisplay.h)
+[OLED API](src/oled/API.md)
 
 [LoRa API](src/lora/API.md)
 
-## 硬件设计参考
-
-### 引脚图
-[https://github.com/Heltec-Aaron-Lee/WiFi_Kit_series/tree/master/PinoutDiagram](https://github.com/Heltec-Aaron-Lee/WiFi_Kit_series/tree/master/PinoutDiagram)
-### 原理图
-[https://github.com/Heltec-Aaron-Lee/WiFi_Kit_series/tree/master/SchematicDiagram](https://github.com/Heltec-Aaron-Lee/WiFi_Kit_series/tree/master/SchematicDiagram)
+## 相关资源
 
+- [WiFi Kit 32](https://resource.heltec.cn/download/WiFi_Kit_32)
+- [WiFi LoRa 32](https://resource.heltec.cn/download/WiFi_LoRa_32)
+- [Wireless Stick](https://resource.heltec.cn/download/Wireless_Stick)
+- [Wireless Stick Lite](https://resource.heltec.cn/download/Wireless_Stick_Lite)
+- [Wireless Shell](https://resource.heltec.cn/download/Wireless_Shell)
 
+如果在资源下载页中看到了`Limited`文件夹，表面这个产品有非公开的技术资料。[获取受限资源的方法](https://heltec-automation.readthedocs.io/zh_CN/latest/general/view_limited_technical_data.html)
 
 

examples/ESP32/ADC_Read_Voltage/Battery_power/Battery_power.ino

@@ -26,7 +26,7 @@
 
 #define Fbattery    3700  //The default battery is 3700mv when the battery is fully charged.
 
-float XS = 0.00225;      //The returned reading is multiplied by this XS to get the battery voltage.
+float XS = 0.0025;      //The returned reading is multiplied by this XS to get the battery voltage.
 uint16_t MUL = 1000;
 uint16_t MMUL = 100;
 
@@ -42,10 +42,26 @@ void setup()
 	delay(1000);
 	Heltec.display->clear();
 
-	adcAttachPin(13);
-	analogSetClockDiv(255); // 1338mS
+   //analogSetClockDiv(255); // 1338mS
+   analogSetCycles(8);                   // Set number of cycles per sample, default is 8 and provides an optimal result, range is 1 - 255
+   analogSetSamples(1);                  // Set number of samples in the range, default is 1, it has an effect on sensitivity has been multiplied
+   analogSetClockDiv(1);                 // Set the divider for the ADC clock, default is 1, range is 1 - 255
+   analogSetAttenuation(ADC_11db);       // Sets the input attenuation for ALL ADC inputs, default is ADC_11db, range is ADC_0db, ADC_2_5db, ADC_6db, ADC_11db
+   analogSetPinAttenuation(36,ADC_11db); // Sets the input attenuation, default is ADC_11db, range is ADC_0db, ADC_2_5db, ADC_6db, ADC_11db
+   analogSetPinAttenuation(37,ADC_11db);
+                                        // ADC_0db provides no attenuation so IN/OUT = 1 / 1 an input of 3 volts remains at 3 volts before ADC measurement
+                                        // ADC_2_5db provides an attenuation so that IN/OUT = 1 / 1.34 an input of 3 volts is reduced to 2.238 volts before ADC measurement
+                                        // ADC_6db provides an attenuation so that IN/OUT = 1 / 2 an input of 3 volts is reduced to 1.500 volts before ADC measurement
+                                        // ADC_11db provides an attenuation so that IN/OUT = 1 / 3.6 an input of 3 volts is reduced to 0.833 volts before ADC measurement
+//   adcAttachPin(VP);                     // Attach a pin to ADC (also clears any other analog mode that could be on), returns TRUE/FALSE result 
+//   adcStart(VP);                         // Starts an ADC conversion on attached pin's bus
+//   adcBusy(VP);                          // Check if conversion on the pin's ADC bus is currently running, returns TRUE/FALSE result 
+//   adcEnd(VP);
+   
+   adcAttachPin(36);
+   adcAttachPin(37);
 
-	Serial.begin(115200);
+   Serial.begin(115200);
 }
 
 void loop()
@@ -55,16 +71,37 @@ void loop()
    //Wireless Stick      -- hardare versrion ≥ 2.3
    //Wireless Stick Lite -- hardare versrion ≥ 2.3
    //Battery voltage read pin changed from GPIO13 to GPI37
-   uint16_t c  =  analogRead(37)*XS*MUL;
+   adcStart(37);
+   while(adcBusy(37));
+   Serial.printf("Battery power in GPIO 37: ");
    Serial.println(analogRead(37));
+   uint16_t c1  =  analogRead(37)*XS*MUL;
+   adcEnd(37);
+
+   delay(100);
+
+   adcStart(36);
+   while(adcBusy(36));
+   Serial.printf("voltage input on GPIO 36: ");
+   Serial.println(analogRead(36));
+   uint16_t c2  =  analogRead(36)*0.769 + 150;
+   adcEnd(36);
+   Serial.println("-------------");
    // uint16_t c  =  analogRead(13)*XS*MUL;
    // Serial.println(analogRead(13));
+   Heltec.display->drawString(0, 0, "Vbat = ");
+   Heltec.display->drawString(33, 0, (String)c1);
+   Heltec.display->drawString(60, 0, "(mV)");
 
-   Heltec.display->drawString(0, 0, "Remaining battery still has:");
-   Heltec.display->drawString(0, 10, "VBAT:");
-   Heltec.display->drawString(35, 10, (String)c);
+   Heltec.display->drawString(0, 10, "Vin   = ");
+   Heltec.display->drawString(33, 10, (String)c2);
    Heltec.display->drawString(60, 10, "(mV)");
+
+   // Heltec.display->drawString(0, 0, "Remaining battery still has:");
+   // Heltec.display->drawString(0, 10, "VBAT:");
+   // Heltec.display->drawString(35, 10, (String)c);
+   // Heltec.display->drawString(60, 10, "(mV)");
    Heltec.display->display();
-   delay(2000);
+   delay(5000);
    Heltec.display->clear();
 }

examples/OLED/SSD1306SimpleDemo/images.h

@@ -30,3 +30,6 @@ const unsigned char WiFi_Logo_bits[] PROGMEM = {
 //Added by Sloeber 
 #pragma once
 
+
+//Added by Sloeber 
+#pragma once