AGS10是一款采用数字信号输出的MEMS TVOC传感器。配置了专用的数字模块采集技术和气体感应传感技术，确保了产品具有极高的可靠性与卓越的长期稳定性，同时具有低功耗、高灵敏度、快速响应、成本低、驱动电路简单等特点。

模块来源

采购链接：

AGS10有害气体传感器

规格参数

工作电压 : 3.0-6.0 V

典型功率 : 75mW

采样周期 : ≥2s

接口速率 ：I2C从机模式（≤15kHz）

预热时间 : ≥120s

工作温度 : 0～50℃

工作湿度 : 0～95%RH

寿命 : ＞5年（25℃，清洁空气中）

输出单位 : ppb

测量范围 : 0～99999 ppb

典型精度（ 25℃/50%RH）: 25% 读数

标准测试气体 : 乙醇

模块尺寸：15*10.6mm

以上信息见厂家资料文件

移植过程

查看资料

工作原理

  AGS10传感器采用标准I 2C通信协议，适应多种设备。IIC的物理接口包含串行数据信号（SDA）与串行时钟信号（SCL）两个接口。两个接口需通过1kΩ～10kΩ电阻上拉至VDD。SDA用于读、写传感器数据。SCL上电必须保持高电平直到进行IIC通信开始，否则会引起I 2C通讯不良。当I 2C通信时SCL用于主机与传感器之间的通讯同步。多个I2C设备可以共享总线，但是只能允许一个主机设备出现在总线上。既然采用的是IIC，那么我们需要知道它的IIC通信地址。

读取TVOC数据的步骤：

引脚选择

这里选择的引脚见引脚接线表

代码移植

下载为大家准备的驱动代码文件夹，复制到自己工程中\luban-lite\application\rt-thread\helloworld\user-bsp文件夹下

驱动代码文件夹下载

📌 资料下载中心（点击跳转）

📌 在 资料下载中心->模块移植资料下载 里面的该章节压缩包中。

提示

如果未找到 user-bsp 这个文件夹，说明你未进行模块移植的前置操作。请转移到手册使用必要操作（点击跳转）中进行必要的配置操作！！！

接下来打开自己的工程，开始修改Kconfig文件。

1、在 VSCode 中打开 application\rt-thread\helloworld\Kconfig 文件

2、在该文件的 #endif 前面添加该模块的 Kconfig路径语句

# AGS10有害气体传感器
source "application/rt-thread/helloworld/user-bsp/ags10-harmful-gas-sensor/Kconfig"

menuconfig操作

1、我们 双击 luban-lite 文件夹下的 win_env.bat 脚本打开env工具：

2、输入以下命令列出所有可用的默认配置：

scons --list-def

3、选择 d13x_JLC_rt-thread_helloworld 这个配置！这个是我们衡山派开发板的默认配置！输入以下命令即可：

scons --apply-def=7

或者

scons --apply-def=d13x_JLC_rt-thread_helloworld_defconfig

这两个命令作用是一样的，一个是 文件名 ，一个是 编号 ！！！

4、输入以下命令进入menuconfig菜单

scons --menuconfig

进入以下界面：

5、选中 Porting code using the LCKFB module

按 Y 选中

按 N 取消选中

方向键 左右 调整 最下面菜单的选项

方向键 上下 调整 列表的选项

回车 执行最下面菜单的选项

6、回车进入 Porting code using the LCKFB module 菜单

7、按方向键 上下 选中 Using AGS10 harmful gas sensor 后按 Y 键，看到前面括号中出现一个 * 号，就可以下一步了。

8、按方向键 左右 选中 <Save> 然后一路回车，然后 退出 即可

编译

我们 保存并退出menuconfig菜单 之后，输入以下命令进行编译：

scons

或

scons -j16

-j 用来选择参与编译的核心数: 我这里是选择16

大家可以根据自己的电脑来选择

核心越多编译越快

如果写的数量高于电脑本身，那么就自动按照最高可用的来运行！

镜像烧录

编译完成之后会在 \luban-lite\output\d13x_JLC_rt-thread_helloworld\images 文件夹下生成一个 d13x_JLC_v1.0.0.img 镜像文件！

然后我们烧录镜像，具体的教程请查看：镜像烧录（点击跳转🚀）

到这里完成了，请移步到 最后一节 进行移植验证。

工程代码解析

bsp_ags10.c

/*
 * 立创开发板软硬件资料与相关扩展板软硬件资料官网全部开源
 * 开发板官网：www.lckfb.com
 * 文档网站：wiki.lckfb.com
 * 技术支持常驻论坛，任何技术问题欢迎随时交流学习
 * 嘉立创社区问答：https://www.jlc-bbs.com/lckfb
 * 关注bilibili账号：【立创开发板】，掌握我们的最新动态！
 * 不靠卖板赚钱，以培养中国工程师为己任
 */

#include <stdlib.h>
#include <string.h>
#include <math.h>
#include <getopt.h>
#include <sys/time.h>
#include <rtthread.h>
#include <inttypes.h>
#include <finsh.h>
#include "hal_adcim.h"
#include "rtdevice.h"
#include "aic_core.h"
#include "aic_log.h"
#include "hal_gpai.h"
#include "aic_hal_gpio.h"
#include "hal_i2c.h"
#include "bsp_ags10.h"

#define I2C_BUS_NAME	"i2c0"           				/* I2C总线设备名称 */
#define SLAVE_ADDR      0x1A 							/* 器件地址 */

static struct rt_i2c_bus_device *i2c_bus = RT_NULL;     /* I2C总线设备句柄 */

/* 发送数据 */
static rt_err_t write_data(struct rt_i2c_bus_device *bus, rt_uint8_t len, rt_uint8_t *data)
{
    struct rt_i2c_msg msgs;

    msgs.addr = SLAVE_ADDR;
    msgs.flags = RT_I2C_WR;
    msgs.buf = data;
    msgs.len = len;

    /* 调用I2C设备接口传输数据 */
    if (rt_i2c_transfer(bus, &msgs, 1) == 1)
    {
        return RT_EOK;
    }
    else
    {
        return -RT_ERROR;
    }
}


/* 读取数据 */
static rt_err_t read_data(struct rt_i2c_bus_device *bus, rt_uint8_t len, rt_uint8_t *buf)
{
    struct rt_i2c_msg msgs;

    msgs.addr  = SLAVE_ADDR;    // 器件地址
    msgs.flags = RT_I2C_RD;     // 读写标志的设定
    msgs.buf   = buf;           // 发送缓存区地址
    msgs.len   = len;           // 发送的字节长度

    /* 调用I2C设备接口传输数据 */
    if (rt_i2c_transfer(bus, &msgs, 1) == 1)
    {
        return RT_EOK;
    }
    else
    {
        return -RT_ERROR;
    }
}


/******************************************************************
 * 函 数 名 称：Calc_CRC8
 * 函 数 说 明：CRC8 计算，初值：0xFF，多项式：0x31(x8 + x5 + x4 +1)
 * 函 数 形 参：u8* dat：需要校验数据的首地址；u8 Num：CRC 校验数据长度
 * 函 数 返 回：crc：计算出的校验值
 * 作       者：LCKFB
 * 备       注：无
******************************************************************/
static uint8_t Calc_CRC8(uint8_t *dat, uint8_t Num)
{
    uint8_t i, byte, crc = 0xFF;

    for(byte = 0; byte < Num; byte++)
    {
        crc ^= (dat[byte]);
        for( i = 0; i < 8; i++ )
        {
            if(crc & 0x80)  crc = ( crc << 1 ) ^ 0x31;
            else            crc = ( crc << 1 );
        }
    }

    return crc;
}





/******************************************************************
 * 函 数 名 称：SHT20_Read
 * 函 数 说 明：测量温湿度
 * 函 数 形 参：TVOC_Value数据地址
 * 函 数 返 回：RT_EOK:成功     -RT_ERROR:错误
 * 作       者：LCKFB
 * 备       注：无
******************************************************************/
int AGS10_Read(uint32_t *TVOC_Value)
{
    uint8_t Send_Buff = 0x00;
    uint8_t Recv_Buff[5] = {0};

    /* 发送数据 */
    if(RT_EOK != write_data(i2c_bus, 1, &Send_Buff))
    {
        LOG_E("[%s][%d]--->write_data Failed !!",__FUNCTION__,__LINE__);

        return -RT_ERROR;
    }

    aicos_udelay(200);

    /* 读取5个字节数据 */
    if(RT_EOK != read_data(i2c_bus, 5, Recv_Buff))
    {
        LOG_E("[%s][%d]--->read_data Failed !!",__FUNCTION__,__LINE__);

        return -RT_ERROR;
    }

    /* 校验 */
    if( Calc_CRC8(Recv_Buff, 4) != Recv_Buff[4] )
    {
        LOG_E("[%s][%d]--->Calc_CRC8 Failed !!",__FUNCTION__,__LINE__);

        return -RT_ERROR;
    }

    *TVOC_Value = (Recv_Buff[1]<<16) | (Recv_Buff[2]<<8) | Recv_Buff[3];

    return RT_EOK;
}

/**********************************************************
 * 函 数 名 称：AGS10_Init
 * 函 数 功 能：初始化AGS10
 * 传 入 参 数：无
 * 函 数 返 回：RT_OK：完成  -RT_ERROR：错误
 * 作       者：LCKFB
 * 备       注：
**********************************************************/
int AGS10_Init(void)
{
	/* 查找I2C总线设备，获取I2C总线设备句柄 */
	i2c_bus = (struct rt_i2c_bus_device *)rt_device_find(I2C_BUS_NAME);
    if(i2c_bus == RT_NULL)
	{
        LOG_E("no device: %s",I2C_BUS_NAME);
        return -RT_ERROR;
    }
	else
	{
        rt_kprintf("\nfind device: %s\n",I2C_BUS_NAME);
	}

    return RT_EOK;
}

bsp_ags10.h

/*
 * 立创开发板软硬件资料与相关扩展板软硬件资料官网全部开源
 * 开发板官网：www.lckfb.com
 * 文档网站：wiki.lckfb.com
 * 技术支持常驻论坛，任何技术问题欢迎随时交流学习
 * 嘉立创社区问答：https://www.jlc-bbs.com/lckfb
 * 关注bilibili账号：【立创开发板】，掌握我们的最新动态！
 * 不靠卖板赚钱，以培养中国工程师为己任
 */
#ifndef __BSP_AGS10_H__
#define __BSP_AGS10_H__

#include "stdio.h"

int AGS10_Init(void);
int AGS10_Read(uint32_t *TVOC_Value);

#endif

Kconfig

这个是一个menuconfig中的选项，如果在菜单中选中该选项，就会在rtconfig.h中定义一个语句，用来if判断条件编译之类的。

config LCKFB_AGS10_HARMFUL_GAS_SENSOR
    bool "Using AGS10 harmful gas sensor"
    select AIC_USING_I2C0
    default n
    help
        More information is available at: https://wiki.lckfb.com/

SConscript

自动化构建文件，如果定义了 LCKFB_EC11 和 USING_LCKFB_TRANSPLANT_CODE 就自动编译当前目录下的文件！！

Import('RTT_ROOT')
Import('rtconfig')
import rtconfig
from building import *

cwd = GetCurrentDir()
CPPPATH = [cwd]
src = []


if GetDepend('LCKFB_AGS10_HARMFUL_GAS_SENSOR') and GetDepend('USING_LCKFB_TRANSPLANT_CODE'):
    src = Glob(os.path.join(cwd, '*.c'))

group = DefineGroup('lckfb-ags10-harmful-gas-sensor', src, depend = [''], CPPPATH = CPPPATH)

Return('group')

test_ags10_harmful_gas_sensor.c

这个文件定义了一个用于处理AGS10气体传感器的线程，初始化了AGS10传感器，并设置了线程的优先级、栈大小和时间片。

线程的主要任务是周期性地读取AGS10的TVOC（总挥发性有机化合物）值，并将读取到的数据打印到控制台。线程在读取数据时会进行错误检查，并在一定次数的读取后提供退出线程的命令提示。通过命令行接口，用户可以启动和退出这个线程来测试AGS10传感器的功能。

线程入口函数逻辑

• 初始化时设置循环次数为1。
• 调用AGS10_Init函数来初始化AGS10传感器。
• 如果初始化失败，打印错误信息并返回。
• 打印开始循环的提示信息。
• 在一个无限循环中，首先读取TVOC值。
• 如果读取成功，将读取到的TVOC值打印到控制台。
• 如果读取失败，打印错误信息。
• 当循环次数达到100次时，重置循环次数并打印退出线程的命令提示信息。
• 在每次循环结束时，线程会挂起一段时间，这里是1000毫秒。

AGS10启动函数逻辑

• 创建名为"ags10_thread"的线程，入口函数为ags10_thread_entry，无参数，设置栈大小、优先级和时间片。
• 如果线程创建成功，启动线程。

AGS10退出函数逻辑

• 使用rt_thread_delete函数尝试删除ags10_thread线程。
• 如果删除失败，打印错误信息。
• 如果删除成功，打印退出成功的提示信息。

提示

• MSH_CMD_EXPORT宏将test_ags10_sensor和test_exit_ags10_sensor函数导出为RT-Thread命令行接口的命令，这样用户可以在RT-Thread的命令行中直接运行这些命令来启动和退出AGS10传感器的读取。

#include <stdlib.h>
#include <stdio.h>
#include <string.h>
#include <getopt.h>
#include <sys/time.h>
#include <rtthread.h>
#include "rtdevice.h"
#include "aic_core.h"
#include "aic_hal_gpio.h"
#include "bsp_ags10.h"


#define THREAD_PRIORITY         25      // 线程优先级
#define THREAD_STACK_SIZE       1024    // 线程大小
#define THREAD_TIMESLICE        20      // 时间片

static rt_thread_t ags10_thread = RT_NULL;   // 线程控制块

// 线程入口函数
static void ags10_thread_entry(void *param)
{
    int ret = 0;
    int while_count = 1; // 循环次数

    /* AGS10初始化 */
    ret = AGS10_Init();
    if(ret != RT_EOK)
    {
        LOG_E("failed to AGS10_Init !!");
        return;
    }

    rt_kprintf("Start Loop !!\n");

    while(while_count++)
    {
        uint32_t TVOC_Value = 0;

        int ret = AGS10_Read(&TVOC_Value); //读取
        if(ret != RT_EOK)
        {
            LOG_E("failed to AGS10_Read !");
        }
        else
        {
            rt_kprintf("\nRead [AGS10] TVOC = %d\n", TVOC_Value);
        }

        if(while_count >= 100)
        {
            while_count = 1;

            rt_kprintf("\nType [test_exit_ags10_sensor] command to exit AGS10 to read data\n");
            rt_kprintf("Note: Pressing [TAB] as you type will autocomplete the command\n");

            rt_thread_mdelay(2000);
        }

        rt_thread_mdelay(1000);
    }

    rt_kprintf("\nEND!!\n");

}

/* AGS10启动函数 */
static void test_ags10_sensor(int argc, char **argv)
{
    /* 创建线程，名称是 ags10_thread，入口是 ags10_thread_entry */
    ags10_thread = rt_thread_create("ags10_thread",
                            ags10_thread_entry, RT_NULL,
                            THREAD_STACK_SIZE,
                            THREAD_PRIORITY, THREAD_TIMESLICE);

    /* 如果获得线程控制块，启动这个线程 */
    if (ags10_thread != RT_NULL)
        rt_thread_startup(ags10_thread);
}
// 导出函数为命令
MSH_CMD_EXPORT(test_ags10_sensor, run AGS10 sensor);


/* AGS10退出函数 */
static void test_exit_ags10_sensor(void)
{
    int ret = rt_thread_delete(ags10_thread);
    if(ret != RT_EOK)
    {
        LOG_E("failed to test_exit_ags10_sensor !!");
    }
    else
    {
        rt_kprintf("\n========AGS10 exit successful !!========\n");
    }

}
// 导出函数为命令
MSH_CMD_EXPORT(test_exit_ags10_sensor, quit AGS10);

移植验证

我们使用串口调试，将 USB转TTL模块 连接到衡山派开发板上面！！

具体的教程查看：串口调试（点击跳转🚀）

串口波特率默认为115200

我们在输入下面的命令运行该模块的线程：

输入的时候按下TAB键会进行命令补全！！

test_ags10_sensor

模块代码下载

链接：下载中心->模块移植代码下载（点击跳转🚀）