Merge pull request #35 from Overdrivr/ergonomy

Ergonomy

Author: Overdrivr

BUILD.md

@@ -54,6 +54,13 @@ cd ../../../../
 
 If all tests passed, mbed library can be released with good confidence.
 
+```shell
+gradle packMbed
+```
+
+This last command will generate an archive of the distribution inside
+ `build/distributions/`
+
 ## arduino distribution
 
 Generates the Arduino distribution by taking files inside `src/`,

drivers/cpp/arduino/Telemetry.cpp

@@ -86,8 +86,7 @@ void Telemetry::pub_f32(const char * topic, float msg)
 void Telemetry::sub(void (*callback)(TM_state * s, TM_msg * m),
                     TM_state* userData)
 {
-    set_state(userData);
-    subscribe(callback);
+    subscribe(callback,userData);
 }
 
 void Telemetry::update()

drivers/cpp/base/Telemetry.cpp

@@ -153,7 +153,7 @@ void Telemetry::pub_f32(const char * topic, float msg)
 void Telemetry::sub(void (*callback)(TM_state * s, TM_msg * m),
                     TM_state* userData)
 {
-    subscribe(callback);
+    subscribe(callback,userData);
 }
 
 void Telemetry::update()

drivers/cpp/mbed/Telemetry.cpp

@@ -91,8 +91,7 @@ void Telemetry::pub_f32(const char * topic, float msg)
 void Telemetry::sub(void (*callback)(TM_state * s, TM_msg * m),
                     TM_state* userData)
 {
-    set_state(userData);
-    subscribe(callback);
+    subscribe(callback,userData);
 }
 
 void Telemetry::update()

src/telemetry/c/telemetry_core.c

@@ -80,13 +80,9 @@ void publish_f32(const char * t, float    msg)
   frame(t,TM_float32,ptr,4);
 }
 
-void set_state(TM_state * s)
+void subscribe(void (*callback)(TM_state* s, TM_msg* m), TM_state * s)
 {
   statePtr = s;
-}
-
-void subscribe(void (*callback)(TM_state* s, TM_msg* m))
-{
   userCallback = callback;
 }
 

src/telemetry/c/telemetry_utils.c

@@ -79,12 +79,27 @@ uint32_t emplace_f32(TM_msg* m, float* dst)
   return 1;
 }
 
+uint32_t match(TM_msg * m, const char * topicToMatch)
+{
+  if(strcmp(m->topic,topicToMatch) == 0)
+    return 1;
+
+  return 0;
+}
+
+uint32_t fullmatch(TM_msg * m, const char * topicToMatch, TM_type typeToMatch)
+{
+  if(strcmp(m->topic,topicToMatch) == 0 && m->type == typeToMatch)
+    return 1;
+
+  return 0;
+}
 
 uint32_t update(TM_msg * msg, const char *topic, char *var, size_t bufSize)
 {
    if(strcmp(topic,msg->topic) == 0)
     return emplace(msg, var, bufSize);
-    
+
    return 0;
 }
 
@@ -130,15 +145,15 @@ uint32_t update_i16(TM_msg * msg, const char *topic, int16_t *var)
 
 uint32_t update_i32(TM_msg * msg, const char *topic, int32_t *var)
 {
-   if(strcmp(topic,msg->topic) == 0)
-    return emplace_i32(msg, var);
+    if(strcmp(topic,msg->topic) == 0)
+      return emplace_i32(msg, var);
 
    return 0;
 }
 
 uint32_t update_f32(TM_msg * msg, const char *topic, float *var)
 {
-   if(strcmp(topic,msg->topic) == 0)
+  if(strcmp(topic,msg->topic) == 0)
     return emplace_f32(msg, var);
 
    return 0;

src/telemetry/headers/telemetry_core.h

@@ -20,9 +20,9 @@ void publish_i16(const char * topic, int16_t msg);
 void publish_i32(const char * topic, int32_t msg);
 void publish_f32(const char * topic, float msg);
 
-void set_state(TM_state * s);
-
-void subscribe(void (*callback)(TM_state * s, TM_msg * m));
+// subscribe a function to be called everytime a frame is received
+// second argument is a data structure that you can implement to access your program data inside the function
+void subscribe(void (*callback)(TM_state * s, TM_msg * m), TM_state * s);
 
 void update_telemetry(float elapsedTime);
 

src/telemetry/headers/telemetry_utils.h

@@ -42,7 +42,7 @@ struct TM_transport {
 };
 
 // Decodes TM_msg buffer and emplaces its value into dst
-// Returns 0 if decoding was successful
+// Returns 1 (true) if decoding was successful
 uint32_t emplace(TM_msg * m, char * buf, size_t bufSize);
 uint32_t emplace_u8(TM_msg * m, uint8_t * dst);
 uint32_t emplace_u16(TM_msg * m, uint16_t * dst);
@@ -52,9 +52,16 @@ uint32_t emplace_i16(TM_msg * m, int16_t * dst);
 uint32_t emplace_i32(TM_msg * m, int32_t * dst);
 uint32_t emplace_f32(TM_msg * m, float * dst);
 
+// Returns 1 if topicToMatch matches m->topic
+//         0 otherwise
+uint32_t match(TM_msg * m, const char * topicToMatch);
+
+// Returns 1 if topicToMatch matches m->topic and typeToMatch matches m->type,
+//         0 otherwise
+uint32_t fullmatch(TM_msg * m, const char * topicToMatch, TM_type typeToMatch);
 
 // Decodes TM_msg buffer and update its value into dst if matching topic
-// Returns 0 if decoding was successful
+// Returns 1 (true) if decoding was successful
 uint32_t update(TM_msg * msg, const char *topic, char *var, size_t bufSize);
 uint32_t update_u8(TM_msg * msg, const char *topic, uint8_t *var);
 uint32_t update_u16(TM_msg * msg, const char *topic, uint16_t *var);

src/tests/c/match_suite.c

@@ -0,0 +1,62 @@
+#include "test.h"
+
+TEST match_simple()
+{
+  TM_msg dummy;
+  char topic[] = "foo";
+  dummy.topic = topic;
+
+  ASSERT_EQ_FMT(match(&dummy, topic),1,"%u");
+  ASSERT_EQ_FMT(match(&dummy, "foo"),1,"%u");
+  ASSERT_EQ_FMT(match(&dummy, "bar"),0,"%u");
+  PASS();
+}
+
+TEST match_with_spaces()
+{
+  TM_msg dummy;
+  char topic[] = "foo with spaces";
+  dummy.topic = topic;
+
+  ASSERT_EQ_FMT(match(&dummy, topic),1,"%u");
+  ASSERT_EQ_FMT(match(&dummy, "foo with spaces"),1,"%u");
+  ASSERT_EQ_FMT(match(&dummy, "foo"),0,"%u");
+  ASSERT_EQ_FMT(match(&dummy, "bar"),0,"%u");
+  PASS();
+}
+
+TEST match_with_special_chars()
+{
+  TM_msg dummy;
+  char topic[] = "/:@#";
+  dummy.topic = topic;
+
+  ASSERT_EQ_FMT(match(&dummy, topic),1,"%u");
+  ASSERT_EQ_FMT(match(&dummy, "/:@#"),1,"%u");
+  ASSERT_EQ_FMT(match(&dummy, "$#@:/"),0,"%u");
+  ASSERT_EQ_FMT(match(&dummy, "bar"),0,"%u");
+  PASS();
+}
+
+TEST fullmatch_test()
+{
+  TM_msg dummy;
+  char topic[] = "foo";
+  dummy.topic = topic;
+  dummy.type = TM_uint8;
+
+  ASSERT_EQ_FMT(fullmatch(&dummy, topic, TM_uint8),1,"%u");
+  ASSERT_EQ_FMT(fullmatch(&dummy, topic, TM_int8),0,"%u");
+  ASSERT_EQ_FMT(fullmatch(&dummy, "foo", TM_uint8),1,"%u");
+  ASSERT_EQ_FMT(fullmatch(&dummy, "foo", TM_int8),0,"%u");
+  ASSERT_EQ_FMT(fullmatch(&dummy, "bar", TM_uint8),0,"%u");
+  ASSERT_EQ_FMT(fullmatch(&dummy, "bar", TM_int16),0,"%u");
+  PASS();
+}
+
+SUITE(match_suite) {
+  RUN_TEST(match_simple);
+  RUN_TEST(match_with_spaces);
+  RUN_TEST(match_with_special_chars);
+  RUN_TEST(fullmatch_test);
+}

src/tests/c/pub_sub_float_suite.c

@@ -81,9 +81,8 @@ TEST publish_float()
   float value = 1.23E4;
 
   init_telemetry(&transport);
-  set_state(&state);
 
-  subscribe(callback_float);
+  subscribe(callback_float,&state);
 
   publish_f32(topic, value);
 
@@ -120,9 +119,8 @@ TEST publish_float_neg()
   float value = -1.23E4;
 
   init_telemetry(&transport);
-  set_state(&state);
 
-  subscribe(callback_float);
+  subscribe(callback_float,&state);
 
   publish_f32(topic, value);