BayEOS.h

 
#ifndef BayEOS_h
#define BayEOS_h
#define BayEOS_VERSION "1.6"
/*
 *  Frame-Types
 */
 
#define BayEOS_DataFrame 0x1 
#define BayEOS_Command 0x2 /* [0x2][CMD][ARGS...] */
#define BayEOS_CommandResponse 0x3 /* [0x3][CMD][RESPONSE...] */
#define BayEOS_Message 0x4
#define BayEOS_ErrorMessage 0x5
/*
 * Routed, Delayed, RoutedRSSI, Timestamp Frame:
 * These frames wrap the original frame. In principle this can be
 * used several times. However the effective payload is reduced by
 * five (six with RSSI) byte per hub
 */
#define BayEOS_RoutedFrame 0x6 /* [0x6][MY_ID][PANID][Original Frame] */
#define BayEOS_DelayedFrame 0x7 /* [0x7][(unsigned long) delay (msec)][Original Frame] */
#define BayEOS_RoutedFrameRSSI 0x8 /* [0x9][MY_ID][PANID][RSSI][Original Frame]
Note RSSI is negative but without sign as uint8_t
*/
#define BayEOS_TimestampFrame 0x9 /* [0x9][(unsigned long) timestamp (sec since 2000-01-01 00:00 GMT)][Original Frame] */
#define BayEOS_BinaryFrame 0xa /* [0xa][(unsigned long) pos][binary data] */
#define BayEOS_OriginFrame 0xb /* [0xb][origin_length][ORIGIN][Original Frame] -> Origin replaces current origin*/
#define BayEOS_MillisecondTimestampFrame 0xc /* [0xc][(long long) timestamp (millisec since 1970-01-01 00:00 GMT)][Original Frame] */
#define BayEOS_RoutedOriginFrame 0xd /* [0xd][origin_length][ORIGIN][Original Frame] -> Origin is appended to current origin using "/" */
 
/*Send commands to the Gateway via frame/save interface */
#define BayEOS_GatewayCommand 0xe /* [0xe][type][ARGS...] */
#define BayEOS_GatewayCommand_SetName 0x1 /* [0xe][0x1][Name]  */
#define BayEOS_GatewayCommand_ApplyTemplate 0x2 /* [0xe][0x2][TemplateName/UUID/URL]  */
#define BayEOS_GatewayCommand_SetSamplingInt 0x3 /* [0xe][0x3][long]  */
#define BayEOS_GatewayCommand_SetCheckDelay 0x4 /* [0xe][0x4][long]  */
 
//#define BayEOS_GatewayCommand_SetChannelName 0x21 /* [0xe][0x2][NR][Name]  */
 
#define BayEOS_ChecksumFrame 0xf /* [0xf][frame][checksum_16bit] */
#define BayEOS_DelayedSecondFrame 0x10 /* [0x10][(unsigned long) delay (sec)][Original Frame] */
#define BayEOS_RF24Frame 0x11 /* [0x11][uint8_t pipe][Original Frame] */
 
#define BayEOS_Action 0x12 /* [0x12][Key][ARGS...] */
#define BayEOS_ActionResponse 0x13 /* [0x13][Key][Status][RESPONSE...] */
#define BayEOS_ActionSuccess 0x0
#define BayEOS_ActionFailed 0x1
 
 
 
/* BayEOS Data Frames */
/* [0x1][0x1][offset][[float]]+...  */
#define BayEOS_Float32le 0x1
#define BayEOS_Int32le 0x2
#define BayEOS_Int16le 0x3
#define BayEOS_UInt8 0x4
#define BayEOS_Double64le 0x5
#define BayEOS_String 0x6 /* [length (2b)][string] */
#define BayEOS_Binary 0x7 /* [offset][length (2b)][data] */
 
/* [0x1][0x21][[float]]+...  */
#define BayEOS_WithoutOffsetFloat32le 0x21
#define BayEOS_WithoutOffsetInt32le 0x22
#define BayEOS_WithoutOffsetInt16le 0x23
#define BayEOS_WithoutOffsetUInt8 0x24
#define BayEOS_WithoutOffsetDouble64le 0x25
/* [0x1][0x41][[Channel number][float]]+...  */
#define BayEOS_ChannelFloat32le 0x41
#define BayEOS_ChannelInt32le 0x42
#define BayEOS_ChannelInt16le 0x43
#define BayEOS_ChannelUInt8 0x44
#define BayEOS_ChannelDouble64le 0x45
 /* [0x1][0x61][[Label length][ChannelLabel][float]]+...  */
#define BayEOS_LabelledChannelFloat32le 0x61
#define BayEOS_LabelledChannelInt32le 0x62
#define BayEOS_LabelledChannelInt16le 0x63
#define BayEOS_LabelledChannelUInt8 0x64
#define BayEOS_LabelledChannelDouble64le 0x65
 
 
#define BayEOS_WithoutOffset 0x20
#define BayEOS_ChannelNumber 0x40
#define BayEOS_ChannelLabel 0x60
 
#define BayEOS_DATATYP_MASK 0x0f
#define BayEOS_OFFSETTYP_MASK 0xf0
 
#define BayEOS_SetCannelAddress 0x1
#define BayEOS_GetCannelAddress 0x2
#define BayEOS_SetAutoSearch 0x3
#define BayEOS_GetAutoSearch 0x4
#define BayEOS_SetPin 0x5
#define BayEOS_GetPin 0x6
#define BayEOS_GetTime 0x7
#define BayEOS_SetTime 0x8
#define BayEOS_GetName 0x9
#define BayEOS_SetName 0xa
#define BayEOS_StartData 0xb
#define BayEOS_StopData 0xc 
#define BayEOS_GetVersion 0xd
#define BayEOS_GetSamplingInt 0xe
#define BayEOS_SetSamplingInt 0xf
#define BayEOS_TimeOfNextFrame 0x10
#define BayEOS_StartLiveData 0x11
#define BayEOS_ModeStop 0x12 /* renamed from StopLiveData - Should be used to stop DUMP/LIVE/SEND-Mode */
#define BayEOS_Seek 0x13
#define BayEOS_StartBinaryDump 0x14 
#define BayEOS_BufferCommand 0x15
#define BayEOS_GetBatStatus 0x16 /* [0x2][0x16] -> returns [0x3][0x16][uint16_t mV][uint16_t warning limit] */
#define BayEOS_BufferInfo 0x17 /*(v1.5) [0x2][0x17] -> returns [0x3][0x17][uint32_t read][uint32_t write][uint32_t end][uint32_t length][int8_t framesize][uint16_t sampling_int] */
#define BayEOS_GetLoggingDisabled 0x18 /*(v1.6) [0x2][0x18] -> returns [0x3][0x18][uint8_t _logging_disabled]*/
#define BayEOS_SetLoggingDisabled 0x19 /*(v1.6) [0x2][0x19][uint8_t 0/1] -> returns [0x3][0x19][uint8_t _logging_disabled]*/
#define BayEOS_GetChannelMap 0x1a /*(v1.6) [0x2][0x1a] -> returns [0x3][0x1a][char ch1;ch2;ch3;ch4....]*/
#define BayEOS_GetUnitMap 0x1b /*(v1.6) [0x2][0x1b] -> returns [0x3][0x1b][char unit1;unit2;....]*/
 
#ifndef BayEOS_MAX_PAYLOAD
#define BayEOS_MAX_PAYLOAD 100
#endif
 
 
 
#include <BayEOSBuffer.h>
 
 
class BayEOS {
public:
    BayEOS(void) {
        _buffer=NULL;
    }
    virtual uint8_t sendPayload(void)=0;
 
    virtual uint8_t readIntoPayload(int timeout=5000){return 0;};
 
    virtual int available(void){ return 0;};
 
    uint8_t sendError(const char* s);
 
    uint8_t sendMessage(const char* s);
 
    uint8_t createMessage(const char* s, uint8_t checksum=0, uint8_t frametype=BayEOS_Message);
 
    uint8_t createActionResponse(uint8_t key, uint8_t status);
 
    void startFrame(void);
 
    void startFrame(uint8_t type);
 
    void startOriginFrame(const char* o, uint8_t routed=0);
 
    void startDataFrame(uint8_t subtype=BayEOS_Float32le,uint8_t checksum=0);
 
    void startDataFrameWithOrigin(uint8_t subtype,const char* o,uint8_t checksum=0,uint8_t routed=0);
 
    uint8_t addChannelValue(float v, uint8_t channel_number=0);
    uint8_t addChannelValue(double v, uint8_t channel_number=0);
    uint8_t addChannelValue(long v, uint8_t channel_number=0);
    uint8_t addChannelValue(unsigned long v, uint8_t channel_number=0);
    uint8_t addChannelValue(int v, uint8_t channel_number=0);
    uint8_t addChannelValue(unsigned int v, uint8_t channel_number=0);
    uint8_t addChannelValue(int8_t v, uint8_t channel_number=0);
    uint8_t addChannelValue(uint8_t v, uint8_t channel_number=0);
 
    uint8_t addChannelValue(float v, const char* channel_label);
    uint8_t addChannelValue(double v, const char* channel_label);
    uint8_t addChannelValue(long v, const char* channel_label);
    uint8_t addChannelValue(unsigned long v, const char* channel_label);
    uint8_t addChannelValue(int v, const char* channel_label);
    uint8_t addChannelValue(unsigned int v, const char* channel_label);
    uint8_t addChannelValue(int8_t v, const char* channel_label);
    uint8_t addChannelValue(uint8_t v, const char* channel_label);
 
    /*
     * Add Checksum at end of frame
     */
    uint8_t addChecksum(void);
 
    /*
     * tries to validate checksum of payload
     * returns
     *  0 on success
     *  1 on checksum error
     *  2 on no checksum
     */
    uint8_t validateChecksum(void);
 
    void startRoutedFrame(uint16_t sourceMyID,uint16_t sourcePANID,uint8_t rssi=0);
 
    void startDelayedFrame(unsigned long delay);
 
    void startDelayedSecondFrame(unsigned long delay);
    void startRF24Frame(uint8_t pipe);
 
    void startTimestampFrame(unsigned long timestamp);
    void startCommand(uint8_t cmd_api);
 
    void startCommandResponse(uint8_t cmd_api);
 
    uint8_t addToPayload(uint8_t b);
 
    uint8_t addToPayload(const void* p,uint8_t length);
 
    uint8_t addToPayload(const uint8_t* c);
 
    uint8_t addToPayload(const char* s);
 
    uint8_t addToPayload(float f);
 
    uint8_t addToPayload(unsigned long l);
 
    uint8_t addToPayload(long l);
 
    uint8_t addToPayload(int w);
 
    uint8_t addToPayload(uint16_t w);
 
 
    uint8_t getPayloadBytesLeft(void) const;
 
    uint8_t getPayloadLength(void) const;
 
    uint8_t getPacketLength(void) const;
 
    const uint8_t *getPayload(void) const;
 
    /*
     * get a byte from payload
     */
    uint8_t getPayload(uint8_t index) const;
 
 
    uint8_t sendOrBuffer(void);
 
    uint8_t sendFromBuffer(void);
 
    uint8_t writeToBuffer(void);
 
    uint8_t readFromBuffer(void);
 
    uint8_t readBinaryFromBuffer(unsigned long pos);
 
    uint8_t readBinaryFromBuffer(unsigned long pos,unsigned long end, unsigned long vpos);
 
    void setBuffer(BayEOSBuffer &buffer, uint16_t max_skip=0) {
        _buffer = &buffer;
        _max_skip=max_skip;
        _skip_counter=0;
        _failure_counter=0;
    }
 
    uint8_t _payload[BayEOS_MAX_PAYLOAD];
    uint8_t _next;
    uint8_t _success;
    uint8_t _failure_counter; //counts send failures
    uint16_t _max_skip; //maximum number of packets to write to buffer before next try
    uint16_t _skip_counter; //skip counter
    BayEOSBuffer* _buffer;
};
 
 
inline uint8_t BayEOS::addToPayload(uint8_t b){
    if(_next<BayEOS_MAX_PAYLOAD){
        _payload[_next]=b;
        _next++;
        return 1;
    }
    return 0;
 
}
#endif