forked from project-chip/connectedhomeip-doc
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathVSCODE_DEVELOPMENT.html
825 lines (667 loc) · 56 KB
/
VSCODE_DEVELOPMENT.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
<!DOCTYPE html>
<html lang="en" >
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
<title>Visual Studio Code Development — Matter documentation</title>
<script data-cfasync="false">
document.documentElement.dataset.mode = localStorage.getItem("mode") || "";
document.documentElement.dataset.theme = localStorage.getItem("theme") || "light";
</script>
<!-- Loaded before other Sphinx assets -->
<link href="_static/styles/theme.css?digest=12da95d707ffb74b382d" rel="stylesheet" />
<link href="_static/styles/bootstrap.css?digest=12da95d707ffb74b382d" rel="stylesheet" />
<link href="_static/styles/pydata-sphinx-theme.css?digest=12da95d707ffb74b382d" rel="stylesheet" />
<link href="_static/vendor/fontawesome/6.1.2/css/all.min.css?digest=12da95d707ffb74b382d" rel="stylesheet" />
<link rel="preload" as="font" type="font/woff2" crossorigin href="_static/vendor/fontawesome/6.1.2/webfonts/fa-solid-900.woff2" />
<link rel="preload" as="font" type="font/woff2" crossorigin href="_static/vendor/fontawesome/6.1.2/webfonts/fa-brands-400.woff2" />
<link rel="preload" as="font" type="font/woff2" crossorigin href="_static/vendor/fontawesome/6.1.2/webfonts/fa-regular-400.woff2" />
<link rel="stylesheet" type="text/css" href="_static/pygments.css" />
<link rel="stylesheet" href="_static/styles/sphinx-book-theme.css?digest=14f4ca6b54d191a8c7657f6c759bf11a5fb86285" type="text/css" />
<!-- Pre-loaded scripts that we'll load fully later -->
<link rel="preload" as="script" href="_static/scripts/bootstrap.js?digest=12da95d707ffb74b382d" />
<link rel="preload" as="script" href="_static/scripts/pydata-sphinx-theme.js?digest=12da95d707ffb74b382d" />
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
<script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script src="_static/_sphinx_javascript_frameworks_compat.js"></script>
<script src="_static/doctools.js"></script>
<script src="_static/sphinx_highlight.js"></script>
<script src="_static/scripts/sphinx-book-theme.js?digest=5a5c038af52cf7bc1a1ec88eea08e6366ee68824"></script>
<script>DOCUMENTATION_OPTIONS.pagename = 'VSCODE_DEVELOPMENT';</script>
<link rel="shortcut icon" href="_static/favicon.ico"/>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="API" href="api/index.html" />
<link rel="prev" title="Matter Project Flow" href="PROJECT_FLOW.html" />
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<meta name="docsearch:language" content="en"/>
</head>
<body data-bs-spy="scroll" data-bs-target=".bd-toc-nav" data-offset="180" data-bs-root-margin="0px 0px -60%" data-default-mode="">
<a class="skip-link" href="#main-content">Skip to main content</a>
<input type="checkbox"
class="sidebar-toggle"
name="__primary"
id="__primary"/>
<label class="overlay overlay-primary" for="__primary"></label>
<input type="checkbox"
class="sidebar-toggle"
name="__secondary"
id="__secondary"/>
<label class="overlay overlay-secondary" for="__secondary"></label>
<div class="search-button__wrapper">
<div class="search-button__overlay"></div>
<div class="search-button__search-container">
<form class="bd-search d-flex align-items-center"
action="search.html"
method="get">
<i class="fa-solid fa-magnifying-glass"></i>
<input type="search"
class="form-control"
name="q"
id="search-input"
placeholder="Search..."
aria-label="Search..."
autocomplete="off"
autocorrect="off"
autocapitalize="off"
spellcheck="false"/>
<span class="search-button__kbd-shortcut"><kbd class="kbd-shortcut__modifier">Ctrl</kbd>+<kbd>K</kbd></span>
</form></div>
</div>
<nav class="bd-header navbar navbar-expand-lg bd-navbar">
</nav>
<div class="bd-container">
<div class="bd-container__inner bd-page-width">
<div class="bd-sidebar-primary bd-sidebar">
<div class="sidebar-header-items sidebar-primary__section">
</div>
<div class="sidebar-primary-items__start sidebar-primary__section">
<div class="sidebar-primary-item">
<a class="navbar-brand logo" href="index.html">
<img src="_static/logo.png" class="logo__image only-light" alt="Logo image"/>
<script>document.write(`<img src="_static/logo.png" class="logo__image only-dark" alt="Logo image"/>`);</script>
</a></div>
<div class="sidebar-primary-item"><ul class="navbar-icon-links navbar-nav"
aria-label="Icon Links">
<li class="nav-item">
<a href="https://github.com/project-chip/connectedhomeip" title="GitHub" class="nav-link" rel="noopener" target="_blank" data-bs-toggle="tooltip" data-bs-placement="bottom"><span><i class="fa-brands fa-square-github"></i></span>
<label class="sr-only">GitHub</label></a>
</li>
</ul></div>
<div class="sidebar-primary-item"><nav class="bd-links" id="bd-docs-nav" aria-label="Main">
<div class="bd-toc-item navbar-nav active">
<p aria-level="2" class="caption" role="heading"><span class="caption-text">Contents</span></p>
<ul class="current nav bd-sidenav">
<li class="toctree-l1"><a class="reference internal" href="QUICK_START.html">Quick Start</a></li>
<li class="toctree-l1"><a class="reference internal" href="PROJECT_FLOW.html">Matter Project Flow</a></li>
<li class="toctree-l1 current active"><a class="current reference internal" href="#">Visual Studio Code Development</a></li>
<li class="toctree-l1 has-children"><a class="reference internal" href="api/index.html">API</a><input class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-1"><i class="fa-solid fa-chevron-down"></i></label><ul>
<li class="toctree-l2"><a class="reference internal" href="api/device_runner.html">CHIP on-device testing</a></li>
<li class="toctree-l2"><a class="reference internal" href="api/device_runner_dispatch.html">CHIP on-device test dispatch</a></li>
</ul>
</li>
<li class="toctree-l1 has-children"><a class="reference internal" href="discussion/index.html">Discussion</a><input class="toctree-checkbox" id="toctree-checkbox-2" name="toctree-checkbox-2" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-2"><i class="fa-solid fa-chevron-down"></i></label><ul>
<li class="toctree-l2"><a class="reference internal" href="discussion/lwip_ipv6.html">LwIP changes for Matter</a></li>
</ul>
</li>
<li class="toctree-l1 has-children"><a class="reference internal" href="guides/index.html">Guides</a><input class="toctree-checkbox" id="toctree-checkbox-3" name="toctree-checkbox-3" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-3"><i class="fa-solid fa-chevron-down"></i></label><ul>
<li class="toctree-l2"><a class="reference internal" href="guides/BUILDING.html">Building Matter</a></li>
<li class="toctree-l2"><a class="reference internal" href="guides/README.html">Guides</a></li>
<li class="toctree-l2"><a class="reference internal" href="guides/access-control-guide.html">Access Control Guide</a></li>
<li class="toctree-l2"><a class="reference internal" href="guides/android_building.html">Building Android</a></li>
<li class="toctree-l2"><a class="reference internal" href="guides/chip_tool_guide.html">Working with the CHIP Tool</a></li>
<li class="toctree-l2"><a class="reference internal" href="guides/darwin.html">Testing with Apple Devices</a></li>
<li class="toctree-l2"><a class="reference internal" href="guides/infineon_psoc6_software_update.html">Matter Software Update with Infineon PSoC6 example applications</a></li>
<li class="toctree-l2"><a class="reference internal" href="guides/ip_commissioning.html">IP commissioning</a></li>
<li class="toctree-l2"><a class="reference internal" href="guides/matter-repl.html">Matter Python REPL</a></li>
<li class="toctree-l2"><a class="reference internal" href="guides/mbedos_add_new_target.html">Mbed-OS add new hardware target</a></li>
<li class="toctree-l2"><a class="reference internal" href="guides/mbedos_commissioning.html">Matter Arm Mbed OS provisioning guide</a></li>
<li class="toctree-l2"><a class="reference internal" href="guides/mbedos_platform_overview.html">Mbed-OS platform overview</a></li>
<li class="toctree-l2"><a class="reference internal" href="guides/nrfconnect_android_commissioning.html">Commissioning nRF Connect Accessory using Android CHIPTool</a></li>
<li class="toctree-l2"><a class="reference internal" href="guides/nrfconnect_examples_cli.html">Using CLI in nRF Connect examples</a></li>
<li class="toctree-l2"><a class="reference internal" href="guides/nrfconnect_examples_configuration.html">Configuring nRF Connect examples</a></li>
<li class="toctree-l2"><a class="reference internal" href="guides/nrfconnect_examples_software_update.html">Performing Device Firmware Upgrade in the nRF Connect examples</a></li>
<li class="toctree-l2"><a class="reference internal" href="guides/nrfconnect_factory_data_configuration.html">Configuring factory data for the nRF Connect examples</a></li>
<li class="toctree-l2"><a class="reference internal" href="guides/nrfconnect_platform_overview.html">nRF Connect platform overview</a></li>
<li class="toctree-l2"><a class="reference internal" href="guides/nxp_imx8m_linux_examples.html">Building and Running CHIP Linux Examples for i.MX 8M Mini EVK</a></li>
<li class="toctree-l2"><a class="reference internal" href="guides/nxp_k32w_android_commissioning.html">Commissioning NXP K32W using Android CHIPTool</a></li>
<li class="toctree-l2"><a class="reference internal" href="guides/openiotsdk_commissioning.html">Commissioning Open IoT SDK devices</a></li>
<li class="toctree-l2"><a class="reference internal" href="guides/openiotsdk_platform_overview.html">Open IoT SDK platform port</a></li>
<li class="toctree-l2"><a class="reference internal" href="guides/openthread_border_router_pi.html">Setup OpenThread Border Router on Raspberry Pi</a></li>
<li class="toctree-l2"><a class="reference internal" href="guides/openthread_rcp_nrf_dongle.html">Configuring OpenThread Radio Co-processor on nRF52840 Dongle</a></li>
<li class="toctree-l2"><a class="reference internal" href="guides/python_chip_controller_advanced_usage.html">Using Python CHIP Controller advanced features</a></li>
<li class="toctree-l2"><a class="reference internal" href="guides/python_chip_controller_building.html">Deprecation notice</a></li>
<li class="toctree-l2"><a class="reference internal" href="guides/silabs_efr32_building.html">Building Silicon Labs EFR32 examples</a></li>
<li class="toctree-l2"><a class="reference internal" href="guides/silabs_efr32_software_update.html">Matter Software Update with EFR32 example applications</a></li>
<li class="toctree-l2"><a class="reference internal" href="guides/simulated_device_linux.html">Simulated Device How-To (Linux)</a></li>
<li class="toctree-l2"><a class="reference internal" href="guides/ti_platform_overview.html">Texas Instruments platform overview</a></li>
<li class="toctree-l2"><a class="reference internal" href="guides/troubleshooting_avahi.html">Troubleshooting Avahi</a></li>
<li class="toctree-l2 has-children"><a class="reference internal" href="guides/esp32/README.html">Espressif (ESP32) Getting Started Guide</a><input class="toctree-checkbox" id="toctree-checkbox-4" name="toctree-checkbox-4" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-4"><i class="fa-solid fa-chevron-down"></i></label><ul>
<li class="toctree-l3"><a class="reference internal" href="guides/esp32/build_app_and_commission.html">ESP32 Application Usage Guide</a></li>
<li class="toctree-l3"><a class="reference internal" href="guides/esp32/factory_data.html">Using ESP32 Factory Data Provider</a></li>
<li class="toctree-l3"><a class="reference internal" href="guides/esp32/flash_nvs_encryption.html">Flash and NVS encryption</a></li>
<li class="toctree-l3"><a class="reference internal" href="guides/esp32/ota.html">Matter OTA</a></li>
<li class="toctree-l3"><a class="reference internal" href="guides/esp32/rpc_console.html">RPC Console and Device Tracing</a></li>
<li class="toctree-l3"><a class="reference internal" href="guides/esp32/setup_idf_chip.html">Setup ESP-IDF and Matter Environment</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l1 has-children"><a class="reference internal" href="style/index.html">Style Guides</a><input class="toctree-checkbox" id="toctree-checkbox-5" name="toctree-checkbox-5" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-5"><i class="fa-solid fa-chevron-down"></i></label><ul>
<li class="toctree-l2"><a class="reference internal" href="style/STYLE_MAKEFILES.html">CHIP Makefile Style Guide</a></li>
<li class="toctree-l2"><a class="reference internal" href="style/style_guide.html">Matter Documentation Style Guide</a></li>
</ul>
</li>
<li class="toctree-l1 has-children"><a class="reference internal" href="examples/index.html">Examples</a><input class="toctree-checkbox" id="toctree-checkbox-6" name="toctree-checkbox-6" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-6"><i class="fa-solid fa-chevron-down"></i></label><ul>
<li class="toctree-l2"><a class="reference internal" href="examples/all-clusters-app/ameba/README.html">CHIP Ameba All Clusters Example</a></li>
<li class="toctree-l2"><a class="reference internal" href="examples/all-clusters-app/cc13x2x7_26x2x7/README.html">Matter CC1352 CC2652 All-clusters Example Application</a></li>
<li class="toctree-l2"><a class="reference internal" href="examples/all-clusters-app/esp32/README.html">CHIP ESP32 All Clusters Example</a></li>
<li class="toctree-l2"><a class="reference internal" href="examples/all-clusters-app/infineon/psoc6/README.html">CHIP PSoC6 All Clusters Example</a></li>
<li class="toctree-l2"><a class="reference internal" href="examples/all-clusters-app/linux/README.html">Matter Linux/Mac All Clusters Example</a></li>
<li class="toctree-l2"><a class="reference internal" href="examples/all-clusters-app/mbed/README.html">Matter Arm Mbed OS All Clusters Example Application</a></li>
<li class="toctree-l2"><a class="reference internal" href="examples/all-clusters-app/nrfconnect/README.html">Matter nRF Connect All Clusters Example Application</a></li>
<li class="toctree-l2"><a class="reference internal" href="examples/all-clusters-app/nxp/mw320/README.html">Matter MW320 All Clusters Example Application</a></li>
<li class="toctree-l2"><a class="reference internal" href="examples/all-clusters-app/telink/Readme.html">Matter Telink All Clusters Example Application</a></li>
<li class="toctree-l2"><a class="reference internal" href="examples/all-clusters-minimal-app/ameba/README.html">CHIP Ameba All Clusters Example</a></li>
<li class="toctree-l2"><a class="reference internal" href="examples/all-clusters-minimal-app/cc13x2x7_26x2x7/README.html">Matter CC1352 CC2652 All-clusters Example Application</a></li>
<li class="toctree-l2"><a class="reference internal" href="examples/all-clusters-minimal-app/esp32/README.html">CHIP ESP32 All Clusters Example</a></li>
<li class="toctree-l2"><a class="reference internal" href="examples/all-clusters-minimal-app/infineon/psoc6/README.html">CHIP PSoC6 All Clusters Example</a></li>
<li class="toctree-l2"><a class="reference internal" href="examples/all-clusters-minimal-app/mbed/README.html">Matter Arm Mbed OS All Clusters Example Application</a></li>
<li class="toctree-l2"><a class="reference internal" href="examples/all-clusters-minimal-app/nrfconnect/README.html">Matter nRF Connect All Clusters Example Application</a></li>
<li class="toctree-l2"><a class="reference internal" href="examples/all-clusters-minimal-app/telink/Readme.html">Matter Telink All Clusters Minimal Example Application</a></li>
<li class="toctree-l2"><a class="reference internal" href="examples/bridge-app/esp32/README.html">CHIP ESP32 Bridge App Example</a></li>
<li class="toctree-l2"><a class="reference internal" href="examples/bridge-app/linux/README.html">CHIP Linux Bridge Example</a></li>
<li class="toctree-l2"><a class="reference internal" href="examples/contact-sensor-app/nxp/k32w/k32w0/README.html">CHIP K32W061 Contact Sensor Example Application</a></li>
<li class="toctree-l2"><a class="reference internal" href="examples/contact-sensor-app/telink/README.html">Matter Telink Contact Sensor Example Application</a></li>
<li class="toctree-l2"><a class="reference internal" href="examples/chef/README.html">MATTER CHEF APP</a></li>
<li class="toctree-l2"><a class="reference internal" href="examples/chef/README_DEVICE.html">Matter Shell - Device Layer module</a></li>
<li class="toctree-l2"><a class="reference internal" href="examples/chef/README_OTCLI.html">Matter Shell - OpenThread CLI pass-through</a></li>
<li class="toctree-l2"><a class="reference internal" href="examples/chef/README_SHELL.html">Matter Shell Reference</a></li>
<li class="toctree-l2"><a class="reference internal" href="examples/chef/nrfconnect/README.html">CHIP nRF Connect SDK Shell Application</a></li>
<li class="toctree-l2"><a class="reference internal" href="examples/chef/sample_app_util/README.html">Chef Build Conventions</a></li>
<li class="toctree-l2"><a class="reference internal" href="examples/chip-tool/README.html">Matter Client Example</a></li>
<li class="toctree-l2"><a class="reference internal" href="examples/darwin-framework-tool/README.html">Matter darwin-framework-tool</a></li>
<li class="toctree-l2"><a class="reference internal" href="examples/dynamic-bridge-app/linux/README.html">CHIP Linux Bridge Example</a></li>
<li class="toctree-l2"><a class="reference internal" href="examples/java-matter-controller/README.html">Matter Controller Java App Example</a></li>
<li class="toctree-l2"><a class="reference internal" href="examples/lighting-app/ameba/README.html">CHIP Ameba Lighting Example</a></li>
<li class="toctree-l2"><a class="reference internal" href="examples/lighting-app/beken/README.html">Matter BEKEN Lighting Example</a></li>
<li class="toctree-l2"><a class="reference internal" href="examples/lighting-app/bouffalolab/README.html"><code class="docutils literal notranslate"><span class="pre">Bouffalo</span> <span class="pre">Lab</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="examples/lighting-app/esp32/README.html">Matter ESP32 Lighting Example</a></li>
<li class="toctree-l2"><a class="reference internal" href="examples/lighting-app/genio/README.html">Matter <code class="docutils literal notranslate"><span class="pre">Genio</span></code> Lighting Example</a></li>
<li class="toctree-l2"><a class="reference internal" href="examples/lighting-app/infineon/cyw30739/README.html">Matter CYW30739 Lighting Example</a></li>
<li class="toctree-l2"><a class="reference internal" href="examples/lighting-app/infineon/psoc6/README.html">CHIP PSoC6 Lighting Example</a></li>
<li class="toctree-l2"><a class="reference internal" href="examples/lighting-app/linux/README.html">CHIP Linux Lighting Example</a></li>
<li class="toctree-l2"><a class="reference internal" href="examples/lighting-app/mbed/README.html">Matter Arm Mbed OS Lighting Example Application</a></li>
<li class="toctree-l2"><a class="reference internal" href="examples/lighting-app/nrfconnect/README.html">Matter nRF Connect Lighting Example Application</a></li>
<li class="toctree-l2"><a class="reference internal" href="examples/lighting-app/nxp/k32w/k32w0/README.html">CHIP K32W061 Lighting Example Application</a></li>
<li class="toctree-l2"><a class="reference internal" href="examples/lighting-app/python/README.html">Python-based lighting example (bridge) device to DALI</a></li>
<li class="toctree-l2"><a class="reference internal" href="examples/lighting-app/qpg/README.html">Matter QPG6105 SDK</a></li>
<li class="toctree-l2"><a class="reference internal" href="examples/lighting-app/silabs/SiWx917/README.html">Matter SiWx917 Lighting Example</a></li>
<li class="toctree-l2"><a class="reference internal" href="examples/lighting-app/silabs/efr32/README.html">Matter EFR32 Lighting Example</a></li>
<li class="toctree-l2"><a class="reference internal" href="examples/lighting-app/telink/README.html">Matter Telink Lighting Example Application</a></li>
<li class="toctree-l2"><a class="reference internal" href="examples/lighting-app/tizen/README.html">CHIP Tizen Lighting Example</a></li>
<li class="toctree-l2"><a class="reference internal" href="examples/lighting-app/qpg/APPLICATION.html">Matter QPG6105 Lighting Example Application</a></li>
<li class="toctree-l2"><a class="reference internal" href="examples/light-switch-app/ameba/README.html">CHIP Ameba Light Switch Example</a></li>
<li class="toctree-l2"><a class="reference internal" href="examples/light-switch-app/esp32/README.html">Matter ESP32 Light-switch Example</a></li>
<li class="toctree-l2"><a class="reference internal" href="examples/light-switch-app/genio/README.html">Matter <code class="docutils literal notranslate"><span class="pre">Genio</span></code> Light Switch Example</a></li>
<li class="toctree-l2"><a class="reference internal" href="examples/light-switch-app/nrfconnect/README.html">Matter nRF Connect Light Switch Example Application</a></li>
<li class="toctree-l2"><a class="reference internal" href="examples/light-switch-app/silabs/SiWx917/README.html">Matter SiWx917 Light Switch Example</a></li>
<li class="toctree-l2"><a class="reference internal" href="examples/light-switch-app/silabs/efr32/README.html">Matter EFR32 Light Switch Example</a></li>
<li class="toctree-l2"><a class="reference internal" href="examples/light-switch-app/telink/README.html">Matter Telink Light Switch Example Application</a></li>
<li class="toctree-l2"><a class="reference internal" href="examples/lock-app/cc13x2x7_26x2x7/README.html">Matter CC1352 CC2652 Lock Example Application</a></li>
<li class="toctree-l2"><a class="reference internal" href="examples/lock-app/cc32xx/README.html">Matter <code class="docutils literal notranslate"><span class="pre">CC32XXSF</span></code> Lock Example Application</a></li>
<li class="toctree-l2"><a class="reference internal" href="examples/lock-app/esp32/README.html">Matter ESP32 Lock Example</a></li>
<li class="toctree-l2"><a class="reference internal" href="examples/lock-app/genio/README.html">Matter <code class="docutils literal notranslate"><span class="pre">Genio</span></code> Lock Example</a></li>
<li class="toctree-l2"><a class="reference internal" href="examples/lock-app/infineon/cyw30739/README.html">Matter CYW30739 Lock Example</a></li>
<li class="toctree-l2"><a class="reference internal" href="examples/lock-app/infineon/psoc6/README.html">Matter PSoC6 Lock Example</a></li>
<li class="toctree-l2"><a class="reference internal" href="examples/lock-app/linux/README.html">Lock Application for Linux</a></li>
<li class="toctree-l2"><a class="reference internal" href="examples/lock-app/mbed/README.html">Matter Arm Mbed OS Lock Example Application</a></li>
<li class="toctree-l2"><a class="reference internal" href="examples/lock-app/nrfconnect/README.html">Matter nRF Connect Lock Example Application</a></li>
<li class="toctree-l2"><a class="reference internal" href="examples/lock-app/nxp/k32w/k32w0/README.html">CHIP K32W061 Lock Example Application</a></li>
<li class="toctree-l2"><a class="reference internal" href="examples/lock-app/openiotsdk/README.html">Matter Open IoT SDK Lock-App Example Application</a></li>
<li class="toctree-l2"><a class="reference internal" href="examples/lock-app/qpg/README.html">Matter QPG6105 SDK</a></li>
<li class="toctree-l2"><a class="reference internal" href="examples/lock-app/silabs/SiWx917/README.html">Matter SiWx917 Lock Example</a></li>
<li class="toctree-l2"><a class="reference internal" href="examples/lock-app/silabs/efr32/README.html">Matter EFR32 Lock Example</a></li>
<li class="toctree-l2"><a class="reference internal" href="examples/lock-app/telink/README.html">Matter Telink Lock Example Application</a></li>
<li class="toctree-l2"><a class="reference internal" href="examples/lock-app/qpg/APPLICATION.html">Matter QPG6105 Lock Example Application</a></li>
<li class="toctree-l2"><a class="reference internal" href="examples/log-source-app/linux/README.html">log-source-app</a></li>
<li class="toctree-l2"><a class="reference internal" href="examples/minimal-mdns/README.html">Minimal mDNS example</a></li>
<li class="toctree-l2"><a class="reference internal" href="examples/openiotsdk_examples.html">Matter Open IoT SDK Example Application</a></li>
<li class="toctree-l2"><a class="reference internal" href="examples/ota-provider-app/esp32/README.html">CHIP ESP32 OTA Provider Example</a></li>
<li class="toctree-l2"><a class="reference internal" href="examples/ota-provider-app/linux/README.html">ota-provider-app</a></li>
<li class="toctree-l2"><a class="reference internal" href="examples/ota-requestor-app/ameba/README.html">CHIP Ameba OTA Requestor Example</a></li>
<li class="toctree-l2"><a class="reference internal" href="examples/ota-requestor-app/esp32/README.html">CHIP ESP32 OTA Requestor Example</a></li>
<li class="toctree-l2"><a class="reference internal" href="examples/ota-requestor-app/genio/README.html">Matter <code class="docutils literal notranslate"><span class="pre">Genio</span></code> Lighting Example</a></li>
<li class="toctree-l2"><a class="reference internal" href="examples/ota-requestor-app/infineon/cyw30739/README.html">Matter CYW30739 OTA Requestor Example</a></li>
<li class="toctree-l2"><a class="reference internal" href="examples/ota-requestor-app/linux/README.html">ota-requestor-app (Linux)</a></li>
<li class="toctree-l2"><a class="reference internal" href="examples/ota-requestor-app/mbed/README.html">Matter Arm Mbed OS Lock Example Application</a></li>
<li class="toctree-l2"><a class="reference internal" href="examples/ota-requestor-app/telink/Readme.html">Build and flash</a></li>
<li class="toctree-l2"><a class="reference internal" href="examples/persistent-storage/cc13x2x7_26x2x7/README.html">Matter CC1352 CC2652 Persistent Storage Example Application</a></li>
<li class="toctree-l2"><a class="reference internal" href="examples/persistent-storage/esp32/README.html">CHIP ESP32 Persistent Storage Example</a></li>
<li class="toctree-l2"><a class="reference internal" href="examples/persistent-storage/infineon/psoc6/README.html">CHIP PSoC6 Persistent Storage Example</a></li>
<li class="toctree-l2"><a class="reference internal" href="examples/persistent-storage/linux/README.html">CHIP Linux Persistent Storage Example</a></li>
<li class="toctree-l2"><a class="reference internal" href="examples/persistent-storage/qpg/README.html">Matter QPG6105 SDK</a></li>
<li class="toctree-l2"><a class="reference internal" href="examples/persistent-storage/qpg/APPLICATION.html">CHIP QPG6105 Persistent Storage Application</a></li>
<li class="toctree-l2"><a class="reference internal" href="examples/pigweed-app/ameba/README.html">CHIP Ameba Pigweed Example Application</a></li>
<li class="toctree-l2"><a class="reference internal" href="examples/pigweed-app/esp32/README.html">CHIP ESP32 Pigweed Example Application</a></li>
<li class="toctree-l2"><a class="reference internal" href="examples/pigweed-app/mbed/README.html">Matter Arm Mbed OS Pigweed Example Application</a></li>
<li class="toctree-l2"><a class="reference internal" href="examples/pigweed-app/nrfconnect/README.html">Matter nRF Connect Pigweed Example Application</a></li>
<li class="toctree-l2"><a class="reference internal" href="examples/pump-app/cc13x2x7_26x2x7/README.html">Matter CC1352 CC2652 Pump Example Application</a></li>
<li class="toctree-l2"><a class="reference internal" href="examples/pump-app/nrfconnect/README.html">Matter nRF Connect Pump Example Application</a></li>
<li class="toctree-l2"><a class="reference internal" href="examples/pump-app/telink/README.html">Matter Telink Pump Controller Example Application</a></li>
<li class="toctree-l2"><a class="reference internal" href="examples/pump-app/cc13x2x7_26x2x7/doc/programming-ccs.html">Programming and Debugging with CCS</a></li>
<li class="toctree-l2"><a class="reference internal" href="examples/pump-app/cc13x2x7_26x2x7/doc/programming-uniflash.html">Programming with UniFlash</a></li>
<li class="toctree-l2"><a class="reference internal" href="examples/pump-controller-app/cc13x2x7_26x2x7/README.html">Matter CC1352 CC2652 Pump Controller Example Application</a></li>
<li class="toctree-l2"><a class="reference internal" href="examples/pump-controller-app/nrfconnect/README.html">Matter nRF Connect Pump Example Application</a></li>
<li class="toctree-l2"><a class="reference internal" href="examples/pump-controller-app/telink/README.html">Matter Telink Pump Controller Example Application</a></li>
<li class="toctree-l2"><a class="reference internal" href="examples/pump-controller-app/cc13x2x7_26x2x7/doc/programming-ccs.html">Programming and Debugging with CCS</a></li>
<li class="toctree-l2"><a class="reference internal" href="examples/pump-controller-app/cc13x2x7_26x2x7/doc/programming-uniflash.html">Programming with UniFlash</a></li>
<li class="toctree-l2"><a class="reference internal" href="examples/shell/README.html">Matter Shell Reference</a></li>
<li class="toctree-l2"><a class="reference internal" href="examples/shell/README_DEVICE.html">Matter Shell - Device Layer module</a></li>
<li class="toctree-l2"><a class="reference internal" href="examples/shell/README_OTCLI.html">Matter Shell - OpenThread CLI pass-through</a></li>
<li class="toctree-l2"><a class="reference internal" href="examples/shell/README_SERVER.html">Matter Shell - App Server module</a></li>
<li class="toctree-l2"><a class="reference internal" href="examples/shell/cc13x2x7_26x2x7/README.html">Matter CC1352 CC2652 Shell Application</a></li>
<li class="toctree-l2"><a class="reference internal" href="examples/shell/mbed/README.html">Matter Arm Mbed OS Shell Example Application</a></li>
<li class="toctree-l2"><a class="reference internal" href="examples/shell/nrfconnect/README.html">Matter nRF Connect SDK Shell Application</a></li>
<li class="toctree-l2"><a class="reference internal" href="examples/shell/nxp/k32w/k32w0/README.html">CHIP NXP K32W Shell Application</a></li>
<li class="toctree-l2"><a class="reference internal" href="examples/shell/openiotsdk/README.html">Matter Open IoT SDK Shell Example Application</a></li>
<li class="toctree-l2"><a class="reference internal" href="examples/temperature-measurement-app/esp32/README.html">Matter ESP32 Temperature Sensor Example</a></li>
<li class="toctree-l2"><a class="reference internal" href="examples/temperature-measurement-app/telink/README.html">Matter Telink Temperature Measurement Example Application</a></li>
<li class="toctree-l2"><a class="reference internal" href="examples/thermostat/genio/README.html">Matter <code class="docutils literal notranslate"><span class="pre">Genio</span></code> Thermostat Example</a></li>
<li class="toctree-l2"><a class="reference internal" href="examples/thermostat/silabs/efr32/README.html">Matter EFR32 Thermostat Example</a></li>
<li class="toctree-l2"><a class="reference internal" href="examples/thermostat/telink/Readme.html">Matter Telink Thermostat Example Application</a></li>
<li class="toctree-l2"><a class="reference internal" href="examples/tv-app/linux/README.html">CHIP TV Example</a></li>
<li class="toctree-l2"><a class="reference internal" href="examples/tv-casting-app/android/README.html">Matter TV Casting Android App Example</a></li>
<li class="toctree-l2"><a class="reference internal" href="examples/tv-casting-app/darwin/TvCasting/README.html">Matter TV Casting iOS App Example</a></li>
<li class="toctree-l2"><a class="reference internal" href="examples/tv-casting-app/linux/README.html">CHIP TV Casting App Example</a></li>
<li class="toctree-l2"><a class="reference internal" href="examples/window-app/nrfconnect/README.html">Matter nRF Connect Window Covering Example Application</a></li>
<li class="toctree-l2"><a class="reference internal" href="examples/window-app/silabs/SiWx917/README.html">Matter SiWx917 Window Covering Example</a></li>
<li class="toctree-l2"><a class="reference internal" href="examples/window-app/silabs/efr32/README.html">Matter EFR32 Window Covering Example</a></li>
<li class="toctree-l2"><a class="reference internal" href="examples/window-app/telink/README.html">Matter Telink Window Example Application</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="BUG_REPORT.html">Reporting bugs</a></li>
<li class="toctree-l1"><a class="reference internal" href="code_generation.html">Code generation</a></li>
<li class="toctree-l1"><a class="reference internal" href="ERROR_CODES.html">Matter SDK <code class="docutils literal notranslate"><span class="pre">CHIP_ERROR</span></code> enums values</a></li>
</ul>
</div>
</nav></div>
</div>
<div class="sidebar-primary-items__end sidebar-primary__section">
</div>
<div id="rtd-footer-container"></div>
</div>
<main id="main-content" class="bd-main">
<div class="sbt-scroll-pixel-helper"></div>
<div class="bd-content">
<div class="bd-article-container">
<div class="bd-header-article">
<div class="header-article-items header-article__inner">
<div class="header-article-items__start">
<div class="header-article-item"><label class="sidebar-toggle primary-toggle btn btn-sm" for="__primary" title="Toggle primary sidebar" data-bs-placement="bottom" data-bs-toggle="tooltip">
<span class="fa-solid fa-bars"></span>
</label></div>
</div>
<div class="header-article-items__end">
<div class="header-article-item">
<div class="article-header-buttons">
<a href="https://github.com/project-chip/connectedhomeip/edit/master/docs/VSCODE_DEVELOPMENT.md" target="_blank"
class="btn btn-sm btn-source-edit-button"
title="Suggest edit"
data-bs-placement="bottom" data-bs-toggle="tooltip"
>
<span class="btn__icon-container">
<i class="fas fa-pencil-alt"></i>
</span>
</a>
<div class="dropdown dropdown-download-buttons">
<button class="btn dropdown-toggle" type="button" data-bs-toggle="dropdown" aria-expanded="false" aria-label="Download this page">
<i class="fas fa-download"></i>
</button>
<ul class="dropdown-menu">
<li><a href="_sources/VSCODE_DEVELOPMENT.md" target="_blank"
class="btn btn-sm btn-download-source-button dropdown-item"
title="Download source file"
data-bs-placement="left" data-bs-toggle="tooltip"
>
<span class="btn__icon-container">
<i class="fas fa-file"></i>
</span>
<span class="btn__text-container">.md</span>
</a>
</li>
<li>
<button onclick="window.print()"
class="btn btn-sm btn-download-pdf-button dropdown-item"
title="Print to PDF"
data-bs-placement="left" data-bs-toggle="tooltip"
>
<span class="btn__icon-container">
<i class="fas fa-file-pdf"></i>
</span>
<span class="btn__text-container">.pdf</span>
</button>
</li>
</ul>
</div>
<button onclick="toggleFullScreen()"
class="btn btn-sm btn-fullscreen-button"
title="Fullscreen mode"
data-bs-placement="bottom" data-bs-toggle="tooltip"
>
<span class="btn__icon-container">
<i class="fas fa-expand"></i>
</span>
</button>
<script>
document.write(`
<button class="theme-switch-button btn btn-sm btn-outline-primary navbar-btn rounded-circle" title="light/dark" aria-label="light/dark" data-bs-placement="bottom" data-bs-toggle="tooltip">
<span class="theme-switch" data-mode="light"><i class="fa-solid fa-sun"></i></span>
<span class="theme-switch" data-mode="dark"><i class="fa-solid fa-moon"></i></span>
<span class="theme-switch" data-mode="auto"><i class="fa-solid fa-circle-half-stroke"></i></span>
</button>
`);
</script>
<script>
document.write(`
<button class="btn btn-sm navbar-btn search-button search-button__button" title="Search" aria-label="Search" data-bs-placement="bottom" data-bs-toggle="tooltip">
<i class="fa-solid fa-magnifying-glass"></i>
</button>
`);
</script>
<label class="sidebar-toggle secondary-toggle btn btn-sm" for="__secondary"title="Toggle secondary sidebar" data-bs-placement="bottom" data-bs-toggle="tooltip">
<span class="fa-solid fa-list"></span>
</label>
</div></div>
</div>
</div>
</div>
<div id="jb-print-docs-body" class="onlyprint">
<h1>Visual Studio Code Development</h1>
<!-- Table of contents -->
<div id="print-main-content">
<div id="jb-print-toc">
<div>
<h2> Contents </h2>
</div>
<nav aria-label="Page">
<ul class="visible nav section-nav flex-column">
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#setup-steps">Setup Steps</a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#bootstrapping-your-source-tree-one-time">Bootstrapping your source tree (one time)</a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#building-the-source-tree">Building the Source Tree</a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#tasks">Tasks</a><ul class="nav section-nav flex-column">
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#current-base-tasks-are-listed-here">Current base tasks are listed here</a></li>
</ul>
</li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#launch-tasks">Launch Tasks</a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#submitting-a-pull-request-practical-advice">Submitting a Pull Request - Practical Advice</a><ul class="nav section-nav flex-column">
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#before-submitting-a-pr-make-sure-these-commands-run-and-succeed">Before submitting a PR, make sure these commands run and succeed</a></li>
</ul>
</li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#common-issues">Common Issues</a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#docker-faq">Docker FAQ</a><ul class="nav section-nav flex-column">
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#dns-problem-can-t-resolve-archive-ubuntu-com">DNS problem: can’t resolve archive.ubuntu.com</a></li>
</ul>
</li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#visual-studio-code-faq">Visual Studio Code FAQ</a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#visual-studio-code-recommended-settings">Visual Studio Code Recommended Settings</a></li>
</ul>
</nav>
</div>
</div>
</div>
<div id="searchbox"></div>
<article class="bd-article" role="main">
<section id="visual-studio-code-development">
<h1>Visual Studio Code Development<a class="headerlink" href="#visual-studio-code-development" title="Permalink to this heading">#</a></h1>
<p><a class="reference external" href="https://code.visualstudio.com/">Visual Studio Code</a> is a great and simple IDE
that can be used to build & develop with for Matter.</p>
<p>Matter supports the docker / remote container workflow in Visual Studio Code,
and has a container environment setup automatically. You can read more about
this workflow <a class="reference external" href="https://code.visualstudio.com/docs/remote/containers">here</a>.</p>
<p>Tested on:</p>
<ul class="simple">
<li><p>macOS 10.5</p></li>
<li><p>Windows 10 Pro + WSL + Ubuntu 18 LTS</p></li>
<li><p>Linux - Fedora Core 35 distribution</p></li>
</ul>
<section id="setup-steps">
<h2>Setup Steps<a class="headerlink" href="#setup-steps" title="Permalink to this heading">#</a></h2>
<ol class="arabic simple">
<li><p><em>Windows Only</em> Enable the Windows Subsystem for Linux (WSL) following
instructions here:
<a class="reference external" href="https://docs.microsoft.com/en-us/windows/wsl/install-win10">https://docs.microsoft.com/en-us/windows/wsl/install-win10</a></p></li>
<li><p><em>Windows Only</em> Install Ubuntu from the Windows App Store here:
<a class="reference external" href="https://www.microsoft.com/en-us/p/ubuntu-1804-lts/9n9tngvndl3q">https://www.microsoft.com/en-us/p/ubuntu-1804-lts/9n9tngvndl3q</a></p></li>
<li><p>Install <a class="reference external" href="https://www.docker.com/">Docker</a> for your operating system of choice
from here: <a class="reference external" href="https://docs.docker.com/engine/install">https://docs.docker.com/engine/install</a></p></li>
<li><p>Install <a class="reference external" href="https://code.visualstudio.com/">Visual Studio Code</a> for your
operating system of choice here: <a class="reference external" href="https://code.visualstudio.com/Download">https://code.visualstudio.com/Download</a></p></li>
<li><p>Install <a class="reference external" href="https://git-scm.com/">Git</a> if you haven’t already</p></li>
<li><p><em>Windows Only</em> Enable git to use LF instead of CLRF by default:
<code class="docutils literal notranslate"><span class="pre">git</span> <span class="pre">config</span> <span class="pre">--global</span> <span class="pre">core.autocrlf</span> <span class="pre">false</span></code></p></li>
<li><p>Git clone the main Matter repository here:
<a class="github reference external" href="https://github.com/project-chip/connectedhomeip">project-chip/connectedhomeip</a></p></li>
<li><p>Launch Visual Studio Code, and open the cloned folder from above</p></li>
<li><p>Install the
<a class="reference external" href="https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers">Dev Containers</a>
extension for Visual Studio Code, this extension allows you to use docker
containers as a development backend.</p></li>
<li><p>Once this is installed, you’ll be prompted to reload Visual Studio Code, do
so</p></li>
<li><p>At the bottom right of your Visual Studio Code window you should have a new
box prompting you to re-open the window as a container. Hit yes.</p></li>
<li><p><em>Windows Only</em> Update your Visual Studio Code settings as documented here:
https://code.visualstudio.com/docs/editor/integrated-terminal#_configuration
to use Bash on Ubuntu (on Windows) eg:
<code class="docutils literal notranslate"><span class="pre">"terminal.integrated.shell.windows":</span> <span class="pre">"C:\\Windows\\System32\\bash.exe"</span></code></p></li>
<li><p>Now your local machine is building a docker image that has all the tools
necessary to build and test Matter. This can take some time, but will
eventually complete and open up the source tree</p></li>
</ol>
</section>
<section id="bootstrapping-your-source-tree-one-time">
<h2>Bootstrapping your source tree (one time)<a class="headerlink" href="#bootstrapping-your-source-tree-one-time" title="Permalink to this heading">#</a></h2>
<ol class="arabic simple">
<li><p>Under the “Terminal” menu (or using another shortcut to the same tool),
select “Run Task…”</p></li>
<li><p>Select the “Bootstrap” task</p></li>
</ol>
</section>
<section id="building-the-source-tree">
<h2>Building the Source Tree<a class="headerlink" href="#building-the-source-tree" title="Permalink to this heading">#</a></h2>
<ol class="arabic simple">
<li><p>Under the “Terminal” menu select “Run Build Task…”</p></li>
</ol>
</section>
<section id="tasks">
<h2>Tasks<a class="headerlink" href="#tasks" title="Permalink to this heading">#</a></h2>
<p>Located in the <a class="reference external" href="https://github.com/project-chip/connectedhomeip/blob/master/.vscode/tasks.json">tasks json</a> file you’ll find a list of
tasks that can be run from the “Run Task…” command. Example tasks are “Clean”,
“Run Pretty Check”</p>
<p>Developers are encouraged to add tasks to the
<a class="reference external" href="https://github.com/project-chip/connectedhomeip/blob/master/.vscode/tasks.json">tasks json</a> over time to make sure everyone is using the
same base configuration and build.</p>
<section id="current-base-tasks-are-listed-here">
<h3>Current base tasks are listed here<a class="headerlink" href="#current-base-tasks-are-listed-here" title="Permalink to this heading">#</a></h3>
<ul class="simple">
<li><p>Main Build - Build the default configuration (i.e., Linux OpenSSL)</p></li>
<li><p>Run Unit and Functional Tests - Test the default configuration</p></li>
<li><p>Build & Test (all) - Build & Test various configurations (Linux variants,
Android, EFR32)</p></li>
<li><p>Update compilation database - Update the database used by IntelliSense
(needed for cross references, completion)</p></li>
<li><p>Bootstrap - On a clean tree, pull in the third party dependencies required</p></li>
<li><p>Clean Output - Remove build artifacts</p></li>
<li><p>Clean Tree - Full (and destructive) git clean of the tree</p></li>
</ul>
</section>
</section>
<section id="launch-tasks">
<h2>Launch Tasks<a class="headerlink" href="#launch-tasks" title="Permalink to this heading">#</a></h2>
<p>Located in the <a class="reference external" href="https://github.com/project-chip/connectedhomeip/blob/master/.vscode/launch.json">launch json</a> file you’ll find a list of
build & run jobs that can be run from the “Run” tab and start a run or debug
session.</p>
<p>Developers are encouraged to add tasks to the
<a class="reference external" href="https://github.com/project-chip/connectedhomeip/blob/master/.vscode/launch.json">launch json</a> over time to make sure everyone is using
the same base debugging setup.</p>
</section>
<section id="submitting-a-pull-request-practical-advice">
<h2>Submitting a Pull Request - Practical Advice<a class="headerlink" href="#submitting-a-pull-request-practical-advice" title="Permalink to this heading">#</a></h2>
<section id="before-submitting-a-pr-make-sure-these-commands-run-and-succeed">
<h3>Before submitting a PR, make sure these commands run and succeed<a class="headerlink" href="#before-submitting-a-pr-make-sure-these-commands-run-and-succeed" title="Permalink to this heading">#</a></h3>
<ul class="simple">
<li><p>Run task: “Build & Test (all)”</p></li>
</ul>
</section>
</section>
<section id="common-issues">
<h2>Common Issues<a class="headerlink" href="#common-issues" title="Permalink to this heading">#</a></h2>
<ul class="simple">
<li><p><a class="reference external" href="https://code.visualstudio.com/docs/remote/containers#_sharing-git-credentials-with-your-container">Missing Git credential</a></p></li>
<li><p><a class="reference external" href="https://code.visualstudio.com/docs/remote/containers#_sharing-git-credentials-with-your-container">Missing Git SSH keys</a></p></li>
<li><p><a class="reference external" href="https://github.com/microsoft/vscode-remote-release/issues/72">Using GPG signing keys</a></p></li>
</ul>
</section>
<section id="docker-faq">
<h2>Docker FAQ<a class="headerlink" href="#docker-faq" title="Permalink to this heading">#</a></h2>
<section id="dns-problem-can-t-resolve-archive-ubuntu-com">
<h3>DNS problem: can’t resolve archive.ubuntu.com<a class="headerlink" href="#dns-problem-can-t-resolve-archive-ubuntu-com" title="Permalink to this heading">#</a></h3>
<p>A common problem encountered is that a container can’t resolve
<code class="docutils literal notranslate"><span class="pre">archive.ubuntu.com</span></code> and can’t install anything via <code class="docutils literal notranslate"><span class="pre">apt-get</span></code>, during the
creation of the container image, resulting in an error like:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">E</span><span class="p">:</span> <span class="n">Package</span> <span class="s1">'locales'</span> <span class="n">has</span> <span class="n">no</span> <span class="n">installation</span> <span class="n">candidate</span>
<span class="n">The</span> <span class="n">command</span> <span class="s1">'/bin/sh -c apt-get install -y locales && localedef -i en_US -c -f UTF-8 -A /usr/share/locale/locale.alias en_US.UTF-8'</span> <span class="n">returned</span> <span class="n">a</span> <span class="n">non</span><span class="o">-</span><span class="n">zero</span> <span class="n">code</span><span class="p">:</span> <span class="mi">100</span>
</pre></div>
</div>
<p>Most common reason for this is that the DNS for docker daemon has not been set
up correctly and is simply using a default: 8.8.8.8, which in many corporate or
more secure environments is not accessible. A typical solution for this is to
put a following key/value into your system-wide docker <code class="docutils literal notranslate"><span class="pre">daemon.json</span></code> (Typically
located under <code class="docutils literal notranslate"><span class="pre">/etc/docker/daemon.json</span></code> on a Linux system):</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="s2">"dns"</span><span class="p">:</span> <span class="p">[</span><span class="s2">"<<IP ADDRESS OF YOUR NAMESERVER>>"</span><span class="p">,</span> <span class="s2">"8.8.8.8"</span><span class="p">]</span>
</pre></div>
</div>
<p>You can obtain the address you should put into that line of your nameserver by
running:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">nmcli</span> <span class="n">dev</span> <span class="n">show</span> <span class="o">|</span> <span class="n">grep</span> <span class="s1">'IP4.DNS'</span>
</pre></div>
</div>
<p>After you update the dns, you should restart docker, specific to your system. On
a typical Linux workstation, you do this via:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">sudo</span> <span class="n">service</span> <span class="n">docker</span> <span class="n">restart</span>
</pre></div>
</div>
<p>Alternatively, you can also pass the <code class="docutils literal notranslate"><span class="pre">--dns</span></code> argument to your docker daemon, but
creating a <code class="docutils literal notranslate"><span class="pre">daemon.json</span></code> and following the above method will solve the problem
system-wide.</p>
</section>
</section>
<section id="visual-studio-code-faq">
<h2>Visual Studio Code FAQ<a class="headerlink" href="#visual-studio-code-faq" title="Permalink to this heading">#</a></h2>
<ul class="simple">
<li><p><em>Highly</em> recommend you read through
<a class="reference external" href="https://code.visualstudio.com/docs/getstarted/settings">this page</a> to learn
how to configure Visual Studio Code to suit your style:
<a class="reference external" href="https://code.visualstudio.com/docs/getstarted/settings">https://code.visualstudio.com/docs/getstarted/settings</a></p></li>
<li><p>Great primer set of videos
<a class="reference external" href="https://code.visualstudio.com/docs/getstarted/introvideos">here</a>
<a class="reference external" href="https://code.visualstudio.com/docs/getstarted/introvideos">https://code.visualstudio.com/docs/getstarted/introvideos</a></p></li>
</ul>
</section>
<section id="visual-studio-code-recommended-settings">
<h2>Visual Studio Code Recommended Settings<a class="headerlink" href="#visual-studio-code-recommended-settings" title="Permalink to this heading">#</a></h2>
<ul class="simple">
<li><p>Configure the editor to format on save, in your Visual Studio Code Settings:
<code class="docutils literal notranslate"><span class="pre">"editor.formatOnSave":</span> <span class="pre">true</span></code></p></li>
<li><p>Configure the clang-format extension <code class="docutils literal notranslate"><span class="pre">@ext:xaver.clang-format</span></code>, it is
installed in the docker container. Make sure all languages are enabled</p></li>
</ul>
</section>
</section>
</article>
<footer class="bd-footer-article">
<!-- Previous / next buttons -->
<div class="prev-next-area">
<a class="left-prev"
href="PROJECT_FLOW.html"
title="previous page">
<i class="fa-solid fa-angle-left"></i>
<div class="prev-next-info">
<p class="prev-next-subtitle">previous</p>
<p class="prev-next-title">Matter Project Flow</p>
</div>
</a>
<a class="right-next"
href="api/index.html"
title="next page">
<div class="prev-next-info">
<p class="prev-next-subtitle">next</p>
<p class="prev-next-title">API</p>
</div>
<i class="fa-solid fa-angle-right"></i>
</a>
</div>
</footer>
</div>
<div class="bd-sidebar-secondary bd-toc"><div class="sidebar-secondary-items sidebar-secondary__inner">
<div class="sidebar-secondary-item">
<div class="page-toc tocsection onthispage">
<i class="fa-solid fa-list"></i> Contents
</div>
<nav class="bd-toc-nav page-toc">
<ul class="visible nav section-nav flex-column">
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#setup-steps">Setup Steps</a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#bootstrapping-your-source-tree-one-time">Bootstrapping your source tree (one time)</a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#building-the-source-tree">Building the Source Tree</a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#tasks">Tasks</a><ul class="nav section-nav flex-column">
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#current-base-tasks-are-listed-here">Current base tasks are listed here</a></li>
</ul>
</li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#launch-tasks">Launch Tasks</a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#submitting-a-pull-request-practical-advice">Submitting a Pull Request - Practical Advice</a><ul class="nav section-nav flex-column">
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#before-submitting-a-pr-make-sure-these-commands-run-and-succeed">Before submitting a PR, make sure these commands run and succeed</a></li>
</ul>
</li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#common-issues">Common Issues</a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#docker-faq">Docker FAQ</a><ul class="nav section-nav flex-column">
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#dns-problem-can-t-resolve-archive-ubuntu-com">DNS problem: can’t resolve archive.ubuntu.com</a></li>
</ul>
</li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#visual-studio-code-faq">Visual Studio Code FAQ</a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#visual-studio-code-recommended-settings">Visual Studio Code Recommended Settings</a></li>
</ul>
</nav></div>
</div></div>
</div>
<footer class="bd-footer-content">
<div class="bd-footer-content__inner">
<div class="bd-footer-content__inner container">
<div class="footer-item">
<p class="component-author">
By Matter Contributors
</p>
</div>
<div class="footer-item">
<p class="copyright">
© Copyright 2020-2023, Matter Contributors.
<br/>
</p>
</div>
<div class="footer-item">
</div>
<div class="footer-item">
</div>
</div></div>
</footer>
</main>
</div>
</div>
<!-- Scripts loaded after <body> so the DOM is not blocked -->
<script src="_static/scripts/bootstrap.js?digest=12da95d707ffb74b382d"></script>
<script src="_static/scripts/pydata-sphinx-theme.js?digest=12da95d707ffb74b382d"></script>
<footer class="bd-footer">
</footer>
</body>
</html>