homekit开发文档
本文档内容包括
第一部分：简介
第二部分：启用HomeKit
第三部分：创建Home布局
第四部分：创建Homes和添加Accessories
第五部分：观察HomeKit数据库的变化
第六部分：访问服务和特性
第七部分：测试HomeKitApp
第八部分：创建动作集（Action Sets）和触发器（Triggers）
第九部分：用户管理
第一部分：简介
该文档旨在帮你编写HomeKit app。HomeKit库是用来沟通和控制家庭自动化配件的，这些家庭自动化配件都支持苹果的HomeKit Accessory Protocol。HomeKit应用程序可让用户发现兼容配件并配置它们。用户可以创建一些action来控制智能配件（例如恒温或者光线强弱），对其进行分组，并且可以通过Siri触发。HomeKit 对象被存储在用户iOS设备的数据库中，并且通过iCloud还可以同步到其他iOS设备。HomeKit支持远程访问智能配件，并支持多个用户设备和多个用户。HomeKit 还对用户的安全和隐私做了处理。
注意：如果你是开发设计HomeKit硬件的供应商，你可以去Hardware Developers下的HomeKit页面了解MFi Program相关信息，也可以阅读External Accessory Programming Topics.
另请参阅
以下资源提供了更多关于创建HomeKit应用程序的信息：
HomeKit User Interface Guidelines提供了用户界面设计指南
App Store Review Guidelines: HomeKit提供了加快app审核的技巧
HomeKit Framework Reference描述了HomeKit框架中的类和方法
External Accessory Framework Reference列出了系统提供的发现和配置无线
智能家居产品UI
HomeKit Catalog提供示例演示HomeKit特性
WWDC 2014: Introducing HomeKit对HomeKit更高层次的分析
iOS Security描述HomeKit如何处理iOS上的安全和隐私
第二部分：启用HomeKit
HomeKit应用服务只提供给通过App Store发布的app应用程序。在你的Xcode工程中，HomeKit应用程序需要额外的配置，你的app必须有开发证书和代码签名才能使用HomeKit。在Xcode的Capabilities面板使用HomeKit，可避免代码签名的问题。你无需直接在Xcode或者会员中心编辑授权文件（entitlements）。
设置
为了完成本文档中所有步骤，你需要：
一个安装Xcode 6 或者Xcode 6 以上版本的Mac电脑。
为了获得最佳体验，你的Mac电脑上最好安装最新的OS X 系统和最新的Xcode 版本。
加iOS开发者计划。
在Member Center 拥有创建代码签名和资源配置的权限。
在你开始使用HomeKit之前，请确保你已经完成以下任务。创建你团队的配置文件（Provisioning Profile），请参阅：App Distribution Quick Start .
当你成功地完成了之前的任务后，General面板中Team弹出菜单中的错误信息和问题修复按钮将会消失。代码签名配置被成功创建后会展示下方的General面板。
解决代码签名和证书配置问题，请参阅App Distribution Guide文档中Troubleshooting 这一节。
启用HomeKit
想要使用HomeKit，首先要启用它。Xcode将会添加HomeKit权限到你的工程授权文件中和会员中心的App ID授权文件中，也会将HomeKit框架添加到你的工程中。HomeKit 需要一个明确的App ID, 这个App ID是为了你完成这些步奏而创建的。
启用HomeKit的步骤如下：
在Xcode中，选择View > Navigators > Show Project Navigator。
从Project/Targets弹出菜单中target（或者从Project/Targets的侧边栏）
点击Capabilities查看你可以添加的应用服务列表。
滑到HomeKit 所在的行并打开关。
下载HomeKit Accessory Simulator
无需为了开发Homekit 应用程序而购买硬件产品。你可以使HomeKit Accessory Simulator来测试HomeKit app和模拟配件设备之间的通信。HomeKit Accessory Simulator不是和Xcode一起发布的。
下载HomeKit Accessory Simulator步骤如下：
在Capabilities面板的HomeKit分区，点击Download HomeKit Accessory
Simulator按钮。（或者选择Xcode > Open Developer Tool > More Developer Tools）
在浏览器中搜索并且下载"Hardware IO Tools for Xcode ".dmg文件。
在Finder中双击~/Downloads中的.dmg文件。
把HomeKit Accessory Simulator拖拽到/Application文件中。
之后，你将可以使用HomeKit Accessory Simulator测试你的HomeKit应用程序，正如Testing YourHomeKit App（第30页）中描述的那样。
第三部分：创建Home布局
HomeKit 允许用户创建一个或者多个Home布局。每个Home（HMHome）代表一个有网络设备的住所。用户拥有Home的数据并可通过自己的任何一台iOS设备进行访问。用户也可以和客户共享一个Home，但是客户的权限会有更多限制。被指定为primary home的home默认是Siri指令的对象，并且不能指定home。
每个Home一般有多个room，并且每个room一般会有多个智能配件。在
home(HMHome) 中，每个房间是独立的room，并具有一个有意义的名字，例如“卧室”或者“厨房”，这些名字可以在Siri 命令中使用。一个accessory（HMAccessory）代表实际家庭中的自动化设备，例如车库开门器。一个sevice（HMService）是accessory 提供的?种实际服务，例如打开或者关闭车库，或者车库上的灯。
如果你的app 缓存了home布局的信息，那么当其布局发声改变的时候，app就需要更新这些信息。使用HMHomeManager对象可以从HomeKit数据库获取HMHome和其他相关的对象。本章描述的API获取对象后，你应该通过代理回调函数保持获取对象和HomeKit数据库同步，具体描述请参看“Observing HomeKit Database Changes".创建Home Manager对象
使用Home Manager—一个HMHomeManager对象的访问home、room、配件、服务以及其他HomeKit对象。在创建家庭对象管理器（home manager）之后，直接设置它的代理，以便获取到这些对象之后及时的通知到你。
1
2 self.homeManager = [[HMHomeManager alloc] init]; self.homeManager.delegate = self;
当你创建一个home manager对象时，HomeKit就开始从HomeKit数据库获取这些homes和相关对象，例如room和accessory对象。当HomeKit正在获取那些对象时，home manager 的primaryHome属性是nil，并且homes属性是个空数组。你的app应该处理用户还没有完成创建home的情况，但是app应该等待直到HomeKit完成初始化。当获取对象完成之后，HomeKit 会发送homeManagerDidUpdateHomes:消息给home manager的代理。
注意：当app进入前台或者在后台Home manager属性发生改变时，这个homeManagerDidUpdateHomes：方法就会被调用，详情请参阅“Observing Changes to the Collection of Homes”。
获取Primary Home和Homes集合
通过home manager的primaryHome属性，可以得到primary home，代码如下：
1 HMHome *home = self.homeManager.primaryHome;
使用home manager的homes属性可以得到用户的所有home的集合；例如自家主要居所、度假别墅以及办公室。每个home都对应一个独立的home对象。
1
2
3 HMHome *home;
for(home in self.homeManager.homes ){ …}
获取Home中的所有room
在一个home中，rooms属性定义accessories的物理位置。用home的rooms属性可以枚举home中的所room。
1
2
3
4
5 HMHome *home = self.homeManager.primaryHome; HMRome *room;
for(room in home.rooms){
…
}
获取Room 中的Accessories
Accessories 数组属于home，但是被指定给了home中的room。假如用户没有给一个accessory指定room，那么这个accessories被指定一个默认的room ,这个room是roomForEntireHome方法的返回值。用room的accessories属性可以枚举room中所有的accessory。代码如下：
1
2
3
4 HMAccessory *accessory;
for(accessory in room.accessories){ …
}
如果你要展示一个个accessory的相关信息或者允许用户控制它，可设置accessory的代理方法并实现这个代理方法，详情请见“Observing Changes to Accessories”.
一旦你获取到一个accessory对象，你就可以访问它的服务和对象，详情请参阅“Accessing Services and Characteristics”。获取Home中的Accessories属性
使用HMHome类中的accessories的方法，可以直接从Home对象中获取所有的accessory对象，而不用枚举home中的所有room对象（详情请见“Getting the Accessories in a Room”。
第四部分：创建Homes和添加Accessories
HomeKit对象被保存在一个可以共享的HomeKit数据库里，它可以通过HomeKit框架被多个应英程序访问。所有HomeKit调用的方法都是异步写入的，并且这些方法都包含一个完成处理后的参数。如果这个方法处理成功了，你的应用将会在完成处理函数里更新本地对象。应用程序启动时，HomeKit对象发生改变的并不能收到代理回调?法，只能接受处理完成后的回调函数。
想要观察其他应用程序启动时HomeKit对象的变化，请参阅：Observing HomeKit Database Changes。查阅异步消息完成处理后传过来的错误码的信息，请参阅：HomeKit Constants Reference.
对象命名规则
HomeKit对象的名字，例如home、room和zone对象都可以被Siri识别，这一点已经在文档中指出。以下几点是HomeKit对象的命名规则：
对象名字在其命名空间内必须是唯一的。
属于用户所有的home名字都在一个命名空间内。
一个home对象及其所包含的对象在另一个命名空间内。
名字只能包含数字、字母、空格以及省略号字符。
名字必须以数字或者字母字符开始。
在名字比较的时候,空格或者省略号是忽略的（例如home1和home 1 同一个名字）。
名字没有大小写之分。
想了用户可以使用哪些语言与Siri进行交互，请参阅HomeKit User Interface Guidelines 文档中的"Siri Integration"
创建Homes
在HMHomeManager类中使用addHomeWithName:completionHandler: 异步方法可
以添加一个home。作为参数传到那个方法中的home的名字，必须是唯一独特的，并且是Siri可以识别的home名字。
1
2
3
4
5
6
7 [self.homeManager addHomeWithName:@"My Home" completionHandler:^(HMHome *home, NSError *error) { if (error != nil) {
// Failed to add a home
} else {
// Successfully added a home
} }];
在else语句中，写入代码以更新你应的程序的视图。为了获取home manager对象，请参阅Getting the Home Manager Object.
在Home中增加一个Room
使用addRoomWithName:completionHandler: 异步方法可以在一个home中添加一个room对象。作为参数传到那个方法中的room的名字，必须是唯一独特的，并且是Siri 可识别的room名字。
1
2
3
4
5
6
7
8 NSString *roomName = @"Living Room";
[home addRoomWithName:roomName completionHandler:^(HMRoom *room, NSError *error) {
if (error != nil) {
// Failed to add a room to a home
} else {
// Successfully added a room to a home
} }];
在else语句中，写入代码更新应用程序的视图。
发现配件
Accessories封装了物理配件的状态，因此它不能被用户创建。想要允许用户给家添加新的配件，我们可以使HMAccessoryBrowser对象找到一个与home没有关联的配件。HMAccessoryBrower对象在后台搜寻配件，当它找到配件的时候，使用委托来通知你的应用程序。只有在startSearchingForNewAccessories方法调用之后或者stopSearchingForNewAccessories方法调用之前，HMAccessoryBrowserDelegate消息才被发送给代理对象。
发现home中的配件
1. 在你的类接口中添加配件浏览器委托协议，并且添加一个配件浏览器属性。代码如下：
1
2
3 @interface EditHomeViewController ()
@property HMAccessoryBrowser *accessoryBrowser; @end
用你自己的类名代替EditHomeViewController 2. 创建配件浏览器对象，并设置它的代理
1
2 self.accessoryBrowser = [[HMAccessoryBrowser alloc] init]; self.accessoryBrowser.delegate = self;
3. 开始搜寻配件
1 [self.accessoryBrowser startSearchingForNewAccessories];
4. 将找到的配件添加到你的收藏里
1
2 --‐ (void)accessoryBrowser:(HMAccessoryBrowser *)browser didFindNewAccessory:(HMAccessory *)accessory {
3
4
5
6
7 // Update the UI per the new accessory; for example, reload a picker
view.
[self.accessoryPicker reloadAllComponents];
}
用你自己的代码实现上面的accessoryBrowser:didFindNewAccessory:方法。当然也可以实现accessoryBrowser:didRemoveNewAccessory:这个方法来移除配件，这个配件对你的视图或者收藏来说不再是新的。
5. 停止搜寻配件
如果一个视图控制器正在开始搜寻配件，那么可以通过重写viewWillDisappear:方法来停止搜寻配件。代码如下：
1
2
3 --‐ (void)viewWillDisappear:(BOOL)animated {
[self.accessoryBrowser stopSearchingForNewAccessories]; }
注意：在WiFi网络环境下，为了安全地获取新的并且能够被HomeKit发现的无线配件，请参阅External Accessory Framework Reference.
为Home和room添加配件（Accessory）
配件归属于home，并且它可以被随意添加到home中的任意一个room中。使用addAccessory:completionHandler:这个异步方法可以在home中添加配件。这个配件的名字作为一个参数传递到上述异步方法中，并且这个名字在配件所属的home中必须是唯一的。使用assignAccessory:toRoom:completionHandler:这个异步方法可以给home中
的room添加配件。配件默认的room是roomForEntireHome这个方法返回值room。下面的代码演示了如何给home和room添加配件:
1
2
3
4
5
6
7
8
9
10
11 // Add an accesory to a home and a room
// 1. Get the home and room objects for the completion handlers.
__block HMHome *home = self.home;
__block HMRoom *room = roomInHome;
// 2. Add the accessory to the home
[home addAccessory:accessory completionHandler:^(NSError *error) {
if (error) {
// Failed to add accessory to home
} else {
12
13
14
15
16
17
18
19
20
21 if (accessory.room != room) {
// 3. If successfully, add the accessory to the room
[home assignAccessory:accessory toRoom:room completionHandler:^(NSError *error) {
if (error) {
// Failed to add accessory to room
} }];
} }
}];
配件可提供一项或者多项服务，这些服务的特性是由制造商定义。想了解配件的服务和特性目的，请参阅Accessing Services and Characteristics.
更改配件名称
使用updateName:completionHandler:异步方法可以改变配件的名称，代码如下：
1
2
3
4
5
6
7
8 [accessory updateName:@"Kid's Night Light" completionHandler:^(NSError *error) {
if (error) {
// Failed to change the name
} else {
// Successfully changed the name
}
}];
为Homes和Room添加Bridge（桥接口）
桥接口是配件中的一个特殊对象，它允许你和其他配件交流，但是不允许你直接和HomeKit交流。例如一个桥接口可以是控制多个灯的枢纽，它使用的是自己的通信协议，而不是HomeKit配件通信协议。想要给home添加多个桥接口，你可以按照Adding Accessories to Homes and Rooms中所描述的步骤，添加任何类型的配件到home中。当你给home添加一个桥接口时，在桥接口底层的配件也会被添加到home中。正如Observing HomeKit Database Changes中所描述的那样，每次更改通知设计模，home 的代理不会接收到桥接口的home:didAddAccessory: 代理消息，而是接收一个有关于配件的home:didAddAccessory:代理消息。在home中，要把桥接口后的配件和任何类型的配件看成一样的--例如，把它们加入配件列表的配置表中。相反的是，当你给room 增添一个桥接口时，这个桥接口底层的配件并不会自动地添加到room中，原因是桥接口和它的的配件可以位于到不同的room中。
创建分区
分区(HMZone) 是任意可选的房间（rooms）分组；例如楼上、楼下或者卧室。房间可以被添加到一个或者多个区域。
可使用addZoneWithName:completionHandler: 异步方法创建分区。所创建的作为参数传递到这个方法中分区的名称，在home中必须是唯一的，并且应该能被Siri识别。代码如下：
1
2
3
4
5
6
7
8
9
10
11 __block HMHome *home = self.home;
NSString *zoneName = @"Upstairs";
[home addZoneWithName:zoneName completionHandler:^(HMZone *zone, NSError *error)
{
if (error) {
// Failed to create zone
} else {
// Successfully created zone, now add the rooms
}
}];
可使用addRoom:completionHandler:异步方法给分区添加一个room，代码如下：
1
2
3
4
5
6 __block HMRoom *room = roomInHome;
[zone addRoom:room completionHandler:^(NSError *error) { if (error) {
// Failed to add room to zone
} else {
// Successfully added room to zone
7 } }];
第五部分：观察HomeKit数据库的变化
每个Home都有一个HomeKit数据库。如下图所示，HomeKit数据库会安全地和home 授权的用户的iOS设备以及潜在的客人的iOS设备进行同步。为了给用户展示当前最新的数据，你的应用需要观察HomeKit数据库的变化。
HomeKit代理方法
HomKit使用代理设计模式（delegation design pattern）来通知应用程序HomeKit对象的改变。一般来讲，如果你的应用程序调用了一个带有完成处理参数的HomeKit方法，并且这个方法被成功调用了，那么相关联的代理消息就会被发送给其他HomeKit应用，无论这些应用是安装在同一台iOS设备上还是远程iOS设备上。这些应用甚至可以运行在客人的iOS设备上。如果你的应用发起了数据改变，但是代理消息并没有发送到你的应用，那么添加代码到完成处理方法和相关联的代理方法中来刷新数据和更新视图就成为必须了。如果home布局发生了显著变化，那么就重新加载关于这个home的所有信息。在完成程序处理的情况下，请在更新应用之前检查那个方法是否成功。Homkit 也会调用代理方法来通知你的应用程序home网络状态的改变。
例如，下图演示了使用代理方法的过程：响应用户的操作，你的应用程序调用了addRoomWithName:completionHandler:方法，并且没有错误发生，完成处理程序应当更新home的所有视图。如果成功了，homeKit将会发送home:didAddRoom:消息给其他应用中homes的代理。因此，你实现的这个home:didAddRoom:方法也应该更新home的所有视图。
应用程序只有在前台运行的时候才能接受代理消息。当你的应用在后台时，HomeKit 数据库的改变并不会成批处理。也就是说，如果你的应用在后台，当其他的应用成功地添加一个room到home中的时候，你的应用程序并不会接收到
home:didAddRoom: 消息。当你的应用程序到前台运行时，你的应用程序将会接收到homeManagerDidUpdateHomes:消息，这个消息是表示你的应用程序要重新加载所有的数据。
观察Homes集合的改变
设置home manager的代理并且实现HMHomeManagerDelegate协议，当primary home或者home集合发生改变时，可以接收代理消息。
所有的应用都需要实现homeManagerDidUpdateHomes:方法，这个方法在完成最初获取homes之后被调用。对新建的home manager来说，在这个方法被调用之前，primaryHome属性的值是nil，homes数组是空的数组。当应用程序开始在前台运行时也会调用homeManagerDidUpdateHomes:方法，当其在后台运行时数据发生改变。该homeManagerDidUpdateHomes:方法会重新加载与homes相关联的所有数据。
观察homes的变化
1.在你的类接口中添加HMHomeManagerDelegate代理和homeManager属性。代码如下：
1
2 @interface AppDelegate () @property (strong, nonatomic) HMHomeManager
@end
2.创建home manager对象并设置其代理
1
2
3
4
5
6
7 --‐ (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {
self.homeManager = [[HMHomeManager alloc] init];
self.homeManager.delegate = self;
return YES;
}
3. 实现homes发生改变时调用的代理方法。例如：如果多个视图控制器展示了homes 相关信息，你可以发布一个更改通知去更新所有视图。
1
2
3
4
5
6
7
8
9
10
11
12
13 --‐ (void)homeManagerDidUpdateHomes:(HMHomeManager *)manager { // Send a notification to the other objects [[NSNotificationCenter defaultCenter] postNotificationName:@"UpdateHomesNotification"
object:self];
}
--‐ (void)homeManagerDidUpdatePrimaryHome:(HMHomeManager
*)manager {
// Send a notification to the other objects [[NSNotificationCenter defaultCenter] postNotificationName:@"UpdatePrimaryHomeNotification" object:self];
}
视图控制器注册更改通知并且执行适当的操作。
1
2
3
4
5
6
7 [[NSNotificationCenter defaultCenter] addObserver:self selector:@selector(updateHomes:)
name:@"UpdateHomesNotification"
object:nil];
[[NSNotificationCenter defaultCenter] addObserver:self selector:@selector(updatePrimaryHome:)
name:@"UpdatePrimaryHomeNotification" object:nil];
观察个别home的变化
展示home信息的视图控制器应该成为home对象的代理，并且当home发生改变时更新视图控制器的视图。
观察特定home对象的改变
1.在类接口中添加home代理协议。
1 @interface HomeViewController () @end
2.设置配件代理
1 home.delegate = self;
3.实现HMHomeDelegate协议
例如：实现home:didAddAccessory:和home:didRemoveAccessory: 方法来更新展示配件的视图。用HMAccessory类的room属性可以获得配件所属的room。（对配件来说，默认的room是roomForEntireHome这个方法的返回值。）
Bridge Note:当你为home添加桥接口时，桥接口底层的配件会自动被添加到home中。你的代理会接收到桥接口后每个配件的home:didAddAccessory:消息，但是你的代理不会接收到桥接口的home:didAddAccessory:消息。
观察配件的变化
配件的状态可以在任何时间发生变化。配件可能不能被获得，可以被移除，或者被关闭。请更新用户界面以反映配件状态的更改，尤其是如果你的app允许用户控制配件时。这以下步骤中，我们假设你已经从HomeKit数据库中检索到了配件对象，正如Getting the Accessories in a Room中描述的那样。
观察个别配件的变化
在类接口中添加配件代理协议。
1
2 @interface AccessoryViewController () @end
2. 设置配件的代理
1 accessory.delegate = self;
3. 实现HMAccessoryDelegate 协议
比如，执行accessoryDidUpdateReachability:方法以启用或者禁用配件控制。
1
2
3
4
5
6
7 --‐ (void)accessoryDidUpdateReachability:(HMAccessory *)accessory { if (accessory.reachable == YES) {
// Can communicate with the accessory
} else {
// The accessory is out of range, turned off, etc
}
}
如果你展示了配件的服务状态和特性，那么请执行以下代理方法来相应地更新其视图：accessoryDidUpdateServices:
accessory:service:didUpdateValueForCharacteristic:
想了解配件的服务，请参阅Accessing Services and Their Characteristics.
第六部分：访问服务和特性
服务(HMService)代表了一个配件(accessory)的某个功能和一些具有可读写的特性(HMCharacteristic)。一个配件可以拥有多项服务,一个服务也可以有很多特性。比如一个车库开门器可能拥有一个照明和开关的服务。照明服务可能拥有打开/关闭和调节亮度的特性。用户不能制造智能家电配件和它们的服务-配件制造商会制造配件和它们的服务-但是用户可以改变服务的特性。一些拥有可读写属性的特性代表着某种物理状态，比如，一个恒温器中的当前温度就是一个只可读的值，但是目标温度又是可读写的。
苹果预先定义了一些服务和特性的名称，以便让Siri能够识别它们。
获得配件的服务和属性
在依照Getting the Accessroties in a Room中描述，你创建了一个配件对象之后,你可
以获得配件的服务和特性。当然你也可以直接从home中按照类型获得不同的服务。
重要:不要暴露匿名服务-比如固件升级服务-给用户
通过HMAccessory类对象的services属性，我们可以获得一个配件的服务。
1 NSArray *services = accessroy.services;
要获得一个home当中配件提供的特定服务，使用HMHome类对象的servicesWithTypes:方法。
1
2
3 // Get all lights and thermostats in a home
NSArray *lightServices = [home servicesWithTypes:[HMServicesTypeLight NSArray *thermostatServices = [home servicesWithTypes:[HMServicesType
使用HMServices类对象的name属性来获得服务的名称
1 NSString *name = https://www.sodocs.net/doc/6417117418.html,;
要获得一个服务的特性，请使用characteristics属性。
1 NSArray *characteristics = service.characteristics
使用servicesType属性来获得服务的类型
NSString *serviceType = service.serviceType;
苹果定义了一些服务类型，并能被Siri识别:
门锁(Door locks)
车库开门器(Garage door openers)
灯光(Lights)
插座(Outlets)
恒温器(Thermostats)
改变服务名称
使用updateName:completionHandler:异步方法来改变服务名称。传入此方法的服务名称参数必须在一个home当中是唯一的，并且服务名可被Siri识别。
1
2
3
4
5
6
7 [service updateName:@"Garage 1 Opener" completionHandler:^(NSError *e if (error) {
// Failed to change the name
} else {
// Successfully changed the name
}
}];
访问特性的值
特性代表了一个服务的一个参数，它要么是只读、可读写或者只写。它提供了这个参数可能的值的信息，比如，一个布尔或者一个范围值。恒温器中的温度就是只读的，而目标温度又是可读写的。一个执行某个任务的命令且不要求任何返回-比如播放一段声音或者闪烁一下灯光来确认某个配件-可能就是只写的。
苹果定义了一些特性的类型，并能被Siri识别:
亮度(Brightness)
最近温度(Current temperature)
锁的状态(Lock state)
电源的状态(Power state)
目标状态(Target state)
目标温度(Target temperature)
比如，对于一个车库开门器来说，目标状态就是打开或者关闭。对于一个锁来说，目标状态又是上锁和未上锁。
在你获得了一个HMService对象之后,如Getting Services and Their Properties所描述的,你可以获得每个服务的特性的值。因为这些值是从配件中获得的，这些读写的方法都是异步的，并可以传入一个完成回调的block。
使用readValueWithCompletionHandler:异步方法来读取一个特性的值。
1
2
3
4
5
6
7
8 [characteristic readValueWithCompletionHandler:^(NSError *error) { if (error == nil) {
// Successfully read the value
id value = characteristic.value;
}
else {
// Unable to read the value
} }];
在if语句块中，加入你的代码以更新app的视图。
使用writeValue:completionHandler:异步方法来向一个特性写入值。
1
2
3
4
5
6
7 [self.characteristic writeValue:@42 withCompletionHandler:^(NSError * if (error == nil) {
// Successfully wrote the value
}
else {
// Unable to write the value
} }];
不要以为函数调用完成就意味着写入成功，实际上只有在当完成回调执行并没有错误产生时才表示写入成功。比如，直到一个开关的特性改变之前都不要改变这个开关的状态。在if语句块中，加入你的代码，以更新app的视图。
另外，在别的app更新了特性的值时也需要更新视图，在Observing Changes to Accessories中有描述。
创建服务组
一个服务组(HMServiceGroup)提供了控制不同配件的任意数量服务的快捷方式-比如，当用户离开家之后控制家中的某些灯。
在你创建了一个HMHome对象之后,如Getting the Primary Home and Collection of Homes中描述,你也就在这个家中创建一个服务组。
为了创建一个服务组,我们使用HMHome类对象的addServiceGroupWithName:completionHandler:方法。方法中参数服务组的名称必须在此家中唯一，并可以被Siri识别。
1
2 [self.home addServiceGroupWithName:@"Away Lights" completionHandler:^ if
(error == nil) {
3
4
5
6 // Successfully created the service group } else {
// Unable to create the service group
}];
我们使用HMServiceGroup类对象的addService:completionHandler:方法来向服务组中添加一个服务。服务可以在一个或多个服务组中。
1
2
3
4
5
6 [serviceGroup addService:service completionHandler:^(NSError *error) if (error == nil) {
// Successfully added service to service group
}
// Unable to add the service to the service group
}];
通过HMHome类对象的serviceGroups属性，来获得这个家的所有服务组。
1 NSArray *serviceGroups = self.home.serviceGroups;
通过HMServiceGroup类对象的accessory属性，我们获得服务所对应的智能电器。
1 HMAccessory *accessory = service.accessory;
和配件类似，代理方法在别的app改变服务组时也会被调用。如果你的app使用了服务组，请阅读HMHomeDelegate Protocol Reference文档，获悉你应该实现哪些方法以观察这些变化。
第七部分：测试HomeKitApp
如果你没有智能电器(智能配件），你可以使用HomeKit Accessroy Simulator来模拟home中的智能电器。每个模拟配件都拥有服务和特性，你可以从你的App当中控制它。你的App在HomeKit数据库中创建对象和关系。它可以创建home布局，可以添加新的配件到模拟的home环境当中，最后向home中的每个房间添加智能配件。然后，你的app就能控制这些在HomeKit Accessory Simulator展示的模拟智能配件了。为了使用HomeKit Accessory Simulator，请在iOS模拟器中运行你的应用程序，或者使用Xcode 在iOS设备上运行应用程序。
HomeKit Accessory Simulator是一个附加的开发者工具，不过并没有安装在Xcode当中。请按照Download HomeKit Accessory Simulator中所述的安装HomeKit Accessory Simulator。
添加智能电器（配件）
使用HomeKit Accessory Simulator来添加智能电器到模拟网络中。
向网络中添加智能电器配件，请按照下面的步骤添加：
在HomeKit Accessory Simulator中，点击底部左边‘+’按钮。
从弹出菜单中选择添加智能电器(Add Accessory)
输入智能电器的名字和制造商。
4. 点击完成
如果想删除一个智能电器，请选择一个智能电器然后点击键盘上的Delete键。
向智能电器（配件）中添加服务
一个智能电器需要一项服务和特性，你可以从app控制它。从预定义了服务列表中选择一项服务，并自定义特性。
按照下面步骤向智能电器中添加服务
在HomeKit Accessory Simulator中，选择Accessories列中的某个配件。
该配件的服务信息会展示在一个详情界面中。
注意:所有智能电器都有一个Accessory Information，显示在所有其他服务的下方。你可以向这个Accessory Information服务添加特性，但你不能删除默认的特性。
2. 点击添加服务(Add Service)，并从弹出视图中选择一个服务类型。
新添加的服务会在右边详细显示。HomeKit Accessory Simulator为每种服务创建通用的特性。比如一个灯光服务的默认特性为色彩(Hue)，饱和度(Saturation)，亮度(Brightness)和开关。(开关特性和电源状态特性是一样的,正如 Accessing Values of Characteristics中描述的那样。）一些特性是强制性的有一些也是可选择的。比如，开关特性就是强制性的，而色彩，饱和度，亮度这些特性都是可选择的。
软件详细设计文档模板(最全面)
研发生产中心文档编号版本A1 密级商密A 项目名称Xx系统 项目来源 Xxx系统 详细设计说明书 (内部资料请勿外传) 编写：日期：检查：日期：审核：日期：批准：日期： XX公司 版权所有不得复制 文档变更记录
序号变更（+/-）说明作者版本号日期批准1 2
目录 1. 引言 (5) 1.1 编写目的和范围 (5) 1.2 术语表 (5) 1.3 参考资料 (5) 1.4 使用的文字处理和绘图工具 (5) 2. 全局数据结构说明 (7) 2.1 常量 (7) 2.2 变量 (8) 2.3 数据结构 (8) 3. 模块设计 (9) 3.1 用例图 (9) 3.2 功能设计说明 (10) 3.2.1 模块1 (10) 3.2.2 模块2 (11) 4. 接口设计 (12) 4.1 内部接口 (12) 4.2 外部接口 (12) 4.2.1 接口说明 (12) 4.2.2 调用方式 (12) 5. 数据库设计 (12) 6. 系统安全保密设计 (12) 6.1 说明 (12) 6.2 设计 (12) 6.2.1 数据传输部分 (12) 6.2.2 IP过滤分部 (13) 6.2.3 身份验证部分 (13) 7. 系统性能设计 (13) 8. 系统出错处理 (13)
1.引言 1.1背景 此文档的背景 1.2编写目的和范围 说明写这份详细设计说明书的目的。 本详细设计说明书编写的目的是说明程序模块的设计考虑，包括程序描述、输入/输出、算法和流程逻辑等，为软件编程和系统维护提供基础。本说明书的预期读者为系统设计人员、软件开发人员、软件测试人员和项目评审人员。 1.3术语表 定义系统或产品中涉及的重要术语，为读者在阅读文档时提供必要的参考信息。 序号术语或缩略语说明性定义 1 PM Project Manager,项目经理 2 1.4参考资料 列出有关资料的名称、作者、文件编号或版本等。参考资料包括： a．需求说明书、架构设计说明书等； b．本项目的其他已发表的文件； c．引用文件、资料、软件开发标准等。 资料名称作者文件编号、版本资料存放地点 1.5使用的文字处理和绘图工具 文字处理软件：[编写设计文档使用的文字处理软件，如RedOffice ] 绘图工具：[使用的UML工具，如Rose、Jude、Visio]
软件开发文档范例
文档编号：_________ _________ 文档名称：____________ 项目名称：____________ 项目负责人：____________ 编写：___________ ____年__月__日 校对：___________ ____年__月__日 审核：___________ ____年__月__日 批准：___________ ____年__月__日
开发单位：传讯网络信息 ________________________ 系统规格说明 一、系统功能和目标： 随着因特网的不断普及，国的用户数呈指数级增长。作为因特网最为常用的电子系统越来越受到人们的喜爱，为了满足不断增长的信息交换的需要，各行各业都希望有自己的系统。传讯网络信息自主设计开发了适合中国国情的免费电子系统，用以解决这一日益突出的问题。CHINATION 免费电子系统是专为免费电子服务商、企业集团设计的电子系统。 Chination免费电子系统的设计目标是立足于一个高度集成的、功能强大、技术先进的电子系统。高度集成意味着本系统将把硬盘软件集成在一起。系统是基于LINUX下的，硬盘和软件的集成使得系统具有绝对的安装优势。功能强大意味着系统的实用性，功能的全面性，系统的安全性和可靠性。技术先进意味着将最新版本的LDAP，IMAP，POSTFIX，MYSQL，APACHE和PHP的巧妙结合。 本系统要实现的主要功能有：
1．用户申请注册功能。用户通过申请可以得到一个自己命名的信箱，容量大小为10M。 2．用户忘记密码处理功能。用户忘记密码可以通过注册时设置的密码提示问题来重设密码。 3．用户收功能。它包括SMTP收、POP3取和WWW读三种方式。 4．用户发功能。它包括SMTP发、WWW直接发送、暗送、抄送、定时发送。 5．用户信件处理功能。系统初始设置4个文件夹来分类处理信件：收件箱、发件箱、草稿箱和垃圾箱。用户还可以自己建立新的文件夹。信件在各个信箱之间可以相互移动。 6．用户查找功能。用户可以使用查找功能通过查找信件主题或信件容来找到自己需要的信件。 7．用户信箱配置设置。它包括个人资料更改、密码更改、参数设置、POP3服务器设置、过滤器设置、自动转信、定时发信、签名设置。 8．管理员管理用户和信箱功能。包括输入（增删改）、查询、统计、报表。系统性能参数设置。 9．广播功能。它用于公司定期向一定的用户发送信息，由于一般的用户数有一定数量，所以必须用数据库管。 二、可行性分析 1．技术可行性 本软件拟决定最终在分布式系统上来运行。硬件方面，由于传讯网络信息是国外多家公司并行处理产品的代理商，而且自己本身拥有ALPHA机等先进设备，所以有足够能力开发出先进的电子系统。软件方面，我们拟采用以下几种软件： 1）操作系统用LINUX。Linux作为一个优秀的网络操作系统，它的发行版本中集成了大量的网络应用软件，如Web服务器(apache)、Ftp服务器(wu-ftp)、服务器(sendmail+imap4)、SQL数据库(postgresql)等，可以快速的构建Intranet环境，并且也有精致的收发程序(metamail)和强大的Web 服务器端开发工具(PHP4)。当你配置好sendmail并激活imapd后，你的Linux用户都可以使用Outlook等客户端软件进行收发，只要通过将它们集中进行应用，便可以实现一个简单的Webmail 服务器的功能。但是随着自由软件的不断开发，要构架一个好的电子系统，就面临着软件选择是否适当、性能是否比别人好的问题。下面列出我们所使用的软件。 2）本系统壳软件用imap。有几种方法可以构造电子系统的壳：共享文件系统的策略，基于局域网的专用协议，X.400P7协议和因特网消息存取协议。而基于INTERNET的协议主要有：POP (Post Office Protocol), DMSP (Distributed Mail System Protocol), 和IMAP (Internet Message Access Protocol).POP是最原始，最为人们所知的一种。DMSP仅局限于一个简单应用——PCMAIL，它的优点主要在于对脱机状态操作的支持。IMAP不但继承了POP和DMSP的优点，而且超越了他们的缺点，提供了三种状态下对远程信箱的访问：在线、不连接和脱机状态。在脱机状态，可以发送到一个共享的服务器，但是客户并不是马上全部把它们COPY过去之后在服务器上删掉它们，
公司技术文档格式规范
目录 一、页边距设置 (3) （一）、装订 (3) （二）、不装订 (3) 二、页面布局设置 (3) 三、目录 (3) （一）、目录选择 (3) （二）、字体 (3) （三）、段落 (3) 四、标题 (4) （一）、“字体”设置 (4) 1、主标题 (4) 2、副标题 (4) （二）、“段落” (4) 五、结构编号 (4) （一）、形式 (4) （二）、字体、段落 (5) 1、一级编号 (5) （1）、“字体” (5) （2）、“段落” (5) 2、二级编号 (5) （1）、“字体” (5) （2）、“段落” (5) 3、三级编号 (6) （1）、“字体” (6) （2）、“段落” (6) 4、四级编号 (6) （1）、“字体” (6) （2）、“段落” (6) 六、正文 (7) （一）、字体 (7) （二）、段落 (7)
（三）、落款、日期、签名规定 (7) （四）、图片 (7) （五）、附件 (9) 七、表格 (10) （一）、Excel电子表格。 (10) 1、页边距 (10) 2、标题 (10) 3、内容 (10) （1）、表头 (10) （2）、内容 (10) 4、列宽 (10) （二）、Word表格 (10) 八、页眉页脚 (11) （一）、格式 (11) （二）、内容 (11) 1、页眉 (11) 2、页脚 (12)
公司技术文档格式规范一、页边距设置 （一）、装订 纵向：上3cm，下2.5cm，左2.7cm，右2.5cm。 横向：上3cm,下2.5cm，左2.5cm，右2.5cm。 （二）、不装订 纵向：上3cm，下2.5cm，左2.5cm，右2.5cm。 横向：上3cm,下2.5cm，左2.5cm，右2.5cm。 二、页面布局设置 布局——页面设置——文档网格 选择“指定文档网格”，设置行数为每页40行。 三、目录 （一）、目录选择 使用引文目录，自动目录1. （二）、字体 “目录”两字：字体，宋体；字形，加粗；字号，四号。居中目录内容：字体，宋体；字形，不加粗；字号，五号。（三）、段落 自定义目录选项下修改目录段落格式。
软件开发设计文档模板
软件开发设计文档
文档管理信息表 主题在线考试系统 版本 1.0 内容基于web的在线考试系统 关键字MVC模式在线考试考生.题库管理 参考文档JSP实用教程（第二版）清华大学出版社（耿祥义.张跃平编著）创建时间2016/7/4 最新发布日期2016/7/6 目录 1 引言 (1) 1.1设计背景 (3) 1.2编写目的 (4) 1.3系统概述 (4) 2开发规划 (4) 2.1开发人员 (4) 2.2开发计划 (4) 2.3开发环境和工具 (5) 3开发设计 (6) 3.1 需求概述 (6) 3.2 软件结构 (7) 3.3基本设计描述 (9) 3.3.1系统总体逻辑结构图 (8) 3.3.2系统部署结构图 (9) 3.4主要界面描述.......................................................................................................错误！未定义书签。 3.4.1用户打开界面............................................................................... 错误！未定义书签。 3.4.2答题界面....................................................................................... 错误！未定义书签。 3.4.2结果显示界面............................................................................... 错误！未定义书签。 3.5模块列表................................................................................................................错误！未定义书签。4数据结构........................................................................................................ 错误！未定义书签。5模块设计. (13) 5.1JSP编辑模块.......................................................................................... 错误！未定义书签。
技术设计方案文档模板V1.0
《基于智能手机设计（短信功能）的设计》技术设计方案
文档修订记录
一、项目名称 《基于智能手机设计（短信功能）的设计》 二、设计要求及性能指标 设计一个基于单片机及虚拟键盘控制的可实现发送和接收短信的3G模块。选用STC15W4K48S4单片机作为主控芯片进行设计和实现。具体任务包括编写单片机程序和通过触摸屏上的虚拟键盘，控制3G模块实现发送和接收短信功能、显示发信人的号码等。具体要求如下： 1．LC6311(+)3G 模块AT 指令中短信发送指令介绍。 2．通过AT 指令控制3G 模块实现短信收发功能。 三、项目总体方案设计 1、系统总体方案（分析项目要求和指标，给出总的设计方案，画出项目设计的方框图，详细分析设计方案及其工作原理。）根据课程设计的要求，系统设计方案如下：以STC15W4K48S4单片机作为主控芯片，采用触摸屏实现虚拟键盘，及3G模块连接天线、安装移动sim卡组成智能手机硬件部分，（以7805稳压管构成电源电路）。 图一、智能手机（短信功能）系统结构框图
短信收发就是能够实现给已入网的手机发送短信，同时能接收短信及显示发信人的号码的功能。为了实现这样的功能，就需要触摸屏模块，这类似于手机上的显示屏和模拟键盘，而接收和发送信息都需要经过有信息处理功能的微处理器和实现收发信息功能的3G模块。此外还需要电源模块来提供能量。 系统的基本原理： 1.短信的发送：触摸屏将要发送的信息给微处理器处理后通过3G模块发送出去。 2.短信的接收：3G模块将接收到的信息传送给微处理器来处理，然后将处理结果送到触摸屏执行。 2、关键技术、设计难点及其解决方案（项目中的关键技术是什么？可能会遇到哪些设计难点？你的解决方案是什么？） 难点：触摸区域和要显示文字的区域难以确定 解决方案：通过画圆或矩形来确定要显示的区域，再使用函数实现触摸区域的准确或保证显示要出现的内容，最后删除画圆或矩形的函数。以实现要达到的目的。 四、项目详细方案设计 1、核心器件选型（分析核心器件有哪些？选型的依据和原则是什么？有哪些可以选择的器件？为什么要选择最终的那个器件？) 单片机STC15W4K48S4： 宏晶科技STC15系列单片机STC15W4K48S4，是单时钟周期/机器周期（1T）的单片机，是宽电压/高速度/高可靠/低功耗/超强抗干扰的新一代8051单片机，指令代码完全兼容传统8051，但速度快8~12倍。内部集成高精度R/C时钟，8路10位PWM，8路10位A/D转换（30万次/秒），内置4K字节大容量SRAM，4组独立的高速异步串行通信端口（UART1/ UART2/ UART3/ UART4），1组高速同步串行通信端口SPI。 （1）增强型8051CPU，单时钟/机器周期1T ，速度比普通8051快8-12倍（2）内部高精度R/C时钟，ISP编程时内部时钟从5MHz~35MHz可设，本项目选用33.1776 MHz
软件详细设计文档模板(最全面)
Xxx系统 详细设计说明书 (内部资料请勿外传)编写：日期： 检查：日期： 审核：日期： 批准：日期： XX公司 版权所有不得复制 文档变更记录
目录 1. 引言错误!未定义书签。 编写目的和范围错误!未定义书签。 术语表错误!未定义书签。 参考资料错误!未定义书签。 使用的文字处理和绘图工具错误!未定义书签。 2. 全局数据结构说明错误!未定义书签。 常量错误!未定义书签。 变量错误!未定义书签。 数据结构错误!未定义书签。 3. 模块设计错误!未定义书签。 用例图错误!未定义书签。 功能设计说明错误!未定义书签。 模块1 错误!未定义书签。 模块2 错误!未定义书签。 4. 接口设计错误!未定义书签。 内部接口错误!未定义书签。 外部接口错误!未定义书签。 接口说明错误!未定义书签。 调用方式错误!未定义书签。 5. 数据库设计错误!未定义书签。 6. 系统安全保密设计错误!未定义书签。 说明错误!未定义书签。 设计错误!未定义书签。 数据传输部分错误!未定义书签。 IP过滤分部错误!未定义书签。 身份验证部分错误!未定义书签。 7. 系统性能设计错误!未定义书签。 8. 系统出错处理错误!未定义书签。
引言 背景 此文档的背景 编写目的和范围 说明写这份详细设计说明书的目的。 本详细设计说明书编写的目的是说明程序模块的设计考虑，包括程序描述、输入/输出、算法和流程逻辑等，为软件编程和系统维护提供基础。本说明书的预期读者为系统设计人员、软件开发人员、软件测试人员和项目评审人员。 术语表 定义系统或产品中涉及的重要术语，为读者在阅读文档时提供必要的参考信息。 参考资料 列出有关资料的名称、作者、文件编号或版本等。参考资料包括： a．需求说明书、架构设计说明书等； b．本项目的其他已发表的文件； 使用的文字处理和绘图工具 文字处理软件：[编写设计文档使用的文字处理软件，如RedOffice ] 绘图工具：[使用的UML工具，如Rose、Jude、Visio] 设计概述 任务和目标 需求概述 运行环境概述 条件与限制 详细设计方法和工具 系统详细需求分析 主要对系统级的需求进行分析。首先应对需求分析提出的企业需求进一步确认，并对由于情况变化而带来的需求变化进行较为详细的分析。 详细需求分析 详细功能需求分析 详细性能需求分析 详细资源需求分析 详细接口需求分析 详细系统运行环境及限制条件分析 总体方案确认 着重解决系统总体结构确认及界面划分问题。
软件开发文档模版
目录 1. 范围 (1) 2. 总体要求 (1) 2.1总体功能要求 (1) 2.2软件开发平台要求 (1) 2.3软件项目的开发实施过程管理要求 (2) 2.3.1 软件项目实施过程总体要求 (2) 2.3.2 软件项目实施变更要求 (2) 2.3.3 软件项目实施里程碑控制 (2) 3. 软件开发 (3) 3.1软件的需求分析 (3) 3.1.1 需求分析 (3) 3.1.2 需求分析报告的编制者 (4) 3.1.3 需求报告评审 (4) 3.1.4 需求报告格式 (4) 3.2软件的概要设计 (4) 3.2.1 概要设计 (4) 3.2.2 编写概要设计的要求 (4) 3.2.3 概要设计报告的编写者 (4) 3.2.4 概要设计和需求分析、详细设计之间的关系和区别 (4) 3.2.5 概要设计的评审 (4) 3.2.6 概要设计格式 (4) 3.3软件的详细设计 (5) 3.3.1 详细设计 (5) 3.3.2 特例 (5) 3.3.3 详细设计的要求 (5) 3.3.4 数据库设计 (5) 3.3.5 详细设计的评审 (5) 3.3.6 详细设计格式 (5) 3.4软件的编码 (5) 3.4.1 软件编码 (5) 3.4.2 软件编码的要求 (5) 3.4.3 编码的评审 (6) 3.4.4 编程规范及要求 (6) 3.5软件的测试 (6) 3.5.1 软件测试 (6) 3.5.2 测试计划 (6) 3.6软件的交付准备 (6) 3.6.1 交付清单 (6)
3.7软件的鉴定验收 (7) 3.7.1 软件的鉴定验收 (7) 3.7.2 验收人员 (7) 3.7.3 验收具体内容 (7) 3.7.4 软件验收测试大纲 (7) 3.8培训 (7) 3.8.1 系统应用培训 (7) 3.8.2 系统管理的培训（可选） (8) 附录A 软件需求分析报告文档模板 (9) 附录B 软件概要设计报告文档模板 (21) 附录C 软件详细设计报告文档模板 (33) 附录D 软件数据库设计报告文档模板 (43) 附录E 软件测试(验收)大纲 ................................................................... 错误！未定义书签。5
技术文档模板
天境世纪服务器运维应急 预案 内部文件：[1.0] 颁布时间：[2011.7.11]
目录 文件版本说明 (2) 参考资料 (2) 手册目的 (2) 声明 (2) 名词定义和缩略语说明 (2) 1 [输入第一章标题] (3) 1.1 [输入第一章第一节标题] (3) 1.1.1 [输入第一章第一节第一小节标题] (3) 1.1.2 [输入第一章第一节第二小节标题] (3) 1.2 [输入第一章第二节标题] (3) 2 [输入第二章标题] (4) 2.1 [输入第一章第一节标题] (4) 2.2 [输入第一章第二节标题] (5) 表格 表 1-1 [输入表格标题] (3) 表 1-2 [输入表格标题] (3) 图表 图1-1 [输入图片名称] (4) 图2-1 [输入图片名称] (4)
文件版本说明 表 1 版本说明 参考资料 1.[列出参考资料名称] 2.[列出参考资料名称，需增加参考资料项，请在行末回车] 手册目的 [请对撰写本手册目的进行适当描述] 声明 [对本文档内容进行声明] 名词定义和缩略语说明 表 2 名词定义及缩略语说明
1[输入第一章标题] [输入正文] 1.1 [输入第一章第一节标题] [输入正文] 1.1.1[输入第一章第一节第一小节标题] [输入正文] 表 1-2 [输入表格标题] 1.1.2[输入第一章第一节第二小节标题] [输入正文] 1.2 [输入第一章第二节标题] [输入正文]
图1-1 [输入图片名称] 2[输入第二章标题] [输入正文] 2.1 [输入第一章第一节标题] [输入正文] 图2-1 [输入图片名称]
软件架构设计文档模板
广州润衡软件连锁有限公司软件架构设计文档 项目名称 软件架构设计文档 版本
修订历史记录
目录 1.简介5 1.1目的5 1.2范围5 1.3定义、首字母缩写词和缩略语5 1.4参考资料5 1.5概述5 2.整体说明5 2.1简介5 2.2构架表示方式5 2.3构架目标和约束5 3.用例视图6 3.1核心用例6 3.2用例实现6 4.逻辑视图6 4.1逻辑视图6 4.2分层6 4.2.1应用层6 4.2.2业务层7 4.2.3中间层7 4.2.4系统层7 4.3架构模式7 4.4设计机制7 4.5公用元素及服务7 5.进程视图7 6.部署视图7 7.实施视图8 7.1概述8 7.2层8 7.3部署8 8.数据视图8 9.大小和性能8
软件架构设计文档 10.质量8 11.其它说明8 12.附录A 指南8 13.附录B 规范9 14.附录C 模版9 15.附录D 示例9
软件架构设计文档 1.简介 软件构架文档的简介应提供整个软件构架文档的概述。它应包括此软件构架文档的目的、范围、定义、首字母缩写词、缩略语、参考资料和概述 1.1目的 本文档将从构架方面对系统进行综合概述，其中会使用多种不同的构架视图来描述系统的各个方面。它用于记录并表述已对系统的构架方面作出的重要决策 本节确定此软件构架文档在整个项目文档中的作用或目的，并对此文档的结构进行简要说明。应确定此文档的特定读者，并指出他们应该如何使用此文档 1.2范围 简要说明此软件构架文档适用的范围和影响的范围 1.3定义、首字母缩写词和缩略语 本小节应提供正确理解此软件构架文档所需的全部术语的定义、首字母缩写词和缩略语。这些信息可以通过引用项目词汇表来提供 1.4参考资料 本小节应完整地列出此软件构架文档中其他部分所引用的所有文档。每个文档应标有标题、报告号（如果适用）、日期和出版单位。列出可从中获取这些参考资料的来源。这些信息可以通过引用附录或其他文档来提供 1.5概述 本小节应说明此软件构架文档中其他部分所包含的内容，并解释此软件构架文档的组织方式 2.整体说明 2.1简介 在此简单介绍软件架构的整体情况，包括用例视图、逻辑视图、进程视图、实施视图和部署视图的简单介绍。另外，简要介绍各种视图的作用和针对的用户 2.2构架表示方式 本节说明当前系统所使用的软件构架及其表示方式。还会从用例视图、逻辑视图、进程视图、部署视图和实施视图中列出必需的那些视图，并分别说明这些视图包含哪些类型的模型元素 2.3构架目标和约束 本节说明对构架具有某种重要影响的软件需求和目标，例如：安全性、保密性、市售产品的使用、可移植
软件设计文档模板(英文)
Software Design Specification I. Table of Contents I. TABLE OF CONTENTS (1) 1.0 INTRODUCTION (3) 1.1 G OALS AND O BJECTIVES (3) 1.2 S YSTEM S TATEMENT OF S COPE (3) 1.2.1 General Requirements (3) 1.3 S YSTEM C ONTEXT (4) 1.4 M AJOR C ONSTRAINTS (4) 2.0 DATA DESIGN (5) 2.1 D ATABASE D ESCRIPTION (5) 3.0 ARCHITECTURAL AND COMPONENT-LEVEL DESIGN (6) 3.1 P ROGRAM S TRUCTURE (6) 3.1.1 Overall (6) 3.1.2 Create Inspection (7) 3.1.3 During Inspection (7) 3.1.4 Post-Inspection (7) 3.1.5 Approval (7) 3.2 D ESCRIPTION FOR C OMPONENTS (7) 3.2.1 Switch User (7) 3.2.2 Facility (8) 3.2.3 Create/Modify Inspection – Step 1 (8) 3.2.4 Create/Modify Inspection – Step 2 (9) 3.2.5 File Results – Step 1 (9) 3.2.6 File Results – Step 2 (10) 3.2.7 Approval (10) 3.2.8 Checklist Maintenance (11) 3.2.9 Letter Maintenance (11) 4.0 USER INTERFACE DESIGN (13) 4.1 D ESCRIPTION OF THE U SER I NTERFACE (13) 4.1.1 Screen Images (13) Login Screen (13) Search Pages (17) Approval Queue (17) 4.1.2 Objects and actions (17) ?Menu Items (18) 4.2 I NTERFACE D ESIGN R ULES (23) 4.3 C OMPONENTS A VAILABLE (23) 4.3.1 Intrinsic Controls (23) 4.3.2 ActiveX Controls (25) 5.0 RESTRICTION, LIMITATIONS, AND CONSTRAINTS (26) T IME (26) E MPLOYEE S KILLS (26)
非标设备通用技术要求文件模板(可编辑修改word版)
非标设备通用技术要求文件模板 1、关于本文件 2、厂家资力 3、投标方义务 4、对投标商前期技术文件要求 5、工艺总体要求 6、设备通用技术要求 7.备件选型 8.安装调试 9、验收 10、保全准备 11．售后服务 1、关于本文件 1.1目的 为控制厂家及其设备、工装产品的基本准入门槛，采购优良品质的设备，使公司采购的设备以最高的综合效率运行，特编制本文件。 1.2在厂商资源可选择的前提下，设备供货商及其产品必须满足本标准对供货商的要求，方可参加轿车公司项目的投标。 1.3本文件也用于轿车公司设备采购技术协议编制参考，除非设备差异性限制，原则按照本文件限定条件执行。 1.4设备采购必须首先满足本标准。
1.4.1在满足： 1）工艺条件； 2）设备的基本可靠性、安全性、可用性； 3）综合成本最低； 的基础上进行厂商和产品选择。 1.4.2所谓的综合成本最低是指： 1）一次性采购成本；2） 综合保养、维护成本；3）使 用人工成本； 4）设备品质不良造成的生产间接损失，包括效率损失和产品质量损失；等各类因设备直接或间接产生的成本的总和最低。 1.5本文件适用于生产直接或间接相关的设备、工装、夹具采购。 1.6本文件为技术标准，不包含商务标准，商务条件遵守公司现行采购流程。 1.7本文件相应技术标准将根据设备技术发展，定期进行更新。 2、厂家资力 2.1基本条件 2.1.1投标方应具备国家法定管理部门核准营业的所有相关资格文件。 2.1.2特种设备，凡国家限定必须取得特定资力证明方能制造的，供货方需取得相关证明。 2.1.3近3 年内，设备供应商必须具备至少两套（含两套）以上同
软件开发设计文档模板1
WallPaper开发设计文档
文档变更纪录 更改人日期更改内容 创建文件 目录 1开发规划 (1) 1.1开发人员 (1) 1.2开发计划 (2) 1.3开发环境和工具 (3) 1.4开发规范 (3) 2总体设计 (4) 2.1概念术语描述 (4) 2.1.1术语1 (4) 2.1.2术语2 (4) 2.2基本设计描述 (5) 2.2.1系统总体逻辑结构图 (5) 2.2.2系统部署结构图 (6) 2.3主要界面流程描述 (7) 2.3.1功能1界面流程 (7) 2.3.2功能2界面流程 (7) 2.4模块列表 (8) 3数据结构 (9) 4接口规范 (10) 4.1<模块1API> (10) 4.1.1Interface1 (10) 4.1.2Interface2 (10) 4.2<模块2API> (11) 4.3<模块3API> (11) 4.4<数据库API> (11) 5模块设计 (12) 5.1M ODULE1设计 (12) 5.1.1模块设计描述 (12)
5.1.2模块界面描述 (12) 5.2M ODULE2设计 (13) 6附录 (14) 6.1第三方组件 (14) 6.2参考资料 (15) 6.3附加文档 (15)
开发规划 开发人员 角色主要职责负责模块人员备注 项目经理PM ?项目全面负责 ?项目设计 ?主要框架/模块编写 ?项目进度控制 ?xxx模块xxx 产品经理PT ?定义需求 ?产品监督 ?结果验证（测试） ?用户文档 无xxx 程序员 DEV ??xxx模块xxx 程序员 DEV ??xxx模块xxx ??
软件开发文档模板库
软件开发文档模板库 1 可行性研究报告 可行性研究报告的编写目的是：说明该软件开发项目的实现在技术、经济和社会条件方面的可行性；评述为了合理地达到开发目标而可能先择的各种方案；说明论证所选定的方案。 可行性研究报告的编写内容要求如下： 1.1 引言 1.1.1 编写目的 1.1.2 背景 1.1.3 定义 1.1.4 参考资料 1.2 可行性研究的前提 1.2.1 要求 1.2.2 目标 1.2.3 条件、假定和限制 1.2.4 进行可行性研究的方法 1.2.5 评价尺度 1.3 对现有系统的分析 1.3.1 数据流程和处理流程 1.3.2 工作负荷 1.3.3 费用开支 1.3.4 人员 1.3.5 设备 1.3.6 局限性 1.4 所建议的系统 1.4.1 对所建议系统的说明 1.4.2 数据流程各处理流程 1.4.3 改进之处 1.4.4 影响 1.4.4.1 对象设备的影响 1.4.4.2 对软件的影响 1.4.4.3 对用户单位机构的影响 1.4.4.4 对系统动行的影响 1.4.4.5 对开发的影响 1.4.4.6 对地点和设施的影响 1.4.4.7 对经费开支的影响 1.4.5 局限性 1.4.6 技术条件方面的可行性 1.5 可选择其他系统方案 1.5.1 可选择的系统方案1
1.5.2 可选择的系统方案2 …… 1.6 投资及收益分析 1.6.1 支出 1.6.1.1 基本建设投资 1.6.1.2 其他一次性支出 1.6.1.3 非一次性支出 1.6.2 收益 1.6. 2.1 一次性收益 1.6. 2.2 非一次性收益 1.6. 2.3 不可定量的收益 1.6.3 收益/投资比 1.6.4 投资回收周期 1.6.5 敏感性分析 1.7 社会条件方面的可行性 1.7.1 法律方面的可行性 1.7.2 使用方面的可行性 1.8 结论 2 项目开发计划 编制项目开发计划的目的是用文件的形式，把对于在开发过程中各项工作的负责人员、开发进度所需经费预算、所需软、硬件条件等问题作出安排记载下来，以便根据本计划开展和检查本项目的开发工作。编制内容要求如下： 2.1 引言 2.1.1 编写目的 2.1.2 背景 2.1.3 定义 2.1.4 参考资料 2.2 项目概述 2.2.1 工作内容 2.2.2 主要参加人员 2.2.3 产品及成果 2.2. 3.1 程序 2.2. 3.2 文件 2.2. 3.3 服务 2.2. 3.4 非移交产品 2.2.4 验收标准 2.2.5 完成项目的最迟期限 2.2.6 本计划的审查者与批准者 2.3 实施总计划 2.3.1 工作任务的分解 2.3.2 接口人员 2.3.3 进度 2.3.4 预算 2.3.5 关键问题
软件开发设计文档模板
软件文档编写指南 封面格式： 文档编号 版本号 文档名称： 项目名称： 项目负责人： 编写年月日 校对年月日 审核年月日 批准年月日 开发单位 系统规约说明书（System Specification） 一．引言 A.文档的范围和目的 B.概述 1．目标 2．约束 二．功能和数据描述 A.系统结构 1．结构关系图 2．结构关系图描述 三．子系统描述 A.子系统N的结构图规约说明 B.结构字典 C.结构连接图和说明 四．系统建模和模拟结构 A.用于模拟的系统模型
B.模拟结果 C.特殊性能 五．软件项目问题 A.软件项目可行性研究报告 B.软件项目计划 六．附录 软件项目可行性研究报告（Report for Feasibility Study） 一．引言 1．编写目的（阐明编写可行性研究报告的目的，指出读者对象） 2．项目背景（应包括：（1）所建议开发的软件名称；（2）项目的任务提出者、开发者、用户及实现单位；（3）项目与其他软件或其他系统的关系。） 3．定义（列出文档中用到的专门术语的定义和缩略词的原文。） 4．参考资料（列出有关资料的作者、标题、编号、发表日期、出版单位或资料来源。）二．可行性研究的前提 1．要求（列出并说明建议开发软件的基本要求，如（1）功能；（2）性能；（3）输出；（4）输入；（5）基本的数据流程和处理流程；（6）安全与保密要求；（7）与软件相关的其他系统；（8）完成期限。） 2．目标（可包括：（1）人力与设备费用的节省；（2）处理速度的提高；（3）控制精度和生产能力的提高；（4）管理信息服务的改进；（5）决策系统的改进；（6）人员工作效率的提高，等等。） 3．条件、假定和限制（可包括：（1）建议开发软件运行的最短寿命；（2）进行系统方案选择比较的期限；（3）经费来源和使用限制；（4）法律和政策方面的限制；（5）硬件、软件、运行环境和开发环境的条件和限制；（6）可利用的信息和资源；（7）建议开发软件投入使用的最迟时间。） 4．可行性研究方法 5．决定可行性的主要因素 三．对现有系统的分析 1．处理流程和数据流程 2．工作负荷 3．费用支出（如人力、设备、空间、支持性服务、材料等项开支。） 4．人员（列出所需人员的专业技术类别和数量。） 5．设备 6．局限性（说明现有系统存在的问题以及为什么需要开发新的系统。） 四．所建议技术可行性分析 1．对系统的简要描述 2．处理流程和数据流程 3．与现有系统比较的优越性 4．采用建议系统可能带来的影响 （1）对设备的影响 （2）对现有软件的影响
通用技术文件模版
××××××××技术文件 密级：秘密编号：××-×××-△△×-×××版次：A 民机复材机翼项目 ××××××××××× 江苏省“轻型通用航空飞行器技术”协同创新中心
目次 1范围 (1) 2规范性引用文件 (1) 3××××× (1) 3.1×××××× (1) 3.2×××××× (1) 3.3×××××× (2) 附录 A （规范性附录）附录名称 (3) A1×××××× (3) A1.1××××××× (3) A1.2××××××× (3) A2××××××× (3) A2.1××××××× (3) A2.2××××××× (3) A2.3××××××× (3)
××××××××××××× 1 范围 ××××××××××××××××××××××××××××××××××××××××××××。 ×××××××。 2 规范性引用文件 3 ××××× 3.1 ×××××× 3.1.1 ×××××× 3.1.1.1 ×××××× 3.1.1.1.1 ××××× 3.1.1.1.1.1 ×××××× ×××××1）××××2）×: a)×××××××××××××××××××××××××××××××××× ×××××××××××××××××； b)×××××××××××: 1)×××××××××××××××××××××××××××××××× ×××××××××××××××××； 2)×××××××××××××××××××××××××××××××× ××××××××××××××。 ××××××××。 ××××××××××××××××××××××××××××××××××××××××××××××××××××××××。 3.2 ×××××× ×××××××××××××××××××××××××××××××××××××××× 1）×××××××。 2）×××××××。
软件开发文档模板
软件开发文档模板 1 可行性研究报告 可行性研究报告的编写目的是：说明该软件开发项目的实现在技术、经济和社会条件方面的可行性；评述为了合理地达到开发目标而可能先择的各种方案；说明论证所选定的方案。可行性研究报告的编写内容要求如下： 1.1 引言 1.1.1 编写目的 1.1.2 背景 1.1.3 定义 1.1.4 参考资料 1.2 可行性研究的前提 1.2.1 要求 1.2.2 目标 1.2.3 条件、假定和限制 1.2.4 进行可行性研究的方法 1.2.5 评价尺度 1.3 对现有系统的分析 1.3.1 数据流程和处理流程 1.3.2 工作负荷 1.3.3 费用开支 1.3.4 人员 1.3.5 设备 1.3.6 局限性 1.4 所建议的系统 1.4.1 对所建议系统的说明 1.4.2 数据流程各处理流程 1.4.3 改进之处 1.4.4 影响 1.4.4.1 对象设备的影响 1.4.4.2 对软件的影响 1.4.4.3 对用户单位机构的影响 1.4.4.4 对系统动行的影响 1.4.4.5 对开发的影响 1.4.4.6 对地点和设施的影响 1.4.4.7 对经费开支的影响 1.4.5 局限性 1.4.6 技术条件方面的可行性 1.5 可选择其他系统方案 1.5.1 可选择的系统方案 1 1.5.2 可选择的系统方案 2 …… 1.6 投资及收益分析 1.6.1 支出 1.6.1.1 基本建设投资
1.6.1.2 其他一次性支出 1.6.1.3 非一次性支出 1.6.2 收益 1.6. 2.1 一次性收益 1.6. 2.2 非一次性收益 1.6. 2.3 不可定量的收益 1.6.3 收益/投资比 1.6.4 投资回收周期 1.6.5 敏感性分析 1.7 社会条件方面的可行性 1.7.1 法律方面的可行性 1.7.2 使用方面的可行性 1.8 结论 2 项目开发计划 编制项目开发计划的目的是用文件的形式，把对于在开发过程中各项工作的负责人员、开发进度所需经费预算、所需软、硬件条件等问题作出安排记载下来，以便根据本计划开展和检查本项目的开发工作。编制内容要求如下： 2.1 引言 2.1.1 编写目的 2.1.2 背景 2.1.3 定义 2.1.4 参考资料 2.2 项目概述 2.2.1 工作内容 2.2.2 主要参加人员 2.2.3 产品及成果 2.2. 3.1 程序 2.2. 3.2 文件 2.2. 3.3 服务 2.2. 3.4 非移交产品 2.2.4 验收标准 2.2.5 完成项目的最迟期限 2.2.6 本计划的审查者与批准者 2.3 实施总计划 2.3.1 工作任务的分解 2.3.2 接口人员 2.3.3 进度 2.3.4 预算 2.3.5 关键问题 2.4 支持条件 2.4.1 计算机系统支持 2.4.2 需要用户承担的工作 2.4.3 需由外单位提供的条件 2.5 专题计划要点
[实用参考]技术文档模板.doc
输入文档名称内部文件：[输入文件版本号] 颁布时间：[输入颁布时间]
目录 文件版本说明 (2) 参考资料 (2) 手册目的 (2) 声明 (2) 名词定义和缩略语说明 (2) 1[输入第一章标题] (3) 1.1[输入第一章第一节标题] (3) 1.1.1[输入第一章第一节第一小节标题] (3) 1.1.2[输入第一章第一节第二小节标题] (3) 1.2[输入第一章第二节标题] (3) 2[输入第二章标题] (4) 2.1[输入第一章第一节标题] (4) 2.2[输入第一章第二节标题] (5) 表格 表 1-1 [输入表格标题] (3) 表 1-2 [输入表格标题] (3) 图表 图1-1 [输入图片名称] (4) 图2-1 [输入图片名称] (4)
文件版本说明 表1版本说明 参考资料 1.[列出参考资料名称] 2.[列出参考资料名称，需增加参考资料项，请在行末回车] 手册目的 [请对撰写本手册目的进行适当描述] 声明 [对本文档内容进行声明] 名词定义和缩略语说明 表2名词定义及缩略语说明
1[输入第一章标题] [输入正文] 1.1 [输入第一章第一节标题] [输入正文] 1.1.1[输入第一章第一节第一小节标题] [输入正文] 1.1.2[输入第一章第一节第二小节标题] [输入正文] 1.2 [输入第一章第二节标题] [输入正文] 图1-1[输入图片名称]
2[输入第二章标题] [输入正文] 2.1 [输入第一章第一节标题] [输入正文] 图2-1[输入图片名称] 2.2 [输入第一章第二节标题] [输入正文] (Thisisthelastpage)
IT技术研发文档模板(2个doc)1
IT技术研发文档模板(2个doc)1 部门： xxx 时间： xxx 整理范文，仅供参考，可下载自行编辑
第一部分前言 在第一次研发中心内部（技术二部）的广泛讨论与征求意见的基础上，经过总结，形成“技术文档规范EY2003-11-V0.20”。改动部分大体有以下几个方面： （1）“配置编号”编制规则； （2）“需求分析说明书/报告”，模板部分 （3）在需求部分以附件的形式增加“最新需求确定”模板，由技术研发中心苏正华负责起草 （4）统一文档原创者身份为“作者” （5）文档模板中统一一项内容“产品名称” （6）“需求/功能变更说明书”模板中增加“负责人签字”项 （7）“数据库设计报告（S）”模板增加“主键”项，“关联关系描述”项，存储过程项，触发器项 （8）产品测试报告（SP1）与（SP2）合并为一套模板，并在测试项遗留问题项中有多处变动，新增新问题项 （9）以附件形式增加“测试方案”模板，由由技术研发中心苏正华负责起草 （10）在 V0.10 的“第三部分内容”第一项“版本控制规则”中版本号增为4位数字 （11）在 V0.10 的“第三部分内容”第七项“详细设计”中有关代码文件的说明部分增加注释改动内容项 在本版中，将不再有V0.10中解释与说明的部分，缺少的必要部分将补充到本版中。 第一部分变动内容说明 一﹑版本控制规则 （1）版本状态：Alfa ，Beta，Deta/内部测试版，Release/对外正式发布版，Changing/内部变更状态 （2）版本号：版本号以四位数字表示，格式为i.jk.l（i=0，1，2，...，n；jkl=001， (999) a.Alfa版，i=0 b.第一次正式发布的Release版，1.00 c.用Changing来表示内部测试版或Release版本的内部修改或升级状态 d.小的改动或升级i，jk保持不变，只增加l值即可，l的升值幅度为修改或升级处的数目，当l值达到或增加至9时， l=l+1，l=0 e.比较大的改动如，一次修改或升级处的数目>10，功能性的增加或改变，则i.j保持不变，增加k值。如果是功能性的修改 或变动，每有一项k+1；如果是>10的非功能性的修改，每9处修改，k+1，个数部分用l来表示 f.重大变动，j值增加 g.在Alfa版状态下，如果变动累计超出999次，则Alfa版升级到Beta版，依次类推