This repository contains a script to automatically sync your Octopus Energy smart meter readings with Tado's Energy IQ feature. The workflow provided allows you to set this up to run on a weekly basis using GitHub Actions, so your Tado Energy IQ remains up-to-date without any manual effort.
Note: This tool is specifically oriented toward users with smart gas meters from Octopus Energy.
- Automatically pulls your gas usage data from Octopus Energy.
- Syncs the data with Tado Energy IQ for better home energy management insights.
- Set up once, and it runs weekly via GitHub Actions.
Follow these steps to configure the sync for your own Octopus Energy and Tado accounts:
First, fork this repository to your own GitHub account. This will allow you to customize the secrets specific to your accounts and run the workflow independently.
In order to use the script, you'll need to provide credentials for both your Tado account and Octopus Energy API. This is done through GitHub secrets.
- Go to the Settings tab of your forked repository.
- In the left-hand menu, select Secrets and variables > Actions.
- Click New repository secret and add the following secrets:
| Secret Name | Description |
|---|---|
TADO_EMAIL |
The email address associated with your Tado account. |
TADO_PASSWORD |
The password for your Tado account. |
OCTOPUS_MPRN |
Your gas MPRN (Meter Point Reference Number). |
OCTOPUS_GAS_SERIAL |
The serial number of your gas meter. |
OCTOPUS_API_KEY |
Your Octopus Energy API key. You can obtain this from the Octopus Energy developer portal (details below). |
To find your API Key, Gas MPRN, and Gas Serial Number, follow these steps:
- Log into your Octopus Energy account.
- Navigate to the "API Access" section of your account. Here, you'll find your API Key.
- Your Gas MPRN and Gas Serial Number can also be found in this section.
These details are necessary to allow the script to pull your gas usage data from Octopus Energy.
The repository is already set up with a GitHub Actions workflow that runs the
sync script once a week. The workflow is located at
.github/workflows/schedule_sync.yml. After you’ve added your secrets, the
workflow will automatically begin running on schedule.
You can manually trigger the workflow by navigating to the Actions tab in your repository and selecting the sync workflow.
By default, the workflow runs weekly. If you want to change the schedule:
- Open the
.github/workflows/schedule_sync.ymlfile in your repository. - Modify the schedule trigger under
on: schedule:following the cron syntax for the desired frequency.
For example, to run daily at midnight:
on: schedule:
- cron: '0 0 * * *' ```You can check the status of the sync runs in the Actions tab of your GitHub repository. Here, you can see past runs, their logs, and any errors that might have occurred.
The GitHub Actions workflow automatically runs the following script:
--tado-password "${{ secrets.TADO_PASSWORD }}" \ --mprn "${{
secrets.OCTOPUS_MPRN }}" \ --gas-serial-number "${{ secrets.OCTOPUS_GAS_SERIAL
}}" \ --octopus-api-key "${{ secrets.OCTOPUS_API_KEY }}"
The script will:
- Fetch the most recent gas usage readings from your Octopus Energy account using their API.
- Sync these readings with Tado's Energy IQ to keep your gas consumption insights up-to-date.
- Incorrect credentials: If the script fails due to incorrect credentials, ensure that the email, password, MPRN, and serial number are accurate. Verify that your Octopus API key is valid.
- Workflow failures: Detailed logs for each sync run can be found in the Actions tab of your repository. Use these logs to identify and troubleshoot any issues.
Feel free to contribute to this project by opening issues or submitting pull requests. Any improvements, bug fixes, or new feature suggestions are welcome!
This project is licensed under the MIT License. See the LICENSE file for details.