Combustory - User contributions [en]

Main Page

2010-12-15T03:03:28Z

Combustor:

<anyweb>http://combustory.com/wiki/ads/ad_rtc.html</anyweb>

{{default}}


== Goal ==

My original Goal was to create a website that is the most comprehensive website for Automobiles. However, as I soon found out while looking for a Domain Name that there were not many good choices related to cars. Some how I came up with Combustory and it made me think of the History of Combustibles in general. So I decided on a site that would include all machines dependent on Combustibles. As you can see from the list below it is a fairly significant task that will require a world of help, so please feel free to join in the task by emailing me to create an account and start creating content.

[[Image:lost_soul_1.jpg |frame|Roadside Assistance Required]]

Contact: combustor@combustory.com

<big>'''Categories'''</big>

* [[Motorcycles]]
* [[Cars]]
* [[Trucks]] (Coming )
* [[Tractors]] (Coming)
* [[Earth Movers]] (Coming)
* [[Tanks]] (Coming)
* [[Airplanes]] (Coming)
* [[Jets]] (Coming)
* [[Rockets]] (Coming)
* [[Helicopters]] (Coming)
* [[Locomotives]] (Coming)
* [[General Electronics]]

== Creators Note ==

== Links ==

GPS Sensors

2010-12-06T03:30:20Z

Combustor:

<anyweb>http://combustory.com/wiki/ads/ad_rtc.html</anyweb>

{{default}}

=Pharos GPS-500=

==Device Set Up on Linux==

* Plug in GPS-500 device to a USB port
* Search for device on computer

lsusb

This command should result in finding the Prolific Tech. line as seen below.

example output:

Bus 001 Device 001: ID 1d6b:0002 Linux Foundation 2.0 root hub
Bus 005 Device 001: ID 1d6b:0001 Linux Foundation 1.1 root hub
Bus 003 Device 001: ID 1d6b:0001 Linux Foundation 1.1 root hub
Bus 002 Device 001: ID 1d6b:0001 Linux Foundation 1.1 root hub
Bus 004 Device 008: ID 067b:aaa0 Prolific Technology, Inc. Prolific Pharos
Bus 004 Device 001: ID 1d6b:0001 Linux Foundation 1.1 root hub

* Search for a tty device

ls /dev

Look for a tty device: ttyUSB0 or ttyUSB1 or any other ttyUSBx, which depends on how many USB serial devices you have set up. (This was done on Fedora, other OS's may have a different designation)

==View Data==

* You may need to use sudo to allow permissions to the tty.

* This command will set the device to allow you to log data via tail or cat

stty -F /dev/ttyUSB0 cs8 4800 ignbrk -brkint -icrnl -imaxbel -opost -onlcr -isig -icanon -iexten -echo -echoe -echok -echoctl -echoke noflsh -ixon -crtscts

* View raw data after stty command

cat /dev/ttyUSB0

* Log Data - You will need to manage the log file sizes

cat /dev/ttyUSB0 >> gps_log

* Log Data with Filter - This significantly cuts down on the number of strings and is really the only string you need.

cat /dev/ttyUSB0 | grep GPRMC >> gps_logs

GPS Sensors

2010-12-06T03:02:56Z

Combustor:

<anyweb>http://combustory.com/wiki/ads/ad_rtc.html</anyweb>

{{default}}

=Pharos GPS-500=

==Device Set Up on Linux==

* Plug in GPS-500 device to a USB port
* Search for device on computer

lsusb

This command should result in a finding the Prolific Tech. line as seen below.

example output:

Bus 001 Device 001: ID 1d6b:0002 Linux Foundation 2.0 root hub
Bus 005 Device 001: ID 1d6b:0001 Linux Foundation 1.1 root hub
Bus 003 Device 001: ID 1d6b:0001 Linux Foundation 1.1 root hub
Bus 002 Device 001: ID 1d6b:0001 Linux Foundation 1.1 root hub
Bus 004 Device 008: ID 067b:aaa0 Prolific Technology, Inc. Prolific Pharos
Bus 004 Device 001: ID 1d6b:0001 Linux Foundation 1.1 root hub

* Search for a tty device

ls /dev

Look for a tty device: ttyUSB0 or ttyUSB1 or any other ttyUSBx, which depends on how many USB serial devices you have set up. (This was done on Fedora, other OS's may have a different designation)

==View Data==

* You may need to use sudo to allow permissions to the tty.

* This command will set the device to allow you to log data via tail or cat

stty -F /dev/ttyUSB0 cs8 4800 ignbrk -brkint -icrnl -imaxbel -opost -onlcr -isig -icanon -iexten -echo -echoe -echok -echoctl -echoke noflsh -ixon -crtscts

* View raw data after stty command

cat /dev/ttyUSB0

* Log Data - You will need to manage the log file sizes

cat /dev/ttyUSB0 >> gps_log

* Log Data with Filter - This significantly cuts down on the number of strings and is really the only string you need.

cat /dev/ttyUSB0 | grep GPRMC >> gps_logs

GPS Sensors

2010-12-06T02:59:45Z

Combustor:

<anyweb>http://combustory.com/wiki/ads/ad_rtc.html</anyweb>

{{default}}

=Pharos GPS-500=

==Device Set Up on Linux==

* Plug in GPS-500 device to a USB port
* Search for device on computer

lsusb

This command should result in a finding the Prolific Tech. line as seen below.

example output:

Bus 001 Device 001: ID 1d6b:0002 Linux Foundation 2.0 root hub
Bus 005 Device 001: ID 1d6b:0001 Linux Foundation 1.1 root hub
Bus 003 Device 001: ID 1d6b:0001 Linux Foundation 1.1 root hub
Bus 002 Device 001: ID 1d6b:0001 Linux Foundation 1.1 root hub
Bus 004 Device 008: ID 067b:aaa0 Prolific Technology, Inc. Prolific Pharos
Bus 004 Device 001: ID 1d6b:0001 Linux Foundation 1.1 root hub

* Search for a tty device

ls /dev

Look for a tty device: ttyUSB0 or ttyUSB1 or any other ttyUSBx, which depends (This was done on Fedora, other OS's may have a different designation)

==View Data==

* You may need to use sudo to allow permissions to the tty.
* This command will output troubleshooting info from the server process.

* This command will set the device to allow you to log data via tail or cat

stty -F /dev/ttyUSB0 cs8 4800 ignbrk -brkint -icrnl -imaxbel -opost -onlcr -isig -icanon -iexten -echo -echoe -echok -echoctl -echoke noflsh -ixon -crtscts

* View raw data after stty command

cat /dev/ttyUSB0

* Log Data - You will need to manage the log file sizes

cat /dev/ttyUSB0 >> gps_log

* Log Data with Filter - This significantly cuts down on the number of strings and is really the only string you need.

cat /dev/ttyUSB0 | grep GPRMC >> gps_logs

GPS Sensors

2010-12-06T02:37:46Z

Combustor: New page: =Pharos GPS-500= ==Device Set Up on Linux== * Plug in GPS-500 device to a USB port * Search for device on computer lsusb This command should result in a finding the Prolific Tech. lin...

=Pharos GPS-500=

==Device Set Up on Linux==

* Plug in GPS-500 device to a USB port
* Search for device on computer

lsusb

This command should result in a finding the Prolific Tech. line as seen below.

example output:

Bus 001 Device 001: ID 1d6b:0002 Linux Foundation 2.0 root hub
Bus 005 Device 001: ID 1d6b:0001 Linux Foundation 1.1 root hub
Bus 003 Device 001: ID 1d6b:0001 Linux Foundation 1.1 root hub
Bus 002 Device 001: ID 1d6b:0001 Linux Foundation 1.1 root hub
Bus 004 Device 008: ID 067b:aaa0 Prolific Technology, Inc. Prolific Pharos
Bus 004 Device 001: ID 1d6b:0001 Linux Foundation 1.1 root hub

* Search for a tty device

ls /dev

Look for a tty device

==View Data==

* You may need to use sudo to allow permissions to the tty.
* This command will output troubleshooting info from the server process.

* This command will set the device to allow you to log data via tail or cat

stty -F /dev/ttyUSB0 cs8 4800 ignbrk -brkint -icrnl -imaxbel -opost -onlcr -isig -icanon -iexten -echo -echoe -echok -echoctl -echoke noflsh -ixon -crtscts

* View raw data after stty command

cat /dev/ttyUSB0

* Log Data - You will need to manage the log file sizes

cat /dev/ttyUSB0 >> gps_log

General Electronics

2010-12-06T02:09:02Z

Combustor:

<anyweb>http://combustory.com/wiki/ads/ad_rtc.html</anyweb>

{{default}}

== Topics ==

This is just a general Electronics discussion zone for Combustory. Certainly most Combustion utilizes electronics these days, so I am opening this platform to general electronics.

* [[OBD-II Diagnostic Tools]]
* [[Arduino Electronics]]
* [[MPGuino]] - An MPG gauge based on the Arduino Platform
* [[GPS Sensors]]

== Creators Note ==
== Links ==
[[Category:Electronics]]

RTC1307 - Real Time Clock

2010-11-08T22:24:49Z

Combustor:

<anyweb>http://combustory.com/wiki/ads/ad_rtc.html</anyweb>

{{default}}
__TOC__
== Summary ==
This code shows how to communicate with the RTC DS1307 Real Time Clock, which is used to set and retrieve the date/time of the chip. As a bonus there are some additional bytes of data that can be used as general purpose memory. The main reason for my use of this code is to be able to log events that occur in my applications. I recommend for you to get the RTC DS1307 data sheet to help with understanding what was done here. The bottom line is that I have created this program to accept commands via serial communication with a PC to instruct the Arduino to send or receive data via I2C to the storage registers of the RTC DS1307 chip.

Note of gratitude to [http://www.glacialwanderer.com/hobbyrobotics/?p=12 Maurice Ribble - http://www.glacialwanderer.com/hobbyrobotics/?p=12] for the majority of the RTC DS1307 code. To not repeat his excellent instructions on this chip I highly recommend you visit his site on this topic. All I did here was expand his code a to get a little more functionality out of the DS1307 chip.

== Method ==

=== DS1307 Chip ===

[[Image:DS1307_pin_out.jpg |left|thumb|300px|]]

If you want to take the easy route, spend the extra bucks and buy a [http://www.sparkfun.com/commerce/product_info.php?products_id=99 Spark Fun] ready to go unit for around $20. However, if you really prefer spending an extra hour or so (In my case 4 hours, but you get the benefit of my labor ;~), then buy a few chips from Digikey or Mouser. I think I spent a couple bucks to pay for the chip and the crystal, I ended up having to use two resistors as well, but those were from my existing inventory. If you go the chip route, just keep in mind that shipping can be significant, so you will want to buy more than just the chip.

The reason I had to use the resistors, was to create a voltage divider to create a voltage on the battery backup pin. As I found out and fortunately you will not endure because you are reading this right now, is that the battery pin must have 2.5-3vdc to operate properly or the chip will stop responding to IC2 requests. Ok, we all know the rule, "When all else fails, READ THE DIRECTIONS". As wisdom will have it, I eventually read this seemingly insignificant information in the Data Sheet. Well if I get the time I will outline all the details on the parts and schematic, but the bottom line is that I was still to cheap to buy a 3v battery, so I just used the voltage divider to drop the 5vdc supply. The absolute most funny part is that the chip does run just fine without the 3vdc...... sometimes. Meaning you think you have it all worked out and then......... sometimes. Hence four hours. But your not going to make that mistake are you? Because you are here. Soooooooo, after all is said and done the chip is very stable and works as expected and is reliable.

Now with all the wires flying on the breadboard, sometimes with voltage (Do as I say not as I do!), it is amazing that the chip even works anymore, but there is one further note I need to make about my chip. It is supposed to have 64 registers, but mine only has 31 registers that work. Who knows, did I kill them?, or did I get a bad part? Either way the pointer still rolls through the dead registers as if they were there, but they do not accept any writing. I only bought one of these chips, so I could not test for repeatability. No worry though, hopefully you will have better luck, and I will eventually get another chip to test. '''NOTE - The register issue may have been solved. [http://www.arduino.cc/cgi-bin/yabb2/YaBB.pl?num=1264477731/7 Click Here] to see if this works for you. I have not tried it myself, but go to the bottom of the posting for the solution. Apparently you cannot write more than 32 times in one I2C serial session.'''

This page does not cover the clock output pin that has several settings for outputting a clock frequency, so I will leave it to the reader to figure that function out, as I have no need for that right now. Another interesting feature on this chip is that the time and memory is maintained as long as you have that battery backup at 2.5-3v. But if the chip goes into backup mode, you will not be able to read or write to any of the registers. One misleading piece of data in the Data Sheet is that the memory is non-volatile, well that is true as long as you have the battery backup power. In my voltage divider method, when the power is gone it is gone-gone, so basically no data is retained, but that is exactly why I made the date/time setting command, because I just reset it from the host software that I use to control the Arduino. Go to [[Arduino Communications]] to see how I am communicating with the Arduino.

=== I2C ===

There are basically only two operations that control this chip, a read or write to 64 data registers and the process is similar for both read or write.

* Reading Data
** Reading date/time
*** Open the I2C communication in write mode.
*** Set the register pointer to (0x00) - To read the date/time you reset the pointer to the first register.
*** End write mode.
*** Open I2C in read mode and read seven bytes of data.
<pre>
Wire.beginTransmission(DS1307_I2C_ADDRESS); // Open I2C line in write mode
Wire.send(0x00); // Set the register pointer to (0x00)
Wire.endTransmission(); // End Write Transmission

Wire.requestFrom(DS1307_I2C_ADDRESS, 7); // Open the I2C line in send mode

second = bcdToDec(Wire.receive() & 0x7f); // Read seven bytes of data
minute = bcdToDec(Wire.receive());
hour = bcdToDec(Wire.receive() & 0x3f);
dayOfWeek = bcdToDec(Wire.receive());
dayOfMonth = bcdToDec(Wire.receive());
month = bcdToDec(Wire.receive());
year = bcdToDec(Wire.receive());

</pre>

** Reading Memory - The process is essentially the same as Reading date/time with two small differences
*** (1) You have to set the register pointer where you want to read the memory.
*** (2) You have to indicate how many bytes to read.

<pre>

Wire.beginTransmission(DS1307_I2C_ADDRESS);
Wire.send(0x08); // Set the register pointer to (0x08) to read first memory byte
Wire.endTransmission();

Wire.requestFrom(DS1307_I2C_ADDRESS, 1); // In this case only read one byte

temp_byte = Wire.receive(); // Read the desired byte

</pre>

* Write date/time.
** Open the I2C communication in write mode.
** Set the register pointer to (0x00) - To write the date/time you reset the pointer to the first register.
** Write seven bytes of data.
** End write mode.

<pre>

Wire.beginTransmission(DS1307_I2C_ADDRESS); // Open I2C line in write mode

Wire.send(0x00); // Set the register pointer to (0x00)
Wire.send(decToBcd(second)); // Write seven bytes
Wire.send(decToBcd(minute));
Wire.send(decToBcd(hour));
Wire.send(decToBcd(dayOfWeek));
Wire.send(decToBcd(dayOfMonth));
Wire.send(decToBcd(month));
Wire.send(decToBcd(year));
Wire.endTransmission(); // End write mode

</pre>

** Writing Memory - The process is essentially the same as writing date/time with two small differences
*** (1) You have to set the register pointer where you want to write the memory.
*** (2) Now write the byte value you want in that memory location.

'''Note: You can continue writing and the register pointer will go to the next memory location. When the pointer reaches the end of the memory it will start back at the beginning, which will overwrite your date/time if you are not careful.'''

<pre>

Wire.beginTransmission(DS1307_I2C_ADDRESS);
Wire.send(0xf3); // Set the register pointer to (0xf3) to write the 11th memory byte
Wire.send(0xa6); // Write the desired byte value
Wire.endTransmission();
</pre>

==== RTC_DS1307_v.01 code ====

<pre>
/*
* RTC Control v.01
* by <http://www.combustory.com> John Vaughters
* Credit to:
* Maurice Ribble - http://www.glacialwanderer.com/hobbyrobotics for RTC DS1307 code
*
* With this code you can set the date/time, retreive the date/time and use the extra memory of an RTC DS1307 chip.
* The program also sets all the extra memory space to 0xff.
* Serial Communication method with the Arduino that utilizes a leading CHAR for each command described below.
* Commands:
* T(00-59)(00-59)(00-23)(1-7)(01-31)(01-12)(00-99) - T(sec)(min)(hour)(dayOfWeek)(dayOfMonth)(month)(year) - T Sets the date of the RTC DS1307 Chip.
* Example to set the time for 02-Feb-09 @ 19:57:11 for the 3 day of the week, use this command - T1157193020209
* Q(1-2) - (Q1) Memory initialization (Q2) RTC - Memory Dump
*/

#include "Wire.h"
#define DS1307_I2C_ADDRESS 0x68 // This is the I2C address

// Global Variables

int command = 0; // This is the command char, in ascii form, sent from the serial port
int i;
long previousMillis = 0; // will store last time Temp was updated
byte second, minute, hour, dayOfWeek, dayOfMonth, month, year;
byte test;

// Convert normal decimal numbers to binary coded decimal
byte decToBcd(byte val)
{
return ( (val/10*16) + (val%10) );
}

// Convert binary coded decimal to normal decimal numbers
byte bcdToDec(byte val)
{
return ( (val/16*10) + (val%16) );
}

// 1) Sets the date and time on the ds1307
// 2) Starts the clock
// 3) Sets hour mode to 24 hour clock
// Assumes you're passing in valid numbers, Probably need to put in checks for valid numbers.

void setDateDs1307()
{

second = (byte) ((Serial.read() - 48) * 10 + (Serial.read() - 48)); // Use of (byte) type casting and ascii math to achieve result.
minute = (byte) ((Serial.read() - 48) *10 + (Serial.read() - 48));
hour = (byte) ((Serial.read() - 48) *10 + (Serial.read() - 48));
dayOfWeek = (byte) (Serial.read() - 48);
dayOfMonth = (byte) ((Serial.read() - 48) *10 + (Serial.read() - 48));
month = (byte) ((Serial.read() - 48) *10 + (Serial.read() - 48));
year= (byte) ((Serial.read() - 48) *10 + (Serial.read() - 48));
Wire.beginTransmission(DS1307_I2C_ADDRESS);
Wire.send(0x00);
Wire.send(decToBcd(second)); // 0 to bit 7 starts the clock
Wire.send(decToBcd(minute));
Wire.send(decToBcd(hour)); // If you want 12 hour am/pm you need to set
// bit 6 (also need to change readDateDs1307)
Wire.send(decToBcd(dayOfWeek));
Wire.send(decToBcd(dayOfMonth));
Wire.send(decToBcd(month));
Wire.send(decToBcd(year));
Wire.endTransmission();
}

// Gets the date and time from the ds1307 and prints result
void getDateDs1307()
{
// Reset the register pointer
Wire.beginTransmission(DS1307_I2C_ADDRESS);
Wire.send(0x00);
Wire.endTransmission();

Wire.requestFrom(DS1307_I2C_ADDRESS, 7);

// A few of these need masks because certain bits are control bits
second = bcdToDec(Wire.receive() & 0x7f);
minute = bcdToDec(Wire.receive());
hour = bcdToDec(Wire.receive() & 0x3f); // Need to change this if 12 hour am/pm
dayOfWeek = bcdToDec(Wire.receive());
dayOfMonth = bcdToDec(Wire.receive());
month = bcdToDec(Wire.receive());
year = bcdToDec(Wire.receive());

Serial.print(hour, DEC);
Serial.print(":");
Serial.print(minute, DEC);
Serial.print(":");
Serial.print(second, DEC);
Serial.print(" ");
Serial.print(month, DEC);
Serial.print("/");
Serial.print(dayOfMonth, DEC);
Serial.print("/");
Serial.print(year, DEC);

}

void setup() {
Wire.begin();
Serial.begin(57600);

}

void loop() {
if (Serial.available()) { // Look for char in serial que and process if found
command = Serial.read();
if (command == 84) { //If command = "T" Set Date
setDateDs1307();
getDateDs1307();
Serial.println(" ");
}
else if (command == 81) { //If command = "Q" RTC1307 Memory Functions
delay(100);
if (Serial.available()) {
command = Serial.read();
if (command == 49) { //If command = "1" RTC1307 Initialize Memory - All Data will be set to 255 (0xff). Therefore 255 or 0 will be an invalid value.
Wire.beginTransmission(DS1307_I2C_ADDRESS); // 255 will be the init value and 0 will be considered an error that occurs when the RTC is in Battery mode.
Wire.send(0x08); // Set the register pointer to be just past the date/time registers.
for (i = 1; i <= 27; i++) {
Wire.send(0xff);
delay(100);
}
Wire.endTransmission();
getDateDs1307();
Serial.println(": RTC1307 Initialized Memory");
}
else if (command == 50) { //If command = "2" RTC1307 Memory Dump
getDateDs1307();
Serial.println(": RTC 1307 Dump Begin");
Wire.beginTransmission(DS1307_I2C_ADDRESS);
Wire.send(0x00);
Wire.endTransmission();
Wire.requestFrom(DS1307_I2C_ADDRESS, 64);
for (i = 1; i <= 64; i++) {
test = Wire.receive();
Serial.print(i);
Serial.print(":");
Serial.println(test, DEC);
}
Serial.println(" RTC1307 Dump end");
}
}
}
Serial.print("Command: ");
Serial.println(command); // Echo command CHAR in ascii that was sent
}

command = 0; // reset command
delay(100);
}
//*****************************************************The End***********************

</pre>

== RTC_DS1307_v.01 User Guide ==

Not much to say here, I tend to use the Arduino in the [[Arduino Communications]] Method, so maybe someday I will present the other part of the controlling SW I made for this tool, but I will have to make changes to get it to work correctly for this particular set-up.

For now just enter the commands from the Arduino Environment or your favorite serial communications method.

==== Commands ====

* T(00-59)(00-59)(00-23)(1-7)(01-31)(01-12)(00-99) - T(sec)(min)(hour)(dayOfWeek)(dayOfMonth)(month)(year) - T Sets the date of the RTC DS1307 Chip.
** Example to set the time for 02-Feb-09 @ 19:57:11 for the 3 day of the week, use this command - T1157193020209
* Q1 - This command will initialize all the non date/time memory to 255 (0xff)
** I do this because when the RTC DS1307 goes into back up mode it returns 0 for any register, so for memory usage a 0 will be considered a failure to read memory and 255 will be a default value. Meaning it is considered null.
* Q2 - This command will Dump all 64 registers to the serial buffer

[[Category:Electronics]]

Talk:Arduino Communications

2008-12-01T17:05:32Z

Combustor:

= Notes from Creator =
1 Dec 08 - Roland has provided an alternate solution that I have not investigated yet. By all means I recommend to look for a smoother way to accomplish this task, and please report any successes. Right now I have invested my time and my method works for my needs, some day I may evaluate other ways as well.

If you are like me and you are always on the lookout for a step by step that reduces your development time, then my method does work great and I built my specific windows Apps quite a bit since I authored this solution.

One note on his comment concerning the resetting of the board. My method does not reset the board as long as stty command remains active with the Arduino, and it does not disconnect unless there is a power failure, so this is not an issue.

I would love to hear more comments.

== 22 Nov 08 Discussion From Roland Latour ==

Communication with Arduino Diecimila under linux is not that difficult.
The instructions at arduino.cc recommend using 'screen', which actually forks
a child of itself to handle responses from the board. You can do the same
from the bash shell. First, start a helper program:
cat /dev/ttyUSB0 >> logfile1.raw &
When you unplug the Diecimila, ttyUSB0 goes away, causing this job to exit.
You also need this because without a process holding open the connection,
the Diecimila resets itself after every command.

Then send commands to the unit. Here's a sample that sends 'r a' to Simple
Message System on the Diecimila to read the analog ports:
/bin/echo -e -n "r a\r" > /dev/ttyUSB0
Then get the results with this command:
tail -1 logfile1.raw
That's it! Everything else is window dressing.

As proof of concept, check out my package of shell scripts to talk to
Simple Message System. Full IO & PWM control. AD is scaled to milliVolts
and formatted for import to most spreadsheets. Navigate to
http://user.cavenet.com/rolandl
and download SMS1.tgz, a tar gzip'd archive file. Unpack it with:
tar xvzf SMS1.tgz
You can't (under GPLv2) remove my name and claim it as your own, but you
can take it apart and re-assemble the pieces in new & interesting ways
(I hope you do). Written under Kubuntu, other OSes may vary (especially Slackware!) Questions: contact rolandl@cavenet.com. I hope you find
this useful. -Roland Latour

Talk:Arduino Communications

2008-12-01T17:02:08Z

Combustor:

= Notes from Creator =
1 Dec 08 - Roland has provided an alternate solution that I have not investigated yet. By all means I recommend to look for a smoother way to accomplish this task, and please report any successes. Right now I have invested my time and my method works for my needs, some day I may evaluate other ways as well. I also want to give Roland credit for the inspiration of his SMS solution, which I reviewed before I made my solution. I liked his ideas and I used his basic concept to forge my method as well.

If you are like me and you are always on the lookout for a step by step that reduces your development time, then my method does work great and I built my specific windows Apps quite a bit since I authored this solution.

One note on his comment concerning the resetting of the board. My method does not reset the board as long as stty command remains active with the Arduino.

I would love to hear more comments.

== 22 Nov 08 Discussion From Roland Latour ==

Communication with Arduino Diecimila under linux is not that difficult.
The instructions at arduino.cc recommend using 'screen', which actually forks
a child of itself to handle responses from the board. You can do the same
from the bash shell. First, start a helper program:
cat /dev/ttyUSB0 >> logfile1.raw &
When you unplug the Diecimila, ttyUSB0 goes away, causing this job to exit.
You also need this because without a process holding open the connection,
the Diecimila resets itself after every command.

Then send commands to the unit. Here's a sample that sends 'r a' to Simple
Message System on the Diecimila to read the analog ports:
/bin/echo -e -n "r a\r" > /dev/ttyUSB0
Then get the results with this command:
tail -1 logfile1.raw
That's it! Everything else is window dressing.

As proof of concept, check out my package of shell scripts to talk to
Simple Message System. Full IO & PWM control. AD is scaled to milliVolts
and formatted for import to most spreadsheets. Navigate to
http://user.cavenet.com/rolandl
and download SMS1.tgz, a tar gzip'd archive file. Unpack it with:
tar xvzf SMS1.tgz
You can't (under GPLv2) remove my name and claim it as your own, but you
can take it apart and re-assemble the pieces in new & interesting ways
(I hope you do). Written under Kubuntu, other OSes may vary (especially Slackware!) Questions: contact rolandl@cavenet.com. I hope you find
this useful. -Roland Latour

Arduino Electronics

2008-09-26T20:07:16Z

Combustor:

{{default}}

== Summary ==

Arduino is an open-source hardware platform. It is a micro controller with a free development environment that is greatly simplified for programming the controller. Visit this website for further details, http://www.arduino.cc/

== Topics ==

* [[Arduino Communications]] - A distributed network approach
* [[Temperature Controller]] - A/C control for multi-room space with air duct throttling (ie. Smart Thermostat)
* [[X9241A - Digital Potentiometer]] - Arduino code for using I2C to control this Digital Potentiometer
* [[MPGuino]] - An MPG gauge based on the Arduino Platform
* Suggestions Welcome

== Links ==
[[Category:Electronics]]

X9241A - Digital Potentiometer

2008-09-26T00:03:53Z

Combustor:

{{default}}

== Summary ==
This code shows how to communicate with the X9241A Digital Potentiometer. I plan on updating this info eventually to explain this chip, but for now you will probably want to get the data sheet to help with understanding what was done here. The bottom line is that I have created this program to accept commands via serial commands to set the storage registers to certain values and to modify the pot registers to change based on serial commands. I have not figured out how to read the registers, but that is not so important to my application.

== Method ==
=== I2C ===

There are basically only two functions that I am after right now which are both three byte instructions:

* Read WCR(Wiper Control Register) for the four potentiometers 0-3 (So far this is failing miserably)
** Send 1st byte - Address (my circuit - 01011010 or 0x2D)(binary - 0101 A3 A2 A1 A0) A values are actual pins set to high or low for an address.
** Send 2nd byte - Instruction (binary - 1001 (1/0)(1/0) 00) - The two bits are used to choose the potentiometer
** Read WCR requested Byte
* Write WCR for the four potentiometers 0-3 (This works)
** Send 1st byte - Address (my circuit - 01011010 or 0x2D)(binary - 0101 A3 A2 A1 A0) A values are actual pins set to high or low for an address.
** Send 2nd byte - Instruction (binary - 1010 (1/0)(1/0) 00) - The two bits are used to choose the potentiometer
** Send WCR Byte - Potentiometer value (binary - 00 D5 D4 D3 D2 D1 D0) - D values are the 0-63 potentiometer positions

==== x9241A_Digital_Potentiometer_v.01 code ====

<pre>
/*
* x9241A Digital Potentiometer v.01
* by <http://www.combustory.com> John Vaughters
*
* This Program illustrates the use of I2C to set up the x9241A Digital Potentiometer by setting and transferring the registers.
* I attempted to read the register data through I2C, but was unable to get it to work.
* Since the reading part was not so important to me I stopped trying.
* To set the registers up and transfer them to the Wiper registers met my goals and that is where I stopped.
*
* The x9142A has four Digital Pots and each pot has four static registers and one dynamic register the Wiper Control Register (WCR).
* Therefore, there are 16 total bytes of storage and four WCR's.
* This Program has the following commands:
* S - Set the 16 registers. Each pot has four registers and this command will set each register group with the same value. So register 00 for each pot will
* be the same value for each pot, and the same for register 01 through 11.
* G(0-3) - Global Transfer of Registers to the WCR's. This command will bulk load the values stored in registers into the WCR's.
* For example, a G0 will load the 00 register for each pot into the WCR in one command. A G1 loads the 01 register for each pot, etc.
* (0-3)(0-3) - This set of commands transfers a single register into a single WCR. The digits are arranged like this (WCR)(Reg).
* For example, a 00 command will load register 00 into WCR 00 or a 13 command will load register 11 into WCR 01, etc.
* W(0-3) - This command writes directly to the WCR. I have created four values that are just random, but the command shows how to write directly to the WCR for each pot.
* For example, a W0 command will write a value of decimal 16. These commands are just for example purposes.
*
* Command Note: If you enter a command that is not recognized, then it is ignored and nothing happens and nothing is printed.
*/

#include "Wire.h"
#define X9241_I2C_ADDRESS 0x2D

// Global Variables
long command;

void setup() {
Wire.begin();
Serial.begin(57600);

}

void loop() {
if (Serial.available()) { // Look for char in serial que and process if found
command = Serial.read();
if (command == 83) { //If command = "S" Set Register Data
// This sets the four registers of each Digital Pot
Wire.beginTransmission(X9241_I2C_ADDRESS);
Wire.send(0xc0); // This is the set register command c and the 16 registers are 0-f
Wire.send(0x0a); // This line is the value to set the register: 0-63 is a valid setting
Wire.endTransmission();
delay(100);
Wire.beginTransmission(X9241_I2C_ADDRESS);
Wire.send(0xc1);
Wire.send(0x14);
Wire.endTransmission();
delay(100);
Wire.beginTransmission(X9241_I2C_ADDRESS);
Wire.send(0xc2);
Wire.send(0x20);
Wire.endTransmission();
delay(100);
Wire.beginTransmission(X9241_I2C_ADDRESS);
Wire.send(0xc3);
Wire.send(0x3c);
Wire.endTransmission();
delay(100);
Wire.beginTransmission(X9241_I2C_ADDRESS);
Wire.send(0xc4);
Wire.send(0x0a);
Wire.endTransmission();
delay(100);
Wire.beginTransmission(X9241_I2C_ADDRESS);
Wire.send(0xc5);
Wire.send(0x14);
Wire.endTransmission();
delay(100);
Wire.beginTransmission(X9241_I2C_ADDRESS);
Wire.send(0xc6);
Wire.send(0x20);
Wire.endTransmission();
delay(100);
Wire.beginTransmission(X9241_I2C_ADDRESS);
Wire.send(0xc7);
Wire.send(0x3c);
Wire.endTransmission();
delay(100);
Wire.beginTransmission(X9241_I2C_ADDRESS);
Wire.send(0xc8);
Wire.send(0x0a);
Wire.endTransmission();
delay(100);
Wire.beginTransmission(X9241_I2C_ADDRESS);
Wire.send(0xc9);
Wire.send(0x14);
Wire.endTransmission();
delay(100);
Wire.beginTransmission(X9241_I2C_ADDRESS);
Wire.send(0xca);
Wire.send(0x20);
Wire.endTransmission();
delay(100);
Wire.beginTransmission(X9241_I2C_ADDRESS);
Wire.send(0xcb);
Wire.send(0x3c);
Wire.endTransmission();
delay(100);
Wire.beginTransmission(X9241_I2C_ADDRESS);
Wire.send(0xcc);
Wire.send(0x0a);
Wire.endTransmission();
delay(100);
Wire.beginTransmission(X9241_I2C_ADDRESS);
Wire.send(0xcd);
Wire.send(0x14);
Wire.endTransmission();
delay(100);
Wire.beginTransmission(X9241_I2C_ADDRESS);
Wire.send(0xce);
Wire.send(0x20);
Wire.endTransmission();
delay(100);
Wire.beginTransmission(X9241_I2C_ADDRESS);
Wire.send(0xcf);
Wire.send(0x3c);
Serial.println("cmd: S");
}
else if (command == 71) { //If command = "G" Transfer Global Register Data
delay(100);
if (Serial.available()) {
command = Serial.read();
if (command == 48) { // If command = "0"
Wire.beginTransmission(X9241_I2C_ADDRESS);
Wire.send(0x10); // Global Load WCR's with Reg-00
Wire.endTransmission();
Serial.println("cmd: G0");
}
else if (command == 49) { // If command = "1"
Wire.beginTransmission(X9241_I2C_ADDRESS);
Wire.send(0x11); // Global Load WCR's with Reg-01
Wire.endTransmission();
Serial.println("cmd: G1");
}
else if (command == 50) { // If command = "2"
Wire.beginTransmission(X9241_I2C_ADDRESS);
Wire.send(0x12); // Global Load WCR's with Reg-10
Wire.endTransmission();
Serial.println("cmd: G2");
}
else if (command == 51) { // If command = "3"
Wire.beginTransmission(X9241_I2C_ADDRESS);
Wire.send(0x13); // Global Load WCR's with Reg-11
Wire.endTransmission();
Serial.println("cmd: G3");
}
}
}

else if (command == 48) { //If command = "0" Transfer Register-00 Data to WCR 0-3
delay(100);
if (Serial.available()) {
command = Serial.read();
if (command == 48) { // If command = "0"
Wire.beginTransmission(X9241_I2C_ADDRESS);
Wire.send(0xd0); // Load WCR-00 with Reg-00
Wire.endTransmission();
Serial.println("cmd: 00");
}
else if (command == 49) { // If command = "1"
Wire.beginTransmission(X9241_I2C_ADDRESS);
Wire.send(0xd1); // Load WCR-00 with Reg-01
Wire.endTransmission();
Serial.println("cmd: 01");
}
else if (command == 50) { // If command = "2"
Wire.beginTransmission(X9241_I2C_ADDRESS);
Wire.send(0xd2); // Load WCR-00 with Reg-10
Wire.endTransmission();
Serial.println("cmd: 02");
}
else if (command == 51) { // If command = "3"
Wire.beginTransmission(X9241_I2C_ADDRESS);
Wire.send(0xd3); // Load WCR-00 with Reg-11
Wire.endTransmission();
Serial.println("cmd: 03");
}
}
}
else if (command == 49) { //If command = "1" Transfer Register-01 Data to WCR 0-3
delay(100);
if (Serial.available()) {
command = Serial.read();
if (command == 48) { // If command = "0"
Wire.beginTransmission(X9241_I2C_ADDRESS);
Wire.send(0xd4); // Load WCR-01 with Reg-00
Wire.endTransmission();
Serial.println("cmd: 10");
}
else if (command == 49) { // If command = "1"
Wire.beginTransmission(X9241_I2C_ADDRESS);
Wire.send(0xd5); // Load WCR-01 with Reg-01
Wire.endTransmission();
Serial.println("cmd: 11");
}
else if (command == 50) { // If command = "2"
Wire.beginTransmission(X9241_I2C_ADDRESS);
Wire.send(0xd6); // Load WCR-01 with Reg-10
Wire.endTransmission();
Serial.println("cmd: 12");
}
else if (command == 51) { // If command = "3"
Wire.beginTransmission(X9241_I2C_ADDRESS);
Wire.send(0xd7); // Load WCR-01 with Reg-11
Wire.endTransmission();
Serial.println("cmd: 13");
}
}
}
else if (command == 50) { //If command = "2" Transfer Register-10 Data to WCR 0-3
if (Serial.available()) {
command = Serial.read();
if (command == 48) { // If command = "0"
Wire.beginTransmission(X9241_I2C_ADDRESS);
Wire.send(0xd8); // Load WCR-10 with Reg-00
Wire.endTransmission();
Serial.println("cmd: 20");
}
else if (command == 49) { // If command = "1"
Wire.beginTransmission(X9241_I2C_ADDRESS);
Wire.send(0xd9); // Load WCR-10 with Reg-01
Wire.endTransmission();
Serial.println("cmd: 21");
}
else if (command == 50) { // If command = "2"
Wire.beginTransmission(X9241_I2C_ADDRESS);
Wire.send(0xda); // Load WCR-10 with Reg-10
Wire.endTransmission();
Serial.println("cmd: 22");
}
else if (command == 51) { // If command = "3"
Wire.beginTransmission(X9241_I2C_ADDRESS);
Wire.send(0xdb); // Load WCR-10 with Reg-11
Wire.endTransmission();
Serial.println("cmd: 23");
}
}
}
else if (command == 51) { //If command = "3" Transfer Register-11 Data to WCR 0-3
delay(100);
if (Serial.available()) {
command = Serial.read();
if (command == 48) { // If command = "0"
Wire.beginTransmission(X9241_I2C_ADDRESS);
Wire.send(0xdc); // Load WCR-11 with Reg-00
Wire.endTransmission();
Serial.println("cmd: 30");
}
else if (command == 49) { // If command = "1"
Wire.beginTransmission(X9241_I2C_ADDRESS);
Wire.send(0xdd); // Load WCR-11 with Reg-01
Wire.endTransmission();
Serial.println("cmd: 31");
}
else if (command == 50) { // If command = "2"
Wire.beginTransmission(X9241_I2C_ADDRESS);
Wire.send(0xde); // Load WCR-11 with Reg-10
Wire.endTransmission();
Serial.println("cmd: 32");
}
else if (command == 51) { // If command = "3"
Wire.beginTransmission(X9241_I2C_ADDRESS);
Wire.send(0xdf); // Load WCR-11 with Reg-11
Wire.endTransmission();
Serial.println("cmd: 33");
}
}
}
else if (command == 87) { //If command = "W" write directly to WCR 0-3
delay(100);
if (Serial.available()) {
command = Serial.read();
if (command == 48) { // If command = "0"
Wire.beginTransmission(X9241_I2C_ADDRESS);
Wire.send(0xa0); //Instruction to write WCR-00
Wire.send(0x10); //Send a D value of 16
Wire.endTransmission();
Serial.println("cmd: W0");
}
else if (command == 49) { // If command = "1"
Wire.beginTransmission(X9241_I2C_ADDRESS);
Wire.send(0xa4); //Instruction to write WCR-01
Wire.send(0x20); //Send a D value of 32
Wire.endTransmission();
Serial.println("cmd: W1");
}
else if (command == 50) { // If command = "2"
Wire.beginTransmission(X9241_I2C_ADDRESS);
Wire.send(0xa8); //Instruction to write WCR-10
Wire.send(0x2a); //Send a D value of 26
Wire.endTransmission();
Serial.println("cmd: W2");
}
else if (command == 51) { // If command = "3"
Wire.beginTransmission(X9241_I2C_ADDRESS);
Wire.send(0xac); //Instruction to write WCR-11
Wire.send(0x30); //Send a D value of 48
Wire.endTransmission();
Serial.println("cmd: W3");
}
}
}
}
}
//*****************************************************The End***********************

</pre>

== x9241A_Digital_Potentiometer_v.01 User Guide ==
==== Commands ====
[[Category:Electronics]]

Temperature Controller

2008-09-26T00:02:55Z

Combustor:

{{default}}
== Warning ==
'''This page is in progress and none of the code can be considered good or complete. I am just using this as an alternate storage of the code for right now.'''

== Summary ==
== Functional Description of the Method ==
== Requirements ==
== Example of Method ==
=== Quick Guide: ===
=== Detailed Guide: ===
=== I2C ===
==== X9241A - Digital Potentiometer ====

Detail on this page [[X9241A - Digital Potentiometer]]

There are basically only two functions that I am after right now which are both three byte instructions:

* Read WCR(Wiper Control Register) for the four potentiometers 0-3 (So far this is failing miserably)
** Send 1st byte - Address (my circuit - 01011010 or 0x2D)(binary - 0101 A3 A2 A1 A0) A values are actual pins set to high or low for an address.
** Send 2nd byte - Instruction (binary - 1001 (1/0)(1/0) 00) - The two bits are used to choose the potentiometer
** Read WCR requested Byte
* Write WCR for the four potentiometers 0-3 (This works)
** Send 1st byte - Address (my circuit - 01011010 or 0x2D)(binary - 0101 A3 A2 A1 A0) A values are actual pins set to high or low for an address.
** Send 2nd byte - Instruction (binary - 1010 (1/0)(1/0) 00) - The two bits are used to choose the potentiometer
** Send WCR Byte - Potentiometer value (binary - 00 D5 D4 D3 D2 D1 D0) - D values are the 0-63 potentiometer positions

'''Sample Code'''
<pre>
Wire.beginTransmission(X9241_I2C_ADDRESS);
Wire.send(0xa0); //Instruction to write WCR-00
Wire.send(0x20); //Send a D value of 32
Wire.endTransmission();
</pre>
==== DS1307 - Real Time Clock ====

The code for this very useful chip came from the [[http://www.glacialwanderer.com/hobbyrobotics/?p=12 Glacial Wanderer]]

==== A/C_Control_v.01 code ====

''' While this says v.01, don't count on it being a released v.01, I am still working on v.01, this is a back up '''

<pre>
/*
* A/C Control v.01
* by <http://www.combustory.com> John Vaughters
* Credit to:
* Maurice Ribble - http://www.glacialwanderer.com/hobbyrobotics for RTC DS1307 code
*
* Turns on an LED for temperatures from analog pins 1-5 on
* digital pins 2-6 when the temperature rises above the THRESHOLDS 1-5.
* The program also implements a
* Serial Communication method that utilizes a leading CHAR for each command Described below.
* Commands:
* T(1-4) - Temp1-5 Status ex. T1, T2, etc
* C(1-4)(0-9) - Increment THRESHOLD1-4 by (1-9) ex. C15 increments THRESHOLD1 BY 5 (Note: C40 will give you a status of THRESHOLD4)
* D(1-4)(0-9) - Decrement THRESHOLD1-4 by (1-9) ex. D59 decrements THRESHOLD5 BY 9 (Note: D10 will give you a status of THRESHOLD1)
* A(0-1) - Manual AC on command A1 is AC on, A0 is AC off
* F(0-1) - Manual AC on command A1 is FAN on, A0 is FAN off
* Q - Q Sets the date of the RTC DS1307 Chip
*/

#include "Wire.h"
#define DS1307_I2C_ADDRESS 0x68

// Global Variables
int val_cnt = 0; // counter for the temp_val
int temp1Pin = 0; // select the input pin for the Thermistor
int temp2Pin = 1; // select the input pin for the Thermistor
int temp3Pin = 2; // select the input pin for the Thermistor
int temp4Pin = 3; // select the input pin for the Thermistor
int temp1_val[5] = {0,0,0,0,0}; // variable to store the value coming from the sensor
int temp2_val[5] = {0,0,0,0,0}; //
int temp3_val[5] = {0,0,0,0,0}; //
int temp4_val[5] = {0,0,0,0,0}; //
int temp1_avg; // average over poll time of the temp values
int temp2_avg;
int temp3_avg;
int temp4_avg;
int duct1 = 2; // Ducts open or close using a digital output
int duct2 = 3;
int duct3 = 4;
int duct4 = 5;
int THRESHOLD1 = 580; // Default theshold values
int THRESHOLD2 = 580;
int THRESHOLD3 = 580;
int THRESHOLD4 = 580;
int ac_on = 13;
int fan_on = 12;
int command = 0; // This is the command char, in ascii form, sent from the serial port
long polltime = 1000; // The time to Poll the tempPins
long previousMillis = 0; // will store last time Temp was updated
long ac_on_start = 0; // Start A/C delay timer
long ac_on_delay = 10000; // Time to wait before checking the ducts again
byte second, minute, hour, dayOfWeek, dayOfMonth, month, year;

// Convert normal decimal numbers to binary coded decimal
byte decToBcd(byte val)
{
return ( (val/10*16) + (val%10) );
}

// Convert binary coded decimal to normal decimal numbers
byte bcdToDec(byte val)
{
return ( (val/16*10) + (val%16) );
}

// 1) Sets the date and time on the ds1307
// 2) Starts the clock
// 3) Sets hour mode to 24 hour clock
// Assumes you're passing in valid numbers
// Watch for scope issues with Global Variables
/*void setDateDs1307(byte second, // 0-59
byte minute, // 0-59
byte hour, // 1-23
byte dayOfWeek, // 1-7
byte dayOfMonth, // 1-28/29/30/31
byte month, // 1-12
byte year) // 0-99*/
void setDateDs1307()
{
Wire.beginTransmission(DS1307_I2C_ADDRESS);
Wire.send(0);
Wire.send(decToBcd(second)); // 0 to bit 7 starts the clock
Wire.send(decToBcd(minute));
Wire.send(decToBcd(hour)); // If you want 12 hour am/pm you need to set
// bit 6 (also need to change readDateDs1307)
Wire.send(decToBcd(dayOfWeek));
Wire.send(decToBcd(dayOfMonth));
Wire.send(decToBcd(month));
Wire.send(decToBcd(year));
Wire.endTransmission();
}

// Gets the date and time from the ds1307 and prints result
// Watch for scope issues with Global Variables
void getDateDs1307()
{
// Reset the register pointer
Wire.beginTransmission(DS1307_I2C_ADDRESS);
Wire.send(0);
Wire.endTransmission();

Wire.requestFrom(DS1307_I2C_ADDRESS, 7);

// A few of these need masks because certain bits are control bits
second = bcdToDec(Wire.receive() & 0x7f);
minute = bcdToDec(Wire.receive());
hour = bcdToDec(Wire.receive() & 0x3f); // Need to change this if 12 hour am/pm
dayOfWeek = bcdToDec(Wire.receive());
dayOfMonth = bcdToDec(Wire.receive());
month = bcdToDec(Wire.receive());
year = bcdToDec(Wire.receive());

Serial.print(hour, DEC);
Serial.print(":");
Serial.print(minute, DEC);
Serial.print(":");
Serial.print(second, DEC);
Serial.print(" ");
Serial.print(month, DEC);
Serial.print("/");
Serial.print(dayOfMonth, DEC);
Serial.print("/");
Serial.print(year, DEC);

}

void setup() {
Wire.begin();
Serial.begin(57600);
pinMode(duct1, OUTPUT);
pinMode(duct2, OUTPUT);
pinMode(duct3, OUTPUT);
pinMode(duct4, OUTPUT);
pinMode(ac_on, OUTPUT);
pinMode(fan_on, OUTPUT);
// Initialize Date/Time to update RTC DS1307 - You need to run the Q command right after you download this program
// This is temporary until a more complex date time command is finished
second = 15;
minute = 41;
hour = 12;
dayOfWeek = 5;
dayOfMonth = 5;
month = 9;
year = 8;
}

void loop() {
if (millis() - previousMillis > polltime) {
previousMillis = millis(); // remember the last time
if (millis() - ac_on_start > ac_on_delay) {
if (digitalRead(duct1) || digitalRead(duct2) || digitalRead(duct3) || digitalRead(duct4)){ // If any ducts are turned on turn on the A/C
if (digitalRead(ac_on) != HIGH) { // Check ac_on state
digitalWrite(ac_on,HIGH);
getDateDs1307();
Serial.println(" - AC ON");
}
ac_on_start = millis();
}
else if (digitalRead(ac_on) != LOW){ //Check ac_on state
digitalWrite(ac_on,LOW);
getDateDs1307();
Serial.println(" - AC OFF");
}
}
temp1_val[val_cnt] = analogRead(temp1Pin); // read the value from the sensors
temp2_val[val_cnt] = analogRead(temp2Pin);
temp3_val[val_cnt] = analogRead(temp3Pin);
temp4_val[val_cnt] = analogRead(temp4Pin);
val_cnt ++;
if (val_cnt == 5) {
val_cnt = 0;
}
temp1_avg = (temp1_val[0] + temp1_val[1] + temp1_val[2] + temp1_val[3] + temp1_val[4])/5;
temp2_avg = (temp2_val[0] + temp2_val[1] + temp2_val[2] + temp2_val[3] + temp2_val[4])/5;
temp3_avg = (temp3_val[0] + temp3_val[1] + temp3_val[2] + temp3_val[3] + temp3_val[4])/5;
temp4_avg = (temp4_val[0] + temp4_val[1] + temp4_val[2] + temp4_val[3] + temp4_val[4])/5;
// Check Thresholds against the Temperatures and set the ducts HIGH or LOW
if (temp1_avg >= THRESHOLD1) {digitalWrite(duct1, HIGH);}
else {digitalWrite(duct1, LOW);}
if (temp2_avg >= THRESHOLD2) {digitalWrite(duct2, HIGH);}
else {digitalWrite(duct2, LOW);}
if (temp3_avg >= THRESHOLD3) {digitalWrite(duct3, HIGH);}
else {digitalWrite(duct3, LOW);}
if (temp4_avg >= THRESHOLD4) {digitalWrite(duct4, HIGH);}
else {digitalWrite(duct4, LOW);}
if (Serial.available()) { // Look for char in serial que and process if found
command = Serial.read();
if (command == 84) { // If command = "T"
command = Serial.read();
if (command == 49) { // If command = "1" print the Temp1
Serial.print("Temp1 = ");
Serial.print(temp1_avg); //
Serial.print(" ");
}
else if (command == 50) { // If command = "2" print the Temp2
Serial.print("Temp2 = ");
Serial.print(temp2_avg); //
Serial.print(" ");
}
else if (command == 51) { // If command = "3" print the Temp3
Serial.print("Temp3 = ");
Serial.print(temp3_avg); //
Serial.print(" ");
}
else if (command == 52) { // If command = "4" print the Temp4
Serial.print("Temp4 = ");
Serial.print(temp4_avg); //
Serial.print(" ");
}
}
else if (command == 67) { //If command = "C" Change Temp Threshhold
if (Serial.available()) {
command = Serial.read();
if (command == 49) { // If command = "1" print the THRESHOLD1
command = Serial.read();
if (command > 47 && command < 58) { // If command is between 0-9 Increment the Threshold by number sent
THRESHOLD1 += command - 48; // ASCII math to get value sent
Serial.print("THRESHOLD1 = ");
Serial.print(THRESHOLD1); //
Serial.print(" ");
}
}
else if (command == 50) { // If command = "2" print the THRESHOLD2
command = Serial.read();
if (command > 47 && command < 58) { // If command is between 0-9 Increment the Threshold by number sent
THRESHOLD2 += command - 48; // ASCII math to get value sent
Serial.print("THRESHOLD2 = ");
Serial.print(THRESHOLD2); //
Serial.print(" ");
}
}
else if (command == 51) { // If command = "3" print the THRESHOLD3
command = Serial.read();
if (command > 47 && command < 58) { // If command is between 0-9 Increment the Threshold by number sent
THRESHOLD3 += command - 48; // ASCII math to get value sent
Serial.print("THRESHOLD3 = ");
Serial.print(THRESHOLD3); //
Serial.print(" ");
}
}
else if (command == 52) { // If command = "4" print the THRESHOLD4
command = Serial.read();
if (command > 47 && command < 58) { // If command is between 0-9 Increment the Threshold by number sent
THRESHOLD4 += command - 48; // ASCII math to get value sent
Serial.print("THRESHOLD4 = ");
Serial.print(THRESHOLD4); //
Serial.print(" ");
}
}
}
}
else if (command == 68) { //If command = "D" Change Temp Threshhold
if (Serial.available()) {
command = Serial.read();
if (command == 49) { // If command = "1" print the THRESHOLD1
command = Serial.read();
if (command > 47 && command < 58) { // If command is between 0-9 Decrement the Threshold by number sent
THRESHOLD1 -= command - 48; // ASCII math to get value sent
Serial.print("THRESHOLD1 = ");
Serial.print(THRESHOLD1); //
Serial.print(" ");
}
}
else if (command == 50) { // If command = "2" print the THRESHOLD2
command = Serial.read();
if (command > 47 && command < 58) { // If command is between 0-9 Decrement the Threshold by number sent
THRESHOLD2 -= command - 48; // ASCII math to get value sent
Serial.print("THRESHOLD2 = ");
Serial.print(THRESHOLD2); //
Serial.print(" ");
}
}
else if (command == 51) { // If command = "3" print the THRESHOLD3
command = Serial.read();
if (command > 47 && command < 58) { // If command is between 0-9 Decrement the Threshold by number sent
THRESHOLD3 -= command - 48; // ASCII math to get value sent
Serial.print("THRESHOLD3 = ");
Serial.print(THRESHOLD3); //
Serial.print(" ");
}
}
else if (command == 52) { // If command = "4" print the THRESHOLD4
command = Serial.read();
if (command > 47 && command < 58) { // If command is between 0-9 Decrement the Threshold by number sent
THRESHOLD4 -= command - 48; // ASCII math to get value sent
Serial.print("THRESHOLD4 = ");
Serial.print(THRESHOLD4); //
Serial.print(" ");
}
}
}
}
//**************** Warning - This is a potential for problem - Consider a manual lock out feature to lock out manual commands
//**************** Possibly create a command to open up manual commands for a certian time period then shut them off again automatically
else if (command == 65) { //If command = "A" Change Temp Threshhold
if (Serial.available()) {
command = Serial.read();
if (command == 49) { // If command = "1" print the AC ON message
getDateDs1307();
Serial.print(" - Manual AC ON ");
ac_on_start = millis(); // Set the AC to a delay before it can be turned off again
digitalWrite(ac_on,HIGH);
}
else if (command == 48) { // If command = "0" print the AC OFF message
getDateDs1307();
Serial.print(" - Manual AC OFF ");
digitalWrite(ac_on,LOW);
}
}
}
else if (command == 70) { //If command = "F" Change Temp Threshhold
if (Serial.available()) {
command = Serial.read();
if (command == 49) { // If command = "1" print the FAN ON message
getDateDs1307();
Serial.print(" - Manual FAN ON ");
ac_on_start = millis();
digitalWrite(fan_on,HIGH);
}
else if (command == 48) { // If command = "0" print the FAN OFF message
getDateDs1307();
Serial.print(" - Manual FAN OFF ");
digitalWrite(fan_on,LOW);
}
}
}
//********************** End of Warning Zone *******************************

// *************** This Section Will list the Staus of the Controller
else if (command == 83) { //If command = "S" Print Controller Status
getDateDs1307();
Serial.println(" ");
Serial.println(" ");
Serial.print("Temp1 = ");
Serial.println(temp1_avg);
Serial.print("Temp2 = ");
Serial.println(temp2_avg);
Serial.print("Temp3 = ");
Serial.println(temp3_avg);
Serial.print("Temp4 = ");
Serial.println(temp4_avg);
Serial.println(" ");
Serial.print("THRESHOLD1 = ");
Serial.println(THRESHOLD1);
Serial.print("THRESHOLD2 = ");
Serial.println(THRESHOLD2);
Serial.print("THRESHOLD3 = ");
Serial.println(THRESHOLD3);
Serial.print("THRESHOLD4 = ");
Serial.println(THRESHOLD4);
Serial.println(" ");
if (digitalRead(duct1) == HIGH) {Serial.println("duct1 ON");}
else{Serial.println("duct1 OFF");}
if (digitalRead(duct2) == HIGH) {Serial.println("duct2 ON");}
else{Serial.println("duct2 OFF");}
if (digitalRead(duct3) == HIGH) {Serial.println("duct3 ON");}
else{Serial.println("duct3 OFF");}
if (digitalRead(duct4) == HIGH) {Serial.println("duct4 ON");}
else{Serial.println("duct4 OFF");}
Serial.println(" ");
if (digitalRead(fan_on) == HIGH) {Serial.println("Fan ON");}
else{Serial.println("Fan OFF");}
if (digitalRead(ac_on) == HIGH) {Serial.println("AC ON");}
else{Serial.println("AC OFF");}
Serial.print("A/C Delay (millisec) = ");
Serial.println(ac_on_delay);
Serial.print("Temp Polling (millisec) = ");
Serial.println(polltime);
Serial.println(" ");

}
else if (command == 81) { //If command = "Q" Set Date
setDateDs1307();
getDateDs1307();
Serial.println(" ");
}
Serial.println(command); // Echo command char found in serial que
command = 0; // reset command
}
}
}
//*****************************************************The End***********************
</pre>

== A/C_Control_v.01 User Guide ==
==== Commands ====
== Troubleshooting ==
=== Summary ===
When Troubleshooting a multi-functional issue, it is best practice to break down the issue into pieces and test each piece as a separate system. However, we will first run through a quick test to see if we can find any obvious issues first.
=== Quick Test ===
[[Category:Electronics]]

X9241A - Digital Potentiometer

2008-09-26T00:00:45Z

Combustor: /* Summary */

X9241A - Digital Potentiometer

2008-09-25T23:55:03Z

Combustor:

{{default}}

== Summary ==

== Method ==
=== I2C ===

There are basically only two functions that I am after right now which are both three byte instructions:

* Read WCR(Wiper Control Register) for the four potentiometers 0-3 (So far this is failing miserably)
** Send 1st byte - Address (my circuit - 01011010 or 0x2D)(binary - 0101 A3 A2 A1 A0) A values are actual pins set to high or low for an address.
** Send 2nd byte - Instruction (binary - 1001 (1/0)(1/0) 00) - The two bits are used to choose the potentiometer
** Read WCR requested Byte
* Write WCR for the four potentiometers 0-3 (This works)
** Send 1st byte - Address (my circuit - 01011010 or 0x2D)(binary - 0101 A3 A2 A1 A0) A values are actual pins set to high or low for an address.
** Send 2nd byte - Instruction (binary - 1010 (1/0)(1/0) 00) - The two bits are used to choose the potentiometer
** Send WCR Byte - Potentiometer value (binary - 00 D5 D4 D3 D2 D1 D0) - D values are the 0-63 potentiometer positions

==== x9241A_Digital_Potentiometer_v.01 code ====

<pre>
/*
* x9241A Digital Potentiometer v.01
* by <http://www.combustory.com> John Vaughters
*
* This Program illustrates the use of I2C to set up the x9241A Digital Potentiometer by setting and transferring the registers.
* I attempted to read the register data through I2C, but was unable to get it to work.
* Since the reading part was not so important to me I stopped trying.
* To set the registers up and transfer them to the Wiper registers met my goals and that is where I stopped.
*
* The x9142A has four Digital Pots and each pot has four static registers and one dynamic register the Wiper Control Register (WCR).
* Therefore, there are 16 total bytes of storage and four WCR's.
* This Program has the following commands:
* S - Set the 16 registers. Each pot has four registers and this command will set each register group with the same value. So register 00 for each pot will
* be the same value for each pot, and the same for register 01 through 11.
* G(0-3) - Global Transfer of Registers to the WCR's. This command will bulk load the values stored in registers into the WCR's.
* For example, a G0 will load the 00 register for each pot into the WCR in one command. A G1 loads the 01 register for each pot, etc.
* (0-3)(0-3) - This set of commands transfers a single register into a single WCR. The digits are arranged like this (WCR)(Reg).
* For example, a 00 command will load register 00 into WCR 00 or a 13 command will load register 11 into WCR 01, etc.
* W(0-3) - This command writes directly to the WCR. I have created four values that are just random, but the command shows how to write directly to the WCR for each pot.
* For example, a W0 command will write a value of decimal 16. These commands are just for example purposes.
*
* Command Note: If you enter a command that is not recognized, then it is ignored and nothing happens and nothing is printed.
*/

#include "Wire.h"
#define X9241_I2C_ADDRESS 0x2D

// Global Variables
long command;

void setup() {
Wire.begin();
Serial.begin(57600);

}

void loop() {
if (Serial.available()) { // Look for char in serial que and process if found
command = Serial.read();
if (command == 83) { //If command = "S" Set Register Data
// This sets the four registers of each Digital Pot
Wire.beginTransmission(X9241_I2C_ADDRESS);
Wire.send(0xc0); // This is the set register command c and the 16 registers are 0-f
Wire.send(0x0a); // This line is the value to set the register: 0-63 is a valid setting
Wire.endTransmission();
delay(100);
Wire.beginTransmission(X9241_I2C_ADDRESS);
Wire.send(0xc1);
Wire.send(0x14);
Wire.endTransmission();
delay(100);
Wire.beginTransmission(X9241_I2C_ADDRESS);
Wire.send(0xc2);
Wire.send(0x20);
Wire.endTransmission();
delay(100);
Wire.beginTransmission(X9241_I2C_ADDRESS);
Wire.send(0xc3);
Wire.send(0x3c);
Wire.endTransmission();
delay(100);
Wire.beginTransmission(X9241_I2C_ADDRESS);
Wire.send(0xc4);
Wire.send(0x0a);
Wire.endTransmission();
delay(100);
Wire.beginTransmission(X9241_I2C_ADDRESS);
Wire.send(0xc5);
Wire.send(0x14);
Wire.endTransmission();
delay(100);
Wire.beginTransmission(X9241_I2C_ADDRESS);
Wire.send(0xc6);
Wire.send(0x20);
Wire.endTransmission();
delay(100);
Wire.beginTransmission(X9241_I2C_ADDRESS);
Wire.send(0xc7);
Wire.send(0x3c);
Wire.endTransmission();
delay(100);
Wire.beginTransmission(X9241_I2C_ADDRESS);
Wire.send(0xc8);
Wire.send(0x0a);
Wire.endTransmission();
delay(100);
Wire.beginTransmission(X9241_I2C_ADDRESS);
Wire.send(0xc9);
Wire.send(0x14);
Wire.endTransmission();
delay(100);
Wire.beginTransmission(X9241_I2C_ADDRESS);
Wire.send(0xca);
Wire.send(0x20);
Wire.endTransmission();
delay(100);
Wire.beginTransmission(X9241_I2C_ADDRESS);
Wire.send(0xcb);
Wire.send(0x3c);
Wire.endTransmission();
delay(100);
Wire.beginTransmission(X9241_I2C_ADDRESS);
Wire.send(0xcc);
Wire.send(0x0a);
Wire.endTransmission();
delay(100);
Wire.beginTransmission(X9241_I2C_ADDRESS);
Wire.send(0xcd);
Wire.send(0x14);
Wire.endTransmission();
delay(100);
Wire.beginTransmission(X9241_I2C_ADDRESS);
Wire.send(0xce);
Wire.send(0x20);
Wire.endTransmission();
delay(100);
Wire.beginTransmission(X9241_I2C_ADDRESS);
Wire.send(0xcf);
Wire.send(0x3c);
Serial.println("cmd: S");
}
else if (command == 71) { //If command = "G" Transfer Global Register Data
delay(100);
if (Serial.available()) {
command = Serial.read();
if (command == 48) { // If command = "0"
Wire.beginTransmission(X9241_I2C_ADDRESS);
Wire.send(0x10); // Global Load WCR's with Reg-00
Wire.endTransmission();
Serial.println("cmd: G0");
}
else if (command == 49) { // If command = "1"
Wire.beginTransmission(X9241_I2C_ADDRESS);
Wire.send(0x11); // Global Load WCR's with Reg-01
Wire.endTransmission();
Serial.println("cmd: G1");
}
else if (command == 50) { // If command = "2"
Wire.beginTransmission(X9241_I2C_ADDRESS);
Wire.send(0x12); // Global Load WCR's with Reg-10
Wire.endTransmission();
Serial.println("cmd: G2");
}
else if (command == 51) { // If command = "3"
Wire.beginTransmission(X9241_I2C_ADDRESS);
Wire.send(0x13); // Global Load WCR's with Reg-11
Wire.endTransmission();
Serial.println("cmd: G3");
}
}
}

else if (command == 48) { //If command = "0" Transfer Register-00 Data to WCR 0-3
delay(100);
if (Serial.available()) {
command = Serial.read();
if (command == 48) { // If command = "0"
Wire.beginTransmission(X9241_I2C_ADDRESS);
Wire.send(0xd0); // Load WCR-00 with Reg-00
Wire.endTransmission();
Serial.println("cmd: 00");
}
else if (command == 49) { // If command = "1"
Wire.beginTransmission(X9241_I2C_ADDRESS);
Wire.send(0xd1); // Load WCR-00 with Reg-01
Wire.endTransmission();
Serial.println("cmd: 01");
}
else if (command == 50) { // If command = "2"
Wire.beginTransmission(X9241_I2C_ADDRESS);
Wire.send(0xd2); // Load WCR-00 with Reg-10
Wire.endTransmission();
Serial.println("cmd: 02");
}
else if (command == 51) { // If command = "3"
Wire.beginTransmission(X9241_I2C_ADDRESS);
Wire.send(0xd3); // Load WCR-00 with Reg-11
Wire.endTransmission();
Serial.println("cmd: 03");
}
}
}
else if (command == 49) { //If command = "1" Transfer Register-01 Data to WCR 0-3
delay(100);
if (Serial.available()) {
command = Serial.read();
if (command == 48) { // If command = "0"
Wire.beginTransmission(X9241_I2C_ADDRESS);
Wire.send(0xd4); // Load WCR-01 with Reg-00
Wire.endTransmission();
Serial.println("cmd: 10");
}
else if (command == 49) { // If command = "1"
Wire.beginTransmission(X9241_I2C_ADDRESS);
Wire.send(0xd5); // Load WCR-01 with Reg-01
Wire.endTransmission();
Serial.println("cmd: 11");
}
else if (command == 50) { // If command = "2"
Wire.beginTransmission(X9241_I2C_ADDRESS);
Wire.send(0xd6); // Load WCR-01 with Reg-10
Wire.endTransmission();
Serial.println("cmd: 12");
}
else if (command == 51) { // If command = "3"
Wire.beginTransmission(X9241_I2C_ADDRESS);
Wire.send(0xd7); // Load WCR-01 with Reg-11
Wire.endTransmission();
Serial.println("cmd: 13");
}
}
}
else if (command == 50) { //If command = "2" Transfer Register-10 Data to WCR 0-3
if (Serial.available()) {
command = Serial.read();
if (command == 48) { // If command = "0"
Wire.beginTransmission(X9241_I2C_ADDRESS);
Wire.send(0xd8); // Load WCR-10 with Reg-00
Wire.endTransmission();
Serial.println("cmd: 20");
}
else if (command == 49) { // If command = "1"
Wire.beginTransmission(X9241_I2C_ADDRESS);
Wire.send(0xd9); // Load WCR-10 with Reg-01
Wire.endTransmission();
Serial.println("cmd: 21");
}
else if (command == 50) { // If command = "2"
Wire.beginTransmission(X9241_I2C_ADDRESS);
Wire.send(0xda); // Load WCR-10 with Reg-10
Wire.endTransmission();
Serial.println("cmd: 22");
}
else if (command == 51) { // If command = "3"
Wire.beginTransmission(X9241_I2C_ADDRESS);
Wire.send(0xdb); // Load WCR-10 with Reg-11
Wire.endTransmission();
Serial.println("cmd: 23");
}
}
}
else if (command == 51) { //If command = "3" Transfer Register-11 Data to WCR 0-3
delay(100);
if (Serial.available()) {
command = Serial.read();
if (command == 48) { // If command = "0"
Wire.beginTransmission(X9241_I2C_ADDRESS);
Wire.send(0xdc); // Load WCR-11 with Reg-00
Wire.endTransmission();
Serial.println("cmd: 30");
}
else if (command == 49) { // If command = "1"
Wire.beginTransmission(X9241_I2C_ADDRESS);
Wire.send(0xdd); // Load WCR-11 with Reg-01
Wire.endTransmission();
Serial.println("cmd: 31");
}
else if (command == 50) { // If command = "2"
Wire.beginTransmission(X9241_I2C_ADDRESS);
Wire.send(0xde); // Load WCR-11 with Reg-10
Wire.endTransmission();
Serial.println("cmd: 32");
}
else if (command == 51) { // If command = "3"
Wire.beginTransmission(X9241_I2C_ADDRESS);
Wire.send(0xdf); // Load WCR-11 with Reg-11
Wire.endTransmission();
Serial.println("cmd: 33");
}
}
}
else if (command == 87) { //If command = "W" write directly to WCR 0-3
delay(100);
if (Serial.available()) {
command = Serial.read();
if (command == 48) { // If command = "0"
Wire.beginTransmission(X9241_I2C_ADDRESS);
Wire.send(0xa0); //Instruction to write WCR-00
Wire.send(0x10); //Send a D value of 16
Wire.endTransmission();
Serial.println("cmd: W0");
}
else if (command == 49) { // If command = "1"
Wire.beginTransmission(X9241_I2C_ADDRESS);
Wire.send(0xa4); //Instruction to write WCR-01
Wire.send(0x20); //Send a D value of 32
Wire.endTransmission();
Serial.println("cmd: W1");
}
else if (command == 50) { // If command = "2"
Wire.beginTransmission(X9241_I2C_ADDRESS);
Wire.send(0xa8); //Instruction to write WCR-10
Wire.send(0x2a); //Send a D value of 26
Wire.endTransmission();
Serial.println("cmd: W2");
}
else if (command == 51) { // If command = "3"
Wire.beginTransmission(X9241_I2C_ADDRESS);
Wire.send(0xac); //Instruction to write WCR-11
Wire.send(0x30); //Send a D value of 48
Wire.endTransmission();
Serial.println("cmd: W3");
}
}
}
}
}
//*****************************************************The End***********************

</pre>

== x9241A_Digital_Potentiometer_v.01 User Guide ==
==== Commands ====

X9241A - Digital Potentiometer

2008-09-14T02:33:41Z

Combustor: /* x9241A_Digital_Potentiometer_v.01 code */

{{default}}

== Summary ==

== Example of Method ==
=== I2C ===

There are basically only two functions that I am after right now which are both three byte instructions:

* Read WCR(Wiper Control Register) for the four potentiometers 0-3 (So far this is failing miserably)
** Send 1st byte - Address (my circuit - 01011010 or 0x2D)(binary - 0101 A3 A2 A1 A0) A values are actual pins set to high or low for an address.
** Send 2nd byte - Instruction (binary - 1001 (1/0)(1/0) 00) - The two bits are used to choose the potentiometer
** Read WCR requested Byte
* Write WCR for the four potentiometers 0-3 (This works)
** Send 1st byte - Address (my circuit - 01011010 or 0x2D)(binary - 0101 A3 A2 A1 A0) A values are actual pins set to high or low for an address.
** Send 2nd byte - Instruction (binary - 1010 (1/0)(1/0) 00) - The two bits are used to choose the potentiometer
** Send WCR Byte - Potentiometer value (binary - 00 D5 D4 D3 D2 D1 D0) - D values are the 0-63 potentiometer positions

'''Sample Code'''
<pre>
Wire.beginTransmission(X9241_I2C_ADDRESS);
Wire.send(0xa0); //Instruction to write WCR-00
Wire.send(0x20); //Send a D value of 32
Wire.endTransmission();
</pre>

==== x9241A_Digital_Potentiometer_v.01 code ====

<pre>
/*
* x9241A Digital Potentiometer v.01
* by <http://www.combustory.com> John Vaughters
*
* This Program illustrates the use of I2C to set up the x9241A Digital Potentiometer by setting and transferring the registers.
* I attempted to read the register data through I2C, but was unable to get it to work.
* Since the reading part was not so important to me I stopped trying.
* To set the registers up and transfer them to the Wiper registers met my goals and that is where I stopped.
*
* The x9142A has four Digital Pots and each pot has four static registers and one dynamic register the Wiper Control Register (WCR).
* Therefore, there are 16 total bytes of storage and four WCR's.
* This Program has the following commands:
* S - Set the 16 registers. Each pot has four registers and this command will set each register group with the same value. So register 00 for each pot will
* be the same value for each pot, and the same for register 01 through 11.
* G(0-3) - Global Transfer of Registers to the WCR's. This command will bulk load the values stored in registers into the WCR's.
* For example, a G0 will load the 00 register for each pot into the WCR in one command. A G1 loads the 01 register for each pot, etc.
* (0-3)(0-3) - This set of commands transfers a single register into a single WCR. The digits are arranged like this (WCR)(Reg).
* For example, a 00 command will load register 00 into WCR 00 or a 13 command will load register 11 into WCR 01, etc.
* W(0-3) - This command writes directly to the WCR. I have created four values that are just random, but the command shows how to write directly to the WCR for each pot.
* For example, a W0 command will write a value of decimal 16. These commands are just for example purposes.
*
* Command Note: If you enter a command that is not recognized, then it is ignored and nothing happens and nothing is printed.
*/

#include "Wire.h"
#define X9241_I2C_ADDRESS 0x2D

// Global Variables
long command;

void setup() {
Wire.begin();
Serial.begin(57600);

}

void loop() {
if (Serial.available()) { // Look for char in serial que and process if found
command = Serial.read();
if (command == 83) { //If command = "S" Set Register Data
// This sets the four registers of each Digital Pot
Wire.beginTransmission(X9241_I2C_ADDRESS);
Wire.send(0xc0); // This is the set register command c and the 16 registers are 0-f
Wire.send(0x0a); // This line is the value to set the register: 0-63 is a valid setting
Wire.endTransmission();
delay(100);
Wire.beginTransmission(X9241_I2C_ADDRESS);
Wire.send(0xc1);
Wire.send(0x14);
Wire.endTransmission();
delay(100);
Wire.beginTransmission(X9241_I2C_ADDRESS);
Wire.send(0xc2);
Wire.send(0x20);
Wire.endTransmission();
delay(100);
Wire.beginTransmission(X9241_I2C_ADDRESS);
Wire.send(0xc3);
Wire.send(0x3c);
Wire.endTransmission();
delay(100);
Wire.beginTransmission(X9241_I2C_ADDRESS);
Wire.send(0xc4);
Wire.send(0x0a);
Wire.endTransmission();
delay(100);
Wire.beginTransmission(X9241_I2C_ADDRESS);
Wire.send(0xc5);
Wire.send(0x14);
Wire.endTransmission();
delay(100);
Wire.beginTransmission(X9241_I2C_ADDRESS);
Wire.send(0xc6);
Wire.send(0x20);
Wire.endTransmission();
delay(100);
Wire.beginTransmission(X9241_I2C_ADDRESS);
Wire.send(0xc7);
Wire.send(0x3c);
Wire.endTransmission();
delay(100);
Wire.beginTransmission(X9241_I2C_ADDRESS);
Wire.send(0xc8);
Wire.send(0x0a);
Wire.endTransmission();
delay(100);
Wire.beginTransmission(X9241_I2C_ADDRESS);
Wire.send(0xc9);
Wire.send(0x14);
Wire.endTransmission();
delay(100);
Wire.beginTransmission(X9241_I2C_ADDRESS);
Wire.send(0xca);
Wire.send(0x20);
Wire.endTransmission();
delay(100);
Wire.beginTransmission(X9241_I2C_ADDRESS);
Wire.send(0xcb);
Wire.send(0x3c);
Wire.endTransmission();
delay(100);
Wire.beginTransmission(X9241_I2C_ADDRESS);
Wire.send(0xcc);
Wire.send(0x0a);
Wire.endTransmission();
delay(100);
Wire.beginTransmission(X9241_I2C_ADDRESS);
Wire.send(0xcd);
Wire.send(0x14);
Wire.endTransmission();
delay(100);
Wire.beginTransmission(X9241_I2C_ADDRESS);
Wire.send(0xce);
Wire.send(0x20);
Wire.endTransmission();
delay(100);
Wire.beginTransmission(X9241_I2C_ADDRESS);
Wire.send(0xcf);
Wire.send(0x3c);
Serial.println("cmd: S");
}
else if (command == 71) { //If command = "G" Transfer Global Register Data
delay(100);
if (Serial.available()) {
command = Serial.read();
if (command == 48) { // If command = "0"
Wire.beginTransmission(X9241_I2C_ADDRESS);
Wire.send(0x10); // Global Load WCR's with Reg-00
Wire.endTransmission();
Serial.println("cmd: G0");
}
else if (command == 49) { // If command = "1"
Wire.beginTransmission(X9241_I2C_ADDRESS);
Wire.send(0x11); // Global Load WCR's with Reg-01
Wire.endTransmission();
Serial.println("cmd: G1");
}
else if (command == 50) { // If command = "2"
Wire.beginTransmission(X9241_I2C_ADDRESS);
Wire.send(0x12); // Global Load WCR's with Reg-10
Wire.endTransmission();
Serial.println("cmd: G2");
}
else if (command == 51) { // If command = "3"
Wire.beginTransmission(X9241_I2C_ADDRESS);
Wire.send(0x13); // Global Load WCR's with Reg-11
Wire.endTransmission();
Serial.println("cmd: G3");
}
}
}

else if (command == 48) { //If command = "0" Transfer Register-00 Data to WCR 0-3
delay(100);
if (Serial.available()) {
command = Serial.read();
if (command == 48) { // If command = "0"
Wire.beginTransmission(X9241_I2C_ADDRESS);
Wire.send(0xd0); // Load WCR-00 with Reg-00
Wire.endTransmission();
Serial.println("cmd: 00");
}
else if (command == 49) { // If command = "1"
Wire.beginTransmission(X9241_I2C_ADDRESS);
Wire.send(0xd1); // Load WCR-00 with Reg-01
Wire.endTransmission();
Serial.println("cmd: 01");
}
else if (command == 50) { // If command = "2"
Wire.beginTransmission(X9241_I2C_ADDRESS);
Wire.send(0xd2); // Load WCR-00 with Reg-10
Wire.endTransmission();
Serial.println("cmd: 02");
}
else if (command == 51) { // If command = "3"
Wire.beginTransmission(X9241_I2C_ADDRESS);
Wire.send(0xd3); // Load WCR-00 with Reg-11
Wire.endTransmission();
Serial.println("cmd: 03");
}
}
}
else if (command == 49) { //If command = "1" Transfer Register-01 Data to WCR 0-3
delay(100);
if (Serial.available()) {
command = Serial.read();
if (command == 48) { // If command = "0"
Wire.beginTransmission(X9241_I2C_ADDRESS);
Wire.send(0xd4); // Load WCR-01 with Reg-00
Wire.endTransmission();
Serial.println("cmd: 10");
}
else if (command == 49) { // If command = "1"
Wire.beginTransmission(X9241_I2C_ADDRESS);
Wire.send(0xd5); // Load WCR-01 with Reg-01
Wire.endTransmission();
Serial.println("cmd: 11");
}
else if (command == 50) { // If command = "2"
Wire.beginTransmission(X9241_I2C_ADDRESS);
Wire.send(0xd6); // Load WCR-01 with Reg-10
Wire.endTransmission();
Serial.println("cmd: 12");
}
else if (command == 51) { // If command = "3"
Wire.beginTransmission(X9241_I2C_ADDRESS);
Wire.send(0xd7); // Load WCR-01 with Reg-11
Wire.endTransmission();
Serial.println("cmd: 13");
}
}
}
else if (command == 50) { //If command = "2" Transfer Register-10 Data to WCR 0-3
if (Serial.available()) {
command = Serial.read();
if (command == 48) { // If command = "0"
Wire.beginTransmission(X9241_I2C_ADDRESS);
Wire.send(0xd8); // Load WCR-10 with Reg-00
Wire.endTransmission();
Serial.println("cmd: 20");
}
else if (command == 49) { // If command = "1"
Wire.beginTransmission(X9241_I2C_ADDRESS);
Wire.send(0xd9); // Load WCR-10 with Reg-01
Wire.endTransmission();
Serial.println("cmd: 21");
}
else if (command == 50) { // If command = "2"
Wire.beginTransmission(X9241_I2C_ADDRESS);
Wire.send(0xda); // Load WCR-10 with Reg-10
Wire.endTransmission();
Serial.println("cmd: 22");
}
else if (command == 51) { // If command = "3"
Wire.beginTransmission(X9241_I2C_ADDRESS);
Wire.send(0xdb); // Load WCR-10 with Reg-11
Wire.endTransmission();
Serial.println("cmd: 23");
}
}
}
else if (command == 51) { //If command = "3" Transfer Register-11 Data to WCR 0-3
delay(100);
if (Serial.available()) {
command = Serial.read();
if (command == 48) { // If command = "0"
Wire.beginTransmission(X9241_I2C_ADDRESS);
Wire.send(0xdc); // Load WCR-11 with Reg-00
Wire.endTransmission();
Serial.println("cmd: 30");
}
else if (command == 49) { // If command = "1"
Wire.beginTransmission(X9241_I2C_ADDRESS);
Wire.send(0xdd); // Load WCR-11 with Reg-01
Wire.endTransmission();
Serial.println("cmd: 31");
}
else if (command == 50) { // If command = "2"
Wire.beginTransmission(X9241_I2C_ADDRESS);
Wire.send(0xde); // Load WCR-11 with Reg-10
Wire.endTransmission();
Serial.println("cmd: 32");
}
else if (command == 51) { // If command = "3"
Wire.beginTransmission(X9241_I2C_ADDRESS);
Wire.send(0xdf); // Load WCR-11 with Reg-11
Wire.endTransmission();
Serial.println("cmd: 33");
}
}
}
else if (command == 87) { //If command = "W" write directly to WCR 0-3
delay(100);
if (Serial.available()) {
command = Serial.read();
if (command == 48) { // If command = "0"
Wire.beginTransmission(X9241_I2C_ADDRESS);
Wire.send(0xa0); //Instruction to write WCR-00
Wire.send(0x10); //Send a D value of 16
Wire.endTransmission();
Serial.println("cmd: W0");
}
else if (command == 49) { // If command = "1"
Wire.beginTransmission(X9241_I2C_ADDRESS);
Wire.send(0xa4); //Instruction to write WCR-01
Wire.send(0x20); //Send a D value of 32
Wire.endTransmission();
Serial.println("cmd: W1");
}
else if (command == 50) { // If command = "2"
Wire.beginTransmission(X9241_I2C_ADDRESS);
Wire.send(0xa8); //Instruction to write WCR-10
Wire.send(0x2a); //Send a D value of 26
Wire.endTransmission();
Serial.println("cmd: W2");
}
else if (command == 51) { // If command = "3"
Wire.beginTransmission(X9241_I2C_ADDRESS);
Wire.send(0xac); //Instruction to write WCR-11
Wire.send(0x30); //Send a D value of 48
Wire.endTransmission();
Serial.println("cmd: W3");
}
}
}
}
}
//*****************************************************The End***********************

</pre>

== x9241A_Digital_Potentiometer_v.01 User Guide ==
==== Commands ====
== Troubleshooting ==
=== Summary ===
=== Quick Test ===

X9241A - Digital Potentiometer

2008-09-13T02:08:12Z

Combustor:

{{default}}

== Summary ==

== Example of Method ==
=== I2C ===

There are basically only two functions that I am after right now which are both three byte instructions:

* Read WCR(Wiper Control Register) for the four potentiometers 0-3 (So far this is failing miserably)
** Send 1st byte - Address (my circuit - 01011010 or 0x2D)(binary - 0101 A3 A2 A1 A0) A values are actual pins set to high or low for an address.
** Send 2nd byte - Instruction (binary - 1001 (1/0)(1/0) 00) - The two bits are used to choose the potentiometer
** Read WCR requested Byte
* Write WCR for the four potentiometers 0-3 (This works)
** Send 1st byte - Address (my circuit - 01011010 or 0x2D)(binary - 0101 A3 A2 A1 A0) A values are actual pins set to high or low for an address.
** Send 2nd byte - Instruction (binary - 1010 (1/0)(1/0) 00) - The two bits are used to choose the potentiometer
** Send WCR Byte - Potentiometer value (binary - 00 D5 D4 D3 D2 D1 D0) - D values are the 0-63 potentiometer positions

'''Sample Code'''
<pre>
Wire.beginTransmission(X9241_I2C_ADDRESS);
Wire.send(0xa0); //Instruction to write WCR-00
Wire.send(0x20); //Send a D value of 32
Wire.endTransmission();
</pre>

==== x9241A_Digital_Potentiometer_v.01 code ====

<pre>
/*
* x9241A Digital Potentiometer v.01
* by <http://www.combustory.com> John Vaughters
*
* This Program illustrates the use of I2C to set up the x9241A Digital Potentiometer by setting and transferring the registers.
* I attempted to read the register data through I2C, but was unable to get it to work.
* Since the reading part was not so important to me I stopped trying.
* To set the registers up and transfer them to the Wiper registers met my goals and that is where I stopped.
*
* The x9142A has four Digital Pots and each pot has four static registers and one dynamic register the Wiper Control Register (WCR).
* Therefore, there are 16 total bytes of storage and four WCR's.
* This Program has the following commands:
* S - Set the 16 registers. Each pot has four registers and this command will set each register group with the same value. So register 00 for each pot will
* be the same value for each pot, and the same for register 01 through 11.
* G(0-3) - Global Transfer of Registers to the WCR's. This command will bulk load the values stored in registers into the WCR's.
* For example, a G0 will load the 00 register for each pot into the WCR in one command. A G1 loads the 01 register for each pot, etc.
* (0-3)(0-3) - This set of commands transfers a single register into a single WCR. The digits are arranged like this (WCR)(Reg).
* For example, a 00 command will load register 00 into WCR 00 or a 13 command will load register 11 into WCR 01, etc.
* W(0-3) - This command writes directly to the WCR. I have created four values that are just random, but the command shows how to write directly to the WCR for each pot.
* For example, a W0 command will write a value of decimal 16. These commands are just for example purposes.
*
* Command Note: If you enter a command that is not recognized, then it is ignored and nothing happens and nothing is printed.
*/

#include "Wire.h"
#define X9241_I2C_ADDRESS 0x2D

// Global Variables
long command;

void setup() {
Wire.begin();
Serial.begin(57600);

}

void loop() {
if (Serial.available()) { // Look for char in serial que and process if found
command = Serial.read();
if (command == 83) { //If command = "S" Set Register Data
// This sets the four registers of each Digital Pot
Wire.beginTransmission(X9241_I2C_ADDRESS);
Wire.send(0xc0); // This is the set register command c and the 16 registers are 0-f
Wire.send(0x0a); // This line is the value to set the register: 0-63 is a valid setting
Wire.endTransmission();
delay(100);
Wire.beginTransmission(X9241_I2C_ADDRESS);
Wire.send(0xc1);
Wire.send(0x14);
Wire.endTransmission();
delay(100);
Wire.beginTransmission(X9241_I2C_ADDRESS);
Wire.send(0xc2);
Wire.send(0x20);
Wire.endTransmission();
delay(100);
Wire.beginTransmission(X9241_I2C_ADDRESS);
Wire.send(0xc3);
Wire.send(0x3c);
Wire.endTransmission();
delay(100);
Wire.beginTransmission(X9241_I2C_ADDRESS);
Wire.send(0xc4);
Wire.send(0x0a);
Wire.endTransmission();
delay(100);
Wire.beginTransmission(X9241_I2C_ADDRESS);
Wire.send(0xc5);
Wire.send(0x14);
Wire.endTransmission();
delay(100);
Wire.beginTransmission(X9241_I2C_ADDRESS);
Wire.send(0xc6);
Wire.send(0x20);
Wire.endTransmission();
delay(100);
Wire.beginTransmission(X9241_I2C_ADDRESS);
Wire.send(0xc7);
Wire.send(0x3c);
delay(100);
Wire.beginTransmission(X9241_I2C_ADDRESS);
Wire.send(0xc8);
Wire.send(0x0a);
Wire.endTransmission();
delay(100);
Wire.beginTransmission(X9241_I2C_ADDRESS);
Wire.send(0xc9);
Wire.send(0x14);
Wire.endTransmission();
delay(100);
Wire.beginTransmission(X9241_I2C_ADDRESS);
Wire.send(0xca);
Wire.send(0x20);
Wire.endTransmission();
delay(100);
Wire.beginTransmission(X9241_I2C_ADDRESS);
Wire.send(0xcb);
Wire.send(0x3c);
Wire.endTransmission();
delay(100);
Wire.beginTransmission(X9241_I2C_ADDRESS);
Wire.send(0xcc);
Wire.send(0x0a);
Wire.endTransmission();
delay(100);
Wire.beginTransmission(X9241_I2C_ADDRESS);
Wire.send(0xcd);
Wire.send(0x14);
Wire.endTransmission();
delay(100);
Wire.beginTransmission(X9241_I2C_ADDRESS);
Wire.send(0xce);
Wire.send(0x20);
Wire.endTransmission();
delay(100);
Wire.beginTransmission(X9241_I2C_ADDRESS);
Wire.send(0xcf);
Wire.send(0x3c);
Serial.println("cmd: S");
}
else if (command == 71) { //If command = "G" Transfer Global Register Data
delay(100);
if (Serial.available()) {
command = Serial.read();
if (command == 48) { // If command = "0"
Wire.beginTransmission(X9241_I2C_ADDRESS);
Wire.send(0x10); // Global Load WCR's with Reg-00
Wire.endTransmission();
Serial.println("cmd: G0");
}
else if (command == 49) { // If command = "1"
Wire.beginTransmission(X9241_I2C_ADDRESS);
Wire.send(0x11); // Global Load WCR's with Reg-01
Wire.endTransmission();
Serial.println("cmd: G1");
}
else if (command == 50) { // If command = "2"
Wire.beginTransmission(X9241_I2C_ADDRESS);
Wire.send(0x12); // Global Load WCR's with Reg-10
Wire.endTransmission();
Serial.println("cmd: G2");
}
else if (command == 51) { // If command = "3"
Wire.beginTransmission(X9241_I2C_ADDRESS);
Wire.send(0x13); // Global Load WCR's with Reg-11
Wire.endTransmission();
Serial.println("cmd: G3");
}
}
}

else if (command == 48) { //If command = "0" Transfer Register-00 Data to WCR 0-3
delay(100);
if (Serial.available()) {
command = Serial.read();
if (command == 48) { // If command = "0"
Wire.beginTransmission(X9241_I2C_ADDRESS);
Wire.send(0xd0); // Load WCR-00 with Reg-00
Wire.endTransmission();
Serial.println("cmd: 00");
}
else if (command == 49) { // If command = "1"
Wire.beginTransmission(X9241_I2C_ADDRESS);
Wire.send(0xd1); // Load WCR-00 with Reg-01
Wire.endTransmission();
Serial.println("cmd: 01");
}
else if (command == 50) { // If command = "2"
Wire.beginTransmission(X9241_I2C_ADDRESS);
Wire.send(0xd2); // Load WCR-00 with Reg-10
Wire.endTransmission();
Serial.println("cmd: 02");
}
else if (command == 51) { // If command = "3"
Wire.beginTransmission(X9241_I2C_ADDRESS);
Wire.send(0xd3); // Load WCR-00 with Reg-11
Wire.endTransmission();
Serial.println("cmd: 03");
}
}
}
else if (command == 49) { //If command = "1" Transfer Register-01 Data to WCR 0-3
delay(100);
if (Serial.available()) {
command = Serial.read();
if (command == 48) { // If command = "0"
Wire.beginTransmission(X9241_I2C_ADDRESS);
Wire.send(0xd4); // Load WCR-01 with Reg-00
Wire.endTransmission();
Serial.println("cmd: 10");
}
else if (command == 49) { // If command = "1"
Wire.beginTransmission(X9241_I2C_ADDRESS);
Wire.send(0xd5); // Load WCR-01 with Reg-01
Wire.endTransmission();
Serial.println("cmd: 11");
}
else if (command == 50) { // If command = "2"
Wire.beginTransmission(X9241_I2C_ADDRESS);
Wire.send(0xd6); // Load WCR-01 with Reg-10
Wire.endTransmission();
Serial.println("cmd: 12");
}
else if (command == 51) { // If command = "3"
Wire.beginTransmission(X9241_I2C_ADDRESS);
Wire.send(0xd7); // Load WCR-01 with Reg-11
Wire.endTransmission();
Serial.println("cmd: 13");
}
}
}
else if (command == 50) { //If command = "2" Transfer Register-10 Data to WCR 0-3
if (Serial.available()) {
command = Serial.read();
if (command == 48) { // If command = "0"
Wire.beginTransmission(X9241_I2C_ADDRESS);
Wire.send(0xd8); // Load WCR-10 with Reg-00
Wire.endTransmission();
Serial.println("cmd: 20");
}
else if (command == 49) { // If command = "1"
Wire.beginTransmission(X9241_I2C_ADDRESS);
Wire.send(0xd9); // Load WCR-10 with Reg-01
Wire.endTransmission();
Serial.println("cmd: 21");
}
else if (command == 50) { // If command = "2"
Wire.beginTransmission(X9241_I2C_ADDRESS);
Wire.send(0xda); // Load WCR-10 with Reg-10
Wire.endTransmission();
Serial.println("cmd: 22");
}
else if (command == 51) { // If command = "3"
Wire.beginTransmission(X9241_I2C_ADDRESS);
Wire.send(0xdb); // Load WCR-10 with Reg-11
Wire.endTransmission();
Serial.println("cmd: 23");
}
}
}
else if (command == 51) { //If command = "3" Transfer Register-11 Data to WCR 0-3
delay(100);
if (Serial.available()) {
command = Serial.read();
if (command == 48) { // If command = "0"
Wire.beginTransmission(X9241_I2C_ADDRESS);
Wire.send(0xdc); // Load WCR-11 with Reg-00
Wire.endTransmission();
Serial.println("cmd: 30");
}
else if (command == 49) { // If command = "1"
Wire.beginTransmission(X9241_I2C_ADDRESS);
Wire.send(0xdd); // Load WCR-11 with Reg-01
Wire.endTransmission();
Serial.println("cmd: 31");
}
else if (command == 50) { // If command = "2"
Wire.beginTransmission(X9241_I2C_ADDRESS);
Wire.send(0xde); // Load WCR-11 with Reg-10
Wire.endTransmission();
Serial.println("cmd: 32");
}
else if (command == 51) { // If command = "3"
Wire.beginTransmission(X9241_I2C_ADDRESS);
Wire.send(0xdf); // Load WCR-11 with Reg-11
Wire.endTransmission();
Serial.println("cmd: 33");
}
}
}
else if (command == 87) { //If command = "W" write directly to WCR 0-3
delay(100);
if (Serial.available()) {
command = Serial.read();
if (command == 48) { // If command = "0"
Wire.beginTransmission(X9241_I2C_ADDRESS);
Wire.send(0xa0); //Instruction to write WCR-00
Wire.send(0x10); //Send a D value of 16
Wire.endTransmission();
Serial.println("cmd: W0");
}
else if (command == 49) { // If command = "1"
Wire.beginTransmission(X9241_I2C_ADDRESS);
Wire.send(0xa4); //Instruction to write WCR-01
Wire.send(0x20); //Send a D value of 32
Wire.endTransmission();
Serial.println("cmd: W1");
}
else if (command == 50) { // If command = "2"
Wire.beginTransmission(X9241_I2C_ADDRESS);
Wire.send(0xa8); //Instruction to write WCR-10
Wire.send(0x2a); //Send a D value of 26
Wire.endTransmission();
Serial.println("cmd: W2");
}
else if (command == 51) { // If command = "3"
Wire.beginTransmission(X9241_I2C_ADDRESS);
Wire.send(0xac); //Instruction to write WCR-11
Wire.send(0x30); //Send a D value of 48
Wire.endTransmission();
Serial.println("cmd: W3");
}
}
}
}
}
//*****************************************************The End***********************

</pre>

== x9241A_Digital_Potentiometer_v.01 User Guide ==
==== Commands ====
== Troubleshooting ==
=== Summary ===
=== Quick Test ===

X9241A - Digital Potentiometer

2008-09-13T02:05:23Z

Combustor:

{{default}}
== Warning ==
'''This page is in progress and none of the code can be considered good or complete. I am just using this as an alternate storage of the code for right now.'''

== Summary ==

== Example of Method ==
=== I2C ===

There are basically only two functions that I am after right now which are both three byte instructions:

* Read WCR(Wiper Control Register) for the four potentiometers 0-3 (So far this is failing miserably)
** Send 1st byte - Address (my circuit - 01011010 or 0x2D)(binary - 0101 A3 A2 A1 A0) A values are actual pins set to high or low for an address.
** Send 2nd byte - Instruction (binary - 1001 (1/0)(1/0) 00) - The two bits are used to choose the potentiometer
** Read WCR requested Byte
* Write WCR for the four potentiometers 0-3 (This works)
** Send 1st byte - Address (my circuit - 01011010 or 0x2D)(binary - 0101 A3 A2 A1 A0) A values are actual pins set to high or low for an address.
** Send 2nd byte - Instruction (binary - 1010 (1/0)(1/0) 00) - The two bits are used to choose the potentiometer
** Send WCR Byte - Potentiometer value (binary - 00 D5 D4 D3 D2 D1 D0) - D values are the 0-63 potentiometer positions

'''Sample Code'''
<pre>
Wire.beginTransmission(X9241_I2C_ADDRESS);
Wire.send(0xa0); //Instruction to write WCR-00
Wire.send(0x20); //Send a D value of 32
Wire.endTransmission();
</pre>

==== x9241A_Digital_Potentiometer_v.01 code ====

<pre>
/*
* x9241A Digital Potentiometer v.01
* by <http://www.combustory.com> John Vaughters
*
* This Program illustrates the use of I2C to set up the x9241A Digital Potentiometer by setting and transferring the registers.
* I attempted to read the register data through I2C, but was unable to get it to work.
* Since the reading part was not so important to me I stopped trying.
* To set the registers up and transfer them to the Wiper registers met my goals and that is where I stopped.
*
* The x9142A has four Digital Pots and each pot has four static registers and one dynamic register the Wiper Control Register (WCR).
* Therefore, there are 16 total bytes of storage and four WCR's.
* This Program has the following commands:
* S - Set the 16 registers. Each pot has four registers and this command will set each register group with the same value. So register 00 for each pot will
* be the same value for each pot, and the same for register 01 through 11.
* G(0-3) - Global Transfer of Registers to the WCR's. This command will bulk load the values stored in registers into the WCR's.
* For example, a G0 will load the 00 register for each pot into the WCR in one command. A G1 loads the 01 register for each pot, etc.
* (0-3)(0-3) - This set of commands transfers a single register into a single WCR. The digits are arranged like this (WCR)(Reg).
* For example, a 00 command will load register 00 into WCR 00 or a 13 command will load register 11 into WCR 01, etc.
* W(0-3) - This command writes directly to the WCR. I have created four values that are just random, but the command shows how to write directly to the WCR for each pot.
* For example, a W0 command will write a value of decimal 16. These commands are just for example purposes.
*
* Command Note: If you enter a command that is not recognized, then it is ignored and nothing happens and nothing is printed.
*/

#include "Wire.h"
#define X9241_I2C_ADDRESS 0x2D

// Global Variables
long command;

void setup() {
Wire.begin();
Serial.begin(57600);

}

void loop() {
if (Serial.available()) { // Look for char in serial que and process if found
command = Serial.read();
if (command == 83) { //If command = "S" Set Register Data
// This sets the four registers of each Digital Pot
Wire.beginTransmission(X9241_I2C_ADDRESS);
Wire.send(0xc0); // This is the set register command c and the 16 registers are 0-f
Wire.send(0x0a); // This line is the value to set the register: 0-63 is a valid setting
Wire.endTransmission();
delay(100);
Wire.beginTransmission(X9241_I2C_ADDRESS);
Wire.send(0xc1);
Wire.send(0x14);
Wire.endTransmission();
delay(100);
Wire.beginTransmission(X9241_I2C_ADDRESS);
Wire.send(0xc2);
Wire.send(0x20);
Wire.endTransmission();
delay(100);
Wire.beginTransmission(X9241_I2C_ADDRESS);
Wire.send(0xc3);
Wire.send(0x3c);
Wire.endTransmission();
delay(100);
Wire.beginTransmission(X9241_I2C_ADDRESS);
Wire.send(0xc4);
Wire.send(0x0a);
Wire.endTransmission();
delay(100);
Wire.beginTransmission(X9241_I2C_ADDRESS);
Wire.send(0xc5);
Wire.send(0x14);
Wire.endTransmission();
delay(100);
Wire.beginTransmission(X9241_I2C_ADDRESS);
Wire.send(0xc6);
Wire.send(0x20);
Wire.endTransmission();
delay(100);
Wire.beginTransmission(X9241_I2C_ADDRESS);
Wire.send(0xc7);
Wire.send(0x3c);
delay(100);
Wire.beginTransmission(X9241_I2C_ADDRESS);
Wire.send(0xc8);
Wire.send(0x0a);
Wire.endTransmission();
delay(100);
Wire.beginTransmission(X9241_I2C_ADDRESS);
Wire.send(0xc9);
Wire.send(0x14);
Wire.endTransmission();
delay(100);
Wire.beginTransmission(X9241_I2C_ADDRESS);
Wire.send(0xca);
Wire.send(0x20);
Wire.endTransmission();
delay(100);
Wire.beginTransmission(X9241_I2C_ADDRESS);
Wire.send(0xcb);
Wire.send(0x3c);
Wire.endTransmission();
delay(100);
Wire.beginTransmission(X9241_I2C_ADDRESS);
Wire.send(0xcc);
Wire.send(0x0a);
Wire.endTransmission();
delay(100);
Wire.beginTransmission(X9241_I2C_ADDRESS);
Wire.send(0xcd);
Wire.send(0x14);
Wire.endTransmission();
delay(100);
Wire.beginTransmission(X9241_I2C_ADDRESS);
Wire.send(0xce);
Wire.send(0x20);
Wire.endTransmission();
delay(100);
Wire.beginTransmission(X9241_I2C_ADDRESS);
Wire.send(0xcf);
Wire.send(0x3c);
Serial.println("cmd: S");
}
else if (command == 71) { //If command = "G" Transfer Global Register Data
delay(100);
if (Serial.available()) {
command = Serial.read();
if (command == 48) { // If command = "0"
Wire.beginTransmission(X9241_I2C_ADDRESS);
Wire.send(0x10); // Global Load WCR's with Reg-00
Wire.endTransmission();
Serial.println("cmd: G0");
}
else if (command == 49) { // If command = "1"
Wire.beginTransmission(X9241_I2C_ADDRESS);
Wire.send(0x11); // Global Load WCR's with Reg-01
Wire.endTransmission();
Serial.println("cmd: G1");
}
else if (command == 50) { // If command = "2"
Wire.beginTransmission(X9241_I2C_ADDRESS);
Wire.send(0x12); // Global Load WCR's with Reg-10
Wire.endTransmission();
Serial.println("cmd: G2");
}
else if (command == 51) { // If command = "3"
Wire.beginTransmission(X9241_I2C_ADDRESS);
Wire.send(0x13); // Global Load WCR's with Reg-11
Wire.endTransmission();
Serial.println("cmd: G3");
}
}
}

else if (command == 48) { //If command = "0" Transfer Register-00 Data to WCR 0-3
delay(100);
if (Serial.available()) {
command = Serial.read();
if (command == 48) { // If command = "0"
Wire.beginTransmission(X9241_I2C_ADDRESS);
Wire.send(0xd0); // Load WCR-00 with Reg-00
Wire.endTransmission();
Serial.println("cmd: 00");
}
else if (command == 49) { // If command = "1"
Wire.beginTransmission(X9241_I2C_ADDRESS);
Wire.send(0xd1); // Load WCR-00 with Reg-01
Wire.endTransmission();
Serial.println("cmd: 01");
}
else if (command == 50) { // If command = "2"
Wire.beginTransmission(X9241_I2C_ADDRESS);
Wire.send(0xd2); // Load WCR-00 with Reg-10
Wire.endTransmission();
Serial.println("cmd: 02");
}
else if (command == 51) { // If command = "3"
Wire.beginTransmission(X9241_I2C_ADDRESS);
Wire.send(0xd3); // Load WCR-00 with Reg-11
Wire.endTransmission();
Serial.println("cmd: 03");
}
}
}
else if (command == 49) { //If command = "1" Transfer Register-01 Data to WCR 0-3
delay(100);
if (Serial.available()) {
command = Serial.read();
if (command == 48) { // If command = "0"
Wire.beginTransmission(X9241_I2C_ADDRESS);
Wire.send(0xd4); // Load WCR-01 with Reg-00
Wire.endTransmission();
Serial.println("cmd: 10");
}
else if (command == 49) { // If command = "1"
Wire.beginTransmission(X9241_I2C_ADDRESS);
Wire.send(0xd5); // Load WCR-01 with Reg-01
Wire.endTransmission();
Serial.println("cmd: 11");
}
else if (command == 50) { // If command = "2"
Wire.beginTransmission(X9241_I2C_ADDRESS);
Wire.send(0xd6); // Load WCR-01 with Reg-10
Wire.endTransmission();
Serial.println("cmd: 12");
}
else if (command == 51) { // If command = "3"
Wire.beginTransmission(X9241_I2C_ADDRESS);
Wire.send(0xd7); // Load WCR-01 with Reg-11
Wire.endTransmission();
Serial.println("cmd: 13");
}
}
}
else if (command == 50) { //If command = "2" Transfer Register-10 Data to WCR 0-3
if (Serial.available()) {
command = Serial.read();
if (command == 48) { // If command = "0"
Wire.beginTransmission(X9241_I2C_ADDRESS);
Wire.send(0xd8); // Load WCR-10 with Reg-00
Wire.endTransmission();
Serial.println("cmd: 20");
}
else if (command == 49) { // If command = "1"
Wire.beginTransmission(X9241_I2C_ADDRESS);
Wire.send(0xd9); // Load WCR-10 with Reg-01
Wire.endTransmission();
Serial.println("cmd: 21");
}
else if (command == 50) { // If command = "2"
Wire.beginTransmission(X9241_I2C_ADDRESS);
Wire.send(0xda); // Load WCR-10 with Reg-10
Wire.endTransmission();
Serial.println("cmd: 22");
}
else if (command == 51) { // If command = "3"
Wire.beginTransmission(X9241_I2C_ADDRESS);
Wire.send(0xdb); // Load WCR-10 with Reg-11
Wire.endTransmission();
Serial.println("cmd: 23");
}
}
}
else if (command == 51) { //If command = "3" Transfer Register-11 Data to WCR 0-3
delay(100);
if (Serial.available()) {
command = Serial.read();
if (command == 48) { // If command = "0"
Wire.beginTransmission(X9241_I2C_ADDRESS);
Wire.send(0xdc); // Load WCR-11 with Reg-00
Wire.endTransmission();
Serial.println("cmd: 30");
}
else if (command == 49) { // If command = "1"
Wire.beginTransmission(X9241_I2C_ADDRESS);
Wire.send(0xdd); // Load WCR-11 with Reg-01
Wire.endTransmission();
Serial.println("cmd: 31");
}
else if (command == 50) { // If command = "2"
Wire.beginTransmission(X9241_I2C_ADDRESS);
Wire.send(0xde); // Load WCR-11 with Reg-10
Wire.endTransmission();
Serial.println("cmd: 32");
}
else if (command == 51) { // If command = "3"
Wire.beginTransmission(X9241_I2C_ADDRESS);
Wire.send(0xdf); // Load WCR-11 with Reg-11
Wire.endTransmission();
Serial.println("cmd: 33");
}
}
}
else if (command == 87) { //If command = "W" write directly to WCR 0-3
delay(100);
if (Serial.available()) {
command = Serial.read();
if (command == 48) { // If command = "0"
Wire.beginTransmission(X9241_I2C_ADDRESS);
Wire.send(0xa0); //Instruction to write WCR-00
Wire.send(0x10); //Send a D value of 16
Wire.endTransmission();
Serial.println("cmd: W0");
}
else if (command == 49) { // If command = "1"
Wire.beginTransmission(X9241_I2C_ADDRESS);
Wire.send(0xa4); //Instruction to write WCR-01
Wire.send(0x20); //Send a D value of 32
Wire.endTransmission();
Serial.println("cmd: W1");
}
else if (command == 50) { // If command = "2"
Wire.beginTransmission(X9241_I2C_ADDRESS);
Wire.send(0xa8); //Instruction to write WCR-10
Wire.send(0x2a); //Send a D value of 26
Wire.endTransmission();
Serial.println("cmd: W2");
}
else if (command == 51) { // If command = "3"
Wire.beginTransmission(X9241_I2C_ADDRESS);
Wire.send(0xac); //Instruction to write WCR-11
Wire.send(0x30); //Send a D value of 48
Wire.endTransmission();
Serial.println("cmd: W3");
}
}
}
}
}
//*****************************************************The End***********************

</pre>

== A/C_Control_v.01 User Guide ==
==== Commands ====
== Troubleshooting ==
=== Summary ===
When Troubleshooting a multi-functional issue, it is best practice to break down the issue into pieces and test each piece as a separate system. However, we will first run through a quick test to see if we can find any obvious issues first.
=== Quick Test ===

X9241A - Digital Potentiometer

2008-09-13T02:04:50Z

Combustor: New page: {{default}} == Warning == '''This page is in progress and none of the code can be considered good or complete. I am just using this as an alternate storage of the code for right now.''' =...

{{default}}
== Warning ==
'''This page is in progress and none of the code can be considered good or complete. I am just using this as an alternate storage of the code for right now.'''

== Summary ==

== Example of Method ==
=== I2C ===

There are basically only two functions that I am after right now which are both three byte instructions:

* Read WCR(Wiper Control Register) for the four potentiometers 0-3 (So far this is failing miserably)
** Send 1st byte - Address (my circuit - 01011010 or 0x2D)(binary - 0101 A3 A2 A1 A0) A values are actual pins set to high or low for an address.
** Send 2nd byte - Instruction (binary - 1001 (1/0)(1/0) 00) - The two bits are used to choose the potentiometer
** Read WCR requested Byte
* Write WCR for the four potentiometers 0-3 (This works)
** Send 1st byte - Address (my circuit - 01011010 or 0x2D)(binary - 0101 A3 A2 A1 A0) A values are actual pins set to high or low for an address.
** Send 2nd byte - Instruction (binary - 1010 (1/0)(1/0) 00) - The two bits are used to choose the potentiometer
** Send WCR Byte - Potentiometer value (binary - 00 D5 D4 D3 D2 D1 D0) - D values are the 0-63 potentiometer positions

'''Sample Code'''
<pre>
Wire.beginTransmission(X9241_I2C_ADDRESS);
Wire.send(0xa0); //Instruction to write WCR-00
Wire.send(0x20); //Send a D value of 32
Wire.endTransmission();
</pre>
==== DS1307 - Real Time Clock ====

The code for this very useful chip came from the [[http://www.glacialwanderer.com/hobbyrobotics/?p=12 Glacial Wanderer]]

==== x9241A_Digital_Potentiometer_v.01 code ====

<pre>
/*
* x9241A Digital Potentiometer v.01
* by <http://www.combustory.com> John Vaughters
*
* This Program illustrates the use of I2C to set up the x9241A Digital Potentiometer by setting and transferring the registers.
* I attempted to read the register data through I2C, but was unable to get it to work.
* Since the reading part was not so important to me I stopped trying.
* To set the registers up and transfer them to the Wiper registers met my goals and that is where I stopped.
*
* The x9142A has four Digital Pots and each pot has four static registers and one dynamic register the Wiper Control Register (WCR).
* Therefore, there are 16 total bytes of storage and four WCR's.
* This Program has the following commands:
* S - Set the 16 registers. Each pot has four registers and this command will set each register group with the same value. So register 00 for each pot will
* be the same value for each pot, and the same for register 01 through 11.
* G(0-3) - Global Transfer of Registers to the WCR's. This command will bulk load the values stored in registers into the WCR's.
* For example, a G0 will load the 00 register for each pot into the WCR in one command. A G1 loads the 01 register for each pot, etc.
* (0-3)(0-3) - This set of commands transfers a single register into a single WCR. The digits are arranged like this (WCR)(Reg).
* For example, a 00 command will load register 00 into WCR 00 or a 13 command will load register 11 into WCR 01, etc.
* W(0-3) - This command writes directly to the WCR. I have created four values that are just random, but the command shows how to write directly to the WCR for each pot.
* For example, a W0 command will write a value of decimal 16. These commands are just for example purposes.
*
* Command Note: If you enter a command that is not recognized, then it is ignored and nothing happens and nothing is printed.
*/

#include "Wire.h"
#define X9241_I2C_ADDRESS 0x2D

// Global Variables
long command;

void setup() {
Wire.begin();
Serial.begin(57600);

}

void loop() {
if (Serial.available()) { // Look for char in serial que and process if found
command = Serial.read();
if (command == 83) { //If command = "S" Set Register Data
// This sets the four registers of each Digital Pot
Wire.beginTransmission(X9241_I2C_ADDRESS);
Wire.send(0xc0); // This is the set register command c and the 16 registers are 0-f
Wire.send(0x0a); // This line is the value to set the register: 0-63 is a valid setting
Wire.endTransmission();
delay(100);
Wire.beginTransmission(X9241_I2C_ADDRESS);
Wire.send(0xc1);
Wire.send(0x14);
Wire.endTransmission();
delay(100);
Wire.beginTransmission(X9241_I2C_ADDRESS);
Wire.send(0xc2);
Wire.send(0x20);
Wire.endTransmission();
delay(100);
Wire.beginTransmission(X9241_I2C_ADDRESS);
Wire.send(0xc3);
Wire.send(0x3c);
Wire.endTransmission();
delay(100);
Wire.beginTransmission(X9241_I2C_ADDRESS);
Wire.send(0xc4);
Wire.send(0x0a);
Wire.endTransmission();
delay(100);
Wire.beginTransmission(X9241_I2C_ADDRESS);
Wire.send(0xc5);
Wire.send(0x14);
Wire.endTransmission();
delay(100);
Wire.beginTransmission(X9241_I2C_ADDRESS);
Wire.send(0xc6);
Wire.send(0x20);
Wire.endTransmission();
delay(100);
Wire.beginTransmission(X9241_I2C_ADDRESS);
Wire.send(0xc7);
Wire.send(0x3c);
delay(100);
Wire.beginTransmission(X9241_I2C_ADDRESS);
Wire.send(0xc8);
Wire.send(0x0a);
Wire.endTransmission();
delay(100);
Wire.beginTransmission(X9241_I2C_ADDRESS);
Wire.send(0xc9);
Wire.send(0x14);
Wire.endTransmission();
delay(100);
Wire.beginTransmission(X9241_I2C_ADDRESS);
Wire.send(0xca);
Wire.send(0x20);
Wire.endTransmission();
delay(100);
Wire.beginTransmission(X9241_I2C_ADDRESS);
Wire.send(0xcb);
Wire.send(0x3c);
Wire.endTransmission();
delay(100);
Wire.beginTransmission(X9241_I2C_ADDRESS);
Wire.send(0xcc);
Wire.send(0x0a);
Wire.endTransmission();
delay(100);
Wire.beginTransmission(X9241_I2C_ADDRESS);
Wire.send(0xcd);
Wire.send(0x14);
Wire.endTransmission();
delay(100);
Wire.beginTransmission(X9241_I2C_ADDRESS);
Wire.send(0xce);
Wire.send(0x20);
Wire.endTransmission();
delay(100);
Wire.beginTransmission(X9241_I2C_ADDRESS);
Wire.send(0xcf);
Wire.send(0x3c);
Serial.println("cmd: S");
}
else if (command == 71) { //If command = "G" Transfer Global Register Data
delay(100);
if (Serial.available()) {
command = Serial.read();
if (command == 48) { // If command = "0"
Wire.beginTransmission(X9241_I2C_ADDRESS);
Wire.send(0x10); // Global Load WCR's with Reg-00
Wire.endTransmission();
Serial.println("cmd: G0");
}
else if (command == 49) { // If command = "1"
Wire.beginTransmission(X9241_I2C_ADDRESS);
Wire.send(0x11); // Global Load WCR's with Reg-01
Wire.endTransmission();
Serial.println("cmd: G1");
}
else if (command == 50) { // If command = "2"
Wire.beginTransmission(X9241_I2C_ADDRESS);
Wire.send(0x12); // Global Load WCR's with Reg-10
Wire.endTransmission();
Serial.println("cmd: G2");
}
else if (command == 51) { // If command = "3"
Wire.beginTransmission(X9241_I2C_ADDRESS);
Wire.send(0x13); // Global Load WCR's with Reg-11
Wire.endTransmission();
Serial.println("cmd: G3");
}
}
}

else if (command == 48) { //If command = "0" Transfer Register-00 Data to WCR 0-3
delay(100);
if (Serial.available()) {
command = Serial.read();
if (command == 48) { // If command = "0"
Wire.beginTransmission(X9241_I2C_ADDRESS);
Wire.send(0xd0); // Load WCR-00 with Reg-00
Wire.endTransmission();
Serial.println("cmd: 00");
}
else if (command == 49) { // If command = "1"
Wire.beginTransmission(X9241_I2C_ADDRESS);
Wire.send(0xd1); // Load WCR-00 with Reg-01
Wire.endTransmission();
Serial.println("cmd: 01");
}
else if (command == 50) { // If command = "2"
Wire.beginTransmission(X9241_I2C_ADDRESS);
Wire.send(0xd2); // Load WCR-00 with Reg-10
Wire.endTransmission();
Serial.println("cmd: 02");
}
else if (command == 51) { // If command = "3"
Wire.beginTransmission(X9241_I2C_ADDRESS);
Wire.send(0xd3); // Load WCR-00 with Reg-11
Wire.endTransmission();
Serial.println("cmd: 03");
}
}
}
else if (command == 49) { //If command = "1" Transfer Register-01 Data to WCR 0-3
delay(100);
if (Serial.available()) {
command = Serial.read();
if (command == 48) { // If command = "0"
Wire.beginTransmission(X9241_I2C_ADDRESS);
Wire.send(0xd4); // Load WCR-01 with Reg-00
Wire.endTransmission();
Serial.println("cmd: 10");
}
else if (command == 49) { // If command = "1"
Wire.beginTransmission(X9241_I2C_ADDRESS);
Wire.send(0xd5); // Load WCR-01 with Reg-01
Wire.endTransmission();
Serial.println("cmd: 11");
}
else if (command == 50) { // If command = "2"
Wire.beginTransmission(X9241_I2C_ADDRESS);
Wire.send(0xd6); // Load WCR-01 with Reg-10
Wire.endTransmission();
Serial.println("cmd: 12");
}
else if (command == 51) { // If command = "3"
Wire.beginTransmission(X9241_I2C_ADDRESS);
Wire.send(0xd7); // Load WCR-01 with Reg-11
Wire.endTransmission();
Serial.println("cmd: 13");
}
}
}
else if (command == 50) { //If command = "2" Transfer Register-10 Data to WCR 0-3
if (Serial.available()) {
command = Serial.read();
if (command == 48) { // If command = "0"
Wire.beginTransmission(X9241_I2C_ADDRESS);
Wire.send(0xd8); // Load WCR-10 with Reg-00
Wire.endTransmission();
Serial.println("cmd: 20");
}
else if (command == 49) { // If command = "1"
Wire.beginTransmission(X9241_I2C_ADDRESS);
Wire.send(0xd9); // Load WCR-10 with Reg-01
Wire.endTransmission();
Serial.println("cmd: 21");
}
else if (command == 50) { // If command = "2"
Wire.beginTransmission(X9241_I2C_ADDRESS);
Wire.send(0xda); // Load WCR-10 with Reg-10
Wire.endTransmission();
Serial.println("cmd: 22");
}
else if (command == 51) { // If command = "3"
Wire.beginTransmission(X9241_I2C_ADDRESS);
Wire.send(0xdb); // Load WCR-10 with Reg-11
Wire.endTransmission();
Serial.println("cmd: 23");
}
}
}
else if (command == 51) { //If command = "3" Transfer Register-11 Data to WCR 0-3
delay(100);
if (Serial.available()) {
command = Serial.read();
if (command == 48) { // If command = "0"
Wire.beginTransmission(X9241_I2C_ADDRESS);
Wire.send(0xdc); // Load WCR-11 with Reg-00
Wire.endTransmission();
Serial.println("cmd: 30");
}
else if (command == 49) { // If command = "1"
Wire.beginTransmission(X9241_I2C_ADDRESS);
Wire.send(0xdd); // Load WCR-11 with Reg-01
Wire.endTransmission();
Serial.println("cmd: 31");
}
else if (command == 50) { // If command = "2"
Wire.beginTransmission(X9241_I2C_ADDRESS);
Wire.send(0xde); // Load WCR-11 with Reg-10
Wire.endTransmission();
Serial.println("cmd: 32");
}
else if (command == 51) { // If command = "3"
Wire.beginTransmission(X9241_I2C_ADDRESS);
Wire.send(0xdf); // Load WCR-11 with Reg-11
Wire.endTransmission();
Serial.println("cmd: 33");
}
}
}
else if (command == 87) { //If command = "W" write directly to WCR 0-3
delay(100);
if (Serial.available()) {
command = Serial.read();
if (command == 48) { // If command = "0"
Wire.beginTransmission(X9241_I2C_ADDRESS);
Wire.send(0xa0); //Instruction to write WCR-00
Wire.send(0x10); //Send a D value of 16
Wire.endTransmission();
Serial.println("cmd: W0");
}
else if (command == 49) { // If command = "1"
Wire.beginTransmission(X9241_I2C_ADDRESS);
Wire.send(0xa4); //Instruction to write WCR-01
Wire.send(0x20); //Send a D value of 32
Wire.endTransmission();
Serial.println("cmd: W1");
}
else if (command == 50) { // If command = "2"
Wire.beginTransmission(X9241_I2C_ADDRESS);
Wire.send(0xa8); //Instruction to write WCR-10
Wire.send(0x2a); //Send a D value of 26
Wire.endTransmission();
Serial.println("cmd: W2");
}
else if (command == 51) { // If command = "3"
Wire.beginTransmission(X9241_I2C_ADDRESS);
Wire.send(0xac); //Instruction to write WCR-11
Wire.send(0x30); //Send a D value of 48
Wire.endTransmission();
Serial.println("cmd: W3");
}
}
}
}
}
//*****************************************************The End***********************

</pre>

== A/C_Control_v.01 User Guide ==
==== Commands ====
== Troubleshooting ==
=== Summary ===
When Troubleshooting a multi-functional issue, it is best practice to break down the issue into pieces and test each piece as a separate system. However, we will first run through a quick test to see if we can find any obvious issues first.
=== Quick Test ===

Temperature Controller

2008-09-13T01:59:30Z

Combustor: /* Example of Method */

Temperature Controller

2008-09-12T18:13:13Z

Combustor:

{{default}}
== Warning ==
'''This page is in progress and none of the code can be considered good or complete. I am just using this as an alternate storage of the code for right now.'''

== Summary ==
== Functional Description of the Method ==
== Requirements ==
== Example of Method ==
=== Quick Guide: ===
=== Detailed Guide: ===
=== I2C ===
==== X9241A - Digital Potentiometer ====

There are basically only two functions that I am after right now which are both three byte instructions:

* Read WCR(Wiper Control Register) for the four potentiometers 0-3 (So far this is failing miserably)
** Send 1st byte - Address (my circuit - 01011010 or 0x2D)(binary - 0101 A3 A2 A1 A0) A values are actual pins set to high or low for an address.
** Send 2nd byte - Instruction (binary - 1001 (1/0)(1/0) 00) - The two bits are used to choose the potentiometer
** Read WCR requested Byte
* Write WCR for the four potentiometers 0-3 (This works)
** Send 1st byte - Address (my circuit - 01011010 or 0x2D)(binary - 0101 A3 A2 A1 A0) A values are actual pins set to high or low for an address.
** Send 2nd byte - Instruction (binary - 1010 (1/0)(1/0) 00) - The two bits are used to choose the potentiometer
** Send WCR Byte - Potentiometer value (binary - 00 D5 D4 D3 D2 D1 D0) - D values are the 0-63 potentiometer positions

'''Sample Code'''
<pre>
Wire.beginTransmission(X9241_I2C_ADDRESS);
Wire.send(0xa0); //Instruction to write WCR-00
Wire.send(0x20); //Send a D value of 32
Wire.endTransmission();
</pre>
==== DS1307 - Real Time Clock ====

The code for this very useful chip came from the [[http://www.glacialwanderer.com/hobbyrobotics/?p=12 Glacial Wanderer]]

==== A/C_Control_v.01 code ====

''' While this says v.01, don't count on it being a released v.01, I am still working on v.01, this is a back up '''

<pre>
/*
* A/C Control v.01
* by <http://www.combustory.com> John Vaughters
* Credit to:
* Maurice Ribble - http://www.glacialwanderer.com/hobbyrobotics for RTC DS1307 code
*
* Turns on an LED for temperatures from analog pins 1-5 on
* digital pins 2-6 when the temperature rises above the THRESHOLDS 1-5.
* The program also implements a
* Serial Communication method that utilizes a leading CHAR for each command Described below.
* Commands:
* T(1-4) - Temp1-5 Status ex. T1, T2, etc
* C(1-4)(0-9) - Increment THRESHOLD1-4 by (1-9) ex. C15 increments THRESHOLD1 BY 5 (Note: C40 will give you a status of THRESHOLD4)
* D(1-4)(0-9) - Decrement THRESHOLD1-4 by (1-9) ex. D59 decrements THRESHOLD5 BY 9 (Note: D10 will give you a status of THRESHOLD1)
* A(0-1) - Manual AC on command A1 is AC on, A0 is AC off
* F(0-1) - Manual AC on command A1 is FAN on, A0 is FAN off
* Q - Q Sets the date of the RTC DS1307 Chip
*/

#include "Wire.h"
#define DS1307_I2C_ADDRESS 0x68

// Global Variables
int val_cnt = 0; // counter for the temp_val
int temp1Pin = 0; // select the input pin for the Thermistor
int temp2Pin = 1; // select the input pin for the Thermistor
int temp3Pin = 2; // select the input pin for the Thermistor
int temp4Pin = 3; // select the input pin for the Thermistor
int temp1_val[5] = {0,0,0,0,0}; // variable to store the value coming from the sensor
int temp2_val[5] = {0,0,0,0,0}; //
int temp3_val[5] = {0,0,0,0,0}; //
int temp4_val[5] = {0,0,0,0,0}; //
int temp1_avg; // average over poll time of the temp values
int temp2_avg;
int temp3_avg;
int temp4_avg;
int duct1 = 2; // Ducts open or close using a digital output
int duct2 = 3;
int duct3 = 4;
int duct4 = 5;
int THRESHOLD1 = 580; // Default theshold values
int THRESHOLD2 = 580;
int THRESHOLD3 = 580;
int THRESHOLD4 = 580;
int ac_on = 13;
int fan_on = 12;
int command = 0; // This is the command char, in ascii form, sent from the serial port
long polltime = 1000; // The time to Poll the tempPins
long previousMillis = 0; // will store last time Temp was updated
long ac_on_start = 0; // Start A/C delay timer
long ac_on_delay = 10000; // Time to wait before checking the ducts again
byte second, minute, hour, dayOfWeek, dayOfMonth, month, year;

// Convert normal decimal numbers to binary coded decimal
byte decToBcd(byte val)
{
return ( (val/10*16) + (val%10) );
}

// Convert binary coded decimal to normal decimal numbers
byte bcdToDec(byte val)
{
return ( (val/16*10) + (val%16) );
}

// 1) Sets the date and time on the ds1307
// 2) Starts the clock
// 3) Sets hour mode to 24 hour clock
// Assumes you're passing in valid numbers
// Watch for scope issues with Global Variables
/*void setDateDs1307(byte second, // 0-59
byte minute, // 0-59
byte hour, // 1-23
byte dayOfWeek, // 1-7
byte dayOfMonth, // 1-28/29/30/31
byte month, // 1-12
byte year) // 0-99*/
void setDateDs1307()
{
Wire.beginTransmission(DS1307_I2C_ADDRESS);
Wire.send(0);
Wire.send(decToBcd(second)); // 0 to bit 7 starts the clock
Wire.send(decToBcd(minute));
Wire.send(decToBcd(hour)); // If you want 12 hour am/pm you need to set
// bit 6 (also need to change readDateDs1307)
Wire.send(decToBcd(dayOfWeek));
Wire.send(decToBcd(dayOfMonth));
Wire.send(decToBcd(month));
Wire.send(decToBcd(year));
Wire.endTransmission();
}

// Gets the date and time from the ds1307 and prints result
// Watch for scope issues with Global Variables
void getDateDs1307()
{
// Reset the register pointer
Wire.beginTransmission(DS1307_I2C_ADDRESS);
Wire.send(0);
Wire.endTransmission();

Wire.requestFrom(DS1307_I2C_ADDRESS, 7);

// A few of these need masks because certain bits are control bits
second = bcdToDec(Wire.receive() & 0x7f);
minute = bcdToDec(Wire.receive());
hour = bcdToDec(Wire.receive() & 0x3f); // Need to change this if 12 hour am/pm
dayOfWeek = bcdToDec(Wire.receive());
dayOfMonth = bcdToDec(Wire.receive());
month = bcdToDec(Wire.receive());
year = bcdToDec(Wire.receive());

Serial.print(hour, DEC);
Serial.print(":");
Serial.print(minute, DEC);
Serial.print(":");
Serial.print(second, DEC);
Serial.print(" ");
Serial.print(month, DEC);
Serial.print("/");
Serial.print(dayOfMonth, DEC);
Serial.print("/");
Serial.print(year, DEC);

}

void setup() {
Wire.begin();
Serial.begin(57600);
pinMode(duct1, OUTPUT);
pinMode(duct2, OUTPUT);
pinMode(duct3, OUTPUT);
pinMode(duct4, OUTPUT);
pinMode(ac_on, OUTPUT);
pinMode(fan_on, OUTPUT);
// Initialize Date/Time to update RTC DS1307 - You need to run the Q command right after you download this program
// This is temporary until a more complex date time command is finished
second = 15;
minute = 41;
hour = 12;
dayOfWeek = 5;
dayOfMonth = 5;
month = 9;
year = 8;
}

void loop() {
if (millis() - previousMillis > polltime) {
previousMillis = millis(); // remember the last time
if (millis() - ac_on_start > ac_on_delay) {
if (digitalRead(duct1) || digitalRead(duct2) || digitalRead(duct3) || digitalRead(duct4)){ // If any ducts are turned on turn on the A/C
if (digitalRead(ac_on) != HIGH) { // Check ac_on state
digitalWrite(ac_on,HIGH);
getDateDs1307();
Serial.println(" - AC ON");
}
ac_on_start = millis();
}
else if (digitalRead(ac_on) != LOW){ //Check ac_on state
digitalWrite(ac_on,LOW);
getDateDs1307();
Serial.println(" - AC OFF");
}
}
temp1_val[val_cnt] = analogRead(temp1Pin); // read the value from the sensors
temp2_val[val_cnt] = analogRead(temp2Pin);
temp3_val[val_cnt] = analogRead(temp3Pin);
temp4_val[val_cnt] = analogRead(temp4Pin);
val_cnt ++;
if (val_cnt == 5) {
val_cnt = 0;
}
temp1_avg = (temp1_val[0] + temp1_val[1] + temp1_val[2] + temp1_val[3] + temp1_val[4])/5;
temp2_avg = (temp2_val[0] + temp2_val[1] + temp2_val[2] + temp2_val[3] + temp2_val[4])/5;
temp3_avg = (temp3_val[0] + temp3_val[1] + temp3_val[2] + temp3_val[3] + temp3_val[4])/5;
temp4_avg = (temp4_val[0] + temp4_val[1] + temp4_val[2] + temp4_val[3] + temp4_val[4])/5;
// Check Thresholds against the Temperatures and set the ducts HIGH or LOW
if (temp1_avg >= THRESHOLD1) {digitalWrite(duct1, HIGH);}
else {digitalWrite(duct1, LOW);}
if (temp2_avg >= THRESHOLD2) {digitalWrite(duct2, HIGH);}
else {digitalWrite(duct2, LOW);}
if (temp3_avg >= THRESHOLD3) {digitalWrite(duct3, HIGH);}
else {digitalWrite(duct3, LOW);}
if (temp4_avg >= THRESHOLD4) {digitalWrite(duct4, HIGH);}
else {digitalWrite(duct4, LOW);}
if (Serial.available()) { // Look for char in serial que and process if found
command = Serial.read();
if (command == 84) { // If command = "T"
command = Serial.read();
if (command == 49) { // If command = "1" print the Temp1
Serial.print("Temp1 = ");
Serial.print(temp1_avg); //
Serial.print(" ");
}
else if (command == 50) { // If command = "2" print the Temp2
Serial.print("Temp2 = ");
Serial.print(temp2_avg); //
Serial.print(" ");
}
else if (command == 51) { // If command = "3" print the Temp3
Serial.print("Temp3 = ");
Serial.print(temp3_avg); //
Serial.print(" ");
}
else if (command == 52) { // If command = "4" print the Temp4
Serial.print("Temp4 = ");
Serial.print(temp4_avg); //
Serial.print(" ");
}
}
else if (command == 67) { //If command = "C" Change Temp Threshhold
if (Serial.available()) {
command = Serial.read();
if (command == 49) { // If command = "1" print the THRESHOLD1
command = Serial.read();
if (command > 47 && command < 58) { // If command is between 0-9 Increment the Threshold by number sent
THRESHOLD1 += command - 48; // ASCII math to get value sent
Serial.print("THRESHOLD1 = ");
Serial.print(THRESHOLD1); //
Serial.print(" ");
}
}
else if (command == 50) { // If command = "2" print the THRESHOLD2
command = Serial.read();
if (command > 47 && command < 58) { // If command is between 0-9 Increment the Threshold by number sent
THRESHOLD2 += command - 48; // ASCII math to get value sent
Serial.print("THRESHOLD2 = ");
Serial.print(THRESHOLD2); //
Serial.print(" ");
}
}
else if (command == 51) { // If command = "3" print the THRESHOLD3
command = Serial.read();
if (command > 47 && command < 58) { // If command is between 0-9 Increment the Threshold by number sent
THRESHOLD3 += command - 48; // ASCII math to get value sent
Serial.print("THRESHOLD3 = ");
Serial.print(THRESHOLD3); //
Serial.print(" ");
}
}
else if (command == 52) { // If command = "4" print the THRESHOLD4
command = Serial.read();
if (command > 47 && command < 58) { // If command is between 0-9 Increment the Threshold by number sent
THRESHOLD4 += command - 48; // ASCII math to get value sent
Serial.print("THRESHOLD4 = ");
Serial.print(THRESHOLD4); //
Serial.print(" ");
}
}
}
}
else if (command == 68) { //If command = "D" Change Temp Threshhold
if (Serial.available()) {
command = Serial.read();
if (command == 49) { // If command = "1" print the THRESHOLD1
command = Serial.read();
if (command > 47 && command < 58) { // If command is between 0-9 Decrement the Threshold by number sent
THRESHOLD1 -= command - 48; // ASCII math to get value sent
Serial.print("THRESHOLD1 = ");
Serial.print(THRESHOLD1); //
Serial.print(" ");
}
}
else if (command == 50) { // If command = "2" print the THRESHOLD2
command = Serial.read();
if (command > 47 && command < 58) { // If command is between 0-9 Decrement the Threshold by number sent
THRESHOLD2 -= command - 48; // ASCII math to get value sent
Serial.print("THRESHOLD2 = ");
Serial.print(THRESHOLD2); //
Serial.print(" ");
}
}
else if (command == 51) { // If command = "3" print the THRESHOLD3
command = Serial.read();
if (command > 47 && command < 58) { // If command is between 0-9 Decrement the Threshold by number sent
THRESHOLD3 -= command - 48; // ASCII math to get value sent
Serial.print("THRESHOLD3 = ");
Serial.print(THRESHOLD3); //
Serial.print(" ");
}
}
else if (command == 52) { // If command = "4" print the THRESHOLD4
command = Serial.read();
if (command > 47 && command < 58) { // If command is between 0-9 Decrement the Threshold by number sent
THRESHOLD4 -= command - 48; // ASCII math to get value sent
Serial.print("THRESHOLD4 = ");
Serial.print(THRESHOLD4); //
Serial.print(" ");
}
}
}
}
//**************** Warning - This is a potential for problem - Consider a manual lock out feature to lock out manual commands
//**************** Possibly create a command to open up manual commands for a certian time period then shut them off again automatically
else if (command == 65) { //If command = "A" Change Temp Threshhold
if (Serial.available()) {
command = Serial.read();
if (command == 49) { // If command = "1" print the AC ON message
getDateDs1307();
Serial.print(" - Manual AC ON ");
ac_on_start = millis(); // Set the AC to a delay before it can be turned off again
digitalWrite(ac_on,HIGH);
}
else if (command == 48) { // If command = "0" print the AC OFF message
getDateDs1307();
Serial.print(" - Manual AC OFF ");
digitalWrite(ac_on,LOW);
}
}
}
else if (command == 70) { //If command = "F" Change Temp Threshhold
if (Serial.available()) {
command = Serial.read();
if (command == 49) { // If command = "1" print the FAN ON message
getDateDs1307();
Serial.print(" - Manual FAN ON ");
ac_on_start = millis();
digitalWrite(fan_on,HIGH);
}
else if (command == 48) { // If command = "0" print the FAN OFF message
getDateDs1307();
Serial.print(" - Manual FAN OFF ");
digitalWrite(fan_on,LOW);
}
}
}
//********************** End of Warning Zone *******************************

// *************** This Section Will list the Staus of the Controller
else if (command == 83) { //If command = "S" Print Controller Status
getDateDs1307();
Serial.println(" ");
Serial.println(" ");
Serial.print("Temp1 = ");
Serial.println(temp1_avg);
Serial.print("Temp2 = ");
Serial.println(temp2_avg);
Serial.print("Temp3 = ");
Serial.println(temp3_avg);
Serial.print("Temp4 = ");
Serial.println(temp4_avg);
Serial.println(" ");
Serial.print("THRESHOLD1 = ");
Serial.println(THRESHOLD1);
Serial.print("THRESHOLD2 = ");
Serial.println(THRESHOLD2);
Serial.print("THRESHOLD3 = ");
Serial.println(THRESHOLD3);
Serial.print("THRESHOLD4 = ");
Serial.println(THRESHOLD4);
Serial.println(" ");
if (digitalRead(duct1) == HIGH) {Serial.println("duct1 ON");}
else{Serial.println("duct1 OFF");}
if (digitalRead(duct2) == HIGH) {Serial.println("duct2 ON");}
else{Serial.println("duct2 OFF");}
if (digitalRead(duct3) == HIGH) {Serial.println("duct3 ON");}
else{Serial.println("duct3 OFF");}
if (digitalRead(duct4) == HIGH) {Serial.println("duct4 ON");}
else{Serial.println("duct4 OFF");}
Serial.println(" ");
if (digitalRead(fan_on) == HIGH) {Serial.println("Fan ON");}
else{Serial.println("Fan OFF");}
if (digitalRead(ac_on) == HIGH) {Serial.println("AC ON");}
else{Serial.println("AC OFF");}
Serial.print("A/C Delay (millisec) = ");
Serial.println(ac_on_delay);
Serial.print("Temp Polling (millisec) = ");
Serial.println(polltime);
Serial.println(" ");

}
else if (command == 81) { //If command = "Q" Set Date
setDateDs1307();
getDateDs1307();
Serial.println(" ");
}
Serial.println(command); // Echo command char found in serial que
command = 0; // reset command
}
}
}
//*****************************************************The End***********************
</pre>

== A/C_Control_v.01 User Guide ==
==== Commands ====
== Troubleshooting ==
=== Summary ===
When Troubleshooting a multi-functional issue, it is best practice to break down the issue into pieces and test each piece as a separate system. However, we will first run through a quick test to see if we can find any obvious issues first.
=== Quick Test ===

Temperature Controller

2008-09-10T23:20:20Z

Combustor: /* Example of Method */

{{default}}
== Warning ==
'''This page is in progress and none of the code can be considered good or complete. I am just using this as an alternate storage of the code for right now.'''

== Summary ==
== Functional Description of the Method ==
== Requirements ==
== Example of Method ==
=== Quick Guide: ===
=== Detailed Guide: ===
=== I2C ===
==== X9241A - Digital Potentiometer ====

There are basically only two functions that I am after right now which are both three byte instructions:

* Read WCR(Wiper Control Register) for the four potentiometers 0-3 (So far this is failing miserably)
** Send 1st byte - Address (my circuit - 01011010 or 0x2D)(binary - 0101 A3 A2 A1 A0) A values are actual pins set to high or low for an address.
** Send 2nd byte - Instruction (binary - 1001 (1/0)(1/0) 00) - The two bits are used to choose the potentiometer
** Read WCR requested Byte
* Write WCR for the four potentiometers 0-3 (This works)
** Send 1st byte - Address (my circuit - 01011010 or 0x2D)(binary - 0101 A3 A2 A1 A0) A values are actual pins set to high or low for an address.
** Send 2nd byte - Instruction (binary - 1010 (1/0)(1/0) 00) - The two bits are used to choose the potentiometer
** Send WCR Byte - Potentiometer value (binary - 00 D5 D4 D3 D2 D1 D0) - D values are the 0-63 potentiometer positions

==== DS1307 - Real Time Clock ====

The code for this very useful chip came from the [[http://www.glacialwanderer.com/hobbyrobotics/?p=12 Glacial Wanderer]]

==== A/C_Control_v.01 code ====

''' While this says v.01, don't count on it being a released v.01, I am still working on v.01, this is a back up '''

<pre>
/*
* A/C Control v.01
* by <http://www.combustory.com> John Vaughters
* Credit to:
* Maurice Ribble - http://www.glacialwanderer.com/hobbyrobotics for RTC DS1307 code
*
* Turns on an LED for temperatures from analog pins 1-5 on
* digital pins 2-6 when the temperature rises above the THRESHOLDS 1-5.
* The program also implements a
* Serial Communication method that utilizes a leading CHAR for each command Described below.
* Commands:
* T(1-4) - Temp1-5 Status ex. T1, T2, etc
* C(1-4)(0-9) - Increment THRESHOLD1-4 by (1-9) ex. C15 increments THRESHOLD1 BY 5 (Note: C40 will give you a status of THRESHOLD4)
* D(1-4)(0-9) - Decrement THRESHOLD1-4 by (1-9) ex. D59 decrements THRESHOLD5 BY 9 (Note: D10 will give you a status of THRESHOLD1)
* A(0-1) - Manual AC on command A1 is AC on, A0 is AC off
* F(0-1) - Manual AC on command A1 is FAN on, A0 is FAN off
* Q - Q Sets the date of the RTC DS1307 Chip
*/

#include "Wire.h"
#define DS1307_I2C_ADDRESS 0x68

// Global Variables
int val_cnt = 0; // counter for the temp_val
int temp1Pin = 0; // select the input pin for the Thermistor
int temp2Pin = 1; // select the input pin for the Thermistor
int temp3Pin = 2; // select the input pin for the Thermistor
int temp4Pin = 3; // select the input pin for the Thermistor
int temp1_val[5] = {0,0,0,0,0}; // variable to store the value coming from the sensor
int temp2_val[5] = {0,0,0,0,0}; //
int temp3_val[5] = {0,0,0,0,0}; //
int temp4_val[5] = {0,0,0,0,0}; //
int temp1_avg; // average over poll time of the temp values
int temp2_avg;
int temp3_avg;
int temp4_avg;
int duct1 = 2; // Ducts open or close using a digital output
int duct2 = 3;
int duct3 = 4;
int duct4 = 5;
int THRESHOLD1 = 580; // Default theshold values
int THRESHOLD2 = 580;
int THRESHOLD3 = 580;
int THRESHOLD4 = 580;
int ac_on = 13;
int fan_on = 12;
int command = 0; // This is the command char, in ascii form, sent from the serial port
long polltime = 1000; // The time to Poll the tempPins
long previousMillis = 0; // will store last time Temp was updated
long ac_on_start = 0; // Start A/C delay timer
long ac_on_delay = 10000; // Time to wait before checking the ducts again
byte second, minute, hour, dayOfWeek, dayOfMonth, month, year;

// Convert normal decimal numbers to binary coded decimal
byte decToBcd(byte val)
{
return ( (val/10*16) + (val%10) );
}

// Convert binary coded decimal to normal decimal numbers
byte bcdToDec(byte val)
{
return ( (val/16*10) + (val%16) );
}

// 1) Sets the date and time on the ds1307
// 2) Starts the clock
// 3) Sets hour mode to 24 hour clock
// Assumes you're passing in valid numbers
// Watch for scope issues with Global Variables
/*void setDateDs1307(byte second, // 0-59
byte minute, // 0-59
byte hour, // 1-23
byte dayOfWeek, // 1-7
byte dayOfMonth, // 1-28/29/30/31
byte month, // 1-12
byte year) // 0-99*/
void setDateDs1307()
{
Wire.beginTransmission(DS1307_I2C_ADDRESS);
Wire.send(0);
Wire.send(decToBcd(second)); // 0 to bit 7 starts the clock
Wire.send(decToBcd(minute));
Wire.send(decToBcd(hour)); // If you want 12 hour am/pm you need to set
// bit 6 (also need to change readDateDs1307)
Wire.send(decToBcd(dayOfWeek));
Wire.send(decToBcd(dayOfMonth));
Wire.send(decToBcd(month));
Wire.send(decToBcd(year));
Wire.endTransmission();
}

// Gets the date and time from the ds1307 and prints result
// Watch for scope issues with Global Variables
void getDateDs1307()
{
// Reset the register pointer
Wire.beginTransmission(DS1307_I2C_ADDRESS);
Wire.send(0);
Wire.endTransmission();

Wire.requestFrom(DS1307_I2C_ADDRESS, 7);

// A few of these need masks because certain bits are control bits
second = bcdToDec(Wire.receive() & 0x7f);
minute = bcdToDec(Wire.receive());
hour = bcdToDec(Wire.receive() & 0x3f); // Need to change this if 12 hour am/pm
dayOfWeek = bcdToDec(Wire.receive());
dayOfMonth = bcdToDec(Wire.receive());
month = bcdToDec(Wire.receive());
year = bcdToDec(Wire.receive());

Serial.print(hour, DEC);
Serial.print(":");
Serial.print(minute, DEC);
Serial.print(":");
Serial.print(second, DEC);
Serial.print(" ");
Serial.print(month, DEC);
Serial.print("/");
Serial.print(dayOfMonth, DEC);
Serial.print("/");
Serial.print(year, DEC);

}

void setup() {
Wire.begin();
Serial.begin(57600);
pinMode(duct1, OUTPUT);
pinMode(duct2, OUTPUT);
pinMode(duct3, OUTPUT);
pinMode(duct4, OUTPUT);
pinMode(ac_on, OUTPUT);
pinMode(fan_on, OUTPUT);
// Initialize Date/Time to update RTC DS1307 - You need to run the Q command right after you download this program
// This is temporary until a more complex date time command is finished
second = 15;
minute = 41;
hour = 12;
dayOfWeek = 5;
dayOfMonth = 5;
month = 9;
year = 8;
}

void loop() {
if (millis() - previousMillis > polltime) {
previousMillis = millis(); // remember the last time
if (millis() - ac_on_start > ac_on_delay) {
if (digitalRead(duct1) || digitalRead(duct2) || digitalRead(duct3) || digitalRead(duct4)){ // If any ducts are turned on turn on the A/C
if (digitalRead(ac_on) != HIGH) { // Check ac_on state
digitalWrite(ac_on,HIGH);
getDateDs1307();
Serial.println(" - AC ON");
}
ac_on_start = millis();
}
else if (digitalRead(ac_on) != LOW){ //Check ac_on state
digitalWrite(ac_on,LOW);
getDateDs1307();
Serial.println(" - AC OFF");
}
}
temp1_val[val_cnt] = analogRead(temp1Pin); // read the value from the sensors
temp2_val[val_cnt] = analogRead(temp2Pin);
temp3_val[val_cnt] = analogRead(temp3Pin);
temp4_val[val_cnt] = analogRead(temp4Pin);
val_cnt ++;
if (val_cnt == 5) {
val_cnt = 0;
}
temp1_avg = (temp1_val[0] + temp1_val[1] + temp1_val[2] + temp1_val[3] + temp1_val[4])/5;
temp2_avg = (temp2_val[0] + temp2_val[1] + temp2_val[2] + temp2_val[3] + temp2_val[4])/5;
temp3_avg = (temp3_val[0] + temp3_val[1] + temp3_val[2] + temp3_val[3] + temp3_val[4])/5;
temp4_avg = (temp4_val[0] + temp4_val[1] + temp4_val[2] + temp4_val[3] + temp4_val[4])/5;
// Check Thresholds against the Temperatures and set the ducts HIGH or LOW
if (temp1_avg >= THRESHOLD1) {digitalWrite(duct1, HIGH);}
else {digitalWrite(duct1, LOW);}
if (temp2_avg >= THRESHOLD2) {digitalWrite(duct2, HIGH);}
else {digitalWrite(duct2, LOW);}
if (temp3_avg >= THRESHOLD3) {digitalWrite(duct3, HIGH);}
else {digitalWrite(duct3, LOW);}
if (temp4_avg >= THRESHOLD4) {digitalWrite(duct4, HIGH);}
else {digitalWrite(duct4, LOW);}
if (Serial.available()) { // Look for char in serial que and process if found
command = Serial.read();
if (command == 84) { // If command = "T"
command = Serial.read();
if (command == 49) { // If command = "1" print the Temp1
Serial.print("Temp1 = ");
Serial.print(temp1_avg); //
Serial.print(" ");
}
else if (command == 50) { // If command = "2" print the Temp2
Serial.print("Temp2 = ");
Serial.print(temp2_avg); //
Serial.print(" ");
}
else if (command == 51) { // If command = "3" print the Temp3
Serial.print("Temp3 = ");
Serial.print(temp3_avg); //
Serial.print(" ");
}
else if (command == 52) { // If command = "4" print the Temp4
Serial.print("Temp4 = ");
Serial.print(temp4_avg); //
Serial.print(" ");
}
}
else if (command == 67) { //If command = "C" Change Temp Threshhold
if (Serial.available()) {
command = Serial.read();
if (command == 49) { // If command = "1" print the THRESHOLD1
command = Serial.read();
if (command > 47 && command < 58) { // If command is between 0-9 Increment the Threshold by number sent
THRESHOLD1 += command - 48; // ASCII math to get value sent
Serial.print("THRESHOLD1 = ");
Serial.print(THRESHOLD1); //
Serial.print(" ");
}
}
else if (command == 50) { // If command = "2" print the THRESHOLD2
command = Serial.read();
if (command > 47 && command < 58) { // If command is between 0-9 Increment the Threshold by number sent
THRESHOLD2 += command - 48; // ASCII math to get value sent
Serial.print("THRESHOLD2 = ");
Serial.print(THRESHOLD2); //
Serial.print(" ");
}
}
else if (command == 51) { // If command = "3" print the THRESHOLD3
command = Serial.read();
if (command > 47 && command < 58) { // If command is between 0-9 Increment the Threshold by number sent
THRESHOLD3 += command - 48; // ASCII math to get value sent
Serial.print("THRESHOLD3 = ");
Serial.print(THRESHOLD3); //
Serial.print(" ");
}
}
else if (command == 52) { // If command = "4" print the THRESHOLD4
command = Serial.read();
if (command > 47 && command < 58) { // If command is between 0-9 Increment the Threshold by number sent
THRESHOLD4 += command - 48; // ASCII math to get value sent
Serial.print("THRESHOLD4 = ");
Serial.print(THRESHOLD4); //
Serial.print(" ");
}
}
}
}
else if (command == 68) { //If command = "D" Change Temp Threshhold
if (Serial.available()) {
command = Serial.read();
if (command == 49) { // If command = "1" print the THRESHOLD1
command = Serial.read();
if (command > 47 && command < 58) { // If command is between 0-9 Decrement the Threshold by number sent
THRESHOLD1 -= command - 48; // ASCII math to get value sent
Serial.print("THRESHOLD1 = ");
Serial.print(THRESHOLD1); //
Serial.print(" ");
}
}
else if (command == 50) { // If command = "2" print the THRESHOLD2
command = Serial.read();
if (command > 47 && command < 58) { // If command is between 0-9 Decrement the Threshold by number sent
THRESHOLD2 -= command - 48; // ASCII math to get value sent
Serial.print("THRESHOLD2 = ");
Serial.print(THRESHOLD2); //
Serial.print(" ");
}
}
else if (command == 51) { // If command = "3" print the THRESHOLD3
command = Serial.read();
if (command > 47 && command < 58) { // If command is between 0-9 Decrement the Threshold by number sent
THRESHOLD3 -= command - 48; // ASCII math to get value sent
Serial.print("THRESHOLD3 = ");
Serial.print(THRESHOLD3); //
Serial.print(" ");
}
}
else if (command == 52) { // If command = "4" print the THRESHOLD4
command = Serial.read();
if (command > 47 && command < 58) { // If command is between 0-9 Decrement the Threshold by number sent
THRESHOLD4 -= command - 48; // ASCII math to get value sent
Serial.print("THRESHOLD4 = ");
Serial.print(THRESHOLD4); //
Serial.print(" ");
}
}
}
}
//**************** Warning - This is a potential for problem - Consider a manual lock out feature to lock out manual commands
//**************** Possibly create a command to open up manual commands for a certian time period then shut them off again automatically
else if (command == 65) { //If command = "A" Change Temp Threshhold
if (Serial.available()) {
command = Serial.read();
if (command == 49) { // If command = "1" print the AC ON message
getDateDs1307();
Serial.print(" - Manual AC ON ");
ac_on_start = millis(); // Set the AC to a delay before it can be turned off again
digitalWrite(ac_on,HIGH);
}
else if (command == 48) { // If command = "0" print the AC OFF message
getDateDs1307();
Serial.print(" - Manual AC OFF ");
digitalWrite(ac_on,LOW);
}
}
}
else if (command == 70) { //If command = "F" Change Temp Threshhold
if (Serial.available()) {
command = Serial.read();
if (command == 49) { // If command = "1" print the FAN ON message
getDateDs1307();
Serial.print(" - Manual FAN ON ");
ac_on_start = millis();
digitalWrite(fan_on,HIGH);
}
else if (command == 48) { // If command = "0" print the FAN OFF message
getDateDs1307();
Serial.print(" - Manual FAN OFF ");
digitalWrite(fan_on,LOW);
}
}
}
//********************** End of Warning Zone *******************************

// *************** This Section Will list the Staus of the Controller
else if (command == 83) { //If command = "S" Print Controller Status
getDateDs1307();
Serial.println(" ");
Serial.println(" ");
Serial.print("Temp1 = ");
Serial.println(temp1_avg);
Serial.print("Temp2 = ");
Serial.println(temp2_avg);
Serial.print("Temp3 = ");
Serial.println(temp3_avg);
Serial.print("Temp4 = ");
Serial.println(temp4_avg);
Serial.println(" ");
Serial.print("THRESHOLD1 = ");
Serial.println(THRESHOLD1);
Serial.print("THRESHOLD2 = ");
Serial.println(THRESHOLD2);
Serial.print("THRESHOLD3 = ");
Serial.println(THRESHOLD3);
Serial.print("THRESHOLD4 = ");
Serial.println(THRESHOLD4);
Serial.println(" ");
if (digitalRead(duct1) == HIGH) {Serial.println("duct1 ON");}
else{Serial.println("duct1 OFF");}
if (digitalRead(duct2) == HIGH) {Serial.println("duct2 ON");}
else{Serial.println("duct2 OFF");}
if (digitalRead(duct3) == HIGH) {Serial.println("duct3 ON");}
else{Serial.println("duct3 OFF");}
if (digitalRead(duct4) == HIGH) {Serial.println("duct4 ON");}
else{Serial.println("duct4 OFF");}
Serial.println(" ");
if (digitalRead(fan_on) == HIGH) {Serial.println("Fan ON");}
else{Serial.println("Fan OFF");}
if (digitalRead(ac_on) == HIGH) {Serial.println("AC ON");}
else{Serial.println("AC OFF");}
Serial.print("A/C Delay (millisec) = ");
Serial.println(ac_on_delay);
Serial.print("Temp Polling (millisec) = ");
Serial.println(polltime);
Serial.println(" ");

}
else if (command == 81) { //If command = "Q" Set Date
setDateDs1307();
getDateDs1307();
Serial.println(" ");
}
Serial.println(command); // Echo command char found in serial que
command = 0; // reset command
}
}
}
//*****************************************************The End***********************
</pre>

== A/C_Control_v.01 User Guide ==
==== Commands ====
== Troubleshooting ==
=== Summary ===
When Troubleshooting a multi-functional issue, it is best practice to break down the issue into pieces and test each piece as a separate system. However, we will first run through a quick test to see if we can find any obvious issues first.
=== Quick Test ===

Temperature Controller

2008-09-10T19:03:28Z

Combustor: /* Example of Method */

{{default}}
== Warning ==
'''This page is in progress and none of the code can be considered good or complete. I am just using this as an alternate storage of the code for right now.'''

== Summary ==
== Functional Description of the Method ==
== Requirements ==
== Example of Method ==
=== Quick Guide: ===
=== Detailed Guide: ===
=== I2C ===
==== X9241A - Digital Potentiometer ====

There are basically only two functions that I am after right now which are both three byte instructions: (So far this is failing miserably)

* Read WCR(Wiper Control Register) for the four potentiometers 0-3
** Send 1st byte - Address (my circuit - 01011010 or 0x2D)(binary - 0101 A3 A2 A1 A0) A values are actual pins set to high or low for an address.
** Send 2nd byte - Instruction (binary - 1001 (1/0)(1/0) 00) - The two bits are used to choose the potentiometer
** Read WCR requested Byte
* Write WCR for the four potentiometers 0-3
** Send 1st byte - Address (my circuit - 01011010 or 0x2D)(binary - 0101 A3 A2 A1 A0) A values are actual pins set to high or low for an address.
** Send 2nd byte - Instruction (binary - 1010 (1/0)(1/0) 00) - The two bits are used to choose the potentiometer
** Send WCR Byte - Potentiometer value (binary - 00 D5 D4 D3 D2 D1 D0) - D values are the 0-63 potentiometer positions

==== DS1307 - Real Time Clock ====

The code for this very useful chip came from the [[http://www.glacialwanderer.com/hobbyrobotics/?p=12 Glacial Wanderer]]

==== A/C_Control_v.01 code ====

''' While this says v.01, don't count on it being a released v.01, I am still working on v.01, this is a back up '''

<pre>
/*
* A/C Control v.01
* by <http://www.combustory.com> John Vaughters
* Credit to:
* Maurice Ribble - http://www.glacialwanderer.com/hobbyrobotics for RTC DS1307 code
*
* Turns on an LED for temperatures from analog pins 1-5 on
* digital pins 2-6 when the temperature rises above the THRESHOLDS 1-5.
* The program also implements a
* Serial Communication method that utilizes a leading CHAR for each command Described below.
* Commands:
* T(1-4) - Temp1-5 Status ex. T1, T2, etc
* C(1-4)(0-9) - Increment THRESHOLD1-4 by (1-9) ex. C15 increments THRESHOLD1 BY 5 (Note: C40 will give you a status of THRESHOLD4)
* D(1-4)(0-9) - Decrement THRESHOLD1-4 by (1-9) ex. D59 decrements THRESHOLD5 BY 9 (Note: D10 will give you a status of THRESHOLD1)
* A(0-1) - Manual AC on command A1 is AC on, A0 is AC off
* F(0-1) - Manual AC on command A1 is FAN on, A0 is FAN off
* Q - Q Sets the date of the RTC DS1307 Chip
*/

#include "Wire.h"
#define DS1307_I2C_ADDRESS 0x68

// Global Variables
int val_cnt = 0; // counter for the temp_val
int temp1Pin = 0; // select the input pin for the Thermistor
int temp2Pin = 1; // select the input pin for the Thermistor
int temp3Pin = 2; // select the input pin for the Thermistor
int temp4Pin = 3; // select the input pin for the Thermistor
int temp1_val[5] = {0,0,0,0,0}; // variable to store the value coming from the sensor
int temp2_val[5] = {0,0,0,0,0}; //
int temp3_val[5] = {0,0,0,0,0}; //
int temp4_val[5] = {0,0,0,0,0}; //
int temp1_avg; // average over poll time of the temp values
int temp2_avg;
int temp3_avg;
int temp4_avg;
int duct1 = 2; // Ducts open or close using a digital output
int duct2 = 3;
int duct3 = 4;
int duct4 = 5;
int THRESHOLD1 = 580; // Default theshold values
int THRESHOLD2 = 580;
int THRESHOLD3 = 580;
int THRESHOLD4 = 580;
int ac_on = 13;
int fan_on = 12;
int command = 0; // This is the command char, in ascii form, sent from the serial port
long polltime = 1000; // The time to Poll the tempPins
long previousMillis = 0; // will store last time Temp was updated
long ac_on_start = 0; // Start A/C delay timer
long ac_on_delay = 10000; // Time to wait before checking the ducts again
byte second, minute, hour, dayOfWeek, dayOfMonth, month, year;

// Convert normal decimal numbers to binary coded decimal
byte decToBcd(byte val)
{
return ( (val/10*16) + (val%10) );
}

// Convert binary coded decimal to normal decimal numbers
byte bcdToDec(byte val)
{
return ( (val/16*10) + (val%16) );
}

// 1) Sets the date and time on the ds1307
// 2) Starts the clock
// 3) Sets hour mode to 24 hour clock
// Assumes you're passing in valid numbers
// Watch for scope issues with Global Variables
/*void setDateDs1307(byte second, // 0-59
byte minute, // 0-59
byte hour, // 1-23
byte dayOfWeek, // 1-7
byte dayOfMonth, // 1-28/29/30/31
byte month, // 1-12
byte year) // 0-99*/
void setDateDs1307()
{
Wire.beginTransmission(DS1307_I2C_ADDRESS);
Wire.send(0);
Wire.send(decToBcd(second)); // 0 to bit 7 starts the clock
Wire.send(decToBcd(minute));
Wire.send(decToBcd(hour)); // If you want 12 hour am/pm you need to set
// bit 6 (also need to change readDateDs1307)
Wire.send(decToBcd(dayOfWeek));
Wire.send(decToBcd(dayOfMonth));
Wire.send(decToBcd(month));
Wire.send(decToBcd(year));
Wire.endTransmission();
}

// Gets the date and time from the ds1307 and prints result
// Watch for scope issues with Global Variables
void getDateDs1307()
{
// Reset the register pointer
Wire.beginTransmission(DS1307_I2C_ADDRESS);
Wire.send(0);
Wire.endTransmission();

Wire.requestFrom(DS1307_I2C_ADDRESS, 7);

// A few of these need masks because certain bits are control bits
second = bcdToDec(Wire.receive() & 0x7f);
minute = bcdToDec(Wire.receive());
hour = bcdToDec(Wire.receive() & 0x3f); // Need to change this if 12 hour am/pm
dayOfWeek = bcdToDec(Wire.receive());
dayOfMonth = bcdToDec(Wire.receive());
month = bcdToDec(Wire.receive());
year = bcdToDec(Wire.receive());

Serial.print(hour, DEC);
Serial.print(":");
Serial.print(minute, DEC);
Serial.print(":");
Serial.print(second, DEC);
Serial.print(" ");
Serial.print(month, DEC);
Serial.print("/");
Serial.print(dayOfMonth, DEC);
Serial.print("/");
Serial.print(year, DEC);

}

void setup() {
Wire.begin();
Serial.begin(57600);
pinMode(duct1, OUTPUT);
pinMode(duct2, OUTPUT);
pinMode(duct3, OUTPUT);
pinMode(duct4, OUTPUT);
pinMode(ac_on, OUTPUT);
pinMode(fan_on, OUTPUT);
// Initialize Date/Time to update RTC DS1307 - You need to run the Q command right after you download this program
// This is temporary until a more complex date time command is finished
second = 15;
minute = 41;
hour = 12;
dayOfWeek = 5;
dayOfMonth = 5;
month = 9;
year = 8;
}

void loop() {
if (millis() - previousMillis > polltime) {
previousMillis = millis(); // remember the last time
if (millis() - ac_on_start > ac_on_delay) {
if (digitalRead(duct1) || digitalRead(duct2) || digitalRead(duct3) || digitalRead(duct4)){ // If any ducts are turned on turn on the A/C
if (digitalRead(ac_on) != HIGH) { // Check ac_on state
digitalWrite(ac_on,HIGH);
getDateDs1307();
Serial.println(" - AC ON");
}
ac_on_start = millis();
}
else if (digitalRead(ac_on) != LOW){ //Check ac_on state
digitalWrite(ac_on,LOW);
getDateDs1307();
Serial.println(" - AC OFF");
}
}
temp1_val[val_cnt] = analogRead(temp1Pin); // read the value from the sensors
temp2_val[val_cnt] = analogRead(temp2Pin);
temp3_val[val_cnt] = analogRead(temp3Pin);
temp4_val[val_cnt] = analogRead(temp4Pin);
val_cnt ++;
if (val_cnt == 5) {
val_cnt = 0;
}
temp1_avg = (temp1_val[0] + temp1_val[1] + temp1_val[2] + temp1_val[3] + temp1_val[4])/5;
temp2_avg = (temp2_val[0] + temp2_val[1] + temp2_val[2] + temp2_val[3] + temp2_val[4])/5;
temp3_avg = (temp3_val[0] + temp3_val[1] + temp3_val[2] + temp3_val[3] + temp3_val[4])/5;
temp4_avg = (temp4_val[0] + temp4_val[1] + temp4_val[2] + temp4_val[3] + temp4_val[4])/5;
// Check Thresholds against the Temperatures and set the ducts HIGH or LOW
if (temp1_avg >= THRESHOLD1) {digitalWrite(duct1, HIGH);}
else {digitalWrite(duct1, LOW);}
if (temp2_avg >= THRESHOLD2) {digitalWrite(duct2, HIGH);}
else {digitalWrite(duct2, LOW);}
if (temp3_avg >= THRESHOLD3) {digitalWrite(duct3, HIGH);}
else {digitalWrite(duct3, LOW);}
if (temp4_avg >= THRESHOLD4) {digitalWrite(duct4, HIGH);}
else {digitalWrite(duct4, LOW);}
if (Serial.available()) { // Look for char in serial que and process if found
command = Serial.read();
if (command == 84) { // If command = "T"
command = Serial.read();
if (command == 49) { // If command = "1" print the Temp1
Serial.print("Temp1 = ");
Serial.print(temp1_avg); //
Serial.print(" ");
}
else if (command == 50) { // If command = "2" print the Temp2
Serial.print("Temp2 = ");
Serial.print(temp2_avg); //
Serial.print(" ");
}
else if (command == 51) { // If command = "3" print the Temp3
Serial.print("Temp3 = ");
Serial.print(temp3_avg); //
Serial.print(" ");
}
else if (command == 52) { // If command = "4" print the Temp4
Serial.print("Temp4 = ");
Serial.print(temp4_avg); //
Serial.print(" ");
}
}
else if (command == 67) { //If command = "C" Change Temp Threshhold
if (Serial.available()) {
command = Serial.read();
if (command == 49) { // If command = "1" print the THRESHOLD1
command = Serial.read();
if (command > 47 && command < 58) { // If command is between 0-9 Increment the Threshold by number sent
THRESHOLD1 += command - 48; // ASCII math to get value sent
Serial.print("THRESHOLD1 = ");
Serial.print(THRESHOLD1); //
Serial.print(" ");
}
}
else if (command == 50) { // If command = "2" print the THRESHOLD2
command = Serial.read();
if (command > 47 && command < 58) { // If command is between 0-9 Increment the Threshold by number sent
THRESHOLD2 += command - 48; // ASCII math to get value sent
Serial.print("THRESHOLD2 = ");
Serial.print(THRESHOLD2); //
Serial.print(" ");
}
}
else if (command == 51) { // If command = "3" print the THRESHOLD3
command = Serial.read();
if (command > 47 && command < 58) { // If command is between 0-9 Increment the Threshold by number sent
THRESHOLD3 += command - 48; // ASCII math to get value sent
Serial.print("THRESHOLD3 = ");
Serial.print(THRESHOLD3); //
Serial.print(" ");
}
}
else if (command == 52) { // If command = "4" print the THRESHOLD4
command = Serial.read();
if (command > 47 && command < 58) { // If command is between 0-9 Increment the Threshold by number sent
THRESHOLD4 += command - 48; // ASCII math to get value sent
Serial.print("THRESHOLD4 = ");
Serial.print(THRESHOLD4); //
Serial.print(" ");
}
}
}
}
else if (command == 68) { //If command = "D" Change Temp Threshhold
if (Serial.available()) {
command = Serial.read();
if (command == 49) { // If command = "1" print the THRESHOLD1
command = Serial.read();
if (command > 47 && command < 58) { // If command is between 0-9 Decrement the Threshold by number sent
THRESHOLD1 -= command - 48; // ASCII math to get value sent
Serial.print("THRESHOLD1 = ");
Serial.print(THRESHOLD1); //
Serial.print(" ");
}
}
else if (command == 50) { // If command = "2" print the THRESHOLD2
command = Serial.read();
if (command > 47 && command < 58) { // If command is between 0-9 Decrement the Threshold by number sent
THRESHOLD2 -= command - 48; // ASCII math to get value sent
Serial.print("THRESHOLD2 = ");
Serial.print(THRESHOLD2); //
Serial.print(" ");
}
}
else if (command == 51) { // If command = "3" print the THRESHOLD3
command = Serial.read();
if (command > 47 && command < 58) { // If command is between 0-9 Decrement the Threshold by number sent
THRESHOLD3 -= command - 48; // ASCII math to get value sent
Serial.print("THRESHOLD3 = ");
Serial.print(THRESHOLD3); //
Serial.print(" ");
}
}
else if (command == 52) { // If command = "4" print the THRESHOLD4
command = Serial.read();
if (command > 47 && command < 58) { // If command is between 0-9 Decrement the Threshold by number sent
THRESHOLD4 -= command - 48; // ASCII math to get value sent
Serial.print("THRESHOLD4 = ");
Serial.print(THRESHOLD4); //
Serial.print(" ");
}
}
}
}
//**************** Warning - This is a potential for problem - Consider a manual lock out feature to lock out manual commands
//**************** Possibly create a command to open up manual commands for a certian time period then shut them off again automatically
else if (command == 65) { //If command = "A" Change Temp Threshhold
if (Serial.available()) {
command = Serial.read();
if (command == 49) { // If command = "1" print the AC ON message
getDateDs1307();
Serial.print(" - Manual AC ON ");
ac_on_start = millis(); // Set the AC to a delay before it can be turned off again
digitalWrite(ac_on,HIGH);
}
else if (command == 48) { // If command = "0" print the AC OFF message
getDateDs1307();
Serial.print(" - Manual AC OFF ");
digitalWrite(ac_on,LOW);
}
}
}
else if (command == 70) { //If command = "F" Change Temp Threshhold
if (Serial.available()) {
command = Serial.read();
if (command == 49) { // If command = "1" print the FAN ON message
getDateDs1307();
Serial.print(" - Manual FAN ON ");
ac_on_start = millis();
digitalWrite(fan_on,HIGH);
}
else if (command == 48) { // If command = "0" print the FAN OFF message
getDateDs1307();
Serial.print(" - Manual FAN OFF ");
digitalWrite(fan_on,LOW);
}
}
}
//********************** End of Warning Zone *******************************

// *************** This Section Will list the Staus of the Controller
else if (command == 83) { //If command = "S" Print Controller Status
getDateDs1307();
Serial.println(" ");
Serial.println(" ");
Serial.print("Temp1 = ");
Serial.println(temp1_avg);
Serial.print("Temp2 = ");
Serial.println(temp2_avg);
Serial.print("Temp3 = ");
Serial.println(temp3_avg);
Serial.print("Temp4 = ");
Serial.println(temp4_avg);
Serial.println(" ");
Serial.print("THRESHOLD1 = ");
Serial.println(THRESHOLD1);
Serial.print("THRESHOLD2 = ");
Serial.println(THRESHOLD2);
Serial.print("THRESHOLD3 = ");
Serial.println(THRESHOLD3);
Serial.print("THRESHOLD4 = ");
Serial.println(THRESHOLD4);
Serial.println(" ");
if (digitalRead(duct1) == HIGH) {Serial.println("duct1 ON");}
else{Serial.println("duct1 OFF");}
if (digitalRead(duct2) == HIGH) {Serial.println("duct2 ON");}
else{Serial.println("duct2 OFF");}
if (digitalRead(duct3) == HIGH) {Serial.println("duct3 ON");}
else{Serial.println("duct3 OFF");}
if (digitalRead(duct4) == HIGH) {Serial.println("duct4 ON");}
else{Serial.println("duct4 OFF");}
Serial.println(" ");
if (digitalRead(fan_on) == HIGH) {Serial.println("Fan ON");}
else{Serial.println("Fan OFF");}
if (digitalRead(ac_on) == HIGH) {Serial.println("AC ON");}
else{Serial.println("AC OFF");}
Serial.print("A/C Delay (millisec) = ");
Serial.println(ac_on_delay);
Serial.print("Temp Polling (millisec) = ");
Serial.println(polltime);
Serial.println(" ");

}
else if (command == 81) { //If command = "Q" Set Date
setDateDs1307();
getDateDs1307();
Serial.println(" ");
}
Serial.println(command); // Echo command char found in serial que
command = 0; // reset command
}
}
}
//*****************************************************The End***********************
</pre>

== A/C_Control_v.01 User Guide ==
==== Commands ====
== Troubleshooting ==
=== Summary ===
When Troubleshooting a multi-functional issue, it is best practice to break down the issue into pieces and test each piece as a separate system. However, we will first run through a quick test to see if we can find any obvious issues first.
=== Quick Test ===

Temperature Controller

2008-09-10T17:03:41Z

Combustor: /* Example of Method */

{{default}}
== Warning ==
'''This page is in progress and none of the code can be considered good or complete. I am just using this as an alternate storage of the code for right now.'''

== Summary ==
== Functional Description of the Method ==
== Requirements ==
== Example of Method ==
=== Quick Guide: ===
=== Detailed Guide: ===
=== I2C ===
==== X9241A - Digital Potentiometer ====

There are basically only two functions that I am after right now which are both three byte instructions:

* Read WCR(Wiper Control Register) for the four potentiometers 0-3
** Send 1st byte - Address (my circuit - 10100101 or 0xA5)(binary - 1010 A0 A1 A2 A3) A values are actual pins set to high or low for an address.
** Send 2nd byte - Instruction (binary - 1001 (1/0)(1/0) 00) - The two bits are used to choose the potentiometer
** Read WCR requested Byte
* Write WCR for the four potentiometers 0-3
** Send 1st byte - Address (my circuit - 10100101 or 0xA5)(binary - 1010 A0 A1 A2 A3) A values are actual pins set to high or low for an address.
** Send 2nd byte - Instruction (binary - 1010 (1/0)(1/0) 00) - The two bits are used to choose the potentiometer
** Send WCR Byte - Potentiometer value (binary - 00 D5 D4 D3 D2 D1 D0) - D values are the 0-63 potentiometer positions

==== DS1307 - Real Time Clock ====

The code for this very useful chip came from the [[http://www.glacialwanderer.com/hobbyrobotics/?p=12 Glacial Wanderer]]

==== A/C_Control_v.01 code ====

''' While this says v.01, don't count on it being a released v.01, I am still working on v.01, this is a back up '''

<pre>
/*
* A/C Control v.01
* by <http://www.combustory.com> John Vaughters
* Credit to:
* Maurice Ribble - http://www.glacialwanderer.com/hobbyrobotics for RTC DS1307 code
*
* Turns on an LED for temperatures from analog pins 1-5 on
* digital pins 2-6 when the temperature rises above the THRESHOLDS 1-5.
* The program also implements a
* Serial Communication method that utilizes a leading CHAR for each command Described below.
* Commands:
* T(1-4) - Temp1-5 Status ex. T1, T2, etc
* C(1-4)(0-9) - Increment THRESHOLD1-4 by (1-9) ex. C15 increments THRESHOLD1 BY 5 (Note: C40 will give you a status of THRESHOLD4)
* D(1-4)(0-9) - Decrement THRESHOLD1-4 by (1-9) ex. D59 decrements THRESHOLD5 BY 9 (Note: D10 will give you a status of THRESHOLD1)
* A(0-1) - Manual AC on command A1 is AC on, A0 is AC off
* F(0-1) - Manual AC on command A1 is FAN on, A0 is FAN off
* Q - Q Sets the date of the RTC DS1307 Chip
*/

#include "Wire.h"
#define DS1307_I2C_ADDRESS 0x68

// Global Variables
int val_cnt = 0; // counter for the temp_val
int temp1Pin = 0; // select the input pin for the Thermistor
int temp2Pin = 1; // select the input pin for the Thermistor
int temp3Pin = 2; // select the input pin for the Thermistor
int temp4Pin = 3; // select the input pin for the Thermistor
int temp1_val[5] = {0,0,0,0,0}; // variable to store the value coming from the sensor
int temp2_val[5] = {0,0,0,0,0}; //
int temp3_val[5] = {0,0,0,0,0}; //
int temp4_val[5] = {0,0,0,0,0}; //
int temp1_avg; // average over poll time of the temp values
int temp2_avg;
int temp3_avg;
int temp4_avg;
int duct1 = 2; // Ducts open or close using a digital output
int duct2 = 3;
int duct3 = 4;
int duct4 = 5;
int THRESHOLD1 = 580; // Default theshold values
int THRESHOLD2 = 580;
int THRESHOLD3 = 580;
int THRESHOLD4 = 580;
int ac_on = 13;
int fan_on = 12;
int command = 0; // This is the command char, in ascii form, sent from the serial port
long polltime = 1000; // The time to Poll the tempPins
long previousMillis = 0; // will store last time Temp was updated
long ac_on_start = 0; // Start A/C delay timer
long ac_on_delay = 10000; // Time to wait before checking the ducts again
byte second, minute, hour, dayOfWeek, dayOfMonth, month, year;

// Convert normal decimal numbers to binary coded decimal
byte decToBcd(byte val)
{
return ( (val/10*16) + (val%10) );
}

// Convert binary coded decimal to normal decimal numbers
byte bcdToDec(byte val)
{
return ( (val/16*10) + (val%16) );
}

// 1) Sets the date and time on the ds1307
// 2) Starts the clock
// 3) Sets hour mode to 24 hour clock
// Assumes you're passing in valid numbers
// Watch for scope issues with Global Variables
/*void setDateDs1307(byte second, // 0-59
byte minute, // 0-59
byte hour, // 1-23
byte dayOfWeek, // 1-7
byte dayOfMonth, // 1-28/29/30/31
byte month, // 1-12
byte year) // 0-99*/
void setDateDs1307()
{
Wire.beginTransmission(DS1307_I2C_ADDRESS);
Wire.send(0);
Wire.send(decToBcd(second)); // 0 to bit 7 starts the clock
Wire.send(decToBcd(minute));
Wire.send(decToBcd(hour)); // If you want 12 hour am/pm you need to set
// bit 6 (also need to change readDateDs1307)
Wire.send(decToBcd(dayOfWeek));
Wire.send(decToBcd(dayOfMonth));
Wire.send(decToBcd(month));
Wire.send(decToBcd(year));
Wire.endTransmission();
}

// Gets the date and time from the ds1307 and prints result
// Watch for scope issues with Global Variables
void getDateDs1307()
{
// Reset the register pointer
Wire.beginTransmission(DS1307_I2C_ADDRESS);
Wire.send(0);
Wire.endTransmission();

Wire.requestFrom(DS1307_I2C_ADDRESS, 7);

// A few of these need masks because certain bits are control bits
second = bcdToDec(Wire.receive() & 0x7f);
minute = bcdToDec(Wire.receive());
hour = bcdToDec(Wire.receive() & 0x3f); // Need to change this if 12 hour am/pm
dayOfWeek = bcdToDec(Wire.receive());
dayOfMonth = bcdToDec(Wire.receive());
month = bcdToDec(Wire.receive());
year = bcdToDec(Wire.receive());

Serial.print(hour, DEC);
Serial.print(":");
Serial.print(minute, DEC);
Serial.print(":");
Serial.print(second, DEC);
Serial.print(" ");
Serial.print(month, DEC);
Serial.print("/");
Serial.print(dayOfMonth, DEC);
Serial.print("/");
Serial.print(year, DEC);

}

void setup() {
Wire.begin();
Serial.begin(57600);
pinMode(duct1, OUTPUT);
pinMode(duct2, OUTPUT);
pinMode(duct3, OUTPUT);
pinMode(duct4, OUTPUT);
pinMode(ac_on, OUTPUT);
pinMode(fan_on, OUTPUT);
// Initialize Date/Time to update RTC DS1307 - You need to run the Q command right after you download this program
// This is temporary until a more complex date time command is finished
second = 15;
minute = 41;
hour = 12;
dayOfWeek = 5;
dayOfMonth = 5;
month = 9;
year = 8;
}

void loop() {
if (millis() - previousMillis > polltime) {
previousMillis = millis(); // remember the last time
if (millis() - ac_on_start > ac_on_delay) {
if (digitalRead(duct1) || digitalRead(duct2) || digitalRead(duct3) || digitalRead(duct4)){ // If any ducts are turned on turn on the A/C
if (digitalRead(ac_on) != HIGH) { // Check ac_on state
digitalWrite(ac_on,HIGH);
getDateDs1307();
Serial.println(" - AC ON");
}
ac_on_start = millis();
}
else if (digitalRead(ac_on) != LOW){ //Check ac_on state
digitalWrite(ac_on,LOW);
getDateDs1307();
Serial.println(" - AC OFF");
}
}
temp1_val[val_cnt] = analogRead(temp1Pin); // read the value from the sensors
temp2_val[val_cnt] = analogRead(temp2Pin);
temp3_val[val_cnt] = analogRead(temp3Pin);
temp4_val[val_cnt] = analogRead(temp4Pin);
val_cnt ++;
if (val_cnt == 5) {
val_cnt = 0;
}
temp1_avg = (temp1_val[0] + temp1_val[1] + temp1_val[2] + temp1_val[3] + temp1_val[4])/5;
temp2_avg = (temp2_val[0] + temp2_val[1] + temp2_val[2] + temp2_val[3] + temp2_val[4])/5;
temp3_avg = (temp3_val[0] + temp3_val[1] + temp3_val[2] + temp3_val[3] + temp3_val[4])/5;
temp4_avg = (temp4_val[0] + temp4_val[1] + temp4_val[2] + temp4_val[3] + temp4_val[4])/5;
// Check Thresholds against the Temperatures and set the ducts HIGH or LOW
if (temp1_avg >= THRESHOLD1) {digitalWrite(duct1, HIGH);}
else {digitalWrite(duct1, LOW);}
if (temp2_avg >= THRESHOLD2) {digitalWrite(duct2, HIGH);}
else {digitalWrite(duct2, LOW);}
if (temp3_avg >= THRESHOLD3) {digitalWrite(duct3, HIGH);}
else {digitalWrite(duct3, LOW);}
if (temp4_avg >= THRESHOLD4) {digitalWrite(duct4, HIGH);}
else {digitalWrite(duct4, LOW);}
if (Serial.available()) { // Look for char in serial que and process if found
command = Serial.read();
if (command == 84) { // If command = "T"
command = Serial.read();
if (command == 49) { // If command = "1" print the Temp1
Serial.print("Temp1 = ");
Serial.print(temp1_avg); //
Serial.print(" ");
}
else if (command == 50) { // If command = "2" print the Temp2
Serial.print("Temp2 = ");
Serial.print(temp2_avg); //
Serial.print(" ");
}
else if (command == 51) { // If command = "3" print the Temp3
Serial.print("Temp3 = ");
Serial.print(temp3_avg); //
Serial.print(" ");
}
else if (command == 52) { // If command = "4" print the Temp4
Serial.print("Temp4 = ");
Serial.print(temp4_avg); //
Serial.print(" ");
}
}
else if (command == 67) { //If command = "C" Change Temp Threshhold
if (Serial.available()) {
command = Serial.read();
if (command == 49) { // If command = "1" print the THRESHOLD1
command = Serial.read();
if (command > 47 && command < 58) { // If command is between 0-9 Increment the Threshold by number sent
THRESHOLD1 += command - 48; // ASCII math to get value sent
Serial.print("THRESHOLD1 = ");
Serial.print(THRESHOLD1); //
Serial.print(" ");
}
}
else if (command == 50) { // If command = "2" print the THRESHOLD2
command = Serial.read();
if (command > 47 && command < 58) { // If command is between 0-9 Increment the Threshold by number sent
THRESHOLD2 += command - 48; // ASCII math to get value sent
Serial.print("THRESHOLD2 = ");
Serial.print(THRESHOLD2); //
Serial.print(" ");
}
}
else if (command == 51) { // If command = "3" print the THRESHOLD3
command = Serial.read();
if (command > 47 && command < 58) { // If command is between 0-9 Increment the Threshold by number sent
THRESHOLD3 += command - 48; // ASCII math to get value sent
Serial.print("THRESHOLD3 = ");
Serial.print(THRESHOLD3); //
Serial.print(" ");
}
}
else if (command == 52) { // If command = "4" print the THRESHOLD4
command = Serial.read();
if (command > 47 && command < 58) { // If command is between 0-9 Increment the Threshold by number sent
THRESHOLD4 += command - 48; // ASCII math to get value sent
Serial.print("THRESHOLD4 = ");
Serial.print(THRESHOLD4); //
Serial.print(" ");
}
}
}
}
else if (command == 68) { //If command = "D" Change Temp Threshhold
if (Serial.available()) {
command = Serial.read();
if (command == 49) { // If command = "1" print the THRESHOLD1
command = Serial.read();
if (command > 47 && command < 58) { // If command is between 0-9 Decrement the Threshold by number sent
THRESHOLD1 -= command - 48; // ASCII math to get value sent
Serial.print("THRESHOLD1 = ");
Serial.print(THRESHOLD1); //
Serial.print(" ");
}
}
else if (command == 50) { // If command = "2" print the THRESHOLD2
command = Serial.read();
if (command > 47 && command < 58) { // If command is between 0-9 Decrement the Threshold by number sent
THRESHOLD2 -= command - 48; // ASCII math to get value sent
Serial.print("THRESHOLD2 = ");
Serial.print(THRESHOLD2); //
Serial.print(" ");
}
}
else if (command == 51) { // If command = "3" print the THRESHOLD3
command = Serial.read();
if (command > 47 && command < 58) { // If command is between 0-9 Decrement the Threshold by number sent
THRESHOLD3 -= command - 48; // ASCII math to get value sent
Serial.print("THRESHOLD3 = ");
Serial.print(THRESHOLD3); //
Serial.print(" ");
}
}
else if (command == 52) { // If command = "4" print the THRESHOLD4
command = Serial.read();
if (command > 47 && command < 58) { // If command is between 0-9 Decrement the Threshold by number sent
THRESHOLD4 -= command - 48; // ASCII math to get value sent
Serial.print("THRESHOLD4 = ");
Serial.print(THRESHOLD4); //
Serial.print(" ");
}
}
}
}
//**************** Warning - This is a potential for problem - Consider a manual lock out feature to lock out manual commands
//**************** Possibly create a command to open up manual commands for a certian time period then shut them off again automatically
else if (command == 65) { //If command = "A" Change Temp Threshhold
if (Serial.available()) {
command = Serial.read();
if (command == 49) { // If command = "1" print the AC ON message
getDateDs1307();
Serial.print(" - Manual AC ON ");
ac_on_start = millis(); // Set the AC to a delay before it can be turned off again
digitalWrite(ac_on,HIGH);
}
else if (command == 48) { // If command = "0" print the AC OFF message
getDateDs1307();
Serial.print(" - Manual AC OFF ");
digitalWrite(ac_on,LOW);
}
}
}
else if (command == 70) { //If command = "F" Change Temp Threshhold
if (Serial.available()) {
command = Serial.read();
if (command == 49) { // If command = "1" print the FAN ON message
getDateDs1307();
Serial.print(" - Manual FAN ON ");
ac_on_start = millis();
digitalWrite(fan_on,HIGH);
}
else if (command == 48) { // If command = "0" print the FAN OFF message
getDateDs1307();
Serial.print(" - Manual FAN OFF ");
digitalWrite(fan_on,LOW);
}
}
}
//********************** End of Warning Zone *******************************

// *************** This Section Will list the Staus of the Controller
else if (command == 83) { //If command = "S" Print Controller Status
getDateDs1307();
Serial.println(" ");
Serial.println(" ");
Serial.print("Temp1 = ");
Serial.println(temp1_avg);
Serial.print("Temp2 = ");
Serial.println(temp2_avg);
Serial.print("Temp3 = ");
Serial.println(temp3_avg);
Serial.print("Temp4 = ");
Serial.println(temp4_avg);
Serial.println(" ");
Serial.print("THRESHOLD1 = ");
Serial.println(THRESHOLD1);
Serial.print("THRESHOLD2 = ");
Serial.println(THRESHOLD2);
Serial.print("THRESHOLD3 = ");
Serial.println(THRESHOLD3);
Serial.print("THRESHOLD4 = ");
Serial.println(THRESHOLD4);
Serial.println(" ");
if (digitalRead(duct1) == HIGH) {Serial.println("duct1 ON");}
else{Serial.println("duct1 OFF");}
if (digitalRead(duct2) == HIGH) {Serial.println("duct2 ON");}
else{Serial.println("duct2 OFF");}
if (digitalRead(duct3) == HIGH) {Serial.println("duct3 ON");}
else{Serial.println("duct3 OFF");}
if (digitalRead(duct4) == HIGH) {Serial.println("duct4 ON");}
else{Serial.println("duct4 OFF");}
Serial.println(" ");
if (digitalRead(fan_on) == HIGH) {Serial.println("Fan ON");}
else{Serial.println("Fan OFF");}
if (digitalRead(ac_on) == HIGH) {Serial.println("AC ON");}
else{Serial.println("AC OFF");}
Serial.print("A/C Delay (millisec) = ");
Serial.println(ac_on_delay);
Serial.print("Temp Polling (millisec) = ");
Serial.println(polltime);
Serial.println(" ");

}
else if (command == 81) { //If command = "Q" Set Date
setDateDs1307();
getDateDs1307();
Serial.println(" ");
}
Serial.println(command); // Echo command char found in serial que
command = 0; // reset command
}
}
}
//*****************************************************The End***********************
</pre>

== A/C_Control_v.01 User Guide ==
==== Commands ====
== Troubleshooting ==
=== Summary ===
When Troubleshooting a multi-functional issue, it is best practice to break down the issue into pieces and test each piece as a separate system. However, we will first run through a quick test to see if we can find any obvious issues first.
=== Quick Test ===

Temperature Controller

2008-09-10T17:02:16Z

Combustor: /* Example of Method */

{{default}}
== Warning ==
'''This page is in progress and none of the code can be considered good or complete. I am just using this as an alternate storage of the code for right now.'''

== Summary ==
== Functional Description of the Method ==
== Requirements ==
== Example of Method ==
=== Quick Guide: ===
=== Detailed Guide: ===
=== I2C ===
==== X9241A - Digital Potentiometer ====

There are basically only two functions that I am after right now which are both three byte instructions:

* Read WCR(Wiper Control Register) for the four potentiometers 0-3
** Send 1st byte - Address (my circuit - 10100101)(binary - 1010 A0 A1 A2 A3) A values are actual pins set to high or low for an address.
** Send 2nd byte - Instruction (binary - 1001 (1/0)(1/0) 00) - The two bits are used to choose the potentiometer
** Read WCR requested Byte
* Write WCR for the four potentiometers 0-3
** Send 1st byte - Address (my circuit - 10100101)(binary - 1010 A0 A1 A2 A3) A values are actual pins set to high or low for an address.
** Send 2nd byte - Instruction (binary - 1010 (1/0)(1/0) 00) - The two bits are used to choose the potentiometer
** Send WCR Byte - Potentiometer value (binary - 00 D5 D4 D3 D2 D1 D0) - D values are the 0-63 potentiometer positions

==== DS1307 - Real Time Clock ====

The code for this very useful chip came from the [[http://www.glacialwanderer.com/hobbyrobotics/?p=12 Glacial Wanderer]]

==== A/C_Control_v.01 code ====

''' While this says v.01, don't count on it being a released v.01, I am still working on v.01, this is a back up '''

<pre>
/*
* A/C Control v.01
* by <http://www.combustory.com> John Vaughters
* Credit to:
* Maurice Ribble - http://www.glacialwanderer.com/hobbyrobotics for RTC DS1307 code
*
* Turns on an LED for temperatures from analog pins 1-5 on
* digital pins 2-6 when the temperature rises above the THRESHOLDS 1-5.
* The program also implements a
* Serial Communication method that utilizes a leading CHAR for each command Described below.
* Commands:
* T(1-4) - Temp1-5 Status ex. T1, T2, etc
* C(1-4)(0-9) - Increment THRESHOLD1-4 by (1-9) ex. C15 increments THRESHOLD1 BY 5 (Note: C40 will give you a status of THRESHOLD4)
* D(1-4)(0-9) - Decrement THRESHOLD1-4 by (1-9) ex. D59 decrements THRESHOLD5 BY 9 (Note: D10 will give you a status of THRESHOLD1)
* A(0-1) - Manual AC on command A1 is AC on, A0 is AC off
* F(0-1) - Manual AC on command A1 is FAN on, A0 is FAN off
* Q - Q Sets the date of the RTC DS1307 Chip
*/

#include "Wire.h"
#define DS1307_I2C_ADDRESS 0x68

// Global Variables
int val_cnt = 0; // counter for the temp_val
int temp1Pin = 0; // select the input pin for the Thermistor
int temp2Pin = 1; // select the input pin for the Thermistor
int temp3Pin = 2; // select the input pin for the Thermistor
int temp4Pin = 3; // select the input pin for the Thermistor
int temp1_val[5] = {0,0,0,0,0}; // variable to store the value coming from the sensor
int temp2_val[5] = {0,0,0,0,0}; //
int temp3_val[5] = {0,0,0,0,0}; //
int temp4_val[5] = {0,0,0,0,0}; //
int temp1_avg; // average over poll time of the temp values
int temp2_avg;
int temp3_avg;
int temp4_avg;
int duct1 = 2; // Ducts open or close using a digital output
int duct2 = 3;
int duct3 = 4;
int duct4 = 5;
int THRESHOLD1 = 580; // Default theshold values
int THRESHOLD2 = 580;
int THRESHOLD3 = 580;
int THRESHOLD4 = 580;
int ac_on = 13;
int fan_on = 12;
int command = 0; // This is the command char, in ascii form, sent from the serial port
long polltime = 1000; // The time to Poll the tempPins
long previousMillis = 0; // will store last time Temp was updated
long ac_on_start = 0; // Start A/C delay timer
long ac_on_delay = 10000; // Time to wait before checking the ducts again
byte second, minute, hour, dayOfWeek, dayOfMonth, month, year;

// Convert normal decimal numbers to binary coded decimal
byte decToBcd(byte val)
{
return ( (val/10*16) + (val%10) );
}

// Convert binary coded decimal to normal decimal numbers
byte bcdToDec(byte val)
{
return ( (val/16*10) + (val%16) );
}

// 1) Sets the date and time on the ds1307
// 2) Starts the clock
// 3) Sets hour mode to 24 hour clock
// Assumes you're passing in valid numbers
// Watch for scope issues with Global Variables
/*void setDateDs1307(byte second, // 0-59
byte minute, // 0-59
byte hour, // 1-23
byte dayOfWeek, // 1-7
byte dayOfMonth, // 1-28/29/30/31
byte month, // 1-12
byte year) // 0-99*/
void setDateDs1307()
{
Wire.beginTransmission(DS1307_I2C_ADDRESS);
Wire.send(0);
Wire.send(decToBcd(second)); // 0 to bit 7 starts the clock
Wire.send(decToBcd(minute));
Wire.send(decToBcd(hour)); // If you want 12 hour am/pm you need to set
// bit 6 (also need to change readDateDs1307)
Wire.send(decToBcd(dayOfWeek));
Wire.send(decToBcd(dayOfMonth));
Wire.send(decToBcd(month));
Wire.send(decToBcd(year));
Wire.endTransmission();
}

// Gets the date and time from the ds1307 and prints result
// Watch for scope issues with Global Variables
void getDateDs1307()
{
// Reset the register pointer
Wire.beginTransmission(DS1307_I2C_ADDRESS);
Wire.send(0);
Wire.endTransmission();

Wire.requestFrom(DS1307_I2C_ADDRESS, 7);

// A few of these need masks because certain bits are control bits
second = bcdToDec(Wire.receive() & 0x7f);
minute = bcdToDec(Wire.receive());
hour = bcdToDec(Wire.receive() & 0x3f); // Need to change this if 12 hour am/pm
dayOfWeek = bcdToDec(Wire.receive());
dayOfMonth = bcdToDec(Wire.receive());
month = bcdToDec(Wire.receive());
year = bcdToDec(Wire.receive());

Serial.print(hour, DEC);
Serial.print(":");
Serial.print(minute, DEC);
Serial.print(":");
Serial.print(second, DEC);
Serial.print(" ");
Serial.print(month, DEC);
Serial.print("/");
Serial.print(dayOfMonth, DEC);
Serial.print("/");
Serial.print(year, DEC);

}

void setup() {
Wire.begin();
Serial.begin(57600);
pinMode(duct1, OUTPUT);
pinMode(duct2, OUTPUT);
pinMode(duct3, OUTPUT);
pinMode(duct4, OUTPUT);
pinMode(ac_on, OUTPUT);
pinMode(fan_on, OUTPUT);
// Initialize Date/Time to update RTC DS1307 - You need to run the Q command right after you download this program
// This is temporary until a more complex date time command is finished
second = 15;
minute = 41;
hour = 12;
dayOfWeek = 5;
dayOfMonth = 5;
month = 9;
year = 8;
}

void loop() {
if (millis() - previousMillis > polltime) {
previousMillis = millis(); // remember the last time
if (millis() - ac_on_start > ac_on_delay) {
if (digitalRead(duct1) || digitalRead(duct2) || digitalRead(duct3) || digitalRead(duct4)){ // If any ducts are turned on turn on the A/C
if (digitalRead(ac_on) != HIGH) { // Check ac_on state
digitalWrite(ac_on,HIGH);
getDateDs1307();
Serial.println(" - AC ON");
}
ac_on_start = millis();
}
else if (digitalRead(ac_on) != LOW){ //Check ac_on state
digitalWrite(ac_on,LOW);
getDateDs1307();
Serial.println(" - AC OFF");
}
}
temp1_val[val_cnt] = analogRead(temp1Pin); // read the value from the sensors
temp2_val[val_cnt] = analogRead(temp2Pin);
temp3_val[val_cnt] = analogRead(temp3Pin);
temp4_val[val_cnt] = analogRead(temp4Pin);
val_cnt ++;
if (val_cnt == 5) {
val_cnt = 0;
}
temp1_avg = (temp1_val[0] + temp1_val[1] + temp1_val[2] + temp1_val[3] + temp1_val[4])/5;
temp2_avg = (temp2_val[0] + temp2_val[1] + temp2_val[2] + temp2_val[3] + temp2_val[4])/5;
temp3_avg = (temp3_val[0] + temp3_val[1] + temp3_val[2] + temp3_val[3] + temp3_val[4])/5;
temp4_avg = (temp4_val[0] + temp4_val[1] + temp4_val[2] + temp4_val[3] + temp4_val[4])/5;
// Check Thresholds against the Temperatures and set the ducts HIGH or LOW
if (temp1_avg >= THRESHOLD1) {digitalWrite(duct1, HIGH);}
else {digitalWrite(duct1, LOW);}
if (temp2_avg >= THRESHOLD2) {digitalWrite(duct2, HIGH);}
else {digitalWrite(duct2, LOW);}
if (temp3_avg >= THRESHOLD3) {digitalWrite(duct3, HIGH);}
else {digitalWrite(duct3, LOW);}
if (temp4_avg >= THRESHOLD4) {digitalWrite(duct4, HIGH);}
else {digitalWrite(duct4, LOW);}
if (Serial.available()) { // Look for char in serial que and process if found
command = Serial.read();
if (command == 84) { // If command = "T"
command = Serial.read();
if (command == 49) { // If command = "1" print the Temp1
Serial.print("Temp1 = ");
Serial.print(temp1_avg); //
Serial.print(" ");
}
else if (command == 50) { // If command = "2" print the Temp2
Serial.print("Temp2 = ");
Serial.print(temp2_avg); //
Serial.print(" ");
}
else if (command == 51) { // If command = "3" print the Temp3
Serial.print("Temp3 = ");
Serial.print(temp3_avg); //
Serial.print(" ");
}
else if (command == 52) { // If command = "4" print the Temp4
Serial.print("Temp4 = ");
Serial.print(temp4_avg); //
Serial.print(" ");
}
}
else if (command == 67) { //If command = "C" Change Temp Threshhold
if (Serial.available()) {
command = Serial.read();
if (command == 49) { // If command = "1" print the THRESHOLD1
command = Serial.read();
if (command > 47 && command < 58) { // If command is between 0-9 Increment the Threshold by number sent
THRESHOLD1 += command - 48; // ASCII math to get value sent
Serial.print("THRESHOLD1 = ");
Serial.print(THRESHOLD1); //
Serial.print(" ");
}
}
else if (command == 50) { // If command = "2" print the THRESHOLD2
command = Serial.read();
if (command > 47 && command < 58) { // If command is between 0-9 Increment the Threshold by number sent
THRESHOLD2 += command - 48; // ASCII math to get value sent
Serial.print("THRESHOLD2 = ");
Serial.print(THRESHOLD2); //
Serial.print(" ");
}
}
else if (command == 51) { // If command = "3" print the THRESHOLD3
command = Serial.read();
if (command > 47 && command < 58) { // If command is between 0-9 Increment the Threshold by number sent
THRESHOLD3 += command - 48; // ASCII math to get value sent
Serial.print("THRESHOLD3 = ");
Serial.print(THRESHOLD3); //
Serial.print(" ");
}
}
else if (command == 52) { // If command = "4" print the THRESHOLD4
command = Serial.read();
if (command > 47 && command < 58) { // If command is between 0-9 Increment the Threshold by number sent
THRESHOLD4 += command - 48; // ASCII math to get value sent
Serial.print("THRESHOLD4 = ");
Serial.print(THRESHOLD4); //
Serial.print(" ");
}
}
}
}
else if (command == 68) { //If command = "D" Change Temp Threshhold
if (Serial.available()) {
command = Serial.read();
if (command == 49) { // If command = "1" print the THRESHOLD1
command = Serial.read();
if (command > 47 && command < 58) { // If command is between 0-9 Decrement the Threshold by number sent
THRESHOLD1 -= command - 48; // ASCII math to get value sent
Serial.print("THRESHOLD1 = ");
Serial.print(THRESHOLD1); //
Serial.print(" ");
}
}
else if (command == 50) { // If command = "2" print the THRESHOLD2
command = Serial.read();
if (command > 47 && command < 58) { // If command is between 0-9 Decrement the Threshold by number sent
THRESHOLD2 -= command - 48; // ASCII math to get value sent
Serial.print("THRESHOLD2 = ");
Serial.print(THRESHOLD2); //
Serial.print(" ");
}
}
else if (command == 51) { // If command = "3" print the THRESHOLD3
command = Serial.read();
if (command > 47 && command < 58) { // If command is between 0-9 Decrement the Threshold by number sent
THRESHOLD3 -= command - 48; // ASCII math to get value sent
Serial.print("THRESHOLD3 = ");
Serial.print(THRESHOLD3); //
Serial.print(" ");
}
}
else if (command == 52) { // If command = "4" print the THRESHOLD4
command = Serial.read();
if (command > 47 && command < 58) { // If command is between 0-9 Decrement the Threshold by number sent
THRESHOLD4 -= command - 48; // ASCII math to get value sent
Serial.print("THRESHOLD4 = ");
Serial.print(THRESHOLD4); //
Serial.print(" ");
}
}
}
}
//**************** Warning - This is a potential for problem - Consider a manual lock out feature to lock out manual commands
//**************** Possibly create a command to open up manual commands for a certian time period then shut them off again automatically
else if (command == 65) { //If command = "A" Change Temp Threshhold
if (Serial.available()) {
command = Serial.read();
if (command == 49) { // If command = "1" print the AC ON message
getDateDs1307();
Serial.print(" - Manual AC ON ");
ac_on_start = millis(); // Set the AC to a delay before it can be turned off again
digitalWrite(ac_on,HIGH);
}
else if (command == 48) { // If command = "0" print the AC OFF message
getDateDs1307();
Serial.print(" - Manual AC OFF ");
digitalWrite(ac_on,LOW);
}
}
}
else if (command == 70) { //If command = "F" Change Temp Threshhold
if (Serial.available()) {
command = Serial.read();
if (command == 49) { // If command = "1" print the FAN ON message
getDateDs1307();
Serial.print(" - Manual FAN ON ");
ac_on_start = millis();
digitalWrite(fan_on,HIGH);
}
else if (command == 48) { // If command = "0" print the FAN OFF message
getDateDs1307();
Serial.print(" - Manual FAN OFF ");
digitalWrite(fan_on,LOW);
}
}
}
//********************** End of Warning Zone *******************************

// *************** This Section Will list the Staus of the Controller
else if (command == 83) { //If command = "S" Print Controller Status
getDateDs1307();
Serial.println(" ");
Serial.println(" ");
Serial.print("Temp1 = ");
Serial.println(temp1_avg);
Serial.print("Temp2 = ");
Serial.println(temp2_avg);
Serial.print("Temp3 = ");
Serial.println(temp3_avg);
Serial.print("Temp4 = ");
Serial.println(temp4_avg);
Serial.println(" ");
Serial.print("THRESHOLD1 = ");
Serial.println(THRESHOLD1);
Serial.print("THRESHOLD2 = ");
Serial.println(THRESHOLD2);
Serial.print("THRESHOLD3 = ");
Serial.println(THRESHOLD3);
Serial.print("THRESHOLD4 = ");
Serial.println(THRESHOLD4);
Serial.println(" ");
if (digitalRead(duct1) == HIGH) {Serial.println("duct1 ON");}
else{Serial.println("duct1 OFF");}
if (digitalRead(duct2) == HIGH) {Serial.println("duct2 ON");}
else{Serial.println("duct2 OFF");}
if (digitalRead(duct3) == HIGH) {Serial.println("duct3 ON");}
else{Serial.println("duct3 OFF");}
if (digitalRead(duct4) == HIGH) {Serial.println("duct4 ON");}
else{Serial.println("duct4 OFF");}
Serial.println(" ");
if (digitalRead(fan_on) == HIGH) {Serial.println("Fan ON");}
else{Serial.println("Fan OFF");}
if (digitalRead(ac_on) == HIGH) {Serial.println("AC ON");}
else{Serial.println("AC OFF");}
Serial.print("A/C Delay (millisec) = ");
Serial.println(ac_on_delay);
Serial.print("Temp Polling (millisec) = ");
Serial.println(polltime);
Serial.println(" ");

}
else if (command == 81) { //If command = "Q" Set Date
setDateDs1307();
getDateDs1307();
Serial.println(" ");
}
Serial.println(command); // Echo command char found in serial que
command = 0; // reset command
}
}
}
//*****************************************************The End***********************
</pre>

== A/C_Control_v.01 User Guide ==
==== Commands ====
== Troubleshooting ==
=== Summary ===
When Troubleshooting a multi-functional issue, it is best practice to break down the issue into pieces and test each piece as a separate system. However, we will first run through a quick test to see if we can find any obvious issues first.
=== Quick Test ===

The MPGuino - Arduino Code

2008-09-10T14:50:32Z

Combustor: /* MPGuino.pde Code v.701 */

{{default}}

'''Check here for any updates http://opengauge.googlecode.com/svn/trunk/mpguino/mpguino.pde'''

== MPGuino.pde Code v.701 ==

<pre>
#define ver=701
/*

*/
//GPL Software
//#define debuguino youbetyourbippy
#include <avr/pgmspace.h>
byte brightness[]={0,42,85,128}; //middle button cycles through these brightness settings
#define brightnessLength (sizeof(brightness)/sizeof(byte)) //array size
byte brightnessIdx=1;

#define contrastIdx 0 //do contrast first to get display dialed in
#define vssPulsesPerMileIdx 1
#define microSecondsPerGallonIdx 2
#define injPulsesPer2Revolutions 3
#define currentTripResetTimeoutUSIdx 4
#define tankSizeIdx 5
#define injectorSettleTimeIdx 6
#define weightIdx 7
#define scratchpadIdx 8
char * parmLabels[]={"Contrast","VSS Pulses/Mile", "MicroSec/Gallon","Pulses/2 revs","Timout(microSec)","Tank Gal * 1000","Injector DelayuS","Weight (lbs)","scratchpad(odo?)"};
//unsigned long parms[]={15ul,16408ul,684968626ul,3ul,420000000ul,13300ul,500ul};//default values
unsigned long parms[]={15ul,10000ul,304409714ul,4ul,420000000ul,13300ul,500ul,2400ul,0ul,};//default values
#define parmsLength (sizeof(parms)/sizeof(unsigned long)) //array size

#define nil 3999999999ul

#define guinosig B10100101
#include <EEPROM.h>
//Vehicle Interface Pins
#define InjectorOpenPin 2
#define InjectorClosedPin 3
#define VSSPin 14 //analog 0

//LCD Pins
#define DIPin 4 // register select RS
#define DB4Pin 7
#define DB5Pin 8
#define DB6Pin 12
#define DB7Pin 13
#define ContrastPin 6
#define EnablePin 5
#define BrightnessPin 9

#define lbuttonPin 17 // Left Button, on analog 3,
#define mbuttonPin 18 // Middle Button, on analog 4
#define rbuttonPin 19 // Right Button, on analog 5

#define vssBit 1 // pin14 is a bitmask 1 on port C
#define lbuttonBit 8 // pin17 is a bitmask 8 on port C
#define mbuttonBit 16 // pin18 is a bitmask 16 on port C
#define rbuttonBit 32 // pin19 is a bitmask 32 on port C
#define loopsPerSecond 2 // how many times will we try and loop in a second

typedef void (* pFunc)(void);//type for display function pointers

volatile unsigned long timer2_overflow_count;

/*** Set up the Events ***
We have our own ISR for timer2 which gets called about once a millisecond.
So we define certain event functions that we can schedule by calling addEvent
with the event ID and the number of milliseconds to wait before calling the event.
The milliseconds is approximate.

Keep the event functions SMALL!!! This is an interrupt!

*/
//event functions

void enableLButton(){PCMSK1 |= (1 << PCINT11);}
void enableMButton(){PCMSK1 |= (1 << PCINT12);}
void enableRButton(){PCMSK1 |= (1 << PCINT13);}
//array of the event functions
pFunc eventFuncs[] ={enableVSS, enableLButton,enableMButton,enableRButton};
#define eventFuncSize (sizeof(eventFuncs)/sizeof(pFunc))
//define the event IDs
#define enableVSSID 0
#define enableLButtonID 1
#define enableMButtonID 2
#define enableRButtonID 3
//ms counters
unsigned int eventFuncCounts[eventFuncSize];

//schedule an event to occur ms milliseconds from now
void addEvent(byte eventID, unsigned int ms){
eventFuncCounts[eventID]=ms;
}

/* this ISR gets called every 1.024 milliseconds, we will call that a millisecond for our purposes
go through all the event counts,
if any are non zero subtract 1 and call the associated function if it just turned zero. */
ISR(TIMER2_OVF_vect){
timer2_overflow_count++;
for(byte eventID = 0; eventID < eventFuncSize; eventID++){
if(eventFuncCounts[eventID]!= 0){
eventFuncCounts[eventID]--;
if(eventFuncCounts[eventID] == 0)
eventFuncs[eventID]();
}
}
}

unsigned long maxLoopLength = 0; //see if we are overutilizing the CPU

#define buttonsUp lbuttonBit + mbuttonBit + rbuttonBit // start with the buttons in the right state
byte buttonState = buttonsUp;

//overflow counter used by millis2()
unsigned long lastMicroSeconds=millis2() * 1000;
unsigned long microSeconds (void){
unsigned long tmp_timer2_overflow_count;
unsigned long tmp;
byte tmp_tcnt2;
cli(); //disable interrupts
tmp_timer2_overflow_count = timer2_overflow_count;
tmp_tcnt2 = TCNT2;
sei(); // enable interrupts
tmp = ((tmp_timer2_overflow_count << 8) + tmp_tcnt2) * 4;
if((tmp<=lastMicroSeconds) && (lastMicroSeconds<4290560000ul))
return microSeconds();
lastMicroSeconds=tmp;
return tmp;
}

unsigned long elapsedMicroseconds(unsigned long startMicroSeconds, unsigned long currentMicroseconds ){
if(currentMicroseconds >= startMicroSeconds)
return currentMicroseconds-startMicroSeconds;
return 4294967295 - (startMicroSeconds-currentMicroseconds);
}

unsigned long elapsedMicroseconds(unsigned long startMicroSeconds ){
return elapsedMicroseconds(startMicroSeconds, microSeconds());
}

//Trip prototype
class Trip{
public:
unsigned long loopCount; //how long has this trip been running
unsigned long injPulses; //rpm
unsigned long injHiSec;// seconds the injector has been open
unsigned long injHius;// microseconds, fractional part of the injectors open
unsigned long vssPulses;//from the speedo
unsigned long vssPulseLength; // only used by instant
//these functions actually return in thousandths,
unsigned long miles();
unsigned long gallons();
unsigned long mpg();
unsigned long mph();
unsigned long time(); //mmm.ss
void update(Trip t);
void reset();
Trip();
};

//LCD prototype
namespace LCD{
void gotoXY(byte x, byte y);
void print(char * string);
void init();
void tickleEnable();
void cmdWriteSet();
void LcdCommandWrite(byte value);
void LcdDataWrite(byte value);
byte pushNibble(byte value);
};

//main objects we will be working with:
unsigned long injHiStart; //for timing injector pulses
Trip tmpTrip;
Trip instant;
Trip current;
Trip tank;

unsigned volatile long instInjStart=nil;
unsigned volatile long tmpInstInjStart=nil;
unsigned volatile long instInjEnd;
unsigned volatile long tmpInstInjEnd;
unsigned volatile long instInjTot;
unsigned volatile long tmpInstInjTot;
unsigned volatile long instInjCount;
unsigned volatile long tmpInstInjCount;

void processInjOpen(void){
injHiStart = microSeconds();
if (tmpInstInjStart == nil)
tmpInstInjStart=injHiStart;
tmpInstInjEnd=injHiStart;
}

void processInjClosed(void){
long x = elapsedMicroseconds(injHiStart)- parms[injectorSettleTimeIdx];
if(x >0)
tmpTrip.injHius += x;
tmpTrip.injPulses++;

if (tmpInstInjStart != nil){
if(x >0)
tmpInstInjTot += x;
tmpInstInjCount++;
}
}

volatile boolean vssFlop = 0;

void enableVSS(){
// tmpTrip.vssPulses++;
vssFlop = !vssFlop;
}

unsigned volatile long lastVSS1;
unsigned volatile long lastVSSTime;
unsigned volatile long lastVSS2;

volatile boolean lastVssFlop = vssFlop;

//attach the vss/buttons interrupt
ISR( PCINT1_vect ){
static byte vsspinstate=0;
byte p = PINC;//bypassing digitalRead for interrupt performance
if ((p & vssBit) != (vsspinstate & vssBit)){
addEvent(enableVSSID,2 ); //check back in a couple milli
}
if(lastVssFlop != vssFlop){
lastVSS1=lastVSS2;
unsigned long t = microSeconds();
lastVSS2=elapsedMicroseconds(lastVSSTime,t);
lastVSSTime=t;
tmpTrip.vssPulses++;
tmpTrip.vssPulseLength += lastVSS2;
lastVssFlop = vssFlop;
}
vsspinstate = p;
buttonState &= p;
}

pFunc displayFuncs[] ={
doDisplayCustom,
doDisplayInstantCurrent,
doDisplayInstantTank,
#ifndef debuguino //need to make room for Serial, so BigNums is out in debug mode
doDisplayBigInstant,
doDisplayBigCurrent,
doDisplayBigTank,
#endif
doDisplay2,
doDisplay3,
doDisplay4,
doDisplay5,
doDisplay6,
doDisplay7};
#define displayFuncSize (sizeof(displayFuncs)/sizeof(pFunc)) //array size
prog_char * displayFuncNames[displayFuncSize];
byte newRun = 0;
void setup (void){
init2();
#ifdef debuguino
Serial.begin(9600);
Serial.println("OpenGauge MPGuino online");
#endif
newRun = load();//load the default parameters
byte x = 0;
displayFuncNames[x++]= PSTR("Custom ");
displayFuncNames[x++]= PSTR("Instant/Current ");
displayFuncNames[x++]= PSTR("Instant/Tank ");
#ifndef debuguino
displayFuncNames[x++]= PSTR("BIG Instant ");
displayFuncNames[x++]= PSTR("BIG Current ");
displayFuncNames[x++]= PSTR("BIG Tank ");
#endif
displayFuncNames[x++]= PSTR("Current ");
displayFuncNames[x++]= PSTR("Tank ");
displayFuncNames[x++]= PSTR("Instant raw Data");
displayFuncNames[x++]= PSTR("Current raw Data");
displayFuncNames[x++]= PSTR("Tank raw Data ");
displayFuncNames[x++]= PSTR("CPU Monitor ");

pinMode(BrightnessPin,OUTPUT);
analogWrite(BrightnessPin,255-brightness[brightnessIdx]);
pinMode(EnablePin,OUTPUT);
pinMode(DIPin,OUTPUT);
pinMode(DB4Pin,OUTPUT);
pinMode(DB5Pin,OUTPUT);
pinMode(DB6Pin,OUTPUT);
pinMode(DB7Pin,OUTPUT);
delay2(500);

pinMode(ContrastPin,OUTPUT);
analogWrite(ContrastPin,parms[contrastIdx]);
LCD::init();
LCD::LcdCommandWrite(B00000001); // clear display, set cursor position to zero
LCD::LcdCommandWrite(B10000000); // set dram to zero
LCD::gotoXY(0,0);
LCD::print(getStr(PSTR("OpenGauge ")));
LCD::gotoXY(0,1);
LCD::print(getStr(PSTR(" MPGuino v0.71")));

pinMode(InjectorOpenPin, INPUT);
pinMode(InjectorClosedPin, INPUT);
pinMode(VSSPin, INPUT);
attachInterrupt(0, processInjOpen, FALLING);
attachInterrupt(1, processInjClosed, RISING);

pinMode( lbuttonPin, INPUT );
pinMode( mbuttonPin, INPUT );
pinMode( rbuttonPin, INPUT );

//"turn on" the internal pullup resistors
digitalWrite( lbuttonPin, HIGH);
digitalWrite( mbuttonPin, HIGH);
digitalWrite( rbuttonPin, HIGH);
// digitalWrite( VSSPin, HIGH);

//low level interrupt enable stuff
PCMSK1 |= (1 << PCINT8);
enableLButton();
enableMButton();
enableRButton();
PCICR |= (1 << PCIE1);

delay2(1500);
}

byte screen=0;
byte holdDisplay = 0;

#define looptime 1000000ul/loopsPerSecond //1/2 second
void loop (void){
if(newRun !=1)
initGuino();//go through the initialization screen
unsigned long lastActivity =microSeconds();
unsigned long tankHold; //state at point of last activity
while(true){
unsigned long loopStart=microSeconds();
instant.reset(); //clear instant
cli();
instant.update(tmpTrip); //"copy" of tmpTrip in instant now
tmpTrip.reset(); //reset tmpTrip first so we don't lose too many interrupts
instInjStart=tmpInstInjStart;
instInjEnd=tmpInstInjEnd;
instInjTot=tmpInstInjTot;
instInjCount=tmpInstInjCount;

tmpInstInjStart=nil;
tmpInstInjEnd=nil;
tmpInstInjTot=0;
tmpInstInjCount=0;

sei();
#ifdef debuguino
// Serial.print("instant: ");Serial.print(instant.injHiSec);Serial.print(",");Serial.print(instant.injHius);
// Serial.print(",");Serial.print(instant.injPulses);Serial.print(",");Serial.println(instant.vssPulses);
#endif
current.update(instant); //use instant to update current
tank.update(instant); //use instant to update tank
#ifdef debuguino
// Serial.print("current: ");Serial.print(current.injHiSec);Serial.print(",");Serial.print(current.injHius);
// Serial.print(",");Serial.print(current.injPulses);Serial.print(",");Serial.println(current.vssPulses);
#endif

//currentTripResetTimeoutUS
if(instant.vssPulses == 0 && instant.injPulses == 0 && holdDisplay==0){
if(elapsedMicroseconds(lastActivity) > parms[currentTripResetTimeoutUSIdx] && lastActivity != nil){
analogWrite(BrightnessPin,255-brightness[0]); //nitey night
lastActivity = nil;
}
}else{
if(lastActivity == nil){//wake up!!!
analogWrite(BrightnessPin,255-brightness[brightnessIdx]);
lastActivity=loopStart;
current.reset();
tank.loopCount = tankHold;
current.update(instant);
tank.update(instant);
}else{
lastActivity=loopStart;
tankHold = tank.loopCount;
}
}

if(holdDisplay==0){
displayFuncs[screen](); //call the appropriate display routine
LCD::gotoXY(0,0);

//see if any buttons were pressed, display a brief message if so
if(!(buttonState&lbuttonBit) && !(buttonState&mbuttonBit)&& !(buttonState&rbuttonBit)){// left and middle and right = initialize
LCD::print(getStr(PSTR("Setup ")));
initGuino();
//}else if(!(buttonState&lbuttonBit) && !(buttonState&rbuttonBit)){// left and right = run lcd init = tank reset
// LCD::print(getStr(PSTR("Init LCD ")));
// LCD::init();
}else if (!(buttonState&lbuttonBit) && !(buttonState&mbuttonBit)){// left and middle = tank reset
tank.reset();
LCD::print(getStr(PSTR("Tank Reset ")));
}else if(!(buttonState&mbuttonBit) && !(buttonState&rbuttonBit)){// right and middle = current reset
current.reset();
LCD::print(getStr(PSTR("Current Reset ")));
}else if(!(buttonState&lbuttonBit)){ //left is rotate through screeens to the left
if(screen!=0)
screen=(screen-1);
else
screen=displayFuncSize-1;
LCD::print(getStr(displayFuncNames[screen]));
}else if(!(buttonState&mbuttonBit)){ //middle is cycle through brightness settings
brightnessIdx = (brightnessIdx + 1) % brightnessLength;
analogWrite(BrightnessPin,255-brightness[brightnessIdx]);
LCD::print(getStr(PSTR("Brightness ")));
LCD::LcdDataWrite('0' + brightnessIdx);
LCD::print(" ");
}else if(!(buttonState&rbuttonBit)){//right is rotate through screeens to the left
screen=(screen+1)%displayFuncSize;
LCD::print(getStr(displayFuncNames[screen]));
}
if(buttonState!=buttonsUp)
holdDisplay=1;
}else{
holdDisplay=0;
}
buttonState=buttonsUp;//reset the buttons

//keep track of how long the loops take before we go int waiting.
unsigned long loopX=elapsedMicroseconds(loopStart);
if(loopX>maxLoopLength) maxLoopLength = loopX;

while (elapsedMicroseconds(loopStart) < (looptime));//wait for the end of a second to arrive
}

}

char fBuff[7];//used by format
//format a number into NNN.NN the number should already be representing thousandths
char* format(unsigned long num){
unsigned long d = 10000;
long t;
byte dp=3;
byte l=6;

//123456 = 123.46
if(num>9999999){
d=100000;
dp=99;
num/=100;
}else if(num>999999){
dp=4;
num/=10;
}

unsigned long val = num/10;
if ((num - (val * 10)) >= 5) //will the first unprinted digit be greater than 4?
val += 1; //round up val

for(byte x = 0; x < l; x++){
if(x==dp) //time to poke in the decimal point?
fBuff[x]='.';
else{
t = val/d;
fBuff[x]= '0' + t%10;//poke the ascii character for the digit.
val-= t*d;
d/=10;
}
}
fBuff[6]= 0; //good old zero terminated strings
return fBuff;
}

//get a string from flash
char mBuff[17];//used by getStr
char * getStr(prog_char * str){
strcpy_P(mBuff, str);
return mBuff;
}

void doDisplayCustom(){displayTripCombo('I','M',instantmpg(),'S',instantmph(),'R','P',instantrpm(),'C',current.mpg());}
void doDisplayInstantCurrent(){displayTripCombo('I','M',instantmpg(),'S',instantmph(),'C','M',current.mpg(),'D',current.miles());}

void doDisplayInstantTank(){displayTripCombo('I','M',instantmpg(),'S',instantmph(),'T','M',tank.mpg(),'D',tank.miles());}

#ifndef debuguino
void doDisplayBigInstant() {bigNum(instant.mpg(),"INST","MPG ");}
void doDisplayBigCurrent() {bigNum(current.mpg(),"CURR","MPG ");}
void doDisplayBigTank() {bigNum(tank.mpg(),"TANK","MPG ");}
#endif

void doDisplay2(void){tDisplay(&current);} //display current trip formatted data.
void doDisplay3(void){tDisplay(&tank);} //display tank trip formatted data.
void doDisplay4(void){rawDisplay(&instant);} //display instant trip "raw" injector and vss data.
void doDisplay5(void){rawDisplay(&current);} //display current trip "raw" injector and vss data.
void doDisplay6(void){rawDisplay(&tank);} //display tank trip "raw" injector and vss data.
void doDisplay7(void){
LCD::gotoXY(0,0);LCD::print("C%");LCD::print(format(maxLoopLength*1000/(looptime/100)));LCD::print(" T"); LCD::print(format(tank.time()));
unsigned long mem = memoryTest();
mem*=1000;
LCD::gotoXY(0,1);LCD::print("FREE MEM: ");LCD::print(format(mem));
} //display max cpu utilization and ram.

void displayTripCombo(char t1, char t1L1, unsigned long t1V1, char t1L2, unsigned long t1V2, char t2, char t2L1, unsigned long t2V1, char t2L2, unsigned long t2V2){
LCD::gotoXY(0,0);LCD::LcdDataWrite(t1);LCD::LcdDataWrite(t1L1);LCD::print(format(t1V1));LCD::LcdDataWrite(' ');
LCD::LcdDataWrite(t1L2);LCD::print(format(t1V2));
LCD::gotoXY(0,1);LCD::LcdDataWrite(t2);LCD::LcdDataWrite(t2L1);LCD::print(format(t2V1));LCD::LcdDataWrite(' ');
LCD::LcdDataWrite(t2L2);LCD::print(format(t2V2));
}

//arduino doesn't do well with types defined in a script as parameters, so have to pass as void * and use -> notation.
void tDisplay( void * r){ //display trip functions.
Trip *t = (Trip *)r;
LCD::gotoXY(0,0);LCD::print("MH");LCD::print(format(t->mph()));LCD::print("MG");LCD::print(format(t->mpg()));
LCD::gotoXY(0,1);LCD::print("MI");LCD::print(format(t->miles()));LCD::print("GA");LCD::print(format(t->gallons()));
}

void rawDisplay(void * r){
Trip *t = (Trip *)r;
LCD::gotoXY(0,0);LCD::print("IJ");LCD::print(format(t->injHiSec*1000));LCD::print("uS");LCD::print(format(t->injHius*1000));
LCD::gotoXY(0,1);LCD::print("IC");LCD::print(format(t->injPulses*1000));LCD::print("VC");LCD::print(format(t->vssPulses*1000));
}

//x=0..16, y= 0..1
void LCD::gotoXY(byte x, byte y){
byte dr=x+0x80;
if (y==1)
dr += 0x40;
if (y==2)
dr += 0x14;
if (y==3)
dr += 0x54;
LCD::LcdCommandWrite(dr);
}

void LCD::print(char * string){
byte x = 0;
char c = string[x];
while(c != 0){
LCD::LcdDataWrite(c);
x++;
c = string[x];
}
}

void LCD::init(){
delay2(16); // wait for more than 15 msec
pushNibble(B00110000); // send (B0011) to DB7-4
cmdWriteSet();
tickleEnable();
delay2(5); // wait for more than 4.1 msec
pushNibble(B00110000); // send (B0011) to DB7-4
cmdWriteSet();
tickleEnable();
delay2(1); // wait for more than 100 usec
pushNibble(B00110000); // send (B0011) to DB7-4
cmdWriteSet();
tickleEnable();
delay2(1); // wait for more than 100 usec
pushNibble(B00100000); // send (B0010) to DB7-4 for 4bit
cmdWriteSet();
tickleEnable();
delay2(1); // wait for more than 100 usec
// ready to use normal LcdCommandWrite() function now!
LcdCommandWrite(B00101000); // 4-bit interface, 2 display lines, 5x8 font
LcdCommandWrite(B00001100); // display control:
LcdCommandWrite(B00000110); // entry mode set: increment automatically, no display shift
#ifndef debuguino
//creating the custom fonts:
LcdCommandWrite(B01001000); // set cgram
static byte chars[] PROGMEM ={
B11111,B00000,B11111,B11111,B00000,
B11111,B00000,B11111,B11111,B00000,
B11111,B00000,B11111,B11111,B00000,
B00000,B00000,B00000,B11111,B00000,
B00000,B00000,B00000,B11111,B00000,
B00000,B11111,B11111,B11111,B01110,
B00000,B11111,B11111,B11111,B01110,
B00000,B11111,B11111,B11111,B01110};

for(byte x=0;x<5;x++)
for(byte y=0;y<8;y++)
LcdDataWrite(pgm_read_byte(&chars[y*5+x])); //write the character data to the character generator ram
#endif
LcdCommandWrite(B00000001); // clear display, set cursor position to zero
LcdCommandWrite(B10000000); // set dram to zero

}

void LCD::tickleEnable(){
// send a pulse to enable
digitalWrite(EnablePin,HIGH);
delayMicroseconds2(1); // pause 1 ms according to datasheet
digitalWrite(EnablePin,LOW);
delayMicroseconds2(1); // pause 1 ms according to datasheet
}

void LCD::cmdWriteSet(){
digitalWrite(EnablePin,LOW);
delayMicroseconds2(1); // pause 1 ms according to datasheet
digitalWrite(DIPin,0);
}

byte LCD::pushNibble(byte value){
digitalWrite(DB7Pin, value & 128);
value <<= 1;
digitalWrite(DB6Pin, value & 128);
value <<= 1;
digitalWrite(DB5Pin, value & 128);
value <<= 1;
digitalWrite(DB4Pin, value & 128);
value <<= 1;
return value;
}

void LCD::LcdCommandWrite(byte value){
value=pushNibble(value);
cmdWriteSet();
tickleEnable();
value=pushNibble(value);
cmdWriteSet();
tickleEnable();
delay2(5);
}

void LCD::LcdDataWrite(byte value){
digitalWrite(DIPin, HIGH);
value=pushNibble(value);
tickleEnable();
value=pushNibble(value);
tickleEnable();
delay2(5);
}

// this function will return the number of bytes currently free in RAM
extern int __bss_end;
extern int *__brkval;
int memoryTest(){
int free_memory;
if((int)__brkval == 0)
free_memory = ((int)&free_memory) - ((int)&__bss_end);
else
free_memory = ((int)&free_memory) - ((int)__brkval);
return free_memory;
}

Trip::Trip(){
}

//for display computing
unsigned long tmp1[2];
unsigned long tmp2[2];
unsigned long tmp3[2];

unsigned long instantmph(){
//unsigned long vssPulseTimeuS = (lastVSS1 + lastVSS2) / 2;
unsigned long vssPulseTimeuS = instant.vssPulseLength/instant.vssPulses;

init64(tmp1,0,1000000000ul);
init64(tmp2,0,parms[vssPulsesPerMileIdx]);
div64(tmp1,tmp2);
init64(tmp2,0,3600);
mul64(tmp1,tmp2);
init64(tmp2,0,vssPulseTimeuS);
div64(tmp1,tmp2);
return tmp1[1];
}

unsigned long instantmpg(){
unsigned long imph=instantmph();
unsigned long igph=instantgph();
init64(tmp1,0,1000ul);
init64(tmp2,0,imph);
mul64(tmp1,tmp2);
init64(tmp2,0,igph);
div64(tmp1,tmp2);
return tmp1[1];
}

unsigned long instantgph(){
// unsigned long vssPulseTimeuS = instant.vssPulseLength/instant.vssPulses;

// unsigned long instInjStart=nil;
//unsigned long instInjEnd;
//unsigned long instInjTot;
init64(tmp1,0,instInjTot);
init64(tmp2,0,3600000000ul);
mul64(tmp1,tmp2);
init64(tmp2,0,1000ul);
mul64(tmp1,tmp2);
init64(tmp2,0,parms[microSecondsPerGallonIdx]);
div64(tmp1,tmp2);
init64(tmp2,0,instInjEnd-instInjStart);
div64(tmp1,tmp2);
return tmp1[1];
}

unsigned long instantrpm(){
// instInjCount=tmpInstInjCount;

// unsigned long vssPulseTimeuS = instant.vssPulseLength/instant.vssPulses;

// unsigned long instInjStart=nil;
//unsigned long instInjEnd;
//unsigned long instInjTot;
init64(tmp1,0,instInjCount);
init64(tmp2,0,120000000ul);
mul64(tmp1,tmp2);
init64(tmp2,0,1000ul);
mul64(tmp1,tmp2);
init64(tmp2,0,parms[injPulsesPer2Revolutions]);
div64(tmp1,tmp2);
init64(tmp2,0,instInjEnd-instInjStart);
div64(tmp1,tmp2);
return tmp1[1];
}

unsigned long Trip::miles(){
init64(tmp1,0,vssPulses);
init64(tmp2,0,1000);
mul64(tmp1,tmp2);
init64(tmp2,0,parms[vssPulsesPerMileIdx]);
div64(tmp1,tmp2);
return tmp1[1];
}

unsigned long Trip::mph(){
if(loopCount == 0)
return 0;
init64(tmp1,0,loopsPerSecond);
init64(tmp2,0,vssPulses);
mul64(tmp1,tmp2);
init64(tmp2,0,3600000);
mul64(tmp1,tmp2);
init64(tmp2,0,parms[vssPulsesPerMileIdx]);
div64(tmp1,tmp2);
init64(tmp2,0,loopCount);
div64(tmp1,tmp2);
return tmp1[1];
}

unsigned long Trip::gallons(){
init64(tmp1,0,injHiSec);
init64(tmp2,0,1000000);
mul64(tmp1,tmp2);
init64(tmp2,0,injHius);
add64(tmp1,tmp2);
init64(tmp2,0,1000);
mul64(tmp1,tmp2);
init64(tmp2,0,parms[microSecondsPerGallonIdx]);
div64(tmp1,tmp2);
return tmp1[1];
}

unsigned long Trip::mpg(){
if(vssPulses==0) return 0;
if(injPulses==0) return 999999000; //who doesn't like to see 999999? :)

init64(tmp1,0,injHiSec);
init64(tmp3,0,1000000);
mul64(tmp3,tmp1);
init64(tmp1,0,injHius);
add64(tmp3,tmp1);
init64(tmp1,0,parms[vssPulsesPerMileIdx]);
mul64(tmp3,tmp1);

init64(tmp1,0,parms[microSecondsPerGallonIdx]);
init64(tmp2,0,1000);
mul64(tmp1,tmp2);
init64(tmp2,0,vssPulses);
mul64(tmp1,tmp2);

div64(tmp1,tmp3);
return tmp1[1];
}

//return the seconds as a time mmm.ss, eventually hhh:mm too
unsigned long Trip::time(){
// return seconds*1000;
byte d = 60;
unsigned long seconds = loopCount/loopsPerSecond;
// if(seconds/60 > 999) d = 3600; //scale up to hours.minutes if we get past 999 minutes
return ((seconds/d)*1000) + ((seconds%d) * 10);
}

void Trip::reset(){
loopCount=0;
injPulses=0;
injHius=0;
injHiSec=0;
vssPulses=0;
vssPulseLength=0;
}

void Trip::update(Trip t){
loopCount++; //we call update once per loop
vssPulses+=t.vssPulses;
vssPulseLength+=t.vssPulseLength;
if(t.injPulses > 2 && t.injHius<500000){//chasing ghosts
injPulses+=t.injPulses;
injHius+=t.injHius;
if (injHius>=1000000){ //rollover into the injHiSec counter
injHiSec++;
injHius-=1000000;
}
}
}

#ifndef debuguino
char bignumchars1[]={4,1,4,0, 1,4,32,0, 3,3,4,0, 1,3,4,0, 4,2,4,0, 4,3,3,0, 4,3,3,0, 1,1,4,0, 4,3,4,0, 4,3,4,0};
char bignumchars2[]={4,2,4,0, 2,4,2,0, 4,2,2,0, 2,2,4,0, 32,32,4,0, 2,2,4,0, 4,2,4,0, 32,4,32,0, 4,2,4,0, 2,2,4,0};

void bigNum (unsigned long t, char * txt1, char * txt2){
// unsigned long t = 98550ul;//number in thousandths
// unsigned long t = 9855ul;//number in thousandths
// char * txt1="INST";
// char * txt2="MPG ";
char dp = 32;

char * r = "009.99"; //"009.99" "000.99" "000.09"
if(t<=99500){
r=format(t/10); //009.86
dp=5;
}else if(t<=999500){
r=format(t/100); //009.86
}

LCD::gotoXY(0,0);
LCD::print(bignumchars1+(r[2]-'0')*4);
LCD::print(" ");
LCD::print(bignumchars1+(r[4]-'0')*4);
LCD::print(" ");
LCD::print(bignumchars1+(r[5]-'0')*4);
LCD::print(" ");
LCD::print(txt1);

LCD::gotoXY(0,1);
LCD::print(bignumchars2+(r[2]-'0')*4);
LCD::print(" ");
LCD::print(bignumchars2+(r[4]-'0')*4);
LCD::LcdDataWrite(dp);
LCD::print(bignumchars2+(r[5]-'0')*4);
LCD::print(" ");
LCD::print(txt2);
}
#endif
//the standard 64 bit math brings in 5000+ bytes
//these bring in 1214 bytes, and everything is pass by reference
unsigned long zero64[]={0,0};

void init64(unsigned long an[], unsigned long bigPart, unsigned long littlePart ){
an[0]=bigPart;
an[1]=littlePart;
}

//left shift 64 bit "number"
void shl64(unsigned long an[]){
an[0] <<= 1;
if(an[1] & 0x80000000)
an[0]++;
an[1] <<= 1;
}

//right shift 64 bit "number"
void shr64(unsigned long an[]){
an[1] >>= 1;
if(an[0] & 0x1)
an[1]+=0x80000000;
an[0] >>= 1;
}

//add ann to an
void add64(unsigned long an[], unsigned long ann[]){
an[0]+=ann[0];
if(an[1] + ann[1] < ann[1])
an[0]++;
an[1]+=ann[1];
}

//subtract ann from an
void sub64(unsigned long an[], unsigned long ann[]){
an[0]-=ann[0];
if(an[1] < ann[1]){
an[0]--;
}
an[1]-= ann[1];
}

//true if an == ann
boolean eq64(unsigned long an[], unsigned long ann[]){
return (an[0]==ann[0]) && (an[1]==ann[1]);
}

//true if an < ann
boolean lt64(unsigned long an[], unsigned long ann[]){
if(an[0]>ann[0]) return false;
return (an[0]<ann[0]) || (an[1]<ann[1]);
}

//divide num by den
void div64(unsigned long num[], unsigned long den[]){
unsigned long quot[2];
unsigned long qbit[2];
unsigned long tmp[2];
init64(quot,0,0);
init64(qbit,0,1);

if (eq64(num, zero64)) { //numerator 0, call it 0
init64(num,0,0);
return;
}

if (eq64(den, zero64)) { //numerator not zero, denominator 0, infinity in my book.
init64(num,0xffffffff,0xffffffff);
return;
}

init64(tmp,0x80000000,0);
while(lt64(den,tmp)){
shl64(den);
shl64(qbit);
}

while(!eq64(qbit,zero64)){
if(lt64(den,num) || eq64(den,num)){
sub64(num,den);
add64(quot,qbit);
}
shr64(den);
shr64(qbit);
}

//remainder now in num, but using it to return quotient for now
init64(num,quot[0],quot[1]);
}

//multiply num by den
void mul64(unsigned long an[], unsigned long ann[]){
unsigned long p[2] = {0,0};
unsigned long y[2] = {ann[0], ann[1]};
while(!eq64(y,zero64)) {
if(y[1] & 1)
add64(p,an);
shl64(an);
shr64(y);
}
init64(an,p[0],p[1]);
}

void save(){
EEPROM.write(0,guinosig);
byte p = 0;
for(int x=4; p < parmsLength; x+= 4){
unsigned long v = parms[p];
EEPROM.write(x ,(v>>24)&255);
EEPROM.write(x + 1,(v>>16)&255);
EEPROM.write(x + 2,(v>>8)&255);
EEPROM.write(x + 3,(v)&255);
p++;
}
}

byte load(){ //return 1 if loaded ok
byte b = EEPROM.read(0);
if(b == guinosig){
byte p = 0;

for(int x=4; p < parmsLength; x+= 4){
unsigned long v = EEPROM.read(x);
v = (v << 8) + EEPROM.read(x+1);
v = (v << 8) + EEPROM.read(x+2);
v = (v << 8) + EEPROM.read(x+3);
parms[p]=v;
p++;
}
return 1;
}
return 0;
}

char * uformat(unsigned long val){
unsigned long d = 1000000000ul;
for(byte p = 0; p < 10 ; p++){
mBuff[p]='0' + (val/d);
val=val-(val/d*d);
d/=10;
}
mBuff[10]=0;
return mBuff;
}

unsigned long rformat(char * val){
unsigned long d = 1000000000ul;
unsigned long v = 0ul;
for(byte p = 0; p < 10 ; p++){
v=v+(d*(val[p]-'0'));
d/=10;
}
return v;
}

#ifndef debuguino
void editParm(byte parmIdx){
unsigned long v = parms[parmIdx];
byte p=9; //right end of 10 digit number
//display label on top line
//set cursor visible
//set pos = 0
//display v

LCD::gotoXY(8,0);
LCD::print(" ");
LCD::gotoXY(0,0);
LCD::print(parmLabels[parmIdx]);
LCD::gotoXY(0,1);
char * fmtv= uformat(v);
LCD::print(fmtv);
LCD::print(" OK XX");
LCD::LcdCommandWrite(B00001110);

for(int x=9 ; x>=0 ;x--){ //do a nice thing and put the cursor at the first non zero number
if(fmtv[x] != '0')
p=x;
}
byte keyLock=1;
while(true){

if(p<10)
LCD::gotoXY(p,1);
if(p==10)
LCD::gotoXY(11,1);
if(p==11)
LCD::gotoXY(14,1);

if(keyLock == 0){
if(!(buttonState&lbuttonBit)){// left
p=p-1;
if(p==255)p=11;
}else if(!(buttonState&rbuttonBit)){// right
p=p+1;
if(p==12)p=0;
}else if(!(buttonState&mbuttonBit)){// middle
if(p==11){ //cancel selected
LCD::LcdCommandWrite(B00001100);
return;
}
if(p==10){ //ok selected
LCD::LcdCommandWrite(B00001100);
parms[parmIdx]=rformat(fmtv);
return;
}

byte n = fmtv[p]-'0';
n++;
if (n > 9) n=0;
if(p==0 && n > 3) n=0;
fmtv[p]='0'+ n;
LCD::gotoXY(0,1);
LCD::print(fmtv);
LCD::gotoXY(p,1);
if(parmIdx==contrastIdx)//adjust contrast dynamically
analogWrite(ContrastPin,rformat(fmtv));

}

if(buttonState!=buttonsUp)
keyLock=1;
}else{
keyLock=0;
}
buttonState=buttonsUp;
delay2(125);
}

}
#endif

void initGuino(){ //edit all the parameters
#ifndef debuguino
for(int x = 0;x<parmsLength;x++)
editParm(x);
save();
holdDisplay=1;
#endif
}

unsigned long millis2(){
return timer2_overflow_count * 64UL * 2 / (16000000UL / 128000UL);
}

void delay2(unsigned long ms){
unsigned long start = millis2();
while (millis2() - start < ms);
}

/* Delay for the given number of microseconds. Assumes a 16 MHz clock.
* Disables interrupts, which will disrupt the millis2() function if used
* too frequently. */
void delayMicroseconds2(unsigned int us){
uint8_t oldSREG;
if (--us == 0) return;
us <<= 2;
us -= 2;
oldSREG = SREG;
cli();
// busy wait
__asm__ __volatile__ (
"1: sbiw %0,1" "\n\t" // 2 cycles
"brne 1b" : "=w" (us) : "0" (us) // 2 cycles
);
// reenable interrupts.
SREG = oldSREG;
}

void init2(){
// this needs to be called before setup() or some functions won't
// work there
sei();

// timer 0 is used for millis2() and delay2()
timer2_overflow_count = 0;
// on the ATmega168, timer 0 is also used for fast hardware pwm
// (using phase-correct PWM would mean that timer 0 overflowed half as often
// resulting in different millis2() behavior on the ATmega8 and ATmega168)
TCCR2A=1<<WGM20|1<<WGM21;
// set timer 2 prescale factor to 64
TCCR2B=1<<CS22;

// TCCR2A=TCCR0A;
// TCCR2B=TCCR0B;
// enable timer 2 overflow interrupt
TIMSK2|=1<<TOIE2;
// disable timer 0 overflow interrupt
TIMSK0&=!(1<<TOIE0);
}

</pre>
{{default}}

The MPGuino - Arduino Code

2008-09-10T14:49:55Z

Combustor: /* MPGuino.pde Code v.7 */

{{default}}

'''Check here for any updates http://opengauge.googlecode.com/svn/trunk/mpguino/mpguino.pde'''

== MPGuino.pde Code v.701 ==

<pre>

</pre>
{{default}}

MPGuino

2008-09-10T14:49:01Z

Combustor: /* Software & Release notes */

{{default}}
[[Image:MPGuino_Enclosure_mounted.jpg|right|thumb|400px|]]

== Summary ==

This is an impressive use of the Arduino platform. One that will actually pay for itself too. A small group of folks banded together and created an open platform called http://opengauge.googlecode.com where you will not really find much information concerning this device, but there are lots of information in a forum at http://www.ecomodder.com, where you will find tons of useful and fun ways on improving gas mileage for any car. To explain what these folks did for the average working Joe, who can't quite afford a car newer than 1995, is just amazing. It still works for just about any car with fuel injection, but for cars built before 1996, there is no [[OBD-II Diagnostic Tools | OBD-II]] option.

They came up with a way to build a reasonably low-cost device that will gauge your MPG, even for cars that do not have an [[OBD-II Diagnostic Tools | OBD-II]] interface in there car. At the moment it is restricted to use in cars with fuel injection, but given enough time they may even find a way to gauge cars with carburetors. To cut to the chase, this device uses inputs from the Vehicle Speed Sensor(VSS) and one fuel injector control wire, both of which are easily found in just about all fuel injected cars, minus mechanical fuel injection, which only Mercedes seemed to make reliably albeit expensively. So, sorry all those 300E owners, you can't play with this toy right now.

The device sports an LCD screen with many display features that include Current,Instant and Tank MPG as well as Trip data for MPG, Mileage, and Tank Gallons. There are many other options and I recommend you reference the User Guide below for more detail.

== Functional Description of the Solution ==

To further detail the solution, the VSS provides a pulse input related to the speed and distance traveled, meaning from this sensor you know how fast the car is going from the pulse frequency and how far the car has traveled by counting the actual number of pulses. Pulses per mile vary from car to car and based on the forum I saw a range in the 4,000 - 10,000 pulses per mile. The injector control wire provides the fuel flow mass. By making the relation of the known flow rate of an injector and the amount of time that the injector is turned on, you can calculate the the actual fuel mass flow rate your car is using.

On the electronics side they used the Arduino platform as the microprocessor and threw in some supporting components to prevent small fires that create anger and horrible smells. I hate the smell of fried electronics, unfortunately I know it too well. The microprocessor polls the sensors in the micro-second realm, and writes the results to the LCD in the 1/2-1 sec. realm. This gives the user a near real time view of the actual data.

There really is not much at the high level design function, but as they say, "The Devil is in the Details".

== Theory of Operation ==

'''Fuel Injectors'''

To completely simplify a fuel injector, just imagine a water faucet valve. When the valve is open, the water flows out. The amount of water that flows out depends on the size of the faucet opening and the pressure of the water behind the faucet. For a fuel injector, the manufacturers specify a lbs/hr of fuel flow by knowing the opening of the injector and specifying the constant pressure for which the injector supply is supposed to maintain. Therefore, if you provide the proper pressure to the injector as specified and you open the injector for one hour, you should get the specified pounds of fuel flowing out of the injector. For example, a 20 lb/hr injector will supply 20lbs of fuel if left turned on for one hour.

This makes the calculation fairly simple to determine a fuel flow rate for your car by measuring the total amount the injector is open that comes from the Injector Sensor of the MPGuino and it is measured through the pulse width sent to the injector by the car computer. Also known as the injector pulse width. So the total time for each pulse width over a given time is the total time an injector is open. This measurement is usually taken in a second time frame and an injector has a limitation known as a frequency response or a max number of pulses per second, which is related to the mechanical response time that the injector can open or close. The MPGuino measures the total time the injector is open, so we will just take that number as a known measured value.

Ti = Time the injector is open as a ratio of a known time = For calculation purposes we will set it at usec/sec

Fr = Fuel flow rate is a known from the manufacturer in lbs/hr

Therefore:

Fuel usage rate = Fr (lbs/hr) / 3600 (sec/hr) * Ti (usec/sec) /1000 = (lbs/sec)

<math >Fu = \frac{Fr}{3600} * \frac {Ti}{1000}</math >

Example:

Ti = 500 usec/sec as measured by MPGuino

Fr = 20 lbs/hr as specified by manufacturer

<math > Fuel\ usage\ rate = \frac{20}{3600} * \frac{500}{1000} = 0.0028 (lbs/sec)</math >

'''VSS - Vehicle Speed Sensor'''

The VSS count is fairly straight forward. There is a device on your car that rotates and creates a certain number of pulses per revolution. The sensor is usually attached to your transmission and it has a direct gear ratio to your tires that I will call the rolling ratio. This sensor is used to feed the vehicle computer the speed and distance data. The actual gear ratio has only one main variation, and that is the tire diameter. For the MPGuino to calculate the the MPG, this input is critical for determining the distance traveled. The VSS count is typically measured in counts per mile.

'''Theory vs. Reality'''

As with any engineering of a product you will have fudge factors. The important thing to realize is that you always design to get the fundamentals close and then expect to calibrate to meet the accuracy needed for the function. For this product we will evaluate the best way to calibrate and adjust to improve the accuracy of the numbers. This may not be necessary at all if your goal is to get feedback on your driving habits, then the accuracy does not matter, as long as you realize that the MPGuino is changing your driving habits to conserve gas AND best of all save you money.

So first let's discuss the factors that will affect your accuracy.

Factors NOT in our control:

Is it possible to control or measure these factors? yes, is it practical? not in my opinion. So these factors will introduce errors that will need compensation in the fudging process. I feel it is a pretty safe assumption that over time these factors will average within a range that will permit fudging.

''Injector Pressure'' - Your car has a pressure regulator to manage your fuel manifold pressure, and it will regulate to it's setting. You could measure your pressure, but then you would have to know how that affects the fuel flow through the injector. We also do not know how the pressure changes over time and this can affect your fuel flow.

''Injector Efficiency'' - Well, since MPGuino is a device that was targeted to older cars, then you have to expect that injectors tend to clog and become less efficient over time. The only way to calibrate that problem is to measure the actual flow through each injector. Have fun if you want to tackle that project. `,~)

''Rolling Ratio'' - The rolling ratio is a constant changing ratio that will affect your VSS counts per mile. The main reason it changes over time is due to tires. As a tire gets more worn your VSS counts per mile will increase. When you replace that old set of tires with new tires, you will have less counts per mile.

'''Fudging/Calibration process'''

There are two areas I want to focus on to get this system as accurate as possible. Let's consider fudging the fuel flow rate and measuring the VSS counts per mile. I am taking this approach, because measuring the VSS counts is a practical option and it can be done with some accuracy. In contrast the fuel flow rate used to calculate the total fuel usage is not very measurable and therefore should be fudged.

To measure the VSS counts per mile get on the highway and find a mile marker and reset you VSS counts to zero. Drive ten miles as marked by the mile markers and note your VSS counts. Divide by ten to get your VSS counts per mile. Take an average of this process if you really want to nail it down, but I do not feel that is necessary. You may need to test this count every 6-12 months to readjust this number. You can compare your numbers to you odometer, but understand that the odometer does not take into account the tire diameter as accurately as your measurement, but it can be used as a verification that you are in the ball park. The best verification would be if you noticed that you have a fairly repeatable offset from the odometer and your calculation.

To measure the fuel is much more difficult. Really the best way to do measure the fuel would be to drain the tank and run the tank dry of fuel. Now weigh the amount of fuel and put it in the tank. Run the tank dry again and compare the actual fuel usage with the MPGuino. Again do this multiple times and take the average. Personally I would not do this at all, but it is the only real way to get acuracy. For a much more practical method, start a fuel usage log. Go to many different gas pumps and take an average over time. I have noticed that the cheapest gas stations tend to calibrate to the high side of the legal limit, if not actually outside the legal limit. Try to keep a standard procedure, like only filling to the first click off. Compare your fuel usage average to your MPGuino fuel usage average and look for a trend. Now fudge the fuel usage to match.

== Requirements and Knowledge ==

* Basic soldering and electronic building skill
* The following parts list for the Arduino assembly
** 2 5.1v zener diodes
** 1 2n3906 PNP Transistor
** 1 220 ohm resistor
** 2 100k resistors
** 3 tactile switches
** 1 freeduino arduino clone (any arduino can probably be made to work) i.e. an iduino: http://spiffie.org/kits/iduino/ or a Freeduino
** 1 LCD (others might work as well, check pinout and chipset, etc). 16x2 LCD Module While Characters Blue Backlight Or a green one from sparkfun or mouser (a number of folks like the green ones better)
** Sufficient Perfboard
** A case to hold it all together
* Additional parts for the iDuino assembly
** 1 7805 Voltage Regulator
** 1 1n4004 diode
** 330 uf cap
** 1 .1uf cap.
* You will need to find the wires for the VSS on the vehicle computer or control unit.
* If you're lucky you won't need much troubleshooting skills

== Assemble the Electronics ==

Here are the schematics. This should be enough for most of you. There are two assemblies that are possible to build. The Arduino or the iDuino.

Notes:

* The only two output leads for the VSS and the injector, other than that a 12vdc supply, and that is it.
* The Analog pins in this schematic show 0-5 are used as digital I/O, therefore, Analog pin 0 is Digital pin 14 then count up from there.

<big>'''Arduino Assembly Schematic'''</big>

[[Image:MPGuino_Schematic.GIF]]

<big>'''iDuino Assembly Schematic'''</big>

[[Image:iDuino_Schematic.GIF]]

== Enclosures ==

{| Border=1
|+ <big>'''MPGuino Arduino Enclosure Pics - [http://www.hitechcontrols.com/hensel/polycarbonate/smooth/kf8040.htm KF 8040 - Polycarbonate Indoor/Outdoor Enclosures]]'''</big>
|-
|[[Image:MPGuino_Enclosure_Front.jpg|thumb|400px|]]|| [[Image:MPGuino_Enclosure_Inside.jpg|thumb|400px|]] || [[Image:MPGuino_Enclosure_mounted.jpg|thumb|400px|]]
|}

{| Border=1
|+ <big>'''MPGuino iDuino Enclosure Pics - [[http://www.radioshack.com/product/index.jsp?productId=2062280&cp=&sr=1&origkw=project+box&kw=project+box&parentPage=search Radio Shack Enclosure]]'''</big>
|-
| [[Image:MPGuino_iDuino_Front.jpg|thumb|400px|]] || [[Image:MPGuino_iDuino_Inside_Front.jpg|thumb|400px|]] || [[Image:MPGuino_iDuino_Inside_Guts_Front.jpg|thumb|400px|]]
|-
| [[Image:MPGuino_iDuino_Back.jpg|thumb|400px|]] || [[Image:MPGuino_iDuino_Inside_Back.jpg|thumb|400px|]] || [[Image:MPGuino_iDuino_Inside_Guts.jpg|thumb|400px|]]
|}

== User Guide ==

'''Screens'''

1. Instant MPG/Speed
Current MPG/Distance

2. Instant MPG/Speed
Tank MPG/Distance

3. Large font instant MPG

4. Large font current MPG

5. Large font tank MPG

6. Current MPH, MPG, Miles, Gallons

7. Tank MPH, MPG, Miles, Gallons

8. Instant Raw Data (very useful for connection troubleshooting)
Injector open seconds, Injector open microSeconds,
Injector pulse count, Vehicle Speed Sensor pulse count

9. Current trip Raw Data
Injector open seconds, Injector open microSeconds,
Injector pulse count, Vehicle Speed Sensor pulse count

10. Tank trip Raw Data
Injector open seconds, Injector open microSeconds,
Injector pulse count, Vehicle Speed Sensor pulse count

11. CPU Monitor
Max CPU %utilization, Tank running Time mm.ss,
Free Memory (bytes)

'''Start-up Settings'''

There is also a setup screen that displays the first time the program is run and by pressing all three buttons at once. It walks you through the following setup variables. Use left and right buttons to select the digit you wish to change or the OK or Cancel (XX) items. Use middle button to rotate the current digit or select OK or XX if that is where the cursor is. Selecting OK will save the currently displayed value to the current variable and advance to the next variable. Selecting XX will just advance to the next variable.

1. Contrast - This comes up first on a brand new run and changes on the screen are immediate so if you can't see anything try pressing middle button a few times.

2. VSS Pulses/Mile - use this to adjust displayed speed/miles. If the speed/miles displayed on the mpguino is low then decrease this number by the percentage that it is off and vice versa for high readings. Most asian cars will be a multiple of 8204 and GM will be 10000, we are hoping users will contribute model specific data here.

3. MicroSec/Gallon - use this to adjust displayed fuel consumption. You may want to readjust this initially to get a ballpark MPG reading (after VSS Pulses/Mile is deemed accurate), then calibrate it with a couple fillups. If the mpguino displayed MPG is high or the displayed tank gallons is low at fillup then reduce MicroSec/Gallon by the percentage that the gallons are low or the displayed mpg is high. Like the vss pulses, this would benefit from user contributions about what values work for what specific cars.

4. Pulses/2 revs - not currently used, but a single injector on a 4 cylinder sequential system will make 1 squirt in 2 revolutions. Hope to be able to base RPM on this at some point.

5. Timout(microSec) - defaults to 7 minutes. If there are no injector or speed signals from the car and no buttons are pressed in that time then the display backlight turns off. When activity resumes the display will turn back on and the current trip will reset and the tank trip will be restored to the point of last activity.

6. Tank Gal * 1000 - not currently used, but defaults to 13300 or 13.3 gallons.

7. Injector DelayuS - Represents the mechanical delay of the injector in microseconds. Advanced topic.

'''Button Functions'''

1. left: cycle through screeens in reverse

2. middle: cycle through pre-defined brightness settings

3. right: cycle through screeens forward

4. left+middle: tank reset

5. right+middle: current reset

6. left+middle+right: go to setup screen

== Table of Car Settings ==

'''I am looking for data here, if you have a car to add, email me at combustor@combustory.com with the data.'''

{| Border=1
|+ MPGuino Car Settings
! Car Year Make Model !! Engine !! Transmission !! VSS (count/mile) !! usec/gal
|-
|1989 Chevy Celebrity|| 3.1 || 4 spd auto || 4000 || 0240000000
|-
|1990 Mitsubishi Eclipse GST || 2.0 litre || 5 speed || 16364 || 126180393
|-
|1994 Suzuki Swift GA Sedan|| 1.3 Liter || 5 Speed || ???? || ????
|-
|1996 Jeep Wrangler || 4.0 Liter || 5 speed || ???? || ????
|-
|1997 Saturn SL2,SC2,SW2,S2|| 1.9 || || 10000 || 0289967320
|-
|2005 Subaru Impreza Outback Sport, 2.5RS || 2.5L N/A || 5MT || 8000 || 183165000 (still calibrating)
|}

== Software & Release notes ==

Here are the latest release notes as of this writing. Get the latest SW from [[The MPGuino - Arduino Code]]

'''8/9/2008 updates for v0.70'''

More experiments with vss processing. Instant mph is very smooth on saturn but still jumps a bit on the metro. Distance reading on metro appears reasonably accurate (102.6 miles on odo, 102.18 on mpguino using 8208 vsspulses/mile). So the guino is doing a pretty good job of counting the vss pulses, it is a little erratic in timing the pulses though.

want to add EOC miles to the trip next, don't know if it will fit
sketch size: 12884

'''8/1/2008 updates for v0.69'''

Added event handler and added debouncing on vss. Still trying to clean up reed switch vss signal via software with no luck. will make separate post for vss issue.

Added instantaneous mph (mpg is next), this looks at the time between vss peaks to determine the speed instead of the number of pulses in the last half second, which was jumpy at slow speeds. We are getting really really tight on space. That might also be an issue when 0012 comes out (don't know when).

'''8/1/2008 updates for v0.68'''

Removed all dependencies on timer0 so we should be arduino 0012 compatible. This also establishes an ISR under our control for scheduling events. Disabled Timer0 so use millis2(), delay2(), etc.

Knocked off a few hundred bytes by converting LCD to a namespace instead of a class.

'''7/10/2008 updates for v0.67'''

Incorporated LCD timings from Yoshi, removed pin 15 code and power up detection code.

moved source code to google/svn Revision 32: /trunk

other happenings:
did a test with the scope regarding the voltage drop at peak pulse. I had the guino set a pin high and low within the interrupts receiving high and low and the pulse widths were the same except the generated one was perfectly square. So that is a good thing. Will need to test exactly what voltage level is acceptable.

The power supply on the scope died I think I just need a new TL431C or NTE999 though. I didn't get a chance to witness the vss bounce, the scope died during the attempt.

I am planning on moving all timing critical code to timer 2 with an event handler. I need real interrupt style debouncing for the vss and might as well use it as an event scheduler for debouncing the buttons as well as whatever else. This move will also allow for arduino0012 compatability.

'''6/27/2008 updates for v0.66'''

ADDED AN ONBOARD VARIABLE EDITOR!!! VARIABLES STORED IN EEPROM!! Now you can upgrade and not lose your settings and make adjustments in the car. Refer to post 1[/url] for screens and edit usage.

Updated screens descriptions in post 1

Checked source into sourceforge.net, linked post 1 to sourceforge (ran out of room again and wiki didn't like the extension .pde).

Sketch size 11734, 448 bytes free

'''6/26/2008 updates for v0.65'''

Added 7 minute activity timeout. It saves the state of the persistent trips (just tank for now) at the point of last activity and after 7 minutes of no injector pulses/vss pulses/or button presses, it turns off the LED backlight and sets up current to be reset and tank to be restored when activity resumes.

Despazed the buttons and Screen labels so they display for a second and accidental double button presses are minimized.

Running out of excuses (and room) to no do the user input/eprom setup screen thing Sketch size 10502 bytes.

'''6/23/2008 updates for v0.64'''

Fixed instant/tank screen (was displaying instant/current on that screen).

Improved LCD reinit on reprogram/reset. Can (usually) tell if LCD needs reinitializing. Press left and right buttons to force an LCD init if necessary. Want to free pin 15 for future tasks if it works well enough.

Added a bit of default verbiage to debug mode.

Working on a portable scope deal.

'''6/20/2008 updates for v0.63'''

Wrote 64bit arithmetic routines, yay no more messing with "ifs" when it should be math!

Noticed double vss count didn't make it in .62, fixed.

Subtracting 500uS from each injector pulse.

Added cli/sei around top of loop trip copy.

Made big font a smidgeon bolder.

Code updated, sketch size 9812, CPU 54%, free mem 602
[[Category:Electronics]]

The Arduino Code

2008-09-10T14:48:09Z

Combustor: The Arduino Code moved to The MPGuino - Arduino Code

#REDIRECT [[The MPGuino - Arduino Code]]

The MPGuino - Arduino Code

2008-09-10T14:48:08Z

Combustor: The Arduino Code moved to The MPGuino - Arduino Code

{{default}}

'''Check here for any updates http://opengauge.googlecode.com/svn/trunk/mpguino/mpguino.pde'''

== MPGuino.pde Code v.7 ==

<pre>
#define ver=700
/*

*/
//GPL Software
//#define debuguino youbetyourbippy
#include <avr/pgmspace.h>
byte brightness[]={0,42,85,128}; //middle button cycles through these brightness settings
#define brightnessLength (sizeof(brightness)/sizeof(byte)) //array size
byte brightnessIdx=1;

#define contrastIdx 0 //do contrast first to get display dialed in
#define vssPulsesPerMileIdx 1
#define microSecondsPerGallonIdx 2
#define injPulsesPer2Revolutions 3
#define currentTripResetTimeoutUSIdx 4
#define tankSizeIdx 5
#define injectorSettleTimeIdx 6
#define weightIdx 7
#define scratchpadIdx 8
char * parmLabels[]={"Contrast","VSS Pulses/Mile", "MicroSec/Gallon","Pulses/2 revs","Timout(microSec)","Tank Gal * 1000","Injector DelayuS","Weight (lbs)","scratchpad(odo?)"};
//unsigned long parms[]={15ul,16408ul,684968626ul,3ul,420000000ul,13300ul,500ul};//default values
unsigned long parms[]={15ul,10000ul,304409714ul,4ul,420000000ul,13300ul,500ul,2400ul,0ul,};//default values
#define parmsLength (sizeof(parms)/sizeof(unsigned long)) //array size

#define guinosig B10100101
#include <EEPROM.h>
//Vehicle Interface Pins
#define InjectorOpenPin 2
#define InjectorClosedPin 3
#define VSSPin 14 //analog 0

//LCD Pins
#define DIPin 4 // register select RS
#define DB4Pin 7
#define DB5Pin 8
#define DB6Pin 12
#define DB7Pin 13
#define ContrastPin 6
#define EnablePin 5
#define BrightnessPin 9

#define lbuttonPin 17 // Left Button, on analog 3,
#define mbuttonPin 18 // Middle Button, on analog 4
#define rbuttonPin 19 // Right Button, on analog 5

#define vssBit 1 // pin14 is a bitmask 1 on port C
#define lbuttonBit 8 // pin17 is a bitmask 8 on port C
#define mbuttonBit 16 // pin18 is a bitmask 16 on port C
#define rbuttonBit 32 // pin19 is a bitmask 32 on port C
#define loopsPerSecond 2 // how many times will we try and loop in a second

typedef void (* pFunc)(void);//type for display function pointers

volatile unsigned long timer2_overflow_count;

/*** Set up the Events ***
We have our own ISR for timer2 which gets called about once a millisecond.
So we define certain event functions that we can schedule by calling addEvent
with the event ID and the number of milliseconds to wait before calling the event.
The milliseconds is approximate.

Keep the event functions SMALL!!! This is an interrupt!

*/
//event functions

void enableLButton(){PCMSK1 |= (1 << PCINT11);}
void enableMButton(){PCMSK1 |= (1 << PCINT12);}
void enableRButton(){PCMSK1 |= (1 << PCINT13);}
//array of the event functions
pFunc eventFuncs[] ={enableVSS, enableLButton,enableMButton,enableRButton};
#define eventFuncSize (sizeof(eventFuncs)/sizeof(pFunc))
//define the event IDs
#define enableVSSID 0
#define enableLButtonID 1
#define enableMButtonID 2
#define enableRButtonID 3
//ms counters
unsigned int eventFuncCounts[eventFuncSize];

//schedule an event to occur ms milliseconds from now
void addEvent(byte eventID, unsigned int ms){
eventFuncCounts[eventID]=ms;
}

/* this ISR gets called every 1.024 milliseconds, we will call that a millisecond for our purposes
go through all the event counts,
if any are non zero subtract 1 and call the associated function if it just turned zero. */
ISR(TIMER2_OVF_vect){
timer2_overflow_count++;
for(byte eventID = 0; eventID < eventFuncSize; eventID++){
if(eventFuncCounts[eventID]!= 0){
eventFuncCounts[eventID]--;
if(eventFuncCounts[eventID] == 0)
eventFuncs[eventID]();
}
}
}

unsigned long maxLoopLength = 0; //see if we are overutilizing the CPU

#define buttonsUp lbuttonBit + mbuttonBit + rbuttonBit // start with the buttons in the right state
byte buttonState = buttonsUp;

//overflow counter used by millis2()
unsigned long lastMicroSeconds=millis2() * 1000;
unsigned long microSeconds (void){
unsigned long tmp_timer2_overflow_count;
unsigned long tmp;
byte tmp_tcnt2;
cli(); //disable interrupts
tmp_timer2_overflow_count = timer2_overflow_count;
tmp_tcnt2 = TCNT2;
sei(); // enable interrupts
tmp = ((tmp_timer2_overflow_count << 8) + tmp_tcnt2) * 4;
if((tmp<=lastMicroSeconds) && (lastMicroSeconds<4290560000ul))
return microSeconds();
lastMicroSeconds=tmp;
return tmp;
}

unsigned long elapsedMicroseconds(unsigned long startMicroSeconds, unsigned long currentMicroseconds ){
if(currentMicroseconds >= startMicroSeconds)
return currentMicroseconds-startMicroSeconds;
return 4294967295 - (startMicroSeconds-currentMicroseconds);
}

unsigned long elapsedMicroseconds(unsigned long startMicroSeconds ){
return elapsedMicroseconds(startMicroSeconds, microSeconds());
}

//Trip prototype
class Trip{
public:
unsigned long loopCount; //how long has this trip been running
unsigned long injPulses; //rpm
unsigned long injHiSec;// seconds the injector has been open
unsigned long injHius;// microseconds, fractional part of the injectors open
unsigned long vssPulses;//from the speedo
//these functions actually return in thousandths,
unsigned long miles();
unsigned long gallons();
unsigned long mpg();
unsigned long mph();
unsigned long time(); //mmm.ss
void update(Trip t);
void reset();
Trip();
};

//LCD prototype
namespace LCD{
void gotoXY(byte x, byte y);
void print(char * string);
void init();
void tickleEnable();
void cmdWriteSet();
void LcdCommandWrite(byte value);
void LcdDataWrite(byte value);
byte pushNibble(byte value);
};

//main objects we will be working with:
unsigned long injHiStart; //for timing injector pulses
Trip tmpTrip;
Trip instant;
Trip current;
Trip tank;

void processInjOpen(void){
injHiStart = microSeconds();
}

void processInjClosed(void){
long x = elapsedMicroseconds(injHiStart)- parms[injectorSettleTimeIdx];
if(x >0)
tmpTrip.injHius += x;
tmpTrip.injPulses++;
}

volatile boolean vssFlop = 0;

void enableVSS(){
tmpTrip.vssPulses++;
vssFlop = !vssFlop;
}

unsigned volatile long lastVSS1;
unsigned volatile long lastVSSTime;
unsigned volatile long lastVSS2;

volatile boolean lastVssFlop = vssFlop;

//attach the vss/buttons interrupt
ISR( PCINT1_vect ){
static byte vsspinstate=0;
byte p = PINC;//bypassing digitalRead for interrupt performance
if ((p & vssBit) != (vsspinstate & vssBit)){
addEvent(enableVSSID,2 ); //check back in a couple milli
}
if(lastVssFlop != vssFlop){
lastVSS1=lastVSS2;
unsigned long t = microSeconds();
lastVSS2=elapsedMicroseconds(lastVSSTime,t);
lastVSSTime=t;
lastVssFlop = vssFlop;
}
vsspinstate = p;
buttonState &= p;
}

pFunc displayFuncs[] ={
doDisplayInstantCurrent,
doDisplayInstantTank,
doDisplayBigInstant,
doDisplayBigCurrent,
doDisplayBigTank,
doDisplay2,
doDisplay3,
doDisplay4,
doDisplay5,
doDisplay6,
doDisplay7};
#define displayFuncSize (sizeof(displayFuncs)/sizeof(pFunc)) //array size
prog_char * displayFuncNames[displayFuncSize];
byte newRun = 0;
void setup (void){
init2();
#ifdef debuguino
Serial.begin(9600);
Serial.println("OpenGauge MPGuino online");
#endif
newRun = load();//load the default parameters
displayFuncNames[0]= PSTR("Instant/Current ");
displayFuncNames[1]= PSTR("Instant/Tank ");
displayFuncNames[2]= PSTR("BIG Instant ");
displayFuncNames[3]= PSTR("BIG Current ");
displayFuncNames[4]= PSTR("BIG Tank ");
displayFuncNames[5]= PSTR("Current ");
displayFuncNames[6]= PSTR("Tank ");
displayFuncNames[7]= PSTR("Instant raw Data");
displayFuncNames[8]= PSTR("Current raw Data");
displayFuncNames[9]= PSTR("Tank raw Data ");
displayFuncNames[10]= PSTR("CPU Monitor ");

pinMode(BrightnessPin,OUTPUT);
analogWrite(BrightnessPin,255-brightness[brightnessIdx]);
pinMode(EnablePin,OUTPUT);
pinMode(DIPin,OUTPUT);
pinMode(DB4Pin,OUTPUT);
pinMode(DB5Pin,OUTPUT);
pinMode(DB6Pin,OUTPUT);
pinMode(DB7Pin,OUTPUT);
delay2(500);

pinMode(ContrastPin,OUTPUT);
analogWrite(ContrastPin,parms[contrastIdx]);
LCD::init();
LCD::LcdCommandWrite(B00000001); // clear display, set cursor position to zero
LCD::LcdCommandWrite(B10000000); // set dram to zero
LCD::gotoXY(0,0);
LCD::print(getStr(PSTR("OpenGauge ")));
LCD::gotoXY(0,1);
LCD::print(getStr(PSTR(" MPGuino v0.70")));

pinMode(InjectorOpenPin, INPUT);
pinMode(InjectorClosedPin, INPUT);
pinMode(VSSPin, INPUT);
attachInterrupt(0, processInjOpen, FALLING);
attachInterrupt(1, processInjClosed, RISING);

pinMode( lbuttonPin, INPUT );
pinMode( mbuttonPin, INPUT );
pinMode( rbuttonPin, INPUT );

//"turn on" the internal pullup resistors
digitalWrite( lbuttonPin, HIGH);
digitalWrite( mbuttonPin, HIGH);
digitalWrite( rbuttonPin, HIGH);
// digitalWrite( VSSPin, HIGH);

//low level interrupt enable stuff
PCMSK1 |= (1 << PCINT8);
enableLButton();
enableMButton();
enableRButton();
PCICR |= (1 << PCIE1);

delay2(1500);
}

byte screen=0;
byte holdDisplay = 0;

#define looptime 1000000ul/loopsPerSecond //1/2 second
void loop (void){
if(newRun !=1)
initGuino();//go through the initialization screen
unsigned long lastActivity =microSeconds();
unsigned long tankHold; //state at point of last activity
while(true){
unsigned long loopStart=microSeconds();
instant.reset(); //clear instant
cli();
instant.update(tmpTrip); //"copy" of tmpTrip in instant now
tmpTrip.reset(); //reset tmpTrip first so we don't lose too many interrupts
sei();

#ifdef debuguino
Serial.print("instant: ");Serial.print(instant.injHiSec);Serial.print(",");Serial.print(instant.injHius);
Serial.print(",");Serial.print(instant.injPulses);Serial.print(",");Serial.println(instant.vssPulses);
#endif
current.update(instant); //use instant to update current
tank.update(instant); //use instant to update tank
#ifdef debuguino
Serial.print("current: ");Serial.print(current.injHiSec);Serial.print(",");Serial.print(current.injHius);
Serial.print(",");Serial.print(current.injPulses);Serial.print(",");Serial.println(current.vssPulses);
#endif

//currentTripResetTimeoutUS
if(instant.vssPulses == 0 && instant.injPulses == 0 && holdDisplay==0){
if(elapsedMicroseconds(lastActivity) > parms[currentTripResetTimeoutUSIdx] && lastActivity != 3999999999ul){
analogWrite(BrightnessPin,255-brightness[0]); //nitey night
lastActivity = 3999999999ul;
}
}else{
if(lastActivity == 3999999999ul){//wake up!!!
analogWrite(BrightnessPin,255-brightness[brightnessIdx]);
lastActivity=loopStart;
current.reset();
tank.loopCount = tankHold;
current.update(instant);
tank.update(instant);
}else{
lastActivity=loopStart;
tankHold = tank.loopCount;
}
}

if(holdDisplay==0){
displayFuncs[screen](); //call the appropriate display routine
LCD::gotoXY(0,0);

//see if any buttons were pressed, display a brief message if so
if(!(buttonState&lbuttonBit) && !(buttonState&mbuttonBit)&& !(buttonState&rbuttonBit)){// left and middle and right = initialize
LCD::print(getStr(PSTR("Setup ")));
initGuino();
//}else if(!(buttonState&lbuttonBit) && !(buttonState&rbuttonBit)){// left and right = run lcd init = tank reset
// LCD::print(getStr(PSTR("Init LCD ")));
// LCD::init();
}else if (!(buttonState&lbuttonBit) && !(buttonState&mbuttonBit)){// left and middle = tank reset
tank.reset();
LCD::print(getStr(PSTR("Tank Reset ")));
}else if(!(buttonState&mbuttonBit) && !(buttonState&rbuttonBit)){// right and middle = current reset
current.reset();
LCD::print(getStr(PSTR("Current Reset ")));
}else if(!(buttonState&lbuttonBit)){ //left is rotate through screeens to the left
if(screen!=0)
screen=(screen-1);
else
screen=displayFuncSize-1;
LCD::print(getStr(displayFuncNames[screen]));
}else if(!(buttonState&mbuttonBit)){ //middle is cycle through brightness settings
brightnessIdx = (brightnessIdx + 1) % brightnessLength;
analogWrite(BrightnessPin,255-brightness[brightnessIdx]);
LCD::print(getStr(PSTR("Brightness ")));
LCD::LcdDataWrite('0' + brightnessIdx);
LCD::print(" ");
}else if(!(buttonState&rbuttonBit)){//right is rotate through screeens to the left
screen=(screen+1)%displayFuncSize;
LCD::print(getStr(displayFuncNames[screen]));
}
if(buttonState!=buttonsUp)
holdDisplay=1;
}else{
holdDisplay=0;
}
buttonState=buttonsUp;//reset the buttons

//keep track of how long the loops take before we go int waiting.
unsigned long loopX=elapsedMicroseconds(loopStart);
if(loopX>maxLoopLength) maxLoopLength = loopX;

while (elapsedMicroseconds(loopStart) < (looptime));//wait for the end of a second to arrive
}

}

char fBuff[7];//used by format
//format a number into NNN.NN the number should already be representing thousandths
char* format(unsigned long num){
unsigned long d = 10000;
long t;
byte dp=3;
byte l=6;

//123456 = 123.46
if(num>9999999){
d=100000;
dp=99;
num/=100;
}else if(num>999999){
dp=4;
num/=10;
}

unsigned long val = num/10;
if ((num - (val * 10)) >= 5) //will the first unprinted digit be greater than 4?
val += 1; //round up val

for(byte x = 0; x < l; x++){
if(x==dp) //time to poke in the decimal point?
fBuff[x]='.';
else{
t = val/d;
fBuff[x]= '0' + t%10;//poke the ascii character for the digit.
val-= t*d;
d/=10;
}
}
fBuff[6]= 0; //good old zero terminated strings
return fBuff;
}

//get a string from flash
char mBuff[17];//used by getStr
char * getStr(prog_char * str){
strcpy_P(mBuff, str);
return mBuff;
}

void doDisplayInstantCurrent(){displayTripCombo('I','M',instant.mpg(),'S',instantmph(),'C','M',current.mpg(),'D',current.miles());}

void doDisplayInstantTank(){displayTripCombo('I','M',instant.mpg(),'S',instantmph(),'T','M',tank.mpg(),'D',tank.miles());}

void doDisplayBigInstant() {bigNum(instant.mpg(),"INST","MPG ");}
void doDisplayBigCurrent() {bigNum(current.mpg(),"CURR","MPG ");}
void doDisplayBigTank() {bigNum(tank.mpg(),"TANK","MPG ");}

void doDisplay2(void){tDisplay(&current);} //display current trip formatted data.
void doDisplay3(void){tDisplay(&tank);} //display tank trip formatted data.
void doDisplay4(void){rawDisplay(&instant);} //display instant trip "raw" injector and vss data.
void doDisplay5(void){rawDisplay(&current);} //display current trip "raw" injector and vss data.
void doDisplay6(void){rawDisplay(&tank);} //display tank trip "raw" injector and vss data.
void doDisplay7(void){
LCD::gotoXY(0,0);LCD::print("C%");LCD::print(format(maxLoopLength*1000/(looptime/100)));LCD::print(" T"); LCD::print(format(tank.time()));
unsigned long mem = memoryTest();
mem*=1000;
LCD::gotoXY(0,1);LCD::print("FREE MEM: ");LCD::print(format(mem));
} //display max cpu utilization and ram.

void displayTripCombo(char t1, char t1L1, unsigned long t1V1, char t1L2, unsigned long t1V2, char t2, char t2L1, unsigned long t2V1, char t2L2, unsigned long t2V2){
LCD::gotoXY(0,0);LCD::LcdDataWrite(t1);LCD::LcdDataWrite(t1L1);LCD::print(format(t1V1));LCD::LcdDataWrite(' ');
LCD::LcdDataWrite(t1L2);LCD::print(format(t1V2));
LCD::gotoXY(0,1);LCD::LcdDataWrite(t2);LCD::LcdDataWrite(t2L1);LCD::print(format(t2V1));LCD::LcdDataWrite(' ');
LCD::LcdDataWrite(t2L2);LCD::print(format(t2V2));
}

//arduino doesn't do well with types defined in a script as parameters, so have to pass as void * and use -> notation.
void tDisplay( void * r){ //display trip functions.
Trip *t = (Trip *)r;
LCD::gotoXY(0,0);LCD::print("MH");LCD::print(format(t->mph()));LCD::print("MG");LCD::print(format(t->mpg()));
LCD::gotoXY(0,1);LCD::print("MI");LCD::print(format(t->miles()));LCD::print("GA");LCD::print(format(t->gallons()));
}

void rawDisplay(void * r){
Trip *t = (Trip *)r;
LCD::gotoXY(0,0);LCD::print("IJ");LCD::print(format(t->injHiSec*1000));LCD::print("uS");LCD::print(format(t->injHius*1000));
LCD::gotoXY(0,1);LCD::print("IC");LCD::print(format(t->injPulses*1000));LCD::print("VC");LCD::print(format(t->vssPulses*1000));
}

//x=0..16, y= 0..1
void LCD::gotoXY(byte x, byte y){
byte dr=x+0x80;
if (y==1)
dr += 0x40;
if (y==2)
dr += 0x14;
if (y==3)
dr += 0x54;
LCD::LcdCommandWrite(dr);
}

void LCD::print(char * string){
byte x = 0;
char c = string[x];
while(c != 0){
LCD::LcdDataWrite(c);
x++;
c = string[x];
}
}

void LCD::init(){
delay2(16); // wait for more than 15 msec
pushNibble(B00110000); // send (B0011) to DB7-4
cmdWriteSet();
tickleEnable();
delay2(5); // wait for more than 4.1 msec
pushNibble(B00110000); // send (B0011) to DB7-4
cmdWriteSet();
tickleEnable();
delay2(1); // wait for more than 100 usec
pushNibble(B00110000); // send (B0011) to DB7-4
cmdWriteSet();
tickleEnable();
delay2(1); // wait for more than 100 usec
pushNibble(B00100000); // send (B0010) to DB7-4 for 4bit
cmdWriteSet();
tickleEnable();
delay2(1); // wait for more than 100 usec
// ready to use normal LcdCommandWrite() function now!
LcdCommandWrite(B00101000); // 4-bit interface, 2 display lines, 5x8 font
LcdCommandWrite(B00001100); // display control:
LcdCommandWrite(B00000110); // entry mode set: increment automatically, no display shift

//creating the custom fonts:
LcdCommandWrite(B01001000); // set cgram
static byte chars[] PROGMEM ={
B11111,B00000,B11111,B11111,B00000,
B11111,B00000,B11111,B11111,B00000,
B11111,B00000,B11111,B11111,B00000,
B00000,B00000,B00000,B11111,B00000,
B00000,B00000,B00000,B11111,B00000,
B00000,B11111,B11111,B11111,B01110,
B00000,B11111,B11111,B11111,B01110,
B00000,B11111,B11111,B11111,B01110};

for(byte x=0;x<5;x++)
for(byte y=0;y<8;y++)
LcdDataWrite(pgm_read_byte(&chars[y*5+x])); //write the character data to the character generator ram

LcdCommandWrite(B00000001); // clear display, set cursor position to zero
LcdCommandWrite(B10000000); // set dram to zero

}

void LCD::tickleEnable(){
// send a pulse to enable
digitalWrite(EnablePin,HIGH);
delayMicroseconds2(1); // pause 1 ms according to datasheet
digitalWrite(EnablePin,LOW);
delayMicroseconds2(1); // pause 1 ms according to datasheet
}

void LCD::cmdWriteSet(){
digitalWrite(EnablePin,LOW);
delayMicroseconds2(1); // pause 1 ms according to datasheet
digitalWrite(DIPin,0);
}

byte LCD::pushNibble(byte value){
digitalWrite(DB7Pin, value & 128);
value <<= 1;
digitalWrite(DB6Pin, value & 128);
value <<= 1;
digitalWrite(DB5Pin, value & 128);
value <<= 1;
digitalWrite(DB4Pin, value & 128);
value <<= 1;
return value;
}

void LCD::LcdCommandWrite(byte value){
value=pushNibble(value);
cmdWriteSet();
tickleEnable();
value=pushNibble(value);
cmdWriteSet();
tickleEnable();
delay2(5);
}

void LCD::LcdDataWrite(byte value){
digitalWrite(DIPin, HIGH);
value=pushNibble(value);
tickleEnable();
value=pushNibble(value);
tickleEnable();
delay2(5);
}

// this function will return the number of bytes currently free in RAM
extern int __bss_end;
extern int *__brkval;
int memoryTest(){
int free_memory;
if((int)__brkval == 0)
free_memory = ((int)&free_memory) - ((int)&__bss_end);
else
free_memory = ((int)&free_memory) - ((int)__brkval);
return free_memory;
}

Trip::Trip(){
}

//for display computing
unsigned long tmp1[2];
unsigned long tmp2[2];
unsigned long tmp3[2];

unsigned long instantmph(){
cli();
unsigned long vssPulseTimeuS = (lastVSS1 + lastVSS2) / 2;
sei();
init64(tmp1,0,1000000000ul);
init64(tmp2,0,parms[vssPulsesPerMileIdx]);
div64(tmp1,tmp2);
init64(tmp2,0,3600);
mul64(tmp1,tmp2);
init64(tmp2,0,vssPulseTimeuS);
div64(tmp1,tmp2);
return tmp1[1];
}

unsigned long instantmpg(){
cli();
unsigned long vssPulseTimeuS = (lastVSS1 + lastVSS2) / 2;
sei();
init64(tmp1,0,1000000000ul);
init64(tmp2,0,parms[vssPulsesPerMileIdx]);
div64(tmp1,tmp2);
init64(tmp2,0,3600);
mul64(tmp1,tmp2);
init64(tmp2,0,vssPulseTimeuS);
div64(tmp1,tmp2);
// return tmp1[1];

init64(tmp1,0,instant.injHiSec);
init64(tmp2,0,1000000);
mul64(tmp1,tmp2);
init64(tmp2,0,instant.injHius);
add64(tmp1,tmp2);
init64(tmp2,0,1000);
mul64(tmp1,tmp2);
init64(tmp2,0,parms[microSecondsPerGallonIdx]);
div64(tmp1,tmp2);
return tmp1[1];

}

unsigned long Trip::miles(){
init64(tmp1,0,vssPulses);
init64(tmp2,0,1000);
mul64(tmp1,tmp2);
init64(tmp2,0,parms[vssPulsesPerMileIdx]);
div64(tmp1,tmp2);
return tmp1[1];
}

unsigned long Trip::mph(){
if(loopCount == 0)
return 0;
init64(tmp1,0,loopsPerSecond);
init64(tmp2,0,vssPulses);
mul64(tmp1,tmp2);
init64(tmp2,0,3600000);
mul64(tmp1,tmp2);
init64(tmp2,0,parms[vssPulsesPerMileIdx]);
div64(tmp1,tmp2);
init64(tmp2,0,loopCount);
div64(tmp1,tmp2);
return tmp1[1];
}

unsigned long Trip::gallons(){
init64(tmp1,0,injHiSec);
init64(tmp2,0,1000000);
mul64(tmp1,tmp2);
init64(tmp2,0,injHius);
add64(tmp1,tmp2);
init64(tmp2,0,1000);
mul64(tmp1,tmp2);
init64(tmp2,0,parms[microSecondsPerGallonIdx]);
div64(tmp1,tmp2);
return tmp1[1];
}

unsigned long Trip::mpg(){
if(vssPulses==0) return 0;
if(injPulses==0) return 999999000; //who doesn't like to see 999999? :)

init64(tmp1,0,injHiSec);
init64(tmp3,0,1000000);
mul64(tmp3,tmp1);
init64(tmp1,0,injHius);
add64(tmp3,tmp1);
init64(tmp1,0,parms[vssPulsesPerMileIdx]);
mul64(tmp3,tmp1);

init64(tmp1,0,parms[microSecondsPerGallonIdx]);
init64(tmp2,0,1000);
mul64(tmp1,tmp2);
init64(tmp2,0,vssPulses);
mul64(tmp1,tmp2);

div64(tmp1,tmp3);
return tmp1[1];
}

//return the seconds as a time mmm.ss, eventually hhh:mm too
unsigned long Trip::time(){
// return seconds*1000;
byte d = 60;
unsigned long seconds = loopCount/loopsPerSecond;
// if(seconds/60 > 999) d = 3600; //scale up to hours.minutes if we get past 999 minutes
return ((seconds/d)*1000) + ((seconds%d) * 10);
}

void Trip::reset(){
loopCount=0;
injPulses=0;
injHius=0;
injHiSec=0;
vssPulses=0;
}

void Trip::update(Trip t){
loopCount++; //we call update once per loop
vssPulses+=t.vssPulses;
if(t.injPulses > 2 && t.injHius<500000){//chasing ghosts
injPulses+=t.injPulses;
injHius+=t.injHius;
if (injHius>=1000000){ //rollover into the injHiSec counter
injHiSec++;
injHius-=1000000;
}
}
}

char bignumchars1[]={4,1,4,0, 1,4,32,0, 3,3,4,0, 1,3,4,0, 4,2,4,0, 4,3,3,0, 4,3,3,0, 1,1,4,0, 4,3,4,0, 4,3,4,0};
char bignumchars2[]={4,2,4,0, 2,4,2,0, 4,2,2,0, 2,2,4,0, 32,32,4,0, 2,2,4,0, 4,2,4,0, 32,4,32,0, 4,2,4,0, 2,2,4,0};

void bigNum (unsigned long t, char * txt1, char * txt2){
// unsigned long t = 98550ul;//number in thousandths
// unsigned long t = 9855ul;//number in thousandths
// char * txt1="INST";
// char * txt2="MPG ";
char dp = 32;

char * r = "009.99"; //"009.99" "000.99" "000.09"
if(t<=99500){
r=format(t/10); //009.86
dp=5;
}else if(t<=999500){
r=format(t/100); //009.86
}

LCD::gotoXY(0,0);
LCD::print(bignumchars1+(r[2]-'0')*4);
LCD::print(" ");
LCD::print(bignumchars1+(r[4]-'0')*4);
LCD::print(" ");
LCD::print(bignumchars1+(r[5]-'0')*4);
LCD::print(" ");
LCD::print(txt1);

LCD::gotoXY(0,1);
LCD::print(bignumchars2+(r[2]-'0')*4);
LCD::print(" ");
LCD::print(bignumchars2+(r[4]-'0')*4);
LCD::LcdDataWrite(dp);
LCD::print(bignumchars2+(r[5]-'0')*4);
LCD::print(" ");
LCD::print(txt2);
}

//the standard 64 bit math brings in 5000+ bytes
//these bring in 1214 bytes, and everything is pass by reference
unsigned long zero64[]={0,0};

void init64(unsigned long an[], unsigned long bigPart, unsigned long littlePart ){
an[0]=bigPart;
an[1]=littlePart;
}

//left shift 64 bit "number"
void shl64(unsigned long an[]){
an[0] <<= 1;
if(an[1] & 0x80000000)
an[0]++;
an[1] <<= 1;
}

//right shift 64 bit "number"
void shr64(unsigned long an[]){
an[1] >>= 1;
if(an[0] & 0x1)
an[1]+=0x80000000;
an[0] >>= 1;
}

//add ann to an
void add64(unsigned long an[], unsigned long ann[]){
an[0]+=ann[0];
if(an[1] + ann[1] < ann[1])
an[0]++;
an[1]+=ann[1];
}

//subtract ann from an
void sub64(unsigned long an[], unsigned long ann[]){
an[0]-=ann[0];
if(an[1] < ann[1]){
an[0]--;
}
an[1]-= ann[1];
}

//true if an == ann
boolean eq64(unsigned long an[], unsigned long ann[]){
return (an[0]==ann[0]) && (an[1]==ann[1]);
}

//true if an < ann
boolean lt64(unsigned long an[], unsigned long ann[]){
if(an[0]>ann[0]) return false;
return (an[0]<ann[0]) || (an[1]<ann[1]);
}

//divide num by den
void div64(unsigned long num[], unsigned long den[]){
unsigned long quot[2];
unsigned long qbit[2];
unsigned long tmp[2];
init64(quot,0,0);
init64(qbit,0,1);

if (eq64(num, zero64)) { //numerator 0, call it 0
init64(num,0,0);
return;
}

if (eq64(den, zero64)) { //numerator not zero, denominator 0, infinity in my book.
init64(num,0xffffffff,0xffffffff);
return;
}

init64(tmp,0x80000000,0);
while(lt64(den,tmp)){
shl64(den);
shl64(qbit);
}

while(!eq64(qbit,zero64)){
if(lt64(den,num) || eq64(den,num)){
sub64(num,den);
add64(quot,qbit);
}
shr64(den);
shr64(qbit);
}

//remainder now in num, but using it to return quotient for now
init64(num,quot[0],quot[1]);
}

//multiply num by den
void mul64(unsigned long an[], unsigned long ann[]){
unsigned long p[2] = {0,0};
unsigned long y[2] = {ann[0], ann[1]};
while(!eq64(y,zero64)) {
if(y[1] & 1)
add64(p,an);
shl64(an);
shr64(y);
}
init64(an,p[0],p[1]);
}

void save(){
EEPROM.write(0,guinosig);
byte p = 0;
for(int x=4; p < parmsLength; x+= 4){
unsigned long v = parms[p];
EEPROM.write(x ,(v>>24)&255);
EEPROM.write(x + 1,(v>>16)&255);
EEPROM.write(x + 2,(v>>8)&255);
EEPROM.write(x + 3,(v)&255);
p++;
}
}

byte load(){ //return 1 if loaded ok
byte b = EEPROM.read(0);
if(b == guinosig){
byte p = 0;

for(int x=4; p < parmsLength; x+= 4){
unsigned long v = EEPROM.read(x);
v = (v << 8) + EEPROM.read(x+1);
v = (v << 8) + EEPROM.read(x+2);
v = (v << 8) + EEPROM.read(x+3);
parms[p]=v;
p++;
}
return 1;
}
return 0;
}

char * uformat(unsigned long val){
unsigned long d = 1000000000ul;
for(byte p = 0; p < 10 ; p++){
mBuff[p]='0' + (val/d);
val=val-(val/d*d);
d/=10;
}
mBuff[10]=0;
return mBuff;
}

unsigned long rformat(char * val){
unsigned long d = 1000000000ul;
unsigned long v = 0ul;
for(byte p = 0; p < 10 ; p++){
v=v+(d*(val[p]-'0'));
d/=10;
}
return v;
}

void editParm(byte parmIdx){
unsigned long v = parms[parmIdx];
byte p=9; //right end of 10 digit number
//display label on top line
//set cursor visible
//set pos = 0
//display v

LCD::gotoXY(8,0);
LCD::print(" ");
LCD::gotoXY(0,0);
LCD::print(parmLabels[parmIdx]);
LCD::gotoXY(0,1);
char * fmtv= uformat(v);
LCD::print(fmtv);
LCD::print(" OK XX");
LCD::LcdCommandWrite(B00001110);

for(int x=9 ; x>=0 ;x--){ //do a nice thing and put the cursor at the first non zero number
if(fmtv[x] != '0')
p=x;
}
byte keyLock=1;
while(true){

if(p<10)
LCD::gotoXY(p,1);
if(p==10)
LCD::gotoXY(11,1);
if(p==11)
LCD::gotoXY(14,1);

if(keyLock == 0){
if(!(buttonState&lbuttonBit)){// left
p=p-1;
if(p==255)p=11;
}else if(!(buttonState&rbuttonBit)){// right
p=p+1;
if(p==12)p=0;
}else if(!(buttonState&mbuttonBit)){// middle
if(p==11){ //cancel selected
LCD::LcdCommandWrite(B00001100);
return;
}
if(p==10){ //ok selected
LCD::LcdCommandWrite(B00001100);
parms[parmIdx]=rformat(fmtv);
return;
}

byte n = fmtv[p]-'0';
n++;
if (n > 9) n=0;
if(p==0 && n > 3) n=0;
fmtv[p]='0'+ n;
LCD::gotoXY(0,1);
LCD::print(fmtv);
LCD::gotoXY(p,1);
if(parmIdx==contrastIdx)//adjust contrast dynamically
analogWrite(ContrastPin,rformat(fmtv));

}

if(buttonState!=buttonsUp)
keyLock=1;
}else{
keyLock=0;
}
buttonState=buttonsUp;
delay2(125);
}

}

void initGuino(){ //edit all the parameters
for(int x = 0;x<parmsLength;x++)
editParm(x);
save();
holdDisplay=1;
}

unsigned long millis2(){
return timer2_overflow_count * 64UL * 2 / (16000000UL / 128000UL);
}

void delay2(unsigned long ms){
unsigned long start = millis2();
while (millis2() - start < ms);
}

/* Delay for the given number of microseconds. Assumes a 16 MHz clock.
* Disables interrupts, which will disrupt the millis2() function if used
* too frequently. */
void delayMicroseconds2(unsigned int us){
uint8_t oldSREG;
if (--us == 0) return;
us <<= 2;
us -= 2;
oldSREG = SREG;
cli();
// busy wait
__asm__ __volatile__ (
"1: sbiw %0,1" "\n\t" // 2 cycles
"brne 1b" : "=w" (us) : "0" (us) // 2 cycles
);
// reenable interrupts.
SREG = oldSREG;
}

void init2(){
// this needs to be called before setup() or some functions won't
// work there
sei();

// timer 0 is used for millis2() and delay2()
timer2_overflow_count = 0;
// on the ATmega168, timer 0 is also used for fast hardware pwm
// (using phase-correct PWM would mean that timer 0 overflowed half as often
// resulting in different millis2() behavior on the ATmega8 and ATmega168)
TCCR2A=1<<WGM20|1<<WGM21;
// set timer 2 prescale factor to 64
TCCR2B=1<<CS22;

// TCCR2A=TCCR0A;
// TCCR2B=TCCR0B;
// enable timer 2 overflow interrupt
TIMSK2|=1<<TOIE2;
// disable timer 0 overflow interrupt
TIMSK0&=!(1<<TOIE0);
}

</pre>
{{default}}

Temperature Controller

2008-09-09T13:14:05Z

Combustor: /* X9241A - Digital Potentiometer */

{{default}}
== Warning ==
'''This page is in progress and none of the code can be considered good or complete. I am just using this as an alternate storage of the code for right now.'''

== Summary ==
== Functional Description of the Method ==
== Requirements ==
== Example of Method ==
=== Quick Guide: ===
=== Detailed Guide: ===
=== I2C ===
==== X9241A - Digital Potentiometer ====

There are basically only two functions that I am after right now which are both three byte instructions:

* Read WCR(Wiper Control Register) for the four potentiometers 0-3
** Send 1st byte - Address (binary - 1010 A0 A1 A2 A3) A values are actual pins set to high or low for an address.
** Send 2nd byte - Instruction (binary - 1001 (1/0)(1/0) 00) - The two bits are used to choose the potentiometer
** Read WCR requested Byte
* Write WCR for the four potentiometers 0-3
** Send 1st byte - Address (binary - 1010 A0 A1 A2 A3) A values are actual pins set to high or low for an address.
** Send 2nd byte - Instruction (binary - 1010 (1/0)(1/0) 00) - The two bits are used to choose the potentiometer
** Send WCR Byte - Potentiometer value (binary - 00 D5 D4 D3 D2 D1 D0) - D values are the 0-63 potentiometer positions

==== DS1307 - Real Time Clock ====

The code for this very useful chip came from the [[http://www.glacialwanderer.com/hobbyrobotics/?p=12 Glacial Wanderer]]

==== A/C_Control_v.01 code ====

''' While this says v.01, don't count on it being a released v.01, I am still working on v.01, this is a back up '''

<pre>
/*
* A/C Control v.01
* by <http://www.combustory.com> John Vaughters
* Credit to:
* Maurice Ribble - http://www.glacialwanderer.com/hobbyrobotics for RTC DS1307 code
*
* Turns on an LED for temperatures from analog pins 1-5 on
* digital pins 2-6 when the temperature rises above the THRESHOLDS 1-5.
* The program also implements a
* Serial Communication method that utilizes a leading CHAR for each command Described below.
* Commands:
* T(1-4) - Temp1-5 Status ex. T1, T2, etc
* C(1-4)(0-9) - Increment THRESHOLD1-4 by (1-9) ex. C15 increments THRESHOLD1 BY 5 (Note: C40 will give you a status of THRESHOLD4)
* D(1-4)(0-9) - Decrement THRESHOLD1-4 by (1-9) ex. D59 decrements THRESHOLD5 BY 9 (Note: D10 will give you a status of THRESHOLD1)
* A(0-1) - Manual AC on command A1 is AC on, A0 is AC off
* F(0-1) - Manual AC on command A1 is FAN on, A0 is FAN off
* Q - Q Sets the date of the RTC DS1307 Chip
*/

#include "Wire.h"
#define DS1307_I2C_ADDRESS 0x68

// Global Variables
int val_cnt = 0; // counter for the temp_val
int temp1Pin = 0; // select the input pin for the Thermistor
int temp2Pin = 1; // select the input pin for the Thermistor
int temp3Pin = 2; // select the input pin for the Thermistor
int temp4Pin = 3; // select the input pin for the Thermistor
int temp1_val[5] = {0,0,0,0,0}; // variable to store the value coming from the sensor
int temp2_val[5] = {0,0,0,0,0}; //
int temp3_val[5] = {0,0,0,0,0}; //
int temp4_val[5] = {0,0,0,0,0}; //
int temp1_avg; // average over poll time of the temp values
int temp2_avg;
int temp3_avg;
int temp4_avg;
int duct1 = 2; // Ducts open or close using a digital output
int duct2 = 3;
int duct3 = 4;
int duct4 = 5;
int THRESHOLD1 = 580; // Default theshold values
int THRESHOLD2 = 580;
int THRESHOLD3 = 580;
int THRESHOLD4 = 580;
int ac_on = 13;
int fan_on = 12;
int command = 0; // This is the command char, in ascii form, sent from the serial port
long polltime = 1000; // The time to Poll the tempPins
long previousMillis = 0; // will store last time Temp was updated
long ac_on_start = 0; // Start A/C delay timer
long ac_on_delay = 10000; // Time to wait before checking the ducts again
byte second, minute, hour, dayOfWeek, dayOfMonth, month, year;

// Convert normal decimal numbers to binary coded decimal
byte decToBcd(byte val)
{
return ( (val/10*16) + (val%10) );
}

// Convert binary coded decimal to normal decimal numbers
byte bcdToDec(byte val)
{
return ( (val/16*10) + (val%16) );
}

// 1) Sets the date and time on the ds1307
// 2) Starts the clock
// 3) Sets hour mode to 24 hour clock
// Assumes you're passing in valid numbers
// Watch for scope issues with Global Variables
/*void setDateDs1307(byte second, // 0-59
byte minute, // 0-59
byte hour, // 1-23
byte dayOfWeek, // 1-7
byte dayOfMonth, // 1-28/29/30/31
byte month, // 1-12
byte year) // 0-99*/
void setDateDs1307()
{
Wire.beginTransmission(DS1307_I2C_ADDRESS);
Wire.send(0);
Wire.send(decToBcd(second)); // 0 to bit 7 starts the clock
Wire.send(decToBcd(minute));
Wire.send(decToBcd(hour)); // If you want 12 hour am/pm you need to set
// bit 6 (also need to change readDateDs1307)
Wire.send(decToBcd(dayOfWeek));
Wire.send(decToBcd(dayOfMonth));
Wire.send(decToBcd(month));
Wire.send(decToBcd(year));
Wire.endTransmission();
}

// Gets the date and time from the ds1307 and prints result
// Watch for scope issues with Global Variables
void getDateDs1307()
{
// Reset the register pointer
Wire.beginTransmission(DS1307_I2C_ADDRESS);
Wire.send(0);
Wire.endTransmission();

Wire.requestFrom(DS1307_I2C_ADDRESS, 7);

// A few of these need masks because certain bits are control bits
second = bcdToDec(Wire.receive() & 0x7f);
minute = bcdToDec(Wire.receive());
hour = bcdToDec(Wire.receive() & 0x3f); // Need to change this if 12 hour am/pm
dayOfWeek = bcdToDec(Wire.receive());
dayOfMonth = bcdToDec(Wire.receive());
month = bcdToDec(Wire.receive());
year = bcdToDec(Wire.receive());

Serial.print(hour, DEC);
Serial.print(":");
Serial.print(minute, DEC);
Serial.print(":");
Serial.print(second, DEC);
Serial.print(" ");
Serial.print(month, DEC);
Serial.print("/");
Serial.print(dayOfMonth, DEC);
Serial.print("/");
Serial.print(year, DEC);

}

void setup() {
Wire.begin();
Serial.begin(57600);
pinMode(duct1, OUTPUT);
pinMode(duct2, OUTPUT);
pinMode(duct3, OUTPUT);
pinMode(duct4, OUTPUT);
pinMode(ac_on, OUTPUT);
pinMode(fan_on, OUTPUT);
// Initialize Date/Time to update RTC DS1307 - You need to run the Q command right after you download this program
// This is temporary until a more complex date time command is finished
second = 15;
minute = 41;
hour = 12;
dayOfWeek = 5;
dayOfMonth = 5;
month = 9;
year = 8;
}

void loop() {
if (millis() - previousMillis > polltime) {
previousMillis = millis(); // remember the last time
if (millis() - ac_on_start > ac_on_delay) {
if (digitalRead(duct1) || digitalRead(duct2) || digitalRead(duct3) || digitalRead(duct4)){ // If any ducts are turned on turn on the A/C
if (digitalRead(ac_on) != HIGH) { // Check ac_on state
digitalWrite(ac_on,HIGH);
getDateDs1307();
Serial.println(" - AC ON");
}
ac_on_start = millis();
}
else if (digitalRead(ac_on) != LOW){ //Check ac_on state
digitalWrite(ac_on,LOW);
getDateDs1307();
Serial.println(" - AC OFF");
}
}
temp1_val[val_cnt] = analogRead(temp1Pin); // read the value from the sensors
temp2_val[val_cnt] = analogRead(temp2Pin);
temp3_val[val_cnt] = analogRead(temp3Pin);
temp4_val[val_cnt] = analogRead(temp4Pin);
val_cnt ++;
if (val_cnt == 5) {
val_cnt = 0;
}
temp1_avg = (temp1_val[0] + temp1_val[1] + temp1_val[2] + temp1_val[3] + temp1_val[4])/5;
temp2_avg = (temp2_val[0] + temp2_val[1] + temp2_val[2] + temp2_val[3] + temp2_val[4])/5;
temp3_avg = (temp3_val[0] + temp3_val[1] + temp3_val[2] + temp3_val[3] + temp3_val[4])/5;
temp4_avg = (temp4_val[0] + temp4_val[1] + temp4_val[2] + temp4_val[3] + temp4_val[4])/5;
// Check Thresholds against the Temperatures and set the ducts HIGH or LOW
if (temp1_avg >= THRESHOLD1) {digitalWrite(duct1, HIGH);}
else {digitalWrite(duct1, LOW);}
if (temp2_avg >= THRESHOLD2) {digitalWrite(duct2, HIGH);}
else {digitalWrite(duct2, LOW);}
if (temp3_avg >= THRESHOLD3) {digitalWrite(duct3, HIGH);}
else {digitalWrite(duct3, LOW);}
if (temp4_avg >= THRESHOLD4) {digitalWrite(duct4, HIGH);}
else {digitalWrite(duct4, LOW);}
if (Serial.available()) { // Look for char in serial que and process if found
command = Serial.read();
if (command == 84) { // If command = "T"
command = Serial.read();
if (command == 49) { // If command = "1" print the Temp1
Serial.print("Temp1 = ");
Serial.print(temp1_avg); //
Serial.print(" ");
}
else if (command == 50) { // If command = "2" print the Temp2
Serial.print("Temp2 = ");
Serial.print(temp2_avg); //
Serial.print(" ");
}
else if (command == 51) { // If command = "3" print the Temp3
Serial.print("Temp3 = ");
Serial.print(temp3_avg); //
Serial.print(" ");
}
else if (command == 52) { // If command = "4" print the Temp4
Serial.print("Temp4 = ");
Serial.print(temp4_avg); //
Serial.print(" ");
}
}
else if (command == 67) { //If command = "C" Change Temp Threshhold
if (Serial.available()) {
command = Serial.read();
if (command == 49) { // If command = "1" print the THRESHOLD1
command = Serial.read();
if (command > 47 && command < 58) { // If command is between 0-9 Increment the Threshold by number sent
THRESHOLD1 += command - 48; // ASCII math to get value sent
Serial.print("THRESHOLD1 = ");
Serial.print(THRESHOLD1); //
Serial.print(" ");
}
}
else if (command == 50) { // If command = "2" print the THRESHOLD2
command = Serial.read();
if (command > 47 && command < 58) { // If command is between 0-9 Increment the Threshold by number sent
THRESHOLD2 += command - 48; // ASCII math to get value sent
Serial.print("THRESHOLD2 = ");
Serial.print(THRESHOLD2); //
Serial.print(" ");
}
}
else if (command == 51) { // If command = "3" print the THRESHOLD3
command = Serial.read();
if (command > 47 && command < 58) { // If command is between 0-9 Increment the Threshold by number sent
THRESHOLD3 += command - 48; // ASCII math to get value sent
Serial.print("THRESHOLD3 = ");
Serial.print(THRESHOLD3); //
Serial.print(" ");
}
}
else if (command == 52) { // If command = "4" print the THRESHOLD4
command = Serial.read();
if (command > 47 && command < 58) { // If command is between 0-9 Increment the Threshold by number sent
THRESHOLD4 += command - 48; // ASCII math to get value sent
Serial.print("THRESHOLD4 = ");
Serial.print(THRESHOLD4); //
Serial.print(" ");
}
}
}
}
else if (command == 68) { //If command = "D" Change Temp Threshhold
if (Serial.available()) {
command = Serial.read();
if (command == 49) { // If command = "1" print the THRESHOLD1
command = Serial.read();
if (command > 47 && command < 58) { // If command is between 0-9 Decrement the Threshold by number sent
THRESHOLD1 -= command - 48; // ASCII math to get value sent
Serial.print("THRESHOLD1 = ");
Serial.print(THRESHOLD1); //
Serial.print(" ");
}
}
else if (command == 50) { // If command = "2" print the THRESHOLD2
command = Serial.read();
if (command > 47 && command < 58) { // If command is between 0-9 Decrement the Threshold by number sent
THRESHOLD2 -= command - 48; // ASCII math to get value sent
Serial.print("THRESHOLD2 = ");
Serial.print(THRESHOLD2); //
Serial.print(" ");
}
}
else if (command == 51) { // If command = "3" print the THRESHOLD3
command = Serial.read();
if (command > 47 && command < 58) { // If command is between 0-9 Decrement the Threshold by number sent
THRESHOLD3 -= command - 48; // ASCII math to get value sent
Serial.print("THRESHOLD3 = ");
Serial.print(THRESHOLD3); //
Serial.print(" ");
}
}
else if (command == 52) { // If command = "4" print the THRESHOLD4
command = Serial.read();
if (command > 47 && command < 58) { // If command is between 0-9 Decrement the Threshold by number sent
THRESHOLD4 -= command - 48; // ASCII math to get value sent
Serial.print("THRESHOLD4 = ");
Serial.print(THRESHOLD4); //
Serial.print(" ");
}
}
}
}
//**************** Warning - This is a potential for problem - Consider a manual lock out feature to lock out manual commands
//**************** Possibly create a command to open up manual commands for a certian time period then shut them off again automatically
else if (command == 65) { //If command = "A" Change Temp Threshhold
if (Serial.available()) {
command = Serial.read();
if (command == 49) { // If command = "1" print the AC ON message
getDateDs1307();
Serial.print(" - Manual AC ON ");
ac_on_start = millis(); // Set the AC to a delay before it can be turned off again
digitalWrite(ac_on,HIGH);
}
else if (command == 48) { // If command = "0" print the AC OFF message
getDateDs1307();
Serial.print(" - Manual AC OFF ");
digitalWrite(ac_on,LOW);
}
}
}
else if (command == 70) { //If command = "F" Change Temp Threshhold
if (Serial.available()) {
command = Serial.read();
if (command == 49) { // If command = "1" print the FAN ON message
getDateDs1307();
Serial.print(" - Manual FAN ON ");
ac_on_start = millis();
digitalWrite(fan_on,HIGH);
}
else if (command == 48) { // If command = "0" print the FAN OFF message
getDateDs1307();
Serial.print(" - Manual FAN OFF ");
digitalWrite(fan_on,LOW);
}
}
}
//********************** End of Warning Zone *******************************

// *************** This Section Will list the Staus of the Controller
else if (command == 83) { //If command = "S" Print Controller Status
getDateDs1307();
Serial.println(" ");
Serial.println(" ");
Serial.print("Temp1 = ");
Serial.println(temp1_avg);
Serial.print("Temp2 = ");
Serial.println(temp2_avg);
Serial.print("Temp3 = ");
Serial.println(temp3_avg);
Serial.print("Temp4 = ");
Serial.println(temp4_avg);
Serial.println(" ");
Serial.print("THRESHOLD1 = ");
Serial.println(THRESHOLD1);
Serial.print("THRESHOLD2 = ");
Serial.println(THRESHOLD2);
Serial.print("THRESHOLD3 = ");
Serial.println(THRESHOLD3);
Serial.print("THRESHOLD4 = ");
Serial.println(THRESHOLD4);
Serial.println(" ");
if (digitalRead(duct1) == HIGH) {Serial.println("duct1 ON");}
else{Serial.println("duct1 OFF");}
if (digitalRead(duct2) == HIGH) {Serial.println("duct2 ON");}
else{Serial.println("duct2 OFF");}
if (digitalRead(duct3) == HIGH) {Serial.println("duct3 ON");}
else{Serial.println("duct3 OFF");}
if (digitalRead(duct4) == HIGH) {Serial.println("duct4 ON");}
else{Serial.println("duct4 OFF");}
Serial.println(" ");
if (digitalRead(fan_on) == HIGH) {Serial.println("Fan ON");}
else{Serial.println("Fan OFF");}
if (digitalRead(ac_on) == HIGH) {Serial.println("AC ON");}
else{Serial.println("AC OFF");}
Serial.print("A/C Delay (millisec) = ");
Serial.println(ac_on_delay);
Serial.print("Temp Polling (millisec) = ");
Serial.println(polltime);
Serial.println(" ");

}
else if (command == 81) { //If command = "Q" Set Date
setDateDs1307();
getDateDs1307();
Serial.println(" ");
}
Serial.println(command); // Echo command char found in serial que
command = 0; // reset command
}
}
}
//*****************************************************The End***********************
</pre>

== A/C_Control_v.01 User Guide ==
==== Commands ====
== Troubleshooting ==
=== Summary ===
When Troubleshooting a multi-functional issue, it is best practice to break down the issue into pieces and test each piece as a separate system. However, we will first run through a quick test to see if we can find any obvious issues first.
=== Quick Test ===

Temperature Controller

2008-09-09T00:58:24Z

Combustor:

{{default}}
== Warning ==
'''This page is in progress and none of the code can be considered good or complete. I am just using this as an alternate storage of the code for right now.'''

== Summary ==
== Functional Description of the Method ==
== Requirements ==
== Example of Method ==
=== Quick Guide: ===
=== Detailed Guide: ===
=== I2C ===
==== X9241A - Digital Potentiometer ====

There are basically only two functions that I am after right now which are both three byte instructions:

* Read WCR(Wiper Control Register) for the four potentiometers 0-3
** Send 1st byte - Address (binary - 1010 A0 A1 A2 A3) A values are actual pins set to high or low for an address.
** Send 2nd byte - Instruction (binary - 1001 (1/0)(1/0) 00) - The two bits are used to choose the potentiometer
** Read WCR requested Byte
* Write WCR for the four potentiometers 0-3
** Send 1st byte - Address (binary - 1010 A0 A1 A2 A3) A values are actual pins set to high or low for an address.
** Send 2nd byte - Instruction (binary - 1010 (1/0)(1/0) 00) - The two bits are used to choose the potentiometer
** Send WCR Byte - Potentiometer value (00 D5 D4 D3 D2 D1 D0) - D values are the 0-63 potentiometer positions

==== DS1307 - Real Time Clock ====

The code for this very useful chip came from the [[http://www.glacialwanderer.com/hobbyrobotics/?p=12 Glacial Wanderer]]

==== A/C_Control_v.01 code ====

''' While this says v.01, don't count on it being a released v.01, I am still working on v.01, this is a back up '''

<pre>
/*
* A/C Control v.01
* by <http://www.combustory.com> John Vaughters
* Credit to:
* Maurice Ribble - http://www.glacialwanderer.com/hobbyrobotics for RTC DS1307 code
*
* Turns on an LED for temperatures from analog pins 1-5 on
* digital pins 2-6 when the temperature rises above the THRESHOLDS 1-5.
* The program also implements a
* Serial Communication method that utilizes a leading CHAR for each command Described below.
* Commands:
* T(1-4) - Temp1-5 Status ex. T1, T2, etc
* C(1-4)(0-9) - Increment THRESHOLD1-4 by (1-9) ex. C15 increments THRESHOLD1 BY 5 (Note: C40 will give you a status of THRESHOLD4)
* D(1-4)(0-9) - Decrement THRESHOLD1-4 by (1-9) ex. D59 decrements THRESHOLD5 BY 9 (Note: D10 will give you a status of THRESHOLD1)
* A(0-1) - Manual AC on command A1 is AC on, A0 is AC off
* F(0-1) - Manual AC on command A1 is FAN on, A0 is FAN off
* Q - Q Sets the date of the RTC DS1307 Chip
*/

#include "Wire.h"
#define DS1307_I2C_ADDRESS 0x68

// Global Variables
int val_cnt = 0; // counter for the temp_val
int temp1Pin = 0; // select the input pin for the Thermistor
int temp2Pin = 1; // select the input pin for the Thermistor
int temp3Pin = 2; // select the input pin for the Thermistor
int temp4Pin = 3; // select the input pin for the Thermistor
int temp1_val[5] = {0,0,0,0,0}; // variable to store the value coming from the sensor
int temp2_val[5] = {0,0,0,0,0}; //
int temp3_val[5] = {0,0,0,0,0}; //
int temp4_val[5] = {0,0,0,0,0}; //
int temp1_avg; // average over poll time of the temp values
int temp2_avg;
int temp3_avg;
int temp4_avg;
int duct1 = 2; // Ducts open or close using a digital output
int duct2 = 3;
int duct3 = 4;
int duct4 = 5;
int THRESHOLD1 = 580; // Default theshold values
int THRESHOLD2 = 580;
int THRESHOLD3 = 580;
int THRESHOLD4 = 580;
int ac_on = 13;
int fan_on = 12;
int command = 0; // This is the command char, in ascii form, sent from the serial port
long polltime = 1000; // The time to Poll the tempPins
long previousMillis = 0; // will store last time Temp was updated
long ac_on_start = 0; // Start A/C delay timer
long ac_on_delay = 10000; // Time to wait before checking the ducts again
byte second, minute, hour, dayOfWeek, dayOfMonth, month, year;

// Convert normal decimal numbers to binary coded decimal
byte decToBcd(byte val)
{
return ( (val/10*16) + (val%10) );
}

// Convert binary coded decimal to normal decimal numbers
byte bcdToDec(byte val)
{
return ( (val/16*10) + (val%16) );
}

// 1) Sets the date and time on the ds1307
// 2) Starts the clock
// 3) Sets hour mode to 24 hour clock
// Assumes you're passing in valid numbers
// Watch for scope issues with Global Variables
/*void setDateDs1307(byte second, // 0-59
byte minute, // 0-59
byte hour, // 1-23
byte dayOfWeek, // 1-7
byte dayOfMonth, // 1-28/29/30/31
byte month, // 1-12
byte year) // 0-99*/
void setDateDs1307()
{
Wire.beginTransmission(DS1307_I2C_ADDRESS);
Wire.send(0);
Wire.send(decToBcd(second)); // 0 to bit 7 starts the clock
Wire.send(decToBcd(minute));
Wire.send(decToBcd(hour)); // If you want 12 hour am/pm you need to set
// bit 6 (also need to change readDateDs1307)
Wire.send(decToBcd(dayOfWeek));
Wire.send(decToBcd(dayOfMonth));
Wire.send(decToBcd(month));
Wire.send(decToBcd(year));
Wire.endTransmission();
}

// Gets the date and time from the ds1307 and prints result
// Watch for scope issues with Global Variables
void getDateDs1307()
{
// Reset the register pointer
Wire.beginTransmission(DS1307_I2C_ADDRESS);
Wire.send(0);
Wire.endTransmission();

Wire.requestFrom(DS1307_I2C_ADDRESS, 7);

// A few of these need masks because certain bits are control bits
second = bcdToDec(Wire.receive() & 0x7f);
minute = bcdToDec(Wire.receive());
hour = bcdToDec(Wire.receive() & 0x3f); // Need to change this if 12 hour am/pm
dayOfWeek = bcdToDec(Wire.receive());
dayOfMonth = bcdToDec(Wire.receive());
month = bcdToDec(Wire.receive());
year = bcdToDec(Wire.receive());

Serial.print(hour, DEC);
Serial.print(":");
Serial.print(minute, DEC);
Serial.print(":");
Serial.print(second, DEC);
Serial.print(" ");
Serial.print(month, DEC);
Serial.print("/");
Serial.print(dayOfMonth, DEC);
Serial.print("/");
Serial.print(year, DEC);

}

void setup() {
Wire.begin();
Serial.begin(57600);
pinMode(duct1, OUTPUT);
pinMode(duct2, OUTPUT);
pinMode(duct3, OUTPUT);
pinMode(duct4, OUTPUT);
pinMode(ac_on, OUTPUT);
pinMode(fan_on, OUTPUT);
// Initialize Date/Time to update RTC DS1307 - You need to run the Q command right after you download this program
// This is temporary until a more complex date time command is finished
second = 15;
minute = 41;
hour = 12;
dayOfWeek = 5;
dayOfMonth = 5;
month = 9;
year = 8;
}

void loop() {
if (millis() - previousMillis > polltime) {
previousMillis = millis(); // remember the last time
if (millis() - ac_on_start > ac_on_delay) {
if (digitalRead(duct1) || digitalRead(duct2) || digitalRead(duct3) || digitalRead(duct4)){ // If any ducts are turned on turn on the A/C
if (digitalRead(ac_on) != HIGH) { // Check ac_on state
digitalWrite(ac_on,HIGH);
getDateDs1307();
Serial.println(" - AC ON");
}
ac_on_start = millis();
}
else if (digitalRead(ac_on) != LOW){ //Check ac_on state
digitalWrite(ac_on,LOW);
getDateDs1307();
Serial.println(" - AC OFF");
}
}
temp1_val[val_cnt] = analogRead(temp1Pin); // read the value from the sensors
temp2_val[val_cnt] = analogRead(temp2Pin);
temp3_val[val_cnt] = analogRead(temp3Pin);
temp4_val[val_cnt] = analogRead(temp4Pin);
val_cnt ++;
if (val_cnt == 5) {
val_cnt = 0;
}
temp1_avg = (temp1_val[0] + temp1_val[1] + temp1_val[2] + temp1_val[3] + temp1_val[4])/5;
temp2_avg = (temp2_val[0] + temp2_val[1] + temp2_val[2] + temp2_val[3] + temp2_val[4])/5;
temp3_avg = (temp3_val[0] + temp3_val[1] + temp3_val[2] + temp3_val[3] + temp3_val[4])/5;
temp4_avg = (temp4_val[0] + temp4_val[1] + temp4_val[2] + temp4_val[3] + temp4_val[4])/5;
// Check Thresholds against the Temperatures and set the ducts HIGH or LOW
if (temp1_avg >= THRESHOLD1) {digitalWrite(duct1, HIGH);}
else {digitalWrite(duct1, LOW);}
if (temp2_avg >= THRESHOLD2) {digitalWrite(duct2, HIGH);}
else {digitalWrite(duct2, LOW);}
if (temp3_avg >= THRESHOLD3) {digitalWrite(duct3, HIGH);}
else {digitalWrite(duct3, LOW);}
if (temp4_avg >= THRESHOLD4) {digitalWrite(duct4, HIGH);}
else {digitalWrite(duct4, LOW);}
if (Serial.available()) { // Look for char in serial que and process if found
command = Serial.read();
if (command == 84) { // If command = "T"
command = Serial.read();
if (command == 49) { // If command = "1" print the Temp1
Serial.print("Temp1 = ");
Serial.print(temp1_avg); //
Serial.print(" ");
}
else if (command == 50) { // If command = "2" print the Temp2
Serial.print("Temp2 = ");
Serial.print(temp2_avg); //
Serial.print(" ");
}
else if (command == 51) { // If command = "3" print the Temp3
Serial.print("Temp3 = ");
Serial.print(temp3_avg); //
Serial.print(" ");
}
else if (command == 52) { // If command = "4" print the Temp4
Serial.print("Temp4 = ");
Serial.print(temp4_avg); //
Serial.print(" ");
}
}
else if (command == 67) { //If command = "C" Change Temp Threshhold
if (Serial.available()) {
command = Serial.read();
if (command == 49) { // If command = "1" print the THRESHOLD1
command = Serial.read();
if (command > 47 && command < 58) { // If command is between 0-9 Increment the Threshold by number sent
THRESHOLD1 += command - 48; // ASCII math to get value sent
Serial.print("THRESHOLD1 = ");
Serial.print(THRESHOLD1); //
Serial.print(" ");
}
}
else if (command == 50) { // If command = "2" print the THRESHOLD2
command = Serial.read();
if (command > 47 && command < 58) { // If command is between 0-9 Increment the Threshold by number sent
THRESHOLD2 += command - 48; // ASCII math to get value sent
Serial.print("THRESHOLD2 = ");
Serial.print(THRESHOLD2); //
Serial.print(" ");
}
}
else if (command == 51) { // If command = "3" print the THRESHOLD3
command = Serial.read();
if (command > 47 && command < 58) { // If command is between 0-9 Increment the Threshold by number sent
THRESHOLD3 += command - 48; // ASCII math to get value sent
Serial.print("THRESHOLD3 = ");
Serial.print(THRESHOLD3); //
Serial.print(" ");
}
}
else if (command == 52) { // If command = "4" print the THRESHOLD4
command = Serial.read();
if (command > 47 && command < 58) { // If command is between 0-9 Increment the Threshold by number sent
THRESHOLD4 += command - 48; // ASCII math to get value sent
Serial.print("THRESHOLD4 = ");
Serial.print(THRESHOLD4); //
Serial.print(" ");
}
}
}
}
else if (command == 68) { //If command = "D" Change Temp Threshhold
if (Serial.available()) {
command = Serial.read();
if (command == 49) { // If command = "1" print the THRESHOLD1
command = Serial.read();
if (command > 47 && command < 58) { // If command is between 0-9 Decrement the Threshold by number sent
THRESHOLD1 -= command - 48; // ASCII math to get value sent
Serial.print("THRESHOLD1 = ");
Serial.print(THRESHOLD1); //
Serial.print(" ");
}
}
else if (command == 50) { // If command = "2" print the THRESHOLD2
command = Serial.read();
if (command > 47 && command < 58) { // If command is between 0-9 Decrement the Threshold by number sent
THRESHOLD2 -= command - 48; // ASCII math to get value sent
Serial.print("THRESHOLD2 = ");
Serial.print(THRESHOLD2); //
Serial.print(" ");
}
}
else if (command == 51) { // If command = "3" print the THRESHOLD3
command = Serial.read();
if (command > 47 && command < 58) { // If command is between 0-9 Decrement the Threshold by number sent
THRESHOLD3 -= command - 48; // ASCII math to get value sent
Serial.print("THRESHOLD3 = ");
Serial.print(THRESHOLD3); //
Serial.print(" ");
}
}
else if (command == 52) { // If command = "4" print the THRESHOLD4
command = Serial.read();
if (command > 47 && command < 58) { // If command is between 0-9 Decrement the Threshold by number sent
THRESHOLD4 -= command - 48; // ASCII math to get value sent
Serial.print("THRESHOLD4 = ");
Serial.print(THRESHOLD4); //
Serial.print(" ");
}
}
}
}
//**************** Warning - This is a potential for problem - Consider a manual lock out feature to lock out manual commands
//**************** Possibly create a command to open up manual commands for a certian time period then shut them off again automatically
else if (command == 65) { //If command = "A" Change Temp Threshhold
if (Serial.available()) {
command = Serial.read();
if (command == 49) { // If command = "1" print the AC ON message
getDateDs1307();
Serial.print(" - Manual AC ON ");
ac_on_start = millis(); // Set the AC to a delay before it can be turned off again
digitalWrite(ac_on,HIGH);
}
else if (command == 48) { // If command = "0" print the AC OFF message
getDateDs1307();
Serial.print(" - Manual AC OFF ");
digitalWrite(ac_on,LOW);
}
}
}
else if (command == 70) { //If command = "F" Change Temp Threshhold
if (Serial.available()) {
command = Serial.read();
if (command == 49) { // If command = "1" print the FAN ON message
getDateDs1307();
Serial.print(" - Manual FAN ON ");
ac_on_start = millis();
digitalWrite(fan_on,HIGH);
}
else if (command == 48) { // If command = "0" print the FAN OFF message
getDateDs1307();
Serial.print(" - Manual FAN OFF ");
digitalWrite(fan_on,LOW);
}
}
}
//********************** End of Warning Zone *******************************

// *************** This Section Will list the Staus of the Controller
else if (command == 83) { //If command = "S" Print Controller Status
getDateDs1307();
Serial.println(" ");
Serial.println(" ");
Serial.print("Temp1 = ");
Serial.println(temp1_avg);
Serial.print("Temp2 = ");
Serial.println(temp2_avg);
Serial.print("Temp3 = ");
Serial.println(temp3_avg);
Serial.print("Temp4 = ");
Serial.println(temp4_avg);
Serial.println(" ");
Serial.print("THRESHOLD1 = ");
Serial.println(THRESHOLD1);
Serial.print("THRESHOLD2 = ");
Serial.println(THRESHOLD2);
Serial.print("THRESHOLD3 = ");
Serial.println(THRESHOLD3);
Serial.print("THRESHOLD4 = ");
Serial.println(THRESHOLD4);
Serial.println(" ");
if (digitalRead(duct1) == HIGH) {Serial.println("duct1 ON");}
else{Serial.println("duct1 OFF");}
if (digitalRead(duct2) == HIGH) {Serial.println("duct2 ON");}
else{Serial.println("duct2 OFF");}
if (digitalRead(duct3) == HIGH) {Serial.println("duct3 ON");}
else{Serial.println("duct3 OFF");}
if (digitalRead(duct4) == HIGH) {Serial.println("duct4 ON");}
else{Serial.println("duct4 OFF");}
Serial.println(" ");
if (digitalRead(fan_on) == HIGH) {Serial.println("Fan ON");}
else{Serial.println("Fan OFF");}
if (digitalRead(ac_on) == HIGH) {Serial.println("AC ON");}
else{Serial.println("AC OFF");}
Serial.print("A/C Delay (millisec) = ");
Serial.println(ac_on_delay);
Serial.print("Temp Polling (millisec) = ");
Serial.println(polltime);
Serial.println(" ");

}
else if (command == 81) { //If command = "Q" Set Date
setDateDs1307();
getDateDs1307();
Serial.println(" ");
}
Serial.println(command); // Echo command char found in serial que
command = 0; // reset command
}
}
}
//*****************************************************The End***********************
</pre>

== A/C_Control_v.01 User Guide ==
==== Commands ====
== Troubleshooting ==
=== Summary ===
When Troubleshooting a multi-functional issue, it is best practice to break down the issue into pieces and test each piece as a separate system. However, we will first run through a quick test to see if we can find any obvious issues first.
=== Quick Test ===

Temperature Controller

2008-09-06T19:47:14Z

{{default}}
== Warning ==
'''This page is in progress and none of the code can be considered good or complete. I am just using this as an alternate storage of the code for right now.'''

== Summary ==
== Functional Description of the Method ==
== Requirements ==
== Example of Method ==
=== Quick Guide: ===
=== Detailed Guide: ===
==== A/C_Control_v.01 code ====

''' While this says v.01, don't count on it being a released v.01, I am still working on v.01, this is a back up '''

<pre>
/*
* A/C Control v.01
* by <http://www.combustory.com> John Vaughters
* Credit to:
* Maurice Ribble - http://www.glacialwanderer.com/hobbyrobotics for RTC DS1307 code
*
* Turns on an LED for temperatures from analog pins 1-5 on
* digital pins 2-6 when the temperature rises above the THRESHOLDS 1-5.
* The program also implements a
* Serial Communication method that utilizes a leading CHAR for each command Described below.
* Commands:
* T(1-4) - Temp1-5 Status ex. T1, T2, etc
* C(1-4)(0-9) - Increment THRESHOLD1-4 by (1-9) ex. C15 increments THRESHOLD1 BY 5 (Note: C40 will give you a status of THRESHOLD4)
* D(1-4)(0-9) - Decrement THRESHOLD1-4 by (1-9) ex. D59 decrements THRESHOLD5 BY 9 (Note: D10 will give you a status of THRESHOLD1)
* A(0-1) - Manual AC on command A1 is AC on, A0 is AC off
* F(0-1) - Manual AC on command A1 is FAN on, A0 is FAN off
* Q - Q Sets the date of the RTC DS1307 Chip
*/

#include "Wire.h"
#define DS1307_I2C_ADDRESS 0x68

// Global Variables
int val_cnt = 0; // counter for the temp_val
int temp1Pin = 0; // select the input pin for the Thermistor
int temp2Pin = 1; // select the input pin for the Thermistor
int temp3Pin = 2; // select the input pin for the Thermistor
int temp4Pin = 3; // select the input pin for the Thermistor
int temp1_val[5] = {0,0,0,0,0}; // variable to store the value coming from the sensor
int temp2_val[5] = {0,0,0,0,0}; //
int temp3_val[5] = {0,0,0,0,0}; //
int temp4_val[5] = {0,0,0,0,0}; //
int temp1_avg; // average over poll time of the temp values
int temp2_avg;
int temp3_avg;
int temp4_avg;
int duct1 = 2; // Ducts open or close using a digital output
int duct2 = 3;
int duct3 = 4;
int duct4 = 5;
int THRESHOLD1 = 580; // Default theshold values
int THRESHOLD2 = 580;
int THRESHOLD3 = 580;
int THRESHOLD4 = 580;
int ac_on = 13;
int fan_on = 12;
int command = 0; // This is the command char, in ascii form, sent from the serial port
long polltime = 1000; // The time to Poll the tempPins
long previousMillis = 0; // will store last time Temp was updated
long ac_on_start = 0; // Start A/C delay timer
long ac_on_delay = 10000; // Time to wait before checking the ducts again
byte second, minute, hour, dayOfWeek, dayOfMonth, month, year;

// Convert normal decimal numbers to binary coded decimal
byte decToBcd(byte val)
{
return ( (val/10*16) + (val%10) );
}

// Convert binary coded decimal to normal decimal numbers
byte bcdToDec(byte val)
{
return ( (val/16*10) + (val%16) );
}

// 1) Sets the date and time on the ds1307
// 2) Starts the clock
// 3) Sets hour mode to 24 hour clock
// Assumes you're passing in valid numbers
// Watch for scope issues with Global Variables
/*void setDateDs1307(byte second, // 0-59
byte minute, // 0-59
byte hour, // 1-23
byte dayOfWeek, // 1-7
byte dayOfMonth, // 1-28/29/30/31
byte month, // 1-12
byte year) // 0-99*/
void setDateDs1307()
{
Wire.beginTransmission(DS1307_I2C_ADDRESS);
Wire.send(0);
Wire.send(decToBcd(second)); // 0 to bit 7 starts the clock
Wire.send(decToBcd(minute));
Wire.send(decToBcd(hour)); // If you want 12 hour am/pm you need to set
// bit 6 (also need to change readDateDs1307)
Wire.send(decToBcd(dayOfWeek));
Wire.send(decToBcd(dayOfMonth));
Wire.send(decToBcd(month));
Wire.send(decToBcd(year));
Wire.endTransmission();
}

// Gets the date and time from the ds1307 and prints result
// Watch for scope issues with Global Variables
void getDateDs1307()
{
// Reset the register pointer
Wire.beginTransmission(DS1307_I2C_ADDRESS);
Wire.send(0);
Wire.endTransmission();

Wire.requestFrom(DS1307_I2C_ADDRESS, 7);

// A few of these need masks because certain bits are control bits
second = bcdToDec(Wire.receive() & 0x7f);
minute = bcdToDec(Wire.receive());
hour = bcdToDec(Wire.receive() & 0x3f); // Need to change this if 12 hour am/pm
dayOfWeek = bcdToDec(Wire.receive());
dayOfMonth = bcdToDec(Wire.receive());
month = bcdToDec(Wire.receive());
year = bcdToDec(Wire.receive());

Serial.print(hour, DEC);
Serial.print(":");
Serial.print(minute, DEC);
Serial.print(":");
Serial.print(second, DEC);
Serial.print(" ");
Serial.print(month, DEC);
Serial.print("/");
Serial.print(dayOfMonth, DEC);
Serial.print("/");
Serial.print(year, DEC);

}

void setup() {
Wire.begin();
Serial.begin(57600);
pinMode(duct1, OUTPUT);
pinMode(duct2, OUTPUT);
pinMode(duct3, OUTPUT);
pinMode(duct4, OUTPUT);
pinMode(ac_on, OUTPUT);
pinMode(fan_on, OUTPUT);
// Initialize Date/Time to update RTC DS1307 - You need to run the Q command right after you download this program
// This is temporary until a more complex date time command is finished
second = 15;
minute = 41;
hour = 12;
dayOfWeek = 5;
dayOfMonth = 5;
month = 9;
year = 8;
}

void loop() {
if (millis() - previousMillis > polltime) {
previousMillis = millis(); // remember the last time
if (millis() - ac_on_start > ac_on_delay) {
if (digitalRead(duct1) || digitalRead(duct2) || digitalRead(duct3) || digitalRead(duct4)){ // If any ducts are turned on turn on the A/C
if (digitalRead(ac_on) != HIGH) { // Check ac_on state
digitalWrite(ac_on,HIGH);
getDateDs1307();
Serial.println(" - AC ON");
}
ac_on_start = millis();
}
else if (digitalRead(ac_on) != LOW){ //Check ac_on state
digitalWrite(ac_on,LOW);
getDateDs1307();
Serial.println(" - AC OFF");
}
}
temp1_val[val_cnt] = analogRead(temp1Pin); // read the value from the sensors
temp2_val[val_cnt] = analogRead(temp2Pin);
temp3_val[val_cnt] = analogRead(temp3Pin);
temp4_val[val_cnt] = analogRead(temp4Pin);
val_cnt ++;
if (val_cnt == 5) {
val_cnt = 0;
}
temp1_avg = (temp1_val[0] + temp1_val[1] + temp1_val[2] + temp1_val[3] + temp1_val[4])/5;
temp2_avg = (temp2_val[0] + temp2_val[1] + temp2_val[2] + temp2_val[3] + temp2_val[4])/5;
temp3_avg = (temp3_val[0] + temp3_val[1] + temp3_val[2] + temp3_val[3] + temp3_val[4])/5;
temp4_avg = (temp4_val[0] + temp4_val[1] + temp4_val[2] + temp4_val[3] + temp4_val[4])/5;
// Check Thresholds against the Temperatures and set the ducts HIGH or LOW
if (temp1_avg >= THRESHOLD1) {digitalWrite(duct1, HIGH);}
else {digitalWrite(duct1, LOW);}
if (temp2_avg >= THRESHOLD2) {digitalWrite(duct2, HIGH);}
else {digitalWrite(duct2, LOW);}
if (temp3_avg >= THRESHOLD3) {digitalWrite(duct3, HIGH);}
else {digitalWrite(duct3, LOW);}
if (temp4_avg >= THRESHOLD4) {digitalWrite(duct4, HIGH);}
else {digitalWrite(duct4, LOW);}
if (Serial.available()) { // Look for char in serial que and process if found
command = Serial.read();
if (command == 84) { // If command = "T"
command = Serial.read();
if (command == 49) { // If command = "1" print the Temp1
Serial.print("Temp1 = ");
Serial.print(temp1_avg); //
Serial.print(" ");
}
else if (command == 50) { // If command = "2" print the Temp2
Serial.print("Temp2 = ");
Serial.print(temp2_avg); //
Serial.print(" ");
}
else if (command == 51) { // If command = "3" print the Temp3
Serial.print("Temp3 = ");
Serial.print(temp3_avg); //
Serial.print(" ");
}
else if (command == 52) { // If command = "4" print the Temp4
Serial.print("Temp4 = ");
Serial.print(temp4_avg); //
Serial.print(" ");
}
}
else if (command == 67) { //If command = "C" Change Temp Threshhold
if (Serial.available()) {
command = Serial.read();
if (command == 49) { // If command = "1" print the THRESHOLD1
command = Serial.read();
if (command > 47 && command < 58) { // If command is between 0-9 Increment the Threshold by number sent
THRESHOLD1 += command - 48; // ASCII math to get value sent
Serial.print("THRESHOLD1 = ");
Serial.print(THRESHOLD1); //
Serial.print(" ");
}
}
else if (command == 50) { // If command = "2" print the THRESHOLD2
command = Serial.read();
if (command > 47 && command < 58) { // If command is between 0-9 Increment the Threshold by number sent
THRESHOLD2 += command - 48; // ASCII math to get value sent
Serial.print("THRESHOLD2 = ");
Serial.print(THRESHOLD2); //
Serial.print(" ");
}
}
else if (command == 51) { // If command = "3" print the THRESHOLD3
command = Serial.read();
if (command > 47 && command < 58) { // If command is between 0-9 Increment the Threshold by number sent
THRESHOLD3 += command - 48; // ASCII math to get value sent
Serial.print("THRESHOLD3 = ");
Serial.print(THRESHOLD3); //
Serial.print(" ");
}
}
else if (command == 52) { // If command = "4" print the THRESHOLD4
command = Serial.read();
if (command > 47 && command < 58) { // If command is between 0-9 Increment the Threshold by number sent
THRESHOLD4 += command - 48; // ASCII math to get value sent
Serial.print("THRESHOLD4 = ");
Serial.print(THRESHOLD4); //
Serial.print(" ");
}
}
}
}
else if (command == 68) { //If command = "D" Change Temp Threshhold
if (Serial.available()) {
command = Serial.read();
if (command == 49) { // If command = "1" print the THRESHOLD1
command = Serial.read();
if (command > 47 && command < 58) { // If command is between 0-9 Decrement the Threshold by number sent
THRESHOLD1 -= command - 48; // ASCII math to get value sent
Serial.print("THRESHOLD1 = ");
Serial.print(THRESHOLD1); //
Serial.print(" ");
}
}
else if (command == 50) { // If command = "2" print the THRESHOLD2
command = Serial.read();
if (command > 47 && command < 58) { // If command is between 0-9 Decrement the Threshold by number sent
THRESHOLD2 -= command - 48; // ASCII math to get value sent
Serial.print("THRESHOLD2 = ");
Serial.print(THRESHOLD2); //
Serial.print(" ");
}
}
else if (command == 51) { // If command = "3" print the THRESHOLD3
command = Serial.read();
if (command > 47 && command < 58) { // If command is between 0-9 Decrement the Threshold by number sent
THRESHOLD3 -= command - 48; // ASCII math to get value sent
Serial.print("THRESHOLD3 = ");
Serial.print(THRESHOLD3); //
Serial.print(" ");
}
}
else if (command == 52) { // If command = "4" print the THRESHOLD4
command = Serial.read();
if (command > 47 && command < 58) { // If command is between 0-9 Decrement the Threshold by number sent
THRESHOLD4 -= command - 48; // ASCII math to get value sent
Serial.print("THRESHOLD4 = ");
Serial.print(THRESHOLD4); //
Serial.print(" ");
}
}
}
}
//**************** Warning - This is a potential for problem - Consider a manual lock out feature to lock out manual commands
//**************** Possibly create a command to open up manual commands for a certian time period then shut them off again automatically
else if (command == 65) { //If command = "A" Change Temp Threshhold
if (Serial.available()) {
command = Serial.read();
if (command == 49) { // If command = "1" print the AC ON message
getDateDs1307();
Serial.print(" - Manual AC ON ");
ac_on_start = millis(); // Set the AC to a delay before it can be turned off again
digitalWrite(ac_on,HIGH);
}
else if (command == 48) { // If command = "0" print the AC OFF message
getDateDs1307();
Serial.print(" - Manual AC OFF ");
digitalWrite(ac_on,LOW);
}
}
}
else if (command == 70) { //If command = "F" Change Temp Threshhold
if (Serial.available()) {
command = Serial.read();
if (command == 49) { // If command = "1" print the FAN ON message
getDateDs1307();
Serial.print(" - Manual FAN ON ");
ac_on_start = millis();
digitalWrite(fan_on,HIGH);
}
else if (command == 48) { // If command = "0" print the FAN OFF message
getDateDs1307();
Serial.print(" - Manual FAN OFF ");
digitalWrite(fan_on,LOW);
}
}
}
//********************** End of Warning Zone *******************************

// *************** This Section Will list the Staus of the Controller
else if (command == 83) { //If command = "S" Print Controller Status
getDateDs1307();
Serial.println(" ");
Serial.println(" ");
Serial.print("Temp1 = ");
Serial.println(temp1_avg);
Serial.print("Temp2 = ");
Serial.println(temp2_avg);
Serial.print("Temp3 = ");
Serial.println(temp3_avg);
Serial.print("Temp4 = ");
Serial.println(temp4_avg);
Serial.println(" ");
Serial.print("THRESHOLD1 = ");
Serial.println(THRESHOLD1);
Serial.print("THRESHOLD2 = ");
Serial.println(THRESHOLD2);
Serial.print("THRESHOLD3 = ");
Serial.println(THRESHOLD3);
Serial.print("THRESHOLD4 = ");
Serial.println(THRESHOLD4);
Serial.println(" ");
if (digitalRead(duct1) == HIGH) {Serial.println("duct1 ON");}
else{Serial.println("duct1 OFF");}
if (digitalRead(duct2) == HIGH) {Serial.println("duct2 ON");}
else{Serial.println("duct2 OFF");}
if (digitalRead(duct3) == HIGH) {Serial.println("duct3 ON");}
else{Serial.println("duct3 OFF");}
if (digitalRead(duct4) == HIGH) {Serial.println("duct4 ON");}
else{Serial.println("duct4 OFF");}
Serial.println(" ");
if (digitalRead(fan_on) == HIGH) {Serial.println("Fan ON");}
else{Serial.println("Fan OFF");}
if (digitalRead(ac_on) == HIGH) {Serial.println("AC ON");}
else{Serial.println("AC OFF");}
Serial.print("A/C Delay (millisec) = ");
Serial.println(ac_on_delay);
Serial.print("Temp Polling (millisec) = ");
Serial.println(polltime);
Serial.println(" ");

}
else if (command == 81) { //If command = "Q" Set Date
setDateDs1307();
getDateDs1307();
Serial.println(" ");
}
Serial.println(command); // Echo command char found in serial que
command = 0; // reset command
}
}
}
//*****************************************************The End***********************
</pre>

== A/C_Control_v.01 User Guide ==
==== Commands ====
== Troubleshooting ==
=== Summary ===
When Troubleshooting a multi-functional issue, it is best practice to break down the issue into pieces and test each piece as a separate system. However, we will first run through a quick test to see if we can find any obvious issues first.
=== Quick Test ===

Arduino Communications

2008-09-06T19:31:11Z

Combustor: /* ''command'' file */

{{default}}

'''Check out this awesome Arduino application - [[MPGuino]] - An MPG gauge for fuel efficiency.'''

== Summary ==

In my search for methods to communicate with the Arduino board, I found lots of ways that required me to learn new languages or learn serial communication programming. I do want to eventually pick up these skills, but I found a quicker way for my needs. I have learned over time that you can always find a better way to solve a problem, but I realize that the amount of time to learn that better way is sometimes greater than the project time-frame, and therefore just solve it in the best way you can with the tools you have. I believe that the solution below encompasses that spirit. Here you will find a quick, dirty yet effective solution for communicating with the Arduino.

This solution met my goals, but it may not meet yours. It is limited in the effect that a transfer in a message may take as long as 5 sec. This fits fine for my needs where I am just looking to form a distributed network of smart sensors/controllers that allow the setting of certain variables and the reporting of alarms and/or useful tracking information from the individual controllers.

'''Note: I owe a BIG debt of gratitude to all the Arduino hackers that provided me with the tools/code/knowledge to allow this solution'''

== Functional Description of the Method ==

This method creates a log file that is created by an Arduino board using serial communications that is sent to a terminal which is redirected to a file. The file can then be used by any software you desire to process the messages from the Arduino board. To send messages to the Arduino board the use of Arduino-Serial (a command line utility) is placed in a BASH script that is used to constantly poll for the existence of a ''command'' file. When a ''command'' file is found, the BASH script will send the commands in the file to the Arduino board. The response by the Arduino is to follow the command input and print response data out to the terminal, which is sent to the log file.

If your brain just got scrambled, join the club. There were several technical hurdles I was concerned about as soon as I thought of this method. I did not even think this would work at first, but it turns out to function just fine. (Until Further Notice! `,~)

In this diagram you will find the basic idea behind the method. This diagram is based on the example I provide below.

[[Image:Arduino_Com_diagram.jpg | 400px]]

== Requirements ==

'''The method requires the following hardware/knowledge:'''

* An Arduino Board or equivalent
* Linux computer that is able to communicate with the Arduino
* Your favorite development language
* Basic Linux operational skill
* Knowledge of ''samba'' or ''NFS'' if networking is desired

'''This example requires the following hardware/knowledge:'''

* An Arduino Board or equivalent (I used an actual Arduino Board with the USB connection)
* Linux computer that is able to communicate with the Arduino (I used an Ubuntu 8.x box)
* A Windows computer that is able to support AutoIT (I used an XP box)
* A network between the two computers
* Development languages - BASH scripting for Linux and AutoIT for windows
* Knowledge of ''samba'' for sharing folders over the network

== Example of Method ==
=== Quick Guide: ===

'''Step 1 -''' Buy an Arduino Board - http://www.arduino.cc/en/Main/Buy

'''Step 2 -''' Load the Arduino software on your linux box - http://www.arduino.cc/playground/Learning/Linux

'''Step 3 -''' Load the sample Arduino code (see Step 3 below) into your Arduino board - http://www.arduino.cc/en/Guide/HomePage

'''Step 4 -''' Create a Folder on the Linux box and share the Folder over the network using ''samba'' - http://us1.samba.org/samba/

'''Step 5 -''' Compile the Arduino-Serial software and place the executable in the shared folder from Step 4 - http://todbot.com/blog/2006/12/06/arduino-serial-c-code-to-talk-to-arduino/

'''Step 6 -''' Load the sample BASH scripting text (see Step 6 below) into an executable file in your shared folder from Step 4 on the Linux box - http://www.gnu.org/software/bash/

'''Step 7 -''' Build your Thermistor circuit based on the diagram (see Step 7 below) or something similar

'''Step 8 -''' Map your 'samba' shared folder on your linux box to a windows drive

'''Step 9 -''' Load AutoIT on your windows box - http://www.autoitscript.com/autoit3/

'''Step 10 -''' Use the sample AutoIT script (see Step 10 below) to test the solution

'''Step 11 -''' Revel in your new found capability to conquer the world, well the Arduino world anyway! `,~)
=== Detailed Guide: ===

==== Step 1 ====
'''Buy an Arduino Board - ''' There are lots of options to buy a board. I chose the standard USB version from the guidance of this [http://www.arduino.cc/en/Main/Buy Arduino link]. If you follow this [http://www.freeduino.org/buy.html Freeduino link] you will find many options including my favorite the Bare Bones Board from [http://moderndevice.com/ moderndevice.com] and [http://wulfden.org/freeduino/freeduino.shtml wulfden.com]. Check out the [http://www.moderndevice.com/RBBB_revB.shtml RBBB assembly]. These options are super cheap and I will definitely be buying my next Arduino based board from these sites. These folks have knocked down the price of micro-controller development boards.
==== Step 2 ====
'''Load the Arduino software on your linux box - ''' Here are the [http://www.arduino.cc/playground/Learning/Linux Linux Instructions]. For my Arduino, I used Ubuntu 8.x. I also recommend you do a google search of Arduino and your linux type to find any type of specific hiccups that inevitably find there way into installs. The Ubuntu instuctions I ended up using was from [http://principialabs.com/running-arduino-on-ubuntu/ principialabs.com] and after all was said and done these instructions worked without a single problem for me.

==== Step 3 ====
''' Load the sample Arduino code into your Arduino board - ''' Here is the code I used. I will not claim it to be pretty, but it does work as a test for this method. Most likely you will have to modify some of the numbers around the input. I will give you my schematic, but I am sure that your set up will vary somewhat and that will change the Threshold and Voltage reading numbers.

/*
* AnalogInput with Thermistor
* by DojoDave <http://www.0j0.org> and John Vaughters <http://www.combustory.com>
*
* Turns on a light emitting diode(LED) connected to digital
* pin 13 when the temperature rises above the threshold. The value obtained by analogRead().
* In the easiest case we connect a thermistor to analog pin 5. The program also implements a
* Serial Communication method that utilizes a char and a # ie. A0...A9, B0...B9, etc. Each Command will implement
* a specific action in the Arduino.
*
*/
int tempPin = 5; // select the input pin for the Thermistor
int ledPin = 13; // select the pin for the LED
int val = 0; // variable to store the value coming from the sensor
int THRESHOLD = 580;
int statePin = HIGH; // variable used to store the last LED status, to toggle the light
int command = 0; // This is the command char, in ascii form, sent from the serial port
long polTime = 1000; // The time to Pol the tempPin
long previousMillis = 0; // will store last time Temp was updated

void setup() {
Serial.begin(57600);
pinMode(ledPin, OUTPUT); // declare the ledPin as an OUTPUT
pinMode(12, OUTPUT); // Test Com Reset issue
digitalWrite(12,HIGH);
delay(5000);
digitalWrite(12,LOW);
}

void loop() {
if (millis() - previousMillis > polTime) {
previousMillis = millis(); // remember the last time
val = analogRead(tempPin); // read the value from the sensor
if (val >= THRESHOLD) {
//statePin = !statePin; // toggle the status of the ledPin (this trick doesn't use time cycles)
digitalWrite(ledPin, statePin); // turn the led on or off
Serial.print("~@ Hot "); // send the string "Hot" back to the computer, followed by newline
Serial.print("Temp = ");
Serial.println(val); //
}
else {
digitalWrite(ledPin, LOW);
}
if (Serial.available()) { // Look for char in serial que and process if found
command = Serial.read();
if (command == 84) { // If command = "T" print the Temp
Serial.print("~& Temp = ");
Serial.print(val); //
Serial.print(" ");
delay(100);
}
else if (command == 67) { //If command = "C" Change Temp Threshhold
if (Serial.available()) {
command = Serial.read();
if (command > 47 && command < 58) { // If command is between 0-9 Increment the Threshold by number sent
THRESHOLD += command - 48; // ASII math to get value sent
Serial.print("~# THRESHOLD = ");
Serial.print(THRESHOLD); //
Serial.print(" ");
delay(100);
}
}
}
else if (command == 68) { //If command = "D" Change Temp Threshhold
if (Serial.available()) {
command = Serial.read();
if (command > 47 && command < 58) { // If command is between 0-9 Decrement the Threshold by number sent
THRESHOLD -= command - 48; // ASII math to get value sent
Serial.print("~# THRESHOLD = ");
Serial.print(THRESHOLD); //
Serial.print(" ");
delay(100);
}
}
}
delay(100);
Serial.println(command); // Echo command char found in serial que
command = 0; // reset command
}
}
}
//*****************************************************The End***********************
==== Step 4 ====
''' Create a Folder on the Linux box and share the Folder over the network using ''samba'' - ''' There is not much to say here other than learn your ''samba'' and make it happen. There are literally tons of info on this subject on the web. Other than that make sure that the permissions are set on the shared folder to allow creating and writing files.

==== Step 5 ====
''' Compile the Arduino-Serial software and place the executable in the shared folder from Step 4 - ''' This step gave me a little bit of an issue. I had to comment out a few baud speed lines. It was not that difficult to figure out, because the compiler gave pretty clear error messages and these [http://todbot.com/blog/2006/12/06/arduino-serial-c-code-to-talk-to-arduino/ Arduino-Serial] instructions even mentioned this as an issue and even though it is mentioned and supposedly fixed, there is still one more line he did not comment out. Make sure any line that looks like this:

case 28800: brate=B28800; break;

Looks like this:

//case 28800: brate=B28800; break;

==== Step 6 ====
''' Load the sample BASH scripting text into an executable file in your shared folder from Step 4 on the Linux box - ''' Here is the BASH script. It is a script that goes into an infinite loop and constantly polls for two files, a ''command'' file and a ''clear_log'' file. When it sees those files it takes action to either send commands or clear the log file. The files are sent from some other application that are used to control the communication to the Arduino. In this example I use AutoIT as the controlling software (See Step 9). I will leave it to the reader to decode these commands.

#!/bin/bash
# File name CommandPoll
# This Script is used to control the communication to an Arduino board via the Arduino-Serial command line utility and the dev/ttyUSB0 terminal
# Written by John Vaughters <http://www.combustory.com>

# Set the terminal to match the Arduino Serial Communications
stty -F /dev/ttyUSB0 cs8 57600 ignbrk -brkint -icrnl -imaxbel -opost -onlcr -isig -icanon -iexten -echo -echoe -echok -echoctl -echoke noflsh -ixon -crtscts

# Kill any existing tail commands logging the terminal
exec ps ax | grep "tail -f /dev/ttyUSB0" | grep ? | awk '{system("kill " $1)}'
# Connect the terminal to a tail logging to a file by appending
exec tail -f /dev/ttyUSB0 >> /home/jvaughters/arduino-0011/sketchbook/ArduinoSerial/arduino_log &

# create an infinite loop to test for files that will prompt action
while [ 1 ]
do
if [ -f command ] # Does the command file exist
then
cat command | awk '{system("./arduino-serial -b 57600 -p /dev/ttyUSB0 -s " $1)}' # Send the commands in the command file via Arduino-Serial utility
rm command # remove the command file
fi
if [ -f clear_log ] # Does the clear_log file exist
then
echo > arduino_log
rm clear_log
fi
if [ -f exit_poll ] # Does the exit_poll file exist
then
# Kill any tail commands logging the terminal
exec ps ax | grep "tail -f /dev/ttyUSB0" | grep ? | awk '{system("kill " $1)}'
rm exit_poll
exit 0 # Exit CommandPoll script
fi
sleep 1 # Sleep for one second or your processor will run 100% (optional)
done
exit 0

==== Step 7 ====
''' Build your Thermistor and LED circuits based on the diagrams or something similar - ''' That's it, just follow the diagrams or create a comparable solution.

[[Image:arduino_com_circuit.jpg]]

==== Step 8 ====
''' Map your ''samba'' linux shared folder to a windows drive - ''' For this example you have to map a drive on your windows box. I think I will leave the details on how to accomplish this task to a google search on mapping drives in windows. It is fairly straight forward. I mapped my drive to P: for no particular reason, but what ever you map it to, you will be able to select the drive from within the AutoIT GUI.

==== Step 9 ====
''' Load AutoIT on your windows box - ''' Go to the [http://www.autoitscript.com/autoit3/ AutoIT] site and load this very powerful and free software. This software has been around for a while and it has a fairly active development crew, which creates constant improvements, extensions and user libraries. It is a very powerful GUI scripting tool and it is very easy to create a GUI application as well. I have created many great utilities using this software. It is not for super powerful software needs, but with today's computers, it does quite a bit. LOVE this tool.
==== Step 10 ====
''' Use the sample AutoIT script to test the solution - ''' This code is a utility that will allow you to select the mapped shared windows drive/path and a working directory. There is a drop down menu with four commands that that will make the Arduino respond. This program will create a ''command'' file, fill it with the command string and place it in the Network Dir. The Software will wait 5 seconds and then retrieve the results and place it in the text window. Then the program will place the ''clear_log'' file in the Network Dir. I will not cover the use of this software here, refer to the User Guide section. For now just get this loaded into AutoIT and hit F5 to get it to run. You can run AutoIT programs interpreted or compiled. Pressing F5 runs it as interpreted.

; Arduino Communications and Control
; File name: Arduino_Com_v.01.au3
; 31 Jul 2008 - John Vaughters <http://www.combustory.com>
; This is a Utility to Communicate with the Arduino Control board

#include <GuiConstants.au3>
#include <GuiEdit.au3>
#include <file.au3>
#include <Date.au3>
#include <IE.au3>

;*************
; _Load_Results() loads the temp file into the desired control then deletes the temp file
; $w_dir is the working directory where the file exists
; $ctl_to_load is the place to load the file contents
; $temp_file is the temporary file to load the data from
; The function returns the number of lines loaded from the file

Func _Load_Results ($w_dir, $ctl_load_to, $temp_file)
Dim $aRecords
If Not _FileReadToArray($w_dir & $temp_file,$aRecords) Then
MsgBox(4096,"Error", " Error reading log to Array error:" & @error)
Exit
EndIf

For $x = 1 to $aRecords[0]
if StringLen($aRecords[$x]) > 0 then GuiCtrlSetData($ctl_load_to, $aRecords[$x] & @CRLF, 1)
Next
;Delete the temporary file
RunWait(@ComSpec & " /c " & "del " & $temp_file, $w_dir & "",@SW_HIDE)
Return ($aRecords[0]-1)
EndFunc

;Initialize Variable Defaults
$working_dir = @DesktopDir & "\"
$working_file = "arduino_log"
$poll_delay = 5000 ; This is the delay the program waits before collecting the command results
$network_dir = "P:\" ; Default network directory
$process_results = False ;Processing Flag
$command_get_begin = TimerInit() ;Initialize Timer
; GUI
GuiCreate(" Arduino Communications and Control", 700, 600)

; MENU
$filemenu = GuiCtrlCreateMenu("&File")
$fileitem = GUICtrlCreateMenuitem ("Open",$filemenu)
GUICtrlSetState(-1,$GUI_DEFBUTTON)
$exititem = GUICtrlCreateMenuitem ("Exit",$filemenu)
$helpmenu = GuiCtrlCreateMenu("Help")
$infoitem = GUICtrlCreateMenuitem ("Info",$helpmenu)

; LOGO PIC
GuiCtrlCreatePic("logo.jpg",0,0, 100,140)

; AVI for letting the user know the system is processing
$processing = GuiCtrlCreateAvi("sampleAVI.avi",0, 405, 140, 32, 32)

; Tabbed Result Window
$tab_result_start_x = 20
$tab_result_start_y = 175
$tab_result_size_x = 650
$tab_result_size_y = 400
$tab_result_title_2 = "Command Results"
$tab_result_title_4 = "Sys Info"
GuiCtrlCreateTab($tab_result_start_x, $tab_result_start_y, $tab_result_size_x , $tab_result_size_y)
GuiCtrlCreateTabItem($tab_result_title_2)
$edit_ctl_tab2 = GuiCtrlCreateEdit(@CRLF & "", $tab_result_start_x + 10 , $tab_result_start_y + 40, $tab_result_size_x - 20, $tab_result_size_y - 50)
GuiCtrlCreateTabItem($tab_result_title_4)
$edit_ctl_tab4 = GuiCtrlCreateEdit(@CRLF & "", $tab_result_start_x + 10 , $tab_result_start_y + 40, $tab_result_size_x - 20, $tab_result_size_y - 50)
GuiCtrlCreateTabItem("")

; Combo Arduino Command File Type
$combo_ctl_search_file = GuiCtrlCreatecombo("*", 240, 145, 120, 100)
GUICtrlSetData(-1,"C5|D5|T1|","C5") ; add other item snd set a new default
GuiCtrlCreateLabel("Arduino Command", 245, 170, 150, 20)

; Current Working Directory Label
$combo_ctl_working_dir = GuiCtrlCreateLabel($working_dir, 240, 80, 450, 22,$WS_DLGFRAME)
GUICtrlSetBkColor(-1,0xffffff)
GuiCtrlCreateLabel("Working Directory", 245, 105, 200, 20)

; Current Network Directory Label
$combo_ctl_network_dir = GuiCtrlCreateLabel($network_dir, 240, 20, 450, 22,$WS_DLGFRAME)
GUICtrlSetBkColor(-1,0xffffff)
GuiCtrlCreateLabel("Network Directory", 245, 45, 200, 20)

; BUTTON
$search_btn = GuiCtrlCreateButton("Go", 370, 143, 25, 25)
$file_btn = GuiCtrlCreateButton("Working Dir", 125, 77, 100, 25)
$network_btn = GuiCtrlCreateButton("Network Dir", 125, 18, 100, 25)
$site_btn = GuiCtrlCreateButton("www.combustory.com", 0, 145, 135, 22)
$clear_btn = GuiCtrlCreateButton("Clear", 620, 170, 50, 22)

; List System Info
GuiCtrlSetData($edit_ctl_tab4, "Computer: " & @CRLF & _
"----------------------------------------------------------" & @CRLF & _
"IP Address: " & @IPAddress1 & @CRLF & _
"Computer Name: " & @ComputerName & @CRLF & _
"OS: " & @OSVersion & @CRLF & _
"Sys Dir: " & @SystemDir & @CRLF & @CRLF)
; GUI MESSAGE LOOP
GuiSetState()

; Main Event Loop
While 1
; After every loop check if the user clicked something in the GUI window
$msg = GUIGetMsg()
if $process_results = True Then
if $poll_delay < TimerDiff($command_get_begin) Then
RunWait(@ComSpec & " /c " & "type arduino_log>results.txt", $network_dir,@SW_HIDE)
; Load command results into Command Results tab
GuiCtrlSetData($edit_ctl_tab2, "------------------------------------------------------------------" & @CRLF,1)
GuiCtrlSetData($edit_ctl_tab2, "Command: " & GUICtrlRead($combo_ctl_search_file) & @CRLF,1)
GuiCtrlSetData($edit_ctl_tab2, "Results: " & @CRLF,1)
_Load_Results ($network_dir, $edit_ctl_tab2, "results.txt")
GuiCtrlSetData($edit_ctl_tab2, "******************************************************************" & @CRLF,1)
$process_results = False
RunWait(@ComSpec & " /c " & "echo>clear_log", $network_dir,@SW_HIDE) ; Send message to Linux polling script to clear the log
GUICtrlSetState ($processing, 0)
EndIf
EndIf
Select

; Check if user clicked on the close button
Case $msg = $GUI_EVENT_CLOSE Or $msg = $exititem
; Destroy the GUI including the controls
GUIDelete()
; Exit the script
Exit

; Check if user clicked on the File Open button
Case $msg = $fileitem
$working_dir = FileSelectFolder("Choose Folder...","",4,"") & "\"
GuiCtrlSetData($combo_ctl_working_dir, $working_dir)

; Check if user clicked on the Help Info button
Case $msg = $infoitem
MsgBox(64, "Info", "Arduino Communications Control v0.1" & @CRLF & "By: John Vaughters")

; Check if user clicked on the "File" button
Case $msg = $file_btn
$working_dir = FileSelectFolder("Choose Folder...","",4,"") & "\"
GuiCtrlSetData($combo_ctl_working_dir, $working_dir)

Case $msg = $network_btn
$network_dir = FileSelectFolder("Choose Folder...","",4,"") & "\"
GuiCtrlSetData($combo_ctl_network_dir, $network_dir)

Case $msg = $search_btn

; Start processing AVI
GUICtrlSetState ($processing, 1)

$file = FileOpen($working_dir & "command", 2)
; Check if file opened for reading OK
If $file = -1 Then
MsgBox(0, "Error", "Unable to open file.")
Exit
EndIf

; Set File Type
$working_file = GUICtrlRead($combo_ctl_search_file)
FileWrite($file, $working_file)
FileClose($file) ; The File must be closed before you can copy it anywhere
RunWait(@ComSpec & " /c " & "copy command " & $network_dir, $working_dir,@SW_HIDE)
$command_get_begin = TimerInit() ;Start the timer until you can retrieve your results
$process_results = True ; Set Processing flag

Case $msg = $site_btn
_IECreate ("www.combustory.com")

Case $msg = $clear_btn
_GUICtrlEdit_SetSel ($edit_ctl_tab2, 0, -1)
_GUICtrlEdit_ReplaceSel ($edit_ctl_tab2, "")

EndSelect

WEnd

==== Step 11 ====
''' Put all the steps together and see if it works - ''' Well ok! I deviated from the quick guide, but if you follow this step and it WORKS! then you can revel. `,~) Now we just want to get it all to work. Check list of things that need to be in place:
* Make sure the Arduino is plugged into the linux box and that the Serial monitor on the Arduino environment is not connected
* Make sure you have loaded the Arduino program from Step 3
* Now you are ready to start the ''CommandPoll'' script from Step 6
* Make sure your Windows box can browse to the mapped drive and you can see the files on your linux box
* Start the ''Arduino_Com_v.01.au3'' program by pressing F5 and set the Network Dir to your mapped drive
* Change the Working Dir if you do not want to use the Desktop (optional)
* Now click the GO button and see if you get a response (it takes about 5 sec to respond)

'''If all goes well it will look something like this:'''

[[Image:arduino_com_pic_1.jpg]]

== ''PollCommand'' User Guide ==
There is not much involved with the operation of this script. It basically looks for three files in the directory where it is started and responds to the existence of the file.
==== Requirements ====
This script requires that the ''Arduino-Serial'' program be compiled and in the same directory as the ''PollCommand'' script.
==== ''command'' file ====
When a ''command'' file is found in the directory, the script will send the contents of the file using the Arduino-Serial command to /dev/ttyUSB0. After the ''command'' file is sent, the script deletes the file. The basic usage is to copy a ''command'' file into the directory to be processed.

==== ''clear_log'' file ====
When a ''clear_log'' file is found in the directory it will clear the ''arduino_log'' file and then delete the ''clear_log'' file. The basic usage is to copy a ''clear_log'' file into the directory to be processed.
==== ''exit_poll'' file ====
When an ''exit_poll'' file is found in the directory it will close the ''tail'' process, delete the ''exit_poll'' file and then exit the script. The basic usage is to copy an ''exit_poll'' file into the directory to be processed.

== Arduino_Com_v.01 User Guide ==

==== Network Dir ====
This is the place where you must find the Windows mapped drive and path to the folder where you placed the Arduino files on the Linux box. This location is where the ''PollCommand'' script is constantly polling for a command or clear_log file and this is where the the arduino_log file is located.
==== Working Dir ====
This particular path is fairly useless and you should be able to leave it as the desktop. All that happens here is that a results file is created until it is read into the Arduino_Com_v.01 software and then it is deleted.
==== Arduino Command ====
''Basic Commands - ''The Arduino Commands data box is set up as a drop down menu with the pre-filled commands, but you can put whatever command you want in the box and then press the GO button to send the command. The commands are worth further explanation. The following commands will make the Arduino respond:
* C - will increment the Threshold value by the second digit. So a C5 will increment the Threshold by 5 points and a C9 will increment the Threshold by 9 points, and so on. If the second Character after the C is not a number, it will not increment the Threshold. The C command also prints out the Current Threshold value.
* D - will decrement the Threshold value by the second digit. So a D5 will decrement the Threshold by 5 points and a D9 will decrement the Threshold by 9 points, and so on. If the second Character after the D is not a number, it will not decrement the Threshold. The D command also prints out the Current Threshold value.
* T - will take a measurement of the current temperature and print out the current Temperature. A plain T will work without any second character.

All other commands are ignored by the Arduino, but you will get a result of the ascii values of any characters you send to the Arduino. A nice little ascii converter that came in handy when programming. Also you will notice several preceding characters and the last ascii character of each the command printed. These were for my testing and further development purposes.

''Stacking Commands - '' You are also able to stack the commands together and they will be processed as individual commands.

For instance this command:
C5TD5
will result with:
------------------------------------------------------------------
Command: C5TD5
Results:
~# THRESHOLD = 585 53
~& Temp = 520 84
~# THRESHOLD = 580 53
******************************************************************
There can be no spaces in the commands. The command will only interpret the characters before the first space.

==== Command Results ====
This text box is where the results of your command will be loaded. There is also a result that will occur when the Temperature exceeds the threshold. This is something I was playing around with on how to handle alarms from the Arduino. So for this alarm you will get the results at the next command sent.

For instance the following result was given after the T command was sent:

------------------------------------------------------------------
Command: T
Results:
~@ Hot Temp = 580
~@ Hot Temp = 580
~@ Hot Temp = 580
~@ Hot Temp = 580
~@ Hot Temp = 580
~& Temp = 577 84
******************************************************************
This indicated that the threshold had been exceeded prior to the T command, and the Hot Temp alarms had been previously printed.
==== Sys Info ====
This Tab in the results location is just a typical text box I create for some basic info about the computer.
==== Clear ====
The Clear button will clear the Command Results text box and only the command results box.

== Troubleshooting ==
=== Summary ===
When Troubleshooting a multi-functional issue, it is best practice to break down the issue into pieces and test each piece as a separate system. However, we will first run through a quick test to see if we can find any obvious issues first.
=== Quick Test ===
* '''Make sure the ''CommandPoll'' script is running - '''From the linux box, open up a terminal window and run the following command.
ps ax | grep PollCommand
You should get a result similar to this if the ''CommandPoll'' script is running:
11763 ? S 0:00 /bin/bash /home/jvaughters/arduino-0011/sketchbook/ArduinoSerial/PollCommand
11777 pts/0 S+ 0:00 grep PollCommand
If it is not running you will only get:
11777 pts/0 S+ 0:00 grep PollCommand
If that is your result, then start the ''PollCommand'' script. I prefer to start it from an Xwindow by double clicking and then clicking RUN.

* '''Make sure the ''tail'' command is running as a process - '''From the terminal window type the following command.
ps ax | grep tail
You should get a result similar to this if the ''tail'' command is running:
11770 ? S 0:00 tail -f /dev/ttyUSB0
12312 pts/0 S+ 0:00 grep tail
If it is not running you will only get:
12312 pts/0 S+ 0:00 grep tail
If ''PollCommand'' is running and ''tail'' is not, then we have a bigger problem that will need to be investigated.

* '''Make sure your Arduino is using the /dev/ttyUSB0 terminal - ''' To check this open up your Arduino programming environment and go to the ''Tools>Serial Port'' menu and check for the /dev/ttyUSB0 entry. If it is not there then the best way to find out what serial port your system is using is to unplug the USB cable and then check the the ''Tools>Serial Port'' menu again, and one of the ports should have disappeared. Now put it back and look to see which new port is added. I the port is different then /dev/ttyUSB0 then you need to replace it with your device path in every location of the ''PollCommand'' script.

* '''Make sure your ''samba'' folder is shared and writable from windows - '''From your windows box browse to the ''samba'' shared drive and verify that you can copy a small file to that shared drive from windows. Also, make sure you have mapped the shared folder in windows to a drive and that you can browse and copy a file to that drive as well. If you cannot copy the small file to the shared drive, then check your folder permissions in linux as well as any possible restrictions in ''samba''.
=== Isolating the Problem ===
If everything checked out in the Quick Test and you are still having trouble getting results, then you probably need to isolate and test the individual components of the system.
==== Linux Server ====
On the Linux box we just want to make sure that we can get the ''PollCommand'' script to accomplish it's tasks. Below we break down each part of the script and test them individually. Each test is somewhat successive, so I recommend starting from the top and working down.
===== Arduino Communication =====
Let's verify the communication between the Arduino and the linux box. We can do this from a nice utility in the Arduino programming environment called the Serial Monitor. First we need to make sure the ''PollCommand'' script is not running. Use this command to check:

ps ax | grep PollCommand
If you get a result similar to this, then the ''CommandPoll'' script is running:
11763 ? S 0:00 /bin/bash /home/jvaughters/arduino-0011/sketchbook/ArduinoSerial/PollCommand
11777 pts/0 S+ 0:00 grep PollCommand
If it is not running you will only get:
11777 pts/0 S+ 0:00 grep PollCommand
To stop the ''PollCommand'' script from running use this command in a terminal window and make sure you are in the same directory as the ''PollCommand'' script.
touch exit_poll
This command will create the file ''exit_poll'' and the existence of that file will make the ''PollCommand'' script exit. Check again to make sure the ''PollCommand'' script is not running. Also make sure that there are no ''tail'' commands running using this command:
ps ax | grep tail
You should get a result similar to this if the ''tail'' command is running:
11770 ? S 0:00 tail -f /dev/ttyUSB0
12312 pts/0 S+ 0:00 grep tail
If it is not running you will only get:
12312 pts/0 S+ 0:00 grep tail
To stop the ''tail'' commands from running try this command:
ps ax | grep "tail -f" | awk '{system("kill " $1)}'
This will kill all ''tail'' commands running, but unless you are using ''tail'' for some other reason it is safe to kill all the ''tail'' processes.

Now that we have the ''PollCommand'' script and the ''tail'' commands stopped, we can start the Serial Monitor in the Arduino programming environment by clicking the upper left button. This will give you a window in the bottom of the environment that will allow you to send and receive data to the Arduino board. make sure the baud is set to 57600, because it defaults to 9600, and my example uses 57600. Now you can type in the SEND box and click SEND to send data to the Arduino. If you have properly downloaded my example program, then you should get responses to commands sent. In the screen shot below I sent four commands: T, C5, D5, T (See description of commands in the User Guide section)

[[Image:arduino_serial_monitor.png]]

If you cannot get this to work, then change this line:
Serial.begin(57600);
With this line in your Arduino program:
Serial.begin(9600);
Now download the new program into the Arduino board, start the serial monitor again, and change the BAUD to 9600 and try the steps above again. If 9600 works and the 57600 does NOT work, then you will need to change any 57600 text in the ''CommandPoll'' script to 9600. If that still does not work, then you have bigger problems and need to make sure your Arduino install was clean.

===== ''arduino-serial'' Command Test =====
This step requires that you have successfully completed the Arduino Communications step above. If you were able to communicate via the Serial Monitor, then the next step is to verify an ''arduino-Serial'' command works. Open a terminal window and make sure you are in the shared folders where all of you files for this example reside. You also need to have the Serial Monitor in the Arduino set up and responding to sent commands. This time however, we will send the command from the command line in the terminal window using the ''arduino-serial'' command. The result will pop up in the Serial Monitor screen just as if you sent it from the Serial Monitor. I like to have the terminal window side-by-side with the Arduino environment when I do this test. Try this command: (Note: change the 57600 to 9600 if you are using that BAUD)

./arduino-serial -b 57600 -p /dev/ttyUSB0 -s T

If this does not work, make sure you have a properly compiled ''arduino-serial'' program (See Step 5). Also make sure the /dev/ttyUSB0 is the same device that your system is using to communicate with the Arduino (See the Quick Test section for a way check the device). Try again until you get this to work.
===== ''tail'' Command Test =====
This test will verify that you are able to connect the Arduino as a terminal in linux. You will need to close the Serial Monitor in the Arduino environment by just clicking the Serial monitor button again. You should not see the BAUD setting or the SEND box when the Serial Monitor is off. You will need two terminal windows open and be in the directory where the example files are located. Again side-by-side is nice. Set the terminal settings with this command: (Note: change the 57600 to 9600 if you are using that BAUD)
stty -F /dev/ttyUSB0 cs8 57600 ignbrk -brkint -icrnl -imaxbel -opost -onlcr -isig -icanon -iexten -echo -echoe -echok -echoctl -echoke noflsh -ixon -crtscts
Now do this command to test the ''tail'' command:
tail -f /dev/tty/USB0
After you hit enter, it will appear as though nothing happened, but you should see a blinking cursor. In any case go to the other terminal window and do this command:(Note: change the 57600 to 9600 if you are using that BAUD)
./arduino-serial -b 57600 -p /dev/ttyUSB0 -s T
You should now see that results in the terminal window where you typed the ''tail'' command. If this does not work, make sure the /dev/ttyUSB0 is the same device that your system is using to communicate with the Arduino (See the Quick Test section for a way check the device). Try again until you get this to work.

To end the ''tail'' command just click into the terminal window where you typed the ''tail'' command and hit ctrl-c.

Assuming that worked, the next step would be to redirect the ''tail '' command to a file. Use this command:
tail -f /dev/ttyUSB0 >> arduino_log
Now use the arduino-serial command to send data again and then use this command to check if the file is recieving the data:
cat arduino_log
To clear the arduino_log file use this command:
echo > arduino_log
At this point I am going to point you to the ususal suspects for any issues, ie. BAUD and /dev/ttyUSB0

You must be able to get this to work if you expect the overall system to work.
===== ''samba'' =====
Troubleshooting ''samba'' is way beyond the scope of this document. All I can say is that you need to make sure that the shared directory is set to Create and Delete permission for others.

==== Windows Client ====
On the Windows box we will want to make sure we can see the shared folder and that the mapped drive is working. One important note is if your network drive is not connected, or you have not listed it correctly in the Network Dir, the Arduino_Com_v.01 will crash. You will need to be able to copy files to the shared folder and mapped drive. For this section the ''PollCommand'' script should NOT be running.
==== File Copy/Write Tests ====
Open an explorer window or a command line window and go navigate to your mapped drive and path. Check the directory and make sure there is no ''command'' or ''clear_log'' files. Then start up the Arduino_Com_v.01 script and send a command. Now check that mapped directory and make sure the files ''command'' and ''clear_log'' are in the proper shared directory. If the Arduino_Com_v.01 script just shuts off, then it could not get to the Network Dir that you provided. If you provided the correct Network Dir and it still crashes then try to re-map the drive again. If the program does not shut down, and you do not see the files in the directory, then you probably have a valid location, but it is not the correct directory where the ''CommandPoll'' script is runs.

[[Category:Electronics]]

{{default}}

Template:Basic Article Structure

2008-09-06T19:22:50Z

Combustor: New page: == Summary == == Functional Description of the Method == == Requirements == == Example of Method == === Quick Guide: === === Detailed Guide: === == Arduino_Com_v.01 User Guide == ==== Ardu...

== Summary ==
== Functional Description of the Method ==
== Requirements ==
== Example of Method ==
=== Quick Guide: ===
=== Detailed Guide: ===
== Arduino_Com_v.01 User Guide ==
==== Arduino Command ====
== Troubleshooting ==
=== Summary ===
When Troubleshooting a multi-functional issue, it is best practice to break down the issue into pieces and test each piece as a separate system. However, we will first run through a quick test to see if we can find any obvious issues first.
=== Quick Test ===

Arduino Electronics

2008-09-06T19:14:54Z

Combustor:

{{default}}

== Summary ==

Arduino is an open-source hardware platform. It is a micro controller with a free development environment that is greatly simplified for programming the controller. Visit this website for further details, http://www.arduino.cc/

== Topics ==

* [[Arduino Communications]] - A distributed network approach
* [[Temperature Controller]] - A/C control for multi-room space with air duct throttling (ie. Smart Thermostat)
* [[MPGuino]] - An MPG gauge based on the Arduino Platform
* Suggestions Welcome

== Links ==
[[Category:Electronics]]

Main Page

2008-08-26T18:00:44Z

Combustor:

{{default}}


== Goal ==

My original Goal was to create a website that is the most comprehensive website for Automobiles. However, as I soon found out while looking for a Domain Name that there were not many good choices related to cars. Some how I came up with Combustory and it made me think of the History of Combustibles in general. So I decided on a site that would include all machines dependent on Combustibles. As you can see from the list below it is a fairly significant task that will require a world of help, so please feel free to join in the task by emailing me to create an account and start creating content.

Contact: combustor@combustory.com

<big>'''Categories'''</big>

* [[Motorcycles]] (Coming)
* [[Cars]]
* [[Trucks]] (Coming)
* [[Tractors]] (Coming)
* [[Earth Movers]] (Coming)
* [[Tanks]] (Coming)
* [[Airplanes]] (Coming)
* [[Jets]] (Coming)
* [[Rockets]] (Coming)
* [[Helicopters]] (Coming)
* [[Locomotives]] (Coming)
* [[General Electronics]]

== Creators Note ==

== Links ==

Template:Default

2008-08-26T17:59:42Z

Combustor:

<big>Welcome to [http://combustory.com Combustory]</big>



'''Any questions or comments:'''
* Go to the discussion tab above and add comments or questions
* Or, Send them to - combustor@combustory.com

Cars

2008-08-26T14:14:59Z

Combustor:

{{default}}

== American Makers ==

* [[GMC]](Coming)
* [[Buick]](Coming)
* [[Cadillac]](Coming)
* [[Oldsmobile]](Coming)
* [[Chevrolet]](Coming)
* [[Pontiac]](Coming)
* [[Saturn]](Coming)
* [[Ford]](Coming)
* [[Lincoln]](Coming)
* [[Mercury]](Coming)
* [[Chrysler]](Coming)
* [[Dodge]](Coming)
* [[Jeep]](Coming)
* [[AMC]](Coming)
* [[Auburn]](Coming)
* [[Studebaker]](Coming)
* [[Duesenberg]](Coming)
* [[Cord]](Coming)

== European Makers ==

* [[BMW]] (Coming)
* [[Mercedes]](Coming)
* [[Volkswagon]](Coming)
* [[Porsche]](Coming)
* [[Fiat]](Coming)
* [[Volvo]](Coming)
* [[MG]](Coming)
* [[Jaguar]](Coming)
* [[Fiat]](Coming)
* [[Audi]](Coming)
* [[Alpha Romeo]](Coming)
* [[Maserati]](Coming)
* [[Ferrari]](Coming)
* [[Bugati]](Coming)
* [[Lamborghini]](Coming)
* [[Saab]](Coming)
* [[Peugeot]](Coming)
* [[Renault]](Coming)
* [[Yugo]](Coming)
* [[Opel]](Coming)
* [[Rolls Royce]](Coming)
* [[Land Rover]](Coming)

== Asian Makers ==

* [[Nissan]](Coming)
* [[Infinity]](Coming)
* [[Datsun]](Coming)
* [[Toyota]](Coming)
* [[Lexus]](Coming)
* [[Scion]](Coming)
* [[Honda]](Coming)
* [[Accura]](Coming)
* [[Mazda]](Coming)
* [[Mitsubishi]](Coming)
* [[Hyundai]](Coming)
* [[Kia]](Coming)
* [[Subaru]](Coming)
* [[Isuzu]](Coming)
* [[Tata]](Coming)
* [[Chery]](Coming)

== Creators Note ==

MPGuino

2008-08-26T13:59:08Z

Combustor:

{{default}}
[[Image:MPGuino_Enclosure_mounted.jpg|right|thumb|400px|]]

== Summary ==

This is an impressive use of the Arduino platform. One that will actually pay for itself too. A small group of folks banded together and created an open platform called http://opengauge.googlecode.com where you will not really find much information concerning this device, but there are lots of information in a forum at http://www.ecomodder.com, where you will find tons of useful and fun ways on improving gas mileage for any car. To explain what these folks did for the average working Joe, who can't quite afford a car newer than 1995, is just amazing. It still works for just about any car with fuel injection, but for cars built before 1996, there is no [[OBD-II Diagnostic Tools | OBD-II]] option.

They came up with a way to build a reasonably low-cost device that will gauge your MPG, even for cars that do not have an [[OBD-II Diagnostic Tools | OBD-II]] interface in there car. At the moment it is restricted to use in cars with fuel injection, but given enough time they may even find a way to gauge cars with carburetors. To cut to the chase, this device uses inputs from the Vehicle Speed Sensor(VSS) and one fuel injector control wire, both of which are easily found in just about all fuel injected cars, minus mechanical fuel injection, which only Mercedes seemed to make reliably albeit expensively. So, sorry all those 300E owners, you can't play with this toy right now.

The device sports an LCD screen with many display features that include Current,Instant and Tank MPG as well as Trip data for MPG, Mileage, and Tank Gallons. There are many other options and I recommend you reference the User Guide below for more detail.

== Functional Description of the Solution ==

To further detail the solution, the VSS provides a pulse input related to the speed and distance traveled, meaning from this sensor you know how fast the car is going from the pulse frequency and how far the car has traveled by counting the actual number of pulses. Pulses per mile vary from car to car and based on the forum I saw a range in the 4,000 - 10,000 pulses per mile. The injector control wire provides the fuel flow mass. By making the relation of the known flow rate of an injector and the amount of time that the injector is turned on, you can calculate the the actual fuel mass flow rate your car is using.

On the electronics side they used the Arduino platform as the microprocessor and threw in some supporting components to prevent small fires that create anger and horrible smells. I hate the smell of fried electronics, unfortunately I know it too well. The microprocessor polls the sensors in the micro-second realm, and writes the results to the LCD in the 1/2-1 sec. realm. This gives the user a near real time view of the actual data.

There really is not much at the high level design function, but as they say, "The Devil is in the Details".

== Theory of Operation ==

'''Fuel Injectors'''

To completely simplify a fuel injector, just imagine a water faucet valve. When the valve is open, the water flows out. The amount of water that flows out depends on the size of the faucet opening and the pressure of the water behind the faucet. For a fuel injector, the manufacturers specify a lbs/hr of fuel flow by knowing the opening of the injector and specifying the constant pressure for which the injector supply is supposed to maintain. Therefore, if you provide the proper pressure to the injector as specified and you open the injector for one hour, you should get the specified pounds of fuel flowing out of the injector. For example, a 20 lb/hr injector will supply 20lbs of fuel if left turned on for one hour.

This makes the calculation fairly simple to determine a fuel flow rate for your car by measuring the total amount the injector is open that comes from the Injector Sensor of the MPGuino and it is measured through the pulse width sent to the injector by the car computer. Also known as the injector pulse width. So the total time for each pulse width over a given time is the total time an injector is open. This measurement is usually taken in a second time frame and an injector has a limitation known as a frequency response or a max number of pulses per second, which is related to the mechanical response time that the injector can open or close. The MPGuino measures the total time the injector is open, so we will just take that number as a known measured value.

Ti = Time the injector is open as a ratio of a known time = For calculation purposes we will set it at usec/sec

Fr = Fuel flow rate is a known from the manufacturer in lbs/hr

Therefore:

Fuel usage rate = Fr (lbs/hr) / 3600 (sec/hr) * Ti (usec/sec) /1000 = (lbs/sec)

<math >Fu = \frac{Fr}{3600} * \frac {Ti}{1000}</math >

Example:

Ti = 500 usec/sec as measured by MPGuino

Fr = 20 lbs/hr as specified by manufacturer

<math > Fuel\ usage\ rate = \frac{20}{3600} * \frac{500}{1000} = 0.0028 (lbs/sec)</math >

'''VSS - Vehicle Speed Sensor'''

The VSS count is fairly straight forward. There is a device on your car that rotates and creates a certain number of pulses per revolution. The sensor is usually attached to your transmission and it has a direct gear ratio to your tires that I will call the rolling ratio. This sensor is used to feed the vehicle computer the speed and distance data. The actual gear ratio has only one main variation, and that is the tire diameter. For the MPGuino to calculate the the MPG, this input is critical for determining the distance traveled. The VSS count is typically measured in counts per mile.

'''Theory vs. Reality'''

As with any engineering of a product you will have fudge factors. The important thing to realize is that you always design to get the fundamentals close and then expect to calibrate to meet the accuracy needed for the function. For this product we will evaluate the best way to calibrate and adjust to improve the accuracy of the numbers. This may not be necessary at all if your goal is to get feedback on your driving habits, then the accuracy does not matter, as long as you realize that the MPGuino is changing your driving habits to conserve gas AND best of all save you money.

So first let's discuss the factors that will affect your accuracy.

Factors NOT in our control:

Is it possible to control or measure these factors? yes, is it practical? not in my opinion. So these factors will introduce errors that will need compensation in the fudging process. I feel it is a pretty safe assumption that over time these factors will average within a range that will permit fudging.

''Injector Pressure'' - Your car has a pressure regulator to manage your fuel manifold pressure, and it will regulate to it's setting. You could measure your pressure, but then you would have to know how that affects the fuel flow through the injector. We also do not know how the pressure changes over time and this can affect your fuel flow.

''Injector Efficiency'' - Well, since MPGuino is a device that was targeted to older cars, then you have to expect that injectors tend to clog and become less efficient over time. The only way to calibrate that problem is to measure the actual flow through each injector. Have fun if you want to tackle that project. `,~)

''Rolling Ratio'' - The rolling ratio is a constant changing ratio that will affect your VSS counts per mile. The main reason it changes over time is due to tires. As a tire gets more worn your VSS counts per mile will increase. When you replace that old set of tires with new tires, you will have less counts per mile.

'''Fudging/Calibration process'''

There are two areas I want to focus on to get this system as accurate as possible. Let's consider fudging the fuel flow rate and measuring the VSS counts per mile. I am taking this approach, because measuring the VSS counts is a practical option and it can be done with some accuracy. In contrast the fuel flow rate used to calculate the total fuel usage is not very measurable and therefore should be fudged.

To measure the VSS counts per mile get on the highway and find a mile marker and reset you VSS counts to zero. Drive ten miles as marked by the mile markers and note your VSS counts. Divide by ten to get your VSS counts per mile. Take an average of this process if you really want to nail it down, but I do not feel that is necessary. You may need to test this count every 6-12 months to readjust this number. You can compare your numbers to you odometer, but understand that the odometer does not take into account the tire diameter as accurately as your measurement, but it can be used as a verification that you are in the ball park. The best verification would be if you noticed that you have a fairly repeatable offset from the odometer and your calculation.

To measure the fuel is much more difficult. Really the best way to do measure the fuel would be to drain the tank and run the tank dry of fuel. Now weigh the amount of fuel and put it in the tank. Run the tank dry again and compare the actual fuel usage with the MPGuino. Again do this multiple times and take the average. Personally I would not do this at all, but it is the only real way to get acuracy. For a much more practical method, start a fuel usage log. Go to many different gas pumps and take an average over time. I have noticed that the cheapest gas stations tend to calibrate to the high side of the legal limit, if not actually outside the legal limit. Try to keep a standard procedure, like only filling to the first click off. Compare your fuel usage average to your MPGuino fuel usage average and look for a trend. Now fudge the fuel usage to match.

== Requirements and Knowledge ==

* Basic soldering and electronic building skill
* The following parts list for the Arduino assembly
** 2 5.1v zener diodes
** 1 2n3906 PNP Transistor
** 1 220 ohm resistor
** 2 100k resistors
** 3 tactile switches
** 1 freeduino arduino clone (any arduino can probably be made to work) i.e. an iduino: http://spiffie.org/kits/iduino/ or a Freeduino
** 1 LCD (others might work as well, check pinout and chipset, etc). 16x2 LCD Module While Characters Blue Backlight Or a green one from sparkfun or mouser (a number of folks like the green ones better)
** Sufficient Perfboard
** A case to hold it all together
* Additional parts for the iDuino assembly
** 1 7805 Voltage Regulator
** 1 1n4004 diode
** 330 uf cap
** 1 .1uf cap.
* You will need to find the wires for the VSS on the vehicle computer or control unit.
* If you're lucky you won't need much troubleshooting skills

== Assemble the Electronics ==

Here are the schematics. This should be enough for most of you. There are two assemblies that are possible to build. The Arduino or the iDuino.

Notes:

* The only two output leads for the VSS and the injector, other than that a 12vdc supply, and that is it.
* The Analog pins in this schematic show 0-5 are used as digital I/O, therefore, Analog pin 0 is Digital pin 14 then count up from there.

<big>'''Arduino Assembly Schematic'''</big>

[[Image:MPGuino_Schematic.GIF]]

<big>'''iDuino Assembly Schematic'''</big>

[[Image:iDuino_Schematic.GIF]]

== Enclosures ==

{| Border=1
|+ <big>'''MPGuino Arduino Enclosure Pics - [http://www.hitechcontrols.com/hensel/polycarbonate/smooth/kf8040.htm KF 8040 - Polycarbonate Indoor/Outdoor Enclosures]]'''</big>
|-
|[[Image:MPGuino_Enclosure_Front.jpg|thumb|400px|]]|| [[Image:MPGuino_Enclosure_Inside.jpg|thumb|400px|]] || [[Image:MPGuino_Enclosure_mounted.jpg|thumb|400px|]]
|}

{| Border=1
|+ <big>'''MPGuino iDuino Enclosure Pics - [[http://www.radioshack.com/product/index.jsp?productId=2062280&cp=&sr=1&origkw=project+box&kw=project+box&parentPage=search Radio Shack Enclosure]]'''</big>
|-
| [[Image:MPGuino_iDuino_Front.jpg|thumb|400px|]] || [[Image:MPGuino_iDuino_Inside_Front.jpg|thumb|400px|]] || [[Image:MPGuino_iDuino_Inside_Guts_Front.jpg|thumb|400px|]]
|-
| [[Image:MPGuino_iDuino_Back.jpg|thumb|400px|]] || [[Image:MPGuino_iDuino_Inside_Back.jpg|thumb|400px|]] || [[Image:MPGuino_iDuino_Inside_Guts.jpg|thumb|400px|]]
|}

== User Guide ==

'''Screens'''

1. Instant MPG/Speed
Current MPG/Distance

2. Instant MPG/Speed
Tank MPG/Distance

3. Large font instant MPG

4. Large font current MPG

5. Large font tank MPG

6. Current MPH, MPG, Miles, Gallons

7. Tank MPH, MPG, Miles, Gallons

8. Instant Raw Data (very useful for connection troubleshooting)
Injector open seconds, Injector open microSeconds,
Injector pulse count, Vehicle Speed Sensor pulse count

9. Current trip Raw Data
Injector open seconds, Injector open microSeconds,
Injector pulse count, Vehicle Speed Sensor pulse count

10. Tank trip Raw Data
Injector open seconds, Injector open microSeconds,
Injector pulse count, Vehicle Speed Sensor pulse count

11. CPU Monitor
Max CPU %utilization, Tank running Time mm.ss,
Free Memory (bytes)

'''Start-up Settings'''

There is also a setup screen that displays the first time the program is run and by pressing all three buttons at once. It walks you through the following setup variables. Use left and right buttons to select the digit you wish to change or the OK or Cancel (XX) items. Use middle button to rotate the current digit or select OK or XX if that is where the cursor is. Selecting OK will save the currently displayed value to the current variable and advance to the next variable. Selecting XX will just advance to the next variable.

1. Contrast - This comes up first on a brand new run and changes on the screen are immediate so if you can't see anything try pressing middle button a few times.

2. VSS Pulses/Mile - use this to adjust displayed speed/miles. If the speed/miles displayed on the mpguino is low then decrease this number by the percentage that it is off and vice versa for high readings. Most asian cars will be a multiple of 8204 and GM will be 10000, we are hoping users will contribute model specific data here.

3. MicroSec/Gallon - use this to adjust displayed fuel consumption. You may want to readjust this initially to get a ballpark MPG reading (after VSS Pulses/Mile is deemed accurate), then calibrate it with a couple fillups. If the mpguino displayed MPG is high or the displayed tank gallons is low at fillup then reduce MicroSec/Gallon by the percentage that the gallons are low or the displayed mpg is high. Like the vss pulses, this would benefit from user contributions about what values work for what specific cars.

4. Pulses/2 revs - not currently used, but a single injector on a 4 cylinder sequential system will make 1 squirt in 2 revolutions. Hope to be able to base RPM on this at some point.

5. Timout(microSec) - defaults to 7 minutes. If there are no injector or speed signals from the car and no buttons are pressed in that time then the display backlight turns off. When activity resumes the display will turn back on and the current trip will reset and the tank trip will be restored to the point of last activity.

6. Tank Gal * 1000 - not currently used, but defaults to 13300 or 13.3 gallons.

7. Injector DelayuS - Represents the mechanical delay of the injector in microseconds. Advanced topic.

'''Button Functions'''

1. left: cycle through screeens in reverse

2. middle: cycle through pre-defined brightness settings

3. right: cycle through screeens forward

4. left+middle: tank reset

5. right+middle: current reset

6. left+middle+right: go to setup screen

== Table of Car Settings ==

'''I am looking for data here, if you have a car to add, email me at combustor@combustory.com with the data.'''

{| Border=1
|+ MPGuino Car Settings
! Car Year Make Model !! Engine !! Transmission !! VSS (count/mile) !! usec/gal
|-
|1989 Chevy Celebrity|| 3.1 || 4 spd auto || 4000 || 0240000000
|-
|1990 Mitsubishi Eclipse GST || 2.0 litre || 5 speed || 16364 || 126180393
|-
|1994 Suzuki Swift GA Sedan|| 1.3 Liter || 5 Speed || ???? || ????
|-
|1996 Jeep Wrangler || 4.0 Liter || 5 speed || ???? || ????
|-
|1997 Saturn SL2,SC2,SW2,S2|| 1.9 || || 10000 || 0289967320
|-
|2005 Subaru Impreza Outback Sport, 2.5RS || 2.5L N/A || 5MT || 8000 || 183165000 (still calibrating)
|}

== Software & Release notes ==

Here are the latest release notes as of this writing. Get the latest SW from [[The Arduino Code]]

'''8/9/2008 updates for v0.70'''

More experiments with vss processing. Instant mph is very smooth on saturn but still jumps a bit on the metro. Distance reading on metro appears reasonably accurate (102.6 miles on odo, 102.18 on mpguino using 8208 vsspulses/mile). So the guino is doing a pretty good job of counting the vss pulses, it is a little erratic in timing the pulses though.

want to add EOC miles to the trip next, don't know if it will fit
sketch size: 12884

'''8/1/2008 updates for v0.69'''

Added event handler and added debouncing on vss. Still trying to clean up reed switch vss signal via software with no luck. will make separate post for vss issue.

Added instantaneous mph (mpg is next), this looks at the time between vss peaks to determine the speed instead of the number of pulses in the last half second, which was jumpy at slow speeds. We are getting really really tight on space. That might also be an issue when 0012 comes out (don't know when).

'''8/1/2008 updates for v0.68'''

Removed all dependencies on timer0 so we should be arduino 0012 compatible. This also establishes an ISR under our control for scheduling events. Disabled Timer0 so use millis2(), delay2(), etc.

Knocked off a few hundred bytes by converting LCD to a namespace instead of a class.

'''7/10/2008 updates for v0.67'''

Incorporated LCD timings from Yoshi, removed pin 15 code and power up detection code.

moved source code to google/svn Revision 32: /trunk

other happenings:
did a test with the scope regarding the voltage drop at peak pulse. I had the guino set a pin high and low within the interrupts receiving high and low and the pulse widths were the same except the generated one was perfectly square. So that is a good thing. Will need to test exactly what voltage level is acceptable.

The power supply on the scope died I think I just need a new TL431C or NTE999 though. I didn't get a chance to witness the vss bounce, the scope died during the attempt.

I am planning on moving all timing critical code to timer 2 with an event handler. I need real interrupt style debouncing for the vss and might as well use it as an event scheduler for debouncing the buttons as well as whatever else. This move will also allow for arduino0012 compatability.

'''6/27/2008 updates for v0.66'''

ADDED AN ONBOARD VARIABLE EDITOR!!! VARIABLES STORED IN EEPROM!! Now you can upgrade and not lose your settings and make adjustments in the car. Refer to post 1[/url] for screens and edit usage.

Updated screens descriptions in post 1

Checked source into sourceforge.net, linked post 1 to sourceforge (ran out of room again and wiki didn't like the extension .pde).

Sketch size 11734, 448 bytes free

'''6/26/2008 updates for v0.65'''

Added 7 minute activity timeout. It saves the state of the persistent trips (just tank for now) at the point of last activity and after 7 minutes of no injector pulses/vss pulses/or button presses, it turns off the LED backlight and sets up current to be reset and tank to be restored when activity resumes.

Despazed the buttons and Screen labels so they display for a second and accidental double button presses are minimized.

Running out of excuses (and room) to no do the user input/eprom setup screen thing Sketch size 10502 bytes.

'''6/23/2008 updates for v0.64'''

Fixed instant/tank screen (was displaying instant/current on that screen).

Improved LCD reinit on reprogram/reset. Can (usually) tell if LCD needs reinitializing. Press left and right buttons to force an LCD init if necessary. Want to free pin 15 for future tasks if it works well enough.

Added a bit of default verbiage to debug mode.

Working on a portable scope deal.

'''6/20/2008 updates for v0.63'''

Wrote 64bit arithmetic routines, yay no more messing with "ifs" when it should be math!

Noticed double vss count didn't make it in .62, fixed.

Subtracting 500uS from each injector pulse.

Added cli/sei around top of loop trip copy.

Made big font a smidgeon bolder.

Code updated, sketch size 9812, CPU 54%, free mem 602
[[Category:Electronics]]

Template:Default

2008-08-26T13:54:55Z

Combustor:

CarCopter

2008-08-25T17:28:23Z

Combustor:

{{default}}

== A Helicopter made from car parts? ==

[[image:Carcopter.jpg]]

That's right! Mubarak Muhammad Abdullahi takes old cars and motorbikes to pieces in the back yard at home and builds his own helicopters from the parts. He is a 24-year-old physics undergraduate in northern Nigeria and he has found the right formula for turning cars into helicopters. This is more than just a hobby for him, it is a sense of national pride. He has been trying to get support from the Nigerian Government as well as other wealthy countrymen. Although some government officials got very excited when they saw him conduct a demonstration flight in neighbouring Katsina state, Nigeria’s Civil Aviation Authority (NCAA) has so far shown no interest in his aircraft. The chopper, which has flown briefly on six occasions, is made from scrap aluminium that Abdullahi bought with the money he makes from computer and mobile phone repairs, and a donation from his father, who teaches at Kano’s Bayero university.

Abdullahi explained from the cockpit, “You start it, allow it to run for a minute or two and you then shift the accelerator forward and the propeller on top begins to spin. The further you shift the accelerator the faster it goes and once you reach 300 rmp you press the joystick and it takes off.” For a four-seater it is a big aircraft, measuring twelve metres (39 feet) long, seven metres high by five wide. It has never attained an altitude of more than seven feet. It is powered by a second-hand 133 horsepower Honda Civic car engine and kitted out with seats from an old Toyota saloon car. Its other parts come from the carcass of a Boeing 747 which crashed near Kano some years ago.

This is not the end of this bright young man's career. He is working on a second model that is supposed to double the performance of his first one. He expects this new model to fly 15 feet for at least three hours. To learn more about this respectable accomplishment:

<google>Mubarak Muhammad Abdullahi</google>

CarCopter

2008-08-25T17:06:45Z

Combustor: New page: {{default}} == A Helicopter made from car parts? == image:Carcopter Contact: combustor@combustory.com <big>'''Categories'''</big> * Motorcycles (Coming) * Cars * [[Truck...

{{default}}

== A Helicopter made from car parts? ==

[[image:Carcopter]]

Contact: combustor@combustory.com

<big>'''Categories'''</big>

* [[Motorcycles]] (Coming)
* [[Cars]]
* [[Trucks]] (Coming)
* [[Tractors]] (Coming)
* [[Earth Movers]] (Coming)
* [[Tanks]] (Coming)
* [[Airplanes]] (Coming)
* [[Jets]] (Coming)
* [[Rockets]] (Coming)
* [[Helicopters]] (Coming)
* [[Locomotives]] (Coming)
* [[General Electronics]]

== Creators Note ==

== Links ==

Template:Featured Picture

2008-08-25T16:13:29Z

Combustor:

[[Image:Carcopter.jpg]]

A car made into a helicopter? [[CarCopter | Find out more...]]

Main Page

2008-08-25T16:11:35Z

Combustor:

{{default}}


{| id="mp-tfp" style="margin:4px 0px 0px 0px; width:30%; background:none;"
|class="MainPageBG" style="width:30%; border:1px solid #ddcef2; background:#faf5ff; vertical-align:top; color:#000;"|
{| cellpadding="2" cellspacing="5" style="vertical-align:top; background:#faf5ff; color:#000; width:30%"
! <h3 id="mp-tfp-h2" style="margin:0; background:#ddcef2; font-size:120%; font-weight:bold; border:1px solid #afa3bf; text-align:top; color:#000; padding:0.2em 0.4em">Featured picture</h3>
|-
|style="color:#000;"| {{Featured Picture}}
|}
|}

== Goal ==

My original Goal was to create a website that is the most comprehensive website for Automobiles. However, as I soon found out while looking for a Domain Name that there were not many good choices related to cars. Some how I came up with Combustory and it made me think of the History of Combustibles in general. So I decided on a site that would include all machines dependent on Combustibles. As you can see from the list below it is a fairly significant task that will require a world of help, so please feel free to join in the task by emailing me to create an account and start creating content.

Contact: combustor@combustory.com

<big>'''Categories'''</big>

* [[Motorcycles]] (Coming)
* [[Cars]]
* [[Trucks]] (Coming)
* [[Tractors]] (Coming)
* [[Earth Movers]] (Coming)
* [[Tanks]] (Coming)
* [[Airplanes]] (Coming)
* [[Jets]] (Coming)
* [[Rockets]] (Coming)
* [[Helicopters]] (Coming)
* [[Locomotives]] (Coming)
* [[General Electronics]]

== Creators Note ==

== Links ==

Main Page

2008-08-25T15:58:49Z

Combustor:

{{default}}


{| id="mp-tfp" style="margin:4px 0px 0px 0px; width:30%; background:none;"
|class="MainPageBG" style="width:30%; border:1px solid #ddcef2; background:#faf5ff; vertical-align:top; color:#000;"|
{| cellpadding="2" cellspacing="5" style="vertical-align:top; background:#faf5ff; color:#000; width:30%"
! <h3 id="mp-tfp-h2" style="margin:0; background:#ddcef2; font-size:120%; font-weight:bold; border:1px solid #afa3bf; text-align:left; color:#000; padding:0.2em 0.4em">Featured picture</h3>
|-
|style="color:#000;"| {{Featured Picture}}
|}
|}

== Goal ==

My original Goal was to create a website that is the most comprehensive website for Automobiles. However, as I soon found out while looking for a Domain Name that there were not many good choices related to cars. Some how I came up with Combustory and it made me think of the History of Combustibles in general. So I decided on a site that would include all machines dependent on Combustibles. As you can see from the list below it is a fairly significant task that will require a world of help, so please feel free to join in the task by emailing me to create an account and start creating content.

Contact: combustor@combustory.com

<big>'''Categories'''</big>

* [[Motorcycles]] (Coming)
* [[Cars]]
* [[Trucks]] (Coming)
* [[Tractors]] (Coming)
* [[Earth Movers]] (Coming)
* [[Tanks]] (Coming)
* [[Airplanes]] (Coming)
* [[Jets]] (Coming)
* [[Rockets]] (Coming)
* [[Helicopters]] (Coming)
* [[Locomotives]] (Coming)
* [[General Electronics]]

== Creators Note ==

== Links ==

Template:Featured Picture

2008-08-25T15:52:43Z

Combustor:

[[Image:Carcopter.jpg]]

[[CarCopter | Find out more...]]

File:Carcopter.jpg

2008-08-25T15:50:24Z

Combustor:

Template:Featured Picture

2008-08-25T15:47:50Z

Combustor: New page: Image:CarCopter.jpg

[[Image:CarCopter.jpg]]

Main Page

2008-08-25T15:45:20Z

Combustor:

{{default}}


{| id="mp-tfp" style="margin:4px 0px 0px 0px; width:100%; background:none;"
|class="MainPageBG" style="width:100%; border:1px solid #ddcef2; background:#faf5ff; vertical-align:top; color:#000;"|
{| cellpadding="2" cellspacing="5" style="vertical-align:top; background:#faf5ff; color:#000; width:100%"
! <h3 id="mp-tfp-h2" style="margin:0; background:#ddcef2; font-size:120%; font-weight:bold; border:1px solid #afa3bf; text-align:left; color:#000; padding:0.2em 0.4em">Featured picture</h3>
|-
|style="color:#000;"| {{Featured Picture}}
|}
|}

== Goal ==

My original Goal was to create a website that is the most comprehensive website for Automobiles. However, as I soon found out while looking for a Domain Name that there were not many good choices related to cars. Some how I came up with Combustory and it made me think of the History of Combustibles in general. So I decided on a site that would include all machines dependent on Combustibles. As you can see from the list below it is a fairly significant task that will require a world of help, so please feel free to join in the task by emailing me to create an account and start creating content.

Contact: combustor@combustory.com

<big>'''Categories'''</big>

* [[Motorcycles]] (Coming)
* [[Cars]]
* [[Trucks]] (Coming)
* [[Tractors]] (Coming)
* [[Earth Movers]] (Coming)
* [[Tanks]] (Coming)
* [[Airplanes]] (Coming)
* [[Jets]] (Coming)
* [[Rockets]] (Coming)
* [[Helicopters]] (Coming)
* [[Locomotives]] (Coming)
* [[General Electronics]]

== Creators Note ==

== Links ==

Template:Default

2008-08-25T15:45:00Z

Combustor:

<big>Welcome to [http://combustory.com Combustory]</big>

<google></google>
<google>CH02</google>

'''Any questions or comments:'''
* Go to the discussion tab above and add comments or questions
* Or, Send them to - combustor@combustory.com

{{Feature Articles}}

Main Page

2008-08-25T15:44:10Z

Combustor:

{{default}}
{{Feature Articles}}

{| id="mp-tfp" style="margin:4px 0px 0px 0px; width:100%; background:none;"
|class="MainPageBG" style="width:100%; border:1px solid #ddcef2; background:#faf5ff; vertical-align:top; color:#000;"|
{| cellpadding="2" cellspacing="5" style="vertical-align:top; background:#faf5ff; color:#000; width:100%"
! <h3 id="mp-tfp-h2" style="margin:0; background:#ddcef2; font-size:120%; font-weight:bold; border:1px solid #afa3bf; text-align:left; color:#000; padding:0.2em 0.4em">Featured picture</h3>
|-
|style="color:#000;"| {{Featured Picture}}
|}
|}

== Goal ==

My original Goal was to create a website that is the most comprehensive website for Automobiles. However, as I soon found out while looking for a Domain Name that there were not many good choices related to cars. Some how I came up with Combustory and it made me think of the History of Combustibles in general. So I decided on a site that would include all machines dependent on Combustibles. As you can see from the list below it is a fairly significant task that will require a world of help, so please feel free to join in the task by emailing me to create an account and start creating content.

Contact: combustor@combustory.com

<big>'''Categories'''</big>

* [[Motorcycles]] (Coming)
* [[Cars]]
* [[Trucks]] (Coming)
* [[Tractors]] (Coming)
* [[Earth Movers]] (Coming)
* [[Tanks]] (Coming)
* [[Airplanes]] (Coming)
* [[Jets]] (Coming)
* [[Rockets]] (Coming)
* [[Helicopters]] (Coming)
* [[Locomotives]] (Coming)
* [[General Electronics]]

== Creators Note ==

== Links ==