Skip to content

Commit

Permalink
added BBQKees table
Browse files Browse the repository at this point in the history
  • Loading branch information
proddy committed Sep 16, 2024
1 parent ff7c98f commit 4872b86
Show file tree
Hide file tree
Showing 2 changed files with 35 additions and 19 deletions.
25 changes: 24 additions & 1 deletion docs/Getting-Started.md
Original file line number Diff line number Diff line change
Expand Up @@ -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-<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.

!!! 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 <target> -t upload`

Expand Down
29 changes: 11 additions & 18 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,9 +19,9 @@ hide:

[![donate](https://img.shields.io/badge/donate-PayPal-blue.svg)](https://www.paypal.com/paypalme/prderbyshire/2)

<span style="font-size: 1.5rem">Current Releases</span>
<span style="font-size: 1.2rem">
<BR>Main - <a href="https://github.com/emsesp/EMS-ESP32/releases/tag/v3.6.5">version 3.6.5</a>
<span style="font-size: 1.5rem">Latest Releases</span>
<span style="font-size: 1.0rem">
<BR>Stable - <a href="https://github.com/emsesp/EMS-ESP32/releases/tag/v3.6.5">version 3.6.5</a>
<BR>Development - <a href="https://github.com/emsesp/EMS-ESP32/releases/tag/latest">version 3.7.0</a>
</span>

Expand All @@ -40,31 +40,24 @@ 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
<img style="width:75%" src="../_media/screenshot/main-screen.png"></img>

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

For feedback, questions, live troubleshooting or just general chat hop on to our Discord channel:

<a href="https://discord.gg/3J3GgnzpyT"><img src="https://discordapp.com/api/guilds/816637840644505620/widget.png?style=banner2"></a>

## 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).

0 comments on commit 4872b86

Please sign in to comment.