libs/base: Add Speaker Base support.

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

Author: lbuque

docs/en/base/index.rst

@@ -8,3 +8,4 @@ Base
     atom_socket.rst
     echo.rst
     motion.rst
+    speaker.rst

docs/en/base/speaker.rst

@@ -0,0 +1,126 @@
+Atomic Speaker Base
+===================
+
+.. sku: A098
+
+.. include:: ../refs/base.speaker.ref
+
+The following products are supported:
+
+    |Atomic Speaker Base|
+
+Below is the detailed support for Speaker on the host:
+
+.. table::
+    :widths: auto
+    :align: center
+
+    +-----------------+---------+---------+
+    |Controller       | NS4168  | SDCard  |
+    +=================+=========+=========+
+    | Atom Echo       | |O|     | |O|     |
+    +-----------------+---------+---------+
+    | Atom Lite       | |S|     | |S|     |
+    +-----------------+---------+---------+
+    | Atom Matrix     | |O|     | |S|     |
+    +-----------------+---------+---------+
+    | AtomS3          | |O|     | |S|     |
+    +-----------------+---------+---------+
+    | AtomS3 Lite     | |S|     | |S|     |
+    +-----------------+---------+---------+
+    | AtomS3R         | |S|     | |S|     |
+    +-----------------+---------+---------+
+    | AtomS3R-CAM     | |S|     | |S|     |
+    +-----------------+---------+---------+
+    | AtomS3R-Ext     | |S|     | |S|     |
+    +-----------------+---------+---------+
+
+.. |S| unicode:: U+2705
+.. |O| unicode:: U+2B55
+
+|S|: Supported.
+
+|O|: Optional, It conflicts with some internal resource of the host.
+
+
+Micropython Example:
+
+    .. literalinclude:: ../../../examples/base/speaker/atoms3_speaker_example.py
+        :language: python
+        :linenos:
+
+
+UIFLOW2 Example:
+
+    |example.png|
+
+
+.. only:: builder_html
+
+    |atoms3_speaker_example.m5f2|
+
+
+class ATOMEchoBase
+------------------
+
+Constructors
+------------
+
+.. class:: SpeakerBase(_id, sck, ws, sd)
+
+    Create an SpeakerBase object.
+
+    :param int _id: The I2S port number.
+    :param int sck: The I2S SCK pin.
+    :param int ws: The I2S WS pin.
+    :param int sd: The I2S DI pin.
+
+    UIFLOW2:
+
+        |SpeakerBase.png|
+
+    Micropython::
+
+        from base import SpeakerBase
+
+        # atoms3 lite / atoms3 / atoms3r / atoms3r-cam / atoms3-ext
+        spk = SpeakerBase(1, 5, 39, 38)
+
+        # atom lite / atom matrix / atom echo
+        spk = SpeakerBase(1, 22, 21, 25)
+
+    SpeakerBase class inherits M5.Speaker class, See :ref:`hardware.Speaker.Methods <hardware.Speaker.Methods>` for more details.
+
+
+class SDCard
+------------
+
+Constructors
+------------
+
+.. class:: SDCard(slot=2, width=1, sck=None, miso=None, mosi=None, cs=None, freq=20000000)
+
+    Create an SDCard object.
+
+    :param int slot: The slot number of the SD card. Default is 2.
+    :param int width: width selects the bus width for the SD/MMC interface.
+    :param int sck: sck can be used to specify an SPI clock pin.
+    :param int miso: miso can be used to specify an SPI miso pin.
+    :param int mosi: mosi can be used to specify an SPI mosi pin.
+    :param int cs: cs can be used to specify an SPI chip select pin.
+    :param int freq: freq selects the SD/MMC interface frequency in Hz.
+
+    UIFLOW2:
+
+        |SDCard.png|
+
+    Micropython::
+
+        from hardware import sdcard
+
+        # atoms lite / atom martrix / atom echo: SPI2
+        sd = sdcard.SDCard(slot=3, width=1, sck=23, miso=33, mosi=19, cs=None, freq=20000000)
+
+        # atoms3 / atoms3 lite / atoms3r / atoms3r-cam / atoms3-ext: SPI2
+        sd = SDCard(slot=3, width=1, sck=7, miso=8, mosi=6, cs=None, freq=20000000)
+

docs/en/module/gpsv2.rst

@@ -27,7 +27,7 @@ UIFLOW2 Example:
     |gpsv2_core2_example.m5f2|
 
 class GPSV2Module
-----------------
+-----------------
 
 Constructors
 ------------

docs/en/refs/base.speaker.ref

@@ -0,0 +1,20 @@
+
+.. |Atomic Speaker Base| image:: https://static-cdn.m5stack.com/resource/docs/products/atom/Atomic%20SPK%20Base/img-f5cdbea1-3dac-4d19-90be-949fb4d0f859.webp
+    :target: https://docs.m5stack.com/en/atom/Atomic%20SPK%20Base
+    :height: 200px
+    :width: 200px
+
+.. |SpeakerBase.png| image:: https://static-cdn.m5stack.com/mpy_docs/base/speaker/init.png
+
+.. |example.png| image:: https://static-cdn.m5stack.com/mpy_docs/base/speaker/example.png
+
+.. |SDCard.png| image:: https://static-cdn.m5stack.com/mpy_docs/base/speaker/sdcard_init.png
+
+.. |atoms3_speaker_example.m5f2| raw:: html
+
+    <a
+        href="https://uiflow2.m5stack.com/?example=https://raw.githubusercontent.com/m5stack/uiflow-micropython/examples/base/speaker/atoms3_speaker_example.m5f2"
+        target="_blank"
+    >
+        atoms3_speaker_example.m5f2
+    </a>

examples/base/speaker/atoms3_speaker_example.m5f2

@@ -0,0 +1 @@
+{"version":"V2.0","versionNumber":"V2.2.1","type":"atoms3","components":[{"name":"screen","type":"screen","layer":0,"screenId":"builtin","screenName":"","id":"__atoms3_screen","createTime":1737084553743,"x":0,"y":0,"width":128,"height":128,"backgroundColor":"#000000","size":0,"isSelected":true}],"resources":[{"hardware":["hardware_button","hardware_pin_button","imu","ir","i2c"]},{"base":["base_spk"]}],"units":[],"hats":[],"bases":[{"type":"base_spk","name":"base_spk","id":"xSb2_fCmI7wD0DB+","createTime":1737085696901,"initBlockType":"base_spk_init"}],"i2cs":[{"id":"i2c1","portType":"base","userPort":[22,21],"freq":"100000","blockId":"*s+UDC|ce#xZ2`(CF4;8"}],"blockly":"<block type=\"basic_on_setup\" id=\"setup_block\" deletable=\"false\" x=\"50\" y=\"51\"><mutation isBegin=\"true\"></mutation><field name=\"UPDATEOP\">true</field><statement name=\"FUNC\"><block type=\"system_m5_begin\" id=\"system_m5_begin\"><next><block type=\"base_spk_init\" id=\"lHHoF;~Y_b1v|}1%q@e4\"><value name=\"ID\"><shadow type=\"base_spk_id_option\" id=\"`)BS3Opz)?mQUy^(tJV0\"><field name=\"VALUE\">1</field></shadow></value><value name=\"SCK\"><shadow type=\"math_number\" id=\"Ir]r_S~.#~A1/Ml6CS1x\"><mutation max=\"Infinity\" min=\"-Infinity\" precision=\"0\"></mutation><field name=\"NUM\">5</field></shadow></value><value name=\"WS\"><shadow type=\"math_number\" id=\"V[nUYzSkAJ?7m*x`:3Tl\"><mutation max=\"Infinity\" min=\"-Infinity\" precision=\"0\"></mutation><field name=\"NUM\">39</field></shadow></value><value name=\"SD\"><shadow type=\"math_number\" id=\"5U$R;VPgjTDb8FJWYUbf\"><mutation max=\"Infinity\" min=\"-Infinity\" precision=\"0\"></mutation><field name=\"NUM\">38</field></shadow></value><next><block type=\"base_spk_sdcard_init\" id=\"8-7clW6`hIKL[[0F/L?p\"><value name=\"SLOT\"><shadow type=\"base_spk_sdcard_init_slot_option\" id=\"G]R~N@,WX24kZypwR(1O\"><field name=\"VALUE\">3</field></shadow></value><value name=\"SCK\"><shadow type=\"math_number\" id=\"3EIFsyE6qGYEo|xozIj/\"><mutation max=\"Infinity\" min=\"-Infinity\" precision=\"0\"></mutation><field name=\"NUM\">7</field></shadow></value><value name=\"MISO\"><shadow type=\"math_number\" id=\"r22[m)p]QN5V`oUye7O^\"><mutation max=\"Infinity\" min=\"-Infinity\" precision=\"0\"></mutation><field name=\"NUM\">8</field></shadow></value><value name=\"MOSI\"><shadow type=\"math_number\" id=\"Ycf_|SWOn%+z)5]Bac}B\"><mutation max=\"Infinity\" min=\"-Infinity\" precision=\"0\"></mutation><field name=\"NUM\">6</field></shadow></value><value name=\"CS\"><shadow type=\"math_number\" id=\".fuMNNsv5irNI|h?SGz+\"><mutation max=\"Infinity\" min=\"-Infinity\" precision=\"0\"></mutation><field name=\"NUM\">-1</field></shadow></value><value name=\"FREQ\"><shadow type=\"base_spk_sdcard_init_freq_option\" id=\"M!kL+J@7]YxiQb3BU1{$\"><field name=\"VALUE\">20000000</field></shadow></value><next><block type=\"base_spk_playwav_file\" id=\"TI/NFc3`UUk6[$Fp[hZA\"><field name=\"TYPE\">flash</field><value name=\"FILE\"><shadow type=\"text\" id=\"wkz`Gw@czy=B^G1M~)}u\"><field name=\"TEXT\">66.wav</field></shadow></value><next><block type=\"base_spk_playwav_file\" id=\"]L}-Ua4/xCbFT`yV__1F\"><field name=\"TYPE\">sd</field><value name=\"FILE\"><shadow type=\"text\" id=\"]kFkRCeU;%.KjHJ76Jiv\"><field name=\"TEXT\">66.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=\"450\" y=\"50\"><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":128,"height":128,"scale":1.3,"screenName":"","blockId":"","screenColorType":0,"id":"builtin","createTime":1737084553743}],"logicWhenNum":0,"customList":[]}

examples/base/speaker/atoms3_speaker_example.py

@@ -0,0 +1,41 @@
+# SPDX-FileCopyrightText: 2024 M5Stack Technology CO LTD
+#
+# SPDX-License-Identifier: MIT
+
+import os, sys, io
+import M5
+from M5 import *
+from base import SpeakerBase
+from hardware import sdcard
+
+
+base_spk = None
+
+
+def setup():
+    global base_spk
+
+    M5.begin()
+    base_spk = SpeakerBase(1, 5, 39, 38)
+    sdcard.SDCard(slot=3, width=1, sck=7, miso=8, mosi=6, cs=None, freq=20000000)
+    base_spk.playWavFile("/flash/res/audio/66.wav")
+    base_spk.playWavFile("/sd/66.wav")
+
+
+def loop():
+    global base_spk
+    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/base/__init__.py

@@ -8,6 +8,7 @@
     "ATOMEchoBase": "echo",
     "Motion": "motion",
     "MotionBase": "motion",
+    "SpeakerBase": "speaker",
 }
 
 

m5stack/libs/base/manifest.py

@@ -9,6 +9,7 @@
         "atom_socket.py",
         "echo.py",
         "motion.py",
+        "speaker.py",
     ),
     base_path="..",
     opt=3,

m5stack/libs/base/speaker.py

@@ -0,0 +1,32 @@
+import M5
+
+
+class SpeakerBase:
+    _instance = None
+
+    def __new__(cls, _id, sck, ws, sd):
+        if cls._instance:
+            cls._instance.end()
+
+        if cls._instance is None:
+            cls._instance = M5.createSpeaker()
+
+        cls._instance.config(
+            pin_data_out=sd,
+            pin_bck=sck,
+            pin_ws=ws,
+            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=_id,
+        )
+        cls._instance.begin()
+        cls._instance.setVolume(80)
+        return cls._instance