3 Copyright (C) 2011, BMW AG
6 author Christian Müller (christian.ei.mueller@bmw.de)
8 ***********************************************************************************************************
10 ***********************************************************************************************************
12 GNU Lesser General Public License, version 2.1, with special exception (GENIVI clause)
13 Copyright (C) 2011, BMW AG – Christian Müller Christian.ei.mueller@bmw.de
15 This program is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License, version 2.1, as published by the Free Software Foundation.
16 This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License, version 2.1, for more details.
17 You should have received a copy of the GNU Lesser General Public License, version 2.1, along with this program; if not, see <http://www.gnu.org/licenses/lgpl-2.1.html>.
18 Note that the copyright holders assume that the GNU Lesser General Public License, version 2.1, may also be applicable to programs even in cases in which the program is not a library in the technical sense.
19 Linking AudioManager statically or dynamically with other modules is making a combined work based on AudioManager. You may license such other modules under the GNU Lesser General Public License, version 2.1. If you do not want to license your linked modules under the GNU Lesser General Public License, version 2.1, you may use the program under the following exception.
20 As a special exception, the copyright holders of AudioManager give you permission to combine AudioManager with software programs or libraries that are released under any license unless such a combination is not permitted by the license of such a software program or library. You may copy and distribute such a system following the terms of the GNU Lesser General Public License, version 2.1, including this special exception, for AudioManager and the licenses of the other code concerned.
21 Note that people who make modified versions of AudioManager are not obligated to grant this special exception for their modified versions; it is their choice whether to do so. The GNU Lesser General Public License, version 2.1, gives permission to release a modified version without this exception; this exception also makes it possible to release a modified version which carries forward this exception.
25 ***********************************************************************************************************
27 ***********************************************************************************************************
28 The most important parts of the audiomanager are already there - nevertheless there are main features missing (pls look at the todos)
29 It should be sufficient to start working on a POC around it.
31 ***********************************************************************************************************
33 ***********************************************************************************************************
34 - compile options with default values:
37 CMAKE_INSTALL_PREFIX /usr/local
40 WITH_DOCUMENTATION OFF
42 WITH_PLUGIN_COMMAND ON
43 WITH_PLUGIN_CONTROL ON
44 WITH_PLUGIN_ROUTING ON
46 WITH_SIMPLEDBUS_LOOP OFF
47 WITH_SOCKETHANDLER_LOOP ON
52 In order to change these options, you can modify this values with ccmake, do the appropriate changes in CmakeList.txt or via
53 the commandline for cmake or (when installed via ccmake)
55 You will need some packages in order to comile the GENIVI AudioManager Daemon, these are:
56 -dbus (only when DBUS_WRAPPER==ON) [tested on version 1.2.16]
57 -sqlite3 [tested on version 3.6.22]
58 -automotive-dlt [tested on version 2.2.0]
59 -doxygen (only when WITH_DOCUMENTATION==ON) [tested on version 1.6.3]
61 to install them in a build environment like Ubuntu you can use:
62 sudo apt-get install libdbus-1-dev libsqlite3-dev doxygen git cmake build-essential
64 For building the tests, you will need the following packages:
65 -google mock [tested on version 1.6.0-1]
66 -google test [tested on version 1.6.0]
67 -python [tested on version 2.6]
69 to install them in a build environment like Ubuntu you can use:
70 sudo apt-get install libgtest-dev google-mock python2.6-dev
72 More details in the CMake Files CmakeList.txt in the projects.
74 The build was tested on a freshly setup LinuxMint 12 (don't like Unity) with the following steps:
77 sudo apt-get install libdbus-1-dev libsqlite3-dev doxygen libgtest-dev google-mock git cmake build-essential python2.6-dev
79 git clone https://<kavi-account>:<kavi-password>@git.genivi.org/srv/git/DLT-daemon
81 In order to build the project (out of source build), please follow these instructions on the commandline:
88 after the script finished, you should have:
90 a bin/ folder which contains all executables and the libraries:
91 a build/ folder which has all build objects (erase that if you need a clean build)
92 a doc/ folder in case you turned the documentation on
94 in order to install the AudioManager, you can do
98 package generation is supported via CPack. To build packages, you have to
102 this will create one package if your CMake version is < 2.8.5 (all binaries stripped):
104 AudioManager-<git verison>-Linux.deb
106 if your version is above, you will get 4 packages (all binaries stripped) :
108 AudioManager-<git verison>-Linux-bin.deb [AudioManager binary]
109 AudioManager-<git verison>-Linux-dev.deb [header files needed to compile plugins]
110 AudioManager-<git verison>-Linux-sampleplugins.deb [sample plugins]
111 AudioManager-<git verison>-Linux-tests.deb [tests including tests for sample plugins, installed in the ~/AudioMAnagerTests]
113 to create a tar.gz file of all sources (not including .git, build and bin folder,config files), you can do:
117 This will create the following package:
119 AudioManager-<git verison>-Source.tar.gz
121 All packages will be placed in a folder called packages
123 The commandline options of the AudioManager:
125 Usage: AudioManagerDaemon [options]
127 -h: print this message
128 -i: info about current settings
130 -d: daemonize AudioManager
131 -p<path> path for sqlite database (default is in memory)
132 -t<port> port for telnetconnection
133 -m<max> number of max telnetconnections
134 -c<Name> use controllerPlugin <Name> (full path with .so ending)
135 -l<Name> replace command plugin directory with <Name> (full path)
136 -r<Name> replace routing plugin directory with <Name> (full path)
137 -L<Name> add command plugin directory with <Name> (full path)
138 -R<Name> add routing plugin directory with <Name> (full path)
141 If you compile your AudioManager with TelnetServer support (cmake -DWITH_TELNET=ON), you will be able to set with commandline argument -t the port number and
142 with -m the maximum supported connections. The default telnet port is 6060.
144 For example, launch a telnet session on port 6060:
145 telnet localhost 6060
147 #>Welcome to GENIVI AudioManager ver-0.0.1-37-ga004215
150 press 'help' to get a list of all supported commands on this level:
153 ####################################################
154 ####### The following commands are supported: ######
155 ####################################################
157 #exit - quit telnet session
158 #get - Go into 'get'-submenu
159 #help - show all possible commands
160 #info - Go into 'info'-submenu
161 #list - Go into 'list'-submenu
162 #set - Go into 'set'-submenu
166 Now type one of these commands, for example 'get', followed with another 'help' to get a list of supported commands:
171 ####################################################
172 ####### The following commands are supported: ######
173 ####################################################
175 #.. - one step back in menu tree (back to root folder)
176 #exit - close telnet session
177 #help - show all possible commands
178 #recv - show receiverversion
179 #routing - show current routing
180 #sendv - show senderversion
184 You can also execute several commands in a line:
186 #\Get>recv sendv .. help exit
188 # Ctrl: 1 | Cmd: 1 | Routing: 1
190 # Ctrl: 1 | Cmd: 1 | Routing: 1
191 ####################################################
192 ######## The following commands are supported: ######
193 ####################################################
195 #exit - quit telnet session
196 #get - Go into 'get'-submenu
197 #help - show all possible commands
198 #info - Go into 'info'-submenu
199 #list - Go into 'list'-submenu
200 #set - Go into 'set'-submenu
202 #Your wish is my command ... bye!
203 #Connection closed by foreign host.
207 The source code if formatted with eclipse, the style sheet used can be found in the cmake folder:
208 cmake/AudioManager_Codestyle.xml
212 __.--'`._/_\j_____/_||___\ `----.
213 _.--'_____ | \ _____ /
214 _j /,---.\ | =o | /,---.\ |_
215 [__]==// .-. \\==`===========/==// .-. \\=[__]
216 `-._|\ `-' /|___\_________/___|\ `-' /|_.'