Skip to content

Commit b71a89d

Browse files
Adam-MaciugaArekBalysNordic
authored andcommitted
Applications: matter bridge: Kconfig: prompt and help improvement
Shortened the prompts Moved additional information to help Signed-off-by: Adam Maciuga <[email protected]>
1 parent e36876e commit b71a89d

File tree

1 file changed

+81
-21
lines changed
  • applications/matter_bridge/src/core

1 file changed

+81
-21
lines changed

applications/matter_bridge/src/core/Kconfig

Lines changed: 81 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -4,89 +4,149 @@
44
# SPDX-License-Identifier: LicenseRef-Nordic-5-Clause
55
#
66

7+
menu "Bridge configuration"
8+
79
config BRIDGE_MAX_DYNAMIC_ENDPOINTS_NUMBER
8-
int "Maximum number of dynamic endpoints supported by the Bridge"
10+
int "Maximum dynamic endpoints"
911
default 16
12+
help
13+
Maximum number of endpoints supported by the bridge.
1014

1115
config BRIDGE_MAX_BRIDGED_DEVICES_NUMBER
12-
int "Maximum number of physical non-Matter devices supported by the Bridge"
16+
int "Maximum bridged devices"
1317
default 16
18+
help
19+
Maximum number of physical non-Matter devices supported by the bridge.
1420

1521
config BRIDGE_MAX_BRIDGED_DEVICES_NUMBER_PER_PROVIDER
16-
int "Maximum number of endpoints paired to the one non-Matter provider device"
22+
int "Maximum endpoints per provider"
1723
default 2
24+
help
25+
Maximum number of endpoints paired to one non-Matter provider device.
1826

1927
config BRIDGE_AGGREGATOR_ENDPOINT_ID
20-
int "Id of an endpoint implementing Aggregator device type functionality"
28+
int "Aggregator endpoint ID"
2129
default 1
30+
help
31+
ID of the endpoint implementing Aggregator device type functionality.
32+
33+
menu "Migration options"
2234

2335
config BRIDGE_MIGRATE_PRE_2_7_0
24-
bool "Migration of bridged device data stored in old scheme from pre nRF SDK 2.7.0 releases"
36+
bool "Migrate pre-2.7.0 data"
37+
help
38+
Enable migration of bridged device data stored in the old scheme (pre-nRF SDK 2.7.0).
2539

2640
config BRIDGE_MIGRATE_VERSION_1
27-
bool "Migration of bridged device data stored in version 1 of new scheme"
41+
bool "Migrate version 1 data"
2842
default y
43+
help
44+
Enable migration of bridged device data stored in version 1 of the new scheme.
45+
46+
endmenu
2947

3048
if BRIDGED_DEVICE_BT
3149

50+
menu "Bluetooth bridge configuration"
51+
3252
config BRIDGE_BT_RECOVERY_MAX_INTERVAL
33-
int "Maximum time (in s) between recovery attempts when the BLE connection to the bridged device is lost"
53+
int "Recovery interval (s)"
3454
default 300
55+
help
56+
Maximum time (in seconds) between recovery attempts when a Bluetooth LE connection is lost.
3557

3658
config BRIDGE_BT_RECOVERY_SCAN_TIMEOUT_MS
37-
int "Time (in ms) within which the Bridge will try to re-establish a connection to the lost BT LE device"
59+
int "Recovery scan timeout (ms)"
3860
default 2000
61+
help
62+
Time (in milliseconds) to attempt reconnection to a lost Bluetooth LE device.
3963

4064
config BRIDGE_BT_MAX_SCANNED_DEVICES
41-
int "Maximum amount of scanned devices"
65+
int "Maximum scanned devices"
4266
default 16
67+
help
68+
Maximum number of Bluetooth devices that can be scanned at once.
4369

4470
config BRIDGE_BT_SCAN_TIMEOUT_MS
45-
int "Bluetooth scan timeout in milliseconds"
71+
int "Scan timeout (ms)"
4672
default 10000
73+
help
74+
Bluetooth scan timeout in milliseconds.
4775

4876
config BRIDGE_BT_MINIMUM_SECURITY_LEVEL
49-
int "Minimum Bluetooth security level of bridged devices that will be accepted by the bridge device"
77+
int "Minimum security level"
5078
default 2
5179
range 2 4
5280
depends on BT_SMP
5381
help
54-
The minimum Bluetooth security level means that the bridged devices using this or a higher level will be
55-
allowed to connect to the bridge. The level cannot be set to a value smaller than 2, as it would mean that
56-
the communication with the connected devices will not be encrypted, what is not considered to be secure.
82+
The minimum Bluetooth security level means that the bridged devices using this or a higher level will be
83+
allowed to connect to the bridge. The level cannot be set to a value smaller than 2, as it would mean that
84+
the communication with the connected devices will not be encrypted, what is not considered to be secure.
5785

5886
config BRIDGE_BT_SCAN_WINDOW
59-
int "Time duration of a central actively scanning for devices within scan interval, it is equal BRIDGE_BT_SCAN_WINDOW*0.625 ms"
87+
int "Scan window"
6088
default 40 if OPENTHREAD # It is necessary to decrease Bluetooth LE activity to leave some radio time to Thread
6189
default 48
90+
help
91+
Duration of active scanning per interval (x0.625 ms).
92+
Default: 40 (25 ms).
93+
Longer windows improve discovery speed but increase power use.
6294

6395
config BRIDGE_BT_SCAN_INTERVAL
64-
int "Time between consecutive Bluetooth scan windows, it is equal BRIDGE_BT_SCAN_INTERVAL*0.625 ms"
96+
int "Scan interval"
6597
default 160 if OPENTHREAD # It is necessary to decrease Bluetooth LE activity to leave some radio time to Thread
6698
default 96
99+
help
100+
Time between consecutive scan windows (x0.625 ms).
101+
Default: 160 (100 ms).
102+
Must be ≥ scan window.
103+
Shorter intervals speed discovery but increase power use.
67104

68105
config BRIDGE_BT_CONNECTION_INTERVAL_MIN
69-
int "It is the minimum duration of time requested by central after the peripheral device should wake up to communicate, it is equal BRIDGE_BT_CONNECTION_INTERVAL_MIN*1.25 ms"
106+
int "Minimum connection interval"
70107
range 6 3200
71108
default 80 if OPENTHREAD # It is necessary to decrease Bluetooth LE activity to leave some radio time to Thread
72109
default 24
110+
help
111+
Minimum time between connection events (x1.25 ms).
112+
Default: 80 (100 ms).
113+
Shorter intervals reduce latency but increase power consumption.
73114

74115
config BRIDGE_BT_CONNECTION_INTERVAL_MAX
75-
int "It is the maximum duration of time requested by central after the peripheral device should wake up to communicate, it is equal BRIDGE_BT_CONNECTION_INTERVAL_MAX*1.25 ms"
116+
int "Maximum connection interval"
76117
range 6 3200
77118
default 80 if OPENTHREAD # It is necessary to decrease Bluetooth LE activity to leave some radio time to Thread
78119
default 40
120+
help
121+
Maximum time between connection events (x1.25 ms).
122+
Default: 80 (100 ms).
123+
Must be ≥ minimum interval.
79124

80125
config BRIDGE_BT_CONNECTION_TIMEOUT
81-
int "The time since the last packet was successfully received until the devices consider the connection lost, it is equal BRIDGE_BT_CONNECTION_TIMEOUT cs"
126+
int "Connection timeout"
82127
default 400
128+
help
129+
Time until connection is considered lost (x10 ms).
130+
Default: 400 (4 sec).
131+
Must be > (1 + latency) x interval_max x 2.
83132

84133
config BRIDGE_BT_CONNECTION_LATENCY
85-
int "It allows the peripheral to skip waking up for a certain number of connection events if it does not have any data to send"
134+
int "Connection latency"
86135
default 0
136+
help
137+
Number of connection events peripheral can skip when idle.
138+
Default: 0.
139+
Higher values save power but increase latency.
87140

88141
config BRIDGE_FORCE_BT_CONNECTION_PARAMS
89-
bool "Determines whether the Matter bridge forces connection parameters or accepts the Bluetooth LE peripheral device selection"
142+
bool "Force connection parameters"
90143
default y
144+
help
145+
Enforce bridge-defined connection parameters instead of accepting the peripheral's preferred values.
146+
Enable for guaranteed timing, disable for peripheral optimization.
147+
148+
endmenu
91149

92150
endif
151+
152+
endmenu

0 commit comments

Comments
 (0)