Doug Anson / endpoint_mqtt

mqtt specific components for the impact mbed endpoint library

Dependents:   mbed_mqtt_endpoint_ublox_ethernet mbed_mqtt_endpoint_ublox_cellular mbed_mqtt_endpoint_nxp

MBEDEndpoint.h@51:15c81f725ba2, 2014-08-28 (annotated)

Committer:
ansond
Date:
Thu Aug 28 20:56:49 2014 +0000
Revision:
51:15c81f725ba2
Parent:
46:32a7545dde45
Child:
56:789a1a8c5ebe
added support for status reporting

Who changed what in which revision?

UserRevisionLine numberNew contents of line
ansond 0:a3fc1c6ef150 1 /* Copyright C2013 Doug Anson, MIT License
ansond 0:a3fc1c6ef150 2 *
ansond 0:a3fc1c6ef150 3 * Permission is hereby granted, free of charge, to any person obtaining a copy of this software
ansond 0:a3fc1c6ef150 4 * and associated documentation files the "Software", to deal in the Software without restriction,
ansond 0:a3fc1c6ef150 5 * including without limitation the rights to use, copy, modify, merge, publish, distribute,
ansond 0:a3fc1c6ef150 6 * sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is
ansond 0:a3fc1c6ef150 7 * furnished to do so, subject to the following conditions:
ansond 0:a3fc1c6ef150 8 *
ansond 0:a3fc1c6ef150 9 * The above copyright notice and this permission notice shall be included in all copies or
ansond 0:a3fc1c6ef150 10 * substantial portions of the Software.
ansond 0:a3fc1c6ef150 11 *
ansond 0:a3fc1c6ef150 12 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING
ansond 0:a3fc1c6ef150 13 * BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
ansond 0:a3fc1c6ef150 14 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
ansond 0:a3fc1c6ef150 15 * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
ansond 0:a3fc1c6ef150 16 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
ansond 0:a3fc1c6ef150 17 */
ansond 0:a3fc1c6ef150 18
ansond 0:a3fc1c6ef150 19 #ifndef _MBED_ENDPOINT_H_
ansond 0:a3fc1c6ef150 20 #define _MBED_ENDPOINT_H_
ansond 0:a3fc1c6ef150 21
ansond 11:9ae0fe4517c1 22 // BaseClass support
ansond 11:9ae0fe4517c1 23 #include "BaseClass.h"
ansond 0:a3fc1c6ef150 24
ansond 0:a3fc1c6ef150 25 // MBED to IOC Resource Map
ansond 0:a3fc1c6ef150 26 #include "MBEDToIOCResourceMap.h"
ansond 0:a3fc1c6ef150 27
ansond 0:a3fc1c6ef150 28 // Transport support
ansond 0:a3fc1c6ef150 29 #include "MQTTTransport.h"
ansond 0:a3fc1c6ef150 30 #include "IOCHTTPTransport.h"
ansond 0:a3fc1c6ef150 31
ansond 6:2db2c7e75ad9 32 // IOC Endpoint support
ansond 6:2db2c7e75ad9 33 #include "IOCEndpoint.h"
ansond 6:2db2c7e75ad9 34
ansond 9:28bd23e25409 35 // Personality Support
ansond 9:28bd23e25409 36 #include "Personality.h"
ansond 0:a3fc1c6ef150 37
ansond 0:a3fc1c6ef150 38 // ResourceFactory Support
ansond 0:a3fc1c6ef150 39 #include "ResourceFactory.h"
ansond 0:a3fc1c6ef150 40
ansond 0:a3fc1c6ef150 41 // Preferences Support
ansond 0:a3fc1c6ef150 42 #include "Preferences.h"
ansond 16:4cc5df8bf10c 43
ansond 18:8ab7aa1dbb41 44 // network selection
ansond 18:8ab7aa1dbb41 45 #ifdef CELLULAR_NETWORK
ansond 18:8ab7aa1dbb41 46 // Cellular
ansond 18:8ab7aa1dbb41 47 #include "MBEDUbloxCellRadio.h"
ansond 18:8ab7aa1dbb41 48 #include "MBEDUbloxGPS.h"
ansond 18:8ab7aa1dbb41 49 #else
ansond 18:8ab7aa1dbb41 50 // Ethernet
ansond 16:4cc5df8bf10c 51 #include "EthernetInterface.h"
ansond 16:4cc5df8bf10c 52 #endif
ansond 0:a3fc1c6ef150 53
ansond 11:9ae0fe4517c1 54 class MBEDEndpoint : public BaseClass {
ansond 0:a3fc1c6ef150 55 private:
ansond 18:8ab7aa1dbb41 56 #ifdef CELLULAR_NETWORK
ansond 18:8ab7aa1dbb41 57 MBEDUbloxCellRadio *m_cellular_modem; // cell modem
ansond 18:8ab7aa1dbb41 58 MBEDUbloxGPS *m_gps; // GPS receiver
ansond 18:8ab7aa1dbb41 59 #else
ansond 15:363a3299e41a 60 EthernetInterface *m_ethernet; // ethernet interface
ansond 15:363a3299e41a 61 #endif
ansond 7:8a4a61202b36 62 Transport *m_transports[NUM_TRANSPORTS]; // our transport
ansond 9:28bd23e25409 63 Personality *m_personalities[NUM_PERSONALITY_INSTANCES]; // our personality instances (at least 1)
ansond 7:8a4a61202b36 64 char m_endpoint_name[PERSONALITY_NAME_LEN+1]; // our endpoint name (personality[0])
ansond 7:8a4a61202b36 65 MBEDToIOCResourceMap *m_map; // IOC <--> MBED resource mapping
ansond 7:8a4a61202b36 66 Preferences *m_preferences; // preference support
ansond 7:8a4a61202b36 67 char m_lcd_status[TEMP_BUFFER_LEN+1]; // LCD status buffer
ansond 7:8a4a61202b36 68 char m_gw_address[PREFERENCE_VALUE_LEN+1]; // GW address buffer
ansond 46:32a7545dde45 69 char m_gw_port[PREFERENCE_VALUE_LEN+1]; // GW port buffer
ansond 7:8a4a61202b36 70 int m_instance_id; // instance ID for this endpoint
ansond 51:15c81f725ba2 71 void *m_status_reporter; // status reporter (optional)
ansond 0:a3fc1c6ef150 72
ansond 0:a3fc1c6ef150 73 public:
ansond 51:15c81f725ba2 74 MBEDEndpoint(ErrorHandler *error_handler,void *transport,void *status_reporter,void *extra);
ansond 11:9ae0fe4517c1 75 virtual ~MBEDEndpoint();
ansond 0:a3fc1c6ef150 76 ResourceFactory *initResourceFactory();
ansond 0:a3fc1c6ef150 77 void run();
ansond 0:a3fc1c6ef150 78
ansond 7:8a4a61202b36 79 int indexOfPersonality(char *name);
ansond 0:a3fc1c6ef150 80 ResourceFactory *getResources(int index);
ansond 0:a3fc1c6ef150 81
ansond 7:8a4a61202b36 82 bool loadPersonalities();
ansond 7:8a4a61202b36 83 bool updatePersonalities();
ansond 7:8a4a61202b36 84 bool updatePersonality(int index);
ansond 0:a3fc1c6ef150 85
ansond 0:a3fc1c6ef150 86 char *getEndpointName();
ansond 0:a3fc1c6ef150 87 char *getGWAddress();
ansond 46:32a7545dde45 88 char *getGWPort();
ansond 0:a3fc1c6ef150 89
ansond 0:a3fc1c6ef150 90 char *getLCDStatus();
ansond 0:a3fc1c6ef150 91
ansond 0:a3fc1c6ef150 92 int getInstanceID();
ansond 0:a3fc1c6ef150 93
ansond 0:a3fc1c6ef150 94 MBEDToIOCResourceMap *getMap();
ansond 0:a3fc1c6ef150 95
ansond 29:ac6390032cec 96 Preferences *preferences();
ansond 29:ac6390032cec 97
ansond 51:15c81f725ba2 98 void extraEventLoopWork();
ansond 51:15c81f725ba2 99
ansond 0:a3fc1c6ef150 100 protected:
ansond 0:a3fc1c6ef150 101
ansond 0:a3fc1c6ef150 102 private:
ansond 7:8a4a61202b36 103 bool initializePersonalities();
ansond 7:8a4a61202b36 104 bool closePersonalities();
ansond 5:1ba6e68bf50e 105
ansond 5:1ba6e68bf50e 106 ResourceFactory *initLightResourceFactory();
ansond 7:8a4a61202b36 107 bool initializeLights();
ansond 7:8a4a61202b36 108
ansond 0:a3fc1c6ef150 109 void initPreferences();
ansond 0:a3fc1c6ef150 110 void initGWAddress();
ansond 0:a3fc1c6ef150 111 void initEndpointName();
ansond 0:a3fc1c6ef150 112 bool initializeTransport(int index,char *key,Transport *transport);
ansond 0:a3fc1c6ef150 113 bool initializeTransports();
ansond 7:8a4a61202b36 114 bool loadPersonality(Personality *instance);
ansond 7:8a4a61202b36 115 bool updatePersonality(Personality *instance);
ansond 0:a3fc1c6ef150 116 bool closeTransport(int index,char *key);
ansond 0:a3fc1c6ef150 117 bool closeTransports();
ansond 12:0114a6493457 118
ansond 18:8ab7aa1dbb41 119 #ifdef CELLULAR_NETWORK
ansond 44:2740794b059a 120 bool initializeCellularModem(void *modem);
ansond 40:72884152baaa 121 bool initializeGPSReceiver(void *gps);
ansond 18:8ab7aa1dbb41 122 bool closeCellularModem();
ansond 18:8ab7aa1dbb41 123 bool closeGPSReceiver();
ansond 18:8ab7aa1dbb41 124 #else
ansond 18:8ab7aa1dbb41 125 bool initializeEthernet(EthernetInterface *ethernet);
ansond 18:8ab7aa1dbb41 126 bool closeEthernet();
ansond 15:363a3299e41a 127 #endif
ansond 0:a3fc1c6ef150 128 };
ansond 0:a3fc1c6ef150 129
ansond 0:a3fc1c6ef150 130 #endif // _MBED_ENDPOINT_H_