listener/utility/LinxDevice.h

/****************************************************************************************
**  LINX header for generic LINX Device.
**
**  For more information see:           www.labviewmakerhub.com/linx
**  For support visit the forums at:    www.labviewmakerhub.com/forums/linx
**  
**  Written By Sam Kristoff, modified by CBC Girard
**
** BSD2 License.
****************************************************************************************/   
 
#ifndef LINX_DEVICE_H
#define LINX_DEVICE_H
 
/****************************************************************************************
**  Includes
****************************************************************************************/       
 
/****************************************************************************************
**  Defines
****************************************************************************************/       
//GPIO
#ifndef INPUT
    #define INPUT 0x00
#endif
 
#ifndef  OUTPUT
    #define OUTPUT 0x01
#endif
 
#ifndef HIGH
    #define HIGH 0x01
#endif
 
#ifndef LOW
    #define LOW 0x00
#endif
 
//SPI
#ifndef IS_M0
 
#ifndef LSBFIRST
    #define LSBFIRST 0
#endif
 
#ifndef MSBFIRST
    #define MSBFIRST 1
#endif
 
#endif
 
//I2C
#define EOF_STOP 0
#define EOF_RESTART 1
#define EOF_RESTART_NOSTOP 2
#define EOF_NOSTOP 3
 
//UART
#ifndef BIN
    #define BIN 2
#endif
#ifndef OCT
    #define OCT 8
#endif
#ifndef DEC
    #define DEC 10
#endif
#ifndef HEX
    #define HEX 16
#endif
 
//Non-Volatile Storage Addresses
#define NVS_USERID 0x00
#define NVS_ETHERNET_IP 0x02
#define NVS_ETHERNET_PORT 0x06
#define NVS_WIFI_IP 0x08
#define NVS_WIFI_PORT 0x0C
#define NVS_WIFI_SSID_SIZE 0x0E
#define NVS_WIFI_SSID 0x0F
#define NVS_WIFI_SECURITY_TYPE 0x30
#define NVS_WIFI_PW_SIZE 0x31
#define NVS_WIFI_PW 0x32
#define NVS_SERIAL_INTERFACE_MAX_BAUD 0x72
 
//DEBUG
#define TX 0
#define RX 1
 
/****************************************************************************************
**  Typedefs
****************************************************************************************/       
typedef enum LinxStatus
{
    L_OK = 0,
    L_FUNCTION_NOT_SUPPORTED,
    L_REQUEST_RESEND,
    L_UNKNOWN_ERROR, 
    L_DISCONNECT
}LinxStatus;
 
typedef enum AioStatus
{
    LANALOG_REF_MODE_ERROR=129,
    LANALOG_REF_VAL_ERROR=130
}AioStatus;
 
typedef enum DioStatus
{
    LDIGITAL_PIN_DNE=128, 
}DioStatus;
 
 
typedef enum SPIStatus
{
    LSPI_OPEN_FAIL = 128,
    LSPI_TRANSFER_FAIL
}SPIStatus;
 
typedef enum I2CStatus
{
    LI2C_SADDR=128, 
    LI2C_EOF, 
    LI2C_WRITE_FAIL,    
    LI2C_READ_FAIL, 
    LI2C_CLOSE_FAIL,
    LI2C_OPEN_FAIL
}I2CStatus;
 
typedef enum UartStatus
{
    LUART_OPEN_FAIL=128, 
    LUART_SET_BAUD_FAIL, 
    LUART_AVAILABLE_FAIL, 
    LUART_READ_FAIL, 
    LUART_WRITE_FAIL, 
    LUART_CLOSE_FAIL
}UartStatus;
 
typedef enum ResetWhat
{
    LRESET_NONE,
    LRESET_SERIAL,
    LRESET_TCP,
    LRESET_ALL
}ResetWhat;
 
class LinxDevice
{
    public: 
        /****************************************************************************************
        **  Member Variables
        ****************************************************************************************/               
        
        //Device ID
        unsigned char DeviceFamily;
        unsigned char DeviceId;
        unsigned char DeviceNameLen;
        const unsigned char* DeviceName;
        unsigned char ListenerBufferSize;
        
        //LINX API Version
        unsigned char LinxApiMajor;
        unsigned char LinxApiMinor;
        unsigned char LinxApiSubminor;
        
        //----Peripherals----
        
        //DIO       
        unsigned char NumDigitalChans;
        const unsigned char*  DigitalChans;
        
        //AI
        unsigned char NumAiChans;
        const unsigned char* AiChans;
        unsigned char AiResolution;
        unsigned long AiRefDefault;
        unsigned long AiRefSet;
        
        //AO
        unsigned char NumAoChans;
        const unsigned char* AoChans;
        unsigned char AoResolution;
        unsigned long AoRefDefault;
        unsigned long AoRefSet;
        
        //PWM
        unsigned char NumPwmChans;
        const unsigned char* PwmChans;
        
        //QE
        unsigned char NumQeChans;
        const unsigned char* QeChans;
        
        //UART
        unsigned char NumUartChans;
        const unsigned char* UartChans;
        unsigned long UartMaxBaud;
        
        //I2C
        unsigned char NumI2cChans;
        const unsigned char* I2cChans;
        
        //SPI
        unsigned char NumSpiChans;
        const unsigned char* SpiChans;
        
        //CAN
        unsigned char NumCanChans;
        const unsigned char* CanChans;
        
        //Servo
        unsigned char NumServoChans;
        const unsigned char* ServoChans;
        
        //User Configured Values
        unsigned short userId;
  
        unsigned long ethernetIp;
        unsigned short ethernetPort;  
 
 
        unsigned long WifiIp;
        unsigned short WifiPort;
        unsigned char WifiSsidSize;
        char WifiSsid[32];
        unsigned char WifiSecurity;
        unsigned char WifiPwSize;
        char WifiPw[64];
 
        
        unsigned long serialInterfaceMaxBaud;
 
        //LINXx values
        ResetWhat ResetTarget=LRESET_NONE;
        unsigned char WifiStatus=0xFF;
        
        /****************************************************************************************
        **  Constructors/Destructor
        ****************************************************************************************/
        LinxDevice();
        virtual ~LinxDevice();
            
        /****************************************************************************************
        **  Functions
        ****************************************************************************************/
        
        //Analog
        virtual int AnalogRead(unsigned char numChans, unsigned char* channels, unsigned char* values) = 0;
        virtual int AnalogReadNoPacking(unsigned char numChans, unsigned char* channels, unsigned long* values);        //Values Are ADC Ticks And Not Bit Packed
        virtual int AnalogSetRef(unsigned char mode, unsigned long voltage) = 0;
 
        virtual int AnalogWrite(unsigned char numChans, unsigned char* channels, unsigned char* values) = 0;                //Values Are Bit Packed
        virtual int AnalogWriteNoPacking(unsigned char numChans, unsigned char* channels, unsigned long* values);       //Values Are Not Bit Packed
            
        //DIGITAL
        virtual int DigitalWrite(unsigned char numChans, unsigned char* channels, unsigned char* values) = 0;               //Values Are Bit Packed
        virtual int DigitalWriteNoPacking(unsigned char numChans, unsigned char* channels, unsigned char* values);      //Values Are Not Bit Packed
        virtual int DigitalRead(unsigned char numChans, unsigned char* channels, unsigned char* values) = 0;
        virtual int DigitalReadNoPacking(unsigned char numChans, unsigned char* channels, unsigned char* values);       //Response Not Bit Packed
        virtual int DigitalWriteSquareWave(unsigned char channel, unsigned long freq, unsigned long duration) = 0;
        virtual int DigitalReadPulseWidth(unsigned char stimChan, unsigned char stimType, unsigned char respChan, unsigned char respType, unsigned long timeout, unsigned long* width) = 0;
        
        //PWM
        virtual int PwmSetDutyCycle(unsigned char numChans, unsigned char* channels, unsigned char* values) = 0;
        virtual int PwmSetFrequency(unsigned char numChans, unsigned char* channels, unsigned long* values);
        
        //SPI
        virtual int SpiOpenMaster(unsigned char channel) = 0;
        virtual int SpiSetBitOrder(unsigned char channel, unsigned char bitOrder) = 0;
        virtual int SpiSetMode(unsigned char channel, unsigned char mode) = 0;
        virtual int SpiSetSpeed(unsigned char channel, unsigned long speed, unsigned long* actualSpeed) = 0;
        virtual int SpiWriteRead(unsigned char channel, unsigned char frameSize, unsigned char numFrames, unsigned char csChan, unsigned char csLL, unsigned char* sendBuffer, unsigned char* recBuffer) = 0;
        
        //I2C
        virtual int I2cOpenMaster(unsigned char channel) = 0;
        virtual int I2cSetSpeed(unsigned char channel, unsigned long speed, unsigned long* actualSpeed) = 0;
        virtual int I2cWrite(unsigned char channel, unsigned char slaveAddress, unsigned char eofConfig, unsigned char numBytes, unsigned char* sendBuffer) = 0;
        virtual int I2cRead(unsigned char channel, unsigned char slaveAddress, unsigned char eofConfig, unsigned char numBytes, unsigned int timeout, unsigned char* recBuffer) = 0;        
        virtual int I2cClose(unsigned char channel) = 0;
        
        //UART
        virtual int UartOpen(unsigned char channel, unsigned long baudRate, unsigned long* actualBaud) = 0;
        virtual int UartSetBaudRate(unsigned char channel, unsigned long baudRate, unsigned long* actualBaud) = 0;
        virtual int UartGetBytesAvailable(unsigned char channel, unsigned char *numBytes) = 0;
        virtual int UartRead(unsigned char channel, unsigned char numBytes, unsigned char* recBuffer, unsigned char* numBytesRead) = 0;     
        virtual int UartWrite(unsigned char channel, unsigned char numBytes, unsigned char* sendBuffer) = 0;        
        virtual void UartWrite(unsigned char channel, char c);
        virtual void UartWrite(unsigned char channel, const char s[]);
        virtual void UartWrite(unsigned char channel, unsigned char c);
        virtual void UartWrite(unsigned char channel, int n);
        virtual void UartWrite(unsigned char channel, unsigned int n);
        virtual void UartWrite(unsigned char channel, long n);
        virtual void UartWrite(unsigned char channel, unsigned long n);
        virtual void UartWrite(unsigned char channel, long n, int base);
        virtual void UartWriteln(unsigned char channel);
        virtual void UartWriteln(unsigned char channel, char c);
        virtual void UartWriteln(unsigned char channel, const char s[]);
        virtual void UartWriteln(unsigned char channel, unsigned char c);
        virtual void UartWriteln(unsigned char channel, int n);
        virtual void UartWriteln(unsigned char channel, long n);
        virtual void UartWriteln(unsigned char channel, unsigned long n);
        virtual void UartWriteln(unsigned char channel, long n, int base);      
        virtual int UartClose(unsigned char channel) = 0;
        
        //Servo
        virtual int ServoOpen(unsigned char numChans, unsigned char* channels) = 0;
        virtual int ServoSetPulseWidth(unsigned char numChans, unsigned char* channels, unsigned short* pulseWidths) = 0;
        virtual int ServoClose(unsigned char numChans, unsigned char* channels) = 0;
        
        //WS2812
        virtual int Ws2812Open(unsigned short numLeds, unsigned char dataChan);
        virtual int Ws2812WriteOnePixel(unsigned short pixelIndex, unsigned char red, unsigned char green, unsigned char blue, unsigned char refresh);
        virtual int Ws2812WriteNPixels(unsigned short startPixel, unsigned short numPixels, unsigned char* data, unsigned char refresh);
        virtual int Ws2812Refresh();
        virtual int Ws2812Close();
                
        //General
        unsigned char ReverseBits(unsigned char b);
        virtual unsigned long GetMilliSeconds() = 0;
        virtual unsigned long GetSeconds() = 0;
        virtual void DelayMs(unsigned long ms);
        virtual void NonVolatileWrite(int address, unsigned char data) = 0;
        virtual unsigned char NonVolatileRead(int address) = 0;
        
        //Debug
        virtual void EnableDebug(unsigned char channel);
        
        virtual void DebugPrint(char c);
        virtual void DebugPrint(const char s[]);
        virtual void DebugPrint(unsigned char c);
        virtual void DebugPrint(int n);
        virtual void DebugPrint(unsigned int n);
        virtual void DebugPrint(long n);
        virtual void DebugPrint(unsigned long n);
        virtual void DebugPrint(long n, int base);
        
        virtual void DebugPrintln();
        virtual void DebugPrintln(char c);
        virtual void DebugPrintln(const char s[]);
        virtual void DebugPrintln(unsigned char c);
        virtual void DebugPrintln(int n);
        virtual void DebugPrintln(long n);
        virtual void DebugPrintln(unsigned long n);
        virtual void DebugPrintln(long n, int base);
 
        
        virtual void DebugPrintPacket(unsigned char direction, const unsigned char* packetBuffer);
                
        // management
        virtual int BoardCommands(unsigned char command, unsigned char numInputBytes, unsigned char* input, unsigned char* numResponseBytes, unsigned char* response);
        virtual int Reset(ResetWhat target);
 
    private:
        /****************************************************************************************
        **  Variables
        ****************************************************************************************/       
        virtual void UartWriteNumber(unsigned char channel, unsigned long n, unsigned char bases);
        
        /****************************************************************************************
        **  Functions
        ****************************************************************************************/
};
#endif //LINX_DEVICE_H