Skip to main content

A multi-output ambient sound mixer for Home Assistant

Project description

Amniotic

A multi-output ambient sound mixer for Home Assistant.

Amniotic lets you use a single device to create on-the-fly, custom ambient audio mixes - e.g. mixing Waterfall sounds with Birdsong on one media player entity, while playing Fireplace sounds from a second audio device - to suit your tastes and environment.

The library integrates with Home Assistant via MQTT as a new device, allowing you to create and control ambient mixes from the Home Assistant interface.

Why Would I Want Such a Thing?

I won't explain the general reasons for introducing non-musical sounds into one's environment, but if you find sound masking helps you concentrate in noisy environments, if you're (as I am) slightly misophonic, if you use white noise machines to induce sleep or relaxation, or if you just think sound is an important factor in setting a pleasant ambience, then you might find Amniotic useful.

Can't I do This with Spotify, Volumio, HifiBerry etc.?

Since those systems are intended for music, they aren't designed for playing or mixing multiple streams simultaneously with a single device, even if set up in multi-room configurations. Also, the streaming services often won't allow a single account to play multiple streams, even if multiple devices are used.

Anyway, those limitations motivated this library.

There are two ways to install and run Amniotic:

  • On the Home Assistant machine itself, as an add-on.
  • Install manually, on a separate machine.

Home Assistant Addon

To add as an Addon, click here:

Open your Home Assistant instance and show the add add-on repository dialog with the repository URL pre-filled.

Dashboard

Lovelace Dashboard

Dashboard Screenshot

Getting Started

Better documentation is coming soon. Currently, the easiest workflow is the following:

  • Install as an Addon, using the button above.
  • If you're using a non-default address for Home Assistant on your network (i.e. not homeassistant.local), set that in the Addon configuration.
  • Add some audio files to the Home Assistant /media/Amniotic directory. Note: currently, you'll need to restart the Addon for it to see new files.
  • Add the Dashboard to Lovelace.
  • Select a Default Theme from A or B. Note: Adding your own themes isn't implemented yet, nor will they be saved between restarts.
  • Select a Recording from the dropdown.
  • Toggle to Enable the Recording.
  • Select a Media Player to stream the Theme to. Note: Your media player needs to support streaming from a basic HTTP stream, which most should.
  • Click Stream to Media Player.
  • Your Theme should start playing on your Media Player.
  • You can now Enable additional Recordings in the Theme, modify their volume, etc., to create a custom mix.
  • Note: there's also a Current Theme URL, for if you want to manually paste stream to a non-HA player, like a phone or something.

Do I need a Sonos Speaker? Can't I just use a Raspberry Pi, etc?

  • You can use basically any device with audio hardware. You just need to allow Home Assistant to see it as a Media Player entity.
  • In Home Assistant, install the https://www.home-assistant.io/integrations/vlc_telnet
  • On your Device, install VLC, and start it in telnet mode, e.g. vlc -I telnet --telnet-password password --telnet-host 0.0.0.0:4212
  • Add your VLC server to the integration.

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

amniotic-1.2.3.tar.gz (27.2 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

amniotic-1.2.3-py3-none-any.whl (31.6 kB view details)

Uploaded Python 3

File details

Details for the file amniotic-1.2.3.tar.gz.

File metadata

  • Download URL: amniotic-1.2.3.tar.gz
  • Upload date:
  • Size: 27.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.3

File hashes

Hashes for amniotic-1.2.3.tar.gz
Algorithm Hash digest
SHA256 73081fc598bf3812147da75c99253d6f38cfefede9d2409d1c9b26038a80e433
MD5 f10e47a30358cf26d4c63af47eb302bb
BLAKE2b-256 24920a0ba7a74f319b6df58a02afebef58933b5651c157b48dd1710084d1de5d

See more details on using hashes here.

File details

Details for the file amniotic-1.2.3-py3-none-any.whl.

File metadata

  • Download URL: amniotic-1.2.3-py3-none-any.whl
  • Upload date:
  • Size: 31.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.3

File hashes

Hashes for amniotic-1.2.3-py3-none-any.whl
Algorithm Hash digest
SHA256 801b2b38cc12c97697d9f2398d94469e2da960e368af9cd66e15bc1ee774bc49
MD5 d12a75d75143046288d54d80de265e2f
BLAKE2b-256 c3b5553ae62fc9aa86e8459c17637d4324b7986bdeaeb38f8c1083855738309b

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page