/ring-mqtt_ynh

Ring-MQTT Bridge for YunoHost

Primary LanguageShellMIT LicenseMIT

Ring-MQTT Bridge for YunoHost

Integration level Working status Maintenance status
Install Ring-MQTT Bridge with YunoHost

Lire ce readme en français.

This package allows you to install Ring-MQTT Bridge quickly and simply on a YunoHost server. If you don't have YunoHost, please consult the guide to learn how to install it.

Overview

The ring-mqtt project acts as a bridge between alarm, smart lighting and camera devices sold by Ring LLC and an MQTT broker thus allowing any automation tools that can leverage the open standards based MQTT protocol to monitor and control these devices.

Features

See https://github.com/tsightler/ring-mqtt/wiki#supported-devices-and-features

Shipped version: 1.01~ynh1

Screenshots

Screenshot of Ring-MQTT Bridge

Disclaimers / important information

After installing the first time you need to open tge web ui to configure your Ring API credentials.

# Go to http://yunohost.local:55123 and login, settings are saved automatically

Make sure two factor is enabled on your Ring account.

Documentation and resources

Developer info

Please send your pull request to the testing branch.

To try the testing branch, please proceed like that.

sudo yunohost app install https://github.com/YunoHost-Apps/ring-mqtt_ynh/tree/testing --debug
or
sudo yunohost app upgrade ring-mqtt -u https://github.com/YunoHost-Apps/ring-mqtt_ynh/tree/testing --debug

More info regarding app packaging: https://yunohost.org/packaging_apps