SUBLIBinal Enumerations

SUBLIBinal Enumerations

This page contains information about global SUBLIBinal enumerations. These enumerations are used throughout the other peripheral libraries. Please refer to the following list to read more about different enumerations.

Enumerations:

• Error
• Pin
• boolean

---

Error

typedef enum {
    ERR_NO_ERR, 
    ERR_INVALID_ENUM,
    ERR_TIMER_FREQ_UNATTAINABLE,
    ERR_INVALID_DIVIDER,
    ERR_INVALID_PERIOD,
    ERR_INVALID_PIN,
    ERR_INVALID_VREF
    ERR_INVALID_POLARITY,
    ERR_INVALID_SEND, 
    ERR_QUEUE_FULL, 
    ERR_QUEUE_INVALID_READ, 
    ERR_INVALID_CHANNEL 
}Error;

The Error enumeration is used to signify any errors encountered within the library. A return of an error signifies disrupted library functionality.

top

---

Pin

typedef enum {
    Pin_RPA0,
    Pin_RPA1,
    Pin_RPA2,
    Pin_RPA3,
    Pin_RPA4,
    Pin_RPB0,
    Pin_RPB1,
    Pin_RPB2,
    Pin_RPB3,
    Pin_RPB4,
    Pin_RPB5,
    Pin_RPB6,
    Pin_RPB7,
    Pin_RPB8,
    Pin_RPB9,
    Pin_RPB10,
    Pin_RPB11,
    Pin_RPB13,
    Pin_RPB14,
    Pin_RPB15
}Pin;

The Pin enumeration is used for peripheral pin select. This will specify which pin the internal peripheral library should use for output on the physical microcontroller. Please be advised, one pin should not be assigned to multiple functions.

To see which pins are available for functions, please select the desired peripheral from the following list:

• Comparator
• External Interrupts
• UART
• PWM

top

boolean

    typedef enum {
        FALSE,
        TRUE
    } boolean;

This enumeration is to simply display true and false parameters for code readability.

top