Pyhacid

Python NCID client with Home Assistant support. Use HA REST API to announce CallerID

Getting Started

You will need an NCID server (AKA ncidd) setup and connected to your modem.

Prerequisites

Currently this project only works under Python 2, it fails silently on Python 3 due to an issue with the underlying socket library. This probably won't ever be fixed as it's not an issue for my use case. Just run it in Docker and put it out of mind.

You need docker installed, then you need to configure the following variables

NCID_HOST=127.0.0.1
NCID_PORT=3333

HA_URL=https://ha.example.com/api/
HA_TOKEN=your_token_here

ALEXA_ANNOUNCE=True
ALEXA_PUSH=True
ALEXA_TARGETS=media_player.kitchen,media_player.lounge

NOTIFY_SERVICES=lounge_tv

MESSAGE_TEMPLATE="{cid} is calling."
ALEXA_TITLE="Call on Home Phone"

You can get a token from the Home Assistant User Profile page under the section marked "Long lived tokens".

Installing

You have two options, run locally or run under Docker. Either way make sure you have setup the environment variables listed above, all are required bu ncid_host and ncid_port have reasonable defaults that should work in many situations.

To install locally run:

pipenv install -r requirements.txt
pipenv run python app.py

Or using docker:

docker run  -e NCID_HOST=127.0.0.1 -e NCID_PORT=3333 -e HA_URL=https://ha.example.com/api/ -e HA_TOKEN=YOURTOKENHERE -e ALEXA_TARGETS=media_player.kitchen,media_player.porch -e NOTIFY_SERVICES=lounge_tv -e ALEXA_ANNOUNCE=True -e ALEXA_PUSH=True -e ALEXA_TITLE="Call on Home Phone" --log-opt max-size=1g chrisfranklin/pyhacid

You can also use docker-compose:

pyhacid:
    image: chrisfranklin/pyhacid:latest
    environment:
        - NCID_HOST=127.0.0.1
        - NCID_PORT=3333
        - HA_URL=https://ha.example.com/api/
        - HA_TOKEN=YOURTOKENHERE
        - ALEXA_TARGETS=media_player.kitchen,media_player.porch
        - NOTIFY_SERVICES=lounge_tv
        - ALEXA_ANNOUNCE=True
        - ALEXA_PUSH=True

Built With

• Python - Programming language
• Requests - HTTP for humans
• NCID - Network Caller ID

Contributing

Yes please, all contributions welcome from anyone kind enough to help.

Versioning

We use SemVer for versioning. For the versions available, see the tags on this repository.

Authors

See the list of contributors who participated in this project.