ufbt_help.py 1.3 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253
  1. targets_help = """Configuration variables:
  2. """
  3. tail_help = """
  4. TASKS:
  5. (* - not supported yet)
  6. launch:
  7. Upload and start application over USB
  8. vscode_dist:
  9. Configure application in current directory for development in VSCode.
  10. create:
  11. Copy application template to current directory. Set APPID=myapp to create an app with id 'myapp'.
  12. Building:
  13. faps:
  14. Build all FAP apps
  15. fap_{APPID}, launch APPSRC={APPID}:
  16. Build FAP app with appid={APPID}; upload & start it over USB
  17. Flashing & debugging:
  18. flash, flash_blackmagic, *jflash:
  19. Flash firmware to target using debug probe
  20. flash_usb, flash_usb_full:
  21. Install firmware using self-update package
  22. debug, debug_other, blackmagic:
  23. Start GDB
  24. Other:
  25. cli:
  26. Open a Flipper CLI session over USB
  27. lint:
  28. run linter for C code
  29. format:
  30. reformat C code
  31. How to create a new application:
  32. 1. Create a new directory for your application and cd into it.
  33. 2. Run `ufbt vscode_dist create APPID=myapp`
  34. 3. In VSCode, open the folder and start editing.
  35. 4. Run `ufbt launch` to build and upload your application.
  36. """
  37. def generate(env, **kw):
  38. vars = kw["vars"]
  39. basic_help = vars.GenerateHelpText(env)
  40. env.Help(targets_help + basic_help + tail_help)
  41. def exists(env):
  42. return True