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.
Features
- Device Discovery
- Queue Control
- Volume Control
- Spotify Support
- Radio
- Change Events
Install
Published versions (recommended)
$ npm install sonos
From the repo, living on the edge
$ npm install git://github.com/bencevans/node-sonos.git
Quick Start
Discovering Devices
const { DeviceDiscovery } = require('sonos')
// event on all found...
DeviceDiscovery((device) => {
console.log('found device at ' + device.host)
// mute every device...
device.setMuted(true)
.then(d => console.log(`${d.host} now muted`))
})
// find one device
DeviceDiscovery().once('DeviceAvailable', (device) => {
console.log('found device at ' + device.host)
// get all groups
sonos = new Sonos(device.host)
sonos.getAllGroups().then(groups => {
groups.forEach(group => {
console.log(group.Name);
})
})
})
Discovering devices async
const DeviceDiscovery = require('sonos').AsyncDeviceDiscovery
let discovery = new DeviceDiscovery()
discovery.discover().then((device, model) => {
// Do stuff, see examples/devicediscovery.js
})
Controlling Known Devices
const { Sonos } = require('sonos')
const device = new Sonos('192.168.1.56');
device.play()
.then(() => console.log('now playing'))
device.getVolume()
.then((volume) => console.log(`current volume = ${volume}`))
API
- 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'
Documentation
We tried to add jsdoc info to all functions, and generate documentation from it. /docs
Examples
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!
Apps
- AirSonos - Apple AirPlay (iOS, OS X) support to all Sonos devices on a network.
- sonos-cli - Command Line Interface for Sonos
- sonos2mqtt - Bridge between Sonos and an MQTT server
- homebridge-zp - Homebridge plugin for Sonos ZonePlayer
- ZenMusic - Control Sonos thru #Slack!
- gladys-sonos - Control Sonos with Gladys a Raspberry Pi Home Assistant
- sonos-web - Sonos controller for your web browser
Writeups
- How we gave our studio WWE-style entrances using iBeacons and Sonos - A technical run-down of using futuristic technology for sheer entertainment value
Maintainers
- Ben Evans (@bencevans)
- Stephen Wan (@stephen)
- Marshall T. Rose (@mrose17)
- Stephan van Rooij (@svrooij)
And a big thanks to all you other contributors! Pull-requests are beautiful things.
Issues
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.
Questions
Do you have a question about this library, we are glad to help you Ask Question. You can see all questions here
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.
- Change the top of the readme to state your specific changes.
- Change the
nameof the project to@npm_username/sonos - Publish it to npm
npm publish --access=public
Node Sonos v0.x (non async)
At 30 jan 2018 we released an promisified version of node-sonos. The old version can be found in the v0.x branch. It won't get any new features, but it might get security updates.
Licence
MIT © Ben Evans