main.h

//=========================================================================
// main.h
//
// An interface for the RM3100 3-axis magnetometer from PNI Sensor Corp.
//
// Author:      David Witten, KD0EAG
// Date:        December 18, 2023
// License:     GPL 3.0
// Note:        replaces i2c.c (using file system calls to read(), write(), etc.
//              with calls to pigpio. 
//              Also adding callbacks on GPIO27 for PPS rising edge.
//=========================================================================
#ifndef SWX3100MAIN_h
#define SWX3100MAIN_h

#include <stdint.h>
#include <stdlib.h>
#include <stdio.h>
#include <string.h>
#include <unistd.h>
#include <signal.h>
#include <math.h>
#include <ctype.h>
#include <sys/types.h>
#include <sys/stat.h>
#include <sys/ioctl.h>
#include <time.h>
#include <sys/time.h>
#include <fcntl.h>
#include <memory.h>
//#include <linux/i2c-dev.h>
#include "MCP9808.h"
#include "rm3100.h"

//------------------------------------------
// Debugging output
//------------------------------------------
#define _DEBUG          FALSE
#define CONSOLE_OUTPUT  TRUE
#define USE_WAITFOREDGE TRUE
#define FOR_GRAPE2      TRUE

//------------------------------------------
// Macros and runtime options.
//------------------------------------------
#define RASPI_I2C_BUS0      0
#define RASPI_I2C_BUS1      1

#define PPS_GPIO_PIN    27
#define OUTPUT_PRINT    stdout
#define OUTPUT_ERROR    stderr
#define PPS_TIMEOUTSECS 2.0

#define USE_PIPES           TRUE
#define MAGDATA_VERSION     "0.0.2"
#define PPS_GPIO_PIN        27                  // physical pin 36
#define PPS_FLAG_TRUE       999                 // Flag Value if edge is received
#define PPS_FLAG_FALSE      0                   // Flag Value for edge otherwise

#define UTCBUFLEN           64
#define MAXPATHBUFLEN       1025
#define XYZ_BUFLEN          9

//------------------------------------------
// Control Parameter List struct
//------------------------------------------
typedef struct tag_ctlList
{
    int pi;

    unsigned magHandle;
    unsigned localTempHandle;
    unsigned remoteTempHandle;

    int  magnetometerAddr;
    int  localTempAddr;
    int  remoteTempAddr;

    int  doBistMask;

    int  cc_x;
    int  cc_y;
    int  cc_z;

    int  x_gain;
    int  y_gain;
    int  z_gain;

    int32_t XYZ[9];

    int  TMRCRate;
    int  CMMSampleRate;

    int  samplingMode;

    int  NOSRegValue;

    int  DRDYdelay;

    int  readBackCCRegs;
    uint8_t magRevId;

    int  i2cBusNumber;

    int  tsMilliseconds;
    char *Version;
    int  usePipes;
    char *pipeInPath;
    char *pipeOutPath;
} ctlList;


//------------------------------------------
// Prototypes
//------------------------------------------
int  main(int argc, char** argv);
void onEdge(void);
char *formatOutput(volatile ctlList *p, char *outBuf);
int  initGPIO(volatile ctlList *p);
void termGPIO(volatile ctlList *p);
int  verifyMagSensor(volatile ctlList *p);
int  initMagSensor(volatile ctlList *p);

struct tm *getUTC();

int  readLocalTemp(volatile ctlList *p);
int  readRemoteTemp(volatile ctlList *p);
int  readMagPOLL(volatile ctlList *p);
void readCycleCountRegs(volatile ctlList *p);
unsigned short getMagSampleRate(volatile ctlList *p);

void showPIGPIOErrMsg(int rv);

int setNOSReg(volatile ctlList *p);
int setCycleCountsReg(volatile ctlList *p);
void setCycleCounts_by_Reg(volatile ctlList *p);

unsigned short getCCGainEquiv(unsigned short CCVal);
unsigned short getCCGainEquiv(unsigned short CCVal);

#endif //SWX3100MAIN_h