Expose multiple Amcrest cameras and events to an MQTT broker, primarily
designed to work with Home Assistant.
Uses the python-amcrest library.
Forked from dchesterton/amcrest2mqtt
For docker-compose, use the configuration included in this repository.
An docker image is available at graystorm/amcrest2mqtt:latest. You can mount your configuration volume at /config (and see the included config.yaml.sample file) or use the ENV variables:
It supports the following environment variables:
-
AMCREST_HOSTS(required, 1+ space-separated list of hostnames/ips) -
AMCREST_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) -
AMCREST_WEBRTC_HOST(optional, webrtc hostname for link, but then link/sources below become required:) -
AMCREST_WEBRTC_PORT(webrtc port, default = 1984) -
AMCREST_WEBRTC_LINK(webrtc stream link, default = 'stream.html') -
AMCREST_WEBRTC_SOURCES(webrtc "Source" param for each camera, same count and order of AMCREST_HOSTS above) -
MQTT_USERNAME(required) -
MQTT_PASSWORD(optional, default = empty password) -
MQTT_HOST(optional, default = 'localhost') -
MQTT_QOS(optional, default = 0) -
MQTT_PORT(optional, default = 1883) -
MQTT_TLS_ENABLED(required if using TLS) - set totrueto enable -
MQTT_TLS_CA_CERT(required if using TLS) - path to the ca certs -
MQTT_TLS_CERT(required if using TLS) - path to the private cert -
MQTT_TLS_KEY(required if using TLS) - path to the private key -
MQTT_PREFIX(optional, default = amgrest2mqtt) -
MQTT_HOMEASSISTANT(optional, default = true) -
MQTT_DISCOVERY_PREFIX(optional, default = 'homeassistant') -
TZ(required, timezone identifier, see https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#List) -
STORAGE_UPDATE_INTERVAL(optional, default = 900) - how often to fetch storage stats (in seconds) -
SNAPSHOT_UPDATE_INTERVAL(optional, default = 60) - how often to fetch camera snapshot (in seconds)
It exposes through device discovery a service and a device with components for each camera:
-
homeassistant/device/amcrest-service- service config -
homeassistant/device/amcrest-[SERIAL_NUMBER]per camera, with components: -
event- most all "other" events, not exposed below -
camera- a snapshot is saved every SNAPSHOT_UPDATE_INTERVAL (also based on how often camera saves snapshot image), also an "eventshot" is stored at the time an "event" is triggered in the camera. This is collected by filename, when the Amcrest camera logs a snapshot was saved because of an event (rather than just a routine timed snapshot) -
doorbell- doorbell status (if AD110 or AD410) -
human- human detection (if AD410) -
motion- motion events (if supported) -
config- device configuration information -
storage- storage stats -
privacy_mode- get (and set) the privacy mode switch of the camera -
motion_detection- get (and set) the motion detection switch of the camera
The camera snapshots work really well for the HomeAssistant Area cards on a dashboard - just make this MQTT camera device the only camera for an area and place an Area card for that location.
An "event snapshot" (eventshot) is separately (and specifically, by filename) collected when the camera automatically records a snapshot because of an event. Note, that if the Amcrest camera is configured to record 3 or 5 snapshots on an event - each of those will be updated by amcrest2mqtt and you will very quickly end up with (only) the last snapshot stored. This might alter you decision on how to configure your camera for this setting. (Or perhaps I can turn the snapshots-for-an-event into an animated image on the HA-side, thought that seems like overkill.)
The WebRTC option works very well with the go2rtc package which is a streaming server that works very well for (my) Amcrest cameras. If you setup the WebRTC config here, the configuration_url for the MQTT device will be the streaming RTC link instead of just a link to the hostname (which is arguably a more correct "configuration" url, but I'd rather have a simple link from the device page to jump to a live stream).
The app supports events for any Amcrest device supported by python-amcrest.
The app has built-in support for Home Assistant discovery. Set the MQTT_HOMEASSISTANT environment variable to true to enable support.
If you are using a different MQTT prefix to the default, you will need to set the MQTT_DISCOVERY_PREFIX environment variable.
To run via env variables with Docker Compose, see docker-compose.yaml or make sure you attach a volume with the config file and point to that directory, for example:
CMD [ "python", "-u", "./app.py", "-c", "/config" ]
Docker is the only supported way of deploying the application. The app should run directly via Python but this is not supported.
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 🙂
