alvaro/esp360-remote
1
0
Fork 0
mirror of https://github.com/ale1800/ESP-360-REMOTE.git synced 2025-03-10 12:48:45 -03:00
Code Issues Packages Projects Releases Wiki Activity

more formatting fixing

Browse Source 
more formatting fixing
This commit is contained in:
Nathann Morand 2023-11-11 23:47:58 +01:00 committed by GitHub
parent c886eedf16
commit 17bd90a865
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 16 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
INSTALL.md
View File

@ -1,6 +1,6 @@
# Introduction
if you know esphome, you can skip most of this document and just use the template in the [ESPHome Configuration](ESPHome Configuration) folder.
if you know esphome, you can skip most of this document and just use the template in the [ESPHome Configuration](ESPHome Configuration/esp360-default-1.yaml) folder.
if you don't know much about esphome this guide will guide you through the installation process. if you need more information you can head to [Discord](https://discord.gg/PsrK3KDkRy) and if you see something that is not clear enough, do not hesistate to make a pull request and improve the documentation for everybody.
@ -14,14 +14,22 @@ you also need to follow the next step no matter what setup you choose and finnis
for this step you will require a USB-C cable that has power + data (a normal cable should but some cheap aliexpress cable only have the power wire and no data wire) and a computer with chrome or edge browser (no firefox)
open the following [link](https://web.esphome.io/) in your browser once the device is connected to your computer using the USB-C cable
you need to click on "connect"
![image](https://github.com/nathmo/ESP-360-REMOTE/assets/15912256/d5390c21-c24f-41e1-a038-98f9d171800e)
and select the USB-Serial device, if no USB serial device appear, ensure your USB cable is good and that you have the CH240X driver (the tool give you the link to install the driver if needed)
![image](https://github.com/nathmo/ESP-360-REMOTE/assets/15912256/8a85914c-d865-4ee3-bd17-9f1b856367f2)
once you are conencted you should be able to click there :
![image](https://github.com/nathmo/ESP-360-REMOTE/assets/15912256/2bd723f7-c853-4a67-82dd-09b676650a08)
the process takes a few minutes and ask for your wifi credentials toward the end so that the device can connect to your network.
once it's done you should be able to access the webpage hosted by the ESP 360 Remote
![image](https://github.com/nathmo/ESP-360-REMOTE/assets/15912256/29d30c93-fc50-4dd9-8d0a-e4df338b7313)
as you can see it's empty. this is only the generic ESPHome configuration. follow to the next section to compile the firmware with the IR, RF and sensors feature
# Standalone
@ -33,7 +41,9 @@ you can now jump to the template section
# ESPhome
this option require docker but allow you to manage you fleet of esphome device
![image](https://github.com/nathmo/ESP-360-REMOTE/assets/15912256/54c6994f-20ff-47d3-a7e6-2f1cb4a1465a)
I assume you know the docker basics, here is a docker-compose.yml that you can use to run the ESPhome "fleet manager"
```
version: '3'
@ -61,7 +71,7 @@ from there you can create a new device
once done, click on skip for the install and click "edit" instead from the main menu :
remplace the text with the one found in the [ESPHome Configuration](ESPHome Configuration) folder.
remplace the text with the one found in the [ESPHome Configuration](ESPHome Configuration/esp360-default-1.yaml) folder.
as explained in the template section of this file
once happy with your config you can compile by clicking save then come back to the main menu and click the "..." then install
@ -80,12 +90,14 @@ the file will be compiled to a .bin that you will be able to download. you need
from there, give it a name and choose ESP32
![image](https://github.com/nathmo/ESP-360-REMOTE/assets/15912256/3865ad0b-b6ad-4962-8827-30d46b669c8e)
![image](https://github.com/nathmo/ESP-360-REMOTE/assets/15912256/8dd688a1-7d29-4f24-bf66-537c23cb7060)
now return to the webpage of the ESP 360 Remote and under OTA Update browse for the file you previously downloaded and click update
once the device as rebooted, you should see the value from the sensors and your switch
![image](https://github.com/nathmo/ESP-360-REMOTE/assets/15912256/8dd688a1-7d29-4f24-bf66-537c23cb7060)
![image](https://github.com/nathmo/ESP-360-REMOTE/assets/15912256/e66aeed3-7168-4010-b728-6675b3e7b089)
you are done :)
# home assistant