Skip to content

Commit

Permalink
feat: adding more info to docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Nelio Santos committed May 3, 2020
1 parent 2dc2100 commit 4336b3f
Show file tree
Hide file tree
Showing 5 changed files with 44 additions and 9 deletions.
53 changes: 44 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,32 @@
# Home Automation

The main goals of this project is provide a simple way to do some home automation [based on a cheap and
The main goal of this project is provide a simple way to do some home automation [based on a cheap and
small board](https://easyeda.com/DIY-Maker-BR/placa-4-reles-esp12f)

Project licensed under: GPLv3
Project licensed under: GPLv3 for board and firmware.

## Board

The board comes with all components soldered from [JLCPCB](https://jlcpcb.com), when you bought with SMT Assembly Services. You need only
solder the relays (3x units), KREs (3x 3 vias, 1x 2 vias) and a ESP12 (E or F). Its super easy.

![Board photo](docs/board.png)

Files links to order your board:

- [Gerber File](docs/Gerber_20200130210739.zip)
- [Bill of Material](docs/BOM_20200130210745.csv)
- [Pick and Place](docs/PickAndPlace_20200130210754.csv)

Characteristcs from this board:

- Source Voltage: 5v
- Current (maximum usage, without extensions): 540mA
- Extension headers: I2C, Analog Input, Additionals GPIO
- Small size: 70mm x 49mm
- Manual reset and flash buttons
- Flash friendly (as describe in FAQ)
- 3 relays (because it is a cold component -- you can use inside your wall conduit box).

## Firmware

Expand Down Expand Up @@ -61,22 +84,34 @@ Your sensor topics:

Action topics:

- GET: command to get informations
- SET: command to set action
- RES: the topic where you will receive the result from GET

```
GET: <baseTopic>/action/e12aio3_<id>/config/get, PAYLOAD: json
SET: <baseTopic>/action/e12aio3_<id>/config/set, PAYLOAD: { .... json bellow .... }
RES: <baseTopic>/action/e12aio3_<id>/config, PAYLOAD: { ... json bellow... }
```

```
GET: <baseTopic>/action/e12aio3_<id>/config/get
SET: <baseTopic>/action/e12aio3_<id>/config/set
RES: <baseTopic>/action/e12aio3_<id>/config
SET: <baseTopic>/action/e12aio3_<id>/restart/set, PAYLOAD: yes
```
```
GET: <baseTopic>/action/e12aio3_<id>/scan/get
RES: <baseTopic>/action/e12aio3_<id>/scan
GET: <baseTopic>/action/e12aio3_<id>/scan/get, PAYLOAD: json
RES: <baseTopic>/action/e12aio3_<id>/scan, PAYLOAD: { ... json under development ... }
```
### How to firmware?
Use [ESP8266-RTOS IDF Like](https://docs.espressif.com/projects/esp8266-rtos-sdk/en/release-v3.3/index.html#)
This firmware was built in [ESP8266-RTOS IDF Like](https://docs.espressif.com/projects/esp8266-rtos-sdk/en/release-v3.3/index.html#).
You can use a ESP8266 Programmer (and avoid to solder serial headers) or via serial (TX, RX, GND).
If you have a FTDI / CP2104 or CH340 with DTR and CTS, the board is flash friendly (auto enter in programmer mode and restart after flash).
### How to configure?
### How to configure default values from firmware?
Use `make menuconfig`
Expand Down
Binary file added docs/BOM_20200130210745.csv
Binary file not shown.
Binary file added docs/Gerber_20200130210739.zip
Binary file not shown.
Binary file added docs/PickAndPlace_20200130210754.csv
Binary file not shown.
Binary file added docs/board.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 4336b3f

Please sign in to comment.