aboutsummaryrefslogtreecommitdiffstats
path: root/documentation/lcd4linux/Makefile (follow)
AgeCommit message (Collapse)AuthorFilesLines
2004-06-02[lcd4linux @ 2004-06-02 05:27:59 by reinelt]reinelt1-0/+59
added documentation tree git-svn-id: https://ssl.bulix.org/svn/lcd4linux/trunk@458 3ae390bd-cb1e-0410-b409-cd5a39f66f1f
43'>43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241
#include "stdafx.h"
#include "cphidgetphsensor.h"
#include <math.h>
#include "cusb.h"
#include "csocket.h"
#include "cthread.h"

// === Internal Functions === //

static double calculate_ph(double Vad, double temperature);

//clearVars - sets all device variables to unknown state
CPHIDGETCLEARVARS(PHSensor)
	
	phid->phMax = PUNI_DBL;
	phid->phMin = PUNI_DBL;
	phid->potentialMax = PUNI_DBL;
	phid->potentialMin = PUNI_DBL;

	phid->Temperature = PUNI_DBL;
	phid->PH = PUNI_DBL;
	phid->PHLastTrigger = PUNK_DBL;
	phid->Potential = PUNI_DBL;
	phid->PHChangeTrigger = PUNI_DBL;

	return EPHIDGET_OK;
}

//initAfterOpen - sets up the initial state of an object, reading in packets from the device if needed
//				  used during attach initialization - on every attach
CPHIDGETINIT(PHSensor)
	TESTPTR(phid);

	phid->Temperature = 20; //20 degrees celcius default

	//Setup max/min values
	switch(phid->phid.deviceIDSpec)
	{
		case PHIDID_PHSENSOR:
			if ((phid->phid.deviceVersion >= 100) && (phid->phid.deviceVersion < 200))
			{
				phid->phMax = round_double(calculate_ph((65535.0 / 13104.0), phid->Temperature), 4);
				phid->phMin = round_double(calculate_ph(0, phid->Temperature), 4);
				phid->potentialMax = round_double(((2.5) / 4.745) * 1000.0, 2);
				phid->potentialMin = round_double(((2.5 - (65535.0 / 13104.0)) / 4.745) * 1000.0, 2);
			}
			else
				return EPHIDGET_BADVERSION;
			break;
		default:
			return EPHIDGET_UNEXPECTED;
	}

	//initialize triggers, set data arrays to unknown
	phid->PH = PUNK_DBL;
	phid->PHLastTrigger = PUNK_DBL;
	phid->Potential = PUNK_DBL;
	phid->PHChangeTrigger = 0.05;

	//issue one read
	CPhidget_read((CPhidgetHandle)phid);

	return EPHIDGET_OK;
}

//dataInput - parses device packets
CPHIDGETDATA(PHSensor)
	double PH = 0, Potential = 0;

	if (length<0) return EPHIDGET_INVALIDARG;
	TESTPTR(phid);
	TESTPTR(buffer);
	
	//Parse device packets - store data locally
	switch(phid->phid.deviceIDSpec)
	{
		case PHIDID_PHSENSOR:
			if ((phid->phid.deviceVersion >= 100) && (phid->phid.deviceVersion < 200))
			{
				double Vad = 0, E = 0;

				Vad = ((double)((unsigned short)buffer[0]+((unsigned short)buffer[1]<<8))) / 13104.0;
				PH = round_double(calculate_ph(Vad, phid->Temperature), 4);
				
				E = (2.5 - Vad) / 4.745;
				Potential = round_double((E * 1000.0), 2);
			}
			else
				return EPHIDGET_UNEXPECTED;
			break;
		default:
			return EPHIDGET_UNEXPECTED;
	}
	
	//Make sure values are within defined range, and store to structure
	if(PH < phid->phMin || PH > phid->phMax)
		phid->PH = PUNK_DBL;
	else
		phid->PH = PH;
	if(Potential < phid->potentialMin || Potential > phid->potentialMax)
		phid->Potential = PUNK_DBL;
	else
		phid->Potential = Potential;

	//send out any events that exceed or match the trigger
	if ((fabs(phid->PH - phid->PHLastTrigger) >= phid->PHChangeTrigger || phid->PHLastTrigger == PUNK_DBL) 
		&& phid->PH != PUNK_DBL)
	{
		FIRE(PHChange, phid->PH);
		phid->PHLastTrigger = phid->PH;
	}

	return EPHIDGET_OK;
}

//eventsAfterOpen - sends out an event for all valid data, used during attach initialization
CPHIDGETINITEVENTS(PHSensor)
	if (phid->PH != PUNK_DBL)
	{
		FIRE(PHChange, phid->PH);
		phid->PHLastTrigger = phid->PH;
	}
	return EPHIDGET_OK;
}

//getPacket - not used for PHSensor
CGETPACKET(PHSensor)
	return EPHIDGET_UNEXPECTED;
}

static double calculate_ph(double Vad, double temperature)
{
	double E, E0, C, T;
	const double R=8.31441, N=1, F=96484.6;
	T=(273.15)+temperature;
	C = 2.3 * ((R*T)/(N*F));
	E0 = 7*C;
	E = (2.5 - Vad) / 4.745;
	return ((E0 - E) / C);
}

// === Exported Functions === //

//create and initialize a device structure
CCREATE(PHSensor, PHIDCLASS_PHSENSOR)

//event setup functions
CFHANDLE(PHSensor, PHChange, double)

CGET(PHSensor,PH,double)
	TESTPTRS(phid,pVal) 
	TESTDEVICETYPE(PHIDCLASS_PHSENSOR)
	TESTATTACHED
	TESTMASGN(PH, PUNK_DBL)

	MASGN(PH)
}

CGET(PHSensor,PHMax,double)
	TESTPTRS(phid,pVal) 	
	TESTDEVICETYPE(PHIDCLASS_PHSENSOR)
	TESTATTACHED
	TESTMASGN(phMax, PUNK_DBL)

	MASGN(phMax)
}

CGET(PHSensor,PHMin,double)
	TESTPTRS(phid,pVal) 	
	TESTDEVICETYPE(PHIDCLASS_PHSENSOR)
	TESTATTACHED
	TESTMASGN(phMin, PUNK_DBL)

	MASGN(phMin)
}

CGET(PHSensor,PHChangeTrigger,double)
	TESTPTRS(phid,pVal) 
	TESTDEVICETYPE(PHIDCLASS_PHSENSOR)
	TESTATTACHED
	TESTMASGN(PHChangeTrigger, PUNK_DBL)

	MASGN(PHChangeTrigger)
}
CSET(PHSensor,PHChangeTrigger,double)
	TESTPTR(phid) 
	TESTDEVICETYPE(PHIDCLASS_PHSENSOR)
	TESTATTACHED
	TESTRANGE(0, phid->phMax - phid->phMin)

	if(CPhidget_statusFlagIsSet(phid->phid.status, PHIDGET_REMOTE_FLAG))
		ADDNETWORKKEY(Trigger, "%lE", PHChangeTrigger);
	else
		phid->PHChangeTrigger = newVal;

	return EPHIDGET_OK;
}

CGET(PHSensor,Potential,double)
	TESTPTRS(phid,pVal) 
	TESTDEVICETYPE(PHIDCLASS_PHSENSOR)
	TESTATTACHED
	TESTMASGN(Potential, PUNK_DBL)

	MASGN(Potential)
}

CGET(PHSensor,PotentialMax,double)
	TESTPTRS(phid,pVal) 	
	TESTDEVICETYPE(PHIDCLASS_PHSENSOR)
	TESTATTACHED
	TESTMASGN(potentialMax, PUNK_DBL)

	MASGN(potentialMax)
}

CGET(PHSensor,PotentialMin,double)
	TESTPTRS(phid,pVal) 	
	TESTDEVICETYPE(PHIDCLASS_PHSENSOR)
	TESTATTACHED
	TESTMASGN(potentialMin, PUNK_DBL)

	MASGN(potentialMin)
}

CSET(PHSensor,Temperature,double)
	TESTPTR(phid) 
	TESTDEVICETYPE(PHIDCLASS_PHSENSOR)
	TESTATTACHED
	TESTRANGE(-273.15, 5000) //arbitrary but reasonable range

	if(CPhidget_statusFlagIsSet(phid->phid.status, PHIDGET_REMOTE_FLAG))
		ADDNETWORKKEY(Temperature, "%lE", Temperature);
	else
		phid->Temperature = newVal;

	phid->phMax = round_double(calculate_ph((65535.0 / 13104.0), phid->Temperature), 4);
	phid->phMin = round_double(calculate_ph(0, phid->Temperature), 4);

	return EPHIDGET_OK;
}