Skip to content

Commit

Permalink
Merge pull request #775 from nakata5321/wiki_rework
Browse files Browse the repository at this point in the history
add article "IR Remote"
  • Loading branch information
positivecrash authored Dec 1, 2023
2 parents b02de97 + edb77fb commit 6baf972
Show file tree
Hide file tree
Showing 14 changed files with 442 additions and 0 deletions.
11 changes: 11 additions & 0 deletions data/sidebar_docs.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -78,6 +78,17 @@
link: /docs/use-blueprints
- title_en: Get Notified When Door Opens
link: /docs/door-notification
- title_en: Devices
items:
- title_en: IR Remote
link: /docs/ir-controller
- title_en: Energy Monitoring
link: /docs/energy-monitoring
- title_en: Smart Switches
link: /docs/smart-switches
- title_en: Air Quality Sensor
link: /docs/air-quality-sensor

- title_en: Learn
items:
# - title_en: Introduction
Expand Down
30 changes: 30 additions & 0 deletions docs/air-quality-sensor.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
---
title: Air Quality Sensor
contributors: [nakata5321]
---

Join with this air quality sensor to the decentralized opensource [sensors map](https://sensors.robonomics.network/#/) which operates with the sole intent of serving the free will of individuals. This sensor is ready to install, you will need wi-fi and a power socket, it can be installed both indoor and outdoor. Includes PM2.5/PM10 sensor and temperature/humidity sensor, can be expanded with several types of additional sensors (VOC, CO2, atmospheric pressure).

## Key features

- Type-c for open-source firmware Tasmota upgrading
- Measures PM2.5/PM10
- Can be added as a part of global sensor map or your own [fork](https://github.com/airalab/sensors.robonomics.network)
- Compatible with Luftdaten

## Hardware specification

- SDS011 laser PM2.5/PM10 sensor
- NodeMCU V3 CH340 based on ESP8266
- DHT22 (AM2302) temperature/humidity sensor
- 12V/2А power adapter
- 5A DC-DC mini560 convertor
- mounting box

## Software specification

- For upgrading ESP firmware, an open source flasher is provided by Robonomics called airrohr-flasher (available on [Github](https://github.com/airalab/sensors-connectivity/releases))

## Other tutorials
- [How to install sensor](https://wiki.robonomics.network/docs/sds-sensor-connect/)
- [How to add sensor to Home Assistant](https://wiki.robonomics.network/docs/sds-sensor-hass/#installation)
Binary file added docs/docsCovers/energy-monitoring-en.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/docsCovers/ir-controller-en.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
106 changes: 106 additions & 0 deletions docs/energy-monitoring.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,106 @@
---
title: Energy Monitoring
contributors: [nakata5321]
---

This page describes the operating instructions for the Energy Monitoring device powered by Robonomics. Here you will find the hardware specification of the device and its basic configuration.

The device has a number of unique features such as:

1. Monitor energy consumption, whether that's an individual estate or an entire building.
2. The included software provides vital insight that can help to control and save energy in the future.
3. Monitoring works on the local network and does not require access to the cloud.
4. Support of Home Assistant via the MQTT protocol.

## Hardware specification

- Input Voltage: AC 100-240V 50/60Hz
- Measuring Range: 0.1-80A
- Wireless Protocol: IEEE 802.11b/g/n (2.4 GHz Wi-Fi)
- CPU: ESP32-S3 MCU-based system on a chip (SoC) dual-core microprocessor (Xtensa 32-bit LX7), up to 240 MHz
- Memory: 448 KB ROM, 520 KB SRAM, 8 MB FLASH
- USB-C for development and updates

# How to setup

<robo-wiki-title :type="2" anchor="step1">
Step 1 — Flashing
</robo-wiki-title>

<robo-wiki-note type="warning">

All devices from Robonomics come pre-flashed out of the box. However, since all devices are development kits, the instructions will cover the option of flashing the device from scratch. If you do not wish to do this now, proceed to [**Step 2 - Access Point**](/docs/ir-controller/#step2).

</robo-wiki-note>

Take the device from the box and connect it to the computer. Then go the website [webflasher.robonomics.network](https://webflasher.robonomics.network/). You will see next:

<robo-wiki-picture src="ir-controller/web-interface.jpg" />

<robo-wiki-note type="warning"> Note! Web flasher is working only with Google Chrome or Microsoft Edge browser.</robo-wiki-note>

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

In "Firmware" drop-box choose **"ENERGY MONITOR"** option and next in "SELECT CHIP" choose **"ESP32-S3"**. Press **"CONNECT"** button.
A popup window will appear where you should select the serial port to which the device is connected (usually it's ttyUSBO). Then choose **"INSTALL ENERGY-MONITOR_EN"**.
On next window you can make **CLEAR INSTALLATION** by check **ERASE DEVICE**. Press Next and then Install. Wait until firmware to upload to Energy Monitoring device.

After finishing the installation process Wi-Fi configuration popup will appear. Provide Wi-Fi credentials.

After setting up Wi-Fi you can visit device via **VISIT DEVICE** button. Later you can visit device via it's IP address in the network. To find it you can use [Fing mobile app](https://www.fing.com/products) or
[nmap CLI tool](https://vitux.com/find-devices-connected-to-your-network-with-nmap/).

Skip **Step 2 — Access Point** and go to [**Step 3 — Configuration**](/docs/ir-controller/#step3).

<robo-wiki-title :type="2" anchor="step2">
Step 2 — Access Point
</robo-wiki-title>

If you take Energy monitor from the box and connect it to the power supply, it will create hotspot with name "robonomics-XXXXXXX". Connect to it. Configuration window should open. If not, open web-browser and go to `192.168.4.1` page.

<robo-wiki-picture src="ir-controller/phone-wifi.jpg" />

Provide Wi-Fi credentials. After that the Energy Monitoring device will connect to Wi-Fi network. Check the device via it's IP address in the network. To find it you can use [Fing mobile app](https://www.fing.com/products) or
[nmap CLI tool](https://vitux.com/find-devices-connected-to-your-network-with-nmap/).

<robo-wiki-title :type="2" anchor="step3">
Step 3 — Configuration
</robo-wiki-title>

The device's page will look similar to this:

<robo-wiki-picture src="energymeter/energymeter.jpg" />

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

Go to **"Configuration"**->**"Configure other"**. In **"Template"** string insert next:

<code-helper copy>

```shell
{"NAME":"Robonomics-Energy-Monitor","GPIO":[1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,3200,5440,1,1,576,0,0,0,0,0,1,1,1,1,1,1,1,1,1,1,1],"FLAG":0,"BASE":1, "CMND":"SetOption21 1|WattRes 2|VoltRes 2"}
```
</code-helper>

Verify that checkbox **"Activate"** and **"MQTT Enable"** is enabled. If not, enable it and press Save button.

Return to "main menu" and go to **"Configuration"** -> **"Configure MQTT"**.
Provide your MQTT credentials here:

<robo-wiki-picture src="ir-controller/mqtt.jpg" />

That's all with ESP for now. Next step is install the Home Assistant integration.

<robo-wiki-title :type="2" anchor="step4">
Step 4 — Integration setup
</robo-wiki-title>

This article assumes, that you have Home Assistant. To connect Energy Monitoring device to Home Assistant, you need to install "Tasmota" integration.

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

Basically, Home Assistant will discover "Tasmota" integration automatically. But if not, add it manually.

<robo-wiki-picture src="energymeter/HA.jpg" />

That's all. Now you can add energy entities to the dashboard.
Binary file added docs/images/energymeter/HA.jpg
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/energymeter/energymeter.jpg
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/ir-controller/mqtt.jpg
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/ir-controller/phone-wifi.jpg
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/ir-controller/tasmota.jpg
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/ir-controller/thermo.jpg
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/ir-controller/web-interface.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading

0 comments on commit 6baf972

Please sign in to comment.