Skip to content

Latest commit

 

History

History
110 lines (74 loc) · 5.09 KB

README.md

File metadata and controls

110 lines (74 loc) · 5.09 KB
Raw

hacs_badge Project Stage

Project Maintenance Maintainability Code Quality

Omnik Inverter Sensor for Home Assistant

The Omnik Inverter Sensor component will scrape data from an Omnik inverter connected to your local network. It has been tested and developed on the following inverters:

Supported models

  • Omnik1000TL
  • Omnik1500TL
  • Omnik2000TL
  • Omnik2500TL (HTML)
  • Omnik2000TL2 (JSON)
  • Omnik4000TL2
  • Ginlong stick (JSON)

After installation you can add the inverter through the integration page. The values will be presented by two devices in Home Assistant. One is the inverter containing the actual solar power, and one is the device containing information about the wifi signal.

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
│   ├── translations
│   │   ├── en.json
│   │   └── nl.json
│   ├── __init__.py
│   ├── config_flow.py
│   ├── const.py
│   ├── manifest.json
│   ├── sensor.py
│   └── strings.json

Configuration

ha_badge

To configure the component, add it using Home Assistant integrations. This will provide you with a configuration screen where you can first select the data source. Again, most inverters use JS. Some use JSON and in some rare cases HTML is used.

After selecting the data source, enter a name and IP address and you're good to go!

Optionally you can update the scan interval in the integration settings.

Examples

Config flow

Entities

What data source do I use?

The web interface has a javascript, JSON or HTML file that contains the actual values. These values are updated every few minutes.

  • Most inverters have a JS file, try accessing http://<your omnik ip address>/js/status.js in your browser.
  • 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.
  • A few inverters dont have JS or JSON but output the values directly in a HTML files. Check if your inverter supports the following URL: http://<your omnik ip address>/status.html. Note that this will work for almost all inverters, but you need to check the HTML source for a <script> tag that contains the relevant webData.

If none of the methods work, please open a new issue and we might be able to make it work for your inverter 😄 Make sure you let us know what inverter you use.

Contributing

Please see CONTRIBUTING and CODE_OF_CONDUCT for details.

Thanks

Special thank you to @klaasnicolaas for taking this component to the next level 🚀 and @relout for testing 👍

References