working through cleanup of json docs and unused variables

Author: me

src/src/Stepper.cpp

@@ -36,16 +36,12 @@ volatile double targetToolRelPos = 0;
 int use_limit = false;
 volatile int64_t calculated_stepper_pulses=0;
 
-volatile bool jog_done = true;
 volatile int32_t jog_steps = 0;
 volatile double jog_scaler = 0.2;
 volatile uint16_t vel = 1;
 volatile double stopPos = 0;
 volatile double stopNeg = 0;
 volatile bool useStops = true;
-volatile bool stopPosEx = false;
-volatile bool stopNegEx = false;
-volatile int exDelta = 0;
 volatile bool pos_feeding = false;
 
 rmtStepper::State zstepper;

src/src/Stepper.h

@@ -34,16 +34,12 @@ extern volatile double targetToolRelPos;
 extern int use_limit;
 extern volatile int64_t calculated_stepper_pulses;
 
-extern volatile bool jog_done;
 extern volatile int32_t jog_steps;
 extern volatile double jog_scaler;
 extern volatile uint16_t vel;
 extern volatile double stopPos;
 extern volatile double stopNeg;
 extern volatile bool useStops;
-extern volatile bool stopPosEx;
-extern volatile bool stopNegEx;
-extern volatile int exDelta;
 extern volatile bool pos_feeding;
 
 extern int microsteps;

src/src/display.cpp

@@ -4,115 +4,4 @@
 
 
 
-/* Gutted
-#include "display.h"
 
-#include <Wire.h>
-#include "SSD1306Wire.h"
-#include "neotimer.h"
-#include "state.h"
-#include "Machine.h"
-#include "Stepper.h"
-
-
-SSD1306Wire  display(0x3c, 5, 4);
-Neotimer display_timer = Neotimer(500);
-
-int display_mode = STARTUP;
-
-
-void clear(){
-  display.clear();
-  //display.flipScreenVertically();
-  display.setTextAlignment(TEXT_ALIGN_LEFT);
-  display.setFont(ArialMT_Plain_10);
-}
-// TODO: figure out best way to deal with different displays or using Serial.
-
-void init_display(){
-//#ifdef USESSD1306
-  // setup the display
-  
-  display.init();
-  delay(200);
-  clear();
-
-  
-//#endif
-
-}
-
-static String sp = String(" ");
-
-
-
-
-// this is the feed mode
-void do_startup_display(){
- 
-  display.drawString(0,0,"Display gutted ") ;
-  display.display();
-}
-
-void do_ready_display(){
-  display.drawString(0,0," Display gutted") ;
-  display.display();
-}
-// this is the config mode
-void do_configure_display(){
-  display.drawString(0,0, "config: ");
-  display.display();
-}
-
-
-void do_debug_ready_display(){
-  display.drawString(0,0,"Debug Jog" + String(vel));
-  display.drawString(0,11," Left to jog 10mm");
-  //display.drawString(0,21," back: middle " + String(step_delta) );
-  display.drawString(0,31,"J:"+ String(jogging) + " JS: " + String(jog_done));
-  display.drawString(0,41,"s: " +String(jog_steps));
-  display.display();
-}
-
-void do_status_display(){
-  // Slave logging/feeding
-  // this mode only moves slaved to spindle and with a direction button pressed
-  display.drawString(0,0,"RPM:" + String(rpm) +  " Rapid: " + String(rapids) );
-  display.drawString(0,11,  "Feed Pitch: " + String(pitch,2));
-  display.drawString(0,21,"Pos: " + String(relativePosition))  ;
-  display.drawString(0,31," Delta: " + String( (int32_t)delta ));
-  display.display();
-}
-
-void do_display(){
-
-  if(display_timer.repeat()){
-
-    
-    clear();
-    switch (display_mode) {
-      case STARTUP:
-        do_startup_display();
-        break;
-      case CONFIGURE:
-        do_configure_display();
-        break; 
-      case DSTATUS: 
-        do_status_display();
-        break;
-      case READY:
-        do_ready_display();
-        break;
-      case FEEDING:
-        do_status_display();
-        break;
-      case DEBUG_READY:
-        do_debug_ready_display();
-        break;
-
-    }
-    
-  }
-  
-}
-*/  

src/src/web.cpp

@@ -23,7 +23,7 @@ bool web = true;
 //TODO move the location of this into a platformio variable or something? Maybe the location of the file as a constant in config.h
 #include "../../wifisecret.h"
 
-// json buffer
+// json docs
 
 // config stateDoc
 StaticJsonDocument<600> stateDoc;
@@ -40,31 +40,34 @@ StaticJsonDocument<600> statusDoc;
 // Used to log to UI
 StaticJsonDocument<600> logDoc;
 
-size_t len = 0;
+// buffer for msgpack
+char outBuffer[450];
+
+
 
+size_t serialize_len = 0;
+
+// stores websocket data from asyncWebServer that gets fed to arduinoJSON
 String wsData;
 
+// sends updates (statusDoc) to UI every interval
 Neotimer update_timer = Neotimer(1000);
 
-/*  not used for dhcp
-// Put IP Address details 
-IPAddress local_ip(192,168,1,1);
-IPAddress gateway(192,168,1,1);
-IPAddress subnet(255,255,255,0);
-*/
-
+// TOOD: consider configs from config.h to update this stuff
 AsyncWebServer server(80);
 AsyncWebSocket ws("/els");
 AsyncWebSocketClient * globalClient = NULL;
-char outBuffer[450];
+
+
+// This is a bit like a ping counter, increments each time a new status is sent to the UI
 uint8_t statusCounter = 0;
 
+// I htink this is sent from the UI and used to set the absolute target postion, in the Doc it is "ja"
 double jogAbs = 0;
 
 void saveNvConfigDoc(){
   EepromStream eepromStream(0, 512);
   serializeJson(nvConfigDoc, eepromStream);
-  //EEPROM.commit();
   eepromStream.flush();
   loadNvConfigDoc();
 }
@@ -89,6 +92,7 @@ void initNvConfigDoc(){
 
   */
   //nvConfigDoc[""] = ;
+
   saveNvConfigDoc();
 }
 
@@ -113,32 +117,60 @@ void loadNvConfigDoc(){
 
 
 void updateStatusDoc(){
-  statusDoc["p"] = toolRelPos;
+  // types the message as a status update for the UI
+  statusDoc["cmd"] = "status";
+  
+  // Currently used for the UI DRO display, 
+  //TODO: needs renamed and this is likely better to compute this in the browser!
+  // TODO:  this means that we need to convert any "distance" move to steps befor it gets send to the controller 
   statusDoc["pmm"] = toolRelPosMM;
+  // defined in util.h and helps UI figure out what to display
   statusDoc["m"] = (int)run_mode;
+  // the position in steps, only used in the "debug" screen of the ui
+  // TODO: could just send this and remove "pmm" and calculate position in MM in the browser
+  // TODO: toolPos and toolRelPos should be consolidated as they seem largely redundant
+  statusDoc["p"] = toolRelPos;
   statusDoc["tp"] = toolPos;
-  statusDoc["encoderPos"] = encoder.pulse_counter;
+
+  statusDoc["encoderPos"] = encoder.getCount();
+  // This is the number of encoder pulses needed before the next stepper pulse
+  // TODO: make this optional and move to a "debug" doc
   statusDoc["delta"] = delta;
-  statusDoc["calcPos"] = calculated_stepper_pulses;
+  // this doesn't appear to be used now, but...
   statusDoc["targetPos"] = targetToolRelPos;
+  // I think this is used for aboslute movements
+  // TODO: We should convert to steps in the UI and not have to do the conversion in the controller
   statusDoc["targetPosMM"] = targetToolRelPosMM;
+  // bool for constant run mode, TODO:  bad name though
   statusDoc["feeding"] = feeding;
+  // bools for sync movements, TODO:  bad name
   statusDoc["jogging"] = jogging;
+  // bool for rapid sync movement TODO: bad name
   statusDoc["rap"] = rapiding;
+  // main bool to turn movement on/off
   statusDoc["pos_feed"] = pos_feeding;
-  statusDoc["jog_dong"] = jog_done;
-  statusDoc["sne"] = stopNegEx;
-  statusDoc["spe"] = stopPosEx;
+  // the virtual stop in the Z + direction
   statusDoc["sp"] = stopPos;
+  // the stop in the Z - direction
   statusDoc["sn"] = stopNeg;
+  // for stats
+  // TODO: move this to a debug doc
   statusDoc["c0"] = cpu0;
   statusDoc["c1"] = cpu1;
-  statusDoc["xd"] = exDelta;
+  // this is incremented every status update
   statusDoc["c"] = statusCounter++;
-  statusDoc["cmd"] = "status";
+  
+  // intended feeding "handiness" CCW or CW 
+  // so if the spindle is rotating CW, and the intension is to feed in the Z- direction this should be false
+  // but this somewhat depends on the setup  
   statusDoc["fd"] = z_feeding_dir;
+  // Wait for the spindle/ncoder "0" position
+  // this acts like a thread dial
   statusDoc["sw"] = syncWaiting;
+  // generated in the encoder and displayed in the UI
+  // TODO: consider making the smoothing configurable or done in the browser
   statusDoc["rpm"] = rpm;
+  // this is the effective pulses, so 600 line encoder using full quad is 2400 CPR
   statusDoc["cpr"] = encoder.cpr;
   sendStatus();
 }
@@ -196,29 +228,29 @@ void setRunMode(int mode){
 }
 
 void sendState(){
-  len = serializeMsgPack(stateDoc, outBuffer);  
+  serialize_len = serializeMsgPack(stateDoc, outBuffer);  
   Serial.print(" s ");
-  ws.binaryAll(outBuffer,len);
+  ws.binaryAll(outBuffer,serialize_len);
 }
 
 void sendLogP(Log::Msg *msg){
   logDoc["msg"] = msg->buf;
   logDoc["level"] = (int)msg->level;
   logDoc["cmd"] = "log";
-  len = serializeMsgPack(logDoc,outBuffer);
-  ws.binaryAll(outBuffer,len);
+  serialize_len = serializeMsgPack(logDoc,outBuffer);
+  ws.binaryAll(outBuffer,serialize_len);
 }
 
 void sendStatus(){
-  len = serializeMsgPack(statusDoc, outBuffer);
-  ws.binaryAll(outBuffer,len);
+  serialize_len = serializeMsgPack(statusDoc, outBuffer);
+  ws.binaryAll(outBuffer,serialize_len);
 
 }
 
 void sendNvConfigDoc(){
   nvConfigDoc["cmd"] = "nvConfig";
-  len = serializeMsgPack(nvConfigDoc, outBuffer);
-  ws.binaryAll(outBuffer,len);
+  serialize_len = serializeMsgPack(nvConfigDoc, outBuffer);
+  ws.binaryAll(outBuffer,serialize_len);
 }
 
 
@@ -325,8 +357,6 @@ void handleJog(){
     */
     if(!pos_feeding){
       setStops();   
-      //Serial.print("updated targetToolRelPos");
-      //Serial.println(targetToolRelPos);
       jogging = true;
       init_pos_feed();
       updateStatusDoc();
@@ -632,6 +662,7 @@ void init_ota(){
 
 }
 void sendUpdates(){
+  // called in main loop
   if(update_timer.repeat()){
     // only send state when it changes
     //updateStateDoc();