# Welcome to LiteX-CNC!
This project aims to make a generic CNC firmware and driver for FPGA cards which are supported by LiteX. Configuration of the board and driver is done using json-files. The supported boards are the Colorlight boards 5A-75B and 5A-75E, as these are fully supported with the open source toolchain.
> **Supported Python version** <br>
> LitexCNC is not (yet) supported on Python 3.13. This is due to an issue in a dependency. As soon as this dependency
has been fixed, the Python requirement will be eased.
> **RV901T** <br>
> Although the RV901T is also supported by Litex, the firmware cannot be automatically build with LitexCNC, as it requires the Xilinx-software to compile the Verilog to a bit-stream. LitexCNC can be used to create the Verilog and the driver will work when the bit-stream is loaded on the board. However, there is a gap in the toolchain not covered. There are known issues with the compantibility of Litex with Xilinx.
The idea of this project was conceived by ColorCNC by *romanetz* on the official LinuxCNC and the difficulty to obtain a MESA card.
## Acknowledgements
This project would not be possible without:
- ColorCNC by *romanetz* [link](https://forum.linuxcnc.org/27-driver-boards/44422-colorcnc?start=0);
- HostMot2 (MESA card driver) as the structure of the driver has been adopted.
## Quick start
LitexCNC can be installed using pip:
```shell
pip install litexcnc
```
> **NOTE: Suffix `[cli]` deprecated!** <br>
> In previous versions the suffix `[cli]` was required. This requirement has been removed since version 1.2
> and deprecated since version 1.3. The suffix will be removed in version 1.4.
After installation of LitexCNC the following scripts are available to the user:
```shell
litexcnc install_driver
litexcnc install_litex
litexcnc install_toolchain
litexcnc build_driver
```
For a full overview on how to use the commands, please refer to the [documentation](https://litex-cnc.readthedocs.io/en/stable/).
Raw data
{
"_id": null,
"home_page": null,
"name": "litexcnc",
"maintainer": null,
"docs_url": null,
"requires_python": "<3.13,>=3.7",
"maintainer_email": null,
"keywords": "FPGA, CNC, CNC-controller, CNC-machine, linuxcnc, linuxcnc-FPGA, litex",
"author": "Peter van Tol",
"author_email": "petertgvantol@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/0e/7a/ebe69c9bb43027d55ea89bc121a8f81d1588f6febf7b51c5c6b1d10586ae/litexcnc-1.3.4.tar.gz",
"platform": null,
"description": "# Welcome to LiteX-CNC!\n\nThis project aims to make a generic CNC firmware and driver for FPGA cards which are supported by LiteX. Configuration of the board and driver is done using json-files. The supported boards are the Colorlight boards 5A-75B and 5A-75E, as these are fully supported with the open source toolchain.\n\n> **Supported Python version** <br>\n> LitexCNC is not (yet) supported on Python 3.13. This is due to an issue in a dependency. As soon as this dependency\nhas been fixed, the Python requirement will be eased.\n\n> **RV901T** <br>\n> Although the RV901T is also supported by Litex, the firmware cannot be automatically build with LitexCNC, as it requires the Xilinx-software to compile the Verilog to a bit-stream. LitexCNC can be used to create the Verilog and the driver will work when the bit-stream is loaded on the board. However, there is a gap in the toolchain not covered. There are known issues with the compantibility of Litex with Xilinx.\n\nThe idea of this project was conceived by ColorCNC by *romanetz* on the official LinuxCNC and the difficulty to obtain a MESA card.\n\n## Acknowledgements\nThis project would not be possible without:\n- ColorCNC by *romanetz* [link](https://forum.linuxcnc.org/27-driver-boards/44422-colorcnc?start=0);\n- HostMot2 (MESA card driver) as the structure of the driver has been adopted.\n\n## Quick start\nLitexCNC can be installed using pip:\n```shell\npip install litexcnc\n```\n\n> **NOTE: Suffix `[cli]` deprecated!** <br>\n> In previous versions the suffix `[cli]` was required. This requirement has been removed since version 1.2\n> and deprecated since version 1.3. The suffix will be removed in version 1.4.\n\nAfter installation of LitexCNC the following scripts are available to the user:\n```shell\nlitexcnc install_driver\nlitexcnc install_litex\nlitexcnc install_toolchain\nlitexcnc build_driver\n```\n\nFor a full overview on how to use the commands, please refer to the [documentation](https://litex-cnc.readthedocs.io/en/stable/).\n\n",
"bugtrack_url": null,
"license": "GPL-3.0-or-later",
"summary": "Generic CNC firmware and driver for FPGA cards which are supported by LiteX",
"version": "1.3.4",
"project_urls": null,
"split_keywords": [
"fpga",
" cnc",
" cnc-controller",
" cnc-machine",
" linuxcnc",
" linuxcnc-fpga",
" litex"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "4241a766bd915e8c0bb16ce9bd6f4a2ab2cad0f52773e2c7dc0a50ca8ea6f76b",
"md5": "43a7d47b1ad2266409edc1c6d018600d",
"sha256": "f85e303e994b32f46034f244cafc5a3d611dd4c6d42222d44a70c4e2a0cb0266"
},
"downloads": -1,
"filename": "litexcnc-1.3.4-py3-none-any.whl",
"has_sig": false,
"md5_digest": "43a7d47b1ad2266409edc1c6d018600d",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<3.13,>=3.7",
"size": 153916,
"upload_time": "2025-02-06T14:10:24",
"upload_time_iso_8601": "2025-02-06T14:10:24.468932Z",
"url": "https://files.pythonhosted.org/packages/42/41/a766bd915e8c0bb16ce9bd6f4a2ab2cad0f52773e2c7dc0a50ca8ea6f76b/litexcnc-1.3.4-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "0e7aebe69c9bb43027d55ea89bc121a8f81d1588f6febf7b51c5c6b1d10586ae",
"md5": "c80cfdb4fb088915324d24f45b23bf54",
"sha256": "7b10497e68f1d252b40e5611182a3a5c3636ec162ad1ed266209030f2b8491d9"
},
"downloads": -1,
"filename": "litexcnc-1.3.4.tar.gz",
"has_sig": false,
"md5_digest": "c80cfdb4fb088915324d24f45b23bf54",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<3.13,>=3.7",
"size": 101202,
"upload_time": "2025-02-06T14:10:26",
"upload_time_iso_8601": "2025-02-06T14:10:26.583188Z",
"url": "https://files.pythonhosted.org/packages/0e/7a/ebe69c9bb43027d55ea89bc121a8f81d1588f6febf7b51c5c6b1d10586ae/litexcnc-1.3.4.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-02-06 14:10:26",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "litexcnc"
}
JSON