# esp32-edge-firmware

**Repository Path**: HTQ_DOG/esp32-edge-firmware

## Basic Information

- **Project Name**: esp32-edge-firmware
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: Apache-2.0
- **Default Branch**: develop
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2021-10-20
- **Last Updated**: 2021-10-20

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Libre Solar ESP32 Edge Firmware

Firmware for CAN and UART to WiFi or Bluetooth gateway based on ESP32-IDF v4.0.

**Warning:** This firmware is at a very early stage. Expect bugs and report them in the issues :)

## Concept Overview

The firmware should support multiple use-cases to connect Libre Solar devices with other networks (incl. the internet).

### ESP32 acting as an Edge Gateway to the cloud

In this application, the ESP32 is integrated in a separate device (like the Libre Solar [Data Manager](https://github.com/LibreSolar/data-manager)) and communicates with the other devices like the charge controller via CAN bus.

The ThingSet protocol on the CAN bus can translated to MQTT in order to push data to a cloud. For local access, the ESP32 can directly serve a website or provide a Bluetooth Low Energy interface for a mobile phone app.

![Edge Gateway Application](docs/esp32-edge-gateway.svg)

### ESP32 integrated in device (e.g. charge controller)

The ESP32 board can also be directly integrated in a charge controller or other devices and communicate with the host device via UART interface (again using the ThingSet protocol).

The data can be accessed in the same way as described above.

![Application with ESP32 integrated in device](docs/esp32-integrated.svg)

## Supported devices

- Libre Solar [Data Manager](https://github.com/LibreSolar/data-manager)
- Sparkfun ESP32thing
- Most other ESP32-based boards

## Firmware features

- Written in C using ESP-IDF and PlatformIO
- Data input from Libre Solar devices via
    - [LS.bus](https://libre.solar/docs/ls_bus/) (CAN bus)
    - [LS.one](https://libre.solar/docs/ls_one/) (UART serial)
- Local communication via [ThingSet Protocol](http://libre.solar/thingset/)
- Data access via HTTP JSON API
- Publishing of monitoring data via WiFi to
    - Open Energy Monitor [Emoncms](https://emoncms.org/)
    - MQTT server (ToDo)
- Data logging on SD card (ToDo)

## Usage

### Getting the firmware

This firmware repository contains git submodules, so you need to clone (download) it by calling:

```
git clone --recursive https://github.com/LibreSolar/esp32-edge-firmware
```

Unfortunately, the green GitHub "Clone or download" button does not include submodules. If you cloned the repository already and want to pull the submodules, run `git submodule update --init --recursive`.


### Building the webapp

To be able to build the esp32-edge-firmware you need to build the webapp first.
To do so, go into the webapp folder

```
    cd esp32-edge-firmware/webapp
```
and run

```
    npm install
    npm run build
```

You are now able to build the firmware itself.

### ESP-IDF toolchain

The ESP-IDF is the native toolchain for ESP32 microcontrollers by Espressif. Follow [this guide](https://docs.espressif.com/projects/esp-idf/en/latest/get-started/index.html#) to install it.

After installation run the following commands:

    idf.py build            # compile the firmware
    idf.py flash            # flash it to the device

### PlatformIO

You can use PlatformIO for easy building and flashing. However, the PlatformIO packages for ESP-IDF are not updated as frequently as the official repositories.

### Configuration

The firmware is configured using Kconfig integrated into ESP-IDF.

The most convenient way is to run `idf.py menuconfig` after the ESP-IDF was successfully installed. If ESP-IDF is not available and PlatformIO is used, configuration can be changed manually in the generated `sdkconfig` file.

### Wifi Connection

The firmware supports provisioning via bluetooth. You can download the espressif BLE provisioning app in the [iOS](https://apps.apple.com/in/app/esp-ble-provisioning/id1473590141) or [android](https://play.google.com/store/apps/details?id=com.espressif.provble) app store and scan this QR code:

![Provisioning QR Code](docs/qrcode.svg)

You can also scan for the device manually in the app, the data manager should be found as device `PROV_LS-DM`, the service pin is `LibreSolar`.