Michal
/
Prusa-Firmware-MMU
mirror of https://github.com/prusa3d/Prusa-Firmware-MMU
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Improve documentation of the startup process

pull/89/head
D.R.racer 2021-08-11 10:44:58 +02:00 committed by DRracer
parent 87d0f1c8f7
commit 492208d25a
1 changed files with 13 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
src/main.dox
View File

@ -172,3 +172,16 @@
///
///@subsection integration_sec Integration tests
///
///@section power_up Powering up the board
///
/// Upon startup, the board tries to initialize all the necessary peripherals.
/// The progress of initialization is visualized by individual LEDs turning green.
/// That includes:
/// - LED 4: shift register - however if the shift register doesn't work we really can't signalize anything, only internal variables will be accessible if the UART works.
/// - LED 3: USART - if both shift register and the UART are dead, we are sitting ducks :(
/// - LED 2: SPI
/// - LED 1: TMC2130 - this may actually report some error
/// - LED 0: ADC
///
/// Ideally, the board has all the green LEDs on after startup - that signalizes all the peripherals started correctly.
///