Skip to content

Device Configuration Details

Jump to bottom
tsightler edited this page Jul 17, 2023 · 2 revisions

Note: This page is a work-in-progress and is not yet complete

This page provides device specific configuration details and an overview of the MQTT topics used. Note that, when used with Home Assistant, it's generally not required to use the MQTT topics directly as the devices will appear in Home Assistant and can be automated there, however, topics are included for those using other tools such as NodeRED.

  • Supports the following devices and features:
    • Alarm Devices
      • Alarm Control Panel
        • Arm/Disarm actions
        • Arm/Disarm commands are monitored for success and retried automatically
        • Automatic and manual sensor bypass when arming
        • 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 Switch
      • Keypad
        • Volume Control
        • Battery level
        • AC/Charging state
        • Proximity sensor as motion sensor (requires keypad LED Settings of "Keep Mode Button Lit" or "Motion Turns on Lights")
      • 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 (Wi-Fi 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 (must set "enable_cameras" config option to "true")
      • 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, must set "enable_cameras" config option to "true")
      • 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
    • Ring Intercom (must set "enable_cameras" config option to "true")
      • Ding state
      • Lock state
      • Unlock door
      • Device info sensor with detailed state information such as (exact info varies by device):
        • Battery level
        • Wireless Signal
        • Wired Network Name
        • Firmware Status
        • Last Update Status
    • Smart Lighting
      • Lighting and motion sensor devices
      • Light groups (requires using Ring primary account)
      • Light duration (set per-device)
      • 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 option
Clone this wiki locally