-
Notifications
You must be signed in to change notification settings - Fork 137
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
19 changed files
with
148 additions
and
72 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -10,7 +10,7 @@ | |
| "items": [ | ||
| { | ||
| "label": "Products", | ||
| "url": "/hardware/en/", | ||
| "url": "/en/", | ||
| "position": "left" | ||
| }, | ||
| { | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,49 +1,61 @@ | ||
| --- | ||
| --- | ||
| title: MaixCAM System Flashing | ||
| --- | ||
|
|
||
| ## Download the System | ||
|
|
||
| Find the latest system image file, such as `maixcam_os_20240401_maixpy_v4.1.0.xz`, on the [MaixPy release page](https://github.com/sipeed/MaixPy/releases). | ||
| Find the latest system image file on the [MaixPy Release Page](https://github.com/sipeed/MaixPy/releases), such as `maixcam_os_20240401_maixpy_v4.1.0.xz`. | ||
|
|
||
| Alternative address: | ||
| Alternative download link: | ||
| * [Sourceforge](https://sourceforge.net/projects/maixpy/files/) | ||
|
|
||
| ## Prepare Flashing Tools | ||
| ## Prepare the Flashing Tool | ||
|
|
||
| Download [Etcher](https://etcher.balena.io/), install and open it. | ||
|
|
||
| Windows can also use [Win32DiskImager](https://sourceforge.net/projects/win32diskimager/) or [Rufus](https://rufus.ie/). | ||
| Windows users can also use [Win32DiskImager](https://sourceforge.net/projects/win32diskimager/) or [Rufus](https://rufus.ie/). | ||
|
|
||
| ## Flash TF Card | ||
| ## Flashing the TF Card | ||
|
|
||
| There are two ways to flash the TF card: | ||
| * If you bought the official TF card package, it already contains a system, but the version might be outdated. It is recommended to use the USB update method so you don't have to disassemble the casing, which makes it difficult to reassemble. | ||
| * If you are using your own card and have never flashed a system onto it before, you must first flash it using a card reader and then install the TF card by disassembling the device. After that, you can flash the image directly via USB without disassembling. | ||
|
|
||
| ### Method One: Flashing the TF Card Using a Card Reader | ||
|
|
||
| * Remove the TF card and insert it into a card reader, then plug it into the computer. | ||
| * Open Etcher, select the image file, choose the TF card, and click `Flash`. | ||
| * Wait for the flashing process to complete, eject the TF card, insert it into the MaixCAM, power it up, and wait for the system to boot. The first boot may be slow, just wait for a while. | ||
|
|
||
| ### Flash TF Card with Card Reader | ||
| ### Method Two: Update the TF Card Image via USB | ||
|
|
||
| * Directly remove the TF card, insert it into the card reader, and then insert it into the computer. | ||
| * Open Etcher, select the image file, select the TF card, and click `Flash`. | ||
| * Wait for the flashing to complete, eject the TF card, insert it into MaixCAM, then power on, wait for the system to start, the first boot will be slower, just wait a while. | ||
| **Note: USB can only be used for updates, not for the first-time flashing.** | ||
| Ensure that the system has already been flashed using a card reader and is **running properly** before using this method. | ||
|
|
||
| ### Flash TF Card via USB | ||
| * Power off the MaixCAM, keeping the TF card inserted. | ||
| * Hold down the `user` button, plug in the USB cable to the computer, (or plug in the USB cable first, then hold down the `user` button, press the `reset` button briefly and release it), wait for the disk drive to appear on the computer, and then release the `user` button. | ||
| * Open `Etcher`, select the image file, choose the disk drive, and click `Flash`. | ||
| * Wait for the flashing to complete, then press the `reset` button or power it back on, wait for the system to boot. The first boot might be slow, wait until the screen displays content (to be safe, wait about 1 minute), and do not power off during boot-up to prevent file corruption during system initialization (if this happens, reflash the image). | ||
|
|
||
| * Power off MaixCAM, keep the TF card inserted. | ||
| * Hold down the `user` button on the device without releasing it, insert the USB cable connected to the computer, and wait for the USB device to appear on the computer. | ||
| * Open Etcher, select the image file, select the USB device, and click `Flash`. | ||
| * Wait for the flashing to complete, then press the `reset` button or re-power on, wait for the system to start, the first boot will be slower, just wait a while. | ||
| > If you cannot enter USB upgrade mode, the system files may be corrupted, and you should reflash the TF card using a card reader. | ||
| ## System Usage Precautions | ||
| ## Points to Note When Using the System | ||
|
|
||
| ### Forced Shutdown | ||
|
|
||
| It is **not recommended to press the `reset` button** during normal system use, except in the situations mentioned above. This button forces a power cut, and if your system is writing content to the TF card, it could cause system and data damage. Similarly, forcibly unplugging the power while the system is still running poses the same risk as pressing the `reset` button. Always try to **shut down the software before unplugging the power**. | ||
| Other than the above situations where using the `reset` button, it is **not recommended to press the `reset` button** during normal use. This button forcefully cuts off power. If your system is writing content to the TF card, it could cause system and data damage. | ||
| Similarly, forcibly unplugging the power supply while the system is still running poses the same risk. Try to **shut down the software before unplugging the power supply**. | ||
|
|
||
| For normal operations, please **shut down or restart using software**. Here are the methods: | ||
| For normal use, please **shut down or reboot via software**. Methods: | ||
| * Method One: From the interface, select `Settings` -> `Power` to perform a software shutdown or reboot. | ||
| * Method Two: In the terminal, use the `poweroff` or `reboot` commands to shut down or restart via software. | ||
| * Method Three: Other software calls, such as using `Python` to invoke `import os;os.system("poweroff")` for shutdown or reboot. | ||
|
|
||
| - **Method 1:** Navigate to `Settings` -> `Power` to shut down or restart through the software. | ||
| - **Method 2:** Use the `poweroff` or `reboot` commands in the terminal for software shutdown or restart. | ||
| - **Method 3:** Other software calls, such as using Python `import os; os.system("poweroff")` to shut down or restart. | ||
| ### Issues with File Writing and Data Loss | ||
|
|
||
| The system uses a caching mechanism. When your code writes a file, it might only write to memory initially, and the system automatically writes to the disk after some time. If the power is cut during this period, the content will not be written to the disk (TF card), and the next time the system boots, the previously written content will be missing. | ||
|
|
||
| Solutions: | ||
| * Try not to directly cut off power or press the `reset` button; use the software shutdown methods mentioned above. | ||
| * To save critical content, you can manually call an API to force the content to be written to disk. For example, in `Python`, you can use `os.sync()` to tell the system to immediately write all cached files to the disk. For other methods such as writing to a specific file, and other languages, please search for terms | ||
|
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.