Server API

This article serves as the main reference point for all myCNC material related to the myCNC Server API.

The server API allows to control movement and machine coordinates remotely, via a series of commands.

To enable Server API functionality, first head into your Settings > Config > Network, and enable the Server Interface option, as well as set a Server Port (the server port will be used to connect to your system via the telnet command, for example telnet 127.0.0.1 4266):

A list of Server API 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:

Command “SetJog” is used for Jog control through Sever API. Command syntax is “SetJog Parameter”. Parameters listed in table below:

Server API has a command to simplify Pendant control emulation. This command can be used for writing third-party Pendant control device drivers.

Command: SetPendant Format: SetPendant Parameter1;Parameter2

• Parameter1 - Emulated Hand wheel position. It's supposed the handwheel has resolution of “100”, such that the position range can be (0…99)
• Parameter2 - 16-bit value, high byte is Step selector, low byte is Axis selector.
• Step selector values can be set through the following format:
  • 0 → “x0.001” (1 wheel step = 0.001 unit)
  • 1 → “x0.01” (1 wheel step = 0.01 unit)
  • 2 → “x0.1” (1 wheel step = 0.1 unit)
  • 3 → “x1” (1 wheel step = 1 unit)
• Axis selector values:
  • 0 → “OFF”
  • 1 → “X”
  • 2 → “Y”
  • 3 → “Z”
  • 4 → “A”
  • 5 → “B”
  • 6 → “C”

There are 3 ways to manipulate myCNC control board Hardware outputs through Server API:

1) Direct manipulation through commands “SetHWBinaryOutput”, “SetHWDAC”, “SetHWPWM” 2) Manipulation through running PLC procedure with Hardware Outputs manipulation. 3) Manipulation though running short G/M-codes program

Command: SetHWBinaryOutput

Syntax: SetHWBinaryOutput <Port number> <Port value>

Port Number is number binary port. Its range is 0 to 159. Set Port value to “1” to turn ON binary output (relay, open collector), “0” to turn OFF the binary output.

Command: SetHWPWM

Syntax: SetHWPWM <PWM channel> <PWM value>

PWM channel is the number of the PWM pin. Software range is 0 to 3, however the number of PWM channels depends on the myCNC Ethernet controller model. Controllers ET1, ET3, ET5 each contain 3 PWM pins.

Command: SetHWDAC

Syntax: SetHWDAC <DAC channel> <DAC value>

DAC channel is number of the DAC pin. Software range is 0 to 1, however real number of DAC channels depends on myCNC Ethernet controller model. Controllers ET1 and ET3 each contain 1 DAC pins, while the ET5 controller contains 6 DAC pins.

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:

PLC procedure: M62 Syntax: M62 <Parameter> M62 allows the user to turn ON a binary output pin with a given number (Parameter=Port number)

PLC Procedure: M63 Syntax: M63 <Parameter>

M63 allows the user to turn OFF a binary output pin with a given number (Parameter=Port number)

Syntax: DAC <Parameter>

The low 12 bits (11…0) contain the value of DAC to be written, high bits (14..12) contain the DAC channel.

Syntax: PWM <Parameter>

The low 12 bits (11…0) contain the value of PWM to be written, high bits (14..12) contain the PWM channel number.

Examples of running these PLC procedures through the Server API are shown table below:

Server API command “SinglePlay” will run a G-code line (or a number of G-code lines separated by the “;” symbol). It's possible to control binary outputs by running M-functions “M62” and “M63” (similar to the method described above). P-parameter sets the binary output number to control.

M-code: M62 Syntax: M62 P<number>

This will turn ON the binary output pin with the given number.

Syntax: M63 P<number>

This will turn OFF the binary output pin with the given number.

Any custom PLC function can be written and assigned to M-code, then loaded through the CNC Server API.

The following videos show examples of using the server API to control a myCNC system (older versions of the software are used, however the principle is the same):

ProgramFileOpen and SetScale:

Hardware Binary Outputs:

Set Scale and Rotation Angle: