Plugin guide

Overview

The platform currently provides the following plugins: Device Panel, Cloud Timer, Local Timer, Device Message History, and Feedback.

Use plugins

1. Before using plugins, create a private app. For more information, see Create a private app.

2. On the SDK and Plugins page in the App Interface of your OEM app, select a plugin and generate the code. This is the procedure for updating plugins.

   • If you are using the plugin for the first time, click Generate Code and copy the plugin code and parameters into your app to integrate the plugin.

   • When an update message, such as "Latest version v1.0.xx", appears next to a plugin, it indicates that a new version is available. To use the latest plugin features, click the message to update the plugin.

3. Copy the plugin routing code and paste it into your app.

   • Each plugin has specific SDK dependencies that must be obtained from App SDK.

     Note

     If you log on to the console with a regular developer account, you can request an App SDK by email. For more information, see Obtain an App SDK.

   • Multi-language support: All plugins support internationalization. When the app language is switched, the plugin language switches accordingly.

   The following code provides an example.

   • Android

     import android.os.Bundle;
     import com.aliyun.iot.aep.component.router.Router;
     
     ...
     
     String code = "link://router/devicenotices";
     Bundle bundle = new Bundle();
     bundle.putString("key","value"); // Pass plugin parameters. This line is not required if there are no parameters.
     Router.getInstance().toUrlForResult(getActivity(), code, 1, bundle);
                                     

   • iOS

     #import <IMSBoneKit/IMSRouter/IMSRouter.h>
     [[IMSRouterService sharedService] openURL:[NSURL URLWithString:@URL_to_redirect] options:nil];
     
     ...
     
     NSURL *url = [NSURL URLWithString:@"link://router/connectConfig"];
     NSDictionary *options = @{@"key": @"value"}; // Pass plugin parameters. This line is not required if there are no parameters.
     [[IMSRouterService sharedService] openURL:url options:options completionHandler:^(BOOL success) {
         if (!success) {
             [self ims_showHUDWithMessage:[NSString ls_loadFailed]];
         }
     }];
                                     

Update plugins

If a plugin, such as Local Timer, works with your device firmware, ensure that the firmware upgrade is compatible with older versions before you update the plugin. Otherwise, issues may occur for online devices. Proceed with caution.

Plugin parameters

• Device Panel

  Parameter	Type	Description
  iotId	String	The device ID. This parameter is required.

• Cloud Timer

  Parameter	Type	Description
  iotId	String	The device ID. This parameter is required.

• Local Timer

  Parameter	Type	Description
  iotId	String	The device ID. This parameter is required.

• Device Message History

  Parameter	Type	Description
  iotId	String	The device ID.

  • If you pass a device ID, the message history for a single device is returned.

  • If you do not pass a device ID, the message history for all devices attached to the user is returned.

• Feedback

  Parameter	Type	Description
  mobileModel	String	The mobile phone model.
  mobileSystem	String	The mobile phone operating system.
  appVersion	String	The app version.

Feedback details

• App users

  • The feedback home page displays devices associated with the current user. Click a device to select a feedback type.

  • Select a feedback type for the device. The available problem types are: Report a failure, Suggest a feature, and Other issues.

  • Enter the feedback information. A problem description is required.

  • After you submit the feedback, you can view it in the feedback history. A red dot indicates a new reply.

  • View the feedback details in the feedback history.

• Merchants

  Merchants can view user feedback in the Operations Hub of the IoT Platform console. Product names are displayed for merchant accounts but are not displayed for Alibaba Cloud employee accounts. For more information, see User feedback.