atomecho01.yaml

substitutions:
  name: atomecho01
  friendly_name: Atom Echo
  static_ip: 192.168.2.186
  micro_wake_word_model: okay_nabu  # alexa, hey_jarvis, hey_mycroft are also supported



esphome:
  name: "${name}"
  friendly_name: "${friendly_name}"
  name_add_mac_suffix: false
  project:
    name: m5stack.atom-echo-voice-assistant
    version: "1.0"
  min_version: 2024.6.0
#  includes:
#    - audio/timer_finished.h
#    - audio/wake_word_triggered.h

esp32:
  board: m5stack-atom
  framework:
    type: esp-idf
    version: 4.4.8
    platform_version: 5.4.0

logger:
api:
  encryption:
    key: !secret api_key

ota:
  - platform: esphome
    id: ota_esphome
    password: !secret ota_pwd_sec
#  - platform: http_request
#    id: ota_http_request
#
#update:
#  - platform: http_request
#    id: update_http_request
#    name: Firmware
#    source: https://firmware.esphome.io/wake-word-voice-assistant/m5stack-atom-echo/manifest.json

# dashboard_import:
#   package_import_url: github://esphome/firmware/voice-assistant/m5stack-atom-echo.yaml@main

wifi:
  networks:
  - ssid: !secret wifi_dmz_ssid
    password: !secret wifi_dmz_password
  use_address: 192.168.2.186

  #manual_ip:
  #  static_ip: ${static_ip}
  #  gateway: 192.xxxxxxxxx
  #  subnet: 255.255.255.0
globals:
  - id: media_player_va_pipeline
    type: int
    restore_value: no
    initial_value: '0'

binary_sensor:
  # button does the following:
  # short click - stop a timer
  # if no timer then restart either microwakeword or voice assistant continuous
  - platform: gpio
    pin:
      number: GPIO39
      inverted: true
    name: Button
    disabled_by_default: true
    entity_category: diagnostic
    id: echo_button

    on_multi_click:
    - timing:
        - ON for at least 1001ms
      then:
        - if:
            condition:
              or:
                - switch.is_on: timer_ringing
                - voice_assistant.is_running
            then:
              - script.execute: handle_generic_click
            else:
              - switch.toggle: use_wake_word
    - timing:
        - ON for at most 1000ms
      then:
        - script.execute: handle_generic_click

button:
  - platform: template
    name: Test speaker
    id: test_speaker
    entity_category: config
    on_press:
      - script.execute: sound_beep
      - script.wait: sound_beep
      - delay: 100ms
      - script.execute: restore_wake_word

  - platform: template
    name: Stop timer
    id: stop_timer
    on_press:
      then:
        - switch.turn_off: timer_ringing

  - platform: template
    name: Start assistant
    id: btn_start_assistant
    entity_category: config
    on_press:
      then:
        - if:
            condition:
              switch.is_off: timer_ringing
            then:
              - script.execute: start_assistant

  - platform: factory_reset
    id: factory_reset_btn
    name: Factory reset
  - platform: restart
    name: "${friendly_name} Restart"


i2s_audio:
  - id: audio_i2s
    i2s_lrclk_pin: GPIO33
    i2s_bclk_pin: GPIO19

speaker:
  - id: audio_out
    platform: i2s_audio
    dac_type: external
    i2s_dout_pin: GPIO22
    i2s_audio_id: audio_i2s
    timeout: 100ms
    channel: right
    bits_per_sample: 16bit
    sample_rate: 48000
    buffer_duration: 100ms
#    buffer_duration: 60ms
#  - platform: mixer
#    id: mixer_speaker_id
#    output_speaker: audio_out
#    source_speakers:
#      - id: announcement_spk_mixer_input
#      - id: media_spk_mixer_input

media_player:
  - platform: speaker
    id: va_media_player
    name: player
    codec_support_enabled: false
    buffer_size: 19200
#    buffer_size: 25000
    announcement_pipeline:
      format: WAV
#      speaker: announcement_spk_mixer_input
      speaker: audio_out
      num_channels: 1
      sample_rate: 48000
#    media_pipeline:
#      format: WAV
#      speaker: media_spk_mixer_input
#      num_channels: 1
#      sample_rate: 16000
#    on_state:
#      - logger.log: "State updated!"
    on_play: &play
      - script.execute: stop_wake_word
      - script.wait: stop_wake_word
      - delay: 100ms
      - if:
          condition:
            lambda: 'return (id(media_player_va_pipeline) == 0);'
          then:
            - light.turn_on:
                id: led
                red: 100%
                green: 0%
                blue: 0%
                brightness: 100%
                effect: "Playing"
    on_announcement: *play
#      - script.execute: stop_wake_word
#      - script.wait: stop_wake_word
#      - delay: 100ms
    on_idle:
      - if:
          condition:
            lambda: 'return (id(media_player_va_pipeline) == 0);'
          then:
            - script.execute: restore_wake_word
    files:
      - id: wake_word_wav
        file: audio/wake_word_triggered.wav # Placed in the yaml directory. Should be encoded with a 16000 Hz sample rate, mono or stereo audio, and 16 bits per sample.
      - id: timer_finished_wav
        file: audio/timer_finished.wav # Placed in the yaml directory. Should be encoded with a 16000 Hz sample rate, mono or stereo audio, and 16 bits per sample.


microphone:
  - platform: i2s_audio
    id: echo_microphone
    i2s_din_pin: GPIO23
    adc_type: external
    pdm: true
    sample_rate: 16000

number:
  - name: Speaker Volume
    id: volume
    platform: template
    entity_category: config
    min_value: 0
    max_value: 1.0
    step: 0.05
    update_interval: never
    optimistic: true
    restore_value: true
    initial_value: 1
    on_value:
      - lambda: id(audio_out).set_volume(x);

switch:
  - platform: template
    id: timer_ringing
    optimistic: true
    internal: true
    restore_mode: ALWAYS_OFF
    on_turn_on:
      - script.execute: timer_start_ringing
    on_turn_off: 
      then:
        - script.stop: timer_start_ringing
        - script.execute: restore_wake_word

  - platform: template
    name: Use wake word
    id: use_wake_word
    optimistic: true
    restore_mode: RESTORE_DEFAULT_OFF
    entity_category: config
    on_turn_on:
      - wait_until:
          media_player.is_idle:
      - delay: 100ms
      - micro_wake_word.start
      - script.execute: refresh_led_default
    on_turn_off:
      - micro_wake_word.stop
      - script.execute: refresh_led_default

#external_components:
#  - source: github://pr#5230
#    components:
#      - esp_adf
#    refresh: 0s

# esp_adf:

script:
  - id: handle_generic_click
    then:
      - if:
          condition:
            voice_assistant.is_running
          then:
            - voice_assistant.stop
            - script.execute: restore_wake_word
          else:
            - if:
                condition:
                  switch.is_on: timer_ringing
                then:
                  - switch.turn_off: timer_ringing
                else:
                  - script.execute: start_assistant

  - id: restore_wake_word
    then:
      - script.execute: refresh_led_default
      - logger.log: "Restore wake word"
      - if:
          condition:
            switch.is_on: use_wake_word
          then:
            - logger.log: "Waiting idle"
            - wait_until:
                media_player.is_idle:
            - globals.set:
                id: media_player_va_pipeline
                value: "0"
            - wait_until:
                speaker.is_stopped:
            - delay: 100ms
            - logger.log: "Start micro wake word"
            - micro_wake_word.start:

  - id: stop_wake_word
    then:
      - if:
          condition:
            micro_wake_word.is_running
          then:
            - micro_wake_word.stop
            - wait_until:
                not:
                  micro_wake_word.is_running

  - id: start_assistant
    then:
      - globals.set:
          id: media_player_va_pipeline
          value: "1"
      - script.execute: stop_wake_word
      - script.wait: stop_wake_word
      - media_player.stop:
      - voice_assistant.start
      - light.turn_on:
          id: led
          red: 0
          green: 0
          blue: 1
          brightness: 1

  - id: refresh_led_default
    mode: restart
    then:
      - if:
          condition:
            switch.is_on: timer_ringing
          then:
            - light.turn_on:
                id: led
                red: 0%
                green: 100%
                blue: 0%
                brightness: 100%
                effect: "Fast Pulse"
          else:
            - if:
                condition:
                  lambda: return id(va)->get_timers().size() > 0;
                then:
                  - if:
                      condition:
                        switch.is_on: use_wake_word
                      then:
                        - light.turn_on:
                            id: led
                            red: 100%
                            green: 90%
                            blue: 0%
                            brightness: 100%
                            effect: "Yellow Cyan Strobe"
                      else:
                        - light.turn_on:
                            id: led
                            red: 100%
                            green: 90%
                            blue: 0%
                            brightness: 100%
                            effect: "Very Slow Pulse"
                else:
                  - if:
                      condition:
                        switch.is_on: use_wake_word
                      then:
                        - light.turn_on:
                            id: led
                            red: 0%
                            green: 0%
                            blue: 100%
                            brightness: 100%
                            effect: none
                      else:
                        - light.turn_off: led

  - id: sound_beep
    then:
      - globals.set:
          id: media_player_va_pipeline
          value: "1"
      - media_player.speaker.play_on_device_media_file:
          media_file: wake_word_wav
          announcement: true
      # Wait until the alarm sound starts playing
      - wait_until:
          media_player.is_announcing:
      # Wait until the alarm sound stops playing
      - wait_until:
          not:
            media_player.is_announcing:

  - id: timer_start_ringing
    then:
      - light.turn_on:
          id: led
          brightness: 1
          red: 1
          green: 1
          blue:  1
          effect: Pulse
      - script.execute: timer_perform_ringing
      - delay: 1min
      - switch.turn_off: timer_ringing

  - id: timer_perform_ringing
    then:
      - script.execute: refresh_led_default
      - voice_assistant.stop:
      - micro_wake_word.stop:
      - wait_until:
          not:
            microphone.is_capturing:
      - delay: 100ms
      - while:
          condition:
            switch.is_on: timer_ringing
          then:
            - globals.set:
                id: media_player_va_pipeline
                value: "1"
            - media_player.speaker.play_on_device_media_file:
                media_file: timer_finished_wav
                announcement: true
            # Wait until the alarm sound starts playing
            - wait_until:
                media_player.is_announcing:
            # Wait until the alarm sound stops playing
            - wait_until:
                not:
                  media_player.is_announcing:
            - delay: 500ms
      - wait_until:
          not:
            media_player.is_announcing:


voice_assistant:
  id: va
  microphone: echo_microphone
#  speaker: echo_speaker
  media_player: va_media_player
  noise_suppression_level: 2
  auto_gain: 31dBFS
  volume_multiplier: 10.0
#  vad_threshold: 3
  on_wake_word_detected:
    - microphone.stop_capture:
    - wait_until:
        not:
          microphone.is_capturing:
#    - lambda: id(echo_speaker).play(id(ok_sound), sizeof(id(ok_sound)));
  on_listening:
    - light.turn_on:
        id: led
        blue: 100%
        red: 0%
        green: 0%
        effect: "Slow Pulse"
  on_stt_vad_end:
    - light.turn_on:
        id: led
        blue: 100%
        red: 0%
        green: 0%
        effect: "Fast Pulse"
  on_tts_start:
    - globals.set:
        id: media_player_va_pipeline
        value: "1"
    - light.turn_on:
        id: led
        blue: 100%
        red: 0%
        green: 0%
        brightness: 100%
        effect: none
  on_idle:
    then:
      - delay: 1s
      - script.execute: restore_wake_word
  on_end:
    then:
      - delay: 1s
      - script.execute: restore_wake_word
  on_error:
    - light.turn_on:
        id: led
        red: 100%
        green: 0%
        blue: 0%
        brightness: 100%
        effect: none
    - script.execute: restore_wake_word
    - delay: 1s
    - script.execute: refresh_led_default
  on_client_connected:
    - delay: 2s  # Give the api server time to settle
    - script.execute: restore_wake_word
#    - micro_wake_word.start:
  on_client_disconnected:
    - voice_assistant.stop:
    - micro_wake_word.stop:
  on_timer_finished:
    - switch.turn_on: timer_ringing


light:
  - platform: esp32_rmt_led_strip
    id: led
    name: None
    disabled_by_default: true
    entity_category: config
    pin: GPIO27
    default_transition_length: 250ms
    chipset: SK6812
    num_leds: 1
    rgb_order: grb
    rmt_channel: 0
    effects:
      - random:
          name: "Playing"
          transition_length: 3s
          update_interval: 5s
      - strobe:
          name: "Yellow Cyan Strobe"
          colors:
            - state: true
              brightness: 100%
              red: 100%
              green: 90%
              blue: 0%
              duration: 2000ms
              transition_length: 2000ms
            - state: true
              brightness: 100%
              red: 0%
              green: 0%
              blue: 100%
              duration: 2000ms
              transition_length: 2000ms
      - pulse:
          name: "Pulse"
          transition_length: 500ms
          update_interval: 500ms
      - pulse:
          name: "Slow Pulse"
          transition_length: 250ms
          update_interval: 250ms
          min_brightness: 50%
          max_brightness: 100%
      - pulse:
          name: "Very Slow Pulse"
          transition_length: 2000ms
          update_interval: 3000ms
          min_brightness: 50%
          max_brightness: 100%
      - pulse:
          name: "Fast Pulse"
          transition_length: 100ms
          update_interval: 100ms
          min_brightness: 50%
          max_brightness: 100%

micro_wake_word:
#  model: okay_nabu
  id: mww
  models:
    - model: https://github.com/kahrendt/microWakeWord/releases/download/okay_nabu_20241205.4/okay_nabu.json
#      id: okay_nabu
#    - model: https://github.com/kahrendt/microWakeWord/releases/download/stop/stop.json
#      id: stop
#      internal: true
#  vad:
#    model: https://github.com/kahrendt/microWakeWord/releases/download/v2.1_models/vad.json
  microphone: echo_microphone
  on_wake_word_detected:
    - lambda: 'ESP_LOGI("custom", "Wake word detected: %s", wake_word.c_str());'
    - if:
        condition:
          switch.is_on: timer_ringing
        then:
          - switch.turn_off: timer_ringing
        else:
          - if:
              condition:
                lambda: return (wake_word != "Stop");
              then:
                - wait_until:
                    not:
                      microphone.is_capturing:
                - delay: 100ms
                - script.execute: sound_beep
                - script.wait: sound_beep
#                - delay: 100ms
            #    - micro_wake_word.stop
                - voice_assistant.start:
                    wake_word: !lambda return wake_word;
                - light.turn_on:
                    id: led
                    red: 0
                    green: 0
                    blue: 1
                    brightness: 1
              else:
                - script.execute: restore_wake_word