智能家居系统方案设计.docx

项目名称，模块设计报告智能家居系统 方案设计文档 目 录 0. 文档介绍40.1 文档目的40.2 文档范围40.3 读者对象40.4 参考文献40.5 术语与缩写解释41. 模块命名规则52. 模块汇总52.1 模块汇总表52.2 模块关系图53. 子系统A的模块设计63.n 模块A-n64. 子系统B的模块设计64.n 模块B-n65. 其他60. 文档介绍0.1 文档目的本文档旨在详细说明智能家居系统中门禁系统和linux下的模块程序开发过程，通过此文档 的描述，希望可以达到具有同等技术的开发人员按此介绍可以完全重现此技术。0.2 文档范围智能控制系统，嵌入式linux系统等。0.3 读者对象嵌入式系统开发人员0.4 参考文献无0.5 术语与缩写解释缩写、术语解 释CPLDCPLD是一种用户根据各自需要而自行构造逻辑功能的数字集成电路。其基本设计方法是借助集成开发软件平台，用原理图、硬件描述语言等方法，生成相应的目标文件，通过下载电缆（“在系统”编程）将代码传送到目标芯片中，实现设计的数字系统。WiegandWiegand协议是国际上统一的标准，有很多格式，标准的26-bit 应该是最常用的格式zigbee紫蜂技术1. 模块命名规则本文档模块名称与具体实现的功能函数采取一致的表示方法。2. 模块汇总设备管理，策略管理，人员管理，定时管理，设备底层操作，串口设备层操作，串口底层操作库，配置文件解析，以及UI通讯等模块。同时包括门禁控制系统模块，家居控制模块和环境探测模块以及人机交互界面设计模块。2.1 模块汇总表设备管理（dev.c）模块名称功能简述init_dev初始化设备根节点add_dev添加入网设备del_dev删除链表中设备init_dev_policy_table按照设备类新初始化策略表update_dev_policy_table按照各个设备类型，更新链表中的各个设备策略表get_dev_policy_table_size按照设备节点的类型返回对应设备类型的策略表大小策略管理（policy.c）模块名称功能简述tempmon_policy_table_init初始化温度计类型设备的策略表。tempmon_policy_table_set_warn根据参数传过来的状态设置设备报警状态。tempmon_policy_table_update调用底层设备控制取得当前设备状态更新对应设备的策略表。设备底层操作接口 (devctl.c)tempmon_get_dev_stat取得温度计设备状态tempmon_get_cur_temp取得温度计设备温度tempmon_set_hi_level设置温度计最高报警温度tempmon_set_low_levl设置温度计最低报警温度用户认证(auth.c)auth_user根据传来的用户名和密码，返回验证结果change_pass根据传来的用户名和密码，更改密码文件里对应项目。）del_pass根据传来的用户名，删除密码文件中的对应用户行add_user根据传来的参数，在密码文件中加入对应用户行配置文件处理(parm.c)load_parm解析器的前端，根据解析器的结果，抛出对应得错误。do_paser根据传进来的文件描述符，将文件中相应的参数解析到参数结构体。save_parm将参数结构体按照对应格式写入配置文件。getnline从文件中取得最大长度为n一行，并将回车翻译为字符串结尾符trim刨去传入字符串开头和结尾的空格和tab配置文件参数处理 (parm_handler.c)temp_hi_level设置参数结构体的temp_hi_level参数temp_low_level设置参数结构体的temp_low_level参数带头节点的双向链表 (list.c) 移植自linux内核list_add_node插入节点list_del_node删除节点is_empty_list判断链表是否为空is_last_node判断是否为最后一个节点offsetof宏取得结构体元素相对于结构体开始的偏移量container_of宏通过结构体元素的指针取得结构体的指针循环缓冲区(loop_buf.c) 移植自linux内核min宏返回两个数中的最小值init_loop_buf初始化循环缓冲区release_loop_buf释放循环缓冲区里的线程锁get_loop_buf从循环缓冲区中获取数据put_loop_buf向循环缓冲区中放置数据lock_buf循环缓冲区线程锁加锁unlock_buf循环缓冲区中线程锁解锁loop_buf_reset循环缓冲区指针复位loop_buf_len返回循环缓冲区剩余长度串口设备层操作（uart.c）init_uart调用底层串口库初始化串口com_monitor串口监视线程，负责监视并接受串口上数据。pre_frame_proces对串口接受数据预处理，调用相应的操作函数read_uart_one_frame从串口读取完整一桢read_uart_buf从缓冲区读取数据，没有数据则休眠等待下次信号唤醒。串口操作库（uart.c）open_uart打开相应串口设备文件read_uart读取串口数据。write_uart将数据写入串口set_uart_speed设置串口工作速度set_uart_parity设置串口的工作特性，例如停止位奇偶流控等。read_uart_timeout带有超时的串口读取操作处理。UI通信（commui.c）init_commui初始化ui通信各个参数。commui_monitor套接字监视线程，监视套接字是否有命令数据到来。get_cmd_line从描述符中取得一行命令行warn_ui向ui发起报警命令处理程序（cmd.c）run_cmd命令解析器，调用对应命令的处理程序。error根据错误码，将返回对应得错误信息。命令处理程序handler（cmd_handler.c）xxx_comand_handler对应各个命令的处理程序。门禁控制模块ReadWiegand读取用户卡信息SendWiegand发送用户卡信息SendCmd发送控制指令家居控制系统和环境探测模块GetTem采集环境信息SendTem封包发送采集数据RecTem解析采集数据信息SendLedData发送led显示数据GetTemFromCDLed模块收取并解析温度数据DisplayTem发送并显示信息OpenLamp打开继电器CloseLamp关闭继电器2.2 模块关系图3.设备管理系统的模块设计模块名称init_dev功能描述初始化设备根节点接口与属性void init_dev(void);数据结构与算法struct dev pthread_mutex_lock mutex; unsigned int nr_dev; struct list list;补充说明包含设备编号和链表的线程锁模块名称add_dev功能描述向设备链表中添加设备节点接口与属性int add_dev(char dev_type, char dev_no, char *ieee_addr);数据结构与算法struct dev_node char dev_type; char dev_no; char ieee_addr8; char alive; char failed; void *policy_table; struct list list;补充说明根据传来的设备类型设备号及IEEE地址，分配新的设备节点，并填写相应的项目然后调用模块名称del_dev功能描述从设备链表中删除设备节点接口与属性int del_dev(char dev_type, char dev_no);数据结构与算法struct dev_node char dev_type; char dev_no; char ieee_addr8; char alive; char failed; void *policy_table; struct list list;补充说明模块名称init_dev_policy_table功能描述初始化设备策略表接口与属性void init_dev_policy_table(struct dev_node *node);数据结构与算法同上补充说明模块名称renew_dev_policy_table功能描述将全局参数表的参数对应节点的参数刷新到设备的策略表里接口与属性void renew_dev_policy_table(struct dev_node *node)数据结构与算法无补充说明模块名称renew_all_dev_policy_table功能描述将全局参数表的参数刷新到所有设备的策略表里接口与属性void renew_all_dev_policy_table(struct dev_node *node)数据结构与算法无补充说明模块名称update_dev_policy_table功能描述通过调用设备控制层相关方法，取得设备对应状态，更新相应策略表接口与属性void update_dev_policy_table(struct dev_node *node)数据结构与算法struct dev_node char dev_type; char dev_no; char ieee_addr8; char alive; char failed; void *policy_table; struct list list;补充说明模块名称update_all_dev_policy_table功能描述更新所有设备策略表接口与属性void update_all_dev_policy_table(struct dev_node *node);数据结构与算法同上补充说明模块名称check_dev_type功能描述检查设备类型是否合法接口与属性int check_dev_type(unsigned char dev_type)数据结构与算法同上补充说明模块名称is_dev_exist功能描述检查设备是否存在接口与属性int is_dev_exist(unsigned char dev_type, unsigned char dev_no)数据结构与算法同上补充说明模块名称get_dev_node功能描述根据设备类型和设备号返回设备节点指针接口与属性struct dev_node *get_dev_node(unsigned char dev_type, unsigned char dev_no)数据结构与算法同上补充说明4. 策略管理模块设计模块名称tempmon_policy_table_init功能描述温度计策略表初始化接口与属性void tempmon_policy_table_init(struct dev_node *node);数据结构与算法struct _dev_table unsigned char dev_type;void (*policy_table_init)(struct dev_node *);void (*policy_table_load_parm)(struct dev_node *);void (*policy_table_update)(struct dev_node *);void (*policy_table_warn)(struct dev_node *, char);void (*parm_table_save)(struct dev_parm *, FILE *fp);struct tempmon_policy char hi_level; char low_level; char cur_temp; char temp_warn;补充说明为设备节点钟的策略表指针分配内存，并使用参数表中的值初始化对应得设备。模块名称tempmon_policy_table_update功能描述调用设备层温度计操作函数，更新温度计温度策略表接口与属性void tempmon_policy_table_update(struct dev_node *node);数据结构与算法同上补充说明模块名称tempmon_policy_table_set_warn功能描述根据传来的参数，设置对应温度计设备的报警状态接口与属性void tempmon_policy_table_set_warn(struct dev_node *node, char stat);数据结构与算法同上补充说明模块名称tempmon_policy_table_load_parm功能描述将温度计参数表中的值填入策略表里接口与属性void tempmon_policy_table_load_parm(struct dev_node *node)数据结构与算法同上补充说明模块名称tempmon_policy_table_load_default_parm功能描述将温度计默认的参数填入策略表里接口与属性void tempmon_policy_table_load_parm(struct dev_node *node)数据结构与算法同上补充说明5.设备底层操作接口模块设计模块名称tempmon_get_dev_stat功能描述取得温度计设备状态接口与属性char tempmon_get_dev_stat(struct dev_node *node);数据结构与算法无补充说明调用取得温度计温度判断是否有返回值，判断设备是否仍然有响应，如果设备没有响应，则将设备节点中的设备状态标记为设备已死并调用failed_dev_ctl使设备节点操作失败次数加1（考虑到网络延迟等情况，采用设备操作失败计数，当累计到操作失败到指定次数，则会调用del_dev将设备从设备链表中删除。而任何一次成功的设备操作则判定设备再次有响应，失败计数被清零）。模块名称tempmon_get_dev_stat功能描述取得温度计当前温度接口与属性char tempmon_get_cur_temp(struct dev_node *node);数据结构与算法struct gen_frame unsigned char head1; unsigned char head2; / always 0x55 0xAA unsigned char type; / frame type WARN unsigned char len; / frame len unsigned char dev_type; / device type unsigned char dev_no; / device no char status;补充说明按照协议，组装好设备的查询数据包，从串口发出，并等待串口回应。模块名称tempmon_set_hi_level功能描述设置当前温度计最高报警温度接口与属性char tempmon_set_hi_level(struct dev_node *node, char high_level);数据结构与算法struct con_frame unsigned char head1; unsigned char head2; unsigned char type; unsigned char len; unsigned char dev_type; unsigned char dev_no; unsigned char con_cmd; char con_value;补充说明按照协议，组装好设备的控制数据包，从串口发出，并调用取得设备温度，刷新设备状态。模块名称tempmon_set_low_level功能描述设置当前温度计最低报警温度接口与属性char tempmon_set_low_level(struct dev_node *node, char high_level);数据结构与算法struct con_frame unsigned char head1; unsigned char head2; unsigned char type; unsigned char len; unsigned char dev_type; unsigned char dev_no; unsigned char con_cmd; char con_value;补充说明按照协议，组装好设备的控制数据包，从串口发出，并调用取得设备温度，刷新设备状态。其他设备以此类类推。5.用户认证模块设计模块名称auth_user功能描述根据传来的用户名和密码返回验证结果接口与属性char auth_user(char *name,char *pass);数据结构与算法无补充说明模块名称add_user功能描述根据传来的用户名和密码将用户添加到密码文件中接口与属性char add_user(char *name,char *pass);数据结构与算法无补充说明模块名称del_user功能描述根据传来的用户名将用户从密码文件中删除接口与属性char del_user(char *name);数据结构与算法无补充说明注意此处仅作用户存在性检查不做用户检查，用户检查应该由UI发命令使用auth_user检查通过后再来调用此函数。功能性模块尽可能在自己被调用时提供方法而不是策略。模块名称change_pass功能描述根据传来的用户名和密码将用户从密码文件中修改对应的记录接口与属性char change_pass(char *name,char *pass);数据结构与算法无补充说明注意事项同上。用户配置文件格式为用户名和密码定长不足定长使用空格补足，分隔符为：防止频繁修改文件大小，加剧Nand Fland的读写。6.配置文件处理模块设计模块名称Load_parm功能描述解析器的前端，根据解析器的结果，抛出对应得错误接口与属性int load_parm(char *fname)数据结构与算法无补充说明无模块名称do_parser功能描述解析器主体，根据传进来的文件指针，将文件中相应的参数解析到全局参数表。接口与属性int do_parser(FILE *fp);数据结构与算法struct temp_parm int temp_hi_level;int temp_low_level;union parm struct temp_parm temp_parm;struct dev_parm char dev_type;char dev_no;union parm parm;struct parm_table unsigned int nr_parm;struct dev_parm dev_parmNR_MAX_PARM;struct parm_action char nameMAX_PARM_NAME_LEN;void (*func)(struct dev_parm*, char *);示例：struct parm_action parm_actionPARM_ACTION_LEN="dev_type",load_dev_type,"dev_no",load_dev_no,"temp_hi_level",load_temp_hi_level,"temp_low_level",load_temp_low_level,;补充说明模块名称save_parm功能描述根据传进来的文件名，将全局参数表存储到配置文件中。接口与属性int save_parm(char *fname);数据结构与算法同上补充说明模块名称get_dev_parm功能描述根据传来的设备类型和设备号，返回对应设备的参数指针接口与属性struct dev_parm *get_dev_parm(char dev_type, char dev_no);数据结构与算法同上补充说明模块名称getnline功能描述根据传进来的文件指针，从中取得一行，此行最大长度为count。接口与属性size_t getnline(char *buf, size_t count, FILE *fp);数据结构与算法无补充说明会将行尾的回车符替换为字符串结束的尾零，并且遇到EOF时停止。返回值为实际取得的字符数（含尾零/回车）。模块名称trim功能描述将传进来的字符串头尾的空格以及制表符砍去，然后将结果复制到dst。接口与属性char *trim(char *dst, const char *src);数据结构与算法无补充说明各个参数的handler：模块名称load_dev_type功能描述将设备类型填入到传入的dev_parm。接口与属性void load_dev_type(struct dev_parm *dev_parm, char *value)；数据结构与算法无补充说明模块名称load_dev_no功能描述将设备号填入到传入的dev_parm。接口与属性void load_dev_type(struct dev_parm *dev_parm, char *value)；数据结构与算法无补充说明模块名称load_temp_hi_level功能描述将温度计最高报警温度填入到传入的dev_parm。接口与属性void load_temp_hi_level(struct dev_parm *dev_parm, char *value)数据结构与算法无补充说明模块名称load_temp_low_level功能描述将温度计最低报警温度填入到传入的dev_parm接口与属性void load_temp_low_level(struct dev_parm *dev_parm, char *value)数据结构与算法无补充说明模块名称temp_parm_save功能描述将传入的温度计的dev_parm按照格式写入到文件指针里接口与属性void temp_parm_save(struct dev_parm *dev_parm, FILE *fp)数据结构与算法无补充说明7.带头节点双向链表模块设计模块名称init_list功能描述初始化链表头节点接口与属性void init_list(struct list *list);数据结构与算法struct list struct list *prev,*next;补充说明模块名称list_add_node功能描述将节点加入链表。接口与属性void list_add_node(struct list *new, struct list *node, int location);数据结构与算法同上补充说明可以使用location标志指定插入node制定节点的左边还是右边，如果node指向头节点，那么左边及为链表尾部，右边是链表头。模块名称list_del_node功能描述将节点从量表中删除接口与属性void list_del_node(struct list *node);数据结构与算法无补充说明模块名称is_last_node功能描述判断节点是否是链表的尾节点接口与属性int is_last_node(struct list *list, struct list *node);数据结构与算法无补充说明真为尾节点模块名称is_empty_list功能描述返回链表是否为空链表接口与属性int is_empty_list(struct list *list);数据结构与算法无补充说明真为空链表模块名称offsetof宏功能描述返回成员在结构体中的偏移接口与属性offsetof(TYPE, MEMBER)；数据结构与算法无补充说明TYPE为对应结构体的类型，MEMBER为成员在结构体中的名字模块名称get_node_owner 宏功能描述传入指向结构体中成员的指针，返回指向结构体的指针。接口与属性get_node_owner(ptr, type, member);数据结构与算法无补充说明type,member定义同offsetof,ptr为指向结构体中成员的指针。模块名称each_node_in_list 宏功能描述使用pos指针遍历结构体。接口与属性each_node_in_list(pos, head);数据结构与算法#define each_node_in_list(pos, head) for (pos = (head)->next; pos != (head); pos = pos->next)补充说明注意不要在循环中修改pos指针。模块名称each_owner_in_list宏功能描述使用pos指针遍历结构体，但是此pos的指针类型是链表宿主的，head节点类型是链表类型。接口与属性each_owner_in_list (pos, type, member);数据结构与算法#define each_owner_in_list(pos, head,member) for (pos = get_node_owner(head)->next, typeof(*pos), member); &pos->member != (head); pos = get_node_owner(pos->member.next, typeof(*pos), member)补充说明同上。8.循环缓冲区模块设计模块名称init_loop_buf功能描述初始化循环缓冲区。接口与属性int init_loop_buf(struct loop_buf *buf);数据结构与算法struct loop_buf pthread_mutex_t mutex; unsigned char bufferLOOP_BUF_LEN; unsigned int in; unsigned int out;补充说明注意缓冲区大小必须为2的平方。模块名称release_loop_buf功能描述释放循环缓冲区。接口与属性void release_loop_buf(struct loop_buf *buf);数据结构与算法同上补充说明释放结构体中的线程锁，同时复位缓冲区模块名称put_loop_buf功能描述将数据放入循环缓冲区接口与属性unsigned int put_loop_buf(struct loop_buf *buf, unsigned char *buffer, unsigned int len);数据结构与算法同上补充说明空间不足则只放入能放入的，返回值为实际放入数据长度。模块名称get_loop_buf功能描述使用pos指针遍历结构体，但是此pos的指针类型是链表宿主的，head节点类型是链表类型。接口与属性unsigned int get_loop_buf(struct loop_buf *buf, unsigned char *buffer, unsigned int len);数据结构与算法同上补充说明同上。模块名称lock_buf(struct loop_buf *buf);功能描述锁定循环缓冲区接口与属性void lock_buf(struct loop_buf *buf);数据结构与算法无补充说明无。模块名称unlock_buf功能描述解锁循环缓冲区接口与属性void unlock_buf(struct loop_buf *buf);数据结构与算法无补充说明无。模块名称loop_buf_reset功能描述循环缓冲区复位接口与属性void loop_buf_reset(struct loop_buf *buf);数据结构与算法无补充说明无。模块名称loop_buf_len功能描述返回循环缓冲区长度接口与属性unsigned int loop_buf_len(struct loop_buf *buf);数据结构与算法无补充说明无。9.串口操作层模块设计模块名称init_uart功能描述按照本程序的需要调用串口库初始化串口，并开启监听线程接口与属性void init_uart(void);数据结构与算法无补充说明无。模块名称com_monitor功能描述串口监听线程实例接口与属性void *com_monitor(void *arg);数据结构与算法无补充说明首先调用read_uart_one_frame收到完整一桢，然后调用process_frame_buf处理由协调器主动发起的添加设备桢和报警桢根据返回值判断是否已经处理，直接进入下一个循环还是放入缓冲区，供发起查询的函数取得回应包。模块名称read_uart_one_frame功能描述从串口中取得完整一桢接口与属性ssize_t read_uart_one_frame(int fd, unsigned char *buf);数据结构与算法无补充说明调用read_uart_timeout取得完整桢头，然后进行一系列桢检查，非法桢直接丢弃返回0，合法桢则放入buf。模块名称read_uart_buf功能描述从缓冲区读取数据，没有数据则休眠等待下次信号唤醒接口与属性void unlock_buf(struct loop_buf *buf);数据结构与算法无补充说明无。10.串口操作库模块设计模块名称open_uart功能描述打开串口接口与属性int open_uart(char *fname);数据结构与算法无补充说明无。模块名称set_uart_speed功能描述设置串口速度接口与属性int set_uart_speed(int fd, int speed);数据结构与算法无补充说明无。模块名称set_uart_parity功能描述设置串口各种工作属性接口与属性int set_uart_parity(int fd, int databits, int stopbits, int parity);数据结构与算法无补充说明无。模块名称read_uart_timeout功能描述在timeout规定的时间内读取指定的count字符个数接口与属性ssize_t read_uart_timeout(i