W600芯片一键配置(iOS) SDK用户手册

"OneShotConfig2.0(IOS) SDK用户手册1" 本文档详细介绍了北京联盛德微电子有限责任公司(WinnerMicro)为W600芯片开发的一键配置(IOS)SDK，该SDK主要用于帮助iPhone应用程序配置Wi-Fi设备接入网络。SDK提供了一系列接口，使得开发者能够更方便地实现设备的Wi-Fi配置。 ### OneShotConfig.h接口定义 #### startConfig函数 此函数是开始一键配置的关键，它将用户的当前连接Wi-Fi的SSID和密码编码加密，并通过UDP组播报文发送出去。函数原型如下： ```objc -(int)startConfig:(NSString*)ssid pwd:(NSString*)password; ``` 参数： - `ssid`：当前连接的Wi-Fi网络名称 - `password`：用户输入的Wi-Fi密码 返回值： - `0`：表示发送操作正常结束，但未配置成功，需要继续调用该方法 - `-1`：表示调用`stop`或`stopConfig`接口导致配置中断 - `-2`：表示内部错误发生 调用注意事项： - 必须在后台线程中调用此方法 - 方法会先发送信道同步包，然后发送编码后的Wi-Fi信息，通常5到10秒后返回结果。为了确保设备接收完整信息，需要持续调用，直到配置成功 - 如果抛出`OneShotException`异常，意味着配置失败，应调用`stopConfig`结束配置并释放资源 #### stopConfig函数 用于停止一键配置，释放配置过程中占用的资源。函数原型如下： ```objc -(void)stopConfig; ``` 参数：无 返回值：无 使用时应注意，无论配置是否成功，都需要在结束时调用此方法来释放资源 #### start方法与stop方法 这两个方法与`startConfig`类似，用于启动和停止配置过程。具体的使用方法和注意事项与`startConfig`和`stopConfig`相似，但它们可能提供了不同的调用方式和处理逻辑，适用于不同的场景需求。 ### 使用方法 要使用OneShotConfig2.0 SDK，开发者需要首先获取`OneShotConfig`对象实例，然后在后台线程中启动配置流程，通常是循环调用`startConfig`或`start`函数，直到配置成功。在配置结束后，不论成功与否，都需调用`stopConfig`以释放资源。 OneShotConfig2.0(IOS) SDK提供了一套完整的解决方案，使得开发者能够高效、安全地帮助用户将Wi-Fi设备接入网络，简化了配置流程，提高了用户体验。开发者需按照手册中的指导，合理使用这些接口，以确保配置过程的顺利进行。