Texas Instruments SimpleLink Wi-Fi CC3 20 Series Manual de usuario

SWRU472A–February 2017–Revised April 2019

SimpleLink™ Wi-Fi®CC3x20 and CC3x35 Provisioning for Mobile

Applications

User's Guide

SWRU472A–February 2017–Revised April 2019

SimpleLink™ Wi-Fi®CC3x20 and CC3x35 Provisioning for

Mobile Applications

This user's guide describes Texas Instruments SimpleLink™ Wi-Fi®provisioning solution for mobile

applications, specifically on the usage of the Android™ and iOS®building blocks for UI requirements,

networking, and provisioning APIs required for building the mobile application.

Terms and Abbreviations

Abbreviation or Term Meaning and Explanation

AP Access Point

APIs Application Interfaces

Bcast Broadcast

HTTP Hypertext Transfer Protocol

JSON Javascript Object Notation

mDNS Multicast DNS

SC SmartConfig

UDP User Datagram Protocol

UI User Interface

Contents

1 Introduction ................................................................................................................... 2

2 Top-Level Architecture...................................................................................................... 4

3 Provisioning - SmartConfig™ .............................................................................................. 6

4 Android™ Block Diagram................................................................................................... 9

5 Provisioning – AP Mode................................................................................................... 14

6 iOS®versus Android™ Development Guidelines ...................................................................... 17

7 Porting Instructions......................................................................................................... 18

8 Settings...................................................................................................................... 19

9 Logger and Email........................................................................................................... 19

Trademarks

SimpleLink, Internet-on-a chip, SmartConfig, Texas Instruments are trademarks of Texas Instruments.

Bluetooth is a registered trademark of Bluetooth SIG, Inc.

iOS is a registered trademark of Cisco.

Android is a trademark of Google, Inc..

Wi-Fi is a registered trademark of Wi-Fi Alliance.

All other trademarks are the property of their respective owners.

Introduction

www.ti.com

2SWRU472A–February 2017–Revised April 2019

Submit Documentation Feedback

SimpleLink™ Wi-Fi®CC3x20 and CC3x35 Provisioning for Mobile

Applications

1 Introduction

1.1 Overview

This document describes the Texas Instruments SimpleLink™ Wi-Fi®provisioning solution for mobile

applications. The main focus of this document is on the usage of the Android™ and iOS®building blocks

for UI requirements, networking, and provisioning APIs required for building the mobile application.

The CC31xx and CC32xx devices are part of the SimpleLink™ microcontroller (MCU) platform which

consists of Wi-Fi®,Bluetooth®low energy, Sub-1 GHz and host MCUs, which all share a common, easy-

to-use development environment with a single core software development kit (SDK) and rich tool set. A

one-time integration of the SimpleLink™ platform enables you to add any combination of the portfolio’s

devices into your design, allowing 100 percent code reuse when your design requirements change. For

more information, visit www.ti.com/simplelink.

The first step in utilizing a CC32xx/CC31xx device in a Wi-Fi®-enabled application is to connect the device

to a Wi-Fi®network (access point). This process is called Wi-Fi®provisioning and it involves loading the

information of the access point (SSID name and security credentials) to the device. This process can be

complex considering that embedded Wi-Fi®applications generally lack user interfaces such as keypads or

touch screens.

www.ti.com

Introduction

SWRU472A–February 2017–Revised April 2019

SimpleLink™ Wi-Fi®CC3x20 and CC3x35 Provisioning for Mobile

Applications

Figure 1 illustrates a general overview of this procedure: a device which is not connected to the network,

but exists in the network range, can accept the information required for connecting to the network, using

the combination of the embedded application (see CC31xx, CC32xx SimpleLink™ Wi-Fi®Internet-on-a

chip™ Solution Device Provisioning) and the mobile application.

Figure 1. General Overview

Introduction

www.ti.com

4SWRU472A–February 2017–Revised April 2019

Submit Documentation Feedback

SimpleLink™ Wi-Fi®CC3x20 and CC3x35 Provisioning for Mobile

Applications

1.2 Provisioning Methods

Wi-Fi®provisioning is usually done once, either while connecting a new device to the network or after an

update on the local network which requires configuration changes. After the provisioning, the CC32xx

device saves the accepted Wi-Fi®information as an encrypted profile. Using this profile, the

CC3xxx/CC31xx device is able to automatically connect to the network when it is available as a Wi-Fi®

station.

There are two main provisioning methods to connect a CC3xxx device to a desired access point using TI's

mobile application for Wi-Fi®provisioning, Wi-Fi®Starter Pro:

• SmartConfig™ – Using the SmartConfig algorithm eliminates the need to know the CC32xx/CC31xx

device identity ahead of time. The process configures any listening device. Using this method, the user

does not need to know the device name, or any other device identity.

• AP mode – The mobile application connects to the device as a Wi-Fi®station, and sends the network

information for the desired network connection. By using this mode, the user should know which device

to connect to according to its published SSID, while functioning as an AP.

The user can select which mode to use using the Wi-Fi®Starter Pro app: SmartConfig™ or AP mode.

Wi-Fi®Starter Pro contains a Settings tab for handling configurations; switching between SmartConfig™

and AP mode is one of the options on this tab.

The preferred mode for the CC3200/CC3100 devices is AP mode. The preferred mode for the

CC3220/CC3235/CC3120/CC3135 devices is SmartConfig™.

2 Top-Level Architecture

2.1 Top-Level Blocks

Figure 2 illustrates the top-level architecture.

Figure 2. Top-Level Architecture

www.ti.com

Top-Level Architecture

SWRU472A–February 2017–Revised April 2019

SimpleLink™ Wi-Fi®CC3x20 and CC3x35 Provisioning for Mobile

Applications

2.2 Basic Provisioning Steps

There are four steps for completing provisioning:

1. User Inputs – The user provides information about the identity of the network.

2. Sending configurations – The mobile app sends network credentials to the device.

3. Finding the device on the network – The mobile app searches for the device. The device publishes

information such as services and device name, and responds to network queries.

4. Connecting to the device and getting feedback – The mobile app connects to the device over the

shared network, and confirms that the device is responding.

2.2.1 Step 1: User Inputs

This is the first step of the application. The mobile phone should be connected to the Wi-Fi®network

before the provisioning is activated.

If using a secured network, the mandatory fields for both options (SmartConfig™ or AP mode) are the

network SSID (usually the active Wi-Fi®connection of the mobile phone) and password.

If the device name is not set to a new value, then the default device name is used.

2.2.2 Step 2: Sending Configurations

The second step is to send the information to the non-configured device, using the active network. The

active network is the link between the Mobile phone and the Router.

In this case, the mobile app side is responsible for transmitting the information to the network while the

device listens to the information transmitted (even if it is a secured network). After verifying the validity of

the information, the device creates and stores a profile of this network that is kept on the device's storage.

The saved profile is now activated and connected to the network.

2.2.3 Step 3: Finding the Device on the Network

The third step is to find the IP address of the device after it is connected to the Wi-Fi®network, and

acquire an IP address from the DHCP server.

The mobile app uses three options for detecting the device on the network:

• Listening to UDP broadcast packets from the device specifying the name and IP address

• Listening to UDP multicast packets from mDNS on the network, and filtering by services supported by

the device

• Sending broadcast ping packets and catching ping response packets from the devices on the network

If the network is not totally isolated, the device will be detected and verified by the mobile application in

one or more of the three options described.

2.2.4 Step 4: Connecting to the Device and Getting Feedback

The final step is to check if the provisioning completed successfully. This is done by sending a query from

the mobile app to the device, asking for the provisioning results. This step is performed assuming the

device IP address is already known from previous step, and that the device supports HTTP requests.

After the query is sent to the device, there are several possible responses that can be received. A

successful response means that the provisioning completed. In case of a timeout or a failure, AP fallback

mode is automatically suggested to the user by the mobile application.

2.2.5 Fallback Step: Confirmation Failed

If the mobile app failed to connect to the device and receive feedback, the mobile app should connect to

the device directly. The app can act as an AP in case of a connection failure, and the device switches to

the configurations stage as normal. In this case, the device is configured but the confirmation feedback is

transferred using the direct connection.

Provisioning - SmartConfig™

www.ti.com

6SWRU472A–February 2017–Revised April 2019

Submit Documentation Feedback

SimpleLink™ Wi-Fi®CC3x20 and CC3x35 Provisioning for Mobile

Applications

3 Provisioning - SmartConfig™

3.1 Overview

TI's SmartConfig™ algorithm sends connection information to the device without a real connection.

SmartConfig™ is responsible for sending the data, and the networking blocks (ping, UDP listener, mDNS)

are responsible for getting the new IP of the connected device after the connection.

SmartConfig™ leverages the standard mechanisms present in Wi-Fi®to configure a CC32xx/CC31xx

device's association information on the fly, regardless of whether a user interface is available. In this

process, a Wi-Fi®-enabled device such as a smartphone, tablet, or a laptop sends the association

information to the CC32xx//CC31xx device.

Additionally, SmartConfig™ does not depend on the I/O capabilities of the host microcontroller, and thus

can be used by embedded applications. SmartConfig™ can be used to associate multiple devices to the

same AP simultaneously. Additionally, the configured device (such as a smartphone or tablet) stays

connected to the user’s home network during the configuration process (as opposed to other methods that

require disconnection).

www.ti.com

Provisioning - SmartConfig™

SWRU472A–February 2017–Revised April 2019

SimpleLink™ Wi-Fi®CC3x20 and CC3x35 Provisioning for Mobile

Applications

3.2 SmartConfig™ Flow Chart

Figure 3 illustrates the SmartConfig™ flow chart.

Figure 3. SmartConfig™ Flow Chart

Provisioning - SmartConfig™

www.ti.com

8SWRU472A–February 2017–Revised April 2019

Submit Documentation Feedback

SimpleLink™ Wi-Fi®CC3x20 and CC3x35 Provisioning for Mobile

Applications

3.3 SmartConfig™ Sequence

Figure 4 illustrates the SmartConfig™ sequence.

Figure 4. SmartConfig™ Sequence

www.ti.com

Android™ Block Diagram

SWRU472A–February 2017–Revised April 2019

SimpleLink™ Wi-Fi®CC3x20 and CC3x35 Provisioning for Mobile

Applications

4 Android™ Block Diagram

4.1 Overview

Figure 5 illustrates the Android™ block diagram.

Figure 5. Android™ Block Diagram

4.2 SmartConfig™ Initialization

The SmartConfig™ library contains a set of APIs to activate SmartConfig™. These APIs cover the

initialization of SmartConfig™ objects, and set configurations such as SSID, password, and start/stop

transmission.

The transmission works repeatedly until it is stopped. The repeated data transmission improves the

probability for success on a limited Wi-Fi®coverage network or on a congested environment.

Activate SmartConfig™ when the phone, the AP, and the target device are all on the same local network,

with no hidden devices. For example, if the phone is not within the range of the device, but both the

device and the phone are in the range of the AP. The device and the phone are hidden.

The SmartConfig™ command is activated by the following class:

Android™:

class SmartConfig

Android™ Block Diagram

www.ti.com

10 SWRU472A–February 2017–Revised April 2019

Submit Documentation Feedback

SimpleLink™ Wi-Fi®CC3x20 and CC3x35 Provisioning for Mobile

Applications

Table 1. Android™ Parameters

String Value

Listener A listener object, whose class derives from FirstTimeConfigListener base class; can be null.

FreeData Null in case of no device name.

If the device name exists, the first byte should be value 0x3, second byte specifies device string length,

and the rest are device name characters.

Key The Wi-Fi key to configure

EncryptionKey A key used by the protocol to encrypt the Wi-Fi key (must be shared with the target device); can be null

String IP Destination IP address of packets. This should be the IP address of the Wi-Fi access point or router.

String Ssid The Wi-Fi network name to configure

Group Group – should be 0

Token Token should be null

For example:

try {

smartConfig = new SmartConfig(smartConfigListener, freeData, passwordKey, paddedEncryptionKey,

gateway, SSID, (byte) 0, "");

} catch (SocketException e) {

Log.e(TAG, "Failed to create instance of smart config");

return;

}

iOS®:

class FirstTimeConfig::initWithData

Table 2. iOS®Parameters

String Value

String IP Destination IP address of packets. This should be the IP address of the Wi-Fi access point or router.

String Ssid The Wi-Fi network name to configure

FreeData Null in case of no device name.

If the device name exists, the first byte should be value 0x3, second byte specifies device string length,

and the rest are device name characters.

Key The Wi-Fi key to configure

EncryptionKey A key used by the protocol to encrypt the Wi-Fi key (must be shared with the target device); can be null.

numberOfSetups 4

numberOfSyncs 10

syncLength1 3

syncLength2 23

delayInMicroSeconds 10000

4.3 SmartConfig™ Transmission

Starts SmartConfig™ packets transmission, based on the init values.

transmitSettings()

For example:

smartConfig.transmitSettings();

Otros manuales para SimpleLink Wi-Fi CC3 20 Series

Este manual sirve para los siguientes modelos

Tabla de contenidos

Otros manuales de Hardware de computadora de Texas Instruments

Texas Instruments

Texas Instruments TIDA-010243 Guía

Texas Instruments

Texas Instruments controlCARD TMDSCNCD2800137 Manual de usuario

Texas Instruments

Texas Instruments Sub-1 GHz Sensor-to-Cloud Linux E14 Kit Manual de usuario

Texas Instruments

Texas Instruments Xilinx UG230 Manual de usuario

Texas Instruments

Texas Instruments ADS8365MEVM Manual de usuario

Texas Instruments

Texas Instruments TMAG5170D Manual de usuario

Texas Instruments

Texas Instruments CC2533 Manual de instalación

Texas Instruments

Texas Instruments TMS320DM355 Manual de usuario

Texas Instruments

Texas Instruments BoosterPack BOOSTXL-RS232 Manual de usuario

Texas Instruments

Texas Instruments DP83867E Manual de usuario

Texas Instruments

Texas Instruments Hercules RM48 Manual de usuario

Texas Instruments

Texas Instruments GC5328 Manual de usuario

Texas Instruments

Texas Instruments TRIS TMS37122 Manual de usuario

Texas Instruments

Texas Instruments PHP1500 Manual de usuario

Texas Instruments

Texas Instruments bq78350-R1 Manual de usuario

Texas Instruments

Texas Instruments XDS522 Manual de usuario

Texas Instruments

Texas Instruments TVP5154EVM Manual de usuario

Texas Instruments

Texas Instruments Jacinto 7 DRA829 Manual de usuario

Texas Instruments

Texas Instruments OMAP5910 Manual de usuario

Texas Instruments

Texas Instruments LM95172EVM Manual de usuario

Texas Instruments

Texas Instruments TPS65941213-Q1 Manual de usuario

Texas Instruments

Texas Instruments DRA821 Manual de usuario

Texas Instruments

Texas Instruments TMS320C6201 Manual de usuario

Texas Instruments

Texas Instruments CC3100 SimpleLink Manual de usuario

Manuales populares de Hardware de computadora de otras marcas

EMC2

EMC2 VNX Series Manual del propietario

Panasonic

Panasonic DV0PM20105 Manual de usuario

Mitsubishi Electric

Mitsubishi Electric Q81BD-J61BT11 Manual de usuario

Gigabyte

Gigabyte B660M DS3H AX DDR4 Manual de usuario

Raidon

Raidon iT2300 Manual de usuario

National Instruments

National Instruments PXI-8186 Manual de usuario

Hauppauge

Hauppauge WinTV-HVR-2250 Manual de usuario

Kontron

Kontron CP6002 Manual de usuario

Manhattan

Manhattan 702843 Manual de usuario

Aphex

Aphex 230 Manual de usuario

AMD

AMD Phenom II Manual operacional

Intel

Intel NUC 12 Pro Manual de usuario

dbx

dbx Zone Pro 1260 Manual de usuario

Galaxy

Galaxy GHDX2-2430S-24F4D Manual de usuario

Intel

Intel AXXRMFBU4 Manual de usuario

Kontron

Kontron DIMM-PC/MD Manual de usuario

ST X-NUCLEO-SAFEA1B Instrucciones de funcionamiento

STEINWAY LYNGDORF

STEINWAY LYNGDORF SP-1 Manual de usuario