Omnik Inverter Sensor Component for Home Assistant

The Omnik Inverter Sensor component will retrieve data from an Omnik inverter connected to your local network. It has been tested and developed on an Omnik 4k TL2, 2k TL2 and it might work for other inverters as well.

The values will be presented as sensors in Home Assistant.

Requirements

Your Omnik Inverter needs to be connected to your local network, as this custom component will utilise the web interface of the Omnik inverter to read data. All you need to know is the IP address of the Omnik inverter and you are good to go.

HACS installation

Add this component using HACS by searching for Omnik Inverter Solar Sensor (No Cloud) on the Integrations page.

Manual installation

Create a directory called omnik_inverter in the <config directory>/custom_components/ directory on your Home Assistant instance. Install this component by copying all files in /custom_components/omnik_inverter/ folder from this repo into the new <config directory>/custom_components/omnik_inverter/ directory you just created.

This is how your custom_components directory should be:

custom_components
├── omnik_inverter
│   ├── __init__.py
│   ├── manifest.json
│   └── sensor.py

Configuration example

To enable this sensor, add the following lines to your configuration.yaml file:

sensor:
  - platform: omnik_inverter
    host: 192.168.100.100

By default caching the power today value is enabled, you can disable it using the cache_power_today configuration attribute. Check "How does it work?" when/why you might need to disable it.

sensor:
  - platform: omnik_inverter
    host: 192.168.100.100
    cache_power_today: false

Most inverters update the JS or JSON every 5 minutes. You increase or decrease this scan interval by setting the scan_interval config variable to the number of seconds you want. The default is set to 300 seconds (5 minutes).

sensor:
  - platform: omnik_inverter
    host: 192.168.100.100
    scan_interval: 900

How does it work?

The web interface has a javascript file that contains the actual values. This is updated every 5 minutes. Check it out in your browser at http://<your omnik ip address>/js/status.js

The result contains a lot of information, but there is one part we're interested in:

// ... Bunch of data
var webData="NLBN1234567A1234,iv4-V6.5-140-4,V5.2-42819,omnik4000tl2,4000,1920,429,87419,,3,";
// Or for some inverters:
var myDeviceArray=new Array(); myDeviceArray[0]="AANN3020,V5.04Build230,V4.13Build253,Omnik3000tl,3000,1313,685,9429,,1,";
// ... Even more data

This output contains your serial number, firmware versions, hardware information, the current power output: 1920, the energy generated today: 429 and the total energy generated: 87419.

The custom component basically requests the URL, looks for the webData part and extracts the values as the following sensors:

sensor.solar_power_current (Watt)
sensor.solar_power_today (kWh)
sensor.solar_power_total (kWh)

My inverter doesn't show any output when I go to the URL.

Use this if you have an Omnik Inverter 2k TL2.

Some inverters use a JSON status file to output the values. Check if your inverter outputs JSON data by navigating to: http://<your omnik ip address>/status.json?CMD=inv_query&rand=0.1234567.

If so, then use the use_json config boolean to make the component use the URL above.

sensor:
  - platform: omnik_inverter
    host: 192.168.100.100
    use_json: true

Caching "power today".

In a few cases the Omnik inverter resets the solar_power_today to 0.0 after for example 21:00. By setting the cache_power_today config attribute to true (default) this component will cache the value and only resets to 0.0 after midnight. If you do not experience this, then disable the cache by setting the config variable to false.

sensor:
  - platform: omnik_inverter
    host: 192.168.100.100
    cache_power_today: false

References

https://community.home-assistant.io/t/omink-inverter-in-home-assistant/102455/36
https://github.com/heinoldenhuis/home_assistant_omnik_solar (This uses omnikportal.com to get data for your inverter, check it out!)
https://github.com/sincze/Domoticz-Omnik-Local-Web-Plugin

freddieleeman / home-assistant-omnik-inverter