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! These downloadable libraries are
49 available in two versions:
50 - The <a href="http://www.ece.msstate.edu/courses/ece3724/main_pic24/labs/files/pic24_code_examples.zip">latest version</a>
51  that uses MPLAB X and is currently in flux as of August 2013 as it is being
52  modified for a second edition of the textbook. The base device for projects in
53  this library is the dsPIC33EP128GP502 (which is pin and function compatible
54  with the PIC24EP128GP202). Modifications to this library will be completed by
55  May 2014.
56 - A <a href="http://www.ece.msstate.edu/courses/ece3724/main_pic24/labs/files/pic24_code_examples_mplab8.zip">frozen version</a>
57  consisting of the last library snapshot before the move to MPLAB X; this
58  version uses MPLAB 8 and matches what is in the first edition of the textbook
59  (the base device is the PIC24HJ64GP202).
60 
61 The libraries are compatible with most devices in the PIC24E/H/F and dsPIC33E/F
62 families. These libraries are accompanied by detailed explanations in the
63 <a href="http://www.reesemicro.com/Home/textbook">textbook</a>,
64 supplemented with numerous real-world <a href="sphinx/textbook_examples.html">examples</a>,
65 and accompanied by extensive on-line documentation given below, enable
66 developers to take advantage of the wide range of peripherals offered by the
67 PIC24. The collection consists of the
68 <a href="http://www.reesemicro.com/Home/pic24-software-library-collection/getting-started">getting
69 started guide</a>; the \ref PIC24_support "PIC24 support library"; and
70 \ref ESOS "ESOS", the Embedded Systems Operating System.
71 
72 
73 \section internalStarted Getting started
74 The
75 <a href="http://www.reesemicro.com/Home/pic24-software-library-collection/getting-started">getting
76 started</a> page walks newcomers through the first step in developing for the PIC24:
77 installing software and obtaining necessary hardware. Next, <a href="sphinx/textbook_examples.html">examples</a> introduce use of the libraries below.
78 Finally, documentation below provides a detailed reference to each of the library's operation.
79 
80 
81 \section internalSupport PIC24 support library
82 The \ref PIC24_support "PIC24 support library" supports all the major subsystems
83 of the PIC24: clock configuration, configuration bits, delays, interrupts,
84 digital I/O, timers, serial I/O, SPI, I2C, ECAN, comparators, A/D conversion,
85 FLASH reads/writes, and DMA. An extensive set of
86 <a href="sphinx/textbook_examples.html">examples</a> accompanying the library
87 provide working sample code to guide newcomers to using the library.
88 
89 
90 \section internalESOS ESOS
91 \ref ESOS "ESOS", the Embedded Systems Operating System, is a cooperative multitasking operating system with
92 very low memory overhead. ESOS is a task-driven programming paradigm within an event-driven framework.
93 ESOS gives the user timer, interrupt, and communication services commonly needed in embedded systems programs.
94 
95 
96 \section feedback Feedback
97 To report bugs, request features, or made contributions, use the
98 <a href="https://bitbucket.org/bjones/pic24lib_all">Bitbucket
99 repository</a>.
100 
101 \section internalLicense License and history
102 These libraries are released under terms given in the \ref License "license".
103 The \ref history "history" document records changes made to the library collection.
104 */