Jump to content

Component: Electrical Machines (AllCode): Difference between revisions

From Flowcode Help
← Older edit

SteveT (talk | contribs)

4 user groups
6,422 edits
m Text replacement - "width="10%" align="center" style="background-color:#D8C9D8;" align="center"" to "width="10%" align="center" class="mtx-class-macrohead""
m Text replacement - "style="background-color:#EAE1EA;"" to "class="mtx-class-propfolder""
 
(3 intermediate revisions by the same user not shown)
Line 75: Line 75:
|-
|-
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Get3PhaseMode'''
| width="90%" class="mtx-class-macrohead" | '''Get3PhaseMode'''
|-
|-
| colspan="2" | Checks to see if the brushless mode is enabled 
| colspan="2" | Checks to see if the brushless mode is enabled 
Line 89: Line 89:
|-
|-
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''GetAPIVersion'''
| width="90%" class="mtx-class-macrohead" | '''GetAPIVersion'''
|-
|-
| colspan="2" | Reads the API firmware version 
| colspan="2" | Reads the API firmware version 
Line 103: Line 103:
|-
|-
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''GetAbsPosition'''
| width="90%" class="mtx-class-macrohead" | '''GetAbsPosition'''
|-
|-
| colspan="2" | Reads the absolute position of the encoder 
| colspan="2" | Reads the absolute position of the encoder 
Line 117: Line 117:
|-
|-
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''GetCommsOK'''
| width="90%" class="mtx-class-macrohead" | '''GetCommsOK'''
|-
|-
| colspan="2" | Checks if comms are ok and stable 
| colspan="2" | Checks if comms are ok and stable 
Line 131: Line 131:
|-
|-
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''GetControlFeedback'''
| width="90%" class="mtx-class-macrohead" | '''GetControlFeedback'''
|-
|-
| colspan="2" |  
| colspan="2" |  
Line 145: Line 145:
|-
|-
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''GetControlOutputs'''
| width="90%" class="mtx-class-macrohead" | '''GetControlOutputs'''
|-
|-
| colspan="2" |  
| colspan="2" |  
Line 164: Line 164:
|-
|-
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''GetCurrent'''
| width="90%" class="mtx-class-macrohead" | '''GetCurrent'''
|-
|-
| colspan="2" | Reads the current of a single channel 
| colspan="2" | Reads the current of a single channel 
Line 183: Line 183:
|-
|-
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''GetDataArray'''
| width="90%" class="mtx-class-macrohead" | '''GetDataArray'''
|-
|-
| colspan="2" | Collects a data array from the EM box full of control data. Each set of data includes: Setpoint, Feedback, Poutput, Ioutput, Doutput Returns the number of complete data samples collected. 
| colspan="2" | Collects a data array from the EM box full of control data. Each set of data includes: Setpoint, Feedback, Poutput, Ioutput, Doutput Returns the number of complete data samples collected. 
Line 202: Line 202:
|-
|-
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''GetErrorStatus'''
| width="90%" class="mtx-class-macrohead" | '''GetErrorStatus'''
|-
|-
| colspan="2" | Gets the current error status. Error status will automatically resolve itself once the causing condition has been removed. 0 = No Error 1 = Error - likely over current or brownout 
| colspan="2" | Gets the current error status. Error status will automatically resolve itself once the causing condition has been removed. 0 = No Error 1 = Error - likely over current or brownout 
Line 216: Line 216:
|-
|-
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''GetLogData'''
| width="90%" class="mtx-class-macrohead" | '''GetLogData'''
|-
|-
| colspan="2" | Gets a 64-byte packet of log data. 250 packets make up a single log. Returns 0 if comms failed and 1 if comms OK 
| colspan="2" | Gets a 64-byte packet of log data. 250 packets make up a single log. Returns 0 if comms failed and 1 if comms OK 
Line 235: Line 235:
|-
|-
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''GetLogDataReady'''
| width="90%" class="mtx-class-macrohead" | '''GetLogDataReady'''
|-
|-
| colspan="2" | Checks to see if the logging is complete and ready to read. 
| colspan="2" | Checks to see if the logging is complete and ready to read. 
Line 249: Line 249:
|-
|-
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''GetLogStartAngle'''
| width="90%" class="mtx-class-macrohead" | '''GetLogStartAngle'''
|-
|-
| colspan="2" | Collects the U Phase angle at the start of logging.  Used to calculate and re-create the 3Phase voltage data. 
| colspan="2" | Collects the U Phase angle at the start of logging.  Used to calculate and re-create the 3Phase voltage data. 
Line 263: Line 263:
|-
|-
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''GetMotorDirection'''
| width="90%" class="mtx-class-macrohead" | '''GetMotorDirection'''
|-
|-
| colspan="2" | Reads the motor direction 
| colspan="2" | Reads the motor direction 
Line 277: Line 277:
|-
|-
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''GetRPM'''
| width="90%" class="mtx-class-macrohead" | '''GetRPM'''
|-
|-
| colspan="2" | Reads the speed in RPM 
| colspan="2" | Reads the speed in RPM 
Line 291: Line 291:
|-
|-
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''GetSafetySwitch'''
| width="90%" class="mtx-class-macrohead" | '''GetSafetySwitch'''
|-
|-
| colspan="2" | Reads the safety switch 
| colspan="2" | Reads the safety switch 
Line 305: Line 305:
|-
|-
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''GetVoltage'''
| width="90%" class="mtx-class-macrohead" | '''GetVoltage'''
|-
|-
| colspan="2" | Reads the voltage of a single channel 
| colspan="2" | Reads the voltage of a single channel 
Line 324: Line 324:
|-
|-
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''GetWeight'''
| width="90%" class="mtx-class-macrohead" | '''GetWeight'''
|-
|-
| colspan="2" | Reads the voltage of a single channel 
| colspan="2" | Reads the voltage of a single channel 
Line 343: Line 343:
|-
|-
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Initialise'''
| width="90%" class="mtx-class-macrohead" | '''Initialise'''
|-
|-
| colspan="2" | Returns 1 if the connection is ok and communications have been established 
| colspan="2" | Returns 1 if the connection is ok and communications have been established 
Line 362: Line 362:
|-
|-
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SetAbsPosition'''
| width="90%" class="mtx-class-macrohead" | '''SetAbsPosition'''
|-
|-
| colspan="2" | Resets the absolute motor position to 0 
| colspan="2" | Resets the absolute motor position to 0 
Line 376: Line 376:
|-
|-
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SetActive'''
| width="90%" class="mtx-class-macrohead" | '''SetActive'''
|-
|-
| colspan="2" |  
| colspan="2" |  
Line 395: Line 395:
|-
|-
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SetCapacitorBank'''
| width="90%" class="mtx-class-macrohead" | '''SetCapacitorBank'''
|-
|-
| colspan="2" |  
| colspan="2" |  
Line 414: Line 414:
|-
|-
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SetControlKD'''
| width="90%" class="mtx-class-macrohead" | '''SetControlKD'''
|-
|-
| colspan="2" |  
| colspan="2" |  
Line 433: Line 433:
|-
|-
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SetControlKI'''
| width="90%" class="mtx-class-macrohead" | '''SetControlKI'''
|-
|-
| colspan="2" |  
| colspan="2" |  
Line 452: Line 452:
|-
|-
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SetControlKP'''
| width="90%" class="mtx-class-macrohead" | '''SetControlKP'''
|-
|-
| colspan="2" |  
| colspan="2" |  
Line 471: Line 471:
|-
|-
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SetControlMaxDrivePercentage'''
| width="90%" class="mtx-class-macrohead" | '''SetControlMaxDrivePercentage'''
|-
|-
| colspan="2" |  
| colspan="2" |  
Line 490: Line 490:
|-
|-
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SetControlSetpoint'''
| width="90%" class="mtx-class-macrohead" | '''SetControlSetpoint'''
|-
|-
| colspan="2" |  
| colspan="2" |  
Line 509: Line 509:
|-
|-
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SetDriveMode'''
| width="90%" class="mtx-class-macrohead" | '''SetDriveMode'''
|-
|-
| colspan="2" |  
| colspan="2" |  
Line 528: Line 528:
|-
|-
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SetDynoLoad'''
| width="90%" class="mtx-class-macrohead" | '''SetDynoLoad'''
|-
|-
| colspan="2" |  
| colspan="2" |  
Line 547: Line 547:
|-
|-
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SetFan'''
| width="90%" class="mtx-class-macrohead" | '''SetFan'''
|-
|-
| colspan="2" | |Sets the speed of the FAN from 0 (MIN)  to 3000 (MAX) 
| colspan="2" | |Sets the speed of the FAN from 0 (MIN)  to 3000 (MAX) 
Line 566: Line 566:
|-
|-
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SetFrequency'''
| width="90%" class="mtx-class-macrohead" | '''SetFrequency'''
|-
|-
| colspan="2" |  
| colspan="2" |  
Line 585: Line 585:
|-
|-
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SetLoadCellCalibration'''
| width="90%" class="mtx-class-macrohead" | '''SetLoadCellCalibration'''
|-
|-
| colspan="2" |  
| colspan="2" |  
Line 604: Line 604:
|-
|-
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SetMotorDirection'''
| width="90%" class="mtx-class-macrohead" | '''SetMotorDirection'''
|-
|-
| colspan="2" |  
| colspan="2" |  
Line 623: Line 623:
|-
|-
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SetMotorType'''
| width="90%" class="mtx-class-macrohead" | '''SetMotorType'''
|-
|-
| colspan="2" |  
| colspan="2" |  
Line 642: Line 642:
|-
|-
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SetTCPProps'''
| width="90%" class="mtx-class-macrohead" | '''SetTCPProps'''
|-
|-
| colspan="2" | Sets the TCP IP address and Port 
| colspan="2" | Sets the TCP IP address and Port 
Line 681: Line 681:
|-
|-
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SetThreePhaseDriveMode'''
| width="90%" class="mtx-class-macrohead" | '''SetThreePhaseDriveMode'''
|-
|-
| colspan="2" |  
| colspan="2" |  
Line 700: Line 700:
|-
|-
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SetVoltage'''
| width="90%" class="mtx-class-macrohead" | '''SetVoltage'''
|-
|-
| colspan="2" | Sets the DC Voltage from 0 to 24V 
| colspan="2" | Sets the DC Voltage from 0 to 24V 
Line 724: Line 724:
|-
|-
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''ZeroLoadCell'''
| width="90%" class="mtx-class-macrohead" | '''ZeroLoadCell'''
|-
|-
| colspan="2" |  
| colspan="2" |  
Line 738: Line 738:
{| class="mtx-class-macrotable wikitable"
{| class="mtx-class-macrotable wikitable"
|-
|-
| width="10%" align="center" style="background-color:#D8C9D8;" | [[File:Fc9-prop-icon.png]]
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-prop-icon.png]]
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Properties'''  
| width="90%" class="mtx-class-macrohead" | '''Properties'''  
|-
|-
|-
|-
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
| width="10%" align="center" class="mtx-class-propfolder" | [[File:Fc9-conn-icon.png]]
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Communications
| width="90%" class="mtx-class-propfolder" | Communications
|-
|-
|-
|-
Line 756: Line 756:
| colspan="2" | Automatically allows the runtime to stop if there is a communications error. 
| colspan="2" | Automatically allows the runtime to stop if there is a communications error. 
|-
|-
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
| width="10%" align="center" class="mtx-class-propfolder" | [[File:Fc9-conn-icon.png]]
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | USB Communications
| width="90%" class="mtx-class-propfolder" | USB Communications
|-
|-
|-
|-
Line 765: Line 765:
| colspan="2" |  
| colspan="2" |  
|-
|-
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
| width="10%" align="center" class="mtx-class-propfolder" | [[File:Fc9-conn-icon.png]]
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Runtime Statistics
| width="90%" class="mtx-class-propfolder" | Runtime Statistics
|-
|-
|-
|-

Latest revision as of 14:36, 13 July 2026

Author Matrix TSL
Version 2.0
Category AllCode


Electrical Machines component

A set of functions to communicate with the Matrix EM hardware. Allows the functions to be easily standardised across all SCADA programs.

Component Source Code

Please click here to download the component source project: FC_Comp_Source_EM_Functions.fcsx

Please click here to view the component source code (Beta): FC_Comp_Source_EM_Functions.fcsx

Detailed description

No detailed description exists yet for this component

Examples

No additional examples







Macro reference

Get3PhaseMode

Get3PhaseMode
Checks to see if the brushless mode is enabled 
- BOOL Return


GetAPIVersion

GetAPIVersion
Reads the API firmware version 
- BYTE Return


GetAbsPosition

GetAbsPosition
Reads the absolute position of the encoder 
- ULONG Return


GetCommsOK

GetCommsOK
Checks if comms are ok and stable 
- BOOL Return


GetControlFeedback

GetControlFeedback
 
- FLOAT Return


GetControlOutputs

GetControlOutputs
 
- FLOAT Data
 
- VOID Return


GetCurrent

GetCurrent
Reads the current of a single channel 
- BYTE Channel
Range: 0-6 - 0=DC1, 1=DC2, 2=U, 3=V, 4=W, 5=Dyno, 6=I, 7=TotalDriver 
- FLOAT Return


GetDataArray

GetDataArray
Collects a data array from the EM box full of control data. Each set of data includes: Setpoint, Feedback, Poutput, Ioutput, Doutput Returns the number of complete data samples collected. 
- FLOAT data
 
- BYTE Return


GetErrorStatus

GetErrorStatus
Gets the current error status. Error status will automatically resolve itself once the causing condition has been removed. 0 = No Error 1 = Error - likely over current or brownout 
- BYTE Return


GetLogData

GetLogData
Gets a 64-byte packet of log data. 250 packets make up a single log. Returns 0 if comms failed and 1 if comms OK 
- BYTE Buffer
Buffer to store the incoming log data 
- BOOL Return


GetLogDataReady

GetLogDataReady
Checks to see if the logging is complete and ready to read. 
- BOOL Return


GetLogStartAngle

GetLogStartAngle
Collects the U Phase angle at the start of logging. Used to calculate and re-create the 3Phase voltage data. 
- BYTE Return


GetMotorDirection

GetMotorDirection
Reads the motor direction 
- UINT Return


GetRPM

GetRPM
Reads the speed in RPM 
- UINT Return


GetSafetySwitch

GetSafetySwitch
Reads the safety switch 
- UINT Return


GetVoltage

GetVoltage
Reads the voltage of a single channel 
- BYTE Channel
Range: 0-5 - 0=DC1, 1=DC2, 2=U, 3=V, 4=W, 5=VEXT 
- FLOAT Return


GetWeight

GetWeight
Reads the voltage of a single channel 
- BYTE Scale
Range: 0-1 - 0=Weight, 1=Torque 
- FLOAT Return


Initialise

Initialise
Returns 1 if the connection is ok and communications have been established 
- BYTE MotorType
0=DC, 1=1Phase, 2=3Phase, 3=AngleControl 
- BOOL Return


SetAbsPosition

SetAbsPosition
Resets the absolute motor position to 0 
- VOID Return


SetActive

SetActive
 
- BOOL Active
0=Off, 1=On 
- VOID Return


SetCapacitorBank

SetCapacitorBank
 
- BYTE Cap
 
- VOID Return


SetControlKD

SetControlKD
 
- FLOAT Value
 
- VOID Return


SetControlKI

SetControlKI
 
- FLOAT Value
 
- VOID Return


SetControlKP

SetControlKP
 
- FLOAT Value
 
- VOID Return


SetControlMaxDrivePercentage

SetControlMaxDrivePercentage
 
- FLOAT Value
Range 0.0-1.0 
- VOID Return


SetControlSetpoint

SetControlSetpoint
 
- FLOAT Value
 
- VOID Return


SetDriveMode

SetDriveMode
 
- BYTE Mode
0=PWM, 1=On/Off/Float 
- VOID Return


SetDynoLoad

SetDynoLoad
 
- FLOAT Load
 
- VOID Return


SetFan

SetFan
|Sets the speed of the FAN from 0 (MIN) to 3000 (MAX) 
- UINT Speed
 
- VOID Return


SetFrequency

SetFrequency
 
- UINT Frequency
Frequency of sine wave in Hz 
- VOID Return


SetLoadCellCalibration

SetLoadCellCalibration
 
- FLOAT Value
 
- VOID Return


SetMotorDirection

SetMotorDirection
 
- BOOL MotorDirection
0=FW, 1=BW 
- VOID Return


SetMotorType

SetMotorType
 
- BYTE MotorType
0=DC, 1=1 Phase, 2=3 Phase 
- VOID Return


SetTCPProps

SetTCPProps
Sets the TCP IP address and Port 
- BYTE IP0
 
- BYTE IP1
 
- BYTE IP2
 
- BYTE IP3
 
- UINT Port
 
- VOID Return


SetThreePhaseDriveMode

SetThreePhaseDriveMode
 
- BOOL Mode
0=Simple, 1=Accurate 
- VOID Return


SetVoltage

SetVoltage
Sets the DC Voltage from 0 to 24V 
- FLOAT Voltage
 
- BYTE Index
 
- VOID Return


ZeroLoadCell

ZeroLoadCell
 
- VOID Return


Property reference

Properties
Communications
Comms Mode
 
Stop On Error
Automatically allows the runtime to stop if there is a communications error. 
USB Communications
Autodetect Port
 
Runtime Statistics
Console Data
Allow console data to be generated showing the high level EM communications and returns 
Retrieved from "https://www.flowcode.co.uk/wiki/index.php?title=Component:_Electrical_Machines_(AllCode)&oldid=47780"