Skip to content

Commit

Permalink
Update Image spelling
Browse files Browse the repository at this point in the history
  • Loading branch information
adabreuti committed Jun 24, 2024
1 parent 5441bd6 commit d629c32
Show file tree
Hide file tree
Showing 9 changed files with 33 additions and 30 deletions.
2 changes: 1 addition & 1 deletion docs/guides/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@
- [Silicon Labs - Software Update](./silabs_efr32_software_update.md)
- [Silicon Labs - CLI Guide](./silabs_cli_guide.md)
- [STMicroelectronics (STM32)](./stm32_getting_started_guide.md)
- [TI - Platform Overview](./ti/ti_platform_overview.md)
- [TI - Platform Overview](./ti/matter-users-guide/ti_matter_overview.md)
- [Open IoT SDK - Platform Overview](./openiotsdk_platform_overview.md)
- [Open IoT SDK - Examples](./openiotsdk_examples.md)
- [Open IoT SDK - Unit Tests](./openiotsdk_unit_tests.md)
Expand Down
2 changes: 1 addition & 1 deletion docs/guides/darwin.md
Original file line number Diff line number Diff line change
Expand Up @@ -267,7 +267,7 @@ Example:
- [Silicon Labs](./silabs_getting_started.md)
- [Simulated Linux](./simulated_device_linux.md)
- [Telink](/examples/lighting-app/telink/README.md)
- [TI Platform](./ti/ti_platform_overview.md)
- [TI Platform](./ti/matter-users-guide/ti_matter_overview.md)
- [TI All Clusters](/examples/all-clusters-app/cc13x4_26x4/README.md)
- [Tizen](/examples/lighting-app/tizen/README.md)

Expand Down
2 changes: 1 addition & 1 deletion docs/guides/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ ti/ti_platform_overview
- [Silicon Labs - Getting Started](./silabs_getting_started.md)
- [Silicon Labs - Software Update](./silabs_efr32_software_update.md)
- [Silicon Labs - CLI Guide](./silabs_cli_guide.md)
- [TI - Platform Overview](./ti/ti_platform_overview.md)
- [TI - Platform Overview](./ti/matter-users-guide/ti_matter_overview.md)

## Tool Guides

Expand Down
51 changes: 27 additions & 24 deletions docs/guides/ti/matter-syscfg/getting-started.md
Original file line number Diff line number Diff line change
@@ -1,26 +1,29 @@
# Get started with SysConfig

System Configuration Tool (SysConfig) is a graphical interface for
configuring your project. Configuration files, C source files and header
files are generated based on the parameters configured in the SysConfig
dashboard.
System Configuration Tool (SysConfig) is a graphical interface for configuring
your project. Configuration files, C source files and header files are generated
based on the parameters configured in the SysConfig dashboard.

SysConfig should be used as a standalone tool for script-based builds (such as for Matter).
SysConfig should be used as a standalone tool for script-based builds (such as
for Matter).

The document will help for getting started in tailoring the syscfg file to your application needs.
The document will help for getting started in tailoring the `syscfg` file to
your application needs.

## Using Stand-alone SysConfig

You can find the standalone SysConfig tool on the [SysConfig Standalone
Installer Download Page](https://www.ti.com/tool/SYSCONFIG).
You can find the standalone SysConfig tool on the
[SysConfig Standalone Installer Download Page](https://www.ti.com/tool/SYSCONFIG).

The location of the Matter syscfg file is located here: `/examples/<name>/cc13x4_26x4/chip.syscfg`
For example, on the github web: https://github.com/project-chip/connectedhomeip/blob/master/examples/lock-app/cc13x4_26x4/chip.syscfg
The location of the Matter `syscfg` file is located here:
`/examples/<name>/cc13x4_26x4/chip.syscfg` For example, on the github web:
`https://github.com/project-chip/connectedhomeip/blob/master/examples/lock-app/cc13x4_26x4/chip.syscfg`
The local file in your cloned repository should be used.

This file is used by Matter build scripts, when it invokes SysConfig CLI.
In order to edit the file for your custom application configurations, you'll need to open the file with the SysConfig GUI.
Before doing so, you should add the following line above the `/* Modules */` comment:
This file is used by Matter build scripts, when it invokes SysConfig CLI. In
order to edit the file for your custom application configurations, you'll need
to open the file with the SysConfig GUI. Before doing so, you should add the
following line above the `/* Modules */` comment:

```
// @cliArgs --product <path to SDK>/.metadata/product.json --board /ti/boards/LP_EM_CC1354P10_6 --rtos freertos
Expand All @@ -38,22 +41,22 @@ If the file is not found, then you may need to first initialize the submodules:
git submodule update --init
```

Now you can open the file in SysConfig GUI.
Once you are done, remove the `@cliArgs` line then save the file. Now the Matter build scripts will use the updated .syscfg file.
Now you can open the file in SysConfig GUI. Once you are done, remove the
`@cliArgs` line then save the file. Now the Matter build scripts will use the
updated `.syscfg` file.

## Viewing SysConfig Output

To preview the code to be generated reference the `Generated Files` image, the button at the top of
the `Configuration` pane you will find a list of Generated Files. After
selecting a file you will be able, in real-time, to identify how the
changes in the GUI affect the generated files. This will help you review
the relationship between the GUI and the code.
To preview the code to be generated reference the `Generated Files` image, the
button at the top of the `Configuration` pane you will find a list of Generated
Files. After selecting a file you will be able, in real-time, to identify how
the changes in the GUI affect the generated files. This will help you review the
relationship between the GUI and the code.

<div style="text-align: center;">
<img src="images/syscfg_generated_files_ble.png" alt="Generated Files" width=30%>
<img src="images/generated_files_ble.png" alt="Generated Files" width=30%>
<div class="caption">Generated Files</div>
</div>

Whenever you re-build the project, SysConfig will re-generate the files.
Because of this, any changes made directly in the generated files will
be overwritten.
Whenever you re-build the project, SysConfig will re-generate the files. Because
of this, any changes made directly in the generated files will be overwritten.
6 changes: 3 additions & 3 deletions docs/guides/ti/matter-syscfg/sysconfig-board.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ Below are the steps required to utilize the Reserve Peripherals feature.
2. Open the panel \"Reserve Peripherals\"

<div style="text-align: center;">
<img src="images/syscfg-reserve-peripheral-panel.png" width=30%>
<img src="images/reserve-peripheral-panel.png" width=30%>
</div>

3. Reserve the resources
Expand All @@ -53,7 +53,7 @@ Below are the steps required to utilize the Reserve Peripherals feature.
15

<div style="text-align: center;">
<img src="images/syscfg-reserve-gpio.png" width=30%>
<img src="images/reserve-gpio.png" width=30%>
</div>

SysConfig ensures no resource conflict occurs. In case no solution can be found,
Expand All @@ -70,5 +70,5 @@ resources.
Sysconfig Hardware View:

<div style="text-align: center;">
<img src="images/syscfg_hardware_view.png" width=30%>
<img src="images/hardware_view.png" width=30%>
</div>

0 comments on commit d629c32

Please sign in to comment.