mirror of
https://github.com/betaflight/betaflight.git
synced 2025-07-13 03:20:00 +03:00
Updated the Unified Target creation documentation to reflect the new naming.
This commit is contained in:
mikeller
parent
fcaa16cd7d
commit
0b1276c487
4 changed files with 6 additions and 49 deletions
4
.github/pull_request_template.md
vendored
4
.github/pull_request_template.md
vendored
|
|
@ -20,9 +20,9 @@ In order to be prepared for this move, the following new requirements for pull r
|
|||
|
||||
1. No new F3 based targets will be accepted;
|
||||
|
||||
2. For any new target that is to be added, both a 'legacy' format target definition into `src/main/target/` and a new Unified Target config into `unified_targets/configs/` need to be submitted. See the for how to create a Unified Target configuration: https://github.com/betaflight/betaflight/blob/master/unified_targets/docs/CreatingAUnifiedTarget.md;
|
||||
2. For any new target that is to be added, only a Unified Target config into https://github.com/betaflight/unified-targets/tree/master/configs/default needs to be submitted. See https://github.com/betaflight/betaflight/blob/master/docs/TargetMaintenance/CreatingAUnifiedTarget.md for how to create a Unified Target configuration. If there is no Unified Target for the MCU type of the new target (see instructions above), then a 'legacy' format target definition into `src/main/target/` has to be submitted as well;
|
||||
|
||||
3. For changes to existing targets, the change needs to be applied to both the 'legacy' format target definition in `src/main/target/` and a new Unified Target config in `unified_targets/configs/`. If no Unified Target configuration for the target exists, a new Unified Target configuration will have to be created and submitted alongside the proposed change.
|
||||
3. For changes to existing targets, the change needs to be applied to the Unified Target config in https://github.com/betaflight/unified-targets/tree/master/configs/default. If no Unified Target configuration for the target exists, a new Unified Target configuration will have to be created and submitted. If there is no Unified Target for the MCU type of the new target (see instructions above), then an update to the 'legacy' format target definition in `src/main/target/` has to be submitted alongside the update to the Unified Target configuration.
|
||||
|
||||
|
||||
## Important considerations when opening a pull request:
|
||||
|
|
|
|||
|
|
@ -34,9 +34,9 @@ In order to be prepared for this move, the following new requirements for pull r
|
|||
|
||||
1. No new F3 based targets will be accepted;
|
||||
|
||||
2. For any new target that is to be added, both a 'legacy' format target definition into `src/main/target/` and a new Unified Target config into https://github.com/betaflight/unified-targets/tree/master/configs/default need to be submitted. See the [instructions](https://github.com/betaflight/betaflight/blob/master/unified_targets/docs/CreatingAUnifiedTarget.md) for how to create a Unified Target configuration;
|
||||
2. For any new target that is to be added, only a Unified Target config into https://github.com/betaflight/unified-targets/tree/master/configs/default needs to be submitted. See the [instructions](https://github.com/betaflight/betaflight/blob/master/docs/TargetMaintenance/CreatingAUnifiedTarget.md) for how to create a Unified Target configuration. If there is no Unified Target for the MCU type of the new target (see instructions above), then a 'legacy' format target definition into `src/main/target/` has to be submitted as well;
|
||||
|
||||
3. For changes to existing targets, the change needs to be applied to both the 'legacy' format target definition in `src/main/target/` and a new Unified Target config in https://github.com/betaflight/unified-targets/tree/master/configs/default. If no Unified Target configuration for the target exists, a new Unified Target configuration will have to be created and submitted alongside the proposed change.
|
||||
3. For changes to existing targets, the change needs to be applied to the Unified Target config in https://github.com/betaflight/unified-targets/tree/master/configs/default. If no Unified Target configuration for the target exists, a new Unified Target configuration will have to be created and submitted. If there is no Unified Target for the MCU type of the new target (see instructions above), then an update to the 'legacy' format target definition in `src/main/target/` has to be submitted alongside the update to the Unified Target configuration.
|
||||
|
||||
|
||||
### End of active development for STM32F3 based flight controllers
|
||||
|
|
|
|||
|
|
@ -18,7 +18,7 @@ These instructions explain how to create a Unified Target configuration for an e
|
|||
|
||||
- re-start CLI (Disconnect / Connect), then do a `dump hardware`, save the output into a file with 'Save to File';
|
||||
|
||||
- edit the resulting file and verify that `board_name` is set to the target name, and `manufacturer_id` is set to the manufacturer's id as listed in [this document](Manufacturers.md). If the manufacturer is not listed, open an [issue](https://github.com/betaflight/betaflight/issues) and ask for a new id to be assigned. For boards that are homebrew and / or not planned for commercial availability, use `CUST` as the `manufacturer_id`.
|
||||
- edit the resulting file and verify that `board_name` is set to the target name, and `manufacturer_id` is set to the manufacturer's id as listed in [this document](https://github.com/betaflight/unified-targets/tree/master/Manufacturers.md). If the manufacturer is not listed, open an [issue](https://github.com/betaflight/betaflight/issues) and ask for a new id to be assigned. For boards that are homebrew and / or not planned for commercial availability, use `CUST` as the `manufacturer_id`.
|
||||
|
||||
## 3. Flash the Unified Target firmware
|
||||
|
||||
|
|
@ -56,7 +56,7 @@ These instructions explain how to create a Unified Target configuration for an e
|
|||
|
||||
## 6. Create a Unified Target configuration file for your board
|
||||
|
||||
- re-start CLI (Disconnect / Connect), then do a `diff all bare`, save the output into a file named `<board_name>.config` with 'Save to File';
|
||||
- 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 there are no extra lines before the one starting with `# Betaflight`, and no extra lines after the last line starting with `set`;
|
||||
|
||||
|
|
@ -1,43 +0,0 @@
|
|||
# Manufacturer Ids
|
||||
|
||||
This is the official list of manufacturer ids (`manufacturer_id` in the target config) that will be supported for loading onto unified targets by Betaflight configurator.
|
||||
|
||||
|
||||
|Manufacturer Id|Name|Contact|
|
||||
|-|-|-|
|
||||
|CUST|'Custom', to be used for homebrew targets||
|
||||
|AFNG|AlienFlight NG|https://www.alienflightng.com/|
|
||||
|AIKO|AIKON Electronics|https://www.aikon-electronics.com/|
|
||||
|AIRB|Airbot|https://store.myairbot.com/|
|
||||
|BKMN|Jason Blackman|https://github.com/blckmn|
|
||||
|CLRA|CLRACING LLC|https://cl-racing.myshopify.com/|
|
||||
|DIAT|Diatone Innovations|https://www.diatoneusa.com/|
|
||||
|DRCL|dronercland|https://www.instagram.com/dronercland/|
|
||||
|DYST|DongYang Smart Technology Co.,Ltd (dys)|http://www.dys.hk/|
|
||||
|FFPV|Furious FPV|https://furiousfpv.com/|
|
||||
|FLWO|Flywoo|https://flywoo.net/|
|
||||
|FOXE|Foxeer|http://www.foxeer.com/|
|
||||
|FPVM|FPV Model|https://fpvmodel.com/|
|
||||
|HAMO|Happymodel|http://www.happymodel.cn/|
|
||||
|HARC|HAKRC|https://github.com/loopur|
|
||||
|HBRO|Holybro|http://www.holybro.com/index.html|
|
||||
|HENA|Heli-Nation|https://www.heli-nation.com/|
|
||||
|HGLR|HGLRC|https://www.hglrc.com/|
|
||||
|IFRC|iFlight Innovation Technology Ltd.|https://www.iflight-rc.com/|
|
||||
|JHEF|JHE\_FPV|https://github.com/atgfpeyv|
|
||||
|KLEE|Kevin Lee (WhitenoiseFPV)|https://whitenoisefpv.com/|
|
||||
|MERA|MerakRC|http://www.merakrc.com/|
|
||||
|MOLA|MotoLab|https://github.com/MotoLab|
|
||||
|MTKS|Matek Systems|http://www.mateksys.com/|
|
||||
|RAST|Racerstar|https://www.racerstar.com/|
|
||||
|RCTI|RCTimer|http://rctimer.com/|
|
||||
|RUSH|FPV Racing Rush|http://www.rushfpv.com/|
|
||||
|SPBE|LangTian Technology (Shenzhen) Co. (SpeedyBee)|https://www.speedybee.com/|
|
||||
|SPRO|Seriously Pro Racing (SP Racing)|http://seriouslypro.com/|
|
||||
|TACO|Taco RC|https://taco-rc.com/|
|
||||
|TCMM|Shenzhen Xinmumu Science and Technology Co (TCMM)|http://www.tcmm-rc.cn/|
|
||||
|TMTR|T-motor|http://uav-en.tmotor.com/|
|
||||
|TTRH|TransTEC|http://www.transtechobby.com/|
|
||||
|VGRC|V-GOOD Technology Co.|http://www.vgoodrc.com/|
|
||||
|VIVA|VivaFPV|https://vivafpv.com/|
|
||||
|ZEEZ|ZeeZ Design|http://www.zeezdesign.com/|
|
||||
Loading…
Add table
Add a link
Reference in a new issue