Difference between revisions of "App Status"

From Hubitat Documentation
Jump to: navigation, search
(Settings)
(Settings)
Line 15: Line 15:
  
 
[[File:App Status - Settings 2.png|none|thumb|600x600px|link=https://docs.hubitat.com/images/c/cb/App_Status_-_Settings_2.png
 
[[File:App Status - Settings 2.png|none|thumb|600x600px|link=https://docs.hubitat.com/images/c/cb/App_Status_-_Settings_2.png
]]
+
|alt=The Settings section of the apps status window displays the app capabilities by "name" in the first column, the capability "type" in the second column, and the app capability "Value" in the third column]]
  
 
===<big>Event Subscriptions</big>===
 
===<big>Event Subscriptions</big>===
Line 29: Line 29:
  
 
[[File:App Status - Event Subscriptions.png|none|thumb|600x600px|link=https://docs.hubitat.com/images/4/4e/App_Status_-_Event_Subscriptions.png
 
[[File:App Status - Event Subscriptions.png|none|thumb|600x600px|link=https://docs.hubitat.com/images/4/4e/App_Status_-_Event_Subscriptions.png
]]
+
|alt=The "Event Subscriptions" section of the App Status page lists the "Source" of the Event Subscription in the first column, the "Event" that has been subscribed to in the second column, the "Handler" method in the third column. This is the method inside the code that will be called when the event is triggered, and a "Filter" column that corresponds to "sendEvent" from the device driver, and whether or not it has true and false filter events.]]
  
 
===<big>Application State</big>===
 
===<big>Application State</big>===
 
<big>This is the data storage of the app. Anything written to ''State'' will show up here as a pairing of '''Name''' and '''Value.'''</big>
 
<big>This is the data storage of the app. Anything written to ''State'' will show up here as a pairing of '''Name''' and '''Value.'''</big>
 
[[File:App Status - Applications State.png|none|thumb|600x600px|link=https://docs.hubitat.com/images/8/8d/App_Status_-_Applications_State.png
 
[[File:App Status - Applications State.png|none|thumb|600x600px|link=https://docs.hubitat.com/images/8/8d/App_Status_-_Applications_State.png
]]
+
|alt=The "Application State" section of the App Status page displays anything written to "State". It will show up here as a pairing of Name and Value.]]
  
 
===<big>Scheduled Jobs</big>===
 
===<big>Scheduled Jobs</big>===
Line 48: Line 48:
 
*<big>'''Schedule''' is the frequency of the job. Once, every ''x'' or a cron schedule are possible values.</big>
 
*<big>'''Schedule''' is the frequency of the job. Once, every ''x'' or a cron schedule are possible values.</big>
  
[[File:App Status - Scheduled Jobs.png|none|thumb|600x600px|link=https://docs.hubitat.com/images/7/7e/App_Status_-_Scheduled_Jobs.png]]
+
[[File:App Status - Scheduled Jobs.png|none|thumb|600x600px|link=https://docs.hubitat.com/images/7/7e/App_Status_-_Scheduled_Jobs.png|alt=The "Scheduled Jobs" section of the App Status page shows the "Handler" in the first column. This is "what" will be triggered. In the second column is the "Next Run Time", which is when the "Handler" is scheduled to run. The "Previous Run Time" column shows when the handler last ran, and the Status column shows whether the job is "Pending" or "Active". Lastly, the "Schedule" column displays the frequency of the job.]]
  
 
*
 
*

Revision as of 19:36, 12 April 2021

Go to the top of the page

The App Status page is where you will find detailed information about the app capabilities, the capability type, and its value specified in the app preferences.

Settings

These are the values for what is set inside the application, the inputs, checkboxes, enums, and device selections. This shows all available settings for the app, but may not always contain a Value.

  • App Title is shown at the top of the App Status page. It may also show the app state for certain apps such as Hubitat Safety Monitor (i.e. Armed or Disarmed) and [true] or [false] for Rule Machine rules.
  • Name is a list of the capabilities an app has. Some examples of this would be the capability of Hubitat Safety Monitor to flash lights or send a notification to your mobile device, by way of the Hubitat Elevation app for Android and iOS when a water leak is detected.
  • Type shows what the capability type is, such as button or mode.
  • Value displays the current settings of one of the app capabilities. For example, a Rule Machine rule has the capability to turn a switch off and if you specify a switch which a rule should turn off, that the switch name(s) will be listed in the value field the that capability.
The Settings section of the apps status window displays the app capabilities by "name" in the first column, the capability "type" in the second column, and the app capability "Value" in the third column

Event Subscriptions

These are any subscription the app has that will be triggered.

  • Source for the Event Subscription might be a device, mode, location, etc.
  • Event is what has been subscribed to.
  • Handler is the method inside the code that will be called when the event is triggered.
  • Filter corresponds to sendEvent from the device driver, and whether or not it has true/false filter events.
The "Event Subscriptions" section of the App Status page lists the "Source" of the Event Subscription in the first column, the "Event" that has been subscribed to in the second column, the "Handler" method in the third column. This is the method inside the code that will be called when the event is triggered, and a "Filter" column that corresponds to "sendEvent" from the device driver, and whether or not it has true and false filter events.

Application State

This is the data storage of the app. Anything written to State will show up here as a pairing of Name and Value.

The "Application State" section of the App Status page displays anything written to "State". It will show up here as a pairing of Name and Value.

Scheduled Jobs

  • Handler is what will be triggered.
  • Next Run Time is when the Handler is scheduled to run.
  • Prev Run Time will show the last time the Handler was run.
  • Status shows if the Job is PENDING or ACTIVE. Typically, this will show PENDING.
  • Schedule is the frequency of the job. Once, every x or a cron schedule are possible values.
The "Scheduled Jobs" section of the App Status page shows the "Handler" in the first column. This is "what" will be triggered. In the second column is the "Next Run Time", which is when the "Handler" is scheduled to run. The "Previous Run Time" column shows when the handler last ran, and the Status column shows whether the job is "Pending" or "Active". Lastly, the "Schedule" column displays the frequency of the job.