Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/audunru/adax2mqtt
https://github.com/audunru/adax2mqtt
Last synced: about 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/audunru/adax2mqtt
- Owner: audunru
- License: mit
- Created: 2024-10-03T07:32:58.000Z (3 months ago)
- Default Branch: main
- Last Pushed: 2024-10-21T20:45:27.000Z (2 months ago)
- Last Synced: 2024-10-22T15:29:46.316Z (2 months ago)
- Language: TypeScript
- Size: 215 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# adax2mqtt: Publish Adax electrix heater energy consumption to MQTT
View your Adax electric heaters in [Home Assistant](https://www.home-assistant.io/)'s energy dashboard.
This is a work in progress.
# Install and run
This assumes you already have Home Assistant and MQTT running.
## Docker
```sh
docker run -d -e ADAX_USERNAME="123" -e ADAX_PASSWORD="abc" -e MQTT_BROKER_URL="mqtt://127.0.0.1:1883" audunru/adax2mqtt
```
If you're using a username/password with MQTT, you can add `-e MQTT_USERNAME="" -e MQTT_PASSWORD=""` as well to the command.
## Docker Compose
```yml
services:
adax2mqtt:
image: audunru/adax2mqtt
environment:
ADAX_USERNAME: "" # Your Adax API account ID
ADAX_PASSWORD: "" # Your Adax API token
MQTT_BROKER_URL: "mqtt://127.0.0.1:1883"
# MQTT_USERNAME: ""
# MQTT_PASSWORD: ""
```
# Development
## Node
```sh
cp .env.example .env # Edit the values in .env afterwards
npm i
npm run dev
```
## Docker
```sh
docker build -t adax2mqtt-dev .
docker run -d -e ADAX_USERNAME="123" -e ADAX_PASSWORD="abc" -e MQTT_BROKER_URL="mqtt://127.0.0.1:1883" --name adax2mqtt-dev adax2mqtt-dev
```