Dan Lopez / osisoft-omf

Separate library that holds helper functions for the main OMF code.

osisoft-omf.cpp@14:6ed67a160616, 2018-05-03 (annotated)

Committer:
danielelopez
Date:
Thu May 03 20:07:42 2018 +0000
Revision:
14:6ed67a160616
Parent:
13:61d3de73a844
Child:
15:32ada27d82b4
Updated copyright year

Who changed what in which revision?

UserRevisionLine numberNew contents of line
danielelopez 14:6ed67a160616 1 //Copyright 2018 OSIsoft, LLC
danielelopez 0:6156b29d3c91 2 //
danielelopez 0:6156b29d3c91 3 //Licensed under the Apache License, Version 2.0 (the "License");
danielelopez 0:6156b29d3c91 4 //you may not use this file except in compliance with the License.
danielelopez 0:6156b29d3c91 5 //You may obtain a copy of the License at
danielelopez 0:6156b29d3c91 6 //
danielelopez 0:6156b29d3c91 7 //<http://www.apache.org/licenses/LICENSE-2.0>
danielelopez 0:6156b29d3c91 8 //
danielelopez 0:6156b29d3c91 9 //Unless required by applicable law or agreed to in writing, software
danielelopez 0:6156b29d3c91 10 //distributed under the License is distributed on an "AS IS" BASIS,
danielelopez 0:6156b29d3c91 11 //WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
danielelopez 0:6156b29d3c91 12 //See the License for the specific language governing permissions and
danielelopez 0:6156b29d3c91 13 //limitations under the License.
danielelopez 0:6156b29d3c91 14
danielelopez 0:6156b29d3c91 15 #include "osisoft-omf.h"
danielelopez 0:6156b29d3c91 16 #include "mbed.h"
danielelopez 0:6156b29d3c91 17 #include "https_request.h"
danielelopez 0:6156b29d3c91 18 #include "ntp-client/NTPClient.h"
danielelopez 10:844e209f1d79 19 #include "config.egressSettings.h"
danielelopez 8:e5fe40b77f8f 20 #include "config.SSLCertificates.h"
danielelopez 8:e5fe40b77f8f 21 #include "config.producerToken.h"
danielelopez 0:6156b29d3c91 22
danielelopez 0:6156b29d3c91 23 // ---------------------------------------------------------------------------------------------------
danielelopez 0:6156b29d3c91 24
danielelopez 0:6156b29d3c91 25 // The clock is set usign NTP; if that fails, the clock defaults to the below time
danielelopez 0:6156b29d3c91 26 const int DEFAULT_HARD_CODED_UTC_TIME = 1513175347;
danielelopez 0:6156b29d3c91 27
danielelopez 0:6156b29d3c91 28 // ---------------------------------------------------------------------------------------------------
danielelopez 0:6156b29d3c91 29
danielelopez 0:6156b29d3c91 30 // ************************************************************************
danielelopez 0:6156b29d3c91 31 // Helper function: prints out an HTTP response
danielelopez 0:6156b29d3c91 32 // ************************************************************************
danielelopez 0:6156b29d3c91 33
danielelopez 1:1c31b413ba0c 34 void OMFLib_dump_response(HttpResponse* res)
danielelopez 0:6156b29d3c91 35 {
danielelopez 1:1c31b413ba0c 36 printf("\n\r----- HTTPS POST response -----\n\r");
danielelopez 0:6156b29d3c91 37 // Print the status code
danielelopez 1:1c31b413ba0c 38 mbedtls_printf("Status: %d - %s\n\r", res->get_status_code(), res->get_status_message().c_str());
danielelopez 0:6156b29d3c91 39 // Print the headers
danielelopez 1:1c31b413ba0c 40 mbedtls_printf("Response headers:\n\r");
danielelopez 0:6156b29d3c91 41 for (size_t ix = 0; ix < res->get_headers_length(); ix++) {
danielelopez 1:1c31b413ba0c 42 mbedtls_printf("\t%s: %s\n\r", res->get_headers_fields()[ix]->c_str(), res->get_headers_values()[ix]->c_str());
danielelopez 0:6156b29d3c91 43 }
danielelopez 0:6156b29d3c91 44 // Print the body
danielelopez 0:6156b29d3c91 45 mbedtls_printf("Response body (%d bytes):\n\n%s", res->get_body_length(), res->get_body_as_string().c_str());
danielelopez 0:6156b29d3c91 46 }
danielelopez 0:6156b29d3c91 47
danielelopez 0:6156b29d3c91 48 // ************************************************************************
danielelopez 0:6156b29d3c91 49 // Helper function that casts floats into strings
danielelopez 0:6156b29d3c91 50 // ************************************************************************
danielelopez 0:6156b29d3c91 51
danielelopez 0:6156b29d3c91 52 string OMFLib_float_to_string(float f) {
danielelopez 0:6156b29d3c91 53 char buffer[20];
danielelopez 0:6156b29d3c91 54 int n = sprintf (buffer, "%f", f);
danielelopez 13:61d3de73a844 55 // Return -1 if a parse failure ocurred
danielelopez 13:61d3de73a844 56 if (string(buffer) == "NaN") {
danielelopez 13:61d3de73a844 57 return string("-1");
danielelopez 13:61d3de73a844 58 } else {
danielelopez 13:61d3de73a844 59 return string(buffer);
danielelopez 13:61d3de73a844 60 }
danielelopez 0:6156b29d3c91 61 }
danielelopez 0:6156b29d3c91 62
danielelopez 0:6156b29d3c91 63 // ************************************************************************
danielelopez 0:6156b29d3c91 64 // Helper function that sends an actual web request
danielelopez 0:6156b29d3c91 65 // ************************************************************************
danielelopez 0:6156b29d3c91 66
danielelopez 0:6156b29d3c91 67 void OMFLib_sendMessageToEndpoint(TLSSocket* socket, const char* action, const char* message_type, const char* body) {
danielelopez 1:1c31b413ba0c 68 printf("\n\r----- HTTPS POST request -----\n\r");
danielelopez 0:6156b29d3c91 69
danielelopez 0:6156b29d3c91 70 // Create the new request
danielelopez 0:6156b29d3c91 71 //HttpsRequest* post_req = new HttpsRequest(network, SSL_CA_PEM, HTTP_POST, TARGET_URL); // Old: doesn't re-use sockets
danielelopez 0:6156b29d3c91 72 HttpsRequest* post_req = new HttpsRequest(socket, HTTP_POST, TARGET_URL);
danielelopez 0:6156b29d3c91 73
danielelopez 0:6156b29d3c91 74 // Turn on debugging - this hides TLS connection information
danielelopez 0:6156b29d3c91 75 post_req->set_debug(true);
danielelopez 0:6156b29d3c91 76
danielelopez 0:6156b29d3c91 77 // Add headers: content type and authentication
danielelopez 0:6156b29d3c91 78 post_req->set_header("Content-Type", "application/json");
danielelopez 0:6156b29d3c91 79
danielelopez 0:6156b29d3c91 80 // Set OMF headers
danielelopez 0:6156b29d3c91 81 post_req->set_header("producertoken", PRODUCER_TOKEN);
danielelopez 0:6156b29d3c91 82 post_req->set_header("messagetype", message_type);
danielelopez 0:6156b29d3c91 83 post_req->set_header("action", action);
danielelopez 0:6156b29d3c91 84 post_req->set_header("messageformat", "JSON");
danielelopez 0:6156b29d3c91 85 post_req->set_header("omfversion", "1.0");
danielelopez 0:6156b29d3c91 86
danielelopez 0:6156b29d3c91 87 // Send the body
danielelopez 0:6156b29d3c91 88 printf("Now sending request...");
danielelopez 1:1c31b413ba0c 89 printf("\n\rOutgoing message headers:\n\tmessagetype: %s\n\taction: %s", message_type, action);
danielelopez 1:1c31b413ba0c 90 printf("\n\rOutgoing message body:\n\t%s\n\r", body);
danielelopez 0:6156b29d3c91 91 HttpResponse* post_res = post_req->send(body, strlen(body));
danielelopez 0:6156b29d3c91 92
danielelopez 0:6156b29d3c91 93 // Check the response for an error
danielelopez 0:6156b29d3c91 94 if (!post_res) {
danielelopez 1:1c31b413ba0c 95 printf("HttpRequest failed (error code %d)\n\r", post_req->get_error());
danielelopez 1:1c31b413ba0c 96 printf("Socket connection status after error: %d\n\r", socket->connected());
danielelopez 0:6156b29d3c91 97 //return 1;
danielelopez 0:6156b29d3c91 98 } else {
danielelopez 0:6156b29d3c91 99 // Print the response
danielelopez 1:1c31b413ba0c 100 OMFLib_dump_response(post_res);
danielelopez 1:1c31b413ba0c 101 }
danielelopez 1:1c31b413ba0c 102
danielelopez 1:1c31b413ba0c 103 // Free up the request object
danielelopez 1:1c31b413ba0c 104 delete post_req;
danielelopez 1:1c31b413ba0c 105 }
danielelopez 1:1c31b413ba0c 106
danielelopez 1:1c31b413ba0c 107 // ************************************************************************
danielelopez 1:1c31b413ba0c 108 // Helper function that sends an actual web request; does not reuse sockets
danielelopez 1:1c31b413ba0c 109 // ************************************************************************
danielelopez 1:1c31b413ba0c 110
danielelopez 1:1c31b413ba0c 111 void OMFLib_sendMessageToEndpoint_NoSocketReuse(NetworkInterface* network, const char* action, const char* message_type, const char* body) {
danielelopez 12:8fb2bb26528f 112
danielelopez 1:1c31b413ba0c 113 printf("\n\r----- HTTPS POST request -----\n\r");
danielelopez 1:1c31b413ba0c 114
danielelopez 1:1c31b413ba0c 115 // Create the new request
danielelopez 1:1c31b413ba0c 116 HttpsRequest* post_req = new HttpsRequest(network, SSL_CA_PEM, HTTP_POST, TARGET_URL);
danielelopez 1:1c31b413ba0c 117
danielelopez 1:1c31b413ba0c 118 // Turn on debugging - this hides TLS connection information
danielelopez 11:e34e1f9bfaec 119 //post_req->set_debug(true);
danielelopez 1:1c31b413ba0c 120
danielelopez 1:1c31b413ba0c 121 // Add headers: content type
danielelopez 1:1c31b413ba0c 122 post_req->set_header("Content-Type", CONTENT_TYPE);
danielelopez 1:1c31b413ba0c 123
danielelopez 1:1c31b413ba0c 124 // Set OMF headers
danielelopez 1:1c31b413ba0c 125 post_req->set_header("producertoken", PRODUCER_TOKEN);
danielelopez 1:1c31b413ba0c 126 post_req->set_header("messagetype", message_type);
danielelopez 1:1c31b413ba0c 127 post_req->set_header("action", action);
danielelopez 1:1c31b413ba0c 128 post_req->set_header("messageformat", OMF_MESSAGE_FORMAT);
danielelopez 1:1c31b413ba0c 129 post_req->set_header("omfversion", OMF_VERSION);
danielelopez 1:1c31b413ba0c 130
danielelopez 1:1c31b413ba0c 131 // Send the body
danielelopez 1:1c31b413ba0c 132 printf("Now sending request... ");
danielelopez 1:1c31b413ba0c 133 //printf("\n\rOutgoing message headers:\n\tmessagetype: %s\n\taction: %s", message_type, action);
danielelopez 1:1c31b413ba0c 134 //printf("\n\rOutgoing message body:\n\t%s\n\r", body);
danielelopez 1:1c31b413ba0c 135 HttpResponse* post_res = post_req->send(body, strlen(body));
danielelopez 12:8fb2bb26528f 136
danielelopez 1:1c31b413ba0c 137 // Check the response for an error
danielelopez 1:1c31b413ba0c 138 if (!post_res) {
danielelopez 1:1c31b413ba0c 139 printf("HttpRequest failed (error code %d)\n\r", post_req->get_error());
danielelopez 1:1c31b413ba0c 140 //return 1;
danielelopez 1:1c31b413ba0c 141 } else {
danielelopez 1:1c31b413ba0c 142 // Print the response
danielelopez 1:1c31b413ba0c 143 printf("Success!\n\r");
danielelopez 1:1c31b413ba0c 144 //OMFLib_dump_response(post_res);
danielelopez 0:6156b29d3c91 145 }
danielelopez 0:6156b29d3c91 146
danielelopez 0:6156b29d3c91 147 // Free up the request object
danielelopez 0:6156b29d3c91 148 delete post_req;
danielelopez 0:6156b29d3c91 149 }
danielelopez 0:6156b29d3c91 150
danielelopez 0:6156b29d3c91 151 // ************************************************************************
danielelopez 0:6156b29d3c91 152 // Gets the current time in the appropriate OMF format
danielelopez 0:6156b29d3c91 153 // ************************************************************************
danielelopez 0:6156b29d3c91 154
danielelopez 0:6156b29d3c91 155 string OMFLib_getCurrentTimeString() {
danielelopez 0:6156b29d3c91 156 // Declar vars
danielelopez 0:6156b29d3c91 157 char timestampBuffer[80];
danielelopez 0:6156b29d3c91 158 time_t now;
danielelopez 0:6156b29d3c91 159 struct tm ts;
danielelopez 0:6156b29d3c91 160
danielelopez 0:6156b29d3c91 161 // Get the current time
danielelopez 0:6156b29d3c91 162 time(&now);
danielelopez 0:6156b29d3c91 163
danielelopez 0:6156b29d3c91 164 // Cast the current time into the correct format
danielelopez 0:6156b29d3c91 165 ts = *localtime(&now);
danielelopez 0:6156b29d3c91 166 strftime(timestampBuffer, sizeof(timestampBuffer), "%Y-%m-%dT%H:%M:%SZ", &ts);
danielelopez 0:6156b29d3c91 167
danielelopez 0:6156b29d3c91 168 // Return the result
danielelopez 0:6156b29d3c91 169 return string(timestampBuffer);
danielelopez 0:6156b29d3c91 170 }
danielelopez 0:6156b29d3c91 171
danielelopez 0:6156b29d3c91 172 // ************************************************************************
danielelopez 9:e2d177cf9135 173 // Sets the clock via NTP via the nwtwork; can point to a local or internet-based server
danielelopez 0:6156b29d3c91 174 // ************************************************************************
danielelopez 0:6156b29d3c91 175
danielelopez 0:6156b29d3c91 176 void OMFLib_syncClockViaNTP(NetworkInterface* network) {
danielelopez 0:6156b29d3c91 177 // Hard-code a start time... see https://www.epochconverter.com/
danielelopez 0:6156b29d3c91 178 set_time(DEFAULT_HARD_CODED_UTC_TIME);
danielelopez 0:6156b29d3c91 179
danielelopez 1:1c31b413ba0c 180 printf("\n\r----- Setting internal clock -----\n\r");
danielelopez 0:6156b29d3c91 181 // See https://github.com/ARMmbed/ntp-client-example/blob/master/main.cpp
danielelopez 0:6156b29d3c91 182
danielelopez 9:e2d177cf9135 183 // Connect the ntp object to the network
danielelopez 0:6156b29d3c91 184 NTPClient ntp(network);
danielelopez 9:e2d177cf9135 185
danielelopez 9:e2d177cf9135 186 // Set the ntp server to either an internet-based server OR to a local server
danielelopez 9:e2d177cf9135 187 ntp.set_server("2.pool.ntp.org", 123);
danielelopez 9:e2d177cf9135 188
danielelopez 9:e2d177cf9135 189 // Get the timestamp via NTP
danielelopez 0:6156b29d3c91 190 time_t timestamp = ntp.get_timestamp();
danielelopez 0:6156b29d3c91 191 if (timestamp > 0) {
danielelopez 0:6156b29d3c91 192 set_time(timestamp);
danielelopez 0:6156b29d3c91 193 printf("Clock set via NTP to UTC %s", ctime(&timestamp));
danielelopez 0:6156b29d3c91 194 } else {
danielelopez 0:6156b29d3c91 195 printf("NTP time sync failed; clock set to %i UTC seconds.", DEFAULT_HARD_CODED_UTC_TIME);
danielelopez 0:6156b29d3c91 196 }
danielelopez 0:6156b29d3c91 197 }