PayloadSimple.h

00001 /** IoT Gateway RFM12B payload Simple format handling
00002  *
00003  * @author Andrew Lindsay
00004  *
00005  * @section LICENSE
00006  *
00007  * Copyright (c) 2012 Andrew Lindsay (andrew [at] thiseldo [dot] co [dot] uk)
00008  *
00009  * Permission is hereby granted, free of charge, to any person obtaining a copy
00010  * of this software and associated documentation files (the "Software"), to deal
00011  * in the Software without restriction, including without limitation the rights
00012  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
00013  * copies of the Software, and to permit persons to whom the Software is
00014  * furnished to do so, subject to the following conditions:
00015 
00016  * The above copyright notice and this permission notice shall be included in
00017  * all copies or substantial portions of the Software.
00018  * 
00019  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
00020  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
00021  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
00022  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
00023  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
00024  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
00025  * THE SOFTWARE.
00026  * 
00027  * @section DESCRIPTION
00028  * 
00029  * 
00030  */
00031 
00032 #ifndef _PAYLOADSIMPLE_H
00033 #define _PAYLOADSIMPLE_H
00034 
00035 #include "mbed.h"
00036 #include "PayloadDef.h"
00037 
00038 
00039 typedef struct {
00040     int16_t reading;        // Reading
00041 }  __attribute__((packed)) PayloadSimpleReading;
00042 
00043 
00044 /** Simple payload format class
00045  * Format is 2 bytes per reading with low byte first.
00046  *
00047  */
00048 class PayloadSimple: public PayloadDef {
00049 public:
00050     /** Default Constructor
00051      */
00052     PayloadSimple();
00053     
00054     /** Alternative constructor for passing payload
00055      *
00056      * @param pptr  Pointer to payload data
00057      * @param plen  Length of paylod data
00058      */
00059     PayloadSimple( uint8_t *pptr, short plen );
00060 
00061     /** Get the number of readings in a payload
00062      *
00063      * @returns the number of readings found in payload so they can be read
00064      */
00065     virtual short numReadings();
00066 
00067     /** Get a single reading from the payload
00068      *
00069      * @param readingNum The number of the reading, starts from 0 upto number of readings in payload
00070      * @returns Integer representation of reading
00071      */
00072     virtual int reading( short readingNum );
00073 
00074     /** Get the sensor ID for the specified reading within the payload
00075      *
00076      * @param readingNum The number of the reading, starts from 0 upto number of readings in payload
00077      * @returns Integer representation of reading
00078      */
00079     virtual short sensorId( short readingNum );
00080 };
00081 
00082 #endif /* _PAYLOADSIMPLE_H */