lukas/WordClockESP
1
0
Fork 0
Code Issues 2 Pull Requests Actions Packages Projects Releases Wiki Activity

more readme tweaks

Browse Source
This commit is contained in:
rjwats@gmail.com 2018-02-26 23:10:27 +00:00
parent df0dbcfed7
commit 01faeac4db
1 changed files with 14 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

31
README.md
View File

@ -11,7 +11,7 @@ I found I was repeating a lot of work when starting new IoT projects with the ES
Most of my IoT projects have required:
* Configurable WiFi
* Configurable Access Point
* Configurable access point
* Synchronization with NTP
* The ability to perform OTA updates
@ -19,7 +19,7 @@ I also wanted to adopt a decent client side framework so the back end could be s
All of the above features are included in this framework, which I plan to use as a basis for my IoT projects.
The interface should work well on mobile devices. It also has the prerequisite manifest/icon file, so it can be added to the home screen if desired.
The interface is responsive and should work well on mobile devices. It also has the prerequisite manifest/icon file, so it can be added to the home screen if desired.
![Screenshots](/screenshots/screenshots.png?raw=true "Screenshots")
@ -43,7 +43,7 @@ Once the platform and libraries are downloaded the back end should be compiling.
### Building the interface
The interface has been configured with create-react-app and react-app-rewired so I can customize the build for the MCU. The large artefacts are gzipped and source maps and service worker are excluded.
The interface has been configured with create-react-app and react-app-rewired so the build can customized for the target device. The large artefacts are gzipped and source maps and service worker are excluded from the production build.
You will find the interface code in the ./interface directory. Change to this directory with your bash shell (or Git Bash) and use the standard commands you would with any react app built with create-react-app:
@ -67,20 +67,19 @@ npm run build
npm start
```
You can run the interface locally for development, you need to modify the endpoint root path and enable CORS for this to work:
**NB: To run the interface locally you will need to modify the endpoint root path and enable CORS.**
* The endpoint root path can be found in Endpoint.js (./interface/src/constants/). This needs to be the root URL of the device running the back end, for example "http://192.168.0.6".
* CORS can be enabled for the back end by uncommenting the -D ENABLE_CORS build flag in platformio.ini and re-deploying.
The endpoint root path can be found in Endpoint.js (./interface/src/constants/). This needs to be the root URL of the device running the back end, for example "http://192.168.0.6".
CORS can be enabled on the back end by uncommenting the -D ENABLE_CORS build flag in platformio.ini and re-deploying.
## Configuration & Deployment
Standard configuration settings, such as build flags, libraries and device configuration can be found in platformio.ini. See the [PlatformIO docs](http://docs.platformio.org/en/latest/projectconf.html) for full details on what you can do with this.
By default, the target device is "esp12e". This is a common ESP8266 variant with 4mb of flash though any device with at least 2mb of flash should be fine. The settings configure the device run @ 160MHz and will upload over serial by default. You can change the upload mechanism to OTA by uncommenting/modifying the relevant lines in platformio.ini.
By default, the target device is "esp12e". This is a common ESP8266 variant with 4mb of flash though any device with at least 2mb of flash should be fine. The settings configure the interface to upload via serial by default, you can change the upload mechanism to OTA by uncommenting the relevant lines.
As well as containing the interface, the SPIFFS image (in the ./data folder) contains configuration files for each of the configurable features.
The config files can be found in the ./data/config directory:
As well as containing the interface, the SPIFFS image (in the ./data folder) contains a JSON settings file for each of the configurable features. The config files can be found in the ./data/config directory:
File | Description
---- | -----------
@ -89,12 +88,10 @@ ntpSettings.json | NTP synchronization settings
otaSettings.json | OTA Update configuration
wifiSettings.json | WiFi connection settings
The default WiFi settings configure the device to bring up an access point on start up:
The default settings configure the device to bring up an access point on start up which can be used to configure the device:
SSID: "ESP8266-React"
Password: "esp-react"
You use this access point to configure the device, so editing the above files isn't strictly necessary.
* SSID: "ESP8266-React"
* Password: "esp-react"
## Software Overview
@ -103,8 +100,8 @@ TODO...
## Future Extensions
- [ ] Provide an emergency config reset feature, via a pin held low for a few seconds
- [ ] Access Point should provide captive portal
- [ ] Perhaps have more configuration options for Access Point: IP address, Subnet, etc
- [ ] Access point should provide captive portal
- [ ] Perhaps have more configuration options for Access point: IP address, Subnet, etc
- [ ] Enable configurable mDNS
- [ ] Introduce authentication to secure the device