Skip to content

Commit

Permalink
Give ESP32 builds their own output section in README.md (#82)
Browse files Browse the repository at this point in the history
  • Loading branch information
mk-pmb committed Jan 3, 2020
1 parent fa19e53 commit 59082e6
Showing 1 changed file with 14 additions and 12 deletions.
26 changes: 14 additions & 12 deletions README.md
Expand Up @@ -83,17 +83,13 @@ Depending on the performance of your system it takes 1-3min until the compilatio
#### Output
All outputs will be created in the `bin` subfolder of your NodeMCU repository's root directory. They will be:

* For ESP8266 builds:
* `nodemcu_${BUILD_TYPE}_${IMAGE_NAME}.bin` is the combined firmware image
you can flash.
`BUILD_TYPE` is `integer` or `float`.
For `IMAGE_NAME`, see the [Options](#options) chapter below.
* Almost same but with `.map` ending, a mapfile will be saved that contains the relative offsets of functions.
* `0x00000.bin` will contain just the firmware.
* `0x10000.bin` will contain the SPIFFS.
* For ESP32 builds:
* `nodemcu_${IMAGE_NAME}.bin` will be the firmware image.
For `IMAGE_NAME`, see the [Options](#options) chapter below.
* `nodemcu_${BUILD_TYPE}_${IMAGE_NAME}.bin` is the combined firmware image
you can flash.
`BUILD_TYPE` is `integer` or `float`.
For `IMAGE_NAME`, see the [Options](#options) chapter below.
* Almost same but with `.map` ending, a mapfile will be saved that contains the relative offsets of functions.
* `0x00000.bin` will contain just the firmware.
* `0x10000.bin` will contain the SPIFFS.

#### Flash the firmware
There are several [tools to flash the firmware](https://nodemcu.readthedocs.io/en/latest/en/flash/) to the ESP8266.
Expand Down Expand Up @@ -156,10 +152,16 @@ That is the exact same command as for building for the ESP8266. It analyses the

The process will fail early with a meaningful error message if it does not find a `sdkconfig` file in the firmware directory.

### Output
All outputs will be created in the `bin` subfolder of your NodeMCU repository's root directory. They will be:

* `nodemcu_${IMAGE_NAME}.bin` will be the firmware image.
For `IMAGE_NAME`, see the [Options](#options) chapter below.

## Options
You can pass the following optional parameters to the Docker build like so `docker run -e "<parameter>=value" -e ...`.

- `IMAGE_NAME` can be set to save the output files (see [Build the firmware](#build-the-firmware) above) with fixed names. If it is not set or empty, the branch name and a timestamp will be used.
- `IMAGE_NAME` can be set to save the output files (see your platform's "Output" section for above) with fixed names. If it is not set or empty, the branch name and a timestamp will be used.
- `TZ` By default the Docker container will run in UTC timezone. Hence, the time in the timestamp of the default image name (see `IMAGE_NAME` option above) will not be same as your host system time - unless that is UTC as well of course. To fix this you can set the `TZ` parameter to any [valid timezone name](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones) e.g. `-e TZ=Asia/Kolkata`.

`INTEGER_ONLY` and `FLOAT_ONLY` are **not supported anymore**. Please configure `LUA_NUMBER_INTEGRAL` in `app/include/user_config.h` as described above.
Expand Down

0 comments on commit 59082e6

Please sign in to comment.