🎨 Doxygen sensor model, ws_manager classes

Author: brentru

src/components/sensor/model.cpp

@@ -14,12 +14,31 @@
  */
 #include "model.h"
 
+/***********************************************************************/
+/*!
+    @brief  SensorModel constructor
+*/
+/***********************************************************************/
 SensorModel::SensorModel() {
   _msg_sensor_event = wippersnapper_sensor_SensorEvent_init_default;
 }
 
+/***********************************************************************/
+/*!
+    @brief  SensorModel destructor
+*/
+/***********************************************************************/
 SensorModel::~SensorModel() {}
 
+/***********************************************************************/
+/*!
+    @brief  Decodes a SensorEvent message into a SensorModel object.
+    @param  stream
+            The input stream
+    @returns True if the SensorEvent message was successfully decoded,
+            False otherwise.
+*/
+/***********************************************************************/
 bool SensorModel::decodeSensorEvent(pb_istream_t *stream) {
   // Decode the stream into theSensorEvent message
   if (!pb_decode(stream, wippersnapper_sensor_SensorEvent_fields,
@@ -29,6 +48,91 @@ bool SensorModel::decodeSensorEvent(pb_istream_t *stream) {
   return true;
 }
 
+/***********************************************************************/
+/*!
+    @brief  Clears the SensorEvent message.
+*/
+/***********************************************************************/
 void SensorModel::clearSensorEvent() {
   _msg_sensor_event = wippersnapper_sensor_SensorEvent_init_default;
+}
+
+/***********************************************************************/
+/*!
+    @brief  Returns a SensorEvent message.
+    @returns The SensorEvent message.
+*/
+/***********************************************************************/
+wippersnapper_sensor_SensorEvent *SensorModel::getSensorEvent() {
+  return &_msg_sensor_event;
+}
+
+/***********************************************************************/
+/*!
+    @brief  Returns the the SensorEvent message's type.
+    @returns The type of the SensorEvent message, as a SensorType.
+*/
+/***********************************************************************/
+wippersnapper_sensor_SensorType SensorModel::getSensorType() {
+  return _msg_sensor_event.type;
+}
+
+/***********************************************************************/
+/*!
+    @brief  Returns the the SensorEvent message's which_value field.
+    @returns The which_value field of the SensorEvent message.
+*/
+/***********************************************************************/
+pb_size_t SensorModel::getSensorEventWhichValue() {
+  return _msg_sensor_event.which_value;
+}
+
+/***********************************************************************/
+/*!
+    @brief  Returns the the SensorEvent message's float value field.
+    @returns The float value of the SensorEvent message.
+*/
+/***********************************************************************/
+float SensorModel::getValueFloat() {
+  return _msg_sensor_event.value.float_value;
+}
+
+/***********************************************************************/
+/*!
+    @brief  Returns the the SensorEvent message's bool value field.
+    @returns The bool value of the SensorEvent message.
+*/
+/***********************************************************************/
+bool SensorModel::getValueBool() { return _msg_sensor_event.value.bool_value; }
+
+/***********************************************************************/
+/*!
+    @brief  Returns the the SensorEvent message's vector value field.
+    @returns The vector value of the SensorEvent message.
+*/
+/***********************************************************************/
+wippersnapper_sensor_SensorEvent_SensorEvent3DVector
+SensorModel::getValueVector() {
+  return _msg_sensor_event.value.vector_value;
+}
+
+/***********************************************************************/
+/*!
+    @brief  Returns the the SensorEvent message's orientation value field.
+    @returns The orientation value of the SensorEvent message.
+*/
+/***********************************************************************/
+wippersnapper_sensor_SensorEvent_SensorEventOrientation
+SensorModel::getValueOrientation() {
+  return _msg_sensor_event.value.orientation_value;
+}
+
+/***********************************************************************/
+/*!
+    @brief  Returns the the SensorEvent message's color value field.
+    @returns The color value of the SensorEvent message.
+*/
+/***********************************************************************/
+wippersnapper_sensor_SensorEvent_SensorEventColor SensorModel::getValueColor() {
+  return _msg_sensor_event.value.color_value;
 }

src/components/sensor/model.h

@@ -29,29 +29,18 @@ class SensorModel {
   ~SensorModel();
   bool decodeSensorEvent(pb_istream_t *stream);
   void clearSensorEvent();
-  wippersnapper_sensor_SensorEvent *getSensorEvent() {
-    return &_msg_sensor_event;
-  }
-  wippersnapper_sensor_SensorType getSensorType() {
-    return _msg_sensor_event.type;
-  } ///< Returns sensor's type and corresponding SI unit
-  pb_size_t getWhichValue() {
-    return _msg_sensor_event.which_value;
-  } ///< Returns the value union's tag
-  float getValueFloat() { return _msg_sensor_event.value.float_value; }
-  bool getValueBool() { return _msg_sensor_event.value.bool_value; }
-  wippersnapper_sensor_SensorEvent_SensorEvent3DVector getValueVector() {
-    return _msg_sensor_event.value.vector_value;
-  }
-  wippersnapper_sensor_SensorEvent_SensorEventOrientation
-  getValueOrientation() {
-    return _msg_sensor_event.value.orientation_value;
-  }
-  wippersnapper_sensor_SensorEvent_SensorEventColor getValueColor() {
-    return _msg_sensor_event.value.color_value;
-  }
+
+  wippersnapper_sensor_SensorEvent *getSensorEvent();
+  wippersnapper_sensor_SensorType getSensorType();
+  pb_size_t getSensorEventWhichValue();
+
+  float getValueFloat();
+  bool getValueBool();
+  wippersnapper_sensor_SensorEvent_SensorEvent3DVector getValueVector();
+  wippersnapper_sensor_SensorEvent_SensorEventOrientation getValueOrientation();
+  wippersnapper_sensor_SensorEvent_SensorEventColor getValueColor();
 
 private:
-  wippersnapper_sensor_SensorEvent _msg_sensor_event;
+  wippersnapper_sensor_SensorEvent _msg_sensor_event; ///< SensorEvent message
 };
 #endif // WS_SENSOR_MODEL_H

src/ws_manager.cpp

@@ -90,4 +90,12 @@ void Wippersnapper_Manager::run() {
   } else {
     WS_DEBUG_PRINTLN("Error: Could not call run(), unknown API version!");
   }
-}
+}
+
+/**************************************************************************/
+/*!
+    @brief    Returns the API version
+    @returns  The API version
+*/
+/**************************************************************************/
+int Wippersnapper_Manager::getAPIVersion() { return _api_version; }

src/ws_manager.h

@@ -19,15 +19,15 @@ class Wippersnapper_Manager {
 
   // API version checks
   void checkAPIVersion(int pinNum);
-  int getAPIVersion() { return _api_version; }
+  int getAPIVersion();
 
   // High-level functions (called from demo sketch ino)
   void provision();
   void connect();
   void run();
 
 protected:
-  Wippersnapper_WiFi *ws_instance; ///< Instance of Wippersnapper API v1
+  Wippersnapper_WiFi *ws_instance;      ///< Instance of Wippersnapper API v1
   Wippersnapper_WiFiV2 *ws_instance_v2; ///< Instance of Wippersnapper API v2
 private:
   int _api_version;