Unofficial Sonos docs
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/
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 need help building an app that talks to your sonos speakers, or you want to share some of your findings. Join us on Discord.
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!