Integración domótica Audiobookshelf, gratuita y de código abierto
Siga quién escucha qué en su servidor Audiobookshelf y reaccione en sus escenas.
Publicado por guim31
- Dispositivos
- Versión 1.0.0
- Requiere Gladys >=5.1.0
- ★ 0
Integre su servidor Audiobookshelf (audiolibros y pódcasts) en Gladys, a través de su red local: quién escucha qué, el progreso y el tiempo restante de cada libro, los minutos escuchados hoy, los últimos añadidos con sus portadas en el panel, y escenas que reaccionan cuando alguien inicia o detiene una escucha, termina un libro o cuando se descarga un nuevo episodio de pódcast.
La integración se ha probado con un servidor Audiobookshelf 2.37 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.
Lo que necesita
- Gladys Assistant 5.1.0 o posterior.
- Un servidor Audiobookshelf accesible desde Gladys (misma red).
- Una clave de API de administrador: en Audiobookshelf, Ajustes → Claves API → Añadir, para un usuario admin (Audiobookshelf 2.26 o posterior). En un servidor más antiguo, use el token de API de un usuario admin (Ajustes → Usuarios → el usuario). Solo un administrador puede leer las sesiones de escucha y el progreso de todos los usuarios.
Puesta en marcha
- Instale la integración desde el catálogo de Gladys.
- En Configuración, introduzca la URL del servidor con su puerto (por
ejemplo
http://192.168.1.20:13378; detrás de un proxy inverso,https://example.org/audiobookshelf) y la clave de API. - Si lo desea, elija la frecuencia de lectura de las sesiones de escucha (cada 30 segundos por defecto) y el idioma de los nombres.
- Guarde y haga clic en Probar la conexión: muestra la versión, las bibliotecas y los usuarios encontrados.
- En la pestaña Descubrimiento, añada el servidor y los usuarios que quiera seguir.
Dispositivos
Audiobookshelf (el servidor):
| Funcionalidad | Significado |
|---|---|
| En línea | 1 mientras la integración lee el servidor |
| Escuchas en curso | número de reproductores que están sonando |
| Audiolibros | libros de las bibliotecas de libros |
| Pódcasts | pódcasts de las bibliotecas de pódcasts |
| Episodios de pódcasts | episodios descargados en las bibliotecas de pódcasts |
| Versión | versión de Audiobookshelf |
Audiobookshelf <usuario> (un dispositivo por usuario del servidor):
| Funcionalidad | Significado |
|---|---|
| Escuchando | 1 mientras suena un reproductor del usuario |
| Título actual | el libro (con su autor) o el episodio (con su pódcast) que suena, si no el último |
| Progreso | posición en ese libro o episodio, en % |
| Tiempo restante | minutos restantes de ese libro o episodio |
| Escuchado hoy | minutos escuchados hoy (día del servidor) |
Un reproductor en pausa mantiene su sesión abierta: el usuario cuenta como escuchando hasta que el reproductor lleva 90 segundos sin informar de su posición.
Panel
- Escuchando ahora: quién escucha qué, con las portadas, el progreso y una insignia Escuchando o En pausa (una sesión en pausa se muestra 30 minutos), el número de reproductores que suenan y los minutos escuchados hoy. Todos los usuarios, o el elegido en la configuración del widget.
- Añadidos recientemente: una cuadrícula de los últimos audiolibros y episodios de pódcast añadidos, con sus portadas, el número de audiolibros y de pódcasts, y un botón Buscar episodios (el mismo que la acción de escena de abajo).
Escenas
Disparadores
- Escucha iniciada: un usuario inicia o reanuda un audiolibro o un episodio. Filtros: el usuario, el tipo (audiolibro o episodio de pódcast). Información: usuario, título, autor, pódcast, tipo, progreso.
- Escucha detenida: un usuario pausa o detiene (90 segundos sin progreso). Mismos filtros e información, más los minutos escuchados en la sesión.
- Libro o episodio terminado: un usuario llega al final de un libro o de un episodio, o lo marca como terminado. Mismos filtros.
- Nuevo episodio de pódcast descargado: Audiobookshelf ha descargado un episodio nuevo (descarga automática, o la acción de abajo). Filtro: el título del pódcast, exactamente como aparece en Audiobookshelf. Información: pódcast, título del episodio, biblioteca, duración en minutos.
Acciones
- Buscar nuevos episodios de pódcast: Audiobookshelf lee el feed de cada pódcast y descarga los episodios nuevos. Resultados: pódcasts comprobados, episodios nuevos encontrados.
- Leer por dónde voy en mi audiolibro: una frase para una notificación o un altavoz, por ejemplo «alice va por el 33 % de Quiet Morning de Jane Doe, quedan 7 min.» Elija el usuario; vacío, todos los que escuchan o tienen un libro en curso. Resultados: la frase, el título, el progreso.
Ideas de escenas
- Cuento de buenas noches: cuando Escucha iniciada para el usuario de los niños después de las 20 h, bajar la luz del dormitorio; cuando Escucha detenida, apagarla.
- Pódcast de la mañana: cada día a las 6 h, Buscar nuevos episodios de pódcast; cuando Nuevo episodio de pódcast descargado para su programa diario, enviar una notificación con su título.
- Enhorabuena: cuando Libro o episodio terminado con el tipo audiolibro, enviar un mensaje de enhorabuena con el título del libro.
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:
localhostes el propio contenedor, use la dirección IP de la máquina. - «clave de API rechazada»: la clave se ha eliminado, desactivado o ha caducado; cree una nueva.
- «esta clave de API no es de un administrador»: cree la clave para un usuario de tipo admin o root.
- «no hay ningún servidor Audiobookshelf en esta dirección» o «la
dirección redirige»: un servidor detrás de un proxy inverso necesita su
ruta (
https://example.org/audiobookshelf); una página de inicio de sesión del proxy bloquea la API: use la dirección local. - «certificado rechazado»: HTTPS con un certificado autofirmado no está
soportado; use la dirección
http://de su red. - Sin portada: Audiobookshelf no tiene ninguna para ese libro o pódcast.
- La integración solo registra su ciclo de vida; con
LOG_LEVEL=debugregistra también cada evento de escucha, con los títulos.
Límites
- Las sesiones se leen cada 15 a 60 segundos, no se reciben al instante: un inicio o una parada llega a Gladys dentro de ese intervalo (90 segundos para una pausa).
- Las bibliotecas, los usuarios, el progreso y el tiempo escuchado hoy se leen cada 5 minutos, y en el acto para un usuario que inicia o detiene una escucha.
- Los libros terminados y los episodios descargados hace más de 24 horas no se anuncian (un Gladys parado dos días no los reproduce).
- Los libros electrónicos y su progreso de lectura no están cubiertos.
- Sin control de reproducción: Audiobookshelf no permite controlar sus reproductores a distancia.
- Sin relación con el proyecto Audiobookshelf.
Parámetros de configuración
Estos son los parámetros que Audiobookshelf te pide en su pantalla de configuración en Gladys.
| Parámetro | Tipo | Obligatorio | Descripción |
|---|---|---|---|
| Conexión a su servidor Audiobookshelf | section | No | Introduzca la dirección del servidor (por ejemplo http://192.168.1.20:13378) y una clave de API de administrador: en Audiobookshelf, Ajustes > Claves API > Añadir, para un usuario admin. Antes de la versión 2.26, use el token de API de un admin (Ajustes > Usuarios). |
| URL del servidor | string | Sí | Dirección del servidor, puerto incluido (13378 para la imagen Docker, a menudo 80). También funciona una dirección https detrás de un proxy inverso. |
| Clave de API (administrador) | secret | Sí | |
| Actualización de las escuchas | select | No | Frecuencia de lectura de las sesiones de escucha abiertas. Bibliotecas, usuarios y progreso se leen cada 5 minutos. |
| Idioma de los nombres | select | No | Idioma 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 Audiobookshelf en Gladys
- En Gladys, abre Integraciones: Audiobookshelf aparece en el catálogo junto a las integraciones nativas, con una insignia de comunidad.
- Haz clic en Instalar. Gladys descarga la imagen Docker (
ghcr.io/guim31/gladys-audiobookshelf: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). - Abre la pantalla de Configuración de la integración, rellena los parámetros y guarda.
- También puedes instalarla directamente desde la URL de su repositorio: https://github.com/guim31/gladys-audiobookshelf.
Audiobookshelf 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
Audiobookshelf 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.
- Explorar todas las integraciones, nativas y de la comunidad
- Crear y publicar tu propia integración externa
- Código fuente en GitHub — fuente de esta documentación