Statistics
| Branch: | Tag: | Revision:

amiro-os / README.txt @ 10687985

History | View | Annotate | Download (7.833 KB)

1 58fe0e0b Thomas Schöpping
AMiRo-OS is the operating system for the base version of the
2
Autonomous Mini Robot (AMiRo) [1,2]. It utilizes ChibiOS (a real-time
3
operating system for embedded devices developed by Giovanni di Sirio;
4
see <http://chibios.org>) as system kernel and extends it with
5
platform specific functionalities.
6
7
Copyright (C) 2016  Thomas Schöpping et al.
8
(a complete list of all authors is given below)
9
10
This program is free software: you can redistribute it and/or modify
11
it under the terms of the GNU General Public License as published by
12
the Free Software Foundation, either version 3 of the License, or (at
13
your option) any later version.
14
15
This program is distributed in the hope that it will be useful, but
16
WITHOUT ANY WARRANTY; without even the implied warranty of
17
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
18
General Public License for more details.
19
20
You should have received a copy of the GNU General Public License
21
along with this program.  If not, see <http://www.gnu.org/licenses/>.
22
23 074e10d7 Thomas Schöpping
This research/work was supported by the Cluster of Excellence
24
Cognitive Interaction Technology 'CITEC' (EXC 277) at Bielefeld
25
University, which is funded by the German Research Foundation (DFG).
26 58fe0e0b Thomas Schöpping
27
Authors:
28
 - Thomas Schöpping        <tschoepp[at]cit-ec.uni-bielefeld.de>
29
 - Timo Korthals           <tkorthals[at]cit-ec.uni-bielefeld.de>
30
 - Stefan Herbechtsmeier   <sherbrec[at]cit-ec.uni-bielefeld.de>
31
 - Teerapat Chinapirom     <tchinapirom[at]cit-ec.uni-bielefeld.de>
32
 - Robert Abel
33
 - Marvin Barther
34
 - Claas Braun
35
 - Tristan Kenneweg
36
37
References:
38
 [1] Herbrechtsmeier S., Rückert U., & Sitte J. (2012). "AMiRo -
39
     Autonomous Mini Robot for Research and Education". In Advances in
40
     Autonomous Mini Robots (pp. 101-112). Springer Berlin
41
     Heidelberg.
42
 [2] Schöpping T., Korthals T., Herbrechtsmeier S., & Rückert U.
43
     (2015). "AMiRo: A Mini Robot for Scientific Applications" In
44
     Advances in Computational Intelligence (pp. 199-205). Springer
45
     International Publishing.
46
47
48
49
#####################################################################
50
#                                                                   #
51
#     RRRRRRRR  EEEEEEEE    AAA    DDDDDDDD  MM     MM EEEEEEEE     #
52
#     RR     RR EE         AA AA   DD     DD MMM   MMM EE           #
53
#     RR     RR EE        AA   AA  DD     DD MMMM MMMM EE           #
54
#     RRRRRRRR  EEEEEE   AA     AA DD     DD MM MMM MM EEEEEE       #
55
#     RR   RR   EE       AAAAAAAAA DD     DD MM     MM EE           #
56
#     RR    RR  EE       AA     AA DD     DD MM     MM EE           #
57
#     RR     RR EEEEEEEE AA     AA DDDDDDDD  MM     MM EEEEEEEE     #
58
#                                                                   #
59
#####################################################################
60
61
This file will help you to setup all required software on your system,
62
compile the source code, and flash it to the AMiRo modules.
63
64
=====================================================================
65
66
CONTENTS:
67
 1  Required software
68
   1.1  gcc-arm-none-eabi
69
   1.2  ChibiOS
70
   1.3  AMiRo-BLT
71
 2  Recommended software
72
   2.1  gtkterm and hterm
73
   2.2  QtCreator
74
 3  Building and flashing
75
76
=====================================================================
77
78
1 - REQUIRED SOFTWARE
79
---------------------
80
81
In order to compile the source code, you need to install the GCC for
82
ARM embedded devices. Since AMiRo-OS requires ChibiOS as system
83
kernel, you need a copy of that project as well. Furthermore, AMiRo-OS
84
requires a compatible bootloader, such as provided by the AMiRo-BLT
85
project.
86
87
1.1 gcc-arm-none-eabi
88
89
Various versions of the GCC for ARM embedded devices can be found at
90
<https://launchpad.net/gcc-arm-embedded>. It is highly recommended to
91
use the version 4.8 with update 2014-q1 since some others will cause
92
issues. For installation of the compiler toolchain, please follow the
93
instructions that can be found on the web page.
94
95
1.2 ChibiOS
96
97
Since AMiRo-OS uses ChibiOS as underlying system kernel, you need to
98
acquire a copy of it as well. First, go to the directory which
99
contains the AMiRo-OS folder (but do not go into the AMiRo-OS
100
directory itself!). Now clone the GIT repository of ChibiOS and
101
checkout version 2.6.x:
102
  >$ git clone https://github.com/ChibiOS/ChibiOS.git ChibiOS
103
  >$ cd ChibiOS
104
  >$ git checkout 2e6dfc7364e7551483922ea6afbaea8f3501ab0e
105
It is highly recommended to use exactly this commit. Although newer
106
commits in the 2.6.x branch might work fine, AMiRo-OS is not
107
compatible with ChibiOS version 3 or newer.
108
109
AMiRo-OS comes with some patches to ChibiOS, which must be applied as
110
well before compiling the project. Therefore you need to copy all
111
files from the ./patches directory of AMiRo-OS to the root directory
112
of ChibiOS. You can then apply the patches via the following command:
113
  >$ for i in `ls | grep patch`; do git am --ignore-space-change --ignore-whitespace < ${i}; done
114
If the files could not be patched successfully, you are probably using
115
an incompatible version of ChibiOS (try to checkout the correct commit
116
as denoted above).
117
118
1.3 AMiRo-BLT
119
120
AMiRo-BLT is an additional software project, which is developed in
121
parallel with AMiRo-OS. If you did not receive a copy of AMiRo-BLT
122
with AMiRo-OS, you can find all code and documentation at
123
<https://opensource.cit-ec.de/projects/amiro-os>. Instructions for
124
installation and how to use the software provided by AMiRo-BLT can be
125
found on the web page or in the project's readme file.
126
127
2 - RECOMMENDED SOFTWARE
128
------------------------
129
130
In order to fully use all features of AMiRo-OS it is recommended to
131
install the 'hterm' or 'gtkterm' application for accessing the robot.
132
To ease further development, this project offers support for the 
133
QtCreator IDE.
134
135
2.1 - gtkterm and hterm
136
137
Depending on your operating system, it is recommended to install
138
'gtkterm' for Linux (available in the Ubuntu repositories), or 'hterm'
139
for Windows.
140
For gtkterm you need to modify the configuration file ~/.gtktermrc (it
141
is generated automatically when you start the application for the
142
first time) as follows:
143
144
  port	= /dev/ttyUSB0
145
  speed	= 115200
146
  bits	= 8
147
  stopbits	= 1
148
  parity	= none
149
  flow	= none
150
  wait_delay	= 0
151
  wait_char	= -1
152
  rs485_rts_time_before_tx	= 30
153
  rs485_rts_time_after_tx	= 30
154
  echo	= False
155
  crlfauto	= True
156
157
For hterm you must need to configure the tool analogously.
158
159
2.2 - QtCreator
160
161
In order to setup QtCreator projects for the three AMiRo base modules,
162
a script is provided in the directory ./ide/qtcreator/. It is
163
accompanied by an additional README.txt file, which contains further
164
information.
165
166
3 - BUILDING AND FLASHING
167
-------------------------
168
169
Each time you modify any part of AMiRo-OS, you need to recompile the
170
whole project for the according AMiRo module. Therefore you have to
171
use the makefiles provided in ./devices/<DeviceToRecompile>/ by simply
172
executing 'make' in the according directory. If you want to compile
173
all modules at once, you can also use the makefile in the ./devices/
174
folder.
175
176
After compilation, you always have to flash the generated program to
177
the robot. Therefore you need to install the SerialBoot tool provided
178
by the AMiRo-BLT project. Furthermore the tool must be accessible
179
globally under the environment variable 'SERIALBOOT'. You can do this
180
by appending the following line to your ~/.bashrc file:
181
182
  export SERIALBOOT=</absolute/path/to/the/SerialBoot/binary>
183
184
You can test the tool by calling it via the variable:
185
  >$ ${SERIALBOOT}
186
This should print some information about the tool.
187
Similar to the compilation procedure as described above, you can flash
188
either each module separately, or all modules at once by executing
189
'make flash' from the according directory.
190
Note that you must connect the programming cable either to the
191
DiWheelDrive or the PowerManagement module for flashing the operating
192
system. All other modules are powered off after reset so that only
193
these two offer a bootloader that is required for flashing.
194
195
=====================================================================