State Machine

Overview

A state machine enables the user to specify a set of modes, that each can take different mode values. For examples we could have a "day" mode that can take the values "weekday" and "weekend", and a "time" mode that could take the "daytime" and "nighttime" values.

Also a set of states is chosen, each state taking different values. For example we could have a "heating" state that could take one of the "normal" and "economical" values.

As the modes and states are represented by blocks, they can be linked. This way the user will specify, that when the "day" is "weekend" the "heating" to be "economical". 

Steps to create a state machine

Creating a new program (temporary way)

First we create a new bLine program.

To do this we navigate to where we want our program to reside, click "new program" in the bLine menu.

At this stage we can add any points we thing that might be useful to our program.

Then we need to add the isStateMachine marker to our program:

• In folio query for programs

• add the isStateMachine marker

Add and link the mode and state blocks

The state machine can have one or multiple modes and one or multiple states.

Each mode and state has an associated string variable that represent it.

Each mode and state can take one of a fixed set of values.

Click edit the program.

Drag a mode block out of the block library. 

Write a the mode name in the input box found on the top of the block.

For each mode value that the current mode can take, add it on the bottom part of the block.

In this example we have a fist mode "day" that has the mode values "weekday" and "weekend" and a second mode "time" that has the mode values "daytime" and "nighttime"

In a similar way, drag find the state block in the block library and drag it into the stage.

Set the state name in the top input box.

Add the state values.

In this example we have one state named "heating" with two values "normal" and "economical"

Link the mode and state blocks.

In this example we link the daytime and weekend values to economical, and the daytime to normal. We want to have "normal" heating in the weekdays and daytime, and "economical" heating in weekends or nighttime, as it's an office building.

Because the "day" mode block is linked closer to the "start" block than the "time" block, the "day" block will have greater priority. So the value "weekend" will override any value set by the "time" block.

Edit the mode block(s)

Click on the pencil on top of the mode block.

In this tab add the logic that sets the current mode value.

Drag the mode setter from the right side of the stage, the one that has the (mode) written next to it.

You can select the value you set to the mode from the drop down list.

Edit the state block(s)

To edit a state block, first click on the pencil on the top of the block.

This makes the tabs associated to the state values to became visible. In this case "heating = normal" and "heating = economical" will show up.

Then click on "heating = normal".

Here add the logic for what happens when the "heating" state is "normal".

Next, click on the "heating = economical".

Here add the logic for what happens when the "heating" state is "economical".

Generated code

The generated code is based on the following three parts:

Mode setup

In this part the mode values are set.

After editing the mode blocks, for each mode block a setup while be generated. In our current example the equivalent of this pseudo-code will appear:

Setting the state values

In this part the state values are set based on the linking done between the mode and state blocks.

In our example this code is generated: 

Taking actions based on the state values

In this part the actions are done based on the current state values