Repository navigation
Home
Sonorium plays ambient soundscapes, such as rain, a forest or a busy tavern, on the speakers in your home. Instead of one recording on repeat, it layers several recordings and keeps changing how each one plays: the rain swells and eases, thunder rolls in now and then, never on a schedule you can hear. The result sounds like weather outside an open window rather than a recording on a loop.
Ambient sound helps with focus, relaxation, sleep and sensory comfort: it masks distracting noise without asking for attention. It only works if it doesn't sound like a loop, and that is what Sonorium is built for.
This wiki documents Sonorium 1.7.1. The same pages are on sonorium.app.
New to Sonorium? Pick how to install it, follow that guide to the end, and it brings you back here.
- Getting Started: compare the three ways to install.
- Home Assistant app · Docker · Windows
- Requirements: systems, processors, speakers and networks.
Five ideas cover most of Sonorium. Think of a radio station:
- A theme is the programme: a folder of recordings (rain, wind, thunder) that Sonorium mixes into one sound. Three themes come with Sonorium: A Rainy Day... Or is it?, Sleigh Ride and Tavern. See Themes.
- Track settings are the mixing desk: each recording (a track) plays in a mode. Background plays all the time, Intermittent now and then, Ebb & Flow all the time while its volume rises and falls. See Track Settings.
- A preset is a saved position of the mixing desk: the same storm with the thunder off, or with the rain louder. See Presets.
- A channel is the station's transmitter: it plays one theme (or one playlist) on the speakers you give it. Several channels can play different themes in different areas at once. See Channels.
- Sequences and playlists make a channel change over time: a sequence glides through a theme's presets, so a mild storm becomes a heavy one; a playlist plays several themes one after another. See Sequences and Playlists.
| Channels | Make, play, change and delete channels; listen in your browser |
| Status | What each track of a playing channel is doing now |
| Themes | The Themes page: create, import, export, categories |
| Theme Editor | Upload sound files, sort them into sections and groups, save presets |
| Track Settings | Every playback mode and track setting, with examples |
| Presets | Saved versions of a theme's mix |
| Sequences and Playlists | Presets in turn, and themes in turn |
| Speakers | Turning speakers on, adding them by address, speaker groups, floors and areas |
| Audio Settings | Crossfade, default volume, output gain |
| Advanced Settings | Optional features, playback values, the stream address |
| Sign-in and Users | Accounts, roles, Require login, forgotten passwords |
| Keys | Access for devices and programs |
| Link App | Linking the Sonorium app for Android to your account |
| Zones | Channels that belong to a person, Kid mode, speaker homes, linked channels |
| Announcements | Chimes and spoken messages from Home Assistant, MQTT, scripts and Node-RED |
| Home Assistant Integration | What Home Assistant gets and how it works |
| MQTT Entities | Every entity Sonorium creates in Home Assistant |
| Dashboard Cards · Dashboard Examples | Sonorium on Home Assistant dashboards |
| Automation Examples | Morning alarms, schedules, doorbells |
| Plugins | The built-in plugins, the catalog, installing and removing plugins |
| Troubleshooting | Common problems, and the logs |
For developers: API Reference · Plugin Development · Theme Format
- Look in Troubleshooting and on Settings › Logs.
- Search the issues on GitHub, or open a new one.
When you report a problem, include the version and the install type. Both are at the bottom left of Sonorium's menu (for example v1.7.1 Docker); on a phone, open the menu with the button in the top bar.
Sonorium is licensed under the PolyForm Noncommercial License 1.0.0: free to use, change and share for noncommercial purposes. Commercial use needs a separate licence. Third-party components keep their own licences; see THIRD_PARTY_NOTICES.md.
Originally based on Amniotic by fmtr. Sonorium has since been rewritten, and none of Amniotic's code remains.
Release notes for every version: What's new.