OpenPrintTag reader: aux write action for the integration

openprinttag_write_aux lets the OpenPrintTag integration's
openprinttag.update write the consumed weight and other aux values
to the tag on the reader.

mcu-rfid-openprinttag.yaml

@@ -0,0 +1,225 @@
+---
+# Hardware: M5Stack M5Stamp S3 + PN5180 module (5 V and 3.3 V both needed)
+# Pinout:
+#   GPIO0   Button
+#   GPIO3   (external RFID LED, not fitted yet; notify_led uses the onboard RGB for now)
+#   GPIO4   Buzzer                     -> buzzer (output ledc)
+#   GPIO5                              -> spi (spi miso_pin)          PN5180 MISO
+#   GPIO6                              -> spi (spi mosi_pin)          PN5180 MOSI
+#   GPIO7                              -> spi (spi clk_pin)           PN5180 SCK
+#   GPIO8                              -> pn5180 (cs_pin)             PN5180 NSS
+#   GPIO9                              -> pn5180 (busy_pin)           PN5180 BUSY
+#   GPIO10                             -> pn5180 (reset_pin)          PN5180 RST
+#   GPIO11                             -> pn5180 (irq_pin)            PN5180 IRQ
+#   GPIO19  U-
+#   GPIO20  U+
+#   GPIO21  RGB                        -> notify_led (light esp32_rmt_led_strip), also status_led
+# PN5180 REQ, AUX, GPIO left open (REQ high at reset = firmware download mode)
+substitutions:
+  device: rfid-openprinttag
+  name: OpenPrintTag
+  area: DEV
+  comment: OpenPrintTag filament spool reader
+
+esphome:
+  name: mcu-${device}
+  friendly_name: ${name}
+  area: ${area}
+  comment: ${comment}
+
+esp32:
+  variant: esp32s3
+  toolchain: esp-idf
+  framework:
+    advanced:
+      flash_chip: gd
+    type: esp-idf
+
+packages:
+  common: !include common/common.yaml
+  ipv6_only: !include common/ipv6_only.yaml
+  status_led: !include
+    file: common/status_led.yaml
+    vars:
+      light_id: notify_led
+      show_errors: "true"
+
+external_components:
+  - source: github://randybb/esphome-components
+    components: [pn5180]
+    refresh: 1h
+
+# Called by the OpenPrintTag integration (openprinttag.update) to update the aux region
+api:
+  actions:
+    - action: openprinttag_write_aux
+      variables:
+        uid: string
+        aux: string
+      then:
+        - lambda: id(pn5180_reader).write_aux(uid, aux);
+
+spi:
+  clk_pin: GPIO7
+  mosi_pin: GPIO6
+  miso_pin: GPIO5
+
+pn5180:
+  id: pn5180_reader
+  cs_pin: GPIO8
+  busy_pin: GPIO9
+  reset_pin: GPIO10
+  irq_pin: GPIO11
+  on_tag:
+    - if:
+        condition:
+          switch.is_on: led_enabled
+        then:
+          - light.turn_on:
+              id: notify_led
+              brightness: 100%
+              red: 0%
+              green: 100%
+              blue: 0%
+              flash_length: 500ms
+    - if:
+        condition:
+          switch.is_on: buzzer_enabled
+        then:
+          - rtttl.play: "success:d=24,o=5,b=100:c,g,b"
+    - homeassistant.tag_scanned: !lambda return x;
+  # Raw tag record for the OpenPrintTag integration (randybb/ha-openprinttag)
+  on_openprinttag:
+    - homeassistant.event:
+        event: esphome.openprinttag
+        data:
+          uid: !lambda return uid;
+          payload: !lambda return payload;
+  on_tag_removed:
+    - homeassistant.event:
+        event: esphome.openprinttag
+        data:
+          uid: !lambda return x;
+          payload: ""
+    - if:
+        condition:
+          switch.is_on: buzzer_enabled
+        then:
+          - rtttl.play: "removed:d=16,o=5,b=100:b"
+
+sensor:
+  - platform: pn5180
+    type: remaining_weight
+    name: Remaining weight
+  - platform: pn5180
+    type: consumed_weight
+    name: Consumed weight
+  - platform: pn5180
+    type: actual_weight
+    name: Full weight
+  - platform: pn5180
+    type: min_print_temperature
+    name: Min print temperature
+  - platform: pn5180
+    type: max_print_temperature
+    name: Max print temperature
+  - platform: pn5180
+    type: max_bed_temperature
+    name: Max bed temperature
+  - platform: pn5180
+    type: drying_temperature
+    name: Drying temperature
+  - platform: pn5180
+    type: drying_time
+    name: Drying time
+
+text_sensor:
+  - platform: pn5180
+    type: uid
+    name: Tag UID
+  - platform: pn5180
+    type: material_type
+    name: Material
+  - platform: pn5180
+    type: material_name
+    name: Material name
+  - platform: pn5180
+    type: brand_name
+    name: Brand
+  - platform: pn5180
+    type: primary_color
+    name: Color
+    # Mirrored to the filament_color light, empty = no tag
+    on_value:
+      - lambda: |-
+          if (x.size() < 7) {
+            id(filament_color).turn_off().set_transition_length(0).perform();
+            return;
+          }
+          uint32_t c = strtoul(x.c_str() + 1, nullptr, 16);
+          if (x.size() > 7)
+            c >>= 8;  // #rrggbbaa
+          // ESPHome scales the strongest channel to 100 %, the darkness goes to the brightness
+          const float r = ((c >> 16) & 0xFF) / 255.0f, g = ((c >> 8) & 0xFF) / 255.0f, b = (c & 0xFF) / 255.0f;
+          const float m = std::max({r, g, b});
+          if (m == 0.0f) {
+            id(filament_color).turn_off().set_transition_length(0).perform();  // black
+            return;
+          }
+          id(filament_color).turn_on()
+              .set_rgb(r, g, b)
+              .set_brightness(m)
+              .set_transition_length(0)
+              .perform();
+
+light:
+  # Onboard RGB for now: tag feedback and status. With the external LED fitted, move
+  # notify_led to pin 3 and give the onboard one back to status_led (as on mcu-rfid-reader)
+  - platform: esp32_rmt_led_strip
+    id: notify_led
+    name: Notify LED
+    channel_colors: GRB
+    pin: 21
+    num_leds: 1
+    chipset: ws2812
+    restore_mode: ALWAYS_OFF
+    rmt_symbols: 96
+
+  # Shows the filament color in Home Assistant; drives nothing, the next tag read overwrites it
+  - platform: rgb
+    id: filament_color
+    name: Filament color
+    icon: mdi:printer-3d-nozzle
+    red: color_none
+    green: color_none
+    blue: color_none
+    restore_mode: ALWAYS_OFF
+    default_transition_length: 0s
+
+output:
+  - platform: ledc
+    pin: 4
+    id: buzzer
+  - platform: template
+    id: color_none
+    type: float
+    write_action: []
+
+rtttl:
+  output: buzzer
+
+switch:
+  - platform: template
+    name: Buzzer Enabled
+    id: buzzer_enabled
+    icon: mdi:volume-high
+    optimistic: true
+    restore_mode: RESTORE_DEFAULT_ON
+    entity_category: config
+  - platform: template
+    name: LED enabled
+    id: led_enabled
+    icon: mdi:alarm-light-outline
+    optimistic: true
+    restore_mode: RESTORE_DEFAULT_ON
+    entity_category: config

mcu-rfid-reader.yaml

@@ -28,7 +28,7 @@ esphome:
   #   - wait_until:
   #       api.connected:
   #   - logger.log: API is connected!
-  #   - rtttl.play: "success:d=24,o=5,b=100:c,g,b"
+  #   - rtttl.play: "success:d=32,o=5,b=100:c,g,b"
   #   - light.turn_on:
   #       id: notify_led
   #       brightness: 100%
@@ -91,13 +91,13 @@ api:
         uri += tag_id;
         message->add_uri_record(uri);
         id(pn532_module).write_mode(message);
-    - rtttl.play: "write:d=24,o=5,b=100:b"
+    - rtttl.play: "write:d=32,o=5,b=100:b"
     - wait_until:
         not:
           pn532.is_writing:
     - light.turn_off:
         id: notify_led
-    - rtttl.play: "write:d=24,o=5,b=100:b,b"
+    - rtttl.play: "write:d=32,o=5,b=100:b,b"
 
   - action: write_music_tag
     variables:
@@ -123,13 +123,13 @@ api:
           message->add_text_record(text);
         }
         id(pn532_module).write_mode(message);
-    - rtttl.play: "write:d=24,o=5,b=100:b"
+    - rtttl.play: "write:d=32,o=5,b=100:b"
     - wait_until:
         not:
           pn532.is_writing:
     - light.turn_off:
         id: notify_led
-    - rtttl.play: "write:d=24,o=5,b=100:b,b"
+    - rtttl.play: "write:d=32,o=5,b=100:b,b"
 
 globals:
   - id: source
@@ -271,7 +271,7 @@ pn532_i2c:
         condition:
           switch.is_on: buzzer_enabled
         then:
-        - rtttl.play: "success:d=24,o=5,b=100:c,g,b"
+        - rtttl.play: "success:d=32,o=5,b=100:c,g,b"
   on_tag_removed:
     then:
     - homeassistant.event:
@@ -313,13 +313,13 @@ button:
           message->add_uri_record(uri);
           ESP_LOGD("tagreader", "Writing payload: %s", uri.c_str());
           id(pn532_module).write_mode(message);
-      - rtttl.play: "write:d=24,o=5,b=100:b"
+      - rtttl.play: "write:d=32,o=5,b=100:b"
       - wait_until:
           not:
             pn532.is_writing:
       - light.turn_off:
           id: notify_led
-      - rtttl.play: "write:d=24,o=5,b=100:b,b"
+      - rtttl.play: "write:d=32,o=5,b=100:b,b"
   - platform: template
     name: Clean Tag
     id: clean_tag
@@ -333,13 +333,13 @@ button:
           green: 64.7%
           blue: 0%
       - lambda: 'id(pn532_module).clean_mode();'
-      - rtttl.play: "write:d=24,o=5,b=100:b"
+      - rtttl.play: "write:d=32,o=5,b=100:b"
       - wait_until:
           not:
             pn532.is_writing:
       - light.turn_off:
           id: notify_led
-      - rtttl.play: "write:d=24,o=5,b=100:b,b"
+      - rtttl.play: "write:d=32,o=5,b=100:b,b"
   - platform: template
     name: Cancel writing
     id: cancel_writing
@@ -349,7 +349,7 @@ button:
       - lambda: 'id(pn532_module).read_mode();'
       - light.turn_off:
           id: notify_led
-      - rtttl.play: "write:d=24,o=5,b=100:b,b"
+      - rtttl.play: "write:d=32,o=5,b=100:b,b"
 
 light:
   - platform: esp32_rmt_led_strip