OutputEmonCms.h

00001 /** IoT Gateway Output definition for Open Energy Monitor emonCms 
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 _OUTPUTEMONCMS_H
00033 #define _OUTPUTEMONCMS_H
00034 
00035 #include "iotgateway.h"
00036 #include "mbed.h"
00037 #include "HTTPClient.h"
00038 #include "HTTPText.h"
00039 
00040 /** Output definition class for sending readings to OpenEnergyMonitor emonCms
00041  */
00042 class OutputEmonCms {
00043 public:
00044     /** Default Constructor
00045      */
00046     OutputEmonCms();
00047 
00048     /** Alternative Constructor
00049      *
00050      * @param internalBufferStart An internal buffer used to build up requests.
00051      * @param url  Pointer to API Url
00052      * @param key  Pointer to API key
00053      */
00054     OutputEmonCms( char *internalBufferStart, char *url, char *key );
00055     
00056     /** Set the API Key to use for sending readings to Pachube
00057      * 
00058      * @param key  Pointer to API key
00059      */
00060 //    void setApiKey( char *key );
00061 
00062     /** Initialise output definition object
00063      */
00064     virtual void init();
00065     
00066     /** Add a character pointer reading to output 
00067      * 
00068      * @param dataFeed The feed to update
00069      * @param dataStream The data stream within the feed to update or null if no feed
00070      * @param reading The new value
00071      */
00072     virtual void addReading(char *dataFeed, char *dataStream, char *reading );
00073     
00074     /** Send any collected readings to the api
00075      * 
00076      * @returns -1 for fail, 1 for success
00077      */
00078     virtual int send();
00079 
00080     /** Get the send count
00081      * 
00082      * @returns mumber of API calls made
00083      */
00084     virtual int getSendCount( );
00085 
00086 protected:
00087     int sendCount;
00088     // OEM config
00089     char *apiUrl;
00090     char *apiKey;
00091     char *dataBuffer;
00092     char *dbufPtr;
00093     bool hasData;
00094     
00095 };
00096 
00097 #endif /* _OUTPUTEMONCMS_H */