Introduction to the App SDK

更新时间:
复制 MD 格式

You can select the required SDK package components for your product. The platform automatically generates an SDK package. You can then download and integrate the package to start development.

Overview

The SDK package provides the following features: a basic package, user accounts, message push, device control, network provisioning User Interface (UI) development, and a Bluetooth Breeze solution. The basic package and user accounts are selected by default. We recommend that you also select message push, device control, and network provisioning UI development. You can select the Bluetooth Breeze solution as needed.

Note

If you are logged on to the IoT Platform as a regular developer, you must request the App SDK by email. For the email template, see Obtain the App SDK.

SDK package introduction

  • Basic package

    This is a required SDK that lets you call official IoT services.

    SDK name

    Type

    API Channel SDK

    Android

    iOS

    User Identity Authentication SDK

    Android

    iOS

  • User account

    This component helps you quickly build an account system for user registration and logon. If you have an existing account system, you can integrate it by performing simple configurations on our platform.

    If you do not have an account system, you can use our built-in one. The built-in system can be called directly without any configuration and includes logon IDs, mobile numbers, email addresses, nicknames, profile pictures, and gender information.

    SDK name

    Type

    Account and User SDK

    Android

    iOS

    For more information, see User account development guide.

  • Message push

    The app can receive push messages from the device or the cloud.

    SDK name

    Type

    Mobile Push SDK

    Android

    iOS

    For more information, see Mobile Push development guide.

  • Device control

    This component lets you monitor and control device status. For example, you can report device status to the cloud and control devices from the cloud or an app.

    SDK name

    Type

    Thing Specification Language Model SDK

    Android

    iOS

    Persistent Connection SDK

    Android

    iOS

  • Network provisioning UI development

    This component includes the SDKs and a complete set of sample UIs that are required to develop a network provisioning UI for Wi-Fi, Ethernet, or cellular networks. You can use it with the standard device-side network provisioning solution.

    SDK name

    Type

    Network Provisioning SDK

    Android

    iOS

    BoneMobile Container SDK

    Android

    iOS

    The network provisioning UI development guide describes two methods. For more information, see Network provisioning development guide.

    • Develop natively

    • Call the complete network provisioning plugin provided by the platform

  • Bluetooth connection solution

    This solution lets you connect Bluetooth devices. It provides a framework SDK with general-purpose connection capabilities for your app. The SDK includes the features of the Bluetooth Breeze SDK and Bluetooth Over-the-Air (OTA) SDK. It also integrates Thing Specification Language model parsing. You can use a bridging solution to connect to non-Breeze devices.

    SDK name

    Type

    Thing Specification Language Model SDK

    Android

    iOS

    For Bluetooth device developers, see Bluetooth device-side development.

SDK and API mapping

The following table shows the mapping between SDKs and APIs.

SDK name

API service name

API Channel

Official Basic Service

Persistent Connection Channel

Application and Plugin Service, Persistent Connection Push Service

User and Account

User Service

Mobile Push

Mobile Push Service

BoneMobile Container

Application and Plugin Service

User Authentication SDK

User Service

Mapping between SDKs and API levels in plugins

  • Configurable panel plugin

    Official SDK dependency

    Minimum supported SDK Level

    Notes

    Account and User

    3

    -

    API Channel

    3

    -

    BoneMobile Container

    3

    -

    Thing Specification Language Model

    3

    To use Bluetooth devices, upgrade the API Level to 4 or later and integrate the Bluetooth SDK.

    Persistent Connection Channel

    3

    -

  • Network provisioning plugin

    Official SDK dependency

    Minimum supported SDK Level

    Notes

    Account and User

    3

    -

    API Channel

    3

    -

    BoneMobile Container

    3

    -

    Network Provisioning SDK

    3

    To use Bluetooth for network provisioning, upgrade the API Level to 4 or later and integrate the Bluetooth SDK.

    Persistent Connection Channel

    3

    -

  • Standard socket panel, Standard light panel, and Standard switch panel

    Official SDK dependency

    Minimum supported SDK Level

    Notes

    API Channel

    3

    -

    BoneMobile Container

    3

    -

    Thing Specification Language Model

    3

    -

    Persistent Connection Channel

    3

    -

    Mobile Push

    3

    -

  • Local countdown, Local timer, Cloud timer, Device message records, Device settings, and Automation scenarios

    Official SDK dependency

    Minimum supported SDK Level

    Notes

    Account and User

    3

    -

    API Channel

    3

    -

    BoneMobile Container

    3

    -

  • Feedback

    Official SDK dependency

    Minimum supported SDK Level

    Notes

    API Channel

    3

    -

    BoneMobile Container

    3

    -

    Thing Specification Language Model

    3

    -

    Persistent Connection Channel

    3

    -

    Mobile Push

    3

    -