概要设计_云台控制

XX产品XXXX模块软件概要设计说明书修订记录目录1概述 (6)1.1 系统背景 (6)1.2 模块定义 (6)1.3 模块功能定义 (6)1.4 模块其他需求 (6)1.5 模块设计说明（可选） (6)2模块设计 (6)2.1 模块结构 (7)2.2 子模块描述 (7)2.2.1软件子模块1（具体名称） ...................................................... 错误！未定义书签。

2.2.2软件子模块2（具体名称） ...................................................... 错误！未定义书签。

2.3 数据流设计（可选） (9)2.3.1模块数据输入 (9)2.3.2模块数据输出 (9)2.3.3模块数据流程 (10)2.4 协议状态机设计（可选） (10)2.5 协议报文交互设计（可选） (10)2.6 模块运行设计 (10)3数据结构 (11)3.1 常数定义 (11)3.2 数据定义1 (11)3.3 数据定义2 (12)3.4 数据结构1 (13)3.5 全局变量说明 (13)4处理流程/算法 (13)4.1 流程1 (13)4.2 流程2 (14)5外部接口 (14)5.1 命令接口 (14)5.1.1命令列表 (14)5.1.2命令名称1 (14)5.1.3命令名称2 (15)5.2 其他用户接口（可选） (15)5.3 报文接口（可选） (15)5.3.1报文1 (15)5.3.2报文2 (15)6模块间接口 (15)6.1 对外函数接口 (15)6.1.1接口函数1 (16)6.1.2接口函数2 (16)6.2 要求其他模块提供的函数接口（可选） (16)6.2.1外部接口函数1 (16)6.2.2外部接口函数2 (17)6.3 对外发出的消息（可选） (17)6.3.1接口消息1 (17)6.3.2接口消息2 (17)6.4 接收到的消息 (17)6.4.1接口消息1 (17)6.4.2接口消息2 (18)6.5 公共数据接口（可选） (18)6.5.1公共数据清单 (18)6.5.2公共数据1 (19)6.5.3公共数据2 (19)6.6 要求其他模块提供的公共数据接口（可选） (19)6.6.1外部公共数据清单 (19)6.6.2外部公共数据1 (20)6.6.3外部公共数据2 (20)7其他属性设计 (20)7.1 性能设计 (20)7.2 可靠性设计 (20)7.3 可维护性设计 (20)7.4 配置保存与恢复 (20)7.5 热备份（可选） (20)8已知缺陷和遗留问题 (21)9参考资料清单 (21)概要设计写作指导 (22)软件概要设计说明书关键词：列出本文中的重要技术概念名称。

缩写说明：对本文所用缩写词语进行说明。

1 概述1.1系统背景简要说明模块所属的整体系统的功能和体系结构。

说明系统中主要的模块及相互关系。

用图表示，并加以文字说明。

1 接收命令转发服务器的SDK消息或CGI消息，并将消息处理结果返回给命令转发服务器或CGI。

1.2模块定义实现对云台控制的操作。

1.3模块功能定义云台上、下、左、右、焦距、焦点、光圈、预置点、辅助开关、串口配置、速度配置等功能。

1.4模块其他需求模块应达到的性能或其他特性要求。

所有描述的需求需要与需求设计文档列举的需求一致1.5模块设计说明（可选）云台支持多种解码器，各种解码器通过注册服务器的方式，采用面向对象的思想通过统一的函数接口以回调函数的形式调用每种解码器的具体实现函数。

2模块设计2.1模块结构命令解析模块：解析SDK关键字，根据关键字将SDK消息调用子模块处理，子模块将消息添加到队列，串口操作线程将数据写到串口。

2.2子模块描述2.2.1 云台转动文档名称密级：机密根据SDK操作命令组织云台操作码，加入到消息队列。

2.2.2 预置点操作2.2.3 串口配置2.2.4 速度配置2.2.5 辅助开关2.3数据流设计（可选）2.3.1命令解析模块数据输入2.3.2命令解析模块数据输出2.3.3串口操作模块数据输入2.3.4串口操作模块数据输出2.3.5模块数据流程用数据流图说明数据在模块中的处理流程。

数据流图以数据流为中心，说明数据从进入模块到离开模块的完整过程，不受子模块划分的限制。

每个处理步骤只需简要说明。

2.4协议状态机设计（可选）用状态清单、状态变迁图和状态变迁表说明状态机的设计。

2.5协议报文交互设计（可选）首先说明协议报文类型。

用协议报文时序图说明协议报文交互过程。

2.6模块运行设计说明本模块在系统中属于哪个任务，对任务优先级、内存、定时器、信号量等系统资源是否有特殊要求。

其中内存、定时器等资源占用估算要结合系统容量规格定量分析。

可使用如下表格：文档名称密级：机密3数据结构本章应详细说明模块内的对模块功能实现有重要意义的数据结构。

3.1常数定义用C语言定义模块中重要的常数宏。

如重要的系统参数、状态位等。

用注释说明含义。

必要时可以将子模块专用的常数定义放在子模块章节内部说明。

#define PTZ_ERROR -1#define PTZ_SUCCESS 0#define PTZ_OPEN_FILE_ERROR -2#define PTZ_SEEK_FILE_ERROR -3#define PTZ_READ_FILE_ERROR -4#define PTZ_WRITE_FILE_ERROR -5#define PTZ_OPEN_CONFIG_ERROR -6#define PTZ_READ_CONFIG_ERROR -7#define PTZ_FIND_DECODER_ERROR -8#define PARSE_PARAM_ERROR -10#define PTZ_OPEN_SERIAL_ERROR -11#define PTZ_READ_SERIAL_ERROR -12#define PTZ_WRITE_SERIAL_ERROR -13#define PTZ_INIT_SERIAL_ERROR -14#define PTZ_SET_SERIAL_ERROR -15#define PTZ_FCNTL_SERIAL_ERROR -16#define PTZ_ISATTY_SERIAL_ERROR -17#define PTZ_OPERATE_NOT_SUPPORT -183.2数据定义1struct uart_buf{unsigned char data_len; /*云台控制码长度*/unsigned char channel_id; /*通道ID*/char data[UART_BUF_LEN]; /*云台控制码*/pthread_mutex_t lock; /*加锁互斥*/};消息队列struct uart_buf_pool {unsigned char read_pos;unsigned char write_pos;struct uart_buf uart_buf_entry[MAX_BUF_NR];};文档名称密级：机密typedef struct speed_config{int pan_speed;int tilt_speed;}speed_config;typedef struct ptz_context{unsigned char channel; /*channel number needed to operator*/unsigned char preset_index; /*preset index*/unsigned char aux_index;unsigned char decoder_addr;unsigned char pan_speed;unsigned char tilt_speed;unsigned char out_len;int cmd_id;char out[MAX_OUT_SIZE];char decoder_name[DECODER_NAME_LEN]; /*decoder name*/char *trans_code;}ptz_context;采用面向对象的思想，按照一级关键字调用相应的处理函数。

struct main_cmd_entry{char *main_cmd;int (*cmd_func)(char *buf,char *ret_buf);};采用面向对象思想，查找命令ID。

struct decoder_cmd_entry{char *cmd;char *sub_cmd;int cmd_id;int (*cmd_func)(char *buf,int *speed);};3.3数据定义2解码器类型操作函数的抽象接口。

typedef struct DecoderContext{const char *name;int (*common_func)(ptz_context *ptzctx);int (*preset_func)(ptz_context *ptzctx);int (*trans_func)(ptz_context *ptzctx);int (*speed_func)(ptz_context *ptzctx);struct DecoderContext *next;}DecoderContext;3.4数据结构1对于比较复杂的数据结构，如十字链表，树，多个交叉的链表等，上文说明的struct定义还不能很好地说明。

应在这里用图形和文字说明数据结构相互之间的关系。

3.5全局变量说明定义模块中使用的所有全局变量和某些起重要作用的静态变量。

可使用以下表格：次要数据可忽略。

4处理流程/算法4.1流程11遍历一级关键字列表for(;;)//遍历第一关键字表{if() //如果找到关键字{调用关键字对应的处理函数}2遍历命令关键字列表for(;;)//遍历命令关键字表{if() //如果找到关键字{查找解码器，调用解码器的处理函数}}3查找解码器for()//遍历解码器列表{if() //通过解码器名字，找到匹配的解码器，返回解码器指针}4.2流程25外部接口5.1命令接口5.1.1命令列表5.1.2命令名称1命令作用：说明命令功能。

命令原型：设计命令语法时应尽量符合现有命令的风格，新功能要尽量符合主流产品的设计。

避免不必要的别出心裁。

语法格式就是目前命令注册的格式，即 list 命令显示的格式。

参数说明：包括参数名称，值域，缺省值。

默认状态：如果不配置这个命令，系统所采用的缺省值或状态。

命令模式：如配置模式、接口配置模式、路由协议配置模式。