diff --git a/README.md b/README.md index 97b58b3..984a895 100644 --- a/README.md +++ b/README.md @@ -1 +1,36 @@ -# esp32_home-assistant_telegram-bot \ No newline at end of file + + +## 👀 esp32_home-assistant_telegram-bot Overview +

Home Assistant controlled by telegram bot

+ + +## 🚀 Features +

The design aims to provide real-time control and monitoring by leveraging a Telegram bot to verify collected data. This core functionality is extended to enable immediate awareness through voice notifications delivered directly via both the user's mobile device and the home system.

+ + +## 📦 Setup + + +1. `Refer to the circuit diagram` +2. `Install and open Arduino IDE` +3. `Open the 'dektop_deck.ino'` +4. `File>Preferences>Additional Boards Manager URLs:(Click the double window button)` +>Paste this code +```bash +http://Digistump.com/package_digistump_index.json +``` +5. `Click 'OK'` +6. `Tools>Board>Boards Manager...` +7. `Search 'esp8266' and install it` +> ⚠️ **Warning:** Make sure you have installed the correct USB driver (CH340 or CP2102) before connecting the ESP8266 to your computer. +8. `Plug the ESP8266 into your computer` +9. `Tools>Port>'Select the esp8266's port'` + + +## 🎉 Run +`Click the 'upload ➡️' button` +✅ **To make sure it has been uploaded successfully, you should see the message 'Done uploading'** + + +## 🔒 License +

📜 GPL-3.0 License