Matthew's Portfolio
uiTask.uiTask Class Reference

UI Task interfaces between front end and the serial port. More...

Public Member Functions

def __init__ (self, debugFlag=True)
 Initialize the UI task. More...
 
def uiTaskFcn (self)
 Report necessary measurements the front end. More...
 
def transitionTo (self, state, newState)
 Method for transitioning states. More...
 

Public Attributes

 state
 Contains the information for which state its in.
 
 debugFlag
 Debugging flag for detailed analysis while running.
 

Static Public Attributes

 S0_INIT = const(0)
 Basic init state.
 
 S1_WRITE_CMDS = const(1)
 Wait for user to press a letter and write to task_share.
 

Detailed Description

UI Task interfaces between front end and the serial port.

This class will take data and report it through serial to the front end. It also receives characters/commands from the front end.

Constructor & Destructor Documentation

◆ __init__()

def uiTask.uiTask.__init__ (   self,
  debugFlag = True 
)

Initialize the UI task.

This task will collect and send data to the front end for the voltage reading from the button circuitry.

Parameters
debugFlagEnables or prevents certain print statements from appearing.

Member Function Documentation

◆ transitionTo()

def uiTask.uiTask.transitionTo (   self,
  state,
  newState 
)

Method for transitioning states.

The method will reassign the state variable when directed to transition.

Parameters
stateThe current state of the system.
newStateThe new desired state for the system.
Returns
The new state of the finite state machine.

◆ uiTaskFcn()

def uiTask.uiTask.uiTaskFcn (   self)

Report necessary measurements the front end.

This method will wait for a 'g' to be pressed, and then subsequently take data until a button press has been identified. It will then send the data through serial to the front end for further data processing.


The documentation for this class was generated from the following file: