Skip to content

πŸ”Š πŸ“– Sonos api documentation for the local UPNP api and a generator to generate clients based on service discovery

License

Notifications You must be signed in to change notification settings

svrooij/sonos-api-docs

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

Unofficial Sonos docs

Sonos API documentation Github Issues Sonos2mqtt Sonos cli Sonos typescript this library

Support me on Github Follow on Twitter

Sonos API documentation for the local UPNP API and a generator to generate clients and documentation based on service discovery

This library is in no way connected to Sonos. It's just a set of text files to document a hidden and unsupported API.

Documentation

Check-out the (generated) documentation about all the SONOS UPNP services svrooij.io/sonos-api-docs/services/

Sonos API documentation

Read documentation

Manually documented

The sonos services have no documentation, that is why we manually created a documentation.json file. To easily add documentation to all services (that are generated with the generator). And it's json so you can easily use it yourself.

Device discovery files

You can use the generator to generate your own discovery files, but we also have the files available for download.

Player Discovery file(s)
Sonos Play:1 S2
Sonos Play:3 S2
Sonos Play:5 (new) S2
Sonos Playbar S2
Sonos One S2
Sonos One (mic) S2
Sonos Beam S2
Sonos Roam S2
Sonos Sub S2
SYMFONISK Bookshelf S2
Sonos Play:5 (old) S1

These files together with the documentation file, are combined to a extensive JSON file, that is used as an input for the generator.

Community

If you have any questions or you want to show your Sonos integration. Please join us in the discussions tab on this repository.

Contributors ✨

All Contributors

Thanks goes to these wonderful people (emoji key):


Stephan van Rooij

πŸ’» πŸ“– πŸ€” 🚧

H. Klages

πŸ“–

Sebastian Schuberth

πŸ“–

Jason Kossis

πŸ“–

This project follows the all-contributors specification. Contributions of any kind welcome!

About

πŸ”Š πŸ“– Sonos api documentation for the local UPNP api and a generator to generate clients based on service discovery

Topics

Resources

License

Code of conduct

Stars

Watchers

Forks

Sponsor this project

 

Packages