Skip to content

Commit

Permalink
add link to download.emsesp.org
Browse files Browse the repository at this point in the history
  • Loading branch information
proddy committed Oct 30, 2024
1 parent ab1b5e3 commit fbb6f0c
Showing 1 changed file with 3 additions and 34 deletions.
37 changes: 3 additions & 34 deletions docs/Getting-Started.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,44 +20,13 @@ EMS-ESP also requires a separate circuit to read and write to the EMS bus. You c

The firmware is a single binary `.bin` file. First decide whether you want to take the [current stable version](https://github.com/emsesp/EMS-ESP32/releases/latest) or risk it and take the [latest development version](https://github.com/emsesp/EMS-ESP32/releases/tag/latest) to have the latest features and of course any possible issues.

Make sure you pick the right firmware .bin file for your ESP32. The format for the file is

`EMS-ESP-<version>-<chip type>-<flash mem>[+].bin`

The `chip type` is as defined in esp_platform from pio (Platform IO). This can be ESP32, ESP32S3, ESP32C3 etc. All uppercase.

`flash mem` is the Flash memory size and is either 4MB or 16MB.

`+` is added at the end if there the module is expected to have PSRAM on board.
Go to [download.emsesp.org](https://download.emsesp.org) to get the latest firmware to match your hardware.

!!! warning "Pay attention to the [Change Log](Version-Release-History) before upgrading for any breaking changes"

### BBQKees Electronics EMS Gateway

Use this table to help you decide which firmware to use when using a BBQKees Electronics EMS Gateway.

| Model | Year | Chip | Flash size | PSRAM | file ending |
| --------------------- | ------------- | -------- | ---------- | ----- | ------------------ |
| Gateway E32 V2 | >01-2024 | ESP32 | 16MB | 8MB | -ESP32-16MB+.bin |
| Gateway S3(-LR) | >09-2023 | ESP32-S3 | 16MB | 8MB | -ESP32S3-16MB+.bin |
| Gateway E32 V1.5 | >12-21 <06-23 | ESP32 | 4MB | no | -ESP32-4MB.bin |
| Gateway E32 V1.0/V1.4 | >04-21 <12-21 | ESP32 | 4MB | no | -ESP32-4MB.bin |
| Gateway S32 V2 | >02-22 <01-23 | ESP32 | 16MB | no | -ESP32-16MB.bin |
| Gateway S32 V1 | >02-21 <02-22 | ESP32 | 4MB | no | -ESP32-4MB.bin |

### First time install

If this is a fresh install you will need to upload it manually and there are two methods for this.

1. via the browser by visiting [https://install.emsesp.org](https://install.emsesp.org).
1. using the [EMS-ESP Flasher tool](https://github.com/emsesp/EMS-ESP-Flasher/releases). The are versions for Windows, Linux and Mac OSX. Note you may see a security vulnerability warning on Windows which you can safely ignore.
1. using the PlatformIO CLI like `pio run -e <target> -t upload`

### Upgrading from a previous release

If you are upgrading from a previous release it's recommended you perform the upgrade directly via the WebUI (`Settings>Download/Upload`).
### Upgrading to a new major release

!!! note "There was an issue with older BBQKees Gateway boards that used a smaller partition size on the ESP32. If you're upgrading from v3.4 or earlier and have one of these boards then make a backup of your settings and use the [EMS-ESP Flasher tool](https://github.com/emsesp/EMS-ESP-Flasher/releases)."
If you are upgrading from a previous release it's recommended you make a backup copy of any settings and configurations before performing the installation.

## What the onboard LED is telling you

Expand Down

0 comments on commit fbb6f0c

Please sign in to comment.