From 88a201d421116de8d0494434020fd7af5b37175e Mon Sep 17 00:00:00 2001 From: Teemu Rytilahti Date: Wed, 13 Nov 2024 17:35:11 +0100 Subject: [PATCH 1/5] Add linkcheck to readthedocs CI --- .readthedocs.yml | 3 +++ 1 file changed, 3 insertions(+) diff --git a/.readthedocs.yml b/.readthedocs.yml index e79a0598b..a97d9f6cd 100644 --- a/.readthedocs.yml +++ b/.readthedocs.yml @@ -6,6 +6,9 @@ build: os: ubuntu-22.04 tools: python: "3" + jobs: + pre_build: + - python -m sphinx -b linkcheck -D linkcheck_timeout=1 docs/ $READTHEDOCS_OUTPUT/linkcheck python: install: From 831e954507087414530ad5c337eea6da24fde5c1 Mon Sep 17 00:00:00 2001 From: Teemu Rytilahti Date: Wed, 13 Nov 2024 17:47:18 +0100 Subject: [PATCH 2/5] Fix srcdir --- .readthedocs.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.readthedocs.yml b/.readthedocs.yml index a97d9f6cd..ac9f5338a 100644 --- a/.readthedocs.yml +++ b/.readthedocs.yml @@ -8,7 +8,7 @@ build: python: "3" jobs: pre_build: - - python -m sphinx -b linkcheck -D linkcheck_timeout=1 docs/ $READTHEDOCS_OUTPUT/linkcheck + - python -m sphinx -b linkcheck -D linkcheck_timeout=1 docs/source/ $READTHEDOCS_OUTPUT/linkcheck python: install: From 6ce7eab75e83f0e5b598ff494e313f975ad92ab0 Mon Sep 17 00:00:00 2001 From: Teemu Rytilahti Date: Wed, 13 Nov 2024 17:53:46 +0100 Subject: [PATCH 3/5] Fix --- .readthedocs.yml | 2 +- README.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/.readthedocs.yml b/.readthedocs.yml index ac9f5338a..1d01cf18f 100644 --- a/.readthedocs.yml +++ b/.readthedocs.yml @@ -8,7 +8,7 @@ build: python: "3" jobs: pre_build: - - python -m sphinx -b linkcheck -D linkcheck_timeout=1 docs/source/ $READTHEDOCS_OUTPUT/linkcheck + - python -m sphinx -b linkcheck docs/source/ $READTHEDOCS_OUTPUT/linkcheck python: install: diff --git a/README.md b/README.md index 0da595a84..448173c77 100644 --- a/README.md +++ b/README.md @@ -211,7 +211,7 @@ See [supported devices in our documentation](SUPPORTED.md) for more detailed inf ### Developer Resources -* [softScheck's github contains lot of information and wireshark dissector](https://github.com/softScheck/tplink-smartplug#wireshark-dissector) +* [softScheck's github contains lot of information and wireshark dissector](https://github.com/softScheck/tplink-smartplug?tab=readme-ov-file#wireshark-dissector) * [TP-Link Smart Home Device Simulator](https://github.com/plasticrake/tplink-smarthome-simulator) * [Unofficial API documentation](https://github.com/plasticrake/tplink-smarthome-api) * [Another unofficial API documentation](https://github.com/whitslack/kasa) From 20a3b22364ffccfc137c8c077c118f164e241e7d Mon Sep 17 00:00:00 2001 From: Teemu Rytilahti Date: Wed, 13 Nov 2024 17:56:38 +0100 Subject: [PATCH 4/5] Remove anchor --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 448173c77..60ff35a20 100644 --- a/README.md +++ b/README.md @@ -211,7 +211,7 @@ See [supported devices in our documentation](SUPPORTED.md) for more detailed inf ### Developer Resources -* [softScheck's github contains lot of information and wireshark dissector](https://github.com/softScheck/tplink-smartplug?tab=readme-ov-file#wireshark-dissector) +* [softScheck's github contains lot of information and wireshark dissector](https://github.com/softScheck/tplink-smartplug) * [TP-Link Smart Home Device Simulator](https://github.com/plasticrake/tplink-smarthome-simulator) * [Unofficial API documentation](https://github.com/plasticrake/tplink-smarthome-api) * [Another unofficial API documentation](https://github.com/whitslack/kasa) From cacd8e9f5a1bb29c438c36727552d86736b2b687 Mon Sep 17 00:00:00 2001 From: Teemu Rytilahti Date: Wed, 13 Nov 2024 18:11:31 +0100 Subject: [PATCH 5/5] Fix contribute.md --- docs/source/contribute.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/source/contribute.md b/docs/source/contribute.md index 2f735ce18..8a0603838 100644 --- a/docs/source/contribute.md +++ b/docs/source/contribute.md @@ -49,7 +49,7 @@ Note that this will perform state changes on the device. ## Analyzing network captures The simplest way to add support for a new device or to improve existing ones is to capture traffic between the mobile app and the device. -After capturing the traffic, you can either use the [softScheck's wireshark dissector](https://github.com/softScheck/tplink-smartplug#wireshark-dissector) +After capturing the traffic, you can either use the [softScheck's wireshark dissector](https://github.com/softScheck/tplink-smartplug) or the `parse_pcap.py` script contained inside the `devtools` directory. Note, that this works currently only on kasa-branded devices which use port 9999 for communications.