Skip to content

Latest commit

 

History

History
104 lines (75 loc) · 5.91 KB

README.md

File metadata and controls

104 lines (75 loc) · 5.91 KB
Raw

Audiobookshelf Sonos

A standalone server that adds support for listening to an Audiobookshelf library on Sonos speakers. Built on top of the Sonos Music API (SMAPI).

This is currently for development testing purposes, and is expected to change significantly

Features

  • Access to all audiobooks in a single Audiobookshelf library
  • Sync progress to and from Audiobookshelf

Missing Features

  • Authentication. Currently anyone on the network can access the library made available through this server from within the Sonos app
  • Browsing different libraries
  • Viewing audiobook metadata such as descriptions
  • Cover Art on the Sonos music player doesn't load
  • M4B files have very spotty coverage right now (MP3s with proper mime-type have full support)
  • Individual chapter support ("previous" and "next" seek moves between MP3 tracks rather than chapters)

How it works

When you use the Sonos app, you have the ability to add "music services" (Audible, YouTube Music, Libby, iHeartRadio, etc.). These services have been developed, submitted to Sonos for approval, and made available to all Sonos users on behalf of the companies that own them. Each company (developer) is responsible for hosting the actual service itself.

The services are built on top of the Sonos Music API (aka SMAPI), which is a SOAP API. The service functions as a middleware for the Sonos device to reach out to, and in response get information on the items available, metadata, stream URIs, etc.

For development puropses, Sonos allows you to manually configure a local service, called a "Custom Service", which is what this application uses. This is done through the Custom Service Descriptor page that is hosted on each Sonos device. This is how this application works -- it is configured as a Custom Service on a local device and made available to all users on the network.

How this server works

There are a 3 main pieces

sonos.wsdl

The WSDL (Web Service Description Language) file provided by Sonos. This is used in SOAP to describe a SOAP service.

sonos-service.js

Our implementation of the sonos.wsdl file (the entire thing does not need to be implemented -- audiobooks only require a select few pieces). It can be thought of as the SOAP router and controller. There is a decent amount of "SOAP magic" that goes on here -- it creates reponse XML tags in it's reponses based on the function name, etc.

soap-server.js

This is the actual express and soap server. 2 things happen in this file:

  1. The SOAP server is brought up (using express to handle network requests) -- it's told where to listen (/wsdl by default), the WSDL file it should abide by (SONOS_WSDL_FILE), and the service it should host (SONOS_SOAP_SERVICE)
  2. A set of non-SOAP endpoints are exposed through express (outside of SOAP). These are part of the Sonos Cloud Queue API and used for reporting progress from the player to the server (which is used to sync with Audiobookshelf)

How to use

Prerequisites

  • A set of Sonos speakers
    • You'll need the IP address of one of the speakers
  • The latest version of the Sonos mobile app
  • Audiobookshelf running and accesssible
  • A domain/URI configured to point at this server (with a valid HTTPS certificate)
    • At least for any modern version of Android, non-HTTPS requests signed by a cert in the CA-chain android already has fails. I have a reverse proxy set up to point to my SOAP_URI on HTTP_PORT for this with a cert configured on it.

Step 1: Configuring a Custom Service Descriptor (CSD)

  1. Browse to http://<SONOS_SPEAKER_IP>:1400/customsd.htm
  2. Input the following information:
    • Service Name: audiobookshelf
    • Secure Endpoint URL: https://<the_url_you_defined_for_this_server_above>/wsdl
    • Polling interval: 10
    • Authentication SOAP header policy: Anonymous
    • Manifest
      • Version: 1.0
      • URI: https:<the_url_you_defined_for_this_server_above>/manifest
    • Support manifest file: check this box
    • Playback event logging during track play: check this box
    • Playback duration logging at track end: check this box
  3. Submit (sometimes this randomly fails, and you need to go back and try again). You should see "Success" if it worked.
  4. Add the new service to the Sonos mobile app
    • Settings -> Services + Voice -> Search for your new service -> "Add to Sonos" -> "Set up audiobookshelf
  5. audiobookshelf should now be listed as a service in the "Browse" tab

Step 2: Setting up your Audiobookshelf Sonos Server

  1. Clone / download and enter the directory containing this repo
  2. Update docker-compose.yml environment variables.
    • SOAP_URI: This is the URL part of the Secure Endpoint URL defined in the CSD on the spekaer earlier -- the URL where this server will be acessible from
    • ABS_URI: This is your audiobookshelf URL
    • ABS_LIBRARY_ID: This is your audiobookshelf library ID. This should be in the form of a long string of letters and numbers. You can find this via the ABS API.
    • ABS_TOKEN: This is your ABS API key. This can be found in the user section of the ABS settings
    • LOG_LEVEL: Set to debug, info, warn, error to set a minimum log level to show. note: debug is very noisy, and shouldn't be run all the time
  3. Update the sonos.wsdl file (line 2062) with your SOAP_URI
    <wsdl:service name="Sonos">
        <wsdl:port name="SonosSoap" binding="tns:SonosSoap">
		<soap:address location=""/> <!-- Update with SOAP_URI -->
        </wsdl:port>
    </wsdl:service>

Step 3: Start the docker container and enjoy

  1. docker-compose up -d
  2. Open the Sonos mobile app and select audiobookshelf
  3. Select a book to listen to
  4. If there is already progress on the book, it should start from where Audiobookshelf left off
    • Otherwise it will start from the beginning