sensorlibrary.h

Go to the documentation of this file.

//
// Copyright (c) 2016 by Dragonnorth Group, all rights reserved.
//
// Author: Michael Newman
#ifndef sensorlibraryHedit
#define sensorlibraryHedit 1            
//  14Feb16 MJNewman 1: Created
//
// An unrestricted license to this software is granted to:
//   None granted yet.
// and may be granted to others.

#include "basetype.h"
#include "sensordatatype.h"
#include "dataservices.h"       // for LogElement_t

extern void sensorlibraryInit();

extern void sensorlibraryDumpSensors(Print *pPrinter = &Serial,
                                        FormatType_t formatType = FormatForConsole);

typedef enum {
    InterfaceProcessorPin,
    InterfaceOneWire,
    InterfaceI2C,
} SensorInterfaceID_t;

extern String sensorlibraryInterfaceGetName(SensorInterfaceID_t interface);

typedef enum {
    SensorProcessorADCpin,              // value logged is voltage
    SensorProcessorIOpin,               // value logged comes from a pin
    SensorDS18x20,                      // A temperature sensor, DS18S20, DS18B20, DS1822
    SensorTCA9535,                      // A 16 bit I/O pin expander
    SensorAD7091R,                      // A 4 channel 12 bit ADC
    SensorDLVRpressure,                 // a DLVR pressure sensor
} SensorTypeID_t;

extern String sensorlibrarySensorTypeGetName(SensorTypeID_t sensorType);

extern const char * const datatypeNames[];

typedef uint32_t SENSOR_READ_CALLBACK(uint8_t *pUniqueID,uint8_t sensorSpecific);

typedef SENSOR_READ_CALLBACK *pSENSOR_READ_CALLBACK;

#define ILLEGAL_TEMPERATURE (1000*1000)

extern int8_t sensorlibraryCreateSensor(uint8_t *uniqueID,
                                           String name,
                                           uint8_t bitsOfData,
                                           bool isSigned,
                                           SensorInterfaceID_t interface,
                                           SensorTypeID_t sensorType,
                                           SensorDatatypeID_t datatype,
                                           uint8_t decimalPlaces,
                                           uint8_t sensorSpecific,
                                           pSENSOR_READ_CALLBACK pReader);

extern void sensorlibraryDisableSensor(uint8_t sensorID);

extern void sensorlibraryReadSensors(LogElement_t &element);

extern void sensorlibraryDumpElement(Print *pPrinter,
                                        uint8_t indent,
                                        LogElement_t &element,
                                        FormatType_t formatType = FormatForConsole,
                                        SensorDatatypeID_t datatype = SDallTypes);

extern void sensorlibraryDumpElementIDvalue(Print *pPrinter,
                                               uint8_t indent,
                                               LogElement_t &element,
                                               FormatType_t formatType = FormatForConsole,
                                               SensorDatatypeID_t datatype = SDallTypes);

extern void sensorlibraryDumpSensorName(Print *pPrinter,
                                           uint8_t sensorID,
                                           FormatType_t formatType = FormatForConsole);
                                            
extern void sensorlibraryDumpSensorUniqueID(Print *pPrinter,
                                               uint8_t sensorID,
                                               FormatType_t formatType = FormatForConsole);

extern void sensorlibraryDumpSensorValue(Print *pPrinter,
                                            uint8_t indent,
                                            uint32_t value,
                                            uint8_t sensorID,
                                            FormatType_t formatType = FormatForConsole);


extern uint32_t sensorlibraryExtractPulseCount(uint8_t index,
    LogElement_t &element,
    uint32_t defaultCount);

extern void sensorlibraryDumpSampleList(Print *pPrinter,
                                           LogElement_t &element,
                                           SensorDatatypeID_t datatype = SDallTypes);

extern void sensorlibrarySetPulsesSinceBoot(LogElement_t &element);

typedef enum {
    GraphTypeAllIntervals,
    GraphTypeAllSamples,
} GraphType_t;
    

extern void sensorlibraryDumpAddColumns(Print *pPrinter,
                                           GraphType_t graphType,
                                           SensorDatatypeID_t datatype);


extern String sensorlibraryGetSensorName(uint8_t index);

extern void sensorlibraryDumpSensorById(uint8_t index,
                                           Print *pPrinter,
                                           FormatType_t formatType);

extern uint8_t sensorlibraryGetI2Caddress(uint8_t sensorID);

extern uint8_t sensorlibraryGetSensorSpecificData(uint8_t sensorID);

#endif // defined(sensorlibraryHedit)