Add a note to entity/device

Feature request
Notes field in devices or entities to remind you what you’ve done
I was looking for a place to add notes to devices or entities for future reference for me. For example I have some sensors that are in obscure locations such as a presence sensor located inside a clock and a door deadbolt open sensor that is wired in the door jam and the sensor located in a space above the door.
I have done some custom modifications that work for me like using a water leak sensor as that deadbolt sensor because it has a long wire connected to the sensor probes. I added a reed switch in place of the probes. I’m sure I’ll forget how I did that!
I may need a reminder what size battery to bring when it’s time to service a zigbee sensor.
And worst case, if I become unable to maintain the system, someone else can see the notes and figure out what I have done.
Anyway, a notes field would be nice.

1 Like

If we had this I would not need my notebook in my desktop drawer. In this notebook I have listed all my devices and what they do.

1 Like

Love this.

I have a gDoc with device nuances or reasons why I set something up one way vs another that may have been less optimal. Would love if those were associated with the HA device.

It may be already a request, but I could not find it.
I would like to have an extra memo field onto a devices data, to store things like dates and problems occured, the solutions, exact location of the device(sometimes I forget where I hide them, blush) and those kind of stuff. Now I store it into a separate database which feels kinda stupid.
Maybe there is already a solution for this, I am pretty new to HA
If that is the case sorry…

It sounds like a good idea, until it is not. :slight_smile:
I use the Powercalc integration to add power reading to devices and entities that normally do not have them and it would be the same you would do with other info.
It works fine normally, but then something happens and the original devices are re-added with a _2 in the end of their name.
The solution to this is to remove the old one and rename the new ones and everything run again.
But the Powercalc information that was stored as extra info on the old one is now gone too.

It is risky to tie important information directly to a device/entity!

1 Like

Plenty of similar requests for “notes” instead of “memo” in the search :wink:
Until this is done in the UI, you can add custom attributes as a workaround as described here

2 Likes

Make sense, I did not realize that. However, sometimes I do add existing devices which lost connection and (probably due to their ID’s) takeover previous settings etc, like which area it is used, the automation there into etc.
It sounds a bit like, you could run into ‘memo history problems’ but not always

That would indeed work!!

That is correct. If the device have an unique ID, then they will reoccupy the old device.
The problem is that you do not really control what devices that get suddenly re-added. :slight_smile:

for Battery Types, I would recommend the custom component “Battery Notes”

This will provide the relevant entities for all “known” devices, but you can also configure your own, individual ones.

For other cases, I would also appreciate the option to be available in the UI, just similar to the current Labels and Tags.

Using customization will be a lot of work, if you want to implement it not just for a single entitiy or device.
Also, it would be great, if “Notes” would be shown in the UI / more Info dialog.

1 Like

I have been looking for a way to do this for some time now. Around three to four years, actually. So much that I created a separate excel document to catalog changes, unique characteristics of each device, troubleshooting tips for each device, etc. For example, I add smart switches/outlets/plugs as I come across great deals from the brands I trust. Trying to remember what brand each switch is can be difficult as not all of them have a visible logo (and I prefer it that way as I don’t want advertisements on every little thing around the home). But then when a smart switch isn’t responding and the status LED is doing something, it would be nice to know the exact make and model so I can match it to its manual quickly. Or simply look at a note for what I did last time it might have happened. So many possibilities for a visual notes system. Maybe someone will be able to make a HACS for it or something.

I just looking something like this to write documentaion or special use of entities oraz devices.

Create feature request but have been closed and linking to this one. I wrote there this:

====================

Asking to add new field of sensor entity with (long) text description.

Right now according documentation of fields of entity definition missing field helping recognize is for what if you are not a developer. For example I have about 1k entities and choose correct entity many times is very hard to decide what is correct due to similar names and units of measurements and time to time very similar device names too (in my cause for example I have many the same devices from the same manufacturer measuring energy is sockets).

Therefore asking for add new field description that hover the cursor for 3s in UI will display in small popup window current value and description. Or just appear in new column with description.

Together with the change should be implemented possibility changing description in UI.

Link for documentation about current fields of entity:

========================

In not sure can I connect or extend my entity with custom attributes, maybe some explain please.

You can, but it’s limited to 255 characters (unless I’m misremembering) and you won’t be able to see it on hover. See my post in this very thread

So if I have entity:

sensor.heatmeter_kamheat_co_4_power_kw

and adding to configuratio.yaml below

homeassistant:
  customize:
    sensor.heatmeter_kamheat_co_4_power_kw
      notes: my some notes here

then appear error in notes position. What I doing wrong?

You’re not telling me what error it is you’re seeing, so how can I help you?

homeassistant:
  customize:
    sensor.heatmeter_kamheat_co_4_power_kw: ##<--- you forgot the : here
      notes: my some notes here
1 Like

Thank you, yes missing colon. However after restart can you please explain when I can found the note “my some notes here” ?

Searching eg. here but no in attributes:

I don’t think the sensor will have any added attributes if the sensor itself is unavailable. You’ll have to get that figured out first.

I was asking about highlighted:

Only here is visible the note or in other places in HA too?

EDIT: There is :slight_smile: