Settings Editor header

All components share the Settings Editor header. In the header, you can view and change component information, enable or disable the component, and view component documentation (where applicable).

Figure 1. Settings Editor header
Table 1. Settings Editor header
Header item Description
Description Displays the configuration component title.
Name Displays the component instance name. This name is used in the generated code in constants and function identifiers and is derived from the peripheral name. You can change it at any time by clicking the Custom name button and editing the field.
Mode Displays the required usage for the component instance and influences available settings. Use the dropdown menu to change the mode (where applicable).
Peripheral Displays the name of the peripheral to be associated with the component instance. Use the dropdown menu to change it.
Documentation Click the button to view configuration component-specific documentation in the Documentation view. Not all configuration components are documented, therefore not all setting headers contain the Documentation icon.
Lock editing Click the button to lock/unlock component editing. Source code will still be generated.
Enable/disable component instance switch Use the switch to enable or disable selected component instance. By disabling the instance, you don’t remove it from the tools configuration, but prevent its inclusion in the generated code.