Description

The PIC18 API, part of the M8M APIs package, is a piece of software developed at #Firmware Engineers for the #IoT Solution Demo project. This API will be used to control the IoT devices based on a PIC18 microcontroller. The map diagram below shows the essential part of this software.

Prerequisites

To use this software you need to:

• Install MPLAB X IDE: https://www.microchip.com/en-us/tools-resources/archives/mplab-ecosystem
• C compiler for PIC 18 microcontrollers (ex. XC8): https://www.microchip.com/en-us/tools-resources/archives/mplab-ecosystem
• Doxygen generator, to generate documentation from source code (optional): https://www.doxygen.nl/download.html

Note:

This API is being developed using:
- MPLAB X IDE V5.30
- XC8 V1.45, V2.36

Usage

This software can be included in any project that uses the PIC18 controller. Just include in the source file the header (.h) file corresponding to the peripheral or library to use, as well as all the associated dependencies (Including library files). All the codes are self documenting and all information required to used the software is specified within. To use the external interrupt input 0 (INT0) for example to generate an interrupt at every RISING edge, here's the source code:

In main.c file :

// Include dependencies
#include "../Inc/GPIO.h"
#include "../Inc/Interrupts.h"
#include "../Inc/PIC18Types.h"

main()
{	
	// User code
	
	ConfigType cfg;
	cfg.grp1 = MCU_INT_ENABLE | INT0_INT_ENABLE;                    // Enables interrupts using setting from INTERRUPT_EN_DIS_CONSTANTS_GROUP1
	cfg.grp2 = 0;                   								// Enables interrupts using setting from INTERRUPT_EN_DIS_CONSTANTS_GROUP2
	cfg.grp3 = 0;                                                   // No changes
	cfg.grp4 = 0;          											// No changes
	InterruptEnable(cfg);
	
    SetINTxEdgeRising(INT0_INT_EDGE);                             	// Generate interrupts on every rising edge on INT0 
    
	// User code
	
    while(1)
    {
        
		// User code
			
    }
 }

In ISR.c file:

// Include dependencies
#include "../Inc/Interrupts.h"

void interrupt Isr(void)
{
    if(GetInterruptFlag(INT0_INT_FLAG) == INT0_INT_FLAG)
    {
        // Interrupt occurred, do something about it
    }
}

Team

This file is currently being developed by the #Firmware-Engineers team. Contributions, recommendations and any sort of feedback are more than welcome.

License