Skip to content

Commit

Permalink
Merge pull request airalab#611 from tubleronchik/master
Browse files Browse the repository at this point in the history
upgrade smart home structure
  • Loading branch information
tubleronchik committed May 25, 2023
2 parents 892ff1d + ecbdbc0 commit 03aacb2
Show file tree
Hide file tree
Showing 17 changed files with 335 additions and 102 deletions.
72 changes: 47 additions & 25 deletions data/sidebar_docs.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -2,38 +2,60 @@
items:
- title_en: Overview
link: /docs/robonomics-smart-home-overview
- title_en: Install
- title_en: Pre-installed Image For Raspberry Pi
items:
- title_en: Pre-installed Image For Raspberry Pi
- title_en: Installation
link: /docs/hass-image-install
- title_en: Upgrade Home Assistant OS
link: /docs/hass-os-upgrade
- title_en: Upgrade Home Assistant Docker for Unix-like OS
link: /docs/hass-docker-upgrade
- title_en: Upgrade Home Assistant Core
link: /docs/hass-core-upgrade
- title_en: Configure
items:
- title_en: Home Assistant Init
link: /docs/hass-init
- title_en: MQTT Broker Options
items:
- title_en: MQTT Broker for Home Assistant OS
link: /docs/mqtt-hassos
- title_en: MQTT Broker for Pre-installed Image, HA Docker, HA Core
link: /docs/mqtt-image-docker-core
- title_en: MQTT Broker
link: /docs/mqtt-image-docker-core
- title_en: MQTT Integration Setup
link: /docs/mqtt-integration
- title_en: ZigBee Setup Options
items:
- title_en: Zigbee2MQTT Adapter for Home Assistant OS
link: /docs/zigbee-to-mqtt-hassos
- title_en: Zigbee2MQTT Adapter for Pre-installed Image, HA Docker, HA Core
link: /docs/zigbee-to-mqtt
- title_en: Robonomics SLS Gateway
link: /docs/sls-gateway
- title_en: IoT Subscription
- title_en: Zigbee2MQTT Adapter
link: /docs/zigbee-to-mqtt-image
- title_en: Subscription Activate
link: /docs/sub-activate
- title_en: Robonomics Integration Setup
link: /docs/robonomics-hass-integration
- title_en: Upgrade Home Assistant OS
items:
- title_en: Robonomics Installation
link: /docs/hass-os-upgrade
- title_en: MQTT Broker
link: /docs/mqtt-hassos
- title_en: MQTT Integration Setup
link: /docs/mqtt-integration
- title_en: Zigbee2MQTT Adapter
link: /docs/zigbee-to-mqtt-hassos
- title_en: Subscription Activate
link: /docs/sub-activate
- title_en: Robonomics Integration Setup
link: /docs/robonomics-hass-integration
- title_en: Upgrade Home Assistant Docker for Unix-like OS
items:
- title_en: Robonomics Installation
link: /docs/hass-docker-upgrade
- title_en: MQTT Broker
link: /docs/mqtt-image-docker-core
- title_en: MQTT Integration Setup
link: /docs/mqtt-integration
- title_en: Zigbee2MQTT Adapter
link: /docs/zigbee-to-mqtt
- title_en: Subscription Activate
link: /docs/sub-activate
- title_en: Robonomics Integration Setup
link: /docs/robonomics-hass-integration
- title_en: Upgrade Home Assistant Core
items:
- title_en: Robonomics Installation
link: /docs/hass-core-upgrade
- title_en: MQTT Broker
link: /docs/mqtt-image-docker-core
- title_en: MQTT Integration Setup
link: /docs/mqtt-integration
- title_en: Zigbee2MQTT Adapter
link: /docs/zigbee-to-mqtt
- title_en: Subscription Activate
link: /docs/sub-activate
- title_en: Robonomics Integration Setup
Expand Down
Binary file added docs/docsCovers/zigbee-to-mqtt-image-en.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
10 changes: 3 additions & 7 deletions docs/hass-image-install.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,11 +26,11 @@ tools:

To simplify the installation process, a pre-made image can be used. It contains Home Assistant Core with Robonomics integration and IPFS. Options for downloading:

### GitHub Release
### Option 1: GitHub Release

Download it from the latest [GitHub releases.](https://github.com/airalab/Robonomics-HomeAssistant-image/releases)
Download image-robonomics_homeassistant.img.xz with current update date from the latest [GitHub releases.](https://github.com/airalab/Robonomics-HomeAssistant-image/releases)

### IPFS get
### Option 2: IPFS get

Alternatively, you can download it using IPFS. [Install IPFS](https://docs.ipfs.tech/install/command-line/), initialize and start the daemon:

Expand Down Expand Up @@ -95,10 +95,6 @@ User is `smart`, password is `robot`.

</robo-wiki-note>

## Next step

Now you have a Raspberry Pi with firmware installed, go to the [Home Assistant Init](/docs/hass-init/) article.

<!-- ## Related videos
https://youtu.be/qW4sjUaShWA -->
Expand Down
21 changes: 2 additions & 19 deletions docs/hass-os-upgrade.md
Original file line number Diff line number Diff line change
Expand Up @@ -87,23 +87,6 @@ wget -O - https://get.hacs.xyz | bash -

Now you can install Robonomics Integration using HACS.

<robo-wiki-video autoplay loop controls :videos="[{src: 'https://crustipfs.info/ipfs/Qmb19UEQwwHfNroCaH8NMFhPV2dc52vSC8i4ATJsqVYiZf', type:'mp4'}]" />
<robo-wiki-video autoplay loop controls :videos="[{src: 'https://crustipfs.live/ipfs/QmUodGanHyTE8hCJdcCHzvdnmuyVVGvnfTuYvYTPVKhh5d', type:'mp4'}]" />

1. Open HACS from a sidebar menu and go to `Integrations`. Press on three dots in the upper right corner and choose `Custom Repositories`. In the opened window paste the following link:

<code-helper copy>

```
https://github.com/airalab/homeassistant-robonomics-integration
```

</code-helper>

2. After that, choose `Integration` category and press `ADD`.

3. In `Custom Repositories` click on Robonomics and press the `Download` button in the lower right corner. After downloading, restart Home Assistant.

Now you have two options:

- If you have not yet used MQTT integration to connect smart devices via Zigbee adapter, go to the [**MQTT Broker for Home Assistant OS**](/docs/mqtt-hassos) article.
- Otherwise, go to the [**IoT Subscription**](/docs/sub-activate) section and start activating the Robonomics subscription.
Open HACS from the sidebar menu and navigate to `Integrations`. Click on `Explore & Download Repositories`, then search for `Robonomics` and click on the `Download` button located in the lower right corner. Once the download is complete, restart Home Assistant.
Binary file added docs/images/home-assistant/need_10.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/home-assistant/need_7.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/home-assistant/need_8.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/home-assistant/need_9.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 0 additions & 2 deletions docs/mqtt-hassos.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,5 +34,3 @@ tools:
</robo-wiki-note>

3. Save the configuration and go to the `Info` tab to start the add-on.

Continue MQTT setup with the [**MQTT Integration Setup**](/docs/mqtt-integration) article.
4 changes: 0 additions & 4 deletions docs/mqtt-image-docker-core.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,10 +22,6 @@ bash mqtt-install.sh

You will be asked to enter `USERNAME` and `PASSWORD` for the broker. After finishing, the broker will be running as a `systemd` service.

## Next step

After that, go to the [MQTT Integration Setup](/docs/mqtt-integration/) article.

## Related videos

https://youtu.be/n4PX25aB1JU
11 changes: 0 additions & 11 deletions docs/mqtt-integration.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,14 +23,3 @@ tools:
- Username & password — your credentials which you created earlier for Mosquitto Broker.

4. After that, press `SUBMIT`.

Now, you can proceed to add devices. Depending on the hardware you have, choose one of the options:

**Option 1 (with zigbee2MQTT for Home Assistant OS)**
* For Zigbee adapter and Home Assistant OS [go here](/docs/zigbee-to-mqtt-hassos/). Ideal for [JetHome USB JetStick Z2](https://jethome.ru/z2/?sl=en) or similar [supported adapters](https://www.zigbee2mqtt.io/information/supported_adapters.html).

**Option 2 (with zigbee2MQTT for for pre-installed image or Home Assistant Docker or Core)**
* For Zigbee adapter with other options of the Home Assistant installation [go here](/docs/zigbee-to-mqtt/). Ideal for [JetHome USB JetStick Z2](https://jethome.ru/z2/?sl=en) or similar [supported adapters](https://www.zigbee2mqtt.io/information/supported_adapters.html).

**Option 3 (with SLS Gateway)**
* For Robonomics SLS Gateway regardless of the Home Assistant installation options [go here](/docs/sls-gateway/). Open SLS gateway specs your can [find here](https://easyeda.com/ludovich88/robonomics_sls_gateway_v01).
2 changes: 0 additions & 2 deletions docs/robonomics-hass-integration.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,5 +21,3 @@ tools:
- (Optional) You can add credentials for pinning service Pinata to spread your data wider over the IPFS network.

3. Press `SUBMIT` after finishing the configuration. If you filled in everything correctly, you will see the success window.

Congratulations! You have fully installed and configured Home Assistant with Robonomics integration. Now go to [**"Use"**](/docs/global-administration) section to start working with your upgraded smart home.
38 changes: 19 additions & 19 deletions docs/robonomics-smart-home-overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,39 +23,39 @@ To solve both problems, we suggest you to try Robonomics, our **secure**, **serv
## What you need for installation

<robo-wiki-grid-element-wrapper textAlign="center" :columns="4">
<robo-wiki-grid-element>
<robo-wiki-picture src="home-assistant/need_1.png" />
<p><a href="https://www.home-assistant.io/">Home Assistant</a> as control system software</p>
</robo-wiki-grid-element>
<robo-wiki-grid-element>
<robo-wiki-picture src="home-assistant/need_2.png" />
<p>Raspberry Pi 4 (at least 2 GB RAM)</p>
</robo-wiki-grid-element>
<robo-wiki-grid-element>
<robo-wiki-picture src="home-assistant/need_3.png" />
<p>SD card (minimum 32 GB)</p>
<p>SD card (minimum 16 GB)</p>
</robo-wiki-grid-element>
<robo-wiki-grid-element>
<robo-wiki-picture src="home-assistant/need_4.png" />
<p>SD adapter</p>
<robo-wiki-picture src="home-assistant/need_10.png" />
<p>Power supply for Raspberry Pi4</p>
</robo-wiki-grid-element>
<robo-wiki-grid-element>
<robo-wiki-picture src="home-assistant/need_7.png" />
<p>Zigbee adapter <a href="https://jethome.ru/z2/">JetHome USB JetStick Z2</a> (or one of <a href="https://www.zigbee2mqtt.io/information/supported_adapters.html">supported</a>)</p>
</robo-wiki-grid-element>
</robo-wiki-grid-element-wrapper>

<robo-wiki-grid-element-wrapper :columns="2" textAlign="center">
<robo-wiki-grid-element-wrapper textAlign="center" :columns="4">
<robo-wiki-grid-element>
<robo-wiki-picture src="home-assistant/need_1.png" />
<p><a href="https://www.home-assistant.io/">Home Assistant</a> as control system software</p>
</robo-wiki-grid-element>
<robo-wiki-grid-element>
<robo-wiki-picture src="home-assistant/need_5.png" />
<p>Zigbee smart devices (any from <a href="https://slsys.io/action/supported_devices.html">supported devices</a>)</p>
</robo-wiki-grid-element>
<robo-wiki-grid-element>
<robo-wiki-picture src="home-assistant/need_6.png" />
<p>Zigbee adapter <a href="https://jethome.ru/z2/">JetHome USB JetStick Z2</a> (or one of <a href="https://www.zigbee2mqtt.io/information/supported_adapters.html">supported</a>) or
<a href="https://easyeda.com/ludovich88/robonomics_sls_gateway_v01">Robonomics SLS Gateway</a></p>
</robo-wiki-grid-element/>
<robo-wiki-picture src="home-assistant/need_9.png" />
<p>Computer for setup</p>
</robo-wiki-grid-element>
<robo-wiki-grid-element>
<robo-wiki-picture src="home-assistant/need_4.png" />
<p>SD adapter (optional)</p>
</robo-wiki-grid-element>
</robo-wiki-grid-element-wrapper>

## How to install Home Assistant with Robonomics

* [Pre-installed image](/docs/hass-image-install/) — This method implies setting up a whole new OS on your Raspberry Pi.
* [Home Assistant OS](/docs/hass-os-upgrade/) — The method is suitable for integrating Robonomics with an existing Home Assistant OS.
* [Home Assistant Docker for Unix-like OS](/docs/hass-docker-upgrade/) — The method is suitable for integrating Robonomics with an existing Home Assistant Docker for Unix-like OS.
* [Home Assistant Core](/docs/hass-core-upgrade/) — The method is suitable for integrating Robonomics with an existing Home Assistant Core.
2 changes: 0 additions & 2 deletions docs/sub-activate.md
Original file line number Diff line number Diff line change
Expand Up @@ -94,5 +94,3 @@ Now you need to add a `sub_controller` account to the **access list**.
3. Repeat steps 1 and 2 for `sub_owner` account.

3. Press `Save`. Enter your `sub_owner` password in the popup window and wait until the activation process is completed.

After that, go to the article ["Robonomics Integration Setup"](/docs/robonomics-hass-integration/) article.
2 changes: 0 additions & 2 deletions docs/zigbee-to-mqtt-hassos.md
Original file line number Diff line number Diff line change
Expand Up @@ -134,5 +134,3 @@ rm coordinator_backup.json
<robo-wiki-picture src="home-assistant/zigbee-2-mqtt-addon-ui.png" />

4. Now you should see the device with the same IEEE Address in your Home Assistant Web UI. Go to `Settings` -> `Devices & Services` -> `Devices`.

Now you can go to the [**IoT Subscription**](/docs/sub-activate) section and start activating the Robonomics subscription.
Loading

0 comments on commit 03aacb2

Please sign in to comment.