openstage

//------------------------------------------------------------------------------------------------
// This file contains functions necessary for controlling OpenStage via the serial port


//------------------------------------------------------------------------------------------------
//Based on code from The Arduino Cookbook, M. Margolis, recipe 4.5
//read CSV from serial port and store in the global array values
//ADD ERROR CHECKING IF TOO MANY OR TOO FEW VALUES ARE SENT
int readSerialCSV(){
  int fieldIndex = 0;  // the current field being received

  int sSign[numAxes]; //movement sign
  for (int ii=0; ii<numAxes; ii++){
    sSign[ii]=1;
  }

  char ch;
  while (ch != '$'){ //read until the terminator ($) is reached
     if (SerialComms->available()){
         ch = SerialComms->read();
      }else{
         continue;
      }

    // is this an ASCII digit between 0 and 9?
    if(ch >= '0' && ch <= '9'){
      // yes, accumulate the value if the fieldIndex is within range
      // additional fields are not stored
      if(fieldIndex < numAxes)
        values[fieldIndex] = (values[fieldIndex] * 10) + (ch - '0'); 
      } else if (ch == '-') { //deal with negative numbers
        if(fieldIndex < numAxes)
          sSign[fieldIndex] = -1;        
      } else if (ch == ',') {  // comma is our separator, so move on to the next field
         fieldIndex++;   // increment field index 
     }
   }
   
   //set the signs
   for (byte ii=0; ii<fieldIndex+1; ii++){
      values[ii]=values[ii]*sSign[ii];
   }
     
   return fieldIndex;
}

//------------------------------------------------------------------------------------------------
//Make a relative or absolute motion 
void serialMove()
{
  bool verbose=0;
  if (verbose){
    Serial.println("Entering serialMove()");
  }
  
  //Determine if this will be an absolute or relative motion
   while( (SerialComms->available()) == 0 );//block until char arrives
   char moveType=SerialComms->read();

   if (verbose){
    Serial.print("Read next character:");
    Serial.println(moveType);
   }
   
   //Define variables
   int doneReading=0; //1 when all axis fields have been read
  
   float serialTarget[numAxes]; //Where we will be going to in microns
   
   int fieldIndex=readSerialCSV();
   
   //Determine where to move [**IS THIS MIN STUFF RIGHT?**]
   for (byte ii=0; ii<min(numAxes, fieldIndex+1); ii++){
      if (moveType=='r')
          serialTarget[ii]=stagePosition[ii]+values[ii]/1.0E3;
        if (moveType=='a') 
          serialTarget[ii]=values[ii]/1.0E3; //because least sig digits are after decimal point
          values[ii] = 0; // set the values to zero, ready for the next message
     }
  
    moveToTarget(serialTarget);
    SerialComms->print('$'); //send a dollar, which is the terminator
 
} //End serialRelativeMove()



//------------------------------------------------------------------------------------------------
// * serialSetMode
// Set speed mode on the DualShock
void serialSetMode(){
  #ifdef DO_GAMEPAD

  while(SerialComms->available() == 0 );//block until char arrives

  char ch = SerialComms->read();
      
   if (ch=='1')
     coarseFine=1;
   if (ch=='2')
     coarseFine=2;
   if (ch=='3')
     coarseFine=3;
   if (ch=='4')
     coarseFine=4;
     
   setPSLEDS();
  #endif
} //End serialSetMode()


//------------------------------------------------------------------------------------------------
// * zero stage
// Current position becomes the new zero. 
// Also updates any stored locations so that we can still returns to them
void zeroStage(){
  float delta[numAxes]; //difference between current position and previous zero
  for (byte ii=0; ii<numAxes; ii++){
    delta[ii]=stagePosition[ii];
    stagePosition[ii]=0;
    #if doLCD
    lcdStagePos(ii,stagePosition[ii],0);
    #endif
  }  
  
  for (byte ii=0; ii<4; ii++){
    if (locationStored==0)
       continue;       
    for (byte jj; jj<numAxes; jj++)
      buttonStageLocations[jj][ii]=buttonStageLocations[jj][ii]-delta[ii];
  }
   
     
} //End zeroStage()


//------------------------------------------------------------------------------------------------
// * tell position
// Report the current stage position via the serial port
void tellPosition(){

  for (byte ii=0; ii<numAxes; ii++){
    SerialComms->print(stagePosition[ii]);
    if (ii<numAxes-1)
      SerialComms->print(",");
  }
  
  SerialComms->print("$");
     
} //End tell position


//------------------------------------------------------------------------------------------------
// * set or report the moveToStepSize
// "ss" sets the step size and "sr" reports it
void serial_moveToStepSize(){
  while(SerialComms->available() == 0 ){}//block until char arrives
  char ch = SerialComms->read();  

  if (ch=='r'){
    SerialComms->print(moveToStepSize);
    SerialComms->print("$");
  }
  if (ch=='s'){
    while(SerialComms->available() == 0 ); //block until char arrives
    char ch = SerialComms->read();  
    
    if (ch=='1')
      moveToStepSize=1.0/1.0;
    if (ch=='2')
      moveToStepSize=1.0/2.0;
    if (ch=='3')
      moveToStepSize=1.0/4.0;
    if (ch=='4')
      moveToStepSize=1.0/8.0;
    if (ch=='5')
      moveToStepSize=1.0/16.0;
  }
} //End serial_moveToStepSize()


//------------------------------------------------------------------------------------------------
// * set or report the moveTo speeds (microns per second)
// "vs" sets the step size and "vr" reports it
void serial_moveToSpeed(){
  while(SerialComms->available() == 0 ); //block until char arrives
  char ch = SerialComms->read();  

  if (ch=='r'){
   for (byte ii=0; ii<numAxes; ii++){
    SerialComms->print(moveToSpeed[ii]);
    if (ii<numAxes-1)
      SerialComms->print(",");
    }
      SerialComms->print("$");
   }
 
  if (ch=='s'){
    readSerialCSV();
    for (byte ii=0; ii<numAxes; ii++){
      moveToSpeed[ii]=values[ii];
      values[ii] = 0; // zero to ready for next message
     }
  }
} //End serial_moveToSpeed


//------------------------------------------------------------------------------------------------
// * set or report the moveTo accelerations (steps / s^2)
// "as" sets the step size and "ar" reports it
void serial_moveToAccel(){
  while(SerialComms->available() == 0 ); //block until char arrives
  char ch = SerialComms->read();  

  if (ch=='r'){
   for (byte ii=0; ii<numAxes; ii++){
    SerialComms->print(moveToAccel[ii]);
    if (ii<numAxes-1)
      SerialComms->print(",");
    }
      SerialComms->print("$");
   }
 
  if (ch=='s'){
    readSerialCSV();
    for (byte ii=0; ii<numAxes; ii++){
      moveToAccel[ii]=values[ii];
      values[ii] = 0; // zero to ready for next message
     }
  }
} //End serial_moveToAccel



//------------------------------------------------------------------------------------------------
// Reports a bunch of useful information to the serial port as text
void reportInfo(){
  byte ii;
  
  SerialComms->println("OpenStage Settings Information");
  
  SerialComms->print("Number of axes: ");
  SerialComms->print(numAxes);
  SerialComms->print('\n');
  
  
  
  SerialComms->print("Gear Ratios at each axis: ");
  for (ii=0; ii<numAxes; ii++){
    SerialComms->print(gearRatio[ii]);
    if (ii<numAxes-1)
       SerialComms->print(",");
    }
    SerialComms->println(" microns/rev");

  SerialComms->print("Motor Full Steps Per Rev at each axis: ");
  for (ii=0; ii<numAxes; ii++){
    SerialComms->print(int(1/(fullStep[ii]/360.0)));
    if (ii<numAxes-1)
       SerialComms->print(",");
   }
    SerialComms->print('\n');

  SerialComms->print("Hat Stick max speeds (speed modes 1 to 4) : ");
  for (ii=0; ii<4; ii++){
    SerialComms->print(maxSpeed[ii]);
    if (ii<3)
       SerialComms->print(",");
  }
  SerialComms->print('\n');
  SerialComms->print('\n');
  
  SerialComms->print("Serial move specs at each axis:");
  SerialComms->print('\n');
  for (ii=0; ii<numAxes; ii++){
    SerialComms->print(ii+1);
    SerialComms->print(". Speed [um/s]: ");
    SerialComms->print(moveToSpeed[ii]);
    SerialComms->print(".  RPM: ");
    SerialComms->print(int(60 * (moveToSpeed[ii]/(gearRatio[ii]*1.0))));
    SerialComms->print(";  min step [um]: ");
    SerialComms->print(fullStep[ii]/360.0*gearRatio[ii]*moveToStepSize);
    SerialComms->print(";  pulse rate [Hz]: ");
    SerialComms->print(short(moveToSpeed[ii] / ((fullStep[ii]/360) * moveToStepSize * gearRatio[ii])));
    if (ii<numAxes-1)
      SerialComms->print('\n');
  }
  
  SerialComms->print("$");
} //End reportInfo




//------------------------------------------------------------------------------------------------
// Reports a bunch of useful information to the serial port as text
void serialBeep(){
  beep(5500,0.12);
} //End serialBeep