What's the best way for creating single entity devices with MQTT autodiscovery?

Cyberbeni · November 3, 2024, 9:36pm

Currently I don’t set device.name, set name to what I want to see. But that results in the devices showing up as “Unnamed device” under the “Connected devices” section of the device corresponding to my server.

If I set both device.name and name to the same then the entity will display the name twice on dashboards.

If I set device.name and don’t set name then it will add an autogenerated postfix based on device_class on dashboards.

Sir_Goodenough · November 4, 2024, 8:05am

Hi Benedek Kozma,

Here’s what I did…

github.com

SirGoodenough/HA_Blueprints/blob/d1c15d75a7b5fa3042d60f7eee2d7633ea8a27a3/Automations/Octoprint_Additional_Buttons_Helper.yaml

blueprint:
  name: Octoprint_Additional_Buttons_Helper- 2024-06-08
  author: SirGoodenough
  description: >
    This is Blueprint is provided as a helper for people using the
    Octoprint Plugin called OctoPrint-HomeAssistant. What this does is add 8 buttons,
    4 of which you as the user can set your own G-Codes to for customizing.
    Also adds safe shutdown and presentation functions along with
    Change Filament and Load Filament.


    The first thing to remember is ANYTIME you make ANY changes to this Blueprint,
    you MUST restart the server so that the button entities can rebuild in the
    configuration you have selected. If you don't restart OctoPrint,
    the change may not be seen and you will wonder why and what is happening.


    To use this you will need the [OctoPrint-MQTT](https://plugins.octoprint.org/plugins/mqtt/) plug-in installed
    along with the [OctoPrint-HomeAssistant](https://github.com/cmroche/OctoPrint-HomeAssistant) plugin.
    You will also need to be connected to an MQTT Broker that your Home Assistant

This file has been truncated. show original

mekaneck · November 4, 2024, 11:17am

Set device.name, and then set the entity name to None (or null if setting it in YAML)

MQTT Naming info can be found here, although it’s not super clear that marking an entity as the “main feature” means inheriting the device name as the entity name.

It’s allowed to set an MQTT entity’s name to None (use null in YAML) to mark it as the main feature of a device.

Further down on that page there is an example that shows this and explains it a bit better: Link