# EMCApplication

**Repository Path**: dexinfu/EMCApplication

## Basic Information

- **Project Name**: EMCApplication
- **Description**: No description available
- **Primary Language**: Python
- **License**: GPL-2.0
- **Default Branch**: machinekit/master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2022-01-14
- **Last Updated**: 2024-06-16

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

<h1 align="center">EMCApplication</h1>

<div align="center"><img alt="Machinekit demo" src="machinekit.svg" width="450px" /></div>

<h4 align="center">Machinekit <i>Featured Application</i> for <b>E</b>nhanced <b>M</b>otion <b>C</b>ontroller from LinuxCNC.</h4>

<p align="center">
<img alt="Version" src="https://img.shields.io/badge/version-2.9-blue.svg?cacheSeconds=2592000&style=for-the-badge" />

<a href="https://matrix.to/#/#machinekit:matrix.org" target="_blank">
<img alt="Matrix Machinekit Room" src="https://img.shields.io/matrix/machinekit:matrix.org?style=for-the-badge&logo=matrix" />
</a>

<a href="https://groups.google.com/forum/#!forum/machinekit" target="_blank">
<img alt="Machinekit Google Groups" src="https://img.shields.io/badge/forum-Machinekit-default?style=for-the-badge&logo=google" />
</a>

<a href="http://www.machinekit.io/community/c4/" target="_blank">
<img alt="C4 community guidelines" src="https://img.shields.io/badge/contributing-C4-default?style=for-the-badge&logo=zeromq" />
</a>

</br>

<a href="https://cloudsmith.io/~machinekit/repos/emcapplication/packages/" target="_blank">
<img alt="Machinekit Cloudsmith repository for EMCApplication packages" src="https://img.shields.io/badge/core%20packages-EMCApplication-brightgreen?style=for-the-badge&logo=cloudsmith" />
</a>

<a href="https://cloudsmith.io/~machinekit/repos/machinekit-hal/packages/" target="_blank">
<img alt="Machinekit Cloudsmith repository for Machinekit-HAL core packages" src="https://img.shields.io/badge/dependencies-Machinekit--HAL-brightgreen?style=for-the-badge&logo=cloudsmith" />
</a>

<a href="https://cloudsmith.io/~machinekit/repos/machinekit/packages/" target="_blank">
<img alt="Machinekit Cloudsmith repository for dependencies" src="https://img.shields.io/badge/dependencies-Machinekit-brightgreen?style=for-the-badge&logo=cloudsmith" />
</a>
</p>

<p align="center">
<a href="https://machinekit.io/">Website</a>
|
<a href="https://machinekit.io/docs">Docs</a>
|
<a href="http://www.machinekit.io/about">About</a>
</p>

**EMCApplication** is the _**E**nhanced **M**otion **C**ontroller_ developed as part of [LinuxCNC](https://github.com/linuxcnc/linuxcnc) ported to use the powerfull [Machinekit-HAL](https://github.com/machinekit/machinekit-hal) backend. With this package integrators can quickly create **CNC** solution to controll a **mill** or a **lathe** or **any other** application which would benefit from **G-Code** based motion controller.

<div align="center"><img alt="Machinekit demo" src="emcapplication.gif" width="650px" /></div>

## Getting started

The recommended way how to get running quickly is to install Debian package. As the **EMCApplication** contains only the CNC portion, the **Machinekit-HAL** is required dependency and can also be installed as a Debian package.

While _**R**un-**I**n-**P**lace_ is theoretically possible, the **Machinekit-HAL** stil has to be installed (respective libraries needs to be exported with _pkg-config_) and _real-time_ components of EMCApplication has to be installed into Machhinekit-HAL specified directory.

**Machinekit organization** keeps current Debian packages in specific repositories: The EMCApplication can downloaded from official [Machinekit/EMCApplication repository](https://cloudsmith.io/~machinekit/repos/emcapplication/packages/), Machinekit-HAL from [Machinekit/Machinekit-HAL repository](https://cloudsmith.io/~machinekit/repos/machinekit-hal/packages/), other dependencies then from [Machinekit/Machinekit repository](https://cloudsmith.io/~machinekit/repos/machinekit/packages/). Allpackages repositories are kindly hosted by [Cloudsmith](https://cloudsmith.io).

Presuming newly installed Debian Buster system (for example Docker container), the following sequence of commands would be needed to install **EMCApplication** as a _non-root_ user with _sudo_ rights:

```sh
curl -1sLf \
  'https://dl.cloudsmith.io/public/machinekit/machinekit/cfg/setup/bash.deb.sh' \
  | sudo -E bash
curl -1sLf \
  'https://dl.cloudsmith.io/public/machinekit/machinekit-hal/cfg/setup/bash.deb.sh' \
  | sudo -E bash
curl -1sLf \
  'https://dl.cloudsmith.io/public/machinekit/emcapplication/cfg/setup/bash.deb.sh' \
  | sudo -E bash
sudo apt install emcapplication
```

If you want to compile the _**R**un-**I**n-**P**lace_ version onto Debian Buster, the following sequence of commands would be needed (again as a _non-root_ user with _sudo_ rights):

```sh
curl -1sLf \
  'https://dl.cloudsmith.io/public/machinekit/machinekit/cfg/setup/bash.deb.sh' \
  | sudo -E bash
curl -1sLf \
  'https://dl.cloudsmith.io/public/machinekit/machinekit-hal/cfg/setup/bash.deb.sh' \
  | sudo -E bash
git clone https://github.com/machinekit/emcapplication.git
cd emcapplication
sudo apt install build-essential fakeroot devscripts python apt-cudf
sudo apt-mark hold machinekit-hal
debian/configure machinekit-hal=${WANTED_VERSION_OF_MACHINEKIT_HAL_PACKAGES} no-docs
mk-build-deps       \
    --install       \
    --remove        \
    --root-cmd sudo \
    --tool          \
    'apt-cudf-get --solver aspcud -o APT::Get::Assume-Yes=1 -o Debug::pkgProblemResolver=0 -o APT::Install-Recommends=0' \
    debian/control
cd src
./autogen.sh
./configure --with-hal=machinekit-hal
make
sudo make install
cd ..
source ./scripts/rip-environment
linuxcnc
```

|![Warning](https://img.icons8.com/ios-filled/50/000000/warning-shield.png)| Be advised that currently there is no support for Linux distributions other than Debian. |
|:---:|---|


## Frequently asked questions

|![Question](https://img.icons8.com/ios-filled/50/000000/ask-question.png)| What is the difference between **EMCApplication** and **Machinekit-CNC**? |
|:---:|---|
|![Answer](https://img.icons8.com/ios-filled/50/000000/smartphone-approve.png)| **Machinekit-CNC** is the **Machinekit organization** project for CNC application based on **Machinekit-HAL** backend.**EMCApplication** on other hand is ported **Enhanced Motion Controller** from LinuxCNC to use the **Machinekit-HAL**. All development of new functionality happens in **LinuxCNC** under supervision of **LinuxCNC community**. Development on **Machinekit** side is strictly limited to creating the compatibility layer to support the different **Machinekit projects**, mainly [**Machinekit-HAL**](https://github.com/machinekit/machinekit-hal). |

|![Question](https://img.icons8.com/ios-filled/50/000000/ask-question.png)| Is the **LinuxCNC** documentation valid for **EMCApplication**? |
|:---:|---|
|![Answer](https://img.icons8.com/ios-filled/50/000000/smartphone-approve.png)| **No.** **Well, it depends.** Documentation pertaining the **Enhanced Motion Controller** will be mostly valid. (G-Code documentation, motion planner manual, GUI tutorials.) However, anything specific to HAL layer (including simple tools like _PNCconf_ or _Stepconf_) will be inherently wrong and should not be used. |

|![Question](https://img.icons8.com/ios-filled/50/000000/ask-question.png)| What's does the term _Featured Application_ mean? |
|:---:|---|
|![Answer](https://img.icons8.com/ios-filled/50/000000/smartphone-approve.png)| **Featured Application** is _terminus technicus_ coined by **Machinekit organization** to give universal title to all projects using **Machinekit-HAL** backend and building new applications on top of it. |

|![Question](https://img.icons8.com/ios-filled/50/000000/ask-question.png)| How can I determine if **.deb** package is from official distribution? |
|:---:|---|
|![Answer](https://img.icons8.com/ios-filled/50/000000/smartphone-approve.png)| Every package should be signed by [**dpkg-sig**](https://manpages.debian.org/buster/dpkg-sig/dpkg-sig.1.en.html) tool. Packages built by [Machinekit](https://machinekit.io) from official repository [_Machinekit/EMCApplication_](https://github.com/machinekit/emcapplication) are signed by the [4A374E9D7CA79FA717293B98D2EFAE426CDDB0FE](https://keyserver.ubuntu.com/pks/lookup?search=0x4A374E9D7CA79FA717293B98D2EFAE426CDDB0FE&fingerprint=on&op=index) sub-key. Forks will use different key or will not sign the packages. |

## Getting involved

**Machinekit-HAL** like all projects in the **Machinekit** organization is volunteer based governed by the [**C**ollective **C**ode **C**onstruction **C**ontract ](http://www.machinekit.io/community/c4), generally known as a C4 originally from the [ZeroMQ](https://rfc.zeromq.org/spec/22) project.

The source code is hosted publicly on [GitHUB](https://github.com/machinekit/emcapplication), where majority of discussion happens. In lower measures, EMCApplication is also discussed on [_Machinekit forum_](https://groups.google.com/forum/#!forum/machinekit) and in [_Machinekit Matrix Room_](https://matrix.to/#/#machinekit:matrix.org), which are used more to the point of support platforms and for general chat.

Synchronization of **EMCApplication** and **LinuxCNC** is done by _merging-in_ changes from _upstream_ **LinuxCNC** repository into **EMCApplication** _downstream_ repository.

|![Counselling](https://img.icons8.com/ios-filled/50/000000/counselor.png)| Development in [**EMCAplicattion** repository](https://github.com/machinekit/emcapplication) is limited strictly to compatibility layer between **Machinekit** projects and **LinuxCNC**. If you want to develop new functionality or post patch for bug repair, please, head to the [**LinuxCNC** repository](https://github.com/linuxcnc/linuxcnc). If you want to develop CNC application in scope of **Machinekit organization**, please head to [**Machinekit-CNC** repository](https://github.com/machinekit/machinekit-cnc) |
|:---:|---|

## Licence

This software is released under the **GPLv2**, with some parts under the **LGPL**. See the file COPYING or COPYING.more for more details.

|![Warning](https://img.icons8.com/ios-filled/50/000000/warning-shield.png)| For more detailed information consult specific files with source code implementing given functionality. There should be explicit licensing. |
|:---:|---|

</br>

Original *LinuxCNC* README.md:

# LinuxCNC

LinuxCNC controls CNC machines. It can drive milling machines, lathes, 3D printers, laser cutters, plasma cutters, robot arms, hexapods, and more. https://linuxcnc.org/

# DISCLAIMER

**THE AUTHORS OF THIS SOFTWARE ACCEPT ABSOLUTELY NO LIABILITY FOR ANY
HARM OR LOSS RESULTING FROM ITS USE.**

**IT IS _EXTREMELY_ UNWISE TO RELY ON SOFTWARE ALONE FOR SAFETY.**

**Any machinery capable of harming persons must have provisions for
completely removing power from all motors, etc, before persons enter
any danger area.**

**All machinery must be designed to comply with local and national
safety codes, and the authors of this software can not, and do not,
take any responsibility for such compliance.**


This software is released under the GPLv2, with some parts under the LGPL.
See the file COPYING for more details.


# The Build Process

Refer to the file 'docs/src/code/building-linuxcnc.txt' for information
about building and running the software, or look here:

http://linuxcnc.org/docs/devel/html/code/building-linuxcnc.html