device

Docs/index.rst

@@ -0,0 +1,219 @@
+.. _xiao_ble:
+
+XIAO BLE (Sense)
+################
+
+Overview
+********
+
+The Seeed XIAO BLE (Sense) is a tiny (21 mm x 17.5 mm) Nordic Semiconductor
+nRF52840 ARM Cortex-M4F development board with onboard LEDs, USB port, QSPI
+flash, battery charger, and range of I/O broken out into 14 pins.
+
+.. figure:: img/xiao_ble.jpg
+     :align: center
+     :alt: XIAO BLE
+
+Hardware
+********
+
+- Nordic nRF52840 Cortex-M4F processor at 64MHz
+- 2MB QSPI Flash
+- RGB LED
+- USB Type-C Connector, nRF52840 acting as USB device
+- Battery charger BQ25101
+- Reset button
+- Bluetooth antenna
+- LSM6DS3TR-C 6D IMU (3D accelerometer and 3D gyroscope) (XIAO BLE Sense only)
+- PDM microphone (XIAO BLE Sense only)
+
+Supported Features
+==================
+
+The xiao_ble board configuration supports the following hardware features:
+
++-----------+------------+----------------------+
+| Interface | Controller | Driver/Component     |
++===========+============+======================+
+| ADC       | on-chip    | adc                  |
++-----------+------------+----------------------+
+| CLOCK     | on-chip    | clock_control        |
++-----------+------------+----------------------+
+| FLASH     | on-chip    | flash, QSPI flash    |
++-----------+------------+----------------------+
+| GPIO      | on-chip    | gpio                 |
++-----------+------------+----------------------+
+| I2C(M)    | on-chip    | i2c                  |
++-----------+------------+----------------------+
+| MPU       | on-chip    | arch/arm             |
++-----------+------------+----------------------+
+| NVIC      | on-chip    | arch/arm             |
++-----------+------------+----------------------+
+| PWM       | on-chip    | pwm                  |
++-----------+------------+----------------------+
+| RADIO     | on-chip    | Bluetooth,           |
+|           |            | ieee802154           |
++-----------+------------+----------------------+
+| RTC       | on-chip    | system clock         |
++-----------+------------+----------------------+
+| SPI(M/S)  | on-chip    | spi                  |
++-----------+------------+----------------------+
+| UART      | on-chip    | serial               |
++-----------+------------+----------------------+
+| USB       | on-chip    | usb                  |
++-----------+------------+----------------------+
+| WDT       | on-chip    | watchdog             |
++-----------+------------+----------------------+
+
+Other hardware features have not been enabled yet for this board.
+
+Connections and IOs
+===================
+
+The `XIAO BLE wiki`_ has detailed information about the board including
+`pinouts`_ and the `schematic`_.
+
+LED
+---
+
+* LED1 (red) = P0.26
+* LED2 (green) = P0.30
+* LED3 (blue) = P0.06
+
+Programming and Debugging
+*************************
+
+The XIAO BLE ships with the `Adafruit nRF52 Bootloader`_ which supports flashing
+using `UF2`_. Doing so allows easy flashing of new images, but does not support
+debugging the device. For debugging please use `External Debugger`_.
+
+UF2 Flashing
+============
+
+To enter the bootloader, connect the USB port of the XIAO BLE to your host, and
+double tap the reset botton to the left of the USB connector. A mass storage
+device named `XIAO BLE` should appear on the host. Using the command line, or
+your file manager copy the `zephyr/zephyr.uf2` file from your build to the base
+of the `XIAO BLE` mass storage device. The XIAO BLE will automatically reset
+and launch the newly flashed application.
+
+External Debugger
+=================
+
+In order to support debugging the device, instead of using the bootloader, you
+can use an :ref:`External Debug Probe <debug-probes>`. To flash and debug Zephyr
+applications you need to use `Seeeduino XIAO Expansion Board`_ or solder an SWD
+header onto the back side of the board.
+
+For Segger J-Link debug probes, follow the instructions in the
+:ref:`jlink-external-debug-probe` page to install and configure all the
+necessary software.
+
+Flashing
+--------
+
+Setup and connect a supported debug probe (JLink, instructions at :ref:`jlink-external-debug-probe` or
+BlackMagic Probe). Then build and flash applications as
+usual (see :ref:`build_an_application` and :ref:`application_run` for more
+details).
+
+Here is an example for the :ref:`hello_world` application.
+
+First, run your favorite terminal program to listen for output.
+
+.. code-block:: console
+
+   $ minicom -D <tty_device> -b 115200
+
+Replace :code:`<tty_device>` with the port where the board XIAO BLE
+can be found. For example, under Linux, :code:`/dev/ttyACM0`.
+
+Then build and flash the application in the usual way. Just add
+``CONFIG_BOOT_DELAY=5000`` to the configuration, so that USB CDC ACM is
+initialized before any text is printed, as below:
+
+.. tabs::
+
+   .. group-tab:: XIAO BLE
+
+      .. zephyr-app-commands::
+         :zephyr-app: samples/hello_world
+         :board: xiao_ble
+         :goals: build flash
+         :gen-args: -DCONFIG_BOOT_DELAY=5000
+
+   .. group-tab:: XIAO BLE Sense
+
+      .. zephyr-app-commands::
+         :zephyr-app: samples/hello_world
+         :board: xiao_ble/nrf52840/sense
+         :goals: build flash
+         :gen-args: -DCONFIG_BOOT_DELAY=5000
+
+Debugging
+---------
+
+Refer to the :ref:`jlink-external-debug-probe` page to learn about debugging
+boards with a Segger IC.
+
+Debugging using a BlackMagic Probe is also supported.
+
+Testing the LEDs in the XIAO BLE (Sense)
+****************************************
+
+There is a sample that allows to test that LEDs on the board are working
+properly with Zephyr:
+
+.. tabs::
+
+   .. group-tab:: XIAO BLE
+
+      .. zephyr-app-commands::
+         :zephyr-app: samples/basic/blinky
+         :board: xiao_ble
+         :goals: build flash
+
+   .. group-tab:: XIAO BLE Sense
+
+      .. zephyr-app-commands::
+         :zephyr-app: samples/basic/blinky
+         :board: xiao_ble/nrf52840/sense
+         :goals: build flash
+
+You can build and flash the examples to make sure Zephyr is running correctly on
+your board. The LED definitions can be found in
+:zephyr_file:`boards/seeed/xiao_ble/xiao_ble_common.dtsi`.
+
+Testing shell over USB in the XIAO BLE (Sense)
+**********************************************
+
+There is a sample that allows to test shell interface over USB CDC ACM interface
+with Zephyr:
+
+.. tabs::
+
+   .. group-tab:: XIAO BLE
+
+      .. zephyr-app-commands::
+         :zephyr-app: samples/subsys/shell/shell_module
+         :board: xiao_ble
+         :goals: build flash
+
+   .. group-tab:: XIAO BLE Sense
+
+      .. zephyr-app-commands::
+         :zephyr-app: samples/subsys/shell/shell_module
+         :board: xiao_ble/nrf52840/sense
+         :goals: build flash
+
+References
+**********
+
+.. target-notes::
+
+.. _XIAO BLE wiki: https://wiki.seeedstudio.com/XIAO_BLE/
+.. _pinouts: https://wiki.seeedstudio.com/XIAO_BLE/#hardware-overview
+.. _schematic: https://wiki.seeedstudio.com/XIAO_BLE/#resources
+.. _Seeeduino XIAO Expansion Board: https://wiki.seeedstudio.com/Seeeduino-XIAO-Expansion-Board/
+.. _Adafruit nRF52 Bootloader: https://github.com/adafruit/Adafruit_nRF52_Bootloader
+.. _UF2: https://github.com/microsoft/uf2

firmware/firmware_v1.0/src/lib/battery/battery.c → firmware/friend/firmware_v1.0/src/lib/battery/battery.c

@@ -14,6 +14,22 @@
  * limitations under the License.
  */
 
+/*
+ * Copyright 2024 Marcus Alexander Tjomsaas
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
 #include "battery.h"
 
 #include <zephyr/kernel.h>
@@ -257,3 +273,76 @@ int battery_init()
 
     return ret;
 }
+
+// New functions for speaker control
+#define GPIO_SPEAKER_PIN_15 15
+#define GPIO_SPEAKER_PIN_16 16
+#define GPIO_SPEAKER_PIN_17 17
+#define GPIO_SPEAKER_PIN_18 18
+#define GPIO_SPEAKER_PIN_19 19
+
+int speaker_init()
+{
+    int ret = 0;
+
+    if (!device_is_ready(gpio_battery_dev))
+    {
+        LOG_ERR("GPIO device not found!");
+        return -EIO;
+    }
+
+    ret |= gpio_pin_configure(gpio_battery_dev, GPIO_SPEAKER_PIN_15, GPIO_OUTPUT | GPIO_ACTIVE_HIGH);
+    ret |= gpio_pin_configure(gpio_battery_dev, GPIO_SPEAKER_PIN_16, GPIO_OUTPUT | GPIO_ACTIVE_HIGH);
+    ret |= gpio_pin_configure(gpio_battery_dev, GPIO_SPEAKER_PIN_17, GPIO_OUTPUT | GPIO_ACTIVE_HIGH);
+    ret |= gpio_pin_configure(gpio_battery_dev, GPIO_SPEAKER_PIN_18, GPIO_OUTPUT | GPIO_ACTIVE_HIGH);
+    ret |= gpio_pin_configure(gpio_battery_dev, GPIO_SPEAKER_PIN_19, GPIO_OUTPUT | GPIO_ACTIVE_HIGH);
+
+    if (ret)
+    {
+        LOG_ERR("Speaker GPIO configure failed!");
+        return ret;
+    }
+
+    LOG_INF("Speaker GPIO initialized");
+    return ret;
+}
+
+int speaker_on()
+{
+    int ret = 0;
+
+    ret |= gpio_pin_set(gpio_battery_dev, GPIO_SPEAKER_PIN_15, 1);
+    ret |= gpio_pin_set(gpio_battery_dev, GPIO_SPEAKER_PIN_16, 1);
+    ret |= gpio_pin_set(gpio_battery_dev, GPIO_SPEAKER_PIN_17, 1);
+    ret |= gpio_pin_set(gpio_battery_dev, GPIO_SPEAKER_PIN_18, 1);
+    ret |= gpio_pin_set(gpio_battery_dev, GPIO_SPEAKER_PIN_19, 1);
+
+    if (ret)
+    {
+        LOG_ERR("Failed to turn on speaker");
+        return ret;
+    }
+
+    LOG_INF("Speaker turned on");
+    return ret;
+}
+
+int speaker_off()
+{
+    int ret = 0;
+
+    ret |= gpio_pin_set(gpio_battery_dev, GPIO_SPEAKER_PIN_15, 0);
+    ret |= gpio_pin_set(gpio_battery_dev, GPIO_SPEAKER_PIN_16, 0);
+    ret |= gpio_pin_set(gpio_battery_dev, GPIO_SPEAKER_PIN_17, 0);
+    ret |= gpio_pin_set(gpio_battery_dev, GPIO_SPEAKER_PIN_18, 0);
+    ret |= gpio_pin_set(gpio_battery_dev, GPIO_SPEAKER_PIN_19, 0);
+
+    if (ret)
+    {
+        LOG_ERR("Failed to turn off speaker");
+        return ret;
+    }
+
+    LOG_INF("Speaker turned off");
+    return ret;
+}

firmware/firmware_v1.0/src/lib/battery/battery.h → firmware/friend/firmware_v1.0/src/lib/battery/battery.h

@@ -76,4 +76,25 @@ int battery_get_percentage(uint8_t *battery_percentage, uint16_t battery_millivo
  */
 int battery_init(void);
 
+/**
+ * @brief Initialize the speaker GPIO pins.
+ *
+ * @retval 0 if successful. Negative errno number on error.
+ */
+int speaker_init(void);
+
+/**
+ * @brief Turn on the speaker.
+ *
+ * @retval 0 if successful. Negative errno number on error.
+ */
+int speaker_on(void);
+
+/**
+ * @brief Turn off the speaker.
+ *
+ * @retval 0 if successful. Negative errno number on error.
+ */
+int speaker_off(void);
+
 #endif