Welcome Home!

README.md

@@ -0,0 +1,69 @@
+# Welcome Home
+
+## Introduction
+
+When I got myself a [Pine64](https://www.pine64.com/), I wondered for a bit about what to do with it. [@RaitoBezarius](https://github.com/RaitoBezarius) suggested that I set up a music server on it, which got my attention as I don't have a lot of hardware to buy for that (none, actually, except if you want to plug in a cheap sound system).
+
+I set up a [Mopidy](https://www.mopidy.com/) server on the card, installed with Pip (since the Pine64 runs an ARM64 architecture and Mopidy's Debian/Ubuntu packages don't support it).
+
+When I got that done, I wanted to enhance it. Since I didn't want just some central sound system I could control from my phone (really, my apartment is not that big, I don't need that), I thought of some system which would detect when I get home after work and automatically start my music.
+
+## Welcome Home
+
+Welcome Home is a bash script which detects when a selected device is connected to your local network. If it detects the device, it will communicate with Mopidy and start playing a selected stream (set in the configuration file) on the Pine64's jack output.
+
+In my example, when I get home and my phone connects to my apartment's wifi, it gets a static IP address (as I configured it in my DHCP server). Welcome Home detects it, which means that I'm home or almost there, and start some nice Trance music for me.
+
+When Welcome Home will stop detecting the device, it will automatically tell Mopidy to stop playing the stream. Which means that if I want to stop the music and am too lazy to turn off my sound system, I can also stop the wifi on my phone.
+
+Detection of both connection and disconnection takes up to 6s maximum with the default settings.
+
+## Files
+
+There are three files in this repository (except for those in the `mopidy` directory which are Pine64-related):
+
+* `welcomehome` contains the bash script and is to move to `/usr/local/bin`.
+* `welcomehome.example.conf` is a configuration example, and is to edit as described below and to move as `/etc/welcomehome/welcomehome.conf` (you'll need to create the `/etc/welcomehome` directory).
+* `welcomehome.service` is the systemd service for Welcome Home, and is to move to `/etc/systemd/system`
+
+## Configuration
+
+Right now, there's only three configurable values:
+
+* `device_address` is the static IP address bound to the device you wish to detect.
+* `device_threshold` is the detection threshold. It defaults to 3. A greater threshold will mean a connection or a disconnection will take more time to detect, but you'll be able to detect them with more accuracy if your device's wifi is working weakly.
+* `stream` is the URL of the audio stream you want Welcome Home to play when you get home. For now, it has to be an HTTP(S) stream.
+
+For more info on the configuration syntax, have a look at the `welcomehome.example.conf` file.
+
+## Starting Welcome Home
+
+Once you moved all the needed files, and filled your configuration file, you need to start Welcome Home as a daemon. I use [systemd](https://freedesktop.org/wiki/Software/systemd/) for that (with the `welcomehome.service` file), but you're free to use whatever you want (and even to send my your configuration file in a [pull request](https://github.com/babolivier/welcome-home/pulls) so I can add it to this repi :wink:).
+
+To start Welcome Home, and launch it at the machine's startup, with systemd, just run:
+
+```shell
+systemctl enable welcomehome
+systemctl start welcomehome
+```
+
+## Bonus: Running Mopidy on Pine64
+
+I had some troubles setting up Mopidy on my Pine64, so here's how I did it.
+
+### No sound playing
+
+I had some troubles setting up the Pine's soundcard, but finally managed it by installing the latest Ubuntu image, and following [these instructions](http://forum.pine64.org/showthread.php?tid=1832&pid=16434#pid16434).
+
+### Binding with alsa
+
+After following the above instructions, I also installed the `gstreamer1.0-alsa` package, which got me some nice ALSA plugins for Gstreamer. I edited the `/usr/share/alsa/alsa.conf` file and set both the `defaults.ctl.card` and the `defaults.pcm.card` properties from 0 to 1, so ALSA doesn't have to wonder too much about what soundcard to use (0 is the HDMI output and 1 is the jack output). I then set Mopidy's configuration file to what you can find in `mopidy/mopidy-pine64.conf`. It's basically the default configuration file, but with the right bindings.
+
+### Launch Mopidy at startup
+
+Since you installed Mopidy from sources, there's no provided way to automatically launch Mopidy when your Pine64 starts. I did it with the systemd service file you can find in `mopidy/mopidy.service`, which I moved to `/etc/systemd/system`. Then, the usual (as root):
+
+```shell
+systemctl enable mopidy
+systemctl start mopidy
+```

mopidy/mopidy-pine64.conf

@@ -0,0 +1,114 @@
+# For further information about options in this file see:
+#   http://docs.mopidy.com/
+#
+# The initial commented out values reflect the defaults as of:
+#   Mopidy 2.0.0
+#   Mopidy-File 2.0.0
+#   Mopidy-HTTP 2.0.0
+#   Mopidy-Local 2.0.0
+#   Mopidy-M3U 2.0.0
+#   Mopidy-MPD 2.0.0
+#   Mopidy-SoftwareMixer 2.0.0
+#   Mopidy-Stream 2.0.0
+#
+# Available options and defaults might have changed since then,
+# run `mopidy config` to see the current effective config and
+# `mopidy --version` to check the current version.
+
+[core]
+#cache_dir = $XDG_CACHE_DIR/mopidy
+#config_dir = $XDG_CONFIG_DIR/mopidy
+#data_dir = $XDG_DATA_DIR/mopidy
+#max_tracklist_length = 10000
+
+[logging]
+#color = true
+#console_format = %(levelname)-8s %(message)s
+#debug_format = %(levelname)-8s %(asctime)s [%(process)d:%(threadName)s] %(name)s\n  %(message)s
+#debug_file = mopidy.log
+#config_file =
+
+[audio]
+mixer = alsamixer
+mixer_volume = 100
+output = alsasink
+#buffer_time = 
+
+[proxy]
+#scheme = 
+#hostname = 
+#port = 
+#username = 
+#password = 
+
+[mpd]
+#enabled = true
+#hostname = 127.0.0.1
+#port = 6600
+#password = 
+#max_connections = 20
+#connection_timeout = 60
+#zeroconf = Mopidy MPD server on $hostname
+#command_blacklist = 
+#  listall
+#  listallinfo
+#default_playlist_scheme = m3u
+
+[http]
+#enabled = true
+#hostname = 127.0.0.1
+#port = 6680
+#static_dir =
+#zeroconf = Mopidy HTTP server on $hostname
+
+[stream]
+#enabled = true
+#protocols = 
+#  http
+#  https
+#  mms
+#  rtmp
+#  rtmps
+#  rtsp
+#metadata_blacklist = 
+#timeout = 5000
+
+[m3u]
+#enabled = true
+#base_dir =
+#default_encoding = latin-1
+#default_extension = .m3u8
+#playlists_dir =
+
+[softwaremixer]
+enabled = false
+
+[file]
+#enabled = true
+#media_dirs = 
+#  $XDG_MUSIC_DIR|Music
+#  ~/|Home
+#show_dotfiles = false
+#follow_symlinks = false
+#metadata_timeout = 1000
+
+[local]
+enabled = true
+library = json
+media_dir = /home/mopidy/media
+#scan_timeout = 1000
+#scan_flush_threshold = 100
+#scan_follow_symlinks = false
+#excluded_file_extensions = 
+#  .directory
+#  .html
+#  .jpeg
+#  .jpg
+#  .log
+#  .nfo
+#  .png
+#  .txt
+
+[alsamixer]
+card = 1
+control = headphone volume

mopidy/mopidy.service

@@ -0,0 +1,10 @@
+[Unit]
+Description=Mopidy
+After=network.target
+[Service]
+Type=simple
+ExecStart=/usr/local/bin/mopidy
+Restart=on-abort
+User=mopidy
+[Install]
+WantedBy=multi-user.target

welcomehome

@@ -0,0 +1,95 @@
+#!/bin/bash
+
+
+##### FUNCTIONS #####
+
+log() {
+    # Beautiful logs
+    date=`date +"%d/%m/%Y - %H:%M:%S"`
+    echo "[$date]" $1
+}
+
+play_stream() {
+    # Reset playback state
+    curl -s -d '{"jsonrpc": "2.0", "id": 1, "method": "core.playback.stop"}' http://localhost:6680/mopidy/rpc > /dev/null
+    curl -s -d '{"jsonrpc": "2.0", "id": 1, "method": "core.tracklist.clear"}' http://localhost:6680/mopidy/rpc > /dev/null
+
+    # Add track infos
+    stream=$1
+    log "Playing stream $stream"
+
+    data='{"jsonrpc": "2.0", "id": 1, "method": "core.tracklist.add", "params": [ [ { "__model__": "Track", "uri": "STREAM" } ] ] }'
+    # Using sed cuz simple quotes
+    data=`echo $data | sed "s,STREAM,${stream},"`
+
+    # Play dat sound
+    curl -s -d "$data" http://localhost:6680/mopidy/rpc > /dev/null
+    curl -s -d '{"jsonrpc": "2.0", "id": 1, "method": "core.playback.play"}' http://localhost:6680/mopidy/rpc > /dev/null
+}
+
+stop_stream() {
+    # Stop dat sound
+    curl -s -d '{"jsonrpc": "2.0", "id": 1, "method": "core.playback.stop"}' http://localhost:6680/mopidy/rpc > /dev/null
+    log "Stream stopped"
+}
+
+parse_arg() {
+    # Echoes the value of a given parameter in a given configuration file
+    value=$(cat $1 | grep -E "^$2" | cut -d"=" -f2)
+    value=$(echo $value | sed "s,^\s+,,")
+    echo $value
+}
+
+check_url() {
+    # Check if URL is starting with "http(s)://"
+    # Returns the same code as grep, which is 1 if incorrect,
+    # 0 if correct
+    echo $1 | grep -E "https?\://"
+    return $?
+}
+
+
+##### PROGRAM #####
+
+if [[ $# -eq 0 || ! -f $1 ]]; then
+    echo "I need a config file as first argument"
+    exit 1
+fi
+
+config_file=$1
+
+log "Parsing the configuration file"
+
+# Get parameters from the given configuration file
+stream=$(parse_arg $config_file "stream")
+threshold=$(parse_arg $config_file "device_threshold")
+address=$(parse_arg $config_file "device_address")
+
+if [ ! $(check_url $stream) ]; then
+    echo "Incorrect stream address"
+    exit 1
+fi
+
+log "Initialisation complete"
+
+while true; do
+    # Lock file
+    lock_file="/etc/welcomehome/home.lck"
+
+    count=$(ping -W 1 -c $threshold $address | grep ttl | wc -l)
+
+    if [ $count -gt 0 ]; then
+        # mopidy.lck present = music already playing
+        if [ ! -f $lock_file ]; then
+            log "Device detected"
+            play_stream $stream
+            touch $lock_file
+        fi
+    else
+        if [ -f $lock_file ]; then
+            log "Device lost"
+            stop_stream
+            rm $lock_file
+        fi
+    fi
+done

welcomehome.example.conf

@@ -0,0 +1,10 @@
+# Static address pointing to the device you wish to check for
+# Can be a manually attributed static DHCP lease bound to the device
+device_address = 127.0.0.1
+
+# Greater threshold = Longer time to detect status change
+# but also greater accuracy if the device's wifi is crap
+device_threshold = 3
+
+# URL of the stream to be played when the device is detected
+stream = http://fr5.ah.fm:443

welcomehome.service

@@ -0,0 +1,9 @@
+[Unit]
+Description=Welcome Home
+After=mopidy.service
+[Service]
+Type=simple
+ExecStart=/usr/local/bin/welcomehome /etc/welcomehome/welcomehome.conf
+Restart=on-abort
+[Install]
+WantedBy=multi-user.target