Skip to content

Commit 03bae3f

Browse files
committed
more work on readme
1 parent bfa94b7 commit 03bae3f

File tree

5 files changed

+22
-10
lines changed

5 files changed

+22
-10
lines changed

README.md

Lines changed: 22 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,16 @@
11
# ESP8266 React
22

3-
A simple, extensible framework for IoT projects built on ESP8266/ESP32 platforms with responsive React front-end.
3+
A simple, secure and extensible framework for IoT projects built on ESP8266/ESP32 platforms with responsive React front-end.
44

5-
Designed to work with the PlatformIO IDE with limited setup, please read below for build and upload instructions.
5+
Designed to work with the PlatformIO IDE with [limited setup](#getting-started). Please read below for setup, build and upload instructions.
66

77
![Screenshots](/media/screenshots.png?raw=true "Screenshots")
88

99
## Features
1010

1111
Provides many of the features required for IoT projects:
1212

13-
* Configurable WiFi - Network scanner and WiFi connection screen
13+
* Configurable WiFi - Network scanner and WiFi configuration screen
1414
* Configurable Access Point - Can be continuous or automatically enabled when WiFi connection fails
1515
* Network Time - Synchronization with NTP
1616
* Remote Firmware Updates - Enable secured OTA updates
@@ -43,26 +43,26 @@ Resource | Description
4343
[src/](src) | C++ back end for the ESP8266 device
4444
[platformio.ini](platformio.ini) | PlatformIO project configuration file
4545

46-
#### Building the firmware
46+
### Building the firmware
4747

4848
Once the platform and libraries are downloaded the back end should be compiling.
4949

5050
> **WINDOWS BUILDS**: If building under Windows you need to delete .piolibdeps/Time/Time.h - due to a [file system case insensitivity issue](https://github.com/me-no-dev/ESPAsyncWebServer/issues/96)
5151
5252
#### Uploading the firmware
5353

54-
Standard configuration settings, such as build flags, libraries and device configuration can be found in ['platformio.ini'](platformio.ini). The project is configured to upload via serial by default, you can change the upload mechanism to OTA by uncommenting the relevant lines.
54+
The project is configured to upload over a serial connection by default. You can change this to use OTA updates by uncommenting the relevant lines in ['platformio.ini'](platformio.ini).
5555

56-
See the [PlatformIO docs](http://docs.platformio.org/en/latest/projectconf.html) for full details on what you can do with this.
56+
The firmware may be uploaded to the device by pressing the "Upload" button:
5757

58-
Click the upload button in PlatformIO, or type the upload command if prefer the command line approach:
58+
![uploadfw](/media/uploadfw.png?raw=true "uploadfw")
59+
60+
Alternatively run the 'upload' target:
5961

6062
```bash
6163
platformio run -t upload
6264
```
6365

64-
![upload](/media/upload.png?raw=true "upload")
65-
6666
### Building the interface
6767

6868
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. This reduces the production build to around ~200k, which easily fits on the device.
@@ -89,9 +89,21 @@ npm run build
8989

9090
> **Note**: The build command will also delete the previously built interface, in the ['data/www'](data/www) directory, replacing it with the freshly built one ready to upload to the device.
9191
92+
#### Uploading the file system image
93+
94+
The compiled user interface may be uploaded to the device by pressing the "Upload File System image" button:
95+
96+
![uploadfs](/media/uploadfs.png?raw=true "uploadfs")
97+
98+
Alternatively run the 'uploadfs' target:
99+
100+
```bash
101+
platformio run -t uploadfs
102+
```
103+
92104
### Running the interface locally
93105

94-
You can run a local development server during development to preview changes to the front end them without the need to upload a file system image to the device after each change.
106+
You can run a local development server to allow you preview changes to the front end without the need to upload a file system image to the device after each change. Run the standard npm start command to start the development server:
95107

96108
```bash
97109
npm start

media/screenshots.png

-52.5 KB
Loading

media/upload.png

-10.9 KB
Binary file not shown.

media/uploadfs.png

8.44 KB
Loading

media/uploadfw.png

8.62 KB
Loading

0 commit comments

Comments
 (0)