Revision b1f38b27

View differences:

.gitignore
1
build
2
.dep
3
*.tmp
4
*.backup
5

  
6
# Eclipse files
7
*eclipse*
8

  
9
# QtCreator files
10
*.includes
11
*.files
12
*.config
13
*.creator
14
*.creator.user
15

  
16
# Shadow files
17
*kate-swp
18
*~
19

  
20
# Backup files
21
*backup*
22
*Backup*
.gitmodules
1
[submodule "os/AMiRo-OS"]
2
	path = os/AMiRo-OS
3
	url = http://openresearch.cit-ec.de/git/amiro-os.amiro-os.git
4
[submodule "middleware/uRtWare"]
5
	path = middleware/uRtWare
6
	url = http://openresearch.cit-ec.de/git/amiro-os.urtware.git
README.txt
1
AMiRo-Apps is a collection of applications and configurations for the Autonomous
2
Mini Robot (AMiRo) [1]. It is tightly coupled to the AMiRo-OS and uRtWare
3
projects, which provide a sophisticated operating system (based on ChibiOS) amd
4
a real-time middleware for embedded devices.
5

  
6
Copyright (C) 2018..2018  Thomas Schöpping et al.
7
(a complete list of all authors is given below)
8

  
9
This program is free software: you can redistribute it and/or modify
10
it under the terms of the GNU General Public License as published by
11
the Free Software Foundation, either version 3 of the License, or (at
12
your option) any later version.
13

  
14
This program is distributed in the hope that it will be useful, but
15
WITHOUT ANY WARRANTY; without even the implied warranty of
16
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
17
General Public License for more details.
18

  
19
You should have received a copy of the GNU General Public License
20
along with this program.  If not, see <http://www.gnu.org/licenses/>.
21

  
22
This research/work was supported by the Cluster of Excellence
23
Cognitive Interaction Technology 'CITEC' (EXC 277) at Bielefeld
24
University, which is funded by the German Research Foundation (DFG).
25

  
26
Authors:
27
 - Thomas Schöpping          <tschoepp[at]cit-ec.uni-bielefeld.de>
28
 - Marc Rothmann
29

  
30
References:
31
 [1] S. Herbrechtsmeier, T. Korthals, T. Schopping and U. Rückert, "AMiRo: A
32
     modular & customizable open-source mini robot platform," 2016 20th
33
     International Conference on System Theory, Control and Computing (ICSTCC),
34
     Sinaia, 2016, pp. 687-692.
35

  
36

  
37

  
38
################################################################################
39
#                                                                              #
40
#        RRRRRRRR   EEEEEEEE     AAA     DDDDDDDD   MM     MM  EEEEEEEE        #
41
#        RR     RR  EE          AA AA    DD     DD  MMM   MMM  EE              #
42
#        RR     RR  EE         AA   AA   DD     DD  MMMM MMMM  EE              #
43
#        RRRRRRRR   EEEEEE    AA     AA  DD     DD  MM MMM MM  EEEEEE          #
44
#        RR   RR    EE        AAAAAAAAA  DD     DD  MM     MM  EE              #
45
#        RR    RR   EE        AA     AA  DD     DD  MM     MM  EE              #
46
#        RR     RR  EEEEEEEE  AA     AA  DDDDDDDD   MM     MM  EEEEEEEE        #
47
#                                                                              #
48
################################################################################
49

  
50
This file will help you to setup all required software on your system, compile
51
the source code, and flash it to the AMiRo modules.
52

  
53
================================================================================
54

  
55
CONTENTS:
56

  
57
  1  Required software
58
  3  Building and flashing
59

  
60
================================================================================
61

  
62

  
63

  
64
1 - REQUIRED SOFTWARE
65
---------------------
66

  
67
Since AMiRo-Apps depends on the AMiRo-OS and uRtWare projects, both are included
68
as Git submodules. Use the provided ./setup.sh script to initialize those. When
69
AMiRo-OS is fully configured, there is no additional software required by
70
AMiRo-Apps. For further details about the initialization follow the instructions
71
in the script and refer to the README.txt file of AMiRo-OS and uRtWare
72
respectively.
73

  
74

  
75

  
76
2 - BUILDING AND FLASHING
77
-------------------------
78

  
79
For building and flashing a specific setup, you must first define a
80
configuration in the ./configurations folder (e.g. ./configurations/MyConf).
81
Such a configuration must consist of a Makefile and a C header file with the
82
name "osconf.h". Please copy the provided template files from the
83
./configurations/template directory and modify them as required in order to
84
minimize the risk of errors and for the sake of consistency. As a result you can
85
build and flash all software using the Makefile.
86

  
87
================================================================================
88

  
license.html
1
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2
<!-- saved from url=(0051)http://www.gnu.org/licenses/gpl-3.0-standalone.html -->
3
<html><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
4
 
5
 <title>GNU General Public License v3.0 - GNU Project - Free Software Foundation (FSF)</title>
6
 <link rel="alternate" type="application/rdf+xml" href="http://www.gnu.org/licenses/gpl-3.0.rdf"> 
7
</head>
8
<body>
9

  
10
<h3 style="text-align: center;">GNU GENERAL PUBLIC LICENSE</h3>
11
<p style="text-align: center;">Version 3, 29 June 2007</p>
12

  
13
<p>Copyright © 2007 Free Software Foundation, Inc.
14
 &lt;<a href="http://fsf.org/">http://fsf.org/</a>&gt;</p><p>
15
 Everyone is permitted to copy and distribute verbatim copies
16
 of this license document, but changing it is not allowed.</p>
17

  
18
<h3><a name="preamble"></a>Preamble</h3>
19

  
20
<p>The GNU General Public License is a free, copyleft license for
21
software and other kinds of works.</p>
22

  
23
<p>The licenses for most software and other practical works are designed
24
to take away your freedom to share and change the works.  By contrast,
25
the GNU General Public License is intended to guarantee your freedom to
26
share and change all versions of a program--to make sure it remains free
27
software for all its users.  We, the Free Software Foundation, use the
28
GNU General Public License for most of our software; it applies also to
29
any other work released this way by its authors.  You can apply it to
30
your programs, too.</p>
31

  
32
<p>When we speak of free software, we are referring to freedom, not
33
price.  Our General Public Licenses are designed to make sure that you
34
have the freedom to distribute copies of free software (and charge for
35
them if you wish), that you receive source code or can get it if you
36
want it, that you can change the software or use pieces of it in new
37
free programs, and that you know you can do these things.</p>
38

  
39
<p>To protect your rights, we need to prevent others from denying you
40
these rights or asking you to surrender the rights.  Therefore, you have
41
certain responsibilities if you distribute copies of the software, or if
42
you modify it: responsibilities to respect the freedom of others.</p>
43

  
44
<p>For example, if you distribute copies of such a program, whether
45
gratis or for a fee, you must pass on to the recipients the same
46
freedoms that you received.  You must make sure that they, too, receive
47
or can get the source code.  And you must show them these terms so they
48
know their rights.</p>
49

  
50
<p>Developers that use the GNU GPL protect your rights with two steps:
51
(1) assert copyright on the software, and (2) offer you this License
52
giving you legal permission to copy, distribute and/or modify it.</p>
53

  
54
<p>For the developers' and authors' protection, the GPL clearly explains
55
that there is no warranty for this free software.  For both users' and
56
authors' sake, the GPL requires that modified versions be marked as
57
changed, so that their problems will not be attributed erroneously to
58
authors of previous versions.</p>
59

  
60
<p>Some devices are designed to deny users access to install or run
61
modified versions of the software inside them, although the manufacturer
62
can do so.  This is fundamentally incompatible with the aim of
63
protecting users' freedom to change the software.  The systematic
64
pattern of such abuse occurs in the area of products for individuals to
65
use, which is precisely where it is most unacceptable.  Therefore, we
66
have designed this version of the GPL to prohibit the practice for those
67
products.  If such problems arise substantially in other domains, we
68
stand ready to extend this provision to those domains in future versions
69
of the GPL, as needed to protect the freedom of users.</p>
70

  
71
<p>Finally, every program is threatened constantly by software patents.
72
States should not allow patents to restrict development and use of
73
software on general-purpose computers, but in those that do, we wish to
74
avoid the special danger that patents applied to a free program could
75
make it effectively proprietary.  To prevent this, the GPL assures that
76
patents cannot be used to render the program non-free.</p>
77

  
78
<p>The precise terms and conditions for copying, distribution and
79
modification follow.</p>
80

  
81
<h3><a name="terms"></a>TERMS AND CONDITIONS</h3>
82

  
83
<h4><a name="section0"></a>0. Definitions.</h4>
84

  
85
<p>“This License” refers to version 3 of the GNU General Public License.</p>
86

  
87
<p>“Copyright” also means copyright-like laws that apply to other kinds of
88
works, such as semiconductor masks.</p>
89
 
90
<p>“The Program” refers to any copyrightable work licensed under this
91
License.  Each licensee is addressed as “you”.  “Licensees” and
92
“recipients” may be individuals or organizations.</p>
93

  
94
<p>To “modify” a work means to copy from or adapt all or part of the work
95
in a fashion requiring copyright permission, other than the making of an
96
exact copy.  The resulting work is called a “modified version” of the
97
earlier work or a work “based on” the earlier work.</p>
98

  
99
<p>A “covered work” means either the unmodified Program or a work based
100
on the Program.</p>
101

  
102
<p>To “propagate” a work means to do anything with it that, without
103
permission, would make you directly or secondarily liable for
104
infringement under applicable copyright law, except executing it on a
105
computer or modifying a private copy.  Propagation includes copying,
106
distribution (with or without modification), making available to the
107
public, and in some countries other activities as well.</p>
108

  
109
<p>To “convey” a work means any kind of propagation that enables other
110
parties to make or receive copies.  Mere interaction with a user through
111
a computer network, with no transfer of a copy, is not conveying.</p>
112

  
113
<p>An interactive user interface displays “Appropriate Legal Notices”
114
to the extent that it includes a convenient and prominently visible
115
feature that (1) displays an appropriate copyright notice, and (2)
116
tells the user that there is no warranty for the work (except to the
117
extent that warranties are provided), that licensees may convey the
118
work under this License, and how to view a copy of this License.  If
119
the interface presents a list of user commands or options, such as a
120
menu, a prominent item in the list meets this criterion.</p>
121

  
122
<h4><a name="section1"></a>1. Source Code.</h4>
123

  
124
<p>The “source code” for a work means the preferred form of the work
125
for making modifications to it.  “Object code” means any non-source
126
form of a work.</p>
127

  
128
<p>A “Standard Interface” means an interface that either is an official
129
standard defined by a recognized standards body, or, in the case of
130
interfaces specified for a particular programming language, one that
131
is widely used among developers working in that language.</p>
132

  
133
<p>The “System Libraries” of an executable work include anything, other
134
than the work as a whole, that (a) is included in the normal form of
135
packaging a Major Component, but which is not part of that Major
136
Component, and (b) serves only to enable use of the work with that
137
Major Component, or to implement a Standard Interface for which an
138
implementation is available to the public in source code form.  A
139
“Major Component”, in this context, means a major essential component
140
(kernel, window system, and so on) of the specific operating system
141
(if any) on which the executable work runs, or a compiler used to
142
produce the work, or an object code interpreter used to run it.</p>
143

  
144
<p>The “Corresponding Source” for a work in object code form means all
145
the source code needed to generate, install, and (for an executable
146
work) run the object code and to modify the work, including scripts to
147
control those activities.  However, it does not include the work's
148
System Libraries, or general-purpose tools or generally available free
149
programs which are used unmodified in performing those activities but
150
which are not part of the work.  For example, Corresponding Source
151
includes interface definition files associated with source files for
152
the work, and the source code for shared libraries and dynamically
153
linked subprograms that the work is specifically designed to require,
154
such as by intimate data communication or control flow between those
155
subprograms and other parts of the work.</p>
156

  
157
<p>The Corresponding Source need not include anything that users
158
can regenerate automatically from other parts of the Corresponding
159
Source.</p>
160

  
161
<p>The Corresponding Source for a work in source code form is that
162
same work.</p>
163

  
164
<h4><a name="section2"></a>2. Basic Permissions.</h4>
165

  
166
<p>All rights granted under this License are granted for the term of
167
copyright on the Program, and are irrevocable provided the stated
168
conditions are met.  This License explicitly affirms your unlimited
169
permission to run the unmodified Program.  The output from running a
170
covered work is covered by this License only if the output, given its
171
content, constitutes a covered work.  This License acknowledges your
172
rights of fair use or other equivalent, as provided by copyright law.</p>
173

  
174
<p>You may make, run and propagate covered works that you do not
175
convey, without conditions so long as your license otherwise remains
176
in force.  You may convey covered works to others for the sole purpose
177
of having them make modifications exclusively for you, or provide you
178
with facilities for running those works, provided that you comply with
179
the terms of this License in conveying all material for which you do
180
not control copyright.  Those thus making or running the covered works
181
for you must do so exclusively on your behalf, under your direction
182
and control, on terms that prohibit them from making any copies of
183
your copyrighted material outside their relationship with you.</p>
184

  
185
<p>Conveying under any other circumstances is permitted solely under
186
the conditions stated below.  Sublicensing is not allowed; section 10
187
makes it unnecessary.</p>
188

  
189
<h4><a name="section3"></a>3. Protecting Users' Legal Rights From Anti-Circumvention Law.</h4>
190

  
191
<p>No covered work shall be deemed part of an effective technological
192
measure under any applicable law fulfilling obligations under article
193
11 of the WIPO copyright treaty adopted on 20 December 1996, or
194
similar laws prohibiting or restricting circumvention of such
195
measures.</p>
196

  
197
<p>When you convey a covered work, you waive any legal power to forbid
198
circumvention of technological measures to the extent such circumvention
199
is effected by exercising rights under this License with respect to
200
the covered work, and you disclaim any intention to limit operation or
201
modification of the work as a means of enforcing, against the work's
202
users, your or third parties' legal rights to forbid circumvention of
203
technological measures.</p>
204

  
205
<h4><a name="section4"></a>4. Conveying Verbatim Copies.</h4>
206

  
207
<p>You may convey verbatim copies of the Program's source code as you
208
receive it, in any medium, provided that you conspicuously and
209
appropriately publish on each copy an appropriate copyright notice;
210
keep intact all notices stating that this License and any
211
non-permissive terms added in accord with section 7 apply to the code;
212
keep intact all notices of the absence of any warranty; and give all
213
recipients a copy of this License along with the Program.</p>
214

  
215
<p>You may charge any price or no price for each copy that you convey,
216
and you may offer support or warranty protection for a fee.</p>
217

  
218
<h4><a name="section5"></a>5. Conveying Modified Source Versions.</h4>
219

  
220
<p>You may convey a work based on the Program, or the modifications to
221
produce it from the Program, in the form of source code under the
222
terms of section 4, provided that you also meet all of these conditions:</p>
223

  
224
<ul>
225
<li>a) The work must carry prominent notices stating that you modified
226
    it, and giving a relevant date.</li>
227

  
228
<li>b) The work must carry prominent notices stating that it is
229
    released under this License and any conditions added under section
230
    7.  This requirement modifies the requirement in section 4 to
231
    “keep intact all notices”.</li>
232

  
233
<li>c) You must license the entire work, as a whole, under this
234
    License to anyone who comes into possession of a copy.  This
235
    License will therefore apply, along with any applicable section 7
236
    additional terms, to the whole of the work, and all its parts,
237
    regardless of how they are packaged.  This License gives no
238
    permission to license the work in any other way, but it does not
239
    invalidate such permission if you have separately received it.</li>
240

  
241
<li>d) If the work has interactive user interfaces, each must display
242
    Appropriate Legal Notices; however, if the Program has interactive
243
    interfaces that do not display Appropriate Legal Notices, your
244
    work need not make them do so.</li>
245
</ul>
246

  
247
<p>A compilation of a covered work with other separate and independent
248
works, which are not by their nature extensions of the covered work,
249
and which are not combined with it such as to form a larger program,
250
in or on a volume of a storage or distribution medium, is called an
251
“aggregate” if the compilation and its resulting copyright are not
252
used to limit the access or legal rights of the compilation's users
253
beyond what the individual works permit.  Inclusion of a covered work
254
in an aggregate does not cause this License to apply to the other
255
parts of the aggregate.</p>
256

  
257
<h4><a name="section6"></a>6. Conveying Non-Source Forms.</h4>
258

  
259
<p>You may convey a covered work in object code form under the terms
260
of sections 4 and 5, provided that you also convey the
261
machine-readable Corresponding Source under the terms of this License,
262
in one of these ways:</p>
263

  
264
<ul>
265
<li>a) Convey the object code in, or embodied in, a physical product
266
    (including a physical distribution medium), accompanied by the
267
    Corresponding Source fixed on a durable physical medium
268
    customarily used for software interchange.</li>
269

  
270
<li>b) Convey the object code in, or embodied in, a physical product
271
    (including a physical distribution medium), accompanied by a
272
    written offer, valid for at least three years and valid for as
273
    long as you offer spare parts or customer support for that product
274
    model, to give anyone who possesses the object code either (1) a
275
    copy of the Corresponding Source for all the software in the
276
    product that is covered by this License, on a durable physical
277
    medium customarily used for software interchange, for a price no
278
    more than your reasonable cost of physically performing this
279
    conveying of source, or (2) access to copy the
280
    Corresponding Source from a network server at no charge.</li>
281

  
282
<li>c) Convey individual copies of the object code with a copy of the
283
    written offer to provide the Corresponding Source.  This
284
    alternative is allowed only occasionally and noncommercially, and
285
    only if you received the object code with such an offer, in accord
286
    with subsection 6b.</li>
287

  
288
<li>d) Convey the object code by offering access from a designated
289
    place (gratis or for a charge), and offer equivalent access to the
290
    Corresponding Source in the same way through the same place at no
291
    further charge.  You need not require recipients to copy the
292
    Corresponding Source along with the object code.  If the place to
293
    copy the object code is a network server, the Corresponding Source
294
    may be on a different server (operated by you or a third party)
295
    that supports equivalent copying facilities, provided you maintain
296
    clear directions next to the object code saying where to find the
297
    Corresponding Source.  Regardless of what server hosts the
298
    Corresponding Source, you remain obligated to ensure that it is
299
    available for as long as needed to satisfy these requirements.</li>
300

  
301
<li>e) Convey the object code using peer-to-peer transmission, provided
302
    you inform other peers where the object code and Corresponding
303
    Source of the work are being offered to the general public at no
304
    charge under subsection 6d.</li>
305
</ul>
306

  
307
<p>A separable portion of the object code, whose source code is excluded
308
from the Corresponding Source as a System Library, need not be
309
included in conveying the object code work.</p>