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.
Enterprise IoT solution - IoT Server 3.0.0 - WSO2 Documentation
||
Skip to end of metadata
Go to start of metadata

This section gives you a quick understanding of how to connect your device to WSO2 IoT Server 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:

Download WSO2 IoT Server

  1. Download WOS2 IoT Server from the here.

  2. Copy the downloaded file to a preferred location and unzip it.

    The unzipped file will be called <IoT_HOME> throughout this documentation.

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 plugins-deployer.xml.
    Example:

    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.

      cd <IoTS_HOME>/broker/bin
      ./wso2server.sh

      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.

      cd <IoTS_HOME>/core/bin
      ./wso2server.sh

      The default port assigned for the core is 9443.

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

      cd <IoTS_HOME>/analytics/bin
      ./wso2server.sh

      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.

     Click here for more information on registering with WSO2 IoTS.

    Follow the instructions given below to register with WSO2 IoT:

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

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

  5. Click LOGIN

Enroll the device

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

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

      Tip: Avoid using spaces or other characters for the device name.

      • Using the Simple Agent you can try out basic functions mentioned under the Try out the virtual fire alarm section of the Simple Agent tab. 
      • Using the Advanced Agent, you can define policies on the device based on the policy enforcement criteria, and also try out the functions mentioned under the Try out the virtual fire alarm section of the Advanced Agent tab.

Start the virtual fire alarm

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

Follow the steps below to start the simple agent fire alarm.

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

    cd <IOTS_HOME>/device_agents/virtual_firealarm
  2. Start the virtual fire alarm.

    sh start-device.sh

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

Try out the virtual fire alarm

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

ActionDescription
View device details

Click the icon, 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.

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

Follow the steps below to define a policy for the fire alarm device and start the advanced agent fire alarm.

  1. Click the icon, and click Policy Management.

  2. Click Add New Policy and select the Virtual Fire Alarm platform.

  3. Configure a policy using the Siddhi Query Language and click Continue.
    The following is an example of a policy you can use for the Fire Alarm device. See  Adding a Policy for more information on how to add your own policy.

    define stream fireAlarmEventStream (deviceID string, temp int);
    from fireAlarmEventStream#window.time(10 sec)
    select deviceID, max(temp) as maxValue
    group by deviceID
    insert into analyzeStream for expired-events;
    from analyzeStream[maxValue < 50]
    select maxValue
    insert into bulbOnStream;
    from fireAlarmEventStream[temp > 50]
    select deviceID, temp
    insert into bulbOffStream;
  4. Assign the policy to user roles or users and select an action to be triggered upon non-compliance.
    For example, you can assign the policy to the admin user role and select Enforce as the action upon non-compliance. For more information, see Adding a Policy.
  5. Enter a name and description for the policy and click Publish.

    When you start the fire alarm device, this policy will be assigned to the device.
  6. Navigate to the location of the unzipped device agent file on your terminal.
    Example: Navigate to the device agent file, which is in the <IOTS_HOME>/device_agents/virtual_firealarm directory.

    cd <IOTS_HOME>/device_agents/virtual_firealarm
  7. Start the virtual fire alarm.

    sh start-device.sh

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

Try out the virtual fire alarm

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

ActionDescription
View device details

Click the icon, 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.

Ring the fire alarm
  1. On the emulator, enter a temperature lower than 50°. The buzzer will start ringing.
  2. Enter a temperature higher than 50° to stop the ringing.

Note that the buzzer now works according to the policy you defined above.

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  to monitor real-time data via the Device Details pages.
 

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