Skip to content

Commit

Permalink
Document OOT / app layer configuration options
Browse files Browse the repository at this point in the history
  • Loading branch information
gemenerik committed Aug 8, 2024
1 parent 9c93952 commit 16e9540
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 1 deletion.
2 changes: 1 addition & 1 deletion docs/development/oot.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ If you have header files in another folder, use `EXTRA_CFLAGS` in the Makefile t
EXTRA_CFLAGS += -I$(PWD)/src/inc
```

And since you are providing a config file by way of `$(OOT_CONFIG)` you do not need to run any make command to create a config like `make menuconfig` or `make defconfig`. Just a simple `make` will suffice.
OOT builds can be configured with [Kbuild](https://www.bitcraze.io/documentation/repository/crazyflie-firmware/master/development/kbuild/) using terminal interfaces like `make menuconfig` or by loading a default configuration, such as with `make cf2_defconfig`. Any definitions in $(OOT_CONFIG) will override conflicting settings.

## OOT estimators
The `config` file needs to enable ESTIMATOR_OOT, and can also set other config options:
Expand Down
4 changes: 4 additions & 0 deletions docs/userguides/app_layer.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,10 @@ obj-y += your-app.o

You can look at the applications in the `examples/` folder of the firmware repository.

## Configuring the app layer

The app layer can be configured with [Kbuild](https://www.bitcraze.io/documentation/repository/crazyflie-firmware/master/development/kbuild/). Default configurations can be loaded by running `make cf2_defconfig` in the app directory. Terminal based user interfaces ('menuconfig', 'nconfig', 'gconfig', 'xconfig') can be used to configure the app layer by e.g. running `make menuconfig` in the app directory. Note that if there are any conflicting settings, the values defined in `app-config` will take priority.

## Building the app layer

In order to build the app layer, go to the root folder of the app example and run:
Expand Down

0 comments on commit 16e9540

Please sign in to comment.