Create an OEM App for Smart Residence

This topic describes how to create, configure, and launch an OEM app for Smart Residence on the Tuya Developer Platform.

Build an OEM app

Create an app

1. Go to the App Creation page on the Tuya Developer Platform.

2. Click Create App. In the Select OEM App Type dialog box, click Create for the Smart Residence category.

   

3. In the dialog box that appears, enter the app information, and carefully read and accept terms in OEM App Service and Software License Agreement.

   Option	Description	Example
   App Name	The app name will be displayed on the user’s mobile phone home screen. We recommend that you enter a name within six characters in Chinese or 12 characters in English. If the specified maximum length is exceeded, app users cannot view the full name.	A branded smart product app
   Package Name for Android, Bundle ID for iOS	The unique identifier used for launching apps in app stores. Try to include the organization’s domain name to ensure a unique package name or bundle ID. If the package name or bundle ID already exists in an app store, the app cannot be launched in the app store. Recommend letters and numbers. Three sections are recommended and they can be separated from each other with periods (.). Each section starts with a letter. The characters such as “tuya” cannot be used. For example, if Tuya’s domain name is tuya.com, the package name can be set to com.tuya.smart.	com.testapp.smartiot
   Channel ID	Optional. If not specified, the channel ID is automatically generated based on the package name or bundle ID. The channel ID cannot be modified after it is confirmed. It is mainly used to evoke this app on the mobile phone, and is also related to the link of the QR code to print.	-

   

4. Click OK.

Customize the UI style

The user interface (UI) configuration determines the app icon and appearance.

1. Set App Icon.

   • Only square images in the .png format are supported. Do not upload images with transparent backgrounds. Otherwise, a display error might occur.
   • The dimensions must be 1024 × 1024 pixels.

2. Set Splash Screen for iOS and Splash Screen for Android.

   A splash screen is automatically generated after you upload the logo. You can also upload a preferred page to change the existing one.

   • Only the .png format is supported.

   • Upload: You can upload an image with dimensions equal to or higher than 1242 × 2688 pixels. Images of different dimensions can be separately uploaded.

     

     On the Splash Screen for Android tab, you can select the Merge Images mode. In this mode, the app automatically merges the uploaded images as previewed into a splash screen for the current aspect ratio. This can avoid image distortion that might occur when a splash page is loaded on the mobile phone with a special aspect ratio.

     

3. Set App Theme Color.

   • When the template version used by your app is earlier than v3.23.5, you can set the theme color of the app. You can choose from 21 preset color schemes, or customize one.

   • When the template version used by your app is v3.23.5 or later, and earlier than v3.25.2, you can set the theme color, background color, text color, round corner style, and other preferred styles.

     Some items are Advanced Settings. They are available only after you subscribe to value-added services. Otherwise, the default configuration takes effect or the preset configuration is automatically used according to the specified background color.

   

4. Set App Tab Icon Settings.

   Tuya provides default icons. Also, you can upload the desired icon.

   You can upload your own six icons in the .png format. The dimensions must be 108 × 108 pixels.

   The following figure shows the configuration:

   • Default: previews an inactive icon.
   • Active: previews an active icon. You can customize the font color of an active tab label.
   

5. More Custom Settings: Tuya provides default icons. Also, you can upload a desired icon.

   • Login/Sign-Up Logo: The logo must be in the .png format, with the dimensions of 400 × 400 pixels.

   • Empty Upload List: the background image that appears when no list is displayed on the home screen. The file must be in the .png format, with the dimensions of 360 × 360 pixels.

   • Default Avatar: the default avatar on the Me tab of the app. The file must be in the .png format, with the dimensions of 144 × 144 pixels.

   • Login/Sign-Up Background: The file must be in the .png format, with the dimensions of 1080 × 1920 pixels. Currently, the button font color on this page is fixed. You must upload the image and confirm the preview effect. We recommend that you change the background.

     • To try an OEM app with a few simple clicks, click Next: Set Functions after the preceding configurations.
     • You can use the default settings of the basic functions or modify the settings. Click Next: Configure App to further configure the app, choose Next: Build App > Build, wait until the app is built, and then test the app. Each version can be built up to 10 times a day and up to 30 times a month.
       :::
   

Set the functions

1. Extended Functions: You can choose whether to enable or set the functions.

   

   • About Us: You can enter your official website URL in the format of https://. If the URL does not start with https://, this page cannot be opened on the app. Currently, only the pages in Chinese and English are supported. To navigate to a page in another language, enter the URL in the field for the English language.

   • Copyright Information: To add the copyright information to the app, tap Me at the bottom of the page, tap the setting icon in the top-right corner of the page, and then tap About. Currently, only Chinese and English are supported.

   • Registration-free Mode: After this function is enabled, users can use certain functions of the app without the need to register. After the account information is completed, the information such as the device bound in the unregistered account applies to the new account. Currently, the function is available for a free trial. However, a subscription will be required later before this function is enabled. The enabled apps will not be affected.

   • User Agreement: Due to the rules of the major app stores, it is enabled by default. After it is enabled, the logged-in user can also view the latest version of the user agreement.

   • Smart Scenes: You can choose whether to enable the function.

   • Scan: You can choose whether to enable the function.

   • Bluetooth Mesh: You can choose whether to enable device pairing over Bluetooth. If you disable the Bluetooth mesh service, make sure that the devices to be paired do not include Bluetooth devices.

   • Gesture Password: You can choose whether to enable this function of the app. If it is enabled, users can use the gesture password to lock and unlock the app and enhance security.

   • Dashboard Weather: You can choose whether to enable the function.

   • Privacy Policy: Due to the rules of the major app stores, it is enabled by default. After it is enabled, the logged-in user can also view the latest version of the user agreement.

Configure the app

After you set functions for the app, click Next: Configure App to configure the features that are required for launching in app stores and subscribe to and configure the recommended services. You complete the configurations as needed. You can also simply click Next: Build App to build and test the app and complete the required configurations later.

Build the app

In the step of Build App, after you click Build, the system builds each app package or bundle in the sequence of application time. The estimated build time appears on the page. After the app is built, the system pushes the build result to your account of the Tuya Developer Platform by email or SMS.

• Launch Checklist: When you visit this page for the first time, this page displays the required configuration items for your app to be launched in app stores. However, to optimize your tests and experience, you can click Build to build the app for tests in advance.

  

• If the app is built, you can use your mobile phone to scan the QR code to download and install the app for tests. The QR code automatically identifies your mobile phone operating system, and supports both Android and iOS.

  

• In the very rare case that the build fails, an error message is returned to help you troubleshoot the error. You can also submit a ticket to request technical support.

  

Trial app

The trial app is created and configured on the Tuya Developer Platform through the above process. After the app is built, you can scan the QR code for the trial version to download and install the app on your mobile phone.

• The trial app is valid for 30 days from the date of creation. The trial app cannot be edited or built after expiration, and the installed app on the mobile phone cannot be used as expected.
• The installation package of the trial app cannot be used to launch the app in app stores. You must purchase the OEM App service and complete the required configurations before the app can be launched.

Official app

If you have already purchased the OEM App service, ignore this step and launch the app in app stores.

Purchase the OEM App service

If your app passes the test, you can launch the app in app stores. If the OEM App service is not purchased, you cannot get the installation package for launching. After the trial app expires, you cannot continue to use the app.

1. Click Purchase OEM App and follow the instructions on the page to place an order and complete the payment.

   
   • Select App: Select the app to be purchased.
   • Tel: Enter the phone number of the contact person.
   • Email: Enter the email address of the contact person.
   

2. After the information is confirmed, click Buy now.

   • Confirm Order: If your OEM app has been paid offline, provide your order number and contact the Tuya staff to bind the payment.

   • Invoice information: You can choose whether to request an invoice. If you want an invoice, provide the invoice information after the service is completed and contact the Tuya staff to get an invoice.

   

3. After you select the payment method and complete the payment, you can return to the studio and continue to configure your app.

   

App overview

After you subscribe to the OEM App service, enter the app overview page from the OEM app list and update the following information as needed.

• Modify App Name: Currently, the name can be set only in Chinese and English. If the name in Simplified Chinese is not specified, the name in English is displayed.

• History Version: If you have created two or more versions of your app, click History Version to view the configuration information of the historical versions.

• Change Template: If the template version of your app is earlier than the latest template on the Tuya Developer Platform, you can choose Change Template > Update to select the latest template. The updates take effect only after you rebuild the app. Click View Release Notes to view the functions of the latest template.

  If you want to get notified of the latest template, you can subscribe to App Update notifications from the Subscribe service.

• Continue: Click here to enter the last configuration page of the latest version.

• Recommended Value-Added Services: If you want to subscribe to more functions of the app, you can view and subscribe to desired services.

• App Operations and Data: You can view the app analytics and feedback from the users and check information about the knowledge base for the app.

Launch the app

Method 1: Purchase the app launching service

• When the app test is finished, click Next: Launch App.

  
  After you modify the content in the development step, such as UI and extended functions, you must rebuild the app.

• If you have not purchased the launching service, we recommend that you purchase this service in advance. Because certain required functions of the app depend on third-party platforms, we provide related configuration services for Location, App Certificate, and Push Certificate.

  

• If you have already purchased the launching service, the system will display a prompt, and the Tuya staff will contact you. You can ignore the steps for launching and the Tuya staff will complete the follow-up operations.

  

Method 2: Launch the app by yourself

1. After the app test is finished, click Next: Launch App. The system automatically checks the required items. When the app is not fully configured, you will be prompted to configure it. You can click Configure for each item to complete the required configurations.

   

   Note: As long as any configuration item is modified, the app must be rebuilt to make the modification effective. After the configuration is completed, you can rebuild the app. To accelerate the build process, we recommend that you complete all the configurations at once before building.

2. After the app is built, uninstall the previous app version and install the latest version for testing. Check whether the push notifications and map function for Android take effect, and continue to launch the app. Push notifications for iOS can only be tested after the app is launched.

3. You can upload and download the bundle for iOS on the Tuya Developer Platform. To pass the strict review of apps for iOS, carefully read the operation manual and launch your app with respect to the specifications.

   The installation package for Android supports Android (mainland China) and Google Play-specific packages. Starting August 2021, new apps will be required to launch with the Android App Bundle on Google Play.

   • By default, the Android (mainland China) package includes the AutoNavi map service. It allows login with WeChat and Tencent QQ accounts and supports push notifications for multiple mobile phone brands.

   • The Google Play-specific package includes Google Maps and push notification services.

     

4. (Optional) You can submit a ticket to consult and solve the problems when you launch the app.

5. After your app has passed the review, click Launched at the bottom of the page to confirm that the app has been launched in app stores.

Required setting

To launch your app, the following functions are required.

User agreement and privacy policy

Click Add Version. You must provide the custom content of the privacy policy and service terms.

Tuya provides Template Reference in multiple languages including Chinese, English, German, French, and Japanese. You can download and customize your content. To launch your app, versions in English are required.

Certificate for iOS

If you want to launch your app in the App Store, you must upload the required certificates. To create a certificate, you must register a developer account first. For more information, see the documents. If the certificate is not uploaded, the system will not be able to build an installation package or bundle, and the app cannot be launched.

• Auto Generate Certificates (recommended): This function is an auxiliary function. The certificate preparation process of the iOS certificate platform is complex. You can enable the automatic generation and upload of all certificates. You only need to enter the authorization information to quickly configure the certificates.

  

• Manually Create and Upload Certificates: For more information, see Create Certificates for iOS.

Certificate for Android

To launch your app in the Android app stores, upload the required certificates. To create a certificate, you must register an Android developer account first and configure the app as required by the app stores. For more information, see the documents. If the certificates are not uploaded, the system will not be able to build an installation package, and the app cannot be launched.

• App certificate

  • Re-signing for Android: App security can be improved after setting. For more information, see Resignature Configuration.

  • App Signing Certificate: You can apply the certificate to specific services. For example, you must provide the certificate to get the token that enables Login with Amazon (LWA).

• Set the Push certificate according to the location of the app user:

  • Google FCM: the certificate information that must be set when you use the Google Push service. For more information, see Register FCM.

  • To send push notifications to users in mainland China, you can use the Tuya push channel or Umeng push channel.

  In addition, to allow users to receive push notifications without the need to open the app, you must set up the branded system-level channel to push certificate information.

Map for Android

Click Get SHA-1 to get the related values, follow the instructions in Apply for Google Map Key and Apply for AutoNavi Map KEY to get the Google Map key or AutoNavi key, and then enter the key in the respective field.

Simultaneous login on devices

You can choose whether to enable simultaneous login on multiple mobile phones with the same account.

Common tools

QR code

A QR code can be printed on the outer packaging of the product and can be used properly even if the app is updated later. Make sure that the specified download URL is available. The app details page of each app store is preferred.