Skip to content

Commit 069cc4b

Browse files
committed
Add Warning About Firmware
1 parent a6bcf10 commit 069cc4b

File tree

2 files changed

+24
-3
lines changed

2 files changed

+24
-3
lines changed

docs/hardware_overview.md

Lines changed: 14 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ There are a variety of power and power-related nets broken out to connectors and
3737

3838
### USB-C and 5V
3939

40-
The DataLogger IoT comes equipped with a USB type C socket which you can use to connect it to your computer for configuration through the serial terminal; upload new firmware; or plug in a USB-C power supply. The DataLogger IoT includes the configuration channel resistors needed to tell the power supply to deliver **5V**. You can use your USB-C laptop charger as the power source should you need to, even though it normally delivers a much higher voltage. There is also a **5V** pin. However, this is not connected to the same USB bus.
40+
The DataLogger IoT comes equipped with a USB type C socket which you can use to connect it to your computer to view the output and configuration through the serial terminal, or plug in a USB-C power supply. The DataLogger IoT includes the configuration channel resistors needed to tell the power supply to deliver **5V**. You can use your USB-C laptop charger as the power source should you need to, even though it normally delivers a much higher voltage. There is also a **5V** pin. However, this is not connected to the same USB bus.
4141

4242
<div style="text-align: center;">
4343
<table>
@@ -254,7 +254,7 @@ There are three 12-bit analog pins available and broken out on edge of the board
254254
There are two buttons available on the board for reset and boot. These are also broken out on the edge of the board as PTHs. If you have your DataLogger IoT mounted in an enclosure, you can also attach an external boot or reset switch too. Any Single Pole Normally-Open Push-To-Close momentary switch will do. Solder pin headers or wires to the RST and GND breakout pins and connect your external switch to those.
255255

256256
* **<span STYLE="text-decoration:overline">RESET</span>**: Pressing this button will pull the pin LOW and reset the program running on the ESP32 without unplugging the board.
257-
* **BOOT**: The boot button allows users to force the ESP32 into bootloader mode to manually flash new firmware to the ESP32.The ESP32 will remain in this mode until there is a power cycle, code is uploaded, or the reset button is pressed. This is connected to pin `0` on the ESP32.
257+
* **BOOT**: The boot button usually allows users to force the ESP32 into bootloader mode to manually flash new firmware to the ESP32. The ESP32 will remain in this mode until there is a power cycle or the reset button is pressed. This is connected to pin `0` on the ESP32.
258258

259259
<div style="text-align: center;">
260260
<table>
@@ -265,7 +265,7 @@ There are two buttons available on the board for reset and boot. These are also
265265
</table>
266266
</div>
267267

268-
Like other ESP32 development boards, these buttons are populated so that users can place the ESP32 module in bootloader mode. For users that need to place the board in booltoader mode when powered, you will need to:
268+
Like other ESP32 development boards, these buttons are populated so that users can place the ESP32 module in bootloader mode. For users that need to place the board in bootloader mode when powered, you will need to:
269269

270270
* Press the BOOT button.
271271
* While holding on the BOOT button, press the RESET button momentarily.
@@ -274,6 +274,17 @@ Like other ESP32 development boards, these buttons are populated so that users c
274274
Most of the time, users will simply have the board executing the firmware that is loaded on the ESP32 module and updating through the configuration menu either through the microSD card or OTA.
275275

276276

277+
!!! danger
278+
279+
Please think very carefully before uploading any Arduino sketches to your DataLogger IoT.
280+
281+
**You will overwrite the DataLogger IoT firmware, leaving it unable to update or restore itself.**
282+
283+
The DataLogger IoT – 9DoF comes pre-programmed with amazing firmware which can do _so_ much. It is designed to be able to update itself and restore itself if necessary. But it can not do that if you overwrite the firmware with any Arduino sketch. It is just like erasing the restore partition on your computer hard drive. Do not do it - unless you _really_ know what you are doing.
284+
285+
Really. We mean it.
286+
287+
277288

278289
## LEDs
279290

docs/updating_firmware.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,13 @@
1+
!!! danger
2+
3+
Please think very carefully before uploading any Arduino sketches to your DataLogger IoT.
4+
5+
**You will overwrite the DataLogger IoT firmware, leaving it unable to update or restore itself.**
6+
7+
The DataLogger IoT – 9DoF comes pre-programmed with amazing firmware which can do _so_ much. It is designed to be able to update itself and restore itself if necessary. But it can not do that if you overwrite the firmware with any Arduino sketch. It is just like erasing the restore partition on your computer hard drive. Do not do it - unless you _really_ know what you are doing.
8+
9+
Really. We mean it.
10+
111

212

313
## Firmware Update - SD Card

0 commit comments

Comments
 (0)