Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/terafin/mqtt-rainforest-bridge

Simple docker container that locally polls the rainforest energy bridge, and sends the results to an MQTT broker
https://github.com/terafin/mqtt-rainforest-bridge

automation energy-monitor mqtt

Last synced: 2 months ago
JSON representation

Simple docker container that locally polls the rainforest energy bridge, and sends the results to an MQTT broker

Awesome Lists containing this project

README 

        

# Rainforest -> MQTT Bridge



## Required environment variables



| ENV VARIABLE        | EXAMPLE                                              |                 |

|---------------------| -----------------------------------------------------| --------------- |

| MQTT_HOST           | "mqtt://your-mqtt.server.here"                       | **REQUIRED**    |

| MQTT_USER           | "mqtt username"                                      | *OPTIONAL*      |

| MQTT_PASS           | "mqtt password"                                      | *OPTIONAL*      |

| TOPIC_PREFIX        | "/your/topic/prefix"                                 | **REQUIRED**    |

| RAINFOREST_IP       | YOUR.RAINFOREST.IP.OR.HOSTNAME                       | *OPTIONAL*      |

| RAINFOREST_MAC      | "your rainforest eagle Zigbee MAC"                   | *OPTIONAL*      |

| RAINFOREST_USER     | "your rainforest username (on the device itself)"    | *OPTIONAL*      |

| RAINFOREST_PASS     | "your rainforest password"                           | *OPTIONAL*      |

| LISTENING_PORT      | "32000"                                              | *OPTIONAL*      |

| LISTENING_PATH      | "/rainforest/data"                                   | *OPTIONAL*      |



## Modes



There are two modes to this mqtt brdige, one as a poller, one as an HTTP REST endpoint



* To set it up as a poller, you must set RAINFOREST_IP, RAINFOREST_MAC - and RAINFOREST_USER, RAINFOREST_PASS if you have security enabled

* To set it up as an HTTP endpoint, you must set LISTENING_PORT and LISTENING_PATH *(note: Example below)*



## Example Usage for HTTP endpoint



Here's a full docker flow you can use to pull the latest image, delete the old one, and create a new container named 'mqtt-rainforest-bridge':



* `docker pull terafin/mqtt-rainforest-bridge:latest`

* `docker rm -f mqtt-rainforest-bridge`

* `docker run -d -p 32000:32000 -e TOPIC_PREFIX='/energyusage/home' -e LISTENING_PORT='32000' -e LISTENING_PATH='/rainforest/data' -e MQTT_HOST='mqtt://mymqtt.local.address' --name='mqtt-rainforest-bridge' terafin/mqtt-rainforest-bridge:latest`

  

This will spin up a working rainforest HTTP PUT endpoint at port 32000, with path /rainforest/data, which will start sending the MQTT messages below



To look at the logging output, you can:



* `docker logs -f mqtt-rainforest-bridge`



## Example Usage for polling



Here's a full docker flow you can use to pull the latest image, delete the old one, and create a new container named 'mqtt-rainforest-bridge':



* `docker pull terafin/mqtt-rainforest-bridge:latest`

* `docker rm -f mqtt-rainforest-bridge`

* `docker run -d -p 32000:32000 -e TOPIC_PREFIX='/energyusage/home' -e RAINFOREST_USER='0x1234' -e RAINFOREST_PASS='mysecretpassword!' -e RAINFOREST_IP='10.0.1.100' -e RAINFOREST_MAC='0xdeadbeef00000abcd' -e MQTT_HOST='mqtt://mymqtt.local.address' --name='mqtt-rainforest-bridge' terafin/mqtt-rainforest-bridge:latest`



This will spin up a working rainforest bridge to a device at IP 10.0.1.100, which will start sending the MQTT messages below



To look at the logging output, you can:



* `docker logs -f mqtt-rainforest-bridge`



## MQTT results



Here's some sample (from my system) results after using the above setup:



*Note: These will be polled and updated every 5 seconds.*



    /energyusage/home/demand 0

    /energyusage/home/meter_status Connected

    /energyusage/home/demand_units kW

    /energyusage/home/summation_received 4022.795

    /energyusage/home/summation_delivered 57155.849

    /energyusage/home/summation_units kWh

    /energyusage/home/price -1.0000

    /energyusage/home/price_units 840

    /energyusage/home/message_timestamp 946684800

    /energyusage/home/message_confirmed N

    /energyusage/home/message_confirm_required N

    /energyusage/home/message_id 0

    /energyusage/home/message_queue active

    /energyusage/home/message_read Y

    /energyusage/home/threshold_upper_demand 20.609000

    /energyusage/home/threshold_lower_demand -14.967000

    /energyusage/home/fast_poll_frequency 0x00

    /energyusage/home/fast_poll_endtime 0x00000000