chwalters / kalliope_neuron_ambient_sound

Play ambient sound for focusing or relaxing

Ambient sound

Synopsis

Background sounds for focusing or create a relaxing ambiance.

Installation

Install the neuron into your resource directory

kalliope install --git-url https://github.com/kalliope-project/kalliope_neuron_ambient_sound.git

Options

parameter	required	type	default	choices	comment
state	YES	string		"on", "off"	Target state of the ambient sound.
sound_name	NO	string		See the list bellow	If not set, a sound will be selectedrandomly
mplayer_path	NO	string	/usr/bin/mplayer		Path to mplayer binary. By default /usr/bin/mplayer on Debian family system
auto_stop_minutes	NO	int		Integer > 1	Number of minutes before Kalliope stop automatically the background sound

List of available sound:

• birds
• fireplace
• forest
• forest-rain
• forest-stream
• heavy-rain
• mountain-steam
• ocean-waves
• seaside
• stream
• summer-rain
• thunderstorm
• tropical-beach
• tropical-thunderstorm
• urban-thunderstorm
• wind
• wood-sailboat

Return Values

Name	Description	Type	sample
playing_sound	The current sound played	string	fireplace
available_sounds	List of available sound in the database	list	['fireplace', 'heavy-rain', 'tropical-beach', 'seaside']

Synapses example

Start an ambient sound randomly

- name: "ambient-random"
  signals:
    - order: "ambient sound"
  neurons:
    - ambient_sound:
        state: "on"

- name: "ambient-stop"
  signals:
    - order: "stop ambient sound"
  neurons:
    - ambient_sound:
        state: "off"

Play selected ambient sound

- name: "ambient-random"
  signals:
    - order: "ambient sound"
  neurons:
    - ambient_sound:
        state: "on"
        sound_name: "forest-rain"

Auto stop after 20 minutes

- name: "ambient-sleep"
  signals:
    - order: "ambient sound before sleeping"
  neurons:
    - ambient_sound:
        state: "on"
        auto_stop_minutes: 20
        say_template:
            - "I've selected {{ playing_sound }}"

Notes

You add your own sound file inside the "sound" folder.

Licence

MIT