mirror of
https://github.com/betaflight/betaflight.git
synced 2025-07-16 21:05:35 +03:00
Update instructions to include new build API
This commit is contained in:
parent
5e7bca1576
commit
36b1383d34
1 changed files with 28 additions and 7 deletions
|
@ -58,14 +58,33 @@ 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'.
|
||||
|
||||
|
||||
### 2.3. Add the board and manufacturer information
|
||||
### 2.3. Add #defines for hardware drivers
|
||||
|
||||
- edit the file from the previous step, and add #defines for accelerometer, barometer, gyro and magnetometer hardware drivers to be included for the cloud build API.
|
||||
|
||||
For example on [this target](https://github.com/betaflight/unified-targets/blob/master/configs/default/AIRB-NOX.config) it will look like:
|
||||
|
||||
# Betaflight / STM32F411 (S411) 4.1.0 Oct 16 2019 / 11:57:34 (c37a7c91a) MSP API: 1.42
|
||||
|
||||
#define USE_BARO_SPI_BMP280
|
||||
#define USE_BARO_BMP280
|
||||
#define USE_GYRO_SPI_MPU6000
|
||||
#define USE_GYRO_SPI_MPU6500
|
||||
#define USE_ACC_SPI_MPU6000
|
||||
#define USE_ACC_SPI_MPU6500
|
||||
|
||||
board_name NOX
|
||||
manufacturer_id AIRB
|
||||
|
||||
|
||||
### 2.4. Add the board and manufacturer information
|
||||
|
||||
- edit the file from the previous step, 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. This issue needs to contain the following: name of the company selling the board and supporting customers of it; a website URL for this company. In a future release of the Betaflight configurator, the listing for every board will include this company name, and users will be able to open the company's website from within Betaflight configurator. Allow for a day or two for the Betaflight team to respond to your issue and assign a manufacturer it;
|
||||
- for boards that are homebrew and / or not planned for commercial availability, use `CUST` as the `manufacturer_id`.
|
||||
|
||||
|
||||
### 2.4. Flash the Unified Target firmware
|
||||
### 2.5. Flash the Unified Target firmware
|
||||
|
||||
- find the correct Unified Target for your board based on the MCU type, according to the table below. If your target's MCU is not listed, please open an [issue](https://github.com/betaflight/betaflight/issues) about this to let us know there is demand. Currently, MCU types with only one or two boards using them are not released as unified targets.
|
||||
|
||||
|
@ -73,13 +92,15 @@ These instructions explain how to create a Unified Target configuration for an e
|
|||
|-|-|
|
||||
|STM32F405|STM32F405|
|
||||
|STM32F411|STM32F411|
|
||||
|STM32G47X|STM32G471|
|
||||
|STM32F7X2|STM32F722|
|
||||
|STM32F745|STM32F745|
|
||||
|STM32H743|STM32H743|
|
||||
|
||||
- find and install the firmware (4.0 or newer) for the Unified Target identified above. The firmware is available from the board type drop-down in configurator. Be aware that after flashing this firmware, the LEDs on your board will not be working - this is normal.
|
||||
|
||||
|
||||
### 2.5. Do the initial setup for your Unified Target configuration
|
||||
### 2.6. Do the initial setup for your Unified Target configuration
|
||||
|
||||
- connect to your board running the Unified Target firmware, enter CLI;
|
||||
|
||||
|
@ -88,7 +109,7 @@ These instructions explain how to create a Unified Target configuration for an e
|
|||
- when the board reboots now, the LEDs should start working again - this is a sign that the previous step was successful.
|
||||
|
||||
|
||||
### 2.6. Add custom settings for your board to the Unified Target configuration
|
||||
### 2.7. Add custom settings for your board to the Unified Target configuration
|
||||
|
||||
- enter the command: `feature OSD` in CLI, just before the #master section (to switch on OSD by default);
|
||||
|
||||
|
@ -101,15 +122,15 @@ These instructions explain how to create a Unified Target configuration for an e
|
|||
- save the changes;
|
||||
|
||||
|
||||
### 2.7. Create a Unified Target configuration file for your board
|
||||
### 2.8. 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 `<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 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;
|
||||
|
||||
### 2.8. Test
|
||||
### 2.9. Test
|
||||
|
||||
- thoroughly test your new Unified Target configuration with the actual hardware (or a prototype of it). Make sure you test all peripherals (gyro, OSD, flash, SDcard, ...) and all motor outputs (with analog and digital protocols). Ideally you want to flight test as well. Remember that Betaflight does no testing of your Unified Target configuration, and once it has been accepted it will become available to your customers through Betaflight Configurator immediately - if it does not work then this will reflect badly onto your company and its products;
|
||||
|
||||
### 2.9. Get it added to Betaflight
|
||||
### 3.0. Get it added to Betaflight
|
||||
- open a [pull request](https://github.com/betaflight/unified-targets/pulls) to put your target configuration into `configs/default`.
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue