peripherals  1.4.2
RoadNarrows Robotics Hardware Peripherals Package
main.doxy
Go to the documentation of this file.
1 ////////////////////////////////////////////////////////////////////////////////
2 //
3 // Package: RoadNarrows Peripherals Library
4 //
5 // File: main.doxy
6 //
7 // Description:
8 // This file contains the doxygen directives to generate the main page.
9 //
10 ////////////////////////////////////////////////////////////////////////////////
11 
12 /*! \file */
13 
14 /*! \mainpage RoadNarrows Robotics Peripherals Package
15 
16 \section intro Introduction
17 
18 The peripherals package provides a set of base libraries for peripheral
19 components that may be shared accross multiple RoadNarrows Products
20 (e.g. Xbox360 controllers, IMUs, etc).
21 
22 \section pkglist Package List
23 <dl>
24 <dt> \b libhid </dt>
25  <dd>
26  A collection of functions to interface with Human Interface Devices
27  (e.g. Xbox360, keyboard and mouse, wiiMote, etc).
28  </dd>
29 <dt> \b libimu </dt>
30  <dd>
31  A collection of functions for working with Inertial Measurement Unts
32  (e.g. yost).
33  </dd>
34 <dt> \b libmotor </dt>
35  <dd>
36  A collection of functions for working with motor controllers.
37  (e.g. yost).
38  </dd>
39 </dl>
40 </dl>
41 
42 \section req Requirements
43 \b librnr - RNR standard libray 1.
44 \b libserail - RNR serial interface library.
45 
46 \section platforms Supported Platforms
47 \li i386 - any Linux Intel (backwards) compatible 32-bit architecures
48 \li x86_64 - any Linux AMD 64-bit architectures
49 \li overo - Linux Texas Intruments OMAP architectures.
50 
51 \section tested Tested Systems
52 \li Ubuntu 12.04 Linux for the i386 and x86_64 architectures.
53 \li Anstrom Linux for OMAP architectures.
54 
55 \page page_eula EULA
56 \section eula_txt RoadNarrows Robotics Peripherals Package End User Licence
57 Agreement
58 
59 \subsection eula_permissions Permissions
60 Permission is hereby granted, without written agreement and without
61 license or royalty fees, to use, copy, modify, and distribute this
62 software and its documentation for any purpose, provided that
63 (1) The above copyright notice and the following two paragraphs
64 appear in all copies of the source code and (2) redistributions
65 including binaries reproduces these notices in the supporting
66 documentation. Substantial modifications to this software may be
67 copyrighted by their authors and need not follow the licensing terms
68 described here, provided that the new terms are clearly indicated in
69 all files where they apply.
70 
71 \subsection eula_warranties Warranties
72 In no event shall the author, RoadNarrows Robotics or any members/employees
73 of RoadNarrows Robotics or distributors of this software be liable to any
74 party for direct, indirect, special, incidental, or consequential
75 damages arising out of the use of this software and its documentation,
76 even if the authors or any of the above parties have been advised of
77 the possibility of such damage.
78 
79 The author and RoadNarrows Robotics specifically disclaim any warranties,
80 including, but not limited to, the implied warranties of merchantability anD
81 fitness for a particular purpose. the software provided hereunder is on an
82 "as is" basis, and the authors and distributors have no obligation tO
83 provide maintenance, support, updates, enhancements, or modifications.
84 
85 \subsection eula_copyright Copyright
86 All Rights Reserved by RoadNarrows Robotics
87 \n (C) 2012-2013
88 \n http://www.roadnarrows.com
89 
90 */