summaryrefslogtreecommitdiff
path: root/README
blob: 149b1a09738bc4db8895cdadcae414680896d0aa (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
***********************************************************************************************************
GENIVI AudioManager
***********************************************************************************************************

Copyright (C) 2012, GENIVI Alliance, Inc.
Copyright (C) 2012, BMW AG

This file is part of GENIVI Project AudioManager.
 
Contributions are licensed to the GENIVI Alliance under one or more
Contribution License Agreements.
 
copyright
This Source Code Form is subject to the terms of the
Mozilla Public License, v. 2.0. If a  copy of the MPL was not distributed with
this file, You can obtain one at http://mozilla.org/MPL/2.0/.
 
author Christian Mueller, christian.ei.mueller@bmw.de BMW 2011,2012

For further information see http://www.genivi.org/.

***********************************************************************************************************
License
***********************************************************************************************************
The licenses of this project are split into two parts:
1) the AudioManagerDaemon, licensed under MPL 2.0
2) all other parts that serve as example code that can be taken to build up an own project with it -
    these parts are licensed with the MIT license
    
Contribution is done under GENIVI CLA. 

***********************************************************************************************************
Version
***********************************************************************************************************
The current version can be taken out of the git. The version 1.0.0 is the first GENIVI compliant code, 
in the compliance statement of discovery (2.0)

***********************************************************************************************************
COMPILE PROGRAMS
***********************************************************************************************************
- compile options with default values:

		 CMAKE_BUILD_TYPE                                                                                                                                    
		 CMAKE_INSTALL_PREFIX             /usr/local                                                                                                         
		 GLIB_DBUS_TYPES_TOLERANT         ON                                                                                                                 
		 USE_BUILD_LIBS                   ON                                                                                                                 
		 WITH_DBUS_WRAPPER                ON                                                                                                                 
		 WITH_DLT                         ON                                                                                                                
		 WITH_DOCUMENTATION               OFF                                                                                                                
		 WITH_MAIN                        ON                                                                                                                 
		 WITH_PLUGIN_COMMAND              ON                                                                                                                 
		 WITH_PLUGIN_CONTROL              ON                                                                                                                 
		 WITH_PLUGIN_ROUTING              ON                                                                                                                 
		 WITH_SYSTEMD_WATCHDOG            ON                                                                                                                 
		 WITH_TELNET                      ON                                                                                                                 
		 WITH_TESTS                       ON
 

Passing options to cmake:
***********************************************************************************************************
-DVERSION="XXX"
    when building the AudioManager without taking it from the git (and thus having a .git folder), you 
    can set the version via via passing -DVERSION="XXX" to cmake, default: "homebrew-${CMAKE_SOURCE_DIR}"
-DDBUS_SERVICE_PREFIX="XXX"
    sets the service prefix for Dbus, default "org.genivi.audiomanager\0"
-DDBUS_SERVICE_OBJECT_PATH="XXX"
    sets the object path for Dbus, default "/org/genivi/audiomanager\0"
-DDEFAULT_TELNETPORT="XXX"
    sets the default telnetport, default 6060. Can be overwriten by command line parameter
-DMAX_TELNETCONNECTIONS="XXX"
    sets the default maximum number of telnetconnections, default is 3

In order to change these options, you can modify this values with ccmake, do the appropriate changes in 
CmakeList.txt or via the commandline for cmake or (when installed via ccmake)

You will need some packages in order to comile the GENIVI AudioManager Daemon, these are:
	-dbus (only when DBUS_WRAPPER==ON) [tested on version 1.2.16]
	-sqlite3 [tested on version 3.6.22]
	-automotive-dlt [greater 2.5.0]                
	-doxygen (only when WITH_DOCUMENTATION==ON) [tested on version 1.6.3]

	to install them in a build environment like Ubuntu you can use:
		sudo apt-get install libdbus-1-dev libsqlite3-dev doxygen git cmake build-essential

For building the tests, you will need the following packages:
	-google mock [tested on version 1.6.0-1] 
	-google test [tested on version 1.6.0]
	-python [tested on version 2.6]

	to install them in a build environment like Ubuntu you can use:
		sudo apt-get install libgtest-dev google-mock python2.6-dev

More details in the CMake Files CmakeList.txt in the projects.

The build was tested on a freshly setup LinuxMint 12 (don't like Unity) with the following steps:
	sudo apt-get update
	sudo apt-get upgrade
	sudo apt-get install libdbus-1-dev libsqlite3-dev doxygen libgtest-dev google-mock git cmake 
	     build-essential python2.6-dev

	git clone https://<kavi-account>:<kavi-password>@git.genivi.org/srv/git/AudioManager

In order to build the project (out of source build), please follow these instructions on the commandline:

	mkdir /build
	cd build
	cmake ..
	make -j4

after the script finished, you should have:

	a bin/ folder which contains all executables and the libraries: 
	a build/ folder which has all build objects (erase that if you need a clean build)
	a doc/ folder in case you turned the documentation on

in order to install the AudioManager, you can do

	sudo make install

package generation is supported via CPack. To build packages, you have to 

	make genivi_package

this will create one package if your CMake version is < 2.8.5 (all binaries stripped):
	
	AudioManager-<git verison>-Linux.deb 

if your version is above, you will get 4 packages (all binaries stripped) :
	
	AudioManager-<git verison>-Linux-bin.deb   		[AudioManager binary]
	AudioManager-<git verison>-Linux-dev.deb   		[header files needed to compile plugins]
	AudioManager-<git verison>-Linux-sampleplugins.deb 	[sample plugins]
	AudioManager-<git verison>-Linux-tests.deb		[tests including tests for sample plugins, 
	       installed in the ~/AudioMAnagerTests]

to create a tar.gz file of all sources (not including .git, build and bin folder,config files), you can do:

	make package_source			 CMAKE_BUILD_TYPE                                                                                                                                    
		 CMAKE_INSTALL_PREFIX             /usr/local                                                                                                         
		 GLIB_DBUS_TYPES_TOLERANT         ON                                                                                                                 
		 USE_BUILD_LIBS                   ON                                                                                                                 
		 WITH_DBUS_WRAPPER                ON                                                                                                                 
		 WITH_DLT                         OFF                                                                                                                
		 WITH_DOCUMENTATION               OFF                                                                                                                
		 WITH_MAIN                        ON                                                                                                                 
		 WITH_PLUGIN_COMMAND              ON                                                                                                                 
		 WITH_PLUGIN_CONTROL              ON                                                                                                                 
		 WITH_PLUGIN_ROUTING              ON                                                                                                                 
		 WITH_SYSTEMD_WATCHDOG            ON                                                                                                                 
		 WITH_TELNET                      ON                                                                                                                 
		 WITH_TESTS                       OFF

This will create the following package:

	AudioManager-<git verison>-Source.tar.gz

All packages will be placed in a folder called packages

The commandline options of the AudioManager:

	Usage:	AudioManagerDaemon [options]
	options:	
	
    -h: print this message  
    -i: info about current settings     
    -v: print version   
    -V: print DLT logs to stdout    
    -d: daemonize AudioManager  
    -T: DbusType to be used by CAmDbusWrapper (0=DBUS_SESSION[default], 1=DBUS_SYSTEM)  
    -p<path> path for sqlite database (default is in memory)    
    -t<port> port for telnetconnection  
    -m<max> number of max telnetconnections 
    -c<Name> use controllerPlugin <Name> (full path with .so ending)    
    -l<Name> replace command plugin directory with <Name> (full path)   
    -r<Name> replace routing plugin directory with <Name> (full path)   
    -L<Name> add command plugin directory with <Name> (full path)   
    -R<Name> add routing plugin directory with <Name> (full path)   	


***********************************************************************************************************
Telnet Server
***********************************************************************************************************
The audiomanager has a build- in telnetserver that serves for debuggin purposes.
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 with -m the maximum supported connections. 
The default telnet port is 6060. 
   
   For example, launch a telnet session on port 6060:
      telnet localhost 6060
   
      #>Welcome to GENIVI AudioManager ver-0.0.1-37-ga004215
      #>
   
   press 'help' to get a list of all supported commands on this level:
   
      #>help
      ####################################################
      ####### The following commands are supported: ######
      ####################################################
      #
      #exit  - quit telnet session
      #get   - Go into 'get'-submenu
      #help  - show all possible commands
      #info  - Go into 'info'-submenu
      #list  - Go into 'list'-submenu
      #set   - Go into 'set'-submenu
      #
      #\>
   
   Now type one of these commands, for example 'get', followed with another 'help' to get a list of supported commands:
   
      #\>get
      #
      #\Get>help
      ####################################################
      ####### The following commands are supported: ######
      ####################################################
      # 
      #.. - one step back in menu tree (back to root folder)
      #exit  - close telnet session
      #help  - show all possible commands
      #recv  - show receiverversion 
      #routing  - show current routing
      #sendv - show senderversion
      #
      #\Get>
   
   You can also execute several commands in a line:
   
      #\Get>recv sendv .. help exit
      #   Receiver versions:
      #   Ctrl: 1 | Cmd: 1 | Routing: 1
      #   Sender versions:
      #   Ctrl: 1 | Cmd: 1 | Routing: 1
      ####################################################
      ######## The following commands are supported: ######
      ####################################################
      #
      #exit  - quit telnet session
      #get   - Go into 'get'-submenu
      #help  - show all possible commands
      #info  - Go into 'info'-submenu
      #list  - Go into 'list'-submenu
      #set   - Go into 'set'-submenu
      #
      #Your wish is my command ... bye!
      #Connection closed by foreign host.


***********************************************************************************************************
Code Formatting
***********************************************************************************************************
The source code if formatted with eclipse, the style sheet used can be found in the cmake folder:
cmake/AudioManager_Codestyle.xml

***********************************************************************************************************
Working on the code & contribution
***********************************************************************************************************
First get the code from the git:
        git clone https://<kavi-account>:<kavi-password>@git.genivi.org/srv/git/AudioManager

Get an overview of all branches:
        git branch

Switch to the branch you want to work on (see versioning schmeme, the master is the feature branch) 
and verify that it has switched (* changed)
        git checkout <your branch>
        git branch

Best practice is to create a local branch based on the current branch:
        git branch working_branch

Start working, best practice is to commit smaller, compilable peaced during the work that makes it easier to 
handle later on.

If you want to commit you changes, send them to the audiomanager-dev list, you can create a patch like this:
        git format-patch working_branch <your branch>

This creates a set of patches that are published via the mailing list (this is already the submission under CLA). 
The patches will be discussed and then merged & uploaded on the git. For more information about git checkout the 
Genivi wiki and the stuff on the web.


                                 _..-------++._
                             _.-'/ |      _||  \"--._
                       __.--'`._/_\j_____/_||___\    `----.
                  _.--'_____    |          \     _____    /
                _j    /,---.\   |        =o |   /,---.\   |_
               [__]==// .-. \\==`===========/==// .-. \\=[__]
                 `-._|\ `-' /|___\_________/___|\ `-' /|_.'     
                       `---'                     `---'