Difference between revisions of "Getting started with Yantrr Device Cloud"

From Yantrr Wiki
Jump to: navigation, search
(→‎Run Yantrr Device Client)
 
(25 intermediate revisions by the same user not shown)
Line 1: Line 1:
 
= Overview  =
 
= Overview  =
−
Yantrr Device Cloud (YDC) is cloud based software that provides complete observability and controllability of your device. YDC combines device status visibility, controllability and data accessibility in one package which user can access it in the form of web application.
+
Yantrr Device Cloud (YDC) is cloud based software that provides complete management and reporting for your registered Yantrr device. You can access features like Device status, positioning, control, and access its data from any browser.
−
[[File:YDCOverview.png| Overview of YDC | center]]
+
 
−
= Before get started =
+
[[File:YDCOverview.png| center|thumb|400px | Overview of YDC ]]
−
Before you get started, you should have
+
<br/><br/>
−
# An registered user account on the Yantrr Device Cloud. <br />If you do not have an account, go to section “New User Registration”.
+
 
−
# A VIBE or Beaglebone Black with Vayu Capes running YCM client.<br />If you do not have these hardware setup, we are assigning some remote devices to get familiar with YDC. For that you just have to login with your YDC account and go to section “Accessing Device Dashboard”.
+
== Getting Started ==
−
# A system with internet connection and web browser to access YDC web application. <br />To access YDC web application, you have to open any web browser and navigate to web address http://demo.yantrr.net:9090/Demo3_Test/default/index
+
* You will have to create a user account on the YDC, if you don't already have one. Click on the “Register Now” button, and fill in the required fields. An email with the verification link is sent and clicking on this completes your Registration process.
−
= Let’s get started =
+
* Once logged in, please register your device(s) using the "Register New Device" link
−
# '''New User Registration'''<br />''This step is only necessary for user which are accessing YDC for first time or who does not have YDC account.''<br />To register new user account open an YDC web application in your web browser by navigating to address http://demo.yantrr.net:9090/Demo3_Test/default/index[[File:YDCIndex.jpg| YDC IndexPage | center]]<br />After clicking on “Register Now” button, you are redirected to user registration form.<br />[[File:YDC_UserRegistration.jpg| YDC User Registration | center]]<br />Fill out all the details and click on “Sign Up” button. After successful registration, a user get a verification link to his/her email address that mention while filling user registration form. The user have to verify his/her Email-ID using the link sent to user’s email address.<br />''Note: Email ID verification is very essential step for user authentication, without this user cannot access his/her YDC account.''
+
* The Device dashboard, is the view where all the registered Yantrr devices like the VIBE or Beaglebone Black with Vayu Capes running YCM client will be displayed.<br />  
−
# '''Already Existing User'''<br />To login in YDC go to http://demo.yantrr.net:9090/Demo3_Test/default/user/login<br />[[File:YDC_UserLogin.jpg| YDC Login | center]]<br />Fill out Username, Password in respective fields and click on “Log In” button. After successful login user is redirected to YDC’s main page.<br />[[File:YDC_Main.jpg| YDC Main Page | center]]
+
* If you are accessing the YDC demo site, the site will be presented in read only mode and the user can browse some of the Yantrr Demo Devices. Some of the functionality like Registering device and Admin tab will be disabled in this demo mode.
−
# '''Accessing Device Dashboard'''<br />For accessing the device dashboard
+
* Please click on the "Devices" tab to get started.
−
## Login to YDC account (like mentioned in step 2)
+
 
−
## After login click on “Device Dashboard” tab[[File:ManageDevices.jpg| Devices List | center]]Here a list of devices and there current status are displayed. To access individual device’s dashboard click on particular Device ID.For example, to access Dashboard of Device ID “ytr_0001” click on ytr_0001.[[File:NavigateDevDashboard.jpg| Access Individual Device Dashboard| center]]After clicking any particular Device ID, user will be redirected to its dashboard page like shown in below image.[[File:IndDevDashboard.jpg| Device Dashboard | center]]On this device dashboard page, user will get various sections which displays real time update coming from device like Device Information, status of Sensors and GPS, live sensors and GPS data, etc. To know all these sections detail go to “Sections on Device Dashboard Page”.
+
== Device Registration ==
−
# '''Sections on Device Dashboard Page'''
+
* Step 1 : Note down the Ethernet MAC ID of your device
−
## '''Device Information'''
+
<pre>
−
## '''Device Status and Control'''
+
#ifconfig eth0
−
## '''Real Time Device GPS Location'''
+
eth0      Link encap:Ethernet  HWaddr 38:60:77:2e:c7:a2 
−
## '''Historical Device Data Access'''
+
          inet addr:192.168.1.150  Bcast:192.168.1.255  Mask:255.255.255.0
−
## '''Monitoring Device CPU Load and CPU Frequency'''
+
          inet6 addr: fe80::3a60:77ff:fe2e:c7a2/64 Scope:Link
−
## '''Sample Weather Data from Device'''
+
          UP BROADCAST RUNNING MULTICAST  MTU:1500  Metric:1
−
## '''Real Time Sensor Data from Device'''
+
          RX packets:96953 errors:0 dropped:284 overruns:0 frame:0
−
# '''Logout from YDC'''
+
          TX packets:61474 errors:0 dropped:0 overruns:0 carrier:0
 +
          collisions:0 txqueuelen:1000
 +
          RX bytes:91913079 (91.9 MB)  TX bytes:6508982 (6.5 MB)
 +
          Interrupt:40
 +
</pre>
 +
Here 38:60:77:2e:c7:a2 is the ethernet MAC ID of your device.  
 +
* Step 2 : Fill the device details in device registration form
 +
#Login to Yantrr Device Cloud
 +
#Click on "Register New Device" button
 +
#Submit the details of your device
 +
Note: In MAC ID field you have to type _ (underscore) instead of : (colon). Like in this case, for Ethernet MAC ID 38:60:77:2e:c7:a2 you have to type 38_60_77_2e_c7_a2.
 +
[[File:deviceReg.png| center|thumb|400px | Device Registration ]]
 +
On successful device registration user is redirected to Devices List page where some of demo devices provided by Yantrr and user registered device is listed.
 +
 
 +
== Run Yantrr Device Client ==
 +
'''Prerequisites :'''
 +
* Beaglebone Black or VIBE/VIBE2 platform flashed with Yantrr debian image
 +
* Device is registered on Yantrr Device Cloud & note down its Device ID. Like in this case it will be "ytr_38_60_77_2e_c7_a2"
 +
'''Steps :'''
 +
<ol>
 +
<li>SSH into device</li>
 +
<pre>
 +
ssh -l root 192.168.1.150
 +
root@192.168.1.150's password: root
 +
root@Yantrr:~#
 +
</pre>
 +
<li>Install python-virtualenv package</li>
 +
<pre>
 +
#apt-get install python-virtualenv
 +
</pre>
 +
<li>Download YES-LiteSandbox package on a device</li>
 +
<pre>
 +
#wget https://www.dropbox.com/s/vkgt7nlq4bdnblt/YES-LiteSandbox.tar
 +
</pre>
 +
<li>Extract the downloaded package</li>
 +
<pre>
 +
#tar xvf YES-LiteSandbox.tar
 +
</pre>
 +
<li>Now Run Yantrr Device Client</li>
 +
<pre>
 +
#source /root/YES/bin/activate; sleep 1; python /root/YES/YantrrClient/mainRunner.py -url "ws://dev.yantrr.net:1235/ws" -c “ytr_38_60_77_2e_c7_a2” -realm SWG_Router1 &
 +
</pre>
 +
Note: Here “ytr_38_60_77_2e_c7_a2” is the registered Device ID of your device on Yantrr Device Cloud.
 +
<li>Now device can be controlled by accessing dashboard of device.</li>
 +
</ol>
 +
 
 +
== Devices List ==
 +
Here a list of devices and their current status are displayed
 +
* The Device ID generated for your registered device
 +
* The Device description entered at the time of registration
 +
* The current status of communication of the device with YDC
 +
* Last connected status
 +
* Mac ID of the device
 +
* Some supported operations on the device (Disabled for demo use)
 +
<br/>   
 +
[[File:DeviceList.JPG| Devices List | center|300px|thumb]]
 +
<br/>
 +
 
 +
== Device Dashboard ==
 +
 +
To access individual device’s dashboard click on the Device ID.
 +
<br/>
 +
[[File:IndDevDashboard.jpg| Device Dashboard | center|300px|thumb]]
 +
 
 +
'''Sections on Device Dashboard Page'''
 +
# '''Device Information'''<br />The device details with its MAC ID, MIPS (CPU Frequency), Memory Information (RAM), Current CPU Temperature, Current CPU Load are displayed here.<br/>Also, its shows the realtime status of Memory Free, CPU Temperature, CPU Load, etc.<br />[[File:DeviceInfo.jpg| Device Information| center|300px|thumb]]<br/>
 +
# '''Device Status and Control'''<br />The current status of Device, the Sensors attached to it as well as GPS status is displayed here. Also you can change the sample rate at which the data to be published to server from current device.[[File:DevStatusControl.jpg|300px|thumb| Device Status & Control| center]]
 +
# '''Real Time Device GPS Location'''<br />The location of the Yantrr device can be visualized on the map in real time. The current GPS location is displayed with timestamp in text format.<br/>[[File:RealTimeGPSLocation.jpg| Real Time GPS Location| 300px|thumb|center]]<br/>
 +
#'''Historical Device Data Access'''<br />This section gives capability to user such that he/she can download historical data of sensors attached to device. Currently the devices which are provided in this demo has LUX and BMP sensors attached to it.[[File:HistoricalDataAccess.jpg| Access Historical Data| center|300px|thumb]]<br/>
 +
#'''Monitoring Device CPU Load and CPU Frequency'''<br />In this section the user can monitor the current CPU load and frequency of device. Also user can increase the CPU load or change CPU frequency.[[File:CPU_Monitoring.jpg| CPU Monitoring| center|300px|thumb]]<br/>
 +
#'''Sample Weather Data from Device'''<br />This section displays the random sample weather data in real time.[[File:sampleWeatherData.jpg| Sample Weather Data| center|300px|thumb]]<br/>
 +
#'''Real Time Sensor Data from Device'''<br />The sensor data of attached LUX and BMP sensors are shown in real time graphs. [[File:RealTimeSensorData.jpg| Real Time Sensor Data| center|300px|thumb]]

Latest revision as of 05:32, 30 December 2015

Overview

Yantrr Device Cloud (YDC) is cloud based software that provides complete management and reporting for your registered Yantrr device. You can access features like Device status, positioning, control, and access its data from any browser.

Overview of YDC



Getting Started

  • You will have to create a user account on the YDC, if you don't already have one. Click on the “Register Now” button, and fill in the required fields. An email with the verification link is sent and clicking on this completes your Registration process.
  • Once logged in, please register your device(s) using the "Register New Device" link
  • The Device dashboard, is the view where all the registered Yantrr devices like the VIBE or Beaglebone Black with Vayu Capes running YCM client will be displayed.
  • If you are accessing the YDC demo site, the site will be presented in read only mode and the user can browse some of the Yantrr Demo Devices. Some of the functionality like Registering device and Admin tab will be disabled in this demo mode.
  • Please click on the "Devices" tab to get started.

Device Registration

  • Step 1 : Note down the Ethernet MAC ID of your device
#ifconfig eth0
eth0      Link encap:Ethernet  HWaddr 38:60:77:2e:c7:a2  
          inet addr:192.168.1.150  Bcast:192.168.1.255  Mask:255.255.255.0
          inet6 addr: fe80::3a60:77ff:fe2e:c7a2/64 Scope:Link
          UP BROADCAST RUNNING MULTICAST  MTU:1500  Metric:1
          RX packets:96953 errors:0 dropped:284 overruns:0 frame:0
          TX packets:61474 errors:0 dropped:0 overruns:0 carrier:0
          collisions:0 txqueuelen:1000 
          RX bytes:91913079 (91.9 MB)  TX bytes:6508982 (6.5 MB)
          Interrupt:40

Here 38:60:77:2e:c7:a2 is the ethernet MAC ID of your device.

  • Step 2 : Fill the device details in device registration form
  1. Login to Yantrr Device Cloud
  2. Click on "Register New Device" button
  3. Submit the details of your device

Note: In MAC ID field you have to type _ (underscore) instead of : (colon). Like in this case, for Ethernet MAC ID 38:60:77:2e:c7:a2 you have to type 38_60_77_2e_c7_a2.

Device Registration

On successful device registration user is redirected to Devices List page where some of demo devices provided by Yantrr and user registered device is listed.

Run Yantrr Device Client

Prerequisites :

  • Beaglebone Black or VIBE/VIBE2 platform flashed with Yantrr debian image
  • Device is registered on Yantrr Device Cloud & note down its Device ID. Like in this case it will be "ytr_38_60_77_2e_c7_a2"

Steps :

  1. SSH into device
    2. ssh -l root 192.168.1.150
root@192.168.1.150's password: root
root@Yantrr:~#
  2. Install python-virtualenv package
    3. #apt-get install python-virtualenv
  3. Download YES-LiteSandbox package on a device
    4. #wget https://www.dropbox.com/s/vkgt7nlq4bdnblt/YES-LiteSandbox.tar
  4. Extract the downloaded package
    5. #tar xvf YES-LiteSandbox.tar
  5. Now Run Yantrr Device Client
    6. #source /root/YES/bin/activate; sleep 1; python /root/YES/YantrrClient/mainRunner.py -url "ws://dev.yantrr.net:1235/ws" -c “ytr_38_60_77_2e_c7_a2” -realm SWG_Router1 &

    Note: Here “ytr_38_60_77_2e_c7_a2” is the registered Device ID of your device on Yantrr Device Cloud.

  6. Now device can be controlled by accessing dashboard of device.

Devices List

Here a list of devices and their current status are displayed

  • The Device ID generated for your registered device
  • The Device description entered at the time of registration
  • The current status of communication of the device with YDC
  • Last connected status
  • Mac ID of the device
  • Some supported operations on the device (Disabled for demo use)


Devices List


Device Dashboard

To access individual device’s dashboard click on the Device ID.

Device Dashboard

Sections on Device Dashboard Page

  1. Device Information
    The device details with its MAC ID, MIPS (CPU Frequency), Memory Information (RAM), Current CPU Temperature, Current CPU Load are displayed here.
    Also, its shows the realtime status of Memory Free, CPU Temperature, CPU Load, etc.
    Device Information

  2. Device Status and Control
    The current status of Device, the Sensors attached to it as well as GPS status is displayed here. Also you can change the sample rate at which the data to be published to server from current device.
    Device Status & Control
  3. Real Time Device GPS Location
    The location of the Yantrr device can be visualized on the map in real time. The current GPS location is displayed with timestamp in text format.
    Real Time GPS Location

  4. Historical Device Data Access
    This section gives capability to user such that he/she can download historical data of sensors attached to device. Currently the devices which are provided in this demo has LUX and BMP sensors attached to it.
    Access Historical Data

  5. Monitoring Device CPU Load and CPU Frequency
    In this section the user can monitor the current CPU load and frequency of device. Also user can increase the CPU load or change CPU frequency.
    CPU Monitoring

  6. Sample Weather Data from Device
    This section displays the random sample weather data in real time.
    Sample Weather Data

  7. Real Time Sensor Data from Device
    The sensor data of attached LUX and BMP sensors are shown in real time graphs.
    Real Time Sensor Data
Retrieved from "http://wiki.yantrr.com/index.php?title=Getting_started_with_Yantrr_Device_Cloud&oldid=772"