mycnc:server_api
Differences
This shows you the differences between two versions of the page.
Both sides previous revisionPrevious revisionNext revision | Previous revisionNext revisionBoth sides next revision | ||
mycnc:server_api [2019/10/22 12:18] – ivan | mycnc:server_api [2022/01/07 13:49] – 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. | 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: |
+ | |||
+ | {{: | ||
+ | |||
+ | A full list of commands is provided below: | ||
+ | |||
+ | ^ Parameter ^ Description ^ | ||
+ | | EchoMode | | | ||
+ | | ProgramFileOpen | | | ||
+ | | ProgramBegin | | ||
+ | | ProgramAppend | | ||
+ | | ProgrmaEnd | | ||
+ | | ProgramPlay | Starts running the program | | ||
+ | | ProgramPlayBack | | ||
+ | | ProgramPlayStep | | ||
+ | | ProgramPlayStepBack | | ||
+ | | ProgramPause | | ||
+ | | ProgramStop | Stops the running program | | ||
+ | | ProgramReset | Resets the program to the beginning | | ||
+ | | GetEstimateTime | | ||
+ | | GetMachinePosition | Returns all of the current machine position coordinates | | ||
+ | | GetProcess | | ||
+ | | GetWorkPosition | Returns all of the current work (program) coordinates | | ||
+ | | GetMyCNCVersion | | ||
+ | | GetFVariable | Returns the value stored in a global variable (as double) | | ||
+ | | GetIVariable | Returns the value stored in a global variable (as int) | | ||
+ | | GetReady | | ||
+ | | LineAppend | | ||
+ | | GetScanData | | ||
+ | | GetSensors | | ||
+ | | GetMCC | Get Motion Control Code - read machine status, returns a number (for example, 3) | | ||
+ | | GetMCPtr | Get Motion Control Pointers | | ||
+ | | GetHW | | ||
+ | | GetHWDAC | | ||
+ | | GetHWADC | | ||
+ | | GetHWInputBit | Returns (reads) the state of a particular input | | ||
+ | | GetHWInputs | Returns (reads) the state of an input group | | ||
+ | | GetHWOutputs | | ||
+ | | GetHWPWM | | ||
+ | | GetPWMs | | ||
+ | | GetPausedLine | | ||
+ | | GetLastMessage | | ||
+ | | GetWorkState | | ||
+ | | PendantWidgetShow | | ||
+ | | PendantWidgetHide | | ||
+ | | PendantWidgetHidden | | ||
+ | | RunPLC | | ||
+ | | SaveConfig | | ||
+ | | SetG92 | Sets the current work position to the selected value (for example, '' | ||
+ | | SetHWDAC | | ||
+ | | SetHWOutputBit | | ||
+ | | SetHWPWM | | ||
+ | | SetPendant | | ||
+ | | SetRotationAngle | | ||
+ | | SetCNCVariable | | ||
+ | | SetJog | | ||
+ | | SetScale | | ||
+ | | SetGVariable | | ||
+ | | SinglePlay | | ||
+ | | ShutDown | | ||
====Server API, Jog control==== | ====Server API, Jog control==== | ||
Line 36: | Line 95: | ||
====Server API, Pendant control emulation==== | ====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== | ==SetPendant== | ||
Line 126: | Line 185: | ||
===Manipulation through PLC procedure=== | ===Manipulation through PLC procedure=== | ||
- | Server API command " | + | Server API command " |
==M62== | ==M62== |
mycnc/server_api.txt · Last modified: 2022/09/07 15:33 by ivan