|
| 1 | +# Get started with SysConfig |
| 2 | + |
| 3 | +System Configuration Tool (SysConfig) is a graphical interface for configuring |
| 4 | +your project. Configuration files, C source files and header files are generated |
| 5 | +based on the parameters configured in the SysConfig dashboard. |
| 6 | + |
| 7 | +SysConfig should be used as a standalone tool for script-based builds (such as |
| 8 | +for Matter). |
| 9 | + |
| 10 | +The document will help for getting started in tailoring the `syscfg` file to |
| 11 | +your application needs. |
| 12 | + |
| 13 | +## Using Stand-alone SysConfig |
| 14 | + |
| 15 | +You can find the standalone SysConfig tool on the |
| 16 | +[SysConfig Standalone Installer Download Page](https://www.ti.com/tool/SYSCONFIG). |
| 17 | + |
| 18 | +The location of the Matter `syscfg` file is located here: |
| 19 | +`/examples/<name>/cc13x4_26x4/chip.syscfg` For example, on the github web: |
| 20 | +`https://github.com/project-chip/connectedhomeip/blob/master/examples/lock-app/cc13x4_26x4/chip.syscfg` |
| 21 | +The local file in your cloned repository should be used. |
| 22 | + |
| 23 | +This file is used by Matter build scripts, when it invokes SysConfig CLI. In |
| 24 | +order to edit the file for your custom application configurations, you'll need |
| 25 | +to open the file with the SysConfig GUI. Before doing so, you should add the |
| 26 | +following line above the `/* Modules */` comment: |
| 27 | + |
| 28 | +``` |
| 29 | +// @cliArgs --product <path to SDK>/.metadata/product.json --board /ti/boards/LP_EM_CC1354P10_6 --rtos freertos |
| 30 | +``` |
| 31 | + |
| 32 | +As an example, after adding the necessary `<path to SDK>`, it would look like: |
| 33 | + |
| 34 | +``` |
| 35 | +// @cliArgs --product /home/Documents/repos/connectedhomeip/third_party/ti_simplelink_sdk/repo_cc13xx_cc26xx/.metadata/product.json --board /ti/boards/LP_EM_CC1354P10_6 --rtos freertos |
| 36 | +``` |
| 37 | + |
| 38 | +If the file is not found, then you may need to first initialize the submodules: |
| 39 | + |
| 40 | +``` |
| 41 | +git submodule update --init |
| 42 | +``` |
| 43 | + |
| 44 | +Now you can open the file in SysConfig GUI. Once you are done, remove the |
| 45 | +`@cliArgs` line then save the file. Now the Matter build scripts will use the |
| 46 | +updated `.syscfg` file. |
| 47 | + |
| 48 | +## Viewing SysConfig Output |
| 49 | + |
| 50 | +To preview the code to be generated reference the `Generated Files` image, the |
| 51 | +button at the top of the `Configuration` pane you will find a list of Generated |
| 52 | +Files. After selecting a file you will be able, in real-time, to identify how |
| 53 | +the changes in the GUI affect the generated files. This will help you review the |
| 54 | +relationship between the GUI and the code. |
| 55 | + |
| 56 | +<div style="text-align: center;"> |
| 57 | + <img src="images/generated_files_ble.png" alt="Generated Files" width=30%> |
| 58 | + <div class="caption">Generated Files</div> |
| 59 | +</div> |
| 60 | + |
| 61 | +Whenever you re-build the project, SysConfig will re-generate the files. Because |
| 62 | +of this, any changes made directly in the generated files will be overwritten. |
0 commit comments