Entities: Suggested Naming Update

[eMeF1]

@dvejsada Before you dive in — I know this would be a big change, so here’s why I’m suggesting it:

• One of the integrations I rely on has become a total mess in terms of entity naming — and every new sensor they add just adds to the confusion.
• This proposal aims to bring structure and consistency, and it could serve as a naming guide for future entities as the integration grows.
• This is my professional deformation and my little autistic me needing order
• I love your project

What follows is a breakdown by functional domain with proposed entity names and IDs that are clear, scalable, and aligned with Home Assistant conventions.

Take it or leave it — no hard feelings. Just thought it might help.

Entity Naming Convention

<device>_<functional domain>_<entity id>

• <device> — Unique integration/device prefix (e.g. rohlikcz)
• <functional domain> — Logical grouping that describes what area of the system the data belongs to:
  • account — user-related limits, IDs, feature flags
  • cart — active shopping session data
  • order — placed order status and delivery info
• <entity id> — Descriptive and concise name of what the sensor/binary sensor represents
  (e.g. total_price, delivery_slot, reusable_bags_active)

---

Account

Tracks user account-level data, entitlements, and status.

Suggested Name	Suggested Entity ID	Current Name	Current Entity ID
Credit Balance	<device>_account_credit_balance	Credit Balance	<device>_credit_balance
Free Express Deliveries	<device>_account_express_deliveries_left	Free Express Deliveries	<device>_free_express_deliveries
Premium Days Left	<device>_account_premium_days_left	Premium Days Remaining	<device>_premium_days_remaining
Reusable Bags Count	<device>_account_reusable_bags	Bags Amount	<device>_bags_amount
Underlimit Orders Left	<device>_account_underlimit_orders_left	No-Limit Orders	<device>_no_limit_orders

---

Cart

Reflects real-time session data, including delivery options and totals.

Suggested Name	Suggested Entity ID	Current Name	Current Entity ID
Cart Total	<device>_cart_total_price	Cart Total	<device>_cart_total
Nearest Express Delivery Slot	<device>_cart_nearest_express_slot	n/a	n/a
Nearest Delivery Slot	<device>_cart_nearest_slot	Nearest Delivery Slot	<device>_nearest_delivery
Nearest Standard Delivery Slot	<device>_cart_nearest_standard_slot	n/a	n/a
Delivery Slot Reserved	<device>_cart_slot_reserved	Slot Reserved	<device>_slot_reserved

---

Order

Information about placed orders and their delivery schedule.

Suggested Name	Suggested Entity ID	Current Name	Current Entity ID
Order Active	<device>_order_active	Next Order Made	<device>_next_order_made
Delivery Window Start	<device>_order_delivery_start	n/a	n/a
Delivery Window End	<device>_order_delivery_end	n/a	n/a
Last Order Placed	<device>_order_last_placed	Last Order	<device>_last_order

Diagnostic

Static data and feature flags related to your user account (ID, contact, feature participation).

Suggested Name	Suggested Entity ID	Current Name	Current Entity ID
Account Email	<device>_account_email	Email	<device>_email
Account ID	<device>_account_id	Account ID	<device>_account_id
Parents Club Active	<device>_account_parents_club	Parents Club	<device>_parents_club
Premium Membership Active	<device>_account_premium_membership	Premium Membership	<device>_premium_membership
Account Phone	<device>_account_phone	Phone	<device>_phone
Reusable Bags Active	<device>_account_reusable_bags_active	Reusable Bags	<device>_reusable_bags
Last Data Update	<device>_last_updated	Last Updated	<device>_last_updated

[dvejsada]

Thanks, this is very thorough and I fully agree. With respect to , it makes more sense to me to include the device name (i.e. name of the account owner), rather than general rohlikcz (domain name) which will be the same for each entity. So for example, the complete name of entity with number of remaining reusable bags will be "sensor.daniel_vejsada_bags_amount". This will also allow to differentiate between entities if multiple accounts are connected.

I will try to implement this naming convention over the upcoming weekend.

[eMeF1]

To further clarify the structure: <device><functional domain><entity id>

device

• I would keep it as you currently have it. It makes perfect sense for this to be the account holder’s name, especially since someone might have multiple accounts.
• Also, when the device name is placed at the beginning of the friendly name, Home Assistant hides it on the device view, making the entity names easier to read.
• Users are free to rename the device to whatever they prefer — for example, I’ve named mine Rohlik.
• If the device name and entity IDs are consistent, Home Assistant will even suggest renaming the related entities when renaming the device.

As you can see here, the friendly name is Rohlik Cart Total

On the Device view, this is displayed as Cart Total because the Friendly name prefix matches the Device name

Here is the suggestion modal that appears when the entity name follows the proper naming conventions (as you have it now!)

functional domain

• One of the reasons I suggested including a functional domain in the entity ID is that it ensures entities are grouped by function when shown in the Home Assistant device view.
• Home Assistant lists entities in the device view alphabetically by their entity id, so by including the functional domain (like Account, Cart, or Order) in the entity ids, you get a natural grouping and logical flow.
• In your case, this results in a clean and intuitive order: Account → Cart → Order
• So the example you have mentioned should be sensor.daniel_vejsada_**account**_...

Other than that

• No need to jump into implementation just yet — give it a few days to settle. The structure feels solid, but a short pause can help make sure it really holds up before locking it in.
• It might also be worth having a quick look at the Picnic integration. They may have some useful naming ideas we can borrow.
• And if you’re open to it, could you enable the Wiki in your repo? I’d love to put together some proper documentation.

[eMeF1]

Reviewed it again and prepared an update. I only added the new sensors you recently introduced and kept the suggested names the same as in the previous post. The names aren’t too critical, and the logic already looks good. The only thing I’d like to adjust is the functional domain in the Entity ID. But I’ll leave it up to you — just sharing my thoughts, no pressure.

Sensors

Name	Entity ID	Functional Domain	Suggested Name	Suggested Entity ID
<device> Bags Amount	<device>_bags_amount	account	<device> Reusable Bags Count	<device>_account_reusable_bags
<device> Cart Total	<device>_cart_total	cart	<device> Cart Total	<device>_cart_total_price
<device> Credit Balance	<device>_credit_balance	account	<device> Credit Balance	<device>_account_credit_balance
<device> Delivery Slot End	<device>_delivery_slot_end	order	<device> Delivery Window Start	<device>_order_delivery_end
<device> Delivery Slot Start	<device>_delivery_slot_start	order	<device> Delivery Window End	<device>_order_delivery_start
<device> Express Available	<device>_express_available	cart	<device> Express Available	<device>_cart_express_available
<device> Free Express Deliveries	<device>_free_express_deliveries	account	<device> Free Express Deliveries	<device>_account_express_deliveries_left
<device> Last Order	<device>_last_order	order	<device> Last Order Placed	<device>_order_last_placed
<device> Nearest Delivery	<device>_nearest_delivery	cart	<device> Nearest Delivery Slot	<device>_cart_nearest_slot
<device> Next Order Made	<device>_next_order_made	order	<device> Order Active	<device>_order_active
<device> No-Limit Orders	<device>_no_limit_orders	account	<device> Underlimit Orders Left	<device>_account_underlimit_orders_left
<device> Premium Days Remaining	<device>_premium_days_remaining	account	<device> Premium Days Left	<device>_account_premium_days_left
<device> Slot Eco Time	<device>_slot_eco_time	cart	<device> Nearest Standard Delivery Slot	<device>_cart_nearest_eco_slot
<device> Slot Express Time	<device>_slot_express_time	cart	<device> Nearest Standard Delivery Slot	<device>_cart_nearest_express_slot
<device> Slot Reserved	<device>_slot_reserved	cart	<device> Delivery Slot Reserved	<device>_cart_slot_reserved
<device> Slot Standard Time	<device>_slot_standard_time	cart	<device> Nearest Express Delivery Slot	<device>_cart_nearest_standard_slot

Diagnostic

Name	Entity ID	Functional Domain	Suggested Name	Suggested Entity ID
<device> Account ID	<device>_account_id	account	<device> Account ID	<device>_account_id
<device> Email	<device>_email	account	<device> Account Email	<device>_account_email
<device> Last Updated	<device>_last_updated		<device> Last Data Update	<device>_last_updated
<device> Parents Club	<device>_parents_club	account	<device> Parents Club Active	<device>_account_parents_club
<device> Phone	<device>_phone	account	<device> Account Phone	<device>_account_phone
<device> Premium Membership	<device>_premium_membership	account	<device> Premium Membership Active	<device>_account_premium_membership
<device> Reusable Bags	<device>_reusable_bags	account	<device> Reusable Bags Active	<device>_account_reusable_bags_active

[dvejsada]

Just to confirm, I will fully implement this, but as it may cause breaking changes (to automations etc.), I want to do it at once when the integration will go from beta after implementing all main features.