You're Invited:Meet the Socket Team at BlackHat and DEF CON in Las Vegas, Aug 7-8.RSVP →
Sign inDemoInstall


Package Overview
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies



Node.js Sonos Interface

Version published
Weekly downloads
increased by2.55%
Weekly downloads



node-sonos logo


Control your Sonos devices with JavaScript (node.js)

Travis Build NPM Version NPM Downloads Standard Codestyle Discord badge

node-sonos gives you the power to control all your Sonos devices from your own apps in JavaScript. Automatically discover your devices on the network and control the playback and queue with instant events announcing change.


  • Device Discovery
  • Queue Control
  • Volume Control
  • Spotify Support
  • Radio
  • Change Events


Published versions (recommended)

$ npm install sonos

From the repo, living on the edge

$ npm install git://

Quick Start

Discovering Devices

const { DeviceDiscovery } = require('sonos')

// event on all found...
DeviceDiscovery((device) => {
  console.log('found device at ' +

  // mute every device...
    .then(d => console.log(`${} now muted`))

// find one device
DeviceDiscovery().once('DeviceAvailable', (device) => {
  console.log('found device at ' +

  // get all groups
  device.getAllGroups().then(groups => {
    groups.forEach(group => {

Discovering devices async

const DeviceDiscovery = require('sonos').AsyncDeviceDiscovery
let discovery = new DeviceDiscovery(), model) => {
    // Do stuff, see examples/devicediscovery.js

Controlling Known Devices

const { Sonos } = require('sonos')

const device = new Sonos('');
  .then(() => console.log('now playing'))

  .then((volume) => console.log(`current volume = ${volume}`))


  • DeviceDiscovery([options], [deviceAvailableListener])
  • Class: DeviceDiscovery([options])
    • Event: 'DeviceAvailable'
    • destroy()
  • Class: 'AsyncDeviceDiscovery'
    • discover([options])
    • discoverMultiple([options])
  • Class: Sonos(host, [port])
    • currentTrack()
    • deviceDescription()
    • flush()
    • getCurrentState()
    • getLEDState()
    • getMusicLibrary(search, options)
    • getMuted()
    • getTopology() Doesn't work if you upgraded to Sonos v9.1. Check-out getAllGroups() for some replacement.
    • getVolume()
    • getZoneAttrs()
    • getZoneInfo()
    • getQueue()
    • next()
    • parseDIDL(didl)
    • pause()
    • play(uri)
    • togglePlayback()
    • previous()
    • queue(uri, positionInQueue)
    • queueNext(uri)
    • request(endpoint, action, body, responseTag)
    • seek(seconds)
    • setLEDState(desiredState)
    • setMuted(muted)
    • setName(name)
    • getPlayMode()
    • setPlayMode(mode)
    • setVolume(volume)
    • stop()
    • setSpotifyRegion(region)
    • alarmClockService()
      • ListAlarms()
      • PatchAlarm(id,options)
      • SetAlarm(id,enabled)
    • joinGroup(otherDeviceName)
    • leaveGroup()
    • getAllGroups()
    • startListening(options)
    • stopListening()
    • Event: 'CurrentTrack'
    • Event: 'NextTrack'
    • Event: 'PlayState' and 'PlaybackStopped'
    • Event: 'AVTransport'
    • Event: 'Volume'
    • Event: 'Muted'
    • Event: 'RenderingControl'


We tried to add jsdoc info to all functions, and generate documentation from it. /docs


Additional examples can be found in the /examples directory within the repository.

In The Wild

node-sonos in use across the interwebs. Missing yours? Add it and send us a pull request!




  • Ben Evans (@bencevans)
  • Stephen Wan (@stephen)
  • Marshall T. Rose (@mrose17)
  • Stephan van Rooij (@svrooij)

Contributors ✨

All Contributors

Thanks goes to these wonderful people (emoji key):

Ben Evans

💻 📖 🤔 🚧

Stephan van Rooij

💻 📖 👀 🚧

Scott Seiber

💻 ⚠️

Marshall T. Rose

💻 🚧

Stephen Wan

💻 🚧

Pascal Opitz


Shobhit Gupta


Martin Giger

💻 🐛

Matthias Brünning


Erik Baauw

💻 🐛

Thomas Mirlacher


Tobias Hultman


Monsur Hossain


Ben A.


Manuel Heim


Alan Layng

💻 🐛

Niels Keurentjes


Arnaud Vallat


Chris Wiggins




Henrik Tilly

💻 🐛

Ian Sutherland


Jason Woods


Marko Harjula


Michaël Dierick


Travis Clarke


Vincent Klaiber




Adam Varga


Arjen van der Ende


Craig Lonsdale


Craig Simpson


Denys Vitali


Erik Beuschau


H. Klages

💻 🐛

Keith McKnight


Kenneth Geisshirt




Marc Easen


Michael Stegeman


Morten Scheel


Nathan Wong


Sam Daitzman


Sammy Griffiths


Trevor Sullivan






Björn Häggquist




Magnus Lundberg


Nick Dandakis


This project follows the all-contributors specification. Contributions of any kind welcome! You can get added by mentioning the @all-contributors bot in a pr or issue.

If we missed you, just go to your (closed) issue or pr and mention the bot to get added.


If you got discovered an issue with this library, please check the issue-tracker. And create an issue if your problem isn't discovered by someone else. If you want to contribute something check out these 'help-wanted' issues.


Join us on Discord

The best place to ask your questions is in Discord, we are there to help you. Join us on Discord.

Unsupported sonos features

There is a great other library to control Sonos with Python, they also have a great list of all possible soap actions here. So if you have anything that you cannot do with node-sonos but that you can with the official app. You could have a look in the above list, or use wireshark to investigate the protocol.

NPM publish

We try to react to all pull-requests, but if you think we don't respond in time, please don't create a 'sonos-by-xyz' or a 'node-sonos-by-xyz' package on NPM. This might lead to people installing the wrong version.

If you want to publish your own version, please do it as a user-scoped eg. @svrooij/sonos package.

  1. Change the top of the readme to state your specific changes.
  2. Change the name of the project to @npm_username/sonos
  3. Publish it to npm npm publish --access=public


If you want to make this library better, you can follow these steps.

  1. Create a fork
  2. Make changes
  3. (optional) Create tests for the feature or the bug, see sonos.test.js.
  4. Run SONOS_HOST=192.168.x.x npm run test to test your code (against an actual sonos device, change the ip)
  5. Check-in your code in a single commit. Make sure your commit starts with fix: for a bugfix or feat: for a new feature followed by a short description. You can also follow with an empty line followed by a more details description.
  6. Send a pull-request
  7. Hold-on, we will be checking them.

If you already had a fork, make sure it is updated with the latest master so things don't get complicated when we want to merge the PR.

git remote add upstream
git fetch upstream
git checkout master
git rebase upstream/master
git push origin


MIT © Ben Evans



Package last updated on 17 Mar 2021

Did you know?


Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.


Related posts

SocketSocket SOC 2 Logo


  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog


Stay in touch

Get open source security insights delivered straight into your inbox.

  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc