1@page pca9544 pca9544
2
3[更正文档](https://gitee.com/alios-things/pca9544/edit/master/README.md)      [贡献说明](https://help.aliyun.com/document_detail/302301.html)
4
5# 概述
6
7PCA9544是一颗有4个选通通道的I2C多路转接器。HaaS100的板上就使用了这颗做了I2C的通道扩展。本文档描述了该芯片的驱动详情，包括目录结构，依赖情况，API，使用等情况，供用户参考。
8组件支持以下功能：
9
10- 初始化
11- 通道选通
12- 当前通道读取
13- 写寄存器
14- 读寄存器
15- 裸数据读写
16
17
18## 版权信息
19
20> Apache license v2.0
21
22## 目录结构
23
24```tree
25├── example
26│   └── i2c_muxer_example.c
27├── include
28│   └── pca9544.h
29├── internal
30│   └── pca9544_i2c_drv.h
31├── package.yaml
32├── README.md
33└── src
34    └── pca9544.c
35    └── pca9544_i2c_drv.c
36
37```
38
39## 依赖组件
40
41- base
42- vfs
43- i2c
44
45# 常用配置
46
47# API说明
48
49```c
50/**********************************************************
51 * @fun    pca9544_init
52 * @breif  pca9544 initialization
53 * @param  i2c:the pointer for i2c configuration
54 * @param  dev_cfg: the pointer for dev configuration
55 * @rtn
56 *********************************************************/
57int pca9544_init(i2c_dev_t *i2c, PCA9544_DEV_CFG_T* dev_cfg);
58
59/**********************************************************
60 * @fun    pca9544_deinit
61 * @breif  pca9544 deinitialization
62 * @param  none
63 * @rtn    none
64 *********************************************************/
65void pca9544_deinit();
66
67/**********************************************************
68 * @fun    pca9544_set_chan
69 * @breif  pca9544 channel set
70 * @param  chan: the object channel
71 * @rtn    ret
72 *********************************************************/
73int pca9544_set_chan(PCA9544_CH_E chan);
74
75/**********************************************************
76 * @fun    pca9544_clean_chan
77 * @breif  pca9544 channel clean
78 * @param  none
79 * @rtn    ret
80 *********************************************************/
81int pca9544_clean_chan();
82
83/**********************************************************
84 * @fun    pca9544_read_chan
85 * @breif  pca9544 channel reading
86 * @param  none
87 * @rtn    chan: the current selected channel of pca9544
88 *********************************************************/
89PCA9544_CH_E pca9544_read_chan();
90
91/**********************************************************
92 * @fun    pca9544_write_reg
93 * @breif  pca9544 register writing operation
94 * @param  dev_addr: i2c device address
95 * @param  regval: register value
96 * @rtn    ret
97 *********************************************************/
98int pca9544_write_reg(uint16_t dev_addr, uint8_t regval);
99
100/**********************************************************
101 * @fun    pca9544_read_reg
102 * @breif  pca9544 register reading operation
103 * @param  dev_addr: i2c device address
104 * @param  regval: register value
105 * @rtn    ret
106 *********************************************************/
107int pca9544_read_reg(uint16_t dev_addr, uint8_t* data);
108
109/**********************************************************
110 * @fun    pca9544_raw_data_write
111 * @breif  write raw data to the selected channel
112 * @param  sub_addr: the sub dev addr for
113 *                   the selected pca9544 channel
114 * @param  reg_addr: the sub dev register addr for
115 *                   the selected pca9544 channel
116 * @param  size: register size
117 * @param  data: the pointer for the writing data
118 * @param  len: the data length
119 * @rtn    ret
120 *********************************************************/
121int pca9544_raw_data_write(uint16_t subdev_addr, uint16_t reg_addr,
122    uint16_t size,  uint8_t* data, uint16_t len);
123
124/**********************************************************
125 * @fun    pca9544_raw_data_read
126 * @breif  read raw data to the selected channel
127 * @param  sub_addr: the sub dev addr for
128 *                   the selected pca9544 channel
129 * @param  reg_addr: the sub dev register addr for
130 *                   the selected pca9544 channel
131 * @param  size: register size
132 * @param  data: the pointer for the reading data
133 * @param  len: the data length
134 * @rtn    ret
135 *********************************************************/
136int pca9544_raw_data_read(uint16_t subdev_addr, uint16_t reg_addr,
137    uint16_t size,  uint8_t* data, uint16_t len);
138
139```
140
141# 使用示例
142
143组件使用示例相关的代码下载、编译和固件烧录均依赖AliOS Things配套的开发工具，所以首先需要参考[《AliOS Things集成开发环境使用说明之搭建开发环境》](https://help.aliyun.com/document_detail/302378.html)，下载安装。
144待开发环境搭建完成后，可以按照以下步骤进行示例的测试。
145
146## 步骤1 创建或打开工程
147
148**打开已有工程**
149
150如果用于测试的案例工程已存在，可参考[《AliOS Things集成开发环境使用说明之打开工程》](https://help.aliyun.com/document_detail/302381.html)打开已有工程。
151
152**创建新的工程**
153
154组件的示例代码可以通过编译链接到AliOS Things的任意案例（solution）来运行，这里选择helloworld_demo案例。helloworld_demo案例相关的源代码下载可参考[《AliOS Things集成开发环境使用说明之创建工程》](https://help.aliyun.com/document_detail/302379.html)。
155
156## 步骤2 添加pca9544组件
157
158> helloworld_demo组件的package.yaml中添加
159
160```bash
161depends:
162  - pca9544: master # helloworld_demo中引入pca9544组件
163```
164
165## 步骤3 下载组件
166
167在已安装了  的开发环境工具栏中，选择Terminal -> New Terminal启动终端，并且默认工作路径为当前工程的workspace，此时在终端命令行中输入：
168
169```shell
170
171aos install pca9544
172
173```
174
175上述命令执行成功后，组件源码则被下载到了./components/drivers/external_device路径中。
176
177## 步骤4 添加示例代码
178
179> 向pca9544组件的package.yaml中添加example
180
181```bash
182source_file:
183  - "src/*.c"
184  - "example/pca9544_example.c" # add pca9544_example.c
185```
186
187## 步骤5 编译固件
188
189在示例代码已经添加至组件的配置文件，并且helloworld_demo已添加了对该组件的依赖后，就可以编译helloworld_demo案例来生成固件了，具体编译方法可参考[《AliOS Things集成开发环境使用说明之编译固件》](https://help.aliyun.com/document_detail/302384.html)。
190
191## 步骤6 烧录固件
192
193helloworld_demo案例的固件生成后，可参考[《AliOS Things集成开发环境使用说明之烧录固件》](https://help.aliyun.com/document_detail/302383.html)来烧录固件。
194
195## 步骤7 打开串口
196
197固件烧录完成后，可以通过串口查看示例的运行结果，打开串口的具体方法可参考[《AliOS Things集成开发环境使用说明之查看日志》](https://help.aliyun.com/document_detail/302382.html)。
198
199当串口终端打开成功后，可在串口中输入help来查看已添加的测试命令。
200
201## 步骤8 PCA9544示例测试
202
203> CLI命令行输入：
204
205```bash
206pca9544_example
207```
208
209> CLI日志：
210
211```bash
212pca9544_example
213PCA9544 cfg is successful
214=====I2C Muxer PCA9544 test: set chan 2[5] of PCA9544=====
215=====I2C Muxer PCA9544 test: read chan val of PCA9544 is 5=====
216=====I2C Muxer PCA9544 test: PCA9544 test:  PASS=====
217pca9544 comp test success!
218
219```
220