Add a warning message for binary output mode, and add text-mode example

Author: chrisdalke

examples/TextModeOutput/TextModeOutput.ino

@@ -0,0 +1,50 @@
+/*
+  TelemetryJet Arduino SDK
+  Chris Dalke <[email protected]>
+  https://github.com/telemetryjet/telemetryjet-arduino-sdk
+
+  Lightweight communication library for hardware telemetry data.
+  Handles bidirectional communication and state management for data points.
+  -------------------------------------------------------------------------
+  Part of the TelemetryJet platform -- Collect, analyze, and share
+  data from your hardware. Code not required.
+
+  Distributed "as is" under the MIT License. See LICENSE.md for details.
+*/
+
+#include <TelemetryJet.h>
+
+// Initialize an instance of the TelemetryJet SDK.
+TelemetryJet telemetry(&Serial, 100);
+Dimension testValue1 = telemetry.createDimension(1);
+Dimension testValue2 = telemetry.createDimension(2);
+
+void setup() {
+  // Send data in "text mode", which can be useful for debugging in the Arduino IDE.
+  // In text mode, all data points are sent as text in a list at the write interval.
+  //
+  // The output for this program will look something like:
+  // 68.21 186.08
+  // 60.57 189.51
+  // 52.32 192.50
+  // ...
+  //
+  // Notes:
+  // - In text mode, values cannot be sent to the device.
+  // - Text mode is highly inefficient for data transmission, and should only be used
+  //   for debugging purposes!
+  telemetry.setTextMode(true);
+
+  // Initialize the serial stream.
+  Serial.begin(115200);
+  while (!Serial);
+}
+
+void loop() {
+  // Process new data if available, and periodically send data points.
+  telemetry.update();
+
+  // Update the dimensions with an oscillating signal.
+  testValue1.setFloat32(sin(millis() / 1000.0) * 100.0);
+  testValue2.setFloat32(sin(millis() / 2000.0) * 200.0);
+}

src/TelemetryJet.cpp

@@ -93,6 +93,14 @@ size_t UnStuffData(const uint8_t *ptr, size_t length, uint8_t *dst) {
 }
 
 void TelemetryJet::update() {
+  if (!isInitialized) {
+    if (hasBinaryWarningMessage && !isTextMode) {
+      transport->println(F("Started streaming data in Binary mode. This data is not human-readable."));
+      transport->println(F("For usage information, please see https://docs.telemetryjet.com/."));
+    }
+    isInitialized = true; 
+  }
+
   if (isTextMode) {
     // Text mode
     // Don't read inputs; just log as text output to the serial stream
@@ -152,7 +160,7 @@ void TelemetryJet::update() {
                 break;
               }
               case DataPointType::FLOAT32: {
-                transport->print((double)(dimensions[i]->value.v_float32));
+                transport->print((float)(dimensions[i]->value.v_float32));
                 break;
               }
               default: {

src/TelemetryJet.h

@@ -167,6 +167,7 @@ class TelemetryJet {
   bool isInitialized = false;
   bool isTextMode = false;
   bool isDeltaMode = true;
+  bool hasBinaryWarningMessage = true;
   uint32_t lastSent;
   uint32_t transmitRate;
 
@@ -208,6 +209,9 @@ class TelemetryJet {
   void setDeltaMode(bool deltaMode = false) {
     isDeltaMode = deltaMode;
   }
+  void setBinaryWarningMessage(bool message = false) {
+    hasBinaryWarningMessage = message;
+  }
 
   friend class Dimension;
 };