PicGIM 0.5 documentation    
Copyright (C) 2002, 2013 - [AsYntote-SkyMatrix] gKript.org    
Generated on Sun Apr 26 2015 11:03:34 with DoxyGen 1.8.8    
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Pages
PicGIM Documentation




PicGIM - Generic Information Manager

for Microchip PIC18® microcontrollers


PicGIM is a part of project


Introduction

PicGIM Documentation Milestone 0.5

gKript.org © Copyright 2002, 2014
Danilo Zannoni (AsYntote) - Corrado Tumiati (SkyMatrix)
PicGIM is part of We.PIC project by gKript.org.

Licenses

We.PIC project is under the terms of GNU General Public License v3

          

Reffer to Gnu license


GNU FDL Version 1.3

Copyright (C)  2014  gKript.org
    Permission is granted to copy, distribute and/or modify this document
    under the terms of the GNU Free Documentation License, Version 1.3
    or any later version published by the Free Software Foundation;
    with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts.
    A copy of the license is included in the section entitled "GNU
    Free Documentation License".
    
Here the link : GNU Free Documentation License



What is PicGIM

PicGIM is a "modular library from scratch".
PicGIM is developed to work with PIC18F MCU family only and with C18 compiler.
PicGIM will compile only the modules enabled.
Through a set of public files, you can configure PicGIM molding it to your project having the most help in programming with a minimum amount of program memory and ram.
Compiling PicGIM only with compulsory modules only takes about 250 bytes of program memory.
It is compatible with Microchip MPLAB 8 and with the new Microchip MPLAB X.
One of the advantages of PicGIM is just to work with a MICROCHIP STANDARD ENVIRONMENT.
You are completely free with PicGIM.
You can choose to use totally or partially the support provided by PicGIM.
Each module of PicGIM can be replaced by personal libraries.

    Anyone is free to contribute to the development of PicGIM.
    For improvements, corrections, or to extend hardware support, please contact us at this email : info@.nosp@m.gkri.nosp@m.pt.or.nosp@m.g



What is PicGIM for

PicGIM is essential in a project in order to dedicate all available time only to the main algorithm.
So you no longer have to think about the management of timers, pwm or display, and even interrupts.
Through this clear documentation you will know the full potential of PicGIM.
What remains is to configure PicGIM carefully to get the best possible result.


Whom is PicGIM for

PicGIM has been designed and developed for anyone.
A beginner or a professional can find advantage to use PicGIM.
The beginner will certainly have an huge advantage on the simplicity of the code.
An experienced user instead will enjoy the power of PicGIM saving a lot of time for the development of the project.


Start in a few steps

In this section you can find all the details in three easy steps for starting a new PicGIM project.

To obtain a copy of PicGIM simply download it from www.gkript.org.
Once downloaded, please refer to this guide: A PicGIM release

First step is to plan: choose the right components for the hardware is crucial for the success of a project.
This documentation provides detailed resource consumption by PicGIM: Planning a new project with PicGIM

Second step is the configuration: Enable the required modules and configure them according to the hardware is easy with PicGIM.
To know how to configure the work environment, the compiler and the library is necessary to follow this section of the documentation: Getting Started

Third and last step writing code: Here is in detail each function and reorganization that makes easy to write their own code.
From the types of variables, by useful macros and the more complex functions.
Everything is commented. He who seeks finds! especially here: The language of PicGIM and Modules


PicGIM is on GitHub



We chose GitHub as a development platform for the version control system as well as issue tracking tool.
Here is the link for the repository of PicGIM : PicGIM Repository


PicGIM changelog

The developer should never underestimate the importance of the changelog.
From it you can understand the various issues already addressed and confirm new issues.
You can know exactly everything that has been developed.
The complete PicGIM changelog is available here: ChangeLog

Note
The changelog of this milestone is almost all in Italian.


This documentation

This documentation is part of We.DOC project.



This documentation is made with Doxygen [ http://www.doxygen.org/ ].
The version of this documentation is 0.5 .
If you find error or you think there is need more precision in some point, please write us here [ info@.nosp@m.gkri.nosp@m.pt.or.nosp@m.g ].
The license references for this documentation can be found here: We.DOC documentation license


Trademarks

All trademarks in this work are registered by their respective owners.
All trademarks in this work are property of their respective owners.