PIC24 Support Libraries
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
mainpage.h
1 /*
2  * "Copyright (c) 2008 Robert B. Reese, Bryan A. Jones, J. W. Bruce ("AUTHORS")"
3  * All rights reserved.
4  * (R. Reese, reese_AT_ece.msstate.edu, Mississippi State University)
5  * (B. A. Jones, bjones_AT_ece.msstate.edu, Mississippi State University)
6  * (J. W. Bruce, jwbruce_AT_ece.msstate.edu, Mississippi State University)
7  *
8  * Permission to use, copy, modify, and distribute this software and its
9  * documentation for any purpose, without fee, and without written agreement is
10  * hereby granted, provided that the above copyright notice, the following
11  * two paragraphs and the authors appear in all copies of this software.
12  *
13  * IN NO EVENT SHALL THE "AUTHORS" BE LIABLE TO ANY PARTY FOR
14  * DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING OUT
15  * OF THE USE OF THIS SOFTWARE AND ITS DOCUMENTATION, EVEN IF THE "AUTHORS"
16  * HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
17  *
18  * THE "AUTHORS" SPECIFICALLY DISCLAIMS ANY WARRANTIES,
19  * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY
20  * AND FITNESS FOR A PARTICULAR PURPOSE. THE SOFTWARE PROVIDED HEREUNDER IS
21  * ON AN "AS IS" BASIS, AND THE "AUTHORS" HAS NO OBLIGATION TO
22  * PROVIDE MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS."
23  *
24  * Please maintain this header in its entirety when copying/modifying
25  * these files.
26  *
27  *
28  */
29 
30 /* Documentation placed on the main page. This file only
31  include comments for Doxygen; it does not contain any
32  code.
33 
34  NOTE: This page must be manually synchronized with
35  http://www.reesemicro.com/Home/pic24-software-library-collection.
36  Make sure any edits there are reflected here and vice versa!
37 */
38 
39 
40 
41 /**
42 \mainpage
43 The latest version of this document is located
44 <a href="http://www.reesemicro.com/Home/pic24-software-library-collection">here</a>.
45 
46 
47 \section internalWelcome PIC24 library collection
48 Welcome to the PIC24 library collection! This \ref PIC24_support "library"
49 (the latest version is
50 <a href="http://www.ece.msstate.edu/courses/ece3724/main_pic24/labs/files/pic24_code_examples.zip">here</a>),
51 accompanied by detailed explanations in the
52 <a href="http://www.reesemicro.com/Home/textbook">textbook</a>,
53 supplemented with numerous real-world \ref textbookExamples "examples", and
54 accompanied by extensive on-line documentation given below,
55 enable developers to take advantage of the wide range of peripherals offered by the PIC24.
56 The collection consists of the
57 <a href="http://www.reesemicro.com/Home/pic24-software-library-collection/getting-started">getting
58 started guide</a>; the \ref PIC24_support "PIC24 support library"; and
59 \ref ESOS, the Embedded Systems Operating System.
60 
61 \section internalStarted Getting started
62 The
63 <a href="http://www.reesemicro.com/Home/pic24-software-library-collection/getting-started">getting
64 started</a> page walks newcomers through the first step in developing for the PIC24:
65 installing software and obtaining necessary hardware. Next, \ref textbookExamples "examples" introduce use of the libraries below.
66 Finally, documentation below provides a detailed reference to each of the library's operation.
67 
68 
69 \section internalSupport PIC24 support library
70 The \ref PIC24_support "PIC24 support library" supports all the major subsystems of the PIC24:
71 clock configuration, configuration bits, delays, interrupts,
72 digital I/O, timers, serial I/O, SPI, I2C, ECAN, comparators, A/D conversion, FLASH reads/writes, and DMA.
73 An extensive set of \ref textbookExamples "examples" accompanying the library provide working sample code to guide newcomers to using the library.
74 
75 
76 \section internalESOS ESOS
77 \ref ESOS, the Embedded Systems Operating System, is a cooperative multitasking operating system with
78 very low memory overhead. ESOS is a task-driven programming paradigm within an event-driven framework.
79 ESOS gives the user timer, interrupt, and communication services commonly needed in embedded systems programs.
80 
81 
82 \section internalLicense License and history
83 These libraries are released under terms given in the \ref License "license".
84 The \ref history "history" document records changes made to the library collection.
85 */