Tiresias Firmware

Source code and associated files for the firmware used in the Tiresias project

☕️ Introduction

Welcome to the Tiresias Firmware repository! This repository contains the source code and associated files for the firmware used in the Tiresias project, a Brazilian research initiative conducted at EESC-USP by MSc students. The goal of the Tiresias project is to develop a free and open-source national technology for hearing aid applications using off-the-shelf components.

The firmware is designed for the Nordic Semiconductor's nRF5340 SoC, running the Zephyr RTOS, and integrating the Analog Devices' ADAU1787 audio codec.

📚 Project Overview

About the Tiresias Project

The Tiresias project is an innovative effort to create an open-source and accessible hearing aid solution tailored to the needs of the Brazilian population. Our aim is to reduce dependency on expensive proprietary technologies by leveraging widely available components and state-of-the-art design practices.

Key Features

Connectivity: Utilizes the Nordic nRF5340 SoC for Bluetooth Low Energy (BLE) communication, ensuring seamless wireless connectivity.
Audio Processing: Integrates the Analog Devices ADAU1787 Audio Codec for high-quality audio processing, essential for effective hearing aid functionality.
Open-Source: All code and design files are open-source, allowing for community collaboration and transparency in the development process.

🗂️ Repository Structure

The repository is structured as follows:

tiresias-fw/
├── docs/                   # Documentation files
├── src/                    # Source code for the firmware
│   ├── main.c              # Main application code
│   ├── drivers/            # Drivers and utilities
│   ├── modules/            # Modules and utilities
│   └── SigmaStudioFiles/   # Automatically generated files from the SigmaStudio software
├── CMakeLists.txt          # CMake build system configuration
└── README.md               # This README file

🛠️ Getting Started

Hardware overview

The project uses a nRF5340 SoC from Nordic Semiconductors. It contains an application proccessor for handling the main functions and a dedicated network processor for handling Bluetooth Low Energy (BLE) connectivity.

For digital audio processing, the ADAU1787 Audio Codec from Analog Devices provides speed and efficiency with its SigmaDSP audio processing core and FastDSP audio processing engine.

The ADAU1787 is controlled via I2C by the nRF5340, which also handles BLE connection for wirelles operation.

Firmware overview

TODO: finish the firmware overview section

The nRF5340 SoC runs the Zephyr RTOS...

The program for the ADAU1787 is built using the SigmaStudio software provided by Analog Devices. It allows the DSP to be graphically programmed and have its program exported as a header file for loading via I2C.

📝 License

This project is licensed under the MIT License - see the LICENSE file for details.

📮 Acknowledgments

EESC-USP: For providing the infrastructure and support for this research.
Nordic Semiconductor: For providing the nRF5340 Audio Development Kits (DK) used in this project and extensive support.
Analog Devices: For providing the ADAU1787 codec used in this project and extensive support.