This documentation is for WSO2 IoT Server 3.0.0. View the documentation for the latest release.
Due to a known issue do not use JDK1.8.0_151 with WSO2 products. Use JDK 1.8.0_144 until JDK 1.8.0_162-ea is released.
Page Comparison - Quick Start Guide (v.5 vs v.6) - IoT Server 3.0.0 - WSO2 Documentation

Versions Compared


  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Reverted from v. 3

The quick start guides in this section give This section gives you a quick understanding of how to connect your enterprise device to WSO2 IoT and mobile devices to WSO2 IoT Server and start using it. childrenServer and start using it. For this purpose, let's use the virtual fire alarm.

The virtual fire alarm is a virtual device that mimics the functionality of a real fire alarm. Therefore, for this use case you do not need a real device. Once you start the virtual fire alarm, it will connect to the WSO2 IoT Server and push the temperature readings it collects. The device supports MQTT and XMPP communications and is configured to use MQTT by default.

The following subsections explain how you can work with the virtual fire alarm:

Table of Contents

Download WSO2 IoT Server

Excerpt Include
Downloading the Product
Downloading the Product

Sign into the Device Management console


Follow the instructions given below to start WSO2 IoTS, and sign into the IoTS device management console:

  1. Navigate to the WSO2 IoT pack plugins and run the sample-deployer.xml.

    Code Block
    cd <IoT_HOME>/plugins
    mvn clean install -f plugins-deployer.xml
  2. Start WSO2 IoT Server by starting the three profiles in the following order:

    1. Start the broker profile, which corresponds to the WSO2 Message Broker profile.

      Code Block
      cd <IoTS_HOME>/broker/bin

      The default port assigned for the broker is 9446.

    2. Start the core profile, which corresponds to the WSO2 Connected Device Management Framework (WSO2 CDMF) profile.

      Code Block
      cd <IoTS_HOME>/core/bin

      The default port assigned for the core is 9443.

    3. Start the analytics profile, which corresponds to the WSO2 Data Analytics Server profile.

      Code Block
      cd <IoTS_HOME>/analytics/bin

      The default port assigned for analytics is 9445.

  3. Access the device management console by navigating to https://<HTTPS_HOST>:<HTTPS_PORT>/devicemgt.
    Example: https://localhost:9443/devicemgt 

  4. Enter your username and password.
    If you are new to using WSO2 IoTS, you need to first register with IoTS before you can to log into the WSO2 IoTS device management console.

    titleClick here for more information on registering with WSO2 IoTS.

    Follow the instructions given below to register with WSO2 IoT:

    1. Click Create an account.
      Image Added
    2. Fill out the registration form.

      Image Added

      • First Name: Provide your first name.
      • Last Name: Provide your last name.
      • Username: Provide a username. It should be at least 3 characters long with no white spaces.
      • Email: Provide a valid email address.
      • Password: Provide a password. It should be at least 8 characters long.
      • Confirm Password: Provide the password again to confirm it.
    3. Click Register.

    Image Added

  5. Click LOGIN

Start the virtual fire alarm

Follow the steps given below to start the virtual fire alarm device:

  1. Click Enroll New Device.
    Image Added
  2. Click Try to try out the Virtual Firealarm.
    Image Added
  3. Download the device:
    1. Click Download Agent to download the device agent.
    2. Enter a preferred name for your device, select the simple or advanced agent option, and click DOWNLOAD NOW.

      Image Added

  4. Navigate to the location of the unzipped device agent file.
    Example: Navigate to the device agent file, which is in the <IOTS_HOME>/device_agents/virtual_firealarm directory.

    Code Block
    cd <IOTS_HOME>/device_agents/virtual_firealarm
  5. Start the virtual fire alarm.

    Code Block

    Once you start your virtual fire alarm, the fire alarm emulator will pop up.

    Image Added


    If you set the Protocol to XMPP, you need to enable XMPP communication on WSO2 IoTS, as it is disabled by default. To enable XMPP communication, open the file that is in the <IoTS_HOME>/repository/conf/etc directory and configure XMPP by defining enabled=true as shown below:

    Code Block

Try out the virtual fire alarm

Once you start your virtual fire alarm, you can try out the following actions:

View device details

Click the menu icon Image Added, and click Device Management. Select the virtual fire alarm device you created from your devices, and view the device details, carry out operations, and monitor real-time data.

Image Added

Ring the fire alarm
  1. Click Control buzzer under Operations on the Device Details page
    Image Added
  2. Enter On to ring the fire alarm, and click Send to Device. Enter Off to stop the ringing.
    Image Added

View real-time and historical data

When you adjust the temperature and humidity values in the virtual fire alarm emulator you can see the data in real-time or view historical data by following the steps given below:

Click Image Added to monitor real-time data via the Device Details pages.

Image Added

What's next?

Follow the options given below to see what you can do next:

  • Do you have an Android device? Try out the Android Sense device type supported by default on WSO2 IoTS. For more information, see Android Sense.
  • Want to try out more devices? Connect the devices listed below to WSO2 IoTS and try them out.
  • Need to create a new device type and connect it to WSO2 IoTS? For more information, see the Device Manufacturer Guide.