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