betaflight.com icon indicating copy to clipboard operation
betaflight.com copied to clipboard

Update Firmware flashing page

Open ctzsnooze opened this issue 9 months ago • 5 comments

Adds some notes and details to the firmware flashing page:

  • explains a simple / basic flash process with an example screen
  • includes RACE PRO option and link
  • fixes incorrect note about Dashboard functionality
  • many small text / editorial / structural changes

Please let me know if anything should be added, or removed, or is incorrect.

ctzsnooze avatar May 04 '24 06:05 ctzsnooze

Deploy Preview for origin-betaflight-com ready!

Name Link
Latest commit cafe50db2c39f730004a933564b9e43cdd9a8140
Latest deploy log https://app.netlify.com/sites/origin-betaflight-com/deploys/6642839ec081e50008aae44f
Deploy Preview https://deploy-preview-418.dev.web.betaflight.com
Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

netlify[bot] avatar May 04 '24 06:05 netlify[bot]

maybe update this screenshot as well image

nerdCopter avatar May 04 '24 15:05 nerdCopter

I note that 'FLASH' and 'FRSKY_OSD' are not options anymore.

ctzsnooze avatar May 04 '24 23:05 ctzsnooze

Quite a big update in the last commit:

  • Added, and linked to, a Defines file in development with the grep code to build it. Thanks @nerdcopter. The file is user-focused and includes a simple explanation of the basic usage and purpose of defines.
  • Changed the ordering of the configurator tabs so that Firmware Flasher is at the top, and removed the junk modes tab document (modes tab info is via auxiliary-tab.md)
  • Various editorial fixes and tidy-ups.

At the time I did this I didn't notice @nerdCopter's list of defines being added to the cloud build API page.

Defines are used more widely than just for cloud build purposes. I think that it's best to focus the cloud build page on the defines made visible to the user in the cloud build process. It's OK to have a complete defines list there as well, but since the full list has relevance to non-cloud build users, perhaps having the complete list in a more generic page about Defines may work a bit better?

ctzsnooze avatar May 09 '24 01:05 ctzsnooze

Updated the list of defines, using: grep --exclude-dir=config -Irh '^[^/].*' src/main/ | grep -wo 'USE_[0-9A-Z_]\+' | sort | uniq

As noted above, this includes, for example:

USE_HAL_ADC_REGISTER_CALLBACKS
USE_HAL_CEC_REGISTER_CALLBACKS
USE_HAL_COMP_REGISTER_CALLBACKS
USE_HAL_CORDIC_REGISTER_CALLBACKS
USE_HAL_CRYP_REGISTER_CALLBACKS
USE_HAL_DAC_REGISTER_CALLBACKS
USE_HAL_DCMI_REGISTER_CALLBACKS
USE_HAL_DFSDM_REGISTER_CALLBACKS
USE_HAL_DMA2D_REGISTER_CALLBACKS
USE_HAL_DRIVER
USE_HAL_DSI_REGISTER_CALLBACKS
USE_HAL_DTS_REGISTER_CALLBACKS
USE_HAL_ETH_REGISTER_CALLBACKS
USE_HAL_EXTI_REGISTER_CALLBACKS
USE_HAL_FDCAN_REGISTER_CALLBACKS
USE_HAL_FMAC_REGISTER_CALLBACKS
USE_HAL_GFXMMU_REGISTER_CALLBACKS
USE_HAL_HASH_REGISTER_CALLBACKS
USE_HAL_HCD_REGISTER_CALLBACKS
USE_HAL_HRTIM_REGISTER_CALLBACKS
USE_HAL_I2C_REGISTER_CALLBACKS
USE_HAL_I2S_REGISTER_CALLBACKS
USE_HAL_IRDA_REGISTER_CALLBACKS
USE_HAL_JPEG_REGISTER_CALLBACKS
USE_HAL_LPTIM_REGISTER_CALLBACKS
USE_HAL_LTDC_REGISTER_CALLBACKS
USE_HAL_MDIOS_REGISTER_CALLBACKS
USE_HAL_MMC_REGISTER_CALLBACKS
USE_HAL_NAND_REGISTER_CALLBACKS
USE_HAL_NOR_REGISTER_CALLBACKS
USE_HAL_OPAMP_REGISTER_CALLBACKS
USE_HAL_OSPI_REGISTER_CALLBACKS
USE_HAL_OTFDEC_REGISTER_CALLBACKS
USE_HAL_PCD_REGISTER_CALLBACK
USE_HAL_PCD_REGISTER_CALLBACKS
USE_HAL_QSPI_REGISTER_CALLBACKS
USE_HAL_RNG_REGISTER_CALLBACKS
USE_HAL_RTC_REGISTER_CALLBACKS
USE_HAL_SAI_REGISTER_CALLBACKS
USE_HAL_SDRAM_REGISTER_CALLBACKS
USE_HAL_SD_REGISTER_CALLBACKS
USE_HAL_SMARTCARD_REGISTER_CALLBACKS
USE_HAL_SMBUS_REGISTER_CALLBACKS
USE_HAL_SPDIFRX_REGISTER_CALLBACKS
USE_HAL_SPI_REGISTER_CALLBACKS
USE_HAL_SRAM_REGISTER_CALLBACKS
USE_HAL_SWPMI_REGISTER_CALLBACKS
USE_HAL_TIM_REGISTER_CALLBACKS
USE_HAL_UART_REGISTER_CALLBACKS
USE_HAL_USART_REGISTER_CALLBACKS
USE_HAL_WWDG_REGISTER_CALLBACKS

They all start with USE_, but only USE_HAL_DRIVER a define which we care about from a configuration perspective. The others just set internal states and are not user-configurable. I'll make a firmware PR to change 'USE_toENABLE_` or something, then rebuild the list.

ctzsnooze avatar May 10 '24 13:05 ctzsnooze

At the time I did this I didn't notice @nerdCopter's list of defines being added to the cloud build API page.

I'm okay with whatever. if this new docs/development/Defines.md goes in, then the API page should to link to it as well.

nerdCopter avatar May 10 '24 13:05 nerdCopter

@ctzsnooze Should change src to src/main otherwise you pick up middleware etc. Good point, realised that myself also, done.

haslinghuis avatar May 10 '24 16:05 haslinghuis

I think this is ready; from my perspective, please give final reviews / approval if OK.

ctzsnooze avatar May 11 '24 02:05 ctzsnooze