Blame - docs/guides/repl/Matter_REPL_Intro.ipynb - third_party/github/project-chip/connectedhomeip

"<a href=\"http://35.236.121.59/hub/user-redirect/git-pull?repo=https%3A%2F%2Fgithub.com%2Fproject-chip%2Fconnectedhomeip&urlpath=lab%2Ftree%2Fconnectedhomeip%2Fdocs%2Fguides%2Frepl%2FMatter%2520-%2520REPL%2520Intro.ipynb&branch=master\">\n",

11

"<img src=\"https://i.ibb.co/hR3yWsC/launch-playground.png\" alt=\"drawing\" width=\"130\"/>\n",

12

"</a>\n",

13

" \n",

14

"\n",

15

"This goes over the basics of interacting with the REPL."

]

},

{

"cell_type": "markdown",

20

"id": "7b7f651c-2e64-4d0e-aa93-1a01d093c946",

"metadata": {

"tags": []

},

"source": [

"## Initialization\n",

26

"\n",

27

"Let's first begin by setting up by importing some key modules that are needed to make it easier for us to interact with the Matter stack.\n",

28

"\n",

29

"`ChipReplStartup.py` is run within the global namespace. This results in all of its imports being made available here.\n",

30

"\n",

31

"> **NOTE**: _This is not needed if you launch the REPL from the command-line._"

]

},

{

"cell_type": "code",

"execution_count": 1,

37

"id": "cdffbe57-bd09-41db-a624-cbfcd65c6eae",

"metadata": {

"tags": []

},

"outputs": [

{

"data": {

"text/html": [

"<pre style=\"white-space:pre;overflow-x:auto;line-height:normal;font-family:Menlo,'DejaVu Sans Mono',consolas,'Courier New',monospace\">──────────────────────────────────────── Matter REPL ────────────────────────────────────────\n",

"</pre>\n"

],

"text/plain": [

"\u001b[92m──────────────────────────────────────── \u001b[0mMatter REPL\u001b[92m ────────────────────────────────────────\u001b[0m\n"

]

},

"metadata": {},

"output_type": "display_data"

},

{

"data": {

"text/html": [

"<pre style=\"white-space:pre;overflow-x:auto;line-height:normal;font-family:Menlo,'DejaVu Sans Mono',consolas,'Courier New',monospace\">\n",

59

" \n",

60

" \n",

61

" Welcome to the Matter Python REPL!\n",

62

" \n",

63

" For help, please type matterhelp()\n",

64

" \n",

65

" To get more information on a particular object/class, you can pass\n",

66

" that into matterhelp() as well.\n",

" \n",

" \n",

"</pre>\n"

],

"text/plain": [

"\n",

" \n",

"\u001b[1;34m \u001b[0m\n",

75

"\u001b[1;34m Welcome to the Matter Python REPL!\u001b[0m\n",

76

"\u001b[1;34m \u001b[0m\n",

77

"\u001b[1;34m For help, please type \u001b[0m\u001b[1;32mmatterhelp\u001b[0m\u001b[1;32m(\u001b[0m\u001b[1;32m)\u001b[0m\n",

78

"\u001b[1;34m \u001b[0m\n",

79

"\u001b[1;34m To get more information on a particular object/class, you can pass\u001b[0m\n",

80

"\u001b[1;34m that into \u001b[0m\u001b[1;32mmatterhelp\u001b[0m\u001b[1;32m(\u001b[0m\u001b[1;32m)\u001b[0m\u001b[1;34m as well.\u001b[0m\n",

81

"\u001b[1;34m \u001b[0m\n",

82

"\u001b[1;34m \u001b[0m\n"

]

},

"metadata": {},

"output_type": "display_data"

},

{

"data": {

"text/html": [

"<pre style=\"white-space:pre;overflow-x:auto;line-height:normal;font-family:Menlo,'DejaVu Sans Mono',consolas,'Courier New',monospace\">─────────────────────────────────────────────────────────────────────────────────────────────\n",

"</pre>\n"

],

"text/plain": [

"\u001b[92m─────────────────────────────────────────────────────────────────────────────────────────────\u001b[0m\n"

]

},

"metadata": {},

"output_type": "display_data"

},

{

"name": "stderr",

"output_type": "stream",

104

"text": [

105

"2022-01-25 16:57:54 johnsj-macbookpro1.roam.corp.google.com root[27642] CRITICAL Loading configuration from /tmp/repl-storage.json...\n"

]

},

{

"data": {

"text/html": [

"<pre style=\"white-space:pre;overflow-x:auto;line-height:normal;font-family:Menlo,'DejaVu Sans Mono',consolas,'Courier New',monospace\">\n",

"\n",

"</pre>\n"

],

"text/plain": [

"\n",

"\n"

]

},

"metadata": {},

"output_type": "display_data"

},

{

"data": {

"text/html": [

"<pre style=\"white-space:pre;overflow-x:auto;line-height:normal;font-family:Menlo,'DejaVu Sans Mono',consolas,'Courier New',monospace\">Restoring FabricAdmin from storage to manage FabricId 1, FabricIndex 1...\n",

"</pre>\n"

],

"text/plain": [

"\u001b[38;5;129mRestoring FabricAdmin from storage to manage FabricId \u001b[0m\u001b[1;38;5;129m1\u001b[0m\u001b[38;5;129m, FabricIndex \u001b[0m\u001b[1;38;5;129m1\u001b[0m\u001b[38;5;129m...\u001b[0m\n"

]

},

"metadata": {},

"output_type": "display_data"

},

{

"name": "stdout",

"output_type": "stream",

139

"text": [

140

"New FabricAdmin: FabricId: 1(1)\n"

]

},

{

"data": {

"text/html": [

"<pre style=\"white-space:pre;overflow-x:auto;line-height:normal;font-family:Menlo,'DejaVu Sans Mono',consolas,'Courier New',monospace\">Restoring FabricAdmin from storage to manage FabricId 2, FabricIndex 2...\n",

"</pre>\n"

],

"text/plain": [

"\u001b[38;5;129mRestoring FabricAdmin from storage to manage FabricId \u001b[0m\u001b[1;38;5;129m2\u001b[0m\u001b[38;5;129m, FabricIndex \u001b[0m\u001b[1;38;5;129m2\u001b[0m\u001b[38;5;129m...\u001b[0m\n"

]

},

"metadata": {},

"output_type": "display_data"

},

{

"name": "stdout",

"output_type": "stream",

159

"text": [

160

"New FabricAdmin: FabricId: 2(2)\n"

]

},

{

"data": {

"text/html": [

"<pre style=\"white-space:pre;overflow-x:auto;line-height:normal;font-family:Menlo,'DejaVu Sans Mono',consolas,'Courier New',monospace\">\n",

167

"Fabric Admins have been loaded and are available at fabricAdmins\n",

"</pre>\n"

],

"text/plain": [

"\n",

"\u001b[34mFabric Admins have been loaded and are available at \u001b[0m\u001b[31mfabricAdmins\u001b[0m\n"

]

},

"metadata": {},

"output_type": "display_data"

},

{

"data": {

"text/html": [

"<pre style=\"white-space:pre;overflow-x:auto;line-height:normal;font-family:Menlo,'DejaVu Sans Mono',consolas,'Courier New',monospace\">\n",

"\n",

"</pre>\n"

],

"text/plain": [

"\n",

"\n"

]

},

"metadata": {},

"output_type": "display_data"

},

{

"data": {

"text/html": [

"<pre style=\"white-space:pre;overflow-x:auto;line-height:normal;font-family:Menlo,'DejaVu Sans Mono',consolas,'Courier New',monospace\">Creating default device controller on fabric 1...\n",

"</pre>\n"

],

"text/plain": [

"\u001b[38;5;129mCreating default device controller on fabric \u001b[0m\u001b[1;38;5;129m1\u001b[0m\u001b[38;5;129m...\u001b[0m\n"

]

},

"metadata": {},

"output_type": "display_data"

},

{

"name": "stdout",

"output_type": "stream",

209

"text": [

210

"Allocating new controller with FabricId: 1(1), NodeId: 1\n"

]

},

{

"data": {

"text/html": [

"<pre style=\"white-space:pre;overflow-x:auto;line-height:normal;font-family:Menlo,'DejaVu Sans Mono',consolas,'Courier New',monospace\">\n",

217

"\n",

218

"Default CHIP Device Controller has been initialized to manage fabricAdmins[0], and is \n",

219

"available as devCtrl\n",

"</pre>\n"

],

"text/plain": [

"\n",

"\n",

"\u001b[34mDefault CHIP Device Controller has been initialized to manage \u001b[0m\u001b[1;31mfabricAdmins\u001b[0m\u001b[1;31m[\u001b[0m\u001b[1;31m0\u001b[0m\u001b[1;31m]\u001b[0m\u001b[1;34m, and is \u001b[0m\n",

226

"\u001b[1;34mavailable as \u001b[0m\u001b[1;31mdevCtrl\u001b[0m\n"

]

},

"metadata": {},

"output_type": "display_data"

}

],

"source": [

"import chip.native\n",

235

"import pkgutil\n",

236

"module = pkgutil.get_loader('chip.ChipReplStartup')\n",

"%run {module.path}"

]

},

{

"cell_type": "markdown",

242

"id": "49a01315-6cac-4f8a-830d-adb5b7b9fc27",

243

"metadata": {},

244

"source": [

245

"## Persistent Storage\n",

246

"\n",

247

"> NOTE: By default, the REPL points to `/tmp/repl-storage.json` for its persistent storage. To change that location, you can pass that in directly as follows:"

]

},

{

"cell_type": "code",

"execution_count": 2,

253

"id": "c05b4b22-f6b1-4669-9358-98b0fe9a9136",

"metadata": {},

"outputs": [

{

"data": {

"text/html": [

"<pre style=\"white-space:pre;overflow-x:auto;line-height:normal;font-family:Menlo,'DejaVu Sans Mono',consolas,'Courier New',monospace\">──────────────────────────────────────── Matter REPL ────────────────────────────────────────\n",

"</pre>\n"

],

"text/plain": [

"\u001b[92m──────────────────────────────────────── \u001b[0mMatter REPL\u001b[92m ────────────────────────────────────────\u001b[0m\n"

]

},

"metadata": {},

"output_type": "display_data"

},

{

"data": {

"text/html": [

"<pre style=\"white-space:pre;overflow-x:auto;line-height:normal;font-family:Menlo,'DejaVu Sans Mono',consolas,'Courier New',monospace\">\n",

273

" \n",

274

" \n",

275

" Welcome to the Matter Python REPL!\n",

276

" \n",

277

" For help, please type matterhelp()\n",

278

" \n",

279

" To get more information on a particular object/class, you can pass\n",

280

" that into matterhelp() as well.\n",

" \n",

" \n",

"</pre>\n"

],

"text/plain": [

"\n",

" \n",

"\u001b[1;34m \u001b[0m\n",

289

"\u001b[1;34m Welcome to the Matter Python REPL!\u001b[0m\n",

290

"\u001b[1;34m \u001b[0m\n",

291

"\u001b[1;34m For help, please type \u001b[0m\u001b[1;32mmatterhelp\u001b[0m\u001b[1;32m(\u001b[0m\u001b[1;32m)\u001b[0m\n",

292

"\u001b[1;34m \u001b[0m\n",

293

"\u001b[1;34m To get more information on a particular object/class, you can pass\u001b[0m\n",

294

"\u001b[1;34m that into \u001b[0m\u001b[1;32mmatterhelp\u001b[0m\u001b[1;32m(\u001b[0m\u001b[1;32m)\u001b[0m\u001b[1;34m as well.\u001b[0m\n",

295

"\u001b[1;34m \u001b[0m\n",

296

"\u001b[1;34m \u001b[0m\n"

]

},

"metadata": {},

"output_type": "display_data"

},

{

"data": {

"text/html": [

"<pre style=\"white-space:pre;overflow-x:auto;line-height:normal;font-family:Menlo,'DejaVu Sans Mono',consolas,'Courier New',monospace\">─────────────────────────────────────────────────────────────────────────────────────────────\n",

"</pre>\n"

],

"text/plain": [

"\u001b[92m─────────────────────────────────────────────────────────────────────────────────────────────\u001b[0m\n"

]

},

"metadata": {},

"output_type": "display_data"

},

{

"data": {

"text/html": [

"<pre style=\"white-space:pre;overflow-x:auto;line-height:normal;font-family:Menlo,'DejaVu Sans Mono',consolas,'Courier New',monospace\">\n",

"\n",

"</pre>\n"

],

"text/plain": [

"\n",

"\n"

]

},

"metadata": {},

"output_type": "display_data"

},

{

"data": {

"text/html": [

"<pre style=\"white-space:pre;overflow-x:auto;line-height:normal;font-family:Menlo,'DejaVu Sans Mono',consolas,'Courier New',monospace\">Restoring FabricAdmin from storage to manage FabricId 1, FabricIndex 1...\n",

"</pre>\n"

],

"text/plain": [

"\u001b[38;5;129mRestoring FabricAdmin from storage to manage FabricId \u001b[0m\u001b[1;38;5;129m1\u001b[0m\u001b[38;5;129m, FabricIndex \u001b[0m\u001b[1;38;5;129m1\u001b[0m\u001b[38;5;129m...\u001b[0m\n"

]

},

"metadata": {},

"output_type": "display_data"

},

{

"name": "stdout",

"output_type": "stream",

346

"text": [

347

"New FabricAdmin: FabricId: 1(1)\n"

]

},

{

"data": {

"text/html": [

"<pre style=\"white-space:pre;overflow-x:auto;line-height:normal;font-family:Menlo,'DejaVu Sans Mono',consolas,'Courier New',monospace\">Restoring FabricAdmin from storage to manage FabricId 2, FabricIndex 2...\n",

"</pre>\n"

],

"text/plain": [

"\u001b[38;5;129mRestoring FabricAdmin from storage to manage FabricId \u001b[0m\u001b[1;38;5;129m2\u001b[0m\u001b[38;5;129m, FabricIndex \u001b[0m\u001b[1;38;5;129m2\u001b[0m\u001b[38;5;129m...\u001b[0m\n"

]

},

"metadata": {},

"output_type": "display_data"

},

{

"name": "stdout",

"output_type": "stream",

366

"text": [

367

"New FabricAdmin: FabricId: 2(2)\n"

]

},

{

"data": {

"text/html": [

"<pre style=\"white-space:pre;overflow-x:auto;line-height:normal;font-family:Menlo,'DejaVu Sans Mono',consolas,'Courier New',monospace\">\n",

374

"Fabric Admins have been loaded and are available at fabricAdmins\n",

"</pre>\n"

],

"text/plain": [

"\n",

"\u001b[34mFabric Admins have been loaded and are available at \u001b[0m\u001b[31mfabricAdmins\u001b[0m\n"

]

},

"metadata": {},

"output_type": "display_data"

},

{

"data": {

"text/html": [

"<pre style=\"white-space:pre;overflow-x:auto;line-height:normal;font-family:Menlo,'DejaVu Sans Mono',consolas,'Courier New',monospace\">\n",

"\n",

"</pre>\n"

],

"text/plain": [

"\n",

"\n"

]

},

"metadata": {},

"output_type": "display_data"

},

{

"data": {

"text/html": [

"<pre style=\"white-space:pre;overflow-x:auto;line-height:normal;font-family:Menlo,'DejaVu Sans Mono',consolas,'Courier New',monospace\">Creating default device controller on fabric 1...\n",

"</pre>\n"

],

"text/plain": [

"\u001b[38;5;129mCreating default device controller on fabric \u001b[0m\u001b[1;38;5;129m1\u001b[0m\u001b[38;5;129m...\u001b[0m\n"

]

},

"metadata": {},

"output_type": "display_data"

},

{

"name": "stdout",

"output_type": "stream",

416

"text": [

417

"Allocating new controller with FabricId: 1(1), NodeId: 1\n"

]

},

{

"data": {

"text/html": [

"<pre style=\"white-space:pre;overflow-x:auto;line-height:normal;font-family:Menlo,'DejaVu Sans Mono',consolas,'Courier New',monospace\">\n",

424

"\n",

425

"Default CHIP Device Controller has been initialized to manage fabricAdmins[0], and is \n",

426

"available as devCtrl\n",

"</pre>\n"

],

"text/plain": [

"\n",

"\n",

"\u001b[34mDefault CHIP Device Controller has been initialized to manage \u001b[0m\u001b[1;31mfabricAdmins\u001b[0m\u001b[1;31m[\u001b[0m\u001b[1;31m0\u001b[0m\u001b[1;31m]\u001b[0m\u001b[1;34m, and is \u001b[0m\n",

433

"\u001b[1;34mavailable as \u001b[0m\u001b[1;31mdevCtrl\u001b[0m\n"

]

},

"metadata": {},

"output_type": "display_data"

}

],

"source": [

"import chip.native\n",

442

"import pkgutil\n",

443

"module = pkgutil.get_loader('chip.ChipReplStartup')\n",

444

"%run {module.path} --storagepath /tmp/repl.json"

]

},

{

"cell_type": "markdown",

449

"id": "04152051-9b58-4a12-a92c-a01db33e38ad",

"metadata": {},

"source": [

"## Help\n",

"\n",

"To get help for the various classes and their respective methods, run:"

]

},

{

"cell_type": "code",

"execution_count": 3,

460

"id": "b36f41dd-d5e2-447e-a9a4-f1eab7d92bec",

"metadata": {

"scrolled": true,

"tags": []

},

"outputs": [

{

"data": {

"text/html": [

"<pre style=\"white-space:pre;overflow-x:auto;line-height:normal;font-family:Menlo,'DejaVu Sans Mono',consolas,'Courier New',monospace\">╭─────────────────── <class 'chip.ChipDeviceCtrl.ChipDeviceController'> ────────────────────╮\n",

470

"│ ╭───────────────────────────────────────────────────────────────────────────────────────╮ │\n",

471

"│ │ <chip.ChipDeviceCtrl.ChipDeviceController object at 0x1143b3910> │ │\n",

472

"│ ╰───────────────────────────────────────────────────────────────────────────────────────╯ │\n",

473

"│ │\n",

474

"│ activeList = { │\n",

475

"│ <chip.ChipDeviceCtrl.ChipDeviceController │\n",

476

"│ object at 0x1143b3910> │\n",

477

"│ } │\n",

478

"│ devCtrl = c_void_p(140320379576320) │\n",

479

"│ isActive = True │\n",

480

"│ state = <DCState.IDLE: 1> │\n",

481

"│ cbHandleCommissioningCompleteFunct = def cbHandleCommissioningCompleteFunct(...) │\n",

482

"│ cbHandleKeyExchangeCompleteFunct = def cbHandleKeyExchangeCompleteFunct(...) │\n",

483

"│ cbOnAddressUpdateComplete = def cbOnAddressUpdateComplete(...) │\n",

484

"│ CheckIsActive = def CheckIsActive(): │\n",

485

"│ CloseBLEConnection = def CloseBLEConnection(): │\n",

486

"│ CloseSession = def CloseSession(nodeid): │\n",

487

"│ Commission = def Commission(nodeid): │\n",

488

"│ CommissionIP = def CommissionIP(ipaddr, setupPinCode, │\n",

489

"│ nodeid): │\n",

490

"│ ConnectBLE = def ConnectBLE(discriminator, setupPinCode, │\n",

491

"│ nodeid): │\n",

492

"│ ConnectBle = def ConnectBle(bleConnection): │\n",

493

"│ DiscoverAllCommissioning = def DiscoverAllCommissioning(): │\n",

494

"│ DiscoverCommissionableNodesCommissioningEn… def │\n",

495

"│ = DiscoverCommissionableNodesCommissioningEnab… │\n",

496

"│ DiscoverCommissionableNodesDeviceType = def │\n",

497

"│ DiscoverCommissionableNodesDeviceType(device… │\n",

498

"│ DiscoverCommissionableNodesLongDiscriminat… def │\n",

499

"│ = DiscoverCommissionableNodesLongDiscriminator… │\n",

500

"│ DiscoverCommissionableNodesShortDiscrimina… def │\n",

501

"│ = DiscoverCommissionableNodesShortDiscriminato… │\n",

502

"│ DiscoverCommissionableNodesVendor = def │\n",

503

"│ DiscoverCommissionableNodesVendor(vendor): │\n",

504

"│ EstablishPASESessionIP = def EstablishPASESessionIP(ipaddr, │\n",

505

"│ setupPinCode, nodeid): │\n",

506

"│ GetAddressAndPort = def GetAddressAndPort(nodeid): │\n",

507

"│ GetClusterHandler = def GetClusterHandler(): │\n",

508

"│ GetCompressedFabricId = def GetCompressedFabricId(): │\n",

509

"│ GetConnectedDeviceSync = def GetConnectedDeviceSync(nodeid): │\n",

510

"│ GetFabricId = def GetFabricId(): │\n",

511

"│ GetIPForDiscoveredDevice = def GetIPForDiscoveredDevice(idx, addrStr, │\n",

512

"│ length): │\n",

513

"│ GetLogFilter = def GetLogFilter(): │\n",

514

"│ IsConnected = def IsConnected(): │\n",

515

"│ OpenCommissioningWindow = def OpenCommissioningWindow(nodeid, timeout, │\n",

516

"│ iteration, discriminator, option): │\n",

517

"│ ParseQRCode = def ParseQRCode(qrCode, output): │\n",

518

"│ PrintDiscoveredDevices = def PrintDiscoveredDevices(): │\n",

519

"│ ReadAttribute = def ReadAttribute(nodeid: int, attributes: │\n",

520

"│ List[Union[NoneType, Tuple[int], │\n",

521

"│ Tuple[Type[chip.clusters.ClusterObjects.Clus… │\n",

522

"│ Tuple[Type[chip.clusters.ClusterObjects.Clus… │\n",

523

"│ Tuple[int, │\n",

524

"│ Type[chip.clusters.ClusterObjects.Cluster]], │\n",

525

"│ Tuple[int, │\n",

526

"│ Type[chip.clusters.ClusterObjects.ClusterAtt… │\n",

527

"│ returnClusterObject: bool = False, │\n",

528

"│ reportInterval: Tuple[int, int] = None, │\n",

529

"│ fabricFiltered: bool = True): │\n",

530

"│ Read a list of attributes from a target node │\n",

531

"│ │\n",

532

"│ nodeId: Target's Node ID │\n",

533

"│ attributes: A list of tuples of varying types │\n",

534

"│ depending on the type of read being │\n",

535

"│ requested: │\n",

536

"│ (endpoint, Clusters.ClusterA.AttributeA): │\n",

537

"│ Endpoint = specific, Cluster = specific, │\n",

538

"│ Attribute = specific │\n",

539

"│ (endpoint, Clusters.ClusterA): │\n",

540

"│ Endpoint = specific, Cluster = specific, │\n",

541

"│ Attribute = * │\n",

542

"│ (Clusters.ClusterA.AttributeA): │\n",

543

"│ Endpoint = *, Cluster = specific, │\n",

544

"│ Attribute = specific │\n",

545

"│ endpoint: │\n",

546

"│ Endpoint = specific, Cluster = *, │\n",

547

"│ Attribute = * │\n",

548

"│ Clusters.ClusterA: │\n",

549

"│ Endpoint = *, Cluster = specific, │\n",

550

"│ Attribute = * │\n",

551

"│ '*' or (): │\n",

552

"│ Endpoint = *, Cluster = *, │\n",

553

"│ Attribute = * │\n",

554

"│ │\n",

555

"│ The cluster and attributes specified │\n",

556

"│ above are to be selected from the generated │\n",

557

"│ cluster objects. │\n",

558

"│ │\n",

559

"│ e.g. │\n",

560

"│ ReadAttribute(1, [ 1 ] ) -- case 4 │\n",

561

"│ above. │\n",

562

"│ ReadAttribute(1, [ Clusters.Basic ] ) │\n",

563

"│ -- case 5 above. │\n",

564

"│ ReadAttribute(1, [ (1, │\n",

565

"│ Clusters.Basic.Attributes.Location ] ) -- │\n",

566

"│ case 1 above. │\n",

567

"│ │\n",

568

"│ returnClusterObject: This returns the data as │\n",

569

"│ consolidated cluster objects, with all │\n",

570

"│ attributes for a cluster inside │\n",

571

"│ a single cluster-wide │\n",

572

"│ cluster object. │\n",

573

"│ │\n",

574

"│ reportInterval: A tuple of two int-s for │\n",

575

"│ (MinIntervalFloor, MaxIntervalCeiling). Used │\n",

576

"│ by establishing subscriptions. │\n",

577

"│ When not provided, a read request will be │\n",

578

"│ sent. │\n",

579

"│ ReadEvent = def ReadEvent(nodeid: int, events: │\n",

580

"│ List[Union[NoneType, Tuple[int], │\n",

581

"│ Tuple[Type[chip.clusters.ClusterObjects.Clus… │\n",

582

"│ Tuple[Type[chip.clusters.ClusterObjects.Clus… │\n",

583

"│ Tuple[int, │\n",

584

"│ Type[chip.clusters.ClusterObjects.Cluster]], │\n",

585

"│ Tuple[int, │\n",

586

"│ Type[chip.clusters.ClusterObjects.ClusterEve… │\n",

587

"│ reportInterval: Tuple[int, int] = None): │\n",

588

"│ Read a list of events from a target node │\n",

589

"│ │\n",

590

"│ nodeId: Target's Node ID │\n",

591

"│ events: A list of tuples of varying types │\n",

592

"│ depending on the type of read being │\n",

593

"│ requested: │\n",

594

"│ (endpoint, Clusters.ClusterA.EventA): │\n",

595

"│ Endpoint = specific, Cluster = specific, │\n",

596

"│ Event = specific │\n",

597

"│ (endpoint, Clusters.ClusterA): │\n",

598

"│ Endpoint = specific, Cluster = specific, │\n",

599

"│ Event = * │\n",

600

"│ (Clusters.ClusterA.EventA): │\n",

601

"│ Endpoint = *, Cluster = specific, │\n",

602

"│ Event = specific │\n",

603

"│ endpoint: │\n",

604

"│ Endpoint = specific, Cluster = *, │\n",

605

"│ Event = * │\n",

606

"│ Clusters.ClusterA: │\n",

607

"│ Endpoint = *, Cluster = specific, │\n",

608

"│ Event = * │\n",

609

"│ '*' or (): │\n",

610

"│ Endpoint = *, Cluster = *, │\n",

611

"│ Event = * │\n",

612

"│ │\n",

613

"│ The cluster and events specified above are to │\n",

614

"│ be selected from the generated cluster │\n",

"│ objects. │\n",

"│ │\n",

"│ e.g. │\n",

"│ ReadEvent(1, [ 1 ] ) -- case 4 above. │\n",

619

"│ ReadEvent(1, [ Clusters.Basic ] ) -- case │\n",

620

"│ 5 above. │\n",

621

"│ ReadEvent(1, [ (1, │\n",

622

"│ Clusters.Basic.Events.Location ] ) -- case 1 │\n",

623

"│ above. │\n",

624

"│ │\n",

625

"│ reportInterval: A tuple of two int-s for │\n",

626

"│ (MinIntervalFloor, MaxIntervalCeiling). Used │\n",

627

"│ by establishing subscriptions. │\n",

628

"│ When not provided, a read request will be │\n",

629

"│ sent. │\n",

630

"│ ResolveNode = def ResolveNode(nodeid): │\n",

631

"│ SendCommand = def SendCommand(nodeid: int, endpoint: int, │\n",

632

"│ payload: │\n",

633

"│ chip.clusters.ClusterObjects.ClusterCommand, │\n",

634

"│ responseType=None, timedRequestTimeoutMs: int │\n",

635

"│ = None): │\n",

636

"│ Send a cluster-object encapsulated command to │\n",

637

"│ a node and get returned a future that can be │\n",

638

"│ awaited upon to receive the response. │\n",

639

"│ If a valid responseType is passed in, that │\n",

640

"│ will be used to deserialize the object. If │\n",

641

"│ not, the type will be automatically deduced │\n",

642

"│ from the metadata received over the wire. │\n",

643

"│ │\n",

644

"│ timedWriteTimeoutMs: Timeout for a timed │\n",

645

"│ invoke request. Omit or set to 'None' to │\n",

646

"│ indicate a non-timed request. │\n",

647

"│ SetBlockingCB = def SetBlockingCB(blockingCB): │\n",

648

"│ SetLogFilter = def SetLogFilter(category): │\n",

649

"│ SetThreadOperationalDataset = def │\n",

650

"│ SetThreadOperationalDataset(threadOperationa… │\n",

651

"│ SetWiFiCredentials = def SetWiFiCredentials(ssid, credentials): │\n",

652

"│ Shutdown = def Shutdown(): │\n",

653

"│ Shuts down this controller and reclaims any │\n",

654

"│ used resources, including the bound │\n",

655

"│ C++ constructor instance in the SDK. │\n",

656

"│ ShutdownAll = def ShutdownAll(...) Shut down all active │\n",

657

"│ controllers and reclaim any used resources. │\n",

658

"│ WriteAttribute = def WriteAttribute(nodeid: int, attributes: │\n",

659

"│ List[Tuple[int, │\n",

660

"│ chip.clusters.ClusterObjects.ClusterAttribut… │\n",

661

"│ timedRequestTimeoutMs: int = None): │\n",

662

"│ Write a list of attributes on a target node. │\n",

663

"│ │\n",

664

"│ nodeId: Target's Node ID │\n",

665

"│ timedWriteTimeoutMs: Timeout for a timed │\n",

666

"│ write request. Omit or set to 'None' to │\n",

667

"│ indicate a non-timed request. │\n",

668

"│ attributes: A list of tuples of type │\n",

669

"│ (endpoint, cluster-object): │\n",

670

"│ │\n",

671

"│ E.g │\n",

672

"│ (1, │\n",

Andrei Litvin

cf32330

2022-11-15 15:00:44 +0100

[diff] [blame]

673

"│ Clusters.UnitTesting.Attributes.XYZAttribute… │\n",

Jerry Johns

f68cd64

2022-01-28 16:39:08 -0800

[diff] [blame]

674

"│ -- Write 'hello' to the XYZ attribute on the │\n",

675

"│ test cluster to endpoint 1 │\n",

676

"│ ZCLAttributeList = def ZCLAttributeList(): │\n",

677

"│ ZCLCommandList = def ZCLCommandList(): │\n",

678

"│ ZCLReadAttribute = def ZCLReadAttribute(cluster, attribute, │\n",

679

"│ nodeid, endpoint, groupid, blocking=True): │\n",

680

"│ ZCLSend = def ZCLSend(cluster, command, nodeid, │\n",

681

"│ endpoint, groupid, args, blocking=False): │\n",

682

"│ ZCLSubscribeAttribute = def ZCLSubscribeAttribute(cluster, attribute, │\n",

683

"│ nodeid, endpoint, minInterval, maxInterval, │\n",

684

"│ blocking=True): │\n",

685

"│ ZCLWriteAttribute = def ZCLWriteAttribute(cluster: str, │\n",

686

"│ attribute: str, nodeid, endpoint, groupid, │\n",

687

"│ value, blocking=True): │\n",

688

"╰───────────────────────────────────────────────────────────────────────────────────────────╯\n",

"</pre>\n"

],

"text/plain": [

"\u001b[34m╭─\u001b[0m\u001b[34m────────────────── \u001b[0m\u001b[1;34m<\u001b[0m\u001b[1;95mclass\u001b[0m\u001b[39m \u001b[0m\u001b[32m'chip.ChipDeviceCtrl.ChipDeviceController'\u001b[0m\u001b[1;34m>\u001b[0m\u001b[34m ───────────────────\u001b[0m\u001b[34m─╮\u001b[0m\n",

693

"\u001b[34m│\u001b[0m \u001b[32m╭───────────────────────────────────────────────────────────────────────────────────────╮\u001b[0m \u001b[34m│\u001b[0m\n",

694

"\u001b[34m│\u001b[0m \u001b[32m│\u001b[0m \u001b[1m<\u001b[0m\u001b[1;95mchip.ChipDeviceCtrl.ChipDeviceController\u001b[0m\u001b[39m object at \u001b[0m\u001b[1;36m0x1143b3910\u001b[0m\u001b[1m>\u001b[0m \u001b[32m│\u001b[0m \u001b[34m│\u001b[0m\n",

695

"\u001b[34m│\u001b[0m \u001b[32m╰───────────────────────────────────────────────────────────────────────────────────────╯\u001b[0m \u001b[34m│\u001b[0m\n",

696

"\u001b[34m│\u001b[0m \u001b[34m│\u001b[0m\n",

697

"\u001b[34m│\u001b[0m \u001b[3;33mactiveList\u001b[0m = \u001b[1m{\u001b[0m \u001b[34m│\u001b[0m\n",

698

"\u001b[34m│\u001b[0m \u001b[1m<\u001b[0m\u001b[1;95mchip.ChipDeviceCtrl.ChipDeviceController\u001b[0m \u001b[34m│\u001b[0m\n",

699

"\u001b[34m│\u001b[0m \u001b[39mobject at \u001b[0m\u001b[1;36m0x1143b3910\u001b[0m\u001b[1m>\u001b[0m \u001b[34m│\u001b[0m\n",

700

"\u001b[34m│\u001b[0m \u001b[1m}\u001b[0m \u001b[34m│\u001b[0m\n",

701

"\u001b[34m│\u001b[0m \u001b[3;33mdevCtrl\u001b[0m = \u001b[1;35mc_void_p\u001b[0m\u001b[1m(\u001b[0m\u001b[1;36m140320379576320\u001b[0m\u001b[1m)\u001b[0m \u001b[34m│\u001b[0m\n",

702

"\u001b[34m│\u001b[0m \u001b[3;33misActive\u001b[0m = \u001b[3;92mTrue\u001b[0m \u001b[34m│\u001b[0m\n",

703

"\u001b[34m│\u001b[0m \u001b[3;33mstate\u001b[0m = \u001b[1m<\u001b[0m\u001b[1;95mDCState.IDLE:\u001b[0m\u001b[39m \u001b[0m\u001b[1;36m1\u001b[0m\u001b[1m>\u001b[0m \u001b[34m│\u001b[0m\n",

704

"\u001b[34m│\u001b[0m \u001b[3;33mcbHandleCommissioningCompleteFunct\u001b[0m = \u001b[3;96mdef \u001b[0m\u001b[1;31mcbHandleCommissioningCompleteFunct\u001b[0m\u001b[1m(\u001b[0m\u001b[33m...\u001b[0m\u001b[1m)\u001b[0m \u001b[34m│\u001b[0m\n",

705

"\u001b[34m│\u001b[0m \u001b[3;33mcbHandleKeyExchangeCompleteFunct\u001b[0m = \u001b[3;96mdef \u001b[0m\u001b[1;31mcbHandleKeyExchangeCompleteFunct\u001b[0m\u001b[1m(\u001b[0m\u001b[33m...\u001b[0m\u001b[1m)\u001b[0m \u001b[34m│\u001b[0m\n",

706

"\u001b[34m│\u001b[0m \u001b[3;33mcbOnAddressUpdateComplete\u001b[0m = \u001b[3;96mdef \u001b[0m\u001b[1;31mcbOnAddressUpdateComplete\u001b[0m\u001b[1m(\u001b[0m\u001b[33m...\u001b[0m\u001b[1m)\u001b[0m \u001b[34m│\u001b[0m\n",

707

"\u001b[34m│\u001b[0m \u001b[3;33mCheckIsActive\u001b[0m = \u001b[3;96mdef \u001b[0m\u001b[1;31mCheckIsActive\u001b[0m\u001b[1m(\u001b[0m\u001b[1m)\u001b[0m: \u001b[34m│\u001b[0m\n",

708

"\u001b[34m│\u001b[0m \u001b[3;33mCloseBLEConnection\u001b[0m = \u001b[3;96mdef \u001b[0m\u001b[1;31mCloseBLEConnection\u001b[0m\u001b[1m(\u001b[0m\u001b[1m)\u001b[0m: \u001b[34m│\u001b[0m\n",

709

"\u001b[34m│\u001b[0m \u001b[3;33mCloseSession\u001b[0m = \u001b[3;96mdef \u001b[0m\u001b[1;31mCloseSession\u001b[0m\u001b[1m(\u001b[0mnodeid\u001b[1m)\u001b[0m: \u001b[34m│\u001b[0m\n",

710

"\u001b[34m│\u001b[0m \u001b[3;33mCommission\u001b[0m = \u001b[3;96mdef \u001b[0m\u001b[1;31mCommission\u001b[0m\u001b[1m(\u001b[0mnodeid\u001b[1m)\u001b[0m: \u001b[34m│\u001b[0m\n",

711

"\u001b[34m│\u001b[0m \u001b[3;33mCommissionIP\u001b[0m = \u001b[3;96mdef \u001b[0m\u001b[1;31mCommissionIP\u001b[0m\u001b[1m(\u001b[0mipaddr, setupPinCode, \u001b[34m│\u001b[0m\n",

712

"\u001b[34m│\u001b[0m nodeid\u001b[1m)\u001b[0m: \u001b[34m│\u001b[0m\n",

713

"\u001b[34m│\u001b[0m \u001b[3;33mConnectBLE\u001b[0m = \u001b[3;96mdef \u001b[0m\u001b[1;31mConnectBLE\u001b[0m\u001b[1m(\u001b[0mdiscriminator, setupPinCode, \u001b[34m│\u001b[0m\n",

714

"\u001b[34m│\u001b[0m nodeid\u001b[1m)\u001b[0m: \u001b[34m│\u001b[0m\n",

715

"\u001b[34m│\u001b[0m \u001b[3;33mConnectBle\u001b[0m = \u001b[3;96mdef \u001b[0m\u001b[1;31mConnectBle\u001b[0m\u001b[1m(\u001b[0mbleConnection\u001b[1m)\u001b[0m: \u001b[34m│\u001b[0m\n",

716

"\u001b[34m│\u001b[0m \u001b[3;33mDiscoverAllCommissioning\u001b[0m = \u001b[3;96mdef \u001b[0m\u001b[1;31mDiscoverAllCommissioning\u001b[0m\u001b[1m(\u001b[0m\u001b[1m)\u001b[0m: \u001b[34m│\u001b[0m\n",

717

"\u001b[34m│\u001b[0m \u001b[3;33mDiscoverCommissionableNodesCommissioningEn…\u001b[0m \u001b[3;96mdef \u001b[0m \u001b[34m│\u001b[0m\n",

718

"\u001b[34m│\u001b[0m = \u001b[1;31mDiscoverCommissionableNodesCommissioningEnab…\u001b[0m \u001b[34m│\u001b[0m\n",

719

"\u001b[34m│\u001b[0m \u001b[3;33mDiscoverCommissionableNodesDeviceType\u001b[0m = \u001b[3;96mdef \u001b[0m \u001b[34m│\u001b[0m\n",

720

"\u001b[34m│\u001b[0m \u001b[1;31mDiscoverCommissionableNodesDeviceType\u001b[0m\u001b[1m(\u001b[0mdevice… \u001b[34m│\u001b[0m\n",

721

"\u001b[34m│\u001b[0m \u001b[3;33mDiscoverCommissionableNodesLongDiscriminat…\u001b[0m \u001b[3;96mdef \u001b[0m \u001b[34m│\u001b[0m\n",

722

"\u001b[34m│\u001b[0m = \u001b[1;31mDiscoverCommissionableNodesLongDiscriminator\u001b[0m\u001b[1m…\u001b[0m \u001b[34m│\u001b[0m\n",

723

"\u001b[34m│\u001b[0m \u001b[3;33mDiscoverCommissionableNodesShortDiscrimina…\u001b[0m \u001b[3;96mdef \u001b[0m \u001b[34m│\u001b[0m\n",

724

"\u001b[34m│\u001b[0m = \u001b[1;31mDiscoverCommissionableNodesShortDiscriminato…\u001b[0m \u001b[34m│\u001b[0m\n",

725

"\u001b[34m│\u001b[0m \u001b[3;33mDiscoverCommissionableNodesVendor\u001b[0m = \u001b[3;96mdef \u001b[0m \u001b[34m│\u001b[0m\n",

726

"\u001b[34m│\u001b[0m \u001b[1;31mDiscoverCommissionableNodesVendor\u001b[0m\u001b[1m(\u001b[0mvendor\u001b[1m)\u001b[0m: \u001b[34m│\u001b[0m\n",

727

"\u001b[34m│\u001b[0m \u001b[3;33mEstablishPASESessionIP\u001b[0m = \u001b[3;96mdef \u001b[0m\u001b[1;31mEstablishPASESessionIP\u001b[0m\u001b[1m(\u001b[0mipaddr, \u001b[34m│\u001b[0m\n",

728

"\u001b[34m│\u001b[0m setupPinCode, nodeid\u001b[1m)\u001b[0m: \u001b[34m│\u001b[0m\n",

729

"\u001b[34m│\u001b[0m \u001b[3;33mGetAddressAndPort\u001b[0m = \u001b[3;96mdef \u001b[0m\u001b[1;31mGetAddressAndPort\u001b[0m\u001b[1m(\u001b[0mnodeid\u001b[1m)\u001b[0m: \u001b[34m│\u001b[0m\n",

730

"\u001b[34m│\u001b[0m \u001b[3;33mGetClusterHandler\u001b[0m = \u001b[3;96mdef \u001b[0m\u001b[1;31mGetClusterHandler\u001b[0m\u001b[1m(\u001b[0m\u001b[1m)\u001b[0m: \u001b[34m│\u001b[0m\n",

731

"\u001b[34m│\u001b[0m \u001b[3;33mGetCompressedFabricId\u001b[0m = \u001b[3;96mdef \u001b[0m\u001b[1;31mGetCompressedFabricId\u001b[0m\u001b[1m(\u001b[0m\u001b[1m)\u001b[0m: \u001b[34m│\u001b[0m\n",

732

"\u001b[34m│\u001b[0m \u001b[3;33mGetConnectedDeviceSync\u001b[0m = \u001b[3;96mdef \u001b[0m\u001b[1;31mGetConnectedDeviceSync\u001b[0m\u001b[1m(\u001b[0mnodeid\u001b[1m)\u001b[0m: \u001b[34m│\u001b[0m\n",

733

"\u001b[34m│\u001b[0m \u001b[3;33mGetFabricId\u001b[0m = \u001b[3;96mdef \u001b[0m\u001b[1;31mGetFabricId\u001b[0m\u001b[1m(\u001b[0m\u001b[1m)\u001b[0m: \u001b[34m│\u001b[0m\n",

734

"\u001b[34m│\u001b[0m \u001b[3;33mGetIPForDiscoveredDevice\u001b[0m = \u001b[3;96mdef \u001b[0m\u001b[1;31mGetIPForDiscoveredDevice\u001b[0m\u001b[1m(\u001b[0midx, addrStr, \u001b[34m│\u001b[0m\n",

735

"\u001b[34m│\u001b[0m length\u001b[1m)\u001b[0m: \u001b[34m│\u001b[0m\n",

736

"\u001b[34m│\u001b[0m \u001b[3;33mGetLogFilter\u001b[0m = \u001b[3;96mdef \u001b[0m\u001b[1;31mGetLogFilter\u001b[0m\u001b[1m(\u001b[0m\u001b[1m)\u001b[0m: \u001b[34m│\u001b[0m\n",

737

"\u001b[34m│\u001b[0m \u001b[3;33mIsConnected\u001b[0m = \u001b[3;96mdef \u001b[0m\u001b[1;31mIsConnected\u001b[0m\u001b[1m(\u001b[0m\u001b[1m)\u001b[0m: \u001b[34m│\u001b[0m\n",

738

"\u001b[34m│\u001b[0m \u001b[3;33mOpenCommissioningWindow\u001b[0m = \u001b[3;96mdef \u001b[0m\u001b[1;31mOpenCommissioningWindow\u001b[0m\u001b[1m(\u001b[0mnodeid, timeout, \u001b[34m│\u001b[0m\n",

739

"\u001b[34m│\u001b[0m iteration, discriminator, option\u001b[1m)\u001b[0m: \u001b[34m│\u001b[0m\n",

740

"\u001b[34m│\u001b[0m \u001b[3;33mParseQRCode\u001b[0m = \u001b[3;96mdef \u001b[0m\u001b[1;31mParseQRCode\u001b[0m\u001b[1m(\u001b[0mqrCode, output\u001b[1m)\u001b[0m: \u001b[34m│\u001b[0m\n",

741

"\u001b[34m│\u001b[0m \u001b[3;33mPrintDiscoveredDevices\u001b[0m = \u001b[3;96mdef \u001b[0m\u001b[1;31mPrintDiscoveredDevices\u001b[0m\u001b[1m(\u001b[0m\u001b[1m)\u001b[0m: \u001b[34m│\u001b[0m\n",

742

"\u001b[34m│\u001b[0m \u001b[3;33mReadAttribute\u001b[0m = \u001b[3;96mdef \u001b[0m\u001b[1;31mReadAttribute\u001b[0m\u001b[1m(\u001b[0mnodeid: int, attributes: \u001b[34m│\u001b[0m\n",

743

"\u001b[34m│\u001b[0m List\u001b[1m[\u001b[0mUnion\u001b[1m[\u001b[0mNoneType, Tuple\u001b[1m[\u001b[0mint\u001b[1m]\u001b[0m, \u001b[34m│\u001b[0m\n",

744

"\u001b[34m│\u001b[0m Tuple\u001b[1m[\u001b[0mType\u001b[1m[\u001b[0mchip.clusters.ClusterObjects.Clus… \u001b[34m│\u001b[0m\n",

745

"\u001b[34m│\u001b[0m Tuple\u001b[1m[\u001b[0mType\u001b[1m[\u001b[0mchip.clusters.ClusterObjects.Clus… \u001b[34m│\u001b[0m\n",

746

"\u001b[34m│\u001b[0m Tuple\u001b[1m[\u001b[0mint, \u001b[34m│\u001b[0m\n",

747

"\u001b[34m│\u001b[0m Type\u001b[1m[\u001b[0mchip.clusters.ClusterObjects.Cluster\u001b[1m]\u001b[0m\u001b[1m]\u001b[0m, \u001b[34m│\u001b[0m\n",

748

"\u001b[34m│\u001b[0m Tuple\u001b[1m[\u001b[0mint, \u001b[34m│\u001b[0m\n",

749

"\u001b[34m│\u001b[0m Type\u001b[1m[\u001b[0mchip.clusters.ClusterObjects.ClusterAtt… \u001b[34m│\u001b[0m\n",

750

"\u001b[34m│\u001b[0m returnClusterObject: bool = \u001b[3;91mFalse\u001b[0m, \u001b[34m│\u001b[0m\n",

751

"\u001b[34m│\u001b[0m reportInterval: Tuple\u001b[1m[\u001b[0mint, int\u001b[1m]\u001b[0m = \u001b[3;35mNone\u001b[0m, \u001b[34m│\u001b[0m\n",

752

"\u001b[34m│\u001b[0m fabricFiltered: bool = \u001b[3;92mTrue\u001b[0m\u001b[1m)\u001b[0m: \u001b[34m│\u001b[0m\n",

753

"\u001b[34m│\u001b[0m \u001b[2mRead a list of attributes from a target node\u001b[0m \u001b[34m│\u001b[0m\n",

754

"\u001b[34m│\u001b[0m \u001b[34m│\u001b[0m\n",

755

"\u001b[34m│\u001b[0m \u001b[2mnodeId: Target's Node ID\u001b[0m \u001b[34m│\u001b[0m\n",

756

"\u001b[34m│\u001b[0m \u001b[2mattributes: A list of tuples of varying types\u001b[0m \u001b[34m│\u001b[0m\n",

757

"\u001b[34m│\u001b[0m \u001b[2mdepending on the type of read being \u001b[0m \u001b[34m│\u001b[0m\n",

758

"\u001b[34m│\u001b[0m \u001b[2mrequested:\u001b[0m \u001b[34m│\u001b[0m\n",

759

"\u001b[34m│\u001b[0m \u001b[2m \u001b[0m\u001b[1;2m(\u001b[0m\u001b[2mendpoint, Clusters.ClusterA.AttributeA\u001b[0m\u001b[1;2m)\u001b[0m\u001b[2m:\u001b[0m \u001b[34m│\u001b[0m\n",

760

"\u001b[34m│\u001b[0m \u001b[2mEndpoint = specific, Cluster = specific, \u001b[0m \u001b[34m│\u001b[0m\n",

761

"\u001b[34m│\u001b[0m \u001b[2mAttribute = specific\u001b[0m \u001b[34m│\u001b[0m\n",

762

"\u001b[34m│\u001b[0m \u001b[2m \u001b[0m\u001b[1;2m(\u001b[0m\u001b[2mendpoint, Clusters.ClusterA\u001b[0m\u001b[1;2m)\u001b[0m\u001b[2m: \u001b[0m \u001b[34m│\u001b[0m\n",

763

"\u001b[34m│\u001b[0m \u001b[2mEndpoint = specific, Cluster = specific, \u001b[0m \u001b[34m│\u001b[0m\n",

764

"\u001b[34m│\u001b[0m \u001b[2mAttribute = *\u001b[0m \u001b[34m│\u001b[0m\n",

765

"\u001b[34m│\u001b[0m \u001b[2m \u001b[0m\u001b[1;2m(\u001b[0m\u001b[2mClusters.ClusterA.AttributeA\u001b[0m\u001b[1;2m)\u001b[0m\u001b[2m: \u001b[0m \u001b[34m│\u001b[0m\n",

766

"\u001b[34m│\u001b[0m \u001b[2mEndpoint = *, Cluster = specific, \u001b[0m \u001b[34m│\u001b[0m\n",

767

"\u001b[34m│\u001b[0m \u001b[2mAttribute = specific\u001b[0m \u001b[34m│\u001b[0m\n",

768

"\u001b[34m│\u001b[0m \u001b[2m endpoint: \u001b[0m \u001b[34m│\u001b[0m\n",

769

"\u001b[34m│\u001b[0m \u001b[2mEndpoint = specific, Cluster = *, \u001b[0m \u001b[34m│\u001b[0m\n",

770

"\u001b[34m│\u001b[0m \u001b[2mAttribute = *\u001b[0m \u001b[34m│\u001b[0m\n",

771

"\u001b[34m│\u001b[0m \u001b[2m Clusters.ClusterA: \u001b[0m \u001b[34m│\u001b[0m\n",

772

"\u001b[34m│\u001b[0m \u001b[2mEndpoint = *, Cluster = specific, \u001b[0m \u001b[34m│\u001b[0m\n",

773

"\u001b[34m│\u001b[0m \u001b[2mAttribute = *\u001b[0m \u001b[34m│\u001b[0m\n",

774

"\u001b[34m│\u001b[0m \u001b[2m \u001b[0m\u001b[2;32m'*'\u001b[0m\u001b[2m or \u001b[0m\u001b[1;2m(\u001b[0m\u001b[1;2m)\u001b[0m\u001b[2m: \u001b[0m \u001b[34m│\u001b[0m\n",

775

"\u001b[34m│\u001b[0m \u001b[2mEndpoint = *, Cluster = *, \u001b[0m \u001b[34m│\u001b[0m\n",

776

"\u001b[34m│\u001b[0m \u001b[2mAttribute = *\u001b[0m \u001b[34m│\u001b[0m\n",

777

"\u001b[34m│\u001b[0m \u001b[34m│\u001b[0m\n",

778

"\u001b[34m│\u001b[0m \u001b[2m The cluster and attributes specified \u001b[0m \u001b[34m│\u001b[0m\n",

779

"\u001b[34m│\u001b[0m \u001b[2mabove are to be selected from the generated \u001b[0m \u001b[34m│\u001b[0m\n",

780

"\u001b[34m│\u001b[0m \u001b[2mcluster objects.\u001b[0m \u001b[34m│\u001b[0m\n",

781

"\u001b[34m│\u001b[0m \u001b[34m│\u001b[0m\n",

782

"\u001b[34m│\u001b[0m \u001b[2m e.g.\u001b[0m \u001b[34m│\u001b[0m\n",

783

"\u001b[34m│\u001b[0m \u001b[2m \u001b[0m\u001b[1;2;35mReadAttribute\u001b[0m\u001b[1;2m(\u001b[0m\u001b[1;2;36m1\u001b[0m\u001b[2m, \u001b[0m\u001b[1;2m[\u001b[0m\u001b[2m \u001b[0m\u001b[1;2;36m1\u001b[0m\u001b[2m \u001b[0m\u001b[1;2m]\u001b[0m\u001b[2m \u001b[0m\u001b[1;2m)\u001b[0m\u001b[2m -- case \u001b[0m\u001b[1;2;36m4\u001b[0m\u001b[2m \u001b[0m \u001b[34m│\u001b[0m\n",

784

"\u001b[34m│\u001b[0m \u001b[2mabove.\u001b[0m \u001b[34m│\u001b[0m\n",

785

"\u001b[34m│\u001b[0m \u001b[2m \u001b[0m\u001b[1;2;35mReadAttribute\u001b[0m\u001b[1;2m(\u001b[0m\u001b[1;2;36m1\u001b[0m\u001b[2m, \u001b[0m\u001b[1;2m[\u001b[0m\u001b[2m Clusters.Basic \u001b[0m\u001b[1;2m]\u001b[0m\u001b[2m \u001b[0m\u001b[1;2m)\u001b[0m \u001b[34m│\u001b[0m\n",

786

"\u001b[34m│\u001b[0m \u001b[2m-- case \u001b[0m\u001b[1;2;36m5\u001b[0m\u001b[2m above.\u001b[0m \u001b[34m│\u001b[0m\n",

787

"\u001b[34m│\u001b[0m \u001b[2m \u001b[0m\u001b[1;2;35mReadAttribute\u001b[0m\u001b[1;2m(\u001b[0m\u001b[1;2;36m1\u001b[0m\u001b[2m, \u001b[0m\u001b[1;2m[\u001b[0m\u001b[2m \u001b[0m\u001b[1;2m(\u001b[0m\u001b[1;2;36m1\u001b[0m\u001b[2m, \u001b[0m \u001b[34m│\u001b[0m\n",

788

"\u001b[34m│\u001b[0m \u001b[2mClusters.Basic.Attributes.Location \u001b[0m\u001b[1;2m]\u001b[0m\u001b[2m \u001b[0m\u001b[1;2m)\u001b[0m\u001b[2m -- \u001b[0m \u001b[34m│\u001b[0m\n",

789

"\u001b[34m│\u001b[0m \u001b[2mcase \u001b[0m\u001b[1;2;36m1\u001b[0m\u001b[2m above.\u001b[0m \u001b[34m│\u001b[0m\n",

790

"\u001b[34m│\u001b[0m \u001b[34m│\u001b[0m\n",

791

"\u001b[34m│\u001b[0m \u001b[2mreturnClusterObject: This returns the data as\u001b[0m \u001b[34m│\u001b[0m\n",

792

"\u001b[34m│\u001b[0m \u001b[2mconsolidated cluster objects, with all \u001b[0m \u001b[34m│\u001b[0m\n",

793

"\u001b[34m│\u001b[0m \u001b[2mattributes for a cluster inside\u001b[0m \u001b[34m│\u001b[0m\n",

794

"\u001b[34m│\u001b[0m \u001b[2m a single cluster-wide \u001b[0m \u001b[34m│\u001b[0m\n",

795

"\u001b[34m│\u001b[0m \u001b[2mcluster object.\u001b[0m \u001b[34m│\u001b[0m\n",

796

"\u001b[34m│\u001b[0m \u001b[34m│\u001b[0m\n",

797

"\u001b[34m│\u001b[0m \u001b[2mreportInterval: A tuple of two int-s for \u001b[0m \u001b[34m│\u001b[0m\n",

798

"\u001b[34m│\u001b[0m \u001b[1;2m(\u001b[0m\u001b[2mMinIntervalFloor, MaxIntervalCeiling\u001b[0m\u001b[1;2m)\u001b[0m\u001b[2m. Used \u001b[0m \u001b[34m│\u001b[0m\n",

799

"\u001b[34m│\u001b[0m \u001b[2mby establishing subscriptions.\u001b[0m \u001b[34m│\u001b[0m\n",

800

"\u001b[34m│\u001b[0m \u001b[2m When not provided, a read request will be\u001b[0m \u001b[34m│\u001b[0m\n",

801

"\u001b[34m│\u001b[0m \u001b[2msent.\u001b[0m \u001b[34m│\u001b[0m\n",

802

"\u001b[34m│\u001b[0m \u001b[3;33mReadEvent\u001b[0m = \u001b[3;96mdef \u001b[0m\u001b[1;31mReadEvent\u001b[0m\u001b[1m(\u001b[0mnodeid: int, events: \u001b[34m│\u001b[0m\n",

803

"\u001b[34m│\u001b[0m List\u001b[1m[\u001b[0mUnion\u001b[1m[\u001b[0mNoneType, Tuple\u001b[1m[\u001b[0mint\u001b[1m]\u001b[0m, \u001b[34m│\u001b[0m\n",

804

"\u001b[34m│\u001b[0m Tuple\u001b[1m[\u001b[0mType\u001b[1m[\u001b[0mchip.clusters.ClusterObjects.Clus… \u001b[34m│\u001b[0m\n",

805

"\u001b[34m│\u001b[0m Tuple\u001b[1m[\u001b[0mType\u001b[1m[\u001b[0mchip.clusters.ClusterObjects.Clus… \u001b[34m│\u001b[0m\n",

806

"\u001b[34m│\u001b[0m Tuple\u001b[1m[\u001b[0mint, \u001b[34m│\u001b[0m\n",

807

"\u001b[34m│\u001b[0m Type\u001b[1m[\u001b[0mchip.clusters.ClusterObjects.Cluster\u001b[1m]\u001b[0m\u001b[1m]\u001b[0m, \u001b[34m│\u001b[0m\n",

808

"\u001b[34m│\u001b[0m Tuple\u001b[1m[\u001b[0mint, \u001b[34m│\u001b[0m\n",

809

"\u001b[34m│\u001b[0m Type\u001b[1m[\u001b[0mchip.clusters.ClusterObjects.ClusterEve… \u001b[34m│\u001b[0m\n",

810

"\u001b[34m│\u001b[0m reportInterval: Tuple\u001b[1m[\u001b[0mint, int\u001b[1m]\u001b[0m = \u001b[3;35mNone\u001b[0m\u001b[1m)\u001b[0m: \u001b[34m│\u001b[0m\n",

811

"\u001b[34m│\u001b[0m \u001b[2mRead a list of events from a target node\u001b[0m \u001b[34m│\u001b[0m\n",

812

"\u001b[34m│\u001b[0m \u001b[34m│\u001b[0m\n",

813

"\u001b[34m│\u001b[0m \u001b[2mnodeId: Target's Node ID\u001b[0m \u001b[34m│\u001b[0m\n",

814

"\u001b[34m│\u001b[0m \u001b[2mevents: A list of tuples of varying types \u001b[0m \u001b[34m│\u001b[0m\n",

815

"\u001b[34m│\u001b[0m \u001b[2mdepending on the type of read being \u001b[0m \u001b[34m│\u001b[0m\n",

816

"\u001b[34m│\u001b[0m \u001b[2mrequested:\u001b[0m \u001b[34m│\u001b[0m\n",

817

"\u001b[34m│\u001b[0m \u001b[2m \u001b[0m\u001b[1;2m(\u001b[0m\u001b[2mendpoint, Clusters.ClusterA.EventA\u001b[0m\u001b[1;2m)\u001b[0m\u001b[2m: \u001b[0m \u001b[34m│\u001b[0m\n",

818

"\u001b[34m│\u001b[0m \u001b[2mEndpoint = specific, Cluster = specific, \u001b[0m \u001b[34m│\u001b[0m\n",

819

"\u001b[34m│\u001b[0m \u001b[2mEvent = specific\u001b[0m \u001b[34m│\u001b[0m\n",

820

"\u001b[34m│\u001b[0m \u001b[2m \u001b[0m\u001b[1;2m(\u001b[0m\u001b[2mendpoint, Clusters.ClusterA\u001b[0m\u001b[1;2m)\u001b[0m\u001b[2m: \u001b[0m \u001b[34m│\u001b[0m\n",

821

"\u001b[34m│\u001b[0m \u001b[2mEndpoint = specific, Cluster = specific, \u001b[0m \u001b[34m│\u001b[0m\n",

822

"\u001b[34m│\u001b[0m \u001b[2mEvent = *\u001b[0m \u001b[34m│\u001b[0m\n",

823

"\u001b[34m│\u001b[0m \u001b[2m \u001b[0m\u001b[1;2m(\u001b[0m\u001b[2mClusters.ClusterA.EventA\u001b[0m\u001b[1;2m)\u001b[0m\u001b[2m: \u001b[0m \u001b[34m│\u001b[0m\n",

824

"\u001b[34m│\u001b[0m \u001b[2mEndpoint = *, Cluster = specific, \u001b[0m \u001b[34m│\u001b[0m\n",

825

"\u001b[34m│\u001b[0m \u001b[2mEvent = specific\u001b[0m \u001b[34m│\u001b[0m\n",

826

"\u001b[34m│\u001b[0m \u001b[2m endpoint: \u001b[0m \u001b[34m│\u001b[0m\n",

827

"\u001b[34m│\u001b[0m \u001b[2mEndpoint = specific, Cluster = *, \u001b[0m \u001b[34m│\u001b[0m\n",

828

"\u001b[34m│\u001b[0m \u001b[2mEvent = *\u001b[0m \u001b[34m│\u001b[0m\n",

829

"\u001b[34m│\u001b[0m \u001b[2m Clusters.ClusterA: \u001b[0m \u001b[34m│\u001b[0m\n",

830

"\u001b[34m│\u001b[0m \u001b[2mEndpoint = *, Cluster = specific, \u001b[0m \u001b[34m│\u001b[0m\n",

831

"\u001b[34m│\u001b[0m \u001b[2mEvent = *\u001b[0m \u001b[34m│\u001b[0m\n",

832

"\u001b[34m│\u001b[0m \u001b[2m \u001b[0m\u001b[2;32m'*'\u001b[0m\u001b[2m or \u001b[0m\u001b[1;2m(\u001b[0m\u001b[1;2m)\u001b[0m\u001b[2m: \u001b[0m \u001b[34m│\u001b[0m\n",

833

"\u001b[34m│\u001b[0m \u001b[2mEndpoint = *, Cluster = *, \u001b[0m \u001b[34m│\u001b[0m\n",

834

"\u001b[34m│\u001b[0m \u001b[2mEvent = *\u001b[0m \u001b[34m│\u001b[0m\n",

835

"\u001b[34m│\u001b[0m \u001b[34m│\u001b[0m\n",

836

"\u001b[34m│\u001b[0m \u001b[2mThe cluster and events specified above are to\u001b[0m \u001b[34m│\u001b[0m\n",

837

"\u001b[34m│\u001b[0m \u001b[2mbe selected from the generated cluster \u001b[0m \u001b[34m│\u001b[0m\n",

838

"\u001b[34m│\u001b[0m \u001b[2mobjects.\u001b[0m \u001b[34m│\u001b[0m\n",

839

"\u001b[34m│\u001b[0m \u001b[34m│\u001b[0m\n",

840

"\u001b[34m│\u001b[0m \u001b[2me.g.\u001b[0m \u001b[34m│\u001b[0m\n",

841

"\u001b[34m│\u001b[0m \u001b[2m \u001b[0m\u001b[1;2;35mReadEvent\u001b[0m\u001b[1;2m(\u001b[0m\u001b[1;2;36m1\u001b[0m\u001b[2m, \u001b[0m\u001b[1;2m[\u001b[0m\u001b[2m \u001b[0m\u001b[1;2;36m1\u001b[0m\u001b[2m \u001b[0m\u001b[1;2m]\u001b[0m\u001b[2m \u001b[0m\u001b[1;2m)\u001b[0m\u001b[2m -- case \u001b[0m\u001b[1;2;36m4\u001b[0m\u001b[2m above.\u001b[0m \u001b[34m│\u001b[0m\n",

842

"\u001b[34m│\u001b[0m \u001b[2m \u001b[0m\u001b[1;2;35mReadEvent\u001b[0m\u001b[1;2m(\u001b[0m\u001b[1;2;36m1\u001b[0m\u001b[2m, \u001b[0m\u001b[1;2m[\u001b[0m\u001b[2m Clusters.Basic \u001b[0m\u001b[1;2m]\u001b[0m\u001b[2m \u001b[0m\u001b[1;2m)\u001b[0m\u001b[2m -- case\u001b[0m \u001b[34m│\u001b[0m\n",

843

"\u001b[34m│\u001b[0m \u001b[1;2;36m5\u001b[0m\u001b[2m above.\u001b[0m \u001b[34m│\u001b[0m\n",

844

"\u001b[34m│\u001b[0m \u001b[2m \u001b[0m\u001b[1;2;35mReadEvent\u001b[0m\u001b[1;2m(\u001b[0m\u001b[1;2;36m1\u001b[0m\u001b[2m, \u001b[0m\u001b[1;2m[\u001b[0m\u001b[2m \u001b[0m\u001b[1;2m(\u001b[0m\u001b[1;2;36m1\u001b[0m\u001b[2m, \u001b[0m \u001b[34m│\u001b[0m\n",

845

"\u001b[34m│\u001b[0m \u001b[2mClusters.Basic.Events.Location \u001b[0m\u001b[1;2m]\u001b[0m\u001b[2m \u001b[0m\u001b[1;2m)\u001b[0m\u001b[2m -- case \u001b[0m\u001b[1;2;36m1\u001b[0m\u001b[2m \u001b[0m \u001b[34m│\u001b[0m\n",

846

"\u001b[34m│\u001b[0m \u001b[2mabove.\u001b[0m \u001b[34m│\u001b[0m\n",

847

"\u001b[34m│\u001b[0m \u001b[34m│\u001b[0m\n",

848

"\u001b[34m│\u001b[0m \u001b[2mreportInterval: A tuple of two int-s for \u001b[0m \u001b[34m│\u001b[0m\n",

849

"\u001b[34m│\u001b[0m \u001b[1;2m(\u001b[0m\u001b[2mMinIntervalFloor, MaxIntervalCeiling\u001b[0m\u001b[1;2m)\u001b[0m\u001b[2m. Used \u001b[0m \u001b[34m│\u001b[0m\n",

850

"\u001b[34m│\u001b[0m \u001b[2mby establishing subscriptions.\u001b[0m \u001b[34m│\u001b[0m\n",

851

"\u001b[34m│\u001b[0m \u001b[2m When not provided, a read request will be\u001b[0m \u001b[34m│\u001b[0m\n",

852

"\u001b[34m│\u001b[0m \u001b[2msent.\u001b[0m \u001b[34m│\u001b[0m\n",

853

"\u001b[34m│\u001b[0m \u001b[3;33mResolveNode\u001b[0m = \u001b[3;96mdef \u001b[0m\u001b[1;31mResolveNode\u001b[0m\u001b[1m(\u001b[0mnodeid\u001b[1m)\u001b[0m: \u001b[34m│\u001b[0m\n",

854

"\u001b[34m│\u001b[0m \u001b[3;33mSendCommand\u001b[0m = \u001b[3;96mdef \u001b[0m\u001b[1;31mSendCommand\u001b[0m\u001b[1m(\u001b[0mnodeid: int, endpoint: int, \u001b[34m│\u001b[0m\n",

855

"\u001b[34m│\u001b[0m payload: \u001b[34m│\u001b[0m\n",

856

"\u001b[34m│\u001b[0m chip.clusters.ClusterObjects.ClusterCommand, \u001b[34m│\u001b[0m\n",

857

"\u001b[34m│\u001b[0m \u001b[33mresponseType\u001b[0m=\u001b[3;35mNone\u001b[0m, timedRequestTimeoutMs: int \u001b[34m│\u001b[0m\n",

858

"\u001b[34m│\u001b[0m = \u001b[3;35mNone\u001b[0m\u001b[1m)\u001b[0m: \u001b[34m│\u001b[0m\n",

859

"\u001b[34m│\u001b[0m \u001b[2mSend a cluster-object encapsulated command to\u001b[0m \u001b[34m│\u001b[0m\n",

860

"\u001b[34m│\u001b[0m \u001b[2ma node and get returned a future that can be \u001b[0m \u001b[34m│\u001b[0m\n",

861

"\u001b[34m│\u001b[0m \u001b[2mawaited upon to receive the response.\u001b[0m \u001b[34m│\u001b[0m\n",

862

"\u001b[34m│\u001b[0m \u001b[2mIf a valid responseType is passed in, that \u001b[0m \u001b[34m│\u001b[0m\n",

863

"\u001b[34m│\u001b[0m \u001b[2mwill be used to deserialize the object. If \u001b[0m \u001b[34m│\u001b[0m\n",

864

"\u001b[34m│\u001b[0m \u001b[2mnot, the type will be automatically deduced\u001b[0m \u001b[34m│\u001b[0m\n",

865

"\u001b[34m│\u001b[0m \u001b[2mfrom the metadata received over the wire.\u001b[0m \u001b[34m│\u001b[0m\n",

866

"\u001b[34m│\u001b[0m \u001b[34m│\u001b[0m\n",

867

"\u001b[34m│\u001b[0m \u001b[2mtimedWriteTimeoutMs: Timeout for a timed \u001b[0m \u001b[34m│\u001b[0m\n",

868

"\u001b[34m│\u001b[0m \u001b[2minvoke request. Omit or set to \u001b[0m\u001b[2;32m'None'\u001b[0m\u001b[2m to \u001b[0m \u001b[34m│\u001b[0m\n",

869

"\u001b[34m│\u001b[0m \u001b[2mindicate a non-timed request.\u001b[0m \u001b[34m│\u001b[0m\n",

870

"\u001b[34m│\u001b[0m \u001b[3;33mSetBlockingCB\u001b[0m = \u001b[3;96mdef \u001b[0m\u001b[1;31mSetBlockingCB\u001b[0m\u001b[1m(\u001b[0mblockingCB\u001b[1m)\u001b[0m: \u001b[34m│\u001b[0m\n",

871

"\u001b[34m│\u001b[0m \u001b[3;33mSetLogFilter\u001b[0m = \u001b[3;96mdef \u001b[0m\u001b[1;31mSetLogFilter\u001b[0m\u001b[1m(\u001b[0mcategory\u001b[1m)\u001b[0m: \u001b[34m│\u001b[0m\n",

872

"\u001b[34m│\u001b[0m \u001b[3;33mSetThreadOperationalDataset\u001b[0m = \u001b[3;96mdef \u001b[0m \u001b[34m│\u001b[0m\n",

873

"\u001b[34m│\u001b[0m \u001b[1;31mSetThreadOperationalDataset\u001b[0m\u001b[1m(\u001b[0mthreadOperationa… \u001b[34m│\u001b[0m\n",

874

"\u001b[34m│\u001b[0m \u001b[3;33mSetWiFiCredentials\u001b[0m = \u001b[3;96mdef \u001b[0m\u001b[1;31mSetWiFiCredentials\u001b[0m\u001b[1m(\u001b[0mssid, credentials\u001b[1m)\u001b[0m: \u001b[34m│\u001b[0m\n",

875

"\u001b[34m│\u001b[0m \u001b[3;33mShutdown\u001b[0m = \u001b[3;96mdef \u001b[0m\u001b[1;31mShutdown\u001b[0m\u001b[1m(\u001b[0m\u001b[1m)\u001b[0m: \u001b[34m│\u001b[0m\n",

876

"\u001b[34m│\u001b[0m \u001b[2mShuts down this controller and reclaims any \u001b[0m \u001b[34m│\u001b[0m\n",

877

"\u001b[34m│\u001b[0m \u001b[2mused resources, including the bound\u001b[0m \u001b[34m│\u001b[0m\n",

878

"\u001b[34m│\u001b[0m \u001b[2mC++ constructor instance in the SDK.\u001b[0m \u001b[34m│\u001b[0m\n",

879

"\u001b[34m│\u001b[0m \u001b[3;33mShutdownAll\u001b[0m = \u001b[3;96mdef \u001b[0m\u001b[1;31mShutdownAll\u001b[0m\u001b[1m(\u001b[0m\u001b[33m...\u001b[0m\u001b[1m)\u001b[0m \u001b[2mShut down all active \u001b[0m \u001b[34m│\u001b[0m\n",

880

"\u001b[34m│\u001b[0m \u001b[2mcontrollers and reclaim any used resources.\u001b[0m \u001b[34m│\u001b[0m\n",

881

"\u001b[34m│\u001b[0m \u001b[3;33mWriteAttribute\u001b[0m = \u001b[3;96mdef \u001b[0m\u001b[1;31mWriteAttribute\u001b[0m\u001b[1m(\u001b[0mnodeid: int, attributes: \u001b[34m│\u001b[0m\n",

882

"\u001b[34m│\u001b[0m List\u001b[1m[\u001b[0mTuple\u001b[1m[\u001b[0mint, \u001b[34m│\u001b[0m\n",

883

"\u001b[34m│\u001b[0m chip.clusters.ClusterObjects.ClusterAttribut… \u001b[34m│\u001b[0m\n",

884

"\u001b[34m│\u001b[0m timedRequestTimeoutMs: int = \u001b[3;35mNone\u001b[0m\u001b[1m)\u001b[0m: \u001b[34m│\u001b[0m\n",

885

"\u001b[34m│\u001b[0m \u001b[2mWrite a list of attributes on a target node.\u001b[0m \u001b[34m│\u001b[0m\n",

886

"\u001b[34m│\u001b[0m \u001b[34m│\u001b[0m\n",

887

"\u001b[34m│\u001b[0m \u001b[2mnodeId: Target's Node ID\u001b[0m \u001b[34m│\u001b[0m\n",

888

"\u001b[34m│\u001b[0m \u001b[2mtimedWriteTimeoutMs: Timeout for a timed \u001b[0m \u001b[34m│\u001b[0m\n",

889

"\u001b[34m│\u001b[0m \u001b[2mwrite request. Omit or set to \u001b[0m\u001b[2;32m'None'\u001b[0m\u001b[2m to \u001b[0m \u001b[34m│\u001b[0m\n",

890

"\u001b[34m│\u001b[0m \u001b[2mindicate a non-timed request.\u001b[0m \u001b[34m│\u001b[0m\n",

891

"\u001b[34m│\u001b[0m \u001b[2mattributes: A list of tuples of type \u001b[0m \u001b[34m│\u001b[0m\n",

892

"\u001b[34m│\u001b[0m \u001b[1;2m(\u001b[0m\u001b[2mendpoint, cluster-object\u001b[0m\u001b[1;2m)\u001b[0m\u001b[2m:\u001b[0m \u001b[34m│\u001b[0m\n",

893

"\u001b[34m│\u001b[0m \u001b[34m│\u001b[0m\n",

894

"\u001b[34m│\u001b[0m \u001b[2mE.g\u001b[0m \u001b[34m│\u001b[0m\n",

895

"\u001b[34m│\u001b[0m \u001b[2m \u001b[0m\u001b[1;2m(\u001b[0m\u001b[1;2;36m1\u001b[0m\u001b[2m, \u001b[0m \u001b[34m│\u001b[0m\n",

Andrei Litvin

cf32330

2022-11-15 15:00:44 +0100

[diff] [blame]

896

"\u001b[34m│\u001b[0m \u001b[1;2;35mClusters.UnitTesting.luster.Attributes.XYZAttribute\u001b[0m\u001b[1;2m…\u001b[0m \u001b[34m│\u001b[0m\n",

Jerry Johns

f68cd64

2022-01-28 16:39:08 -0800

[diff] [blame]

897

"\u001b[34m│\u001b[0m \u001b[2m-- Write \u001b[0m\u001b[2;32m'hello'\u001b[0m\u001b[2m to the XYZ attribute on the \u001b[0m \u001b[34m│\u001b[0m\n",

898

"\u001b[34m│\u001b[0m \u001b[2mtest cluster to endpoint \u001b[0m\u001b[1;2;36m1\u001b[0m \u001b[34m│\u001b[0m\n",

899

"\u001b[34m│\u001b[0m \u001b[3;33mZCLAttributeList\u001b[0m = \u001b[3;96mdef \u001b[0m\u001b[1;31mZCLAttributeList\u001b[0m\u001b[1m(\u001b[0m\u001b[1m)\u001b[0m: \u001b[34m│\u001b[0m\n",

900

"\u001b[34m│\u001b[0m \u001b[3;33mZCLCommandList\u001b[0m = \u001b[3;96mdef \u001b[0m\u001b[1;31mZCLCommandList\u001b[0m\u001b[1m(\u001b[0m\u001b[1m)\u001b[0m: \u001b[34m│\u001b[0m\n",

901

"\u001b[34m│\u001b[0m \u001b[3;33mZCLReadAttribute\u001b[0m = \u001b[3;96mdef \u001b[0m\u001b[1;31mZCLReadAttribute\u001b[0m\u001b[1m(\u001b[0mcluster, attribute, \u001b[34m│\u001b[0m\n",

902

"\u001b[34m│\u001b[0m nodeid, endpoint, groupid, \u001b[33mblocking\u001b[0m=\u001b[3;92mTrue\u001b[0m\u001b[1m)\u001b[0m: \u001b[34m│\u001b[0m\n",

903

"\u001b[34m│\u001b[0m \u001b[3;33mZCLSend\u001b[0m = \u001b[3;96mdef \u001b[0m\u001b[1;31mZCLSend\u001b[0m\u001b[1m(\u001b[0mcluster, command, nodeid, \u001b[34m│\u001b[0m\n",

904

"\u001b[34m│\u001b[0m endpoint, groupid, args, \u001b[33mblocking\u001b[0m=\u001b[3;91mFalse\u001b[0m\u001b[1m)\u001b[0m: \u001b[34m│\u001b[0m\n",

905

"\u001b[34m│\u001b[0m \u001b[3;33mZCLSubscribeAttribute\u001b[0m = \u001b[3;96mdef \u001b[0m\u001b[1;31mZCLSubscribeAttribute\u001b[0m\u001b[1m(\u001b[0mcluster, attribute, \u001b[34m│\u001b[0m\n",

906

"\u001b[34m│\u001b[0m nodeid, endpoint, minInterval, maxInterval, \u001b[34m│\u001b[0m\n",

907

"\u001b[34m│\u001b[0m \u001b[33mblocking\u001b[0m=\u001b[3;92mTrue\u001b[0m\u001b[1m)\u001b[0m: \u001b[34m│\u001b[0m\n",

908

"\u001b[34m│\u001b[0m \u001b[3;33mZCLWriteAttribute\u001b[0m = \u001b[3;96mdef \u001b[0m\u001b[1;31mZCLWriteAttribute\u001b[0m\u001b[1m(\u001b[0mcluster: str, \u001b[34m│\u001b[0m\n",

909

"\u001b[34m│\u001b[0m attribute: str, nodeid, endpoint, groupid, \u001b[34m│\u001b[0m\n",

910

"\u001b[34m│\u001b[0m value, \u001b[33mblocking\u001b[0m=\u001b[3;92mTrue\u001b[0m\u001b[1m)\u001b[0m: \u001b[34m│\u001b[0m\n",

911

"\u001b[34m╰───────────────────────────────────────────────────────────────────────────────────────────╯\u001b[0m\n"

]

},

"metadata": {},

"output_type": "display_data"

},

{

"data": {

"text/html": [

"<pre style=\"white-space:pre;overflow-x:auto;line-height:normal;font-family:Menlo,'DejaVu Sans Mono',consolas,'Courier New',monospace\">╭─────────── <function mattersetlog at 0x115ea1670> ───────────╮\n",

921

"│ def mattersetlog(level): │\n",

922

"│ │\n",

923

"│ 35 attribute(s) not shown. Run inspect(inspect) for options. │\n",

924

"╰──────────────────────────────────────────────────────────────╯\n",

"</pre>\n"

],

"text/plain": [

"\u001b[34m╭─\u001b[0m\u001b[34m────────── \u001b[0m\u001b[1;34m<\u001b[0m\u001b[1;95mfunction\u001b[0m\u001b[39m mattersetlog at \u001b[0m\u001b[1;36m0x115ea1670\u001b[0m\u001b[1;34m>\u001b[0m\u001b[34m ──────────\u001b[0m\u001b[34m─╮\u001b[0m\n",

929

"\u001b[34m│\u001b[0m \u001b[3;96mdef \u001b[0m\u001b[1;31mmattersetlog\u001b[0m\u001b[1m(\u001b[0mlevel\u001b[1m)\u001b[0m: \u001b[34m│\u001b[0m\n",

930

"\u001b[34m│\u001b[0m \u001b[34m│\u001b[0m\n",

931

"\u001b[34m│\u001b[0m \u001b[1;36m35\u001b[0m\u001b[3m attribute(s) not shown.\u001b[0m Run \u001b[1;35minspect\u001b[0m\u001b[1m(\u001b[0minspect\u001b[1m)\u001b[0m for options. \u001b[34m│\u001b[0m\n",

932

"\u001b[34m╰──────────────────────────────────────────────────────────────╯\u001b[0m\n"

]

},

"metadata": {},

"output_type": "display_data"

},

{

"data": {

"text/html": [

"<pre style=\"white-space:pre;overflow-x:auto;line-height:normal;font-family:Menlo,'DejaVu Sans Mono',consolas,'Courier New',monospace\">╭───────────────── <function mattersetdebug at 0x115ea1700> ──────────────────╮\n",

942

"│ def mattersetdebug(enableDebugMode: bool = True): │\n",

943

"│ │\n",

944

"│ Enables debug mode that is utilized by some Matter modules │\n",

945

"│ to better facilitate debugging of failures (e.g throwing exceptions instead │\n",

946

"│ of returning well-formatted results). │\n",

947

"│ │\n",

948

"│ 35 attribute(s) not shown. Run inspect(inspect) for options. │\n",

949

"╰─────────────────────────────────────────────────────────────────────────────╯\n",

"</pre>\n"

],

"text/plain": [

"\u001b[34m╭─\u001b[0m\u001b[34m──────────────── \u001b[0m\u001b[1;34m<\u001b[0m\u001b[1;95mfunction\u001b[0m\u001b[39m mattersetdebug at \u001b[0m\u001b[1;36m0x115ea1700\u001b[0m\u001b[1;34m>\u001b[0m\u001b[34m ─────────────────\u001b[0m\u001b[34m─╮\u001b[0m\n",

954

"\u001b[34m│\u001b[0m \u001b[3;96mdef \u001b[0m\u001b[1;31mmattersetdebug\u001b[0m\u001b[1m(\u001b[0menableDebugMode: bool = \u001b[3;92mTrue\u001b[0m\u001b[1m)\u001b[0m: \u001b[34m│\u001b[0m\n",

955

"\u001b[34m│\u001b[0m \u001b[34m│\u001b[0m\n",

956

"\u001b[34m│\u001b[0m \u001b[36mEnables debug mode that is utilized by some Matter modules\u001b[0m \u001b[34m│\u001b[0m\n",

957

"\u001b[34m│\u001b[0m \u001b[36mto better facilitate debugging of failures \u001b[0m\u001b[1;36m(\u001b[0m\u001b[36me.g throwing exceptions instead\u001b[0m \u001b[34m│\u001b[0m\n",

958

"\u001b[34m│\u001b[0m \u001b[36mof returning well-formatted results\u001b[0m\u001b[1;36m)\u001b[0m\u001b[36m.\u001b[0m \u001b[34m│\u001b[0m\n",

959

"\u001b[34m│\u001b[0m \u001b[34m│\u001b[0m\n",

960

"\u001b[34m│\u001b[0m \u001b[1;36m35\u001b[0m\u001b[3m attribute(s) not shown.\u001b[0m Run \u001b[1;35minspect\u001b[0m\u001b[1m(\u001b[0minspect\u001b[1m)\u001b[0m for options. \u001b[34m│\u001b[0m\n",

961

"\u001b[34m╰─────────────────────────────────────────────────────────────────────────────╯\u001b[0m\n"

]

},

"metadata": {},

"output_type": "display_data"

}

],

"source": [

"matterhelp()"

]

},

{

"cell_type": "markdown",

974

"id": "17536445-9ca7-4bcb-9a1b-752d08858442",

975

"metadata": {},

976

"source": [

977

"To get help on a specific method in that class, you can pass that in as an argument:"

]

},

{

"cell_type": "code",

"execution_count": 4,

983

"id": "537404ad-cf20-4ce8-9cd6-037c397339ee",

"metadata": {},

"outputs": [

{

"data": {

"text/html": [

"<pre style=\"white-space:pre;overflow-x:auto;line-height:normal;font-family:Menlo,'DejaVu Sans Mono',consolas,'Courier New',monospace\">╭─ <bound method ChipDeviceController.SendCommand of <chip.ChipDeviceCtrl.ChipDeviceControl─╮\n",

990

"│ def ChipDeviceController.SendCommand(nodeid: int, endpoint: int, payload: │\n",

991

"│ chip.clusters.ClusterObjects.ClusterCommand, responseType=None, timedRequestTimeoutMs: │\n",

992

"│ int = None): │\n",

993

"│ │\n",

994

"│ Send a cluster-object encapsulated command to a node and get returned a future that can │\n",

995

"│ be awaited upon to receive the response. │\n",

996

"│ If a valid responseType is passed in, that will be used to deserialize the object. If │\n",

997

"│ not, the type will be automatically deduced │\n",

998

"│ from the metadata received over the wire. │\n",

999

"│ │\n",

1000

"│ timedWriteTimeoutMs: Timeout for a timed invoke request. Omit or set to 'None' to │\n",

1001

"│ indicate a non-timed request. │\n",

1002

"│ │\n",

1003

"│ 27 attribute(s) not shown. Run inspect(inspect) for options. │\n",

1004

"╰───────────────────────────────────────────────────────────────────────────────────────────╯\n",

"</pre>\n"

],

"text/plain": [

"\u001b[34m╭─\u001b[0m\u001b[34m \u001b[0m\u001b[1;34m<\u001b[0m\u001b[1;95mbound\u001b[0m\u001b[39m method ChipDeviceController.SendCommand of <chip.ChipDeviceCtrl.ChipDeviceControl\u001b[0m\u001b[34m─╮\u001b[0m\n",

1009

"\u001b[34m│\u001b[0m \u001b[3;96mdef \u001b[0m\u001b[1;31mChipDeviceController.SendCommand\u001b[0m\u001b[1m(\u001b[0mnodeid: int, endpoint: int, payload: \u001b[34m│\u001b[0m\n",

1010

"\u001b[34m│\u001b[0m chip.clusters.ClusterObjects.ClusterCommand, \u001b[33mresponseType\u001b[0m=\u001b[3;35mNone\u001b[0m, timedRequestTimeoutMs: \u001b[34m│\u001b[0m\n",

1011

"\u001b[34m│\u001b[0m int = \u001b[3;35mNone\u001b[0m\u001b[1m)\u001b[0m: \u001b[34m│\u001b[0m\n",

1012

"\u001b[34m│\u001b[0m \u001b[34m│\u001b[0m\n",

1013

"\u001b[34m│\u001b[0m \u001b[36mSend a cluster-object encapsulated command to a node and get returned a future that can \u001b[0m \u001b[34m│\u001b[0m\n",

1014

"\u001b[34m│\u001b[0m \u001b[36mbe awaited upon to receive the response.\u001b[0m \u001b[34m│\u001b[0m\n",

1015

"\u001b[34m│\u001b[0m \u001b[36mIf a valid responseType is passed in, that will be used to deserialize the object. If \u001b[0m \u001b[34m│\u001b[0m\n",

1016

"\u001b[34m│\u001b[0m \u001b[36mnot, the type will be automatically deduced\u001b[0m \u001b[34m│\u001b[0m\n",

1017

"\u001b[34m│\u001b[0m \u001b[36mfrom the metadata received over the wire.\u001b[0m \u001b[34m│\u001b[0m\n",

1018

"\u001b[34m│\u001b[0m \u001b[34m│\u001b[0m\n",

1019

"\u001b[34m│\u001b[0m \u001b[36mtimedWriteTimeoutMs: Timeout for a timed invoke request. Omit or set to \u001b[0m\u001b[32m'None'\u001b[0m\u001b[36m to \u001b[0m \u001b[34m│\u001b[0m\n",

1020

"\u001b[34m│\u001b[0m \u001b[36mindicate a non-timed request.\u001b[0m \u001b[34m│\u001b[0m\n",

1021

"\u001b[34m│\u001b[0m \u001b[34m│\u001b[0m\n",

1022

"\u001b[34m│\u001b[0m \u001b[1;36m27\u001b[0m\u001b[3m attribute(s) not shown.\u001b[0m Run \u001b[1;35minspect\u001b[0m\u001b[1m(\u001b[0minspect\u001b[1m)\u001b[0m for options. \u001b[34m│\u001b[0m\n",

1023

"\u001b[34m╰───────────────────────────────────────────────────────────────────────────────────────────╯\u001b[0m\n"

]

},

"metadata": {},

"output_type": "display_data"

}

],

"source": [

"matterhelp(devCtrl.SendCommand)"

]

},

{

"cell_type": "markdown",

1036

"id": "85a5e222-3efc-499a-b41b-a76ec75e17ea",

"metadata": {},

"source": [

"## Log Levels\n",

"\n",

"By default on boot, the log level is set to `logging.ERROR`. If you would like to see more debug messages, you can set the logging level by doing so:"

]

},

{

"cell_type": "code",

"execution_count": 5,

1047

"id": "331b1d7b-02c7-4415-9583-630973024de7",

"metadata": {},

"outputs": [],

"source": [

"mattersetlog(logging.DEBUG)"

]

},

{

"cell_type": "markdown",

1056

"id": "f27e75e7-71fe-44fa-b070-f804a6afd1ce",

"metadata": {},

"source": [

"To set it back:"

]

},

{

"cell_type": "code",

"execution_count": 6,

1065

"id": "f0e3428d-2316-4f45-9746-f637191634c7",

"metadata": {},

"outputs": [],

"source": [

"mattersetlog(logging.WARNING)"

]

},

{

"cell_type": "markdown",

1074

"id": "d8bb4bc6-336e-4747-8a8b-dc8369f92246",

1075

"metadata": {},

1076

"source": [

1077

"## Pretty Printing\n",

1078

"The Matter REPL leverages the rich Python package heavily to do pretty printing of various data structures with appropriate colored formatting.\n",

1079

"\n",

1080

"This pretty printer is installed by default into the REPL environment:"

]

},

{

"cell_type": "code",

"execution_count": 7,

1086

"id": "8282f584-bd20-4b2b-b8f9-ea72cf6c4820",

"metadata": {},

"outputs": [

{

"data": {

"text/html": [

"<pre style=\"white-space:pre;overflow-x:auto;line-height:normal;font-family:Menlo,'DejaVu Sans Mono',consolas,'Courier New',monospace\">\n",

"{\n",

"│ 'value': [\n",

"│ │ 1,\n",

"│ │ 2,\n",

"│ │ 3,\n",

"│ │ 4,\n",

"│ │ [\n",

"│ │ │ 1,\n",

"│ │ │ 2\n",

"│ │ ]\n",

"│ ]\n",

"}\n",

"</pre>\n"

],

"text/plain": [

"\n",

"\u001b[1m{\u001b[0m\n",

1110

"\u001b[2;32m│ \u001b[0m\u001b[32m'value'\u001b[0m: \u001b[1m[\u001b[0m\n",

1111

"\u001b[2;32m│ │ \u001b[0m\u001b[1;36m1\u001b[0m,\n",

1112

"\u001b[2;32m│ │ \u001b[0m\u001b[1;36m2\u001b[0m,\n",

1113

"\u001b[2;32m│ │ \u001b[0m\u001b[1;36m3\u001b[0m,\n",

1114

"\u001b[2;32m│ │ \u001b[0m\u001b[1;36m4\u001b[0m,\n",

1115

"\u001b[2;32m│ │ \u001b[0m\u001b[1m[\u001b[0m\n",

1116

"\u001b[2;32m│ │ │ \u001b[0m\u001b[1;36m1\u001b[0m,\n",

1117

"\u001b[2;32m│ │ │ \u001b[0m\u001b[1;36m2\u001b[0m\n",

1118

"\u001b[2;32m│ │ \u001b[0m\u001b[1m]\u001b[0m\n",

1119

"\u001b[2;32m│ \u001b[0m\u001b[1m]\u001b[0m\n",

1120

"\u001b[1m}\u001b[0m\n"

]

},

"metadata": {},

"output_type": "display_data"

}

],

"source": [

"a = {'value': [1, 2, 3, 4, [1, 2]]}\n",

"a"

]

}

],

"metadata": {

"kernelspec": {

"display_name": "matter-env",

1136

"language": "python",

"name": "matter-env"

},

"language_info": {

"codemirror_mode": {

"name": "ipython",

"version": 3

},

"file_extension": ".py",

1145

"mimetype": "text/x-python",

1146

"name": "python",

1147

"nbconvert_exporter": "python",

1148

"pygments_lexer": "ipython3",

1149

"version": "3.8.2+chromium.10"

}

},

"nbformat": 4,

"nbformat_minor": 5

}

Jerry Johns	f68cd64	2022-01-28 16:39:08 -0800	[diff] [blame]	1	{
				2	"cells": [
				3	{
				4	"cell_type": "markdown",
				5	"id": "9cd8236c-1a11-4d08-aad3-d1744d1b26e3",
				6	"metadata": {},
				7	"source": [
				8	"# REPL Basics\n",
				9	"\n",
				10	"<a href=\"http://35.236.121.59/hub/user-redirect/git-pull?repo=https%3A%2F%2Fgithub.com%2Fproject-chip%2Fconnectedhomeip&urlpath=lab%2Ftree%2Fconnectedhomeip%2Fdocs%2Fguides%2Frepl%2FMatter%2520-%2520REPL%2520Intro.ipynb&branch=master\">\n",
				11	"<img src=\"https://i.ibb.co/hR3yWsC/launch-playground.png\" alt=\"drawing\" width=\"130\"/>\n",
				12	"</a>\n",
				13	"<br></br>\n",
				14	"\n",
				15	"This goes over the basics of interacting with the REPL."
				16	]
				17	},
				18	{
				19	"cell_type": "markdown",
				20	"id": "7b7f651c-2e64-4d0e-aa93-1a01d093c946",
				21	"metadata": {
				22	"tags": []
				23	},
				24	"source": [
				25	"## Initialization\n",
				26	"\n",
				27	"Let's first begin by setting up by importing some key modules that are needed to make it easier for us to interact with the Matter stack.\n",
				28	"\n",
				29	"`ChipReplStartup.py` is run within the global namespace. This results in all of its imports being made available here.\n",
				30	"\n",
				31	"> NOTE: _This is not needed if you launch the REPL from the command-line._"
				32	]
				33	},
				34	{
				35	"cell_type": "code",
				36	"execution_count": 1,
				37	"id": "cdffbe57-bd09-41db-a624-cbfcd65c6eae",
				38	"metadata": {
				39	"tags": []
				40	},