Yalton / Arden

Voice assistant written in python

Arden

Arden - Raspberry Pi Voice Assistant

A versatile voice assistant designed to run on a Raspberry Pi, offering a wide range of features and integrations.
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact
8. Acknowledgments

About The Project

Arden is a versatile voice assistant designed to run on a Raspberry Pi. It offers a wide range of features and integrations, making it a powerful tool for everyday use.

(back to top)

Built With

• 

(back to top)

Getting Started

Clone the repository to your local system

Prerequisites

You will require some local system packages to make the script function properly

• apt

  apt install portaudio19-dev espeak mpg123 libasound2-dev flac at

Installation

1. Get a free API Key at https://example.com
2. Clone the repo

   git clone https://github.com/Yalton/Arden.git

3. Install NPM packages

   pip install -r requirements.txt

4. Enter your API keys in config.ini

   [API_KEYS]
    OpenWeatherMap = API_KEY
    OpenAI = API_KEY
   

(back to top)

Roadmap

• Get news updates by integrating with a news API, such as NewsAPI, to fetch and read the latest headlines or news articles based on your interests or preferred sources.
• Connect to your calendar (e.g., Google Calendar) to read, create, or modify events.
• Integrate with a music or podcast service to play tracks based on your preferences or requests.
• Connect to an email service (e.g., Gmail) or messaging platform to send emails or messages on your behalf.
• Control smart home devices by integrating with their respective APIs, allowing you to control things like lights, thermostats, or door locks.
• Access currency conversion rates or stock market updates by integrating with a financial API.
• Translate text between languages using a translation API.

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

Contact

Dalton Bailey - @yalt7117 - [e-mail]

Project Link: https://github.com/Yalton/Arden

(back to top)

Acknowledgments

• HomeAssistantDocs

(back to top)