Skip to content

Commit 58a9699

Browse files
ArduinoBotcanchebagurjcarolinares
authored
[PC-1385] [PC-1404] - Nicla Voice User Manual Update (#1372)
* Content update (user manual updates) * Content update (tutorial fixes) * Content update (Julián's review) Co-authored-by: Julián Caro Linares <jcarolinares@gmail.com> * Content update (Julián's review) Co-authored-by: Julián Caro Linares <jcarolinares@gmail.com> * Content update (Julián's review) Co-authored-by: Julián Caro Linares <jcarolinares@gmail.com> * Content update (Julián's review) --------- Co-authored-by: José Antonio Bagur Nájera <josea.bagur@gmail.com> Co-authored-by: Julián Caro Linares <jcarolinares@gmail.com>
1 parent 56615ba commit 58a9699

File tree

2 files changed

+33
-12
lines changed

2 files changed

+33
-12
lines changed
Loading

content/hardware/06.nicla/boards/nicla-voice/tutorials/user-manual/content.md

Lines changed: 33 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ tags:
88
- Cheat sheet
99
- RGB
1010
- Communication
11-
author: 'Benjamin Dannegård and José Bagur'
11+
author: 'José Bagur and Benjamin Dannegård'
1212
hardware:
1313
- hardware/06.nicla/boards/nicla-voice
1414
software:
@@ -20,27 +20,27 @@ software:
2020

2121
## Overview
2222

23-
This user manual will provide you with a comprehensive overview of the Arduino Nicla Voice board, covering its main hardware and software features. With this user manual, you will also learn how to set up, configure and use these features.
23+
This user manual will provide you with a comprehensive overview of the Arduino Nicla Voice board, covering its main hardware and software features. This user manual will also show you how to set up, configure, and use these features.
2424

2525
## Hardware and Software Requirements
2626

2727
### Hardware Requirements
2828

2929
- [Nicla Voice](https://store.arduino.cc/products/nicla-voice) (x1)
30-
- Micro USB cable (x1)
30+
- [Micro USB cable](https://store.arduino.cc/products/usb-2-0-cable-type-a-micro) (x1)
3131

3232
### Software Requirements
3333

3434
- [Arduino IDE 1.8.10+](https://www.arduino.cc/en/software), [Arduino IDE 2.0+](https://www.arduino.cc/en/software), or [Arduino Web Editor](https://create.arduino.cc/editor)
35-
- To create custom Machine Learning models, the integrated Machine Learning Tools of the [Arduino Cloud](https://create.arduino.cc/iot/) are needed. In case you do not have an Arduino Cloud account, you will need to create one first.
35+
- To create custom Machine Learning models, the integrated [Machine Learning Tools](https://cloud.arduino.cc/machine-learning-tools/) of the [Arduino Cloud](https://create.arduino.cc/iot/) are needed. In case you do not have an Arduino Cloud account, you will need to create one first.
3636

3737
## Product Overview
3838

3939
The Nicla Voice is an innovative and versatile development board designed by the Arduino team for sound-enabled projects and applications. This board has an onboard always-on speech recognition and sensor-fusion processor, advanced motion sensors, and wireless connectivity via Bluetooth® Low Energy. The Nicla Voice is an ideal solution for various applications, from ultra-low power predictive maintenance and gesture or voice recognition systems to contactless wireless applications.
4040

4141
### Board Architecture Overview
4242

43-
The Nicla Voice features a robust and efficient architecture that integrates various components to enable speech, sound, and motion projects and applications.
43+
The Nicla Voice features a robust and efficient architecture integrating various components to enable speech, sound, and motion projects and applications.
4444

4545
![The Nicla Voice main components (top view)](assets/user-manual-2.png)
4646

@@ -96,18 +96,34 @@ The complete STEP files are available and downloadable from the link below:
9696
The Nicla voice can be powered by:
9797

9898
- Using a Micro USB cable (not included).
99-
- Using an external **5V power supply** connected to `VIN_BQ25120` pin (please, refer to the [board pinout section](#pinout) of the user manual).
99+
- Using an external **5V power supply** connected to `VIN_BQ25120` pin (please refer to the [board pinout section](#pinout) of the user manual).
100100
- Using a **3.7V Lithium Polymer (Li-Po) battery** connected to the board through the onboard battery connector; the manufacturer part number of the battery connector is BM03B-ACHSS and its matching receptacle manufacturer part number is ACHR-03V-S. The **recommended minimum battery capacity for the Nicla Voice is 200 mAh**. A Li-Po battery with an integrated NTC thermistor is also recommended for thermal protection.
101101
- Using the onboard **ESLOV connector**, which has a dedicated 5V power line.
102102

103103
![Different ways to power the Nicla Voice](assets/user-manual-6.png)
104104

105-
The onboard battery charger of your board is, by default, **disabled**. To enable it, you can use the `enableCharge()` function defined in the Nicla Voice board core:
105+
***A 3.7V Li-Po battery can be also connected through the board's pins: `1 (NTC)`, `2 (VBAT)`, and `6 (GND)`. Please refer to the board's [pinout](#pinout) to locate those pins on your Nicla Voice board.***
106+
107+
#### Onboard Battery Charger
108+
<br></br>
109+
110+
The onboard battery charger of your board is, by default, **disabled**. To enable it, you can use the `enableCharging()` function defined in the Nicla Voice board core:
111+
112+
```arduino
113+
// Enable the onboard battery charger
114+
// The function parameter defines the charging current in mA (between 5 mA and 300 mA)
115+
nicla::enableCharging(100);
116+
```
117+
118+
The desired charging current can be set to a value between 5 mA and 300 mA; the default value is 20 mA.
119+
120+
***A safe default charging current value that works for most common LiPo batteries is 0.5C, which means charging at a rate equal to half the battery's capacity. For example, a 200 mAh battery could be safely charged at 100 mA (0.1 A).***
121+
122+
To disable the onboard battery charger, you can use the `disableCharging()` function defined in the Nicla Voice board core:
106123

107124
```arduino
108-
// Enabling the battery charger
109-
// The function parameter defines the charging current in mA
110-
nicla::enableCharge(100);
125+
// Disable the onboard battery charger
126+
nicla::disableCharging();
111127
```
112128

113129
### NDP120 Processor Firmware Update
@@ -144,6 +160,7 @@ It is recommended to update the NDP120 processor firmware and the built-in speec
144160
After uploading the three files, your board's firmware is updated to the latest release and ready to be used.
145161
146162
#### External Memory Format
163+
<br></br>
147164
148165
Your board NDP120 processor files (firmware and models) are stored in your board's external Flash memory. It is recommended to **format your Nicla Voice external Flash memory** every time you are going to update the processor firmware or when you are going to update/add models to the external Flash memory.
149166
@@ -691,7 +708,7 @@ Next, in the `setup()` function:
691708
- The serial communication is initialized at a baud rate of 115200.
692709
- The Nicla Voice board is initialized, and the LDO regulator (used for putting the board into power-saving mode) is disabled to avoid communication problems with the IMU.
693710
- Error and event handlers are initialized.
694-
- NDP processor is initialized; this process includes populating the external Flash memory of the board with the NDP processor's internal microcontroller firmware (`mcu_fw_120_v91.synpkg`), the NDP processor's internal DSP firmware (`dsp_firmware_v91.synpkg`), and the ML model (`ei_model.synpkg`).
711+
- NDP processor is initialized; this process includes populating the external Flash memory of the board with the NDP processor's internal microcontroller firmware (`mcu_fw_120_v91.synpkg`), the NDP processor's internal DSP firmware (`dsp_firmware_v91.synpkg`), and the Machine Learning model (`ei_model.synpkg`).
695712
- The BMI270 sensor is initialized; this includes a software reset, loading the sensor configuration, and setting it into normal power mode with the accelerometer and gyroscope operational.
696713

697714
Finally, in the `loop()` function:
@@ -912,7 +929,7 @@ Next, in the `setup()` function:
912929
- The serial communication is initialized at a baud rate of 115200.
913930
- The Nicla Voice board is initialized, and the LDO regulator (used for putting the board into power-saving mode) is disabled to avoid communication problems with the magnetometer.
914931
- Error and event handlers are initialized.
915-
- NDP processor is initialized; this process includes populating the external Flash memory of the board with the NDP processor's internal microcontroller firmware (`mcu_fw_120_v91.synpkg`), the NDP processor's internal DSP firmware (`dsp_firmware_v91.synpkg`), and the ML model (`ei_model.synpkg`).
932+
- NDP processor is initialized; this process includes populating the external Flash memory of the board with the NDP processor's internal microcontroller firmware (`mcu_fw_120_v91.synpkg`), the NDP processor's internal DSP firmware (`dsp_firmware_v91.synpkg`), and the Machine Learning model (`ei_model.synpkg`).
916933
- The BMM150 sensor is initialized; this includes setting it into normal operation with an output data rate (ODR) of 10 Hz.
917934

918935
Finally, in the `loop()` function:
@@ -1027,6 +1044,10 @@ In the example code above, a Machine Learning model is loaded into the Nicla Voi
10271044
- If an error occurs, the built-in RGB LED will blink red continuously.
10281045
- While an event is recognized, the built-in RGB LED is turned on green.
10291046

1047+
To learn more about your Nicla Voice board Machine Learning capabilities, check out the following tutorial and learn how to create a simple motion detection application:
1048+
1049+
- [Motion Detection with Nicla Voice and Machine Learning Tools](https://docs.arduino.cc/tutorials/nicla-voice/motion-detection-ml)
1050+
10301051
## Actuators
10311052

10321053
### RGB LED

0 commit comments

Comments
 (0)