libs/hat: Add Speaker/Speaker2 Hat support.

Signed-off-by: lbuque <[email protected]>

Author: lbuque

docs/en/hats/index.rst

@@ -21,6 +21,7 @@ HAT
     pir.rst
     servo.rst
     servo8.rst
+    speaker.rst
     thermal.rst
     tof.rst
     vibrator.rst

docs/en/hats/speaker.rst

@@ -0,0 +1,65 @@
+Speaker Hat
+===========
+
+.. sku: U055
+
+.. include:: ../refs/hat.speaker.ref
+
+The following products are supported:
+
+    |Speaker Hat|
+
+Below is the detailed support for Speaker on the host:
+
+.. table::
+    :widths: auto
+    :align: center
+
+    +-----------------+-------------------+
+    |Controller       | Atomic Echo Base  |
+    +=================+===================+
+    | CoreInk         | |S|               |
+    +-----------------+-------------------+
+    | StickC          | |S|               |
+    +-----------------+-------------------+
+    | StickC PLUS     | |S|               |
+    +-----------------+-------------------+
+    | StickC PLUS2    | |S|               |
+    +-----------------+-------------------+
+
+.. |S| unicode:: U+2705
+.. |N| unicode:: U+274C
+
+Micropython Example:
+
+    .. literalinclude:: ../../../examples/hat/speaker/stickc_plus2_speaker_example.py
+        :language: python
+        :linenos:
+
+
+UIFLOW2 Example:
+
+    |example.png|
+
+
+.. only:: builder_html
+
+    |stickc_plus2_speaker_example.m5f2|
+
+    :download:`poweron_2_5s.wav <../../../examples/hardware/speaker/poweron_2_5s.wav>`
+
+class SpeakerHat
+----------------
+
+Constructors
+------------
+
+.. class:: SpeakerHat(*args, **kwargs)
+
+    Create an SpeakerHat object.
+
+    UIFLOW2:
+
+        |init.png|
+
+    SpeakerHat class inherits M5.Speaker class, See :ref:`hardware.Speaker.Methods <hardware.Speaker.Methods>` for more details.

docs/en/refs/hat.speaker.ref

@@ -0,0 +1,18 @@
+
+.. |Speaker Hat| image:: https://static-cdn.m5stack.com/resource/docs/products/hat/hat-spk/hat-spk_01.webp
+    :target: https://docs.m5stack.com/en/hat/hat-spk
+    :height: 200px
+    :width: 200px
+
+.. |init.png| image:: https://static-cdn.m5stack.com/mpy_docs/hat/speaker/init.png
+
+.. |example.png| image:: https://static-cdn.m5stack.com/mpy_docs/hat/speaker/example.png
+
+.. |stickc_plus2_speaker_example.m5f2| raw:: html
+
+    <a
+        href="https://uiflow2.m5stack.com/?example=https://raw.githubusercontent.com/m5stack/uiflow-micropython/examples/base/speaker/atoms3r_speaker_example.m5f2"
+        target="_blank"
+    >
+        stickc_plus2_speaker_example.m5f2
+    </a>

examples/hat/speaker/stickc_plus2_speaker_example.m5f2

@@ -0,0 +1 @@
+{"version":"V2.0","versionNumber":"V2.2.0","type":"stickc-plus2","components":[{"name":"screen","type":"screen","layer":0,"screenId":"builtin","screenName":"","id":"__stickc-plus2_screen","createTime":1736390749863,"x":0,"y":0,"width":135,"height":240,"backgroundColor":"#000000","size":0,"isSelected":true}],"resources":[{"hardware":["hardware_button","hardware_pin_button","imu","speaker","ir"]},{"hat":["hat_spk"]}],"units":[],"hats":[{"type":"hat_spk","name":"hat_spk_0","id":"j7DlK=`NEI45Rmmr","createTime":1736390757035,"portList":["HAT"],"portType":"HAT","initBlockType":"hat_spk_init","initBlockId":"`7.vspFa/g)ZQAI1EVxz"}],"bases":[],"i2cs":[],"blockly":"<block type=\"basic_on_setup\" id=\"setup_block\" deletable=\"false\" x=\"-170\" y=\"-90\"><mutation isBegin=\"true\"></mutation><field name=\"UPDATEOP\">true</field><statement name=\"FUNC\"><block type=\"system_m5_begin\" id=\"system_m5_begin\"><next><block type=\"hat_spk_init\" id=\"`7.vspFa/g)ZQAI1EVxz\"><field name=\"NAME\">hat_spk_0</field><next><block type=\"hat_spk_set_volume_percentage\" id=\"5Fp+Plvq#9V:lPCVqz@j\"><field name=\"NAME\">hat_spk_0</field><value name=\"VALUE\"><shadow type=\"math_slider\" id=\"jSeye/=aa0`R9YU!jD=3\"><mutation max=\"100\" min=\"0\" step=\"1\" precision=\"1\"></mutation><field name=\"NUM\">100</field></shadow></value><next><block type=\"hat_spk_tone\" id=\"5S+U4sp_=83Hhsx65Tzx\"><field name=\"NAME\">hat_spk_0</field><value name=\"FREQ\"><shadow type=\"math_number\" id=\"F1B36q49G:Vfq+9E@Eut\"><mutation max=\"Infinity\" min=\"0\" precision=\"0\"></mutation><field name=\"NUM\">2000</field></shadow></value><value name=\"MS\"><shadow type=\"math_number\" id=\"^1UC-%)e.dyj[jk(Qm8_\"><mutation max=\"Infinity\" min=\"0\" precision=\"0\"></mutation><field name=\"NUM\">100</field></shadow></value><next><block type=\"hat_spk_playwav_file\" id=\"bCS.|h*EqIHg).AuYyVU\"><field name=\"NAME\">hat_spk_0</field><field name=\"TYPE\">flash</field><value name=\"FILE\"><shadow type=\"text\" id=\"irIM-MGAPBA$zaWhkM;k\"><field name=\"TEXT\">poweron_2_5s.wav</field></shadow></value></block></next></block></next></block></next></block></next></block></statement></block><block type=\"basic_on_loop\" id=\"loop_block\" deletable=\"false\" x=\"-170\" y=\"190\"><mutation isUpdate=\"true\"></mutation><field name=\"UPDATEOP\">true</field><statement name=\"FUNC\"><block type=\"system_m5_update\" id=\"system_m5_update\"></block></statement></block>","screen":[{"simulationName":"Built-in","type":"builtin","width":135,"height":240,"scale":0.92,"screenName":"","blockId":"","screenColorType":0,"id":"builtin","createTime":1736390749863}],"logicWhenNum":0,"customList":[]}

examples/hat/speaker/stickc_plus2_speaker_example.py

@@ -0,0 +1,40 @@
+# SPDX-FileCopyrightText: 2024 M5Stack Technology CO LTD
+#
+# SPDX-License-Identifier: MIT
+
+import os, sys, io
+import M5
+from M5 import *
+from hat import SpeakerHat
+
+
+hat_spk_0 = None
+
+
+def setup():
+    global hat_spk_0
+
+    M5.begin()
+    hat_spk_0 = SpeakerHat((26, 0))
+    hat_spk_0.setVolumePercentage(1)
+    hat_spk_0.tone(2000, 100)
+    hat_spk_0.playWavFile("/flash/res/audio/poweron_2_5s.wav")
+
+
+def loop():
+    global hat_spk_0
+    M5.update()
+
+
+if __name__ == "__main__":
+    try:
+        setup()
+        while True:
+            loop()
+    except (Exception, KeyboardInterrupt) as e:
+        try:
+            from utility import print_error_msg
+
+            print_error_msg(e)
+        except ImportError:
+            print("please update to latest firmware")

m5stack/libs/hat/__init__.py

@@ -21,6 +21,8 @@
     "RS485Hat": "rs485",
     "ServoHat": "servo",
     "Servos8Hat": "servo8",
+    "SpeakerHat": "speaker",
+    "Speaker2Hat": "speaker2",
     "ThermalHat": "thermal",
     "ToFHat": "tof",
     "VibratorHat": "vibrator",

m5stack/libs/hat/manifest.py

@@ -24,6 +24,8 @@
         "rs485.py",
         "servo.py",
         "servo8.py",
+        "speaker.py",
+        "speaker2.py",
         "thermal.py",
         "tof.py",
         "vibrator.py",

m5stack/libs/hat/speaker.py

@@ -0,0 +1,20 @@
+import M5
+import machine
+
+
+class SpeakerHat:
+    _en_pin = {
+        M5.BOARD.M5StickC: 0,
+        M5.BOARD.M5StickCPlus: 0,
+        M5.BOARD.M5StickCPlus2: 0,
+        M5.BOARD.M5StackCoreInk: 25,
+    }
+
+    def __new__(cls, *args, **kwargs):
+        spk = M5.createSpeaker()
+        pin_en = machine.Pin(cls._en_pin.get(M5.getBoard()), machine.Pin.OUT)
+        pin_en(1)
+        spk.config(pin_data_out=26, use_dac=True, buzzer=False, magnification=32)
+        spk.begin()
+        spk.setVolume(80)
+        return spk

m5stack/libs/hat/speaker2.py

@@ -0,0 +1,27 @@
+import M5
+
+
+class Speaker2Hat:
+    def __new__(cls):
+        spk = M5.createSpeaker()
+        spk.config(
+            pin_data_out=25,
+            pin_bck=26,
+            pin_ws=0,
+            sample_rate=48000,
+            stereo=False,
+            buzzer=False,
+            use_dac=False,
+            dac_zero_level=0,
+            magnification=16,
+            dma_buf_len=256,
+            dma_buf_count=8,
+            task_priority=2,
+            task_pinned_core=255,
+            i2s_port=1,
+        )
+        M5.Speaker.end()
+        M5.Mic.end()
+        spk.begin()
+        spk.setVolume(50)
+        return spk