Skip to content

Commit

Permalink
update with requested changes
Browse files Browse the repository at this point in the history
  • Loading branch information
nakata5321 committed May 24, 2024
1 parent 3f5546f commit ecf9a39
Show file tree
Hide file tree
Showing 6 changed files with 25 additions and 25 deletions.
12 changes: 6 additions & 6 deletions data/sidebar_docs.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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
Expand All @@ -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
Expand Down
18 changes: 9 additions & 9 deletions docs/install-smart-home.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,15 +51,15 @@ 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
- Zigbee2MQTT
- 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:

<code-helper copy>

Expand All @@ -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:

<code-helper copy>

Expand All @@ -88,7 +88,7 @@ cd home-assistant-web3-build/
```
</code-helper>

then you have to create `.env` file. Convert it from `template.env` file:
Then, create a `.env` file from the `template.env`:

<code-helper copy>

Expand All @@ -98,14 +98,14 @@ mv template.env .env

</code-helper>

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:

<code-helper copy>

Expand All @@ -114,10 +114,10 @@ bash setup.sh
```

</code-helper>
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:

<code-helper>

Expand All @@ -130,7 +130,7 @@ Do you want to proceed? (y/n)

</code-helper>

- 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:

<code-helper>

Expand Down
2 changes: 1 addition & 1 deletion docs/robonomics-hass-integration.md
Original file line number Diff line number Diff line change
Expand Up @@ -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).
2 changes: 1 addition & 1 deletion docs/robonomics-smart-home-overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,6 @@ We have prepared detailed guides on setting up a smart home on Robonomics. The s
<robo-wiki-button link="/docs/sub-activate/?topic=Upgrade Home Assistant OS" label="For Home Assistant users" block />
</robo-wiki-grid-element>
<robo-wiki-grid-element>
<robo-wiki-button link="/docs/hass-image-install" label="For new users" block />
<robo-wiki-button link="/docs/install-smart-home" label="For new users" block />
</robo-wiki-grid-element>
</robo-wiki-grid-element-wrapper>
11 changes: 5 additions & 6 deletions docs/virtual-devices.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:

<code-helper copy>

Expand All @@ -26,7 +25,7 @@ demo:

</code-helper>

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.

<robo-wiki-picture src="home-assistant/demo-entities.png" />
5 changes: 3 additions & 2 deletions docs/zigbee-devices.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.**

<robo-wiki-picture src="home-assistant/zigbee2mqtt.png" />

Expand All @@ -35,6 +36,6 @@ When the device connects, you will see them in web-interface:

<robo-wiki-picture src="home-assistant/device_connected.jpg" />

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.

0 comments on commit ecf9a39

Please sign in to comment.