Doug Anson / endpoint_nsp

nsp specific components for the NSP version of the impact endpoint

Dependents:   mbed_nsp_endpoint_ublox_cellular mbed_nsp_endpoint_ublox_ethernet mbed_nsp_endpoint_nxp

MBEDEndpoint.cpp@5:94d000e6fa70, 2014-03-28 (annotated)

Committer:
ansond
Date:
Fri Mar 28 17:53:14 2014 +0000
Revision:
5:94d000e6fa70
Parent:
4:7f7fe167d9c0
Child:
6:edf306673e54
updates

Who changed what in which revision?

UserRevisionLine numberNew contents of line
ansond 0:e1c4378df3fe 1 /* Copyright C2013 Doug Anson, MIT License
ansond 0:e1c4378df3fe 2 *
ansond 0:e1c4378df3fe 3 * Permission is hereby granted, free of charge, to any person obtaining a copy of this software
ansond 0:e1c4378df3fe 4 * and associated documentation files the "Software", to deal in the Software without restriction,
ansond 0:e1c4378df3fe 5 * including without limitation the rights to use, copy, modify, merge, publish, distribute,
ansond 0:e1c4378df3fe 6 * sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is
ansond 0:e1c4378df3fe 7 * furnished to do so, subject to the following conditions:
ansond 0:e1c4378df3fe 8 *
ansond 0:e1c4378df3fe 9 * The above copyright notice and this permission notice shall be included in all copies or
ansond 0:e1c4378df3fe 10 * substantial portions of the Software.
ansond 0:e1c4378df3fe 11 *
ansond 0:e1c4378df3fe 12 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING
ansond 0:e1c4378df3fe 13 * BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
ansond 0:e1c4378df3fe 14 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
ansond 0:e1c4378df3fe 15 * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
ansond 0:e1c4378df3fe 16 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
ansond 0:e1c4378df3fe 17 */
ansond 0:e1c4378df3fe 18
ansond 0:e1c4378df3fe 19 #include "NSPTransport.h"
ansond 0:e1c4378df3fe 20 #include "MBEDEndpoint.h"
ansond 0:e1c4378df3fe 21
ansond 4:7f7fe167d9c0 22 // Light Personality Support: MBED Light support
ansond 0:e1c4378df3fe 23 #include "MBEDLight.h"
ansond 0:e1c4378df3fe 24
ansond 4:7f7fe167d9c0 25 // Light Personality Support: NSP Resource Factory
ansond 4:7f7fe167d9c0 26 #include "NSPLightResourceFactory.h"
ansond 0:e1c4378df3fe 27
ansond 4:7f7fe167d9c0 28 // Light Personality Support: NSP Actions we can act on
ansond 0:e1c4378df3fe 29 #include "NSPLightDimmerAction.h"
ansond 0:e1c4378df3fe 30 #include "NSPLightSwitchAction.h"
ansond 0:e1c4378df3fe 31
ansond 0:e1c4378df3fe 32 // shutdown endpoint reference
ansond 0:e1c4378df3fe 33 extern void closedown(int code);
ansond 0:e1c4378df3fe 34
ansond 0:e1c4378df3fe 35 // default constructor
ansond 5:94d000e6fa70 36 MBEDEndpoint::MBEDEndpoint(ErrorHandler *error_handler,EthernetInterface *ethernet) : BaseClass(error_handler,NULL) {
ansond 0:e1c4378df3fe 37 bool success = true;
ansond 0:e1c4378df3fe 38 this->m_preferences = NULL;
ansond 0:e1c4378df3fe 39 this->m_instance_id = 0;
ansond 0:e1c4378df3fe 40 memset(this->m_lcd_status,0,TEMP_BUFFER_LEN+1);
ansond 0:e1c4378df3fe 41 memset(this->m_nsp_address,0,PREFERENCE_VALUE_LEN+1);
ansond 0:e1c4378df3fe 42 for(int i=0;i<NUM_TRANSPORTS;++i) this->m_transports[i] = NULL;
ansond 5:94d000e6fa70 43 this->logger()->setEndpoint((void *)this);
ansond 0:e1c4378df3fe 44 if (success) this->initPreferences();
ansond 0:e1c4378df3fe 45 if (success) this->initEndpointName();
ansond 0:e1c4378df3fe 46 if (success) this->logger()->turnLEDBlue();
ansond 0:e1c4378df3fe 47 #ifdef MAC_ADDRESS
ansond 0:e1c4378df3fe 48 extern char fmt_mac[RESOURCE_VALUE_LEN+1];
ansond 0:e1c4378df3fe 49 if (success)this->logger()->log("%s (MAC: %s)",ENDPOINT_VERSION_ANNOUNCE,fmt_mac);
ansond 0:e1c4378df3fe 50 #else
ansond 0:e1c4378df3fe 51 if (success)this->logger()->log(ENDPOINT_VERSION_ANNOUNCE);
ansond 0:e1c4378df3fe 52 #endif
ansond 0:e1c4378df3fe 53 if (success) this->initNSPAddress();
ansond 0:e1c4378df3fe 54 if (PL_ENABLE && success) this->logger()->log("Philips Light ID: %d Philips Gateway IP: %s",PL_LIGHT_ID,PL_GW_ADDRESS);
ansond 0:e1c4378df3fe 55 if (success) success = this->initializeEthernet(ethernet);
ansond 0:e1c4378df3fe 56 if (success) this->logger()->turnLEDYellow();
ansond 0:e1c4378df3fe 57 if (success) success = this->initializeTransports();
ansond 4:7f7fe167d9c0 58 if (success) success = this->initializePersonalities();
ansond 0:e1c4378df3fe 59 if (success) this->logger()->turnLEDOrange();
ansond 0:e1c4378df3fe 60 this->logger()->lcdStatusOnly(true);
ansond 0:e1c4378df3fe 61 if (!success) closedown(2);
ansond 0:e1c4378df3fe 62 }
ansond 0:e1c4378df3fe 63
ansond 0:e1c4378df3fe 64 // default destructor
ansond 0:e1c4378df3fe 65 MBEDEndpoint::~MBEDEndpoint() {
ansond 0:e1c4378df3fe 66 bool success = true;
ansond 0:e1c4378df3fe 67 if (success) this->logger()->turnLEDYellow();
ansond 4:7f7fe167d9c0 68 if (success) success = this->closePersonalities();
ansond 0:e1c4378df3fe 69 if (success) success = this->closeTransports();
ansond 0:e1c4378df3fe 70 if (success) success = this->closeEthernet();
ansond 0:e1c4378df3fe 71 if (success) this->logger()->turnLEDBlue();
ansond 0:e1c4378df3fe 72 }
ansond 0:e1c4378df3fe 73
ansond 0:e1c4378df3fe 74 // initialize our preferences
ansond 0:e1c4378df3fe 75 void MBEDEndpoint::initPreferences() { if (this->m_preferences == NULL) this->m_preferences = new Preferences(this->logger()); }
ansond 0:e1c4378df3fe 76
ansond 0:e1c4378df3fe 77 // get our preferences
ansond 0:e1c4378df3fe 78 Preferences *MBEDEndpoint::preferences() { return this->m_preferences; }
ansond 0:e1c4378df3fe 79
ansond 0:e1c4378df3fe 80 // initialize the NSP address from the configuration
ansond 0:e1c4378df3fe 81 void MBEDEndpoint::initNSPAddress() {
ansond 0:e1c4378df3fe 82 memset(this->m_nsp_address,0,PREFERENCE_VALUE_LEN+1);
ansond 0:e1c4378df3fe 83 this->preferences()->getPreference("nsp_address",this->m_nsp_address,PREFERENCE_VALUE_LEN,NSP_ADDRESS);
ansond 0:e1c4378df3fe 84 this->logger()->log("NSP IP: %s PORT: %d",this->getNSPAddress(),NSP_PORT);
ansond 0:e1c4378df3fe 85 }
ansond 0:e1c4378df3fe 86
ansond 0:e1c4378df3fe 87 // get our NSP address
ansond 0:e1c4378df3fe 88 char *MBEDEndpoint::getNSPAddress() { return this->m_nsp_address; }
ansond 0:e1c4378df3fe 89
ansond 0:e1c4378df3fe 90 // get our LCD status
ansond 0:e1c4378df3fe 91 char *MBEDEndpoint::getLCDStatus() {
ansond 0:e1c4378df3fe 92 memset(this->m_lcd_status,0,TEMP_BUFFER_LEN+1);
ansond 0:e1c4378df3fe 93
ansond 0:e1c4378df3fe 94 // look at Light#0 to determine the IOC linkage ID...
ansond 4:7f7fe167d9c0 95 char *ioc = this->m_personalities[0]->getResourceFactory()->getResourceValue(EXTERNAL_LINKAGE_RESOURCE);
ansond 0:e1c4378df3fe 96
ansond 0:e1c4378df3fe 97 // color our LED depending on whether we have IOC linkage or not...
ansond 4:7f7fe167d9c0 98 if (ioc == NULL || strcmp(ioc,EXTERNAL_LINKAGE_UNSET) == 0) this->logger()->turnLEDOrange();
ansond 0:e1c4378df3fe 99 else this->logger()->turnLEDGreen();
ansond 0:e1c4378df3fe 100
ansond 0:e1c4378df3fe 101 sprintf(this->m_lcd_status,"Node: %s\nNSP IP: %s\nIOC Link: %s",this->getEndpointName(),this->getNSPAddress(),ioc);
ansond 0:e1c4378df3fe 102 return this->m_lcd_status;
ansond 0:e1c4378df3fe 103 }
ansond 4:7f7fe167d9c0 104
ansond 4:7f7fe167d9c0 105 // initialize our Personalities
ansond 4:7f7fe167d9c0 106 bool MBEDEndpoint::initializePersonalities() {
ansond 4:7f7fe167d9c0 107 #ifdef LIGHT_PERSONALITY
ansond 4:7f7fe167d9c0 108 return this->initializeLights();
ansond 4:7f7fe167d9c0 109 #else
ansond 4:7f7fe167d9c0 110 return false;
ansond 4:7f7fe167d9c0 111 #endif
ansond 4:7f7fe167d9c0 112 }
ansond 0:e1c4378df3fe 113
ansond 0:e1c4378df3fe 114 // initialize the Lights
ansond 0:e1c4378df3fe 115 bool MBEDEndpoint::initializeLights() {
ansond 4:7f7fe167d9c0 116 int index = this->preferences()->getIntPreference("endpoint_id",PERSONALITY_NAME_INDEX);
ansond 4:7f7fe167d9c0 117 this->logger()->log("Initializing Personality(Light)...");
ansond 4:7f7fe167d9c0 118 for(int i=0;i<NUM_PERSONALITY_INSTANCES;++i) {
ansond 4:7f7fe167d9c0 119 this->m_personalities[i] = new MBEDLight(this->logger(),this->m_transports,i+index,this);
ansond 4:7f7fe167d9c0 120 ((Light *)this->m_personalities[i])->setDimmerAction(new NSPLightDimmerAction(this->logger(),(Light *)this->m_personalities[i]));
ansond 4:7f7fe167d9c0 121 ((Light *)this->m_personalities[i])->setSwitchAction(new NSPLightSwitchAction(this->logger(),(Light *)this->m_personalities[i]));
ansond 0:e1c4378df3fe 122 }
ansond 0:e1c4378df3fe 123 return true;
ansond 0:e1c4378df3fe 124 }
ansond 0:e1c4378df3fe 125
ansond 0:e1c4378df3fe 126 // send any observations we may have
ansond 0:e1c4378df3fe 127 void MBEDEndpoint::sendObservations() {
ansond 4:7f7fe167d9c0 128 for(int i=0;i<NUM_PERSONALITY_INSTANCES;++i) {
ansond 4:7f7fe167d9c0 129 if (this->m_personalities[i] != NULL) {
ansond 4:7f7fe167d9c0 130 NSPResourceFactory *resource_factory = (NSPResourceFactory *)(this->m_personalities[i]->getResourceFactory());
ansond 4:7f7fe167d9c0 131 if (resource_factory != NULL) resource_factory->sendObservations();
ansond 0:e1c4378df3fe 132 }
ansond 0:e1c4378df3fe 133 }
ansond 0:e1c4378df3fe 134 }
ansond 0:e1c4378df3fe 135
ansond 0:e1c4378df3fe 136 // initialize our ResourceFactory
ansond 4:7f7fe167d9c0 137 ResourceFactory *MBEDEndpoint::initResourceFactory() {
ansond 4:7f7fe167d9c0 138 #ifdef LIGHT_PERSONALITY
ansond 4:7f7fe167d9c0 139 return new NSPLightResourceFactory(this->logger(),(void *)this);
ansond 4:7f7fe167d9c0 140 #else
ansond 4:7f7fe167d9c0 141 return NULL;
ansond 4:7f7fe167d9c0 142 #endif
ansond 4:7f7fe167d9c0 143 }
ansond 0:e1c4378df3fe 144
ansond 0:e1c4378df3fe 145 // Initialize the Endpoint Name - will be the first Light resource name (and there must be one...)
ansond 0:e1c4378df3fe 146 void MBEDEndpoint::initEndpointName() {
ansond 4:7f7fe167d9c0 147 this->m_instance_id = this->preferences()->getIntPreference("endpoint_id",PERSONALITY_NAME_INDEX);
ansond 4:7f7fe167d9c0 148 memset(_endpoint_name,0,PERSONALITY_NAME_LEN+1);
ansond 4:7f7fe167d9c0 149 memset(this->m_endpoint_name,0,PERSONALITY_NAME_LEN+1);
ansond 4:7f7fe167d9c0 150 sprintf(this->m_endpoint_name,PERSONALITY_NAME,this->m_instance_id);
ansond 4:7f7fe167d9c0 151 sprintf(_endpoint_name,PERSONALITY_NAME,this->m_instance_id);
ansond 0:e1c4378df3fe 152 }
ansond 0:e1c4378df3fe 153
ansond 0:e1c4378df3fe 154 // get our endpoint name
ansond 0:e1c4378df3fe 155 char *MBEDEndpoint::getEndpointName() { return this->m_endpoint_name; }
ansond 0:e1c4378df3fe 156
ansond 0:e1c4378df3fe 157 // get our instance id
ansond 0:e1c4378df3fe 158 int MBEDEndpoint::getInstanceID() { return this->m_instance_id; }
ansond 0:e1c4378df3fe 159
ansond 0:e1c4378df3fe 160 // initialize a specific transport
ansond 0:e1c4378df3fe 161 bool MBEDEndpoint::initializeTransport(int index,char *key,Transport *transport) {
ansond 0:e1c4378df3fe 162 bool success = false;
ansond 0:e1c4378df3fe 163 if (this->m_transports[index] == NULL) {
ansond 0:e1c4378df3fe 164 this->logger()->log("Initializing %s Transport...", key);
ansond 0:e1c4378df3fe 165 this->m_transports[index] = transport;
ansond 0:e1c4378df3fe 166 if (this->m_transports[index] != NULL) success = this->m_transports[index]->connect();
ansond 0:e1c4378df3fe 167 }
ansond 0:e1c4378df3fe 168 else {
ansond 0:e1c4378df3fe 169 this->logger()->log("%s already connected (OK)...", key);
ansond 0:e1c4378df3fe 170 success = true;
ansond 0:e1c4378df3fe 171 }
ansond 0:e1c4378df3fe 172 return success;
ansond 0:e1c4378df3fe 173 }
ansond 0:e1c4378df3fe 174
ansond 0:e1c4378df3fe 175 // initialize our transports
ansond 0:e1c4378df3fe 176 bool MBEDEndpoint::initializeTransports() {
ansond 0:e1c4378df3fe 177 bool success = true;
ansond 0:e1c4378df3fe 178
ansond 0:e1c4378df3fe 179 if (success == true) {
ansond 0:e1c4378df3fe 180 // NSP Initialization
ansond 5:94d000e6fa70 181 success = this->initializeTransport(NSP_TRANSPORT,"NSP",new NSPTransport(this->logger(),this));
ansond 0:e1c4378df3fe 182 }
ansond 0:e1c4378df3fe 183
ansond 0:e1c4378df3fe 184 if (success == true) {
ansond 0:e1c4378df3fe 185 // HTTP Initialization
ansond 5:94d000e6fa70 186 success = this->initializeTransport(HTTP_TRANSPORT,"HTTP",new HTTPTransport(this->logger(),this));
ansond 0:e1c4378df3fe 187 }
ansond 0:e1c4378df3fe 188
ansond 0:e1c4378df3fe 189 return success;
ansond 0:e1c4378df3fe 190 }
ansond 0:e1c4378df3fe 191
ansond 0:e1c4378df3fe 192 // initialize our Ethernet
ansond 0:e1c4378df3fe 193 bool MBEDEndpoint::initializeEthernet(EthernetInterface *ethernet) {
ansond 0:e1c4378df3fe 194 bool success = false;
ansond 0:e1c4378df3fe 195 this->m_ethernet = ethernet;
ansond 0:e1c4378df3fe 196 if (this->m_ethernet != NULL) {
ansond 0:e1c4378df3fe 197 this->logger()->log("Initializing Ethernet...");
ansond 0:e1c4378df3fe 198
ansond 0:e1c4378df3fe 199 // connect up ethernet
ansond 0:e1c4378df3fe 200 this->m_ethernet->init();
ansond 0:e1c4378df3fe 201 this->m_ethernet->connect();
ansond 0:e1c4378df3fe 202
ansond 0:e1c4378df3fe 203 // display our IP address
ansond 0:e1c4378df3fe 204 char *ipaddr = this->m_ethernet->getIPAddress();
ansond 0:e1c4378df3fe 205 if (ipaddr != NULL && strlen(ipaddr) > 0) {
ansond 0:e1c4378df3fe 206 this->logger()->log("IPAddress: %s",this->m_ethernet->getIPAddress());
ansond 0:e1c4378df3fe 207 success = true;
ansond 0:e1c4378df3fe 208 }
ansond 0:e1c4378df3fe 209 else {
ansond 0:e1c4378df3fe 210 this->logger()->log("Ethernet Not Connected...");
ansond 0:e1c4378df3fe 211 success = false;
ansond 0:e1c4378df3fe 212 }
ansond 0:e1c4378df3fe 213 }
ansond 0:e1c4378df3fe 214 else {
ansond 0:e1c4378df3fe 215 this->logger()->log("No Ethernet instance found");
ansond 0:e1c4378df3fe 216 success = false;
ansond 0:e1c4378df3fe 217 }
ansond 0:e1c4378df3fe 218 return success;
ansond 0:e1c4378df3fe 219 }
ansond 0:e1c4378df3fe 220
ansond 4:7f7fe167d9c0 221 // close down the Personalities
ansond 4:7f7fe167d9c0 222 bool MBEDEndpoint::closePersonalities() {
ansond 0:e1c4378df3fe 223 bool success = true;
ansond 4:7f7fe167d9c0 224 this->logger()->log("Closing down Personalities...");
ansond 0:e1c4378df3fe 225 return success;
ansond 0:e1c4378df3fe 226 }
ansond 0:e1c4378df3fe 227
ansond 0:e1c4378df3fe 228 // close a given transport
ansond 0:e1c4378df3fe 229 bool MBEDEndpoint::closeTransport(int index,char *key) {
ansond 0:e1c4378df3fe 230 this->logger()->log("Closing down %s Transport...", key);
ansond 0:e1c4378df3fe 231 if (this->m_transports[index] != NULL) delete this->m_transports[index];
ansond 0:e1c4378df3fe 232 return true;
ansond 0:e1c4378df3fe 233 }
ansond 0:e1c4378df3fe 234
ansond 0:e1c4378df3fe 235 // close down our transports
ansond 0:e1c4378df3fe 236 bool MBEDEndpoint::closeTransports() {
ansond 0:e1c4378df3fe 237 bool success = true;
ansond 0:e1c4378df3fe 238
ansond 0:e1c4378df3fe 239 if (success) {
ansond 0:e1c4378df3fe 240 // close NSP
ansond 0:e1c4378df3fe 241 success = this->closeTransport(NSP_TRANSPORT,"NSP");
ansond 0:e1c4378df3fe 242 }
ansond 0:e1c4378df3fe 243
ansond 0:e1c4378df3fe 244 return success;
ansond 0:e1c4378df3fe 245 }
ansond 0:e1c4378df3fe 246
ansond 0:e1c4378df3fe 247 // close down our Ethernet
ansond 0:e1c4378df3fe 248 bool MBEDEndpoint::closeEthernet() {
ansond 0:e1c4378df3fe 249 this->logger()->log("Closing down Ethernet...");
ansond 0:e1c4378df3fe 250 if (this->m_ethernet != NULL) this->m_ethernet->disconnect();
ansond 0:e1c4378df3fe 251 return true;
ansond 0:e1c4378df3fe 252 }
ansond 0:e1c4378df3fe 253
ansond 0:e1c4378df3fe 254 // main running loop
ansond 0:e1c4378df3fe 255 void MBEDEndpoint::run() {
ansond 0:e1c4378df3fe 256 this->logger()->log("Endpoint Main Loop");
ansond 0:e1c4378df3fe 257 this->m_transports[NSP_TRANSPORT]->checkAndProcess();
ansond 0:e1c4378df3fe 258 }
ansond 0:e1c4378df3fe 259