Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mwdle/esphomeconfig
ESPHome configuration and flashing guides for some Gosund, Magic Home, and Sonoff smart home devices.
https://github.com/mwdle/esphomeconfig
esp8285 esphome esphome-config esphome-configs esphome-devices gosund magichome sonoff
Last synced: 3 days ago
JSON representation
ESPHome configuration and flashing guides for some Gosund, Magic Home, and Sonoff smart home devices.
- Host: GitHub
- URL: https://github.com/mwdle/esphomeconfig
- Owner: mwdle
- License: gpl-3.0
- Created: 2024-07-23T07:08:00.000Z (4 months ago)
- Default Branch: main
- Last Pushed: 2024-09-16T01:33:52.000Z (2 months ago)
- Last Synced: 2024-09-16T02:53:05.051Z (2 months ago)
- Topics: esp8285, esphome, esphome-config, esphome-configs, esphome-devices, gosund, magichome, sonoff
- Homepage:
- Size: 67.1 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# ESPHome Configurations and Flashing Instructions
Configurations and flashing instructions for my ESPHome converted Gosund, Sonoff, and Magic Home smart home devices.
## Table of Contents
* [Description](#esphome-configurations-and-flashing-instructions)
* [Included In This Repository](#included-in-this-repository)
* [Getting Started](#getting-started)
* [Flashing Instructions](#flashing-instructions-coming-soon)
* [License](#license)
* [Disclaimer](#disclaimer)
## Included In This Repository
* Docker Compose configuration for ESPHome CLI
* ESPHome YAML configuration for the `Magic Home ESP-IR-B-v2.3` RGB LED strip controller with some custom lighting effects.
* ESPHome YAML configuration for the `Magic Home ZJ-WFMN-A V1.1` RGB LED strip controller with some custom lighting effects.
* ESPHome YAML configuration for the `Gosund WP3 (ESP8285)` Smart Plug
* ESPHome YAML configuration for the `Sonoff S31` Smart Plug
* Instructions (with photos) on flashing custom firmware to the aforementioned devices
## Getting Started
1. Clone the repository:
```shell
git clone https://github.com/mwdle/ESPHomeConfig.git
```
2. Create a folder on your system for Docker bind mounts / storing container files. The folder should have the following structure:
```shell
docker_volumes/
├── ESPHome/
│ └── .esphome/
```
3. Change the `.env` file properties for your configuration:
```properties
DOCKER_VOLUMES= # The folder created in the previous step.
```
4. Create a file called secrets.yaml in the "config" of this project containing the following properties:
```YAML
wifissid: ""
wifipass: ""
fallbackpass: ""
encryption_key: ""
otauser: ""
otapass: ""
```
5. Open a terminal in the directory containing the docker-compose file.
6. Create docker macvlan network for the container
```shell
docker network create -d macvlan --subnet=192.168.0.0/24 --gateway=192.168.0.1 -o parent=eno1 AAA_LAN
```
* Ensure the gateway and subnet match your LAN network.
* AAA in the network name ensures Docker uses this network as the primary interface for all connected containers.
* eno1 is the name of the network interface on my system. Replace this with the name of your network interface.
7. Start the container:
```shell
docker compose up -d
```
Your container should be up and running and you should be able to execute ESPHome commands via `docker exec` like so:
```shell
docker exec -it esphome esphome run YOUR_CONFIG.yaml
```
## Flashing Instructions (coming soon)
### Magic Home ESP-IR-B-v2.3 RGB LED Strip Controller
### Magic Home ZJ-WFMN-A V1.1 RGB LED Strip Controller
### Gosund WP3 (ESP8285) Smart Plug
### Sonoff S31 Smart Plug
## License
This project is licensed under the GNU General Public License v3.0 (GPL-3.0). See the [LICENSE](LICENSE.txt) file for details.
## Disclaimer
This repository is provided as-is and is intended for informational and reference purposes only. The author assumes no responsibility for any errors or omissions in the content or for any consequences that may arise from the use of the information provided. Always exercise caution and seek professional advice if necessary.