Don't add extra entities for zwave_js controller (#67209)

* Don't add extra entities for zwave_js controller

* Revert reformat of controller_state

* fix indentation issues

* fix indentation issues

homeassistant/components/zwave_js/__init__.py

@@ -293,6 +293,8 @@ async def async_setup_entry(  # noqa: C901
 
     async def async_on_node_added(node: ZwaveNode) -> None:
         """Handle node added event."""
+        # No need for a ping button or node status sensor for controller nodes
+        if not node.is_controller_node:
             # Create a node status sensor for each device
             await async_setup_platform(SENSOR_DOMAIN)
             async_dispatcher_send(

tests/components/zwave_js/conftest.py

@@ -181,6 +181,12 @@ def controller_state_fixture():
     return json.loads(load_fixture("zwave_js/controller_state.json"))
 
 
+@pytest.fixture(name="controller_node_state", scope="session")
+def controller_node_state_fixture():
+    """Load the controller node state fixture data."""
+    return json.loads(load_fixture("zwave_js/controller_node_state.json"))
+
+
 @pytest.fixture(name="version_state", scope="session")
 def version_state_fixture():
     """Load the version state fixture data."""
@@ -535,6 +541,14 @@ def mock_client_fixture(controller_state, version_state, log_config_state):
         yield client
 
 
+@pytest.fixture(name="controller_node")
+def controller_node_fixture(client, controller_node_state):
+    """Mock a controller node."""
+    node = Node(client, copy.deepcopy(controller_node_state))
+    client.driver.controller.nodes[node.node_id] = node
+    return node
+
+
 @pytest.fixture(name="multisensor_6")
 def multisensor_6_fixture(client, multisensor_6_state):
     """Mock a multisensor 6 node."""

tests/components/zwave_js/fixtures/aeon_smart_switch_6_state.json

@@ -1245,5 +1245,6 @@
           "label": "Z-Wave chip hardware version"
         }
       }
-    ]
+    ],
+    "isControllerNode": false
   }

tests/components/zwave_js/fixtures/aeotec_radiator_thermostat_state.json

@@ -616,5 +616,6 @@
           "label": "Z-Wave chip hardware version"
         }
       }
-    ]
+    ],
+    "isControllerNode": false
   }

tests/components/zwave_js/fixtures/aeotec_zw164_siren_state.json

@@ -3752,5 +3752,6 @@
 		}
 	],
 	"interviewStage": "Complete",
-	"deviceDatabaseUrl": "https://devices.zwave-js.io/?jumpTo=0x0371:0x0103:0x00a4:1.3"
+	"deviceDatabaseUrl": "https://devices.zwave-js.io/?jumpTo=0x0371:0x0103:0x00a4:1.3",
+	"isControllerNode": false
 }

tests/components/zwave_js/fixtures/bulb_6_multi_color_state.json

@@ -645,5 +645,6 @@
                 "label": "Z-Wave chip hardware version"
             }
         }
-    ]
+    ],
+    "isControllerNode": false
 }

tests/components/zwave_js/fixtures/chain_actuator_zws12_state.json

@@ -397,5 +397,6 @@
         },
         "value": 0
       }
-    ]
+    ],
+    "isControllerNode": false
   }

tests/components/zwave_js/fixtures/climate_danfoss_lc_13_state.json

@@ -432,5 +432,6 @@
                 "1.1"
             ]
         }
-    ]
+    ],
+    "isControllerNode": false
 }

tests/components/zwave_js/fixtures/climate_eurotronic_spirit_z_state.json

@@ -712,5 +712,6 @@
                 "label": "Z-Wave chip hardware version"
             }
         }
-    ]
+    ],
+    "isControllerNode": false
 }

tests/components/zwave_js/fixtures/climate_heatit_z_trm2fx_state.json

@@ -1440,5 +1440,6 @@
 			"isSecure": false
 		}
 	],
-	"interviewStage": "Complete"
+	"interviewStage": "Complete",
+	"isControllerNode": false
 }

tests/components/zwave_js/fixtures/climate_heatit_z_trm3_no_value_state.json

@@ -1246,5 +1246,6 @@
             "isSecure": true
         }
     ],
-    "interviewStage": "Complete"
+    "interviewStage": "Complete",
+    "isControllerNode": false
 }

tests/components/zwave_js/fixtures/climate_heatit_z_trm3_state.json

@@ -1173,5 +1173,6 @@
             },
             "value": 25.5
         }
-    ]
+    ],
+    "isControllerNode": false
 }

tests/components/zwave_js/fixtures/climate_radio_thermostat_ct100_mode_and_setpoint_on_different_endpoints_state.json

@@ -826,5 +826,6 @@
 			"version": 1,
 			"isSecure": false
 		}
-	]
+	],
+	"isControllerNode": false
 }

tests/components/zwave_js/fixtures/climate_radio_thermostat_ct100_plus_different_endpoints_state.json

@@ -1083,5 +1083,6 @@
 			"version": 3,
 			"isSecure": false
 		}
-	]
+	],
+	"isControllerNode": false
 }

tests/components/zwave_js/fixtures/climate_radio_thermostat_ct100_plus_state.json

@@ -851,5 +851,6 @@
       },
       "value": false
     }
-  ]
+  ],
+  "isControllerNode": false
 }

tests/components/zwave_js/fixtures/climate_radio_thermostat_ct101_multiple_temp_units_state.json

@@ -958,5 +958,6 @@
 			"version": 1,
 			"isSecure": false
 		}
-	]
+	],
+	"isControllerNode": false
 }

tests/components/zwave_js/fixtures/controller_node_state.json

@@ -0,0 +1,104 @@
+{
+  "nodeId": 1,
+  "index": 0,
+  "status": 4,
+  "ready": true,
+  "isListening": true,
+  "isRouting": false,
+  "isSecure": "unknown",
+  "manufacturerId": 134,
+  "productId": 90,
+  "productType": 1,
+  "firmwareVersion": "1.2",
+  "deviceConfig": {
+    "filename": "/data/db/devices/0x0086/zw090.json",
+    "isEmbedded": true,
+    "manufacturer": "AEON Labs",
+    "manufacturerId": 134,
+    "label": "ZW090",
+    "description": "Z\u2010Stick Gen5 USB Controller",
+    "devices": [
+      {
+        "productType": 1,
+        "productId": 90
+      },
+      {
+        "productType": 257,
+        "productId": 90
+      },
+      {
+        "productType": 513,
+        "productId": 90
+      }
+    ],
+    "firmwareVersion": {
+      "min": "0.0",
+      "max": "255.255"
+    },
+    "associations": {},
+    "paramInformation": {
+      "_map": {}
+    },
+    "metadata": {
+      "reset": "Use this procedure only in the event that the primary controller is missing or otherwise inoperable.\n\nPress and hold the Action Button on Z-Stick for 20 seconds and then release",
+      "manual": "https://products.z-wavealliance.org/ProductManual/File?folder=&filename=MarketCertificationFiles/1345/Z%20Stick%20Gen5%20manual%201.pdf"
+    }
+  },
+  "label": "ZW090",
+  "interviewAttempts": 0,
+  "endpoints": [
+    {
+      "nodeId": 1,
+      "index": 0,
+      "deviceClass": {
+        "basic": {
+          "key": 2,
+          "label": "Static Controller"
+        },
+        "generic": {
+          "key": 2,
+          "label": "Static Controller"
+        },
+        "specific": {
+          "key": 1,
+          "label": "PC Controller"
+        },
+        "mandatorySupportedCCs": [],
+        "mandatoryControlledCCs": [32]
+      },
+      "commandClasses": []
+    }
+  ],
+  "values": [],
+  "isFrequentListening": false,
+  "maxDataRate": 40000,
+  "supportedDataRates": [40000],
+  "protocolVersion": 3,
+  "deviceClass": {
+    "basic": {
+      "key": 2,
+      "label": "Static Controller"
+    },
+    "generic": {
+      "key": 2,
+      "label": "Static Controller"
+    },
+    "specific": {
+      "key": 1,
+      "label": "PC Controller"
+    },
+    "mandatorySupportedCCs": [],
+    "mandatoryControlledCCs": [32]
+  },
+  "interviewStage": "Complete",
+  "deviceDatabaseUrl": "https://devices.zwave-js.io/?jumpTo=0x0086:0x0001:0x005a:1.2",
+  "statistics": {
+    "commandsTX": 0,
+    "commandsRX": 0,
+    "commandsDroppedRX": 0,
+    "commandsDroppedTX": 0,
+    "timeoutResponse": 0
+  },
+  "isControllerNode": true,
+  "keepAwake": false
+}

tests/components/zwave_js/fixtures/cover_aeotec_nano_shutter_state.json

@@ -494,5 +494,6 @@
     }
   ],
   "interviewStage": "Complete",
-  "deviceDatabaseUrl": "https://devices.zwave-js.io/?jumpTo=0x0371:0x0003:0x008d:3.1"
+  "deviceDatabaseUrl": "https://devices.zwave-js.io/?jumpTo=0x0371:0x0003:0x008d:3.1",
+  "isControllerNode": false
 }

tests/components/zwave_js/fixtures/cover_fibaro_fgr222_state.json

@@ -1129,5 +1129,6 @@
         "commandsDroppedRX": 1,
         "commandsDroppedTX": 0,
         "timeoutResponse": 0
-    }
+    },
+    "isControllerNode": false
 }

tests/components/zwave_js/fixtures/cover_iblinds_v2_state.json

@@ -353,5 +353,6 @@
                 "label": "Z-Wave chip hardware version"
             }
         }
-    ]
+    ],
+    "isControllerNode": false
 }

tests/components/zwave_js/fixtures/cover_qubino_shutter_state.json

@@ -896,5 +896,6 @@
     "commandsDroppedRX": 0,
     "commandsDroppedTX": 0,
     "timeoutResponse": 0
-  }
+  },
+  "isControllerNode": false
 }

tests/components/zwave_js/fixtures/cover_zw062_state.json

@@ -917,5 +917,6 @@
         "label": "Z-Wave chip hardware version"
       }
     }
-  ]
+  ],
+  "isControllerNode": false
 }

tests/components/zwave_js/fixtures/eaton_rf9640_dimmer_state.json

@@ -775,5 +775,6 @@
             "value": 0,
             "ccVersion": 3
         }
-    ]
+    ],
+    "isControllerNode": false
 }

tests/components/zwave_js/fixtures/ecolink_door_sensor_state.json

@@ -325,6 +325,7 @@
           "2.0"
         ]
       }
-    ]
+    ],
+    "isControllerNode": false
   }
   

tests/components/zwave_js/fixtures/fan_ge_12730_state.json

@@ -427,5 +427,6 @@
                 "3.10"
             ]
         }
-    ]
+    ],
+    "isControllerNode": false
 }

tests/components/zwave_js/fixtures/fan_generic_state.json

@@ -348,5 +348,6 @@
           "label": "Z-Wave chip hardware version"
         }
       }
-    ]
+    ],
+    "isControllerNode": false
   }

tests/components/zwave_js/fixtures/fan_hs_fc200_state.json

@@ -10502,5 +10502,6 @@
     "commandsDroppedRX": 0,
     "commandsDroppedTX": 0,
     "timeoutResponse": 2
-  }
+  },
+  "isControllerNode": false
 }

tests/components/zwave_js/fixtures/fortrezz_ssa1_siren_state.json

@@ -346,5 +346,6 @@
 		"commandsDroppedRX": 0,
 		"commandsDroppedTX": 0,
 		"timeoutResponse": 2
-	}
+	},
+	"isControllerNode": false
 }

tests/components/zwave_js/fixtures/fortrezz_ssa3_siren_state.json

@@ -351,5 +351,6 @@
     "commandsDroppedTX": 0,
     "timeoutResponse": 1
   },
-  "highestSecurityClass": -1
+  "highestSecurityClass": -1,
+  "isControllerNode": false
 }

tests/components/zwave_js/fixtures/ge_in_wall_dimmer_switch_state.json

@@ -638,5 +638,6 @@
     "mandatoryControlledCCs": []
   },
   "interviewStage": "Complete",
-  "deviceDatabaseUrl": "https://devices.zwave-js.io/?jumpTo=0x0063:0x4944:0x3038:5.26"
+  "deviceDatabaseUrl": "https://devices.zwave-js.io/?jumpTo=0x0063:0x4944:0x3038:5.26",
+  "isControllerNode": false
 }

tests/components/zwave_js/fixtures/hank_binary_switch_state.json

@@ -720,5 +720,6 @@
                 "label": "Z-Wave chip hardware version"
             }
         }
-    ]
+    ],
+    "isControllerNode": false
 }

tests/components/zwave_js/fixtures/inovelli_lzw36_state.json

@@ -1952,5 +1952,6 @@
           }
         }
       }
-    ]
+    ],
+    "isControllerNode": false
   }

tests/components/zwave_js/fixtures/light_color_null_values_state.json

@@ -685,5 +685,6 @@
         "version": 1,
         "isSecure": false
       }
-    ]
+    ],
+    "isControllerNode": false
   }

tests/components/zwave_js/fixtures/lock_august_asl03_state.json

@@ -446,5 +446,6 @@
                 "label": "Z-Wave chip hardware version"
             }
         }
-    ]
+    ],
+    "isControllerNode": false
 }

tests/components/zwave_js/fixtures/lock_id_lock_as_id150_state.json

@@ -2915,5 +2915,6 @@
 			"version": 1,
 			"isSecure": true
 		}
-	]
+	],
+	"isControllerNode": false
 }

tests/components/zwave_js/fixtures/lock_popp_electric_strike_lock_control_state.json

@@ -564,5 +564,6 @@
 		"commandsDroppedRX": 0,
 		"commandsDroppedTX": 0,
 		"timeoutResponse": 0
-	}
+	},
+	"isControllerNode": false
 }

tests/components/zwave_js/fixtures/lock_schlage_be469_state.json

@@ -2103,5 +2103,6 @@
             },
             "value": 0
         }
-    ]
+    ],
+    "isControllerNode": false
 }

tests/components/zwave_js/fixtures/nortek_thermostat_added_event.json

@@ -250,7 +250,8 @@
                     "label": "Dimming duration"
                 }
             }
-        ]
+        ],
+        "isControllerNode": false
     },
     "result": {}
 }

tests/components/zwave_js/fixtures/nortek_thermostat_state.json

@@ -1275,5 +1275,6 @@
                 "label": "Dimming duration"
             }
         }
-    ]
+    ],
+    "isControllerNode": false
 }

tests/components/zwave_js/fixtures/null_name_check_state.json

@@ -410,5 +410,6 @@
 			"version": 3,
 			"isSecure": false
 		}
-	]
+	],
+	"isControllerNode": false
 }

tests/components/zwave_js/fixtures/srt321_hrt4_zw_state.json

@@ -258,5 +258,6 @@
           "2.0"
         ]
       }
-    ]
+    ],
+    "isControllerNode": false
   }

tests/components/zwave_js/fixtures/vision_security_zl7432_state.json

@@ -429,5 +429,6 @@
 			"version": 1,
 			"isSecure": false
 		}
-	]
+	],
+	"isControllerNode": false
 }

tests/components/zwave_js/fixtures/wallmote_central_scene_state.json

@@ -694,5 +694,6 @@
         "label": "Z-Wave chip hardware version"
       }
     }
-  ]
+  ],
+  "isControllerNode": false
 }

tests/components/zwave_js/fixtures/zen_31_state.json

@@ -2803,5 +2803,6 @@
         "version": 1,
         "isSecure": true
       }
-    ]
+    ],
+    "isControllerNode": false
   }

tests/components/zwave_js/fixtures/zp3111-5_not_ready_state.json

@@ -64,5 +64,6 @@
         "commandsDroppedRX": 0,
         "commandsDroppedTX": 0,
         "timeoutResponse": 0
-    }
+    },
+    "isControllerNode": false
 }

tests/components/zwave_js/fixtures/zp3111-5_state.json

@@ -702,5 +702,6 @@
         "commandsDroppedTX": 0,
         "timeoutResponse": 0
     },
-    "highestSecurityClass": -1
+    "highestSecurityClass": -1,
+    "isControllerNode": false
 }

tests/components/zwave_js/test_button.py

@@ -1,13 +1,16 @@
 """Test the Z-Wave JS button entities."""
 from homeassistant.components.button.const import DOMAIN as BUTTON_DOMAIN, SERVICE_PRESS
 from homeassistant.components.zwave_js.const import DOMAIN, SERVICE_REFRESH_VALUE
+from homeassistant.components.zwave_js.helpers import get_valueless_base_unique_id
 from homeassistant.const import ATTR_ENTITY_ID
+from homeassistant.helpers.entity_registry import async_get
 
 
 async def test_ping_entity(
     hass,
     client,
     climate_radio_thermostat_ct100_plus_different_endpoints,
+    controller_node,
     integration,
     caplog,
 ):
@@ -44,3 +47,13 @@ async def test_ping_entity(
     )
 
     assert "There is no value to refresh for this entity" in caplog.text
+
+    # Assert a node ping button entity is not created for the controller
+    node = client.driver.controller.nodes[1]
+    assert node.is_controller_node
+    assert (
+        async_get(hass).async_get_entity_id(
+            DOMAIN, "sensor", f"{get_valueless_base_unique_id(client, node)}.ping"
+        )
+        is None
+    )

tests/components/zwave_js/test_init.py

@@ -934,6 +934,7 @@ async def test_replace_same_node(
                     "commandsDroppedTX": 0,
                     "timeoutResponse": 0,
                 },
+                "isControllerNode": False,
             },
             "result": {},
         },
@@ -1052,6 +1053,7 @@ async def test_replace_different_node(
                     "commandsDroppedTX": 0,
                     "timeoutResponse": 0,
                 },
+                "isControllerNode": False,
             },
             "result": {},
         },

tests/components/zwave_js/test_sensor.py

@@ -18,6 +18,7 @@ from homeassistant.components.zwave_js.const import (
     SERVICE_REFRESH_VALUE,
     SERVICE_RESET_METER,
 )
+from homeassistant.components.zwave_js.helpers import get_valueless_base_unique_id
 from homeassistant.const import (
     ATTR_DEVICE_CLASS,
     ATTR_ENTITY_ID,
@@ -155,7 +156,9 @@ async def test_config_parameter_sensor(hass, lock_id_lock_as_id150, integration)
     assert entity_entry.disabled
 
 
-async def test_node_status_sensor(hass, client, lock_id_lock_as_id150, integration):
+async def test_node_status_sensor(
+    hass, client, controller_node, lock_id_lock_as_id150, integration
+):
     """Test node status sensor is created and gets updated on node state changes."""
     NODE_STATUS_ENTITY = "sensor.z_wave_module_for_id_lock_150_and_101_node_status"
     node = lock_id_lock_as_id150
@@ -201,6 +204,18 @@ async def test_node_status_sensor(hass, client, lock_id_lock_as_id150, integrati
     await client.disconnect()
     assert hass.states.get(NODE_STATUS_ENTITY).state != STATE_UNAVAILABLE
 
+    # Assert a node status sensor entity is not created for the controller
+    node = client.driver.controller.nodes[1]
+    assert node.is_controller_node
+    assert (
+        ent_reg.async_get_entity_id(
+            DOMAIN,
+            "sensor",
+            f"{get_valueless_base_unique_id(client, node)}.node_status",
+        )
+        is None
+    )
+
 
 async def test_node_status_sensor_not_ready(
     hass,