PayloadV1.h

00001 /** IoT Gateway RFM12B payload V1 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 _PAYLOADV1_H
00033 #define _PAYLOADV1_H
00034 
00035 #include "mbed.h"
00036 #include "PayloadDef.h"
00037 
00038 /**
00039  *
00040  */
00041 
00042 typedef struct {
00043     uint8_t id;             // Sensor ID
00044     int16_t reading;        // Reading
00045 }  __attribute__((packed)) payloadv1Reading;
00046 
00047 /** Payload format class
00048  * Format of each reading is defined above with first byte of payload being a status byte.
00049  *
00050  */
00051 class PayloadV1: public PayloadDef {
00052 public:
00053     /** Default Constructor
00054      */
00055     PayloadV1();
00056 
00057     /** Alternative constructor for passing payload details
00058      *
00059      * @param pptr  Pointer to payload data
00060      * @param plen  Length of paylod data
00061      */
00062     PayloadV1( uint8_t *pptr, short plen );
00063 
00064     /** Get the number of readings in a payload
00065      *
00066      * @returns the number of readings found in payload so they can be read
00067      */
00068     virtual short numReadings();
00069 
00070     /** Get a single reading from the payload
00071      *
00072      * @param readingNum The number of the reading, starts from 0 upto number of readings in payload
00073      * @returns Integer representation of reading
00074      */
00075     virtual int reading( short readingNum );
00076 
00077     /** Get the sensor ID for the specified reading within the payload
00078      *
00079      * @param readingNum The number of the reading, starts from 0 upto number of readings in payload
00080      * @returns Integer representation of reading
00081      */
00082     virtual short sensorId( short readingNum );
00083 
00084 };
00085 
00086 #endif /* _PAYLOADV1_H */