OutputMqtt.h

00001 /** IoT Gateway Output definition for MQTT
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 _OUTPUTMQTT_H
00033 #define _OUTPUTMQTT_H
00034 
00035 #include "iotgateway.h"
00036 #include "mbed.h"
00037 #include "MQTTClient.h"
00038 
00039 /** Implementation of MQTT output class
00040  *
00041  */
00042 class OutputMqtt {
00043 public:
00044     /** Default Constructor
00045      */
00046     OutputMqtt();
00047 
00048     /** Initialise output definition object
00049      */
00050     virtual bool init();
00051     
00052     /** Set the IP address of the host
00053      * 
00054      * @param serverIpAddr IP Addres of host
00055      * @param port         Port to use
00056      * @param username     Username or NULL if not used
00057      * @param password     Password or NULL if not used
00058      */
00059     void initConnection(IpAddr *serverIpAddr, short port, char *username, char *password );
00060 
00061     /** Add a character pointer reading to output 
00062      * 
00063      * @param topic The topic to publish to
00064      * @param unused Unused in this output
00065      * @param reading The new value
00066      */
00067     virtual void addReading(char *topic, char *unused, char *reading );
00068 
00069     /** Send any collected readings
00070      * Does nothing in MQTT as already published 
00071      * 
00072      * @returns -1 for fail, 1 for success
00073      */
00074     virtual int send();
00075     
00076     /** Get the send count
00077      * 
00078      * @returns mumber of API calls made
00079      */
00080     virtual int getSendCount( );
00081 
00082 
00083 protected:
00084     MQTTClient mqtt;
00085     int sendCount;
00086     IpAddr *serverIpAddr;
00087     short port;
00088     char *username;
00089     char *password;
00090 
00091 };
00092 
00093 #endif /* _OUTPUTMQTT_H */