CALPOLY MECHATRONICS
Documentation for all Mechatronics Labs
ME405_FP_Shares.py File Reference

Shares and Queues of the term projects defined here. More...

Variables

 ME405_FP_Shares.xShare = ts.Share('f', name = "Ball X Position")
 The x-position SHARE set by the TOUCH PANEL.
 
 ME405_FP_Shares.xDotShare = ts.Share('f', name = "Ball X Velocity")
 The x-velocity SHARE set by the TOUCH PANEL.
 
 ME405_FP_Shares.yShare = ts.Share('f', name = "Ball Y Position")
 The y-position SHARE set by the TOUCH PANEL.
 
 ME405_FP_Shares.yDotShare = ts.Share('f', name = "Ball Y Velocity")
 The y-velocity SHARE set by the TOUCH PANEL.
 
 ME405_FP_Shares.xPos_Q
 The x-position QUEUE set by the TOUCH PANEL. More...
 
 ME405_FP_Shares.yPos_Q
 The y-position QUEUE set by the TOUCH PANEL. More...
 
 ME405_FP_Shares.xDot_Q
 The x-velocity QUEUE set by the TOUCH PANEL. More...
 
 ME405_FP_Shares.yDot_Q
 The y-velocity QUEUE set by the TOUCH PANEL. More...
 
 ME405_FP_Shares.thetaXShare = ts.Share('f', name = "Plate X angle")
 The SHARE set by the ENCODER for angular displacement about the X-AXIS.
 
 ME405_FP_Shares.thetaXDotShare = ts.Share('f', name = "Plate X Angular Velocity")
 The SHARE set by the ENCODER for angular velocity about the X-AXIS.
 
 ME405_FP_Shares.thetaYShare = ts.Share('f', name = "Plate Y angle")
 The SHARE set by the ENCODER for angular displacement about the Y-AXIS.
 
 ME405_FP_Shares.thetaYDotShare = ts.Share('f', name = "Plate Y Angular Velocity")
 The SHARE set by the ENCODER for angular velocity about the Y-AXIS.
 
 ME405_FP_Shares.thetaXQueue
 The QUEUE set by the ENCODER for angular displacement about the X-AXIS. More...
 
 ME405_FP_Shares.thetaXDotQueue
 The QUEUE set by the ENCODER for angular velocity about the X-AXIS. More...
 
 ME405_FP_Shares.thetaYQueue
 The SHARE set by the ENCODER for angular displacement about the Y-AXIS. More...
 
 ME405_FP_Shares.thetaYDotQueue
 The SHARE set by the ENCODER for angular velocity about the Y-AXIS. More...
 
 ME405_FP_Shares.encTimeQueue
 The SHARE set by the ENCODER to monitor the TIME that corresponds to the colleciton of values put into queues. More...
 
 ME405_FP_Shares.xDutyCycleShare = ts.Share('f', name = "X Motor Duty Cycle")
 The SHARE set by the CONTROLLER for the DUTY CYCLE to be delivered to the X-Motor.
 
 ME405_FP_Shares.yDutyCycleShare = ts.Share('f', name = "Y Motor Duty Cycle")
 The SHARE set by the CONTROLLER for the DUTY CYCLE to be delivered to the Y-Motor.
 
 ME405_FP_Shares.dataClct = ts.Share('i', name ="Data collect")
 The Boolean value set in the USER TASK that indicates if data collection should begin or stop.
 
 ME405_FP_Shares.enabledShare = ts.Share('i', name = "Enabled")
 The Boolean value set in the USER TASK that tells the platform to begin or stop balancing.
 
 ME405_FP_Shares.resetShare = ts.Share('i', name = "Reset Motor Driver Error")
 The Boolean value set in the USER TASK that allows the user to clear a motor fault.
 
 ME405_FP_Shares.programExitShare = ts.Share('i', name = "Program Exit Share")
 The Boolean value set in the USER TASK that exits the program and stops motor operation.
 
 ME405_FP_Shares.t_sample = ts.Share('f', name = "Sample Time")
 The sample period (ms) at which the Touch Panel, Controller, and Encoder all run.
 
int ME405_FP_Shares.smplPer = 20
 

Detailed Description

Shares and Queues of the term projects defined here.

Using the provided task_share.py file, shares and queues are instantiated here to be shared with multiple different tasks. These shares and queues are separated by the tasks that are puttin values into said objects.
source code: https://bitbucket.org/eliotBriefer/me405_term_project/src/master/Additional%20Modules/ME405_FP_Shares.py

Author
Eliot Briefer & Nicholas Greco
Date
6/11/2021

Variable Documentation

◆ encTimeQueue

ME405_FP_Shares.encTimeQueue
Initial value:
1 = ts.Queue('f', 50, thread_protect = False, overwrite = True,
2  name = "Encoder Time Queue")

The SHARE set by the ENCODER to monitor the TIME that corresponds to the colleciton of values put into queues.

◆ thetaXDotQueue

ME405_FP_Shares.thetaXDotQueue
Initial value:
1 = ts.Queue ('f', 50, thread_protect = False, overwrite = True,
2  name = "omX_Q")

The QUEUE set by the ENCODER for angular velocity about the X-AXIS.

◆ thetaXQueue

ME405_FP_Shares.thetaXQueue
Initial value:
1 = ts.Queue ('f', 50, thread_protect = False, overwrite = True,
2  name = "thX_Q")

The QUEUE set by the ENCODER for angular displacement about the X-AXIS.

◆ thetaYDotQueue

ME405_FP_Shares.thetaYDotQueue
Initial value:
1 = ts.Queue ('f', 50, thread_protect = False, overwrite = True,
2  name = "omY_Q")

The SHARE set by the ENCODER for angular velocity about the Y-AXIS.

◆ thetaYQueue

ME405_FP_Shares.thetaYQueue
Initial value:
1 = ts.Queue ('f', 50, thread_protect = False, overwrite = True,
2  name = "thY_Q")

The SHARE set by the ENCODER for angular displacement about the Y-AXIS.

◆ xDot_Q

ME405_FP_Shares.xDot_Q
Initial value:
1 = ts.Queue ('f', 50, thread_protect = False, overwrite = True,
2  name = "xDot_Q")

The x-velocity QUEUE set by the TOUCH PANEL.

◆ xPos_Q

ME405_FP_Shares.xPos_Q
Initial value:
1 = ts.Queue ('f', 50, thread_protect = False, overwrite = True,
2  name = "xPos_Q")

The x-position QUEUE set by the TOUCH PANEL.

◆ yDot_Q

ME405_FP_Shares.yDot_Q
Initial value:
1 = ts.Queue ('f', 50, thread_protect = False, overwrite = True,
2  name = "yDot_Q")

The y-velocity QUEUE set by the TOUCH PANEL.

◆ yPos_Q

ME405_FP_Shares.yPos_Q
Initial value:
1 = ts.Queue ('f', 50, thread_protect = False, overwrite = True,
2  name = "yPos_Q")

The y-position QUEUE set by the TOUCH PANEL.