Merge pull request #117 from bonitoo-io/feat/api_improvements

feat: added InfluxDBClient::pointToLineProtocol function

Author: vlastahajek

CHANGELOG.md

@@ -1,5 +1,8 @@
 # Changelog
 ## 3.5.1 [in progress]
+### Features
+- [#117](https://github.com/tobiasschuerg/InfluxDB-Client-for-Arduino/pull/117) - Added `InfluxDBClient::pointToLineProtocol(const Point& point)` for simple creation of InfluxDB line-protocol string with respect to default tags
+
 ### Fixes
 - [#114](https://github.com/tobiasschuerg/InfluxDB-Client-for-Arduino/pull/114) - Renamed `getRemaingRetryTime()`->`getRemainingRetryTime()`
 - [#115](https://github.com/tobiasschuerg/InfluxDB-Client-for-Arduino/pull/115) - Restored writing capability after a connection failure

examples/BasicWrite/BasicWrite.ino

@@ -81,7 +81,7 @@ void loop() {
   sensor.addField("rssi", WiFi.RSSI());
   // Print what are we exactly writing
   Serial.print("Writing: ");
-  Serial.println(sensor.toLineProtocol());
+  Serial.println(client.pointToLineProtocol(sensor));
   // If no Wifi signal, try to reconnect it
   if ((WiFi.RSSI() == 0) && (wifiMulti.run() != WL_CONNECTED))
     Serial.println("Wifi connection lost");

examples/SecureBatchWrite/SecureBatchWrite.ino

@@ -120,7 +120,7 @@ void loop() {
 
       // Print what are we exactly writing
       Serial.print("Writing: ");
-      Serial.println(sensorNetworks.toLineProtocol());
+      Serial.println(client.pointToLineProtocol(sensorNetworks));
 
       // Write point into buffer - low priority measures
       client.writePoint(sensorNetworks);
@@ -134,7 +134,7 @@ void loop() {
 
   // Print what are we exactly writing
   Serial.print("Writing: ");
-  Serial.println(sensorStatus.toLineProtocol());
+  Serial.println(client.pointToLineProtocol(sensorStatus));
 
   // Write point into buffer - high priority measure
   client.writePoint(sensorStatus);

examples/SecureWrite/SecureWrite.ino

@@ -91,7 +91,7 @@ void loop() {
   sensor.addField("rssi", WiFi.RSSI());
   // Print what are we exactly writing
   Serial.print("Writing: ");
-  Serial.println(sensor.toLineProtocol());
+  Serial.println(client.pointToLineProtocol(sensor));
   // If no Wifi signal, try to reconnect it
   if ((WiFi.RSSI() == 0) && (wifiMulti.run() != WL_CONNECTED))
     Serial.println("Wifi connection lost");

src/InfluxDbClient.cpp

@@ -44,11 +44,11 @@ static const char UserAgent[] PROGMEM = "influxdb-client-arduino/" INFLUXDB_CLIE
 //#define INFLUXDB_CLIENT_DEBUG_ENABLE
 #include "util/debug.h"
 
-static const char UnitialisedMessage[] PROGMEM = "Unconfigured instance"; 
+static const char UninitializedMessage[] PROGMEM = "Unconfigured instance"; 
 static const char TooEarlyMessage[] PROGMEM = "Cannot send request yet because of applied retry strategy. Remaining ";
 // This cannot be put to PROGMEM due to the way how it is used
 static const char RetryAfter[] = "Retry-After";
-static const char TransferEnconding[] = "Transfer-Encoding";
+static const char TransferEncoding[] = "Transfer-Encoding";
 
 static String escapeJSONString(String &value);
 #if defined(ESP8266)  
@@ -110,6 +110,7 @@ void InfluxDBClient::setConnectionParamsV1(const char *serverUrl, const char *db
 
 bool InfluxDBClient::init() {
     INFLUXDB_CLIENT_DEBUG("Init\n");
+    INFLUXDB_CLIENT_DEBUG("  Library version: " INFLUXDB_CLIENT_VERSION "\n");
     INFLUXDB_CLIENT_DEBUG("  Server url: %s\n", _serverUrl.c_str());
     INFLUXDB_CLIENT_DEBUG("  Org: %s\n", _org.c_str());
     INFLUXDB_CLIENT_DEBUG("  Bucket: %s\n", _bucket.c_str());
@@ -340,7 +341,7 @@ bool InfluxDBClient::writePoint(Point & point) {
         if(_writeOptions._writePrecision != WritePrecision::NoTime && !point.hasTime()) {
             point.setTime(_writeOptions._writePrecision);
         }
-        String line = point.toLineProtocol(_writeOptions._defaultTags);
+        String line = pointToLineProtocol(point);
         return writeRecord(line);
     }
     return false;
@@ -504,7 +505,6 @@ bool InfluxDBClient::flushBufferInternal(bool flashOnlyFull) {
     return success;
 }
 
-
 void  InfluxDBClient::dropCurrentBatch() {
     delete _writeBuffer[_batchPointer];
     _writeBuffer[_batchPointer] = nullptr;
@@ -516,13 +516,17 @@ void  InfluxDBClient::dropCurrentBatch() {
         // we reached buffer size, that means buffer was full and now lower ceiling 
         _bufferCeiling = _bufferPointer;
     }
-    INFLUXDB_CLIENT_DEBUG("[D] Droped batch, batchpointer: %d\n", _batchPointer);
+    INFLUXDB_CLIENT_DEBUG("[D] Dropped batch, batchpointer: %d\n", _batchPointer);
+}
+
+String InfluxDBClient::pointToLineProtocol(const Point& point) {
+    return point.toLineProtocol(_writeOptions._defaultTags);
 }
 
 bool InfluxDBClient::validateConnection() {
     if(!_wifiClient && !init()) {
         _lastStatusCode = 0;
-        _lastErrorResponse = FPSTR(UnitialisedMessage);
+        _lastErrorResponse = FPSTR(UninitializedMessage);
         return false;
     }
     // on version 1.x /ping will by default return status code 204, without verbose
@@ -550,14 +554,14 @@ void InfluxDBClient::beforeRequest() {
     if(_authToken.length() > 0) {
         _httpClient.addHeader(F("Authorization"), "Token " + _authToken);
     }
-    const char * headerKeys[] = {RetryAfter, TransferEnconding} ;
+    const char * headerKeys[] = {RetryAfter, TransferEncoding} ;
     _httpClient.collectHeaders(headerKeys, 2);
 }
 
 int InfluxDBClient::postData(const char *data) {
     if(!_wifiClient && !init()) {
         _lastStatusCode = 0;
-        _lastErrorResponse = FPSTR(UnitialisedMessage);
+        _lastErrorResponse = FPSTR(UninitializedMessage);
         return 0;
     }
     if(data) {
@@ -607,7 +611,7 @@ FluxQueryResult InfluxDBClient::query(String fluxQuery) {
     }
     if(!_wifiClient && !init()) {
         _lastStatusCode = 0;
-        _lastErrorResponse = FPSTR(UnitialisedMessage);
+        _lastErrorResponse = FPSTR(UninitializedMessage);
         return FluxQueryResult(_lastErrorResponse);
     }
     INFLUXDB_CLIENT_DEBUG("[D] Query to %s\n", _queryUrl.c_str());
@@ -630,8 +634,8 @@ FluxQueryResult InfluxDBClient::query(String fluxQuery) {
     afterRequest(200);
     if(_lastStatusCode == 200) {
         bool chunked = false;
-        if(_httpClient.hasHeader(TransferEnconding)) {
-            String header = _httpClient.header(TransferEnconding);
+        if(_httpClient.hasHeader(TransferEncoding)) {
+            String header = _httpClient.header(TransferEncoding);
             chunked = header.equalsIgnoreCase("chunked");
         }
         INFLUXDB_CLIENT_DEBUG("[D] chunked: %s\n", chunked?"true":"false");

src/InfluxDbClient.h

@@ -110,13 +110,15 @@ class InfluxDBClient {
     // authToken - InfluxDB 2 authorization token
     // serverCert - Optional. InfluxDB 2 server trusted certificate (or CA certificate) or certificate SHA1 fingerprint.  Should be stored in PROGMEM. Only in case of https connection.
     void setConnectionParams(const char *serverUrl, const char *org, const char *bucket, const char *authToken, const char *certInfo = nullptr);
-    // Sets parameters for connection to InfuxDB 1
+    // Sets parameters for connection to InfluxDB 1
     // serverUrl - url of the InfluxDB server (e.g. http://localhost:8086)
     // db - database name where to store or read data
     // user - Optional. User name, in case of server requires authetication
     // password - Optional. User password, in case of server requires authetication
     // certInfo - Optional. InfluxDB server trusted certificate (or CA certificate) or certificate SHA1 fingerprint.  Should be stored in PROGMEM. Only in case of https connection.
     void setConnectionParamsV1(const char *serverUrl, const char *db, const char *user = nullptr, const char *password = nullptr, const char *certInfo = nullptr);
+    // Creates line protocol string from point data and optional default tags set in WriteOptions.
+    String pointToLineProtocol(const Point& point);
     // Validates connection parameters by conecting to server
     // Returns true if successful, false in case of any error
     bool validateConnection();
@@ -126,7 +128,7 @@ class InfluxDBClient {
     // Writes record represented by Point to buffer
     // Returns true if successful, false in case of any error 
     bool writePoint(Point& point);
-    // Sends Flux query and returns FluxQueryResult object for subsequentialy reading flux query response.
+    // Sends Flux query and returns FluxQueryResult object for subsequently reading flux query response.
     // Use FluxQueryResult::next() method to iterate over lines of the query result.
     // Always call of FluxQueryResult::close() when reading is finished. Check FluxQueryResult doc for more info.
     FluxQueryResult query(String fluxQuery);
@@ -208,7 +210,7 @@ class InfluxDBClient {
     uint8_t _bufferCeiling = 0;
     // Index of bath start for next write
     uint8_t _batchPointer = 0;
-    // Last time in sec bufer has been sucessfully flushed
+    // Last time in sec buffer has been successfully flushed
     uint32_t _lastFlushed = 0;
     // Last time in ms we made are a request to server
     uint32_t _lastRequestTime = 0;
@@ -218,7 +220,7 @@ class InfluxDBClient {
     String _lastErrorResponse;
     // Underlying HTTPClient instance 
     HTTPClient _httpClient;
-    // Underlying connenction object 
+    // Underlying connection object 
     WiFiClient *_wifiClient = nullptr;
     // Certificate info
     const char *_certInfo = nullptr;
@@ -237,7 +239,7 @@ class InfluxDBClient {
     void setUrls();
     // Ensures buffer has required size
     void reserveBuffer(int size);
-    // Drops current batcj and advances batch pointer
+    // Drops current batch and advances batch pointer
     void dropCurrentBatch();
     // Writes all points in buffer, with respect to the batch size, and in case of success clears the buffer.
     //  flashOnlyFull - whether to flush only full batches

src/Point.cpp

@@ -61,15 +61,15 @@ void Point::putField(String name, String value) {
 
 String Point::toLineProtocol(String includeTags) const {
     String line =  _measurement;
-    line.reserve(1 + _tags.length() + 1 + includeTags.length() + 1 + _fields.length() + 1 + _timestamp.length());
-    if(hasTags()) {
-        line += ",";
-        line += _tags;
-    }
+    line.reserve(1 + includeTags.length() + 1 + _tags.length() + 1 + _fields.length() + 1 + _timestamp.length());
     if(includeTags.length()>0) {
         line += ",";
         line += includeTags;
     }
+    if(hasTags()) {
+        line += ",";
+        line += _tags;
+    }
     if(hasFields()) {
         line += " ";
         line += _fields;

src/Point.h

@@ -68,6 +68,7 @@ class Point {
     // True if a point contains timestamp
     bool hasTime() const   { return _timestamp.length() > 0; }
     // Creates line protocol with optionaly added tags
+    [[deprecated("Use InfluxDBClient::pointToLineProtocol()")]]
     String toLineProtocol(String includeTags = "") const;
     // returns current timestamp
     String getTime() const { return _timestamp; } 

test/Test.cpp

@@ -197,7 +197,7 @@ void Test::testEcaping() {
     w.addDefaultTag("dta=g","dval=ue");
     w.addDefaultTag("dtag","dvalue");
     line = p.toLineProtocol(w._defaultTags);
-    TEST_ASSERTM(line == "t\\\re=s\\\nt\\\t_t\\ e\"s\\,t,ta\\=g=val\\=ue,ta\\\tg=val\\\tue,ta\\\rg=val\\\rue,ta\\\ng=val\\\nue,ta\\ g=valu\\ e,ta\\,g=valu\\,e,tag=value,ta\"g=val\"ue,dta\\=g=dval\\=ue,dtag=dvalue fie\\=ld=\"val=ue\",fie\\\tld=\"val\tue\",fie\\\rld=\"val\rue\",fie\\\nld=\"val\nue\",fie\\ ld=\"val ue\",fie\\,ld=\"val,ue\",fie\"ld=\"val\\\"ue\"", line);
+    TEST_ASSERTM(line == "t\\\re=s\\\nt\\\t_t\\ e\"s\\,t,dta\\=g=dval\\=ue,dtag=dvalue,ta\\=g=val\\=ue,ta\\\tg=val\\\tue,ta\\\rg=val\\\rue,ta\\\ng=val\\\nue,ta\\ g=valu\\ e,ta\\,g=valu\\,e,tag=value,ta\"g=val\"ue fie\\=ld=\"val=ue\",fie\\\tld=\"val\tue\",fie\\\rld=\"val\rue\",fie\\\nld=\"val\nue\",fie\\ ld=\"val ue\",fie\\,ld=\"val,ue\",fie\"ld=\"val\\\"ue\"", line);
     TEST_END();
 }
 
@@ -230,7 +230,7 @@ void Test::testPoint() {
 
     String defaultTags="dtag=val";
     line = p.toLineProtocol(defaultTags);
-    testLine = "test,tag1=tagvalue,dtag=val fieldInt=-23i,fieldBool=true,fieldFloat1=1.12,fieldFloat2=1.12345,fieldDouble1=1.12,fieldDouble2=1.12345,fieldChar=\"A\",fieldUChar=1i,fieldUInt=23i,fieldLong=123456i,fieldULong=123456i,fieldString=\"text test\"";
+    testLine = "test,dtag=val,tag1=tagvalue fieldInt=-23i,fieldBool=true,fieldFloat1=1.12,fieldFloat2=1.12345,fieldDouble1=1.12,fieldDouble2=1.12345,fieldChar=\"A\",fieldUChar=1i,fieldUInt=23i,fieldLong=123456i,fieldULong=123456i,fieldString=\"text test\"";
     TEST_ASSERTM(line == testLine, line);
 
     p.clearTags();
@@ -1804,6 +1804,15 @@ void Test::testDefaultTags() {
     TEST_INIT("testDefaultTags");
 
     InfluxDBClient client(Test::apiUrl, Test::orgName, Test::bucketName, Test::token);
+
+    Point pt("test");
+    pt.addTag("tag1", "tagvalue");
+    pt.addField("fieldInt", -23);
+    String testLine = "test,tag1=tagvalue fieldInt=-23i";
+    String line = client.pointToLineProtocol(pt);
+    TEST_ASSERTM(line == testLine, line);
+
+    
 
     TEST_ASSERT(waitServer(Test::managementUrl, true));
     for (int i = 0; i < 5; i++) {
@@ -1827,6 +1836,9 @@ void Test::testDefaultTags() {
     deleteAll(Test::apiUrl);
 
     client.setWriteOptions(WriteOptions().addDefaultTag("dtag1","dval1").addDefaultTag("dtag2","dval2"));
+    testLine = "test,dtag1=dval1,dtag2=dval2,tag1=tagvalue fieldInt=-23i";
+    line = client.pointToLineProtocol(pt);
+    TEST_ASSERTM(line == testLine, line);
 
     for (int i = 0; i < 5; i++) {
         Point *p = createPoint("test1");

test/TestSupport.cpp

@@ -42,6 +42,7 @@ void printFreeHeap() {
 
 int httpPOST(String url, String mess) {
   HTTPClient http;
+  http.setReuse(false);
   int code = 0;
   if(http.begin(url)) {
     code = http.POST(mess);
@@ -52,12 +53,14 @@ int httpPOST(String url, String mess) {
 
 int httpGET(String url) {
   HTTPClient http;
+  http.setReuse(false);
   int code = 0;
   if(http.begin(url)) {
     code = http.GET();
     if(code != 204) {
-       Serial.print("[TD] ");
-       Serial.println(http.getString());
+       //Serial.print("[TD] ");
+       //String res = http.getString();
+       //Serial.println(res);
     }
     http.end();
   }