ЕЛК ЖКХ «Интер РАО» для Home Assistant

Предоставление информации о текущем состоянии ваших аккаунтов в ЕЛК ЖКХ.

Information retrieval from Inter RAO personal cabinets.

Установка

Посредством HACS

✔️️ Рекомендуемый метод

Установите HACS (инструкция по установке на оф. сайте)
Найдите lkcomu_interrao (или Интер РАО) в поиске по интеграциям ¹
Установите последнюю версию компонента, нажав на кнопку Установить (Install)
Перезапустите Home Assistant

Вручную

⚠️ Не рекомендуется

Скачайте архив с исходным кодом дополнения
Извлеките папку lkcomu_interrao из архива в папку custom_components внутри папки с конфигурацией Home Assistant (создайте её, если она отсутствует)
Перезапустите Home Assistant

Настройка

Через раздел интеграции

Перейдите в подраздел "Интеграции" в разделе "Настройки"
Нажмите кнопку "Добавить интеграцию"
Введите в поисковую строку: Личный кабинет Интер РАО (Энергосбыт) (англ. Inter RAO Personal Cabinet (Energosbyt))
Выберите найденную интеграцию
Следуйте инструкциям мастера по добавлению

Примечание: Поле Заголовок User-Agent (англ. User-Agent header) генерируется автоматически.

Описание конфигурационной схемы

# Файл `configuration.yaml`
lkcomu_interrao:

  # Тип выбранного ЛК
  # Значение по умолчанию: moscow
  # Перечень возможных значений:
  # - altai (ЛК Алтай (АО «АлтайЭнергосбыт»))
  # - bashkortostan (ЛКК ЭСКБ (Башэлектросбыт))
  # - moscow (ЕЛК ЖКХ (АО «Мосэнергосбыт», МосОблЕИРЦ, ПАО «Россети Московский регион»))
  # - oryol (ЛКК Орел (ООО «Орловский энергосбыт»))
  # - saratov (ЛК Саратов (ПАО «Саратовэнерго»))
  # - sevesk (ЕЛК Вологда (Северная сбытовая компания))
  # - tambov (ЛК ТЭСК (Тамбовская энергосбытовая компания))
  # - tomsk (ЕЛК Томск (Томскэнергосбыт / Томск РТС))
  # - volga (ЛКК ЭСВ (Энергосбыт Волга))
  type: "..."

  # Имя пользователя
  # Обязательный параметр
  username: "..."

  # Пароль
  # Обязательный параметр
  password: "..."

  # Конфигурация по умолчанию для лицевых счетов
  # Необязательный параметр
  #  # Данная конфигурация применяется, если отсутствует  # конкретизация, указанная в разделе `accounts`.
  default:

    # Получать ли ссылки на логотипы
    # Значение по умолчанию: истина (true)
    logos: true | false

    # Добавлять ли объект(-ы): Информация о лицевом счёте
    # Значение по умолчанию: истина (true)
    accounts: true | false

    # Добавлять ли объект(-ы): Счётчик коммунальных услуг
    # Значение по умолчанию: истина (true)
    meters: true | false

    # Добавлять ли объект(-ы): Последний зарегистрированный платёж
    # Значение по умолчанию: истина (true)
    last_payment: true | false

    # Добавлять ли объект(-ы): Последняя выпущенная квитанция
    # Значение по умолчанию: истина (true)
    last_invoice: true | false

  # Настройки для отдельных лицевых счетов
  # Необязательный параметр
  accounts:

    # Номер лицевого счёта
    "...":

      # Конфигурация по конкретным лицевым счетам выполняется аналогично
      # конфигурации по умолчанию для лицевых счетов (раздел `default`).
      ...

Вариант конфигурации "Чёрный список"

Для реализации белого списка, конфигурация выполняется следующим образом:

...
lkcomu_interrao:
  ...
  # Выборочное исключение лицевых счетов
  accounts:
    # Все указанные ниже лицевые счета будут добавлены
    "12345-678-90": false
    "98765-432-10": false
    "111000111000": false

Вариант конфигурации "Белый список"

Для реализации белого списка, конфигурация выполняется следующим образом:

...
lkcomu_interrao:
  ...
  # Отключение добавление лицевых счетов по умолчанию
  default: false

  # Выборочное включение лицевых сченов
  accounts:
    # Все указанные ниже лицевые счета будут добавлены
    "12345-678-90": true
    "98765-432-10": true
    "111000111000": true

Также возможно использовать укороченную запись:

...
lkcomu_interrao:
  ...
  # Данный пример функционально эквивалентен предыдущему примеру
  default: false
  accounts: ["12345-678-90", "98765-432-10", "111000111000"]

Доступные объекты

Все объекты гарантируют наличие и полноту следующих атрибутов:

account_code: str - Номер лицевого счёта
account_id: int - Внутренний идентификатор лицевого счёта

Лицевые счета — `lkcomu_interrao_account`

Домен объектов: sensor

Объект лицевого счёта отображает основную информацию о лицевом счёте, а также его баланс (положительное значение) или имеющуюся задолженность (отрицательное значение) ¹.

Состояние объекта может принимать следующие значения:

unknown - Информация о состоянии баланса не была предоставлена
число - Текущее состояние баланса

¹ ... в том случае, если лицевой счёт предоставляет информацию о балансе

Сопутствующие службы

Данные службы применимы только к объектам лицевых счетов

`set_description` — Установить описание лицевого счёта

Устанавливает описание для лицевого счёта и провоцирует его обновление.

Параметры

description: str | None - (опционально) Новое описание для лицевого счёта

Результат

Событие с идентификатором lkcomu_interrao_set_description и следующими значениями:

success: bool - Если установка описания была выполнена успешно
description: str | None - Описание, с которым была вызвана служба
previous: str | None - Описание, которым обладал (или, в случае ошибки, обладает) лицевой счёт
account_id: int - Внутренний идентификатор лицевого счёта
account_code: str - Номер лицевого счёта

`get_invoices` — Получение квитанций по периодам

Только для объектов, поддерживающих данный функционал

Параметры

start: str | None - (опционально) Дата начала периода
end: str | None - (опционально) Дата окончания периода

Результат

Событие с идентификатором lkcomu_interrao_get_invoices и следующими значениями:

sum: float - сумма всех квитанций за указанный период
period: str - период квитанции
invoice_id: str - идентификатор квитанции
total: float - сумма к оплате по квитанции
paid: float | None - сумма оплат, учтённых к квитанции
initial: float | None - задолженность/избыток на начало периода
charged: float | None - начислено за период
insurance: float | None - добровольное страхование
benefits: float | None - льготы
penalty: float | None - штрафы
service: float | None - тех. обслуживание

`get_payments` — Получение платежей по периодам

Только для объектов, поддерживающих данный функционал

Параметры

start: str | None - (опционально) Дата начала периода
end: str | None - (опционально) Дата окончания периода

Результат

Событие с идентификатором lkcomu_interrao_get_payments и следующими значениями:

sum: float - сумма всех платежей за указанный период
amount: float - объём платежа
paid_at: str - дата/время платежа
period: str - период, за который платёж был выполнен
status: str | None - состояние платежа
agent: str | None - банк-обработчик платежа
group: str | None - группа платежа (для лицевых счетов с несколькими типами платежей)

Счётчики — `lkcomu_interrao_meter`

Домен объектов: sensor

Объект счётчика отображает информацию о счётчике, а также сведения о последних переданных показаниях и диапазоне периода передачи показаний¹.

Состояние объекта может принимать следующие значения:

ok - Текстовое описание состояния отсутствует
текст - Текстовое описание состояние счётчика (может быть любой длины, и содержать в себе любой набор символов, в т.ч. HTML-теги)

Объект гарантирует наличие и полноту следующих атрибутов:

meter_code - Номер счётчика
install_date - Дата установки
submit_period_start - Дата начала периода передачи показаний (в текущем месяце) ¹
submit_period_end - Дата окончания периода передачи показаний (в текущем месяце) ¹
submit_period_active - Флаг активности периода передачи показаний ¹
zone_t[N]_name - Наименование тарифной зоны / тарифа
zone_t[N]_last_indication - Последнее показание по тарифной зоне ²

Объект гарантирует наличие, но не полноту следующих атрибутов:

model - Модель счётчика
last_indications_date - Дата последней передачи показаний
zone_t[N]_description - Описание тарифной зоны / тарифа
zone_t[N]_today_indication - Значение переданного сегодня показания по тарифной зоне
zone_t[N]_invoice_indication - Значение последнего показания по тарифной зоне, учтённому в квитанции
zone_t[N]_period_indication - Значение переданного за период показания по тарифной зоне ¹
zone_t[N]_invoice_name - Наименование тарифной зоны, указанное в последней квитанции

¹ ... в том случае, если счётчик поддерживает передачу показаний
² При отсутствии фактического значения атрибут примет значение 0.0

Сопутствующие службы

Данные службы применимы только к объектам счётчиков

`push_indications` — Передача показаний

Только для объектов, поддерживающих данный функционал

Служба передачи показаний позволяет отправлять показания по счётчикам в личный кабинет, и имеет следующий набор параметров:

Название	Описание
`target`	Выборка целевых объектов, для которых требуется передавать показания
`data`.`indications`	Список / именованный массив показаний, передаваемых в ЛК
`data`.`incremental`	Суммирование текущих показаний с передаваемыми
`data`.`ignore_period`	Игнорировать период передачи показаний
`data`.`ignore_indications`	Игнорировать ограничения по значениям

1. Обычная передача показаний

Например, если передача показаний активна с 15 по 25 число, а сегодня 11, то показания не будут отправлены¹.
Например, если текущие, последние или принятые значения по счётчику – 321, 654 и 987 по зонам Т1, Т2 и Т3 соответственно, то показания не будут отправлены¹.

service: lkcomu_interrao.push_indications
data:
  indications: "123, 456, 789"
target:
  entity_id: sensor.1243145122_meter_123456789

... или, с помощью именованного массива:

service: lkcomu_interrao.calculate_indications
data:
  indications:
    t1: 123
    t2: 456
    t3: 789
target:
  entity_id: sensor.1243145122_meter_123456789

... или, с помощью списка:

service: lkcomu_interrao.calculate_indications
data:
  indications: [123, 456, 789]
target:
  entity_id: sensor.1243145122_meter_123456789

2. Форсированная передача показаний

Отключение всех ограничений по показаниям.

Например, если передача показаний активна с 15 по 25 число, а сегодня 11, то показания будут отправлены¹.
Например, если текущие, последние или принятые значения по счётчику – 321, 654 и 987 по зонам Т1, Т2 и Т3 соответственно, то показания будут отправлены¹.

service: lkcomu_interrao.calculate_indications
data_template:
  indications: [123, 456, 789]
  ignore_indications: true
  ignore_periods: true
target:
  entity_id: sensor.1243145122_meter_123456789

3. Сложение показаний

Например, если передача показаний активна с 15 по 25 число, а сегодня 11, то показания не будут отправлены¹.
Например, если текущие, последние или принятые значения по счётчику – 321, 654 и 987 по зонам Т1, Т2 и Т3 соответственно, то показания будут отправлены¹.

Внимание: в данном примере будут отправлены показания 444, 1110 и 1776, а не 123, 456 и 789.

service: lkcomu_interrao.calculate_indications
data_template:
  indications: [123, 456, 789]
  incremental: true
target:
  entity_id: sensor.1243145122_meter_123456789

`calculate_indications` — Подсчёт показаний

Только для объектов, поддерживающих данный функционал

Последние платежи — `lkcomu_interrao_last_payment`

Домен объектов: binary_sensor

Объект последнего платежа отображает информацию о последнем зарегистрированном платеже, связанном с лицевым счётом.

Состояние объекта может принимать следующие значения:

on - Платёж был обработан
off - Платёж ещё не обработан
unknown - Последний платёж не был найден

Объект гарантирует наличие и полноту следующих атрибутов:

amount: float - Сумма платежа
paid_at: str - Дата и время платежа
period: str - Период, за который был выполнен платёж

Объект гарантирует наличие, но не полноту, следующих атрибутов:

status: str | None - Состояние платежа
agent: str | None - Банк, проводящий платёж
group: str | None - Группа платежа (для лицевых счетов с несколькими источниками платежей)

Последние квитанции — `lkcomu_interrao_last_invoice`

Домен объектов: sensor

@ TODO @

Поддерживаемые ЛК

Ниже предъявлен перечень поддерживаемых ЛК с их внутренними идентификаторами. Данные идентификаторы используются как значение для поля type.

Внимание: Поддерживаются только ЛК физических лиц. Поддержка ЛК юридических лиц не планируется.

ЕЛК ЖКХ (АО «Мосэнергосбыт», МосОблЕИРЦ, ПАО «Россети Московский регион») - `moscow`

Пример конфигурации:

...
lkcomu_interrao:
  type: moscow
  username: username1
  password: password1

Поставщик `MES` — Электричество

Для поставщика реализована поддержка следующих объектов:

Информация о лицевом счёте

Последний зарегистрированный платёж

Последняя выпущенная квитанция

Счётчик коммунальных услуг

Поставщик `KSG` — Электричество

Для поставщика реализована поддержка следующих объектов:

Информация о лицевом счёте

Последний зарегистрированный платёж

Последняя выпущенная квитанция

Счётчик коммунальных услуг

Поставщик `MOE` — ЕПД

Для поставщика реализована поддержка следующих объектов:

Информация о лицевом счёте

Последний зарегистрированный платёж

Последняя выпущенная квитанция

Счётчик коммунальных услуг

Поставщик `TKO` — ТКО

Для поставщика реализована поддержка следующих объектов:

Информация о лицевом счёте

Последний зарегистрированный платёж

Снимок экрана отсутствует

Последняя выпущенная квитанция

Счётчик коммунальных услуг

Снимок экрана отсутствует

ЛКК Орел (ООО «Орловский энергосбыт») - `oryol`

Пример конфигурации:

...
lkcomu_interrao:
  type: oryol
  username: username1
  password: password1

Поставщик `ORL_EPD` — ЕПД

Для поставщика реализована поддержка следующих объектов:

Информация о лицевом счёте

...
lkcomu_interrao:
  type: altai
  username: username1
  password: password1

Поставщик `ALT` — Электричество

Для поставщика реализована поддержка следующих объектов:

Информация о лицевом счёте

Последний зарегистрированный платёж

Последняя выпущенная квитанция

Счётчик коммунальных услуг

Дополнительная информация

Компонент находится в активной разработке. Примерная дорожная карта и план развития:

[0.0.1; 0.1.0) — первичная обкатка компонента на поддерживаемых поставщиках;
[0.1.0; 0.2.0) — разработка визуального конфигуратора для интеграции;
[0.2.0; 1.0.0) — выполнение задач по оптимизации и чистке кода;
[1.0.0; .....) — финальный выпуск компонента и исправление ошибок.

Увеличение старшей версии сопутствует:

изменениям в конфигурационной схеме;
удалению функционала;
расширению сферы применения интеграции.

Увеличение младшей версии сопутствует:

добавлению нового функционала;
исправлению значительных ошибок.

Увеличение номера сборки сопутствует:

исправлению мелких ошибок / выпуску хотфиксов;
изменениям во взаимодействии с основополагающей библиотекой (или её версии).

Files

README.md

Latest commit

History

README.md

File metadata and controls

ЕЛК ЖКХ «Интер РАО» для Home Assistant

Установка

Посредством HACS

Вручную

Настройка

Через раздел интеграции

Описание конфигурационной схемы

Вариант конфигурации "Чёрный список"

Вариант конфигурации "Белый список"

Доступные объекты

Лицевые счета — lkcomu_interrao_account

Сопутствующие службы

set_description — Установить описание лицевого счёта

Параметры

Результат

get_invoices — Получение квитанций по периодам

Параметры

Результат

get_payments — Получение платежей по периодам

Параметры

Результат

Счётчики — lkcomu_interrao_meter

Сопутствующие службы

push_indications — Передача показаний

1. Обычная передача показаний

2. Форсированная передача показаний

3. Сложение показаний

calculate_indications — Подсчёт показаний

Последние платежи — lkcomu_interrao_last_payment

Последние квитанции — lkcomu_interrao_last_invoice

Поддерживаемые ЛК

ЕЛК ЖКХ (АО «Мосэнергосбыт», МосОблЕИРЦ, ПАО «Россети Московский регион») - moscow

Пример конфигурации:

Поставщик MES — Электричество

Поставщик KSG — Электричество

Поставщик MOE — ЕПД

Поставщик TKO — ТКО

ЛКК Орел (ООО «Орловский энергосбыт») - oryol

Пример конфигурации:

Поставщик ORL_EPD — ЕПД

Поставщик ORL — Электричество

ЛКК ЭСВ (Энергосбыт Волга) - volga

Пример конфигурации:

Поставщик VLD — Электричество

ЕЛК Томск (Томскэнергосбыт / Томск РТС) - tomsk

Пример конфигурации:

Поставщик TMK_NRG — generic

ЛК ТЭСК (Тамбовская энергосбытовая компания) - tambov

Пример конфигурации:

Поставщик TMB — Электричество

ЕЛК Вологда (Северная сбытовая компания) - sevesk

Пример конфигурации:

Поставщик VLG — Электричество

ЛК Саратов (ПАО «Саратовэнерго») - saratov

Пример конфигурации:

Поставщик SAR — Электричество

ЛКК ЭСКБ (Башэлектросбыт) - bashkortostan

Пример конфигурации:

Поставщик UFA — Электричество

ЛК Алтай (АО «АлтайЭнергосбыт») - altai

Пример конфигурации:

Поставщик ALT — Электричество

Дополнительная информация

Лицевые счета — `lkcomu_interrao_account`

`set_description` — Установить описание лицевого счёта

`get_invoices` — Получение квитанций по периодам

`get_payments` — Получение платежей по периодам

Счётчики — `lkcomu_interrao_meter`

`push_indications` — Передача показаний

`calculate_indications` — Подсчёт показаний

Последние платежи — `lkcomu_interrao_last_payment`

Последние квитанции — `lkcomu_interrao_last_invoice`

ЕЛК ЖКХ (АО «Мосэнергосбыт», МосОблЕИРЦ, ПАО «Россети Московский регион») - `moscow`

Поставщик `MES` — Электричество

Поставщик `KSG` — Электричество

Поставщик `MOE` — ЕПД

Поставщик `TKO` — ТКО

ЛКК Орел (ООО «Орловский энергосбыт») - `oryol`

Поставщик `ORL_EPD` — ЕПД

Поставщик `ORL` — Электричество

ЛКК ЭСВ (Энергосбыт Волга) - `volga`

Поставщик `VLD` — Электричество

ЕЛК Томск (Томскэнергосбыт / Томск РТС) - `tomsk`

Поставщик `TMK_NRG` — generic

ЛК ТЭСК (Тамбовская энергосбытовая компания) - `tambov`

Поставщик `TMB` — Электричество

ЕЛК Вологда (Северная сбытовая компания) - `sevesk`

Поставщик `VLG` — Электричество

ЛК Саратов (ПАО «Саратовэнерго») - `saratov`

Поставщик `SAR` — Электричество

ЛКК ЭСКБ (Башэлектросбыт) - `bashkortostan`

Поставщик `UFA` — Электричество

ЛК Алтай (АО «АлтайЭнергосбыт») - `altai`

Поставщик `ALT` — Электричество