Skip to content

Commit aa7ed7c

Browse files
committed
Use placeholder for board name component of "DSpotterSDK_Maker_*" libraries
There is a separate speech recognition library for each of the supported boards. The library name all use the same "DSpotterSDK_Maker_" prefix, differentiated with a suffix to indicate the target board. The tutorial contains instructions for opening the library's example sketch. These instructions are intended to be applicable for use with any of the library variants so it is necessary for the reader to extrapolate the correct library name. The new approach is to use a placeholder to indicate the board name suffix on the library name. The common convention of indicating a placeholder via angle brackets was chosen. This causes a visual collision with the tutorials use of right angle brackets as separators when indicating menu path navigation, as is the standard in Arduino documentation. In order to avoid this collision, the tutorial is migrated to using the alternative "->" menu path separator.
1 parent 7d1e97a commit aa7ed7c

File tree

1 file changed

+4
-4
lines changed
  • content/hardware/04.pro/shields/portenta-vision-shield/tutorials/speech-recognition-engine

1 file changed

+4
-4
lines changed

Diff for: content/hardware/04.pro/shields/portenta-vision-shield/tutorials/speech-recognition-engine/content.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -97,11 +97,11 @@ In case you need more instructions about how to install libraries, read this [gu
9797

9898
To use the Arduino Speech Recognition Engine, you will need a free trial license or paid license. In any of the cases, the serial number of the board that you are using is necessary to activate the license.
9999

100-
To get your board's serial number, and once you have the library downloaded, navigate to **File > Examples > DSpotterSDK_Maker_33BLE/NiclaVision/PortentaH7/RP2040 > GetSerialNumber**.
100+
To get your board's serial number, and once you have the library downloaded, navigate to **File -> Examples -> DSpotterSDK\_Maker\_<board_name> -> GetSerialNumber**.
101101

102102
Connect your board to the computer, upload the sketch to it and, once is done, open the **Serial Monitor** to see your device's Serial Number.
103103

104-
***On the Arduino IDE 1.6.x or previous versions, you can also find the serial number as follow: select the board's serial port and click on `tools > Get Board Info`, you will see the "SN" number, save it for later.***
104+
***On the Arduino IDE 1.6.x or previous versions, you can also find the serial number as follow: select the board's serial port and click on `tools -> Get Board Info`, you will see the "SN" number, save it for later.***
105105

106106
#### Get the Demo License
107107

@@ -117,7 +117,7 @@ Once everything is ready, click on the **submit** button to get your license, it
117117

118118
### Test the Free Demo Sketch
119119

120-
* Open the sketch **File > Examples > DSpotterSDK_Maker_33BLE/NiclaVision/PortentaH7/RP2040 > VoiceRecognition**
120+
* Open the sketch **File -> Examples -> DSpotterSDK\_Maker\_<board_name> -> VoiceRecognition**
121121
* Navigate to the `CybLicense.h` tab.
122122
* Paste your license between the brackets, like in the following example:
123123
```cpp
@@ -193,7 +193,7 @@ Once everything is checked, click **Confirm** and you will get the model header
193193
194194
You will now get some files in your e-mail inbox. Download them to your computer.
195195
196-
On the IDE, open the example **File > Examples > DSpotterSDK_Maker_33BLE/NiclaVision/PortentaH7/RP2040 > VoiceRecognition** and click **File > Save As...** and type a name for your sketch.
196+
On the IDE, open the example **File -> Examples -> DSpotterSDK\_Maker\_<board_name> -> VoiceRecognition** and click **File -> Save As...** and type a name for your sketch.
197197
198198
Once it is saved, open your File Explorer, and navigate to your sketch path.
199199

0 commit comments

Comments
 (0)