diff --git a/CHANGELOG.md b/CHANGELOG.md
index 720ee5f..a886ee5 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -2,11 +2,11 @@
### ⚠ BREAKING CHANGES
-* npm package and docker image renamed to "homewizard-webhooks"
+* npm package and docker image renamed to "hw-hooks"
### chore
-* prepare renaming to homewizard-webhooks ([0e574df](https://github.com/Th3S4mur41/hw2energyid/commit/0e574df1ceb5c4911a244920da6b50de3353eb86))
+* prepare renaming to hw-hooks ([0e574df](https://github.com/Th3S4mur41/hw2energyid/commit/0e574df1ceb5c4911a244920da6b50de3353eb86))
### Dependencies and Other Build Updates
diff --git a/Dockerfile b/Dockerfile
index ee0f9d8..4c32bb3 100644
--- a/Dockerfile
+++ b/Dockerfile
@@ -16,4 +16,4 @@ ENV energyid ''
ENV p1 ''
ENV meter ${p1}
-CMD npx homewizard-webhooks --energyid=${energyid} --meter=${meter} -r
+CMD npx hw-hooks --energyid=${energyid} --meter=${meter} -r
diff --git a/README.md b/README.md
index 9939067..c707660 100644
--- a/README.md
+++ b/README.md
@@ -1,4 +1,4 @@
-# HomeWizard to EnergyId
+# HW Hooks
[](https://github.com/codespaces/new?machine=basicLinux32gb&repo=612398925&ref=main)
@@ -7,10 +7,19 @@
[](https://scorecard.dev/viewer/?uri=github.com/Th3S4mur41/hw2energyid)
-**homewizard-webhooks** is small tool to synchronize data from [HomeWizard](https://www.homewizard.com/) devices to your [EnergyID](https://app.energyid.eu/) dashboard.
+
+
+
+
+
+
+
+**hw-hooks** is small tool trigger webhooks based on data gathered from [HomeWizard](https://www.homewizard.com/) devices.
+
+The app includes a bunch of preconfigured webhooks to synchonize your data with you [EnergyID](https://app.energyid.eu/) dashboard.
Since HomeWizard devices API are only available within your local network, using an [EnergyID App](https://app.energyid.eu/integrations) to synchronize the data is not possible.
-**homewizard-webhooks** helps bridge the gap by reading the data from your local network and sending them to EnergyId using the WebHook App
+**hw-hooks** helps bridge the gap by reading the data from your local network and sending them to EnergyId using the WebHook App
## Prerequisites
@@ -35,7 +44,7 @@ You can either run the tool in the console using the NPM script or use the Docke
Open a terminal/console and run the following script:
```sh
-npx homewizard-webhooks --energyid=
+npx hw-hooks --energyid=
```
### Options
@@ -78,8 +87,8 @@ Create a docker compose file with the following content:
version: '3'
services:
- homewizard-webhooks:
- image: ghcr.io/th3s4mur41/homewizard-webhooks
+ hw-hooks:
+ image: ghcr.io/th3s4mur41/hw-hooks
environment:
- energyid=
- meter=
@@ -100,7 +109,7 @@ services:
## Examples
> **Note**
-> homewizard-webhooks currently only supports synchronizing electricity and water readings
+> hw-hooks currently only supports synchronizing electricity and water readings
### P1 Meter
@@ -117,13 +126,13 @@ The name of the device is 'hw-p1meter-' followed by the last six charachters of
Now that you have all the data you need. Open a terminal/console and run the following script:
```sh
-npx homewizard-webhooks --meter=hw-p1meter- --energyid=
+npx hw-hooks --meter=hw-p1meter- --energyid=
```
E.g.: The command with your data should look similar to this:
```sh
-npx homewizard-webhooks --meter=hw-p1meter-65d8c7 --energyid=https://hooks.energyid.eu/services/WebhookIn/46535693-fe25-48ba-96fa-ea827e987318/OS753GD97A11
+npx hw-hooks --meter=hw-p1meter-65d8c7 --energyid=https://hooks.energyid.eu/services/WebhookIn/46535693-fe25-48ba-96fa-ea827e987318/OS753GD97A11
```
### Water Meter
@@ -136,16 +145,16 @@ The name of the device is 'watermeter-' followed by the last six charachters of
Now that you have all the data you need. Open a terminal/console and run the following script:
```sh
-npx homewizard-webhooks --meter=watermeter- --energyid=
+npx hw-hooks --meter=watermeter- --energyid=
```
E.g.: The command with your data should look similar to this:
```sh
-npx homewizard-webhooks --meter=watermeter-65d8c7 --offset=22.334 --energyid=https://hooks.energyid.eu/services/WebhookIn/46535693-fe25-48ba-96fa-ea827e987318/OS753GD97A11
+npx hw-hooks --meter=watermeter-65d8c7 --offset=22.334 --energyid=https://hooks.energyid.eu/services/WebhookIn/46535693-fe25-48ba-96fa-ea827e987318/OS753GD97A11
```
## Links
-[homewizard dicovery docs](https://homewizard-energy-api.readthedocs.io/discovery.html)
+[homewizard dicovery docs](https://api-documentation.homewizard.com/docs/discovery)
[EnergyId Webhook Docs](https://api.energyid.eu/docs.html#webhook)
diff --git a/docs/logo-dark.png b/docs/logo-dark.png
new file mode 100644
index 0000000..9214314
Binary files /dev/null and b/docs/logo-dark.png differ
diff --git a/docs/logo-light.png b/docs/logo-light.png
new file mode 100644
index 0000000..483bab9
Binary files /dev/null and b/docs/logo-light.png differ
diff --git a/docs/logo.svg b/docs/logo.svg
new file mode 100644
index 0000000..fd8c235
--- /dev/null
+++ b/docs/logo.svg
@@ -0,0 +1,864 @@
+
+
\ No newline at end of file
diff --git a/package-lock.json b/package-lock.json
index 99845b3..fd68fbd 100644
--- a/package-lock.json
+++ b/package-lock.json
@@ -1,11 +1,11 @@
{
- "name": "homewizard-webhooks",
+ "name": "hw-hooks",
"version": "2.0.0-alpha.1",
"lockfileVersion": 3,
"requires": true,
"packages": {
"": {
- "name": "homewizard-webhooks",
+ "name": "hw-hooks",
"version": "2.0.0-alpha.1",
"license": "MIT",
"dependencies": {
@@ -13,7 +13,7 @@
"yargs": "^17.7.1"
},
"bin": {
- "homewizard-webhooks ": "bin/cli.mjs"
+ "hw-hooks ": "bin/cli.mjs"
},
"devDependencies": {
"@biomejs/biome": "1.9.1",
diff --git a/package.json b/package.json
index 24fb37b..38a0e28 100644
--- a/package.json
+++ b/package.json
@@ -1,5 +1,5 @@
{
- "name": "homewizard-webhooks",
+ "name": "hw-hooks",
"version": "2.0.0-alpha.1",
"description": "A tool to synchronize data from HomeWizard to EnergyID",
"keywords": ["homewizard", "homewizard-energy", "homewizard-p1-meter", "energyid", "sync", "api", "webhook"],
@@ -22,14 +22,14 @@
"main": "index.mjs",
"files": ["config/"],
"bin": {
- "homewizard-webhooks ": "bin/cli.mjs"
+ "hw-hooks ": "bin/cli.mjs"
},
"scripts": {
"clean": "npx rimraf dist bin coverage && git clean -Xf",
"dev": "npm run build:cli -- --watch",
"build": "npm run build:cli && npm run build:docker",
"build:cli": "node esbuild.config.mjs",
- "build:docker": "docker build --tag homewizard-webhooks .",
+ "build:docker": "docker build --tag hw-hooks .",
"lint": "biome ci . && prettier --check --ignore-unknown --no-error-on-unmatched-pattern .",
"lint:fix": "biome check --write . && prettier --write --ignore-unknown --no-error-on-unmatched-pattern .",
"prepare": "husky",
diff --git a/src/bin/cli.mjs b/src/bin/cli.mjs
index f4912f1..9153c3f 100644
--- a/src/bin/cli.mjs
+++ b/src/bin/cli.mjs
@@ -64,7 +64,7 @@ for (const key in mappings) {
}
if (argv.r) {
- console.log("Scheduling homewizard-webhooks to run every hour");
+ console.log("Scheduling hw-hooks to run every hour");
schedule(argv.meter, hooks, argv.offset);
} else {
console.log(`Execute all hooks for ${argv.meter}`);