diff --git a/docs/Getting-Started.md b/docs/Getting-Started.md index 5896dbc3..2198101f 100644 --- a/docs/Getting-Started.md +++ b/docs/Getting-Started.md @@ -19,13 +19,36 @@ 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 firmare .bin file for your ESP32. The format for the file is + +`EMS-ESP---[+].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. + !!! 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 Web at [install.emsesp.org](http://install.emsesp.org). +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 -t upload` diff --git a/docs/index.md b/docs/index.md index 881e6c40..3d79c522 100644 --- a/docs/index.md +++ b/docs/index.md @@ -19,9 +19,9 @@ hide: [![donate](https://img.shields.io/badge/donate-PayPal-blue.svg)](https://www.paypal.com/paypalme/prderbyshire/2) -Current Releases - -
Main - version 3.6.5 +Latest Releases + +
Stable - version 3.6.5
Development - version 3.7.0 @@ -40,15 +40,17 @@ hide: For a full list of features read the [change log](Version-Release-History). -![Console](_media/screenshot/main-screen.png) +Play with a [live demo](https://demo.emsesp.org) at `https://demo.emsesp.org`. Select your language on the sign-on page and log in with and username and password. -## See a demo + -Play with a [live demo](https://demo.emsesp.org) at `https://demo.emsesp.org`. Select your language on the sign-on page and log in with and username and password. +## Installing + +Head over to the [Getting Started](Getting-Started) guide to see what hardware you need and how to install the firmware. -## Requesting features or reporting issues +## Support -See the support page for [reporting issues](Support). +See the support page for [reporting issues](Support) and requesting new features. ## Join Our Community @@ -56,15 +58,6 @@ For feedback, questions, live troubleshooting or just general chat hop on to our -## Contribute - -Everybody is welcome and invited to contribute to this EMS-ESP project by: - -- providing Pull Requests (Features, Proof of Concepts, Language files or Fixes) -- testing new released features and report back on issues or feedback -- donating to acquire hardware for testing and implementing or out of gratitude -- contributing missing [documentation](Contributing.md) and expanding the community FAQ - ## Contact us -For general questions, feedback or support, please use the [contact form](Contact). +For general questions about this project please use the [contact form](Contact).