GS2K Hosted HomeKit User Guide. 1VV Rev

Transcription

1 GS2K Hosted HomeKit User Guide 1VV Rev

2 SPECIFICATIONS ARE SUBJECT TO CHANGE WITHOUT NOTICE NOTICE While reasonable efforts have been made to assure the accuracy of this document, Telit assumes no liability resulting from any inaccuracies or omissions in this document, or from use of the information obtained herein. The information in this document has been carefully checked and is believed to be reliable. However, no responsibility is assumed for inaccuracies or omissions. Telit reserves the right to make changes to any products described herein and reserves the right to revise this document and to make changes from time to time in content hereof with no obligation to notify any person of revisions or changes. Telit does not assume any liability arising out of the application or use of any product, software, or circuit described herein; neither does it convey license under its patent rights or the rights of others. It is possible that this publication may contain references to, or information about Telit products (machines and programs), programming, or services that are not announced in your country. Such references or information must not be construed to mean that Telit intends to announce such Telit products, programming, or services in your country. COPYRIGHTS This instruction manual and the Telit products described in this instruction manual may be, include or describe copyrighted Telit material, such as computer programs stored in semiconductor memories or other media. Laws in the Italy and other countries preserve for Telit and its licensors certain exclusive rights for copyrighted material, including the exclusive right to copy, reproduce in any form, distribute and make derivative works of the copyrighted material. Accordingly, any copyrighted material of Telit and its licensors contained herein or in the Telit products described in this instruction manual may not be copied, reproduced, distributed, merged or modified in any manner without the express written permission of Telit. Furthermore, the purchase of Telit products shall not be deemed to grant either directly or by implication, estoppel, or otherwise, any license under the copyrights, patents or patent applications of Telit, as arises by operation of law in the sale of a product. COMPUTER SOFTWARE COPYRIGHTS The Telit and 3rd Party supplied Software (SW) products described in this instruction manual may include copyrighted Telit and other 3rd Party supplied computer programs stored in semiconductor memories or other media. Laws in the Italy and other countries preserve for Telit and other 3rd Party supplied SW certain exclusive rights for copyrighted computer programs, including the exclusive right to copy or reproduce in any form the copyrighted computer program. Accordingly, any copyrighted Telit or other 3rd Party supplied SW computer programs contained in the Telit products described in this instruction manual may not be copied (reverse engineered) or reproduced in any manner without the express written permission of Telit or the 3rd Party SW supplier. Furthermore, the purchase of Telit products shall not be deemed to grant either directly or by implication, estoppel, or otherwise, any license under the copyrights, patents or patent applications of Telit or other 3rd Party supplied SW, except for the normal non-exclusive, royalty free license to use that arises by operation of law in the sale of a product. 1VV Rev. 1.3 Page 2 of

3 USAGE AND DISCLOSURE RESTRICTIONS I. License Agreements The software described in this document is the property of Telit and its licensors. It is furnished by express license agreement only and may be used only in accordance with the terms of such an agreement. II. Copyrighted Materials Software and documentation are copyrighted materials. Making unauthorized copies is prohibited by law. No part of the software or documentation may be reproduced, transmitted, transcribed, stored in a retrieval system, or translated into any language or computer language, in any form or by any means, without prior written permission of Telit III. High Risk Materials Components, units, or third-party products used in the product described herein are NOT faulttolerant and are NOT designed, manufactured, or intended for use as on-line control equipment in the following hazardous environments requiring fail-safe controls: the operation of Nuclear Facilities, Aircraft Navigation or Aircraft Communication Systems, Air Traffic Control, Life Support, or Weapons Systems (High Risk Activities"). Telit and its supplier(s) specifically disclaim any expressed or implied warranty of fitness for such High Risk Activities. IV. Trademarks TELIT and the Stylized T Logo are registered in Trademark Office. All other product or service names are the property of their respective owners. V. Third Party Rights The software may include Third Party Right software. In this case you agree to comply with all terms and conditions imposed on you in respect of such separate software. In addition to Third Party Terms, the disclaimer of warranty and limitation of liability provisions in this License shall apply to the Third Party Right software. TELIT HEREBY DISCLAIMS ANY AND ALL WARRANTIES EXPRESS OR IMPLIED FROM ANY THIRD PARTIES REGARDING ANY SEPARATE FILES, ANY THIRD PARTY MATERIALS INCLUDED IN THE SOFTWARE, ANY THIRD PARTY MATERIALS FROM WHICH THE SOFTWARE IS DERIVED (COLLECTIVELY OTHER CODE ), AND THE USE OF ANY OR ALL THE OTHER CODE IN CONNECTION WITH THE SOFTWARE, INCLUDING (WITHOUT LIMITATION) ANY WARRANTIES OF SATISFACTORY QUALITY OR FITNESS FOR A PARTICULAR PURPOSE. NO THIRD PARTY LICENSORS OF OTHER CODE SHALL HAVE ANY LIABILITY FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING WITHOUT LIMITATION LOST PROFITS), HOWEVER CAUSED AND WHETHER MADE UNDER CONTRACT, TORT OR OTHER LEGAL THEORY, ARISING IN ANY WAY OUT OF THE USE OR DISTRIBUTION OF THE OTHER CODE OR THE EXERCISE OF ANY RIGHTS GRANTED UNDER EITHER OR BOTH THIS LICENSE AND THE LEGAL TERMS APPLICABLE TO ANY SEPARATE FILES, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. 1VV Rev. 1.3 Page 3 of

4 APPLICABILITY TABLE PRODUCT GS2K based Modules Note: The features described in the present document are provided by the products equipped with the software versions equal or higher than the versions shown in the table. See also the Revision History chapter. 1VV Rev. 1.3 Page 4 of

5 Revision History Version Date Remarks 1.0 November 2016 Initial release 1.1 April, 2017 Restructuring the content and updated scripts 1.2 October, 2017 Updated Chapter 2Building Hosted HomeKit Using SDK Builder Tool with HomeKit icloud services. Updated 3.2.1Download and Install Python for Windows section. Added A.3Hosted HomeKit over icloud section 1.3 September, 2018 Added a note regarding icloud testing under section A.3Hosted HomeKit over icloud and also updated the AT command. 1VV Rev. 1.3 Page 5 of

6 Table of Contents NOTICE... 2 COPYRIGHTS..2 COMPUTER SOFTWARE COPYRIGHTS... 2 USAGE AND DISCLOSURE RESTRICTIONS... 3 APPLICABILITY TABLE... 4 CHAPTER 1 INTRODUCTION CHAPTER 2 BUILDING HOSTED HOMEKIT USING SDK BUILDER TOOL CHAPTER 3 TESTING HOSTED HOMEKIT IN SERIAL TO WI-FI APPLICATION PRE-REQUISITES TEST PROCEDURE Download and Install Python for Windows Configuring GainSpan s Python Scripting Package Running Python Script to Simulate Host MCU Testing Hosted HomeKit using ios Home Application APPENDIX A.1 BUILDING HOSTED HOMEKIT IN S2W APPLICATION A.1.1 PREREQUISITES A.1.2 DOWNLOADING HOMEKIT PACKAGE FROM SDK BUILDER A.1.3 UPDATING AND BUILDING SDK_LIB.EWW WORKSPACE A.1.4 UPDATING AND BUIDLING S2W.EWW WORKSPACE A.2 PROGRAMMING GAINSPAN MODULE A.3 HOSTED HOMEKIT OVER ICLOUD VV Rev. 1.3 Page 6 of

7 List of Figures Figure 1: GainSpan Login Figure 2: Accessing SDK Builder Tool Figure 3: SDK Builder Configuration Figure 4: Selecting HomeKit Feature Figure 5: Creating Final Build Figure 6: Upon Successful Build Figure 7: Test Setup Figure 8: COM Port Selection Figure 9: Downloading Python for Windows Figure 10: Python Installer for Windows Figure 11: Installing Python for Windows Figure 12: Checking Python version Figure 13: Installing pyserial Figure 14: Configuring GainSpan s Python Scripting Package Figure 15: Running test script Figure 16: Connecting to AP Figure 17: Adding Accessory Figure 18: Fan Service Figure 19: Set up code Figure 20: Successful addition of Accessory Figure 21: Favorite Accessory Screen Figure 22: Switching ON the Accessory Figure 23: Opening the Fan Switch Figure 24: FAN Speed Figure 25: SDK Builder Figure 26: HomeKit ADK Build Figure 27: Updating rom_patch_fpt.ewp Figure 28: Rebuilding sdk_lib.eww Figure 29: Changing Post-build command line Figure 30: Changing Command line options VV Rev. 1.3 Page 7 of

8 Figure 31: HomeKit.a and wac.a files in applet_1.ewp Figure 32: Rebuilding s2w.eww Figure 33: Communicating with GainSpan Figure 34: Valid Super Block and Firmware Single Image Selected Figure 35: Programming Single Image Complete VV Rev. 1.3 Page 8 of

9 List of Tables Table 1: Pre-requisites Table 2: Entries for Python Fan Accessory VV Rev. 1.3 Page 9 of

10 Chapter 1 Introduction This document provides test procedure for demonstrating hosted HomeKit feature in Serial-to- Wi-Fi Application. It also provides step by step procedure to build the hosted HomeKit feature in Serial-to-Wi-Fi Application. 1VV Rev. 1.3 Page 10 of

11 Chapter 2 Building Hosted HomeKit Using SDK Builder Tool This section provides detailed procedure to create custom package of Serial to Wi-Fi Application with HomeKit feature using SDK Builder tool. NOTE: The user should have HomeKit ADK license and Apple s MFI license to enable the HomeKit feature in Serial to Wi-Fi application. In the below snapshots the numbering indicates the sequence of progress. Following are the steps to enable the HomeKit feature in Serial to Wi-Fi application: 1. Login to GainSpan Portal using following URL Figure 1: GainSpan Login 2. Start SDK Builder tool by selecting SDK BUILDER and option GS2000 on the right hand corner of Home screen as shown in following screen shot. 1VV Rev. 1.3 Page 11 of

12 Figure 2: Accessing SDK Builder Tool 3. Select SDK Builder configuration based on GainSpan s module (GS2200, GS2101, and so on). Following screen shot shows custom selection of Serial to Wi-Fi Application firmware, for GS2200 module. NOTE: Ensure Include Documents & Utilities" check box is selected. 1VV Rev. 1.3 Page 12 of

13 Figure 3: SDK Builder Configuration 4. Proceed by clicking the Next button, keep selecting the Next option until the Network Services tab is found. Select HomeKit and icloud (to enable icloud services). Figure 4: Selecting HomeKit Feature 5. Keep selecting the Next option until the Summary tab, scroll down and click OK button. Build button will be enabled, click Build button to generate the Firmware Package. 1VV Rev. 1.3 Page 13 of

14 Figure 5: Creating Final Build 6. Once the package is successfully built, an is sent to the registered account. Now download the package from the SDK Builder tool under Build History Tab. Figure 6: Upon Successful Build 7. Make GS2K Evaluation board ready for HomeKit demonstration, by programing the GS2K module with custom firmware downloaded in above step. 1VV Rev. 1.3 Page 14 of

15 NOTE: If not familiar in programming GainSpan module, please refer Appendix: Programming GainSpan Module. 1VV Rev. 1.3 Page 15 of

16 Chapter 3 Testing Hosted HomeKit in Serial to Wi-Fi Application This section describes how to test Hosted HomeKit feature using Serial to Wi-Fi Application. NOTE: In the below snapshots the numbering indicates the sequence of progress. Following figure shows Test Bed and Pre-requisites for demonstrating the GainSpan s Hosted HomeKit feature using Serial-to-Wi-Fi Application. Figure 7: Test Setup 1VV Rev. 1.3 Page 16 of

17 3.1 PRE-REQUISITES The prerequisites for testing a Hosted HomeKit application is as below: Hardware and Software 1. GainSpan Evaluation board with WAC chip Description This Evaluation Board is used for running Serial To Wi-Fi Application firmware with HomeKit feature. The EVB communicates with ios Device Via Access Point and receives HomeKit request from Wi-Fi Interface and passes the requests to Python scripts running on Windows Laptop via Serial Interface. The response from the python scripts are received as HomeKit responses via Wireless Interfaces. 2. USB Connector Cable The connector is used for serial connection between GainSpan Evaluation board and Windows Laptop. 3. Windows Laptop with Python This script is used for simulating MCU s behavior. Software (3.5.2 onwards) Installed. 4. Access Point An Access Point is used for establishing Wireless Local Area Network. GainSpan evaluation board and ios device communicates using this Access Point. 5. Apple Device with ios 10 onwards This device is used to run the Home App for testing HomeKit Feature. Table 1: Pre-requisites 3.2 TEST PROCEDURE 1. Connect one end of USB connector to GS2200 EVB s USB0 Port and other end of the connector to Laptop s USB Port. 2. Get the COM port number from Device Manager at Ports (COM & LPT), it is required for executing scripts. Figure 8: COM Port Selection 1VV Rev. 1.3 Page 17 of

18 3. Configure the GainSpan module in Auto connection mode to run the script. Flash the firmware on GainSpan module and keep the module in run mode. Connect the teraterm terminal to execute the following Auto Connection commands. The default baud rate for UART interface is at+ncmauto=0,0,0 at&w0 at&y0 at+reset 4. To check the version of the python software, type the command Python -V in the command prompt. Ensure that python version is or Onward. If Python Software is not installed in the laptop, please follow the steps mentioned in Download and Install Python for Windows. 5. Run the Python Script as explained in Configuring GainSpan s Python Scripting Package 6. This script will ask the user to enter the COM port number, Wireless Network Name (SSID) and Passphrase. 7. GS2200 connects to the configured Access point. 8. Connect iphone to the same Access Point where GS2200M EVB is connected. 9. Perform the HomeKit Test as explained in section Testing Hosted HomeKit using ios Home Application Download and Install Python for Windows Perform the following steps to download python for windows: 1. Go to URL: 2. Download latest version of Python package and click on Download. This will navigate to other pages Figure 9: Downloading Python for Windows 1VV Rev. 1.3 Page 18 of

19 3. Scroll down and download the package based on the windows Operating System type ( 32 Bit/64 Bit). Figure 10: Python Installer for Windows 4. Install the downloaded Python. Ensure the check box is selected for Add Python 3.5 to PATH during the installation process. Figure 11: Installing Python for Windows 1VV Rev. 1.3 Page 19 of

20 5. After successful installation of Python, check the version by executing the following command from the command prompt. Python V Figure 12: Checking Python version 6. As serial interface module is not available in default Python installation. Install pyserial module by executing following command from the command prompt. Pip install pyserial Figure 13: Installing pyserial Configuring GainSpan s Python Scripting Package Perform the following steps to set GainSpan s Python scripting package: 1. Navigate to ~\Tools\scripts folder location in the downloaded SDK package from SDK Builder. File pygate.zip will be listed, right-click on pygate.zip file and do Extract to pygate. 2. Open the system properties by pressing the Windows key + R on keyboard, type sysdm.cpl and click OK. 3. Choose Advance tab and opt Environment Variable. 4. Now click on the option New, to add the Environment Variable with the following details as shown in the figure below and click OK. Variable Name: PYTHONPATH 1VV Rev. 1.3 Page 20 of

21 Variable Value: D:\Tools\scripts\pyGate NOTE: In the above step-4 and in the figure below the variable value is set to D:\Tools\scripts\pyGate path. As the package is copied and extracted in D:\ folder. Figure 14: Configuring GainSpan s Python Scripting Package Running Python Script to Simulate Host MCU fanaccessory.py is the test script written in python programming language. This script simulates the MCU s behavior. When Apple Device request fan accessory information over the Wi-Fi interface, GainSpan Module receives the request and sends it to the serial interface. fanaccessory.py receives these requests over serial interface, prepares the required response, and sends it back to GainSpan Module over the serial interface. GainSpan module processes these inputs from serial interface, prepares the response in JSON format, and sends it over Wi-Fi interface to Apple device. From the windows command prompt, navigate to D:\Tools\scripts\pyGate\pyGate\scripts\regr\homeKit, and execute the following command. The script would ask user to enter following Python fanaccessory.py 1VV Rev. 1.3 Page 21 of

22 Parameters Description Port number UART COM Port number is displayed in the Device Manager with ports (COM & LPT) (refer Image Figure 8: COM Port Selection). Give the COM Port number only. For example: - for COM13, give port number as 13 not COM13 Wireless Networks SSID SSID of the local Access Point. Passphrase It is the Passphrase of the local Access Point, if present. If not just press the ENTER on the key board. Table 2: Entries for Python Fan Accessory Figure 15: Running test script 1VV Rev. 1.3 Page 22 of

23 3.2.4 Testing Hosted HomeKit using ios Home Application Perform the following steps to test the Hosted HomeKit feature using ios Home Application: 1. Connect the idevice to the same AP to which GS Node is connected. Figure 16: Connecting to AP 1VV Rev. 1.3 Page 23 of

24 2. Launch the Home Application in the iphone, and tap Add Accessory. Figure 17: Adding Accessory 1VV Rev. 1.3 Page 24 of

25 3. Tap on the displayed Fan service. Figure 18: Fan Service 1VV Rev. 1.3 Page 25 of

26 4. Home Application requests for an 8-digit set up code. Tap Enter code manually and Enter the 8-digit code Figure 19: Set up code 5. After entering the code, pairing procedure starts from the iphone to GS Node. 1VV Rev. 1.3 Page 26 of

27 6. Following screen is displayed upon successful addition of Accessory followed by Accessory details screen. Figure 20: Successful addition of Accessory 1VV Rev. 1.3 Page 27 of

28 7. Tap Done. Home Application displays the Favorite Accessory screen where it shows the fan state as OFF. Figure 21: Favorite Accessory Screen 1VV Rev. 1.3 Page 28 of

29 8. Tap GS-FAN accessory to switch ON the accessory. Figure 22: Switching ON the Accessory 1VV Rev. 1.3 Page 29 of

30 9. Long press on the GS-FAN to open the Fan Switch. Figure 23: Opening the Fan Switch 1VV Rev. 1.3 Page 30 of

31 10. Speed of the FAN can be increased or decreased by sliding UP/DOWN on the screen. Figure 24: FAN Speed 1VV Rev. 1.3 Page 31 of

32 Appendix A.1 BUILDING HOSTED HOMEKIT IN S2W APPLICATION NOTE: In the below snapshots the numbering indicates the sequence of progress. A.1.1 PRE-REQUISITES Following are the pre-requisites required for building a Hosted HomeKit application: 1. IAR Workbench with valid license 2. SDK Builder with SDK+HomeKit ADK access. A.1.2 DOWNLOADING HOMEKIT PACKAGE FROM SDK BUILDER Perform the following steps to download HomeKit package: 1. Login to and go to SDK Builder page. Figure 25: SDK Builder 2. Select the following configuration as part of the HomeKit ADK package and click Build. 1VV Rev. 1.3 Page 32 of

33 Figure 26: HomeKit ADK Build 3. Once the package is successfully built, an is sent to the registered account. 4. Download the package and extract it. To build Hosted HomeKit feature in Serial-to-Wi-Fi Application, 1. Update and build the sdk_lib.eww workspace (from the downloaded and extracted HomeKit SDK package) 2. Update and build the s2w.eww workspace (from the downloaded and extracted HomeKit SDK package) A.1.3 UPDATING AND BUILDING SDK_LIB.EWW WORKSPACE Perform the following steps to update and build sdk_lib.eww: 1. Go to path (from the downloaded and extracted folder) \SDK\Embedded\ geps\build\ and find sdk_lib.eww Note: By defualt sdk_lib.eww comes up with all the generic features to evaluate Gainspan Firmware. When HomeKit feature is included, it exceeds the GainSpan supported firmware size as Homekit has its own set of features. Configure the ROM patch function pointer table project rom_path_fpt.ewp with set of features those are required for building Hosted Homekit Application. 2. To update rom_path_fpt.ewp, open sdk_lib.eww workspace. This worksapce has 3 projects attached to it. Select rom_patch_fpt.ewp right click and select Options Under category, select C/C++ Compiler Naviate to Pre-processor tab Under Defined Symbols Remove all Macros and set the Macros mentioned as follows. 1VV Rev. 1.3 Page 33 of

34 Figure 27: Updating rom_patch_fpt.ewp Following is the list of Macros required for Hosted HomeKit: GSN_CLK_CTL_ENABLE GSN_DYN_MEM_MGMT_ENABLE GSN_GPIO_ENABLE GSN_MDNS_SD_ENABLE GSN_PSP_ENABLE GSN_XML_STRING_PARSER_ENABLE GSN_MB_ENABLE GSN_SAFE_FLASH_ENABLE GSN_FACT_DFLT_ENABLE GSN_HTTPD_SYS_API_ENABLE GSN_FLASH_CACHE_ENABLE GSN_HTTP_ENABLE GSN_NWX_ENABLE _RPST_= const GSN_SECURITY_ENTERPRISE_AVAILABLE GSN_DHCP_SERVER_ENABLE GSN_XML_PARSER_ENABLE GSN_I2C_ENABLE GSN_OTP_MM_ENABLE GSN_SOFT_TIMER_ENABLE GSN_OAL_ENABLE _DLIB_FILE_DESCRIPTOR GSN_DMA_ENABLE GSN_UART_ENABLE TX_ENABLE_IAR_LIBRARY_SUPPORT GSN_NETX_ENABLE GSN_SYS_QUAL_ENABLE GSN_OTP_ENABLE GSN_SYS_CTL_ENABLE GSN_HTTP_SERVER_ENABLE 1VV Rev. 1.3 Page 34 of

35 GSN_WDD_ENABLE GSN_PERSIST_TIMER_ENABLE GSN_SDAADC_ENABLE IAR GSN_FLASH_IF_ENABLE 3. Press F8 key on key board, batch Build pop up is displayed. Click Rebuild All button. Figure 28: Rebuilding sdk_lib.eww A.1.4 UPDATING AND BUIDLING S2W.EWW WORKSPACE Perform the following steps to update and build s2w.eww: 1. Go to "\SDK\Embedded\userapps\s2w\build" and open "pre_include.h". 2. Remove all the content from "pre_include.h" and replace with following HomeKit macros: #define TX_ENABLE_IAR_LIBRARY_SUPPORT #define IAR #define FIXED_ROM_BUILD #define NX_INCLUDE_USER_DEFINE_FILE #define TM_USE_HTTPD #define S2W_GSLINK #define S2W_GSLINK_XML #define S2W_WEB_SERVER #define S2W_UART_ENABLE #define S2W_FORCE_UART_PORT #define S2W_DEFAULT_UART_BAUD 9600 #define S2W_DEFAULT_UART_BITS_PER_CHAR 3 #define S2W_DEFAULT_UART_PARITY 0 #define S2W_DEFAULT_UART_STOP_BITS 0 #define S2W_DEFAULT_UART_SW_FLOW 0 #define S2W_DEFAULT_UART_HW_FLOW 0 #define S2W_DNS_CLIENT #define S2W_MDNS_ENABLE #define S2W_NCM_SUPPORT_ENABLE #define S2W_NCM_ROAMING_SUPPORT #define S2W_HOMEKIT_SUPPORT #define S2W_I2C_SUPPORT #define S2W_ADC_SUPPORT #define RUN_ALL_FROM_FLASH #define NX_INCLUDE_USER_DEFINE_FILE #define S2W_WEB_FS_AVAILABLE #define S2W_EXTFLASH_DRIVER_TEST 1VV Rev. 1.3 Page 35 of

36 #define S2W_MEM_ACCESS #define S2W_PERSISTENT_TMR_SUPPORT #define S2W_DHCP_SERVER_ENABLE 3. Open the S2W Application's workspace ("s2w.eww") located at "\SDK\Embedded\userapps\s2w\build" 4. Two projects "s2w" and "applet_1" are displayed in the WorkSpace. 5. Go to Workspace --> Select "s2w" project --> right click --> select Options. This opens the "Options for node S2W" window. 6. Under Category -->go to "Build Actions" --> change content of "Post-build Command Line :" with following content: "$PROJ_DIR$\symbols_homekit.bat" "$TOOLKIT_DIR$\bin" "$PROJ_DIR$" Figure 29: Changing Post-build command line 7. Under Category -->go to "Linker" -->go to "Extra Options" tab -->change content of "Command Line Options : (One per Line)" with following: -f $PROJ_DIR$\..\..\..\geps\lib\rom_patch_fpt_symbols.txt -f $PROJ_DIR$\s2wKeepSymbols_homekit.txt --keep app_auto_patch_dummy1 --keep app_auto_patch_dummy2 --entry GsnStartup_Main --redirect malloc=malloc --redirect free=free 1VV Rev. 1.3 Page 36 of

37 Figure 30: Changing Command line options 8. Add two Library files homekit.a and wac.a to applet_1.ewp project. 9. Select applet_1 project, right click and select the Add option with Add files. This opens the Add Files window. 10. Choose All Files and select the library files homekit.a and wac.a from "\SDK\Embedded\adk\HomeKit\lib and \SDK\Embedded\adk\wac\lib" paths respectively. 1VV Rev. 1.3 Page 37 of

38 Figure 31: HomeKit.a and wac.a files in applet_1.ewp 11. Press F8 key on the key board and batch Build window pops up. Click Rebuild All button to build the project without any errors. Figure 32: Rebuilding s2w.eww 12. Navigate to "\SDK\Embedded\userapps\s2w\build and RUN flash_program_flashfetch_singleimage.bat file. 13. Press the Enter key after providing the COM port details. 14. Single image gs2000_singleimage.bin will now be created in \SDK\Embedded\userapps\s2w\bin folder. 1VV Rev. 1.3 Page 38 of

39 A.2 PROGRAMMING GAINSPAN MODULE For programming the GS2101M and GS2200M modules using UART interface, perform the following: 1. Select the Single UART Interface from the pull-down tab. 2. Select the UART port. 3. Select Baud Rate. The Baud Rate will automatically be selected. When selecting Baud Rate. Ensure Jumper J13 is shorted, it is located near to Programming and Running Switch. 4. Click the Check Connection button. The software will communicate with the GS2101M or GS2200M evaluation board to check the connection and display the Module Specifications (Module Type and Mac Address of the module). A Green check will display at the bottom of the screen indicating the Connection and Communication with the board is successful along with the selections as show below: Figure 33: Communicating with GainSpan 5. Select the Firmware and Binaries to program the board with a Single Image. Click the Browse (...) button next to the Super Block and Current FW Version. Select the Super Block and Single Image Firmware located in \Embedded folder in the downloaded package. 6. Once selected, a message will be displayed indicating that a valid Super Block and Firmware Image have been selected as seen below: 1VV Rev. 1.3 Page 39 of

40 Figure 34: Valid Super Block and Firmware Single Image Selected 7. Click the Erase and Program" button. The GUI software will go through a process of programming the module flash with the new firmware and binaries. When completed, a Green check will be displayed indicating the flash has been programmed successfully which is as shown below: 1VV Rev. 1.3 Page 40 of

41 Figure 35: Programming Single Image Complete 8. Click the Close button. Turn the ON/OFF switch to the OFF position. Turn the PROGRAM/RUN switch to the RUN position. Turn the ON/OFF switch back to the ON position. 1VV Rev. 1.3 Page 41 of

42 A.3 HOSTED HOMEKIT OVER ICLOUD With icloud enabled, we can use the same to remotely access control of ios-connected home automation accessories and not confined to be on the local network only. In order to we enable it we perform following modifications in at+hksetup command at host side: at+hksetup=3,hk-gs2000-s2w,1,gs2000, ,ffffffff,1 fffffff is put to enable for all event notifications available. 1VV Rev. 1.3 Page 42 of

43 Following event notifications are applicable for icloud: icloud ACTIVATION INIT 16 icloud ACTIVATION DONE 17 icloud ACTIVATION FAILED 18 icloud PAIRING INIT 19 icloud PAIRING DONE 20 icloud PAIRING FAILED 21 icloud CONNECTED 22 icloud DISCONNECTED 23 icloud VERIFICATION INIT 24 icloud VERIFICATION DONE 25 icloud VERIFICATION FAILED 26 icloud VERIFICATION SESSION CLOSED 27 icloud ACCESSORY DISCOVERY REQ 28 icloud CHAR READ REQUEST 29 icloud CHAR WRITE REQUEST 30 icloud CHAR EVENT REQUEST 31 These notifications are received on the terminal as and when these events are triggered. All the procedures are same as mentioned in the document. Note: In ios 11.0, icloud activation may fail. Solution is, during ICLOUD ACTIVATION INIT - go to settings of idevice and select Home icon. Toggle Use this ipad as a Home Hub option such a way that it is disabled at the end of toggling. Once the event notification icloud ACCESSORY DISCOVERY REQ is received i.e. no. 28, change the idevice network to something other than home network and it can still control the accessories through homekit app. Introduction. The icloud testing requires ECC enabled firmware. Therefore, it is mandatory for the customer to enable "ECC related feature" in the Homekit "s2w" Project while building the S2W application. 1VV Rev. 1.3 Page 43 of

44