APIs, concepts, guides, and more
_helpers.cs
1using RSI.RapidCode; // RSI.RapidCode.dotNET;
2
4public static class Helpers
5{
15 public static void CheckErrors(RapidCodeObject rsiObject)
16 {
17 var hasErrors = false;
18 var errorStrBuilder = new System.Text.StringBuilder();
19
20 while (rsiObject.ErrorLogCountGet() > 0)
21 {
22 // get error
23 RsiError rsiError = rsiObject.ErrorLogGet();
24
25 // get message
26 var errorMsg = rsiError.isWarning ? $"WARNING: {rsiError.Message}" : $"ERROR: {rsiError.Message}";
27 errorStrBuilder.AppendLine(errorMsg);
28
29 // set flag
30 hasErrors = !rsiError.isWarning;
31 }
32
33 if (hasErrors)
34 throw new Exception(errorStrBuilder.ToString());
35 }
36
37
47 public static void NetworkStart(MotionController controller)
48 {
49 // check if network is started already
50 if (controller.NetworkStateGet() != RSINetworkState.RSINetworkStateOPERATIONAL)
51 {
52 Console.WriteLine("Starting Network..");
53
54 // if not started, initialize the network
55 controller.NetworkStart();
56 }
57
58 // check if network is started again
59 if (controller.NetworkStateGet() != RSINetworkState.RSINetworkStateOPERATIONAL)
60 {
61 // read network log messages
62 int messagesToRead = controller.NetworkLogMessageCountGet();
63
64 // print all the messages to help figure out the problem
65 for (int i = 0; i < messagesToRead; i++)
66 Console.WriteLine(controller.NetworkLogMessageGet(i));
67
68 throw new SystemException("Expected OPERATIONAL state but the network did not get there.");
69 }
70 else
71 {
72 Console.WriteLine("Network Started");
73 }
74 }
75
76
86 public static void NetworkShutdown(MotionController controller)
87 {
88 // check if the network is already shutdown
89 if (controller.NetworkStateGet() == RSINetworkState.RSINetworkStateUNINITIALIZED ||
90 controller.NetworkStateGet() == RSINetworkState.RSINetworkStateSHUTDOWN)
91 return;
92
93 // shutdown the network
94 Console.WriteLine("Shutting down the network..");
95 controller.NetworkShutdown();
96
97 // check if the network is shutdown
98 var networkState = controller.NetworkStateGet();
99 if (networkState != RSINetworkState.RSINetworkStateUNINITIALIZED &&
100 networkState != RSINetworkState.RSINetworkStateSHUTDOWN)
101 {
102 // some kind of error shutting down the network, read the network log messages
103 int messagesToRead = controller.NetworkLogMessageCountGet();
104
105 // print all the messages to help figure out the problem
106 for (int i = 0; i < messagesToRead; i++)
107 Console.WriteLine(controller.NetworkLogMessageGet(i));
108
109 throw new SystemException("Expected SHUTDOWN state but the network did not get there.");
110 }
111 else
112 {
113 Console.WriteLine("Network Shutdown");
114 }
115 }
116
117
126 public static void ControllerSetup(MotionController controller)
127 {
128 NetworkShutdown(controller);
129
130 // reset the controller to ensure it is in a known state
131 controller.Reset();
132
133 NetworkStart(controller);
134 }
135
136
144 public static void PhantomAxisReset(Axis phantomAxis)
145 {
146 if (phantomAxis.MotorTypeGet() != RSIMotorType.RSIMotorTypePHANTOM)
147 {
148 throw new Exception(@$"Axis {phantomAxis.NumberGet()} is not configured as a phantom axis.
149 Please ensure the axis is set to phantom before calling PhantomAxisConfigure.");
150 }
151
152 // abort any motion
153 AbortMotionObject(phantomAxis);
154
155 // disable all limits (not used for phantom axes)
156 phantomAxis.ErrorLimitActionSet(RSIAction.RSIActionNONE);
157 phantomAxis.HardwareNegLimitActionSet(RSIAction.RSIActionNONE);
158 phantomAxis.HardwarePosLimitActionSet(RSIAction.RSIActionNONE);
159 phantomAxis.HomeActionSet(RSIAction.RSIActionNONE);
160 phantomAxis.SoftwareNegLimitActionSet(RSIAction.RSIActionNONE);
161 phantomAxis.SoftwarePosLimitActionSet(RSIAction.RSIActionNONE);
162
163 // set position tolerances to max value for immediate MotionDone
164 double POSITION_TOLERANCE_MAX = Double.MaxValue / 10.0;
165 phantomAxis.PositionToleranceCoarseSet(POSITION_TOLERANCE_MAX);
166 phantomAxis.PositionToleranceFineSet(POSITION_TOLERANCE_MAX);
167
168 // set sample apps default motion parameters
169 phantomAxis.UserUnitsSet(1);
170 phantomAxis.DefaultVelocitySet(100);
171 phantomAxis.DefaultAccelerationSet(1000);
172 phantomAxis.DefaultDecelerationSet(1000);
173 phantomAxis.DefaultJerkPercentSet(0);
174 phantomAxis.PositionSet(0);
175 }
177
178
186 /// @internal @[AbortMotionObject]
187 public static void AbortMotionObject(RapidCodeMotion motionObject)
188 {
189 motionObject.EStopAbort();
190 motionObject.MotionDoneWait();
191 motionObject.ClearFaults();
192
193 // check for idle state
194 if (motionObject.StateGet() != RSIState.RSIStateIDLE)
195 {
196 RSISource source = motionObject.SourceGet(); // get state source enum
197 string errorMsg = @$"Axis or MultiAxis {motionObject.NumberGet()} failed to enter IDLE state after aborting.
198 The source of the axis error is: {motionObject.SourceNameGet(source)}";
199 throw new Exception(errorMsg);
200 }
201 }
202
203}
static void AbortMotionObject(RapidCodeMotion motionObject)
Aborts motion on the given RapidCodeMotion object (Axis or MultiAxis), waits for motion to stop,...
Definition _helpers.cs:186
static void NetworkShutdown(MotionController controller)
Shuts down the network communication for the given MotionController.
Definition _helpers.cs:86
static void CheckErrors(RapidCodeObject rsiObject)
Checks for errors in the given RapidCodeObject and throws an exception if any non-warning errors are ...
Definition _helpers.cs:15
static void PhantomAxisReset(Axis phantomAxis)
Configures a phantom axis on the controller.
Definition _helpers.cs:144
static void NetworkStart(MotionController controller)
Starts the network communication for the given MotionController.
Definition _helpers.cs:47
static void ControllerSetup(MotionController controller)
Sets up the controller for hardware use by resetting it and starting the network.
Definition _helpers.cs:126
void HardwareNegLimitActionSet(RSIAction action)
Set the action that will occur when the Hardware Negative Limit Event triggers.
void HardwarePosLimitActionSet(RSIAction action)
Set the action that will occur when the Hardware Positive Limit Event triggers.
RSIMotorType MotorTypeGet()
Get the motor type.
void PositionToleranceCoarseSet(double tolerance)
Set the Coarse Position Tolerance for Axis settling.
void SoftwareNegLimitActionSet(RSIAction action)
Set the action that will occur when the Software Negative Limit Event triggers.
void UserUnitsSet(double countsPerUserUnit)
Sets the number of counts per User Unit.
void HomeActionSet(RSIAction action)
Set the action that will occur when the Home Event triggers.
void PositionToleranceFineSet(double tolerance)
Set the Fine Position Tolerance for Axis settling.
void ErrorLimitActionSet(RSIAction action)
Set the action that will occur when the Error Limit Event triggers.
void PositionSet(double position)
Set the Command and Actual positions.
void SoftwarePosLimitActionSet(RSIAction action)
Set the action that will occur when the Software Positive Limit Event triggers.
Represents a single axis of motion control. This class provides an interface for commanding motion,...
Definition rsi.h:5863
void DefaultVelocitySet(double velocity)
Set the default velocity in UserUnits.
void DefaultAccelerationSet(double acceleration)
Set the default acceleration in UserUnits.
void DefaultDecelerationSet(double deceleration)
Set the default deceleration in UserUnits.
void DefaultJerkPercentSet(double jerkPercent)
Set the default jerk percent.
Represents the RMP soft motion controller. This class provides an interface to general controller con...
Definition rsi.h:800
void ClearFaults()
Clear all faults for an Axis or MultiAxis.
int32_t MotionDoneWait()
Waits for a move to complete.
RSIState StateGet()
Get the Axis or MultiAxis state.
RSISource SourceGet()
Get the source of an error state for an Axis or MultiAxis.
void EStopAbort()
E-Stop, then abort an axis.
The RapidCodeMotion interface is implemented by Axis and MultiAxis .
Definition rsi.h:4312
const RsiError *const ErrorLogGet()
Get the next RsiError in the log.
int32_t ErrorLogCountGet()
Get the number of software errors in the error log.
The RapidCode base class. All non-error objects are derived from this class.
Definition rsi.h:184
Represents the error details thrown as an exception by all RapidCode classes. This class contains an ...
Definition rsi.h:111
bool isWarning
Whether the error is or is not a warning.
Definition rsi.h:120
RSINetworkState
State of network.
Definition rsienums.h:568
RSIAction
Action to perform on an Axis.
Definition rsienums.h:1115
RSIMotorType
Motor Type.
Definition rsienums.h:1311
RSISource
Possible sources that have caused an Error state.
Definition rsienums.h:1014
void NetworkStart(MotionController *controller)
[CheckErrors]
Definition helpers.h:73
void NetworkShutdown(MotionController *controller)
[NetworkStart]
Definition helpers.h:108
Helpers namespace provides utility functions for common tasks in RMP applications.
Definition helpers.h:21