home-assistant.io/source/_integrations/emoncms_history.markdown
Sam Reed 3977a906ca
emoncms_history.markdown: Improve config docs (#28702)
* emoncms_history.markdown: Improve config docs

cf d220c19a36/source/_integrations/emoncms.markdown (L34-L41)

* emoncms_history.markdown: Reference emoncms sensor
2023-08-28 07:56:48 +02:00

52 lines
1.8 KiB
Markdown

---
title: Emoncms History
description: Instructions on how to integrate Emoncms history into Home Assistant.
ha_category:
- History
ha_iot_class: Local Polling
ha_release: 0.31
ha_domain: emoncms_history
ha_integration_type: integration
---
The `emoncms_history` integration makes it possible to transfer (write) details collected with Home Assistant to [Emoncms.org](https://emoncms.org/) or your local running Emoncms instance. It will send the data to a specific input node on Emoncms with the entity IDs as a key. Afterwards you can create feeds and dashboards in Emoncms with the collected data.
To use the `emoncms_history` integration in your installation, add the following to your `configuration.yaml` file:
```yaml
# Example configuration.yaml entry
emoncms_history:
api_key: YOUR_EMONCMS_WRITE_API_KEY
url: https://emoncms.org
inputnode: 19
whitelist:
- sensor.owm_temperature
- sensor.owm_wind_speed
```
To read information from Emoncms to Home Assistant, you can use the [`emoncms`](/integrations/emoncms) integration.
{% configuration %}
api_key:
description: The write API key for your Emoncms user.
required: true
type: string
url:
description: "The base URL of Emoncms, use <https://emoncms.org> for the cloud-based version. For self-hosted Emoncms or EmonPi you may need a URL of `http://x.x.x.x/emoncms`."
required: true
type: string
inputnode:
description: Input node that will be used inside Emoncms. Please make sure you use a dedicated, not used before, node for this integration!
required: true
type: integer
whitelist:
description: List of entity IDs you want to publish.
required: true
type: list
scan_interval:
description: Defines, in seconds, how regularly the states of the whitelisted entities are being gathered and send to Emoncms.
required: false
type: integer
default: 30
{% endconfiguration %}