StepMotorDriver 模块

StepMotor Driver Module 13.2 V1.1 是一款适配 M5 主控的步进电机驱动器，采用 STM32 + HR8825 步进电机驱动方案，提供 3 路双极性步进电机控制接口。

支持以下产品：

MicroPython 应用示例：

# SPDX-FileCopyrightText: 2024 M5Stack Technology CO LTD
#
# SPDX-License-Identifier: MIT

import os, sys, io
import M5
from M5 import *
from module import StepMotorDriverModule
import time


stepmotor_driver_0 = None


DIR = None


def setup():
    global stepmotor_driver_0, DIR

    M5.begin()
    Widgets.fillScreen(0x222222)

    stepmotor_driver_0 = StepMotorDriverModule(
        address=0x27, step_pin=(16, 12, 15), dir_pin=(17, 13, 0)
    )
    print(stepmotor_driver_0.get_all_limit_switch_state())
    print(stepmotor_driver_0.get_limit_switch_state(0))
    print(stepmotor_driver_0.get_fault_io_state(StepMotorDriverModule.MOTOR_X))
    print(stepmotor_driver_0.get_firmware_version())
    stepmotor_driver_0.reset_motor(
        StepMotorDriverModule.MOTOR_X, StepMotorDriverModule.MOTOR_STATE_ENABLE
    )
    stepmotor_driver_0.set_motor_state(StepMotorDriverModule.MOTOR_STATE_ENABLE)
    stepmotor_driver_0.set_microstep(StepMotorDriverModule.STEP_FULL)
    stepmotor_driver_0.set_motor_direction(StepMotorDriverModule.MOTOR_X, 1)
    stepmotor_driver_0.set_motor_pwm_freq(StepMotorDriverModule.MOTOR_X, 1000)
    stepmotor_driver_0.motor_control(StepMotorDriverModule.MOTOR_X, 1)
    DIR = 0


def loop():
    global stepmotor_driver_0, DIR
    M5.update()
    if DIR:
        stepmotor_driver_0.set_motor_direction(StepMotorDriverModule.MOTOR_X, 1)
    else:
        stepmotor_driver_0.set_motor_direction(StepMotorDriverModule.MOTOR_X, 0)
    DIR = not DIR
    time.sleep(2)


if __name__ == "__main__":
    try:
        setup()
        while True:
            loop()
    except (Exception, KeyboardInterrupt) as e:
        try:
            from utility import print_error_msg

            print_error_msg(e)
        except ImportError:
            print("please update to latest firmware")

UiFlow2 应用示例

step_motor_driver.m5f2

class StepMotorDriverModule

构造函数

class StepMotorDriverModule(address, step_pin, dir_pin)

初始化 StepMotorDriverModule。

参数:

address (hex) – 设备的 I2C 地址。
step_pin (tuple) – 电机的步进引脚（X、Y、Z）。
dir_pin (tuple) – 电机的 dir 引脚（X、Y、Z）。

UIFLOW2：

Methods

StepMotorDriverModule.reset_motor(motor_id, state)

重置电机。

参数:

motor_id – 要复位的电机。可选项：- X：StepMotorDriverModule.MOTOR_X - Y：StepMotorDriverModule.MOTOR_Y - Z：StepMotorDriverModule.MOTOR_Z
state (bool) – 电机的状态。

UIFLOW2：

StepMotorDriverModule.set_motor_state(state)

启用或禁用电机。

参数:: state (bool) – 电机的状态。

UIFLOW2：

StepMotorDriverModule.set_microstep(step)

设置细分。

参数:: step – 微步值。选项：- FULL：StepMotorDriverModule.STEP_FULL - 1/2：StepMotorDriverModule.STEP1_2 - 1/4：StepMotorDriverModule.STEP1_4 - 1/8：StepMotorDriverModule.STEP1_8 - 1/16：StepMotorDriverModule.STEP1_16 - 1/32：StepMotorDriverModule.STEP1_32

UIFLOW2：

StepMotorDriverModule.set_motor_pwm_freq(motor_id, freq)

设置电机 PWM 频率。

参数:

motor_id – 用于设置频率的电机。选项：- X：StepMotorDriverModule.MOTOR_X - Y：StepMotorDriverModule.MOTOR_Y - Z：StepMotorDriverModule.MOTOR_Z
freq (int) – 频率值。

UIFLOW2：

StepMotorDriverModule.set_motor_direction(motor_id, direction)

设置电机方向。

参数:

motor_id – 用于设置方向的电机。选项：- X：StepMotorDriverModule.MOTOR_X - Y：StepMotorDriverModule.MOTOR_Y - Z：StepMotorDriverModule.MOTOR_Z。
direction (bool) – 方向值。选项：- Positive：1 - Negative：0

UIFLOW2：

StepMotorDriverModule.get_all_limit_switch_state()

获取所有 IO 状态。

UIFLOW2：

StepMotorDriverModule.get_limit_switch_state(switch_id)

获取 io 状态。

参数:: switch_id (int) – io id。

UIFLOW2：

StepMotorDriverModule.get_fault_io_state(motor_id)

获取故障 io 状态。

参数:: motor_id (int) – 电机 ID。选项：- X：StepMotorDriverModule.MOTOR_X - Y：StepMotorDriverModule.MOTOR_Y - Z：StepMotorDriverModule.MOTOR_Z

UIFLOW2：

StepMotorDriverModule.motor_control(motor_id, state)

控制电机旋转/停止。

参数:

motor_id – 电机 ID。选项：- X：StepMotorDriverModule.MOTOR_X - Y：StepMotorDriverModule.MOTOR_Y - Z：StepMotorDriverModule.MOTOR_Z
state (bool) – 状态值。选项：- Rotate：1 - Stop：0

UIFLOW2：

StepMotorDriverModule.get_firmware_version()

获取固件版本。

UIFLOW2：

StepMotorDriverModule.set_i2c_address(new_address)

设置 i2c 地址。

参数:: new_address (int) – 新地址。

UIFLOW2：

Constants

StepMotorDriverModule.MOTOR_X

StepMotorDriverModule.MOTOR_Y

StepMotorDriverModule.MOTOR_Z

电机 ID

StepMotorDriverModule.MOTOR_STATE_ENABLE

StepMotorDriverModule.MOTOR_STATE_DISABLE

电机状态

StepMotorDriverModule.INPUT_REG

StepMotorDriverModule.OUTPUT_REG

StepMotorDriverModule.POLINV_REG

StepMotorDriverModule.CONFIG_REG

StepMotorDriverModule.FAULT_REG

StepMotorDriverModule.RESET_REG

StepMotorDriverModule.FIRM_REG

StepMotorDriverModule.I2C_REG

寄存器地址

StepMotorDriverModule.STEP_FULL

StepMotorDriverModule.STEP1_2

StepMotorDriverModule.STEP1_4

StepMotorDriverModule.STEP1_8

StepMotorDriverModule.STEP1_16

StepMotorDriverModule.STEP1_32

微步值。