Messages Store

Messages Store is a custom Home Assistant component designed to store, manage, and retrieve messages in a SQLite database. Whether it's for TTS messages, mobile notifications, Telegram alerts, or other applications, this component allows you to dynamically handle text data across various automation scenarios. You can easily add, edit, delete, and retrieve messages.

Features

• UI Panel: A user-friendly interface is available in the Home Assistant sidebar under "Messages Store," where you can list, search, edit, delete, and add messages.
• State Replacement: Automatically replace (state:entity_id) tags in messages with the current state of the specified Home Assistant entity, including the unit of measurement if available.
• Slug Replacement: Replace (slug:slug_name) tags in messages with the corresponding message stored under that slug, allowing for dynamic message construction.
• Placeholder Replacement: Dynamically replace %s placeholders in messages with values provided when retrieving the message, allowing for customizable and flexible messaging.

Installation

Manual Installation

1. Copy the custom_components\messages_store directory into your Home Assistant custom_components directory.
2. Restart Home Assistant.
3. Install the component through the Home Assistant UI by navigating to Settings > Devices & Services > Integrations and clicking on the "+ Add Integration" button.
4. Search for "Messages Store" and follow the on-screen instructions to configure it.

Installation via HACS (Home Assistant Community Store)

1. Ensure you have HACS installed and configured in your Home Assistant setup.
2. Open HACS in the Home Assistant UI.
3. Go to the "Integrations" tab.
4. Click the three-dot menu in the top right corner and select "Custom repositories."
5. Add the repository URL of this project and select "Integration" as the category.
6. Click "Add" and then search for "Messages Store" in HACS.
7. Install the integration.
8. Restart Home Assistant.
9. After restarting, go to Settings > Devices & Services > Integrations and click "+ Add Integration."
10. Search for "Messages Store" and follow the on-screen instructions to configure it.

Services

• Add messages
• Retrieve messages
• Edit existing messages.
• Delete messages
• Retrieve multiple messages
• Add multiple messages

UI Panel

Search

Edit

Add

Preview tags

Services

1. messages_store.add_message

Description: Adds a new message.

Service Data:

• slug (required): A unique identifier for the message.
• message (required): The message to be stored. Can be a string or a list of strings.

Example:

service: messages_store.add_message
data:
  slug: "greeting_message"
  message: "Hello, welcome to %s, %s!"

Example 2, multiple messages in slug:

service: messages_store.add_message
data:
  slug: "greeting_message"
  message: 
    - "Hello, welcome to %s, %s!"
    - "Welcome to %s %s !!"

Example 3, advanced usage with slug tags:

service: messages_store.add_message
data:
  slug: "welcome_message"
  message: "Welcome to our service! (slug:greeting_message)"

Explanation:

• The message stored with the slug of welcome_message contains a reference to another message using the tag (slug:greeting_message).
• When welcome_message is retrieved using the get_message service, the (slug:greeting_message) will be replaced with the corresponding message if it doesn't contain circular references.

Example 4, advanced usage with state entity tags:

service: messages_store.add_message
data:
  slug: "welcome_message"
  message: "Welcome to our service! (state:sensor.temperature)"

Explanation:

• The message stored with the slug of welcome_message contains a reference to the current state of a Home Assistant entity using the tag (state:sensor.temperature).
• When welcome_message is retrieved using the get_message service, the (state:sensor.temperature) tag will be replaced with the current state value of the sensor.temperature entity, including its unit of measurement, if available.

Response:

status: true
message: Message added with slug welcome_message

2. messages_store.get_message

Description: Retrieves a message by its slug, with optional placeholder replacements.

Service Data:

• slug (required): The identifier of the message to retrieve.
• replace (optional): A list of values to replace placeholders (%s) in the message.
• filter (optional): Use random to retrieve a random message from the list.

Example:

service: messages_store.get_message
data:
  slug: "greeting_message"
  replace:
    - "Home Assistant"
    - "John"

Response:

status: true
message: 
  - Hello, welcome to Home Assistant, John!
  - Welcome to Home Assistant John !!

Example 2, using state replacement:

service: messages_store.get_message
data:
  slug: "welcome_message"

Response 2:

status: true
message: 
  - "Welcome to our service! 10°"

3. messages_store.edit_message

Description: Edits an existing message.

Service Data:

• slug (required): The identifier of the message to edit.
• message (required): The new message content. Can be a string or a list of strings.

Example:

service: messages_store.edit_message
data:
  slug: "greeting_message"
  message: "Hello, welcome to the Home Assistant community!"

Response:

status: true
message: "Message updated for slug greeting_message"

4. messages_store.delete_message

Description: Deletes a message by slug.

Service Data:

• slug (required): The identifier of the message to delete.

Example:

service: messages_store.delete_message
data:
  slug: "greeting_message"

Response:

status: true
message: "Message deleted for slug greeting_message"

5. messages_store.get_messages

Description: Retrieves multiple messages with optional filtering and placeholder replacements.

Service Data:

• filter (optional): A list of filters. Each filter is a dictionary with slug and optional replace fields. You can also use the random filter to retrieve a random message.

Example:

service: messages_store.get_messages
data:
  filter:
    - slug: "greeting_message"
      replace:
        - "Home Assistant"
        - "John"
    - slug: "farewell_message"
      replace:
        - "Mary"

Response:

status: true
data: 
  - slug: greeting_message
    message: 
      - Hello, welcome to Home Assistant, John!
  - slug: farewell_message
    message: 
      - Goodbye, Mary. See you next time!

Example 2:

service: messages_store.get_messages
data:
  filter:
    - slug: "greeting_message"
    - slug: "farewell_message"
      replace:
        - "Mary"
    - filter: "random"

Response 2:

status: true
data: 
  - slug: greeting_message
    message: 
      - Hello, welcome to %s, %s
  - slug: farewell_message
    message: 
      - Goodbye, Mary. See you next time!

6. messages_store.add_bulk_messages

Description: Adds multiple messages.

Service Data:

• data (required): A dictionary where each key is a slug and the corresponding value is a list of messages.

Example:

service: messages_store.add_bulk_messages
data:
  closed_window_office_rain:
    - "It's raining and the office window is open"
    - "Close the office window because it's raining"
  alert_bedroom_climate_on_opened_door:
    - "I turned off the air conditioning because the door is open"

Response:

status: true
message: "Successfully inserted slugs: closed_window_office_rain, alert_bedroom_climate_on_opened_door"

License

This project is licensed under the MIT License. See the LICENSE file for details.

Contributing

Feel free to contribute to this project by submitting issues or pull requests. Please ensure that your contributions follow the established coding guidelines and are thoroughly tested.