home-assistant.io/source/_integrations/emoncms.markdown

2.3 KiB

title description ha_category ha_release ha_iot_class ha_domain ha_codeowners ha_platforms ha_integration_type related ha_config_flow
Emoncms Instructions on how to integrate Emoncms feeds as sensors into Home Assistant.
Sensor
0.29 Local Polling emoncms
@borpin
@alexandrecuer
sensor
integration
docs title
/docs/configuration/ Configuration file
true

The emoncms sensor {% term integration %} creates sensors for the feeds available in your local or cloud based version of Emoncms.

To write information from Home Assistant to Emoncms, you can use the emoncms_history {% term integration %}.

Prerequisites

To use this service, you need an Emoncms account and an API key. You can find the API key in your local or cloud-based Emoncms account settings.

{% include integrations/config_flow.md %}

{% configuration_basic %} URL: description: The URL of the Emoncms server starting with the protocol (http or https). For cloud installations, use https://emoncms.org (trailing slash optional). For local installations, use your local server address (e.g., http://localhost:8080). Ensure the server is accessible from your Home Assistant instance. API key: description: The 32-character read-only API key needed for authentication is found under "My Account > Read Only API Key" in Emoncms. The key should be a hexadecimal string. The read-and-write API key is not needed as this integration reads data from Emoncms. If you receive authentication errors, verify that you've copied the entire key correctly. {% endconfiguration_basic %}

{% include integrations/option_flow.md %}

Sensors

  • energy in Wh, kWh
  • power in W
  • voltage in V
  • current in A
  • apparent power in VA
  • temperature in °C, °F or K
  • frequency in Hz
  • pressure in hPa

Data updates

This integration retrieves data from Emoncms every 60 seconds.

Troubleshooting

The Emoncms integration relies on an active local network or internet connection to communicate with your local or cloud based version of Emoncms. If you encounter issues, verify that your connection is stable.

Removing the integration

This integration can be removed by following these steps:

{% include integrations/remove_device_service.md %}