Last week’s post was rather long because (as is often the case in this work) there was a lot we had to go over before we could start writing code. That article ended with the presentation of a state diagram describing a state machine for a very simple temperature controller. This week we have on our plate the task of turning that state diagram into LabVIEW code that implements the state machine functionality.
The first step in that process is to consider in more detail the temperature control process that the state diagram I presented last week described in broad terms. By the way, as we go through this discussion please remember that the point of this exercise is to learn about state machines — not temperature control techniques. So unless your application is to manage the internal temperature of a hen-house, dog-house or out-house; don’t use this temperature control algorithm anywhere.
How the demo works
The demonstration is simulating temperature control for an exothermic process — which is to say, a process that tends to warm or release heat into the environment over time. To control the temperature, the system has two resources at its disposal: an exhaust fans and a cooler. Because the cooler is actively putting cool air into the area, it has a very dramatic effect on temperature. The fan, on the other hand, has a much smaller effect because it is just reduces the heat through increased ventilation.
When the system starts, the state machine is simply monitoring the area temperature and as long as the temp is below a defined “High Warning Level” it does nothing. When that level is exceeded, the system turns on the fan, as shown by the fan light coming on. In this state, the temperature will continue to rise, but at a slower rate.
Eventually the temperature will, exceed the “High Error Level” and when it does, the system will turn on the cooler (it has a light too). The cooler will cause the temperature to start dropping. When the temperature drops below the “Low Warning Level” the fan will turn off. This action will reduce the cooling rate, but not stop it completely. When the temperature reaches the “Low Error Level”, the cooler will turn off and the temperature will start rising again.
So let’s look at how our state machine will implement that functionality.
As I stated last week, the basic structure is an event structure with most of the state machine functionality built into the timeout case. To get us started with a little perspective, this is what the structure as a whole looks like.
Obviously, from the earlier description, this state machine will need some internal data in order to perform its work. Some of the data (the 4 limit values and the sample interval) is stored in the database, while others are generated dynamically as the state machine executes. Regardless of its source, all of this data is stored in a cluster, and you can see two of the values that it contains being unbundled for use.
Timeout is the timeout value for the event structure and is initialized to zero. The
Mode value is an enumeration with two values. In the
Startup case is the logic that implements startup error checking and reads the initial setup values from the database. When it finishes, it sets
Mode to its other value:
Run. This is where you will find the bulk of the state machine logic. Note that while I don’t implement it here, this logic could be expanded to provide the ability to do such things as pause the state machine.
The following sections describe the function of each state and shows the code that implements it.
This state is responsible for getting everything initialized and ready to run.
In a real system, the logic represented here by a single hardware initialization VI would be responsible for initializing the data acquisition, verifying that the system is capable of communicating with the fan and cooler, and reading their operational states. Consequently, this logic might be 1 subVI or there might be 2 or 3 subVIs. The important point is to not show too much detail in various states. Use subVIs. Likewise, do not try to expand on the structure by adding multiple initialization states.
Finally, note that while the selection logic for the next state may appear to be a default transition, it isn’t. The little subVI outside the case structure actually creates a two-way branch in the logic. If the incoming error cluster is good, the incoming state transitions (in this case,
Read Input) is passed through unmodified. However, if an error is present, the state machine will instead branch to the
Error state where the problem can be addressed as needed.
This state is responsible for reading the current temperature (referred to as the
Process Variable) and updating the state machine data cluster.
In addition to updating the last value, there are a couple other values that it sets. Both of these values relate to how the acquisition delay is implemented in the state machine. The first of these is the
Timeout value, and since we want no delay between states, we set this to zero. The other value is the
Last Sample Time. It is a timestamp indicating when the reading was made. You’ll see in a bit how these values are used.
This state also updates two front panel indicators, the graph and a troubleshooting value.
Test Fan Limits
This state incorporates a subVI that analyzes the data contained in the state machine data to determine whether or not the fan needs to change state.
The selector in this state results in what is the potential for a 3-way branch. If a threshold has been crossed, the next state will be
Set Fan, if it has not, the next state will be
Test Cooler Limits, and if an error has occurred, the next state will be
Since the fan can only be on or off, all this state needs to do is reverse its current operating condition.
In addition to the subVI toggling the fan on or off, the resulting
Fan State is unbundled from the state machine data and the value is used to control the fan LED.
Test Cooler Limits
This state determines whether the cooler needs to be changed. It can also only be on or off.
The logic here is very similar to that used to test the fan limits.
Again, not unlike the corresponding fan control state, this state changes the cooler state and sets the cooler LED as needed.
Acquisition TO Wait
This state handles the part of the state machine that is in often the Achilles Heel of an implementation. How do we delay starting the control sequence again without incurring the inefficiency of polling?
The answer is to take advantage of the timeout that event structures already have. The heart of that capability is the timeout calculation VI, shown here:
Using inputs from the state machine data, the VI adds the
Sample Interval to the
Last Sample Time. The result is the time when the next sample will need to be taken. From that value, the code subtracts the current time and converts the difference into milliseconds. This value is stored back into the state machine data as the new timeout. This technique is very efficient because it requires no polling.
But wait, you say. This won’t work if some other event happens before the timeout expires! True. But that is very easy to handle. As an example, here is the modified event handler for the save data button.
It looks just as it did before, but with one tiny addition. After reading, formatting and saving the data, the event handler calls the timeout calculation VI again to calculate a new timeout to the intended next sample time.
This state handles errors that occur in the state machine. That being the case, it is the new home for our error VI.
Finally, this state provides the way to stop the state machine and the VI running it. To reach this state, the event handler for the UDE that shuts down the application, will branch to this state. Because it is the last thing to execute before the VI terminates, you need to be sure that it includes everything you need to bring the system to a safe condition.
With those descriptions done, let’s look at how the code works.
The Code Running
When you look at the new Temperature Controller screen you’ll notice that in addition to the graph and the indicators showing the states of the fan and cooler, there are a couple of numbers below the LEDs. The top one is the amount of elapsed between the last two samples, the bottom one is the delay calculated for the acquisition timeout.
If you watch the program carefully as its running, you’ll notice something a bit odd. The elapsed time indicator shows a constant 10 seconds between updates (plus or minus a couple of milliseconds — which is about all you can hope for on a PC). However, the indicator showing the actual delay being applied is never anywhere near 10,000 milliseconds. Moreover, if you switch to one of the other screens and the back, the indicated delay can be considerably less than 10,000 milliseconds, but the elapsed time never budges from 10 seconds. So what gives?
What you are seeing in action is the delay recalculation, we talked about earlier. In order to better simulate a real-world system, I put a delay in the read function that pauses between 200- and 250-msec. Consequently when execution reaches the timeout calculation, we are already about 1/4 of a second into the 10 second delay. The calculation, however, automatically compensates for this delay because the timeout is always referenced to the time of the last measurement. The same thing happens if another event comes between successive data acquisitions.
As always, if you have any questions, concerns, gripes or even (gasp!) complements, post ’em. If not feel free to use any of this logic as you see fit — and above all, play with the code see how you might modify it to do similar sorts of things.
Stay tuned. Next week we will take a deeper look at something we have used before, but not really discussed in detail: Dynamically Calling of VIs. I know there are people out there wondering about this, so it should be fun.
Until next time…
12 thoughts on “Building a Proper LabVIEW State Machine Design Pattern – Pt 2”
Is there way to download the code that you mention in this article? Thank you,
Actually the code isn’t there because at the end of this post we were still in the middle of a larger discussion. The following post completes the conversation and presents all the code modifications.
I see, thank you! And do I have to download each file one by one, or am I missing a faster way?
If you use tortoisesvn you can grab the entire working copy at once.
I see, thanks again!
Hi Mike, I finally got tortoisesvn after learning about the importance of source code control. I have tried a couple times to download your examples now, but my tortoisesvn repo browser always times out.
I go to my windows explorer and right click on a new folder that I made to put the files, then click “svn checkout…”. For URL of repository I have: and my Checkout directory is already filled in. Checkout Depth is set to “Fully Recursive” and Revision is “HEAD revision”. Then I press OK. After about 5 minutes of nothing, the checkout screen disappears and another window pops up showing the checkout command being issued. After about 5 more minutes, the checkout fails.
Is it a problem with how I am trying to access the files?
I left out the URL in my comment below. In the URL field I have: http://svn.notatamelion.com/blogProject/testbed%20application/Tags/Release%2011/
Nice and clean State Diagram. I have a question, what if I have multiple timeout requirement? For example, I need to take 0.5 sec for Read Input and 1 sec for GUI update? Does your layout work? Thank you.
It would still work, but there are a couple different ways to do it depending on the specifics of your application. For example, you could read the input every 0.5 seconds, but only update the GUI every other read. Or depending on the complexity of the two operations you may want to split them into separate processes. It all depends on what you are trying to accomplish.
It was very useful.Can I get another problem statement/exercise on state machines for me understand the concept better,
Thank you !
Actually, I am right now knee-deep in working on a pair of posts that will expand the conversation to include Queued State Machines. If you want to practice the design concepts you can take any nonlinear process and create a state machine that expresses it. For example, design a state machine that encapsulates the process of checking out your groceries at the store — don’t forget to include paying with cash or card (or phone?), and if a card what happens if the electronic payment is rejected.
You see, the real point is learning how to think about problem solving in this sort of scenario.
Thanks a lot Mike