# @svrooij/sonos > A node library to control your sonos devices, written in typescript Latest version **2.7.0** (published 2026-11-03) · MIT license · 0 weekly downloads ## Install ```sh npm install @svrooij/sonos pnpm add @svrooij/sonos yarn add @svrooij/sonos bun add @svrooij/sonos ``` ## Health **Score 70/100 (B)** — status: active. Positive: has types; no vulnerabilities; has provenance; recently updated; high maintenance score; high quality score. Warnings: low downloads; no esm support. ## Facts | | | |---|---| | Version | 2.7.0 | | Published | 2026-11-03 | | First published | 2019-11-05 | | Weekly downloads | 0 | | License | MIT | | TypeScript types | bundled | | Module format | CommonJS | | Dependencies | 6 | | Unpacked size | 488.5 KB | | Known vulnerabilities | 0 | | Install scripts | no | | Provenance | attested (GitHub Actions) | | GitHub stars | 111 | | Author | Stephan van Rooij | | Maintainers | svrooij | | Keywords | sonos, typescript, real-time, home-automation | ## Links - npm: https://www.npmjs.com/package/@svrooij/sonos - Repository: https://github.com/svrooij/node-sonos-ts - Homepage: https://sonos-ts.svrooij.io/ - Issues: https://github.com/svrooij/node-sonos-ts/issues - npm.io page: https://npm.io/package/@svrooij/sonos ## Dependencies (6) - [ws](https://npm.io/package/ws.md) ^8.18.1 - [debug](https://npm.io/package/debug.md) 4.4.0 - [node-fetch](https://npm.io/package/node-fetch.md) ^2.7.0 - [html-entities](https://npm.io/package/html-entities.md) ^2.5.2 - [typed-emitter](https://npm.io/package/typed-emitter.md) ^2.1.0 - [@rgrove/parse-xml](https://npm.io/package/@rgrove/parse-xml.md) ^4.2.0 ## Alternatives - [@openai/codex-sdk](https://npm.io/package/@openai/codex-sdk.md) — 731.4K weekly downloads - [babel-plugin-transform-react-jsx](https://npm.io/package/babel-plugin-transform-react-jsx.md) — 565.0K weekly downloads - [babel-helper-remove-or-void](https://npm.io/package/babel-helper-remove-or-void.md) — 508.5K weekly downloads - [@pnpm/store-controller-types](https://npm.io/package/@pnpm/store-controller-types.md) — 186.9K weekly downloads - [react-native-signature-canvas](https://npm.io/package/react-native-signature-canvas.md) — 155.6K weekly downloads ## Recent versions - 2.7.0 (latest) — 2026-11-03 - 2.7.0-beta.4 (beta) — 2026-07-08 - 2.7.0-beta.3 — 2026-07-06 - 2.7.0-beta.1 — 2026-07-04 - 2.6.0-beta.13 — 2025-11-19 - 2.6.0-beta.12 — 2025-02-24 - 2.6.0-beta.11 — 2024-05-01 - 2.6.0-beta.10 — 2024-03-30 - 2.6.0-beta.9 — 2024-03-30 - 2.6.0-beta.8 — 2024-03-30 - 2.6.0-beta.7 — 2024-02-07 - 2.6.0-beta.6 — 2023-07-06 - 2.6.0-beta.5 — 2023-02-15 - 2.6.0-beta.4 — 2023-01-20 - 2.6.0-beta.3 — 2023-01-20 - … 76 more at https://npm.io/package/@svrooij/sonos/versions ## README # Sonos (the typescript version) [![Sonos typescript this library][badge_sonos-typescript]][link_sonos-typescript] [![npm][badge_npm]][link_npm] [![Sonos api documentation][badge_sonos-docs]][link_sonos-docs] [![Sonos2mqtt][badge_sonos-mqtt]][link_sonos-mqtt] [![Sonos cli][badge_sonos-cli]][link_sonos-cli] [![Support me on Github][badge_sponsor]][link_sponsor] [![Follow on Twitter][badge_twitter]][link_twitter] [![Run tests and publish][badge_build]][link_build] [![github issues][badge_issues]][link_issues] [![All Contributors][badge_contrib]](#contributors-) [![Coverage Status][badge_coverage]](https://coveralls.io/github/svrooij/node-sonos-ts?branch=main) [![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg?style=for-the-badge)](//github.com/semantic-release/semantic-release) Typescript library to control your Sonos speakers. Can be used in other typescript (or node) apps. --- ## Key features - [x] Auto generated client (supporting all features the normal app does). [Sonos api documentation and generator][link_sonos-docs] - [x] Auto discovery or one known device as starting point. - [x] Support for logical devices (grouped speakers) from the start. - [x] Access to all (generated) services. - [x] Sonos device class with extra functionality. - [x] Strongly typed service events. - [x] Easier implemented [metadata generation](./src/helpers/metadata-helper.ts). ## Documentation To use the library just add it to your project. `npm install @svrooij/sonos`. And start using it. This library isn't meant to be used by itself, as you see in the [examples](./examples) you still need to use node (or typescript). See **[Documentation](https://sonos-ts.svrooij.io/getting-started.html)** [![Sonos typescript this library][badge_sonos-typescript]][link_sonos-typescript] If you need help using this library, check out the [questions section](https://github.com/svrooij/node-sonos-ts/discussions/categories/q-a) on this repository. ## Use Sonos manager (recommended) This library is developed with Sonos groups in mind. We created a **SonosManager** to discover all known groups and keep track of changes to them. ```js const SonosManager = require('@svrooij/sonos').SonosManager const manager = new SonosManager() manager.InitializeWithDiscovery(10) .then(console.log) .then(() => { manager.Devices.forEach(d => console.log('Device %s (%s) is joined in %s', d.Name, d.uuid, d.GroupName)) }) .catch(console.error) ``` In some network situations (or Docker usage) SSDP won't work, but you can also start the manager if you know one (static) IP of a single speaker. ```js const SonosManager = require('@svrooij/sonos').SonosManager const manager = new SonosManager() manager.InitializeFromDevice(process.env.SONOS_HOST || '192.168.96.56') .then(console.log) .then(() => { manager.Devices.forEach(d => console.log('Device %s (%s) is joined in %s', d.Name, d.uuid, d.GroupName)) }) .catch(console.error) ``` ### Single sonos speaker (no manager) If you just want to control a single device and don't want to use the SonosManager, you can also create a instance of **SonosDevice**, but you'll be missing the group options. ```js const SonosDevice = require('@svrooij/sonos').SonosDevice const sonos = new SonosDevice(process.env.SONOS_HOST || '192.168.96.56') sonos.LoadDeviceData() .then(success => { console.log(sonos.Name) }) .catch(console.error) ``` ## Text to speech A lot of people want to send text to sonos to use for notifications (or a welcome message in your B&B). This library has support for text-to-speech but you'll need a text-to-speech endpoint. To keep this library as clean as possible, the text-to-speech server is build in a seperate package. See [node-sonos-tts-polly](https://github.com/svrooij/node-sonos-tts-polly) for a text-to-speech server that uses Amazon Polly for speech generation. For my [sponsors](link_sponsor) I've setup a hosted version, so if you don't want to setup your own server, you know what to do. The text-to-speech works as following: 1. Request the TTS endpoint what the url of the supplied text is. 2. If the server doesn't have this file, it will generate the mp3 file on the fly. 3. The TTS endpoint returns the url of the mp3. 4. We call the regular `.PlayNotification({})` command, with the tts url. You can also set the endpoint with the `SONOS_TTS_ENDPOINT` environment variable, so you don't have to supply it every time. The default language can be set with the environment variable `SONOS_TTS_LANG`. The server I've build is based on Amazon Polly, but I invite eveybody to build their own if you want to support an other tts service. ```JavaScript const SonosDevice = require('../lib').SonosDevice const sonos = new SonosDevice(process.env.SONOS_HOST || '192.168.96.56') sonos.PlayTTS({ text: 'Someone at the front-door', lang: 'en-US', gender: 'male', volume: 50, endpoint: 'https://your.tts.endpoint/api/generate' }) .then(played => { console.log('Played notification %o', played) // Timeout to allow event subscriptions to cancel. setTimeout(() => { process.exit(0) }, 500) }) ``` ## Others using node-sonos-ts |Name|Maintainer|Description| |----|----------|----------| |[sonos2mqtt](https://github.com/svrooij/sonos2mqtt)|[@svrooij](https://github.com/svrooij)|A bridge between sonos and mqtt, so you can control all your sonos devices right from your mqtt server| |[sonos-cli](https://github.com/svrooij/sonos-cli)|[@svrooij](https://github.com/svrooij)|An experimental command line interface for your sonos devices.| |[node-red-contrib-sonos-plus](https://github.com/hklages/node-red-contrib-sonos-plus)|[@hklages](https://github.com/hklages)|A node-red node to control your sonos devices| Also using this library, but not in the list? Send a PR. ## Contributing [![Sonos api documentation][badge_sonos-docs]][link_sonos-docs] [![Sonos2mqtt][badge_sonos-mqtt]][link_sonos-mqtt] [![Sonos cli][badge_sonos-cli]][link_sonos-cli] [![Sonos typescript this library][badge_sonos-typescript]][link_sonos-typescript] [![Support me on Github][badge_sponsor]][link_sponsor] [![Follow on Twitter][badge_twitter]][link_twitter] You can contribute in many ways. Asking good questions, solving bugs, sponsoring me on github. This library is build in my spare time, so don't be rude about it. ### Support new music service If you're using a music service that currently isn't supported for metadata generation, you should check out the [metadata generator](./src/helpers/metadata-helper.ts). It works by taking an url (which you can get by running the [get-position-info sample](./examples/get-position-info.js)). And generating a **Track** for it. Use the information out the console to get the right values. The values you'll be looking for are `ProtocolInfo`, `TrackUri`, `UpnpClass`, `ItemID` and `ParentID`. [![Support me on Github][badge_sponsor]][link_sponsor] ## Contributors ✨ [![All Contributors][badge_contrib]](#contributors-) Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):

Stephan van Rooij
💻 📖 🤔 🚧
Sven Werner
💻
H. Klages
📖
Jason Kossis
💻
This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome! ## Developer section This will contain usefull information if you want to fix a bug you've found in this library. You always start with cloning the repo and doing a `npm install` in the folder. I like consistancy so everything is in a specific order :wink:. ### Running example code This library has two VSCode launch configurations. One for running the current open example, you can set breakpoints in the example file and in the typescript code! Be sure to change the IP to your own in `.vscode/launch.json`, so you don't have to edit all the example files. And it has a launch configuration to run the current Mocha test file, be sure to have a mocha test (in test folder) open. ### Service generator Most of this library is generated by the [generator](https://github.com/svrooij/sonos-api-docs/tree/main/generator/sonos-docs). You can use the generator in your own project. Or just use the service file. I could use some help improving the code of the generator. ### Big thanks to all the original contributors Creating a library from scratch is quite hard, and I'm using a lot of stuff from [node-sonos](https://github.com/bencevans/node-sonos/). That wouldn't exists without the [contributors](https://github.com/bencevans/node-sonos/graphs/contributors). [badge_build]: https://img.shields.io/github/actions/workflow/status/svrooij/node-sonos-ts/test-and-release.yml?branch=main&style=for-the-badge [badge_contrib]: https://img.shields.io/github/all-contributors/svrooij/node-sonos-ts?style=for-the-badge [badge_coverage]: https://img.shields.io/coverallsCoverage/github/svrooij/node-sonos-ts?style=for-the-badge&branch=main [badge_issues]: https://img.shields.io/github/issues/svrooij/node-sonos-ts?style=for-the-badge [badge_npm]: https://img.shields.io/npm/v/@svrooij/sonos?style=for-the-badge [badge_sonos-cli]: https://img.shields.io/badge/sonos-cli-blue?style=for-the-badge [badge_sonos-docs]: https://img.shields.io/badge/sonos-api-blue?style=for-the-badge [badge_sonos-mqtt]: https://img.shields.io/badge/sonos-mqtt-blue?style=for-the-badge [badge_sonos-typescript]: https://img.shields.io/badge/sonos-typescript-blue?style=for-the-badge [badge_sponsor]: https://img.shields.io/github/sponsors/svrooij?style=for-the-badge&logo=github [badge_twitter]: https://img.shields.io/twitter/follow/svrooij?logo=twitter&style=for-the-badge [link_build]: https://github.com/svrooij/node-sonos-ts/actions [link_issues]: https://github.com/svrooij/node-sonos-ts/issues [link_npm]: https://www.npmjs.com/package/@svrooij/sonos [link_sonos-cli]: https://github.com/svrooij/sonos-cli [link_sonos-docs]: https://sonos.svrooij.io/ [link_sonos-mqtt]: https://sonos2mqtt.svrooij.io/ [link_sonos-typescript]: https://sonos-ts.svrooij.io/ [link_sponsor]: https://github.com/sponsors/svrooij [link_twitter]: https://twitter.com/svrooij --- _Source: https://npm.io/package/@svrooij/sonos · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._