Pulse Encoder设备

简介

本开发指南给用户提供了Pulse Encoder的基本配置，工程构建编译、操作API介绍以及使用示例展示。

目录

• 简介
• 目录
• 配置指南
• Pulse Encoder API介绍
• 使用示例

配置指南

工程及使用说明

如果在提供的OneOS源码中已经有适合的工程DEMO工程，则可以直接使用；如果没有请参照快速上手中的操作指南，新建一个合适的工程。 STM32的脉冲编码器硬件接口依赖于定时器实现，在配置时需要配置好定时器的脉冲编码器功能。定时器配置为脉冲编码器功能后，将只做脉冲编码器，不再支持通用定时器功能。

STM32CubeMX配置硬件

1. 打开oneos\projects\xxxxx(project文件夹)\board\CubeMX_Config下的CUBE工程文件；

2. 在CUBE工程中进行Pulse Encoder配置,如下图所示：

注意事项： i. 请根据实际的编码器类型进行正确的配置，保证计数准确性。 ii. 编码器使用时必须开启外定时器的更新中断，否则编码器计数无法累计。

配置和生成工程

1. 点击Clock Configuration检查时钟配置，然后点击GENARATE CODE生成STM32CubeMX工程代码；
2. 在对应的oneos\projects\xxxxx(project文件夹)目录下打开OneOS-Cube工具，在命令行输入menuconfig打开可视化配置界面；如下图示，通过空格或向右方向键选择(Top) → Drivers→ MISC下的Using pulse encoder device drivers选项；

   (Top) → Drivers→ MISC
                                      OneOS Configuration
   [*] Using push button device drivers
   [*] Using led device drivers
   [ ] Using buzzer device drivers
   [ ] Using ADC device drivers
   [ ] Using DAC device drivers
   [ ] Using PWM device drivers
   [ ] Using input capture device drivers
   [*] Using pulse encoder device drivers
   

3. 通过Esc退出配置界面，退出时选择保存。
4. 在命令行输入scons --ide=mdk5构建工程；

工程编译及实现

1. 打开对应的oneos\projects\xxxxx(project文件夹) 目录下的project.uvprojx工程文件；
2. 在工程中将原有或自己编写的pulse encoder_test文件加入到application子文件夹中；
3. 编译并下载工程，运行程序；
4. 打开串口工具如xshell等，通信成功后，即可通过输入pulse_encoder_sample的测试指令；
5. 通过串口可以收到当前的脉冲编码计数值；

Pulse Encoder API介绍

API 列表

API 说明

os_device_find

该函数根据脉冲编码器设备名查找对应的脉冲编码器设备，函数原型如下：

os_device_t *os_device_find(const char *name);

os_device_control

该函数用于控制脉冲编码器设备参数，函数原型如下：

os_err_t os_device_control(os_device_t *dev, int cmd, void *arg);

脉冲编码器支持的命令控制字如下所示：

os_pulse_encoder_read

该函数用于获取脉冲编码器计数值，函数原型如下：

os_err_t os_pulse_encoder_read(struct os_pulse_encoder_device *pulse_encoder, os_int32_t *buffer);

os_pulse_encoder_clear

该函数用于清除脉冲编码器计数，函数原型如下：

os_err_t os_pulse_encoder_clear(struct os_pulse_encoder_device *pulse_encoder);

os_pulse_encoder_set_period

该函数用于设定编码器计数脉冲编码器周期，函数原型如下：

os_err_t os_pulse_encoder_set_period(struct os_pulse_encoder_device *pulse_encoder, os_uint32_t period);

os_pulse_encoder_enable

该函数用于使能启动编码器计数，函数原型如下：

os_err_t os_pulse_encoder_enable(struct os_pulse_encoder_device *pulse_encoder);

os_pulse_encoder_disable

该函数用于停止编码器计数，函数原型如下：

os_err_t os_pulse_encoder_disable(struct os_pulse_encoder_device *pulse_encoder);

使用示例

脉冲编码器使用示例

脉冲编码器设备的具体使用方式可以参考如下示例代码，示例代码的主要步骤如下：

1. 首先根据脉冲编码器的设备名称如 “encoder_tim1” 查找设备获取设备句柄；
2. 通过控制指令使能设备；
3. 读取脉冲编码器设备的计数值；
4. 清空脉冲编码器的计数值。（可选步骤）

#include <os_device.h>
#include "drv_gpio.h"
#include <os_errno.h>
#include <os_idle.h>

#ifdef OS_USING_SHELL
#include <shell.h>
#endif

int pulse_encoder_sample(int argc, char **argv)
{
    os_err_t     ret  = OS_EOK;
    os_int32_t count = 0;

    char *dev_name;
    os_pulse_encoder_device_t *pulse_encoder_dev = OS_NULL;

    if (argc != 2)
    {
        os_kprintf("usage: pulse_encoder_sample <dev>\r\n");
        os_kprintf("       pulse_encoder_sample encoder_tim1\r\n");
        return -1;
    }

    dev_name = argv[1];
    pulse_encoder_dev = (os_pulse_encoder_device_t *)os_device_find(dev_name);
    if (pulse_encoder_dev == OS_NULL)
    {
        os_kprintf("pulse encoder sample run failed! can't find %s device!\r\n", dev_name);
        return OS_ERROR;
    }

    ret = os_pulse_encoder_enable(pulse_encoder_dev);

    for (int i = 0; i <= 10; i++)
    {
        os_task_msleep(500);
        ret = os_pulse_encoder_read(pulse_encoder_dev, &count);
        os_kprintf("get count %d\r\n", count);
    }

    return ret;
}
/* Export to msh command list */
SH_CMD_EXPORT(pulse_encoder_sample, pulse_encoder_sample, "pulse_encoder_sample");

运行结果如下：

sh />pulse_encoder_sample encoder_tim1
get count 101
get count 203
get count 304
get count 202