Skip to content

Commit

Permalink
Add cloudformation info
Browse files Browse the repository at this point in the history
  • Loading branch information
jsjohnstone committed Dec 26, 2023
1 parent 2e3dea7 commit cd29298
Showing 1 changed file with 8 additions and 2 deletions.
10 changes: 8 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,13 @@ This script retrieves meter reads from Geohome and pushes them to Tado EnergyIQ

While this project is called 'gassyoctopus' ("Gas Sync for Octopus"), it in reality doesn't use the Octopus APIs at all as they don't reveal total consumption/the actual meter read. This instead uses the Geohome Trio hub connected to my SMETS2 Smart Meter... so it's probably useful to non-Octopus customers as well.

## How to use
## How to use (slightly more automatically)
1. Deploy the [Cloudformation template](cloudformation.yml) on your AWS account
2. Go to the newly created [lambda (gassyoctopus-lambda-[randomid])](https://console.aws.amazon.com/lambda/home#/functions) and upload the [latest zipped release](https://github.com/jsjohnstone/gassyoctopus/releases/download/latest/lambda_function.zip)
3. Go to the newly created [Secret (home/gassyoctopus-secret-[randomID])](https://console.aws.amazon.com/secretsmanager/listsecrets) and edit the values to reflect your own Geohome and Tado accounts
4. The sync will automatically happen at 23:30 GMT - you can edit this in Eventbridge Schedules, or manually run the Lambda to test it.

## How to use (manually)
1. Deploy the function on AWS Lambda.
2. Add the `AWS-Parameters-and-Secrets-Lambda-Extension` layer to your Lambda.
3. Create a secret on Secret Manager (e.g. called `home/gassysecrets`) with this key/value structure:
Expand All @@ -30,4 +36,4 @@ While this project is called 'gassyoctopus' ("Gas Sync for Octopus"), it in real
Distributed under the MIT License.

## Acknowledgements
- [node-tado-client](https://github.com/mattdavis90/node-tado-client) by mattdavis90
- [node-tado-client](https://github.com/mattdavis90/node-tado-client) by mattdavis90

0 comments on commit cd29298

Please sign in to comment.