device.h

#ifndef _device_
#define _device_
 
#include "../defines.h"
 
class Device
{
private:
    #define headerSize 25
    #define headerPinSize 68
    #define headerFunctionSize 29
    #define headerFunctionA1Size 44
    #define headerFunctionA2Size 59
    SmeJson json_data;
    char* json = nullptr; 
    char* jsonGPIOs = nullptr;
    char* jsonFunctions = nullptr;
 
public:
// variable: Device.GPIOType
 
//     describes the type of the pin
    char GPIOType[5][10] = {"out", "in", "analogIn", "analogOut", "pwm"};
 
//     describes the type of the pull config
    char pullType[3][5] = {"none", "up", "down"};
 
// Function: Device.set
 
//     an object that describes the device from the hw perspective
 
//     Prototype:
//         void Device::set(char* name);
 
//     Parameters:
 
//     Returns:
    void set(char* deviceId, char* name);
    
// Function: Device.gpioTypeIndex
 
//     turn the GPIOType into the corresponding index
 
//     Prototype:
//         void gpioTypeIndex(char* GPIOType, char* GPIOTypeIndex);
 
//     Parameters:
 
//     Returns:
    void gpioTypeIndex(char* gpioType, char* GPIOTypeIndex);
 
// Function: Device.addGPIO
 
//     add a GPIO to an array that describes the hw interface capabilities of the device
 
//     Prototype:
//         void Device::addGPIO(char* name, char* pinType, char* portName, int pinNumber, int value);
 
//     Parameters:
 
//     Returns:
    void addGPIO(char* name, char* GPIOType, char* portName, char* pinNumber, char* pullType);
    
// Function: Device.appendGPIOs
 
//     Append the selected GPIO
 
//     Prototype:
//         void Device::appendGPIOs();
 
//     Parameters:
 
//     Returns:
    void appendGPIOs();
 
// Function: Device.addFunction
 
//     add an array of internal methods/functions  
 
//     Prototype:
//         void Device::addFunction(char* name, char* functionName);
 
//     Parameters:
 
//     Returns:
    void addFunction(char* name, char* functionName);
    void addFunction(char* name, char* functionName, char* arg1);
    void addFunction(char* name, char* functionName, char* arg1, char* arg2);
 
// Function: Device.appendFunctions
 
//     Append the selected functions
 
//     Prototype:
//         void Device::appendFunctions();
 
//     Parameters:
 
//     Returns:
 
    void appendFunctions();
    
// Function: Device.get
 
//     return the json script
 
//     Prototype:
//         void Device::get();
 
//     Parameters:
 
//     Returns:
    char* get();
};
 
#endif