Add service descriptions in zwave panel (#306)

* Add support for service descriptions in call buttons. Use it in Zwave panel. * Hide descriptions behind a tap on questionmark * Sort nodes by name and not entity_id
home-assistant · Jun 18, 2017 · 70da89a · 70da89a
1 parent 37098f8
commit 70da89a
Show file tree

Hide file tree

Showing 4 changed files with 79 additions and 16 deletions.
diff --git a/panels/zwave/ha-panel-zwave.html b/panels/zwave/ha-panel-zwave.html
@@ -4,6 +4,7 @@
 <link rel="import" href="../../bower_components/app-layout/app-header-layout/app-header-layout.html">
 <link rel="import" href="../../bower_components/app-layout/app-header/app-header.html">
 <link rel="import" href="../../bower_components/app-layout/app-toolbar/app-toolbar.html">
+<link rel="import" href="../../bower_components/iron-icon/iron-icon.html">
 <link rel="import" href="../../bower_components/paper-dropdown-menu/paper-dropdown-menu.html">
 <link rel='import' href='../../bower_components/paper-item/paper-item.html'>
 <link rel='import' href="../../bower_components/paper-listbox/paper-listbox.html">
@@ -28,7 +29,6 @@
 
       .node-info {
         margin-left: 16px;
-        text-transform: capitalize;
       }
 
       .help-text {
@@ -67,7 +67,8 @@
 <!--Node card-->
       <div class='content'>
         <paper-card heading='Z-Wave Node Management'>
-          <div class='card-content'>
+          <iron-icon on-tap='toggleHelp' style='padding: 14px 0 14px 12px' icon='mdi:help-circle'></iron-icon>
+          <div style='display:inline-block' class='card-content'>
             Z-Wave Node controls.
           </div>
           <div class='device-picker'>
@@ -81,35 +82,44 @@
               </paper-listbox>
             </paper-dropdown-menu>
           </div>
+            <template is='dom-if' if='[[!computeIsNodeSelected(selectedNode)]]'>
+              <template is='dom-if' if='[[showHelp]]'>
+                <div style='color: grey; padding: 12px'>Select node to view per-node options</div>
+              </template>
+            </template>
 
-          <template is='dom-if' if='[[!computeIsNodeSelected(selectedNode)]]'>
+          <template is='dom-if' if='[[computeIsNodeSelected(selectedNode)]]'>
           <div class='card-actions'>
             <ha-call-service-button
                 hass='[[hass]]'
                 domain='zwave'
                 service='refresh_node'
                 service-data=[[computeNodeServiceData(selectedNode)]]
+                show-description=[[showHelp]]
               >Refresh Node</ha-call-service-button>
             <ha-call-service-button
               hass='[[hass]]'
               domain='zwave'
               service='remove_failed_node'
               service-data=[[computeNodeServiceData(selectedNode)]]
+              show-description=[[showHelp]]
             >Remove Failed Node</ha-call-service-button>
             <ha-call-service-button
               hass='[[hass]]'
               domain='zwave'
               service='replace_failed_node'
               service-data=[[computeNodeServiceData(selectedNode)]]
+              show-description=[[showHelp]]
             >Replace Failed Node</ha-call-service-button>
             <ha-call-service-button
               hass='[[hass]]'
               domain='zwave'
               service='print_node'
               service-data=[[computeNodeServiceData(selectedNode)]]
+              show-description=[[showHelp]]
             >Print Node</ha-call-service-button>
-            </div>
-           <div class='card-actions'>
+          </div>
+          <div class='card-actions'>
             <paper-input
               float-label="New node name"
               type=text
@@ -121,6 +131,7 @@
               domain='zwave'
               service='rename_node'
               service-data=[[computeNodeNameServiceData(newNodeNameInput)]]
+              show-description=[[showHelp]]
             >Rename Node</ha-call-service-button>
            </div>
 
@@ -142,6 +153,7 @@
               domain='zwave'
               service='refresh_entity'
               service-data=[[computeRefreshEntityServiceData(selectedEntity)]]
+              show-description=[[showHelp]]
             >Refresh Entity</ha-call-service-button>
            </div>
            <div class='content'>
@@ -162,15 +174,15 @@
         </paper-card>
         </div>
 <!--Node info card-->
-        <template is='dom-if' if='[[!computeIsNodeSelected(selectedNode)]]'>
+        <template is='dom-if' if='[[computeIsNodeSelected(selectedNode)]]'>
           <zwave-node-information
             id='zwave-node-information'
             nodes='[[nodes]]'
             selected-node='[[selectedNode]]'
           ></zwave-node-information>
         </template>
 <!--Value card-->
-        <template is='dom-if' if='[[!computeIsNodeSelected(selectedNode)]]'>
+        <template is='dom-if' if='[[computeIsNodeSelected(selectedNode)]]'>
           <zwave-values
             hass='[[hass]]'
             nodes='[[nodes]]'
@@ -179,7 +191,7 @@
           ></zwave-values>
         </template>
 <!--Group card-->
-        <template is='dom-if' if='[[!computeIsNodeSelected(selectedNode)]]'>
+        <template is='dom-if' if='[[computeIsNodeSelected(selectedNode)]]'>
           <zwave-groups
             hass='[[hass]]'
             nodes='[[nodes]]'
@@ -188,7 +200,7 @@
           ></zwave-groups>
         </template>
 <!--Config card-->
-        <template is='dom-if' if='[[!computeIsNodeSelected(selectedNode)]]'>
+        <template is='dom-if' if='[[computeIsNodeSelected(selectedNode)]]'>
           <zwave-node-config
             hass='[[hass]]'
             nodes='[[nodes]]'
@@ -296,7 +308,12 @@
 
     hasNodeUserCodes: {
       type: Boolean,
-      value: false
+      value: false,
+    },
+
+    showHelp: {
+      type: Boolean,
+      value: false,
     },
   },
 
@@ -334,10 +351,12 @@
                 (!(ent.entity_id).match('zwave[.]')));
       })
       .sort(function (entityA, entityB) {
-        if (entityA.entity_id < entityB.entity_id) {
+        var nameA = window.hassUtil.computeStateName(entityA);
+        var nameB = window.hassUtil.computeStateName(entityB);
+        if (nameA < nameB) {
           return -1;
         }
-        if (entityA.entity_id > entityB.entity_id) {
+        if (nameA > nameB) {
           return 1;
         }
         return 0;
@@ -411,7 +430,7 @@
   },
 
   computeIsNodeSelected: function () {
-    return (!this.nodes || this.selectedNode === -1);
+    return (this.nodes && this.selectedNode !== -1);
   },
 
   computeIsEntitySelected: function (selectedEntity) {
@@ -437,5 +456,9 @@
     if (selectedEntity === -1) return -1;
     return { entity_id: this.entities[selectedEntity].entity_id };
   },
+
+  toggleHelp: function () {
+    this.showHelp = !this.showHelp;
+  },
 });
 </script>
diff --git a/panels/zwave/zwave-network.html b/panels/zwave/zwave-network.html
@@ -1,5 +1,6 @@
 <link rel="import" href="../../bower_components/polymer/polymer.html">
 <link rel="import" href="../../bower_components/paper-card/paper-card.html">
+<link rel="import" href="../../bower_components/iron-icon/iron-icon.html">
 <link rel="import" href="../../src/components/buttons/ha-call-service-button.html">
 
 <dom-module id='zwave-network'>
@@ -20,53 +21,68 @@
       }
     </style>
     <paper-card heading='Z-Wave Network Management'>
-      <div class='card-content'>
+      <iron-icon on-tap='helpTap' style='padding: 14px 0 14px 12px' icon='mdi:help-circle'></iron-icon>
+      <div style='display:inline-block' class='card-content'>
         Z-Wave Network controls.
       </div>
       <div class='card-actions'>
         <ha-call-service-button
           hass='[[hass]]'
           domain='zwave'
           service='add_node_secure'
+          show-description=[[showDescription]]
+        >Add Node Secure</ha-call-service-button>
+        <ha-call-service-button
+          hass='[[hass]]'
+          domain='zwave'
+          service='add_node'
+          show-description=[[showDescription]]
         >Add Node</ha-call-service-button>
         <ha-call-service-button
           hass='[[hass]]'
           domain='zwave'
           service='remove_node'
+          show-description=[[showDescription]]
         >Remove Node</ha-call-service-button>
       </div>
       <div class='card-actions warning'>
         <ha-call-service-button
           hass='[[hass]]'
           domain='zwave'
           service='cancel_command'
+          show-description=[[showDescription]]
         >Cancel Command</ha-call-service-button>
       </div>
       <div class='card-actions'>
         <ha-call-service-button
           hass='[[hass]]'
           domain='zwave'
           service='heal_network'
+          show-description=[[showDescription]]
         >Heal Network</ha-call-service-button>
         <ha-call-service-button
           hass='[[hass]]'
           domain='zwave'
           service='start_network'
+          show-description=[[showDescription]]
         >Start Network</ha-call-service-button>
         <ha-call-service-button
           hass='[[hass]]'
           domain='zwave'
           service='stop_network'
+          show-description=[[showDescription]]
         >Stop Network</ha-call-service-button>
         <ha-call-service-button
           hass='[[hass]]'
           domain='zwave'
           service='soft_reset'
+          show-description=[[showDescription]]
         >Soft Reset</ha-call-service-button>
         <ha-call-service-button
           hass='[[hass]]'
           domain='zwave'
           service='test_network'
+          show-description=[[showDescription]]
         >Test Network</ha-call-service-button>
       </div>
     </paper-card>
@@ -81,6 +97,15 @@
     hass: {
       type: Object,
     },
+
+    showDescription: {
+      type: Boolean,
+      value: false,
+    },
   },
+
+  helpTap: function () {
+    this.showDescription = !this.showDescription;
+  }
 });
 </script>
diff --git a/panels/zwave/zwave-node-information.html b/panels/zwave/zwave-node-information.html
@@ -10,7 +10,6 @@
 
       .node-info {
         margin-left: 16px;
-        text-transform: capitalize;
       }
 
       paper-card {

diff --git a/src/components/buttons/ha-call-service-button.html b/src/components/buttons/ha-call-service-button.html
@@ -8,6 +8,9 @@
       progress='[[progress]]'
       on-tap='buttonTapped'
     ><slot></slot></ha-progress-button>
+  <template is='dom-if' if='[[showDescription]]'>
+    <div style="color: grey">[[getDescription(hass, domain, service)]]</div>
+  </template>
   </template>
 </dom-module>
 
@@ -37,6 +40,11 @@
       type: Object,
       value: {},
     },
+
+    showDescription: {
+      type: Boolean,
+      value: false,
+    },
   },
 
   buttonTapped: function () {
@@ -60,6 +68,14 @@
       }).then(function () {
         el.fire('hass-service-called', eventData);
       });
-  }
+  },
+
+  getDescription: function (hass, domain, service) {
+    var domainServices = hass.config.services[domain];
+    if (!domainServices) return '';
+    var serviceObject = domainServices[service];
+    if (!serviceObject) return '';
+    return serviceObject.description;
+  },
 });
 </script>