TpHardwareI2c 类
V0.2.1TpExtUtils
2025-11-14
继承关系
基础信息
| 头文件: | include <TpHardwareI2c.h> |
|---|---|
| Cmake: | None |
| 发布版本: | V0.2.1 |
| 继承类: | TpHardwareDevice |
| 派生类: |
Public 成员函数
| TpHardwareI2c(const TpString &name) | ||
|---|---|---|
| TpHardwareI2c(const TpString &name, tpUInt8 address) | ||
| TpHardwareI2c(tpUInt8 bus, tpUInt8 address) | ||
| ~TpHardwareI2c() | ||
| open() | 打开设备 | |
| close() | 关闭设备 | |
| read(uint8_t *buffer, size_t length) | ||
| write(const uint8_t *data, size_t length) | ||
| readReg(tpUInt8 reg, tpUInt8 *data, size_t length, uint32_t timeout_ms=1000) | 从指定寄存器开始读取，适合于存储设备 | |
| writeReg(tpUInt8 reg, const tpUInt8 *data, size_t length, uint32_t timeout_ms=1000) | 从指定寄存器开始写入 | |
| writeCmd(tpUInt8 cmd, uint32_t timeout_ms=1000) | 写命令 | |
| readData(tpUInt8 *buf, size_t length, uint32_t timeout_ms=1000) | 读数据，通常和writeCmd搭配使用，适合于传感器，ADC等采集的接口 | |
| setSlaveAddress(tpUInt8 address) | 设置IIC从机地址 | |
| getSlaveAddress() | 获取IIC从机地址 | |
| probeDevice() | 探测设备是否存在 | |
| static TpList< tpUInt8 > | getI2cBuss() | 获取本机上内核已开启的I2C的bus号列表，但不保证全部可用。 |
| static TpList< tpUInt8 > | getSlaveDevices(tpUInt8 bus) | 获取总线上所有从机地址 |
成员函数说明
TpHardwareI2c::TpHardwareI2c(const TpString &name)
暂无注释...
TpHardwareI2c::TpHardwareI2c(const TpString &name, tpUInt8 address)
暂无注释...
参数：name: 设备名
参数：address: 从设备地址
TpHardwareI2c::TpHardwareI2c(tpUInt8 bus, tpUInt8 address)
暂无注释...
参数：bus: I2C总线编号
参数：address: 从设备地址
TpHardwareI2c::~TpHardwareI2c()
暂无注释...
tpBool TpHardwareI2c::open()
打开设备...
打开设备
返回值：
void TpHardwareI2c::close()
关闭设备...
关闭设备
ssize_t TpHardwareI2c::read(uint8_t *buffer, size_t length)
暂无注释...
参数：buffer:
参数：length:
返回值：
ssize_t TpHardwareI2c::write(const uint8_t *data, size_t length)
暂无注释...
参数：data:
参数：length:
返回值：
tpInt64 TpHardwareI2c::readReg(tpUInt8 reg, tpUInt8 *data, size_t length, uint32_t timeout_ms=1000)
从指定寄存器开始读取，适合于存储设备...
从指定寄存器开始读取，适合于存储设备
参数：reg: 起始寄存器地址
参数：data: 数据
参数：length: 数据长度
参数：timeout_ms:
返回值：
tpInt64 TpHardwareI2c::writeReg(tpUInt8 reg, const tpUInt8 *data, size_t length, uint32_t timeout_ms=1000)
从指定寄存器开始写入...
从指定寄存器开始写入
参数：reg: 起始寄存器地址
参数：data: 数据
参数：length: 数据长度
参数：timeout_ms: 超时时间
返回值：
tpInt64 TpHardwareI2c::writeCmd(tpUInt8 cmd, uint32_t timeout_ms=1000)
写命令...
写命令
参数：cmd: 命令
参数：data: 数据
参数：timeout_ms: 超时时间
返回值：
tpInt64 TpHardwareI2c::readData(tpUInt8 *buf, size_t length, uint32_t timeout_ms=1000)
读数据，通常和writeCmd搭配使用，适合于传感器，ADC...
读数据，通常和writeCmd搭配使用，适合于传感器，ADC等采集的接口
参数：buf:
参数：length:
参数：timeout_ms:
返回值：
int TpHardwareI2c::setSlaveAddress(tpUInt8 address)
设置IIC从机地址...
设置IIC从机地址
参数：address:
返回值：
tpUInt8 TpHardwareI2c::getSlaveAddress()
获取IIC从机地址...
获取IIC从机地址
返回值：
tpBool TpHardwareI2c::probeDevice()
探测设备是否存在...
探测设备是否存在
返回值：
static TpList< tpUInt8 > TpHardwareI2c::getI2cBuss()
获取本机上内核已开启的I2C的bus号列表，但不保证全部可用...
获取本机上内核已开启的I2C的bus号列表，但不保证全部可用。
返回值：
static TpList< tpUInt8 > TpHardwareI2c::getSlaveDevices(tpUInt8 bus)
获取总线上所有从机地址...
获取总线上所有从机地址
返回值：
