Skip to content

Latest commit

 

History

History
34 lines (26 loc) · 1.44 KB

README.md

File metadata and controls

34 lines (26 loc) · 1.44 KB

Time Speaker Project

This project is a simple script that announces the current time in a conversational manner using text-to-speech synthesis. It's designed to run on a Unix-like operating system with the shell.

Requirements

  • Unix-like operating system
  • zsh or bash shell
  • Piper text-to-speech tool
  • SoX sound processing tool

Installation

  • Install the required tools: Piper and SoX.
  • Download the suitable piper voices from here (both voice model and the config) to the directory.
  • Update the piper_path variable in the script with the path to your Piper installation.

Usage

Run the script with the absolute path to the script directory as an argument. If no argument is provided, the current directory is used as the absolute path to the script directory.

./speak_time.sh [/absolute/path/to/script/directory]

Note: The absolute path to script directory argument is only needed if you run this script via a cronjob.

How it works

The script performs the following steps:

  1. Retrieves the current time and converts it to 12-hour and 24-hour formats.
  2. Determines the part of the day (morning, afternoon, evening, or night).
  3. Format the time in a colloquial expression.
  4. Synthesizes the text-to-speech audio using Piper and the pre-trained model.
  5. Plays the audio using SoX.

License

This project is open-source and licensed under the MIT License.