Skip to content

Commit

Permalink
Daemonizing + doc
Browse files Browse the repository at this point in the history
  • Loading branch information
@carlou33
carlou33 committed Sep 12, 2016
1 parent 634348b commit fe265c9
Show file tree
Hide file tree
Showing 9 changed files with 224 additions and 64 deletions.
101 changes: 78 additions & 23 deletions doc/SETUP.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,61 @@ Setup
Installation
------------

Basic Installation
~~~~~~~~~~~~~~~~~~

.. _daemonized:

Daemonizing
~~~~~~~~~~~

To make the server running in the background automatically on the RasPi startup, it's possible to daemonize it with a few steps.

First, copy the ``be-server`` executable file to ``/opt/boites-electriques/``, and the ``be-server.sh`` script (located in the repo's ``share/`` directory) to ``/etc/init.d/be-server``::

sudo mkdir /opt/boites-electriques
sudo cp build/be-server /opt/boites-electriques/be-server
sudo cp share/be-server.sh /etc/init.d/be-server

You can then edit the ``/etc/init.d/be-server`` to change the following values:

``DAEMON``
The full command.
Default : ``"/opt/boites-electriques/be-server"``

``daemon_OPT``
The program's arguments (here, the path to a specific configuration file).
Default : ``""`` (empty, to use the default config file)

``DAEMONUSER``
The user running the program.
Default : ``"pi"`` (default ``sudo`` user of Raspbian)

``daemon_NAME``
Name of the program.
Default : ``"be-server"``

Then, we give the right permissions to the daemonizing script and reload the system's daemons::

sudo chmod 0755 /etc/init.d/be-server
sudo systemctl daemon-reload

We can then test the script::

sudo /etc/init.d/be-server start
[ ok ] Starting be-server (via systemctl): be-server.service
sudo /etc/init.d/be-server stop
[....] Stopping be-server (via systemctl): be-server.service

And add it to the startup scripts::
sudo update-rc.d be-server defaults

To remove it::

sudo update-rc.d -f be-server remove

Configuration
-------------

Expand All @@ -19,59 +74,59 @@ The following options are available :
~~~~~~~~~~~~~~~~~~~~~~~~~~~~

``threshold``
Default threshold's value (integer)
Default : 200
Default threshold's value (integer).
Default : ``200``

``master``
Default master volume's value (integer)
Default : 50
Default master volume's value (integer).
Default : ``50``

``volume``
Default track's volume (integer)
Default : 50
Default track's volume (integer).
Default : ``50``

``pan``
Default track's pan (integer)
Default : 0
Default track's pan (integer).
Default : ``0``

``activation``
Default track's activation status (boolean : true or false)
Default : false
Default track's activation status (boolean : ``true`` or ``false``).
Default : ``false``

``[files]`` section
~~~~~~~~~~~~~~~~~~~

``folder``
Files save/load folder (string : path, ending with '/')
Default : /home/pi/songs/
Files save/load folder (string : path, ending with '``/``').
Default : ``/home/pi/songs/``

``extension``
Songs files' extension (string : '*.<extension>')
Default : *.song
Songs files' extension (string : ``*.<extension>``).
Default : ``*.song``

``[gpio]`` section
~~~~~~~~~~~~~~~~~~

``led``
LED's WiringPi identifier (to use with the ``gpio`` command)
Default : 6
LED's WiringPi identifier (to use with the ``gpio`` command).
Default : ``6``

``[osc]`` section
~~~~~~~~~~~~~~~~~

``ip``
Client's OSC IP address (integer)
Default : 192.170.0.17
Client's OSC IP address (integer).
Default : ``192.170.0.17``

``receiver``
Server's OSC receiver port (integer)
Default : 9988
Server's OSC receiver port (integer).
Default : ``9988``

``sender``
Server's OSC sender port (integer)
Default : 9989
Server's OSC sender port (integer).
Default : ``9989``

Run
---

To start the server, just run ``./be-server``
To start the server, just run ``./be-server``, or ``sudo /etc/init.d/be-server start`` if the server has been daemonized_.
66 changes: 66 additions & 0 deletions share/be-server.sh
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,66 @@
#!/bin/sh -e

# Daemonizing script for be-server

DAEMON="/opt/boites-electriques/be-server" # Command line
daemon_OPT="" # Arguments
DAEMONUSER="pi" # Program's user
daemon_NAME="be-server" # Program's name (same as the executable)


### BEGIN INIT INFO
# Provides: be-server
# Required-Start: $remote-fs $syslog
# Required-Stop: $remote-fs $syslog
# Default-Start: 2 3 4 5
# Default-Stop: 0 1 6
# Short-Description: Run be-server at startup
# Description: Server for the Boites Electriques
### END INIT INFO


PATH="/sbin:/bin:/usr/sbin:/usr/bin"

test -x $DAEMON || exit 0

. /lib/lsb/init-functions

d_start () {
log_daemon_msg "Starting system $daemon_NAME Daemon"
start-stop-daemon --background --name $daemon_NAME --start --quiet --chuid $DAEMONUSER --exec $DAEMON -- $daemon_OPT
log_end_msg $?
}

d_stop () {
log_daemon_msg "Stopping system $daemon_NAME Daemon"
start-stop-daemon --name $daemon_NAME --stop --retry 5 --quiet --name $daemon_NAME
log_end_msg $?
}

case "$1" in

start|stop)
d_${1}
;;

restart|reload|force-reload)
d_stop
d_start
;;

force-stop)
d_stop
killall -q $daemon_NAME || true
sleep 2
killall -q -9 $daemon_NAME || true
;;

status)
status_of_proc "$daemon_NAME" "$DAEMON" "system-wide $daemon_NAME" && exit 0 || exit $?
;;
*)
echo "Usage: /etc/init.d/$daemon_NAME {start|stop|force-stop|restart|reload|force-reload|status}"
exit 1
;;
esac
exit 0
28 changes: 21 additions & 7 deletions src/PlayThread.cpp
View file
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,9 @@ void PlayThread::timeHandle() {
if(++m_bufferCount > m_maxBufferCount)
m_bufferCount = 0;

emit actualBeatChanged(m_bufferCount * m_conf.bufferSize / double(m_conf.samplingRate));
emit actualBeatChanged(m_bufferCount
* m_conf.bufferSize
/ double(m_conf.samplingRate));
}

void PlayThread::stop() {
Expand Down Expand Up @@ -159,20 +161,32 @@ void PlayThread::load(const SongData& s) {
m_maxBufferCount = file->v(0).size() / m_conf.bufferSize;
emit beatCountChanged(file->v(0).size() / double(m_conf.samplingRate));

chains[i] = Input_p(new SfxInputProxy<double>(new StereoAdapter<double>(new LoopInputProxy<double>(file)),
new Sequence<double>(m_conf, m_tracks[i]->getVolumePtr(), m_tracks[i]->getPanPtr(), m_tracks[i]->getMutePtr() )));
chains[i] = Input_p(new SfxInputProxy<double>(
new StereoAdapter<double>(
new LoopInputProxy<double>(file)),
new Sequence<double>(m_conf,
m_tracks[i]->getVolumePtr(),
m_tracks[i]->getPanPtr(),
m_tracks[i]->getMutePtr() )));

emit songLoaded(i+1,track_count);
}

// Master
auto input = Input_p(new SfxInputProxy<double>(new SummationProxy<double>(new InputMultiplexer<double>(m_conf, chains)), m_masterVolume));
auto input = Input_p(new SfxInputProxy<double>(
new SummationProxy<double>(
new InputMultiplexer<double>(m_conf, chains)),
m_masterVolume));

// Manager
m_manager = std::make_shared<StreamingManager<double>>(std::move(input),
std::move(std::make_shared<RtAudioOutput<double>>(m_conf)),
std::bind(&PlayThread::timeHandle, this),
m_conf);
std::move(
std::make_shared<RtAudioOutput<double>>(
m_conf)),
std::bind(
&PlayThread::timeHandle,
this),
m_conf);
}

bool PlayThread::isValidTrack(unsigned int track)
Expand Down
30 changes: 21 additions & 9 deletions src/SaveManager.cpp
View file
Original file line number Diff line number Diff line change
Expand Up @@ -50,12 +50,19 @@ SongData SaveManager::load(const QString loadpath) {
bool end = false;

for(int i = 0; i < count; ++ i) {
sd.tracks.emplace_back(settings.value(QString("Track%1/name").arg(i)).toString().toStdString(),
(tempdir->path() + "/" + settings.value(QString("Track%1/filename").arg(i)).toString()).toStdString(),
settings.value(QString("Track%1/volume").arg(i)).toInt(),
settings.value(QString("Track%1/pan").arg(i)).toInt());

QString track_name = settings.value(QString("Track%1/name").arg(i)).toString();
sd.tracks.emplace_back(settings.value(
QString("Track%1/name").arg(i)).toString().toStdString(),
(tempdir->path()
+ "/"
+ settings.value(
QString("Track%1/filename").arg(i)).toString()).toStdString(),
settings.value(
QString("Track%1/volume").arg(i)).toInt(),
settings.value(
QString("Track%1/pan").arg(i)).toInt());

QString track_name =
settings.value(QString("Track%1/name").arg(i)).toString();
temp = temp + track_name;
t++;

Expand All @@ -78,15 +85,20 @@ void SaveManager::save(const QString savepath, Server* manager) {
//// Opening of .ini file in tempdir
QStringList nameFilter("*.ini");
QDir directory(tempdir->path());
QString iniFile = tempdir->path() + "/" + directory.entryList(nameFilter).first();
QString iniFile =
tempdir->path() + "/" + directory.entryList(nameFilter).first();

//// Modification
QSettings settings(iniFile, QSettings::IniFormat);
int count = settings.value("General/trackCount").toInt();

for(int i = 0; i < count; ++ i) {
settings.setValue(QString("Track%1/volume").arg(i), manager->m_player->getTrack(i)->getVolume());
settings.setValue(QString("Track%1/pan").arg(i), manager->m_player->getTrack(i)->getPan());
settings.setValue(
QString("Track%1/volume").arg(i),
manager->m_player->getTrack(i)->getVolume());
settings.setValue(
QString("Track%1/pan").arg(i),
manager->m_player->getTrack(i)->getPan());
}

settings.sync();
Expand Down
5 changes: 4 additions & 1 deletion src/SerialManager.cpp
View file
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,10 @@ void SerialManager::run() {
if(port->canReadLine()) {
numRead = port->readLine(txt, STR_SIZE);
auto msg = QString(txt).simplified().split(' ');
if(numRead > 0) emit boxActivated(msg[0].toInt(), msg[1].toInt());

if(numRead > 0)
emit boxActivated(msg[0].toInt(),
msg[1].toInt());
}
}
}
Expand Down
Loading

0 comments on commit fe265c9

Please sign in to comment.