Use → Tutorials → Wizard: user guide

Wizard: user guide

The Wizard is a powerful configuration tool created to simplify BeRTOS project creation. Using the Wizard you can create with a few clicks a project template, select the modules you need and modify the configuration of each module with an intuitive and user friendly interface. The resulting project can be built using the BeRTOS Build System and it's ready for project development.

Project creation page

In this page you can choose the project's name and the working directory.

WARNING: you must use only ASCII characters for your project's name.

The button on the right allows you to select the directory using the file selector window.

It's necessary to provide a valid name before continuing to the next page. If you select a name that is an already existing file or directory, the existing item will be deleted. If the directory you specified doesn't exists, it will be created.

Press "Next" to go to the next page.

BeRTOS version selection page

This page allows you to select the BeRTOS version you want to use for your project. If you are using the BeRTOS SDK you will see the versions installed with the SDK; in case you're using the SVN version of the Wizard, you won't find any version.

It's always possible to add a BeRTOS version by simply pressing on the "+" button and selecting the base BeRTOS directory you want to add.

Every time you add a version manually, the Wizard will try to identify the version and it will show the name and version number.

WARNING: if you choose an incorrect version you can still proceed, but probably the sources are not valid.

To remove a version, select it and press the "-" button. It's not possible to remove the default installed versions. You must select a BeRTOS version to continue.

Press the "Next" button to continue.

Development board selection

In this page you can select the target development board. BeRTOS supports a list of commonly-used predefined boards. You can choose any of them clicking on the list below.

It is even possible to choose a custom board (made with custom components). In this way the BeRTOS wizard will guide througth a different menu to virtually "build" the custom board, choosing any single component from the list of the supported drivers. In the first screen the user must select the CPU mounted on the custom board and the corresponding clock frequency.

Press the "Next" button to continue.

In this page the user can select a predefined template, that can be used as a starting point for your project.

BeRTOS provides three different types of template:

Templates: minimalist projects that simply initialize the hardware present on the board, providing an empty C main;
Examples: full-featured applications ready to be compiled and flashed to the target board;
Benchmarks: example projects to measure the different BeRTOS performance.

Choose the preferred template and press "Next" to continue.

Toolchain page selection

In this page you can select the toolchain to be used with the project. If you're using BeRTOS SDK you will be presented with the toolchains installed with the package, otherwise you must manually select the toolchain. The Wizard will automatically select the correct toolchain for your CPU, if present.

You can manually add a toolchain by clicking on the "+" button and then selecting the gcc executable you want to add.

As you can see from the screenshot, the Wizard will not automatically identify the toolchain. This is a security feature, since the validation process implies running the programs listed. To validate the toolchain, press the "Validate" button.

To remove a toolchain, select it from the list and press the "-" button.

WARNING: you can't remove the toolchains automatically installed with BeRTOS SDK.

It is also possible to do an automatic search for the toolchains installed in the system; simply press the "Search..." button.

The window with search options will be shown.

You can tell the Wizard to look for toolchains in your PATH by selecting the "Search in PATH" checkbox. Furthermore, you can add custom search paths by clicking on the "+" button and selecting the correct directory.

You can remove a custom search directory by selecting it and pressing the "-" button.

Press "Search" to start the search process.

All the toolchains found are added to the toolchain list, but they aren't automatically validated. Just press "Validate" to validate them all.

A green symbol will appear next to the toolchain if the toolchain was identified and it's correct for the CPU you selected in the previous step. The toolchains that are not identified will be marked with a red "X".

You must select a toolchain to continue.

WARNING: you can continue even if you select a wrong toolchain, however the created project may not work.

Press "Next" to continue to the next page.

BeRTOS modules selection and configuration page

After the toolchain selection, the wizard jumps to the modules configuration page. The Wizard will automatically find out all the available modules, analysing the source code of the selected BeRTOS version. The modules are divided into various categories.

To select a module, simply check it from the list.

WARNING: BeRTOS has many dependencies between the modules. It's possible (and recommended) to let the Wizard automatically resolve the dependencies by checking "Automatically fix dependencies".

If a module is coloured in red, it's not completely supported on your CPU. WARNING, if you select a partially supported module the project may not work properly.

You can configure the module by clicking on it. The configurable properties, if any, will appear on the side.

Press "Next" to continue with the next section.

Summary page

The final page shows a summary of all the previous settings.

Click on "Create" to generate all the BeRTOS project files in the target directory.

The make based BeRTOS Build System is active by default and it cannot be disactivated. In addition, the project files for the CodeLite IDE can be automatically generated by the Wizard. This option can be deactivated checking the box "Do not create the Codelite project files".