Skip to content

Commit c44a241

Browse files
committed
Merge branch 'controller_docs' into 'main'
docs: Controller docs improvement See merge request app-frameworks/esp-matter!1222
2 parents a91e6ff + e8f8b3b commit c44a241

File tree

13 files changed

+712
-593
lines changed

13 files changed

+712
-593
lines changed

components/esp_matter_controller/attestation_store/esp_matter_attestation_trust_store.cpp

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -307,6 +307,13 @@ CHIP_ERROR dcl_attestation_trust_store::GetProductAttestationAuthorityCert(const
307307
}
308308
#endif // CONFIG_DCL_ATTESTATION_TRUST_STORE
309309

310+
static AttestationTrustStore *s_custom_store = nullptr;
311+
312+
void set_custom_attestation_trust_store(AttestationTrustStore *custom_store)
313+
{
314+
s_custom_store = custom_store;
315+
}
316+
310317
const AttestationTrustStore *get_attestation_trust_store()
311318
{
312319
#if CONFIG_TEST_ATTESTATION_TRUST_STORE
@@ -316,6 +323,8 @@ const AttestationTrustStore *get_attestation_trust_store()
316323
return &spiffs_attestation_trust_store::get_instance();
317324
#elif CONFIG_DCL_ATTESTATION_TRUST_STORE
318325
return &dcl_attestation_trust_store::get_instance();
326+
#elif CONFIG_CUSTOM_ATTESTATION_TRUST_STORE
327+
return s_custom_store;
319328
#endif
320329
}
321330

components/esp_matter_controller/attestation_store/esp_matter_attestation_trust_store.h

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -92,6 +92,8 @@ class dcl_attestation_trust_store : public AttestationTrustStore {
9292
};
9393
#endif // CONFIG_DCL_ATTESTATION_TRUST_STORE
9494

95+
void set_custom_attestation_trust_store(AttestationTrustStore *custom_store);
96+
9597
const AttestationTrustStore *get_attestation_trust_store();
9698

9799
} // namespace Credentials

components/esp_matter_controller/core/esp_matter_controller_console.cpp

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -631,12 +631,6 @@ esp_err_t controller_register_commands()
631631
"\tcontroller pairing unpair <nodeid>",
632632
.handler = controller_pairing_handler,
633633
},
634-
{
635-
.name = "group-settings",
636-
.description = "Managing the groups and keysets of the controller.\n"
637-
"\tUsage: controller group-settings <sub-commands>",
638-
.handler = controller_group_settings_handler,
639-
},
640634
{
641635
.name = "icd",
642636
.description = "icd client management.\n"
@@ -654,6 +648,14 @@ esp_err_t controller_register_commands()
654648
},
655649
#endif
656650
#endif // CONFIG_ESP_MATTER_COMMISSIONER_ENABLE
651+
#ifndef CONFIG_ESP_MATTER_ENABLE_MATTER_SERVER
652+
{
653+
.name = "group-settings",
654+
.description = "Managing the groups and keysets of the controller.\n"
655+
"\tUsage: controller group-settings <sub-commands>",
656+
.handler = controller_group_settings_handler,
657+
},
658+
#endif // !CONFIG_ESP_MATTER_ENABLE_MATTER_SERVER
657659
{
658660
.name = "open-commissioning-window",
659661
.description =

docs/en/app_guide.rst

Lines changed: 50 additions & 50 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
1-
9. Application User Guide
2-
<<<<<<<<<<<<<<<<<<<<<<<<<
1+
Application User Guide
2+
======================
33

4-
9.1. Delegate Implementation
5-
============================
4+
1. Delegate Implementation
5+
--------------------------
66

77
As per the implementation in the connectedhomeip repository, some of the clusters
88
require an application defined delegate to consume specific data and actions.
@@ -49,8 +49,8 @@ List of clusters with delegate:
4949
- Energy Preference Cluster.
5050
- Commissioner Control Cluster.
5151

52-
9.1.1 Mode Base Cluster
53-
-----------------------
52+
1.1 Mode Base Cluster
53+
~~~~~~~~~~~~~~~~~~~~~
5454

5555
It is a base cluster for ModeEVSE, ModeOven, ModeRVSRun, ModeRVSClean, ModeDishwasher,
5656
ModeWaterHeater, ModeRefrigerator, ModeLaundryWasher and ModeMicrowaveOven.
@@ -67,177 +67,177 @@ ModeWaterHeater, ModeRefrigerator, ModeLaundryWasher and ModeMicrowaveOven.
6767
, `Device Energy Management Mode`_
6868
, `Water Heater Mode`_
6969

70-
9.1.2 Energy Evse Cluster
71-
-------------------------
70+
1.2 Energy Evse Cluster
71+
~~~~~~~~~~~~~~~~~~~~~~~
7272

7373
.. csv-table::
7474
:header: "Delegate Class", "Reference Implementation"
7575

7676
`Energy Evse`_, `Energy Evse Delegate`_
7777

78-
9.1.3 Operational State Cluster
79-
-------------------------------
78+
1.3 Operational State Cluster
79+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
8080

8181
.. csv-table::
8282
:header: "Delegate Class", "Reference Implementation"
8383

8484
`Operational State`_, `Operational State Delegate`_
8585

86-
9.1.4 Microwave Oven Control Cluster
87-
------------------------------------
86+
1.4 Microwave Oven Control Cluster
87+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
8888

8989
.. csv-table::
9090
:header: "Delegate Class", "Reference Implementation"
9191

9292
`Microwave Oven Control`_, `Microwave Oven Control Delegate`_
9393

94-
9.1.5 Fan Control Cluster
95-
-------------------------
94+
1.5 Fan Control Cluster
95+
~~~~~~~~~~~~~~~~~~~~~~~
9696

9797
.. csv-table::
9898
:header: "Delegate Class", "Reference Implementation"
9999

100100
`Fan Control`_, `Fan Control Delegate`_
101101

102-
9.1.6 Resource Monitoring Cluster
103-
---------------------------------
102+
1.6 Resource Monitoring Cluster
103+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
104104

105105
.. csv-table::
106106
:header: "Delegate Class", "Reference Implementation"
107107

108108
`Resource Monitoring`_, `Resource Monitoring Delegate`_
109109

110-
9.1.7 Laundry Dryer Controls Cluster
111-
------------------------------------
110+
1.7 Laundry Dryer Controls Cluster
111+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
112112

113113
.. csv-table::
114114
:header: "Delegate Class", "Reference Implementation"
115115

116116
`Laundry Dryer Controls`_, `Laundry Dryer Controls Delegate`_
117117

118118

119-
9.1.8 Valve Configuration And Control Cluster
120-
---------------------------------------------
119+
1.8 Valve Configuration And Control Cluster
120+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
121121

122122
.. csv-table::
123123
:header: "Delegate Class", "Reference Implementation"
124124

125125
`Valve Configuration And Control`_, `Valve Configuration And Control Delegate`_
126126

127-
9.1.9 Device Energy Management Cluster
128-
--------------------------------------
127+
1.9 Device Energy Management Cluster
128+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
129129

130130
.. csv-table::
131131
:header: "Delegate Class", "Reference Implementation"
132132

133133
`Device Energy Management`_, `Device Energy Management Delegate`_
134134

135-
9.1.10 Door Lock Cluster
136-
------------------------
135+
1.10 Door Lock Cluster
136+
~~~~~~~~~~~~~~~~~~~~~~
137137

138138
.. csv-table::
139139
:header: "Delegate Class", "Reference Implementation"
140140

141141
`Door Lock`_, None
142142

143-
9.1.11 Boolean State Configuration Cluster
144-
------------------------------------------
143+
1.11 Boolean State Configuration Cluster
144+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
145145

146146
.. csv-table::
147147
:header: "Delegate Class", "Reference Implementation"
148148

149149
`Boolean State Configuration`_, None
150150

151-
9.1.12 Time Synchronization Cluster
152-
-----------------------------------
151+
1.12 Time Synchronization Cluster
152+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
153153

154154
.. csv-table::
155155
:header: "Delegate Class", "Reference Implementation"
156156

157157
`Time Synchronization`_, `Time Synchronization Delegate`_
158158

159-
9.1.13 Application Basic Cluster
160-
--------------------------------
159+
1.13 Application Basic Cluster
160+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
161161

162162
.. csv-table::
163163
:header: "Delegate Class", "Reference Implementation"
164164

165165
`Application Basic`_, None
166166

167-
9.1.14 Power Topology Cluster
168-
-----------------------------
167+
1.14 Power Topology Cluster
168+
~~~~~~~~~~~~~~~~~~~~~~~~~~~
169169

170170
.. csv-table::
171171
:header: "Delegate Class", "Reference Implementation"
172172

173173
`Power Topology`_, `Power Topology Delegate`_
174174

175-
9.1.15 Electrical Power Measurement Cluster
176-
-------------------------------------------
175+
1.15 Electrical Power Measurement Cluster
176+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
177177

178178
.. csv-table::
179179
:header: "Delegate Class", "Reference Implementation"
180180

181181
`Electrical Power Measurement`_, `Electrical Power Measurement Delegate`_
182182

183-
9.1.16 Laundry Washer Controls Cluster
184-
--------------------------------------
183+
1.16 Laundry Washer Controls Cluster
184+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
185185

186186
.. csv-table::
187187
:header: "Delegate Class", "Reference Implementation"
188188

189189
`Laundry Washer Controls`_, `Laundry Washer Controls Delegate`_
190190

191-
9.1.17 Window Covering Cluster
192-
------------------------------
191+
1.17 Window Covering Cluster
192+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
193193

194194
.. csv-table::
195195
:header: "Delegate Class", "Reference Implementation"
196196

197197
`Window Covering`_, `Window Covering Delegate`_
198198

199-
9.1.18 Dishwasher Alarm Cluster
200-
-------------------------------
199+
1.18 Dishwasher Alarm Cluster
200+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
201201

202202
.. csv-table::
203203
:header: "Delegate Class", "Reference Implementation"
204204

205205
`Dishwasher Alarm`_, `Dishwasher Alarm Delegate`_
206206

207-
9.1.19 Keypad Input Cluster
208-
---------------------------
207+
1.19 Keypad Input Cluster
208+
~~~~~~~~~~~~~~~~~~~~~~~~~
209209

210210
.. csv-table::
211211
:header: "Delegate Class", "Reference Implementation"
212212

213213
`Keypad Input`_, `Keypad Input Delegate`_
214214

215-
9.1.20 Mode Select Cluster
216-
--------------------------
215+
1.20 Mode Select Cluster
216+
~~~~~~~~~~~~~~~~~~~~~~~~
217217

218218
.. csv-table::
219219
:header: "Delegate Class", "Reference Implementation"
220220

221221
`Mode Select`_, `Mode Select Delegate`_
222222

223-
9.1.21 Water Heater Management Cluster
224-
--------------------------------------
223+
1.21 Water Heater Management Cluster
224+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
225225

226226
.. csv-table::
227227
:header: "Delegate Class", "Reference Implementation"
228228

229229
`Water Heater Management`_, `Water Heater Management Delegate`_
230230

231-
9.1.22 Energy Preference Cluster
232-
--------------------------------
231+
1.22 Energy Preference Cluster
232+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
233233

234234
.. csv-table::
235235
:header: "Delegate Class", "Reference Implementation"
236236

237237
`Energy Preference`_, `Energy Preference Delegate`_
238238

239-
9.1.23 Commissioner Control Cluster
240-
-----------------------------------
239+
1.23 Commissioner Control Cluster
240+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
241241

242242
.. csv-table::
243243
:header: "Delegate Class", "Reference Implementation"

0 commit comments

Comments
 (0)