{ "info": { "author": "klafyvel", "author_email": "sivigik@gmail.com", "bugtrack_url": null, "classifiers": [], "description": "=============\nSiviCNCDriver\n=============\n\n.. image:: https://readthedocs.org/projects/sivicncdriver/badge/?version=latest\n :target: http://sivicncdriver.readthedocs.io/en/latest/?badge=latest\n :alt: Documentation Status\n\nSiviCNCDriver, a software to control my CNC.\n\n:Info: This is a Python program to control a CNC.\n:Author: Hugo LEVY-FALK\n:Date: 2017-08\n:Version: 0.1.9\n\n.. index: README\n.. contents:: Table of Contents\n\n------\n\nGoal\n====\n\nSiviCNCDriver, as its name lets you guess, is designed to drive a CNC. What does it do ?\n\n- Provides a basic tool to view and edit G-Codes files. You can see which G-Code line draws which path and perform some basic edits with the preprocessor, such as finding an origin to the coordinate system which minimize the bounding box of the drawing.\n- Allows you to control manually your CNC, by :\n - Sending your own G-Codes;\n - Sending `custom G-Codes`_ so the machine performs continuous movements, or step-by-step movements;\n - Sending automatic commands so the machine performs some goings and comings and you can measure the play or the steps/mm.\n- Sends as `custom G-Codes`_ and store as JSON configuration files for your machine.\n\nScreenshots\n===========\n\n.. image:: docs/images/gcode_viewer.png\n :alt: G-Codes viewer\n\n.. image:: docs/images/configuration.png\n :alt: Machine configuration\n\n.. image:: docs/images/send_command.png\n :alt: Commands sending\n\nInstallation\n============\nUsing pip\n---------\nOn any operating system with a python and pip installated, use pip (you may need superuser privilege) ::\n\n pip install sivicncdriver\n\nThen you should be able to run the program with a simple::\n\n sivicnc\n\n\nYou can get the development version using pip, although it is not recommended. ::\n\n pip install git+git://github.com/Klafyvel/SiviCNCDriver\n\nBinary distribution (Windows)\n-----------------------------\nIf, for some reasons, you can't or don't want to use pip, a binary is available here_ .\n\n.. _here: https://github.com/Klafyvel/SiviCNCDriver/releases/latest\n\nContribute\n===========\n\nThe project has its own Git repository on GitHub_.\n\n.. _github: https://github.com/Klafyvel/SiviCNCDriver\n\nYou nill need ``virtualenv`` ::\n\n pip install --user virtualenv\n\nCreate a directory in which we will work. ::\n\n mkdir SiviCNCDriver\n cd SiviCNCDriver\n\nClone the project ::\n\n git clone https://github.com/Klafyvel/SiviCNCDriver.git\n\nThen create the virtual environment ::\n\n virtualenv ENV\n\nActivate it ::\n\n source ENV/bin/activate\n\nDownload the dependencies ::\n\n cd SiviCNCDriver\n pip install -r requirements.txt\n\nYou can code ! To test the code, run the application as package ::\n\n python -m sivicncdriver\n\nIf you need to re-create the ui after editing it with QtCreator, you can use `make_ui.sh` or directly `pyuic5`.\n\n\nCustom G-Codes\n==============\n\nSiviCNCDriver uses several custom G-Codes, they may change in the future.\n\n\n+----------------------+--------------------------------------------------------------------------------------------------------------+\n|Command | Explanation |\n+======================+==============================================================================================================+\n|``S0 Xnnn Ynnn Znnn`` | Perform a straight line with ``nnn`` in steps on the given axes. A negative number make the axis go backward.|\n+----------------------+--------------------------------------------------------------------------------------------------------------+\n|``S1 X Y Z`` | Trigger continuous advancement forward on the given axes. |\n+----------------------+--------------------------------------------------------------------------------------------------------------+\n|``S2 X Y Z`` | Trigger continuous advancement backward on the given axes. |\n+----------------------+--------------------------------------------------------------------------------------------------------------+\n|``S3 X Y Z`` | Stop continuous advancement (if exists) on the given axes. |\n+----------------------+--------------------------------------------------------------------------------------------------------------+\n|``S5 X Y Z`` | Set driving mode to normal on the given axes. |\n+----------------------+--------------------------------------------------------------------------------------------------------------+\n|``S6 X Y Z`` | Set driving mode to max torque on the given axes. |\n+----------------------+--------------------------------------------------------------------------------------------------------------+\n|``S7 X Y Z`` | Set driving mode to half steps on the given axes. |\n+----------------------+--------------------------------------------------------------------------------------------------------------+\n|``S8 Xnnn Ynnn Znnn`` | Set the play of the given axes, with ``nnn`` in millimeters. |\n+----------------------+--------------------------------------------------------------------------------------------------------------+\n|``S9 X Y Z`` | Set the given axes sense to reverse. |\n+----------------------+--------------------------------------------------------------------------------------------------------------+\n|``S10 X Y Z`` | Set the given axes sense to normal. |\n+----------------------+--------------------------------------------------------------------------------------------------------------+\n|``S11 Xnnn Ynnn Znnn``| Set the minimal duration between two pulses for the given axes. |\n+----------------------+--------------------------------------------------------------------------------------------------------------+\n\n\nLicense\n=======\n\nSiviCNCDriver\nCopyright (C) 2017 Hugo LEVY-FALK\n\nThis program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.\n\nThis program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.\n\nYou should have received a copy of the GNU General Public License along with this program. If not, see .\n", "description_content_type": null, "docs_url": null, "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "http://github.com/klafyvel/SiviCNCDriver", "keywords": "", "license": "GPL", "maintainer": "", "maintainer_email": "", "name": "SiviCNCDriver", "package_url": "https://pypi.org/project/SiviCNCDriver/", "platform": "", "project_url": "https://pypi.org/project/SiviCNCDriver/", "project_urls": { "Homepage": "http://github.com/klafyvel/SiviCNCDriver" }, "release_url": "https://pypi.org/project/SiviCNCDriver/0.1.10/", "requires_dist": null, "requires_python": "", "summary": "A software to control my CNC", "version": "0.1.10" }, "last_serial": 3393433, "releases": { "0.1": [ { "comment_text": "", "digests": { "md5": "e07124729a2c75009585264b2b06a694", "sha256": "9ae263b943f3b8bcf863935f697958ffcc44c2f174ece9da0a307f888712b88a" }, "downloads": -1, "filename": "SiviCNCDriver-0.1.tar.gz", "has_sig": false, "md5_digest": "e07124729a2c75009585264b2b06a694", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 97300, "upload_time": "2017-08-01T20:56:03", "url": "https://files.pythonhosted.org/packages/28/a3/ab8fff2563f59c3a7b0324ca90be73f7cd2c50b8e00387024df255114dd9/SiviCNCDriver-0.1.tar.gz" } ], "0.1.1": [ { "comment_text": "", "digests": { "md5": "0059fb14ac40e4e460608d5965b332c8", "sha256": "7839411a3c63556506719f8a225e046180009feabe6390125d2251bd69959851" }, "downloads": -1, "filename": "SiviCNCDriver-0.1.1.tar.gz", "has_sig": false, "md5_digest": "0059fb14ac40e4e460608d5965b332c8", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 97342, "upload_time": "2017-08-01T21:05:48", "url": "https://files.pythonhosted.org/packages/3c/3a/1185a2477209e837f64bf8a3c2beb84743f5df6bdf6af392ee40bbcfa52e/SiviCNCDriver-0.1.1.tar.gz" } ], "0.1.10": [ { "comment_text": "", "digests": { "md5": "5b4d41262f9c93e99775af16035ea40b", "sha256": "d8ded46acbd833e84415ca1c001a7adc18c49eef84d2bc5a9960f6bea2bad8fd" }, "downloads": -1, "filename": "SiviCNCDriver-0.1.10.tar.gz", "has_sig": false, "md5_digest": "5b4d41262f9c93e99775af16035ea40b", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 98246, "upload_time": "2017-12-06T10:03:32", "url": "https://files.pythonhosted.org/packages/da/b3/1766b6e8dbcfcfcd269c34fea1a1949e4ce71213d7abd5824da48cd3e94b/SiviCNCDriver-0.1.10.tar.gz" } ], "0.1.2": [ { "comment_text": "", "digests": { "md5": "3aaa37175c2842b54dd4f76679d117d5", "sha256": "cbf9baa873874083b5b68b2d6784d6defdfd4453145a062c16826e42e0c29f4d" }, "downloads": -1, "filename": "SiviCNCDriver-0.1.2.tar.gz", "has_sig": false, "md5_digest": "3aaa37175c2842b54dd4f76679d117d5", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 56588, "upload_time": "2017-08-12T14:40:45", "url": "https://files.pythonhosted.org/packages/12/24/11ff2e1a3f941a6168edbf7dd1b12a0077cd939d44c97f849601711859a9/SiviCNCDriver-0.1.2.tar.gz" } ], "0.1.3": [ { "comment_text": "", "digests": { "md5": "483b6cc10185166922af9db4ace0e7ab", "sha256": "308517ef8cddb434072ec195cacecb3dc70d63cda07ba5591f32b434d9954f18" }, "downloads": -1, "filename": "SiviCNCDriver-0.1.3.tar.gz", "has_sig": false, "md5_digest": "483b6cc10185166922af9db4ace0e7ab", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 91570, "upload_time": "2017-08-13T16:54:30", "url": "https://files.pythonhosted.org/packages/9a/11/a3e5ef21f2bb8042c1a90ceeb8a2bb5104b330806356e732507856820096/SiviCNCDriver-0.1.3.tar.gz" } ], "0.1.4": [ { "comment_text": "", "digests": { "md5": "619f282630eb7aa8f634ab8e45c1c608", "sha256": "33100002bed4db7563672b57f2ad84ba6598bc9ca10246f8c4df845f501b4bd0" }, "downloads": -1, "filename": "SiviCNCDriver-0.1.4.tar.gz", "has_sig": false, "md5_digest": "619f282630eb7aa8f634ab8e45c1c608", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 98663, "upload_time": "2017-08-14T16:24:12", "url": "https://files.pythonhosted.org/packages/28/e7/90fbc046aaf4b06f1b4b2b8b03a9dbacf446cfe7c63ce2a39620873b8867/SiviCNCDriver-0.1.4.tar.gz" } ], "0.1.5": [ { "comment_text": "", "digests": { "md5": "71dbff28f81f1684bae4dc93afabdbb6", "sha256": "9a11eeaa7ba45f897dc6c55c008a07545791623d58135cd226e5e7a0fff429dd" }, "downloads": -1, "filename": "SiviCNCDriver-0.1.5.tar.gz", "has_sig": false, "md5_digest": "71dbff28f81f1684bae4dc93afabdbb6", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 93589, "upload_time": "2017-08-19T08:26:43", "url": "https://files.pythonhosted.org/packages/5d/e3/771612defa711f441bf0d7e244856ef75cbd90129a38f089549744a7cc4a/SiviCNCDriver-0.1.5.tar.gz" } ], "0.1.6": [ { "comment_text": "", "digests": { "md5": "d1518b1e3553087bcd3689b98d234ef5", "sha256": "0bb213f07ebccfee2ed45efd0138b61fc5be5266fda89638aae93948e067639f" }, "downloads": -1, "filename": "SiviCNCDriver-0.1.6.tar.gz", "has_sig": false, "md5_digest": "d1518b1e3553087bcd3689b98d234ef5", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 97958, "upload_time": "2017-08-19T08:40:06", "url": "https://files.pythonhosted.org/packages/6d/dd/bafdf47f52a1a401e6fdb3a5d5bcc3a354f9553c9df184d51cb7c26c4256/SiviCNCDriver-0.1.6.tar.gz" } ], "0.1.7": [ { "comment_text": "", "digests": { "md5": "242cac94cba122f3a3e2f2a88197eb16", "sha256": "edb0dde9eaff8e28eb0890c12074f7dd711251f913f6dd3c46bdaad173b58dad" }, "downloads": -1, "filename": "SiviCNCDriver-0.1.7.tar.gz", "has_sig": false, "md5_digest": "242cac94cba122f3a3e2f2a88197eb16", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 97942, "upload_time": "2017-08-19T08:49:47", "url": "https://files.pythonhosted.org/packages/d7/cb/095ede16fbb9b4a56d20f2a8692644f527827c7c1732df1e8012e3955ba6/SiviCNCDriver-0.1.7.tar.gz" } ], "0.1.8": [ { "comment_text": "", "digests": { "md5": "a3765a28acd02d75ec80057dec0754d2", "sha256": "26ccc740536cd687b7d2861e0eeae82ac8cd7ff6b94fe3a003e576a87b1618bf" }, "downloads": -1, "filename": "SiviCNCDriver-0.1.8.tar.gz", "has_sig": false, "md5_digest": "a3765a28acd02d75ec80057dec0754d2", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 97556, "upload_time": "2017-08-22T20:04:31", "url": "https://files.pythonhosted.org/packages/be/e6/0f37376f4c18cbee811a817e0b986c266dd217f48a2604fa1a8a54fafa1d/SiviCNCDriver-0.1.8.tar.gz" } ], "0.1.9": [ { "comment_text": "", "digests": { "md5": "f55e46593f5163aa4eb998aeccfea86a", "sha256": "1a6c3541d9980f632e074c0ce1a50a7c47d56f0d3924be2fa033d67331461ba5" }, "downloads": -1, "filename": "SiviCNCDriver-0.1.9.tar.gz", "has_sig": false, "md5_digest": "f55e46593f5163aa4eb998aeccfea86a", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 97561, "upload_time": "2017-08-23T11:42:59", "url": "https://files.pythonhosted.org/packages/34/a8/a71efb69af68459c592de94f04ea821730e1a05fef328a321d34b108ccff/SiviCNCDriver-0.1.9.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "5b4d41262f9c93e99775af16035ea40b", "sha256": "d8ded46acbd833e84415ca1c001a7adc18c49eef84d2bc5a9960f6bea2bad8fd" }, "downloads": -1, "filename": "SiviCNCDriver-0.1.10.tar.gz", "has_sig": false, "md5_digest": "5b4d41262f9c93e99775af16035ea40b", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 98246, "upload_time": "2017-12-06T10:03:32", "url": "https://files.pythonhosted.org/packages/da/b3/1766b6e8dbcfcfcd269c34fea1a1949e4ce71213d7abd5824da48cd3e94b/SiviCNCDriver-0.1.10.tar.gz" } ] }