From af4ed020d3f56272c94d6e86fa65c64b176b39c2 Mon Sep 17 00:00:00 2001 From: Vladimir Makeev Date: Tue, 19 Sep 2023 14:32:52 +0400 Subject: [PATCH] Documentation improvements (#60) Documentation improvements --- README.md | 20 ++++++++++++++++++-- docs/images/flags/br.png | Bin 0 -> 593 bytes docs/images/flags/gb.png | Bin 0 -> 599 bytes docs/images/flags/ru.png | Bin 0 -> 420 bytes docs/localization.md | 19 +++++++++++++++++++ 5 files changed, 37 insertions(+), 2 deletions(-) create mode 100644 docs/images/flags/br.png create mode 100644 docs/images/flags/gb.png create mode 100644 docs/images/flags/ru.png create mode 100644 docs/localization.md diff --git a/README.md b/README.md index 7f8d12a..6d3eeb4 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ Home Assistant custom component for control Huawei mesh routers over LAN. -[![hacs_badge](https://img.shields.io/badge/HACS-Default-orange.svg)](https://github.com/hacs/integration) +[![Hacs Default](https://img.shields.io/badge/HACS-Default-orange.svg)](https://github.com/hacs/integration) [![License](https://img.shields.io/github/license/vmakeev/huawei_mesh_router)](https://github.com/vmakeev/huawei_mesh_router/blob/master/LICENSE.md) ![Active installatons](https://img.shields.io/badge/dynamic/json?color=blue&label=active%20installations&query=$[%27huawei_mesh_router%27][%27total%27]&url=https%3A%2F%2Fanalytics.home-assistant.io%2Fcustom_integrations.json&cacheSeconds=600) @@ -10,6 +10,12 @@ Home Assistant custom component for control Huawei mesh routers over LAN. [![ReleaseDate](https://img.shields.io/github/release-date/vmakeev/huawei_mesh_router)](https://github.com/vmakeev/huawei_mesh_router/releases/latest) ![Maintained](https://img.shields.io/maintenance/yes/2023) +[![Localization contribute](https://img.shields.io/badge/localization-contrubute-blue)](docs/localization.md) + +[![Russian](docs/images/flags/ru.png)](custom_components/huawei_mesh_router/translations/ru.json) +[![English](docs/images/flags/gb.png)](custom_components/huawei_mesh_router/translations/en.json) +[![Brazilian Portuguese](docs/images/flags/br.png)](custom_components/huawei_mesh_router/translations/pt-BR.json) + ## Key features - obtaining information about all routers and connected devices in the entire mesh network: @@ -42,7 +48,17 @@ Home Assistant custom component for control Huawei mesh routers over LAN. | [Huawei WiFi AX3 Pro](https://consumer.huawei.com/en/routers/ax3-pro/) | WS7206 | No | | | [Huawei WiFi Mesh 3](https://consumer.huawei.com/en/routers/wifi-mesh3/) | WS8100 | Yes | My router model. All features are available | | [Huawei WiFi Mesh 7](https://consumer.huawei.com/en/routers/wifi-mesh7/) | WS8800 | Yes | | -| Other routers with HarmonyOS | ------ | No | Will most likely work | + + +## Not supported models + +| Name | Model | Notes | +|------------------------------------------------------------------------------------|--------|-----------------------------------------------| +| [Huawei Q2S](https://consumer.huawei.com/cn/support/routers/ws5280/) | WS5281 | The router blocks requests from the component | +| [Huawei Q2 Pro](https://consumer.huawei.com/cn/support/routers/q2-pro-2pack/) | WS5280 | The router blocks requests from the component | +| [Huawei Q6](https://consumer.huawei.com/cn/support/routers/q6/) | WS7290 | The router blocks requests from the component | + +As far as I can understand, problems arise with routers designed for the domestic market of China. Unfortunately, I do not have such devices available so that I can try to find out the reasons for this behavior. ## Installation diff --git a/docs/images/flags/br.png b/docs/images/flags/br.png new file mode 100644 index 0000000000000000000000000000000000000000..9b1a5538b264a295021f4f717d4299bb8ed98d98 GIT binary patch literal 593 zcmV-X0j-HAXl7XJGjM{~r+i{r~sxzrQwG-&h#_Y&p;L z=ieV7_s^f-zyJOD{rC5(+EoAn1k&)I;s3Kw&;LT?{{2}P{Pq8T&j0^^J4?LvUd;UK z&+k8ffB*XXONL(tXahh1fi?X94^$0Q>Z$uRRO)Y4)uapmB!2(-ul(c1=C+V!kAF`) z$PCo;`_FHns{jIs3Fu;wy-Z(c2YwAz{&V4aXk?bejFO*Op&u`@i~PecqBpL@DIoojb8mb+WHGK%fG2>)a3=iVf_~v+`s?*1;!`?Kmai^I3i*ZIYtpN f{g(k500bBS@U(k2*|8J(R-+sudaynhucHbwAMTnor{mwqO^w7JHzaBsT z{O^B8RYf5+LvDs&KmRKVd78=o{`1#HTiEo_OolaGleS)G+IQ#sUI`b*pv<`1zCJ=H0jd{{2S>p`ri%{LsXJ%FbMS z$#S`6f|?OG!^Jxczkf6Q`UNF{l0Sd`ad7zm>({^EzyAS6{{CgrkluOb3l1A>ZU2~A zK+FZ=zkmP!`TOVhpFbzBzFaPmD2$N3;+$pK?>zdet`f0002ovPDHLkV1gy;I?Vt8 literal 0 HcmV?d00001 diff --git a/docs/images/flags/ru.png b/docs/images/flags/ru.png new file mode 100644 index 0000000000000000000000000000000000000000..47da4214fd9edb383687c1d4f84fe8b42a51ceb2 GIT binary patch literal 420 zcmV;V0bBlwP)X|NRSO0LlM<{-BURBqYRGSojej zfLOL~|EH_V_~;P>Nc10*D0|Jxss< zFi1)Q<$$6LU}rIc*dU*QNFV}+9T))>0|XG`SD?F)5CbX~O$rDA0t^5@iDe$xIAIn5 O0000.json`. The new file should also be located in the [`custom_components/huawei_mesh_router/translations/`](../custom_components/huawei_mesh_router/translations/) folder. After that, translate all the values in the json file into your language. + +_Note: The language codes follow the [BCP47](https://www.rfc-editor.org/info/bcp47) format, a few examples can be seen [here](https://gist.github.com/typpo/b2b828a35e683b9bf8db91b5404f1bd1)._ + +After that, you will need to make a [pull request](https://docs.github.com/articles/about-pull-requests) to the [original project](https://github.com/vmakeev/huawei_mesh_router), I will check it and add your language to the list of supported. + +## A simpler, but less technological way + +Download the [`en.json` file](../custom_components/huawei_mesh_router/translations/en.json), translate all the values into the language of your choice, and [create an issue](https://github.com/vmakeev/huawei_mesh_router/issues/new/choose) to add a new language. + +Be sure to attach the translated file to the issue and specify which language it is, so that there are no misunderstandings. + +After checking, I will add a new translation to the component.