From ecf9a3926dff802bcfb8e6321a1b5f1d0b1d5b52 Mon Sep 17 00:00:00 2001 From: nakata5321 Date: Fri, 24 May 2024 10:17:51 +0300 Subject: [PATCH] update with requested changes --- data/sidebar_docs.yaml | 12 ++++++------ docs/install-smart-home.md | 18 +++++++++--------- docs/robonomics-hass-integration.md | 2 +- docs/robonomics-smart-home-overview.md | 2 +- docs/virtual-devices.md | 11 +++++------ docs/zigbee-devices.md | 5 +++-- 6 files changed, 25 insertions(+), 25 deletions(-) diff --git a/data/sidebar_docs.yaml b/data/sidebar_docs.yaml index b7d5f239b96..64986a8b8dc 100644 --- a/data/sidebar_docs.yaml +++ b/data/sidebar_docs.yaml @@ -20,8 +20,8 @@ link: /docs/robonomics-hass-integration topic: Smart Home next: - - title: Global Administration - link: /docs/global-administration + - title: Add User + link: /docs/add-user - title_en: Advanced Setup items: - title_en: Upgrade Home Assistant OS @@ -35,8 +35,8 @@ link: /docs/robonomics-hass-integration topic: Upgrade Home Assistant OS next: - - title: Global Administration - link: /docs/global-administration + - title: Add User + link: /docs/add-user - title_en: Upgrade Home Assistant Docker for Unix-like OS items: - title_en: Subscription Activate @@ -49,8 +49,8 @@ link: /docs/robonomics-hass-integration topic: Upgrade Home Assistant Docker for Unix-like OS next: - - title: Global Administration - link: /docs/global-administration + - title: Add User + link: /docs/add-user - title_en: Upgrade Home Assistant Core items: - title_en: Subscription Activate diff --git a/docs/install-smart-home.md b/docs/install-smart-home.md index d391554cd04..9cb431491fc 100644 --- a/docs/install-smart-home.md +++ b/docs/install-smart-home.md @@ -51,7 +51,7 @@ system from the ground up. The Robonomics team recommend to use Raspberry Pi 4 a ## 1. Install Pre-requirements -Robonomics docker contains: +Robonomics Docker contains: - Home Assistant - IPFS - MQTT Broker and Integration @@ -59,7 +59,7 @@ Robonomics docker contains: - libp2p proxy - Robonomics Integration -This article will show the installation process on ubuntu system. First you need to install next packages: +This article will show the installation process on Ubuntu system. First you need to install next packages: @@ -78,7 +78,7 @@ Then you need to install Docker on PC. Installation instruction find on [the off ## 2. Configure -Download GitHub repository and go inside it: +Download the GitHub repository and navigate inside it: @@ -88,7 +88,7 @@ cd home-assistant-web3-build/ ``` -then you have to create `.env` file. Convert it from `template.env` file: +Then, create a `.env` file from the `template.env`: @@ -98,14 +98,14 @@ mv template.env .env -After that,You may open the file and edit default values such as: +After that, you may open the `.env` file and edit default values such as: - Versions of packages - path to repository where will be stored all configurations folders. - time zone in ["tz database name"](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones). ## 3. Start -Run bash script and wait until the script will install all required packages: +Run the bash script and wait until it installs all required packages: @@ -114,10 +114,10 @@ bash setup.sh ``` -The script will check all required actions, which you did in previous steps, and throw the error if something is wrong. +The script will check all required actions that you completed in the previous steps and will throw an error if something is wrong. During the installation process the following situations may occur: -- If you decide not to use the Zigbee coordinator, then you will see a dialog line confirming to continue the installation: +- If you decide not to use the Zigbee coordinator, you will see a dialog line confirming whether to continue the installation: @@ -130,7 +130,7 @@ Do you want to proceed? (y/n) -- if on your PC are several devices that use serial ports, the script will ask which device to use: +- If there are several devices on your PC that use serial ports, the script will ask which device to use: diff --git a/docs/robonomics-hass-integration.md b/docs/robonomics-hass-integration.md index 756c50f2636..83469aa2a50 100644 --- a/docs/robonomics-hass-integration.md +++ b/docs/robonomics-hass-integration.md @@ -29,4 +29,4 @@ tools: 3. Press `SUBMIT` after finishing the configuration. If you filled in everything correctly, you will see the success window. That's all! You have fully setup Robonomics Integration into Home Assistant. Now you can use all -Robonomics Web Services. To find out more about them, go to ["Use" section](/docs/global-administration). +Robonomics Web Services. To find out more about them, go to ["Use" section](/docs/add-user). diff --git a/docs/robonomics-smart-home-overview.md b/docs/robonomics-smart-home-overview.md index ea88e7dc637..6e5cc7db411 100644 --- a/docs/robonomics-smart-home-overview.md +++ b/docs/robonomics-smart-home-overview.md @@ -36,6 +36,6 @@ We have prepared detailed guides on setting up a smart home on Robonomics. The s - + diff --git a/docs/virtual-devices.md b/docs/virtual-devices.md index 3fefe52ea90..9df366f080d 100644 --- a/docs/virtual-devices.md +++ b/docs/virtual-devices.md @@ -9,11 +9,10 @@ contributors: [nakata5321] ## Install integration To use virtual devices you need to install ["demo" integration](https://www.home-assistant.io/integrations/demo/). -To do this, you should add next string to your configuration file: +To do this, you should edit your configuration file. -Go to configuration folder, which you provide due configuration process. -In this folder you will find folder with name "homeassistant". go inside it. -Open `configuration.yaml` file with text editor under **root** user and insert next string in it: +Go to the configuration folder, which you provided during the configuration process. In this folder, you will find a folder +named "homeassistant". Go inside it. Open the `configuration.yaml` file with a text editor under the **root** user and insert the following line into it: @@ -26,7 +25,7 @@ demo: -After that restart Home Assistant via web interface. When smart home will start, you can find all virtual devices in "demo" -entities. Find it in `Settings -> Devices & services -> Demo`. All this entities you can add to your dashboard. +After that, restart Home Assistant via web interface. When the smart home restarts, you can find all virtual devices in the "demo" entities. +Find them in `Settings -> Devices & services -> Demo`. All these entities can be added to your dashboard. diff --git a/docs/zigbee-devices.md b/docs/zigbee-devices.md index 55c800fa769..2367257402a 100644 --- a/docs/zigbee-devices.md +++ b/docs/zigbee-devices.md @@ -8,7 +8,8 @@ tools: --- -**If during the installation process, you insert a ZigBee coordinator, you can add ZigBee devices to your smart home and this article will explain how to do it.** +**If, during the installation process, you insert a ZigBee coordinator, you can add ZigBee devices to your smart home. +This article will explain how to do it.** @@ -35,6 +36,6 @@ When the device connects, you will see them in web-interface: -Now you should see this sensor in your Home Assistant WebUI. Go to `Settings` -> `Devices & Services` -> `Devices`. In mqtt integration. +Now you should see this sensor in your Home Assistant WebUI. Go to `Settings` -> `Devices & Services` -> `Devices`. And open the mqtt integration. After adding all the sensors, you can close web-interface of Zigbee2MQTT.