View source for KS0566 Keyestudio ENS160 Air Quality Sensor (TVOC, eCO2, AQI)

[[File:KS0566.png|thumb|600px|right|Keyestudio ENS160 Air Quality Sensor]]

<br>
== '''Description''' ==
<br>
Keyestudio ENS160 air quality sensor, originated from ScioSense, reveals indoor air quality by outputting IAQ data (TVOC, eCO2, AQI). Technically, It applies TrueVOC and Metal oxides Technology, featuring splendid accuracy, fast response and anti-interference. 
<br><br>
Algorithms are built in the ENS160 air quality sensor to directly output TVOC, eCO2 and AQI values, hence the quality data is enriched and easy to understand. During using, its preheat time is less than 3 minutes, which makes the sensor quickly get accurate data. What’s more, the algorithm is automatically calibrated by an internal baseline to guarantee its long-term stability.
<br><br>

== '''Features''' ==
<br>
* Multiple IAQ outputs (TVOC, eCO2, AQI), enriching data
<br>
* Preheat time is less than 3min, quickly acquiring data
<br>
* Built-in algorithm, outputting accurate data
<br>
* Automatic calibration baseline, ensuring long-term stability
<br><br>

== '''Parameters''' ==
<br>
{| class="wikitable"
|+ 
|-
| Power Voltage || 3.3 V~5.5 V
|-
| Working Current || 29 mA
|-
| Preheat Time || <3min
|-
| Interface Mode|| I2C
|-
| I2C Address || 0x52; 0x53
|-
| Working Temperature || -10℃~65℃
|-
| Working Humidity || 5 %RH~95 %RH
|-
| eCO2 Detection Range || 400 ppm~65000 ppm
|-
| TVOC Detection Range || 0 ppb~65000 ppb
|-
| Sensor Pin || 5P 2.54mm right angled pin headers
|-
| Wire || 5P 2.54mm DuPont Wire
|-
| Diameter of Hole || 3.2mm
|-
| Dimensions || 30mm*20mm*7.5mm
|-
| Weight || 2.4g
|}
<br>

== '''Pin out''' ==
<br>
'''ENS160 sensor pin description:''' 
<br>[[File:ENS160 sensor pin description.png|800px|frameless]]<br>
<br>
'''ENS160 pin description:''' 
<br>[[File:ENS160 pin description.png|800px|frameless]]<br>
<br>
Pin 3 on ENS160 sensor is for I2C address selection (SPI master input slave output). When I2C ADDR pin is at high level, it selects 0x53; when it is at low, the address becomes 0x52. Herein, our I2C ADDR pin is designed at high, so the I2C address is 0x53 by default. 
<br><br>
Besides, this sensor includes empty pads(pulled down by I2C ADDR pin) and ADDR pin, which are able to alter the I2C address. Here are procedures: 
* '''Method 1''': Weld a 0Ω resistor packaged in 0603 at the empty pad(as below), and modify the address to 0x52 in example code “getMeasureData.ino”.
<br>[[File:截图20230824142304.png|800px|frameless]]<br>
<br>[[File:图4.4.png|800px|frameless]]<br>
<br>
* '''Method 2''': Connect ADDR pin to GND on mainboard(as below), and also modify the address to 0x52 in that example code.
<br>[[File:截图20230824142614.png|800px|frameless]]<br>

For more, please refer to Specifications of ENS160.
<br><br>

== '''Air Quality Reference''' ==
<br>
=== '''Air quality index (AQI) grade''' ===
<br>[[File:Air quality index (AQI) grade.png|800px|frameless]]<br>

=== '''Carbon dioxide (eCO2/CO2) concentration''' ===
<br>[[File:Carbon dioxide concentration.png|800px|frameless]]<br>

=== '''Total volatile organic compounds (TVOC) concentration''' ===
<br>[[File:Total volatile organic compounds concentration.png|800px|frameless]]<br>
<br>

== '''Shamanistic Diagram''' ==
<br>[[File:Shamanistic Diagram.png|800px|frameless]]<br>
<br>

== '''Dimensions''' ==
<br>[[File:0566Dimensions.png|800px|frameless]]<br>
<br>

== '''Arduino Tutorial''' ==
<br>
=== '''Hardware Requirement''' ===
<br>
* Keyestudio Arduino UNO R3 main control board X1
<br>
* ENS160 air quality sensor X1
<br>
* M-F DuPont wire: many
<br><br>
=== '''Software Requirement''' ===
<br>
Arduino IDE 2.0.4
<br><br>
Download Arduino IDE. Please refer to Arduino official website: https://www.arduino.cc/
<br><br>

=== '''Wiring Diagram''' ===
<br>
Wire up according to the following diagram, and connect the mainboard to your computer via USB cable.
<br>[[File:8.3 Wiring Diagram.png|800px|frameless]]<br>
Open Arduino IDE 2.0.4, and check whether the port is selected. If not, please the installation of the driver. 
<br><br>
Select the port.
<br>[[File:Select the port..png|800px|frameless]]<br>
<br>
'''Note''': If you want to connect to other boards, please link with the corresponding SCL or SDA interface.
<br><br>

=== '''Example Code''' ===
<br>[[File:8.4 Example Code.png|800px|frameless]]<br>

Open example code getMeasureData.ino. It is not recommended to copy and paste the following text to Arduino IDE and upload it, as errors may occur due to wrong format. <br>
Thus, please find the library file to load the code on Arduino.
<br><br>

'''Complete code:'''
<br>
 /******************************************************************************
 #include <DFRobot_ENS160.h>
 #define I2C_COMMUNICATION  //use I2C for communication. To use SPI to communicate, you need to invalidate this line code
 #ifdef  I2C_COMMUNICATION
   /**
    *   Fermion version: I2C address is 0x53 by default. Connect SDO pin to GND, I2C address becomes 0x52
    */
   DFRobot_ENS160_I2C ENS160(&Wire, /*iicAddr*/ 0x53);#else
   uint8_t csPin = D3;
   DFRobot_ENS160_SPI ENS160(&SPI, csPin);#endif
 void setup(void){
   Serial.begin(115200);
 
   // Initialization
   while( NO_ERR != ENS160.begin() ){
     Serial.println("Communication with device failed, please check connection");
     delay(3000);
   }
 
   /**
    * Set power mode
    * mode: Configurable power mode
    *   ENS160_SLEEP_MODE: DEEP SLEEP mode (low power standby)
    *   ENS160_IDLE_MODE: IDLE mode (No data measurement)
    *   ENS160_STANDARD_MODE: STANDARD Gas Sensing Modes
    */
   ENS160.setPWRMode(ENS160_STANDARD_MODE);
 
   /**
    * Set temperature and humidity parameter to measure the calibration compensation of data
    * temperature: current temperature value, float, °C
    * humidity: current ambient humidity, float, %rH
    */
   ENS160.setTempAndHum(/*temperature=*/25.0, /*humidity=*/50.0);
 }
 void loop(){
   /**
    * Acquire the sensor status
    * Output: 0-Normal operation, 
    *       1-Warm-Up phase, During first 3 minutes after power-on.
    *       2-Initial Start-Up phase, During first full hour of operation after initial power-on.Only once in the sensor’s lifetime.
    *           Note that the status will only be stored in the non-volatile memory after an initial 24h of continuous
    *           operation. If unpowered before conclusion of said period, the ENS160 will resume "Initial Start-up" mode
    *           after re-powering.
    */
   uint8_t Status = ENS160.getENS160Status();
   Serial.print("传感器运行状态 : ");
   Serial.println(Status);
   /**
    * Acquire air quality index
    * Output: 1-Excellent, 2-Good, 3-Moderate, 4-Poor, 5-Unhealthy
    */
   uint8_t AQI = ENS160.getAQI();
   Serial.print("Air quality index : ");
   Serial.println(AQI);
 
   /**
    * Acquire TVOC
    * Output:  0~65000, ppb
    */
   uint16_t TVOC = ENS160.getTVOC();
   Serial.print("Concentration of total volatile organic compounds : ");
   Serial.print(TVOC);
   Serial.println(" ppb");
 
   /**
    * Acquire eCO2
    * Output: 400~65000, ppm
    */
   uint16_t ECO2 = ENS160.getECO2();
   Serial.print("Carbon dioxide equivalent concentration : ");
   Serial.print(ECO2);
   Serial.println(" ppm");
 
   Serial.println();
   delay(1000);
 *********************************************************************/
<br>
'''Note''': Ambient temperature and humidity impact the accuracy of detection, please fill current values in the following function: 
<br>
setTempAndHum(/*temperature=*/temp, /*humidity=*/hum);
<br>[[File:图8.4.1.png|800px|frameless]]<br>
ENS160 sensor pulls up I2C ADDR pin so the address is 0x53. If you want to alter it to 0x52, please refer to Section '''''4. Pin out'''''.
<br>[[File:图8.4.2.png|800px|frameless]]<br>
<br>

=== '''Test Result''' ===
<br>
Upload code on UNO R3 board via Arduino IDE, and open the serial monitor to set the baud rate to 115200. We will see that sensor status, AQI Grade, TVOC and eCO2 concentration are printed on it:
<br>[[File:RFG`F2-J3G SK2JLQ-FK8@X.png|800px|frameless]]<br>
<br>

== '''Troubleshooting''' ==
<br>
(1) The port cannot be recognized
<br>
Please check whether the driver is installed or port is in poor conduct. Try to change a USB cable.
<br><br>
(2) Error occurs during compiling
<br>
Please select the correct development board. Please import library first as needed.
<br><br>
(3) Copy and paste the text code to Arduino IDE, format may be wrong when uploading. Please open and upload code in library file.
<br>