https://github.com/smashedr/esphome-configs

ESPHome Configs
https://github.com/smashedr/esphome-configs
Last synced: 15 days ago
JSON representation
ESPHome Configs
Host: GitHub
URL: https://github.com/smashedr/esphome-configs
Owner: smashedr
Created: 2024-11-13T20:13:42.000Z (over 1 year ago)
Default Branch: master
Last Pushed: 2025-01-06T08:22:58.000Z (over 1 year ago)
Last Synced: 2025-01-20T23:49:10.116Z (over 1 year ago)
Language: Jupyter Notebook
Homepage:
Size: 1.86 MB
Stars: 0
Watchers: 1
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
Awesome Lists containing this project

README

          [![GitHub Last Commit](https://img.shields.io/github/last-commit/smashedr/esphome-configs?logo=github&logoColor=white&label=updated)](https://github.com/smashedr/esphome-configs/graphs/commit-activity)

[![GitHub Org Stars](https://img.shields.io/github/stars/cssnr?style=flat&logo=github&logoColor=white)](https://cssnr.github.io/)

[![Discord](https://img.shields.io/discord/899171661457293343?logo=discord&logoColor=white&label=discord&color=7289da)](https://discord.gg/wXy6m2X8wY)

# ESPHome Configs

- [Substitutions](#substitutions)

- [Voice Assistant](#voice-assistant)

- [Micro Wake Word](#micro-wake-word)

- [LVGL](#lvgl)

- [Packages](#packages) <-- this is a **MUST SEE!**

ESPHome: https://esphome.io/

## Substitutions

- https://esphome.io/components/substitutions

This is now a WIP with Packages coming soon, but seems stable...

To see how these substitutions are used, see: [include/common.yaml](include/common.yaml)

```yaml

substitutions:

  # required for most of package: common

  friendly_name: "Kitchen Box" # Friendly name for display in Home Assistant.

  box_num: "01" # Unique box number appended to box_name used for hostname and IP address.

  box_name: "espbox" # Non-unique box name prepended to box_num used for hostname.

  type: "esp32" # Platform, see: https://esphome.io/#supported-microcontrollers

  board: "esp32dev" # Board, see: https://esphome.io/#supported-microcontrollers

  comment: "38-pin" # Just a comment to show in ESPHome.

  # provided by package: common

  update_interval: "1min" # Used to define update_interval for many of the included sensors.

  force_update: "true" # Used to define force_update for many of the included sensors.

```

## Voice Assistant

- https://esphome.io/components/voice_assistant

**See Packages for more info: [voice_assistant](#voice_assistant)**

Current Progress:

- Configs: [esptest48.yaml](esptest48.yaml) /[esptest51.yaml](esptest51.yaml) / [esptest52.yaml](esptest52.yaml)

- Package: [include/va/voice_assistant.yaml](include/va/voice_assistant.yaml)

## Micro Wake Word

- https://esphome.io/components/micro_wake_word

- https://github.com/kahrendt/microWakeWord

**See Packages for more info: [micro_wake_word](#micro_wake_word)**

For training documentation, see: [basic_training_notebook.ipynb](models/basic_training_notebook.ipynb)

**These models are a WIP** and will either be deprecated or improved based on popularity.

| Wake Word     | File                                              | URL for Model                                                 |

| ------------- | ------------------------------------------------- | ------------------------------------------------------------- |

| Computer      | [models/computer.json](models/computer.json)      | `github://smashedr/esphome-configs/models/computer.json`      |

| Jarvis        | [models/jarvis.json](models/jarvis.json)          | `github://smashedr/esphome-configs/models/jarvis.json`        |

| Jenkins       | [models/jenkins.json](models/jenkins.json)        | `github://smashedr/esphome-configs/models/jenkins.json`       |

| Wakeup Jarvis | [models/computer.json](models/wakeup_jarvis.json) | `github://smashedr/esphome-configs/models/wakeup_jarvis.json` |

Note: training wake words that work with background noise takes lots of trial and error and playing with the settings.  

Some notes on the models I have trained.

- **Computer**: This is "actually" the first version of computer.

- **Jarvis**: Quite a few false positives, same issue with background noise.

- **Jenkins**: Works well, except with background noise.

- **Wakeup Jarvis**: This is just for testing to enable micro wake word and activate for "muted" boxes.

- **Frasier**: This was only trained with my voice. **DO NOT USE!**

Example Configuration (official, local, and remote):

```yaml

micro_wake_word:

  vad:

  models:

    - model: hey_jarvis

    - model: models/computer.json

    - model: github://smashedr/esphome-configs/models/jarvis.json@master

    - model: github://smashedr/esphome-configs/models/jenkins.json@master

  on_wake_word_detected:

    then:

      - voice_assistant.start:

```

**Note: Using only use 1 model seems to improve performance.**

Tip: Micro Wake Word will respond slightly faster with increased CPU frequency on ESP32:

```yaml

esp32:

  board: "${board}"

  framework:

    type: esp-idf

    version: recommended

    sdkconfig_options:

      CONFIG_ESP32_DEFAULT_CPU_FREQ_240: "y"

```

Note: This may differ for variants...

_Reference: https://esphome.io/components/esp32_  

_Reference: https://docs.espressif.com/projects/esp-idf/en/latest/esp32/api-reference/kconfig-reference.html_

## LVGL

Coming Soon...

Current Project: https://www.waveshare.com/wiki/ESP32-S3-Touch-LCD-4.3

Progress: [waveshare01.yaml](waveshare01.yaml)

## Packages

- https://esphome.io/components/packages.html

This is still a **WIP** but **very powerful** in its current state...

_Click on the package name for info on using the package and the file name for full details._

| Package                             | File                                                               | URL                                                                      |

| ----------------------------------- | ------------------------------------------------------------------ | ------------------------------------------------------------------------ |

| [common](#common)                   | [include/common.yaml](include/common.yaml)                         | github://smashedr/esphome-configs/include/common.yaml@master             |

| [debug](#debug)                     | [include/debug.yaml](include/debug.yaml)                           | github://smashedr/esphome-configs/include/debug.yaml@master              |

| [status_led](#status_led)           | [include/status_led.yaml](include/status_led.yaml)                 | github://smashedr/esphome-configs/include/status_led.yaml@master         |

| [voice_assistant](#voice_assistant) | [include/va/voice_assistant.yaml](include/va/voice_assistant.yaml) | github://smashedr/esphome-configs/include/va/voice_assistant.yaml@master |

| [micro_wake_word](#micro_wake_word) | [include/va/micro_wake_word.yaml](include/va/micro_wake_word.yaml) | github://smashedr/esphome-configs/include/va/micro_wake_word.yaml@master |

| [pmsx003](#pmsx003)                 | [include/pmsx003/pmsx003.yaml](include/pmsx003/pmsx003.yaml)       | github://smashedr/esphome-configs/include/pmsx003/pmsx003.yaml@master    |

| [apds9960](#apds9960)               | [include/apds9960/apds9960.yaml](include/apds9960/apds9960.yaml)   | github://smashedr/esphome-configs/include/apds9960/apds9960.yaml@master  |

| [ld2420](#ld2420)                   | [include/ld2420/ld2420.yaml](include/ld2420/ld2420.yaml)           | github://smashedr/esphome-configs/include/ld2420/ld2420.yaml@master      |

| [ld2450](#ld2450)                   | [include/ld2450/ld2450.yaml](include/ld2450/ld2450.yaml)           | github://smashedr/esphome-configs/include/ld2450/ld2450.yaml@master      |

**Note:** All components included in a package can be `removed` or `extended` as desired...

### common

These are my common configurations shared with all boxes. You probably don't want to use these without modification.

This package requires most of the required variables from: [Substitutions](#substitutions)

### debug

- https://esphome.io/components/debug

| Variable | Default | Description                       |

| -------- | ------- | --------------------------------- |

| box_num  | `01`    | Number/Name Appended to `name`(s) |

```yaml

packages:

  debug: github://smashedr/esphome-configs/include/debug.yaml@master

substitutions:

  box_num: "01"

```

Use this to easily enable the `debug` platform on ESPHome.

### status_led

- https://esphome.io/components/status_led

| Variable   | Default    | Description               |

| ---------- | ---------- | ------------------------- |

| pin        | -          | PIN for LED Binary Output |

| status_led | `main_led` | ID of the `status_led`    |

This combines the `status_led` platform with an `identify` button.

```yaml

packages:

  status_led: github://smashedr/esphome-configs/include/status_led.yaml@master

substitutions:

  pin: "GPIO18" # required

  status_led: "name_for_id"

```

### counters

| Variable | Default | Description                          |

| -------- | ------- | ------------------------------------ |

| box_num  | `01`    | Number/Name Appended to `name`(s)    |

| level    | `ERROR` | Log Level to trigger error messages. |

Sends all logs at `level` or higher to a discord `channel_id` via the discord integration `notify_id`.

```yaml

packages:

  counters: github://smashedr/esphome-configs/include/counters.yaml@master

substitutions:

  box_num: "01"

  level: "ERROR"

```

### discord_logs

- https://www.home-assistant.io/integrations/discord/

| Variable      | Default      | Description                                   |

| ------------- | ------------ | --------------------------------------------- |

| channel_id    | -            | PIN for LED Binary Output                     |

| box_num       | `01`         | Combined with box_name for name. Vanity Only. |

| box_name      | `esp`        | Combined with box_num for name. Vanity Only.  |

| friendly_name | `ESP Box`    | Box Name. Vanity Only.                        |

| notify_id     | `ha_discord` | ID of the `notify.discord` integration.       |

| level         | `ERROR`      | Log Level to trigger error messages.          |

Sends all logs at `level` or higher to a discord `channel_id` via the discord integration `notify_id`.

```yaml

packages:

  discord_logs: github://smashedr/esphome-configs/include/discord_logs.yaml@master

substitutions:

  channel_id: "0123456789" # REQUIRED

  box_num: "01"

  box_name: "esp"

  friendly_name: "ESP Box"

  notify_id: "ha_discord"

  level: "ERROR"

```

### voice_assistant

- https://esphome.io/components/voice_assistant

| Variable        | Default    | Description                  |

| --------------- | ---------- | ---------------------------- |

| microphone      | `va_mic`   | ID of `microphone`           |

| script_va_start | `va_start` | ID of script to `start` va   |

| sorting_weight  | `-30`      | `sorting_weight` of VA group |

```yaml

packages:

  voice_assistant: github://smashedr/esphome-configs/include/va/voice_assistant.yaml@master

substitutions:

  microphone: "va_mic"

  script_va_start: "va_start"

  sorting_weight: "-30"

```

This package provides the voice_assistant, a button to activate and a web_server sorting_group.

This requires the a `va_start` script provided by `micro_wake_word` package. If only using `voice_assistant`, add:

```yaml

script:

  - id: va_start

    mode: restart

    then:

      - logger.log: "Running script: va_start"

      - if:

          condition:

            - voice_assistant.is_running:

          then:

            - logger.log: "va_start: voice_assistant.stop"

            - voice_assistant.stop:

          else:

            - wait_until:

                condition:

                  not:

                    microphone.is_capturing:

            - logger.log: "va_start: voice_assistant.start"

            - voice_assistant.start:

```

This will stop the VA if it is running, otherwise start the VA; making it a toggle.  

At minimum the script should attempt to: `- voice_assistant.start:`.

### micro_wake_word

- https://esphome.io/components/micro_wake_word

| Variable         | Default      | Description                   |

| ---------------- | ------------ | ----------------------------- |

| model            | `hey_jarvis` | Number/Name or URL of `model` |

| sorting_group_id | `sg_va`      | ID of VA `sorting_group`      |

```yaml

packages:

  micro_wake_word: github://smashedr/esphome-configs/include/va/micro_wake_word.yaml@master

substitutions:

  model: "hey_jarvis"

  sorting_group_id: "sg_va"

```

This package provides the micro_wake_word, a switch to enable/disable it and save state, an on_boot to ensure state; plus scripts:

- micro_wake_enable

- va_start

- va_end

You will want to !extend these, and use them in your workflow for those actions.

Example extending the `va_end` script to turn off a light:

```yaml

script:

  - id: !extend va_end

    then:

      - light.turn_off: main_led

```

### pmsx003

- https://esphome.io/components/sensor/pmsx003

| Variable     | Default  | Description                       |

| ------------ | -------- | --------------------------------- |

| pms_num      | `01`     | Number/Name Appended to `name`(s) |

| rx_pin       | `GPIO16` | PIN for `rx_pin`                  |

| tx_pin       | `GPIO17` | PIN for `tx_pin`                  |

| force_update | `true`   | Set `force_update` for sensor     |

```yaml

packages:

  pmsx003: github://smashedr/esphome-configs/include/pmsx003/pmsx003.yaml@master

substitutions:

  pms_num: "01"

  rx_pin: "GPIO16"

  tx_pin: "GPIO17"

  force_update: "true"

```

You may want to !extend the sensor for `on_value` automations:

```yaml

sensor:

  - id: !extend pm_sensor

    pm_2_5:

      on_value_range:

```

### apds9960

- https://esphome.io/components/sensor/apds9960

| Variable            | Default | Description                                 |

| ------------------- | ------- | ------------------------------------------- |

| box_num             | `01`    | Number/Name Appended to `name`(s)           |

| sorting_weight      | `50`    | web_server: sorting_group: `sorting_weight` |

| disabled_by_default | `true`  | Binary sensors `disabled_by_default`        |

```yaml

packages:

  apds9960: github://smashedr/esphome-configs/include/apds9960/apds9960.yaml@master

substitutions:

  box_num: "01"

  sorting_weight: "50"

  disabled_by_default: "true"

```

This package captures each gesture and publishes them to a text sensor with the last value, UP, DOWN, RIGHT, or LEFT.

You will probably want to !extend the `last_gesture` sensor to add automation for the `on_value`:

```yaml

text_sensor:

  - platform: template

    id: !extend last_gesture

    on_value:

      then:

        - logger.log:

            format: "Direction: %s"

            args: ["x.c_str()"]

```

This also adds a `sorting_group` to the `web_server`. If you don't use `web_server` 3 this can be disabled:

```yaml

web_server: !remove

```

### ld2420

- https://esphome.io/components/sensor/ld2420

| Variable | Default  | Description                       |

| -------- | -------- | --------------------------------- |

| box_num  | `01`     | Number/Name Appended to `name`(s) |

| rx_pin   | `GPIO16` | PIN for `rx_pin`                  |

| tx_pin   | `GPIO17` | PIN for `tx_pin`                  |

```yaml

packages:

  ld2420: github://smashedr/esphome-configs/include/ld2420/ld2420.yaml@master

substitutions:

  rx_pin: "GPIO16"

  tx_pin: "GPIO17"

```

You may want to !extend the presence sensor for `on_press` automations:

```yaml

binary_sensor:

  - id: !extend presence_sensor

    has_target:

      on_press:

        then:

          - logger.log: "Presence Detected"

      on_release:

        then:

          - logger.log: "No Presence"

```

Attempting to include this in the package then overriding it throws a duplicate ID error on `presence`.

_Note: If you plan to !extend the `uart:` definition, the `ld2420:` definition must come before it!_

### ld2450

- https://github.com/uncle-yura/esphome-ld2450

| Variable | Default  | Description                       |

| -------- | -------- | --------------------------------- |

| box_num  | `01`     | Number/Name Appended to `name`(s) |

| rx_pin   | `GPIO16` | PIN for `rx_pin`                  |

| tx_pin   | `GPIO17` | PIN for `tx_pin`                  |

```yaml

packages:

  ld2450: github://smashedr/esphome-configs/include/ld2450/ld2450.yaml@master

substitutions:

  rx_pin: "GPIO16"

  tx_pin: "GPIO17"

```

The `presence` binary_sensor needs to be added manually and optionally moving/still:

```yaml

binary_sensor:

  - platform: ld2450

    has_target:

      name: "Presence ${box_num}"

      id: presence

      on_press:

        then:

          - logger.log: "Presence Detected"

      on_release:

        then:

          - logger.log: "No Presence"

    has_moving_target:

      name: "Moving Target ${box_num}"

    has_still_target:

      name: "Still Target ${box_num}"

```

_Note: This custom package can not be extended because it does not allow an ID..._
ecosyste.ms

Data

Tools

Indexes

Applications

Experiments

Awesome

https://github.com/smashedr/esphome-configs

Awesome Lists containing this project

README
