Sketch 框架和类库 - 第一部分

#include <avr/pgmspace.h> 	//enable use of flash memory

static String unitID = "Demo-" + String(__TIME__); 
// __TIME__ has format hh:mm:ss – if we happen to compile at exactly the same time another day we will get the same ID, but pretty unlikely.
						
/* Sketch info strings */
const char sketchName[] PROGMEM = "SoP Demo";	// any valid string
const char sketchVer[] PROGMEM = "1.0.0";		// A.B[.C[.D]] 
const char sketchDate[] PROGMEM = __TIMESTAMP__;		
// __TIMESTAMP__ has format ddd dd MMM hh:mm:ss YYYY - a nightmare to parse!!!
const char sketchAuthor[] PROGMEM = "RogerCO";	// any valid string
const char* const sketchArr[] PROGMEM = { sketchName, sketchVer, sketchDate, sketchAuthor };

char strbuffer[50];  // variable to copy strings from PROGMEN when required

static long loopTime = 20;	// default delay in mS used in main loop

void loop()
{
	//do any read/write ports stuff 

	// deal with any serial commands
	char serialChar;			
	while (Serial.available() > 0) {  
		serialChar = Serial.read();
		if (serialChar = 19) {	// standard commands are Ctrl chars
			reportSketch();
		} else { 	// deal with any sketch specific commands	

	} // endwhile serial port has bytes available

	// do any final tidying up required at end of loop and wait until we go again
	delay(loopTime);

} // end main loop

void reportSketch(void) {
/* reports sketch details */
	strcpy_P(strbuffer, (char*)pgm_read_word(&(sketchArr[0]))); //sketch name
	Serial.print("S="); Serial.println(strbuffer);
	strcpy_P(strbuffer, (char*)pgm_read_word(&(sketchArr[1]))); //sketch version
	Serial.print("V="); Serial.println(strbuffer);
	strcpy_P(strbuffer, (char*)pgm_read_word(&(sketchArr[2]))); //sketch comiled date
	Serial.print("D="); Serial.println(strbuffer);
	strcpy_P(strbuffer, (char*)pgm_read_word(&(sketchArr[3]))); //sketch author
	Serial.print("A="); Serial.println(strbuffer);
	Serial.print("N="); Serial.println(unitID);
}

/* variables associated with standard status info */
static unsigned long loopTime = 20;  // default delay in mS used in main loop
static boolean sendSerialValues = false; // default not send values to serial port
static boolean sendSerialInts = false; // default not send interrupts to serial port

/* standard ctrl commands */
static const byte cmdLoopOn = 1;	//ctrlA enables loop values out to serial
static const byte cmdIntOn = 2;		//ctrlB enables interrupt values to serial
static const byte qCmdDefn = 3;		//ctrlC report sketch command definitions
static const byte qStatusDefn = 4;	//ctrlD report sketch status definitions
static const byte qValDefn = 5;		//ctrlE report sketch value definitions
static const byte qIns = 6;			//ctrlF report input pins used
static const byte qOuts = 7;		//ctrlG report output pins used
static const byte qSketch = 19;		//ctrlS report sketch name, ver, date, author
static const byte cmdLoopTime = 20;	//ctrlT set or get main loop time in ms
static const byte cmdUnitID = 21;	//ctrlU set or get UnitID
static const byte cmdLoopOff = 24;	//ctrlX disable loop values out to serial
static const byte cmdIntOff = 25;	//ctrlY disable interrupt values to serial
static const byte qErrors = 26;		//ctrlZ report timing errors

/* standard status flags */
static const String lblAuthor = "A=";	// Sketch author
static const String lblCmd = "C=";		// Command definition
static const String lblDate = "D=";	    // Sketch Date
static const String lblStatus = "E=";	// Status definition
static const String lblValue = "F=";	// Value definition"
static const String lblIn = "G=";		// Input pin definition"
static const String lblOut = "H=";		// Output pin definition"
static const String lblIntOn = "I=";	// Interrupt output enabled 0|1
static const String lblUnitName = "N=";	// Unit ID
static const String lblLoopOn = "O=";	// Loop output enabled 0|1
static const String lblSketch = "S=";	// Sketch name
static const String lblLoopTime = "T=";	// Main Loop time ms 
static const String lblVersion = "V=";	// Sketch version (as version string format)
static const String lblErrors = "Z=";	// Timing errors report

/* example sketch specific commands and descriptors */
static const byte cmdDoLED = 'L';
const char Lcstr[] PROGMEM = "L=Enable LED";
static const byte cmdNoLED = 'l';
const char lcstr[] PROGMEM = "l=Disable LED";
static const byte cmdPulseWidth = 'p';
const char pcstr[] PROGMEM = "p=Set/Get LED pulse duration (ms)";
const char* const cmdArr[] PROGMEM = { Lcstr, lcstr, pcstr };
static int cmdSize = 3;

int x;

void reportCommands(void) {
/* returns a list of all of the command characters recognised by this sketch */
	for (x = 0; x < cmdSize; x++) {
		strcpy_P(strbuffer, (char*)pgm_read_word(&(cmdArr[x])));
		Serial.print(lblCmd);
		Serial.println(strbuffer);
	}
}

// ...
while (Serial.available() > 0) {  
		serialChar = Serial.read();
		String cmdstr;
		if (serialByte < 28) {	// standard commands are Ctrl chars
			doStdCmd(serialChar);
		} else { 	// deal with any sketch specific commands	

	} // endwhile serial port has bytes available
// ...

 

void doStdCmd(char cmd) {
/* handles a standard control command */
	switch (cmd) {
    case qSketch:	
        reportSketch();
		break;
	case cmdLoopOn:
		sendSerialValues = true;
		Serial.print(lblLoopOn); Serial.println(sendSerialValues);
		break;
// other command function calls as required - see full example
	case cmdLoopTime:	// in this case we are expecting a parameter value
		setLoopTime();
// we always report back the current loop time, so sending just CtrlT will give us the current value without changing it
		Serial.print(lblLoopTime); Serial.println(loopTime);
		break;
	}
}

void setLoopTime (void) {
/* example of handling a command that has a numeric parameter */
	boolean endOfDigits = false;
	String cmdStr = "";
int inChar;
	while (!endOfDigits && Serial.available()) { 
//read digits from the port while available until a non-digit char found
		inChar = Serial.read();
		if (isDigit(inChar)) {
			cmdStr += (char)inChar;
		} else {
			endOfDigits = true;
		}
	}
	if (cmdStr.length() >= 1) { // if we have a number > 0 set new loopTime
		long tmp = cmdStr.toInt();
		if (tmp > 0) loopTime = tmp; 
	}
}