Getting Started. Version: 5.0. Date Released: September 27, Document Number: AY006AIO2-5

Transcription

1 Getting Started Version: 5.0 Date Released: September 27, 2017 Document Number: AY006AIO2-5

2 2017 Ayla Networks, Inc. All rights reserved. Do not make printed or electronic copies of this document, or parts of it, without written authority from Ayla Networks. The information contained in this document is for the sole use of Ayla Networks personnel, authorized users of the equipment, and licensees of Ayla Networks and for no other purpose. The information contained herein is subject to change without notice. Ayla and the Ayla Networks logo are registered trademarks and service marks of Ayla Networks. Other product, brand, or service names are trademarks or service marks of their respective holders. Do not make copies, show, or use trademarks or service marks without written authority from Ayla Networks. Ayla Networks does not supply all documents that are referenced in this document with the equipment. Ayla Networks reserves the right to decide which documents are supplied with products and services. Ayla Networks TECHNICAL SUPPORT and SALES Contact Technical Support: or via at Contact Sales: Ayla Networks REGIONAL OFFICES GREATER CHINA Shenzhen Room City University of Hong Kong Research Institute Building No. 8 Yuexing 1st Road High-Tech Industrial Park Nanshan District Shenzhen, China Phone: HEADQUARTERS Silicon Valley 4250 Burton Drive, Suite 100 Santa Clara, CA United States Phone: Fax: JAPAN Wise Next Shin Yokohama, Shnyokohama, Kohokuku Yokohama-shi, Kanagawa-ken Yokohoma, Japan EUROPE Munich Ludwigstr. 8 D München, Germany TAIWAN Taipei 5F No. 250 Sec. 1 Neihu Road, Neihu District Taipei 11493, Taiwan For a Complete Contact List of Our Offices in the US, China, Europe, Taiwan, and Japan:

3 1 Introduction Audience Related Documentation Requirements Get Connected Register for Developer Account About the Ayla Networks Mobile App (AMAP) Connect the Ayla Networks Design Kit Minimum System Requirements Power up the Ayla Networks Design Kit ios Platform Download & Install the Mobile Application Sign in to the AMAP App Register your Ayla Networks Design Kit with the AMAP App Android Platform Download AMAP App Sign in to the AMAP App Register your Ayla Networks Design Kit with the AMAP App Connect to Your Ayla Networks Design Kit Ayla Developer Portal Control Demo Ayla Networks Design Kit Details Troubleshooting Factory Reset Device Not Connecting Next Steps Ayla Networks, Inc. Proprietary i

4

5 Ayla Networks enables manufacturers and service providers to bring connected products to market quickly and securely using the industry s first Agile IoT Platform. This document provides step-by-step instructions to get started with the Ayla Networks Platform. This provides a basic understanding of how the Ayla Platform works. This document walks through the setup process with the Ayla Networks Platform Design Kit. This document is written for anyone who wants to learn how to get started using the Ayla Networks platform. Ayla Networks assumed the readers of this document understand how to: Download and install an application from an app store Locate a list of available Wi-Fi networks on their smart device (phone or tablet) Ayla Product Development Overview (AY006GOV1) Design Kit - Hello World! (AY006GHW2) Please make sure you have the following before beginning: Ayla Platform Design Kit If you do not have the Design kit, you can purchase it on the Ayla Networks Website. On the home page, select the Getting Started > Ayla Design Kits drop-down. Computer/Laptop with a browser installed Smart device, ios or Android (phone or tablet) Computer or outlet USB adaptor (to power the Design Kit) Internet access via Wi-Fi connection (hotspot or wireless access point) 2017 Ayla Networks, Inc. Proprietary 1

6 The diagram below illustrates the steps required to successfully connect the Ayla Networks Design Kit to the Ayla Networks cloud. Details for each step are discussed in following sections. Figure 1 Process Flow Connection of Ayla Networks Design Kit You can use the Ayla Networks Developer Portal to complete the following tasks: Register and configure new devices View and modify device properties Design templates, schedules, groups, and roles 2017 Ayla Networks, Inc. Proprietary 2

7 To use the Ayla Platform Design Kit, you must first register for an Ayla Developer account. 1. On your browser, navigate to 2. To create an account, click on the SIGN UP link (upper right corner). Figure 2 - Developer Portal Login page 2017 Ayla Networks, Inc. Proprietary 3

8 3. On the Sign up page, fill out the form with all required fields as indicated by an asterisk (*). Figure 3 - Developer Portal Account Sign up page 4. Read the Terms of Service and select the checkbox to accept. 5. Click the blue OK button to continue. NOTE Disregard the Have an Ayla Dev Kit checkbox. You will register your device with the AMAP mobile app. 6. When the registration process is completed, a confirmation is sent to the address (entered in the form) Ayla Networks, Inc. Proprietary 4

9 7. To confirm your account, click the link in your . Figure 4 - Developer Portal Account Confirmation 8. The account is created and you will be redirected to the Ayla Networks Developer Site. Figure 5 - Developer Portal Account Sign up page 2017 Ayla Networks, Inc. Proprietary 5

10 Ayla Networks provides both ios and Android installation options for the Ayla Networks Design Kit. The AMAP App provides a comprehensive set of features used in many IoT applications including: Simplified device setup and registration to streamline device onboarding Key device management features such as property management and device connectivity Powerful flow based event management that allows users to set custom triggers and notifications for their devices For ios, see Section 3 ios Platform. For Android, see Section 4 Android Platform. The Ayla Networks Design Kit features a Wi-Fi connectivity module and includes a STM 32F Discovery Board. With the Ayla Networks Design Kit, developers can connect products to the Ayla Networks Cloud and create mobile apps for the Internet of Things. USB Type A to Mini-B Cable Accessible b/g/n Wi-Fi network Smart device with AMAP mobile app installed 2017 Ayla Networks, Inc. Proprietary 6

11 To provide power to the Ayla Networks Design Kit, perform the following steps: 1. Plug the Mini-B end of the USB adaptor cable into the Design Kit. 2. Plug the Type A end of the USB adaptor cable into a USB power source. 3. Verify that the Red Power LEDs illuminate on each board. 4. After a brief initialization, verify that the Green Ready LED illuminates. NOTE You may see a slightly different board layout, depending on the Design Kit. The Orange LINK LED should NOT be lit at this time. If it is, please Factory Reset your board before proceeding with setup. Figure 6 Ayla Networks Platform Board 2017 Ayla Networks, Inc. Proprietary 7

12 This section provides the ios installation requirements and the detailed installation steps. 1. In the itunes store, search for Ayla AMAP. 2. Download the latest Ayla Networks AMAP app. Figure 7 Ayla Networks AMAP App (ios) 3. Follow the application installation instructions Ayla Networks, Inc. Proprietary 8

13 To sign in to the AMAP App, perform the following steps: 1. Connect your ios device to a Wi-Fi hotspot with internet access. 2. Take note of the network to which you connect, as you will need this information in a later step. 3. Sign into the Ayla Networks AMAP App using the credentials ( and password) used when you registered for your Ayla Networks Developer Portal account. NOTE If necessary, click the Forget your password? or Resend confirmation links. NOTE After five (5) consecutive failed login attempts, the user account is locked on the system for thirty (30) minutes. After 30 minutes, the user account is unlocked and the user can make subsequent attempts (up to 5) and the process is repeated. Alternately, click the "Forgot your password link" to reset the user password. Any attempts (login or password reset) are blocked during the 30-minute period. (This 30-minute time period is not extended, regardless of any attempts during the lockout period.) 2017 Ayla Networks, Inc. Proprietary 9

14 To setup and register your Ayla Networks Design Kit, perform the following steps: 1. Tap the Plus Sign (+) located on the top right-hand side of the screen (Figure 10) to get to the Add Device page (Figure 11). 2. Verify that Product Type displays Ayla EVB and that Registration Type displays Same-LAN. Figure 8 Add Device page Figure 9 Device Registration 2017 Ayla Networks, Inc. Proprietary 10

15 3. Tap the Wi-Fi Setup & Registration button (Figure 12) to get to the Switch to Settings page (Figure 13). Figure 10 Wi-Fi Setup & Registration Figure 11 Switch to Settings App 2017 Ayla Networks, Inc. Proprietary 11

16 4. Tap the Switch to Settings App button (Figure 14) to navigate to the AMAP App Settings page (Figure 15). Figure 12 Switch to Setting App Selection Figure 13 AMAP App Settings NOTE Some ios versions may skip this screen and take you directly to the ios Settings page Ayla Networks, Inc. Proprietary 12

17 5. Tap Settings (Figure 16) to navigate to the ios Settings page (Figure 17) and select the Wi-Fi access point for your Ayla Networks Design Kit. Figure 14 Settings Navigation Figure 15 Wi-Fi access point 2017 Ayla Networks, Inc. Proprietary 13

18 6. Select the Wi-Fi access point (Figure 18 & 19)from the Choose a Network list that matches the unique network ID on your Ayla Networks Design Kit (Ayla-xxx) (Figure 20). Figure 16 Wi-Fi access point selection Figure 17 Connecting to Wi-Fi access point Figure 18 Locating unique network ID on the Ayla Networks Design Kit 2017 Ayla Networks, Inc. Proprietary 14

19 7. If the connection was successful, you should see a message that you are being redirected (Figure 21 & 22). Figure 19 Connecting to Wi-Fi access point Figure 20 Redirecting to Wi-Fi setup At this point, your smartphone is connected to the access point of the Ayla Networks Design Kit Ayla Networks, Inc. Proprietary 15

20 8. Now select the Wi-Fi with internet access that you initially connected your smart device (Figure 23). If necessary, provide the password and tap the Connect button (Figure 24). You should see the success message (Figure 24) on a successful connection. Figure 21 Wi-Fi selection Figure 22 Successful connection At this point, you should see the Orange Link LED illuminate on your Ayla Networks Design Kit. NOTE Please be patient, as this can take up to several minutes. Should your registration not succeed, perform a Factory Reset and try again Ayla Networks, Inc. Proprietary 16

21 9. The AMAP App will attempt to automatically register your connected Ayla Networks Design Kit (Figure 25). If successful, you should see the Registered new device message (Figure 26). Figure 23 Found registration candidate Figure 24 Registered new device After your Ayla Networks Design Kit is connected, you can control it using the UI on your AMAP App. NOTE See Section 5 Ayla Developer Portal Control Demo for more details on using the AMAP App to manage your Ayla Networks Design Kit Ayla Networks, Inc. Proprietary 17

22 This section describes the process to install Ayla Networks AMAP App. 1. On the Google Play Store, locate the latest version of the Ayla Networks AMAP App. 2. Download from the Store. Figure 25 Ayla Networks AMAP App (Android) To sign in to the AMAP App, perform the following steps: 1. Connect your Android device to a Wi-Fi hotspot with internet access. 2. Take note of the network to which you connect (information is needed in a later step) Ayla Networks, Inc. Proprietary 18

23 3. Sign into the Ayla Networks AMAP App with the credentials ( and password) used when you registered for the Ayla Networks Developer Portal account. Figure 26 AMAP App Sign In Screen Figure 27 AMAP App Wi-Fi Connection NOTE If necessary, click the Forgot Password or Re-send Confirmation links. NOTE After five (5) consecutive failed login attempts, the user account is locked on the system for thirty (30) minutes. After 30 minutes, the user account is unlocked and the user can make subsequent attempts (up to 5) and the process is repeated. Alternately, click the "Forgot your password link" to reset the user password. Any attempts (login or password reset) are blocked during the 30-minute period. (This 30-minute time period is not extended, regardless of any attempts during the lockout period.) 2017 Ayla Networks, Inc. Proprietary 19

24 1. To setup and register your Ayla Networks Design Kit, perform the following steps: 2. Tap the Blue Plus Sign (+) located on the bottom right-hand side of the screen (Figure 30) to get to the Device Registration page (Figure 31). 3. Verify that Product Type displays Ayla EVB and that Registration Type displays Same-LAN. Figure 28 Add Device Page Figure 29 Device Registration 2017 Ayla Networks, Inc. Proprietary 20

25 4. Tap the Scan for Devices button (Figure 32) to get to the Device Access Points page (Figure 33). 5. Select the device access point from the list that matches the unique network ID on your Ayla Networks Design Kit (Ayla-xxx) (Figure 34). Figure 30 Scan for Devices Figure 31 Device Access Points Figure 32 Locating unique network ID on the Ayla Networks Design Kit 2017 Ayla Networks, Inc. Proprietary 21

26 You will now connect your Ayla Networks Design Kit to the Wi-Fi network you initially connected your smartphone. 1. On Wi-Fi Access Points page (Figure 35), locate and select the correct access point. 2. If prompted, enter your Wi-Fi- password (Figure 36). Figure 33 Wi-Fi Access Points Figure 34 Wi-Fi Network 2017 Ayla Networks, Inc. Proprietary 22

27 3. After your credentials are authenticated, you will receive a confirmation prompt (Figure 37). Please be patient, as this process will take several minutes. 4. If successful, the Registered Devices page will list your device (Figure 38). Figure 35 Connecting to Wi-Fi access point Figure 36 Registered new device NOTE Please be patient, as this can take up to several minutes. Should your registration not succeed, perform a Factory Reset and try again. After your device is connected, it can be controlled from the Developer Portal and your smart device. For more information on how to use the app, see Section 5, Ayla Developer Portal Control Demo Ayla Networks, Inc. Proprietary 23

28 This section explains how to use the Ayla Developer Portal to control LED lights on the Design Kit. 1. In you web browser, navigate to the Ayla Developer Portal ( 2. Log into the Ayla Developer Portal. 3. On the Welcome page, click View My Devices icon. Figure 37 -Ayla Developer Portal 4. On the Device listing, click the Serial Number of your device. Figure 38 -Design Kit Device Serial Number (DSN) 2017 Ayla Networks, Inc. Proprietary 24

29 5. Navigate to the AMAP App on your smart device. 6. On the AMAP App, tap the Blue LED icon. The Blue LED should light up on the Ayla Networks Design Kit. Figure 39 -AMAP Application UI Blue LED 2017 Ayla Networks, Inc. Proprietary 25

30 7. On the Ayla Networks Developer Portal, click on the Current Value for the Green LED. The Green LED icon on the AMAP mobile app and the Green LED on the Ayla Networks Design Kit should illuminate. Figure 40 -AMAP Application UI Green LED 2017 Ayla Networks, Inc. Proprietary 26

31 8. Press and hold the Blue button on the Ayla Networks Design Kit. The Blue button on the AMAP mobile app will indicate that the Blue button is pressed and the Current Value for the Blue button will change to 1. Figure 41 -AMAP Application UI Blue Button 2017 Ayla Networks, Inc. Proprietary 27

32 After you successfully setup and register your Ayla Networks Design Kit, you are ready to perform some basic tests to demonstrate how easy it is to use the Ayla Networks Platform. Figure 44 is an illustration of the Ayla Networks Design Kit. Descriptions of important components are listed below. Figure 42 -Ayla Networks Design Kit 2017 Ayla Networks, Inc. Proprietary 28

33 Location LED / Connector Description and Usage Ayla Networks Board STM Board Power USB Connector Orange Link LED Reset Button Reset Button USB ST-Link This Mini-USB female connector is used to power your board. It is recommended to switch to this after programming your board (before resetting). Attempt to use this connection whenever applying power to your board to apply the correct amount of power to the board This Orange LED will notify you that the board has a connection to the network and, the Ayla Networks cloud. This reset is used to reset the Ayla Networks board, but should not be used unless directed to do so. This reset button, notably in the STM32F Discovery board, will reset the STM board when pressed. Additionally, it can be used to factory reset your device. Whenever this document mentions to reset the device, use this button or un-power and power your device. This Mini-USB female connector is used to program your board. Make sure you are plugged in here when downloading a new flash onto the board. Blue Button LED Test Circle This blue button is used in the demo applications and can also be used to factory reset your device. The LED Circle is where you should be looking to see if your LED s have lit up after setting up the Ayla Networks Developer s Dashboard. The three-circled LED s are, in order from left to right, Green, Blue, and Red Ayla Networks, Inc. Proprietary 29

34 This section contains information about troubleshooting the Ayla Platform Design Kit. If your device is connected to the wrong network, or did not complete setup/registration correctly, you can factory reset your device. To do this, follow the steps below: 1. On the Ayla Design Kit, simply hold the blue button then quickly tap the black reset button without letting go of the blue button. 2. The Blue LED should start blinking when you tap the black button. When it finishes blinking, release the blue button. 3. Your device should restart and you have successfully completed the factory reset. Figure 43 -Factory Reset buttons A device can only be registered to one developer account at a time. You will need to unregister a device to attach it to your account if it has already been registered. To unregister the device contact Ayla Support. Additionally, the Ayla Networks board and not the STM32 board should power your design kit. If you do not power it from the Ayla Networks board, it may not get enough current Ayla Networks, Inc. Proprietary 30

35 For additional information about how to use the Design Kit, please visit the Ayla Networks Support website: 1. Sign-in with your Developer account credentials. 2. Search for the Hello World document in the search bar. The Hello World (AY006GHW2) document walks through steps needed to successfully enable a new property on the Design Kit and the Ayla Cloud service. The document provides an end-toend view of how the Ayla Platform enables cloud connectivity. For more information on how to get started with the Ayla Platform, please reach out to our support team at: support@aylanetworks.com 2017 Ayla Networks, Inc. Proprietary 31

36 4250 Burton Drive, Santa Clara, CA Phone: Fax: Ayla Networks, Inc. Proprietary 32