From edfe0329bf45b6e76f4de33e4a8f254fc33f7c09 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Kuba=20Szczodrzy=C5=84ski?= Date: Wed, 18 Jan 2023 17:59:19 +0100 Subject: [PATCH] [docs] Update links in board docs --- boards/_base/beken-72xx.json | 3 +-- boards/_base/realtek-ambz.json | 5 ++--- boards/_base/realtek-ambz2.json | 2 +- boards/bw12/README.md | 5 ++--- boards/bw15/README.md | 2 +- boards/cb2l/README.md | 1 - boards/cb2s/README.md | 1 - boards/cb3l/README.md | 1 - boards/cb3s/README.md | 1 - boards/cb3se/README.md | 1 - boards/generic-bk7231n-qfn32-tuya/README.md | 1 - boards/generic-bk7231t-qfn32-tuya/README.md | 1 - boards/generic-bk7252/README.md | 1 - boards/generic-rtl8710bn-2mb-468k/README.md | 5 ++--- boards/generic-rtl8710bn-2mb-788k/README.md | 5 ++--- boards/generic-rtl8710bx-4mb-980k/README.md | 5 ++--- boards/generic-rtl8720cf-2mb-992k/README.md | 2 +- boards/lsc-lma35/README.md | 1 - boards/wb2l/README.md | 1 - boards/wb2s/README.md | 1 - boards/wb3l/README.md | 1 - boards/wb3s/README.md | 1 - boards/wr2/README.md | 5 ++--- boards/wr2e/README.md | 5 ++--- boards/wr2l/README.md | 5 ++--- boards/wr2le/README.md | 5 ++--- boards/wr3/README.md | 5 ++--- boards/wr3e/README.md | 5 ++--- boards/wr3l/README.md | 5 ++--- boards/wr3le/README.md | 5 ++--- boards/wr3n/README.md | 5 ++--- docs/update_docs.py | 3 ++- 32 files changed, 34 insertions(+), 61 deletions(-) diff --git a/boards/_base/beken-72xx.json b/boards/_base/beken-72xx.json index d132845..bbbaef8 100644 --- a/boards/_base/beken-72xx.json +++ b/boards/_base/beken-72xx.json @@ -46,8 +46,7 @@ }, "links": { "General info": "../../docs/platform/beken-72xx/README.md", - "Flashing guide": "../../docs/platform/beken-72xx/flashing.md", - "BkWriter v1.6.0": "https://images.tuyacn.com/smart/bk_writer1.60/bk_writer1.60.exe" + "Flashing guide": "../../docs/platform/beken-72xx/flashing.md" }, "extra": [ "Bootloader and app partitions contain CRC16 sums every 32 bytes. That results in the actual flash offsets/sizes not aligned to sector boundaries. To simplify calculations, the values shown in the table (extracted from bootloader's partition table) were aligned to 4096 bytes." diff --git a/boards/_base/realtek-ambz.json b/boards/_base/realtek-ambz.json index 77363c6..9585c44 100644 --- a/boards/_base/realtek-ambz.json +++ b/boards/_base/realtek-ambz.json @@ -47,10 +47,9 @@ } }, "links": { - "General info": "../../docs/platform/realtek/README.md", - "Debugging": "../../docs/platform/realtek/debugging.md", + "General info": "../../docs/platform/realtek-amb/README.md", "Flashing guide": "../../docs/platform/realtek-ambz/flashing.md", - "ImageTool (AmebaZ/AmebaD)": "https://images.tuyacn.com/smart/Image_Tool/Image_Tool.zip" + "Debugging": "../../docs/platform/realtek-ambz/debugging.md" }, "extra": [ "RDP is most likely not used in Tuya firmwares, as the System Data partition contains an incorrect offset 0xFF000 for RDP, which is in the middle of OTA2 image.", diff --git a/boards/_base/realtek-ambz2.json b/boards/_base/realtek-ambz2.json index 52b71db..c7f451a 100644 --- a/boards/_base/realtek-ambz2.json +++ b/boards/_base/realtek-ambz2.json @@ -29,7 +29,7 @@ "voltage": "3.0V - 3.6V" }, "links": { - "General info": "../../docs/platform/realtek/README.md" + "General info": "../../docs/platform/realtek-amb/README.md" } } } diff --git a/boards/bw12/README.md b/boards/bw12/README.md index 687fc80..db2e50c 100644 --- a/boards/bw12/README.md +++ b/boards/bw12/README.md @@ -4,10 +4,9 @@ [Product page](http://www.ai-thinker.com/pro_view-13.html) -- [General info](../../docs/platform/realtek/README.md) -- [Debugging](../../docs/platform/realtek/debugging.md) +- [General info](../../docs/platform/realtek-amb/README.md) - [Flashing guide](../../docs/platform/realtek-ambz/flashing.md) -- [ImageTool (AmebaZ/AmebaD)](https://images.tuyacn.com/smart/Image_Tool/Image_Tool.zip) +- [Debugging](../../docs/platform/realtek-ambz/debugging.md) - [Vendor datasheet](https://docs.ai-thinker.com/_media/rtl8710/hardware/bw12_datasheet_en.pdf) Parameter | Value diff --git a/boards/bw15/README.md b/boards/bw15/README.md index aa9824d..9c5c778 100644 --- a/boards/bw15/README.md +++ b/boards/bw15/README.md @@ -4,7 +4,7 @@ [Product page](https://docs.ai-thinker.com/_media/rtl8710/docs/bw15_datasheet_en.pdf) -- [General info](../../docs/platform/realtek/README.md) +- [General info](../../docs/platform/realtek-amb/README.md) - [Vendor datasheet](https://docs.ai-thinker.com/_media/rtl8710/docs/bw15_datasheet_en.pdf) Parameter | Value diff --git a/boards/cb2l/README.md b/boards/cb2l/README.md index 371b678..103c865 100644 --- a/boards/cb2l/README.md +++ b/boards/cb2l/README.md @@ -6,7 +6,6 @@ - [General info](../../docs/platform/beken-72xx/README.md) - [Flashing guide](../../docs/platform/beken-72xx/flashing.md) -- [BkWriter v1.6.0](https://images.tuyacn.com/smart/bk_writer1.60/bk_writer1.60.exe) Parameter | Value -------------|------------------------------------------ diff --git a/boards/cb2s/README.md b/boards/cb2s/README.md index c7c12c7..bdaf6f8 100644 --- a/boards/cb2s/README.md +++ b/boards/cb2s/README.md @@ -6,7 +6,6 @@ - [General info](../../docs/platform/beken-72xx/README.md) - [Flashing guide](../../docs/platform/beken-72xx/flashing.md) -- [BkWriter v1.6.0](https://images.tuyacn.com/smart/bk_writer1.60/bk_writer1.60.exe) Parameter | Value -------------|------------------------------------------ diff --git a/boards/cb3l/README.md b/boards/cb3l/README.md index d7798f4..3d0a043 100644 --- a/boards/cb3l/README.md +++ b/boards/cb3l/README.md @@ -6,7 +6,6 @@ - [General info](../../docs/platform/beken-72xx/README.md) - [Flashing guide](../../docs/platform/beken-72xx/flashing.md) -- [BkWriter v1.6.0](https://images.tuyacn.com/smart/bk_writer1.60/bk_writer1.60.exe) Parameter | Value -------------|------------------------------------------ diff --git a/boards/cb3s/README.md b/boards/cb3s/README.md index 5ddc3fd..825ed95 100644 --- a/boards/cb3s/README.md +++ b/boards/cb3s/README.md @@ -6,7 +6,6 @@ - [General info](../../docs/platform/beken-72xx/README.md) - [Flashing guide](../../docs/platform/beken-72xx/flashing.md) -- [BkWriter v1.6.0](https://images.tuyacn.com/smart/bk_writer1.60/bk_writer1.60.exe) Parameter | Value -------------|------------------------------------------ diff --git a/boards/cb3se/README.md b/boards/cb3se/README.md index 262dd52..584b8be 100644 --- a/boards/cb3se/README.md +++ b/boards/cb3se/README.md @@ -6,7 +6,6 @@ - [General info](../../docs/platform/beken-72xx/README.md) - [Flashing guide](../../docs/platform/beken-72xx/flashing.md) -- [BkWriter v1.6.0](https://images.tuyacn.com/smart/bk_writer1.60/bk_writer1.60.exe) Parameter | Value -------------|-------------------------------------------- diff --git a/boards/generic-bk7231n-qfn32-tuya/README.md b/boards/generic-bk7231n-qfn32-tuya/README.md index 574d10e..a6a34c7 100644 --- a/boards/generic-bk7231n-qfn32-tuya/README.md +++ b/boards/generic-bk7231n-qfn32-tuya/README.md @@ -6,7 +6,6 @@ - [General info](../../docs/platform/beken-72xx/README.md) - [Flashing guide](../../docs/platform/beken-72xx/flashing.md) -- [BkWriter v1.6.0](https://images.tuyacn.com/smart/bk_writer1.60/bk_writer1.60.exe) Parameter | Value -------------|---------------------------------- diff --git a/boards/generic-bk7231t-qfn32-tuya/README.md b/boards/generic-bk7231t-qfn32-tuya/README.md index f5ab91d..8554058 100644 --- a/boards/generic-bk7231t-qfn32-tuya/README.md +++ b/boards/generic-bk7231t-qfn32-tuya/README.md @@ -6,7 +6,6 @@ - [General info](../../docs/platform/beken-72xx/README.md) - [Flashing guide](../../docs/platform/beken-72xx/flashing.md) -- [BkWriter v1.6.0](https://images.tuyacn.com/smart/bk_writer1.60/bk_writer1.60.exe) Parameter | Value -------------|---------------------------------- diff --git a/boards/generic-bk7252/README.md b/boards/generic-bk7252/README.md index c7ea4d9..6517fed 100644 --- a/boards/generic-bk7252/README.md +++ b/boards/generic-bk7252/README.md @@ -6,7 +6,6 @@ - [General info](../../docs/platform/beken-72xx/README.md) - [Flashing guide](../../docs/platform/beken-72xx/flashing.md) -- [BkWriter v1.6.0](https://images.tuyacn.com/smart/bk_writer1.60/bk_writer1.60.exe) Parameter | Value -------------|---------------------------------- diff --git a/boards/generic-rtl8710bn-2mb-468k/README.md b/boards/generic-rtl8710bn-2mb-468k/README.md index 1a1244e..8d692ca 100644 --- a/boards/generic-rtl8710bn-2mb-468k/README.md +++ b/boards/generic-rtl8710bn-2mb-468k/README.md @@ -4,10 +4,9 @@ [Product page](https://kuba2k2.github.io/libretuya/boards/generic-rtl8710bn-2mb-468k/) -- [General info](../../docs/platform/realtek/README.md) -- [Debugging](../../docs/platform/realtek/debugging.md) +- [General info](../../docs/platform/realtek-amb/README.md) - [Flashing guide](../../docs/platform/realtek-ambz/flashing.md) -- [ImageTool (AmebaZ/AmebaD)](https://images.tuyacn.com/smart/Image_Tool/Image_Tool.zip) +- [Debugging](../../docs/platform/realtek-ambz/debugging.md) Parameter | Value -------------|---------------------------------- diff --git a/boards/generic-rtl8710bn-2mb-788k/README.md b/boards/generic-rtl8710bn-2mb-788k/README.md index 1922a3d..d2d7c83 100644 --- a/boards/generic-rtl8710bn-2mb-788k/README.md +++ b/boards/generic-rtl8710bn-2mb-788k/README.md @@ -4,10 +4,9 @@ [Product page](https://kuba2k2.github.io/libretuya/boards/generic-rtl8710bn-2mb-788k/) -- [General info](../../docs/platform/realtek/README.md) -- [Debugging](../../docs/platform/realtek/debugging.md) +- [General info](../../docs/platform/realtek-amb/README.md) - [Flashing guide](../../docs/platform/realtek-ambz/flashing.md) -- [ImageTool (AmebaZ/AmebaD)](https://images.tuyacn.com/smart/Image_Tool/Image_Tool.zip) +- [Debugging](../../docs/platform/realtek-ambz/debugging.md) Parameter | Value -------------|---------------------------------- diff --git a/boards/generic-rtl8710bx-4mb-980k/README.md b/boards/generic-rtl8710bx-4mb-980k/README.md index 5966b97..403467d 100644 --- a/boards/generic-rtl8710bx-4mb-980k/README.md +++ b/boards/generic-rtl8710bx-4mb-980k/README.md @@ -4,10 +4,9 @@ [Product page](https://kuba2k2.github.io/libretuya/boards/generic-rtl8710bx-4mb-980k/) -- [General info](../../docs/platform/realtek/README.md) -- [Debugging](../../docs/platform/realtek/debugging.md) +- [General info](../../docs/platform/realtek-amb/README.md) - [Flashing guide](../../docs/platform/realtek-ambz/flashing.md) -- [ImageTool (AmebaZ/AmebaD)](https://images.tuyacn.com/smart/Image_Tool/Image_Tool.zip) +- [Debugging](../../docs/platform/realtek-ambz/debugging.md) Parameter | Value -------------|---------------------------------- diff --git a/boards/generic-rtl8720cf-2mb-992k/README.md b/boards/generic-rtl8720cf-2mb-992k/README.md index f9fee6f..bab705c 100644 --- a/boards/generic-rtl8720cf-2mb-992k/README.md +++ b/boards/generic-rtl8720cf-2mb-992k/README.md @@ -4,7 +4,7 @@ [Product page](https://kuba2k2.github.io/libretuya/boards/generic-rtl8720cf-2mb-992k/) -- [General info](../../docs/platform/realtek/README.md) +- [General info](../../docs/platform/realtek-amb/README.md) Parameter | Value -------------|----------------------------- diff --git a/boards/lsc-lma35/README.md b/boards/lsc-lma35/README.md index c274186..9065734 100644 --- a/boards/lsc-lma35/README.md +++ b/boards/lsc-lma35/README.md @@ -6,7 +6,6 @@ - [General info](../../docs/platform/beken-72xx/README.md) - [Flashing guide](../../docs/platform/beken-72xx/flashing.md) -- [BkWriter v1.6.0](https://images.tuyacn.com/smart/bk_writer1.60/bk_writer1.60.exe) Parameter | Value -------------|---------------------------------- diff --git a/boards/wb2l/README.md b/boards/wb2l/README.md index 4ceb118..698083f 100644 --- a/boards/wb2l/README.md +++ b/boards/wb2l/README.md @@ -6,7 +6,6 @@ - [General info](../../docs/platform/beken-72xx/README.md) - [Flashing guide](../../docs/platform/beken-72xx/flashing.md) -- [BkWriter v1.6.0](https://images.tuyacn.com/smart/bk_writer1.60/bk_writer1.60.exe) Parameter | Value -------------|------------------------------------------ diff --git a/boards/wb2s/README.md b/boards/wb2s/README.md index a14cd6e..cf44ee6 100644 --- a/boards/wb2s/README.md +++ b/boards/wb2s/README.md @@ -6,7 +6,6 @@ - [General info](../../docs/platform/beken-72xx/README.md) - [Flashing guide](../../docs/platform/beken-72xx/flashing.md) -- [BkWriter v1.6.0](https://images.tuyacn.com/smart/bk_writer1.60/bk_writer1.60.exe) Parameter | Value -------------|------------------------------------------ diff --git a/boards/wb3l/README.md b/boards/wb3l/README.md index 8560e25..4baf8e4 100644 --- a/boards/wb3l/README.md +++ b/boards/wb3l/README.md @@ -6,7 +6,6 @@ - [General info](../../docs/platform/beken-72xx/README.md) - [Flashing guide](../../docs/platform/beken-72xx/flashing.md) -- [BkWriter v1.6.0](https://images.tuyacn.com/smart/bk_writer1.60/bk_writer1.60.exe) Parameter | Value -------------|------------------------------------------ diff --git a/boards/wb3s/README.md b/boards/wb3s/README.md index 504a814..de30353 100644 --- a/boards/wb3s/README.md +++ b/boards/wb3s/README.md @@ -6,7 +6,6 @@ - [General info](../../docs/platform/beken-72xx/README.md) - [Flashing guide](../../docs/platform/beken-72xx/flashing.md) -- [BkWriter v1.6.0](https://images.tuyacn.com/smart/bk_writer1.60/bk_writer1.60.exe) Parameter | Value -------------|------------------------------------------ diff --git a/boards/wr2/README.md b/boards/wr2/README.md index 29c5367..3fdfc80 100644 --- a/boards/wr2/README.md +++ b/boards/wr2/README.md @@ -4,10 +4,9 @@ [Product page](https://developer.tuya.com/en/docs/iot/wifiwr2module?id=K9605tko0juc3) -- [General info](../../docs/platform/realtek/README.md) -- [Debugging](../../docs/platform/realtek/debugging.md) +- [General info](../../docs/platform/realtek-amb/README.md) - [Flashing guide](../../docs/platform/realtek-ambz/flashing.md) -- [ImageTool (AmebaZ/AmebaD)](https://images.tuyacn.com/smart/Image_Tool/Image_Tool.zip) +- [Debugging](../../docs/platform/realtek-ambz/debugging.md) Parameter | Value -------------|---------------------------------------- diff --git a/boards/wr2e/README.md b/boards/wr2e/README.md index 9614011..2a513f0 100644 --- a/boards/wr2e/README.md +++ b/boards/wr2e/README.md @@ -4,10 +4,9 @@ [Product page](https://developer.tuya.com/en/docs/iot/wr2e?id=K97scnsjhue4h) -- [General info](../../docs/platform/realtek/README.md) -- [Debugging](../../docs/platform/realtek/debugging.md) +- [General info](../../docs/platform/realtek-amb/README.md) - [Flashing guide](../../docs/platform/realtek-ambz/flashing.md) -- [ImageTool (AmebaZ/AmebaD)](https://images.tuyacn.com/smart/Image_Tool/Image_Tool.zip) +- [Debugging](../../docs/platform/realtek-ambz/debugging.md) Parameter | Value -------------|------------------------------------------ diff --git a/boards/wr2l/README.md b/boards/wr2l/README.md index b15873d..65e4299 100644 --- a/boards/wr2l/README.md +++ b/boards/wr2l/README.md @@ -4,10 +4,9 @@ [Product page](https://developer.tuya.com/en/docs/iot/wifiwr2lmodule?id=K9605tnbj7gva) -- [General info](../../docs/platform/realtek/README.md) -- [Debugging](../../docs/platform/realtek/debugging.md) +- [General info](../../docs/platform/realtek-amb/README.md) - [Flashing guide](../../docs/platform/realtek-ambz/flashing.md) -- [ImageTool (AmebaZ/AmebaD)](https://images.tuyacn.com/smart/Image_Tool/Image_Tool.zip) +- [Debugging](../../docs/platform/realtek-ambz/debugging.md) Parameter | Value -------------|------------------------------------------ diff --git a/boards/wr2le/README.md b/boards/wr2le/README.md index b875736..fb05274 100644 --- a/boards/wr2le/README.md +++ b/boards/wr2le/README.md @@ -4,10 +4,9 @@ [Product page](https://developer.tuya.com/en/docs/iot/wr2le?id=K9eio9y9e8i8c) -- [General info](../../docs/platform/realtek/README.md) -- [Debugging](../../docs/platform/realtek/debugging.md) +- [General info](../../docs/platform/realtek-amb/README.md) - [Flashing guide](../../docs/platform/realtek-ambz/flashing.md) -- [ImageTool (AmebaZ/AmebaD)](https://images.tuyacn.com/smart/Image_Tool/Image_Tool.zip) +- [Debugging](../../docs/platform/realtek-ambz/debugging.md) Parameter | Value -------------|------------------------- diff --git a/boards/wr3/README.md b/boards/wr3/README.md index 68266af..cae18a1 100644 --- a/boards/wr3/README.md +++ b/boards/wr3/README.md @@ -4,10 +4,9 @@ [Product page](https://developer.tuya.com/en/docs/iot/wr3-module-datasheet?id=K9g3ainzbj9z1) -- [General info](../../docs/platform/realtek/README.md) -- [Debugging](../../docs/platform/realtek/debugging.md) +- [General info](../../docs/platform/realtek-amb/README.md) - [Flashing guide](../../docs/platform/realtek-ambz/flashing.md) -- [ImageTool (AmebaZ/AmebaD)](https://images.tuyacn.com/smart/Image_Tool/Image_Tool.zip) +- [Debugging](../../docs/platform/realtek-ambz/debugging.md) Parameter | Value -------------|---------------------------------------- diff --git a/boards/wr3e/README.md b/boards/wr3e/README.md index 17d344c..d564d2d 100644 --- a/boards/wr3e/README.md +++ b/boards/wr3e/README.md @@ -4,10 +4,9 @@ [Product page](https://developer.tuya.com/en/docs/iot/wr3e-module-datasheet?id=K9elwlqbfosbc) -- [General info](../../docs/platform/realtek/README.md) -- [Debugging](../../docs/platform/realtek/debugging.md) +- [General info](../../docs/platform/realtek-amb/README.md) - [Flashing guide](../../docs/platform/realtek-ambz/flashing.md) -- [ImageTool (AmebaZ/AmebaD)](https://images.tuyacn.com/smart/Image_Tool/Image_Tool.zip) +- [Debugging](../../docs/platform/realtek-ambz/debugging.md) Parameter | Value -------------|------------------------------------------ diff --git a/boards/wr3l/README.md b/boards/wr3l/README.md index 19d1b86..e10a350 100644 --- a/boards/wr3l/README.md +++ b/boards/wr3l/README.md @@ -4,10 +4,9 @@ [Product page](https://developer.tuya.com/en/docs/iot/wifiwr3lmodule?id=K9605tt0kveqm) -- [General info](../../docs/platform/realtek/README.md) -- [Debugging](../../docs/platform/realtek/debugging.md) +- [General info](../../docs/platform/realtek-amb/README.md) - [Flashing guide](../../docs/platform/realtek-ambz/flashing.md) -- [ImageTool (AmebaZ/AmebaD)](https://images.tuyacn.com/smart/Image_Tool/Image_Tool.zip) +- [Debugging](../../docs/platform/realtek-ambz/debugging.md) Parameter | Value -------------|------------------------------------------ diff --git a/boards/wr3le/README.md b/boards/wr3le/README.md index 68fcd1d..6e28e43 100644 --- a/boards/wr3le/README.md +++ b/boards/wr3le/README.md @@ -4,10 +4,9 @@ [Product page](https://developer.tuya.com/en/docs/iot/wr3le?id=K986l7a1ha8tm) -- [General info](../../docs/platform/realtek/README.md) -- [Debugging](../../docs/platform/realtek/debugging.md) +- [General info](../../docs/platform/realtek-amb/README.md) - [Flashing guide](../../docs/platform/realtek-ambz/flashing.md) -- [ImageTool (AmebaZ/AmebaD)](https://images.tuyacn.com/smart/Image_Tool/Image_Tool.zip) +- [Debugging](../../docs/platform/realtek-ambz/debugging.md) Parameter | Value -------------|-------------------------------------------- diff --git a/boards/wr3n/README.md b/boards/wr3n/README.md index f63ae51..4bfa78e 100644 --- a/boards/wr3n/README.md +++ b/boards/wr3n/README.md @@ -4,10 +4,9 @@ [Product page](https://developer.tuya.com/en/docs/iot/wr3n-datasheet?id=K98zdx31ztdge) -- [General info](../../docs/platform/realtek/README.md) -- [Debugging](../../docs/platform/realtek/debugging.md) +- [General info](../../docs/platform/realtek-amb/README.md) - [Flashing guide](../../docs/platform/realtek-ambz/flashing.md) -- [ImageTool (AmebaZ/AmebaD)](https://images.tuyacn.com/smart/Image_Tool/Image_Tool.zip) +- [Debugging](../../docs/platform/realtek-ambz/debugging.md) Parameter | Value -------------|------------------------------------------ diff --git a/docs/update_docs.py b/docs/update_docs.py index d3723cf..db90bfd 100644 --- a/docs/update_docs.py +++ b/docs/update_docs.py @@ -11,7 +11,8 @@ from typing import Dict, List, Set import colorama from colorama import Fore, Style from ltchiptool import Board, Family -from ltchiptool.util import readjson, readtext, sizeof +from ltchiptool.util.fileio import readjson, readtext +from ltchiptool.util.misc import sizeof from markdown import Markdown OUTPUT = join(dirname(__file__), "status")