Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add iskra documentation #33422

Merged
merged 15 commits into from
Sep 9, 2024
Merged

Add iskra documentation #33422

Changes from all commits
Commits
Show all changes
15 commits
Select commit Hold shift + click to select a range
47abb4f
Add iskra documentation
iskrakranj Jun 26, 2024
fb663e3
terminology fix
iskrakranj Jun 26, 2024
9014052
Update iskra.markdown
iskrakranj Jun 26, 2024
0bd931d
Updated ismra integration documentation
iskrakranj Jul 15, 2024
81d0dfa
Iskra documentation minor typo fix
iskrakranj Jul 15, 2024
e37f814
Iskra integration documentation minor fix
iskrakranj Jul 15, 2024
0aa737a
Iskra integration grammatical error fixes
iskrakranj Jul 15, 2024
0216d70
Update iskra.markdown
iskrakranj Jul 15, 2024
1f55269
tiny tweaks
c0ffeeca7 Jul 19, 2024
d4b4333
Update iskra.markdown
iskrakranj Jul 23, 2024
c03e190
Update source/_integrations/iskra.markdown
iskrakranj Sep 4, 2024
2204c5c
Update iskra.markdown
iskrakranj Sep 4, 2024
985f647
Fixed iskra documentation blank lines
iskrakranj Sep 4, 2024
2d6814d
Apply suggestions from code review
iskrakranj Sep 4, 2024
a1d78f6
Update source/_integrations/iskra.markdown
iskrakranj Sep 9, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
81 changes: 81 additions & 0 deletions source/_integrations/iskra.markdown
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,81 @@
---
title: Iskra
description: Instructions on how to connect your Iskra energy meters to Home Assistant.
ha_release: "2024.10"
ha_category:
- Energy
- Sensor
ha_codeowners:
- '@iskramis'
ha_config_flow: true
ha_domain: iskra
ha_iot_class: local_polling
ha_platforms:
- sensor
ha_integration_type: integration
---


The [Iskra](https://www.iskra.eu/) {% term integration %} allows you to connect Iskra energy meters and power quality analyzers to Home Assistant. Data is polled using Modbus TCP or the Iskra Smart Gateway's REST API.

## Supported devices

### Energy meters

Most Iskra's DIN rail mountable energy meters support Modbus RTU over RS485 and IR. To integrate them, you will need a Modbus TCP gateway or Iskra's Smart Gateway:

- Impact series ([IE38XX / IE14XX](https://www.iskra.eu/en/Iskra-Energy-meters/))
- WM series ([WM3XX / WM1XX](https://www.iskra.eu/en/Iskra-Energy-meters/))

### Power quality analyzers

These devices typically support Ethernet connections and use Modbus TCP for data polling:

- iMT/MT series ([MTXXX / iMTXXX](https://www.iskra.eu/en/NEW_SERIES_Universal_measuring_devices_/))
- iMC/MC series ([MCXXX / iMCXXX](https://www.iskra.eu/en/NEW_SERIES_Universal_measuring_devices_/))

## Configuration options

There are two ways to configure your devices with Home Assistant:
- [Using a Smart Gateway with REST API](#smart-gateway-with-rest-api)
- [Using a Modbus TCP connection](#modbus-tcp-connection)

iskrakranj marked this conversation as resolved.
Show resolved Hide resolved
### Smart Gateway with REST API

If your device supports Modbus RTU over RS485/IR, you can use Iskra's Smart Gateway to connect them via the REST API:

- **Smart Gateway**: Connect your devices to the Smart Gateway and add your devices to the Smart Gateway's configuration. It's also recommended to set a static IP on your smart gateway.
- **Home Assistant**: Add the Iskra integration, enter the Smart Gateway's **IP address**, and select **RestAPI** as the connection type within the Home Assistant integration. If authentication is required, Home Assistant will prompt you to enter the Smart Gateway's **credentials**. All devices configured on the Smart Gateway will be automatically added to your Home Assistant.

### Modbus TCP connection

If your device supports a direct internet connection, such as PQ meters (iMC/MC series/ iMT/MT series usually), you can use Modbus TCP:

- **Device**: Find your device using the [MiQen](https://www.iskra.si/sl/Programska-oprema/MiQen/) software and configure it to use a static IP.
- **Home Assistant**: Add the Iskra integration, enter the device's **IP address**, and select **Modbus TCP** as the connection type within the Home Assistant integration. Home Assistant will prompt you to enter the Modbus TCP port and Modbus address of your device.

{% include integrations/config_flow.md %}

## Sensors

The integration provides detailed information about power, current, and voltage for each phase. The data is updated every minute.

| Name | Unit | Description |
| ------------------- | ---- | :-------------------------------------------------------------------------- |
| total_active_power | W | Total active power. |
| total_reactive_power| var | Total reactive power. |
| total_apparent_power| VA | Total apparent power. |
| phase1_power | W | Active power of phase 1. |
| phase2_power | W | Active power of phase 2. |
| phase3_power | W | Active power of phase 3. |
| phase1_voltage | V | Voltage of phase 1. |
| phase2_voltage | V | Voltage of phase 2. |
| phase3_voltage | V | Voltage of phase 3. |
| phase1_current | A | Current of phase 1. |
| phase2_current | A | Current of phase 2. |
| phase3_current | A | Current of phase 3. |
| frequency | Hz | Frequency. |

## Note

This integration supports Iskra's energy meters, not Iskra Emeco ones.
Comment on lines +1 to +81
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Comprehensive Review of the Iskra Integration Documentation

The documentation is well-structured and covers essential aspects of the Iskra integration. Below are detailed comments for each section to ensure clarity, accuracy, and adherence to Home Assistant's documentation standards.

Front Matter (Lines 1-16):

  • The metadata at the top of the file is correctly formatted and includes all necessary fields such as title, description, ha_release, and others. This section is crucial for integration with Home Assistant's documentation system and seems to be correctly set up.

Introduction and Device Support (Lines 19-35):

  • The introduction clearly explains what the Iskra integration does and mentions the connection methods available. This is crucial for users to understand the scope of the integration.
  • The supported devices section is well-detailed, providing links to the products which can help users verify their device compatibility.

Configuration Options (Lines 37-55):

  • The configuration section is divided into two parts: using a Smart Gateway with REST API and using a Modbus TCP connection. This division is logical and caters to different user needs based on their hardware setup.
  • However, there is a hint from static analysis tools regarding the need for blank lines around lists (MD032). This needs to be addressed to comply with Markdown standards.

Sensors (Lines 59-77):

  • The sensors section is comprehensive, listing all the sensors provided by the integration along with their units and descriptions. This is crucial for users to understand the data they can monitor.
  • The table format is appropriate for this kind of data presentation, making it easy for users to quickly scan and find information.

General Note (Lines 79-81):

  • The note clarifying the support for Iskra's energy meters and not Iskra Emeco ones is an important distinction that helps manage user expectations.

Suggestions for Improvement:

  • Add Blank Lines Around Lists: To comply with Markdownlint's suggestion and improve readability, add blank lines around the lists in the configuration options section.
  • Clarify REST API Configuration: Previous comments suggest that the steps for configuring the REST API connection type could be clearer. It might be beneficial to include more detailed steps or diagrams if possible.

Overall, the documentation is well-prepared but could benefit from minor adjustments for clarity and formatting compliance.

Tools
Markdownlint

40-40: null
Lists should be surrounded by blank lines

(MD032, blanks-around-lists)