GmUartLineSensor.hpp

/*
 * GmTivaGpsUart.hpp
 *
 *  Created on: May 10, 2016
 *      Author: rcram
 */
 
 
#ifndef GM_UART_LINE_SENSOR_HPP_
#define GM_UART_LINE_SENSOR_HPP_
 
/* RTOS Driver Header files */
#include <ti/drivers/UART.h>
#include <ti/drivers/GPIO.h>
 
#include <GmBufferedSensor.hpp>
 
#ifndef GMMFAMDATA_HPP_
#include <GmMfamData.hpp>
#endif
#include <GmError.hpp>
#include <GmGenericData.hpp>
 
#include <GmRingBuffer.hpp>
#include <GmManagedRingBuffer.hpp>
#include <GmChildRingBuffer.hpp>
#include <GmStorage.hpp>
 
namespace Geometrics
{
   class GmUartLineSensor : public GmBufferedSensor, public GmStorage
   {
   public:
      GmUartLineSensor (UInt8                iSubject,
                            int                  iLineLength,
                            int                  iMaxBuffered,
                            GmManagedArrayRingBuffer<uint8_t,GM_SIZE_OF_APP_DATA_QUEUE> *mainEventQueue);
      GmUartLineSensor (UInt8                iSubject,
                            int                  iLineLength,
                            int                  iMaxBuffered,
                            int                  iCustomRecordSize,
                            GmManagedArrayRingBuffer<uint8_t,GM_SIZE_OF_APP_DATA_QUEUE> *mainEventQueue);
      GmUartLineSensor (UInt8                iSubject,
                            int                  iLineLength,
                            int                  iMaxBuffered,
                            int                  iCustomRecordSize,
                            UInt8               *puiBuffer,
                            UInt32               uiBufferSize,
                            GmManagedArrayRingBuffer<uint8_t,GM_SIZE_OF_APP_DATA_QUEUE> *mainEventQueue);
 
 
      virtual int        Initialize         (int iBoardID) = 0;
 
      //TODO RHC verify OK to leave to base class.
      // int                DeleteNextRecord ();
      int                Start              ();
      Void               UartReadLoop       ();
 
 
      int                WriteData          (const char*     pcData,
                                             unsigned int    iDataSize,
                                             UInt32          ui32Topic);
      Bool               m_bPing,
                         m_bCustomRecord;
      UART_Handle        m_uhUartHandle;
 
 
   protected:
      /* When sending commands and reading responses, the read function may need to be
       * used by the command functions.  PauseRead and UnpauseRead for this purpose. */
      void               PauseRead          ();
      void               UnpauseRead        ();
 
      Task_Handle        m_thTask;
      bool               m_boolInitialized;
      bool               m_bReadPaused;
      int                m_iLineLength,
                         m_iPrefixLength,
                         m_iCustomRecordSize;
      virtual Void       OnPreProcessUartString (char  *pscString) {};
      virtual int        ConvertToCustomRecord  (UInt8  *pscUartData,
                                                 UInt8  *pcCustomRecordBuffer) { return -1;};
   protected:
      GeoIndexedStringWithHeader *m_pgiswhBuffer;
      int                m_iIndexThisUart;
      UInt8             *m_caCustomRecordBuffer;
   public:
      /************************************************************************/
      /* The application must call InitUarts before creating or starting any  */
      /*  uart sensors.  InitUarts creates the table that dispatches the      */
      /*  uart polling tasks to the correct individual sensor.                */
      /************************************************************************/
      static int InitUarts (int iMaxUarts),
                            m_static_iMaxUarts,
                            m_static_iNextUart;
      static GmUartLineSensor  **m_static_aulsUarts;
   };
 
} // End namespace Geometrics
 
#endif