软件著作权设计说明书编写 – MOZE

文章目录

申请软件著作权最难的部分应该就是说明书的编写了，听说很多人在这一步被刷下来反反复复修改。作为一个学电气的门外汉，我也来尝试这个过程。先在这篇文章里记录一下写说明书的过程。如果申请成功了，估计以后还用的到，也是一份属于自己的宝贵经验。

这次是给之前文章里提到过的那个摄像机监控报警软件写说明书。这个软件最初是为了便于现场调试写的，后来逐渐往里面加了一点点功能。总的来说也就是个小工具，结构很简单。但是后来发现申请软著的话对职称、课题等社畜必备环节有利，就决定给这个小小的软件申请一下。

说明书分为两大类，操作说明书和设计说明书。前者适用于界面为主的软件，说明书主要介绍各个界面的功能与操作指南。后者偏向功能，说明书主要为功能说明与流程图。本文使用后者。

首先是说明书的名字，直接使用“xxx软件设计说明书”即可。但是听取相关人士的经验，软件名字最好归于“系统”二字，更容易通过审核。于是名字就成为了“xxx系统设计说明书”。另外，不论软件出了多少个大版本或修订版本，申请时都建议填“1.0”版本，利于过审。

页眉左上角为软件名与版本号，右上角为页码。

说明书引言

本项目拟设计一套用于危险环境动态监测的机器视觉系统，该系统主要包含视频监控与S7通讯两大部分。

工控场所的摄像机往往不具备与工控设备建立通讯的能力，即使双方预留了有相同的接口，但在后期调试施工时工作量大。而西门子的S7协议只运行在西门子自家设备上，与其他设备通讯配置较为复杂。本软件兼顾视频监控与工控系统，既可以实现对生产现场异常情况的监测，又可以将报警信号与西门子系列PLC通讯，使控制系统及时作出反应，防止造成进一步损失。

危险场所的具体需求如下：（1） 摄像机代替人工监视危险场所变化（2） 检测到异常情况及时报警（3） 报警信号同步至控制系统（4） 同步监测多路信号（5） 保留异常情况的图片视频数据

摄像机厂商提供的控制软件功能复杂，且无法输出符合工控设备通讯协议的信号。工业控制器无法直接连接摄像机识别视频信号，对视频进行分析。摄像机与控制器巨头海康威视及西门子开源了自家设备的SDK与协议，本软件基于此进行开发。但西门子提供的英文技术文档版本老旧，长期未更新，对开发过程造成了一定影响。

系统整体结构框架图

系统详细模块信息

模块内部结构图

本软件主要功能是实现摄像机监测生产现场是否出现异常情况，监测阀门，釜罐，电机等各类设备的外观状态。重点功能是实现与下位机的通讯，利用西门子自家成熟的S7协议传输报警信息，使监控完美融入工控系统。

工控机、摄像机与PLC均使用网络电缆连接进工控网络。上位机通过不同协议分别与摄像机和PLC建立连接。通讯建立成功后返回信息。

连接摄像机流程

连接PLC流程

建立摄像机连接后可以对摄像机进行进一步操作，如生成回放，截图，录制视频，视频动态分析等。

功能结构如下

图像分析是报警信号产生的途径。开始分析后从摄像机抓取一帧视频数据到内存进行分析，生成其特征值，然后不断抓取新帧，并计算相邻帧的差别，如果差别大于设定阈值，即生成报警信号。

分析流程如下

连接PLC后，软件持续向PLC输出所有监控点位信息。如产生报警信息，则根据设定的PLC型号，I/O地址等数据，将传输数据的对应位置位。报警信息消除后，将对应位复位。PLC根据此报警信号做出相应反应，如开启关闭指定设备，打开关闭报警或联动消防雨淋系统。

流程如下

在每次使用中，本软件都会记录用户对摄像机、PLC及软件的各类设置，并存储为本地用户配置文件。配置文件支持独立编辑修改。软件在启动时，会先读取配置文件，将之前保存的配置信息写入软件，可省去重复键入操作。配置文件支持同时存储多个摄像机数据，支持一键清除保存的配置。

支持保存的数据如下：（1） 摄像机IP；（2） 摄像机连接端口；（3） 摄像机用户名；（4） 摄像机登录密码；（5） 摄像机报警抓拍开关；（6） PLC类型；（7） PLC IP地址；（8） PLC机架号；（9） PLC插槽号；（10）识别灵敏度；（11）报警阈值；（12）PLC报警输入起始字节；（13）PLC报警输入起始位；（14）报警消除自动复位。

逻辑如下

本软件使用WinForms窗体制作的界面实现人机交互。通过界面可以实现摄像头登录、摄像机视频回放、截图与录像、手动控制监测与抓拍、连接PLC、设置报警地址、设置报警灵敏度、阈值等。每个窗体控件均设置了气泡提示，来协助用户使用。

人机界面如下

软件内部包含两个协议：与摄像机通讯的海康威视私有视频协议，与西门子系列设备通讯的S7协议。两者皆为开源协议且有官方说明手册。

软件下部配置有状态条，每一步操作状态及错误信息会及时显示在状态条。关键错误弹窗提醒。