wolffshots / hass-audiobookshelf Goto Github PK

View Code? Open in Web Editor NEW

30.0 4.0 2.0 890 KB

Adds sensors for an Audiobookshelf server to Home Assistant to show connection and active sessions

License: MIT License

Python 100.00%

audiobooks audiobookshelf home-assistant home-automation

hass-audiobookshelf's Introduction

Audiobookshelf

This component will set up the following platforms.

Entity	Description
`binary_sensor`:`connectivity`	Show whether the server is connected
`sensor`:`open_sessions`	Show number of open audio sessions

Installation

Manual installation

Using the tool of choice open the directory (folder) for your HA configuration (where you find configuration.yaml).
If you do not have a custom_components directory (folder) there, you need to create it.
In the custom_components directory (folder) create a new folder called audiobookshelf.
Download all the files from the custom_components/audiobookshelf/ directory (folder) in this repository.
Place the files you downloaded in the new directory (folder) you created.
Restart Home Assistant
In the HA UI go to "Configuration" -> "Integrations" click "+" and search for "Audiobookshelf"

Configuration

Getting an access token

Log in as the admin user
Go to Settings > Users
Click on the account
Copy the API Token from beneath the user's name

For more info on what the token can be used for see: https://api.audiobookshelf.org/#introduction

Setting up via the UI

Credits

This project was generated from @oncleben31's Home Assistant Custom Component Cookiecutter template.

Code template was mainly taken from @Ludeeus's integration_blueprint template

hass-audiobookshelf's People

Contributors

Stargazers

Watchers

Forkers

donkevlar jenemoore

hass-audiobookshelf's Issues

Adding "Now playing" data a la spotify/sonos

This is awesome integration, thank you. If it's possible I would love to be able to pull the cover of the audiobook I'm listening to, like how Spotify or Sonos show the album art when an entity is playing.

Deprecated `async_add_job` is called

Detected that custom integration 'audiobookshelf' calls async_add_job, which is deprecated and will be removed in Home Assistant 2025.4; Please review https://developers.home-assistant.io/blog/2024/03/13/deprecate_add_run_job for replacement options at custom_components/audiobookshelf/init.py, line 133: hass.async_add_job(, please create a bug report at https://github.com/wolffshots/hass-audiobookshelf/issues

Additional Sensor Ideas/Info

Hi,
Firstly, great work!

I thought I'd share the details of some other AudioBookShelf sensors I've added to HA as rest sensors, in case you wanted to add them to this integration also. Some of which I have found really useful, especial being able to track when a new podcast episode is available and when the size of my podcasts is getting too big and I should think about pruning them.

Using the api path http(s)://[URL]/api/libraries/[LIBRARY_ID]/stats gets you stats on a library as detailed below.

The [LIBRARY_ID] is in the format "abcdef12-4567-890a-bcdef1234567". I originally found it by taking it from the URL when viewing the library in the AudioBookShelf UI so you could get users to add them as part of the config flow but ideally you can list them from the API using http(s)://[URL]/api/libraries which would obviously be better.

Audiobooks
Number of books - value_json.totalItems
Number of authors - value_json.totalAuthors
Total Duration (hours) - ( value_json.totalDuration / 60 / 60 ) | round(0)
Total Size (GB) - ( value_json.totalSize / 1024 / 1024 / 1024 ) | round(2)

Podcasts
Number of podcasts (not episodes) - value_json.totalItems
Number of podcast episodes - value_json.numAudioTracks
Total Duration (hours) - ( value_json.totalDuration / 60 / 60 ) | round(0)
Total Size (GB) - ( value_json.totalSize / 1024 / 1024 / 1024 ) | round(2)

Hope that's useful!
Matt

What's the Access Token and where do i find it?

Thank you for your integration!

But I've got a questeion: What's the Access Token and where do i find it?
I assume it could be generated somewhere within audiobookshelf, but i can't find any option on v2.5.0 for this token, an api key or something similar.

Thanks in advance :)