SerialPort.h

/*----------------------------------------------------------------------------*/
/* Copyright (c) FIRST 2008. All Rights Reserved.							  */
/* Open Source Software - may be modified and shared by FRC teams. The code   */
/* must be accompanied by the FIRST BSD license file in $(WIND_BASE)/WPILib.  */
/*----------------------------------------------------------------------------*/

#ifndef __SerialPort_h__
#define __SerialPort_h__

#include "Base.h"
#include <vxWorks.h>

/**
 * Driver for the RS-232 serial port on the cRIO.
 * 
 * The current implementation uses the VISA formatted I/O mode.  This means that
 *   all traffic goes through the fomatted buffers.  This allows the intermingled
 *   use of Printf(), Scanf(), and the raw buffer accessors Read() and Write().
 * 
 * More information can be found in the NI-VISA User Manual here:
 *   http://www.ni.com/pdf/manuals/370423a.pdf
 * and the NI-VISA Programmer's Reference Manual here:
 *   http://www.ni.com/pdf/manuals/370132c.pdf
 */
class SerialPort
{
public:
	typedef enum {kParity_None=0, kParity_Odd=1, kParity_Even=2, kParity_Mark=3, kParity_Space=4} Parity;
	typedef enum {kStopBits_One=10, kStopBits_OnePointFive=15, kStopBits_Two=20} StopBits;
	typedef enum {kFlowControl_None=0, kFlowControl_XonXoff=1, kFlowControl_RtsCts=2, kFlowControl_DtrDsr=4} FlowControl;
	typedef enum {kFlushOnAccess=1, kFlushWhenFull=2} WriteBufferMode;

	SerialPort(UINT32 baudRate, UINT8 dataBits = 8, Parity parity = kParity_None, StopBits stopBits = kStopBits_One);
	~SerialPort();
	void SetFlowControl(FlowControl flowControl);
	void EnableTermination(char terminator = '\n');
	void DisableTermination();
	INT32 GetBytesReceived();
	void Printf(const char *writeFmt, ...);
	void Scanf(const char *readFmt, ...);
	UINT32 Read(char *buffer, INT32 count);
	UINT32 Write(const char *buffer, INT32 count);
	void SetTimeout(float timeout);
	void SetReadBufferSize(UINT32 size);
	void SetWriteBufferSize(UINT32 size);
	void SetWriteBufferMode(WriteBufferMode mode);
	void Flush();
	void Reset();

	/*
	 * Do not call me!
	 */
	//void _internalHandler(UINT32 port, UINT32 eventType, UINT32 event);
private:
	UINT32 m_resourceManagerHandle;
	UINT32 m_portHandle;
	bool m_consoleModeEnabled;
	DISALLOW_COPY_AND_ASSIGN(SerialPort);
};

#endif