picapi.h

Go to the documentation of this file.

#ifndef PICAPI_H
#define PICAPI_H

#ifndef FALSE

#define FALSE  0
#endif

#ifndef TRUE

#define TRUE   1
#endif

#define DIGITAL_INPUT               0

#define ANALOGUE_INPUT              1

#define PIC_SUCCESS                 0

#define PIC_UNKNOWNERROR            -1

#define PIC_FILEERROR               -2

#define PIC_HDRMISMATCH             -3

#define PIC_DATAMISMATCH            -4

#define PIC_PARAMERROR              -5

// Initialisation / Cleanup
int PIC_Initialise( void );
void PIC_Close( int fdPIC );

// PIC Firmware Information
int PIC_ReadFirmwareVersion( int fdPIC, int *version );

// Real time clock functions
int PIC_ReadRTC( int fdPIC, time_t *rtc );
int PIC_SetRTC( int fdPIC, time_t rtc );
int PIC_ReadPowerOffTime( int fdPIC, time_t *powerOffTime );
int PIC_ReadPowerOnTime( int fdPIC, time_t *powerOffTime );

// Analogue input functions
int PIC_ReadAnalogueInput( int fdPIC, int adcPort, int *value );

// Switch / Power off switch logger functions
int PIC_ReadSwitches( int fdPIC, int *switches );
int PIC_ClearLog( int fdPIC );
int PIC_GetLogEntry( int fdPIC, int *valid, time_t *rtc, int *switches );
int PIC_DeleteLogEntry( int fdPIC, int *deleteOK );

// PIC Status Flags
int PIC_ReadWatchdogResetFlag( int fdPIC, int *flag );
int PIC_ReadPowerOnResetFlag( int fdPIC, int *flag );
int PIC_ReadBrownOutResetFlag( int fdPIC, int *flag );
int PIC_ReadOscillatorFailureFlag( int fdPIC, int *flag );
int PIC_ReadLogBufferOverflowFlag( int fdPIC, int *flag );

// Battery functions
int PIC_BatteryFastCharge( int fdPIC, int fastCharge );
int PIC_BatteryReadVoltage( int fdPIC, int *batteryVoltage );
int PIC_BatteryReadMaxRef( int fdPIC, int *maxRef );
int PIC_BatteryReadMinETXVoltage( int fdPIC, int *minETXVoltage );

// Hardware configuration
int PIC_ConfigureRA2InputType( int fdPIC, int type );
int PIC_ConfigureRA4InputType( int fdPIC, int type );

#endif

---