taskEncoder_02.py File Reference

Manages the states for the encoder task. More...

Functions
def	taskEncoder_02.taskEncoderFcn_02 (str taskName, int period, int sample_period, shares_02.Share_02 zFlag, shares_02.Share_02 pFlag, shares_02.Share_02 dFlag, shares_02.Share_02 gFlag, shares_02.Share_02 sFlag, shares_02.Share_02 dataPrint)
	Function to execute the state management functionality for the encoder tasks. More...

Variables
	taskEncoder_02.S0_INIT = micropython.const(0)
	Maps state 0 to a more readable const S0_INIT.
	taskEncoder_02.S1_UPDATE = micropython.const(1)
	Maps state 1 to a more readable const S1_UPDATE.
	taskEncoder_02.S2_ZERO = micropython.const(2)
	Maps state 2 to a more readable const S2_ZERO.

Detailed Description

Manages the states for the encoder task.

Manages the current state and executes state-related logic for all encoder related functionality. Cycles through state for initialization, updating encoder, and zeroing encoder position.

Author

Caleb Savard

Chris Linthacum

Date

February 2, 2022

Function Documentation

taskEncoderFcn_02()

def taskEncoder_02.taskEncoderFcn_02	(	str	taskName,
		int	period,
		int	sample_period,
		shares_02.Share_02	zFlag,
		shares_02.Share_02	pFlag,
		shares_02.Share_02	dFlag,
		shares_02.Share_02	gFlag,
		shares_02.Share_02	sFlag,
		shares_02.Share_02	dataPrint
	)

Function to execute the state management functionality for the encoder tasks.

Function manages states for the management of encoder functions. Performs all encoder related tasks including position updates, checking and storing encoder data, recording encoder position data, and zeroing the encoder when requested.

Parameters

taskName	Brief string to describe the instance of the function. Useful for debug purposes.
period	Period with which to run the function and update/execute state logic.
zFlag	Shared data object to encapsulate the z key being pressed. Signals that encoder should be zeroed.
pFlag	Shared data object to encapsulate the p key being pressed. Signals to print the encoder position.
dFlag	Shared data object to encapsulate the d key being pressed. Signals to print the encoder delta.
gFlag	Shared data object to encapsulate the g key being pressed. Signals to begin data collection.
sFlag	Shared data object to encapsulate the s key being pressed. Signals to end data collection prematurely.
sample_period	Period to record position data when recording position data vs. time.
dataPrint	Shared data object to store the recorded encoder data. Stores both the position data and time values. @yield state If task ran, yields state the function is now in. If task did not evaluate, returns None.