Sweeper SDK

Tuya Sweeper SDK provides the APIs to enable the functionality of robot vacuums. For example, get the cleaning maps, routes, and historical maps. You can integrate the SDK with your project based on Tuya Smart Life App SDK. For more information, see Fast Integration with Smart Life App SDK for iOS.

Feature overview

The Sweeper SDK supports gyroscope, vision, and laser robot vacuums. The following features are provided:

• Sweeper SDK: Provide capabilities to transmit real-time data through channels and return full data.

• Gyroscope and vision robot vacuums: Return real-time data through streams and dynamically report incremental data from smart robot vacuums over Message Queuing Telemetry Transport (MQTT).

• Laser robot vacuums: Transmit large amounts of full data in real time that is not suitable for MQTT-based streams. The robot vacuums report full cleaning data including maps and routes to the Tuya IoT Development Platform. The data is stored in binary files. The file storage path on the app server is published over MQTT.

Preparation

The Sweeper SDK serves your development as an extension of the Tuya Smart Life App SDK. Before you start development, register a developer account on the Tuya IoT Development Platform, create a product, and then get the key used to integrate with the SDK. For more information, see Preparation.

Fast integration

1. Add the following code block to the Podfile:

   platform :ios, '9.0'
   
   target 'your_target_name' do
   	pod "TuyaSmartSweeperKit"
   end
   

2. In the root directory of your project, run pod update to integrate with a third-party library. For more information about CocoaPods, see CocoaPods Guides.

Import header files

• Add the following content to the project file PrefixHeader.pch:

  #import <TuyaSmartSweeperKit/TuyaSmartSweeperKit.h>
  

• Add the following content to the bridging header file xxx_Bridging-Header.h for a Swift project:

  #import <TuyaSmartSweeperKit/TuyaSmartSweeperKit.h>
  

Terms