Dan Lopez / osisoft-omf

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

osisoft-omf.cpp@10:844e209f1d79, 2018-03-14 (annotated)

Committer:
danielelopez
Date:
Wed Mar 14 18:47:12 2018 +0000
Revision:
10:844e209f1d79
Parent:
9:e2d177cf9135
Child:
11:e34e1f9bfaec
Updated to remove custom OMF structures

Who changed what in which revision?

UserRevisionLine numberNew contents of line
danielelopez 0:6156b29d3c91 1 //Copyright 2017 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 0:6156b29d3c91 55 return string(buffer);
danielelopez 0:6156b29d3c91 56 }
danielelopez 0:6156b29d3c91 57
danielelopez 0:6156b29d3c91 58 // ************************************************************************
danielelopez 0:6156b29d3c91 59 // Helper function that sends an actual web request
danielelopez 0:6156b29d3c91 60 // ************************************************************************
danielelopez 0:6156b29d3c91 61
danielelopez 0:6156b29d3c91 62 void OMFLib_sendMessageToEndpoint(TLSSocket* socket, const char* action, const char* message_type, const char* body) {
danielelopez 1:1c31b413ba0c 63 printf("\n\r----- HTTPS POST request -----\n\r");
danielelopez 0:6156b29d3c91 64
danielelopez 0:6156b29d3c91 65 // Create the new request
danielelopez 0:6156b29d3c91 66 //HttpsRequest* post_req = new HttpsRequest(network, SSL_CA_PEM, HTTP_POST, TARGET_URL); // Old: doesn't re-use sockets
danielelopez 0:6156b29d3c91 67 HttpsRequest* post_req = new HttpsRequest(socket, HTTP_POST, TARGET_URL);
danielelopez 0:6156b29d3c91 68
danielelopez 0:6156b29d3c91 69 // Turn on debugging - this hides TLS connection information
danielelopez 0:6156b29d3c91 70 post_req->set_debug(true);
danielelopez 0:6156b29d3c91 71
danielelopez 0:6156b29d3c91 72 // Add headers: content type and authentication
danielelopez 0:6156b29d3c91 73 post_req->set_header("Content-Type", "application/json");
danielelopez 0:6156b29d3c91 74
danielelopez 0:6156b29d3c91 75 // Set OMF headers
danielelopez 0:6156b29d3c91 76 post_req->set_header("producertoken", PRODUCER_TOKEN);
danielelopez 0:6156b29d3c91 77 post_req->set_header("messagetype", message_type);
danielelopez 0:6156b29d3c91 78 post_req->set_header("action", action);
danielelopez 0:6156b29d3c91 79 post_req->set_header("messageformat", "JSON");
danielelopez 0:6156b29d3c91 80 post_req->set_header("omfversion", "1.0");
danielelopez 0:6156b29d3c91 81
danielelopez 0:6156b29d3c91 82 // Send the body
danielelopez 0:6156b29d3c91 83 printf("Now sending request...");
danielelopez 1:1c31b413ba0c 84 printf("\n\rOutgoing message headers:\n\tmessagetype: %s\n\taction: %s", message_type, action);
danielelopez 1:1c31b413ba0c 85 printf("\n\rOutgoing message body:\n\t%s\n\r", body);
danielelopez 0:6156b29d3c91 86 HttpResponse* post_res = post_req->send(body, strlen(body));
danielelopez 0:6156b29d3c91 87
danielelopez 0:6156b29d3c91 88 // Check the response for an error
danielelopez 0:6156b29d3c91 89 if (!post_res) {
danielelopez 1:1c31b413ba0c 90 printf("HttpRequest failed (error code %d)\n\r", post_req->get_error());
danielelopez 1:1c31b413ba0c 91 printf("Socket connection status after error: %d\n\r", socket->connected());
danielelopez 0:6156b29d3c91 92 //return 1;
danielelopez 0:6156b29d3c91 93 } else {
danielelopez 0:6156b29d3c91 94 // Print the response
danielelopez 1:1c31b413ba0c 95 OMFLib_dump_response(post_res);
danielelopez 1:1c31b413ba0c 96 }
danielelopez 1:1c31b413ba0c 97
danielelopez 1:1c31b413ba0c 98 // Free up the request object
danielelopez 1:1c31b413ba0c 99 delete post_req;
danielelopez 1:1c31b413ba0c 100 }
danielelopez 1:1c31b413ba0c 101
danielelopez 1:1c31b413ba0c 102 // ************************************************************************
danielelopez 1:1c31b413ba0c 103 // Helper function that sends an actual web request; does not reuse sockets
danielelopez 1:1c31b413ba0c 104 // ************************************************************************
danielelopez 1:1c31b413ba0c 105
danielelopez 1:1c31b413ba0c 106 void OMFLib_sendMessageToEndpoint_NoSocketReuse(NetworkInterface* network, const char* action, const char* message_type, const char* body) {
danielelopez 1:1c31b413ba0c 107 printf("\n\r----- HTTPS POST request -----\n\r");
danielelopez 1:1c31b413ba0c 108
danielelopez 1:1c31b413ba0c 109 // Create the new request
danielelopez 1:1c31b413ba0c 110 HttpsRequest* post_req = new HttpsRequest(network, SSL_CA_PEM, HTTP_POST, TARGET_URL);
danielelopez 1:1c31b413ba0c 111
danielelopez 1:1c31b413ba0c 112 // Turn on debugging - this hides TLS connection information
danielelopez 1:1c31b413ba0c 113 post_req->set_debug(true);
danielelopez 1:1c31b413ba0c 114
danielelopez 1:1c31b413ba0c 115 // Add headers: content type
danielelopez 1:1c31b413ba0c 116 post_req->set_header("Content-Type", CONTENT_TYPE);
danielelopez 1:1c31b413ba0c 117
danielelopez 1:1c31b413ba0c 118 // Set OMF headers
danielelopez 1:1c31b413ba0c 119 post_req->set_header("producertoken", PRODUCER_TOKEN);
danielelopez 1:1c31b413ba0c 120 post_req->set_header("messagetype", message_type);
danielelopez 1:1c31b413ba0c 121 post_req->set_header("action", action);
danielelopez 1:1c31b413ba0c 122 post_req->set_header("messageformat", OMF_MESSAGE_FORMAT);
danielelopez 1:1c31b413ba0c 123 post_req->set_header("omfversion", OMF_VERSION);
danielelopez 1:1c31b413ba0c 124
danielelopez 1:1c31b413ba0c 125 // Send the body
danielelopez 1:1c31b413ba0c 126 printf("Now sending request... ");
danielelopez 1:1c31b413ba0c 127 //printf("\n\rOutgoing message headers:\n\tmessagetype: %s\n\taction: %s", message_type, action);
danielelopez 1:1c31b413ba0c 128 //printf("\n\rOutgoing message body:\n\t%s\n\r", body);
danielelopez 1:1c31b413ba0c 129 HttpResponse* post_res = post_req->send(body, strlen(body));
danielelopez 1:1c31b413ba0c 130
danielelopez 1:1c31b413ba0c 131 // Check the response for an error
danielelopez 1:1c31b413ba0c 132 if (!post_res) {
danielelopez 1:1c31b413ba0c 133 printf("HttpRequest failed (error code %d)\n\r", post_req->get_error());
danielelopez 1:1c31b413ba0c 134 //return 1;
danielelopez 1:1c31b413ba0c 135 } else {
danielelopez 1:1c31b413ba0c 136 // Print the response
danielelopez 1:1c31b413ba0c 137 printf("Success!\n\r");
danielelopez 1:1c31b413ba0c 138 //OMFLib_dump_response(post_res);
danielelopez 0:6156b29d3c91 139 }
danielelopez 0:6156b29d3c91 140
danielelopez 0:6156b29d3c91 141 // Free up the request object
danielelopez 0:6156b29d3c91 142 delete post_req;
danielelopez 0:6156b29d3c91 143 }
danielelopez 0:6156b29d3c91 144
danielelopez 0:6156b29d3c91 145 // ************************************************************************
danielelopez 0:6156b29d3c91 146 // Gets the current time in the appropriate OMF format
danielelopez 0:6156b29d3c91 147 // ************************************************************************
danielelopez 0:6156b29d3c91 148
danielelopez 0:6156b29d3c91 149 string OMFLib_getCurrentTimeString() {
danielelopez 0:6156b29d3c91 150 // Declar vars
danielelopez 0:6156b29d3c91 151 char timestampBuffer[80];
danielelopez 0:6156b29d3c91 152 time_t now;
danielelopez 0:6156b29d3c91 153 struct tm ts;
danielelopez 0:6156b29d3c91 154
danielelopez 0:6156b29d3c91 155 // Get the current time
danielelopez 0:6156b29d3c91 156 time(&now);
danielelopez 0:6156b29d3c91 157
danielelopez 0:6156b29d3c91 158 // Cast the current time into the correct format
danielelopez 0:6156b29d3c91 159 ts = *localtime(&now);
danielelopez 0:6156b29d3c91 160 strftime(timestampBuffer, sizeof(timestampBuffer), "%Y-%m-%dT%H:%M:%SZ", &ts);
danielelopez 0:6156b29d3c91 161
danielelopez 0:6156b29d3c91 162 // Return the result
danielelopez 0:6156b29d3c91 163 return string(timestampBuffer);
danielelopez 0:6156b29d3c91 164 }
danielelopez 0:6156b29d3c91 165
danielelopez 0:6156b29d3c91 166 // ************************************************************************
danielelopez 9:e2d177cf9135 167 // Sets the clock via NTP via the nwtwork; can point to a local or internet-based server
danielelopez 0:6156b29d3c91 168 // ************************************************************************
danielelopez 0:6156b29d3c91 169
danielelopez 0:6156b29d3c91 170 void OMFLib_syncClockViaNTP(NetworkInterface* network) {
danielelopez 0:6156b29d3c91 171 // Hard-code a start time... see https://www.epochconverter.com/
danielelopez 0:6156b29d3c91 172 set_time(DEFAULT_HARD_CODED_UTC_TIME);
danielelopez 0:6156b29d3c91 173
danielelopez 1:1c31b413ba0c 174 printf("\n\r----- Setting internal clock -----\n\r");
danielelopez 0:6156b29d3c91 175 // See https://github.com/ARMmbed/ntp-client-example/blob/master/main.cpp
danielelopez 0:6156b29d3c91 176
danielelopez 9:e2d177cf9135 177 // Connect the ntp object to the network
danielelopez 0:6156b29d3c91 178 NTPClient ntp(network);
danielelopez 9:e2d177cf9135 179
danielelopez 9:e2d177cf9135 180 // Set the ntp server to either an internet-based server OR to a local server
danielelopez 9:e2d177cf9135 181 ntp.set_server("2.pool.ntp.org", 123);
danielelopez 9:e2d177cf9135 182
danielelopez 9:e2d177cf9135 183 // Get the timestamp via NTP
danielelopez 0:6156b29d3c91 184 time_t timestamp = ntp.get_timestamp();
danielelopez 0:6156b29d3c91 185 if (timestamp > 0) {
danielelopez 0:6156b29d3c91 186 set_time(timestamp);
danielelopez 0:6156b29d3c91 187 printf("Clock set via NTP to UTC %s", ctime(&timestamp));
danielelopez 0:6156b29d3c91 188 } else {
danielelopez 0:6156b29d3c91 189 printf("NTP time sync failed; clock set to %i UTC seconds.", DEFAULT_HARD_CODED_UTC_TIME);
danielelopez 0:6156b29d3c91 190 }
danielelopez 0:6156b29d3c91 191 }