MC200编程手册（Python）¶

简介¶

pycncapi是一个Python库，用以使用Python编程语言实现与维控科技旗下的MC系列运动控制器通讯。

✨-特性¶

支持通过以太网与MC控制器通讯
支持读取和设置控制器参数
支持发送运动指令
支持获取控制器状态信息

⏳版本¶

pycncapi目前发布v1.0.0版本

v1.0.0¶

完成控制类指令的开发，支持对控制的急停、使能控制
完成点动类指令的开发，支持对控制器的点动控制
完成运动类指令的开发，支持对控制器的运动控制
完成参数类指令的开发，支持对控制器的参数读写
完成状态类指令的开发，支持对控制器的状态读取

快速开始¶

📦安装¶

使用pip安装pycncapi:

Bash

pip install pycncapi -i http://pypi.we-con.com.cn/simple --trusted-host pypi.we-con.com.cn

🔨使用¶

Python

from pycncapi import CncCtrlApi

接口介绍¶

控制器连接¶

connect¶

参数: ip: str, port: int
返回值: bool
功能: 连接到控制器

disconnect¶

参数: 无
返回值: bool
功能: 断开与控制器的连接

控制器控制¶

estop¶

参数: state: bool
返回值: bool
功能: 设置控制器的急停状态

enable¶

参数: state: bool
返回值: bool
功能: 设置控制器的使能状态

setOpMode¶

参数: mode: int
返回值: bool
功能: 设置控制器的点动状态
参数值: 0: MANUAL，1: AUTO，2: MDI

运动控制¶

continuousJog¶

参数: axis: int, speed: float
返回值: bool
功能: 连续点动，控制关节按照指定速度运动。需要调用stopJog停止运动。
参数解释: axis: 关节号，speed: 速度

incrementJog¶

参数: axis: int, speed: float, distance: float
返回值: bool
返回值: bool
功能: 增量点动，控制关节按照指定速度运动指定距离。可以调用stopJog停止运动。
参数解释: axis: 关节号，speed: 速度, distance: 距离

stopJog¶

参数: axis: int
返回值: bool
功能: 停止点动
参数解释: axis: 关节号

executeMdi¶

参数: mdi: str
返回值: bool
功能: 执行MDI指令
参数解释: mdi: MDI指令

G代码¶

downloadGcode¶

参数: file_path: str
返回值: bool
功能: 下载G代码
参数解释: file_path: G代码文件路径
注意: 本接口将自动将g代码文件下载至控制器中，并且以原文件名存储，后续调用openProgram仅需传入文件名即可。

resetProgram¶

参数: 无
返回值: bool
功能: 复位G代码载入状态

openProgram¶

参数: file_name: str
返回值: bool
功能: 打开G代码
参数解释: file_name: G代码文件名。

Note

注意: 本接口仅需传入下载的G代码文件名即可。一定要是底层存在的文件名。

runProgram¶

参数: line: int
返回值: bool
功能: 运行G代码
参数解释: line: 指定行运行。

stopProgram¶

参数: 无
返回值: bool
功能: 停止G代码

pauseProgram¶

参数: 无
返回值: bool
功能: 暂停G代码

resumeProgram¶

参数: 无
返回值: bool

stepProgram¶

参数: 无
返回值: bool
功能: 单步运行G代码。调用一次，执行一行。

状态获取¶

getMotionState¶

参数: 无
返回值: int
功能: 获取运动状态
返回值解释: 1: 急停，2: 急停复位，3: 未使能，4: 使能

getInterpState¶

参数: 无
返回值: bool
功能: 获取系统状态
返回值解释: 1: 空闲, 2: 加载文件中, 3: 暂停, 4: 等待

getOpMode¶

参数: 无
返回值: bool
功能: 获取操作模式
返回值解释: 0: MANUAL，1: AUTO，2: MDI

getCurCoordinate¶

参数: 无
返回值: list[float]
功能: 获取当前坐标
返回值解释: 返回一个列表，列表中包含当前坐标值。

getCurVel¶

参数: 无
返回值: float
功能: 获取当前速度

示例代码¶

连接控制器¶

Python
from pycncapi import CncCtrlApi

api = CncCtrlApi()
if api.connect('192.168.1.100', 9995):
    print('Connected to controller')
else:
    print('Failed to connect to controller')

设置控制器状态¶

Python
from pycncapi import CncCtrlApi

api = CncCtrlApi()
if api.connect('192.168.1.100', 9995):
    if api.estop(False):
        print('Estop reset')
        if api.enable(True):
            print('Enable set')
        if api.setOpMode(1):
            print('OpMode set')
else:
    print('Failed to connect to controller')

控制Jog¶

以下示例将控制机器X轴按照100的速度运动100的距离

Python
from pycncapi import CncCtrlApi

api = CncCtrlApi()
axis = 0
speed = 100
distance = 100
if api.connect('192.168.1.100', 9995):
    if api.estop(False): # 急停复位
        if api.enable(True): # 使能
            # 控制点动
            api.incrementJog(axis, speed, distance)
else:
    print('Failed to connect to controller')

控制运行G代码¶

以下示例将控制机器打开机器内部名为test.ngc的G代码并且运行

Python
from pycncapi import CncCtrlApi

api = CncCtrlApi()
axis = 0
speed = 100
distance = 100
if api.connect('192.168.1.100', 9995):
    if api.estop(False): # 急停复位
        if api.enable(True): # 使能
            # 打开指定G代码文件
            if api.openProgram('test.ngc'):
                api.runProgram() # 开始运行
else:
    print('Failed to connect to controller')

从零开始设计一个简单的UI控制¶

这里以windows上使用VSCode作为ide开发举例，其余平台请类比开发。

安装pyqt5¶

使用PyQt5需要用到两个包：pyqt5和pyqt5-tools。如果想在原生环境中安装，那么在命令行中使用pip即可安装：

Bash
pip install PyQt5
pip install PyQt5-tools

为VSCode配置扩展¶

在VSC中点击「Extensions 拓展」，搜索「PYQT Integration」并安装。

vscode

安装完成后，点击「PYQT Integration」的齿轮，选择「Extension Settings」，进入该拓展的设置页面。

在设置页面，我们指定一些PyQt工具的路径，以便于在VSC中启动这些工具，便捷地执行PyQt操作。

首先指定Pyuic的路径（前文说到，Pyuic是一个将我们设计的GUI界面的 .ui 文件转换为 .py 文件的工具），在「Pyqt-integration > Pyuic: Cmd」，输入安装PyQt5的虚拟环境中Pyuic的绝对路径：

比如我的电脑是：

Text Only

D:\_A_1_Soft\Python\311\Scripts\pyuic5

指定QT designer的路径（前文说到，QT designer就是QT用来设计GUI的软件，通过拖拽组件可以快速构建GUI），在「Pyqt-integration > Qtdesigner: Path」，输入虚拟环境中QT designer的绝对路径：