Hubitat Documentation - User contributions [en]

Hubitat Elevation Documentation

2020-07-21T03:19:37Z

SneakyPete: /* App Documentation */

==[[Getting Started]]==

#[[Registration and setup]]
#[[Navigating the Web Interface]]
#[[Discovering your Devices]]
#[[Automating your Devices]]
#[[Care and Maintenance]]
#[[How to Collect Information for Support|Support]]

==Hubitat Web Interface Guide==

'''Main Menu'''

*[[Home]]
*[[Location and Modes]]
*[[Devices]]
**[[Device Discovery]]
**[[Device Detail]]
**[[Device Events]]
*[[Apps]]
**[[App Status]]
**[[App Events]]
*[[Settings]]
**[[Hub Details]]
**[[Hub Login Security]]
**[[Location and Modes]]
**[[Z-Wave Details]]
**[[Zigbee Details]]
***[[Zigbee Logs]]
**[[Check For Updates]]
**[[Backup and Restore]]
**[[Discover Zigbee and Z-Wave Devices]]

'''Advanced Features'''

*[[Apps Code]]
*[[Drivers Code]]
*[[System Events]]
**[[Hub Events]]
**[[Location Events]]
*[[Logs]]
**[[Past Logs]]
*[[Hubitat Diagnostic Tool]]
*[[Soft Reset]]
*[[Full Reset]]

==App Documentation==

*[[Amazon Echo App]]
*[[Amazon Echo Skill]]
*[[Model C-7 Z-Wave Guide]]
*[[Ecobee Integration]]
*[[Google Home]]
*[[Groups and Scenes]]
*[[Hub Link]]
*[[Hubitat® Dashboard|Hubitat® Dashboard]]
*[[Hubitat® Safety Monitor|Hubitat® Safety Monitor]]
*[[Hubitat® Simple Lighting|Hubitat® Simple Lighting]]
*[[Hue Bridge Integration]]
*[[IFTTT Integration]]
*[[Life360 Connector]]
*[[Link to Hub]]
*[[Lock Code Manager]]
*[[Lutron Integrator]]
*[[Maker API]]
*[[Motion Lighting Apps#Creating a Mode Lighting App|Mode Lighting]]
*[[Mode Manager]]
*[[Motion Lighting Apps]]
*[[Notifications]]
*[[Rachio Integration]]
*[[Rule Machine]]®
*[[Rule-4.0|Rule-4.0]]
*[[Send Hub Events]]
*[[SharpTools]]
*[[Sonos Integration]]
*[[Zone Motion Controllers]]
*[[Z-Wave Poller]]

==Device Documentation==

*[[Orbit Hose Water Timer]]

*[[Pushover]]

*[[SecurityKeypads]]

*[[Twilio Notification]]

==Compatible Devices==

[[List of Compatible Devices]]

[[Join and Reset Instructions]]

==How to Guides==

[[Hub Placement Tips]]

[[How to collect information for support]]

[[How to Build a Solid Zigbee Mesh]]

[[How to Build a Solid Z-Wave Mesh]]

[[How to remove a Z-Wave device]]

[[The Anatomy of Z-Wave™ Repair]]

[[How to update your hub]]

[[How to backup your hub]]

[[How to change your location]]

[[How to add/change a mode]]

[[How to Install Custom Apps]]

[[How to Install Custom Drivers]]

[[Hub Login Security|How to add password protection]]

[[How to Manage Lock Codes]]

[[How to change accounts linked to your hub]]

==Developer Documentation==

[[Developer Documentation]]

[[Driver Capability List]]

==Platform==
[[Release Notes]]

List of Compatible Devices

2018-10-24T22:41:17Z

SneakyPete: Created page with "The table below lists all of the devices officially supported by Hubitat Elevation. You can sort the list by Brand Name, Protocol or Device Type to help you quickly find the d..."

The table below lists all of the devices officially supported by Hubitat Elevation. You can sort the list by Brand Name, Protocol or Device Type to help you quickly find the device you are looking for. This list will be updated with each new software release.

Zigbee and Z-Wave devices require the correct drivers to connect and work properly with the hub. LAN and Cloud devices connect using the specific integration app listed and may require an additional bridge device to communicate.

While this list includes all officially supported devices, there are countless other devices users have running on their hubs. Visit our [https://community.hubitat.com/t/compatible-devices-wiki/465 Community Devices Page] to for list of devices and custom driver users have running on their hubs. Note that these are not officially supported and we cannot guarantee their performance.

{| class="wikitable sortable"

! Brand
! Device
! Product Number
! Device type
! Protocol
! Driver Name
! Integration App
! Additional Required Hardware
|-
| Bosch
| PIR Motion Detector
|
| Motion Sensor
| Zigbee
| Bosch Motion Detector
|
|
|-
| Bosch
| TriTech Motion Detector
|
| Motion Sensor
| Zigbee
| Bosch Motion Detector
|
|
|-
| Centralite
| Contact Sensor
|
| Contact Sensor
| Zigbee
| Generic Zigbee Contact Sensor
|
|
|-
| Centralite
| Motion Sensor
|
| Motion Sensor
| Zigbee
| Generic Zigbee Motion Sensor
|
|
|-
| Centralite
| Outlet Plug-in
|
| Smart Plug
| Zigbee
| Generic Zigbee Outlet
|
|
|-
| Centralite
| Perl Thermostat
|
| Thermostat
| Zigbee
| Generic Zigbee Thermostat
|
|
|-
| Centralite
| Micro Door Sensor
|
| Contact Sensor
| Zigbee
| SmartSense Multi Sensor
|
|
|-
| Cree
| Connected A-19 Bulb
|
| Smart Bulb
| Zigbee
| Generic Zigbee Bulb
|
|
|-
| Enerwave
| Duplex Outlet
|
| Outlet
| Zigbee
| Generic Zigbee Outlet
|
|
|-
| GE
| Link Soft White Bulb
|
| Smart Bulb
| Zigbee
| Generic Zigbee Bulb
|
|
|-
| GE
| Link Bulb
|
| Smart Bulb
| Zigbee
| Generic Zigbee Bulb
|
|
|-
| GE
| Link Daylight Bulb
|
| Smart Bulb
| Zigbee
| Generic Zigbee Bulb
|
|
|-
| GE
| Smart Dimmer
|
| Dimmer
| Zigbee
| Generic Zigbee Dimmer
|
|
|-
| GE/Jasco
| Switch
| 45856
| Switch
| Zigbee
| Generic Zigbee Switch
|
|
|-
| Halo
| Smoke Alarm
|
| Smoke Detector
| Zigbee
| Halo Smoke Alarm
|
|
|-
| Iris
| 3405-L Keypad V2
|
| Keypad
| Zigbee
| Centralitle Keypad
|
|
|-
| Iris
| 3405-L Keypad
|
| Keypad
| Zigbee
| Centralitle Keypad
|
|
|-
| Iris
| Xfinity 3400-X Keypad
|
| Keypad
| Zigbee
| Centralitle Keypad
|
|
|-
| Iris
| Contact Sensor
|
| Contact Sensor
| Zigbee
| Generic Zigbee Contact Sensor
|
|
|-
| Iris
| Smart Water Sensor
|
| Water Sensor
| Zigbee
| Generic Zigbee Moisture Sensor
|
|
|-
| Iris
| Motion Sensor
|
| Motion Sensor
| Zigbee
| Generic Zigbee Motion Sensor
|
|
|-
| Iris
| Button
|
| Button Controller
| Zigbee
| Iris Button Controller
|
|
|-
| Iris
| Outlet
|
| Outlet
| Zigbee
| Generic Zigbee Outlet
|
|
|-
| Iris
| Outlet V2
|
| Outlet
| Zigbee
| Generic Zigbee Outlet
|
|
|-
| Iris
| Smart Fob
|
| Button Controller
| Zigbee
| Iris 4 Button Fob
|
|
|-
| Keen
| Home Smart Vent
|
| Vent
| Zigbee
| Keen Home Smart Vent
|
|
|-
| Kwikset
| 10-Button Deadbolt
|
| Lock
| Zigbee
| Generic Zigbee Lock
|
|
|-
| Kwikset
| 5-Button Deadbolt
|
| Lock
| Zigbee
| Generic Zigbee Lock
|
|
|-
| Kwikset
| 10-Button Touch Deadbolt
|
| Lock
| Zigbee
| Generic Zigbee Lock
|
|
|-
| Kwikset
| 5-Button Lever
|
| Lock
| Zigbee
| Generic Zigbee Lock
|
|
|-
| Kwikset
| Smartcode Lock
|
| Lock
| Zigbee
| Generic Zigbee Lock
|
|
|-
| Lux
| Zigbee Thermostat
|
| Thermostat
| Zigbee
| LUX Zigbee Thermostat
|
|
|-
| NYCE
| contact sensor
|
| Contact Sensor
| Zigbee
| NYCE Contact Sensor
|
|
|-
| NYCE
| Celing Motion Censor
|
| Motion Sensor
| Zigbee
| NYCE Motoin Sensor Series
|
|
|-
| NYCE
| Curtain Motion Sensor
|
| Motion Sensor
| Zigbee
| NYCE Motoin Sensor Series
|
|
|-
| NYCE
| Celing Motion Censor with T/H
|
| Motion Sensor
| Zigbee
| NYCE Motoin Sensor Series
|
|
|-
| NYCE
| Motion Sensor
|
| Motion Sensor
| Zigbee
| NYCE Motoin Sensor Series
|
|
|-
| NYCE
| Motion Sensor with T/H
|
| Motion Sensor
| Zigbee
| NYCE Motoin Sensor Series
|
|
|-
| NYCE
| Curtain Motion Sensor with T/H
|
| Motion Sensor
| Zigbee
| NYCE Motoin Sensor Series
|
|
|-
| Orvibo
| Motion Sensor
|
| Motion Sensor
| Zigbee
| Generic Zigbee Motion Sensor
|
|
|-
| Osram
| Lightify Flex RGBW
|
| Smart Bulb
| Zigbee
| Generic Zigbee RGBW Light
|
|
|-
| Osram
| Smart+ Classic E27 Multicolor
|
| Smart Bulb
| Zigbee
| Generic Zigbee RGBW Light
|
|
|-
| Osram
| Lightify LED Tunable White 60W
|
| Smart Bulb
| Zigbee
| Generic Zigbee CT Bulb (dev)
|
|
|-
| Osram
| Lightify LED Recessed Kit RT 5/6 Tunable
|
| Smart Bulb
| Zigbee
| Generic Zigbee CT Bulb (dev)
|
|
|-
| Osram
| Lightify LED Flood BR30 Tunable White
|
| Smart Bulb
| Zigbee
| Generic Zigbee CT Bulb (dev)
|
|
|-
| Osram
| Lightify LED Classic B40 Tunable White 60W
|
| Smart Bulb
| Zigbee
| Generic Zigbee CT Bulb (dev)
|
|
|-
| Osram
| Smart Outdoor Plug
|
| Smart Plug
| Zigbee
| Generic Zigbee Outlet
|
|
|-
| PEQ
| contact sensors
|
| Contact Sensor
| Zigbee
| Generic Zigbee Contact Sensor
|
|
|-
| PEQ
| Moisture Sensor
|
| Water Sensor
| Zigbee
| Generic Zigbee Moisture Sensor
|
|
|-
| PEQ
| Motion Sensor
|
| Motion Sensor
| Zigbee
| Generic Zigbee Motion Sensor
|
|
|-
| Philips
| Dimmer Switch
|
| Dimmer
| Zigbee
| Philips Dimmer Button Controller
|
|
|-
| Philips Hue
| Strip Lights
|
| Smart Bulb
| Zigbee
| Generic Zigbee RGB Light
| Hue Bridge Integrator
| Philips Hue Bridge (Optional, but recommended)
|-
| Philips Hue
| Bloom Lights
|
| Smart Bulb
| Zigbee
| Generic Zigbee RGB Light
| Hue Bridge Integrator
| Philips Hue Bridge (Optional, but recommended)
|-
| Philips Hue
| Living Colors Lights
|
| Smart Bulb
| Zigbee
| Generic Zigbee RGB Light
| Hue Bridge Integrator
| Philips Hue Bridge (Optional, but recommended)
|-
| Philips Hue
| Lux
|
| Smart Bulb
| Zigbee
| Generic Zigbee RGBW Light
| Hue Bridge Integrator
| Philips Hue Bridge (Optional, but recommended)
|-
| Philips Hue
| Motion Sensor
|
| Motion Sensor
| Zigbee
| Hue Motion Sensor
| Hue Bridge Integrator
| Philips Hue Bridge (Optional, but recommended)
|-
| Phillps
| White Ambiance
|
| Smart Bulb
| Zigbee
| Generic Zigbee CT Bulb (dev)
|
|
|-
| Phillps
| Ambiance White
|
| Smart Bulb
| Zigbee
| Generic Zigbee CT Bulb (dev)
|
|
|-
| Sengled
| Element Classic Bulb
|
| Smart Bulb
| Zigbee
| Generic Zigbee Bulb
|
|
|-
| Sengled
| Element Plus Plus Bulb
|
| Smart Bulb
| Zigbee
| Generic Zigbee CT Bulb (dev)
|
|
|-
| Sengled
| Element Plus Color Bulb
|
| Smart Bulb
| Zigbee
| Generic Zigbee RGBW Light
|
|
|-
| SmartSense
| Motion Sensors
|
| Motion Sensor
| Zigbee
| SmartSense Multi Sensor
|
|
|-
| Smartthings
| Contact Sensors
|
| Contact Sensor
| Zigbee
| Generic Zigbee Contact Sensor
|
|
|-
| SmartThings
| Multi Sensor V5
|
| Contact Sensor
| Zigbee
| Generic Zigbee Contact Sensor
|
|
|-
| Smartthings
| Moisture Sensor
|
| Water Sensor
| Zigbee
| Generic Zigbee Moisture Sensor
|
|
|-
| Smartthings
| Moisture Sensor V4
|
| Water Sensor
| Zigbee
| Generic Zigbee Moisture Sensor
|
|
|-
| Smartthings
| Moisture Sensor V5
|
| Water Sensor
| Zigbee
| Generic Zigbee Moisture Sensor
|
|
|-
| Smartthings
| Motion Sensor V5
|
| Motion Sensor
| Zigbee
| Generic Zigbee Motion Sensor
|
|
|-
| Smartthings
| Motion Sensor V4
|
| Motion Sensor
| Zigbee
| Generic Zigbee Motion Sensor
|
|
|-
| Smartthings
| Motion Sensor V3
|
| Motion Sensor
| Zigbee
| Generic Zigbee Motion Sensor
|
|
|-
| Smartthings
| Motion Sensor V2
|
| Motion Sensor
| Zigbee
| Generic Zigbee Motion Sensor
|
|
|-
| Smartthings
| V1 & V2 & V3 & V5 (IM6001-MTP02) Motion Sensor (using)
|
| Motion Sensor
| Zigbee
| Generic Zigbee Motion Sensor
| *
|
|-
| Smartthings
| F-OUT-US-2
|
| Outlet
| Zigbee
| Generic Zigbee Outlet
|
|
|-
| SmartThings
| Button V5
|
| Button Controller
| Zigbee
| Samsung Zigbee Button
|
|
|-
| Smartthings
| F-SS-MULT-001/2
|
| Motion Sensor
| Zigbee
| SmartSense Multi Sensor V4
|
|
|-
| Smartthings
| Multipupose Sensor V4
|
| Motion Sensor
| Zigbee
| SmartSense Multi Sensor V4
|
|
|-
| Smartthings
| Multi Sensor
| STSS-MULT-001
| Motion Sensor
| Zigbee
| SmartSense Multi V1
|
|
|-
| Smartthings
| Humidity Sensor
|
| Humidity Sensor
| Zigbee
| SmartThings Humidity Sensor
|
|
|-
| Smartthings
| Presence Sensor V2
|
| Presence Sensor
| Zigbee
| SmartThings Presence Sensor V2
|
|
|-
| Smartthings
| Presence Sensor V4
|
| Presence Sensor
| Zigbee
| SmartThings Presence Sensor V4
|
|
|-
| Sylvania
| Smart+ A19 Dimmable
|
| Smart Bulb
| Zigbee
| Generic Zigbee Bulb
|
|
|-
| Sylvania
| Smart Flex RGBW
|
| Smart Bulb
| Zigbee
| Generic Zigbee RGBW Light
|
|
|-
| Sylvania
| Smart BR30 RGBW
|
| Smart Bulb
| Zigbee
| Generic Zigbee RGBW Light
|
|
|-
| Sylvania
| Smart RT5/6 RGBW
|
| Smart Bulb
| Zigbee
| Generic Zigbee RGBW Light
|
|
|-
| Sylvania
| Smart A19 RGBW
|
| Smart Bulb
| Zigbee
| Generic Zigbee RGBW Light
|
|
|-
| Sylvania
| Smart Outdoor RGBW Flex
|
| Smart Bulb
| Zigbee
| Generic Zigbee RGBW Light
|
|
|-
| Sylvania
| Dimmer Switch
|
| Dimmer
| Zigbee
| Sylvania Dimmer Switch Button Controller
|
|
|-
| Third Reality
| Switch
|
| Switch
| Zigbee
| Generic Zigbee Switch
|
|
|-
| TRADFRI
| Bulb E14
|
| Smart Bulb
| Zigbee
| Generic Zigbee CT Bulb (dev)
|
|
|-
| Yale
| Touch Screen Deadbolt Lock
|
| Lock
| Zigbee
| Generic Zigbee Lock
|
|
|-
| Yale
| Assure Loclk
|
| Lock
| Zigbee
| Generic Zigbee Lock
|
|
|-
| Yale
| Push Button Deadbolt Lock
|
| Lock
| Zigbee
| Generic Zigbee Lock
|
|
|-
| Yale
| Touch Screen Leverl Lock
|
| Lock
| Zigbee
| Generic Zigbee Lock
|
|
|-
| Yale
| Push Button Lever Lock
|
| Lock
| Zigbee
| Generic Zigbee Lock
|
|
|-
| Zen
| Thermostat
|
| Thermostat
| Zigbee
| Zen Thermostat
|
|
|-
| Aeotec
| Dry Contact Sensor
| ZW097-A
| Contact Sensor
| Z-Wave
| Generic Z-Wave Contact Sensor
|
|
|-
| Aeotec
| Door/Window Sensor Gen 2
|
| Contact Sensor
| Z-Wave
| Generic Z-Wave Contact Sensor
|
|
|-
| Aeotec
| Recessed Door Sensor Gen 5
|
| Contact Sensor
| Z-Wave
| Generic Z-Wave Contact Sensor
|
|
|-
| Aeotec
| Recessed Door Sensor
|
| Contact Sensor
| Z-Wave
| Generic Z-Wave Contact Sensor
|
|
|-
| Aeotec
| Contact Sensro
| DSB04100
| Contact Sensor
| Z-Wave
| Generic Z-Wave Contact Sensor
|
|
|-
| Aeotec
| Doorbell
|
| Doorbell
| Z-Wave
| Aeon Labs Doorbell
|
|
|-
| Aeotec
| Micro G2 Dimmers
|
| Dimmer
| Z-Wave
| Aeon Micro Dimmer
|
|
|-
| Aeotec
| Nano Dimmer
|
| Dimmer
| Z-Wave
| Aeon Micro Dimmer
|
|
|-
| Aeotec
| G2 Micro Switch
|
| Switch
| Z-Wave
| Aeon Micro Switch
|
|
|-
| Aeotec
| Minimote
|
| Button Controller
| Z-Wave
| Aeon Minimote
|
|
|-
| Aeotec
| Micro Motor Controllers
|
| Motor Controller
| Z-Wave
| Aeon Motor Controller
|
|
|-
| Aeotec
| Motor Controller
|
| Motor Controller
| Z-Wave
| Aeon Motor Controller
|
|
|-
| Aeotec
| MultiSensor 5
|
| Motion Sensor
| Z-Wave
| Aeon MultiSensor 6
|
|
|-
| Aeotec
| MultiSensor 6
|
| Motion Sensor
| Z-Wave
| Aeon MultiSensor 6
|
|
|-
| Aeotec
| Siren
|
| Siren
| Z-Wave
| Aeon Siren
|
|
|-
| Aeotec
| WallMote
|
| Button Controller
| Z-Wave
| Aeon WallMote
|
|
|-
| Aeotec
| Aeon WallMote Quad
|
| Button Controller
| Z-Wave
| Aeon WallMote
|
|
|-
| Aeotec
| LED Bulb 6 Multi-Color
|
| Smart Bulb
| Z-Wave
| Aeotec LED Bulb 6 Multi-Color
|
|
|-
| Aeotec
| LED Bulb 6 Multi-Color
|
| Smart Bulb
| Z-Wave
| Aeotec LED Bulb 6 Multi-Color
|
|
|-
| Aeotec
| NanoMote One
| ZWA003-A
| Button Controller
| Z-Wave
| Aeotec NanoMote
|
|
|-
| Aeotec
| NanoMote Quad
| ZWA004-A
| Button Controller
| Z-Wave
| Aeotec NanoMote
|
|
|-
| Aeotec
| TriSensor
| ZWA005-A
| Motion Sensor
| Z-Wave
| Aeotec TriSensor
|
|
|-
| Aeotec
| Smart Switch 6
| ZW096AU
| Smart Plug
| Z-Wave
| Generic Z-Wave Outlet
|
|
|-
| Aeotec
| Door Window Sensor 6
|
| Contact Sensor
| Z-Wave
| Generic Z-Wave Contact Sensor
|
|
|-
| Aeotec
| Home Energy Meter
|
| Energy Meter
| Z-Wave
| Aeon Home Energy Meter
|
|
|-
| BeSense
| 360 Ceiling Sensor
| IX32
| Motion Sensor
| Z-Wave
| BeSense Motion Sensor
|
|
|-
| BeSense
| PIR Wall Sensor
| IX30
| Motion Sensor
| Z-Wave
| BeSense Motion Sensor
|
|
|-
| BeSense
| Door/Window Sensor
| IM20
| Contact Sensor
| Z-Wave
| Generic Z-Wave Contact Sensor
|
|
|-
| Dome
| Door Sensor
|
| Contact Sensor
| Z-Wave
| Dome Door Sensor
|
|
|-
| Dome
| Door/Window Sensor Pro
|
| Contact Sensor
| Z-Wave
| Dome Door/Window Sensor Pro
|
|
|-
| Dome
| Leak Sensor
|
| Water Sensor
| Z-Wave
| Dome Leak Sensor
|
|
|-
| Dome
| Motion Sensor
|
| Motion Sensor
| Z-Wave
| Dome Motion Sensor
|
|
|-
| Dome
| Mouser
|
| Mouse Trap
| Z-Wave
| Dome Mouser
|
|
|-
| Dome
| On/Off Plug
|
| Smart Plug
| Z-Wave
| Dome On Off Plug
|
|
|-
| Dome
| Siren
|
| Siren
| Z-Wave
| Dome Siren
|
|
|-
| Dome
| Water Shutoff
|
| Shutoff Valve
| Z-Wave
| Dome Water Shut-Off
|
|
|-
| Dragontech
| Outlet
|
| Outlet
| Z-Wave
| Generic Z-Wave Outlet
|
|
|-
| Eaton
| Dimmer
| RF9540
| Dimmer
| Z-Wave
| Generic Z-Wave Smart Dimmer
|
|
|-
| Ecolink
| Siren
|
| Siren
| Z-Wave
| Ecolink Siren
|
|
|-
| Ecolink
| Smoke/CO Audio Detector
| FF-ZWAVE5
| Smoke/CO Detector
| Z-Wave
| Ecolink Smoke/CO Audio Detector
|
|
|-
| Ecolink
| Wireless Rocker Switch
|
| Switch
| Z-Wave
| Ecolink Wireless Switch
|
|
|-
| Ecolink
| Wireless Toggle Switch
|
| Switch
| Z-Wave
| Ecolink Wireless Switch
|
|
|-
| Ecolink
| Wireless Double Rocker Switch
|
| Switch
| Z-Wave
| Ecolink Wireless Switch
|
|
|-
| Ecolink
| Contact Sensor
| DWZWAVE2.5-ECO
| Contact Sensor
| Z-Wave
| Generic Z-Wave Contact Sensor
|
|
|-
| Ecolink
| Garage Door Tilt Sensor
| TILT-ZWAVE2
| Tilt Sensor
| Z-Wave
| Generic Z-Wave Contact Sensor
|
|
|-
| Ecolink
| Tilt Sensor
|
| Tilt Sensor
| Z-Wave
| Generic Z-Wave Contact Sensor
|
|
|-
| Ecolink
| Motion Sensor
|
| Motion Sensor
| Z-Wave
| Generic Z-Wave Motion Sensor
|
|
|-
| Ecolink
| Flood/Freeze Sensor
|
| Water Sensor
| Z-Wave
| Generic Z-Wave Water Sensor
|
|
|-
| Enerwave
| Motion Sensor
|
| Motion Sensor
| Z-Wave
| Generic Z-Wave Motion Sensor
|
|
|-
| Everspring
| Contact Sensor
| HSM02
| Contact Sensor
| Z-Wave
| Generic Z-Wave Contact Sensor
|
|
|-
| Everspring
| Motion Sensor
| HSP02
| Motion Sensor
| Z-Wave
| Generic Z-Wave Motion Sensor
|
|
|-
| Everspring
| Smoke Detector
| SF813
| Smoke Detector
| Z-Wave
| Generic Z-Wave Smoke Detector
|
|
|-
| Everspring
| Flood Detector
|
| Water Sensor
| Z-Wave
| Generic Z-Wave Water Sensor
|
|
|-
| Evolve
| Relay
| LFM-20
| Relay
| Z-Wave
| Generic Z-Wave Relay
|
|
|-
| Fibaro
| Door/Window Sensor 2
|
| Contact Sensor
| Z-Wave
| Fibaro Door/Window Sensor 2
|
|
|-
| Fibaro
| Flood Sensor
|
| Water Sensor
| Z-Wave
| Fibaro Flood Sensor
|
|
|-
| Fibaro
| Flood Sensor ZW5
|
| Water Sensor
| Z-Wave
| Fibaro Flood Sensor
|
|
|-
| Fibaro
| Motion Sensor ZW5
| FGMS-001
| Motion Sensor
| Z-Wave
| Fibaro Motion Sensor ZW5
|
|
|-
| Fibaro
| Single Switch 2
|
| Switch
| Z-Wave
| Fibaro Switch
|
|
|-
| Fibaro
| Wall Plug
|
| Smart Plug
| Z-Wave
| Fibaro Wall Plug
|
|
|-
| Fibaro
| KeyFob
|
| Button Controller
| Z-Wave
| Generic Z-Wave Button Controller
|
|
|-
| Fibaro
| Button
|
| Button Controller
| Z-Wave
| Generic Z-Wave Button Controller
|
|
|-
| First Alert
| Smoke & CO Alarm
| ZCOMBO
| Smoke/CO Detector
| Z-Wave
| Generic Z-Wave Smoke/CO Detector
|
|
|-
| GE
| Outlet
|
| Outlet
| Z-Wave
| Generic Z-Wave Outlet
|
|
|-
| GE
| Jasco Smart Switch Outlet
|
| Outlet
| Z-Wave
| Generic Z-Wave Outlet
|
|
|-
| GE
| Smart Switch Dimmer
| 14294
| Dimmer
| Z-Wave
| Generic Z-Wave Smart Dimmer
|
|
|-
| GE
| Smart Switch
| 14291
| Switch
| Z-Wave
| Generic Z-Wave Smart Switch
|
|
|-
| GE
| Outdoor Switch
|
| Switch
| Z-Wave
| Generic Z-Wave Switch
|
|
|-
| GE
| Smart Fan Control
|
| Fan Controller
| Z-Wave
| GE Smart Fan Control
|
|
|-
| GE
| Smart Fan Control ZW4002
|
| Fan Controller
| Z-Wave
| GE Smart Fan Control
|
|
|-
| GE/Jasco
| Switch
| 12722/ZW4001
| Switch
| Z-Wave
| Generic Z-Wave Switch
|
|
|-
| GE/Jasco
| Wall Switch
| 45856
| Switch
| Z-Wave
| Jasco Z-Wave Motion Switch
|
|
|-
| GoControl
| Glass Break Detector
|
| Glass Break Detector
| Z-Wave
| Generic Glass Break Detector
|
|
|-
| GoControl
| Garage Door Controller
|
| Controller
| Z-Wave
| Generic Z-Wave Garage Door Opener
|
|
|-
| Graber
| Z-Wave+ Roller Blinds
|
| Shade
| Z-Wave
| Generic Z-Wave Shade
|
|
|-
| Hank
| Four-Key Scene Controller
| HKZW-SCN04
| Button Controller
| Z-Wave
| Aeotec NanoMote
|
|
|-
| Hank
| One-Key Scene Controller
| HKZW-SCN01
| Button Controller
| Z-Wave
| Aeotec NanoMote
|
|
|-
| Hank
| RGBW LED Bulb
| HKZW-RGB01
| Smart Bulb
| Z-Wave
| Hank RGBW LED Bulb
|
|
|-
| Homeseer
| 200 Switch
|
| Switch
| Z-Wave
| Generic Z-Wave CentralScene Switch
|
|
|-
| Homeseer
| ZWave Plus Door/Window Sensor
| hs-ds100+
| Contact Sensor
| Z-Wave
| Generic Z-Wave Contact Sensor
|
|
|-
| Homeseer
| WD-200 Dimmer
|
| Dimmer
| Z-Wave
| HomeSeer WD-200 Dimmer
|
|
|-
| Homeseer
| 200 Dimmer
|
| Dimmer
| Z-Wave
| HomeSeer WD-200 Dimmer
|
|
|-
| Honeywell
| Z-Wave Thermostat
|
| Thermostat
| Z-Wave
| Generic Z-Wave Thermostat
|
|
|-
| Inovelli
| Outlet
|
| Outlet
| Z-Wave
| Generic Z-Wave Outlet
|
|
|-
| Inovelli
| Switch
|
| Switch
| Z-Wave
| Generic Z-Wave Smart Switch
|
|
|-
| Inovelli
| Switch Module
|
| Switch
| Z-Wave
| Generic Z-Wave Smart Switch
|
|
|-
| Inovelli
| Switch Module
|
| Switch
| Z-Wave
| Generic Z-Wave Switch
|
|
|-
| Iris
| Garage Door Opener
|
| Garage Door Opener
| Z-Wave
| Generic Z-Wave Garage Door Opener
|
|
|-
| Iris
| Smart Plug Z-Wave Repeater
|
| Smart Plug
| Z-Wave
| Generic Z-Wave Repeater
|
|
|-
| Kwikset
| 910/912 Lock
|
| Lock
| Z-Wave
| Generic Z-Wave Lock
|
|
|-
| Leviton
| Plug-in Dimmer Module
| VRMX1
| Smart Plug
| Z-Wave
| Generic Z-Wave Dimmer
|
|
|-
| Leviton
| Plug-in Appliance Module
| DZPA1
| Smart Plug
| Z-Wave
| Generic Z-Wave Outlet
|
|
|-
| Leviton
| Smart Dimmer
| DZ6HD-1BZ
| Dimmer
| Z-Wave
| Generic Z-Wave Smart Dimmer
|
|
|-
| Leviton
| Switch
| DZ15S
| Switch
| Z-Wave
| Generic Z-Wave Switch
|
|
|-
| Leviton
| Fan Controller
|
| Fan Controller
| Z-Wave
| Leviton Fan Controller
|
|
|-
| Linear
| Motion Sensor
| WAPIRZ-1
| Motion Sensor
| Z-Wave
| Generic Z-Wave Motion/Temperature Sensor
|
|
|-
| Linear
| Siren
| WA105DBZ-1
| Siren
| Z-Wave
| Linear/Vision Siren
|
|
|-
| Monoprice
| Contact Sensor
|
| Contact Sensor
| Z-Wave
| Generic Z-Wave Contact Sensor
|
|
|-
| Monoprice
| Z-Wave Plus Recessed Door/Window Sensor
| 15268
| Contact Sensor
| Z-Wave
| Generic Z-Wave Contact Sensor
| *
|
|-
| Monoprice
| Plugin Dimmer
|
| Dimmer
| Z-Wave
| Generic Z-Wave Dimmer
|
|
|-
| Monoprice
| Z-Wave Plus PIR Motion Detector With Temperature Sensor
| 15271
| Motion Sensor
| Z-Wave
| Generic Z-Wave Motion/Temperature Sensor
|
|
|-
| Monoprice
| Z-Wave Plugin On/Off
| 11995
| Smart Plug
| Z-Wave
| Generic Z-Wave Outlet
| *
|
|-
| Monoprice
| Outlet
|
| Outlet
| Z-Wave
| Generic Z-Wave Outlet
|
|
|-
| Monoprice
| Z-Wave Plus PIR Multi Sensor
| 15902
| Motion Sensor
| Z-Wave
| Zooz 4-in-1 Sensor
| *
|
|-
| Monoprice
| Z-Wave Plus Smart Plug and Repeater with 2 USB ports
| 27481
| Smart Plug
| Z-Wave
| Zooz Power Switch
| *
|
|-
| Nexia
| One Touch
| NX1000
| Controller
| Z-Wave
| Remotec ZRC DH
| *
|
|-
| NodOn
| Soft Remote
|
| Button Controller
| Z-Wave
| Generic Z-Wave Button Controller
|
|
|-
| NodOn
| Octan Remote
|
| Button Controller
| Z-Wave
| Generic Z-Wave Button Controller
|
|
|-
| Qubino
| Relay
|
| Relay
| Z-Wave
| Generic Z-Wave Relay
|
|
|-
| Radio
| Thermostat Z-Wave USNAP Module
|
| Thermostat
| Z-Wave
| Generic Z-Wave Thermostat
|
|
|-
| Radio
| CT101 Thermostat
|
| Thermostat
| Z-Wave
| Generic Z-Wave Thermostat
|
|
|-
| Radio
| CT100 Thermostat
|
| Thermostat
| Z-Wave
| Generic Z-Wave Thermostat
|
|
|-
| Remotec
| ZFM-80 relay
|
| Switch
| Z-Wave
| Remotec ZFM-80
|
|
|-
| Remotec
| ZRC-90US Button Controller
|
| Button Controller
| Z-Wave
| Remotec ZRC-90
|
|
|-
| Schlage
| Deadbolt Lock
|
| Lock
| Z-Wave
| Generic Z-Wave Lock
|
|
|-
| Schlage
| Touchscreen Lock
|
| Lock
| Z-Wave
| Generic Z-Wave Lock
|
|
|-
| Sensative
| Strips Guard
|
| Contact Sensor
| Z-Wave
| Generic Z-Wave Contact Sensor
|
|
|-
| Sensative
| Strips Multisensor
|
| Motion Sensor
| Z-Wave
| Strips Multi-Sensor
|
|
|-
| Somfy
| 2 Button Controller
|
| Button Controller
| Z-Wave
| Somfy 2 Button Controller
|
|
|-
| Telguard
| Switch
| GDC1
| Switch
| Z-Wave
| Generic Z-Wave Switch
|
|
|-
| Telldus
| Outlet Switch
|
| Smart Plug
| Z-Wave
| Generic Z-Wave Smart Switch
|
|
|-
| Utilitech
| Siren
|
| Siren
| Z-Wave
| Linear/Vision Siren
|
|
|-
| Vision
| Siren
| zm1601US-3
| Siren
| Z-Wave
| Linear/Vision Siren
|
|
|-
| Vision
| Siren
| zm1601US-5
| Siren
| Z-Wave
| Linear/Vision Siren
|
|
|-
| WaterCop
| Shutoff Valve
|
| Shutoff Valve
| Z-Wave
| Generic Z-Wave Valve
|
|
|-
| Wireless
| Smoke Detector
| ZWN-SD
| Smoke Detector
| Z-Wave
| Generic Z-Wave Smoke Detector
|
|
|-
| Yale
| YRD226 Lock
| YRD226
| Lock
| Z-Wave
| Generic Z-Wave Lock
|
|
|-
| Zipato
| Siren
|
| Siren
| Z-Wave
| Zipato Siren
|
|
|-
| Zlink
| ZL-WD-100 Dimmer
|
| Dimmer
| Z-Wave
| Generic Z-Wave CentralScene Dimmer
|
|
|-
| Zlink
| ZL-WS-100 Switch
|
| Switch
| Z-Wave
| Generic Z-Wave CentralScene Switch
|
|
|-
| Zooz
| Smart Chime
|
| Doorbell
| Z-Wave
| Dome Siren
|
|
|-
| Zooz
| Motion Sensor
| ZSE02
| Motion Sensor
| Z-Wave
| Generic Z-Wave Motion Sensor
|
|
|-
| Zooz
| Dimmer Switch
|
| Dimmer
| Z-Wave
| Generic Z-Wave Smart Dimmer
|
|
|-
| Zooz
| Smart Switch
| ZEN21
| Switch
| Z-Wave
| Generic Z-Wave Smart Switch
|
|
|-
| Zooz
| Water Valve
|
| Shutoff Valve
| Z-Wave
| Generic Z-Wave Valve
|
|
|-
| Zooz
| 4-in-1 Sensor
| ZSE40
| Motion Sensor
| Z-Wave
| Zooz 4-in-1 Sensor
|
|
|-
| Zooz
| Motion Sensor
| ZSE18
| Motion Sensor
| Z-Wave
| Zooz Motion Sensor ZSE18
|
|
|-
| Zooz
| Power Strip
|
| Power Strip
| Z-Wave
| Zooz Power Strip
|
|
|-
| Zooz
| Power Strip VER 2.0
|
| Power Strip
| Z-Wave
| Zooz Power Strip
|
|
|-
| Zooz
| Power Switch
| ZEN15
| Switch
| Z-Wave
| Zooz Power Switch
|
|
|-
| Zooz
| Smart Plug
| ZEN06
| Smart Plug
| Z-Wave
| Zooz Power Switch
|
|
|-
| ZWP
| WD-100 Dimmer
|
| Dimmer
| Z-Wave
| Generic Z-Wave CentralScene Dimmer
|
|
|-
| ZWP
| ZWP WS100 Switch
|
| Switch
| Z-Wave
| Generic Z-Wave CentralScene Switch
|
|
|-
| Lutron
| Caseta Switches
|
| Switch
| Lutron
|
| Lutron Integrator
| Caseta SmartBridge Pro
|-
| Lutron
| Caseta Dimmers
|
| Dimmer
| Lutron
|
| Lutron Integrator
| Caseta SmartBridge Pro
|-
| Lutron
| Caseta SmartBridge Pro
|
| Bridge
| Lutron
|
| Lutron Integrator
|
|-
| Lutron
| Pico Remotes
|
| Button Controller
| Lutron
|
| Lutron Integrator
| Caseta SmartBridge Pro
|-
| Lutron
| RadioRA 2 Select
|
| Bridge
| Lutron
|
| Lutron Integrator
| Radio RA2 Select
|-
| Lutron
| RadioRA 2 Keypads
|
| Keypad
| Lutron
|
| Lutron Integrator
| Radio RA2 Select
|-
| Lutron
| RadioRA 2 Motion Sensors
|
| Motion Sensor
| Lutron
|
| Lutron Integrator
| Radio RA2 Select
|-
| Lutron
| RadioRA 2 Main Repeater
|
| Repeater
| Lutron
|
| Lutron Integrator
| Radio RA2 Select
|-
| Lutron
| RadioRA 2 Switches and Dimmers
|
| Dimmer
| Lutron
|
| Lutron Integrator
| Radio RA2 Select
|-
| Lutron
| Serena Shades
|
| Shade Control
| Lutron
|
| Lutron Integrator
| Radio RA2 Select
|-
| Lutron
| Sivoia QS Shades
|
| Shade Control
| Lutron
|
| Lutron Integrator
| Radio RA2 Select
|-
| Amazon
| Echo
|
| Voice Assistant
| Cloud
|
| Amazon Echo Skill
|
|-
| Life360
| Life360 App
|
| Presence Sensor
| Cloud
|
| Life360 Connector
| Compatible Smart Phone
|-
| Sonos
| Speakers
|
| Speaker
| LAN
|
| Sonos Integration
|
|-
| Ecobee
|
|
| Thermostat
| Cloud
|
| Ecobee Integration
|
|-
| IFTTT
|
|
| Web Service
| Cloud
|
| IFTTT Integration
|
|-
| Nest
|
|
| Thermostat
| Cloud
|
| Nest Integration
|
|-
| Pushover Notifications
|
|
|
| Cloud
|
|
|
|-
| Rachio
|
|
| Irrigation Controller
| Cloud
|
| Rachio Integration
|
|-
| sharptools.io
|
|
| Dashboard
| Cloud
|
| SharpTools
|
|-
| Philips Hue
| Bridge
|
| Bridge
| LAN
|
| Hue Bridge Integrator
|
|}

Note: Aeotec was formerly known as Aeon Labs

Rule Machine

2018-10-17T05:28:00Z

SneakyPete: /* Conditions and Trigger Events */

Rule Machine is a powerful automation tool for Hubitat.

The Rule Machine User Guide has four sections below:

*Conditions and Trigger Events

*Actions

*Expert Features: Custom Commands

*Restrictions

==Conditions and Trigger Events==

Rules and Triggers respond to events on the selected devices. In the case of a Rule, it evaluates its rule upon any event affecting its Conditions. In the case of a Trigger, it is fired whenever the selected event occurs.

Devices with the following capabilities may be Conditions or Trigger Events: [with noted exceptions]

'''Acceleration'''

"active" or "inactive"

'''Battery'''

value

'''Between Two Times''

only between selected times

'''Button''' [Only available as Trigger Event]

"number": "pressed"or "held"

'''Contact:'''

"open" or "closed"

'''Certain Time''' [Only available as Trigger Event]

at a certain time, including sunrise or sunset with offset

'''Days of week''' [Only available as Condition]

"Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday", "Sunday"

'''Dimmer level'''

value

'''Door'''

"open", "closed", "opening", "closing", "unknown"

'''Energy meter'''

value

'''Garage door'''

"open", "closed", "opening", "closing", "unknown"

'''Humidity'''

value

'''Illuminance'''

value

'''Lock'''

"locked" or "unlocked"

'''Lock Codes'''

value

'''Mode'''

any of your location’s modes

'''Motion'''

"active" or "inactive"

'''Music player'''

"playing", "paused", or "stopped"

'''Periodic''' [Only available as Trigger Event]

Allows periodic schedules for minutes, hourly, daily, weekly, monthly or yearly

'''Physical switch''' [only available as Trigger Event]

"on" or "off"

'''Power meter'''

value

'''Presence'''

"present" / "not present" or "arrives" / "leaves"

'''Private Boolean'''

"true" or "false"

'''Rule truth'''

"true" or "false"

'''Switch'''

"on" or "off"

'''Temperature'''

value

'''Thermostat mode'''

"heat", "cool", "auto", "off" or "emergency heat"

'''Thermostat state'''

"heating", "cooling", "fan only", "idle", "pending heat" or "pending cool"

'''Time of day''' [Only available as Condition]

between two times, including sunrise or sunset with offsets

'''Water sensor'''

"dry" or "wet"

Note: '''value''' means compare current value to a number or to another device with an offset

'''Limitation:''' a rule may only have at most one each of Days of week, Mode, or Time of day as conditions. If you need logic for two different Time of day periods, that would have to be done in two separate rules. A trigger can have at most one each of Certain Time, Mode change, or Periodic schedule as trigger events. If you need more time events, that would have to be done in separate triggers.

== Actions ==

*Rules, Triggers, Triggered Rules and Actions run selected Actions.

*Rules and Triggered Rules run Actions for True or Actions for False depending on Rule evaluation outcome.

*Triggers and Actions just run Actions.

'''Delay these actions''' [by minutes, seconds, or milliseconds, with optional cancel on change, or random time]

This selection causes all of the selected actions in a Rule (for Actions for True, Actions for False, or simply Actions) to be delayed. A delay of minutes or seconds may apply for any action. Delays of less than 60 seconds may not work reliably. A delay of milliseconds only applies for actions on, off, dim level, open, and close. For delays in Rules of minutes or seconds, an option to Cancel on truth change is available. If selected, should the rule truth change before expiration of the delay, the delayed actions are cancelled. A random delay is also available. This will be for a random number of seconds up to the delay time selected.

'''Turn on these switches'''

This action turns on the selected switches.

'''Turn off these switches'''

This action turns off the selected switches.

'''Toggle these switches'''

If the selected switches are on, this action turns them off, and if they are on, it turns them off.

'''Turn on or off these switches after a delay'''

This action turns on or turns off the selected switches after a delay. The choice between on or off is available, with off being the default. Delays of minutes, seconds or milliseconds may be selected. Delays of less than 60 seconds may be less reliable. Delays of up to 5000 milliseconds seem to be fairly reliable.

'''Turn on or off these switches after a delay, pending cancellation'''

This action turns on or turns off the selected switches after a delay, pending a change of rule truth. Should rule truth change before the expiration of the delay, the delayed action is cancelled. The choice between on or off is available, with off being the default. This action is not available for Triggers or Actions, only for Rules. (Rules Rule!)

'''Push a button'''

This action causes the selected button to be pushed.

'''Push button per mode'''

This action causes a selected button to be pushed depending upon the current mode. Multiple modes with corresponding buttons can be selected.

'''Set these dimmers'''

This action sets the selected dimmers to the selected level with an optional fade time, or tracks another dimmer’s level.

Track event dimmer works along with a Condition or Trigger Event of “Dimmer level”. When this dimmer level event causes the rule to run this action, the selected dimmers are set to the same level as the dimmer that triggered the rule. This can be used in automations where a group of dimmers follow another dimmer as it changes level. The typical usage for a Trigger is to have a Trigger Event of “Dimmer level >= 0”, and then Track Dim as the action.

'''Set these other dimmers'''

This action sets the selected dimmers to the selected level with optional fade time, allowing a second dimmer level for each rule.

'''Toggle these dimmers'''

If the selected dimmers are on, this action turns them off. If the selected dimmers are off, it sets them to the selected level. Optional fade time may be selected.

'''Adjust these dimmers'''

This action adjusts the selected dimmers’ level up or down by the selected amount, with optional fade time. Dimmer values range from 0 to 100. Adjusting to 0 does not necessarily mean that the device is turned off.

'''Set these dimmers per mode'''

This action sets the selected dimmers to the level selected for the current mode, with optional fade time. Multiple modes with corresponding dimmer levels can be selected.

'''Capture the state of these switches'''

This action captures the state of the selected switches, including on/off, hue, saturation and level. The captured state can be used in the “Restore the state of captured switches” action.

'''Restore the state of captured switches'''

This action restores the state to the devices selected in the “Capture the state of these switches” action, restoring the devices to the state captured by the most recent Capture action run. It is up to the user to design and use the rule such that Capture occurs prior to Restore. It is possible to select a delay for Restore, and optionally to Cancel such a delay on rule truth change.

'''Set color temperature for these bulbs'''

This action sets the colour temperature for the selected bulbs. {a sic compromise}

'''Set color for these bulbs'''

This action sets the colour and level for the selected bulbs.

'''Open these garage doors'''

This action opens the selected garage doors.

'''Close these garage doors'''

This action closes the selected garage doors.

'''Locks to lock'''

This action locks the selected locks.

'''Locks to unlock'''

This action unlocks the selected locks.

'''Adjust this fan — Low, Medium, High, Off'''

This action adjusts a fan switch with successive trigger events first to low, then medium, then high, then off. To simply set a fan switch to low, medium or high, treat it as a dimmer and set the dimmer level to 20, 50, or 80 respectively.

'''Open these valves'''

This action opens the selected valves.

'''Close these valves'''

This action closes the selected valves.

'''Set these thermostats'''

This action sets various settings of a thermostat. The thermostat mode, heating setpoint, cooling setpoint, and fan setting can be selected. It is possible to adjust the heating or cooling setpoints up or down by a selected amount. For thermostat mode, the choices are “auto”, “heat”, “cool”, “off” and “emergency heat”. For the setpoints and adjustments, the number input may have a decimal fraction, e.g. 21.5, which is helpful with degrees Celsius devices. For fan setting, the choices are “on” and “auto”.

'''Set the mode'''

This action sets the location mode to the selected mode.

'''Send http request'''

Sends asyncGET to URL; allows %device% and/or %value% in URL for last event device and/or value

'''Send or speak a message'''

This action sends a push or notification, as selected, and optionally includes the name of the device that triggered the actions. It can also send an SMS to multiple phones (separate the numbers with *). This action also supports devices that speak or process text to speech.

'''Take photos'''

This action takes a burst of photos with the selected camera.

'''Evaluate Rules'''

This action causes the selected Rules to be evaluated.

'''Run Rule Actions'''

This action causes the Actions for True or Actions for the selected Rules to be run.

'''Update Rules'''

This action causes the selected Rules to be updated to refresh subscriptions and schedules.

'''Evaluate Rules after delay'''

This action causes the selected Rules to be evaluated after a delay of a selected number of minutes. This action allows the Rule it is used in to be the Rule selected to be evaluated after the delay; this is a looping mechanism.

'''Set private Boolean'''

This action sets the Rule’s private Boolean variable to true or false, and/or the private Boolean variable of other Rules to true or false. There is an option to delay this. If the action is to set the rule’s own private Boolean with a delay, the delayed action is treated as an event, causing rule evaluation or possibly a trigger event. Setting a private Boolean of another rule is treated as an event by that rule. Setting a rule’s own private Boolean is not an event unless it is delayed. Private Boolean with a delay may be used to create a looping mechanism. It is possible to have a delay cancelled upon rule truth change.

'''Run custom commands'''

This action runs selected custom commands. Custom commands must first be created and saved in the Expert Features section of Rule Machine.

'''Switches Per Mode'''

Activates selected switches during specified mode.

'''Activate Scene Per Mode'''

Activates selected Scene during specified mode.

'''Delay (Cancel) Per Mode'''

Delays automation by a specified amount of time during selected modes.

== Expert Features: Custom Commands ==

With custom commands, you can explore any device you have to see the commands that it offers. There are two steps required to use those commands in your rules, and then a third to manage your commands.

*Create, test and save your custom command with “Tap to create Custom Commands” on the Rule Machine main page

*Incorporate the saved custom command into your rules with “Run custom commands”

*Manage custom commands with “Delete saved commands” and “Test saved command on…”

#Create, test and save your custom command

:*Open Rule Machine

:*Under Expert Features “Tap to create Custom Commands”

:*Select a capability for devices to test for available commands (if unsure, try Actuator)

:*Select a device of that capability to test for commands

:*Select New custom command to see the available commands, then select the command you want

:*Once selected, the command will be tested on the selected device and the results of the command execution shown

:*Add any required parameters to the command

:*After the command is executing against the device as expected, select Save command now, then Done, then Done again to return to the Custom Commands page

:*The saved custom command will now be available in your new and existing rules

#Select the custom command to run in your rule and the devices to run it on

:*Create a new rule or edit an existing one

:*In the Actions section (at the very bottom), select Run custom command, then select the custom command (saved above) and the devices to run it on

Be sure that each device selected supports the selected command; any errors will be trapped and shown in the logs.

#Manage custom commands
One or more custom commands can be removed by selecting them in Delete Custom Commands, then Delete commands now, then Done. You can also test saved custom commands against other devices you might select.

== Restrictions ==

The Restrictions section of defining a rule allows you to restrict when or under what conditions the rule may run. When restricted, the rule does nothing and timers are ignored. Restrictions may seem similar to some Conditions, but they are actually quite distinct. Restrictions do not participate in the logic of the Conditions and the Rule in any way. Restrictions simply enable or disable the rule from doing things. Conditions, on the other hand, are subscribed to their events, and those events cause rule evaluations to occur, and possibly actions to run. A restriction doesn’t do any of those things, it merely restricts.

The restriction options are:

'''Only during a certain time [including sunrise or sunset with offsets]'''

This setting restricts when a rule may run to a certain time period, start and stop. Outside of the selected time period, the rule will do nothing, all outstanding timers are ignored.

'''Only on certain days of the week'''

This setting restricts when a rule may run to certain days of the week. On days not selected, the rule will do nothing, all outstanding timers are ignored.

'''Only when mode is …'''

This setting restricts the rule to only run when the location’s mode is one of the modes selected. At any time when not in one of the selected modes, the rule will do nothing, all outstanding timers are ignored.

'''Switch to disable Rule'''

This setting selects a switch device, possibly virtual, which if on disables the rule. If off, the rule is enabled. There is an option to reverse the meanings of on and off, so that on means enable, and off means disable. When the rule is disabled, the rule will do nothing, all outstanding timers are ignored.

'''Enable/Disable with private Boolean?'''

This setting allows the rule’s private Boolean variable to act as an enable / disable selector. If this option is selected, then the rule is enabled when its private Boolean is true, and is disabled when its private Boolean is false. Other rules may set the rule’s private Boolean. The private Boolean variable is initialized to true when a rule is created, so when selecting this option to use private Boolean to disable, the rule will start out enabled. When the rule is disabled, the rule will do nothing, all outstanding timers are ignored.

Mode Manager

2018-10-17T05:15:15Z

SneakyPete:

Mode Manger is a simple way to configure your modes. Modes are a valuable tool for setting automations in Rule Machine and other apps. Modes can be created, renamed and deleted in the ''Location'' page in the Web Interface. Once your modes are created, you can configure them here in Mode Manager.

Using Mode Manager, modes can be set based on time (either set around sunset/sunrise or a specific clock time), days of the week, by presence sensors or by a button.

'''SET MODE BASED ON TIME'''
#Load/Open the the Mode Manager app in your Hubitat Web Interface.
#If you want your modes to be different on different days of the week (for example you want day mode to start later on Saturday mornings so you can nurse your hangover), toggle the ''Configure with daily settings'' to ''on''.
#:[[File:MM1.png|300px]]
#Click on ''Set modes based on time of day''. Each mode except Away mode has an area to set its mode.
#:[[File:MM2.png|300px]]
#The first dropdown menu allows to choose between setting the mode at a specific time or the earlier of two times. This option is convenient if, for example, you want to have evening mode start at the earlier of sunset or 7:00.
#:[[File:MM3.png|300px]]
#Next you will set the time(s). You can choose a specific time or sunrise or sunset. Sunrise/sunset times may be offset by entering a +/- number into the field. When you have made your selection, click ''Done''.
#:[[File:MM4.png|300px]]
#If you selected the ''configure with daily settings'' option, use the dropdown menu to select the days you want this time setting to apply. When you do, an additional ''Set Day Mode Based On'' field will appear. Follow steps 2-5 until you have set all of the times and days you want for this mode.
#:[[File:MM5.png|300px]]
#Follow this same process for any additional modes you want set by time. Leave any modes you don’t want set by time blank.

'''SET MODES BASED ON DAYS OF THE WEEK'''
If you want a mode to trigger on a specific day of the week (for example you might have a weekend mode that you want to trigger on Saturday and Sunday) you can set that here.
:[[File:MM6.png|300px]]
Simply use the dropdown list below the mode you want to set and select the days you desire. Leave any modes you don’t want to set by day blank.
:[[File:MM7.png|300px]]

'''NOTE:''' If you are also setting modes based on time of day, be sure to configure with the daily settings on and leave any days you want to set by day of the week blank. Otherwise the time settings will override your daily mode settings.

'''SET MODES BASED ON PRESENCE'''
Before you can set a mode based on presence, you will need to set up and configure a presence sensor in order to set mode based on presence. You can set any mode based on presence, but the most common mode is Away mode. Away mode acts differently than other modes in that it overrides any other mode when you are away from home. However, when you come back home, you want your home to kick into what ever mode it is supposed to be in at that time. This is what Use time settings for Return From Away Mode does. If you do not select this, when you return home your mode will not change until the next mode change.

If you have multiple people in your home, you will probably want each of them to have a presence sensor. That way you can configure Away mode to kick in whenever all of the presence sensors are gone and Return From Away Mode will activate when any one presence sensor returns.

Ok, let’s start.

#Click on ''Set modes based on presence''
#Select if you want to use time settings for ''Return From Away'' (you probably do). A box will appear for you to select which presence sensors you would like to trigger ''Return From Away Mode.''
#Select which presence sensors want to use to trigger the mode.
#Select the minimum number of sensors you want to trigger the mode (for example, Away mode you would want triggered only when all sensors are gone).
#Select if you want the mode triggered when the sensors leave or arrive.
#You have the option to restrict the mode change between two times by clicking the ''only between two times'' toggle. Use the dropdown menu to select between using sunrise/sunset or a specific time, enter your times and click ''Done''.
#Follow these same steps for any other modes you want set by presence sensors. Leave any other modes blank. When your modes are set, click Done.

'''SET MODES WITH BUTTON DEVICES'''

Button device are a popular way to set modes that may not fall on a regular schedule, especially a night. Many people set a button by their bed that they can press when they are ready to sleep to kick the house into night mode.

#Click on ''Set modes with button devices''.
#:[[File:MM8.png|300px]]
#Each mode you have will be represented by a box. If want to use a button to trigger Return From Away Mode, toggle on ''Use time settings for Return From Away Mode''. A box will appear for you to select which button you would like to trigger Return From Away Mode.
#Select which button(s) you would like to use to trigger the mode.
#:[[File:MM9.png|300px]]
#Select the button number.
#:[[File:MM10.png|300px]]
#Select if you want the button held or pushed to trigger the mode.
#:[[File:MM11.png|300px]]
#Follow steps 3-5 for any modes you want set with buttons. Leave any other mode blank. When you are done setting your modes with buttons, click Done.

'''SET MODES WITH SWITCHES'''

Modes can also be set with switches. Detailed documentaion to come.

Hubitat Safety Monitor

2018-10-17T05:11:52Z

SneakyPete:

Hubitat Safety Monitor lets you set intrusion alerts, safety warnings and other customer alerts. Your alerts can include text messages, push notifications, alarms, flashing lights and more.

We’re going to set up our Intrusion Alerts first, although you can set your alerts in any order you choose. Once your first alert is set you will see options to configure your armed states that we will discuss below. For reference, the available states are:

:'''Armed-Away:''' Your hub is in away mode and your alerts are turned on.

:'''Unarmed-Away:''' Your hub is in away mode but your alerts turned off.

:'''Armed-Night:''' Your hub is in Night mode and your alerts are turned on.

:'''Unarmed-Night:''' Your hub is in Night mode but your alerts are turned off.

:'''Armed-Home:''' Your hub is in any other mode and your selected alerts are turned on.

:'''Unarmed-Home:''' Your hub is in any other mode but your selected alerts are turned off.

==Setting Your Intrusion Alerts==
We're going to use ''Intrusion-Away'' as our example, but these same steps apply to setting your ''Intrusion-Home'' alerts and alerts for water, smoke and carbon monoxide.

#Open/load Hubitat Safety Monitor in the Hubitat Web Interface.
#Click ''Intrusion-Away''.
#:[[File:HSM1.png|300px]]
#:'''NOTE:''' You can set different intrusion alerts for when you are home and when you are away. Many people like to set all of their motion and contact sensor to alert them when they are away and only windows and door sensors to send alerts when they are home.
#Now you will select the sensors you want to alert you when they are triggered while your home is in its Armed-Away state. If you want to use every sensor in your system, toggle the ''Use every open/close, motion and shock sensor'' switch to ''on''. Otherwise you can select your sensors individually. Choose from your open/close sensors, motion sensors and shock (window break) sensors.
#:[[File:HSM2.png|300px]]
#When your sensors are selected, move down to ''Configure Intrusion Alerts''. Here you will select the devices you wish to alert you when an intrusion is detected. Click on any one of the alert types and a unique configuration window will appear:
#:'''Text Alerts'''
#:#First write the message you wish to send with the alert is triggered, such as “ALERT! Hubitat Safety Monitor has been triggered.” or “Some stupid jerk is breaking into your house!” You can also choose to include the name of the device that triggered the alarm in your message.
#:#Next, add the phone number you wish to text using SMS format: +1<10 digits> (For example 1-555-867-5390 would be +1<5558675309>). You can add multiple number by separating them by a comma. There is a limit of 10 text messages per day.
#:#:[[File:HSM3.png|300px]]
#:#Click ''Done'' to save your text alert configurations
#:'''Siren Alerts'''
#:#Select the siren(s) you want to use from the dropdown menu, then select the function you want to trigger. You may select multiple functions (such as strobe and siren) if your device has multiple warning capabilities.
#:#:[[File:HSM5.png|300px]]
#:#Click ''done'' to save your siren alert configurations.
#:'''Lights Alerts'''
#:#Using lights to scare off intruders can be very effective. Here you can use the menus to select which lights you want to turn on (and if they are dimmers, at what level), which lights you want to flash and which lights you want to change color.
#:#:[[File:HSM6.png|300px]]
#:#Click ''Done'' to save your Lights Alert configurations.
#:'''Audio Alerts'''
#:#If you have a speech device or speaker that can convert text to voice, you can configure them here. Start by entering your text in the Message to Speak field. Use the toggle to select if you want the message to include the name of the triggered device.
#:#Next, select the speech or music device(s) you want to send the message to.
#:#Click ''Done'' to save your Audio Alerts configurations.
#When you have configured the Intrusion Alerts you want, click ''Done''.
#:#:[[File:HSM7.png|300px]]

Once you set your first alerts, you will notice a few changes to the Hubitat Safety Monitor home screen. At the top of the screen you will see the current armed state in red (it will start as disarmed). A new link titled ''Configure Arm/Disarm for Automatic, Keypads, Buttons and Cancel'' is now in the menu. Finally you will see a new section titled Arm and Disarm. Below it will be buttons for you to manually arm your monitoring states.

:[[File:HSM14.png|300px]]

Let's start by configuring your Arm/Disarm settings.

== '''How to Configure Your Arm/Disarm Settings''' ==

You can configure your home and away states to be armed automatically during certain modes or manually by using buttons. You can also set delays and designate buttons or switches to cancel alerts. Here’s how:

#Click ''Configure Arm/Disarm for Automatic, Keypads, Buttons and Cancel''.
#There are four section on this page, each with their own settings:
#:'''Configure automatic arm/disarm.'''
#:If you would like your system to automatically arm itself during certain modes, you'll set that here. Use the dropdown menus to select which modes will arm you Away state and which modes will arm your Home state. You can select multiple modes for each of these states. You can also select the modes that will disarm your Intrusion alerts.
#::[[File:HSM10.png|300px]]
#:'''NOTE:''' If you set your system to automatically arm during a certain mode, it will NOT automatically disarm when that mode changes. Therefor you MUST set your automatic disarm modes (or set your disarm buttons below) or you could be in for a very rude surprise when your system doesn't disarm itself.
#:'''Use Delays for Arming or Alerts'''
#:Some people like to delay their alters and armed states by a few seconds. For example, if you arm your Away state using a button in your house, you may want build in a 20 second delay to allow yourself to get out of the house before it is actually armed. Conversely, you can delay your alerts for a few seconds to give you a chance to disarm your alert with a kill switch if you accidentally trip your alarm.
#:To add the delay, simply enter the number of seconds you wish to delay the arming or the alert in the appropriate box.
#::[[File:HSM11.png|300px]]
#:'''Use Buttons pushed to arm/disarm'''
#:Buttons are a convenient way to manually arm or disarm your intrusion alerts. Many people keep a button by their bed to arm/disarm their Home alerts when they go to bed or wake up. Others use a hidden button near their door to arm/disarm their Away alerts. Use the designated boxes to select the buttons you would like to use to arm you Home or Away alerts or to disarm the system. When you select your button device you will be asked to select which button to use. If your device only has one button, select 1.
#::[[File:HSM12.png|300px]]
#:'''Cancel Alert Options'''
#:Setting your Cancel Alerts Buttons or Switches is very important. First, if you set a delay for your intrusion alerts, you’ll want an easy way to cancel the alert before it fires after the delay. Second, if your alerts are triggered (especially sirens), you’ll want a way to shut them off when they get triggered without having to go into the Hubitat Web Interface.
#:You have a choice of canceling your alerts using buttons or switches. Select the buttons or switches you want to use to cancel your alerts by clicking on the appropriate boxes.
#::[[File:HSM13.png|300px]]
#When you are done configuring you arm/disarm opens, click ''done''.

== Setting Custom Monitoring Rules ==

#In Hubitat Safety Monitor, click ''new custom monitoring rule.''
#Name your Custom Monitoring Rule and click ''continue''.
#Select the type of device you would like to use to trigger your custom alerts. You can choose from:
#:*Temperature Sensor
#:*Contact Sensor
#:*Vibration Sensor
#:*Motion Sensor
#:*Humidity Sensor
#:*Shock Sensor
#:*Lock
#:*Battery Level
#:*Tamper Sensor
#:*Presence Sensor
#:*Sound Sensor
#When you select a type of device, a bevy of options will appear. Select the specific device(s) you would like to monitor (some devices, such as battery level, give you a toggle switch to select all devices). Then select the specific states that will trigger an alert. This varies by device.
#Next, select the type of Alerts you would like to receive. These options are exactly the same as you will find for setting Intrusion Alerts.
#Custom alerts are not armed in the same manner as intrusion alerts. To arm your Custom alert, you can use the ''arm this rule'' button if you want it on all the time. Or you can click the ''restrictions'' link to automate rule. The available restrictions include:
#:*'''Only between two times''- these can be specific times or sunset/sunrise
#:*'''Only on certain days of the week'''- check any days that apply
#:*'''Only when mode is'''- select the modes you want this rule active
#:These restriction can be used together. For example you can say the rule applies only between sunrise and sunset on Tuesdays during day mode.
#When your custom monitoring rule is complete, click ''done.''
#You will see a new child app with the name you gave your rule has been added below the Hubitat Safety Monitor app. Use this link to edit your new rule.

Groups and Scenes

2018-10-17T05:05:27Z

SneakyPete: /* How to create and capture a Scene */

Groups and Scenes are two distinct ways combine devices for simplified automation.

'''Groups''' let you select a collection bulbs, dimmers and switches that you would like to act together as if they were a single device. This means they will all turn on/off, change level, and change color together using a single "group device" in our rule-building apps or in Alexa. In addition to making rules easier, the Zigbee Group Messaging option allows you to group zigbee lights together to eliminate the "popcorn effect" when you turn them on.

'''Scenes''' are used to capture a group of devices in their unique states. Once that scene is captured, Hubitat Elevation can activate to return those the devices back to this captured state when you desire. This new scene is turned into a virtual device that is activated using rules or Alexa commands.

== How to Create a new Group ==

#Open the ''Groups and Scenes'' app in the Hubitat Web Interface.
#Click ''Create New Group''
#Give your new group a name. This is the name you will use to control the group via your smart speaker so make it easy to understand.
#Use the drop down menus to select the devices you'd like to include in your group. You can include bulbs, dimmers and/or switches.
#Use the toggle to select if you would like to ''Enable Zigbee group messaging.'' This option groups together all Zigbee devices into a Zigbee Group. This feature allows all of those grouped Zigbee devices to turn on or off together simultaneously -- no popcorn effect -- or to dim together simultaneously. The Group may have non-Zigbee devices in it as well, and these will turn on or off or dim at the very same time, but possibly with some popcorn effect.
#Once your group options are selected, click ''done''. Your new group will now be available as a device in our rule-building apps.

== How to create and capture a Scene ==

Creating a scene is a multistep process. The first step is to select the device you want in your scene using the app. Next you will need to set and capture those devices. Finally you will be able to activate the scene .

'''Create a New Scene'''

#Open the ''Groups and Scenes'' app in the Hubitat Web Interface.
#Click ''Create New Scene''
#Give your new scene a name. This is the name you will use to activate the scene via your smart speaker so make it easy to understand.
#Use the drop down menus to select the devices you'd like to include in your scene. You can include bulbs, dimmers and/or switches.
#If you would like a button to be pressed when you activate a scene (which you can configure using the Button Controllers app or Rule Machine), select it here.
#You have the option to add restrictions to your Scene. This limited the Scene to only being active during certain modes or conditions. Your restriction options include:
#:'''Only between two times'''
#:'''Only on certain days of the week'''
#:'''Only when mode is'''
#:'''Only when illuminance is'''Select an illuminance sensor and light level
#:'''Switch to disable scene''' Toggle ''Disable when off'' switch to ''on'' if you want the switch to disable the scene when it is in the off position.
#:'''Ignore Off of disable switch'''Toggle this switch ''on'' if you do not want the scene to turn off when the activation switch is turned off. The default is that the entire scene will turn off when the switch is turned off.
#:'''Transition Time'''Select a time for your scene to transition back to their normal state.
#Once your devices and restrictions are selected, click ''done''.

Now that your devices are selected you need to capture the state of those devices as you want them in the scene. If you go into your the Devices page in your Hubitat Web Interface, you'll notice two new devices have been added. One is the name of Scene you just created. The the other is the name of the scene you created followed by "capture." You can use this second device to capture the state of your devices to build your scene.

'''Capture the Scene'''

#Start by adjusting all of the devices in your scene to the level you desire. Turn off the devices you want off, turn on the devices you want on, set dimmers and colors to create the perfect setting.
#With your devices set, go to your devices list in the Hubitat Web Interface and click on the ''[Scene Name] Capture'' device you just created. When the device opens, click the ''on'' button. Your scene is now captured. To make capturing a scene easier, you can add the ''[Scene Name] capture'' device to your Hubitat Dashboard as a momentary button, then turn it on from the dashboard to capture the scene. You could also add it to your Alexa device list, then say ''Alexa, turn on [Scene Name] Capture'' to capture your scene.
#You can adjust your scene capture settings at any time simply by adjusting your devices, then turning on the ''[Scene Name] Capture'' device.

'''Activate the Scene'''
Once your scene has been captured,

To Activate a Scene you will use the newly create Scene device. The Scene device can be used as a button or switch in other automations, including Simple Lighting, Motion Lighting, Button Controller or Rule Machine, or it can be placed in a Dashboard. You can also activate your scene using Alexa. If the scene Switch is turned off, all of the member devices are turned off. There is an option for a Scene when activated to push a button of a button device, such as a keypad. This is useful for activating scenes (phantom buttons) in a Lutron system.