ring-mqtt | Ring devices to MQTT Bridge

by tsightler JavaScript Version: v5.3.0 License: MIT

X-Ray Key Features Code Snippets Community Discussions(1)Vulnerabilities Install Support

kandi X-RAY | ring-mqtt Summary

ring-mqtt is a JavaScript library typically used in Internet of Things (IoT), Raspberry Pi, Arduino applications. ring-mqtt has no bugs, it has no vulnerabilities, it has a Permissive License and it has low support. You can download it from GitHub.

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. The project also supports video streaming by providing an RTSP gateway service that allows any media client supporting the RTSP protocol to connect to a Ring camera livestream or to play back recorded events (Ring Protect subscription required for event recording playback). Please review the full list of supported devices and features for more information on current capabilities. The code is written primarily in Javascript and leverages the excellent ring-client-api for communicating with the same REST API used by the official Ring apps. For video streaming ring-client-api establishes the RTP steam via a SIP session and forwards the packets to an FFmpeg which publishes the stream via RTSP to rtsp-simple-server. Home Assistant style MQTT discovery is supported which allows for easy integration with minimal configuration (requires the Home Assistant Mosquitto/MQTT integration to be enabled). For those using Home Assistant OS, or other supervised Home Assistant installations, there is a sister project providding a Home Assistant Addon which allows installing Ring-MQTT directly via the native add-on store capabilities (not HACS).

Support

Quality

Security

License

Reuse

Support

ring-mqtt has a low active ecosystem.

It has 404 star(s) with 94 fork(s). There are 24 watchers for this library.

It had no major release in the last 12 months.

There are 1 open issues and 260 have been closed. On average issues are closed in 3 days. There are no pull requests.

It has a neutral sentiment in the developer community.

The latest version of ring-mqtt is v5.3.0

Quality

ring-mqtt has 0 bugs and 0 code smells.

Security

ring-mqtt has no vulnerabilities reported, and its dependent libraries have no vulnerabilities reported.

ring-mqtt code analysis shows 0 unresolved vulnerabilities.

There are 0 security hotspots that need review.

License

ring-mqtt is licensed under the MIT License. This license is Permissive.

Permissive licenses have the least restrictions, and you can use them in most projects.

Reuse

ring-mqtt releases are available to install and integrate.

Installation instructions, examples and code snippets are available.

It has 236 lines of code, 0 functions and 35 files.

It has low code complexity. Code complexity directly impacts maintainability of the code.

Top functions reviewed by kandi - BETA

kandi has reviewed ring-mqtt and discovered the below as its top functions. This is intended to give you an instant insight into ring-mqtt implemented functionality, and help decide if they suit your requirements.

Get Refresh Token credentials

Get all kandi verified functions for this library.

ring-mqtt Key Features

No Key Features are available at this moment for ring-mqtt.

ring-mqtt Examples and Code Snippets

No Code Snippets are available at this moment for ring-mqtt.

Community Discussions

Trending Discussions on ring-mqtt

Configuring Mosquitto on VM to Connect to Azure WebApp

QUESTION

Configuring Mosquitto on VM to Connect to Azure WebApp

Asked 2021-Jan-11 at 10:36

I am running the MQTT mosquitto broker (v.1.4.15) on a Azure Virtual Machine running Ubuntu (v18.04.1). My aim is to connect multiple microcontrollers to the broker. In order to monitor and control the microcontrollers remotely, I've setup an Azure WebApp on which I am running Node-RED. I am trying to establish a connection between the web-app and the broker. In order to configure Mosquitto properly, I am using this tutorial from DigitalOcean. However, because I'm new to this part of the work (usually working on embeded systems) I'm trying to establish a connection without SSL first for testing and then add SSL.

I've password protected mosquitto and am able to pub and sub on a test topic on local host (using the following commands on the VM terminal)

...

ANSWER

Answered 2021-Jan-11 at 10:36

To follow up on the first comment.

You need to open the port in the Azure portal as well as in ufw

Details of how can be found here:

https://docs.microsoft.com/en-us/azure/virtual-machines/windows/nsg-quickstart-portal

Source https://stackoverflow.com/questions/65653434

Community Discussions, Code Snippets contain sources that include Stack Exchange Network

Vulnerabilities

No vulnerabilities reported

Install ring-mqtt

Docker is the recommended installation method. While it's completely possible to install this code manually as a service on Linux, it requires manually satisfying pre-requisites, copying systemd unit files and registering the service, etc. I do not test the standard install method so if you go with this method you are mostly on your own to solve problems with versions and dependencies. Note that this project supports only Linux platforms and will not run properly on Windows. Please read the documenation for your preferred install method below for details on the require installtion steps and configuration:.

Support

Full support for 2FA including embedded web based authentication app (addon and standalone installs only, Docker includes a simple CLI)Supports the following devices and features: Alarm Devices Alarm Control Panel Arm/Disarm actions Arm/Disarm commands are monitored for success and retried automatically Arm/Disarm arming bypass switch (Allows arming with faulted contact sensors) Alarm states: Disarmed Armed Home Armed Away Arming (exit delay) Pending (entry delay) Triggered Disarm code support for Home Assistant (optional) Base Station Volume Control (only when using Ring primary account) Panic Switches (same as panic sliders in Ring app, Ring Protect Plan is required) Siren Swich Keypad Volume Control Battery level AC/Charging state Ring Contact and Motion Sensors Ring Flood/Freeze Sensor Ring Smoke/CO Listener First Alert Z-Wave Smoke/CO Detector Ring Retro Kit Zones Ring Range Extender Ring External Siren 3rd party Z-wave door locks (Wifi based locks integrated via Amazon Key are NOT supported as they use a completely different API) 3rd party Z-Wave switches, dimmers, and fans 3rd party Z-Wave motion/contact/tilt sensors (basic support) 3rd party Z-Wave thermostats and temperature sensors 3rd party Z-Wave sirens Battery Level (for devices that support battery, detailed data in entity attributes) Tamper Status (for devices that support tamper) Device info sensor with detailed state information such as (exact info varies by device): Communication status Z-wave Link Quality Serial Number Firmware status Device volume Ring Camera Devices Motion Events Doorbell (Ding) Events Lights (for capable devices) Siren (for capable device) Snapshots (images refresh on motion events or scheduled refresh interval). Live video streams via RTSP (streams start on-demand or can also be started via MQTT, for example to record based on events from other devices) Recorded event streams via RTSP (playback of last 5 motion/ding recorded events selected via MQTT) Battery Level (detailed battery data such as charging status and aux battery state in attributes) Wireless Signal in dBm (Wireless network in attributes) Device info sensor with detailed state information such as (exact info varies by device): Wireless Signal Wired Network Name Firmware Status Last Update Status Ring Chimes (requires using Ring primary account) Volume Control Play ding/motion sounds Enter/Exit Snooze Mode Set Snooze Minute (must be set prior to entering snooze state) Wireless Signal in dBm (Wireless network in attributes) Device info sensor with detailed state information such as (exact info varies by device): Wireless Signal Wired Network Name Firmware Status Last Update Status Smart Lighting Lighting and motion sensor devices Light groups (requires using Ring primary account) Device info sensor with detailed state information (exact info varies by device) Location Modes For locations without a Ring Alarm, can add a security panel style device for controlling camera settings via Ring Location Modes feature Displays as an Alarm Panel in Home Assistant for setting modes and displaying mode state Must be explicitly enabled using "enable_modes" config or ENABLEMODES envrionment variableFull Home Assistant MQTT discovery and device registry support - devices appear automaticallyConsistent topic creation based on location/device ID - easy to use with MQTT tools like Node-RED or other home automation platforms with MQTT supportSupport for mulitple locationsMonitors websocket connection to each alarm and sets reachability status if socket is unavailable (Home Assistant UI reports "unknown" status for unreachable devices), automatically resends device state when connection is establishedMonitors MQTT connection to trigger automatic resend of configuration and state data after restart/disconnectMonitors Home Assistant MQTT birth messages to trigger automatic resend of configuration and state data after Home Assistant restartDoes not require MQTT retain and can work well with brokers that provide no persistent storage

Find more information at: