Component: Electrical Machines (AllCode): Difference between revisions
No edit summary |
m Text replacement - "style="background-color:#EAE1EA;"" to "class="mtx-class-propfolder"" |
||
| (7 intermediate revisions by 2 users not shown) | |||
| Line 17: | Line 17: | ||
==Component Source Code== | ==Component Source Code== | ||
Please click here to download the component source project: [https://www.flowcode.co.uk/wiki/componentsource/ | Please click here to download the component source project: [https://www.flowcode.co.uk/wiki/componentsource/FC_Comp_Source_EM_Functions.fcsx FC_Comp_Source_EM_Functions.fcsx] | ||
Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/ | Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/FC_Comp_Source_EM_Functions.fcsx FC_Comp_Source_EM_Functions.fcsx] | ||
==Detailed description== | ==Detailed description== | ||
| Line 57: | Line 57: | ||
''<span style="color:red;">No additional examples</span>'' | ''<span style="color:red;">No additional examples</span>'' | ||
| Line 68: | Line 72: | ||
===Get3PhaseMode=== | ===Get3PhaseMode=== | ||
{| class="wikitable | {| class="mtx-class-macrotable wikitable" | ||
|- | |- | ||
| width="10%" align="center" | | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]] | ||
| width="90%" | | 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 82: | Line 86: | ||
===GetAPIVersion=== | ===GetAPIVersion=== | ||
{| class="wikitable | {| class="mtx-class-macrotable wikitable" | ||
|- | |- | ||
| width="10%" align="center" | | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]] | ||
| width="90%" | | width="90%" class="mtx-class-macrohead" | '''GetAPIVersion''' | ||
|- | |- | ||
| colspan="2" | Reads the API firmware version | | colspan="2" | Reads the API firmware version | ||
| Line 96: | Line 100: | ||
===GetAbsPosition=== | ===GetAbsPosition=== | ||
{| class="wikitable | {| class="mtx-class-macrotable wikitable" | ||
|- | |- | ||
| width="10%" align="center" | | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]] | ||
| width="90%" | | 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 110: | Line 114: | ||
===GetCommsOK=== | ===GetCommsOK=== | ||
{| class="wikitable | {| class="mtx-class-macrotable wikitable" | ||
|- | |- | ||
| width="10%" align="center" | | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]] | ||
| width="90%" | | 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 124: | Line 128: | ||
===GetControlFeedback=== | ===GetControlFeedback=== | ||
{| class="wikitable | {| class="mtx-class-macrotable wikitable" | ||
|- | |- | ||
| width="10%" align="center" | | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]] | ||
| width="90%" | | width="90%" class="mtx-class-macrohead" | '''GetControlFeedback''' | ||
|- | |- | ||
| colspan="2" | | | colspan="2" | | ||
| Line 138: | Line 142: | ||
===GetControlOutputs=== | ===GetControlOutputs=== | ||
{| class="wikitable | {| class="mtx-class-macrotable wikitable" | ||
|- | |- | ||
| width="10%" align="center" | | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]] | ||
| width="90%" | | width="90%" class="mtx-class-macrohead" | '''GetControlOutputs''' | ||
|- | |- | ||
| colspan="2" | | | colspan="2" | | ||
| Line 157: | Line 161: | ||
===GetCurrent=== | ===GetCurrent=== | ||
{| class="wikitable | {| class="mtx-class-macrotable wikitable" | ||
|- | |- | ||
| width="10%" align="center" | | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]] | ||
| width="90%" | | 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 176: | Line 180: | ||
===GetDataArray=== | ===GetDataArray=== | ||
{| class="wikitable | {| class="mtx-class-macrotable wikitable" | ||
|- | |- | ||
| width="10%" align="center" | | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]] | ||
| width="90%" | | 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 195: | Line 199: | ||
===GetErrorStatus=== | ===GetErrorStatus=== | ||
{| class="wikitable | {| class="mtx-class-macrotable wikitable" | ||
|- | |- | ||
| width="10%" align="center" | | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]] | ||
| width="90%" | | 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 209: | Line 213: | ||
===GetLogData=== | ===GetLogData=== | ||
{| class="wikitable | {| class="mtx-class-macrotable wikitable" | ||
|- | |- | ||
| width="10%" align="center" | | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]] | ||
| width="90%" | | 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 228: | Line 232: | ||
===GetLogDataReady=== | ===GetLogDataReady=== | ||
{| class="wikitable | {| class="mtx-class-macrotable wikitable" | ||
|- | |- | ||
| width="10%" align="center" | | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]] | ||
| width="90%" | | 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 242: | Line 246: | ||
===GetLogStartAngle=== | ===GetLogStartAngle=== | ||
{| class="wikitable | {| class="mtx-class-macrotable wikitable" | ||
|- | |- | ||
| width="10%" align="center" | | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]] | ||
| width="90%" | | 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 256: | Line 260: | ||
===GetMotorDirection=== | ===GetMotorDirection=== | ||
{| class="wikitable | {| class="mtx-class-macrotable wikitable" | ||
|- | |- | ||
| width="10%" align="center" | | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]] | ||
| width="90%" | | width="90%" class="mtx-class-macrohead" | '''GetMotorDirection''' | ||
|- | |- | ||
| colspan="2" | Reads the motor direction | | colspan="2" | Reads the motor direction | ||
| Line 270: | Line 274: | ||
===GetRPM=== | ===GetRPM=== | ||
{| class="wikitable | {| class="mtx-class-macrotable wikitable" | ||
|- | |- | ||
| width="10%" align="center" | | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]] | ||
| width="90%" | | width="90%" class="mtx-class-macrohead" | '''GetRPM''' | ||
|- | |- | ||
| colspan="2" | Reads the speed in RPM | | colspan="2" | Reads the speed in RPM | ||
| Line 284: | Line 288: | ||
===GetSafetySwitch=== | ===GetSafetySwitch=== | ||
{| class="wikitable | {| class="mtx-class-macrotable wikitable" | ||
|- | |- | ||
| width="10%" align="center" | | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]] | ||
| width="90%" | | width="90%" class="mtx-class-macrohead" | '''GetSafetySwitch''' | ||
|- | |- | ||
| colspan="2" | Reads the safety switch | | colspan="2" | Reads the safety switch | ||
| Line 298: | Line 302: | ||
===GetVoltage=== | ===GetVoltage=== | ||
{| class="wikitable | {| class="mtx-class-macrotable wikitable" | ||
|- | |- | ||
| width="10%" align="center" | | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]] | ||
| width="90%" | | 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 317: | Line 321: | ||
===GetWeight=== | ===GetWeight=== | ||
{| class="wikitable | {| class="mtx-class-macrotable wikitable" | ||
|- | |- | ||
| width="10%" align="center" | | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]] | ||
| width="90%" | | 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 336: | Line 340: | ||
===Initialise=== | ===Initialise=== | ||
{| class="wikitable | {| class="mtx-class-macrotable wikitable" | ||
|- | |- | ||
| width="10%" align="center" | | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]] | ||
| width="90%" | | 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 355: | Line 359: | ||
===SetAbsPosition=== | ===SetAbsPosition=== | ||
{| class="wikitable | {| class="mtx-class-macrotable wikitable" | ||
|- | |- | ||
| width="10%" align="center" | | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]] | ||
| width="90%" | | 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 369: | Line 373: | ||
===SetActive=== | ===SetActive=== | ||
{| class="wikitable | {| class="mtx-class-macrotable wikitable" | ||
|- | |- | ||
| width="10%" align="center" | | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]] | ||
| width="90%" | | width="90%" class="mtx-class-macrohead" | '''SetActive''' | ||
|- | |- | ||
| colspan="2" | | | colspan="2" | | ||
| Line 388: | Line 392: | ||
===SetCapacitorBank=== | ===SetCapacitorBank=== | ||
{| class="wikitable | {| class="mtx-class-macrotable wikitable" | ||
|- | |- | ||
| width="10%" align="center" | | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]] | ||
| width="90%" | | width="90%" class="mtx-class-macrohead" | '''SetCapacitorBank''' | ||
|- | |- | ||
| colspan="2" | | | colspan="2" | | ||
| Line 407: | Line 411: | ||
===SetControlKD=== | ===SetControlKD=== | ||
{| class="wikitable | {| class="mtx-class-macrotable wikitable" | ||
|- | |- | ||
| width="10%" align="center" | | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]] | ||
| width="90%" | | width="90%" class="mtx-class-macrohead" | '''SetControlKD''' | ||
|- | |- | ||
| colspan="2" | | | colspan="2" | | ||
| Line 426: | Line 430: | ||
===SetControlKI=== | ===SetControlKI=== | ||
{| class="wikitable | {| class="mtx-class-macrotable wikitable" | ||
|- | |- | ||
| width="10%" align="center" | | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]] | ||
| width="90%" | | width="90%" class="mtx-class-macrohead" | '''SetControlKI''' | ||
|- | |- | ||
| colspan="2" | | | colspan="2" | | ||
| Line 445: | Line 449: | ||
===SetControlKP=== | ===SetControlKP=== | ||
{| class="wikitable | {| class="mtx-class-macrotable wikitable" | ||
|- | |- | ||
| width="10%" align="center" | | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]] | ||
| width="90%" | | width="90%" class="mtx-class-macrohead" | '''SetControlKP''' | ||
|- | |- | ||
| colspan="2" | | | colspan="2" | | ||
| Line 464: | Line 468: | ||
===SetControlMaxDrivePercentage=== | ===SetControlMaxDrivePercentage=== | ||
{| class="wikitable | {| class="mtx-class-macrotable wikitable" | ||
|- | |- | ||
| width="10%" align="center" | | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]] | ||
| width="90%" | | width="90%" class="mtx-class-macrohead" | '''SetControlMaxDrivePercentage''' | ||
|- | |- | ||
| colspan="2" | | | colspan="2" | | ||
| Line 483: | Line 487: | ||
===SetControlSetpoint=== | ===SetControlSetpoint=== | ||
{| class="wikitable | {| class="mtx-class-macrotable wikitable" | ||
|- | |- | ||
| width="10%" align="center" | | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]] | ||
| width="90%" | | width="90%" class="mtx-class-macrohead" | '''SetControlSetpoint''' | ||
|- | |- | ||
| colspan="2" | | | colspan="2" | | ||
| Line 502: | Line 506: | ||
===SetDriveMode=== | ===SetDriveMode=== | ||
{| class="wikitable | {| class="mtx-class-macrotable wikitable" | ||
|- | |- | ||
| width="10%" align="center" | | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]] | ||
| width="90%" | | width="90%" class="mtx-class-macrohead" | '''SetDriveMode''' | ||
|- | |- | ||
| colspan="2" | | | colspan="2" | | ||
| Line 521: | Line 525: | ||
===SetDynoLoad=== | ===SetDynoLoad=== | ||
{| class="wikitable | {| class="mtx-class-macrotable wikitable" | ||
|- | |- | ||
| width="10%" align="center" | | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]] | ||
| width="90%" | | width="90%" class="mtx-class-macrohead" | '''SetDynoLoad''' | ||
|- | |- | ||
| colspan="2" | | | colspan="2" | | ||
| Line 540: | Line 544: | ||
===SetFan=== | ===SetFan=== | ||
{| class="wikitable | {| class="mtx-class-macrotable wikitable" | ||
|- | |- | ||
| width="10%" align="center" | | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]] | ||
| width="90%" | | 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 559: | Line 563: | ||
===SetFrequency=== | ===SetFrequency=== | ||
{| class="wikitable | {| class="mtx-class-macrotable wikitable" | ||
|- | |- | ||
| width="10%" align="center" | | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]] | ||
| width="90%" | | width="90%" class="mtx-class-macrohead" | '''SetFrequency''' | ||
|- | |- | ||
| colspan="2" | | | colspan="2" | | ||
| Line 578: | Line 582: | ||
===SetLoadCellCalibration=== | ===SetLoadCellCalibration=== | ||
{| class="wikitable | {| class="mtx-class-macrotable wikitable" | ||
|- | |- | ||
| width="10%" align="center" | | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]] | ||
| width="90%" | | width="90%" class="mtx-class-macrohead" | '''SetLoadCellCalibration''' | ||
|- | |- | ||
| colspan="2" | | | colspan="2" | | ||
| Line 597: | Line 601: | ||
===SetMotorDirection=== | ===SetMotorDirection=== | ||
{| class="wikitable | {| class="mtx-class-macrotable wikitable" | ||
|- | |- | ||
| width="10%" align="center" | | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]] | ||
| width="90%" | | width="90%" class="mtx-class-macrohead" | '''SetMotorDirection''' | ||
|- | |- | ||
| colspan="2" | | | colspan="2" | | ||
| Line 616: | Line 620: | ||
===SetMotorType=== | ===SetMotorType=== | ||
{| class="wikitable | {| class="mtx-class-macrotable wikitable" | ||
|- | |- | ||
| width="10%" align="center" | | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]] | ||
| width="90%" | | width="90%" class="mtx-class-macrohead" | '''SetMotorType''' | ||
|- | |- | ||
| colspan="2" | | | colspan="2" | | ||
| Line 635: | Line 639: | ||
===SetTCPProps=== | ===SetTCPProps=== | ||
{| class="wikitable | {| class="mtx-class-macrotable wikitable" | ||
|- | |- | ||
| width="10%" align="center" | | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]] | ||
| width="90%" | | 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 674: | Line 678: | ||
===SetThreePhaseDriveMode=== | ===SetThreePhaseDriveMode=== | ||
{| class="wikitable | {| class="mtx-class-macrotable wikitable" | ||
|- | |- | ||
| width="10%" align="center" | | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]] | ||
| width="90%" | | width="90%" class="mtx-class-macrohead" | '''SetThreePhaseDriveMode''' | ||
|- | |- | ||
| colspan="2" | | | colspan="2" | | ||
| Line 693: | Line 697: | ||
===SetVoltage=== | ===SetVoltage=== | ||
{| class="wikitable | {| class="mtx-class-macrotable wikitable" | ||
|- | |- | ||
| width="10%" align="center" | | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]] | ||
| width="90%" | | 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 717: | Line 721: | ||
===ZeroLoadCell=== | ===ZeroLoadCell=== | ||
{| class="wikitable | {| class="mtx-class-macrotable wikitable" | ||
|- | |- | ||
| width="10%" align="center" | | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]] | ||
| width="90%" | | width="90%" class="mtx-class-macrohead" | '''ZeroLoadCell''' | ||
|- | |- | ||
| colspan="2" | | | colspan="2" | | ||
| Line 728: | Line 732: | ||
| width="90%" style="border-top: 2px solid #000;" | ''Return'' | | width="90%" style="border-top: 2px solid #000;" | ''Return'' | ||
|} | |} | ||
==Property reference== | ==Property reference== | ||
{| class="wikitable | {| class="mtx-class-macrotable wikitable" | ||
|- | |- | ||
| width="10%" align="center" | | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-prop-icon.png]] | ||
| width="90%" | | width="90%" class="mtx-class-macrohead" | '''Properties''' | ||
|- | |- | ||
|- | |- | ||
| width="10%" align="center" | | width="10%" align="center" class="mtx-class-propfolder" | [[File:Fc9-conn-icon.png]] | ||
| width="90%" | | width="90%" class="mtx-class-propfolder" | Communications | ||
|- | |- | ||
|- | |- | ||
| Line 754: | 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" | | width="10%" align="center" class="mtx-class-propfolder" | [[File:Fc9-conn-icon.png]] | ||
| width="90%" | | width="90%" class="mtx-class-propfolder" | USB Communications | ||
|- | |- | ||
|- | |- | ||
| Line 763: | Line 765: | ||
| colspan="2" | | | colspan="2" | | ||
|- | |- | ||
| width="10%" align="center" | | width="10%" align="center" class="mtx-class-propfolder" | [[File:Fc9-conn-icon.png]] | ||
| width="90%" | | 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 | |