Matterflow is a powerful Home Assistant add-on that simplifies working with data from Matter-enabled IoT devices. With Matterflow, you can Transform and Stream IoT Data to Cloud and AI Applications. It seamlessly integrates with your Home Assistant setup to:
- Automatically receive and process IoT data.
- Transform and model data for use in various formats like CSV or JSON.
- Send processed data to the Cloud and AI applications or store it locally for further analysis.
This add-on is ideal for developers, data scientists, and IoT enthusiasts looking to unlock the full potential of their smart devices.
A great place to start is to follow the "Getting Started Tutorial" on our documentation website: https://matterflow.cloud/docs/intro
- Ensure your Home Assistant installation is up and running.
- The Matter server addon is required for communication with Matter devices. If you don't have that installed follow these instructions:
In Home Assistant, have the Matter integration installed.
- Go to Settings > Devices & services.
- Add the Matter (BETA) integration.
- When prompted to Select the connection method:
- If you run Home Assistant OS in a regular setup: select Submit. This will install the official Matter server add-on. Note that the official Matter server add-on is not supported on 32-bit platforms.
- If you are already running the Matter server in another add-on, in or a custom container, Deselect the checkbox, then select Submit. In the next step, provide the URL to your Matter server.
- Go to the Add-on store in Home Assistant.
- Click ⋮ → Repositories, and paste the following URL:
https://github.com/MatterCoder/addon-matterflow
Click Add → Close, or click the button below to add the repository directly:
-
Select the add-on and click Install.
-
You may need to refresh the add-on page and scroll down to see the Matterflow addon.
- After installation, open the Web UI to verify the add-on is running.
- If it shows
502: Bad Gateway, wait a moment and refresh the page. - Check the Log tab for errors if the add-on doesn't start.
- Automatic Pipeline Run: Automatically run local pipelines.
- Data Transformation: Supports custom rules for transforming incoming data.
- Storage Options: Save data locally as CSV or JSON, or send it to a remote server.
- AI-Ready: Seamlessly export data for machine learning or AI-driven analysis.
-
No data received from devices:
-
Ensure your Matter server is running and configured correctly.
-
Verify device connectivity and compatibility with Matter.
-
Add-on fails to start:
-
Check the logs for configuration errors.
-
Ensure dependencies like the Matter server are installed and running.
View detailed logs in the Log tab of the add-on to diagnose issues.
Comprehensive documentation is available in the docs website. Topics include:
- Advanced configuration
- Custom data transformation rules
- Sending data to cloud platforms
We welcome contributions! Check out the contribution guidelines to get started. Issues and pull requests are always appreciated.
All notable changes will be documented in CHANGELOG.md. The versioning follows the format:
- Stable releases:
X.Y.Z - Development versions:
X.Y.Z-Dev
This project is licensed under the Apache License.