Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

The remote control feature allows administrators to troubleshoot devices that are enrolled with WSO2 IoT Server using the device management console. You can create a remote session, send adb shell commands, view the device logs, and remotely view and interact with the screen of an Android device.

Let's take a look at how you can start using it.

Table of Contents

Tip
titleBefore you begin!
  • Make sure to enroll an Android device. For more information, see Android Device.
  • Make sure that your Android device supports the Android Lollipop (API level 21) version or above to use the screen sharing feature.
  • The enrolled device needs to be connected to the network at all times.

Create a remote session

Follow the steps given below to create a remote session between the device and WSO2 IoT Server:

  1. Start WSO2 IoT Server's core profile, which corresponds to the WSO2 Connected Device Management Framework (WSO2 CDMF) profile.

    Localtabgroup
    Localtab
    activetrue
    titleLinux/Mac/Solaris
    Code Block
    ./iot-server.sh
    Localtab
    titleWindows
    Code Block
    iot-server.bat
  2. Access the device management console: https://<IOTS_HTTPS_HOST>:9443/devicemgt
    For example: https://localhost:9443/devicemgt
  3. Sign in as an administrator. By default, the username is admin and the password is admin.
  4. Under DEVICES, click View.
    Image Added
    A page appears that lists all the devices that are enrolled with WSO2 IoT Server because you have administrator privileges. If you do not have administrator privileges, you only the see the devices that you enrolled.
  5. Click the device you want to troubleshoot.
  6. Click the Remote Session tab.
    Image Added
  7. Click Connect to Device to start a remote session with the device. 
    After the server connects to the device, you see the following screen:
    Image Added
  8. You can now troubleshoot the device as described in the next sections. To stop the remote sharing session, click Close Session.

Send adb shell commands

Android Debug Bridge (adb) is a command line tool that lets you communicate with an emulator or connected Android device. Follow the steps given below to troubleshoot the device using adb shell commands:

  1. If you haven't already set up a remote session, set it up now.
  2. Click Shell.
  3. Write the shell command (see adb shell commands for the available commands) and press Enter.
    For example, if you want to get the CPU and memory usage of the device, use the top adb command.
    Sample output:
    Image Added

View device logs

Logcat is a tool that displays messages from the device log in real time and keeps a history so you can view the old messages. Follow the steps given below to view the device logs.

  1. If you haven't already set up a remote session, set it up now.
  2. Click Logcat.

You can now see the log for the device. 

Image Added

View the device screen via the remote session

To troubleshoot a device, it can be helpful to view the device's screen so you can monitor how the device owner is using it and then take actions yourself, such as opening applications and configuring settings. To view the screen, take the following steps: 

  1. If you haven't already set up a remote session, set it up now.
  2. Click Screen Share > Start.
    Image Added
  3. A message is sent to the device asking the device owner to share the screen with WSO2 IoT Server. After the device owner accepts this message, you can view the device's screen and start interacting with it using the mouse.
    Image Added
  4. Click Stop to stop viewing the screen of the device.

View and interact with the device via the remote session

Viewing the screen of the device alone does not help you to solve the issue. You need to be able to carry out actions on the shared screen to successfully troubleshoot the device. Follow the steps given below to try it out:

  1. Enable the Android System Service Applications.
    Insert excerpt
    Integrating the Android System Service Application
    Integrating the Android System Service Application
    nopaneltrue
  2. Restart or start WSO2 IoT Server's core profile, which corresponds to the WSO2 Connected Device Management Framework (WSO2 CDMF) profile.
  3. Access the device management console: https://<IOTS_HTTPS_HOST>:9443/devicemgt
    For example: https://localhost:9443/devicemgt
  4. Sign in as an administrator. By default, the username is admin and the password is admin.
  5. Under DEVICES, click View.
    Image AddedYou are navigated to a page that lists out all the devices that are enrolled with WSO2 IoT Server because you have administrator privileges. If you do not have administrator privileges, you only the see the devices that you enrolled.
  6. Click on the device you want to start a remote session.
  7. Click the Remote Session tab.
  8. Click Connect to Device to start a remote session with the device. 
  9. Click Screen Share > Start
    Image Added
  10. Click on the applications you want to open or the configurations you want to enable using the mouse.
  11. Click Stop to stop viewing the screen of the device.