English
English
简体中文
Contact Us
Register
Log In

Tuya IoT Development Platform

layoutIndex

Create an OEM App for Smart Life

Last Updated on : 2022-07-14 06:31:36download

This topic describes how to create, configure, and launch an OEM app for smart life on the Tuya IoT Development Platform.

Build an OEM app

Create an app

  1. Go to Tuya IoT Development Platform > App Creation.

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

    Create an OEM App for Smart Life

  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
    Edition Type Choose between the following edition types to fit your needs:
    • Basic Edition: provides all features of the Smart Life app for you to quickly build a branded IoT app.
    • Advanced Edition: Push the boundaries of quick build of branded IoT apps and take your app customization to the next level, powered by Siri voice assistant and other capabilities.
    For more information, see OEM App Plans on Tuya IoT Development Platform.
    Advanced Edition
    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. Smart app
    Package Name for Android, Bundle ID for iOS The unique identifier used for launching apps on 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 on an app store, the app cannot be launched on that app store. Recommend letters and numbers. Three sections are recommended. Each section is separated from the other sections with periods (.) and starts with a letter. The characters such as “tuya” cannot be used. For example, if the Tuya domain name is tuya.com, the package name can be set to com.tuya.smart. com.testapp.smartiot
    App Schema Optional. If not specified, the app schema is automatically generated based on the package name or bundle ID. The app schema 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 URL of the QR code to print. Auto Generated
    Targeted Locations
    Required. You must select the countries or regions where your app is available. This setting determines the available configurations and installation packages to be built in subsequent steps. You can click each option to view details.
    The Global option is described as an example in the following sections.
    Global
    Create an OEM App for Smart Life
  4. Click OK.

Customize UI

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

  1. Set App Icon.

    • Only .png files are supported. 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 app icon in the previous step. You can also upload a preferred page to change the existing one.

    Splash screen for iOS:
    You can upload one image or merge images. 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.

    • Only .png files are supported.

    • Image dimensions: 1244 × 2688 pixels.

      Create an OEM App for Smart Life

    Splash screen for tablets: For the template versions 3.32.5 and later, you can purchase the Adapt to Tablet feature. After the subscription, the Set Splash Screen for Tablet section appears below the settings for iOS. For more information, see Adapt to Tablet Features and FAQ.

    • Only .png files are supported.
    • Image dimensions: 2732 × 2048 pixels.

    To preview the default effect, click Restore Default. Then, the system will display the default splash screen for tablets with a white background image that adapts to your app icon.

    Create an OEM App for Smart Life

    Splash Screen for Android:
    You can upload one image or merge images. 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.

    Create an OEM App for Smart Life

    If the Adapt to Tablet feature has been enabled and the Merge Images mode is selected, you must upload a new background image of the splash screen for Android without a logo. After the settings are saved, the app will merge the uploaded background image and the logo on the splash screen into a splash screen that adapts to the aspect ratio of the current tablet.

  3. Set Style and Theme.

    • 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 five preset theme schemes, or customize a color scheme.

    • 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.

      • The setting at Details > Personalized Colors cannot be the same as the setting at Theme > Background Color.
      • The setting at Theme > Theme Color cannot be the same as the setting at Theme > Background Color.
      • The setting at Details > Background Color of Tab Bar cannot be the same as the setting at Page > Tab Icon > Font Color of Active Tab Label.

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

      Create an OEM App for Smart Life

      After you subscribe to the Advanced Edition or purchase the value-added service Custom App Tools of the app, more options are available as shown in the following figures. Specifically, you can configure:

      • Paid styles and theme templates

      • Homepage and other components defined on your terms

      • Background images of the homepage and other main pages

      • Text color transparency, and right-angle or round corners of cards, buttons, and dialog boxes

        Create an OEM App for Smart Life

        Create an OEM App for Smart Life

        Create an OEM App for Smart Life

      The following table shows Previews A and B of each advanced setting for your reference.

      This configuration does not apply to specific control panels and webpages.

    Item Preview A Preview B
    Background color of cards Create an OEM App for Smart Life Create an OEM App for Smart Life
    Background color of dialog boxes Create an OEM App for Smart Life Create an OEM App for Smart Life
    Background color of tab bars Create an OEM App for Smart Life Create an OEM App for Smart Life
    Text transparency of headlines Create an OEM App for Smart Life Create an OEM App for Smart Life
    Text transparency of headings Create an OEM App for Smart Life Create an OEM App for Smart Life
    Text transparency of notes Create an OEM App for Smart Life Create an OEM App for Smart Life
    Text transparency of expiration prompts Create an OEM App for Smart Life Create an OEM App for Smart Life
    Right-angle or round corner of cards Create an OEM App for Smart Life Create an OEM App for Smart Life
    Right-angle or round corner of buttons Create an OEM App for Smart Life Create an OEM App for Smart Life
    Right-angle or round corner of dialog boxes Create an OEM App for Smart Life Create an OEM App for Smart Life

    • When the template version used by your app is v3.25.2 or later, the dark theme can be enabled after you subscribe to the paid service. App users can choose Me > Settings > Dark Mode to select the mode or follow the system settings. If the app follows the system settings, the app will switch the dark mode on or off to match system settings.

      Create an OEM App for Smart Life

  4. Set Page.

    When the template version used by your app is v3.33.5 or later, you can select a recommended template for each of the Home, Automation, Tap-to-Run, Me, and Login and Register pages, or customize the page style as desired. You can go to Page and select the desired page to be configured.

    Create an OEM App for Smart Life

    The system displays the settings available for the page in the left-side pane. You can set the style of different components to be displayed on the page.
    For example, you can configure “Home” through the following steps:

    1. Set the switch next to a component to enable or disable the component.

    2. After the component is enabled, select a style for the component as needed.

    3. In the right-side pane, drag and drop the component on the previewed page to a specific location and arrange the layout of the components on this page.

      Certain components (such as the mall component) can be used normally only after specific settings. You can click the icon “!” next to the component and check how to use the component.

    4. After all desired settings are finished, in the top right corner of the page, click Save, rebuild the app, and then install it on a mobile phone to view the latest custom app.

      Create an OEM App for Smart Life

  5. Set Tab Icon.

    Tuya provides default icons. Also, you can upload the desired icon. If the template v3.33.5 or later is used, the tab icons of the lighting scenes and recipe features can be set, and certain tab icons can be sorted.

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

    As shown in the following figure, an icon in the Default state represents an inactive icon.

    Create an OEM App for Smart Life

    These settings do not make all the tab icons displayed on the app. To display desired tab icons, go to Step 2: Set Functions > Tab Icon Features and enable their features. In addition to these steps, the Mall tab icon is displayed only after the target mall is bound with the current app in the Seller Center.

  6. Preview and make settings effective.

    After UI customization, in the top right corner of the page, click Preview, follow the instructions that appear to scan a QR code and download the app. Then, the app with the latest UI settings can be previewed.

    Create an OEM App for Smart Life

    • To try an OEM app with a few simple clicks, click Next: Set Functions after the preceding settings.
    • 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 functions

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

    Create an OEM App for Smart Life
    • 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.

    • 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.

  2. Third-Party Voice Assistants: If your product supports a smart speaker, you can select the required voice assistant, and add the name of the supported skill in the input box next to the name of the voice assistant. Then, choose Me > Third-Party Voice Services on the app to see the icon for navigation to the documents.

    Create an OEM App for Smart Life

    • If you select Customize Document Content, you can click Edit File to edit the document in a preferred language in the dialog box.

      Create an OEM App for Smart Life

      The preset text is displayed in the online editor. You can modify and save this template. Users can view the latest version of the text.

      To create a document in languages other than Chinese and English, you must first create the version in English and click the language drop-down list, select the required language, and then edit the content.

      Create an OEM App for Smart Life
    • If you enable Alexa and Google Assistant for your app, you must subscribe to the OEM skills for each of the voice assistants. Otherwise, the voice control might fail.
    • The Alexa app-to-app account linking is available. In the Support Alexa section, click the hyperlink Service Description for the desired capability to view the description or click Subscribe to purchase the service.
    • You can enable or disable the preferred voice-enabled service, or modify the document for the service without the need to rebuild the app.

  3. Tab Icon Features: Set whether to display the tab icons, except Home and Me, at the bottom of the app. These tab icons provide access to associated features.
    When your app template is earlier than v3.33.5, the Smart tab icon is available.
    When your app template is v3.33.5 or later, the Smart, Mall, Light, and Recipe tab icons are available.
    To display the Mall tab icon, in addition to the preceding settings, you must go to the Seller Center and bind the target mall with the current app. The Smart, Light, and Recipe tab icons can be displayed for you to use associated features after these feature options are set to Yes on the current tab.

    Create an OEM App for Smart Life

Configure the app

After you set functions for the app, click Next: Configure App to configure the features that are required for launching on 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.

Create an OEM App for Smart Life

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 IoT Development 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 on app stores. However, to optimize your tests and experience, you can click Build to build the app for tests in advance.

    Create an OEM App for Smart Life

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

    Click Get QR Code to download and share the QR code of the test package with other internal users for tests. The QR code is available only within a validity period and only used for testing within your organization.

    Create an OEM App for Smart Life

  • 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.

    Create an OEM App for Smart Life

Trial app

The trial app is created and configured on the Tuya IoT Development 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 on 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 on app stores.

Purchase the OEM App service

If your app passes the test, you can launch the app on 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.

    Create an OEM App for Smart Life

    • Select App: Select the app to be purchased. Check the Application Object option and other details carefully to purchase the right service.
    • Verify the country or region and currency.
  2. Check and confirm the order information. If all the information is correct, you can 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.

Create an OEM App for Smart Life

  • 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 IoT Development 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 Subscriptions 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 marketing tools for the app.

Launch the app

Method 1: Purchase the app launching service

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

    Create an OEM App for Smart Life

    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 App Certificate and Push Certificate.

    Create an OEM App for Smart Life

  • 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.

    Create an OEM App for Smart Life

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.

    Create an OEM App for Smart Life

    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 IoT Development 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.

      Create an OEM App for Smart Life

  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 on 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, the versions in English are required.

Tuya’s privacy policy and user agreement templates are for reference only. Upload your versions of the privacy policy and user agreement with accurate and legal content. If you follow the entire content of the template, Tuya shall not make any representations or warranties as to the applicability and application results of the specified template. To meet the mandatory regulatory requirements and improve privacy protection, Tuya will modify and launch the template content from time to time. You must check and update your privacy policy and user agreement if you follow the template content.

Create an OEM App for Smart Life

Certificate for iOS

If you want to launch your app on 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.

Certificate for Android

To launch your app on 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.

Optional setting

Devices

Currently, you can choose the category of the devices to be paired. Standard View is selected by default. For this category, the same pairing list and guide content as the Smart Life app are used. In the standard view, you cannot modify the pairing list and guide content.

Create an OEM App for Smart Life

After the app is built, template A v3.24.6 is used as an example. You can click a device icon to add the device. The following figure shows the example in the standard view.

Create an OEM App for Smart Life
  • If you have less than 10 categories, you can choose Tile View. Users do not need to switch categories. All available product categories are easily visualized.

    Create an OEM App for Smart Life
  • If you have multiple product categories, you can choose List View. Users can quickly find the pairing entry of the target product category by classification, and pair devices under the guidance.

    Create an OEM App for Smart Life

Customize specific steps

  1. Click Create Custom Category. In the Custom Category for Pairing dialog box, select the product to be associated with the category.

    Create an OEM App for Smart Life
  2. If no product has been created for the current space account, the product cannot be associated. You must create a product first or choose Add Standard Category. For more information about how to create a product, see Create Products.

    After the association, during pairing with the specified category, the app user can see pairing guidance. Accurate pairing guidance can improve the success rate of pairing.

  3. After the product is associated, the category icon will default to the icon of the associated product. Also, you can upload other icons.

    The category name can be customized. The default names in Chinese and English are required. After the creation is successful, you can set the category name in other languages in the dialog box that appears.

    Create an OEM App for Smart Life
  4. Click a category to see an icon with three lines on the left side of the category. Click and hold the icon to sort the specified category.

    Create an OEM App for Smart Life
  5. Click Setup Instructions in the Operation column to navigate to the pairing wizard of the product. You can improve pairing wizard content by following actual pairing steps and things to note.

  6. Click the icon with three dots in the Operation column to view more operation items.

    1. Click Multilingual to navigate to the multilingual configuration page for the pairing list.
    2. Click Modify to modify the specified information in the dialog box.
    Create an OEM App for Smart Life
  7. Click Delete. In the dialog box that appears, click OK to delete the category. The deletion operation immediately takes effect. Proceed with caution.

Add a standard category

  1. Click Add Standard Category. In the dialog box, add the required standard categories to the Selected column.

    Create an OEM App for Smart Life
  2. You cannot modify the icon, name, and pairing guidance of a standard category. You can only sort the list of paired devices or delete the category.

Push notifications triggered by third-party devices

  1. Third-party push notifications
    Currently, LINE push notifications are supported. After users’ devices trigger conditions that match predefined push notification rules, users can receive push notifications from the LINE app. For more information, see Integrate with LINE Notification.

  2. Third-party login
    Configure Biometric Login: OEM apps allow biometric login after this service is enabled. This way, users can log in to the apps without entering the account and password. For more information, see Enable Biometric Login.

    App Store requires that both Apple login and third-party login must be enabled for the same apps. You can enable the third-party login in the Apple certificate.

    • Users in mainland China can log in to your app with Tencent QQ and WeChat accounts.
    • Users in other countries or regions can log in with Facebook, Google, or LINE accounts. If a user logs in with a Facebook account, a minimum activity level is required. If the lower limit is not reached, the authorization might be revoked and the user cannot log in to the app with a Facebook account. For more information, see Facebook Login Application. Create an OEM App for Smart Life

Malls

This page displays the malls that are associated with the app, including the multilingual navigation name and mall center name.

If you have not subscribed to the mall service, you can subscribe to the trial version first.

More

  • Simultaneous Login on Devices: You can choose whether to enable simultaneous login on multiple mobile phones with the same account.

  • Support Tuya’s Generic Skills: You can choose whether to enable Tuya’s generic skills and allow smart speakers to control devices.

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. It must be the URL of the app details page that appears on each app store.

The QR code of one download URL must be configured before the QR code can be displayed. You can get the download URLs from the app stores. Only after the download URL of each operating system is set, the mobile phones of the respective operating system can scan the QR code, and visit the download URL to download the app.

Create an OEM App for Smart Life

Update notification

You can configure the update notification feature. This way, when your app updates are released, update notifications are sent to app users. The users can determine whether to update the app. For more information, see Configure Upgrade Notification Push.

Create an OEM App for Smart Life

Debug the allowlist

If your app uses the template version v3.20.0 or later, the setting bar will appear. You can add an app account in mainland China to the allowlist. Users can choose Me > Settings > Multilingual Debug Mode in your app. This allows users to check the latest updates of UI text. For more information, see What is the debug allowlist?

Multilingual settings

Currently, you can modify all entries in the same task and modify specified entries online.

  • Method 1 (batch modification): You can export the spreadsheet of the app UI entries, modify the content in this file, and then upload the edited file.

  • Method 2 (individual modification): You can search for the specified entry with UI text and modify it.

    For more information, see App Multilingual Introduction.

Subscribe to template updates

The OEM app can be iterated and updated. After you enable App Update in the OEM App section of Subscriptions, your specified email address will receive notifications of the template updates.

Currently, up to 30 email addresses can be set in the same subscription.

Create an OEM App for Smart Life