Date
1-SEP-2020
Release Summary
This is v1.0.0 of the Call Attendant (__callattendant__) . This is the first stable/production release and it includes all of the functionality planned for the system.
- A call blocker that intercepts robocallers and blocked numbers at or before the first ring
- Allows permitted numbers pass straight through to the local phone system for normal call ringing and answering
- Visual indicators (LEDs) show whether the incoming call is from a permitted, blocked or unknown number
- Call history, permitted and blocked numbers, and voice messages are available in a web-based user interface
- Calls can be handled by a voice messaging system that optionally requires human interaction, e.g, "Press 1 to leave a message"
Associated GitHub Issues
Description | Type | Issue
------------- | ------ | -----------
Package and make installable via PyPi | epic | 37
Generate end-user documentation in the Wiki | enhancement | 43
Document LED Wiring | task | 89
Embellish configuration | task | 88
Web Interface Improvements | task | 87
Need to mock the Modem class/object | task |81
Known Issues
Description | Type | Issue
------------- | ------ | -----------
None.
User Facing Changes
- Installation has changed. The software is distributed by [PyPI](https://pypi.org/project/callattendant/) is now installed with `pip`.
- Data location has changed. The default location for data is now `~/.callattendant`, most likely expanded to `home/pi/.callattendant`
- Command line has changed. A system-wide command is provided: `callattendant [--config <cfg file>]`
Operation
Command Line Options
A new `callattendant` script is placed on the system path. Use this command to start the software without specifying "python".
text.
Usage: callattendant --config [FILE] --data-path [FOLDER]
Options:
-c, --config [FILE] load a python configuration file
-d, --data-path [FOLDER] path to data and configuration files
-f, --create-folder create the data-path folder if it does not exist
-h, --help displays this help text
Data Files
The location of the database and messages has changed from `[application folder]/data/` to `~/.callattendant`. This makes the data easier to locate and backup. You can override this location via the `--data-path` command line option.
If you are upgrading from an earlier release, you should move your database file and messages from the `data/ ` folder after starting and stopping the upgraded __callattendant__. Running the __callattendant__ with the `--create-folder` command line option will create the data folder and the initial data. Overwrite the new files with your existing files.
Configuration file
An example configuration is provided: [app.cfg.example](https://github.com/emxsys/callattendant/blob/master/callattendant/app.cfg.example). A copy of this file, named `app.cfg`, is placed in the data folder after the first execution of the software. You can copy/rename this file to match its purpose (e.g., `debug.cfg`) and edit it to match your preferences.
Documentation
See the project's Wiki pages:
- [User Guide](https://github.com/emxsys/callattendant/wiki/User-Guide)
- [Developer Guide](https://github.com/emxsys/callattendant/wiki/Developer-Guide)
Install/Update/Removal
Install/Update
`pip` is used to install and update the __callattendant__
bash
pip install callattendant
Removal
bash
pip uninstall callattendant