- added changelog for app and arduino code
- added some more instructions
This commit is contained in:
parent
630f3f388a
commit
2844502153
4 changed files with 49 additions and 4 deletions
17
Arduino/CHANGELOG.md
Normal file
17
Arduino/CHANGELOG.md
Normal file
|
@ -0,0 +1,17 @@
|
||||||
|
# Changelog
|
||||||
|
All notable changes to this project will be documented in this file.
|
||||||
|
|
||||||
|
The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
|
||||||
|
and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
|
||||||
|
|
||||||
|
## [1.01] - 2019 - 03 - 16
|
||||||
|
## Added
|
||||||
|
- new Web interface
|
||||||
|
|
||||||
|
## Changed
|
||||||
|
- moved user specific variables to 'env.h'
|
||||||
|
|
||||||
|
|
||||||
|
## [1.0] - 2019 - 02 - 24
|
||||||
|
### Added
|
||||||
|
- initial Release
|
|
@ -2,4 +2,13 @@
|
||||||
This is the arduino code for 'Das Schmalter' it is it was tested on an esp8266 but should work just fine on an esp32 with some minor modifications.
|
This is the arduino code for 'Das Schmalter' it is it was tested on an esp8266 but should work just fine on an esp32 with some minor modifications.
|
||||||
|
|
||||||
# Schematic
|
# Schematic
|
||||||
You can find a fritzing schematic [here](https://git.itsblue.de/dorian/dasschmalter/raw/master/Arduino/Das_Schmalter.fzz)
|
You can find a fritzing schematic [here](https://git.itsblue.de/dorian/dasschmalter/raw/master/Arduino/Das_Schmalter.fzz)
|
||||||
|
|
||||||
|
# Usage
|
||||||
|
To set up an esp8266 as a schmalter, you can follow the followind steps:
|
||||||
|
1. build your Schmalter according to the schematic
|
||||||
|
2. rename the file 'env.h.example'
|
||||||
|
3. install the esp8266 board in the arduino IDE (instructions can be found [here](https://github.com/esp8266/Arduino#installing-with-boards-manager))
|
||||||
|
4. open the 'DasSchmalter' sketch in the arduino IDE and change the wifi credentinals in the env.h file
|
||||||
|
5. flash the sketch to the esp8266
|
||||||
|
6. you can now use your browser to control your schmalter, just type in your schmalters ip
|
15
DasSchmalterApp/CHANGELOG.md
Normal file
15
DasSchmalterApp/CHANGELOG.md
Normal file
|
@ -0,0 +1,15 @@
|
||||||
|
# Changelog
|
||||||
|
All notable changes to this project will be documented in this file.
|
||||||
|
|
||||||
|
The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
|
||||||
|
and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
## [1.01] - 2019 - 03 - 16
|
||||||
|
## Added
|
||||||
|
- states for 'connecting' and 'error'
|
||||||
|
|
||||||
|
## [1.0] - 2019 - 02 - 24
|
||||||
|
### Added
|
||||||
|
- initial Release
|
10
README.md
10
README.md
|
@ -1,11 +1,15 @@
|
||||||
# Overwiew
|
# Overwiew
|
||||||
|
|
||||||
'Das Schmalter' is a smart switch which can turn on / off basically everything.
|
'Das Schmalter' is a smart switch which can turn on / off basically everything.
|
||||||
It works with a normal hardware switch, a webinterface and an app.
|
It works with a normal hardware switch but can also be controlled via a web interface and an app
|
||||||
It was created on the [Hack to the future](https://www.hacktothefuture.de/de/startseite/) coding camp in Stuttgart 2019.
|
'Das Schmalter' was created at the '[Hack to the future](https://www.hacktothefuture.de/de/startseite/)' coding camp in Stuttgart 2019.
|
||||||
|
|
||||||
|
# Setup
|
||||||
|
|
||||||
|
You can find some instructions on how to create your own Schmalter [here](https://git.itsblue.de/dorian/dasschmalter/blob/master/Arduino/README.md#usage).
|
||||||
|
|
||||||
# App
|
# App
|
||||||
|
|
||||||
The 'Das Schmalter' App is currently available for:
|
The 'Das Schmalter' app is currently available for:
|
||||||
|
|
||||||
- [Android](https://git.itsblue.de/dorian/dasschmalter/raw/master/DasSchmalterApp/Release/Android/DasSchmalter-Signed-ARMv7-latest.apk)
|
- [Android](https://git.itsblue.de/dorian/dasschmalter/raw/master/DasSchmalterApp/Release/Android/DasSchmalter-Signed-ARMv7-latest.apk)
|
Reference in a new issue