This repository contains multiple files, here is a overview:
| File | Purpose | Documentation |
|---|---|---|
.devcontainer.json |
Used for development/testing with Visual Studio Code. | Documentation |
.github/ISSUE_TEMPLATE/*.yml |
Templates for the issue tracker | Documentation |
custom_components/textbelt-sms/* |
Integration files, this is where everything happens. | Documentation |
CONTRIBUTING.md |
Guidelines on how to contribute. | Documentation |
LICENSE |
The license file for the project. | Documentation |
README.md |
The file you are reading now, should contain info about the integration, installation and configuration instructions. | Documentation |
requirements.txt |
Python packages used for development/lint/testing this integration. | Documentation |
- Create a new repository in GitHub, using this repository as a template by clicking the "Use this template" button in the GitHub UI.
- Open your new repository in Visual Studio Code devcontainer (Preferably with the "
Dev Containers: Clone Repository in Named Container Volume..." option). - Rename all instances of the
textbelt-smstocustom_components/<your_integration_domain>(e.g.custom_components/awesome_integration). - Rename all instances of the
Integration Blueprintto<Your Integration Name>(e.g.Awesome Integration). - Run the
scripts/developto start HA and test out your new integration.
These are some next steps you may want to look into:
- Add tests to your integration,
pytest-homeassistant-custom-componentcan help you get started. - Add brand images (logo/icon) to https://github.com/home-assistant/brands.
- Create your first release.
- Share your integration on the Home Assistant Forum.
- Submit your integration to HACS.
This custom component integrates the Textbelt SMS API into Home Assistant, allowing you to send SMS messages through your automations and scripts.
- Send SMS messages from Home Assistant
- Simple configuration through the UI
- Error handling and logging
- Make sure HACS is installed
- Add this repository through HACS
- Search for "Textbelt SMS" in HACS and install
- Restart Home Assistant
- Copy the
custom_components/textbelt_smsdirectory to your Home Assistant/config/custom_componentsdirectory - Restart Home Assistant
- Go to Settings -> Devices & Services
- Click the "+ ADD INTEGRATION" button
- Search for "Textbelt SMS"
- Enter your Textbelt API key
- Get an API key from Textbelt
- Testing key available: "textbelt"
The integration provides a service textbelt_sms.send_sms with the following parameters:
| Parameter | Required | Description |
|---|---|---|
| phone | Yes | Phone number in international format (e.g., +1234567890) |
| message | Yes | The message text to send |
automation:
- alias: "Low Battery Notification"
trigger:
- platform: numeric_state
entity_id: sensor.phone_battery
below: 20
action:
- service: textbelt_sms.send_sms
data:
phone: "+1234567890"
message: "Your phone battery is low!"- Testing: Use
textbeltas your API key (limited to 1 message) - Pay-as-you-go: Purchase credits from Textbelt
Check Home Assistant logs for detailed error messages. Common issues:
- Invalid API key
- Invalid phone number format
- API quota exceeded
- Report issues on GitHub
- Textbelt API documentation: docs.textbelt.com
This project is licensed under MIT License - see the LICENSE file for details.