Skip to content

Use markdown footnotes in supported.md #1310

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Nov 25, 2024
Merged

Use markdown footnotes in supported.md #1310

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 10 additions & 10 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -182,15 +182,15 @@ The following devices have been tested and confirmed as working. If your device
<!--SUPPORTED_START-->
### Supported Kasa devices

- **Plugs**: EP10, EP25<sup>\*</sup>, HS100<sup>\*\*</sup>, HS103, HS105, HS110, KP100, KP105, KP115, KP125, KP125M<sup>\*</sup>, KP401
- **Power Strips**: EP40, EP40M<sup>\*</sup>, HS107, HS300, KP200, KP303, KP400
- **Wall Switches**: ES20M, HS200<sup>\*\*</sup>, HS210, HS220<sup>\*\*</sup>, KP405, KS200M, KS205<sup>\*</sup>, KS220, KS220M, KS225<sup>\*</sup>, KS230, KS240<sup>\*</sup>
- **Plugs**: EP10, EP25[^1], HS100[^2], HS103, HS105, HS110, KP100, KP105, KP115, KP125, KP125M[^1], KP401
- **Power Strips**: EP40, EP40M[^1], HS107, HS300, KP200, KP303, KP400
- **Wall Switches**: ES20M, HS200[^2], HS210, HS220[^2], KP405, KS200M, KS205[^1], KS220, KS220M, KS225[^1], KS230, KS240[^1]
- **Bulbs**: KL110, KL120, KL125, KL130, KL135, KL50, KL60, LB110
- **Light Strips**: KL400L5, KL420L5, KL430
- **Hubs**: KH100<sup>\*</sup>
- **Hub-Connected Devices<sup>\*\*\*</sup>**: KE100<sup>\*</sup>
- **Hubs**: KH100[^1]
- **Hub-Connected Devices[^3]**: KE100[^1]

### Supported Tapo<sup>\*</sup> devices
### Supported Tapo[^1] devices

- **Plugs**: P100, P110, P110M, P115, P125M, P135, TP15
- **Power Strips**: P300, P304M, TP25
Expand All @@ -199,12 +199,12 @@ The following devices have been tested and confirmed as working. If your device
- **Light Strips**: L900-10, L900-5, L920-5, L930-5
- **Cameras**: C210, TC65
- **Hubs**: H100, H200
- **Hub-Connected Devices<sup>\*\*\*</sup>**: S200B, S200D, T100, T110, T300, T310, T315
- **Hub-Connected Devices[^3]**: S200B, S200D, T100, T110, T300, T310, T315

<!--SUPPORTED_END-->
<sup>\*</sup>&nbsp;&nbsp; Model requires authentication<br>
<sup>\*\*</sup>&nbsp; Newer versions require authentication<br>
<sup>\*\*\*</sup> Devices may work across TAPO/KASA branded hubs
[^1]: Model requires authentication
[^2]: Newer versions require authentication
[^3]: Devices may work across TAPO/KASA branded hubs

See [supported devices in our documentation](SUPPORTED.md) for more detailed information about tested hardware and software versions.

Expand Down
45 changes: 23 additions & 22 deletions SUPPORTED.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,18 +10,18 @@ The following devices have been tested and confirmed as working. If your device
<!--SUPPORTED_START-->
## Kasa devices

Some newer Kasa devices require authentication. These are marked with <sup>*</sup> in the list below.<br>Hub-Connected Devices may work across TAPO/KASA branded hubs even if they don't work across the native apps.
Some newer Kasa devices require authentication. These are marked with [^1] in the list below.<br>Hub-Connected Devices may work across TAPO/KASA branded hubs even if they don't work across the native apps.

### Plugs

- **EP10**
- Hardware: 1.0 (US) / Firmware: 1.0.2
- **EP25**
- Hardware: 2.6 (US) / Firmware: 1.0.1<sup>\*</sup>
- Hardware: 2.6 (US) / Firmware: 1.0.2<sup>\*</sup>
- Hardware: 2.6 (US) / Firmware: 1.0.1[^1]
- Hardware: 2.6 (US) / Firmware: 1.0.2[^1]
- **HS100**
- Hardware: 1.0 (UK) / Firmware: 1.2.6
- Hardware: 4.1 (UK) / Firmware: 1.1.0<sup>\*</sup>
- Hardware: 4.1 (UK) / Firmware: 1.1.0[^1]
- Hardware: 1.0 (US) / Firmware: 1.2.5
- Hardware: 2.0 (US) / Firmware: 1.5.6
- **HS103**
Expand All @@ -46,8 +46,8 @@ Some newer Kasa devices require authentication. These are marked with <sup>*</su
- **KP125**
- Hardware: 1.0 (US) / Firmware: 1.0.6
- **KP125M**
- Hardware: 1.0 (US) / Firmware: 1.1.3<sup>\*</sup>
- Hardware: 1.0 (US) / Firmware: 1.2.3<sup>\*</sup>
- Hardware: 1.0 (US) / Firmware: 1.1.3[^1]
- Hardware: 1.0 (US) / Firmware: 1.2.3[^1]
- **KP401**
- Hardware: 1.0 (US) / Firmware: 1.0.0

Expand All @@ -56,7 +56,7 @@ Some newer Kasa devices require authentication. These are marked with <sup>*</su
- **EP40**
- Hardware: 1.0 (US) / Firmware: 1.0.2
- **EP40M**
- Hardware: 1.0 (US) / Firmware: 1.1.0<sup>\*</sup>
- Hardware: 1.0 (US) / Firmware: 1.1.0[^1]
- **HS107**
- Hardware: 1.0 (US) / Firmware: 1.0.8
- **HS300**
Expand Down Expand Up @@ -86,14 +86,14 @@ Some newer Kasa devices require authentication. These are marked with <sup>*</su
- Hardware: 3.0 (US) / Firmware: 1.1.5
- Hardware: 5.0 (US) / Firmware: 1.0.11
- Hardware: 5.0 (US) / Firmware: 1.0.2
- Hardware: 5.26 (US) / Firmware: 1.0.3<sup>\*</sup>
- Hardware: 5.26 (US) / Firmware: 1.0.3[^1]
- **HS210**
- Hardware: 1.0 (US) / Firmware: 1.5.8
- Hardware: 2.0 (US) / Firmware: 1.1.5
- **HS220**
- Hardware: 1.0 (US) / Firmware: 1.5.7
- Hardware: 2.0 (US) / Firmware: 1.0.3
- Hardware: 3.26 (US) / Firmware: 1.0.1<sup>\*</sup>
- Hardware: 3.26 (US) / Firmware: 1.0.1[^1]
- **KP405**
- Hardware: 1.0 (US) / Firmware: 1.0.5
- Hardware: 1.0 (US) / Firmware: 1.0.6
Expand All @@ -103,21 +103,21 @@ Some newer Kasa devices require authentication. These are marked with <sup>*</su
- Hardware: 1.0 (US) / Firmware: 1.0.12
- Hardware: 1.0 (US) / Firmware: 1.0.8
- **KS205**
- Hardware: 1.0 (US) / Firmware: 1.0.2<sup>\*</sup>
- Hardware: 1.0 (US) / Firmware: 1.1.0<sup>\*</sup>
- Hardware: 1.0 (US) / Firmware: 1.0.2[^1]
- Hardware: 1.0 (US) / Firmware: 1.1.0[^1]
- **KS220**
- Hardware: 1.0 (US) / Firmware: 1.0.13
- **KS220M**
- Hardware: 1.0 (US) / Firmware: 1.0.4
- **KS225**
- Hardware: 1.0 (US) / Firmware: 1.0.2<sup>\*</sup>
- Hardware: 1.0 (US) / Firmware: 1.1.0<sup>\*</sup>
- Hardware: 1.0 (US) / Firmware: 1.0.2[^1]
- Hardware: 1.0 (US) / Firmware: 1.1.0[^1]
- **KS230**
- Hardware: 1.0 (US) / Firmware: 1.0.14
- **KS240**
- Hardware: 1.0 (US) / Firmware: 1.0.4<sup>\*</sup>
- Hardware: 1.0 (US) / Firmware: 1.0.5<sup>\*</sup>
- Hardware: 1.0 (US) / Firmware: 1.0.7<sup>\*</sup>
- Hardware: 1.0 (US) / Firmware: 1.0.4[^1]
- Hardware: 1.0 (US) / Firmware: 1.0.5[^1]
- Hardware: 1.0 (US) / Firmware: 1.0.7[^1]

### Bulbs

Expand Down Expand Up @@ -161,16 +161,16 @@ Some newer Kasa devices require authentication. These are marked with <sup>*</su
### Hubs

- **KH100**
- Hardware: 1.0 (EU) / Firmware: 1.2.3<sup>\*</sup>
- Hardware: 1.0 (EU) / Firmware: 1.5.12<sup>\*</sup>
- Hardware: 1.0 (UK) / Firmware: 1.5.6<sup>\*</sup>
- Hardware: 1.0 (EU) / Firmware: 1.2.3[^1]
- Hardware: 1.0 (EU) / Firmware: 1.5.12[^1]
- Hardware: 1.0 (UK) / Firmware: 1.5.6[^1]

### Hub-Connected Devices

- **KE100**
- Hardware: 1.0 (EU) / Firmware: 2.4.0<sup>\*</sup>
- Hardware: 1.0 (EU) / Firmware: 2.8.0<sup>\*</sup>
- Hardware: 1.0 (UK) / Firmware: 2.8.0<sup>\*</sup>
- Hardware: 1.0 (EU) / Firmware: 2.4.0[^1]
- Hardware: 1.0 (EU) / Firmware: 2.8.0[^1]
- Hardware: 1.0 (UK) / Firmware: 2.8.0[^1]


## Tapo devices
Expand Down Expand Up @@ -293,3 +293,4 @@ All Tapo devices require authentication.<br>Hub-Connected Devices may work acros


<!--SUPPORTED_END-->
[^1]: Model requires authentication
20 changes: 5 additions & 15 deletions devtools/generate_supported.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -142,7 +142,7 @@ def _supported_text(
for brand, types in supported.items():
preamble_text = (
"Some newer Kasa devices require authentication. "
+ "These are marked with <sup>*</sup> in the list below."
+ "These are marked with [^1] in the list below."
if brand == "kasa"
else "All Tapo devices require authentication."
)
Expand All @@ -151,7 +151,7 @@ def _supported_text(
+ "hubs even if they don't work across the native apps."
)
brand_text = brand.capitalize()
brand_auth = r"<sup>\*</sup>" if brand == "tapo" else ""
brand_auth = r"[^1]" if brand == "tapo" else ""
types_text = ""
for supported_type, models in sorted(
# Sort by device type order in the enum
Expand All @@ -166,9 +166,7 @@ def _supported_text(
for version in sorted(versions):
region_text = f" ({version.region})" if version.region else ""
auth_count += 1 if version.auth else 0
vauth_flag = (
r"<sup>\*</sup>" if version.auth and brand == "kasa" else ""
)
vauth_flag = r"[^1]" if version.auth and brand == "kasa" else ""
if version_template:
versions_text += versst.substitute(
hw=version.hw,
Expand All @@ -177,11 +175,7 @@ def _supported_text(
auth_flag=vauth_flag,
)
if brand == "kasa" and auth_count > 0:
auth_flag = (
r"<sup>\*</sup>"
if auth_count == len(versions)
else r"<sup>\*\*</sup>"
)
auth_flag = r"[^1]" if auth_count == len(versions) else r"[^2]"
else:
auth_flag = ""
if model_template:
Expand All @@ -191,11 +185,7 @@ def _supported_text(
else:
models_list.append(f"{model}{auth_flag}")
models_text = models_text if models_text else ", ".join(models_list)
type_asterix = (
r"<sup>\*\*\*</sup>"
if supported_type == "Hub-Connected Devices"
else ""
)
type_asterix = r"[^3]" if supported_type == "Hub-Connected Devices" else ""
types_text += typest.substitute(
type_=supported_type, type_asterix=type_asterix, models=models_text
)
Expand Down
Loading