8000 Use markdown footnotes in supported.md (#1310) · python-kasa/python-kasa@fe53cd7 · GitHub
[go: up one dir, main page]
Skip to content

Commit fe53cd7

Browse files
sdb9696sdb9696
authored
Use markdown footnotes in supporte 8000 d.md (#1310)
Brings our markdown inline with the [HA markdown](home-assistant/home-assistant.io#33342 (comment))
1 parent 15ecf32 commit fe53cd7

File tree

3 files changed

+38
-47
lines changed

3 files changed

+38
-47
lines changed

‎README.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -182,15 +182,15 @@ The following devices have been tested and confirmed as working. If your device
182182
<!--SUPPORTED_START-->
183183
### Supported Kasa devices
184184

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

193-
### Supported Tapo<sup>\*</sup> devices
193+
### Supported Tapo[^1] devices
194194

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

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

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

‎SUPPORTED.md

Lines changed: 23 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -10,18 +10,18 @@ The following devices have been tested and confirmed as working. If your device
1010
<!--SUPPORTED_START-->
1111
## Kasa devices
1212

13-
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.
13+
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.
1414

1515
### Plugs
1616

1717
- **EP10**
1818
- Hardware: 1.0 (US) / Firmware: 1.0.2
1919
- **EP25**
20-
- Hardware: 2.6 (US) / Firmware: 1.0.1<sup>\*</sup>
21-
- Hardware: 2.6 (US) / Firmware: 1.0.2<sup>\*</sup>
20+
- Hardware: 2.6 (US) / Firmware: 1.0.1[^1]
21+
- Hardware: 2.6 (US) / Firmware: 1.0.2[^1]
2222
- **HS100**
2323
- Hardware: 1.0 (UK) / Firmware: 1.2.6
24-
- Hardware: 4.1 (UK) / Firmware: 1.1.0<sup>\*</sup>
24+
- Hardware: 4.1 (UK) / Firmware: 1.1.0[^1]
2525
- Hardware: 1.0 (US) / Firmware: 1.2.5
2626
- Hardware: 2.0 (US) / Firmware: 1.5.6
2727
- **HS103**
@@ -46,8 +46,8 @@ Some newer Kasa devices require authentication. These are marked with <sup>*</su
4646
- **KP125**
4747
- Hardware: 1.0 (US) / Firmware: 1.0.6
4848
- **KP125M**
49-
- Hardware: 1.0 (US) / Firmware: 1.1.3<sup>\*</sup>
50-
- Hardware: 1.0 (US) / Firmware: 1.2.3<sup>\*</sup>
49+
- Hardware: 1.0 (US) / Firmware: 1.1.3[^1]
50+
- Hardware: 1.0 (US) / Firmware: 1.2.3[^1]
5151
- **KP401**
5252
- Hardware: 1.0 (US) / Firmware: 1.0.0
5353

@@ -56,7 +56,7 @@ Some newer Kasa devices require authentication. These are marked with <sup>*</su
5656
- **EP40**
5757
- Hardware: 1.0 (US) / Firmware: 1.0.2
5858
- **EP40M**
59-
- Hardware: 1.0 (US) / Firmware: 1.1.0<sup>\*</sup>
59+
- Hardware: 1.0 (US) / Firmware: 1.1.0[^1]
6060
- **HS107**
6161
- Hardware: 1.0 (US) / Firmware: 1.0.8
6262
- **HS300**
@@ -86,14 +86,14 @@ Some newer Kasa devices require authentication. These are marked with <sup>*</su
8686
- Hardware: 3.0 (US) / Firmware: 1.1.5
8787
- Hardware: 5.0 (US) / Firmware: 1.0.11
8888
- Hardware: 5.0 (US) / Firmware: 1.0.2
89-
- Hardware: 5.26 (US) / Firmware: 1.0.3<sup>\*</sup>
89+
- Hardware: 5.26 (US) / Firmware: 1.0.3[^1]
9090
- **HS210**
9191
- Hardware: 1.0 (US) / Firmware: 1.5.8
9292
- Hardware: 2.0 (US) / Firmware: 1.1.5
9393
- **HS220**
9494
- Hardware: 1.0 (US) / Firmware: 1.5.7
9595
- Hardware: 2.0 (US) / Firmware: 1.0.3
96-
- Hardware: 3.26 (US) / Firmware: 1.0.1<sup>\*</sup>
96+
- Hardware: 3.26 (US) / Firmware: 1.0.1[^1]
9797
- **KP405**
9898
- Hardware: 1.0 (US) / Firmware: 1.0.5
9999
- Hardware: 1.0 (US) / Firmware: 1.0.6
@@ -103,21 +103,21 @@ Some newer Kasa devices require authentication. These are marked with <sup>*</su
103103
- Hardware: 1.0 (US) / Firmware: 1.0.12
104104
- Hardware: 1.0 (US) / Firmware: 1.0.8
105105
- **KS205**
106-
- Hardware: 1.0 (US) / Firmware: 1.0.2<sup>\*</sup>
107-
- Hardware: 1.0 (US) / Firmware: 1.1.0<sup>\*</sup>
106+
- Hardware: 1.0 (US) / Firmware: 1.0.2[^1]
107+
- Hardware: 1.0 (US) / Firmware: 1.1.0[^1]
108108
- **KS220**
109109
- Hardware: 1.0 (US) / Firmware: 1.0.13
110110
- **KS220M**
111111
- Hardware: 1.0 (US) / Firmware: 1.0.4
112112
- **KS225**
113-
- Hardware: 1.0 (US) / Firmware: 1.0.2<sup>\*</sup>
114-
- Hardware: 1.0 (US) / Firmware: 1.1.0<sup>\*</sup>
113+
- Hardware: 1.0 (US) / Firmware: 1.0.2[^1]
114+
- Hardware: 1.0 (US) / Firmware: 1.1.0[^1]
115115
- **KS230**
116116
- Hardware: 1.0 (US) / Firmware: 1.0.14
117117
- **KS240**
118-
- Hardware: 1.0 (US) / Firmware: 1.0.4<sup>\*</sup>
119-
- Hardware: 1.0 (US) / Firmware: 1.0.5<sup>\*</sup>
120-
- Hardware: 1.0 (US) / Firmware: 1.0.7<sup>\*</sup>
118+
- Hardware: 1.0 (US) / Firmware: 1.0.4[ 10000 ^1]
119+
- Hardware: 1.0 (US) / Firmware: 1.0.5[^1]
120+
- Hardware: 1.0 (US) / Firmware: 1.0.7[^1]
121121

122122
### Bulbs
123123

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

163163
- **KH100**
164-
- Hardware: 1.0 (EU) / Firmware: 1.2.3<sup>\*</sup>
165-
- Hardware: 1.0 (EU) / Firmware: 1.5.12<sup>\*</sup>
166-
- Hardware: 1.0 (UK) / Firmware: 1.5.6<sup>\*</sup>
164+
- Hardware: 1.0 (EU) / Firmware: 1.2.3[^1]
165+
- Hardware: 1.0 (EU) / Firmware: 1.5.12[^1]
166+
- Hardware: 1.0 (UK) / Firmware: 1.5.6[^1]
167167

168168
### Hub-Connected Devices
169169

170170
- **KE100**
171-
- Hardware: 1.0 (EU) / Firmware: 2.4.0<sup>\*</sup>
172-
- Hardware: 1.0 (EU) / Firmware: 2.8.0<sup>\*</sup>
173-
- Hardware: 1.0 (UK) / Firmware: 2.8.0<sup>\*</sup>
171+
- Hardware: 1.0 (EU) / Firmware: 2.4.0[^1]
172+
- Hardware: 1.0 (EU) / Firmware: 2.8.0[^1]
173+
- Hardware: 1.0 (UK) / Firmware: 2.8.0[^1]
174174

175175

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

294294

295295
<!--SUPPORTED_END-->
296+
[^1]: Model requires authentication

‎devtools/generate_supported.py

Lines changed: 5 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -142,7 +142,7 @@ def _supported_text(
142142
for brand, types in supported.items():
143143
preamble_text = (
144144
"Some newer Kasa devices require authentication. "
145-
+ "These are marked with <sup>*</sup> in the list below."
145+
+ "These are marked with [^1] in the list below."
146146
if brand == "kasa"
147147
else "All Tapo devices require authentication."
148148
)
@@ -151,7 +151,7 @@ def _supported_text(
151151
+ "hubs even if they don't work across the native apps."
152152
)
153153
brand_text = brand.capitalize()
154-
brand_auth = r"<sup>\*</sup>" if brand == "tapo" else ""
154+
brand_auth = r"[^1]" if brand == "tapo" else ""
155155
types_text = ""
156156
for supported_type, models in sorted(
157157
# Sort by device type order in the enum
@@ -166,9 +166,7 @@ def _supported_text(
166166
for version in sorted(versions):
167167
region_text = f" ({version.region})" if version.region else ""
168168
auth_count += 1 if version.auth else 0
169-
vauth_flag = (
170-
r"<sup>\*</sup>" if version.auth and brand == "kasa" else ""
171-
)
169+
vauth_flag = r"[^1]" if version.auth and brand == "kasa" else ""
172170
if version_template:
173171
versions_text += versst.substitute(
174172
hw=version.hw,
@@ -177,11 +175,7 @@ def _supported_text(
177175
auth_flag=vauth_flag,
178176
)
179177
if brand == "kasa" and auth_count > 0:
180-
auth_flag = (
181-
r"<sup>\*</sup>"
182-
if auth_count == len(versions)
183-
else r"<sup>\*\*</sup>"
184-
)
178+
auth_flag = r"[^1]" if auth_count == len(versions) else r"[^2]"
185179
else:
186180
auth_flag = ""
187181
if model_template:
@@ -191,11 +185,7 @@ def _supported_text(
191185
else:
192186
models_list.append(f"{model}{auth_flag}")
193187
models_text = models_text if models_text else ", ".join(models_list)
194-
type_asterix = (
195-
r"<sup>\*\*\*</sup>"
196-
if supported_type == "Hub-Connected Devices"
197-
else ""
198-
)
188+
type_asterix = r"[^3]" if supported_type == "Hub-Connected Devices" else ""
199189
types_text += typest.substitute(
200190
type_=supported_type, type_asterix=type_asterix, models=models_text
201191
)

0 commit comments

Comments
 (0)
0