cnc-centroid-skinning 1.5.42

wrapper for the CncSkinning API (C#) 64 bits

Unofficial cnc_centroid_skinning - A wrapper for the CNC12 API.

Introduction

I use products developed by Centroid CNC for my CNC activities: https://www.centroidcnc.com/

Centroid CNC has developed a controller card named ACORN: https://www.centroidcnc.com/centroid_diy/acorn_cnc_controller.html

and the ACORN Mill and Lathe CNC12 software for use with the Centroid Acorn CNC controller: https://www.centroidcnc.com/centroid_diy/centroid_cnc_software_downloads.html

The goal: A Wrapper for Python

In chapter 1.11 of the CNC12 documentation: "CNC12 gives the user the ability to create a custom interface that can be applied in many different ways."

This wrapper allows you to use this API in Python, with (almost) the same interface as C#. ( https://centroidcncforum.com/viewtopic.php?f=60&t=3397 )

Release for CNC12 V5.42

This wrapper targets the current CentroidAPI surface published with CNC12 V5.42. The V5.42 update keeps the 64-bit CentroidAPI.dll model introduced in CNC12 V5.x and includes newer API areas such as inbound communication and WCS reference/location helpers.

Enums are kept as a generated Python snapshot so the package remains importable without CNC12 or pythonnet at import time. To refresh the snapshot from an installed CNC12 release, run:

python tools\generate_cncenums.py C:\cncr

Release for ACORN 5.30

The interface has evolved with 64-bit communication, which requires Python to use the same architecture to communicate with CentroidAPI.dll. .NET has evolved as well, with greater security at the .NET and pythonnet level.

Several interfaces have been added to CentroidAPI, and the code does not include all the changes, but it is very simple to add them.

I couldn't test everything, but the main features seem to work. The goal is to make it easy for everyone to use Python to send and receive data from the CNC12 program.

I hope this wrapper allows enthusiasts like me to simply develop their applications with CNC12. Python is easy to use and allows rapid prototyping.

To develop

This method cannot be called because the MpuToPcSysVarBit and PcToMpuSysVarBit enums are not published in CentroidAPI.dll:

• getPcSystemVariableBit

Warning

Be careful when you send commands or update settings. Keep in mind that you can move (or even destroy) your material (which isn't the worst case...). There is no protection like in the 'acorn wizard' and you can send many bad values. Verify each time that the wrapper method is correct and responds as described in the documentation.
This interface is not really tested, don't trust it.

Example use case: video probing

With this wrapper, I have developed a 'video probing' system for internal use. A camera is placed on the CNC head and detects the center of a hole (thanks to the opencv library https://pypi.org/project/opencv-python/). This center is used as an origin, and the coordinates are sent directly to the CNC12 software. The head moves immediately (thanks to job.runCommand()). The second step is to move the head exactly above the center of this hole.

Writing this kind of application is quite simple in Python with the help of libraries and the CentroidAPI.

The image recognition library I used with the camera for assertions is not included in this library.

Please read the 'CNC Machine Tool Safety' chapter in the Centroid CNC documentation.

Installation

If you have pip, installation is straightforward:

python -m pip install cnc_centroid_skinning

This will automatically install the required dependencies. Python 3.10 to 3.13 is supported; Python 3.14 or later is not supported.

To install the current V5.42 branch directly from GitHub:

python -m pip install git+https://github.com/fca1/cnc_centroid_skinning.git@V542

For local development from this repository:

python -m pip install -e .
python tools\generate_cncenums.py C:\cncr

The documentation

The /CncSkinningDocumentation provided by Centroid CNC has the same packages and references. There are some differences, however:

• The methods begin with a lowercase letter.
• The return code is not provided, but an ErrorCodeException is raised for any value other than 'SUCCESS'.

documentation

Examples

Verify communication between this wrapper and CNC12. CNC12 must already be running; otherwise, no communication is possible.

The function detect_cnc(path_of_cnc12) is written for that purpose.

>>> from cnc_centroid_skinning import detect_cnc
>>> detect_cnc(r"C:\cncr")
'cnc_centroid_skinning communicates... OK' 
>>>

Ask for configuration

>>> from cnc_centroid_skinning import CentroidApi
>>> sk = CentroidApi(r"C:\cncr")                    # create the instance
>>> sk.isConstructed()                  
True
>>> sk.state.getAcornBoardRevision()
4
>>> sk.system.getSystemIdentifier()
115202849
>>> from cnc_centroid_skinning import Axes, Direction
>>> sk.axis.getLabel(Axes.AXIS_1)
'Z'
>>> sk.axis.getTravelLimit(Axes.AXIS_1, Direction.PLUS)
300

Send a string message to the message window:

>>> sk.message_window.addMessage('move in 5 seconds...')
>>> sk.message_window.getMessages()[-1]
'move in 5 seconds...'

or

>>> sk.message_window.message = 'move in 5 seconds...'
>>> sk.message_window.message
'move in 5 seconds...'

Run command (more than one way is possible) with a message window provided

Verify the machine is clear to move the following distance: Z0 -> +Z50

Be careful with this command. If a command is already running, the next command is ignored until the job is finished. You can see below a method to detect that the job is finished by polling the last message '306 job finished', but it is not a very good way.

>>> sk.job.runCommand("G4 P5.0\nG53 G0 Z0\nZ50", require_cycle_start=False)
>>> while not sk.message_window.message.startswith('306'): time.sleep(0.3) # job finished
>>> sk.job.runCommand("G53 G0 Z0", require_cycle_start=False)

or

>>> sk.job.gcode = "G4 P5.0", "G53 G0 Z0", "Z50" 
>>> while not sk.message_window.message.startswith('306'): time.sleep(0.3) # job finished
>>>

Use the French language for menus, prompts, etc.

(see 12.3.11 Parameter 9 – Display Language)

>>> sk.param.getMachineParameterValue(9)   # 0 = english
0
>>> sk.param.setMachineParameter(9, 2)
>>> sk.system.exitSoftware() # Restart is mandatory 

or

>>> sk.parameter[9] 
0
>>> sk.parameter[9] = 2  
>>> sk.system.exitSoftware() # Restart is mandatory

TODO list

• VCP is not tested
• Improve unit test behavior
• Docstrings are still preliminary; parameter values are not fully described.
• ...