Skip to content

Commit

Permalink
README
Browse files Browse the repository at this point in the history
  • Loading branch information
aBozowski committed Nov 3, 2023
1 parent dc98974 commit f2e9a8c
Show file tree
Hide file tree
Showing 2 changed files with 23 additions and 4 deletions.
24 changes: 21 additions & 3 deletions src/tools/interop/idt/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -243,7 +243,18 @@ idt discover -t d
There is a per device log for ble scanning in `ble` subdirectory of the root
artifact dir.
[TODO] dnssd per device log
The `dnssd` log may be found in the dnssd directory.
### Probe
```
usage: idt probe [-h]

options:
-h, --help show this help message and exit
```
Collect contextually relevant networking info from the local environment and provide artifacts.
## Extending functionality
Expand Down Expand Up @@ -298,6 +309,13 @@ For discovery:
- `matter_dnssd` provides a simple DNS-SD browser that searches for matter
devices and thread border routers.
For probe:
- `probe` contains the base class for (`idt`'s) host platform specific implementation.
- Reuses the dnssd discovery implementation to build probe targets
- Calls platform + addr type specific probe methods for each target
- `linux` and `mac` contain `probe` implementations for each host platform
### Conventions
- `config.py` should be used to hold development configs within the directory
Expand All @@ -311,8 +329,8 @@ For discovery:
## Troubleshooting
- Change log level from `INFO` to `DEBUG` in `config.py` for additional
logging.
- Change log level from `INFO` to `DEBUG` in root `config.py` for
additional logging.
- Compiling `tcpdump` for android may require additional dependencies.
- If the build script fails for you, try
`idt_go && source idt/scripts/compilers.sh`.
Expand Down
3 changes: 2 additions & 1 deletion src/tools/interop/idt/idt.py
Original file line number Diff line number Diff line change
Expand Up @@ -178,7 +178,8 @@ def process_args(self) -> None:

capture_parser.set_defaults(func=self.command_capture)

prober_parser = subparsers.add_parser("probe", help="Probe all Matter devices on the local environment.")
prober_parser = subparsers.add_parser("probe",
help="Probe the environment for Matter and general networking info")
prober_parser.set_defaults(func=self.command_probe)

args, unknown = parser.parse_known_args()
Expand Down

0 comments on commit f2e9a8c

Please sign in to comment.