Start sensing the world around you with Nicla Sense Env. The board combines three state-of-the-art sensors from Renesas® with the simplicity of integration and scalability of the Arduino ecosystem. Expand your Portenta, MKR, or Nano projects by adding a Nicla Sense Env. In addition to its ultra-low power temperature and humidity sensor, it integrates two state-of-the-art, industrial-grade gas sensors, able to evaluate air quality in indoor and outdoor environments.
- - -# Target Areas: -Industrial automation, building automation, prototyping - -# CONTENTS - -## Application Examples - -The Arduino Nicla Sense Env, when combined with Portenta, MKR, or Nano family boards, provides a versatile solution for various sectors. Below are some application examples that demonstrate its transformative potential: - -- **Industrial automation**: The Nicla Sense Env enhances industrial automation by providing precise monitoring and control capabilities, ensuring safety, efficiency, and environmental compliance in various processes. - - **Heat pump machines**: When combined with a Portenta family board, the Nicla Sense Env can be easily installed into any heat pump to properly monitor air quality, temperature, and humidity, both indoors and outdoors. This allows users to adjust the thermostat, set temperature schedules, and review energy consumption and air quality at any time. - - **Industrial processes toxic substances detection**: The Nicla Sense Env can be easily implemented in multiple industrial processes to detect the presence of poisonous substances or gas leakages, such as volatile organic compounds (VOCs), hydrocarbons, CO2, and hydrogen. The data can then be transmitted to the connected Portenta, MKR, or Nano family board to provide real-time alarms. -- **Prototyping**: The Nicla Sense Env offers a ready-to-use solution for developers working on prototypes, integrating various environmental sensors to expedite development. - - **Ready-to-use environmental monitoring prototyping solution**: The Nicla Sense Env is a valuable tool for Portenta, MKR, and Nano family board developers working on prototypes, integrating ready-to-use sensors such as temperature, humidity, and gas sensors. -- **Building automation**: In building automation, the Nicla Sense Env facilitates the creation of intelligent systems that improve comfort, safety, and energy efficiency. - - **Climate control systems**: Integrate a Nicla Sense Env into your HVAC, air conditioning, or ventilation system to accurately measure air quality, humidity, and temperature. This ensures compliance with environmental regulations inside your smart building and increases tenant comfort. - - **Automated air purifier**: With its embedded sensing capabilities, the Nicla Sense Env provides a comprehensive solution for air purifier systems in smart buildings and offices, saving energy and helping to maintain user health and wellness. - - **Fumes and fire detection**: The effects of fire, smoke, and fumes can be catastrophic in various environments. By incorporating intelligent gas sensors with onboard Artificial Intelligence (AI), the Nicla Sense Env can detect the presence of indoor and outdoor carbon dioxide, notifying authorities for timely intervention. - -## Features -### General Specifications Overview - --The Nicla Sense Env is a compact, powerful board for environmental sensing applications. It integrates two advanced state-of-the-art, industrial-grade gas sensors, and the Renesas R7FA2E1A92DNH microcontroller, making it ideal for monitoring air quality, temperature, and humidity in various environments. -
- -The main features are highlighted in the table shown below. - -| **Feature** | **Description** | -|-----------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| Microcontroller | 48 MHz, Arm® Cortex® M23 (not accessible or programmable by the user) | -| Internal Memory | 128 kB Flash and 16 kB SRAM | -| Power Supply | Various options for easily powering the board: Using the power supply of the connected Portenta, MKR, or Nano board and using an external power supply connected through the board's header connector pins (VCC pin) | -| Analog Peripherals | 12-bit ADC (x2) | -| Digital Peripherals | UART (x1), I2C (x1), SPI (x1) | -| Onboard Humidity and Temperature Sensor | Renesas HS4001 | -| Onboard Indoor Air Quality Sensor | Renesas ZMOD4410AI1V (total volatile organic compounds, CO2, and indoor air quality) | -| Onboard Outdoor Air Quality Sensor | Renesas ZMOD4510AI1V (nitrogen dioxide, ozone, and outdoor air quality) | -| Dimensions | 22.86 mm x 22.86 mm | -| Weight | 2 g | -| Pinout features | Castellated pins allow the board to be SMD soldered on a custom board or carrier | - - - -### Accessories - -- ESLOV cable (included) -- 12-pin P-MOD header connector (not included, P/N: TSM-106-01-L-DH-TR) - -### Related Products - -- Arduino Portenta C33 (SKU: ABX00074) -- Arduino Portenta H7 (SKU: ABX00042) -- Arduino Portenta H7 Lite (SKU: ABX00045) -- Arduino Portenta H7 Lite Connected (SKU: ABX00046) -- Arduino MKR WiFi 1010 (SKU: ABX00023) -- Arduino MKR WAN 1310 (SKU: ABX00029) -- Arduino MKR Zero (SKU: ABX00012) -- Arduino MKR NB 1500 (SKU: ABX00019) -- Arduino Nano 33 BLE (SKU: ABX00030) -- Arduino Nano 33 BLE Rev2 (SKU: ABX00071) -- Arduino Nano 33 BLE Sense (SKU: ABX00031) -- Arduino Nano 33 BLE Sense Rev2 (SKU: ABX00069) -- Arduino Nano 33 IoT (SKU: ABX00027) -- Arduino Nano ESP32 (SKU: ABX00092) -- Arduino Nano Every (SKU: ABX00028) -- Arduino Nano RP2040 Connect (SKU: ABX00052) -- Arduino UNO R4 Minima (SKU: ABX00080) -- Arduino UNO R4 WiFi (SKU: ABX00087) -- Arduino Zero (SKU: ABX00003) - - - -## Ratings - -### Recommended Operating Conditions - --The table below provides a comprehensive guideline for the optimal use of the Nicla Sense Env, outlining typical operating conditions and design limits. The operating conditions of the Nicla Sense Env are largely based on the specifications of its components. -
- -Tip: To put the Nicla Sense Env in deep sleep mode, use the API provided by the Nicla Sense Env Arduino library.
-Safety Note: The Nicla Sense Env board operates at 3.3 VDC, and while its pins are 5 VDC tolerant, we recommend using a level translator when connecting it to 5 VDC-compatible Arduino boards to ensure safe communication and prevent potential damage to the components. This connection can be made either through the Nicla Sense Env’s ESLOV connector or its dedicated I2C pins (I2C0).
--The core of the Nicla Sense Env is the R7FA2E1A92DNH microcontroller from Renesas. The board also contains several sensors and user-programmable LEDs connected to its microcontroller, such as a relative humidity and temperature sensor, indoor and outdoor air quality sensors, and two LEDs, one orange and one RGB LED, available for the user. -
- -### Pinout - -The Nicla Sense Env connectors pinout is shown in the figure below. - - - - - -### Block Diagram - -An overview of the high-level architecture of the Nicla Sense Env is illustrated in the figure below. - - - - - -### Power Supply - --The Nicla Sense Env is a double-sided 28.86 mm x 28.86 mm board with an ESLOV connector overhanging the bottom edge and dual castellated/through-hole pins around two of the four edges of the board. -
- -### Board Dimensions - -The Nicla Sense Env board outline is shown in the figure below; all the dimensions are in mm. - - - --The Nicla Sense Env does not have mounting holes for mechanical fixing. The slots found in the board were placed because of the board's sensor requirements and specifications. -
- - - -### Board Connectors - --The ESLOV connector of the Nicla Sense Env is placed on the bottom side of the board; its placement is shown in the figure below; all the dimensions are in mm. -
- - - --The Nicla Sense Env was designed to be usable as a surface-mount module and presents a dual inline package (DIP) format with the MKR-styled header connectors on a 2.54 mm pitch grid with 1 mm holes. -
- - - -### Board Peripherals and Actuators - --The Nicla Sense Env has one reset button and two LEDs, an orange and an RGB LED, available for the user; the reset button, the orange LED, and the RGB LED are placed on the top side of the board. The placement of these components is shown in the figure below; all the dimensions are in mm. -
- - - - - -## Product Compliance - -### Product Compliance Summary - -| **Product Compliance** | -|:----------------------:| -| CE (European Union) | -| RoHS | -| REACH | -| WEEE | -| VCCI (Japan) | - -### Japan VCCI Statement - --This is a VCCI Class B compliant product. -
- -### Declaration of Conformity CE DoC (EU) - --We declare under our sole responsibility that the products above are in conformity with the essential requirements of the following EU Directives and therefore qualify for free movement within markets comprising the European Union (EU) and European Economic Area (EEA). -
- -### Declaration of Conformity to EU RoHS & REACH 211 01/19/2021 - --Arduino boards are in compliance with RoHS 2 Directive 2011/65/EU of the European Parliament and RoHS 3 Directive 2015/863/EU of the Council of 4 June 2015 on the restriction of the use of certain hazardous substances in electrical and electronic equipment. -
- -| **Substance** | **Maximum Limit (ppm)** | -|----------------------------------------|-------------------------| -| Lead (Pb) | 1000 | -| Cadmium (Cd) | 100 | -| Mercury (Hg) | 1000 | -| Hexavalent Chromium (Cr6+) | 1000 | -| Poly Brominated Biphenyls (PBB) | 1000 | -| Poly Brominated Diphenyl ethers (PBDE) | 1000 | -| Bis(2-Ethylhexyl) phthalate (DEHP) | 1000 | -| Benzyl butyl phthalate (BBP) | 1000 | -| Dibutyl phthalate (DBP) | 1000 | -| Diisobutyl phthalate (DIBP) | 1000 | - - - -Exemptions: No exemptions are claimed. - --Arduino Boards are fully compliant with the related requirements of European Union Regulation (EC) 1907 /2006 concerning the Registration, Evaluation, Authorization and Restriction of Chemicals (REACH). We declare none of the SVHCs (https://echa.europa.eu/web/guest/candidate-list-table), the Candidate List of Substances of Very High Concern for authorization currently released by ECHA, is present in all products (and also package) in quantities totaling in a concentration equal or above 0.1%. To the best of our knowledge, we also declare that our products do not contain any of the substances listed on the "Authorization List" (Annex XIV of the REACH regulations) and Substances of Very High Concern (SVHC) in any significant amounts as specified by the Annex XVII of Candidate list published by ECHA (European Chemical Agency) 1907 /2006/EC. -
- -### Conflict Minerals Declaration - --As a global supplier of electronic and electrical components, Arduino is aware of our obligations concerning laws and regulations regarding Conflict Minerals, specifically the Dodd-Frank Wall Street Reform and Consumer Protection Act, Section 1502. Arduino does not directly source or process conflict minerals such as Tin, Tantalum, Tungsten, or Gold. Conflict minerals are contained in our products in the form of solder, or as a component in metal alloys. As part of our reasonable due diligence, Arduino has contacted component suppliers within our supply chain to verify their continued compliance with the regulations. Based on the information received thus far we declare that our products contain Conflict Minerals sourced from conflict-free areas. -
- -## Company Information - -| **Company Information** | **Details** | -|-------------------------|--------------------------------------------| -| **Company Name** | Arduino S.r.l. | -| **Company Address** | Via Andrea Appiani, 25-20900 Monza (Italy) | - -## Reference Documentation - -| **No.** | **Reference** | **Link** | -|:-------:|-------------------------------------------|------------------------------------------------------------| -| 1 | Arduino IDE (Desktop) | https://www.arduino.cc/en/Main/Software | -| 2 | Arduino IDE (Cloud) | https://create.arduino.cc/editor | -| 3 | Arduino Cloud - Getting Started | https://docs.arduino.cc/arduino-cloud/guides/overview/ | -| 4 | Arduino_NiclaSenseEnv Library | https://github.com/arduino-libraries/Arduino_NiclaSenseEnv | -| 5 | Arduino_NiclaSenseEnv MicroPython Library | https://github.com/arduino/arduino-nicla-sense-env-mpy/ | -| 6 | Nicla Sense Env Documentation | https://docs.arduino.cc/hardware/nicla-sense-env/ | -| 7 | Project Hub | https://create.arduino.cc/projecthub | -| 8 | Library Reference | https://www.arduino.cc/reference/en/ | -| 9 | Online Store | https://store.arduino.cc/ | - -## Document Revision History - -| **Date** | **Revision** | **Changes** | -|:----------:|:------------:|:------------------------------------------------------:| -| 14/01/2025 | 2 | Update on Product Compliance with Japan VCCI Statement | +--- +identifier: ABX00089 +title: Arduino® Nicla Sense Env +type: pro +variant: 'Datasheet' +author: José Bagur +--- + + +# Description +Start sensing the world around you with Nicla Sense Env. The board combines three state-of-the-art sensors from Renesas® with the simplicity of integration and scalability of the Arduino ecosystem. Expand your Portenta, MKR, or Nano projects by adding a Nicla Sense Env. In addition to its ultra-low power temperature and humidity sensor, it integrates two state-of-the-art, industrial-grade gas sensors, able to evaluate air quality in indoor and outdoor environments.
+ + +# Target Areas: +Industrial automation, building automation, prototyping + +# CONTENTS + +## Application Examples + +The Arduino Nicla Sense Env, when combined with Portenta, MKR, or Nano family boards, provides a versatile solution for various sectors. Below are some application examples that demonstrate its transformative potential: + +- **Industrial automation**: The Nicla Sense Env enhances industrial automation by providing precise monitoring and control capabilities, ensuring safety, efficiency, and environmental compliance in various processes. + - **Heat pump machines**: When combined with a Portenta family board, the Nicla Sense Env can be easily installed into any heat pump to properly monitor air quality, temperature, and humidity, both indoors and outdoors. This allows users to adjust the thermostat, set temperature schedules, and review energy consumption and air quality at any time. + - **Industrial processes toxic substances detection**: The Nicla Sense Env can be easily implemented in multiple industrial processes to detect the presence of poisonous substances or gas leakages, such as volatile organic compounds (VOCs), hydrocarbons, CO2, and hydrogen. The data can then be transmitted to the connected Portenta, MKR, or Nano family board to provide real-time alarms. +- **Prototyping**: The Nicla Sense Env offers a ready-to-use solution for developers working on prototypes, integrating various environmental sensors to expedite development. + - **Ready-to-use environmental monitoring prototyping solution**: The Nicla Sense Env is a valuable tool for Portenta, MKR, and Nano family board developers working on prototypes, integrating ready-to-use sensors such as temperature, humidity, and gas sensors. +- **Building automation**: In building automation, the Nicla Sense Env facilitates the creation of intelligent systems that improve comfort, safety, and energy efficiency. + - **Climate control systems**: Integrate a Nicla Sense Env into your HVAC, air conditioning, or ventilation system to accurately measure air quality, humidity, and temperature. This ensures compliance with environmental regulations inside your smart building and increases tenant comfort. + - **Automated air purifier**: With its embedded sensing capabilities, the Nicla Sense Env provides a comprehensive solution for air purifier systems in smart buildings and offices, saving energy and helping to maintain user health and wellness. + - **Fumes and fire detection**: The effects of fire, smoke, and fumes can be catastrophic in various environments. By incorporating intelligent gas sensors with onboard Artificial Intelligence (AI), the Nicla Sense Env can detect the presence of indoor and outdoor carbon dioxide, notifying authorities for timely intervention. + +## Features +### General Specifications Overview + ++The Nicla Sense Env is a compact, powerful board for environmental sensing applications. It integrates two advanced state-of-the-art, industrial-grade gas sensors, and the Renesas R7FA2E1A92DNH microcontroller, making it ideal for monitoring air quality, temperature, and humidity in various environments. +
+ +The main features are highlighted in the table shown below. + +| **Feature** | **Description** | +|-----------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Microcontroller | 48 MHz, Arm® Cortex® M23 (not accessible or programmable by the user) | +| Internal Memory | 128 kB Flash and 16 kB SRAM | +| Power Supply | Various options for easily powering the board: Using the power supply of the connected Portenta, MKR, or Nano board and using an external power supply connected through the board's header connector pins (VCC pin) | +| Analog Peripherals | 12-bit ADC (x2) | +| Digital Peripherals | UART (x1), I2C (x1), SPI (x1) | +| Onboard Humidity and Temperature Sensor | Renesas HS4001 | +| Onboard Indoor Air Quality Sensor | Renesas ZMOD4410AI1V (total volatile organic compounds, CO2, and indoor air quality) | +| Onboard Outdoor Air Quality Sensor | Renesas ZMOD4510AI1V (nitrogen dioxide, ozone, and outdoor air quality) | +| Dimensions | 22.86 mm x 22.86 mm | +| Weight | 2 g | +| Pinout features | Castellated pins allow the board to be SMD soldered on a custom board or carrier | + + + +### Accessories + +- ESLOV cable (included) +- 12-pin P-MOD header connector (not included, P/N: TSM-106-01-L-DH-TR) + +### Related Products + +- Arduino Portenta C33 (SKU: ABX00074) +- Arduino Portenta H7 (SKU: ABX00042) +- Arduino Portenta H7 Lite (SKU: ABX00045) +- Arduino Portenta H7 Lite Connected (SKU: ABX00046) +- Arduino MKR WiFi 1010 (SKU: ABX00023) +- Arduino MKR WAN 1310 (SKU: ABX00029) +- Arduino MKR Zero (SKU: ABX00012) +- Arduino MKR NB 1500 (SKU: ABX00019) +- Arduino Nano 33 BLE (SKU: ABX00030) +- Arduino Nano 33 BLE Rev2 (SKU: ABX00071) +- Arduino Nano 33 BLE Sense (SKU: ABX00031) +- Arduino Nano 33 BLE Sense Rev2 (SKU: ABX00069) +- Arduino Nano 33 IoT (SKU: ABX00027) +- Arduino Nano ESP32 (SKU: ABX00092) +- Arduino Nano Every (SKU: ABX00028) +- Arduino Nano RP2040 Connect (SKU: ABX00052) +- Arduino UNO R4 Minima (SKU: ABX00080) +- Arduino UNO R4 WiFi (SKU: ABX00087) +- Arduino Zero (SKU: ABX00003) + + + +## Ratings + +### Recommended Operating Conditions + ++The table below provides a comprehensive guideline for the optimal use of the Nicla Sense Env, outlining typical operating conditions and design limits. The operating conditions of the Nicla Sense Env are largely based on the specifications of its components. +
+ +
+1 Power input through the IN pin, regulated to +3.3 VDC by the onboard voltage regulator.
+
+2 Direct +3.3 VDC power input through the OUT pin, bypassing the onboard voltage regulator.
+
Power Tip: To put the Nicla Sense Env in deep sleep mode, use the API provided by the Nicla Sense Env Arduino library.
+Safety Note: The Nicla Sense Env board operates at +3.3 VDC, and while its pins are +5 VDC tolerant, we recommend using a level translator when connecting it to +5 VDC-compatible Arduino boards to ensure safe communication and prevent potential damage to the components. This connection can be made either through the Nicla Sense Env's ESLOV connector or its dedicated I2C pins (I2C0).
++The core of the Nicla Sense Env is the R7FA2E1A92DNH microcontroller from Renesas. The board also contains several sensors and user-programmable LEDs connected to its microcontroller, such as a relative humidity and temperature sensor, indoor and outdoor air quality sensors, and two LEDs, one orange and one RGB LED, available for the user. +
+ +### Pinout + +The Nicla Sense Env connectors pinout is shown in the figure below. + + + + + +### Block Diagram + +An overview of the high-level architecture of the Nicla Sense Env is illustrated in the figure below. + + + + + +### Power Supply + +IN pin and +3.3 VDC for the OUT pin. Voltages outside these ranges will permanently damage the board. Neither pin has reverse polarity protection; always verify all connections before applying power.
++The Nicla Sense Env is a double-sided 28.86 mm x 28.86 mm board with an ESLOV connector overhanging the bottom edge and dual castellated/through-hole pins around two of the four edges of the board. +
+ +### Board Dimensions + +The Nicla Sense Env board outline is shown in the figure below; all the dimensions are in mm. + + + ++The Nicla Sense Env does not have mounting holes for mechanical fixing. The slots found in the board were placed because of the board's sensor requirements and specifications. +
+ + + +### Board Connectors + ++The ESLOV connector of the Nicla Sense Env is placed on the bottom side of the board; its placement is shown in the figure below; all the dimensions are in mm. +
+ + + ++The Nicla Sense Env was designed to be usable as a surface-mount module and presents a dual inline package (DIP) format with the MKR-styled header connectors on a 2.54 mm pitch grid with 1 mm holes. +
+ + + +### Board Peripherals and Actuators + ++The Nicla Sense Env has one reset button and two LEDs, an orange and an RGB LED, available for the user; the reset button, the orange LED, and the RGB LED are placed on the top side of the board. The placement of these components is shown in the figure below; all the dimensions are in mm. +
+ + + + + +## Product Compliance + +### Product Compliance Summary + +| **Product Compliance** | +|:----------------------:| +| CE (European Union) | +| RoHS | +| REACH | +| WEEE | +| VCCI (Japan) | + +### Japan VCCI Statement + ++This is a VCCI Class B compliant product. +
+ +### Declaration of Conformity CE DoC (EU) + ++We declare under our sole responsibility that the products above are in conformity with the essential requirements of the following EU Directives and therefore qualify for free movement within markets comprising the European Union (EU) and European Economic Area (EEA). +
+ +### Declaration of Conformity to EU RoHS & REACH 211 01/19/2021 + ++Arduino boards are in compliance with RoHS 2 Directive 2011/65/EU of the European Parliament and RoHS 3 Directive 2015/863/EU of the Council of 4 June 2015 on the restriction of the use of certain hazardous substances in electrical and electronic equipment. +
+ +| **Substance** | **Maximum Limit (ppm)** | +|----------------------------------------|-------------------------| +| Lead (Pb) | 1000 | +| Cadmium (Cd) | 100 | +| Mercury (Hg) | 1000 | +| Hexavalent Chromium (Cr6+) | 1000 | +| Poly Brominated Biphenyls (PBB) | 1000 | +| Poly Brominated Diphenyl ethers (PBDE) | 1000 | +| Bis(2-Ethylhexyl) phthalate (DEHP) | 1000 | +| Benzyl butyl phthalate (BBP) | 1000 | +| Dibutyl phthalate (DBP) | 1000 | +| Diisobutyl phthalate (DIBP) | 1000 | + + + +Exemptions: No exemptions are claimed. + ++Arduino Boards are fully compliant with the related requirements of European Union Regulation (EC) 1907 /2006 concerning the Registration, Evaluation, Authorization and Restriction of Chemicals (REACH). We declare none of the SVHCs (https://echa.europa.eu/web/guest/candidate-list-table), the Candidate List of Substances of Very High Concern for authorization currently released by ECHA, is present in all products (and also package) in quantities totaling in a concentration equal or above 0.1%. To the best of our knowledge, we also declare that our products do not contain any of the substances listed on the "Authorization List" (Annex XIV of the REACH regulations) and Substances of Very High Concern (SVHC) in any significant amounts as specified by the Annex XVII of Candidate list published by ECHA (European Chemical Agency) 1907 /2006/EC. +
+ +### Conflict Minerals Declaration + ++As a global supplier of electronic and electrical components, Arduino is aware of our obligations concerning laws and regulations regarding Conflict Minerals, specifically the Dodd-Frank Wall Street Reform and Consumer Protection Act, Section 1502. Arduino does not directly source or process conflict minerals such as Tin, Tantalum, Tungsten, or Gold. Conflict minerals are contained in our products in the form of solder, or as a component in metal alloys. As part of our reasonable due diligence, Arduino has contacted component suppliers within our supply chain to verify their continued compliance with the regulations. Based on the information received thus far we declare that our products contain Conflict Minerals sourced from conflict-free areas. +
+ +## Company Information + +| **Company Information** | **Details** | +|-------------------------|--------------------------------------------| +| **Company Name** | Arduino S.r.l. | +| **Company Address** | Via Andrea Appiani, 25-20900 Monza (Italy) | + +## Reference Documentation + +| **No.** | **Reference** | **Link** | +|:-------:|-------------------------------------------|------------------------------------------------------------| +| 1 | Arduino IDE (Desktop) | https://www.arduino.cc/en/Main/Software | +| 2 | Arduino IDE (Cloud) | https://create.arduino.cc/editor | +| 3 | Arduino Cloud - Getting Started | https://docs.arduino.cc/arduino-cloud/guides/overview/ | +| 4 | Arduino_NiclaSenseEnv Library | https://github.com/arduino-libraries/Arduino_NiclaSenseEnv | +| 5 | Arduino_NiclaSenseEnv MicroPython Library | https://github.com/arduino/arduino-nicla-sense-env-mpy/ | +| 6 | Nicla Sense Env Documentation | https://docs.arduino.cc/hardware/nicla-sense-env/ | +| 7 | Project Hub | https://create.arduino.cc/projecthub | +| 8 | Library Reference | https://www.arduino.cc/reference/en/ | +| 9 | Online Store | https://store.arduino.cc/ | + +## Document Revision History + +| **Date** | **Revision** | **Changes** | +|:----------:|:------------:|:------------------------------------------------------:| +| 14/01/2025 | 2 | Update on Product Compliance with Japan VCCI Statement | | 10/10/2024 | 1 | First release | \ No newline at end of file diff --git a/content/hardware/06.nicla/boards/nicla-sense-env/tutorials/01.user-manual/assets/user-manual-5.png b/content/hardware/06.nicla/boards/nicla-sense-env/tutorials/01.user-manual/assets/user-manual-5.png index 6924b40a90..33e9ddebb5 100644 Binary files a/content/hardware/06.nicla/boards/nicla-sense-env/tutorials/01.user-manual/assets/user-manual-5.png and b/content/hardware/06.nicla/boards/nicla-sense-env/tutorials/01.user-manual/assets/user-manual-5.png differ diff --git a/content/hardware/06.nicla/boards/nicla-sense-env/tutorials/01.user-manual/content.md b/content/hardware/06.nicla/boards/nicla-sense-env/tutorials/01.user-manual/content.md index 2260fc9668..62b925f45e 100644 --- a/content/hardware/06.nicla/boards/nicla-sense-env/tutorials/01.user-manual/content.md +++ b/content/hardware/06.nicla/boards/nicla-sense-env/tutorials/01.user-manual/content.md @@ -1,1119 +1,1132 @@ ---- -title: 'Nicla Sense Env User Manual' -difficulty: beginner -compatible-products: [nicla-sense-env] -description: 'Learn about the hardware and software features of the Arduino® Nicla Sense Env.' -tags: - - RGB - - Sensors - - Cheat sheet - - User manual -author: 'José Bagur' -hardware: - - hardware/06.nicla/boards/nicla-sense-env -software: - - ide-v1 - - ide-v2 - - iot-cloud - - web-editor ---- - -This user manual provides a comprehensive overview of the Nicla Sense Env board, highlighting its hardware and software elements. With it, you will learn how to set up, configure, and use all the main features of a Nicla Sense Env board. - - - -## Hardware and Software Requirements - -### Hardware Requirements - -- [Nicla Sense Env](https://store.arduino.cc/products/nicla-sense-env) (x1) -- [Portenta C33](https://store.arduino.cc/products/portenta-c33) (x1) -- [USB-C® cable](https://store.arduino.cc/products/usb-cable2in1-type-c) (x1) - -### Software Requirements - -- [Arduino IDE 2.0+](https://www.arduino.cc/en/software) or [Arduino Web Editor](https://create.arduino.cc/editor) -- [Arduino_NiclaSenseEnv library](https://github.com/arduino-libraries/Arduino_NiclaSenseEnv) -- [Arduino Renesas Portenta Boards core](https://github.com/arduino/ArduinoCore-renesas) (required to work with the Portenta C33 board) - -***The Nicla Sense Env board is not intended as a standalone device but as a shield to work alongside a Portenta, MKR, or Nano family board. In this user manual, we will use the Portenta C33 as the main board and show how to use the Nicla Sense Env board as a shield.*** - -## Nicla Sense Env Overview - -Enhance your environmental sensing capabilities with the Nicla Sense Env board. This board combines three cutting-edge sensors from Renesas® with the Arduino ecosystem's ease of integration and scalability. This board is well-suited for augmenting your Portenta or MKR-based projects with environmental sensing capabilities. - - - -The Nicla Sense Env includes an ultra-low power temperature and humidity sensor, complemented by two sophisticated industrial-grade gas sensors capable of assessing air quality in indoor and outdoor settings. Its compact dimensions (22.86 x 22.86 mm) and sturdy build make the Nicla Sense Env an excellent choice for projects that demand sensor fusion and the computational capabilities of Arduino boards. - -### Nicla Sense Env Architecture Overview - -The Nicla Sense Env features a secure, certified, and durable design that suits various applications, such as industrial automation, building automation, and prototyping. - -The top view of the Nicla Sense Env board is shown in the image below: - - - -The bottom view of the Nicla Sense Env board is shown in the image below: - - - -Here's an overview of the board's main components shown in the images above: - -- **Microcontroller**: At the heart of the Nicla Sense Env is a [Renesas RA2E1 microcontroller](https://www.renesas.com/us/en/products/microcontrollers-microprocessors/ra-cortex-m-mcus/ra2e1-48mhz-arm-cortex-m23-entry-level-general-purpose-microcontroller). This entry-level single-chip microcontroller, known as one of the industry's most energy-efficient ultra-low-power microcontroller, is based on a 48 MHz Arm® Cortex®-M23 core with up to 128 KB code flash and 16 KB SRAM memory. -- **Onboard humidity and temperature sensor**: The Nicla Sense Env features an onboard humidity and temperature sensor, the [HS4001 from Renesas](https://www.renesas.com/us/en/products/sensor-products/environmental-sensors/humidity-temperature-sensors/hs4001-relative-humidity-and-temperature-sensor-digital-output-15-rh). This highly accurate, ultra-low power, fully calibrated relative humidity and temperature sensor features proprietary sensor-level protection, ensuring high reliability and long-term stability. -- **Onboard indoor air quality sensor**: The Nicla Sense Env features an onboard gas sensor, the [ZMOD4410 from Renesas](https://www.renesas.com/us/en/document/dst/zmod4410-datasheet). This sophisticated sensor was designed to detect total volatile organic compounds (TVOC), estimate CO2, and monitor and report indoor air quality (IAQ). -- **Onboard outdoor air quality sensor**: The Nicla Sense Env features an onboard gas sensor, the [ZMOD4510 from Renesas](https://www.renesas.com/us/en/document/dst/zmod4410-datasheet). This sophisticated sensor was designed to monitor and report outdoor air quality (OAQ) based on nitrogen dioxide (NO2) and ozone (O3) measurements. -- **Onboard user LEDs**: The Nicla Sense Env has two onboard user-programmable LEDs; one is an orange LED, and the other one is an RGB LED. -- **ESLOV connector**: The Nicla Sense Env has an onboard ESLOV connector to extend the board communication capabilities via I2C. -- **Surface mount**: The castellated pins of the board allow it to be positioned as a surface-mountable module. - -### Board Libraries - -The [`Arduino_NiclaSenseEnv` library](https://github.com/arduino-libraries/Arduino_NiclaSenseEnv) contains an application programming interface (API) to read data from the board and control its parameters and behavior over I²C. This library supports the following: - -- Board control (sleep, reset, and factory reset) -- Board configuration (I²C address configuration) -- Onboard RGB LED control -- Onboard orange LED control -- Onboard indoor air quality sensor control (sulfur detection, odor intensity, ethanol level, TVOC, CO₂, IAQ measurements) -- Onboard outdoor air quality sensor control (NO₂, O3, OAQ measurements) -- Temperature and humidity sensor control -- UART comma-separated values (CSV) output - -***The Portenta, MKR, Nano and UNO (R4) family boards support the `Arduino_NiclaSenseEnv` library.*** - -To install the `Arduino_NiclaSenseEnv` library, navigate to `Tools > Manage libraries...` or click the **Library Manager** icon in the left tab of the Arduino IDE. In the Library Manager tab, search for `Arduino_NiclaSenseEnv` and install the latest version of the library. - - - -### Pinout - -The full pinout is available and downloadable as PDF from the link below: - -- [Nicla Sense Env pinout](https://docs.arduino.cc/resources/pinouts/ABX00089-full-pinout.pdf) - -### Datasheet - -The complete datasheet is available and downloadable as PDF from the link below: - -- [Nicla Sense Env datasheet](https://docs.arduino.cc/resources/datasheets/ABX00089-datasheet.pdf) - -### Schematics - -The complete schematics are available and downloadable as PDF from the link below: - -- [Nicla Sense Env schematics](https://docs.arduino.cc/resources/schematics/ABX00089-schematics.pdf) - -### STEP Files - -The complete STEP files are available and downloadable from the link below: - -- [Nicla Sense Env STEP files](../../downloads/ABX00089-step.zip) - -## First Use - -### Unboxing the Product - -Let's check out what is inside the box of the Nicla Sense Env board. Besides the board, you will find an ESLOV cable inside the box, which can connect the Nicla Sense Env with other supported Arduino boards with an onboard ESLOV connector (Portenta or MKR family boards). The board's MKR-styled pins can also connect the Nicla Sense Env to other supported Arduino boards (Nano family), but 2.54 mm header pins (not included) must be soldered to the MKR-styled board pins. - - - -**The Nicla Sense Env is not a standalone device but a shield for an Arduino-supported board from the Portenta, MKR, or Nano board families**. This user manual will use a Portenta C33 as the main or host board and the Nicla Sense Env as a shield or client board connected through the included ESLOV cable. - -### Connecting the Board - -As shown in the image below, the Nicla Sense Env can be connected to a Portenta or MKR family board using the onboard ESLOV connector and the included ESLOV cable. Alternatively, you can connect the Nicla Sense Env as a shield by using the MKR-style pins on the Portenta or MKR family boards. - - - -For other compatible boards, such as those from the Nano family, the Nicla Sense Env can also be connected using the 2.54 mm pins of the Nicla Sense Env board. - -***Important note: The Nicla Sense Env board operates at 3.3 VDC, and while its pins are 5 VDC tolerant, we recommend using a level translator when connecting it to 5 VDC-compatible Arduino boards to ensure safe communication and prevent potential damage to the components. This connection can be made either through the Nicla Sense Env’s ESLOV connector or its dedicated I2C pins (`I2C0`), as illustrated in the image below.*** - - - -As shown in the image above, the use of a dedicated level translator between the Nicla Sense Env board and the 5 VDC-compatible Arduino board, in this example an Arduino UNO R4 WiFi, is recommended. - -### Powering the Board - -The Nicla Sense Env can be powered by: - -- Using the onboard **ESLOV connector**, which has a dedicated +5 VDC power line regulated onboard to +3.3 VDC. -- Using an **external +3.3 VDC power supply** connected to the `VCC` pin (please refer to the [board pinout section](#pinout) of the user manual). - - - -***The Nicla Sense Env's `VCC` pin can be connected only to a +3.3 VDC power supply; any other voltage will permanently damage the board. Furthermore, the `VCC` pin does not have reverse polarity protection. Double-check your connections to avoid damaging the board.*** - -In this user manual, we will use the board's ESLOV connector to power it. - -### Hello World Example - -Let's control the Nicla Sense Env board to reproduce the classic `hello world` example used in the Arduino ecosystem: the `Blink`. We will use this example to verify the Nicla Sense Env's connection to the host board (a Portenta C33) via ESLOV, the host board's connection to the Arduino IDE, and that the `Arduino_NiclaSenseEnv` library and both boards, the shield and the host, are working as expected. This section will refer to the Nicla Sense Env as a shield or client. - -***We are using the API of the `Arduino_NiclaSenseEnv` library with the host board (Portenta C33) to control the Nicla Sense Env (shield).*** - -First, connect the shield to the host board via ESLOV, as shown in the image below, using an ESLOV cable (included with your Nicla Sense Env): - - - -Now, connect the host board to your computer using a USB-C® cable, open the Arduino IDE, and connect the host board to it. - -***If you are new to the Portenta C33, please refer to the board's [user manual](https://docs.arduino.cc/tutorials/portenta-c33/user-manual/) for more detailed information.*** - -Copy and paste the example sketch below into a new sketch in the Arduino IDE: - -```arduino -/** - Blink Example on Nicla Sense Env - Name: nicla_sense_env_blink.ino - Purpose: This sketch demonstrates how to blink the onboard - orange LED of the Nicla Sense Env board. - - @author Arduino Product Experience Team - @version 1.0 31/05/24 -*/ - -// Include the NiclaSenseEnv library -#include "NiclaSenseEnv.h" - -// Global device object for the Nicla Sense Env board -NiclaSenseEnv device; - -/** - Toggles the onboard orange LED between on and off states. - @param led Reference to OrangeLED object controlling the LED. -*/ -void toggleLED(OrangeLED& led) { - // Turn on the LED to full brightness for one second - led.setBrightness(63); - delay(1000); - - // Turn off the LED for one second - led.setBrightness(0); - delay(1000); -} - -void setup() { - // Initialize serial communication at 115200 bits per second. - Serial.begin(115200); - - // Wait for Serial to be ready with a timeout of 5 seconds - for(auto start = millis(); !Serial && millis() - start < 5000;); - - if (device.begin()) { - // Initialize the onboard orange LED - auto orangeLED = device.orangeLED(); - } -} - -void loop() { - // Retrieve the orange LED object - OrangeLED orangeLED = device.orangeLED(); - - // Continuously toggle the orange LED on and off - toggleLED(orangeLED); -} -``` - -To upload the sketch to the host board, click the **Verify** button to compile the sketch and check for errors, then click the **Upload** button to program the device with the sketch. - - - -You should see the onboard orange LED of your Nicla Sense Env board turn on for one second, then off for one second, repeatedly. - - - -## Board Management - -This section of the user manual outlines how to manage the onboard sensors and main features of the Nicla Sense Env board using the `Arduino_NiclaSenseEnv` library API. It also explains how to perform essential tasks such as retrieving the board's information, managing sensor states, resetting the board, and putting it into deep sleep mode. - -### Board Information - -Detailed information from the board, such as its I2C address, serial number, product ID, software revision, and UART communication settings, can be retrieved using the `Arduino_NiclaSenseEnv` library API. The example sketch shown below retrieves that information using a dedicated function called `printDeviceInfo()`: - -```arduino -/** - Board Information Retrieval Example for Nicla Sense Env - Name: nicla_sense_env_board_info_example.ino - Purpose: This sketch demonstrates how to retrieve detailed board information from the Nicla Sense Env using the Arduino_NiclaSenseEnv library API. - - @author Sebastián Romero, modified by the Arduino Product Experience Team - @version 1.0 31/05/24 -*/ - -// Include the NiclaSenseEnv library -#include "NiclaSenseEnv.h" - -// Global device object for Nicla Sense Env -NiclaSenseEnv device; - -/** - Prints detailed device information to the Serial Monitor. - This function outputs all critical system parameters including - the device I2C address, serial number, and other configuration settings. -*/ -void printDeviceInfo() { - Serial.println("- Device Information:"); - Serial.print("- Device (0x"); - Serial.print(device.deviceAddress(), HEX); - Serial.println(") connected."); - Serial.print("- Serial number: "); - Serial.println(device.serialNumber()); - Serial.print("- Product ID: "); - Serial.println(device.productID()); - Serial.print("- Software revision: "); - Serial.println(device.softwareRevision()); - Serial.print("- Baud rate: "); - Serial.println(device.UARTBaudRate()); - Serial.print("- CSV delimiter: "); - Serial.println(device.CSVDelimiter()); - - Serial.print("- Debugging enabled: "); - if (device.isDebuggingEnabled()) { - Serial.println("true"); - } else { - Serial.println("false"); - } - - Serial.print("- CSV output enabled: "); - if (device.isUARTCSVOutputEnabled()) { - Serial.println("true"); - } else { - Serial.println("false"); - } -} - -void setup() { - // Initialize serial communication and wait up to 2.5 seconds for a connection - Serial.begin(115200); - for (auto startNow = millis() + 2500; !Serial && millis() < startNow; delay(500)); - - if (device.begin()) { - Serial.println("- Device successfully initialized!"); - // Print device information once after initialization - printDeviceInfo(); - } else { - Serial.println("- Failed to initialize the device. Please check the connection!"); - } -} - -void loop() { - // Nothing to do here. All information is printed once in setup(). -} -``` - -Here is a detailed breakdown of the `printDeviceInfo()` function and the `Arduino_NiclaSenseEnv` library API functions used in the `printDeviceInfo()` function: - -- `deviceAddress()`: Retrieves the I2C address of the board. This is useful for identifying the board when multiple devices are connected to the same I2C bus. -- `serialNumber()`: Outputs the board's unique serial number. Each board's serial number is unique and can be used for tracking, inventory management, or validating its authenticity. -- `productID()`: Provides the product ID, which specifies the exact model or version of the board. -- `softwareRevision()`: This displays the current firmware version installed on the board. Keeping the firmware updated is critical for security, performance, and access to new features, making this information valuable for maintenance and support. -- `UARTBaudRate()`: Shows the baud rate used for UART communications. -- `CSVDelimiter()`: Reveals the delimiter used in CSV outputs. This detail is vital for developers who process or log data, as it affects how data is parsed and stored. -- `isDebuggingEnabled()`: Indicates whether the debugging mode is active. Debugging can provide additional output that helps diagnose issues or for development purposes. -- `isUARTCSVOutputEnabled()`: Shows whether CSV output through UART is enabled. This setting is important for applications that require data logging for analysis or reporting, as it impacts how data is exported from the board. - -After uploading the example sketch to the host board, you should see the following output in the Arduino IDE's Serial Monitor: - - - -You can download the example sketch [here](assets/nicla_sense_env_board_info_example.zip). - -### Onboard Sensors Management - -Efficient management of the Nicla Sense Env's onboard sensors is important for optimizing its performance and power usage. The sketch shown below demonstrates how to manage (turn on or off) the onboard sensors (temperature, relative humidity, and air quality) of the Nicla Sense Env and check their status using the `Arduino_NiclaSenseEnv` library API: - -```arduino -/** - Onboard Sensors Management Example for Nicla Sense Env - Name: nicla_sense_env_sensors_management_example.ino - Purpose: This sketch demonstrates how to manage the onboard sensors of the Nicla Sense Env using the Arduino_NiclaSenseEnv library API. - - @author Arduino Product Experience Team - @version 1.0 31/05/24 -*/ - -// Include the NiclaSenseEnv library -#include "NiclaSenseEnv.h" - -// Global device object for Nicla Sense Env -NiclaSenseEnv device; - -void setup() { - // Initialize serial communication and wait up to 2.5 seconds for a connection - Serial.begin(115200); - for (auto startNow = millis() + 2500; !Serial && millis() < startNow; delay(500)); - - if (device.begin()) { - // Disable all the onboard sensors - Serial.println("- Disabling all sensors..."); - device.temperatureHumiditySensor().setEnabled(false); - device.indoorAirQualitySensor().setEnabled(false); - device.outdoorAirQualitySensor().setEnabled(false); - - // Check the onboard sensor states - Serial.println("- Checking the sensor states..."); - Serial.print("- Temperature sensor enabled: "); - if (device.temperatureHumiditySensor().enabled()) { - Serial.println("true"); - } else { - Serial.println("false"); - } - - Serial.print("- Indoor air quality sensor enabled: "); - if (device.indoorAirQualitySensor().enabled()) { - Serial.println("true"); - } else { - Serial.println("false"); - } - - Serial.print("- Outdoor air quality sensor enabled: "); - if (device.outdoorAirQualitySensor().enabled()) { - Serial.println("true"); - } else { - Serial.println("false"); - } - } else { - Serial.println("- Device could not be found. Please double-check the wiring!"); - } -} - -void loop() { - // Nothing to do here. All information is printed once in setup(). -} -``` - -This example sketch initializes the Nicla Sense Env board, disables all onboard sensors and then checks and prints the status of each sensor on the Arduino IDE's Serial Monitor. Here is a detailed breakdown of the example sketch shown before and the `Arduino_NiclaSenseEnv` library API functions used in the sketch: - -- `temperatureHumiditySensor().setEnabled(false)`: Disables the onboard temperature and humidity sensor. -- `indoorAirQualitySensor().setEnabled(false)`: Turns off the onboard indoor air quality sensor. -- `outdoorAirQualitySensor().setEnabled(false)`: Deactivates the onboard outdoor air quality sensor. -- `temperatureHumiditySensor().enabled()`: Checks if the onboard temperature and humidity sensor is active. -- `indoorAirQualitySensor().enabled()`: Indicates whether the onboard indoor air quality sensor is currently enabled. -- `outdoorAirQualitySensor().enabled()`: Confirms if the onboard outdoor air quality sensor is operational. - -After uploading the example sketch to the host board, you should see the following output in the Arduino IDE's Serial Monitor: - - - -You can download the example sketch [here](assets/nicla_sense_env_sensors_management_example.zip). - -### Board Reset - -Resetting the Nicla Sense Env is important for troubleshooting and ensuring the device operates cleanly. It is handy after making significant changes to the configuration or when an unexpected behavior occurs. - -The example sketch below demonstrates how to reset the Nicla Sense Env using the `Arduino_NiclaSenseEnv` library API. It also shows how to verify that the board has been reset by turning off the temperature sensor before the reset and checking its status after the reset. - -```arduino -/** - Board Reset Example for Nicla Sense Env - Name: nicla_sense_env_board_reset_example.ino - Purpose: This sketch demonstrates how to reset the Nicla Sense Env - using the Arduino_NiclaSenseEnv library API and verifies the reset - by disabling and then re-enabling the temperature sensor. - - @author Arduino Product Experience Team - @version 1.0 31/05/24 -*/ - -// Include the NiclaSenseEnv library -#include "NiclaSenseEnv.h" - -// Global device object for Nicla Sense Env -NiclaSenseEnv device; - -void setup() { - // Initialize serial communication and wait up to 2.5 seconds for a connection - Serial.begin(115200); - for (auto startNow = millis() + 2500; !Serial && millis() < startNow; delay(500)); - - if (device.begin()) { - // Disable the temperature sensor - Serial.println("- Disabling temperature sensor..."); - device.temperatureHumiditySensor().setEnabled(false); - - // Check the temperature sensor state before reset - Serial.print("- Temperature sensor enabled before reset: "); - if (device.temperatureHumiditySensor().enabled()) { - Serial.println("true"); - } else { - Serial.println("false"); - } - - // Resetting the device - Serial.println("- Resetting the device..."); - device.reset(); - delay(2000); // Ensure the device has enough time to reset properly - - // Check the temperature sensor state after reset - Serial.print("- Temperature sensor enabled after reset: "); - if (device.temperatureHumiditySensor().enabled()) { - Serial.println("true"); - } else { - Serial.println("false"); - } - } else { - Serial.println("- Device could not be found. Please double-check the wiring!"); - } -} - -void loop() { - // Nothing to do here. The device resets in setup(). -} -``` - -This example shows that the temperature sensor, disabled before the reset, is re-enabled after the reset, confirming that the board has restarted and all settings have been reset to their defaults. Here is a detailed breakdown of the example sketch shown before and the `Arduino_NiclaSenseEnv` library API functions used in the sketch: - -- `device.temperatureHumiditySensor().setEnabled(false)`: Disables the onboard temperature and humidity sensor. -- `device.reset()`: This function reboots the Nicla Sense Env, clearing all temporary settings. - -After uploading the example sketch to the host board, you should see the following output in the Arduino IDE's Serial Monitor: - - - -You can download the example sketch [here](assets/nicla_sense_env_board_reset_example.zip). - -### Low Power Mode Management - -Saving energy is vital for many projects, particularly those deployed in remote areas or with a limited power supply. The Nicla Sense Env supports a deep sleep mode that can help to minimize the board's power consumption. - -***Deep sleep is essential for extending battery life and minimizing energy consumption when the board is not collecting data or performing tasks. It is necessary for battery-powered or power-constrained applications.*** - -The example sketch shown below demonstrates how to put the Nicla Sense Env board into deep sleep mode using the `Arduino_NiclaSenseEnv` library API: - -```arduino -/** - Low Power Mode Management Example for Nicla Sense Env - Name: nicla_sense_env_low_power_mode_example.ino - Purpose: This sketch demonstrates how to put the Nicla Sense Env - into deep sleep mode using the Arduino_NiclaSenseEnv library API. - - @author Arduino Product Experience Team - @version 1.0 31/05/24 -*/ - -// Include the NiclaSenseEnv library -#include "NiclaSenseEnv.h" - -// Global device object for Nicla Sense Env -NiclaSenseEnv device; - -void setup() { - // Initialize serial communication and wait up to 2.5 seconds for a connection - Serial.begin(115200); - for (auto startNow = millis() + 2500; !Serial && millis() < startNow; delay(500)); - - if (device.begin()) { - // Putting the device to sleep - Serial.println("- Going to deep sleep mode..."); - device.deepSleep(); - } else { - Serial.println("- Device could not be found. Please double-check the wiring!"); - } -} - -void loop() { - // Nothing to do here. The device is in deep sleep mode. -} -``` - -Here is a detailed breakdown of the example sketch shown before and the `Arduino_NiclaSenseEnv` library API functions used in the sketch: - -- `device.deepSleep()`: This function puts the Nicla Sense Env board into a deep sleep state, minimizing power consumption to the lowest possible level. - -After uploading the example sketch to the host board, you should see the following output in the Arduino IDE's Serial Monitor: - - - -***Waking up a Nicla Sense Env board from deep sleep mode can only be done by a hardware reset.*** - -You can download the example sketch [here](assets/nicla_sense_env_low_power_mode_example.zip). - -## LEDs - -This section of the user manual explains how to control both the onboard orange and RGB and LEDs of the Nicla Sense Env board using the `Arduino_NiclaSenseEnv` library API. The LEDs can be used to provide visual feedback for various operations, such as indicating status, warnings, or sensor errors. This section covers the basic usage of both LEDs, including turning them on, changing colors, and adjusting its brightness. - - - -### Orange LED - -The onboard orange LED on the Nicla Sense Env board can be controlled using the `Arduino_NiclaSenseEnv` library. The example sketch shown below shows how to smoothly increase and decrease the brightness of the onboard orange LED. The LED pulses continuously in the `loop()` function. - -```arduino -/** - Orange LED Control Example for Nicla Sense Env - Name: nicla_sense_env_orange_led_control_example_smooth_brightness.ino - Purpose: This sketch demonstrates how to smoothly control the orange LED - by increasing and decreasing its brightness using the Arduino_NiclaSenseEnv library. - - @author Arduino Product Experience Team - @version 1.0 31/05/24 -*/ - -// Include the NiclaSenseEnv library -#include "Arduino_NiclaSenseEnv.h" - -// Global device object for Nicla Sense Env -NiclaSenseEnv device; - -// Initial brightness level -int brightness = 0; - -// Amount to increase/decrease the brightness by each loop -int fadeAmount = 5; - -void setup() { - // Initialize serial communication and wait up to 2.5 seconds for a connection - Serial.begin(115200); - for (auto startNow = millis() + 2500; !Serial && millis() < startNow; delay(500)); - - if (device.begin()) { - Serial.println("- Device successfully initialized!"); - } else { - Serial.println("- Failed to initialize the device. Please check the connection!"); - } -} - -void loop() { - // Get the orange LED object - auto orangeLED = device.orangeLED(); - - // Set the brightness level - orangeLED.setBrightness(brightness); - - // Change the brightness for next time through the loop - brightness += fadeAmount; - - // Reverse the direction of the fading at the ends of the fade (0 and 255) - if (brightness <= 0 || brightness >= 255) { - // Change the direction of the fade - fadeAmount = -fadeAmount; - } - - // Wait for a short time before updating the brightness again - delay(30); -} -``` - -Here is a detailed breakdown of the example sketch shown before and the `Arduino_NiclaSenseEnv` library API functions used in the sketch: - -- `device.begin()`: Initializes the Nicla Sense Env board, setting up communication with all onboard sensors and components, including the orange LED. -- `orangeLED.setBrightness(uint8_t brightness)`: Adjusts the brightness of the orange LED. The brightness ranges from `0` (off) to `255` (full brightness). In this sketch, the brightness gradually increases from `0` to `255` and then decreases back to 0, creating a smooth pulsing effect. -- `fadeAmount`: Controls the rate of change of brightness. When the brightness reaches either 0 or 255, the direction of change is reversed, making the LED brightness smoothly cycle up and down. - -After uploading the example sketch to the Nicla Sense Env board, you should see the orange LED smoothly increase and decrease in brightness, creating a continuous pulsing effect. - - - -You can download the example sketch [here](assets/nicla_sense_env_orange_led_control_example.zip). - -### RGB LED - -The onboard RGB LED on the Nicla Sense Env board can be controlled using the `Arduino_NiclaSenseEnv` library. The example sketch shown below shows how to turn on the LED with different colors and then turn it off using the `setColor()` and `setBrightness()` functions. The LED colors cycle continuously in the `loop()` function. - -```arduino -/** - RGB LED Control Example for Nicla Sense Env - Name: nicla_sense_env_rgb_led_control_example_brightness.ino - Purpose: This sketch demonstrates how to control the RGB LED by setting - different colors and ensuring brightness control using the Arduino_NiclaSenseEnv library. - - @author Arduino Product Experience Team - @version 1.0 31/05/24 -*/ - -// Include the NiclaSenseEnv library -#include "Arduino_NiclaSenseEnv.h" - -// Global device object for Nicla Sense Env -NiclaSenseEnv device; - -void setup() { - // Initialize serial communication and wait up to 2.5 seconds for a connection - Serial.begin(115200); - for (auto startNow = millis() + 2500; !Serial && millis() < startNow; delay(500)); - - if (device.begin()) { - Serial.println("- Device successfully initialized!"); - } else { - Serial.println("- Failed to initialize the device. Please check the connection!"); - } -} - -void loop() { - // Get the RGB LED object - auto rgbLED = device.rgbLED(); - - // Turn on the LED with red color - rgbLED.setColor(255, 0, 0); - // Ensure maximum brightness, wait for one second - rgbLED.setBrightness(255); - Serial.println("- RGB LED is now red!"); - delay(1000); - - // Turn on the LED with green color - rgbLED.setColor(0, 255, 0); - // Ensure maximum brightness, wait for one second - rgbLED.setBrightness(255); - Serial.println("- RGB LED is now green!"); - delay(1000); - - // Turn on the LED with blue color - rgbLED.setColor(0, 0, 255); - // Ensure maximum brightness, wait for one second - rgbLED.setBrightness(255); - Serial.println("- RGB LED is now blue!"); - delay(1000); - - // Set the LED color to black and brightness to 0 to turn it off - rgbLED.setColor(0, 0, 0); - // Ensure minimum brightness, wait for one second - rgbLED.setBrightness(0); - Serial.println("- RGB LED is now off!"); - delay(1000); -} -``` - -Here is a detailed breakdown of the example sketch shown before and the `Arduino_NiclaSenseEnv` library API functions used in the sketch: - -- `device.begin()`: Initializes the Nicla Sense Env board, setting up communication with all onboard sensors and components, including the RGB LED. -- `rgbLED.setColor(uint8_t red, uint8_t green, uint8_t blue)`: This function sets the RGB LED to a specific color by specifying the intensity of the red, green, and blue components. Each value can range from `0` (off) to `255` (full brightness). In the example, the RGB LED cycles through red (255, 0, 0), green (0, 255, 0), and blue (0, 0, 255). -- `rgbLED.setBrightness(uint8_t brightness)`: Adjusts the brightness of the RGB LED. The value ranges from `0` (off) to `255` (full brightness). In the sketch, the brightness is set to 255 (maximum) when the LED is on, and to 0 (off) when the LED is turned off. - -After uploading the example sketch to the Nicla Sense Env board, you should see the following output in the Arduino IDE's Serial Monitor: - - - -You should also see the onboard RGB LED of your Nicla Sense Env board turn on red for one second, then green for one second, then blue for one second, and finally turn off, repeating this cycle. - - - -You can download the example sketch [here](assets/nicla_sense_env_rgb_led_control_example_brightness.zip). - -## Temperature and Humidity Sensor - -The Nicla Sense Env board has an onboard temperature and humidity sensor, the HS4001 from Renesas. The HS4001 is a highly accurate, ultra-low power, fully calibrated automotive-grade relative humidity and temperature sensor. Its high accuracy, fast measurement response time, and long-term stability make the HS4001 sensor ideal for many applications ranging from portable devices to products designed for harsh environments. - - - -The example sketch below demonstrates how to read temperature and humidity data from the HS4001 sensor using the `Arduino_NiclaSenseEnv` library API. The sketch will report the temperature and humidity values to the Arduino IDE's Serial Monitor every 2.5 seconds. - -```arduino -/** - Temperature and Humidity Sensor Example for Nicla Sense Env - Name: nicla_sense_env_temp_humidity_example.ino - Purpose: This sketch demonstrates how to read temperature and humidity from - the HS4001 sensor on the Nicla Sense Env using the Arduino_NiclaSenseEnv library API. - - @author Arduino Product Experience Team - @version 1.0 31/05/24 -*/ - -// Include the NiclaSenseEnv library -#include "NiclaSenseEnv.h" - -// Global device object for Nicla Sense Env -NiclaSenseEnv device; - -/** - Displays temperature and humidity data from the HS4001 sensor. - @param sensor Reference to TemperatureHumiditySensor object controlling the sensor. -*/ -void displaySensorData(TemperatureHumiditySensor& sensor) { - if (sensor.enabled()) { - float temperature = sensor.temperature(); - if (isnan(temperature)) { - Serial.println("- Temperature: N/A"); - } else { - Serial.print("- Temperature: "); - Serial.print(temperature, 2); - Serial.println(" °C"); - } - Serial.print("- Relative humidity: "); - Serial.print(sensor.humidity(), 2); - Serial.println(" %"); - Serial.println(""); - } else { - Serial.println("- Temperature sensor is disabled!"); - } -} - -void setup() { - // Initialize serial communication and wait up to 2.5 seconds for a connection - Serial.begin(115200); - for (auto startNow = millis() + 2500; !Serial && millis() < startNow; delay(500)); - - if (device.begin()) { - Serial.println("- Device is connected!"); - } else { - Serial.println("- Device could not be found. Please double check the wiring!"); - } -} - -void loop() { - // Read data from the HS4001 sensor - // Wait for 2.5 seconds before reading again - auto temperatureSensor = device.temperatureHumiditySensor(); - displaySensorData(temperatureSensor); - delay(2500); -} -``` - -Here is a detailed breakdown of the example sketch shown before and the `Arduino_NiclaSenseEnv` library API functions used in the sketch: - -- `temperatureHumiditySensor()`: Retrieves the temperature and humidity sensor object from the Nicla Sense Env. -- `sensor.enabled()`: Checks if the sensor is currently enabled. -- `sensor.temperature()`: Reads the current temperature value from the sensor. The reading is unavailable if the value is not a number (NaN). -- `sensor.humidity()`: Reads the current relative humidity value from the sensor. - -After uploading the example sketch to the host board, you should see the following output in the Arduino IDE's Serial Monitor: - - - -You can download the example sketch [here](assets/nicla_sense_env_temp_humidity_example.zip). - -## Indoor Air Quality Sensor - -The Nicla Sense Env board features an onboard air quality sensor, the ZMOD4410 from Renesas. The ZMOD4410 is a highly integrated digital gas sensor module for indoor air quality monitoring. It provides measurements of total volatile organic compounds (TVOCs), estimates CO₂ levels, and monitors indoor air quality (IAQ), making it suitable for applications such as smart home devices, air purifiers, and HVAC systems. Its compact size, low power consumption, and high sensitivity make this sensor an excellent choice for various air quality monitoring applications. - - - -***Every ZMOD sensor is electrically and chemically calibrated during Renesas production. The calibration data is stored in the non-volatile memory (NVM) of the sensor module and is used by the firmware routines during sensor initialization. ZMOD sensors are qualified for a 10-year lifetime (following the JEDEC JESD47 standard) without the need for recalibration.*** - -The example sketch below demonstrates how to read air quality data from the ZMOD4410 sensor using the `Arduino_NiclaSenseEnv` library API. The sketch reports indoor air quality values to the Arduino IDE's Serial Monitor every 5 seconds. - -**Important**: The ZMOD4410 supports several operation modes, each with specific sample rates and warm-up requirements. For IAQ measurements, the sensor can take a sample every three seconds but requires 60 warm-up samples, meaning a total warm-up time of 3 minutes. In ultra-low-power mode, the sensor can take samples every 90 seconds but requires only 10 warm-up samples, meaning it takes 15 minutes to fully warm-up. - -```arduino -/** - Indoor Air Quality Sensor Example for Nicla Sense Env - Name: nicla_sense_env_indoor_air_quality_example.ino - Purpose: This sketch demonstrates how to read air quality data from the - ZMOD4410 sensor on the Nicla Sense Env using the Arduino_NiclaSenseEnv library API. - - @author Arduino Product Experience Team - @version 1.0 31/05/24 -*/ - -// Include the NiclaSenseEnv library -#include "NiclaSenseEnv.h" - -// Global device object for Nicla Sense Env -NiclaSenseEnv device; - -/** - Displays air quality data from the ZMOD4410 sensor. - @param sensor Reference to IndoorAirQualitySensor object controlling the sensor. -*/ -void displaySensorData(IndoorAirQualitySensor& sensor) { - if (sensor.enabled()) { - Serial.print("- Indoor air quality value: "); - Serial.println(sensor.airQuality()); - Serial.print("- CO2 (ppm): "); - Serial.println(sensor.CO2()); - Serial.print("- TVOC (mg/m3): "); - Serial.println(sensor.TVOC()); - Serial.print("- Ethanol (ppm): "); - Serial.println(sensor.ethanol()); - Serial.println(""); - } else { - Serial.println("- Indoor air quality sensor is disabled!"); - } -} - -void setup() { - // Initialize serial communication and wait up to 2.5 seconds for a connection - Serial.begin(115200); - for (auto startNow = millis() + 2500; !Serial && millis() < startNow; delay(500)); - - if (device.begin()) { - Serial.println("- Device is connected!"); - auto airQualitySensor = device.indoorAirQualitySensor(); - - // Set the sensor mode to indoor air quality - airQualitySensor.setMode(IndoorAirQualitySensorMode::indoorAirQuality); - - // The ZMOD4410 can take a sample every 3 seconds in IAQ mode and requires 60 warm-up samples, - // meaning the sensor will take about 3 minutes to fully warm-up before accurate readings can - // be obtained. In this example, we allow 5 seconds for the sensor to start delivering data. - delay(5000); - } else { - Serial.println("- Device could not be found. Please double-check the wiring!"); - } -} - -void loop() { - // Read data from the ZMOD4410 sensor every 5 seconds - auto airQualitySensor = device.indoorAirQualitySensor(); - displaySensorData(airQualitySensor); - delay(5000); -} -``` - -Here is a detailed breakdown of the example sketch shown before and the `Arduino_NiclaSenseEnv` library API functions used in the sketch: - -- `indoorAirQualitySensor()`: Retrieves the air quality sensor object from the Nicla Sense Env. -- `sensor.enabled()`: Checks if the sensor is currently enabled. -- `sensor.airQuality()`: Reads the current air quality value from the sensor. -- `sensor.CO2()`: Reads the estimated CO₂ concentration from the sensor. -- `sensor.TVOC()`: Reads the sensor's total concentration of volatile organic compounds. -- `sensor.ethanol()`: Reads the ethanol concentration from the sensor. - -After uploading the example sketch to the host board, you should see the following output in the Arduino IDE's Serial Monitor: - - - -You can download the example sketch [here](assets/nicla_sense_env_indoor_air_quality_example.zip). - -## Outdoor Air Quality Sensor - -The Nicla Sense Env board features an onboard outdoor air quality sensor, the ZMOD4510 from Renesas. The ZMOD4510 is a digital gas sensor module for outdoor air quality monitoring. It measures nitrogen dioxide (NO₂) and ozone (O₃) levels. It calculates an outdoor air quality index (AQI), making it suitable for air quality monitoring stations, wearable devices, and smart city infrastructure applications. Its robustness, low power consumption, and high sensitivity make this sensor an excellent choice for outdoor air quality monitoring applications. - - - -***Every ZMOD sensor is electrically and chemically calibrated during Renesas production. The calibration data is stored in the non-volatile memory (NVM) of the sensor module and is used by the firmware routines during sensor initialization. ZMOD sensors are qualified for a 10-year lifetime (following the JEDEC JESD47 standard) without the need for recalibration.*** - -The example sketch below demonstrates how to read air quality data from the ZMOD4510 sensor using the `Arduino_NiclaSenseEnv` library API. The sketch reports outdoor air quality values to the Arduino IDE's Serial Monitor every 5 seconds. - -**Important**: The ZMOD4510 supports several operation modes, each with specific sample rates and warm-up requirements. For NO₂/O₃ measurements, the sensor can take a sample every 6 seconds but requires 50 warm-up samples, meaning a total warm-up time of 5 minutes. In ultra-low-power O₃ mode, the sensor can take samples every two seconds, but it requires 900 warm-up samples before it is fully operational, meaning it takes 30 minutes to warm-up completely. - -```arduino -/** - Outdoor Air Quality Sensor Example for Nicla Sense Env - Name: nicla_sense_env_outdoor_air_quality_example.ino - Purpose: This sketch demonstrates how to read air quality data from the - ZMOD4510 sensor on the Nicla Sense Env using the Arduino_NiclaSenseEnv library API. - - @author Arduino Product Experience Team - @version 1.0 31/05/24 -*/ - -// Include the NiclaSenseEnv library -#include "NiclaSenseEnv.h" - -// Global device object for Nicla Sense Env -NiclaSenseEnv device; - -/** - Displays air quality data from the ZMOD4510 sensor. - @param sensor Reference to OutdoorAirQualitySensor object controlling the sensor. -*/ -void displaySensorData(OutdoorAirQualitySensor& sensor) { - if (sensor.enabled()) { - Serial.print("- Outdoor air quality value: "); - Serial.println(sensor.airQualityIndex()); - Serial.print("- NO2 (ppb): "); - Serial.println(sensor.NO2()); - Serial.print("- O3 (ppb): "); - Serial.println(sensor.O3()); - Serial.println(""); - } else { - Serial.println("- Outdoor air quality sensor is disabled!"); - } -} - -void setup() { - // Initialize serial communication and wait up to 2.5 seconds for a connection - Serial.begin(115200); - for (auto startNow = millis() + 2500; !Serial && millis() < startNow; delay(500)); - - if (device.begin()) { - Serial.println("- Device is connected!"); - auto outdoorAirQualitySensor = device.outdoorAirQualitySensor(); - - // Enable the outdoor air quality sensor - outdoorAirQualitySensor.setMode(OutdoorAirQualitySensorMode::outdoorAirQuality); - outdoorAirQualitySensor.setEnabled(true); - - // The ZMOD4510 takes a sample every 6 seconds in NO2/O3 mode and requires 50 warm-up samples, - // meaning the sensor will take about 5 minutes to fully warm-up before accurate readings - // can be obtained. In this example, we allow 6 seconds for the sensor to start delivering data. - delay(6000); - } else { - Serial.println("- Device could not be found. Please double-check the wiring!"); - } -} - -void loop() { - // Read data from the ZMOD4510 sensor every 5 seconds - auto outdoorAirQualitySensor = device.outdoorAirQualitySensor(); - displaySensorData(outdoorAirQualitySensor); - delay(6000); -} -``` - -Here is a detailed breakdown of the example sketch shown before and the `Arduino_NiclaSenseEnv` library API functions used in the sketch: - -- `outdoorAirQualitySensor()`: Retrieves the outdoor air quality sensor object from the Nicla Sense Env. -- `sensor.enabled()`: Checks if the sensor is currently enabled. -- `sensor.airQualityIndex()`: Reads the current outdoor air quality index value. -- `sensor.NO2()`: Reads the nitrogen dioxide concentration from the sensor. -- `sensor.O3()`: Reads the ozone concentration from the sensor. - -After uploading the example sketch to the host board, you should see the following output in the Arduino IDE's Serial Monitor: - - - -You can download the example sketch [here](assets/nicla_sense_env_outdoor_air_quality_example.zip). - -## Communication - -The Nicla Sense Env board features a UART interface for data logging purposes. This allows the board to output sensor data in `CSV` format over UART, enabling easy data logging and monitoring in various applications. The UART interface is handy for scenarios where the board needs to communicate with other microcontrollers or systems without relying on USB connections. - -The example sketch below demonstrates how to read data from the UART port on the Nicla Sense Env board. The sketch assumes the Nicla Sense Env is powered through the board's `VCC` pin or the ESLOV connector of a host board and connected to another board through the UART pins. The example also requires enabling the UART output on the Nicla Sense Env. - -```arduino -/** - UART Communication Example for Nicla Sense Env - Name: nicla_sense_env_uart_communication_example.ino - Purpose: This sketch demonstrates how to read data from the UART port on the Nicla Sense Env board - and process the data in CSV format for logging and monitoring purposes. - - @author Sebastián Romero, modified by the Arduino Product Experience Team - @version 1.0 31/05/24 -*/ - -// Include necessary libraries -#include