eoPacketStream.h

Go to the documentation of this file.

/******************************************************************************
 DISCLAIMER

 THIS SOFTWARE PRODUCT ("SOFTWARE") IS PROPRIETARY TO ENOCEAN GMBH, OBERHACHING, 
 GERMANY (THE "OWNER") AND IS PROTECTED BY COPYRIGHT AND INTERNATIONAL TREATIES OR 
 PROTECTED AS TRADE SECRET OR AS OTHER INTELLECTUAL PROPERTY RIGHT. ALL RIGHTS, TITLE AND
 INTEREST IN AND TO THE SOFTWARE, INCLUDING ANY COPYRIGHT, TRADE SECRET OR ANY OTHER 
 INTELLECTUAL PROPERTY EMBODIED IN THE SOFTWARE, AND ANY RIGHTS TO REPRODUCE, 
 DISTRIBUTE, MODIFY, DISPLAY OR OTHERWISE USE THE SOFTWARE SHALL EXCLUSIVELY VEST IN THE
 OWNER. ANY UNAUTHORIZED REPRODUCTION, DISTRIBUTION, MODIFICATION, DISPLAY OR OTHER
 USE OF THE SOFTWARE WITHOUT THE EXPLICIT PERMISSION OF OWNER IS PROHIBITED AND WILL 
 CONSTITUTE AN INFRINGEMENT OF THE OWNER'S RIGHT AND MAY BE SUBJECT TO CIVIL OR 
 CRIMINAL SANCTION.

 THIS SOFTWARE IS PROVIDED BY THE OWNER "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
 INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS 
 FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN PARTICULAR, THE OWNER DOES NOT WARRANT 
 THAT THE SOFTWARE SHALL BE ERROR FREE AND WORKS WITHOUT INTERRUPTION.

 IN NO EVENT SHALL THE OWNER BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, 
 EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, 
 OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS 
 SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 ******************************************************************************/

#if !defined(EO_PACKETSTREAM_H)
#define EO_PACKETSTREAM_H

#include "eoHalTypes.h"
#include "eoApiDef.h"
#include "eoPacket.h"

/****************************Defines******************************/
#define SER_SYNCH_CODE            0x55
#define SER_HEADER_NR_BYTES             4
#define SER_INTERBYTE_TIME_OUT    100

class eoPacketStream
{
private:
 typedef enum
 {
  GET_SYNC_STATE = 0,
  GET_HEADER_STATE,
  CHECK_CRC8H_STATE,
  GET_DATA_STATE,
  CHECK_CRC8D_STATE

 } STATES_GET_PACKET;

 uint8_t u8CRC;
 uint16_t u16Count;
 STATES_GET_PACKET u8State;
 uint32_t u32LastTimeoutCheckTickCount;
 uint32_t u32LastByteReceivedTickCount;
 eoPacket receivePacket;

public:
 eoPacketStream();
 virtual ~eoPacketStream();

 virtual eoReturn Open(const char *port) = 0;
 virtual void Close() = 0;

 virtual eoReturn Receive(eoPacket *p);
 virtual eoReturn ReceiveByte(uint8_t *d) = 0;
 virtual eoReturn Send(const eoPacket &p);
 virtual eoReturn SendByte(uint8_t d) = 0;
 virtual bool IsPacketPending();

};
#endif // !defined(EO_PACKETSTREAM_H)