CentroidAPI FAQ

[Centroid_Jacob]

Hey Centroid Forums,

Here is the current CentroidAPI FAQ, feel free to ask questions and we'll either update the FAQ here or add it to the API Documentation depending on the scope of the question.

• Q: What is the Centroid CNC API?
• A: The Centroid API (Application Programming Interface) is an easy way to build your own Custom CNC Applications and solutions powered by any of Centroid’s CNC Control Boards (Allin1DC, Oak, Hickory, Acorn, and AcornSix).

• Q: What can I do with it?
• A: Use the Centroid API to create your own custom CNC applications that can run along with CNC12 or completely replace the CNC12 UI.
  Your Apps can command motion, control motors, pumps, activate accessories, interface with a robot, read sensors, read inputs, control outputs, run macros, run g codes, display all kinds of machine tool information such as but not limited to: spindle speed, feedrate, WCS and Machine positions. Run probing cycles, set part zeros, interface with 3rd party software. The applications and functions are nearly limitless.

• Q: How much does the Centroid API cost?
• A: The Centroid APi is free and open, there is no charge to use the Centroid APi tools to create your own CNC application. A CNC12 “Pro” License is the recommended minimum software license to use the Centroid API effectively.

• Q: What programming languages can I use to create a Centroid CNC App using the Centroid API?
• A: At this time only Visual Basic.net and C# languages are officially supported however, Console, WinForms, and WPF projects are supported with those languages.

• Q: What programming tools does Centroid use and recommend when creating Apps?
• A: Visual Studio Community Edition (Free) or Visual Studio Pro/Enterprise (Paid), see more here: https://visualstudio.microsoft.com/vs/compare/

• Q: Is there a place I can get help?
• A: Yes, Centroid has created a Centroid API Technical Support Forum where we will answer questions and take suggestions.

• Q: Can I download the Centroid example Apps to edit myself?
• A: Yes, on the CentroidCNC GitHub Repos:
  1. VB: https://github.com/CentroidCNC/Centroid ... _PowerFeed
  2. C#: https://github.com/CentroidCNC/Centroid ... _PowerFeed

• Q: Where is the Centroid CNC12 API documentation?
• A: New CentroidAPI Documentation will be coming soon on the website.
  Current CentroidAPI Documentation is available in your CNC12 Install Directory:
  • Mill: C:\cncm\CentroidAPIDocumentation
  • Lathe: C:\cnct\CentroidAPIDocumentation
  • Router: C:\cncm\CentroidAPIDocumentation
  • Plasma: C:\cncm\CentroidAPIDocumentation
  • MillDemo: C:\Centroid_Mill_Intercon_Offline\CentroidAPIDocumentation
  • LatheDemo: C:\Centroid_Lathe_Intercon_Offline\CentroidAPIDocumentation

• Q: What are the requirements for using the Centroid API?
• A:
  1. Centroid CNC12 Installed (Offline or Standard, but Offline is limited, ie. no jogging or skin_event calls possible)
     - https://centroidcnc.com/centroid_diy/ce ... loads.html)
  2. Visual Studio Installed
     - https://visualstudio.microsoft.com/vs/compare/
  3. A 64-bit Development PC running Windows 10 or 11
     - https://centroidcnc.com/cnc_pc_performa ... ments.html
     - Note: Must Exceed our Minimum Spec but will vary depending on the scale of your CentroidAPI Application
  4. (Optional but Recommended) A CentroidCNC Control Board
     - https://shopcentroidcnc.com/
     - The Offline CNC12 Mill and Lathe Intercon installer can be used for basic development and testing but is not ideal for complex operations.

CentroidAPI Troubleshooting:

• Q: I get the message "Could not load file or assembly 'CentroidAPI, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null'"
• A: Check that you are building for "x64" and not "Any CPU" as the CentroidAPI is a 64bit library.

• Q: My project won't build after installing a new version of CNC12
• A: Try the following steps.
  
  1. Solution Explorer -> Dependencies -> Assemblies -> CentroidAPI (right click on this and remove it)
  2. Solution Explorer -> Dependencies (right click and choose Add Project Reference).
  3. The Reference Manager will open. Choose browse.
  4. A file dialog box will open. Browse to the Centroid working directory (C:/cncm for Mill, Plasma, Router installs, C:/cnct for Lathe installs).
  5. Choose the file "CentroidAPI.dll" and click "Add".
  6. Click OK in the Reference Manager.
  7. Build your project with Build->Build Solution