SUBLIBinal Enumerations - PalouseRobosub/SUBLIBinal_AVR GitHub Wiki
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
typedef enum {
ERR_NO_ERR, //not an error
ERR_INVALID_ENUM,
ERR_TIMER_FREQ_UNATTAINABLE,
ERR_INVALID_DIVIDER,
ERR_INVALID_PERIOD,
ERR_BAD_CONFIG,
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.
boolean
typedef enum {
FALSE,
TRUE
} Boolean;
This enumeration is to simply display true and false parameters for code readability.