Skip to content

black-roland/homeassistant-vkcloud-vision

Repository files navigation

See description in English below 👇

VK Cloud Vision для Home Assistant

Добавить репозиторий в HACS Настроить интеграцию

Интеграция добавляет поддержку облачного распознавания объектов и текста через VK Cloud Vision.
Используйте возможности компьютерного зрения для создания автоматизаций на основе анализа изображений с камер видеонаблюдения.

Возможности

  • Распознавание объектов (людей, животных) и автомобильных номеров.
  • Распознавание текста (OCR): например, надписей на автомобилях.
  • Сохранение стоп-кадров с разметкой обнаруженных объектов.
  • Blueprints для реализации распространённых сценариев.

VK Cloud Vision — это облачный сервис, плата за который взимается в соответствии с тарифами. При первой регистрации можно получить приветственные бонусы.

Сигнализация с распознаванием объектов Распознавание автомобильных номеров

Установка и настройка

Подготовка

  1. Зарегистрируйтесь в VK Cloud.
  2. Создайте новый ключ в разделе «Доступ через идентификатор клиента и секретный ключ».
  3. Сохраните полученные данные:
    • Идентификатор клиента (Client ID);
    • Секретный ключ (Client Secret).

Установка

  1. Скачайте интеграцию через HACS.
  2. Перезапустите Home Assistant.
  3. Перейдите в Настройки → Устройства и службы → Добавить интеграцию или используйте кнопку настройки.
  4. Введите Идентификатор клиента и Секретный ключ, полученные в личном кабинете VK Cloud.

Использование на практике

Интеграция с motionEye

Интеграция с VK Cloud Vision занимается только распознаванием объектов, и ей нужен внешний триггер, который запустит распознавание. Про использование motionEye в качестве такого триггера можно почитать тут.

Охранная сигнализация с облачным распознаванием объектов

Импорт blueprint

Активирует сигнализацию при обнаружении людей или транспортных средств, игнорируя ложные срабатывания (например, движение веток или животных).

Основные функции:

  • Активация только в выбранных режимах охраны;
  • Проверка на наличие важных объектов («Человек», «Автомобиль», «Грузовик», «Автобус»);
  • Сохранение стоп-кадров с разметкой объектов;
  • Логирование результатов обнаружения.

Система контроля доступа для транспорта

Импорт blueprint

Автоматическое открытие ворот и выполнение других действий для «своих» машин и спецтранспорта.

Основные функции:

  • Распознавание номеров «своих» автомобилей;
  • Идентификация спецтранспорта (скорая, спасатели, пожарные);
  • Обнаружение служебного транспорта (курьеры, доставка);
  • Гибкая настройка действий для разных категорий.

Оповещение при обнаружении объектов

Импорт blueprint

Отправляет push-уведомления при обнаружении заданных объектов с прикреплением стоп-кадра и списком распознанных объектов. Логирует все обнаруженные объекты в журнал (logbook).

Карточка с изображением с камеры Журнал

Доступные сервисы

Интеграция предоставляет два действия для анализа изображений с камер:

vkcloud_vision.detect_objects

Обнаруживает объекты, сцены или автомобильные номера на изображениях с камеры. Позволяет сохранять стоп-кадры с рамками вокруг обнаруженных объектов.

Параметры:

  • modes (необязательное, по умолчанию ["multiobject"]) — режимы распознавания. Доступные варианты:
    • multiobject: Искать на изображении мультиобъекты — объекты и все множество боксов всех найденных объектов.
    • car_number: Распознавание автомобильных номеров.
    • object: Искать на изображении объекты.
    • object2: Искать на изображении объекты (версия модели v2 — распознает объекты, принадлежащие большему количеству классов).
    • scene: Распознавание сцен.
    • pedestrian: Искать на изображении людей (более точно определяет множество боксов всех людей на изображении).
    • selfie: Определение селфи.
  • prob_threshold (необязательное, по умолчанию 0.1): Минимальная вероятность (от 0 до 1) для включения обнаруженных объектов в результаты. Например, значение 0.1 означает, что будут учитываться только объекты с точностью обнаружения не менее 10%.
  • file_out (необязательное): Путь для сохранения стоп-кадра с разметкой (например, /config/www/vkcloud_vision_snapshot.jpg).
  • bounding_boxes (необязательное, по умолчанию rus): Стиль отображения рамок:
    • none: Не отображать рамки;
    • no_labels: Только рамки без подписей;
    • rus: Подписи на русском языке;
    • eng: Подписи на английском языке.
  • num_snapshots (необязательное, по умолчанию 1): Количество последовательных стоп-кадров, снимаемых с камеры заданным интервалом. Повышает точность распознавания, особенно для движущихся объектов.
  • snapshot_interval_sec (необязательное, по умолчанию 0.5): Интервал в секундах между стоп-кадрами.
  • max_retries (необязательное, по умолчанию 5): Количество попыток повторного выполнения запросов к API в случае таймаутов или временных ошибок.

Пример использования:

action: vkcloud_vision.detect_objects
target:
  entity_id: camera.front_door
data:
  modes:
    - multiobject
    - car_number
  file_out: /config/www/vkcloud_vision_snapshot.jpg
  bounding_boxes: rus

vkcloud_vision.recognize_text

Распознает текст на изображениях с камеры (например, надписи на автомобилях).

Параметры:

  • detailed (необязательное, по умолчанию false): Если true, возвращает подробные результаты с координатами текста и оценкой достоверности.

Пример использования:

action: vkcloud_vision.recognize_text
target:
  entity_id: camera.front_door
data:
  detailed: true

Поддержка автора

Если интеграция оказалась полезной, вы можете угостить автора чашечкой кофе. Ваша благодарность ценится!

Благодарности

Огромное спасибо всем, кто поддерживает этот проект:

Спасибо

Уведомление

Данная интеграция является неофициальной и не связана с VK Cloud. VK Cloud Vision — это сервис, предоставляемый VK Cloud.

Данная интеграция не является официальным продуктом VK Cloud и не поддерживается VK.


VK Cloud Vision for Home Assistant

Add repository to HACS Configure Integration

This integration brings cloud-based object and text recognition to Home Assistant using the VK Cloud Vision service. Leverage computer vision to create automations based on image analysis from surveillance cameras.

Key Features

  • Object and license plate detection using the vkcloud_vision.detect_objects action.
  • Text recognition on images (e.g., vehicle inscriptions) using the vkcloud_vision.recognize_text action.
  • Create automations based on image analysis from surveillance cameras.
  • Save snapshots with annotations of detected objects.

Installation and Setup

Prerequisites

Register with VK Cloud:

  • Sign up at VK Cloud.
  • Activate the Vision service in the dashboard.
  • Generate access keys in the AI API → Vision API section:
    • Client ID.
    • Client Secret.
  • Save the keys for integration setup.

Installation

  1. Open HACS → Integrations.
  2. Click the three-dot menu in the top right and select Custom repositories.
  3. Add the repository: https://github.com/black-roland/homeassistant-vkcloud-vision, select Integration as the category.
  4. Find and install the VK Cloud Vision integration.
  5. Restart Home Assistant.

Configuration

  1. Go to Settings → Devices & Services → Add Integration or use the configuration button.
  2. Enter the Client ID and Client Secret obtained from VK Cloud.
  3. Save the configuration and restart Home Assistant if prompted.

Donations

If this integration has been useful to you, consider buying the author a coffee. Your gratitude is appreciated!

Thank you

Thank you

Notice

This is a community project, not affiliated with VK Cloud. VK Cloud Vision is a service provided by VK Cloud.

This integration is not an official VK Cloud product and is not supported by VK.