Merge pull request #199 from synthetos/dev-198-ignore-uart

First pass at supporting devices that mute.

Author: giseburt

g2core/config.cpp

@@ -692,6 +692,7 @@ nvObj_t *nv_add_conditional_message(const char *string)    // conditionally add
  *  Inputs:
  *    json_flags = JSON_OBJECT_FORMAT - print just the body w/o header or footer
  *    json_flags = JSON_RESPONSE_FORMAT - print a full "r" object with footer
+ *    json_flags = JSON_RESPONSE_TO_MUTED_FORMAT - JSON_RESPONSE_FORMAT, but only to muted channels
  *
  *    text_flags = TEXT_INLINE_PAIRS - print text as name/value pairs on a single line
  *    text_flags = TEXT_INLINE_VALUES - print text as comma separated values on a single line

g2core/controller.cpp

@@ -72,7 +72,7 @@ static stat_t _sync_to_planner(void);
 static stat_t _sync_to_tx_buffer(void);
 static stat_t _dispatch_command(void);
 static stat_t _dispatch_control(void);
-static void _dispatch_kernel(void);
+static void _dispatch_kernel(const devflags_t flags);
 static stat_t _controller_state(void);          // manage controller state transitions
 
 static Motate::OutputPin<Motate::kOutputSAFE_PinNumber> safe_pin;
@@ -191,7 +191,7 @@ static stat_t _dispatch_control()
     if (cs.controller_state != CONTROLLER_PAUSED) {
         devflags_t flags = DEV_IS_CTRL;
         if ((cs.bufp = xio_readline(flags, cs.linelen)) != NULL) {
-            _dispatch_kernel();
+            _dispatch_kernel(flags);
         }
     }
     return (STAT_OK);
@@ -200,17 +200,27 @@ static stat_t _dispatch_control()
 static stat_t _dispatch_command()
 {
     if (cs.controller_state != CONTROLLER_PAUSED) {
-        devflags_t flags = DEV_IS_BOTH;
+        devflags_t flags = DEV_IS_BOTH | DEV_IS_MUTED; // expressly state we'll handle muted devices
         if ((!mp_planner_is_full()) && (cs.bufp = xio_readline(flags, cs.linelen)) != NULL) {
-            _dispatch_kernel();
+            _dispatch_kernel(flags);
         }
     }
     return (STAT_OK);
 }
 
-static void _dispatch_kernel()
+static void _dispatch_kernel(const devflags_t flags)
 {
     stat_t status;
+
+    if (flags & DEV_IS_MUTED) {
+        status = STAT_INPUT_FROM_MUTED_CHANNEL_ERROR;
+        nv_reset_nv_list();                   // get a fresh nvObj list
+        nv_add_string((const char *)"msg", "lines from muted devices are ignored");
+        nv_print_list(status, TEXT_NO_PRINT, JSON_RESPONSE_TO_MUTED_FORMAT);
+
+        // It's possible to let some stuff through, but that's not happening yet.
+        return;
+    }
 
     while ((*cs.bufp == SPC) || (*cs.bufp == TAB)) {        // position past any leading whitespace
         cs.bufp++;
@@ -299,6 +309,23 @@ void controller_set_connected(bool is_connected) {
     }
 }
 
+/*
+ * controller_set_muted(bool) - hook for xio to tell the controller that we
+ * have/don't have one or more muted devices.
+ */
+
+void controller_set_muted(bool is_muted) {
+    // TODO: care about text mode
+    if (is_muted) {
+        // one channel just got muted.
+        const bool only_to_muted = true;
+        xio_writeline("{\"muted\":true}\n", only_to_muted);
+    } else {
+        // one channel just got unmuted, announce it (except to the muted)
+        xio_writeline("{\"muted\":false}\n");
+    }
+}
+
 /*
  * controller_parse_control() - return true if command is a control (versus data)
  * Note: parsing for control is somewhat naiive. This will need to get better
@@ -456,4 +483,4 @@ stat_t _test_system_assertions()
     return (STAT_OK);
 }
 
-    
+    

g2core/controller.h

@@ -84,6 +84,7 @@ extern controller_t cs;                 // controller state structure
 void controller_init(void);
 void controller_run(void);
 void controller_set_connected(bool is_connected);
+void controller_set_muted(bool is_muted);
 bool controller_parse_control(char *p);
 
 #endif // End of include guard: CONTROLLER_H_ONCE

g2core/error.h

@@ -204,7 +204,7 @@ char *get_status_message(stat_t status);
 #define STAT_MAX_DEPTH_EXCEEDED 115             // JSON exceeded maximum nesting depth
 #define STAT_VALUE_TYPE_ERROR 116               // JSON value does not agree with variable type
 
-#define STAT_ERROR_117 117
+#define STAT_INPUT_FROM_MUTED_CHANNEL_ERROR 117               // input from a muted channel was ignored
 #define STAT_ERROR_118 118
 #define STAT_ERROR_119 119
 

g2core/json_parser.cpp

@@ -499,7 +499,9 @@ void json_print_list(stat_t status, uint8_t flags)
     switch (flags) {
         case JSON_NO_PRINT: break;
         case JSON_OBJECT_FORMAT: { json_print_object(nv_body); break; }
-        case JSON_RESPONSE_FORMAT: { json_print_response(status); break; }
+        case JSON_RESPONSE_FORMAT:
+        case JSON_RESPONSE_TO_MUTED_FORMAT:
+            { json_print_response(status, flags == JSON_RESPONSE_TO_MUTED_FORMAT); break; }
     }
 }
 
@@ -522,7 +524,7 @@ void json_print_list(stat_t status, uint8_t flags)
  *  on all the (non-silent) responses.
  */
 
-void json_print_response(uint8_t status)
+void json_print_response(uint8_t status, const bool only_to_muted /*= false*/)
 {
     if (js.json_verbosity == JV_SILENT) {                   // silent means no responses
         return;
@@ -599,7 +601,7 @@ void json_print_response(uint8_t status)
 
     // serialize the JSON response and print it if there were no errors
     if (json_serialize(nv_header, cs.out_buf, sizeof(cs.out_buf)) >= 0) {
-        xio_writeline(cs.out_buf);
+        xio_writeline(cs.out_buf, only_to_muted);
     }
 }
 

g2core/json_parser.h

@@ -57,7 +57,8 @@ typedef enum {
 typedef enum {                      // json output print modes
     JSON_NO_PRINT = 0,              // don't print anything if you find yourself in JSON mode
     JSON_OBJECT_FORMAT,             // print just the body as a json object
-    JSON_RESPONSE_FORMAT            // print the header/body/footer as a response object
+    JSON_RESPONSE_FORMAT,           // print the header/body/footer as a response object
+    JSON_RESPONSE_TO_MUTED_FORMAT   // print the header/body/footer as a response object, only to muted channels
 } jsonFormats;
 
 typedef struct jsSingleton {
@@ -85,7 +86,7 @@ void json_parser(char *str);
 void json_parse_for_exec(char *str, bool execute);
 uint16_t json_serialize(nvObj_t *nv, char *out_buf, uint16_t size);
 void json_print_object(nvObj_t *nv);
-void json_print_response(uint8_t status);
+void json_print_response(uint8_t status, const bool only_to_muted = false);
 void json_print_list(stat_t status, uint8_t flags);
 
 stat_t json_set_jv(nvObj_t *nv);

g2core/settings/settings_Printrbot_Simple_1608.h

@@ -59,6 +59,7 @@
 
 #define COMM_MODE                   JSON_MODE               // one of: TEXT_MODE, JSON_MODE
 #define XIO_ENABLE_FLOW_CONTROL FLOW_CONTROL_RTS            // FLOW_CONTROL_OFF, FLOW_CONTROL_RTS
+#define XIO_UART_MUTES_WHEN_USB_CONNECTED 1                 // Mute the UART when USB connects
 
 #define TEXT_VERBOSITY              TV_VERBOSE              // one of: TV_SILENT, TV_VERBOSE
 #define JSON_VERBOSITY              JV_LINENUM              // one of: JV_SILENT, JV_FOOTER, JV_CONFIGS, JV_MESSAGES, JV_LINENUM, JV_VERBOSE

g2core/settings/settings_default.h

@@ -141,6 +141,10 @@
 #define XIO_ENABLE_FLOW_CONTROL     FLOW_CONTROL_RTS        // FLOW_CONTROL_OFF, FLOW_CONTROL_XON, FLOW_CONTROL_RTS
 #endif
 
+#ifndef XIO_UART_MUTES_WHEN_USB_CONNECTED
+#define XIO_UART_MUTES_WHEN_USB_CONNECTED  0                // UART will be muted when USB connected (off by default)
+#endif
+
 #ifndef JSON_VERBOSITY
 #define JSON_VERBOSITY              JV_MESSAGES             // {jv: JV_SILENT, JV_FOOTER, JV_CONFIGS, JV_MESSAGES, JV_LINENUM, JV_VERBOSE
 #endif