Mirror/AI-on-the-edge-device-docs
1
0
Fork 0
mirror of https://github.com/jomjol/AI-on-the-edge-device-docs.git synced 2025-12-07 12:07:01 +03:00
Code Issues Packages Projects Releases Wiki Activity

Add Makefile and Markdown linter (#73)

Browse Source 
* Add Makefile

* Update .gitignore to exclude venv

* Add requirements.txt for venv

* Add pymarkdown lint Github action

* Update .md from lint tool

* Update README with make commands

* Add linter config
This commit is contained in:
Adriaan Van Niekerk
2025-10-31 01:06:36 +02:00
committed by GitHub
parent bbe3bd79db
commit 0cd98c67e2
44 changed files with 524 additions and 279 deletions
Download Patch File Download Diff File Expand all files Collapse all files

50
docs/Error-Codes.md
View File

@@ -8,63 +8,70 @@ The error code(s) get printed with specific error codes. This page lists the pos
Here the error codes are defined in source code: [error codes](https://github.com/jomjol/AI-on-the-edge-device/blob/main/code/components/jomjol_helper/Helper.h).
## Critical Errors
Those Errors make the normal operation of the device impossible.
Most likely they are caused by a hardware issue!
### `0x00000001` PSRAM bad
Your device most likely has no PSRAM at all or it is too small (needs to have at least 4 MBytes)!
See [Hardware Compatibility](Hardware-Compatibility.md).
Usually the log shows something like this:
```
psram: PSRAM ID read error: 0xffffffff
cpu_start: Failed to init external RAM!
```
### `0x00000002` Heap too small
The firmware failed to allocate enough memory. This most likely is a consequential error of a bad PSRAM!
### `0x00000004` Cam bad
The attached camera can not be initialized.
This usually is because on of the following reasons:
* The camera is not supported, see [Hardware Compatibility](Hardware-Compatibility.md)
* The camera is not attached properly -> Try to remove and attach it again. Make sure you move the black part enough into the socket!
* The camera or the camera cable is damaged
* The camera is not supported, see [Hardware Compatibility](Hardware-Compatibility.md)
* The camera is not attached properly -> Try to remove and attach it again. Make sure you move the black part enough into the socket!
* The camera or the camera cable is damaged
### `0x00000008` SD card basic check failed
One or more basic SD card checks failed.
The following checks are performed during boot sequence:
* Write a file (sdcard/sdcheck.txt) to SD card with some generic text
* Read the written file back
* CRC verification
* Delete the file
* Write a file (sdcard/sdcheck.txt) to SD card with some generic text
* Read the written file back
* CRC verification
* Delete the file
Detailed error indication (write, rerad or delete error) can be derived from blinking code of red board status LED. Please refer to [StatusLED-BlinkCodes](https://jomjol.github.io/AI-on-the-edge-device-docs/StatusLED-BlinkCodes/)
Recommendation: Reformat SD card and check again or try another SD card
### `0x00000010` SD folder or file presence check failed
One or more mandatory folders and/or files are missing on SD card.
To have early indication that SD card is potentially ready for operation, some folder and files, which are mandatory are presence checked. This is not a 100% check and a successful test does not mean everthing is OK.
The following folders / files get checked during boot sequence:
* /sdcard/config
* /sdcard/html
* /sdcard/demo --> created automatically in firmware
* /sdcard/firmware --> created automatically in firmware
* /sdcard/img_tmp --> created automatically in firmware
* /sdcard/log --> created automatically in firmware
* /sdcard/wlan.ini
* /sdcard/config/config.ini
* /sdcard/html/index.html
* /sdcard/html/ota_page.html
* /sdcard/html/log.html
* /sdcard/html/common.js
* /sdcard/html/version.txt
* /sdcard/config
* /sdcard/html
* /sdcard/demo --> created automatically in firmware
* /sdcard/firmware --> created automatically in firmware
* /sdcard/img_tmp --> created automatically in firmware
* /sdcard/log --> created automatically in firmware
* /sdcard/wlan.ini
* /sdcard/config/config.ini
* /sdcard/html/index.html
* /sdcard/html/ota_page.html
* /sdcard/html/log.html
* /sdcard/html/common.js
* /sdcard/html/version.txt
!!! Notes
This list might be outdated, see the source code for the latest implementation: [SDCardCheckRW()](https://github.com/jomjol/AI-on-the-edge-device/blob/main/code/components/jomjol_helper/sdcard_check.cpp#L14)
@@ -72,9 +79,11 @@ The following folders / files get checked during boot sequence:
Recommendation: Check logs and / or redo a Over-The-Air Update (OTA Update) to ensure proper SD card structure
## Non-Critical Errors
Those Errors can be caused by an error during initialization. It is possible that the error has no impact at all or that a reboot solves it.
### `0x00000100` Cam Framebuffer bad
The firmware was unable to initialize the Camera Framebuffer.
The firmware will continue to work, but other consequential error might arise.
A reboot of the device might help.
@@ -82,4 +91,5 @@ A reboot of the device might help.
This might also be caused by a corrupred SD-Card, see [CAM is not working anymore" on init #2390](https://github.com/jomjol/AI-on-the-edge-device/discussions/2390#discussioncomment-6430819)
### `0x00000200` NTP failed
The firmware failed to get the world time from an NTP server. The firmware will continue to work, but has a wrong time.