diff --git a/README.md b/README.md index 33582e5..453c1fe 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,15 @@ -# amcrest2mqtt +# weirdtangent/amcrest2mqtt -A simple app to expose all events generated by an Amcrest device to MQTT using the +Forked from dchesterton/amcrest2mqtt + +A simple app to expose all events generated by Amcrest devices to MQTT using the [`python-amcrest`](https://github.com/tchellomello/python-amcrest) library. It supports the following environment variables: -- `AMCREST_HOST` (required) +- `AMCREST_HOSTS` (required, 1+ space-separated list of hostnames/ips) +- `DEVICE_NAMES` (required, 1+ space-separated list of device names - must match count of AMCREST_HOSTS) + - `AMCREST_PORT` (optional, default = 80) - `AMCREST_USERNAME` (optional, default = admin) - `AMCREST_PASSWORD` (required) @@ -21,10 +25,10 @@ It supports the following environment variables: - `HOME_ASSISTANT` (optional, default = false) - `HOME_ASSISTANT_PREFIX` (optional, default = 'homeassistant') - `STORAGE_POLL_INTERVAL` (optional, default = 3600) - how often to fetch storage data (in seconds) (set to 0 to disable functionality) -- `DEVICE_NAME` (optional) - override the default device name used in the Amcrest app It exposes events to the following topics: +- `amcrest2mqtt/broker` - broker config - `amcrest2mqtt/[SERIAL_NUMBER]/event` - all events - `amcrest2mqtt/[SERIAL_NUMBER]/doorbell` - doorbell status (if AD110 or AD410) - `amcrest2mqtt/[SERIAL_NUMBER]/human` - human detection (if AD410) @@ -49,10 +53,11 @@ version: "3" services: amcrest2mqtt: container_name: amcrest2mqtt - image: dchesterton/amcrest2mqtt:latest + image: weirdtangent/amcrest2mqtt:latest restart: unless-stopped environment: - AMCREST_HOST: 192.168.0.1 + AMCREST_HOSTS: 192.168.0.1 192.168.0.2 camera.local + DEVICE_NAMES: sensor.doorbell camera.garage camera.backyard AMCREST_PASSWORD: password MQTT_HOST: 192.168.0.2 MQTT_USERNAME: admin @@ -62,28 +67,14 @@ services: ## Out of Scope -### Multiple Devices - -The app will not support multiple devices. You can run multiple instances of the app if you need to expose events for multiple devices. - ### Non-Docker Environments Docker is the only supported way of deploying the application. The app should run directly via Python but this is not supported. -### Home Assistant Addons - -There are a couple of Home Assistant Addons that use my code to be able to port this software into Supervised versions of Home Assistant. I do not specifically support the add-ons themselves, only the base software in the original docker format. Please contact the authors of those add-ons for support if using that method. - -https://github.com/ikifar2012/amcrest2mqtt-addon/blob/master/README.md -[![Open your Home Assistant instance and show the add add-on repository dialog with a specific repository URL pre-filled.](https://my.home-assistant.io/badges/supervisor_add_addon_repository.svg)](https://my.home-assistant.io/redirect/supervisor_add_addon_repository/?repository_url=https%3A%2F%2Fgithub.com%2Fikifar2012%2Fha-addons) - -https://github.com/robsonke/hassio-addons/blob/master/amcrest2mqtt/README.md -[![Open your Home Assistant instance and show the add add-on repository dialog with a specific repository URL pre-filled.](https://my.home-assistant.io/badges/supervisor_add_addon_repository.svg)](https://my.home-assistant.io/redirect/supervisor_add_addon_repository/?repository_url=https%3A%2F%2Fgithub.com%2Frobsonke%2Fhassio-addons) - -## Buy Me A ~~Coffee~~ Beer 🍻 +## Buy Me A Coffee A few people have kindly requested a way to donate a small amount of money. If you feel so inclined I've set up a "Buy Me A Coffee" page where you can donate a small sum. Please do not feel obligated to donate in any way - I work on the app because it's useful to myself and others, not for any financial gain - but any token of appreciation is much appreciated 🙂 - +Buy Me A Coffee