'README.md' ändern

Format Fix
This commit is contained in:
2018-01-05 23:37:57 +01:00
parent 6fdb48718e
commit ab5647d9c9

View File

@@ -2,13 +2,13 @@
This is an Alarm Clock (Radio) based on the ESP8266 in combination with a MAX7219 LED-Matrix, Relay-Board and DS3231 RTC. This is an Alarm Clock (Radio) based on the ESP8266 in combination with a MAX7219 LED-Matrix, Relay-Board and DS3231 RTC.
Note: This Project is in heavy development at the moment. Note: This Project is under heavy development at the moment.
## Wiring ## Wiring
Image how to wire the project will follow. Image how to wire the project will follow.
LED-Matrix: ###### LED-Matrix:
| LED-Matrix | ESP8266 | | LED-Matrix | ESP8266 |
| -------- | -------- | | -------- | -------- |
@@ -18,7 +18,8 @@ LED-Matrix:
| CS | GPIO 10 | | CS | GPIO 10 |
| CLK | GPIO14 (HSPICLK) | | CLK | GPIO14 (HSPICLK) |
RTC DS3231:
###### RTC DS3231:
| DS3231 | ESP8266 | | DS3231 | ESP8266 |
| -------- | -------- | | -------- | -------- |
@@ -27,26 +28,32 @@ RTC DS3231:
| SCL | GPIO5 | | SCL | GPIO5 |
| SDA | GPIO4 | | SDA | GPIO4 |
Relay-Module:
###### Relay-Module:
| Relay-Module | ESP8266 | Type | | Relay-Module | ESP8266 | Type |
| -------- | -------- | | | -------- | -------- | -------- |
| VCC | Vin/5V+ | | | VCC | Vin/5V+ | Power |
| GND | GND | | | GND | GND | GND |
| In1 | GPIO16 | Power | | In1 | GPIO16 | Power |
| In2 | GPIO12 | Input | | In2 | GPIO12 | Input |
| In3 | GPIO12 | Input | | In3 | GPIO12 | Input |
| In4 | GPIO12 | Input | | In4 | GPIO12 | Input |
Switch:
###### Switch:
The switch should connect the GPIO to ground if it is pressed down: The switch should connect the GPIO to ground if it is pressed down:
power_sw: GPIO3 power_sw: GPIO3
input_sw: GPIO1 input_sw: GPIO1
alarm_sw: GPIO2 alarm_sw: GPIO2
sleep_sw: GPIO0 sleep_sw: GPIO0
You can also change this at the beginning of the code: You can also change this at the beginning of the code:
``` ```
//Pin Taster //Pin Taster
@@ -84,11 +91,13 @@ The Clock is controlled with 4-Button Control
## Issues ## Issues
* Alarm 2 is not working like expected. It will be triggered every hour. * Alarm 2 is not working like expected. It will be triggered every hour.
* Network connection is not used to update time over NTP. * Networkconnection is not used to update time over NTP.
* Long-Press blocks display until release. * Long-Press blocks display until release.
## Dependencies ## Dependencies
LedMatrix.h : [https://github.com/squix78/MAX7219LedMatrix](https://github.com/squix78/MAX7219LedMatrix) LedMatrix.h : [https://github.com/squix78/MAX7219LedMatrix](https://github.com/squix78/MAX7219LedMatrix)
DS3231.h : [https://github.com/NorthernWidget/DS3231](https://github.com/NorthernWidget/DS3231) DS3231.h : [https://github.com/NorthernWidget/DS3231](https://github.com/NorthernWidget/DS3231)
WiFiManager.h : [https://github.com/tzapu/WiFiManager](https://github.com/tzapu/WiFiManager) WiFiManager.h : [https://github.com/tzapu/WiFiManager](https://github.com/tzapu/WiFiManager)