Add ability to retrieve entities by label

[foux]

Hello,
Home Assistant 2024.4 added ability to tag elements by labels
If I'm not mistaken, there currently isn't a way in NodeRed to retrieve entities/elements by label. It would be a great addition.

Thanks

[zachowj]

A current stopgap would be to use something like this

[{"id":"9d6d7802931a9809","type":"ha-api","z":"892eaca92f0b4509","name":"entities","server":"","version":1,"debugenabled":false,"protocol":"websocket","method":"get","path":"","data":"{\"type\": \"config/entity_registry/list\"}","dataType":"json","responseType":"json","outputProperties":[{"property":"payload","propertyType":"msg","value":"","valueType":"results"}],"x":428,"y":1728,"wires":[["d3deb98fb37a5515"]]},{"id":"7a2d563e5a739c19","type":"inject","z":"892eaca92f0b4509","name":"","props":[{"p":"payload"},{"p":"topic","vt":"str"}],"repeat":"","crontab":"","once":false,"onceDelay":0.1,"topic":"","payload":"","payloadType":"date","x":276,"y":1728,"wires":[["9d6d7802931a9809"]]},{"id":"902ab6d88884d28c","type":"debug","z":"892eaca92f0b4509","name":"debug 173","active":true,"tosidebar":true,"console":false,"tostatus":false,"complete":"false","statusVal":"","statusType":"auto","x":726,"y":1728,"wires":[]},{"id":"d3deb98fb37a5515","type":"function","z":"892eaca92f0b4509","name":"filter","func":"const label = \"test\";\nmsg.payload = msg.payload.filter((e) => e.labels.includes(label)).map(e => e.entity_id);\n\nreturn msg;","outputs":1,"timeout":0,"noerr":0,"initialize":"","finalize":"","libs":[],"x":566,"y":1728,"wires":[["902ab6d88884d28c"]]}]

[NicoOosterwijk]

I also would like to see this feature!

[fhteagle]

Not sure if this should be its own discussion / FR, but it would also be nice to retrieve the labels as part of the results returned from the "get entities" node, whether the entities query was filtering by label or not.

[zachowj]

[{"id":"0a7869dabd2e4832","type":"subflow","name":"Add on labels","info":"","category":"","in":[{"x":64,"y":80,"wires":[{"id":"6ada5d0d666e7b3f"}]}],"out":[{"x":528,"y":80,"wires":[{"id":"2c328fb139b08339","port":0}]}],"env":[{"name":"property","type":"str","value":"payload","ui":{"label":{"en-US":"entities property"},"type":"input","opts":{"types":["str","env"]}}}],"meta":{},"color":"#46B1EF","icon":"node-red/debug.svg"},{"id":"6ada5d0d666e7b3f","type":"ha-api","z":"0a7869dabd2e4832","name":"entities","server":"","version":1,"debugenabled":false,"protocol":"websocket","method":"get","path":"","data":"{\"type\": \"config/entity_registry/list\"}","dataType":"json","responseType":"json","outputProperties":[{"property":"registry","propertyType":"flow","value":"","valueType":"results"}],"x":196,"y":80,"wires":[["2c328fb139b08339"]]},{"id":"2c328fb139b08339","type":"function","z":"0a7869dabd2e4832","name":"add on labels","func":"msg[env.get(\"property\")] = msg[env.get(\"property\")].map((entity) => {\n    const labels = flow.get(\"registry\").find((ele) => ele.entity_id === entity.entity_id).labels;\n    return {...entity, labels};\n});\n\nreturn msg;","outputs":1,"timeout":0,"noerr":0,"initialize":"","finalize":"","libs":[],"x":364,"y":80,"wires":[[]]},{"id":"8fd5df25b95541f4","type":"ha-get-entities","z":"892eaca92f0b4509","name":"","server":"","version":1,"rules":[{"property":"entity_id","logic":"starts_with","value":"light.","valueType":"str"}],"outputType":"array","outputEmptyResults":false,"outputLocationType":"msg","outputLocation":"abc","outputResultsCount":1,"x":410,"y":1824,"wires":[["7dd21d25f0626608"]]},{"id":"e6dfe0bcc40a2e92","type":"inject","z":"892eaca92f0b4509","name":"","props":[{"p":"payload"},{"p":"topic","vt":"str"}],"repeat":"","crontab":"","once":false,"onceDelay":0.1,"topic":"","payload":"","payloadType":"date","x":261,"y":1824,"wires":[["8fd5df25b95541f4"]]},{"id":"6fe02475225be313","type":"debug","z":"892eaca92f0b4509","name":"debug 180","active":true,"tosidebar":true,"console":false,"tostatus":false,"complete":"abc","targetType":"msg","statusVal":"","statusType":"auto","x":794,"y":1824,"wires":[]},{"id":"7dd21d25f0626608","type":"subflow:0a7869dabd2e4832","z":"892eaca92f0b4509","name":"","env":[{"name":"property","value":"abc","type":"str"}],"x":608,"y":1824,"wires":[["6fe02475225be313"]]}]

[fhteagle]

Thanks for that example. Definitely helpful for my use case.

[fear]

i would love to see Labels as a further option to pick in the Call Serviec Node. Dont know if it's possible, but it would make my life so much better ;-)

[zachowj]

This is already in the next release. 20e08ab

[sstratoti]

Awesome job!! Thank you!

[fear]

thanks! <3

[zachowj]

Added b194eb0