Skip to content

wolffshots/hass-audiobookshelf

Repository files navigation

Audiobookshelf

GitHub Release GitHub Activity License

pre-commit Black

hacs_badge Project Maintenance BuyMeCoffee

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

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

Configuration

Getting an access token

  1. Log in as the admin user
  2. Go to Settings > Users
  3. Click on the account
  4. 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

Config in 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