Differences

This shows you the differences between two versions of the page.

--- mycnc:server_api [2019/10/22 12:18] – ivan
+++ mycnc:server_api [2022/01/07 13:08] – ivan
@@ Line 3: / Line 3: @@
 This article serves as the main reference point for all myCNC material related to the myCNC Server API. It will be expanded at a full manual.
-The server API allows to control movement and machine coordinates remotely, via a series of commands. A list of such commands is presented below for jog control, etc.
+The server API allows to control movement and machine coordinates remotely, via a series of commands. A list of such commands is presented below for jog control, etc. To obtain a full list of commands, type ? while connected to the remote host:
+{{:mycnc:server-api-001-commands-list.png}}
+A full list of commands is provided below:
+^ Parameter ^ Description ^
+| EchoMode |  |
+| ProgramFileOpen |  |
+| ProgramBegin |
+| ProgramAppend |
+| ProgrmaEnd |
+| ProgramPlay |
+| ProgramPlayBack |
+| ProgramPlayStep |
+| ProgramPlayStepBack |
+| ProgramPause |
+| ProgramStop |
+| ProgramReset |
+| GetEstimateTime |
+| GetMachinePosition |
+| GetProcess |
+| GetWorkPosition |
+| GetMyCNCVersion |
+| GetFVariable |
+| GetIVariable |
+| GetReady |
+| LineAppend |
+| GetScanData |
+| GetSensors |
+| GetMCC |
+| GetMCPtr |
+| GetHW |
+| GetHWDAC |
+| GetHWADC |
+| GetHWInputBit |
+| GetHWInputs |
+| GetHWOutputs |
+| GetHWPWM |
+| GetPWMs |
+| GetPausedLine |
+| GetLastMessage |
+| GetWorkState |
+| PendantWidgetShow |
+| PendantWidgetHide |
+| PendantWidgetHidden |
+| RunPLC |
+| SaveConfig |
+| SetG92 |
+| SetHWDAC |
+| SetHWOutputBit |
+| SetHWPWM |
+| SetPendant |
+| SetRotationAngle |
+| SetCNCVariable |
+| SetJog |
+| SetScale |
+| SetGVariable |
+| SinglePlay |
+| ShutDown |
 ====Server API, Jog control====
@@ Line 36: / Line 96: @@
 ====Server API, Pendant control emulation====
-Server API has a command to simplify Pendant control emulation. This command can be used for writing third-patry Pendant control device drivers.
+Server API has a command to simplify Pendant control emulation. This command can be used for writing third-party Pendant control device drivers.
 ==SetPendant==
@@ Line 126: / Line 186: @@
 ===Manipulation through PLC procedure===
-Server API command "RunPLC" loads and runs PLC procedure on the controller end with a given parameter. We can run a PLC procedure that manipulates Hardware outputs to get a similar result. Normally every profile configuration contains PLC procedures for Hardware outputs manipulation :
+Server API command "RunPLC" loads and runs PLC procedure on the controller end with a given parameter. We can run a PLC procedure that manipulates Hardware outputs to get a similar result. Normally, every profile configuration contains PLC procedures for Hardware outputs manipulation:
 ==M62==