Mirrored_Repos/python-kasa
1
0
Fork 0
mirror of https://github.com/python-kasa/python-kasa.git synced 2024-12-22 19:23:34 +00:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity

Use markdown footnotes in supported.md (#1310)

Browse Source 
Brings our markdown inline with the [HA
markdown](https://github.com/home-assistant/home-assistant.io/pull/33342#discussion_r1653484233)
This commit is contained in:
Steven B. 2024-11-25 17:02:12 +00:00 committed by GitHub
parent 15ecf320d9
commit fe53cd7d9c
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
3 changed files with 38 additions and 47 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
README.md
View File

@ -182,15 +182,15 @@ The following devices have been tested and confirmed as working. If your device
<!--SUPPORTED_START--> <!--SUPPORTED_START-->
### Supported Kasa devices ### Supported Kasa devices
- **Plugs**: EP10, EP25<sup>\*</sup>, HS100<sup>\*\*</sup>, HS103, HS105, HS110, KP100, KP105, KP115, KP125, KP125M<sup>\*</sup>, KP401 - **Plugs**: EP10, EP25[^1], HS100[^2], HS103, HS105, HS110, KP100, KP105, KP115, KP125, KP125M[^1], KP401
- **Power Strips**: EP40, EP40M<sup>\*</sup>, HS107, HS300, KP200, KP303, KP400 - **Power Strips**: EP40, EP40M[^1], 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> - **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 - **Bulbs**: KL110, KL120, KL125, KL130, KL135, KL50, KL60, LB110
- **Light Strips**: KL400L5, KL420L5, KL430 - **Light Strips**: KL400L5, KL420L5, KL430
- **Hubs**: KH100<sup>\*</sup> - **Hubs**: KH100[^1]
- **Hub-Connected Devices<sup>\*\*\*</sup>**: KE100<sup>\*</sup> - **Hub-Connected Devices[^3]**: KE100[^1]
### Supported Tapo<sup>\*</sup> devices ### Supported Tapo[^1] devices
- **Plugs**: P100, P110, P110M, P115, P125M, P135, TP15 - **Plugs**: P100, P110, P110M, P115, P125M, P135, TP15
- **Power Strips**: P300, P304M, TP25 - **Power Strips**: P300, P304M, TP25
@ -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 - **Light Strips**: L900-10, L900-5, L920-5, L930-5
- **Cameras**: C210, TC65 - **Cameras**: C210, TC65
- **Hubs**: H100, H200 - **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--> <!--SUPPORTED_END-->
<sup>\*</sup>&nbsp;&nbsp; Model requires authentication<br> [^1]: Model requires authentication
<sup>\*\*</sup>&nbsp; Newer versions require authentication<br> [^2]: Newer versions require authentication
<sup>\*\*\*</sup> Devices may work across TAPO/KASA branded hubs [^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. See [supported devices in our documentation](SUPPORTED.md) for more detailed information about tested hardware and software versions.

45
SUPPORTED.md
View File

@ -10,18 +10,18 @@ The following devices have been tested and confirmed as working. If your device
<!--SUPPORTED_START--> <!--SUPPORTED_START-->
## Kasa devices ## 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 ### Plugs
- **EP10** - **EP10**
- Hardware: 1.0 (US) / Firmware: 1.0.2 - Hardware: 1.0 (US) / Firmware: 1.0.2
- **EP25** - **EP25**
- Hardware: 2.6 (US) / Firmware: 1.0.1<sup>\*</sup> - Hardware: 2.6 (US) / Firmware: 1.0.1[^1]
- Hardware: 2.6 (US) / Firmware: 1.0.2<sup>\*</sup> - Hardware: 2.6 (US) / Firmware: 1.0.2[^1]
- **HS100** - **HS100**
- Hardware: 1.0 (UK) / Firmware: 1.2.6 - 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: 1.0 (US) / Firmware: 1.2.5
- Hardware: 2.0 (US) / Firmware: 1.5.6 - Hardware: 2.0 (US) / Firmware: 1.5.6
- **HS103** - **HS103**
@ -46,8 +46,8 @@ Some newer Kasa devices require authentication. These are marked with <sup>*</su
- **KP125** - **KP125**
- Hardware: 1.0 (US) / Firmware: 1.0.6 - Hardware: 1.0 (US) / Firmware: 1.0.6
- **KP125M** - **KP125M**
- Hardware: 1.0 (US) / Firmware: 1.1.3<sup>\*</sup> - Hardware: 1.0 (US) / Firmware: 1.1.3[^1]
- Hardware: 1.0 (US) / Firmware: 1.2.3<sup>\*</sup> - Hardware: 1.0 (US) / Firmware: 1.2.3[^1]
- **KP401** - **KP401**
- Hardware: 1.0 (US) / Firmware: 1.0.0 - Hardware: 1.0 (US) / Firmware: 1.0.0
@ -56,7 +56,7 @@ Some newer Kasa devices require authentication. These are marked with <sup>*</su
- **EP40** - **EP40**
- Hardware: 1.0 (US) / Firmware: 1.0.2 - Hardware: 1.0 (US) / Firmware: 1.0.2
- **EP40M** - **EP40M**
- Hardware: 1.0 (US) / Firmware: 1.1.0<sup>\*</sup> - Hardware: 1.0 (US) / Firmware: 1.1.0[^1]
- **HS107** - **HS107**
- Hardware: 1.0 (US) / Firmware: 1.0.8 - Hardware: 1.0 (US) / Firmware: 1.0.8
- **HS300** - **HS300**
@ -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: 3.0 (US) / Firmware: 1.1.5
- Hardware: 5.0 (US) / Firmware: 1.0.11 - Hardware: 5.0 (US) / Firmware: 1.0.11
- Hardware: 5.0 (US) / Firmware: 1.0.2 - 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** - **HS210**
- Hardware: 1.0 (US) / Firmware: 1.5.8 - Hardware: 1.0 (US) / Firmware: 1.5.8
- Hardware: 2.0 (US) / Firmware: 1.1.5 - Hardware: 2.0 (US) / Firmware: 1.1.5
- **HS220** - **HS220**
- Hardware: 1.0 (US) / Firmware: 1.5.7 - Hardware: 1.0 (US) / Firmware: 1.5.7
- Hardware: 2.0 (US) / Firmware: 1.0.3 - 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** - **KP405**
- Hardware: 1.0 (US) / Firmware: 1.0.5 - Hardware: 1.0 (US) / Firmware: 1.0.5
- Hardware: 1.0 (US) / Firmware: 1.0.6 - Hardware: 1.0 (US) / Firmware: 1.0.6
@ -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.12
- Hardware: 1.0 (US) / Firmware: 1.0.8 - Hardware: 1.0 (US) / Firmware: 1.0.8
- **KS205** - **KS205**
- Hardware: 1.0 (US) / Firmware: 1.0.2<sup>\*</sup> - Hardware: 1.0 (US) / Firmware: 1.0.2[^1]
- Hardware: 1.0 (US) / Firmware: 1.1.0<sup>\*</sup> - Hardware: 1.0 (US) / Firmware: 1.1.0[^1]
- **KS220** - **KS220**
- Hardware: 1.0 (US) / Firmware: 1.0.13 - Hardware: 1.0 (US) / Firmware: 1.0.13
- **KS220M** - **KS220M**
- Hardware: 1.0 (US) / Firmware: 1.0.4 - Hardware: 1.0 (US) / Firmware: 1.0.4
- **KS225** - **KS225**
- Hardware: 1.0 (US) / Firmware: 1.0.2<sup>\*</sup> - Hardware: 1.0 (US) / Firmware: 1.0.2[^1]
- Hardware: 1.0 (US) / Firmware: 1.1.0<sup>\*</sup> - Hardware: 1.0 (US) / Firmware: 1.1.0[^1]
- **KS230** - **KS230**
- Hardware: 1.0 (US) / Firmware: 1.0.14 - Hardware: 1.0 (US) / Firmware: 1.0.14
- **KS240** - **KS240**
- Hardware: 1.0 (US) / Firmware: 1.0.4<sup>\*</sup> - Hardware: 1.0 (US) / Firmware: 1.0.4[^1]
- Hardware: 1.0 (US) / Firmware: 1.0.5<sup>\*</sup> - Hardware: 1.0 (US) / Firmware: 1.0.5[^1]
- Hardware: 1.0 (US) / Firmware: 1.0.7<sup>\*</sup> - Hardware: 1.0 (US) / Firmware: 1.0.7[^1]
### Bulbs ### Bulbs
@ -161,16 +161,16 @@ Some newer Kasa devices require authentication. These are marked with <sup>*</su
### Hubs ### Hubs
- **KH100** - **KH100**
- Hardware: 1.0 (EU) / Firmware: 1.2.3<sup>\*</sup> - Hardware: 1.0 (EU) / Firmware: 1.2.3[^1]
- Hardware: 1.0 (EU) / Firmware: 1.5.12<sup>\*</sup> - Hardware: 1.0 (EU) / Firmware: 1.5.12[^1]
- Hardware: 1.0 (UK) / Firmware: 1.5.6<sup>\*</sup> - Hardware: 1.0 (UK) / Firmware: 1.5.6[^1]
### Hub-Connected Devices ### Hub-Connected Devices
- **KE100** - **KE100**
- Hardware: 1.0 (EU) / Firmware: 2.4.0<sup>\*</sup> - Hardware: 1.0 (EU) / Firmware: 2.4.0[^1]
- Hardware: 1.0 (EU) / Firmware: 2.8.0<sup>\*</sup> - Hardware: 1.0 (EU) / Firmware: 2.8.0[^1]
- Hardware: 1.0 (UK) / Firmware: 2.8.0<sup>\*</sup> - Hardware: 1.0 (UK) / Firmware: 2.8.0[^1]
## Tapo devices ## Tapo devices
@ -293,3 +293,4 @@ All Tapo devices require authentication.<br>Hub-Connected Devices may work acros
<!--SUPPORTED_END--> <!--SUPPORTED_END-->
[^1]: Model requires authentication

20
devtools/generate_supported.py
View File

@ -142,7 +142,7 @@ def _supported_text(
for brand, types in supported.items(): for brand, types in supported.items():
preamble_text = ( preamble_text = (
"Some newer Kasa devices require authentication. " "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" if brand == "kasa"
else "All Tapo devices require authentication." else "All Tapo devices require authentication."
) )
@ -151,7 +151,7 @@ def _supported_text(
+ "hubs even if they don't work across the native apps." + "hubs even if they don't work across the native apps."
) )
brand_text = brand.capitalize() brand_text = brand.capitalize()
brand_auth = r"<sup>\*</sup>" if brand == "tapo" else "" brand_auth = r"[^1]" if brand == "tapo" else ""
types_text = "" types_text = ""
for supported_type, models in sorted( for supported_type, models in sorted(
# Sort by device type order in the enum # Sort by device type order in the enum
@ -166,9 +166,7 @@ def _supported_text(
for version in sorted(versions): for version in sorted(versions):
region_text = f" ({version.region})" if version.region else "" region_text = f" ({version.region})" if version.region else ""
auth_count += 1 if version.auth else 0 auth_count += 1 if version.auth else 0
vauth_flag = ( vauth_flag = r"[^1]" if version.auth and brand == "kasa" else ""
r"<sup>\*</sup>" if version.auth and brand == "kasa" else ""
)
if version_template: if version_template:
versions_text += versst.substitute( versions_text += versst.substitute(
hw=version.hw, hw=version.hw,
@ -177,11 +175,7 @@ def _supported_text(
auth_flag=vauth_flag, auth_flag=vauth_flag,
) )
if brand == "kasa" and auth_count > 0: if brand == "kasa" and auth_count > 0:
auth_flag = ( auth_flag = r"[^1]" if auth_count == len(versions) else r"[^2]"
r"<sup>\*</sup>"
if auth_count == len(versions)
else r"<sup>\*\*</sup>"
)
else: else:
auth_flag = "" auth_flag = ""
if model_template: if model_template:
@ -191,11 +185,7 @@ def _supported_text(
else: else:
models_list.append(f"{model}{auth_flag}") models_list.append(f"{model}{auth_flag}")
models_text = models_text if models_text else ", ".join(models_list) models_text = models_text if models_text else ", ".join(models_list)
type_asterix = ( type_asterix = r"[^3]" if supported_type == "Hub-Connected Devices" else ""
r"<sup>\*\*\*</sup>"
if supported_type == "Hub-Connected Devices"
else ""
)
types_text += typest.substitute( types_text += typest.substitute(
type_=supported_type, type_asterix=type_asterix, models=models_text type_=supported_type, type_asterix=type_asterix, models=models_text
) )