### GetConsoleType Source: https://centroidcnc.com/CentroidAPI/class_centroid_a_p_i_1_1_c_n_c_pipe_1_1_state.html Get the current console type. ```APIDOC ## GetConsoleType ### Description Get the current console type. ### Method ReturnCode GetConsoleType(out ConsoleTypes consoleType) ### Parameters - **consoleType** (ConsoleTypes) - Output parameter for the current console type. ### Return Value ReturnCode indicating success or failure. ``` -------------------------------- ### GetConsoleType Source: https://centroidcnc.com/CentroidAPI/class_centroid_a_p_i_1_1_c_n_c_pipe_1_1_v_b___state.html Get the current console type. ```APIDOC ## GetConsoleType ### Description Get the current console type. ### Method ReturnCode GetConsoleType(out ConsoleTypes consoleType) ### Parameters #### Output Parameters - **consoleType** (ConsoleTypes) - The current console type. ### Return Value ReturnCode indicating success or failure. ``` -------------------------------- ### CScreen Source: https://centroidcnc.com/CentroidAPI/annotated.html Class to get screen and viewport info. ```APIDOC ## CScreen ### Description Class to get screen and viewport info. ### Methods (Methods not explicitly detailed in the source) ``` -------------------------------- ### RunCommand Source: https://centroidcnc.com/CentroidAPI/class_centroid_a_p_i_1_1_c_n_c_pipe_1_1_job.html Runs a command immediately or posts it as a job if cycle start is required. ```APIDOC ## RunCommand(string command, string cnc12_working_directory, bool require_cycle_start = true) ### Description Run a command now. If we require cycle start, it will post as an actual job. ### Parameters - **command** (string) - The command to run. - **cnc12_working_directory** (string) - The working directory for CNC12. - **require_cycle_start** (bool) - Optional. Defaults to true. If true, the command will be posted as a job requiring cycle start. ``` ```APIDOC ## RunCommand(string command, bool require_cycle_start = true) ### Description Run a command now. If we require cycle start, it will post as an actual job. ### Parameters - **command** (string) - The command to run. - **require_cycle_start** (bool) - Optional. Defaults to true. If true, the command will be posted as a job requiring cycle start. ``` -------------------------------- ### CSys Source: https://centroidcnc.com/CentroidAPI/annotated.html A class for getting system-related information. ```APIDOC ## CSys ### Description A class for getting system-related information. ### Methods (Methods not explicitly detailed in the source) ``` -------------------------------- ### GetUsbOnlineBits Source: https://centroidcnc.com/CentroidAPI/class_centroid_a_p_i_1_1_c_n_c_pipe_1_1_state.html Get the online bits of the connected USB-BOBs. ```APIDOC ## GetUsbOnlineBits ### Description Get the online bits of the connected USB-BOBs. ### Method ReturnCode GetUsbOnlineBits(out bool[] onlineBits) ### Parameters - **onlineBits** (bool[]) - Output parameter for an array of booleans indicating the online status of USB-BOBs. ### Return Value ReturnCode indicating success or failure. ``` -------------------------------- ### GetUsbOnlineBits Source: https://centroidcnc.com/CentroidAPI/class_centroid_a_p_i_1_1_c_n_c_pipe_1_1_v_b___state.html Get the online bits of the connected USB-BOBs. ```APIDOC ## GetUsbOnlineBits ### Description Get the online bits of the connected USB-BOBs. ### Method ReturnCode GetUsbOnlineBits(out bool[] onlineBits) ### Parameters #### Output Parameters - **onlineBits** (bool[]) - An array of booleans indicating the online status of USB-BOBs. ### Return Value ReturnCode indicating success or failure. ``` -------------------------------- ### CParameter Source: https://centroidcnc.com/CentroidAPI/annotated.html Handles getting and setting of machine parameters. ```APIDOC ## CParameter ### Description Handles getting and setting of machine parameters. ### Methods (Methods not explicitly detailed in the source) ``` -------------------------------- ### GetUsbInputInversions Source: https://centroidcnc.com/CentroidAPI/class_centroid_a_p_i_1_1_c_n_c_pipe_1_1_v_b___state.html Get the current USB-BOB input inversion bits. ```APIDOC ## GetUsbInputInversions ### Description Get the current USB-BOB input inversion bits. ### Method ReturnCode GetUsbInputInversions(out string inversionBits) ### Parameters #### Output Parameters - **inversionBits** (string) - A string representing the USB-BOB input inversion bits. ### Return Value ReturnCode indicating success or failure. ``` -------------------------------- ### GetUsbInputInversions Source: https://centroidcnc.com/CentroidAPI/class_centroid_a_p_i_1_1_c_n_c_pipe_1_1_state.html Get the current USB-BOB input inversion bits. ```APIDOC ## GetUsbInputInversions ### Description Get the current USB-BOB input inversion bits. ### Method ReturnCode GetUsbInputInversions(out string inversionBits) ### Parameters - **inversionBits** (string) - Output parameter for the USB-BOB input inversion bits. ### Return Value ReturnCode indicating success or failure. ``` -------------------------------- ### RunCommand (command, require_cycle_start) Source: https://centroidcnc.com/CentroidAPI/class_centroid_a_p_i_1_1_c_n_c_pipe_1_1_job-members.html Runs a command, optionally requiring cycle start. ```APIDOC ## RunCommand (command, require_cycle_start) ### Description Runs a command, optionally requiring cycle start. ### Method (Implicitly a method call on a Job object) ### Parameters * **command** (string) - The command to execute. * **require_cycle_start** (bool) - Defaults to true. Specifies if cycle start is required before executing the command. ### Response (No specific response details provided in source) ``` -------------------------------- ### GetHighestLicenseVersion Source: https://centroidcnc.com/CentroidAPI/class_centroid_a_p_i_1_1_c_n_c_pipe_1_1_sys-members.html Retrieves the highest installed license version. ```APIDOC ## GetHighestLicenseVersion ### Description Retrieves the highest installed license version. ### Method LicenseVersion ### Endpoint CentroidAPI.CNCPipe.Sys.GetHighestLicenseVersion(out LicenseVersion highestVersion) ``` -------------------------------- ### MainWindow.cs Initialization and Event Handlers Source: https://centroidcnc.com/CentroidAPI/axisdata.html Sets up the main window, initializes the CNCPipe for communication, and declares event handlers for UI interactions. The `allowedAxisLabels` array is defined for validation purposes. ```C# using System; using System.Linq; using System.Windows; using CentroidAPI; namespace GettingSomeAxisData { public partial class MainWindow : Window { private CNCPipe cnc12_pipe; private CNCPipe.ReturnCode returnCode; private readonly string[] allowedAxisLabels = { "A", "B", "C", "N", "W", "X", "Y", "Z" }; public MainWindow() { InitializeComponent(); cnc12_pipe = new CNCPipe(); } private void ButtonGetAxis1Label_Click(object sender, RoutedEventArgs e) { } private void ButtonSetAxis1Label_Click(object sender, RoutedEventArgs e) { } private void ButtonGetAxis1TravelLimit_Click(object sender, RoutedEventArgs e) { } private void ButtonSetAxis1TravelLimit_Click(object sender, RoutedEventArgs e) { } private void ButtonGetAxis1MaxRate_Click(object sender, RoutedEventArgs e) { } private void ButtonSetAxis1MaxRate_Click(object sender, RoutedEventArgs e) { } } } ``` -------------------------------- ### Get Wear Adjustment Source: https://centroidcnc.com/CentroidAPI/class_centroid_a_p_i_1_1_c_n_c_pipe_1_1_tool.html Gets the tool wear adjustment for a lathe tool. ```APIDOC ## GetWearAdjustment ### Description Get the tool wear adjustment for a lathe tool. ### Method `GetWearAdjustment(int T, ToolWearAdjustmentType type, out double value)` ### Parameters - `T` (int) - Required - The tool number. - `type` (ToolWearAdjustmentType) - Required - The type of wear adjustment. ### Returns - `ReturnCode`: Indicates the success or failure of the operation. - `value` (out double): The wear adjustment value. ``` -------------------------------- ### Screen Constructor Source: https://centroidcnc.com/CentroidAPI/class_centroid_a_p_i_1_1_c_n_c_pipe_1_1_screen-members.html Initializes a new instance of the Screen class. ```APIDOC ## Screen Constructor ### Description Initializes a new instance of the Screen class with the specified parent CNCPipe object. ### Method (Method signature implies a call, but no HTTP method is specified) ### Parameters #### Path Parameters None #### Query Parameters None #### Request Body None ### Parameters - **parent** (CNCPipe) - The parent CNCPipe object. ### Request Example (No example provided in source) ### Response #### Success Response (Response details not provided in source) #### Response Example (No example provided in source) ``` -------------------------------- ### Get Accel Time for an Axis Source: https://centroidcnc.com/CentroidAPI/class_centroid_a_p_i_1_1_c_n_c_pipe_1_1_axis.html Retrieves the acceleration time for a specified axis. Use this to get the configured acceleration time for axis control. ```csharp returnCode = cnc_pipe.axis.GetAccelTime(CNCPipe.Axes.AXIS_1, out double accel_time); ``` -------------------------------- ### CCNCPipe Source: https://centroidcnc.com/CentroidAPI/annotated.html Class for getting and setting different system variables. ```APIDOC ## CCNCPipe ### Description Class for getting and setting different system variables. ### Methods (Methods not explicitly detailed in the source) ``` -------------------------------- ### StartListening Source: https://centroidcnc.com/CentroidAPI/class_centroid_a_p_i_1_1_c_n_c_pipe.html Begins the process of listening for incoming messages from CNC12. ```APIDOC ## StartListening ### Description Starts listening for messages from CNC12. ### Method `void StartListening()` ``` -------------------------------- ### Get Rate for CNC Axis Source: https://centroidcnc.com/CentroidAPI/class_centroid_a_p_i_1_1_c_n_c_pipe_1_1_axis.html Retrieves the current jog rate for a specified axis. Use this to get the slow jog rate, fast jog rate, or maximum rate for an axis. ```csharp returnCode = cnc_pipe.axis.GetRate(CNCPipe.Axes.AXIS_1, CNCPipe.Axis.JogRate.SLOW_JOG, out double rate); ``` -------------------------------- ### VB_System Constructor Source: https://centroidcnc.com/CentroidAPI/class_centroid_a_p_i_1_1_c_n_c_pipe_1_1_v_b___system.html Initializes a new instance of the VB_System class. ```APIDOC ## VB_System() ### Description Constructor for the VB_System class. ### Parameters * **parent** (CNCPipe) - Required - A reference to an already created System object. ``` -------------------------------- ### GetJogState Source: https://centroidcnc.com/CentroidAPI/class_centroid_a_p_i_1_1_c_n_c_pipe_1_1_state.html Get if the user is jogging the machine or not. ```APIDOC ## GetJogState ### Description Get if the user is jogging the machine or not. ### Method ReturnCode GetJogState(out bool jog_state) ### Parameters - **jog_state** (bool) - Output parameter indicating if the machine is being jogged. ### Return Value ReturnCode indicating success or failure. ``` -------------------------------- ### RunCommand Source: https://centroidcnc.com/CentroidAPI/class_centroid_a_p_i_1_1_c_n_c_pipe_1_1_v_b___job.html Runs a command immediately. If cycle start is required, it will be posted as an actual job. ```APIDOC ## RunCommand (string command, string cnc12_working_directory, bool require_cycle_start=true) ### Description Runs a command now. If cycle start is required, it will be posted as an actual job. ### Parameters - **command** (string) - Required - The command to run. - **cnc12_working_directory** (string) - Required - The working directory for CNC12. - **require_cycle_start** (bool) - Optional - Defaults to true. Specifies if cycle start is required. ``` ```APIDOC ## RunCommand (string command, bool require_cycle_start=true) ### Description Runs a command now. If cycle start is required, it will be posted as an actual job. ### Parameters - **command** (string) - Required - The command to run. - **require_cycle_start** (bool) - Optional - Defaults to true. Specifies if cycle start is required. ``` -------------------------------- ### Screen Class Source: https://centroidcnc.com/CentroidAPI/class_centroid_a_p_i_1_1_c_n_c_pipe.html Provides access to functionalities for getting screen and viewport information. ```APIDOC ## Screen **screen** Class for getting screen and viewport info. ``` -------------------------------- ### GetMachineHomeAtPowerUp Source: https://centroidcnc.com/CentroidAPI/class_centroid_a_p_i_1_1_c_n_c_pipe_1_1_v_b___state.html Get the currently set machine homing type at power up. ```APIDOC ## GetMachineHomeAtPowerUp ### Description Get the currently set machine homing type at power up. ### Method ReturnCode GetMachineHomeAtPowerUp(out HomingType homing_type) ### Parameters #### Output Parameters - **homing_type** (HomingType) - The machine homing type at power up. ### Return Value ReturnCode indicating success or failure. ``` -------------------------------- ### GetMachineHomeAtPowerUp Source: https://centroidcnc.com/CentroidAPI/class_centroid_a_p_i_1_1_c_n_c_pipe_1_1_state.html Get the currently set machine homing type at power up. ```APIDOC ## GetMachineHomeAtPowerUp ### Description Get the currently set machine homing type at power up. ### Method ReturnCode GetMachineHomeAtPowerUp(out HomingType homing_type) ### Parameters - **homing_type** (HomingType) - Output parameter for the machine homing type. ### Return Value ReturnCode indicating success or failure. ``` -------------------------------- ### GetJogState Source: https://centroidcnc.com/CentroidAPI/class_centroid_a_p_i_1_1_c_n_c_pipe_1_1_v_b___state.html Get if the user is jogging the machine or not. ```APIDOC ## GetJogState ### Description Get if the user is jogging the machine or not. ### Method ReturnCode GetJogState(out bool jog_state) ### Parameters #### Output Parameters - **jog_state** (bool) - True if the user is jogging, false otherwise. ### Return Value ReturnCode indicating success or failure. ``` -------------------------------- ### Sys Constructor Source: https://centroidcnc.com/CentroidAPI/class_centroid_a_p_i_1_1_c_n_c_pipe_1_1_sys-members.html Initializes a new instance of the Sys class. ```APIDOC ## Sys Constructor ### Description Initializes a new instance of the Sys class. ### Endpoint CentroidAPI.CNCPipe.Sys.Sys(CNCPipe parent) ``` -------------------------------- ### Tool Constructor Source: https://centroidcnc.com/CentroidAPI/class_centroid_a_p_i_1_1_c_n_c_pipe_1_1_tool-members.html Initializes a new instance of the Tool class. ```APIDOC ## Tool Constructor ### Description Initializes a new instance of the Tool class. ### Method `Tool(CNCPipe parent)` ### Parameters #### Path Parameters - **parent** (CNCPipe) - The parent CNCPipe object. ### Response #### Success Response Initializes a new Tool object. ``` -------------------------------- ### GetCurrentLocalPosition Source: https://centroidcnc.com/CentroidAPI/class_centroid_a_p_i_1_1_c_n_c_pipe_1_1_state.html Get the current wcs position. ```APIDOC ## GetCurrentLocalPosition ### Description Get the current wcs position. ### Method ReturnCode GetCurrentLocalPosition(out double[] local_pos) ### Parameters - **local_pos** (double[]) - Output parameter for the current local (WCS) position coordinates. ### Return Value ReturnCode indicating success or failure. ``` -------------------------------- ### Tool Class Source: https://centroidcnc.com/CentroidAPI/class_centroid_a_p_i_1_1_c_n_c_pipe.html Provides functionalities for getting and setting tool information. ```APIDOC ## Tool **tool** Class for getting and setting tool info. ``` -------------------------------- ### VB_Screen Constructor Source: https://centroidcnc.com/CentroidAPI/class_centroid_a_p_i_1_1_c_n_c_pipe_1_1_v_b___screen-members.html Initializes a new instance of the VB_Screen class. ```APIDOC ## VB_Screen Constructor ### Description Initializes a new instance of the VB_Screen class. ### Method Signature `VB_Screen(CNCPipe parent)` ### Parameters - **parent** (CNCPipe) - The parent CNCPipe object. ``` -------------------------------- ### GetCurrentLocalPosition Source: https://centroidcnc.com/CentroidAPI/class_centroid_a_p_i_1_1_c_n_c_pipe_1_1_v_b___state.html Get the current wcs position. ```APIDOC ## GetCurrentLocalPosition ### Description Get the current wcs position. ### Method ReturnCode GetCurrentLocalPosition(out double[] local_pos) ### Parameters #### Output Parameters - **local_pos** (double[]) - An array representing the current local (WCS) position. ### Return Value ReturnCode indicating success or failure. ``` -------------------------------- ### GetCurrentMachinePosition Source: https://centroidcnc.com/CentroidAPI/class_centroid_a_p_i_1_1_c_n_c_pipe_1_1_state.html Gets the current machine position. ```APIDOC ## GetCurrentMachinePosition ### Description Gets the current machine position. ### Method ReturnCode GetCurrentMachinePosition(out double[] machine_pos) ### Parameters - **machine_pos** (double[]) - Output parameter for the current machine position coordinates. ### Return Value ReturnCode indicating success or failure. ``` -------------------------------- ### MainWindow C# Initialization Source: https://centroidcnc.com/CentroidAPI/cnc12mainscreen.html Initializes the main window, creates a CNCPipe instance, and assigns it to various Centroid API user controls for data binding and communication. ```C# using System.Text; using System.Threading.Tasks; using System.Windows; using System.Windows.Controls; using System.Windows.Data; using System.Windows.Documents; using System.Windows.Input; using System.Windows.Media; using System.Windows.Media.Imaging; using System.Windows.Navigation; using System.Windows.Shapes; using CentroidAPI; namespace Cnc12MainScreen { public partial class MainWindow : Window { private CNCPipe cnc12_pipe; public MainWindow() { InitializeComponent(); cnc12_pipe = new CNCPipe(); Dro.Pipe = cnc12_pipe; StatusWindow.Pipe = cnc12_pipe; MessageWindow.Pipe = cnc12_pipe; DroDistanceToGo.Pipe = cnc12_pipe; ActiveGCodes.Pipe = cnc12_pipe; GCodeDisplay.Pipe = cnc12_pipe; } } } ``` -------------------------------- ### GetSpindleSpeed Source: https://centroidcnc.com/CentroidAPI/class_centroid_a_p_i_1_1_c_n_c_pipe_1_1_state.html Get the current spindle speed. ```APIDOC ## GetSpindleSpeed ### Description Get the current spindle speed. ### Method ReturnCode GetSpindleSpeed(out double spindle_speed) ### Parameters - **spindle_speed** (double) - Output parameter for the current spindle speed. ### Return Value ReturnCode indicating success or failure. ``` -------------------------------- ### Tool() Constructor Source: https://centroidcnc.com/CentroidAPI/class_centroid_a_p_i_1_1_c_n_c_pipe_1_1_tool.html Initializes a new instance of the Tool class. It requires a reference to an existing System object as its parent. ```APIDOC ## Tool() CentroidAPI.CNCPipe.Tool.Tool() constructor. ### Parameters - **parent** (System) - Required - A reference to an already constructed System object. ``` -------------------------------- ### GetCurrentMachinePosition Source: https://centroidcnc.com/CentroidAPI/class_centroid_a_p_i_1_1_c_n_c_pipe_1_1_v_b___state.html Gets the current machine position. ```APIDOC ## GetCurrentMachinePosition ### Description Gets the current machine position. ### Method ReturnCode GetCurrentMachinePosition(out double[] machine_pos) ### Parameters #### Output Parameters - **machine_pos** (double[]) - An array representing the current machine position. ### Return Value ReturnCode indicating success or failure. ``` -------------------------------- ### Job Constructor Source: https://centroidcnc.com/CentroidAPI/class_centroid_a_p_i_1_1_c_n_c_pipe_1_1_job-members.html Initializes a new instance of the Job class. ```APIDOC ## Job Constructor ### Description Initializes a new instance of the Job class. ### Method Job(CNCPipe parent) ### Parameters * **parent** (CNCPipe) - The parent CNCPipe object. ### Response (No specific response details provided in source) ``` -------------------------------- ### GetSpindleSpeed Source: https://centroidcnc.com/CentroidAPI/class_centroid_a_p_i_1_1_c_n_c_pipe_1_1_v_b___state.html Get the current spindle speed. ```APIDOC ## GetSpindleSpeed ### Description Get the current spindle speed. ### Method ReturnCode GetSpindleSpeed(out double spindle_speed) ### Parameters #### Output Parameters - **spindle_speed** (double) - The current spindle speed. ### Return Value ReturnCode indicating success or failure. ``` -------------------------------- ### MessageWindow Constructor Source: https://centroidcnc.com/CentroidAPI/class_centroid_a_p_i_1_1_c_n_c_pipe_1_1_message_window-members.html Initializes a new instance of the MessageWindow class. ```APIDOC ## MessageWindow(CNCPipe parent) ### Description Initializes a new instance of the MessageWindow class, associating it with a CNCPipe parent object. ### Method Signature CentroidAPI.CNCPipe.MessageWindow.MessageWindow(CNCPipe parent) ### Parameters - **parent** (CNCPipe) - Required - The parent CNCPipe object to which this message window belongs. ``` -------------------------------- ### Get Tool Description Source: https://centroidcnc.com/CentroidAPI/class_centroid_a_p_i_1_1_c_n_c_pipe_1_1_tool.html Retrieves the description for the current or a specified tool. ```APIDOC ## GetToolDescription ### Description Gets the description for the current tool or a specified tool. ### Methods 1. `GetToolDescription(out string description)` - Gets the description for the current tool. 2. `GetToolDescription(int i, out string description)` - Gets the description for the specified tool. ### Returns - `ReturnCode`: Indicates the success or failure of the operation. - `description` (out string): The tool description. ``` -------------------------------- ### GetToolDescription() - Overload 2 Source: https://centroidcnc.com/CentroidAPI/class_centroid_a_p_i_1_1_c_n_c_pipe_1_1_tool.html Retrieves the description for the currently active tool. It returns a ReturnCode indicating success or failure. ```APIDOC ## GetToolDescription() [2/2] ReturnCode CentroidAPI.CNCPipe.Tool.GetToolDescription(out string description) ### Description Get the description for the current tool. ### Parameters - **description** (out string) - Required - The tool description of the current tool. ### Returns - SUCCESS or an error code. ### Since v5.24 ``` -------------------------------- ### GetMdiState Source: https://centroidcnc.com/CentroidAPI/class_centroid_a_p_i_1_1_c_n_c_pipe_1_1_state.html Get whether or not CNC12 is in MDI. ```APIDOC ## GetMdiState ### Description Get whether or not CNC12 is in MDI. ### Method ReturnCode GetMdiState(out MdiState mdi_state) ### Parameters - **mdi_state** (MdiState) - Output parameter for the MDI state. ### Return Value ReturnCode indicating success or failure. ``` -------------------------------- ### Plc Constructor Source: https://centroidcnc.com/CentroidAPI/class_centroid_a_p_i_1_1_c_n_c_pipe_1_1_plc-members.html Initializes a new instance of the Plc class. ```APIDOC ## Plc Constructor ### Description Initializes a new instance of the Plc class. ### Method `Plc(CNCPipe parent)` ### Parameters #### Path Parameters - **parent** (CNCPipe) - Description not available. ``` -------------------------------- ### GetAcornBoardRevision Source: https://centroidcnc.com/CentroidAPI/class_centroid_a_p_i_1_1_c_n_c_pipe_1_1_v_b___state.html Gets the Acorn Board Revision. ```APIDOC ## GetAcornBoardRevision ### Description Gets the Acorn Board Revision. ### Method ReturnCode GetAcornBoardRevision(out int revision) ### Parameters #### Output Parameters - **revision** (int) - The revision number of the Acorn Board. ### Return Value ReturnCode indicating success or failure. ``` -------------------------------- ### Get Tool Library Source: https://centroidcnc.com/CentroidAPI/class_centroid_a_p_i_1_1_c_n_c_pipe_1_1_tool.html Retrieves information for all tools within the tool library. ```APIDOC ## GetToolLibrary ### Description Gets tool info for all tools within the tool library. ### Method `GetToolLibrary(out List ToolLibrary)` ### Returns - `ReturnCode`: Indicates the success or failure of the operation. - `ToolLibrary` (out List): A list containing information for all tools in the library. ``` -------------------------------- ### Get Tool Info Source: https://centroidcnc.com/CentroidAPI/class_centroid_a_p_i_1_1_c_n_c_pipe_1_1_tool.html Retrieves information for the current tool or a specified tool. ```APIDOC ## GetToolInfo ### Description Gets info for the current tool or a specified tool. ### Methods 1. `GetToolInfo ()` - Gets info for the current tool. 2. `GetToolInfo (int t)` - Gets tool info for the tool with the specified tool number. ### Returns - `Info`: An object containing tool information. ``` -------------------------------- ### GetAcornBoardRevision Source: https://centroidcnc.com/CentroidAPI/class_centroid_a_p_i_1_1_c_n_c_pipe_1_1_state.html Gets the Acorn Board Revision. ```APIDOC ## GetAcornBoardRevision ### Description Gets the Acorn Board Revision. ### Method ReturnCode GetAcornBoardRevision(out int revision) ### Parameters - **revision** (int) - Output parameter for the board revision. ### Return Value ReturnCode indicating success or failure. ``` -------------------------------- ### GetToolDescription Source: https://centroidcnc.com/CentroidAPI/class_centroid_a_p_i_1_1_c_n_c_pipe_1_1_tool-members.html Retrieves the description of the current tool. ```APIDOC ## GetToolDescription ### Description Retrieves the description of the current tool. ### Method `GetToolDescription(out string description)` ### Parameters #### Output Parameters - **description** (string) - The tool description. ### Response #### Success Response - **description** (string) - The tool description. ## GetToolDescription ### Description Retrieves the description of a specific tool. ### Method `GetToolDescription(int i, out string description)` ### Parameters #### Path Parameters - **i** (int) - The tool index. #### Output Parameters - **description** (string) - The description of the specified tool. ### Response #### Success Response - **description** (string) - The tool description is returned. ``` -------------------------------- ### GetScreenPosition Source: https://centroidcnc.com/CentroidAPI/class_centroid_a_p_i_1_1_c_n_c_pipe_1_1_v_b___state.html Gets the position of the CNC application. ```APIDOC ## GetScreenPosition ### Description Gets the position of the CNC application. ### Method ReturnCode GetScreenPosition(out int x, out int y) ### Parameters #### Output Parameters - **x** (int) - The x-coordinate of the application's position. - **y** (int) - The y-coordinate of the application's position. ### Return Value ReturnCode indicating success or failure. ``` -------------------------------- ### Parameter Constructor Source: https://centroidcnc.com/CentroidAPI/class_centroid_a_p_i_1_1_c_n_c_pipe_1_1_parameter-members.html Initializes a new instance of the Parameter class. ```APIDOC ## Parameter Constructor ### Description Initializes a new instance of the Parameter class. ### Method Signature CentroidAPI.CNCPipe.Parameter.Parameter(CNCPipe parent) ``` -------------------------------- ### GetScreenPosition Source: https://centroidcnc.com/CentroidAPI/class_centroid_a_p_i_1_1_c_n_c_pipe_1_1_state.html Gets the position of the CNC application. ```APIDOC ## GetScreenPosition ### Description Gets the position of the CNC application. ### Method ReturnCode GetScreenPosition(out int x, out int y) ### Parameters - **x** (int) - Output parameter for the screen's X coordinate. - **y** (int) - Output parameter for the screen's Y coordinate. ### Return Value ReturnCode indicating success or failure. ``` -------------------------------- ### VB_State Constructor Source: https://centroidcnc.com/CentroidAPI/class_centroid_a_p_i_1_1_c_n_c_pipe_1_1_v_b___state.html Initializes a new instance of the VB_State class. ```APIDOC ## VB_State() ### Description Constructor for the VB_State class. ### Parameters - **parent** (CNCPipe) - Required - A reference to an already created System object. ``` -------------------------------- ### GetLabel Source: https://centroidcnc.com/CentroidAPI/class_centroid_a_p_i_1_1_c_n_c_pipe_1_1_axis-members.html Gets the label for a specified axis. ```APIDOC ## GetLabel ### Description Gets the label for a specified axis. ### Method GET ### Endpoint /api/axis/label ### Parameters #### Query Parameters * **axis** (Axes) - Required - The axis to get the label for. * **label** (out char) - Required - Output parameter for the axis label. ``` -------------------------------- ### GetAxisReversal Source: https://centroidcnc.com/CentroidAPI/class_centroid_a_p_i_1_1_c_n_c_pipe_1_1_axis-members.html Gets whether the axis is reversed. ```APIDOC ## GetAxisReversal ### Description Gets whether the axis is reversed. ### Method GET ### Endpoint /api/axis/reversal ### Parameters #### Query Parameters * **axis** (Axes) - Required - The axis to check. * **is_axis_reversed** (out bool) - Required - Output parameter indicating if the axis is reversed. ``` -------------------------------- ### Screen Constructor (Inherited) Source: https://centroidcnc.com/CentroidAPI/class_centroid_a_p_i_1_1_c_n_c_pipe_1_1_v_b___screen.html Initializes a new instance of the Screen class. This is an inherited constructor for VB_Screen. ```APIDOC ## Screen(CNCPipe parent) ### Description Constructor for the base Screen class. ### Parameters - **parent** (CNCPipe) - Required - A reference to an already created CNCPipe object. ``` -------------------------------- ### Wcs Constructor Source: https://centroidcnc.com/CentroidAPI/class_centroid_a_p_i_1_1_c_n_c_pipe_1_1_wcs-members.html Initializes a new instance of the Wcs class. ```APIDOC ## Wcs(CNCPipe parent) ### Description Initializes a new instance of the Wcs class. ### Method CentroidAPI.CNCPipe.Wcs ### Parameters - **parent** (CNCPipe) - The parent CNCPipe object. ``` -------------------------------- ### GetPositioningMode Source: https://centroidcnc.com/CentroidAPI/class_centroid_a_p_i_1_1_c_n_c_pipe_1_1_v_b___state.html Get the positioning mode of the machine currently. ```APIDOC ## GetPositioningMode ### Description Get the positioning mode of the machine currently. ### Method ReturnCode GetPositioningMode(out PositioningMode positioning_mode) ### Parameters #### Output Parameters - **positioning_mode** (PositioningMode) - The current positioning mode. ### Return Value ReturnCode indicating success or failure. ``` -------------------------------- ### VB_Tool Constructor Source: https://centroidcnc.com/CentroidAPI/class_centroid_a_p_i_1_1_c_n_c_pipe_1_1_v_b___tool.html Initializes a new instance of the VB_Tool class. ```APIDOC ## VB_Tool() ### Description Constructor for the VB_Tool class. ### Parameters #### Path Parameters - **parent** (CNCPipe) - Required - A reference to an already created System object. ``` -------------------------------- ### GetPositioningMode Source: https://centroidcnc.com/CentroidAPI/class_centroid_a_p_i_1_1_c_n_c_pipe_1_1_state.html Get the positioning mode of the machine currently. ```APIDOC ## GetPositioningMode ### Description Get the positioning mode of the machine currently. ### Method ReturnCode GetPositioningMode(out PositioningMode positioning_mode) ### Parameters - **positioning_mode** (PositioningMode) - Output parameter for the current positioning mode. ### Return Value ReturnCode indicating success or failure. ``` -------------------------------- ### GetMdiState Source: https://centroidcnc.com/CentroidAPI/class_centroid_a_p_i_1_1_c_n_c_pipe_1_1_v_b___state.html Get whether or not CNC12 is in MDI mode. ```APIDOC ## GetMdiState ### Description Get whether or not CNC12 is in MDI mode. ### Method ReturnCode GetMdiState(out MdiState mdi_state) ### Parameters #### Output Parameters - **mdi_state** (MdiState) - The current MDI state. ### Return Value ReturnCode indicating success or failure. ``` -------------------------------- ### RunCommand (command, cnc12_working_directory, require_cycle_start) Source: https://centroidcnc.com/CentroidAPI/class_centroid_a_p_i_1_1_c_n_c_pipe_1_1_job-members.html Runs a command within the specified CNC12 working directory, optionally requiring cycle start. ```APIDOC ## RunCommand (command, cnc12_working_directory, require_cycle_start) ### Description Runs a command within the specified CNC12 working directory, optionally requiring cycle start. ### Method (Implicitly a method call on a Job object) ### Parameters * **command** (string) - The command to execute. * **cnc12_working_directory** (string) - The CNC12 working directory. * **require_cycle_start** (bool) - Defaults to true. Specifies if cycle start is required before executing the command. ### Response (No specific response details provided in source) ``` -------------------------------- ### GetJobNameCurrent Source: https://centroidcnc.com/CentroidAPI/class_centroid_a_p_i_1_1_c_n_c_pipe_1_1_v_b___state.html Get the name of the currently loaded job. ```APIDOC ## GetJobNameCurrent ### Description Get the name of the currently loaded job. ### Method ReturnCode GetJobNameCurrent(out string job_name) ### Parameters #### Output Parameters - **job_name** (string) - The name of the current job. ### Return Value ReturnCode indicating success or failure. ``` -------------------------------- ### Load (path, cnc12_working_directory) Source: https://centroidcnc.com/CentroidAPI/class_centroid_a_p_i_1_1_c_n_c_pipe_1_1_job-members.html Loads a job from the specified path with a given CNC12 working directory. ```APIDOC ## Load (path, cnc12_working_directory) ### Description Loads a job from the specified path with a given CNC12 working directory. ### Method (Implicitly a method call on a Job object) ### Parameters * **path** (string) - The path to the job file. * **cnc12_working_directory** (string) - The CNC12 working directory. ### Response (No specific response details provided in source) ``` -------------------------------- ### GetJobNameCurrent Source: https://centroidcnc.com/CentroidAPI/class_centroid_a_p_i_1_1_c_n_c_pipe_1_1_state.html Get the name of the currently loaded job. ```APIDOC ## GetJobNameCurrent ### Description Get the name of the currently loaded job. ### Method ReturnCode GetJobNameCurrent(out string job_name) ### Parameters - **job_name** (string) - Output parameter for the name of the current job. ### Return Value ReturnCode indicating success or failure. ``` -------------------------------- ### Load (path) Source: https://centroidcnc.com/CentroidAPI/class_centroid_a_p_i_1_1_c_n_c_pipe_1_1_job-members.html Loads a job from the specified path. ```APIDOC ## Load (path) ### Description Loads a job from the specified path. ### Method (Implicitly a method call on a Job object) ### Parameters * **path** (string) - The path to the job file. ### Response (No specific response details provided in source) ``` -------------------------------- ### GetFeedHoldState Source: https://centroidcnc.com/CentroidAPI/class_centroid_a_p_i_1_1_c_n_c_pipe_1_1_v_b___state.html Get the current feed hold state. ```APIDOC ## GetFeedHoldState ### Description Get the current feed hold state. ### Method ReturnCode GetFeedHoldState(out FeedHoldState feed_hold_state) ### Parameters #### Output Parameters - **feed_hold_state** (FeedHoldState) - The current feed hold state. ### Return Value ReturnCode indicating success or failure. ``` -------------------------------- ### VB_MessageWindow Constructor Source: https://centroidcnc.com/CentroidAPI/class_centroid_a_p_i_1_1_c_n_c_pipe_1_1_v_b___message_window.html Initializes a new instance of the VB_MessageWindow class. ```APIDOC ## VB_MessageWindow Constructor ### Description Initializes a new instance of the VB_MessageWindow class. ### Parameters * **parent** (CNCPipe) - A reference to an already created System object. ``` -------------------------------- ### VB_MessageWindow Constructor Source: https://centroidcnc.com/CentroidAPI/class_centroid_a_p_i_1_1_c_n_c_pipe_1_1_v_b___message_window-members.html Initializes a new instance of the VB_MessageWindow class. ```APIDOC ## VB_MessageWindow(CNCPipe parent) ### Description Constructs a new VB_MessageWindow object, associating it with a parent CNCPipe instance. ### Method VB_MessageWindow ### Parameters - **parent** (CNCPipe) - Required - The parent CNCPipe object to which this message window belongs. ``` -------------------------------- ### GetFeedHoldState Source: https://centroidcnc.com/CentroidAPI/class_centroid_a_p_i_1_1_c_n_c_pipe_1_1_state.html Get the current feed hold state. ```APIDOC ## GetFeedHoldState ### Description Get the current feed hold state. ### Method ReturnCode GetFeedHoldState(out FeedHoldState feed_hold_state) ### Parameters - **feed_hold_state** (FeedHoldState) - Output parameter for the current feed hold state. ### Return Value ReturnCode indicating success or failure. ``` -------------------------------- ### GetMonitorSize Source: https://centroidcnc.com/CentroidAPI/class_centroid_a_p_i_1_1_c_n_c_pipe_1_1_v_b___state.html Gets the monitor size of the CNC application. ```APIDOC ## GetMonitorSize ### Description Gets the monitor size of the CNC application. ### Method ReturnCode GetMonitorSize(out int width, out int height) ### Parameters #### Output Parameters - **width** (int) - The width of the monitor. - **height** (int) - The height of the monitor. ### Return Value ReturnCode indicating success or failure. ``` -------------------------------- ### VB_Plc Constructor Source: https://centroidcnc.com/CentroidAPI/class_centroid_a_p_i_1_1_c_n_c_pipe_1_1_v_b___plc.html Initializes a new instance of the VB_Plc class. ```APIDOC ## VB_Plc() ### Description Constructor for the VB_Plc class. ### Method Constructor ### Parameters #### Path Parameters - **parent** (CNCPipe) - Required - A reference to an already created System object. ``` -------------------------------- ### VB_Screen Constructor Source: https://centroidcnc.com/CentroidAPI/class_centroid_a_p_i_1_1_c_n_c_pipe_1_1_v_b___screen.html Initializes a new instance of the VB_Screen class. This constructor requires a reference to an existing CNCPipe object. ```APIDOC ## VB_Screen() ### Description Constructor for the VB_Screen class. ### Parameters - **parent** (CNCPipe) - Required - A reference to an already created CNCPipe object. ``` -------------------------------- ### GetMonitorSize Source: https://centroidcnc.com/CentroidAPI/class_centroid_a_p_i_1_1_c_n_c_pipe_1_1_state.html Gets the monitor size of the CNC application. ```APIDOC ## GetMonitorSize ### Description Gets the monitor size of the CNC application. ### Method ReturnCode GetMonitorSize(out int width, out int height) ### Parameters - **width** (int) - Output parameter for the monitor width. - **height** (int) - Output parameter for the monitor height. ### Return Value ReturnCode indicating success or failure. ``` -------------------------------- ### GetScreenSize Source: https://centroidcnc.com/CentroidAPI/class_centroid_a_p_i_1_1_c_n_c_pipe_1_1_v_b___state.html Gets the screen size of the CNC application. ```APIDOC ## GetScreenSize ### Description Gets the screen size of the CNC application. ### Method ReturnCode GetScreenSize(out int width, out int height) ### Parameters #### Output Parameters - **width** (int) - The width of the screen. - **height** (int) - The height of the screen. ### Return Value ReturnCode indicating success or failure. ``` -------------------------------- ### VB_Wcs Constructor Source: https://centroidcnc.com/CentroidAPI/class_centroid_a_p_i_1_1_c_n_c_pipe_1_1_v_b___wcs.html Initializes a new instance of the VB_Wcs class. ```APIDOC ## VB_Wcs() ### Description Constructor for the VB_Wcs class. ### Parameters - **parent** (CNCPipe) - Required - A reference to an already created CNCPipe object. ``` -------------------------------- ### GetScreenSize Source: https://centroidcnc.com/CentroidAPI/class_centroid_a_p_i_1_1_c_n_c_pipe_1_1_state.html Gets the screen size of the CNC application. ```APIDOC ## GetScreenSize ### Description Gets the screen size of the CNC application. ### Method ReturnCode GetScreenSize(out int width, out int height) ### Parameters - **width** (int) - Output parameter for the screen width. - **height** (int) - Output parameter for the screen height. ### Return Value ReturnCode indicating success or failure. ``` -------------------------------- ### InboundComm Constructor Source: https://centroidcnc.com/CentroidAPI/class_centroid_a_p_i_1_1_c_n_c_pipe_1_1_inbound_comm.html Initializes a new instance of the InboundComm class. ```APIDOC ## InboundComm() CentroidAPI.CNCPipe.InboundComm.InboundComm ### Description Constructor. ### Parameters - **parent** (CNCPipe) - Required - Is a reference to an already constructed System object. ``` -------------------------------- ### System Class Source: https://centroidcnc.com/CentroidAPI/class_centroid_a_p_i_1_1_c_n_c_pipe.html Provides access to functionalities for retrieving system-related information. ```APIDOC ## Sys **system** Class for getting system related info. ``` -------------------------------- ### GetScrewPitch Source: https://centroidcnc.com/CentroidAPI/class_centroid_a_p_i_1_1_c_n_c_pipe_1_1_axis-members.html Gets the screw pitch for a specified axis. ```APIDOC ## GetScrewPitch ### Description Gets the screw pitch for a specified axis. ### Method GET ### Endpoint /api/axis/screw_pitch ### Parameters #### Query Parameters * **axis** (Axes) - Required - The axis to get the screw pitch for. * **screw_pitch** (out double) - Required - Output parameter for the screw pitch. ``` -------------------------------- ### VB_InboundComm Constructor Source: https://centroidcnc.com/CentroidAPI/class_centroid_a_p_i_1_1_c_n_c_pipe_1_1_v_b___inbound_comm.html Initializes a new instance of the VB_InboundComm class. ```APIDOC ## VB_InboundComm() ### Description Constructor for the VB_InboundComm class. ### Parameters - **parent** (CNCPipe) - Required - A reference to an already created System object. ``` -------------------------------- ### GetScalesVelocity Source: https://centroidcnc.com/CentroidAPI/class_centroid_a_p_i_1_1_c_n_c_pipe_1_1_axis-members.html Gets the scaling velocity for a specified axis. ```APIDOC ## GetScalesVelocity ### Description Gets the scaling velocity for a specified axis. ### Method GET ### Endpoint /api/axis/scales_velocity ### Parameters #### Query Parameters * **axis** (Axes) - Required - The axis to get the scaling velocity for. * **scaling_velocity** (out double) - Required - Output parameter for the scaling velocity. ``` -------------------------------- ### GetScalesDeadband Source: https://centroidcnc.com/CentroidAPI/class_centroid_a_p_i_1_1_c_n_c_pipe_1_1_axis-members.html Gets the scaling deadband for a specified axis. ```APIDOC ## GetScalesDeadband ### Description Gets the scaling deadband for a specified axis. ### Method GET ### Endpoint /api/axis/scales_deadband ### Parameters #### Query Parameters * **axis** (Axes) - Required - The axis to get the scaling deadband for. * **scaling_deadband** (out int) - Required - Output parameter for the scaling deadband. ``` -------------------------------- ### Save Source: https://centroidcnc.com/CentroidAPI/class_centroid_a_p_i_1_1_c_n_c_pipe_1_1_tool-members.html Saves the current tool configuration. ```APIDOC ## Save ### Description Saves the current tool configuration. ### Method `Save()` ### Response #### Success Response Indicates that the tool configuration has been saved. ``` -------------------------------- ### VB_Job Constructor Source: https://centroidcnc.com/CentroidAPI/class_centroid_a_p_i_1_1_c_n_c_pipe_1_1_v_b___job.html Initializes a new instance of the VB_Job class. ```APIDOC ## VB_Job() ### Description Constructor for the VB_Job class. ### Parameters - **parent** (CNCPipe) - Required - A reference to an already created System object. ``` -------------------------------- ### GetScalesCounts Source: https://centroidcnc.com/CentroidAPI/class_centroid_a_p_i_1_1_c_n_c_pipe_1_1_axis-members.html Gets the scaling counts for a specified axis. ```APIDOC ## GetScalesCounts ### Description Gets the scaling counts for a specified axis. ### Method GET ### Endpoint /api/axis/scales_counts ### Parameters #### Query Parameters * **axis** (Axes) - Required - The axis to get the scaling counts for. * **scaling_counts** (out double) - Required - Output parameter for the scaling counts. ``` -------------------------------- ### GetLimit Source: https://centroidcnc.com/CentroidAPI/class_centroid_a_p_i_1_1_c_n_c_pipe_1_1_axis-members.html Gets the limit for a specified axis and direction. ```APIDOC ## GetLimit ### Description Gets the limit for a specified axis and direction. ### Method GET ### Endpoint /api/axis/limit ### Parameters #### Query Parameters * **axis** (Axes) - Required - The axis to get the limit for. * **direction** (Direction) - Required - The direction for the limit. * **axis_limit** (out double) - Required - Output parameter for the axis limit. ``` -------------------------------- ### VB_Job Constructor Source: https://centroidcnc.com/CentroidAPI/class_centroid_a_p_i_1_1_c_n_c_pipe_1_1_v_b___job-members.html Initializes a new instance of the VB_Job class. ```APIDOC ## VB_Job(CNCPipe parent) ### Description Initializes a new instance of the VB_Job class. ### Method CentroidAPI.CNCPipe.VB_Job ### Endpoint N/A (Constructor) ### Parameters - **parent** (CNCPipe) - The parent CNCPipe object. ### Request Example N/A ### Response N/A ### Response Example N/A ``` -------------------------------- ### Set Deadstart Velocity for an Axis Source: https://centroidcnc.com/CentroidAPI/class_centroid_a_p_i_1_1_c_n_c_pipe_1_1_axis.html Configure the deadstart velocity for a specific axis. Use this to set the minimum velocity required for an axis to begin moving. ```csharp returnCode = cnc_pipe.axis.SetDeadstartVelocity(CNCPipe.Axes.AXIS_1, .2); ``` -------------------------------- ### VB_Csr Constructor Source: https://centroidcnc.com/CentroidAPI/class_centroid_a_p_i_1_1_c_n_c_pipe_1_1_v_b___csr.html Initializes a new instance of the VB_Csr class. ```APIDOC ## VB_Csr() ### Description Constructor for the VB_Csr class. ### Parameters #### Path Parameters - **parent** (CNCPipe) - Required - A reference to an already created System object. ``` -------------------------------- ### Initialize CNC12 Controls in MainWindow Source: https://centroidcnc.com/CentroidAPI/cnc12mainscreen.html Add this code to your MainWindow.xaml.cs to initialize and connect the CentroidAPI user controls to the CNCPipe. Ensure CNC12 is running for these controls to function correctly. ```csharp using System.Windows; using CentroidAPI; namespace CNC12MainWindowExample { public partial class MainWindow : Window { CNCPipe cnc12_pipe; public MainWindow() { InitializeComponent(); cnc12_pipe = new CNCPipe(); Dro.Pipe = cnc12_pipe; StatusWindow.Pipe = cnc12_pipe; MessageWindow.Pipe = cnc12_pipe; DroDistanceToGo.Pipe = cnc12_pipe; ActiveGCodes.Pipe = cnc12_pipe; GCodeDisplay.Pipe = cnc12_pipe; } } } ``` -------------------------------- ### GetDeadstartVelocity Source: https://centroidcnc.com/CentroidAPI/class_centroid_a_p_i_1_1_c_n_c_pipe_1_1_axis-members.html Gets the deadstart velocity for a specified axis. ```APIDOC ## GetDeadstartVelocity ### Description Gets the deadstart velocity for a specified axis. ### Method GET ### Endpoint /api/axis/deadstart_velocity ### Parameters #### Query Parameters * **axis** (Axes) - Required - The axis to get the deadstart velocity for. * **deadstart_velocity** (out double) - Required - Output parameter for the deadstart velocity. ``` -------------------------------- ### CMessageWindow Source: https://centroidcnc.com/CentroidAPI/annotated.html Class for getting status window information. ```APIDOC ## CMessageWindow ### Description Class for getting status window information. ### Methods (Methods not explicitly detailed in the source) ``` -------------------------------- ### GetAccelTime Source: https://centroidcnc.com/CentroidAPI/class_centroid_a_p_i_1_1_c_n_c_pipe_1_1_axis-members.html Gets the acceleration time for a specified axis. ```APIDOC ## GetAccelTime ### Description Gets the acceleration time for a specified axis. ### Method GET ### Endpoint /api/axis/accel_time ### Parameters #### Query Parameters * **axis** (Axes) - Required - The axis to get the acceleration time for. * **accel_time** (out double) - Required - Output parameter for the acceleration time. ``` -------------------------------- ### GetToolDescription() - Overload 1 Source: https://centroidcnc.com/CentroidAPI/class_centroid_a_p_i_1_1_c_n_c_pipe_1_1_tool.html Retrieves the description for a specified tool number. It returns a ReturnCode indicating success or failure. ```APIDOC ## GetToolDescription() [1/2] ReturnCode CentroidAPI.CNCPipe.Tool.GetToolDescription(int i, out string description) ### Description Get the description for the specified tool. ### Parameters - **i** (int) - Required - The specified tool number. - **description** (out string) - Required - The tool description of the specified tool. ### Returns - SUCCESS or an error code. ### Since v5.24 ``` -------------------------------- ### CDro Source: https://centroidcnc.com/CentroidAPI/annotated.html Class to get DRO information from CNC12. ```APIDOC ## CDro ### Description Class to get DRO information from CNC12. ### Methods (Methods not explicitly detailed in the source) ``` -------------------------------- ### MessageReceivedEventArgs Constructor Source: https://centroidcnc.com/CentroidAPI/class_centroid_a_p_i_1_1_message_received_event_args-members.html Initializes a new instance of the MessageReceivedEventArgs class. ```APIDOC ## MessageReceivedEventArgs(CNCPipe.InboundComm.CommPacket data) ### Description Initializes a new instance of the MessageReceivedEventArgs class with the specified communication packet. ### Method Constructor ### Parameters #### Path Parameters - **data** (CNCPipe.InboundComm.CommPacket) - Required - The communication packet received. ``` -------------------------------- ### CAxis Source: https://centroidcnc.com/CentroidAPI/annotated.html Class for setting and getting axis info. ```APIDOC ## CAxis ### Description Class for setting and getting axis info. ### Methods (Methods not explicitly detailed in the source) ``` -------------------------------- ### GetJobRepeatState Source: https://centroidcnc.com/CentroidAPI/class_centroid_a_p_i_1_1_c_n_c_pipe_1_1_job-members.html Gets the current repeat state of the job. ```APIDOC ## GetJobRepeatState ### Description Gets the current repeat state of the job. ### Method (Implicitly a method call on a Job object) ### Parameters * **repeat_state** (out bool) - Output parameter to store the repeat state (true if repeating, false otherwise). ### Response (No specific response details provided in source) ``` -------------------------------- ### VB_Parameter Constructor Source: https://centroidcnc.com/CentroidAPI/class_centroid_a_p_i_1_1_c_n_c_pipe_1_1_v_b___parameter.html Initializes a new instance of the VB_Parameter class. ```APIDOC ## VB_Parameter() ### Description Constructor for the VB_Parameter class. ### Parameters - **parent** (CNCPipe) - Required - A reference to an already created System object. ``` -------------------------------- ### Get Tool Number Source: https://centroidcnc.com/CentroidAPI/class_centroid_a_p_i_1_1_c_n_c_pipe_1_1_tool.html Retrieves the current tool number. ```APIDOC ## GetToolNumber ### Description Gets the current tool number. ### Method `GetToolNumber(out int tool_number)` ### Returns - `ReturnCode`: Indicates the success or failure of the operation. - `tool_number` (out int): The current tool number. ``` -------------------------------- ### CNCPipe Constructor Source: https://centroidcnc.com/CentroidAPI/class_centroid_a_p_i_1_1_c_n_c_pipe.html Initializes a new instance of the CNCPipe class, establishing a communication pipe with the CNC12 machine. Allows specifying a connection timeout and whether to use the VCP pipe. ```APIDOC ## CNCPipe() CentroidAPI.CNCPipe.CNCPipe(int _timeout_ = 1) Class constructor. If successful, it will open a pipe for communicating with CNC12. Parameters: - timeout (int): The number of seconds to wait for a connection with CNC12. ## CNCPipe() CentroidAPI.CNCPipe.CNCPipe(bool _useVcpPipe_ = false, int _timeout_ = 1) Class constructor. If successful, it will open a pipe for communicating with CNC12. Parameters: - timeout (int): The number of seconds to wait for a connection with CNC12. - useVcpPipe (bool): Set to true to use the named pipe dedicated for VCP. ``` -------------------------------- ### GetCurrentMachinePosition Source: https://centroidcnc.com/CentroidAPI/class_centroid_a_p_i_1_1_c_n_c_pipe_1_1_state.html Gets the current machine position for each labeled axis. ```APIDOC ## GetCurrentMachinePosition() ### Description Gets the current machine position. ### Parameters - **machine_pos** (double[]) - Output - An array containing current positions for each labeled axis. ### Returns SUCCESS or an error code. ### Since v5.24 ``` -------------------------------- ### SetUsbInputInversions Source: https://centroidcnc.com/CentroidAPI/class_centroid_a_p_i_1_1_c_n_c_pipe_1_1_v_b___state.html Set the current USB-BOB input inversion bits. ```APIDOC ## SetUsbInputInversions ### Description Set the current USB-BOB input inversion bits. ### Method ReturnCode SetUsbInputInversions(char[] inputInversions) ### Parameters #### Input Parameters - **inputInversions** (char[]) - An array of characters representing the new input inversion bits. ### Return Value ReturnCode indicating success or failure. ``` -------------------------------- ### SetUsbInputInversions Source: https://centroidcnc.com/CentroidAPI/class_centroid_a_p_i_1_1_c_n_c_pipe_1_1_state.html Set the current USB-BOB input inversion bits. ```APIDOC ## SetUsbInputInversions ### Description Set the current USB-BOB input inversion bits. ### Method ReturnCode SetUsbInputInversions(char[] inputInversions) ### Parameters - **inputInversions** (char[]) - An array of characters representing the input inversion bits to set. ### Return Value ReturnCode indicating success or failure. ``` -------------------------------- ### Load (path) Source: https://centroidcnc.com/CentroidAPI/class_centroid_a_p_i_1_1_c_n_c_pipe_1_1_job.html Loads an existing job into CNC12 using only the job path. ```APIDOC ## ◆ Load() [1/2] ReturnCode CentroidAPI.CNCPipe.Job.Load | ( | string | _path_| ) | Load an existing job into CNC12. Parameters path| The path to the currently existing job. Returns SUCCESS or an error code Since v5.40 ```