Saltar al contenido principal

Integración domótica Kavita, gratuita y de código abierto

Integración Kavita para Gladys Assistant

Su servidor de lectura Kavita en Gladys: nuevas series y tomos, lecturas en curso, escaneos.

Integre su servidor de lectura Kavita (libros, cómics, manga, autoalojado) en Gladys: las cifras de sus bibliotecas, sus series en curso y las páginas leídas hoy, las últimas novedades con sus portadas en el panel, y escenas que reaccionan cuando llega una nueva serie o un nuevo tomo, o cuando termina una serie.

La integración se ha probado con un servidor Kavita 0.9.1.4 real (la imagen Docker oficial), todavía no en una instalación real de Gladys: sus comentarios son bienvenidos en el foro de Gladys o en las issues.

Requisitos​

  • Gladys Assistant 5.1.0 o posterior.
  • Un servidor Kavita accesible desde Gladys: en su red, o en Internet detrás de un proxy inverso. Probado con Kavita 0.9; la 0.8 debería funcionar.
  • La clave de API de su cuenta Kavita: en Kavita, Ajustes → 3rd Party Clients (Auth Keys desde Kavita 0.9), copie la clave. La integración ve lo que ve esa cuenta: sus bibliotecas, su progreso de lectura.
  • La clave de un administrador da además el número de tomos y permite los escaneos de bibliotecas; la clave de un lector basta para todo lo demás.

Configuración​

  1. Instale la integración desde el catálogo de Gladys.
  2. En Configuración, introduzca la URL del servidor con su puerto (por ejemplo http://192.168.1.20:5000; detrás de un proxy inverso, https://example.org/kavita) y la clave de API.
  3. Si lo desea, elija la frecuencia de lectura del servidor (cada 5 minutos por defecto) y el idioma de los nombres.
  4. Guarde y pulse Probar la conexión: muestra la versión, la cuenta (administrador o lector) y las cifras encontradas.
  5. En la pestaña Descubrimiento, añada el dispositivo Kavita.

Dispositivo​

Kavita (un dispositivo para el servidor, visto desde su cuenta):

FuncionalidadSignificado
En línea1 mientras la integración lee el servidor
Bibliotecasbibliotecas que ve su cuenta
Seriesseries del servidor (de sus bibliotecas con una clave de lector)
Tomostomos del servidor (solo con clave de administrador)
Series en cursoseries empezadas y no terminadas («On Deck»)
Páginas leídas hoypáginas leídas hoy, según las cuenta Kavita
Versiónversión de Kavita

Panel​

  • Kavita: novedades: una cuadrícula de las últimas series añadidas, con sus portadas, la fecha y la biblioteca, el número de series y de tomos y (clave de administrador) un botón Escanear bibliotecas, el mismo que la acción de escena de abajo.
  • Kavita: seguir leyendo: sus series en curso con sus portadas, las páginas leídas y el progreso, el número de series en curso y las páginas leídas hoy.

Escenas​

Disparadores​

  • Nueva serie añadida: una nueva serie (libro, cómic, manga) aparece en una biblioteca tras un escaneo. Filtro: la biblioteca, exactamente como aparece en Kavita. Información: título de la serie, biblioteca, formato (archive, epub, pdf, images).
  • Nuevo tomo o capítulo: se añade un nuevo tomo o capítulo a una serie que ya está en Kavita. Filtro: la serie que sigue, su título exactamente como aparece en Kavita. Información: título de la serie, biblioteca.
  • Serie leída hasta el final: llega a la última página de una serie, o la marca como leída. Filtro: la biblioteca. Información: título de la serie, biblioteca, páginas.

Acciones​

  • Escanear bibliotecas de Kavita: Kavita busca archivos nuevos en una biblioteca (su nombre, sin distinguir mayúsculas) o en todas; el escaneo se ejecuta en segundo plano y las nuevas series llegan en la lectura siguiente, aproximadamente un minuto después. Solo con clave de administrador. Resultado: el número de bibliotecas escaneadas.
  • Leer las últimas novedades de Kavita: una frase para una notificación o un altavoz, por ejemplo «2 serie(s) nueva(s) en Kavita en los últimos 7 días: Quiet Morning y Test Comic.» Resultados: la frase, el número de series nuevas, el título de la última (12 series como máximo).

Ideas de escenas​

  • Nuevo tomo de mi manga: cuando Nuevo tomo o capítulo con su serie, enviar la notificación «Nuevo tomo de {series}».
  • Resumen del domingo: cada domingo a las 10 h, Leer las últimas novedades de Kavita y enviar la frase como mensaje.
  • Después de las descargas: cada noche a las 3 h, Escanear bibliotecas de Kavita, para que los archivos de sus herramientas de descarga estén ahí por la mañana.

Solución de problemas​

  • «el servidor no responde»: compruebe la dirección y el puerto desde la máquina de Gladys. Gladys ejecuta la integración en un contenedor: localhost es el propio contenedor, use la dirección IP de la máquina.
  • «clave de API rechazada»: la clave se ha restablecido o eliminado en Kavita; cópiela de nuevo.
  • «esta clave de API no es de un administrador»: el escaneo necesita la clave de una cuenta de administrador.
  • «no hay ningún servidor Kavita en esta dirección» o «la dirección redirige»: un servidor detrás de un proxy inverso necesita su ruta base (https://example.org/kavita); una página de inicio de sesión del proxy bloquea la API.
  • «certificado rechazado»: no se admite HTTPS con un certificado autofirmado; use la dirección http:// de su red.
  • Sin portada: Kavita no tiene ninguna para esta serie (un EPUB sin imagen), o guarda sus portadas en AVIF, que Gladys no muestra (Kavita: Ajustes → Media → Save Media As: PNG o WebP).
  • La integración solo registra su ciclo de vida; con LOG_LEVEL=debug, registra también cada evento, con los títulos.

Limitaciones​

  • El servidor se lee cada 1 a 15 minutos, no se recibe en tiempo real: una novedad llega a Gladys en ese intervalo (y después del escaneo del propio Kavita).
  • Como máximo 10 eventos de un mismo tipo por lectura (un primer gran escaneo anuncia 10 series, no cientos). Los tomos añadidos hace más de 24 horas no se anuncian (un Gladys detenido dos días no los repite).
  • Serie leída hasta el final sigue las 20 series leídas por última vez, a nivel de serie (un solo tomo leído hasta el final no es un evento).
  • Páginas leídas hoy sigue las estadísticas de lectura de Kavita (páginas leídas en sus lectores), contadas desde la primera lectura del día: las páginas leídas tras la medianoche mientras Gladys o Kavita estaban detenidos no cuentan.
  • Una cuenta de Kavita y un servidor por instalación de la integración.
  • Sin relación con el proyecto Kavita.

Parámetros de configuración​

Estos son los parámetros que Kavita te pide en su pantalla de configuración en Gladys.

ParámetroTipoObligatorioDescripción
Conexión a su servidor KavitasectionNoIntroduzca la dirección del servidor (por ejemplo http://192.168.1.20:5000) y la clave de API de su cuenta Kavita: en Kavita, Ajustes > 3rd Party Clients (Auth Keys desde la 0.9). La clave de un administrador da también el número de tomos y los escaneos.
URL del servidorstringSíDirección del servidor, puerto incluido (5000 para la imagen Docker). También funciona una dirección https detrás de un proxy inverso, con su ruta base.
Clave de APIsecretSí
ActualizaciónselectNoFrecuencia de lectura del servidor (unas ocho peticiones ligeras cada vez).
Idioma de los nombresselectNoIdioma de los nombres de las funcionalidades y de los textos de las acciones de escena. Los nombres se fijan al crear un dispositivo: para cambiarlos, elimine el dispositivo y vuelva a añadirlo.

Cómo instalar Kavita en Gladys​

  1. En Gladys, abre Integraciones: Kavita aparece en el catálogo junto a las integraciones nativas, con una insignia de comunidad.
  2. Haz clic en Instalar. Gladys descarga la imagen Docker (ghcr.io/guim31/gladys-kavita:1.0.0), la ejecuta en un entorno aislado del núcleo y genera la interfaz de la integración (dispositivos, descubrimiento y configuración).
  3. Abre la pantalla de Configuración de la integración, rellena los parámetros y guarda.
  4. También puedes instalarla directamente desde la URL de su repositorio: https://github.com/guim31/gladys-kavita.

Kavita requiere Gladys >=5.1.0. El catálogo de Gladys se actualiza cada hora, así que una nueva versión está disponible como máximo una hora después de publicarse.

¿Todavía no usas Gladys? Es gratuito y de código abierto: sigue la guía de instalación para empezar.

Sobre las integraciones externas​

Kavita es una integración externa: una integración comunitaria empaquetada como contenedor Docker y publicada en GitHub. Gladys la instala con un clic y la ejecuta en un entorno aislado del núcleo. La publica y mantiene guim31, no el equipo principal de Gladys.

Suscríbete a la newsletter de Gladys Assistant

Unos pocos correos al mes sobre nuevas versiones y novedades del proyecto. Enviados por Pierre-Gilles Leymarie, fundador del proyecto. Puedes darte de baja cuando quieras 🙂