¶ Device Detail Page
The Device Detail page is accessed by navigating to Devices (in the sidebar of the hub UI) and then selecting a particular device from the list.
This page allows you to view the current device state; manually send commands to the device; edit device information; and view or edit the device name, preferences, and other details about the device. This page may look slightly different for different devices, depending on the device and driver.
- Events (A) takes you to a page showing a recent history of events (generally changes under "Current States") and commands sent to the device, which can be helpful for troubleshooting. See device events for more details.
- Logs (B) is a shortcut to the Past Logs page filtered to entries for this device.
- Commands (C) are buttons that allow you to manually send a command to the device (e.g., to try to turn the device on or off or change some other state). While many commands are device-specific, there are some common ones:
- On and Off: turns the device on or off (usually found on switches, dimmers, bulbs, etc.)
- Configure: Pressing this button causes the driver to execute its
configure()function. This function usually sends configuration commands to the Zigbee or Z-Wave device, instructing those devices on how to report status updates back to the Hubitat hub or setting preferences chosen in the UI. This normally happens automatically whenever a device is initially added to the hub, but it is also generally a good idea to run if you manually change drivers. - Refresh: polls the device to retrieve new current states (see below). Note that battery-powered devices, especially Z-Wave ones, may need to be “woken up” before they will report back.
- Current States (D) shows the current status of the device and can be as simple as one state showing "on" or "off", but it may also include other status readings such as battery level and temperature, etc. Technically, these states are composed of an attribute (or event name) and value. For example, in the screenshot above, the
switchattribute has a value ofon. - State Variables (E) are generally intended only for internal use by the driver and are not of concern for regular use of the device (they can be helpful to consult if you are developing a driver or working with a developer to troubleshoot). Different drivers/devices may put different information here or, as in the example above, none at all.
- Preferences (F) is where you can configure device or driver behavior. Most drivers offer options to enable or disable debug logging (which may be helpful for troubleshooting driver behavior or working with the developer) or event description logging (which can be helpful to see event history in Logs if that is helpful for app or other troubleshooting). Devices may also have some settings that you can configure here. Consult the device user manual or the custom driver developer for specifics on how to adjust these preferences. Select Save Preferences to save any changes made in this section.
- The hub provides the Status attribute for Devices/Rooms preference for all devices automatically. This chooses which attribute from "Current States" has its value displayed in the Status column on the Devices and Rooms pages. For example, if you select "switch," you will see "on" or "off" in the Status column for this device. (You can also edit this setting from the Rooms or Devices pages themselves using the pencil icon in this column, enabled from the display settings on the page if not visible.) Options include:
- Device Information (G) is where you can change the device name or label and other device data. Options include:
- Device Name: Often set by the hub automatically when adding the device; will be used as the dispaly name if no Device Label is provided.
- Device Label: Will be used as the display name for the device (in the Devices list, Logs, device selectors in apps, etc.) if specified.
- Type: shows the current driver and allows you to change the driver to another one if needed (e.g., if the proper driver was not automatically selected when adding the device).
- This section also provides options for conveniently enabling the device for use with certain hub features (not all options may not appear if the corresponding hub feature is not set up):
- Room: Allows easy assignment of this device to a Room (can also be done from the Rooms page)
- Dashboards: Allows easy authorization of this device for the selected Hubitat Dashboard apps (the same as can be done from Apps > Hubitat Dashboard and then the particular Dashboard app in which you wish to authorize the device)
- Hub Mesh enabled: Allows you to add your device to Hub Mesh (can also be done via Settings > Hub Mesh; note that this option refers to the the Hub Mesh feature that allows sharing device events and commands to other Hubitat hubs on your network, not to Z-Wave or Zigbee mesh behavior)
- HomeKit enabled: Adds the selected device to the HomeKit integration (can also be done via Apps > HomeKit Integration, which also provides additional options for what device features are exposed to HomeKit)
- Save Device (H): Select to save any changes made to the Device Information section
Device Name vs. Device Label: The “Device Name” is used as the display name if no “Device Label” is specified; otherwise, the “Device Label” is used. The display name affects how devices appear in device lists inside apps, in logs, and other places throughout the interface — as well as the default name when used with apps that provide integrations to other services, like Alexa, Google Home, or HomeKit. Most devices let you edit either or both to your liking. In some case, the "Device Name" may be set by a parent driver/app or integration. In general, we recommend using "Device Label" as the name you want to see and use for a given device.
- Device Details (J) allows you to view metadata about the device, including when it was created on Hubitat and device-specific data the platform or driver adds to this section. This section also shows what apps are using this device under the "In use by" section, which can be particularly handy when removing or swapping devices.
- Scheduled Jobs (K) shows any jobs the driver has scheduled for itself. Note that this does not reflect anything that an app (automation) may have scheduled for that device; that information would be found in App Status, generally as configured in the app's regular interface. (This information is often only useful when troubleshooting a driver with the developer or driver code you are writing as a developer yourself.)
- Remove Device (L) allows you to remove the device from Hubitat. Be sure to remove the device from any apps using the device before removing it; apps using the device will be shown under the In Use By section. If this device is a Z-Wave device, be sure to put the device in exclusion mode (check the manufacturer's instructions) when using this option. Most Zigbee devices do not require this, though you may still reset the device manually if necessary, nor do most Matter, LAN, and other devices. The manual for your device should have specific exclusion or removal instructions if needed.