Skip to content

Commit dbbaf81

Browse files
committed
Edited the main doxygen page.
1 parent 189db98 commit dbbaf81

File tree

1 file changed

+29
-61
lines changed

1 file changed

+29
-61
lines changed

mainpage.dox

Lines changed: 29 additions & 61 deletions
Original file line numberDiff line numberDiff line change
@@ -2,68 +2,36 @@
22

33
@section sec_intro Introduction
44

5-
This is the documentation for the \c libbarrett robot control library, written
6-
and maintained by Barrett Technology, Inc. For more details about the
7-
library, see the development page at <http://wiki.barrett.com/libbarrett>.
8-
For questions, send an email to <support@barrett.com>.
9-
10-
@section sec_modules Modules
11-
12-
The \c libbarrett library is composed of two main parts that are in the process
13-
of being reconciled:
14-
- a C library dubbed \c cdlbt that handles CAN communication, real-time
15-
execution, kinematics, dynamics, and lots of other things
16-
- a C++ library that allows users to compose the main-loop of the control
17-
thread for their application.
18-
19-
@subsection subsec_cdlbt cdlbt Library Overview
20-
The \c cdlbt library is separated into several modules, that look like this:
21-
22-
@dot
23-
digraph modules {
24-
node [shape=box, fontname=FreeSans, fontsize=9];
25-
bt_wam -> bt_control -> bt_dynamics;
26-
bt_control -> bt_kinematics;
27-
bt_control -> bt_gsl;
28-
bt_wam -> bt_refgen -> bt_kinematics;
29-
bt_refgen -> bt_spline -> bt_interp;
30-
bt_refgen -> bt_profile;
31-
bt_refgen -> bt_log;
32-
bt_wam -> bt_dynamics -> bt_kinematics;
33-
bt_wam -> bt_gravity -> bt_kinematics;
34-
bt_wam -> bt_kinematics;
35-
bt_wam -> bt_log;
36-
bt_wam -> bt_os;
37-
bt_wam -> bt_wambot -> bt_bus -> bt_os;
38-
bt_discover;
39-
bt_rpc;
40-
}
41-
@enddot
42-
43-
44-
@subsection subsec_mainloop Main-loop Library Overview
45-
The main-loop library allows users to construct a main-loop by describing a block-diagram; the blocks are called \ref barrett::systems::System "System"s, and the lines representing information flow are formed by \ref barrett::systems::connect() "connect"ing \ref barrett::systems::System::Output "System::Output"s to \ref barrett::systems::System::Input "System::Input"s. In other words, \ref barrett::systems::System "System"s are where the processing happens, and \ref barrett::systems::System::Input "System::Input"s and \ref barrett::systems::System::Output "System::Output"s are the pipes through which data flows into and out of a \ref barrett::systems::System "System" (respectively).
46-
47-
Each \ref barrett::systems::System::Input "System::Input" and \ref barrett::systems::System::Output "System::Output" can transmit any one type of data. That data type is specified at compile-time with a template parameter. Only \ref barrett::systems::System::Input "System::Input"s and \ref barrett::systems::System::Output "System::Output"s that transmit the same type of data can be \ref barrett::systems::connect() "connect"ed together. A \ref barrett::systems::System "System" can have any number of \ref barrett::systems::System::Input "System::Input"s and \ref barrett::systems::System::Output "System::Output"s.
48-
49-
Additionally, the library provides a mechanism to label \ref barrett::math::Vector "Vector"s of doubles with "units" in order to increase code clarity. (The built-in units classes are found in the barrett::units namespace.) Such \ref barrett::math::Vector "Vector"s can take advantage of a collection of arithmetic operators and \ref math/utils.h "math utilities". For these reasons, classes in the barrett::units namespace are often the data-types of choice for \ref barrett::systems::System::Input "System::Input"s and \ref barrett::systems::System::Output "System::Output"s.
50-
51-
Key sections of documentation describing the C++ main-loop library are:
52-
- barrett::systems::System
53-
- barrett::systems::System::Input
54-
- barrett::systems::System::Output
55-
- barrett::units
56-
57-
@section sec_using Using libbarrett in Your Programs
58-
59-
There are several example programs in the \c examples directory.
60-
61-
@section sec_license License Notes
62-
63-
See <http://wiki.barrett.com/libbarrett/wiki/LicenseNotes> for more details.
64-
5+
This is the documentation for the \c libbarrett real-time controls library,
6+
written and maintained by Barrett Technology, Inc. Libbarrett is written in C++
7+
and runs Barrett Technology's products, including the WAM Arm and the BH8-280
8+
BarrettHand. For further information, see the documentation at:
9+
http://support.barrett.com/wiki/Libbarrett
10+
11+
The best way to get started with libbarrett is by reading and experimenting with
12+
the programs in the \c examples directory.
13+
14+
The library provides both a high-level interface (initialize the Hand, move the
15+
WAM to a position in joint-space, etc.) and a low-level interface (for
16+
performing torque calculations in hard real-time).
17+
18+
This version of libbarrett is free software: you can redistribute it and/or
19+
modify it under the terms of the GNU General Public License as published by the
20+
Free Software Foundation.
21+
22+
Contact us at:
23+
<pre>
24+
support@barrett.com
25+
http://www.barrett.com/
26+
+1-617-252-9000
27+
28+
Barrett Technology
29+
625 Mount Auburn Street
30+
Cambridge, MA 02138
31+
USA
32+
</pre>
6533
*/
6634

6735
/** @namespace barrett
6836
The root namespace for libbarrett.
69-
*/
37+
*/

0 commit comments

Comments
 (0)