rusefi
/
atbetaflight
mirror of https://github.com/rusefi/atbetaflight.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Update CreatingAUnifiedTarget.md

This commit is contained in:
Reinhard 2019-10-21 09:31:43 +02:00 committed by GitHub
parent 456ecfaf2e
commit 72153399dd
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 7 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
docs/TargetMaintenance/CreatingAUnifiedTarget.md
View File

@ -44,20 +44,20 @@ These instructions explain how to create a Unified Target configuration for an e
- connect to your board running the Unified Target firmware, enter CLI;
- copy / paste the contents of the dump created in 2. into CLI
- enter the command: `feature OSD` in CLI, just before the #master section (to switch on OSD by default), then enter `save`;
- copy / paste the contents of the dump created in 2. into CLI, then enter `save`;
- when the board reboots now, the LEDs should start working again - this is a sign that the previous step was successful.
## 6. Add custom settings for your board to the Unified Target configuration
- this step is optional. Omitting it will give users of your board a minimal but working board configuration when using a Unified Target;
- enter the command: `feature OSD` in CLI, just before the #master section (to switch on OSD by default);
- set all the custom settings that are specific to your board (e.g. presets for serial RX on a specific port if the board's instructions are for users to use this port for the serial RX). Changes can be done in the UI or in CLI;
- the following steps are optional (omitting it will give users of your board a minimal but working board configuration when using a Unified Target):;
- try to only include extra settings if you are certain that most / all of your users will want them - unwanted extra changes just make it harder for your users to use your board;
- set all the custom settings that are specific to your board (e.g. presets for serial RX on a specific port if the board's instructions are for users to use this port for the serial RX). Changes can be done in the UI or in CLI;
- try to only include extra settings if you are certain that most / all of your users will want them - unwanted extra changes just make it harder for your users to use your board;
- save the changes;
@ -66,6 +66,6 @@ These instructions explain how to create a Unified Target configuration for an e
- re-start CLI (Disconnect / Connect), then do a `diff all bare`, save the output into a file named `<manufacturer_id>-<board_name>.config` with 'Save to File'. It is crucial that the name exactly matches the manufacturer id and board name specified in the file, or else checking of the pull request you are going to open in a subsequent step will fail;
- edit the resulting file and verify that the first line in the file starts with `# Betaflight`, otherwise delete the lines before this line. Likewise, there must be no extra lines after the last line starting with `set`, delete all subsequnet lines otherwise;
- edit the resulting file and identify the first line in the file starting with `# Betaflight`. This line (called the banner line) should be left untouched, and it has to be the first line in the file. Whatever content is found above this line, delete it. Likewise, there must be no extra lines after the last line starting with `set` - delete all subsequnet lines otherwise;
- open a [pull request](https://github.com/betaflight/unified-targets/pulls) to put your target configuration into `configs/default`.