Skip to content

Improve documentation for display #44

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
claire-mn wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Improve documentation for display #44

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 27 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,33 @@ Once you have this wired up to your flasher, you can download [0.1.22.bin](https

After this flashes, you can reassemble and install the device into a wall socket. The esp32 should start flashing the nextion display automatically shortly after powering on. Since this bin is likely not the latest version, after setup, you can go into settings->update and update to the latest verison.

### Editing the display firmware

To make changes to the display firmware you will need to use the [Nextion Editor](https://nextion.tech/nextion-editor/) to make changes to the `amplipi_v2.HMI` display config.
When you are done, save the display .tft file in Nextion Editor under `File > TFT file output`, save the file as `amplipi_v2.tft`, this is the file you will use to program the display.

### Programming the display firmware

1. Install the Adafruit MicroPython tool [ampy](https://github.com/scientifichackers/ampy)
2. Push the new `amplipi_v2.tft` to the panel, the ESP firmware expects the display firmware to be in `/app/amplipi_v2.tft`

```cmd
ampy --port COM7 put .\src\app\amplipi_v2.tft /app/amplipi_v2.tft
```

3. Restart the panel and the ESP firwmare will automatically flash the display using the file on the panel.

### Creating a system image

To create a new system binary we can capture an image of an existing panel which has the modifications we desire using [esptool](https://github.com/espressif/esptool).

```cmd
esptool.py --baud 460800 --port COM7 read_flash 0x0 0x400000 new_firmware.bin
```

>Note: if your build also has a new display firmware, take this image after [uploading the display](#programming-the-display-firmware), but before rebooting, as the display firmware is deleted after it is applied.


## Setting up MQTT with Home Assistant
### 1. Setting Up an MQTT Broker
Set up an MQTT broker with Home Assistant if you haven't already. It's recommended to use the Mosquitto MQTT broker addon with Home Assistant, you can install it by following the steps [here](https://github.com/home-assistant/addons/blob/master/mosquitto/DOCS.md).
Expand Down