tagreader.yaml

# Insert your SSID and Your PWD after inital setup
wifi:
# networks:
#   - ssid: 'REPLACEME' # Enter your WiFi SSID here. Example: `ssid: 'your_network_name'`
#     password: 'REPLACEME' # Enter your wifi password here. Example: `password: 'abcde123456'`
  ap:
    ssid: ${name}

web_server:
  port: 80

# Enable the captive portal for inital WiFi setup
captive_portal:

dashboard_import:
  package_import_url: github://adonno/tagreader/tagreader.yaml

improv_serial:

substitutions:
  name: tagreader
  friendly_name: TagReader

esp8266:
  board: d1_mini

esphome:
  name: $name

  # Automatically add the mac address to the name
  # so you can use a single firmware for all devices
  name_add_mac_suffix: true

  # This will allow for (future) project identification,
  # configuration and updates.
  project:
    name: adonno.tag_reader
    version: dev
# If buzzer is enabled, notify on api connection success
  on_boot:
    priority: -10
    then:
    - wait_until:
        api.connected:
    - logger.log: API is connected!
    - rtttl.play: "success:d=32,o=5,b=100:c,g,b"
    - light.turn_on:
        id: activity_led
        brightness: 100%
        red: 0%
        green: 0%
        blue: 100%
        flash_length: 500ms
    - switch.turn_on: buzzer_enabled
    - switch.turn_on: led_enabled

# Define switches to control LED and buzzer from HA
switch:
- platform: template
  name: "${friendly_name} Buzzer Enabled"
  id: buzzer_enabled
  icon: mdi:volume-high
  optimistic: true
  restore_mode: RESTORE_DEFAULT_ON
  entity_category: config
- platform: template
  name: "${friendly_name} LED enabled"
  id: led_enabled
  icon: mdi:alarm-light-outline
  optimistic: true
  restore_mode: RESTORE_DEFAULT_ON
  entity_category: config

# Define buttons for writing tags via HA
button:
  - platform: template
    name: Write Tag Random
    id: write_tag_random
    # Optional variables:
    icon: "mdi:pencil-box"
    on_press:
      then:
      - light.turn_on:
          id: activity_led
          brightness: 100%
          red: 100%
          green: 0%
          blue: 100%
      - lambda: |-
          static const char alphanum[] = "0123456789abcdef";
          std::string uri = "https://www.home-assistant.io/tag/";
          for (int i = 0; i < 8; i++)
            uri += alphanum[random_uint32() % (sizeof(alphanum) - 1)];
          uri += "-";
          for (int j = 0; j < 3; j++) {
            for (int i = 0; i < 4; i++)
              uri += alphanum[random_uint32() % (sizeof(alphanum) - 1)];
            uri += "-";
          }
          for (int i = 0; i < 12; i++)
            uri += alphanum[random_uint32() % (sizeof(alphanum) - 1)];
          auto message = new nfc::NdefMessage();
          message->add_uri_record(uri);
          ESP_LOGD("tagreader", "Writing payload: %s", uri.c_str());
          id(pn532_board).write_mode(message);
      - rtttl.play: "write:d=32,o=5,b=100:b"
      - wait_until:
          not:
            pn532.is_writing:
      - light.turn_off:
          id: activity_led
      - rtttl.play: "write:d=32,o=5,b=100:b,b"
  - platform: template
    name: Clean Tag
    id: clean_tag
    icon: "mdi:nfc-variant-off"
    on_press:
      then:
      - light.turn_on:
          id: activity_led
          brightness: 100%
          red: 100%
          green: 64.7%
          blue: 0%
      - lambda: 'id(pn532_board).clean_mode();'
      - rtttl.play: "write:d=32,o=5,b=100:b"
      - wait_until:
          not:
            pn532.is_writing:
      - light.turn_off:
          id: activity_led
      - rtttl.play: "write:d=32,o=5,b=100:b,b"
  - platform: template
    name: Cancel writing
    id: cancel_writing
    icon: "mdi:pencil-off"
    on_press:
      then:
      - lambda: 'id(pn532_board).read_mode();'
      - light.turn_off:
          id: activity_led
      - rtttl.play: "write:d=32,o=5,b=100:b,b"

  - platform: restart
    name: "${friendly_name} Restart"
    entity_category: config

# Enable logging
logger:
  # level: VERY_VERBOSE
  # level: VERBOSE

# Enable Home Assistant API
api:
  encryption:
    key: !secret api_encryption_key
  services:
  - service: rfidreader_tag_ok
    then:
    - rtttl.play: "beep:d=16,o=5,b=100:b"

  - service: rfidreader_tag_ko
    then:
    - rtttl.play: "beep:d=8,o=5,b=100:b"

  - service: play_rtttl
    variables:
      song_str: string
    then:
    - rtttl.play: !lambda 'return song_str;'

  - service: write_tag_id
    variables:
      tag_id: string
    then:
    - light.turn_on:
        id: activity_led
        brightness: 100%
        red: 100%
        green: 0%
        blue: 0%
    - lambda: |-
        auto message = new nfc::NdefMessage();
        std::string uri = "https://www.home-assistant.io/tag/";
        uri += tag_id;
        message->add_uri_record(uri);
        id(pn532_board).write_mode(message);
    - rtttl.play: "write:d=32,o=5,b=100:b"
    - wait_until:
        not:
          pn532.is_writing:
    - light.turn_off:
        id: activity_led
    - rtttl.play: "write:d=32,o=5,b=100:b,b"

  - service: write_music_tag
    variables:
      music_url: string
      music_info: string
    then:
    - light.turn_on:
        id: activity_led
        brightness: 100%
        red: 100%
        green: 0%
        blue: 0%
    - lambda: |-
        auto message = new nfc::NdefMessage();
        std::string uri = "";
        std::string text = "";
        uri += music_url;
        text += music_info;
        if ( music_url != "" ) {
          message->add_uri_record(uri);
        }
        if ( music_info != "" ) {
          message->add_text_record(text);
        }
        id(pn532_board).write_mode(message);
    - rtttl.play: "write:d=32,o=5,b=100:b"
    - wait_until:
        not:
          pn532.is_writing:
    - light.turn_off:
        id: activity_led
    - rtttl.play: "write:d=32,o=5,b=100:b,b"

# Enable OTA upgrade
ota:
- platform: esphome

i2c:
  scan: False
  frequency: 400kHz

globals:
  - id: source
    type: std::string
  - id: url
    type: std::string
  - id: info
    type: std::string

pn532_i2c:
  id: pn532_board
  on_tag:
    then:
    - if:
        condition:
          switch.is_on: led_enabled
        then:
        - light.turn_on:
            id: activity_led
            brightness: 100%
            red: 0%
            green: 100%
            blue: 0%
            flash_length: 500ms

    - delay: 0.15s #to fix slow component

    - lambda: |-
        id(source)="";
        id(url)="";
        id(info)="";
        if (tag.has_ndef_message()) {
          auto message = tag.get_ndef_message();
          auto records = message->get_records();
          for (auto &record : records) {
            std::string payload = record->get_payload();
            std::string type = record->get_type();
            size_t hass = payload.find("https://www.home-assistant.io/tag/");
            size_t applemusic = payload.find("https://music.apple.com");
            size_t spotify = payload.find("https://open.spotify.com");
            size_t sonos = payload.find("sonos-2://");
            size_t mass_deezer = payload.find("deezer://");
            size_t mass_filesystem_local = payload.find("filesystem_local://");
            size_t mass_filesystem_smb = payload.find("filesystem_smb://");
            size_t mass_plex = payload.find("plex://");
            size_t mass_qobuz = payload.find("qobuz://");
            size_t mass_radiobrowser = payload.find("radiobrowser://");
            size_t mass_soundcloud = payload.find("soundcloud://");
            size_t mass_spotify = payload.find("spotify://");
            size_t mass_tidal = payload.find("tidal://");
            size_t mass_tunein = payload.find("tunein://");
            size_t mass_ytmusic = payload.find("ytmusic://");

            if (type == "U" and hass != std::string::npos ) {
              ESP_LOGD("tagreader", "Found Home Assistant tag NDEF");
              id(source)="hass";
              id(url)=payload;
              id(info)=payload.substr(hass + 34);
            }
            else if (type == "U" and applemusic != std::string::npos ) {
              ESP_LOGD("tagreader", "Found Apple Music tag NDEF");
              id(source)="amusic";
              id(url)=payload;
            }
            else if (type == "U" and spotify != std::string::npos ) {
              ESP_LOGD("tagreader", "Found Spotify tag NDEF");
              id(source)="spotify";
              id(url)=payload;
            }
            else if (type == "U" and sonos != std::string::npos ) {
              ESP_LOGD("tagreader", "Found Sonos app tag NDEF");
              id(source)="sonos";
              id(url)=payload;
            }
            else if (type == "U" && (mass_deezer != std::string::npos ||
                                      mass_filesystem_local != std::string::npos ||
                                      mass_filesystem_smb != std::string::npos ||
                                      mass_plex != std::string::npos ||
                                      mass_qobuz != std::string::npos ||
                                      mass_radiobrowser != std::string::npos ||
                                      mass_soundcloud != std::string::npos ||
                                      mass_spotify != std::string::npos ||
                                      mass_tidal != std::string::npos ||
                                      mass_tunein != std::string::npos ||
                                      mass_ytmusic != std::string::npos)) {
              ESP_LOGD("tagreader", "Found Music Assistant tag NDEF");
              id(source) = "mass";
              id(url) = payload;
            }
            else if (type == "U") {
              ESP_LOGD("tagreader", "Found generic URL tag NDEF");
              id(source) = "url";
              id(url) = payload;
            }
            else if (type == "T" ) {
              ESP_LOGD("tagreader", "Found music info tag NDEF");
              id(info)=payload;
            }
            else if ( id(source)=="" ) {
              id(source)="uid";
            }
          }
        }
        else {
          id(source)="uid";
        }

    - if:
        condition:
          lambda: 'return ( id(source)=="uid" );'
        then:
          - homeassistant.tag_scanned: !lambda |-
              ESP_LOGD("tagreader", "No HA NDEF, using UID");
              return x;
        else:
        - if:
            condition:
              lambda: 'return ( id(source)=="hass" );'
            then:
            - homeassistant.tag_scanned: !lambda 'return id(info);'
            else:
            - homeassistant.event:
                event: esphome.music_tag
                data:
                  reader: !lambda |-
                    return App.get_name().c_str();
                  source: !lambda |-
                    return id(source);
                  url: !lambda |-
                    return id(url);
                  info: !lambda |-
                    return id(info);

    - if:
        condition:
          switch.is_on: buzzer_enabled
        then:
        - rtttl.play: "success:d=32,o=5,b=100:c,g,b"
  on_tag_removed:
    then:
    - homeassistant.event:
        event: esphome.tag_removed

# Define the buzzer output
output:
- platform: esp8266_pwm
  pin: D7
  id: buzzer

# ---------------------------------------------------------------------------
# Buttons (merged from the button-capable variant)
# 4 physical buttons: 3 momentary (short + long press) + 1 toggle
# Wire momentary buttons to GPIO10 (pin 12), GPIO14 (pin 5), GPIO0 (pin 18)
# Wire the toggle switch to GPIO16 (pin 4)
# ---------------------------------------------------------------------------
binary_sensor:
  - platform: status
    name: "${friendly_name} Status"
    entity_category: diagnostic

  # --- Button 1 ---
  - platform: gpio
    name: "Button 1 (raw)"
    id: button_1_raw
    pin:
      number: 10 # pin 12
      inverted: true
      mode:
        input: true
        pullup: true
    internal: true
    filters:
      - delayed_on: 30ms
      - delayed_off: 30ms
    on_multi_click:
      - timing:
          - ON for 40ms to 400ms
          - OFF for at least 330ms
        then:
          - binary_sensor.template.publish:
              id: button_1
              state: ON
      - timing:
          - ON for at least 2s
        then:
          - binary_sensor.template.publish:
              id: button_1_long_press
              state: ON
          - rtttl.play: "write:d=32,o=5,b=100:b"
  - platform: template
    name: "Button 1"
    id: button_1
    icon: "mdi:button-pointer"
    trigger_on_initial_state: true
    on_press:
      then:
        - delay: 500ms
        - binary_sensor.template.publish:
            id: button_1
            state: OFF
  - platform: template
    name: "Button 1 (long press)"
    id: button_1_long_press
    icon: "mdi:button-pointer"
    trigger_on_initial_state: true
    on_press:
      then:
        - delay: 500ms
        - binary_sensor.template.publish:
            id: button_1_long_press
            state: OFF

  # --- Button 2 ---
  - platform: gpio
    name: "Button 2 (raw)"
    id: button_2_raw
    pin:
      number: 14 # pin 5
      inverted: true
      mode:
        input: true
        pullup: true
    internal: true
    filters:
      - delayed_on: 30ms
      - delayed_off: 30ms
    on_multi_click:
      - timing:
          - ON for 40ms to 400ms
          - OFF for at least 330ms
        then:
          - binary_sensor.template.publish:
              id: button_2
              state: ON
      - timing:
          - ON for at least 2s
        then:
          - binary_sensor.template.publish:
              id: button_2_long_press
              state: ON
          - rtttl.play: "write:d=32,o=5,b=100:b"
  - platform: template
    name: "Button 2"
    id: button_2
    icon: "mdi:button-pointer"
    trigger_on_initial_state: true
    on_press:
      then:
        - delay: 500ms
        - binary_sensor.template.publish:
            id: button_2
            state: OFF
  - platform: template
    name: "Button 2 (long press)"
    id: button_2_long_press
    icon: "mdi:button-pointer"
    trigger_on_initial_state: true
    on_press:
      then:
        - delay: 500ms
        - binary_sensor.template.publish:
            id: button_2_long_press
            state: OFF

  # --- Button 3 ---
  - platform: gpio
    name: "Button 3 (raw)"
    id: button_3_raw
    pin:
      number: 0 # pin 18
      inverted: true
      mode:
        input: true
        pullup: true
    internal: true
    filters:
      - delayed_on: 30ms
      - delayed_off: 30ms
    on_multi_click:
      - timing:
          - ON for 40ms to 400ms
          - OFF for at least 330ms
        then:
          - binary_sensor.template.publish:
              id: button_3
              state: ON
      - timing:
          - ON for at least 2s
        then:
          - binary_sensor.template.publish:
              id: button_3_long_press
              state: ON
          - rtttl.play: "write:d=32,o=5,b=100:b"
  - platform: template
    name: "Button 3"
    id: button_3
    icon: "mdi:button-pointer"
    trigger_on_initial_state: true
    on_press:
      then:
        - delay: 500ms
        - binary_sensor.template.publish:
            id: button_3
            state: OFF
  - platform: template
    name: "Button 3 (long press)"
    id: button_3_long_press
    icon: "mdi:button-pointer"
    trigger_on_initial_state: true
    on_press:
      then:
        - delay: 500ms
        - binary_sensor.template.publish:
            id: button_3_long_press
            state: OFF

  # --- Button 4 (toggle) ---
  - platform: gpio
    name: "Button 4 (toggle button)"
    id: button_4_toggle
    pin:
      number: 16 # pin 4
      inverted: false
      mode:
        input: true
        pulldown: true
    icon: "mdi:toggle-switch"

text_sensor:
  - platform: version
    hide_timestamp: true
    name: "${friendly_name} ESPHome Version"
    entity_category: diagnostic
  - platform: wifi_info
    ip_address:
      name: "${friendly_name} IP Address"
      icon: mdi:wifi
      entity_category: diagnostic
    ssid:
      name: "${friendly_name} Connected SSID"
      icon: mdi:wifi-strength-2
      entity_category: diagnostic

# Define buzzer as output for RTTTL
rtttl:
  output: buzzer

# Configure LED
light:
- platform: neopixelbus
  variant: WS2812
  pin: D8
  num_leds: 1
  flash_transition_length: 500ms
  type: GRB
  id: activity_led
  name: "${friendly_name} LED"
  restore_mode: ALWAYS_OFF