KloudOS Devices

This section will guide you through the simple process of installing and configuring Kloudspot’s KloudOS software, including KloudVision, KloudDisplay, and KloudSensor.

KloudDisplay

KloudDisplay is a digital signage and content management system crafted to simplify the process of managing your displays. For detailed instructions on installing KloudDisplay to a controller, adding resources to it, and integrating those resources into a template, please consult the KloudDisplay document.

KloudVision

KloudVision has the capability to enhance the security and operational efficacy of a business or location through the implementation of advanced Surveillance feature. Consult the KloudVision guide for instructions on configuring a camera for this. Software installation, camera setup, and configuration are included in it.

Kloudspot Gateway

The Kloudspot Gateway is the best and most complete wireless network management tool for business networks. Routers called Kloudspot Gateway can be used as Access Points. The special Kloudspot Gateway document will help you understand how to set up the gateway.

Kloud Sensors

Sensors are utilized to gather data from the surrounding area. For information regarding the installation, configuration, and analytics integration, consult the Kloud Sensors guide.

Kloud Access Point

Access Points are used to connect to the internet, either through the Captive Portal or without the Captive Portal authentication process. Kloudspot supports both qsdk and third-party access points such as Meraki, Engenius, Cisco, and others. To learn how to configure it, visit the Kloud access point guide.

Subsections of KloudOS Devices

Kloud Display

Brochure

KloudDisplay is an advanced digital signage and content management solution designed to streamline your display management process. Whether you’re looking to enhance customer engagement, communicate important information, or showcase dynamic content, KloudDisplay offers a range of features to help you create captivating displays and manage them with ease.

Key Features:

Content Management: KloudDisplay allows you to create, manage, and organize various types of content, such as images, videos, text, and more. You can easily upload, arrange, and schedule content to be displayed on your terminals.

Templates and Resources: With KloudDisplay, you can design visually appealing templates that determine how your content is displayed on the terminals. Resources are building blocks that make up your templates, providing flexibility in content creation.

Announcements: Deliver important messages, alerts, and announcements directly to your display terminals. KloudDisplay enables you to create and manage announcements, ensuring that your audience receives timely information.

Workflow Management: Implement a structured workflow for content creation and approval. Assign roles and permissions to users for editing, reviewing, and approving resources and templates.

Analytics Integration: Integrate KloudDisplay with Kloudspot Analytics to trigger display template changes and announcements based on predefined rules. Enhance engagement and tailor content to real-time insights.

Terminal Insights: Gain insights into terminal performance and content usage. Access real-time summaries, top resources and templates, and more to optimize your displays.

Benefits of KloudDisplay:

Engagement: Create captivating displays to engage your audience and deliver targeted messages.

Flexibility: Easily customize templates and content to match your branding and communication goals.

Efficiency: Streamline content creation, editing, and approval processes with workflow management.

Analytics-Driven: Use real-time insights to make data-driven decisions and tailor content for optimal impact.

Automation: Seamlessly integrate with Kloudspot Analytics to automate content changes based on predefined rules.

Communication: Keep your audience informed with announcements and alerts displayed on terminals.

Scalability: Manage multiple terminals and locations from a central interface, scaling your displays as needed.

  • If you’re using KloudDisplay for the first time, refer the Installation section for guidance on choosing an appropriate controller, installing KloudDisplay on the selected controller, and establishing a connection between a Display Terminal and the controller where KloudDisplay is installed.

  • Refer the User Guide for instructions on creating a resource, integrating it into a template, and adding that template to a display terminal.

In this documentation

Effortlessly set up your KloudDisplay system with step-by-step instructions on controller selection, software installation, and terminal connection provided in the installation guide
Master the KloudDisplay system with our User Guide, featuring step-by-step instructions on adding resources, creating templates, linking them to display terminals, and utilizing the powerful workflow feature.
Get quick answers to common questions with our informative FAQ resource.

Subsections of Kloud Display

Installation

This section will take you through a step-by-step installation of KloudDisplay, from choosing the right controller to establishing a connection between KloudDisplay and the former. This guide will ensure a smooth integration of KloudDisplay into your controller and display terminal.

For information on KloudSpot’s products and purchasing details, refer to the KloudSpot Product Purchase document.

Table of content

Subsections of Installation

Choosing the Right Display Controller

The success of your installation hinges on the compatibility between your chosen display and the controller. The KloudDisplay controller specifications act as a guide to help you make this critical decision. By referring to these specifications, you’ll be empowered to select the ideal controller that aligns with your display’s unique characteristics.

KloudDisplay Device Specification

Up to 1080P

CPU: Intel® Celeron® Processor N4020 , 2 Cores/2 Threads (4M Cache, up to 2.80 GHz)GPU:

GPU: Intel® UHD Graphics 600

Memory: DDR4 4GB (On Board)

Storage: eMMC 64GB (On Board)

Up to 4K

CPU: Intel® Core i3 8th Gen or above

GPU: Intel® UHD Graphics 600

Memory: DDR4 8GB (On Board)

Storage: eMMC 256GB (On Board)

Installing KloudDisplay Software

Once you’ve obtained the suitable controller for your display, the next step is to bring it to life with the KloudDisplay software. We offer two options for this installation:

Combo Device Installation: Transform your display into a comprehensive digital hub by installing both KloudDisplay and KloudVision. This dynamic duo will unlock a world of possibilities for your visual projects.

Standalone KloudDisplay Installation: If your project requires a dedicated display solution, you can choose to install only KloudDisplay. This streamlined approach focuses solely on optimizing your display performance.

For detailed step-by-step instructions on how to execute these installations, consult the Installation document. This comprehensive guide will provide you with the clarity you need to navigate the installation process effortlessly.

Connecting Display Terminal to Controller

After successfully installing the KloudDisplay software on your controller, it’s time to connect your display terminal for an exciting visual experience. For detailed guidance, consult the following steps.

  1. Installation involves three steps:
  • Power: connect the supplied power cable.
  • HDMI: connect the supplied HDMI cable between the Kloud Display unit and a suitable display.
  • Network. This can be done in two ways.
    • Wired
    • Wireless

Wired Connection

  1. Connect an ethernet cable and power on the Kloudspot controller.

  2. Ensure that the ethernet cable doesn’t supply power (POE). This may damage the Kloud Display.

image

Wireless Connection

In order to set up a connection to a wireless network, you will need a 2.4GHz WiFi network with a known SSID and password.

  1. Power on the KloudDisplay unit.
  2. Then wait until the screen below is shown.
image
  1. Connect a phone or laptop to the .klouddisplay network using kloudspot as a password.

  2. Open a browser on your phone or laptop and go to http://kd.kloudspot.com.

  3. Provide the WiFi network connection details (SSID name and password) that you want to the KloudDisplay to connect to.

image
  1. Click SUBMIT.
image
  1. The KloudDisplay will reset in a few seconds and connect to the WiFi network you entered.

  2. In order for you to manage a display it will need to be allocated to your account.

  3. Once linked to the display controller, proceed to log in to the Kloud management software and customize the display according to your preferences. For guidance, consult the KloudDisplay user manual.

User Guide

The KloudDisplay user manual tells you everything you need to know about how to use it and all of its features. This manual gives both new and experienced KloudDisplay users clear and simple instructions, suggestions, and information on all of KloudDisplay’s features, from setting it up to Until resources are added to the display.

If you haven’t chosen a KloudDisplay Controller and completed the software installation, please refer to the installation guide before moving forward.

Table of content

Subsections of User Guide

Logging In

Congratulations on successfully installing the Klouddisplay to your controller! After receiving your controller’s MAC address, Kloudspot’s support team will process the activation of your license. Please consult the section on KloudDisplay software installation for instructions on how to acquire the controller’s MAC address.

  1. Once your license is activated, you will receive your login ID, temporary password, and the URL to access the KloudVision platform.

  2. Access the Klouddisplay login page using the provided URL.

  3. Enter your provided login ID and password.

  4. Click the “Login” button to access your Klouddisplay account.

image image

Dashboard Overview

If you’re logging into the Kloud management software for the first time, you won’t see the “Display controllers” menu button initially. This button appears after you’ve added the controller to the KloudManage software. For instructions on how to do this, please consult the “Adding and Managing Display Terminals” section.

  1. Menu bar: The left side displays the menu bar, where you can access a variety of options for the KloudManage software.

  2. Venues: You can view the list of venues incorporated in the Kloud Manage software here.

  3. Displays: The count of added displays is visible here. To access the Display Terminals window, simply click on the “More details” button.

  4. Resource Impressions: Total number of resources displayed on the termina.

  5. Template Impressions: Total number of templates displayed on the terminal.

  6. Top Resource:

  7. Top Templates:

  8. Display Assets: Indicates the quantity of Template Groups, Templates, and Resources present.

image image

Adding and Managing Display Terminal

  1. Having successfully logged into the KloudManage software, you’re now ready to delve into the realm of adding and managing your display terminals. By seamlessly incorporating display controllers into Kloudmanage software, you’ll have the tools to create impactful presentations and engaging displays.

  2. For that, navigate to NETWORK DEVICES > Add Network Devices.

image image

  1. Enter the following in the window that opens and click the Save Changes button.

    Device Type: Select Display Controller or Combo device (Display + Vision controller) or virtual display controller from the dropdown list.

    Model: Select your controller model from the dropdown list.

    Orientation: Select Display Orientation.

    Rotation: The rotation parameter in display refers to a feature that allows users to adjust the orientation of their screen or visual content. With this parameter, individuals can easily rotate the display to various angles, such as landscape or portrait mode, depending on their preferences or specific needs.

    MAC address: Enter the MAC address of your controller.

    Name: Give a name for the controller.

    Account: Kloudspot provides this information during account creation and it is advised to keep it as is.

    Venues: During the account creation process, Kloudspot provides information about the venue. To add a new venue, you can refer to the Venues section, which provides guidelines and instructions for the process.

image image

  1. If you are selected Virtual Display Controller. Check the Virtual checkbox and select the hosting platform.

image image

Open Display Terminal

  1. Once the display controller is added, the Display Terminal menu will become accessible. Clicking on this option allows you to view all the display terminals that you have added.

  2. Within this context, you have the option to utilize the buttons found in the actions column. Through these buttons, you can rename the terminal, access the list of added templates, incorporate a location, and apply templates.

  1. If you select one of the terminals, you can see status information and see what is being displayed on the terminal.
  1. If you click on the terminal group tab, you can view terminal groups and create new ones. Multiple display terminals can be included in a terminal group. This enables the addition of a template to multiple display terminals at the same time.
  1. To populate the display terminal, you’ll need both a resource and a template. For guidance on adding a resource, please consult the Resources section. If you’ve already created a resource, head to the template section to incorporate it into your template. .

Integrate 3rd Party Applications

This section contains comprehensive guidance for integrating third-party applications in order to improve the functionality and performance of KloudDisplay. The integration process can be modified to match your specific requirements, resulting in a personalized and optimized experience.

Subsections of Integrate 3rd Party Applications

TikTok Integration

  1. This document provides a step-by-step guide for integrating TikTok into the KloudManage application. Using this you can display your TikTok videos on KloudDisplay.

  2. First, Log in to your TikTok developer account.

  3. Then, click on the “Manage apps” menu in the profile menu.

  1. In the manage apps window that opens, click on the “Connect an app” button.
  1. In the popup window that opens, select the “An Individual developer” option, and click Confirm.
  1. In the “Manage App” window that opens, scroll down and enter the following information in the Configuration section:

    • App icon: Add your company logo
    • App name: Enter App Name. It shows TikTok users.
    • Category: Select the category of your app from the dropdown list.
    • Description: Describe your App or website.
    • Terms of Service URL: Add the URL of your website’s official terms of service page.
    • Privacy Policy URL: Add the URL of your website’s Privacy Policy page.
  2. Enable the “Configure for Web” toggle button.

  3. Enter the URL of your website.

  1. Click on “Add product” in the menu bar.

  2. Add products called “Login kit and Scopes” and click “Done”.

  1. Add your KloudManage link on the web tab of the Login Kit.
  1. In the scope section, click the Edit Scope button and add the scopes “user.info.basic” and “user.info.profile”.
  1. Then scroll up and click on the Save Changes button to save the configuration. Then click on Submit for review button and submit for review.

  2. Once the configuration is approved, the Status will change from “Staging” to “Live in Production”.

  1. After the above steps are completed, log in to the KloudManage application. Then, navigate to Settings > Third Party Integration.
  1. Scroll down and find the TikTok integration section. Here, click on the edit button. Enter the Client Key and Client secret obtained from the TikTok developer account and click on the Save TikTok settings button.

  2. Your TikTok account has been successfully integrated into KloudManage. Now you can add TikTok in the resource. Refer Resource section to know how to create a Resource.

Resources

Next, you need to add resources to show on your screen. This resource you’re adding fits into the template you’re using. It’s important to know that you can add more than one resource to the template. In this part, we’ll look at different resources you can add, what they do, and how to add them to your setup smoothly.

Resources are the basic building blocks used to create templates. Resources are used to create the content that will be displayed on the display. It can be used to create a wide variety of content. To do so, follow the steps below.

Add Resource

Here, I am generating an image-type resource. You can create various types of resources based on your specific requirements.

  1. Navigate to DISPLAY TERMINAL > RESOURCES. Then click on Create New button.
  1. When you click on it, a new resource creation window will appear. Fill out all the required fields.

    • The primary fields are as follows

      Name: Name the resource for future use.

      Type: Select the desired type from the dropdown list depending on the nature of the resource you intend to create. See the Resource Types section for more information on what each type is used for.

      Background color: Select the background color you want to add.

      Comments: If you have any additional information about the resource, please include it in the comments section.

      Content: Here I have selected the Image type so you can see the content column which will vary depending on the type selected.

  2. Then finally click on the Save button. Now you have to add the created resource to the template. Refer to Create Template section to know how to do that.

Resource Types

Camera count

Utilizing the advanced capabilities of Kloudvision, this Resource enables real-time tracking and display of entry and exit counts. this system accurately captures and presents the number of individuals entering and exiting a specified area, ensuring up-to-date information on foot traffic.

Camera feed

Harnessing the innovative features of Kloudvision, this Resource offers the ability to showcase live camera feeds in real-time. With this functionality, users can observe a continuous stream of footage captured by connected cameras, providing enhanced security and monitoring capabilities.

Clock

This Resource displays the time in a specific timezone. This can be useful for employees who work in multiple timezones, or for visitors who are not familiar with the local time.

Desk bookings

Designed to streamline workspace management, this Resource presents detailed information about users who are currently logged into the KloudHybrid system. By showcasing relevant user details, such as names or booking statuses, this feature facilitates efficient desk allocation and utilization.

Floor map

This dynamic signage display offers a real-time visualization of floor maps, utilizing data extracted from Kloudspot Analytics. By incorporating live data, users can gain valuable insights into occupancy patterns, movement flows, or resource allocation within the designated area.

Google Analytics

Empowering users with valuable insights, this customizable Resource provides a visual representation of data from Google Analytics. By incorporating a user-provided JSON key file from a Service Account, this feature allows for the customization and display of various metrics, such as website traffic, user engagement, or conversion rates.

Image

With the image Resource, you can easily upload and display PNG or JPG images on the display. This capability allows you to showcase visual content such as photographs, illustrations, or graphics, enhancing the overall visual appeal and engagement of the display.

Instagram Hashtag Feed

The Instagram Hashtag Feed Resource enables you to present a dynamic and constantly updating feed of public posts associated with a specific hashtag on Instagram. This functionality brings the power of social media into your signage display, allowing you to leverage user-generated content and create an interactive experience for viewers.

Instagram User Feed

By utilizing Instagram credentials, the Instagram User Feed Resource allows you to showcase an updating list of posts from a specific user’s account. This feature is ideal for businesses, influencers, or brands that want to highlight their own content or curate a specific user’s posts for promotional or informational purposes.

Kibana Panel

The Kibana Panel Resource enables the integration of a Kibana dashboard panel into your signage display. Kibana is a powerful data visualization tool that allows you to create and display visually appealing charts, graphs, and metrics based on data from various sources. With this feature, you can provide real-time insights and analytics in a visually appealing and easily understandable format.

Kloudspot Widget

The Kloudspot Widget Resource allows you to display a shared widget from Kloudspot Analytics on your signage display. Kloudspot Analytics provides valuable data and insights regarding visitor behavior, foot traffic patterns, and occupancy metrics. By showcasing a Kloudspot Widget, you can offer viewers a glimpse into important analytics and empower them with valuable information for decision-making and optimization purposes.

RSS Feed

The RSS Feed feature allows you to display an RSS feed on your signage display. RSS (Really Simple Syndication) feeds provide a convenient way to aggregate and showcase updates from various sources such as news websites, blogs, or other content platforms. By integrating an RSS feed, you can keep viewers informed and engaged with the latest news, articles, or updates in a visually appealing format.

Salesforce Dashboard

The Salesforce Dashboard Resource enables you to showcase a Salesforce Dashboard directly on your signage display. This functionality requires Salesforce credentials and a security token for authentication. By incorporating a Salesforce Dashboard, you can present key sales, marketing, or customer service metrics in a visually engaging and easily digestible manner. This feature is especially useful for businesses that utilize Salesforce as their CRM (Customer Relationship Management) platform.

Follow the steps given below to know how to add Salesforce Dashboard.

Login to Salesforce.com

  1. Open your web browser and go to the Salesforce login page.
  2. Enter your Salesforce username and password, then click “Login”.

image image

Reset your security token

  1. In Salesforce, Navigate to My personal information > Reset My Security Token.
  2. On the Security Reset Token page. Click the “Reset Security Token” button. Salesforce will send an email with your new security token.

image image

Check your email for your security token

  1. Open your email inbox and look for an email from Salesforce.

image image

Login to KloudDisplay

  1. Once you receive the security token Login to KloudDisplay.

Create a new resource of type Salesforce

  1. In KloudDisplay, navigate to the “Resources” > “Create New”.
  2. Select the type “Salesforce”.
  3. Enter your login credentials and security token.
  4. KloudDisplay will display a list of available dashboards. Choose the one you want to use.
  5. After selecting a dashboard, you’ll see a list of components associated with it. Choose one or more components you want to include.

image image

Create a Template on KloudDisplay

  1. Create a Template on KloudDisplay and assign the resource.
  2. Refer Templates section to learn how to create a template.

image image

ServiceNow

The ServiceNow feature allows you to display ServiceNow data on your signage display. This versatile feature supports any table and metric from your ServiceNow account, providing flexibility in the type of data you can showcase.

Follow the steps given below to know how to add ServiceNow Dashboard.

Access ServiceNow Developer Account

  1. Go to the ServiceNow Developer website at https://developer.servicenow.com/

  2. Log in to your ServiceNow Developer account.

image image

Create a New App Instance

  1. Once logged in, navigate to the option for creating/building a new app.
  2. Follow the prompts to create or build your app.
  3. After the instance is created or built, the instance information will be displayed on the screen. Make sure to copy these details for future reference.

image image

image image

Set Up OAuth in ServiceNow

  1. In your ServiceNow account, go to OAuth and then to Application Registry.

image image

  1. Create a new OAuth application.

image image

  1. Choose the type of OAuth application you want to create.

image image

  1. Provide the necessary details and make sure to copy the Client ID and Client Secret.

image image

Login to KloudDisplay

  1. Once you created Clint ID and Client Secret Login to KloudDisplay.

Create a new resource of type ServiceNow.

  1. In KloudDisplay, navigate to “Display Terminal” > “Resources” > “Create new”.

image image

  1. From the “Type” drop-down menu, select “ServiceNow”.
  2. Fill in all the required details. You can choose the collection and metric that will be fetched from your ServiceNow account.
  3. Save the resource.

image image

Refer to the Template section to know how to add this resource to the template.

Slideshow

The Slideshow Resource allows you to create an engaging and visually appealing display by showcasing a rotating set of images. With this functionality, you can curate a collection of images and configure the display to smoothly transition between them, capturing viewers’ attention and delivering a dynamic visual experience.

Stock Feed

The Stock Feed Resource enables you to present a live feed of stock tickers on your signage display. By providing a list of stock tickers, this feature displays real-time stock market data, including stock prices, changes, and other relevant information. This functionality is ideal for financial institutions, investors, or anyone interested in keeping track of stock market trends and updates.

Tableau Workbook

With the Tableau Workbook Resource, you can display a Tableau workbook directly from a specified URL. Tableau is a powerful data visualization tool that allows you to create interactive and insightful dashboards, charts, and graphs. By integrating Tableau workbooks into your signage display, you can present complex data in a visually compelling and easily digestible format, empowering viewers with valuable insights and analytics.

Text

The Text Resource allows you to display text directly on the signage display, providing a versatile way to convey information. Whether it’s displaying a user’s name, important announcements, or any other textual content, this feature allows you to communicate directly with viewers in a clear and concise manner.

TikTok Feed

The TikTok Feed feature enables you to showcase your TikTok videos on Kloud Display. For this, you need to connect your TikTok account with kloudManage. To learn how to do this, refer to the TikTok Integration section. This is a one-time setup. If you have already integrated TikTok then follow the steps given below.

  1. To do this, choose “TikTok Feed” as the resource type.

  2. Next, click the “Authorize Kloudspot” button to authenticate your TikTok account.

  3. Log in to your TikTok account through the popup window that appears.

  1. After logging in, an authentication message will open, and you can click the Authorize button here.
  1. Afterward, click on the Save button to save the resource. Your TikTok resource has been successfully created.

Twitter Hashtag Feed

The Twitter Hashtag Feed Resource enables you to showcase an updating feed of public posts associated with a specific hashtag on Twitter. By integrating this functionality into your signage display, you can harness the power of social media and curate a dynamic stream of user-generated content, keeping viewers engaged and informed with real-time updates and discussions.

Twitter User Feed

With the Twitter User Feed Resource, you can display an updating list of posts from a specific user’s Twitter account. This feature is ideal for highlighting a particular user’s tweets, whether it’s your own account or someone else’s. By showcasing a continuous stream of posts, you can keep viewers up-to-date with the latest tweets, news, or updates from the specified user.

Twitter Wall

The Twitter Wall feature allows you to create a visually captivating display of posts with a specific hashtag from Twitter. By curating and presenting a ‘wall’ of posts, you can showcase a collection of tweets related to a specific topic or event, encouraging viewer engagement and participation in the conversation.

Uber Wait Times

With the Uber Wait Times feature, you can display wait times for a specific address. This functionality provides valuable information to viewers, allowing them to estimate wait times for Uber rides in a particular location. By presenting real-time wait times, you can enhance the convenience and planning capabilities for viewers who rely on Uber services.

Video

The Video feature enables you to upload and showcase videos on your signage display. Whether it’s promotional videos, informative content, or any other video material, this feature allows you to engage viewers with dynamic visual content, delivering a rich and immersive viewing experience.

Weather

The Weather feature allows you to display weather information for a specified location on your signage display. By integrating real-time weather updates, such as temperature, humidity, precipitation, and forecasts, you can provide viewers with valuable weather insights, helping them plan their activities accordingly.

Webpage

The Webpage feature allows you to embed a web page directly onto your signage display. This functionality is particularly useful for showcasing websites, online content, or interactive applications. Please note that the embedded webpage needs to allow this type of display for proper integration.

Youtube

The YouTube feature enables you to showcase a video directly from YouTube on your signage display. By integrating YouTube videos, you can engage viewers with a wide range of content, including tutorials, entertainment, presentations, or any other video material available on the platform.

Zoom Meeting

The Zoom Meeting feature allows you to display a Zoom meeting with a specific ID on your signage display. This feature can be configured to show either video-only or both audio and video elements. Please note that accessing the Zoom meeting may require a password, depending on the meeting’s settings. With this feature, you can facilitate virtual meetings, webinars, or conferences directly on the signage display, enhancing communication and collaboration capabilities.

Bulk upload

  1. KloudDisplay also supports the bulk creation of media files. Users can use the Bulk Upload button to launch a screen where one or more files can be uploaded. This functionality is applicable for image and video files.
  1. Alternatively, files can just be dragged and dropped on the hot region. Each file results in a resource created.
  1. The name and type of the file are derived from the uploaded file. In addition, a comment is added on the resource denoting the upload date.

Templates

After you’ve created the resources you want to use, your next task is to place them within the template. This is where you assemble everything together to create the final display. In this section, we’ll guide you through the process of adding these resources to the template, showing you the steps to seamlessly integrate them. This way, you’ll have a clear understanding of how to bring all the elements together for your setup.

Template Structure in Display Terminals

A template serves as a framework for organizing and displaying resources on display terminals. It consists of multiple regions, each capable of accommodating one or more resources.

Refer Create Template section to know how to create a templete.

Note: Before utilizing templates, it is essential to create the necessary resources.

image image

Types of Templates

There are two types of templates available:

Regular Type Templates:

  • These templates are either consistently displayed or shown according to a predefined schedule.
  • When multiple templates are assigned to a terminal, they are displayed in a sequential manner, appearing one after another.

Event Type Templates:

  • These templates are triggered based on external events.
  • They can be activated through the API or triggered by Rules within the Analytics platform.

By utilizing templates, display terminals can effectively organize and present resources, providing a structured and visually appealing experience for viewers.

Table of content

Subsections of Templates

Create template

  1. A template defines how resources are displayed on display terminals. A template consists of a number of regions each containing one or more resources.
  2. You must create resources before they can be used in templates.

Create template and add resource

  1. Navigate to DISPLAY TERMINALS > TEMPLATE > Create New.
  1. Then, in the template window that appears, fill in all the fields.

Name: Enter template name

Display Type: Select the display type from the dropdown list. 3 types are available. Ultra HD(4K), Full HD(1080P), HD Ready(720P)

Background Color: Select Background color for terminal.

Priority: Select the priority from the dropdown list.

Orientation: According to the terminal direction of the displayed screen,

Select the orientation. you cannot assign a vertical orientation template to a horizontal orientation display.

Type: Two types are available Regular and Event. To gain a deeper understanding of these two types, refer to the Types of Template section.

3. The next step is to add the region to the template. For that click on Add Region button.

4. You can control the size, background color, and order for each region. You can also define how long each resource is shown in a region.

5. To add resources to the region click on the Edit button. Then, in the region property window that appears, select the resource to be added and click the Add button. If necessary, you can add things such as how long each resource should be displayed and how many times it should be displayed. Otherwise, it will show system default settings.

6. After adding enough resources, you can click on the Update Region Properties button.

7. You can drag and change the location of the region as needed.

8. Then Click on the Save Template button. The template is added Successfully. Now you have to add this template to your display terminal for that refer Add Template to Display Terminal section.

9. If you want to create a template group by including multiple templates, refer to the Template Groups section.

Template Groups

  1. A Template Group is a collection of one or more Templates. Templates within a Template Group can be ordered to see the sequence in which the content of each template is displayed.
  2. To create a template group, navigate to DISPLAY TERMINAL > TEMPLATES > Templates Groups > Create New.

3. Then, from the dropdown list, select the templates to add and click Save.

Note: All the Templates within a Template Group must be of the same Orientation as that of the Template Group.

Add template to display terminal

  1. Finally, the created template needs to be added to the display terminal. For that, navigate to DISPLAY TERMINAL.
  2. There you will see a list of terminals. From there click on the Device ID of the terminal to which the template is to be added.

3. Then, in the top right corner of the window, click the Add Template button.

4. Then, from the pop-up window that appears, select the template and time to be added and click the Save button.

Note: Time can be added in two ways. Always and Custom. The Always option allows you to always keep that template visible on the screen. Custom option helps to show only on specific days.

5. After assigning the template, click the Apply Template button in the terminal window.

6. It takes 5-10 seconds to apply. Then you will get a successful notification.

7. The template is successfully added to the terminal.

Announcements

  1. Announcements are a quick and eye-catching way to temporarily overlay text onto a KloudDisplay. It could be a warning or a piece of information. It can be found at the bottom of the display terminal.
image
  1. To see an audit log of existing and expired announcements, click on the Announcements menu item.

  2. To create a new announcement, Navigate to DISPLAY TERMINAL > ANNOUNCEMENTS.

  3. Then click on the Create New button.

image image

  1. Fill in the following details on the popup window that opens.

    Name: Enter the name for the announcement.

    Priority: Select the priority from the dropdown list. Two types of priorities are there Normal and Critical. If you are choosing Normal priority, this will be indicated by a yellow label at the bottom of the screen. In critical it is the red label

    Type: Currently only Text type is available.

    Message: Enter your message here. This message will display on the screen.

    Start time: It helps to determine from what time the announcement should show.

    End Time: It helps to determine at what time the announcement should stop.

    Terminals: Select on which terminal the announcement should be shown. It is possible to select multiple terminals.

  2. After entering all the above information click the Save button.

image image

  1. In addition to this editor, it is possible to set announcements using the action templates in Kloudspot Analytics.

Display Groups

  1. Groups are a solution to separate users into different departments within an organization. Classifying users into Groups in KloudDisplay enables the following

    • Resources & Templates created by users of a Group can only be edited or deleted by users belonging to that Group
    • Resources & Templates created by users of a Group can be previewed by users belonging to any Group
    • Resources created by users of a Group can be used by users of any Group to create Templates
    • Templates created by users of a Group can be used by users of any Group to create Template Groups

Note that a Template Group consisting of Templates created by members of any group can be edited or deleted by members of any other Group.

Workflow Management

This comprehensive guide outlines the step-by-step processes involved in enabling and managing workflows, user roles, resources, and templates using the Kloudspot system. Whether you’re an administrator, author, publisher, or approver, this documentation provides clear instructions on how to navigate the Kloudspot manage and monitoring interface to efficiently edit, approve, and collaborate on resources and templates. By following these guidelines, you’ll be able to seamlessly streamline content modifications, ensure accurate approvals, and effectively manage your digital displays."

Table of content

Subsections of Workflow Management

Enable workflow

  1. Log in to Kloud manage interface.

  2. Click on the Settings menu from the home page. In the basic tab that opens click on the edit button.

  1. Then scroll down and check the Enable Workflow check box and click Save.

Add or edit user

  1. If you enable workflow, you must either add a new user or assign a role to an existing user. To do so, follow the steps described below.

  2. Log in to your Kloud manage admin account with your company username and password.

  1. Navigate to Profile > User & Role Management.
  1. Click the Add User button in the Users window that appears.
  1. Enter user information, such as name, email address, and password.

  2. Then choose a role and click Save. Depending on the user’s responsibility, koudDisplay has three roles.

    • ROLE_DISPLAY_AUTHOR- It allows you to access and Edit the display terminal.

    • ROLE_DISPLAY_PUBLISHER- It allows you to authorize changes made by the author.

    • ROLE_DISPLAY_AUTHOR&PUBLISHER- This allows you to play the roles of both author and publisher.

  1. New user is added successfully. If you want to edit the user, click the edit user button in the Actions column

Edit a resource and send it for approval

Introduction

This document provides a step-by-step guide on how to edit a resource and send it for approval in the system. The process involves logging in with the appropriate user roles, accessing the resource edit page, making necessary changes, and finally, sending the edited resource for approval.

Process Steps

  1. To begin the process, login to the system using an account with either the ROLE_DISPLAY_AUTHOR or ROLE_DISPLAY_AUTHOR&PUBLISHER role. These roles grant the required permissions to edit and submit resources for approval.

  2. After successful login, navigate to the main menu of the application. Look for a RESOURCES menu and click on it. This action will take you to the Resources section where you can manage all the available resources. On the resources page, you should see a list of available resources. Locate the resource you wish to modify and find the edit button next to it. Click on the edit button to open the resource’s edit page.

  1. Once the edit page of the resource appears, you can make the desired changes to the resource’s content. Ensure you apply all the required modifications to the resource.

  2. After you have made the necessary changes, look for Send For Approval button on the edit page. Click on this button to initiate the approval process for the edited resource. The resource will be submitted to the relevant approvers for review and approval.

    NOTE: The changes to the resource only need to be approved if it is impacted by any template. Otherwise, it can be edited directly. The template column indicates whether it has been added to the template.

    NOTE: Once submitted for approval, no further changes are permitted unless the publisher approves or deletes it.

  1. After you have sent the resource for approval, a draft copy will be generated. To view this draft copy, navigate to the Draft resource tab. Please note that the draft tab will be visible only if the workflow is enabled in the system. Once the resource is approved, the draft copy will be removed from the draft resource tab.

Handling “Send For Approval” Button Visibility

  1. If you are editing the resource for the first time, you may not see the Send For Approval button on the edit page. In such cases, follow these additional steps:

    • Navigate to the Draft resource tab.
    • Open the Resource: Find the edited resource in the draft tab and open it by clicking on it.
    • Send For Approval: Once the resource is open, you will be able to see the Send For Approval button. Click on it to start the approval process.

Edit a template and send it for approval

Introduction

This technical document provides a step-by-step guide on how to edit a template and send it for approval in the application. Users with the appropriate roles (ROLE_DISPLAY_AUTHOR and ROLE_DISPLAY_AUTHOR&PUBLISHER) can make changes to existing templates and submit them for approval. The document outlines the process of accessing the template edit page, making modifications, and initiating the approval workflow.

Process Steps

  1. Launch the application and enter your credentials. Use an account that has either the ROLE_DISPLAY_AUTHOR or ROLE_DISPLAY_AUTHOR&PUBLISHER role.

  2. After logging in, Look for the TEMPLATE button in the menu bar and click on it.

  3. In the template window that opens, you will see a list of existing templates. Locate the template you wish to modify, and click on the Edit button next to it.

  1. The edit page for the selected template will now appear. Modify the template content as required. And review the changes and ensure they are accurate and complete.

  2. Once you are satisfied with the changes, click on the Send For Approval button. If this is your first time editing the template, Send For Approval button might not be visible at this stage. Proceed to “Handling “Send For Approval” Button Visibility” steps to learn how to access it.

    NOTE: The changes to the template only need to be approved if it is impacted by any terminal. Otherwise, it can be edited directly. The terminals column indicates whether it has been added to the terminal

    NOTE: Once submitted for approval, no further changes are permitted unless the publisher approves or deletes it.

  3. After editing the template, a draft copy will be automatically generated, If the workflow is enabled, you can view the draft template by navigating to the Draft templates tab.

  4. The draft copy will only be visible until it is approved. Once the template is approved, the draft copy will be removed from the draft template tab.

Handling “Send For Approval” Button Visibility

  1. First-time editors might not see the “Send For Approval” button after editing the template directly.

  2. To send the template for approval, you need to access the draft template page.

  3. Open the template associated with the draft template.

  4. Now, you should be able to see Send For Approval button. Click on it to initiate the approval process.

Approve an edited resource or template

  1. Approval requires a ROLE_DISPLAY_PUBLISHER or ROLE_DISPLAY_AUTHOR&PUBLISHER account. Login with it.
  2. Then click on the WORKFLOW button from the menu bar. In the window that opens. You will see a list of requests.
  3. You can then choose the Resource and Template tabs as required.
  4. Requests can be approved by clicking the Approve button. By clicking on the View button, you can learn more about the change.
  1. If you need to add any more to the change, click on the Request Change button, then add a comment in the popup window that appears and click the Notify button, which will be sent to the author as an email.

  2. If you have any additional comments, leave them in the comment box.

  1. If this change is no longer needed, simply delete it by clicking the delete button.

Analytics Integration

It is possible to trigger display template changes and announcements using rules in the Kloudspot Analytics platform. In order to do this follow the following steps to create an Action Template and then you can use that within a Rule Definition.

Announcement

Go to the Action Templates under ‘Rules’ in Kloudspot Analytics and create a new Action Template with the Display Terminal Announcement type.

It has the following parameters similar to using the Announcement UI :

  • Use display from location.

    • If set, then the displays configured for the location which triggered the rule will be used.

    • If not set, the a drop down will allow the user to select terminal to show the announcement.

  • Priority: Normal or Critical

  • Duration for announcement. Note that the announcement will be displayed immediately and then shown for the specified time.

  • Announcement Text: The message to show. Note that substitution variables (for example ’location’ can be used.)

Event Template

Event templates can only be triggered for a KloudDisplay if they have been assigned to that KloudDisplay

  1. Create an Event Template with the content you want to display.
  2. Assign the template to the displays you want to show it.
  3. Go to the Action Templates under ‘Rules’ in Kloudspot Analytics and create a new Action Template with the __Display Terminal Alert type.
  1. Select the template you created above.
  2. Select the terminals to show the Alert.

Get Insights about a terminal

  1. It helps to get more insights about a terminal.
    • Top Resources served by count.
    • Top Template served by count.
    • Resource Running Summary.
    • Template Running Summary.
  2. Navigate to DISPLAY TERMINALS and open your desired terminal from the displayed terminal list.
  1. Then click on the Insights button from the menu bar. Immediately the insights of that terminal will open.

Get the terminal summary.

  1. It helps to get Resource Count, Template Count, and Real-time Playing Summary about a display.
  2. Navigate to DISPLAY TERMINALS and open your desired terminal from the displayed terminal list.
  1. Then click on the Summary button from the menu bar. Immediately the Realtime summery of that terminal will open.

Kloud Display FAQs

  1. Does KloudDisplay work with any brand of access point?

    • Yes. KloudDisplay supports any access point and needs 2.4GHz SSID for Wireless connectivity. However for proper connectivity we recommend wired connectivity.
  2. Does KloudDisplay support all brands of display terminals?

    • Yes. KloudDisplay supports all brands of display terminals that support HDMI ports
  3. What are the display terminal resolutions supported by KloudDisplay?

    • KloudDisplay supports all display resolutions from HD upto 4K Ultra HD
  4. What are the wireless frequency bands supported by KloudDisplay?

    • loudDisplay supports 2.4GHz wireless frequency band
  5. Does KloudDisplay support both Landscape and Portrait orientations?

    • Yes. KloudDisplay supports both Landscape and Portrait orientations
  6. Does KloudDisplay provide audit information of what was run on the display terminals?

    • Yes. KloudDisplay provides both real Time and historical information on what was run on the display terminals
  7. Does KloudDisplay support scheduling content on the display terminals?

    • Yes. KloudDisplay provides various scheduling options to display content on the display terminals
  8. Does KloudDisplay support remotely switching ON/OFF the display terminals?

    • Yes. Using KloudDisplay, display terminals can be remotely switched ON/OFF. KloudDisplay also supports scheduled switch ON/OFF of display terminals
  9. Does KloudDisplay support Social Media feeds?

    • Yes. KloudDisplay supports various Social Media feeds like Instagram, Twitter, RSS Feeds
  10. Does KloudDisplay integrate with 3rd party systems.

    • Yes. KloudDisplay can be integrated with 3rd party systems. Out of the box, KloudDisplay supports ServiceNow, Tableau, SalesForce & Kibana panel
  11. Does KloudDisplay provide role based access control?

    • Yes. KloudDisplay supports role based access control to provide controlled access to various contents owned by different departments within an organization
  12. Does KloudDisplay support grouping of display terminals?

    • Yes. KloudDisplay supports grouping of display terminals and controlling them as a group
  13. How long is a user authenticated for if they select “Remember me” on the KloudAnalytics login page?

    • If a user selects “Remember me” their session remains valid for 31 days.

Kloud Vision

Brochure

KloudVision is an advanced software that uses artificial intelligence and computer vision algorithms to help businesses with various tasks such as face detection, PPE detection, entry/exit count, vehicle detection, social distancing, and video surveillance. This innovative software has revolutionized the way businesses operate and has significantly improved their security and operational efficiency.

Face detection is one of the primary applications of KloudVision. It is widely used in various industries such as retail, hospitality, and security. With KloudVision, businesses can detect and identify individuals who enter their premises, monitor their movements, and even track their behavior. This is especially useful in high-security areas where unauthorized access is a significant concern.

Personal protection equipment (PPE) detection is an important feature KloudVision provides. The software can detect if an individual is wearing PPE, such as a helmet, safety goggles, or a mask. This is required by industries where safety is primary, such as construction sites, factories, and healthcare facilities. KloudVision ensures that all individuals on the premises are following safety guidelines and wearing the necessary protective gear.

Entry/exit count functionality is also offered by KloudVision, which helps businesses monitor foot traffic in and out of their area. This feature is useful for retail stores and shopping malls, where foot traffic is crucial to determine business performance. With KloudVision, businesses can track the number of visitors and identify peak hours, enabling them to improve their operations accordingly.

Vehicle detection, another capability of KloudVision, allowes businesses to monitor traffic flow and manage parking lots. Businesses with large parking facilities can benefit from this feature. It can also be used to manage traffic in busy urban areas.

During the COVID-19 pandemic, KloudVision had also introduced a social distancing feature. Businesses can monitor the distance between individuals and get alerts when individuals violate those guidelines. This was particularly useful in workplaces or public spaces where maintaining a safe distance between individuals was critical for preventing the spread of the virus.

KloudVision also offers comprehensive video surveillance capabilities, allowing businesses to monitor their premises and respond quickly to any security threats. With advanced video analytics, businesses can detect suspicious behavior or identify potential security breaches in real-time, ensuring that their premises and assets are always protected.

KloudVision is a powerful software that can help businesses improve their security, operational efficiency, and compliance with safety regulations.

In this documentation

Effortlessly set up your KloudVision system with step-by-step instructions on controller selection, and software installation, provided in the installation guide.
Effortlessly set up and configure your KloudVision system with our comprehensive User Guide, covering controller installation and camera setup.
Get quick answers to common questions with our informative FAQ resource.

Subsections of Kloud Vision

Subsections of Installation

System Requirements

The System Requirements document outlines the technical specifications and prerequisites necessary for the successful deployment and operation of the KloudVision video analytics platform. This document serves as a comprehensive guide for system administrators, IT personnel, and stakeholders involved in setting up and maintaining the KloudVision environment.

After choosing a controller that suits your needs, you can proceed to install the kloudvision software on it.

Vision Controller Specifications

The specification of the vision controller is given below.

Feature Specification
CPU Intel Core i3 NUC
Integrated GPU I GPU
RAM 8-16GB
Storage 120GB
All Demographics: Age, gender, emotions 1-2 Cameras
Only Head Count 3 Cameras
Feature Specification
CPU Intel Core i7 NUC
Integrated GPU Intel IrisXE / Iris Plus
RAM 8-16GB
Storage 120GB
All Demographics: Age, gender, emotions 3 to 4 Cameras
Head Count Only 5 Cameras
Feature Specification
CPU Intel Core i9 - 11900k with integrated GPU
Integrated GPU I GPU
RAM 64 GB
Storage 500 GB
VPU card Advantech VEGA-340-08A1 (2 cards can be used in one server and each card supports 10 cameras)
All Demographics: Age, gender, emotions 4-20 Cameras
Head Count Only 25 Cameras
Feature Specification
CPU Intel Xeon Gold 6242R @ 3.10GHz
RAM 64 GB
Storage 1 TB
VPU card Advantech VEGA-340-08A1 (2 cards can be used in one server and each card supports 10 cameras)
All Demographics: Age, gender, emotions 20-30 Cameras
Head Count Only 35 Cameras
Feature Specification
CPU Intel Xeon Gold Model XXX (You can use any model of Xeon Gold)
RAM 8x32GB DDR4
Storage 1 TB
VPU card Advantech VEGA-340-08A1 (3 cards can be used in one server and each card supports 10 cameras)
All Demographics: Age, gender, emotions Up to 30 Cameras
Head Count Only 40 Cameras

Camera Specifications

Note: POE compatible preferred.

Hik-Vision:

Specifications:

  1. Min 1080p* 1920 Camera resolution i.e, 2MP
  2. Support to RTSP url

URL structure for Hik-Vision:

rtsp://username:password@<IP_ADDRESS_COMES_HERE>/cam/realmonitor?channel=1&subtype=0

For Hik Vision cameras, both RTSP and HTTP URL’s work fine. There is no need to use HTTP streams as RTSP works fine and is lag-free.

AXIS cameras:

http://username:password@<IP_ADDRESS_COMES_HERE>/mjpg/1/video.mjpg

For AXIS cameras, RTSP feed lags behind by almost 1.5 minutes. Use HTTP only.

Install KloudVision software to Controller

Having gained a comprehensive understanding of the essential system requirements necessary for the successful deployment of the KloudVision video analytics platform, the next crucial step is to embark on the installation process. In this section, we will delve into the step-by-step procedure to install the KloudVision software onto the designated controller. The controller acts as the central hub that orchestrates the interaction between cameras, data processing, and the user interface. The installation process encapsulates various facets, from acquiring the necessary software components to configuring the software on the controller.

Download ISO File

  1. Please download the ISO from the link below:

Note: To optimize the installation process, it is recommended to obtain three distinct iso files. The first one is dedicated for the exclusive use of KloudVision software, the second for combo devices (both KloudVision and Disply), and the third only for KloudDisplay. If you possess solely the KloudVision device, the Vision ISO will suffice. However, if you have both KloudVision and Display, the appropriate selection would be the Combo Device ISO. Additionally, if you have purchased only KloudDisplay software, then installation of the Display ISO is suitable for your needs.

  1. After downloading you need to create a bootable USB Drive from the downloaded image.

  2. You can download an image writing tool from the link below:

    Rufus - Create bootable USB drives the easy way

  3. This is just a recommendation. You can use any tool you wish, that can accomplish the same job.

  4. Follow the steps as per your software and create a bootable USB.

  5. After flashing, remove the USB from the host and proceed to the installation step below.

Installation

Pre-requisites

  1. Ensure you have a USB drive containing the installation files.
  2. Make sure you have an active internet connection.

Installation Steps

  1. Plug the USB drive into the controller’s USB port and Reboot the controller.

  2. During the reboot process, look for the setup menu, boot options menu, or boot device selection screen. If your system boots up quickly, try using keys like F10, F12, F8, or Del to access the boot menu.

  3. On an Intel NUC, press the ‘On’ button for more than 2 seconds until it turns red. This will bring up the boot menu.

  4. On the boot device menu, select the USB drive as the boot device. The option might have the words “bootloader” or “Ubuntu Installer” associated with it. Make sure it’s booting up Ubuntu Installer from the USB drive.

  5. Once the bootloader menu appears. A window displaying the IP address will open. Select “Done” and press Enter.

    Note: If the device is not connected to the internet, the IP page will not load. It is crucial to ensure that your device is properly connected to the internet before proceeding with the installation process. If the IP page does not load, please check your internet connection and ensure it is active and stable.

  1. After the installation starts, a confirmation window will appear. Select the “Continue” option and press Enter.
  1. The installation process will begin immediately, and it may take approximately 40-45 minutes. If you wish to see the full log, you can select the “View full log” option. Otherwise, the installation will complete automatically.
  1. When the installation is finished, A window will open, displaying a similar interface as shown in the image below. At this point, please remove the USB drive and press the Enter key.
  1. The system will reboot automatically, and the software will open.

Finding the MAC Address

  1. After the installation is complete, the next step is to obtain the KloudSpot license, which requires the MAC address.
  2. Disconnect your internet connection to find your MAC address.
  3. The MAC address can be found at the bottom of the display.
  1. Send the MAC address of the device to Kloudspot, and it will be licensed to your account.

  2. Once the license is applied, you can log in to your Kloudspot Account to configure the camera and other settings for the controller.

Account Creation and Login

Congratulations on successfully installing the KloudVision software to your controller! After receiving your controller’s MAC address, Kloudspot’s support team will process the activation of your license.

  1. Once your license is activated, you will receive your login ID, temporary password, and the URL to access the KloudVision platform.

  2. Access the KloudVision login page using the provided URL.

  3. Enter your provided login ID and password.

  4. Click the “Login” button to access your KloudVision account.

Dashboard Overview

User Guide

In this section you will understand how you can add a controller to our KloudManage software, a step-by-step guide to how you can setup the cameras, configure them, and later view the captured data from the video gallery and play it back. This helps you analyse customer behaviour in physical spaces like, malls, retail stores, and event venues, among others. You can also find out how to integrate Vision with Insights so you can understand footfall patterns, monitor social distancing, or detect specific objects.

This guide is designed to give you step-by-step instructions, valuable tips, and best practices to so you navigate and harness KloudVision effectively, thus equipping you to utilise KloudVision to the best of its abilities.

Table of content

Subsections of User Guide

Add a Controller to KloudManage software

Building upon the foundation of our Dashboard Overview, the next essential step in harnessing the full potential of KloudVision is to seamlessly integrate your controller into the platform.

  1. Once you have obtained your login credentials from Kloudspot, you can proceed to the next step, which involves adding the KloudVison controller to Kloudspot’s Device management system.
  2. For that login to the Device management system.
  1. Navigate to NETWORK DEVICES > Add Network Devices.
  1. Enter the following in the window that opens and click the Save Changes button.

    • Device Type: Select Vision Controller or Combo device (Display + Vision controller) from the dropdown list.
    • Model: Select your controller model from the dropdown list.
    • Orientation: If you selected combo device then select Display Orientation.
    • Rotation: Select Rotation type.
    • MAC address: Enter the MAC address of your controller.
    • Name: Give a name for the controller.
    • Account: Kloudspot provides this information during account creation and it is advised to keep it as is.
    • Venues: During the account creation process, Kloudspot provides information about the venue. To add a new venue, you can refer to the Venues section, which provides guidelines and instructions for the process.

Camera Setup and Configuration

The next pivotal step involves setting up and configuring your cameras. Now that your controller is seamlessly integrated into the KloudVision.

In this section, we will guide you through the process of adding and configuring cameras within the KloudVision platform. By following the step-by-step instructions provided, you will seamlessly bring your cameras online, enabling them to contribute to the generation of actionable analytics.

From defining regions of interest (ROIs) to adjusting camera settings for optimal performance, the Camera Setup and Configuration process empowers you to customize your surveillance network according to your specific requirements.

Table of content:

Subsections of Camera Setup and Configuration

Adding Cameras

In this section, we will guide you through the smooth incorporation of cameras into KloudVision. Incorporating cameras is more than just a physical setup; it symbolizes the merging of advanced technology and thoughtful strategy to establish a unified network of vigilant observers. Refer to the Camera Specifications document to select the appropriate camera for your needs.

  1. Once you have connected the controller, the next thing you need to do is to add the cameras to it. To do so, open the controller to which you want to add the camera.
  2. Navigate to VISION CONTROLLERS > Open the desired controller.
  1. Then click on the Configuration button from the left menu bar.

  2. In the window that opens click on the +Add Camera button.

  1. Enter the following in the popup window that opens and click the Save Changes button.

    • Name your camera and enter a serial number.
    • Choose the connection type (RSTP or USB). (Real-time streaming protocol)
    • If you choose, RTSP (Real-time streaming protocol) you will need to enter the URL you will link your camera feed from.

Create Profiles

This section of our guide delves into the realm of KloudVision Profiles, a dynamic tool that enables you to create and manage distinct profiles for different scenarios, locations, or requirements. By creating a profile you can avoid adding the same configuration to multiple cameras.

  1. Follow the steps below to add a profile.
  2. Click the Profiles button from the menu.
  1. Window containing the profiles will open. Click Create New button from the top right corner.
  1. Enter the profile name and select the primary purpose from the dropdown menu.

    Face Detection: Used to detect the face and related parameters of visitors.

    Face Recognition: Used to configure FRS (face recognition system) using KloudInsight.

    PPE Detection: Used for Personal Protective Equipment-related use cases.

    Entry/Exit count: Used to calculate the number of visitors.

    Social Distancing: Used to determine whether visitors maintain a social distance.

    Vehicle Detection: Used to detect the vehicle and related parameters.

    Video surveillance: Used to configure video surveillance.

    Queue Management: Used to configure queue management.

    QR/Bar Codes:

  1. Once the profile is created it will be displayed in the profile list.

  2. Click the Edit button to configure the profile.

  1. Each profile type offers specific configuration options. Refer to the corresponding sections for detailed guidance on configuring different profile types:

General Camera Configuration

  1. Here are the common steps to do regardless of which camera you install. You can configure the following according to your needs. To configure general camera configurations, navigate to Vision Controllers > (Select the controller).
  1. Immediately the controller dashboard will open and click on the configuration button from the menu bar.
  1. In the camera list that opens, click on the Configuration button next to the camera you want to configure. Immediately the camera configuration window will open.
  1. The configurations used as common in all use cases are given below.
  2. Enable: To activate any camera setup you desire, check enable checkbox.
  3. Target device: Select the type of hardware used.
  4. Post Camera Feed: Enable this check box if you want to get camera status in KloudManage application.
  1. Enable KloudDisplay: Check this option to configure a KloudDisplay to react to the events generated by the camera. Click on the Target KloudDisplay dropdown to tie this camera with a KloudDisplay. Examples of this could be displaying a ‘Please wear a mask’ message on the display when the camera detects a person without a facemask.
  1. Profile:
  • Select the profile containing the configuration to be added from the dropdown list. Refer to the Create profiles section for more information about profile.

    Note: This is useful if you are doing the same configuration on multiple cameras. Otherwise, this step can be skipped.

  • Click Apply Profile button to apply the profile. In the popup window that appears, click on the Yes, I do button.

    Note: Once applied, the configuration cannot be edited later.

  1. Buffer Frame For Recording:
  1. Enable KloudInsights: If you intend to share data from this camera with KloudInsights, please enable the designated checkbox. This will allow you to utilize the collected data to create new dashboards within the KloudInsights platform. Before proceeding, ensure integration between our Kloud Insights platform and KloudManage. Refer to the Integration with KloudManage section for detailed instructions on how to perform this integration.

  2. KloudInsights Post URL : Enter your KloudInsights URL here.

  1. Reachability: It notifies you if the camera is inactive for an extended period. For example, If you set reachability to 10 you will get a notification if the camera is inactive for more than 10 minutes.
  1. The following are the common options available in advanced settings. Values shown below are the default values for each of these options. The default values can be changed as per configuration required.
  • Frames per second (for processing): These are the number of frames used by Vision Controller every second for data processing. KloudVision does not use all the frames emitted from the camera in a second. Higher values provided in this field may increase CPU/GPU usage.
  • Data Frequency in seconds: This value indicates how long Vision controller aggregates data before sending it out to KloudInsights. A lower value may increase the data frequency and result in a faster response. A higher value results in a delayed response.
  • People confidence: This value is the probability that a detected shape on camera is a person. Higher values may fail to detect people. Lower values may detect objects that are shaped as people.
  • Face Confidence: This value is the probability that a detected shape on camera is a face. Higher values may fail to detect faces. Lower values may detect objects that are shaped like faces.
  • Post Request Timeout (in seconds): This value indicates how long KloudVision waits and retries to send the payloads out to KloudInsights until it reaches the preset timeout period.

Face Detection Configuration

  1. If you want to configure any of the following use cases on your camera, you can configure it using the Face detection feature.
  • Queue management

  • Detection

  • Duffle Bag tracking

  • Fire Extinguisher tracking

  • Face fingerprint detection

  • Emotion detection

  • Gender detection

  • Pace monitoring

  • Flow monitoring

  • Age detection

  • Face Mask detection

  • Perspective Transform

  • Detecting People with Infant

  1. Before you begin configuring the use cases, you should first configure the camera’s general configuration. Refer to the General Camera Configuration section for instructions.

  2. Then, select the Face Detection from the dropdown list.

  1. Next, scroll down and choose your preferred use cases. You can choose multiple use cases.
  1. The next step is to plot the ROI on the camera feed. This is necessary for the Queue management feature, as well as in other use cases where Kiosk mode is enabled. Otherwise, it’s optional. Refer to Queue Management section to know how to configure a Queue. Refer to the Draw ROI (region of interest) on the camera frame section to learn how to add an ROI to the camera feed.

  2. Kiosk Mode: Kiosk mode is mainly developed for vending machines where we will be displaying contextual advertising based on the demographics of the people and it also has additional options for choosing the detection range and prominent where it will consider the demographics of the first person in a queue.

  3. Some use cases require additional values; there will be a default value. If you wish to change it, you can. Refer to the Configuring the Face Detection Parameters section to learn what this is and how to change it.

  4. Click the Save button to save the configuration.

Queue management

  1. Configuring queue monitoring involves defining Regions of Interest (ROIs) to focus on specific sections of a queue, such as the lane area, server area, and exit gate. This document outlines the steps to configure queue monitoring to a camera for efficient surveillance and monitoring.

  2. Ensure that you have already created a queue. Refer to the “Queue Creation " document for instructions on how to create a queue.

    Note: It is important to note the specific section that the configured camera is targeting. There are instances where a single camera encompasses all three sections. Alternatively, a queue might require configuration with multiple cameras. The following outlines the process for configuring a lane using a single camera, and this logic can be applied to configure multiple cameras.

  3. If you want to enable this feature, Check the Queue checkbox.

  4. Click All Queues button to view the currently available queues.

  1. Next, draw the ROI in the camera frame. This is mandatory for Queue management.

Configuration Process

Marking the Lane Area

Draw ROI for Lane Area:

  1. Using a polygon or rectangle tool, draw a Region of Interest (ROI) on the camera feed at the locations corresponding to the lane area of the queue.

Configure Lane Area:

  1. In the popup window that appears after drawing the ROI, navigate to the Use Case column.

  2. Select Restrict to Queue Area of Interest from the options.

  3. Choose the queue you created earlier from the Choose Queues dropdown list.

  4. Select the specific lane you are configuring from the Choose Lanes dropdown list.

  5. Click the Save button to save the configuration.

Marking the Server Location

Draw ROI for Server Area:

Draw another ROI using the polygon or rectangle tool at the places where the server area appears in the camera feed.

Configure Server Area:

  1. In the popup window, choose Restrict to Server Area of Interest from the Use Case column.

  2. Select the queue from the Choose Queues dropdown list.

  3. Choose the server area you are configuring from the Choose Servers dropdown list.

  4. Click the Save button to save the configuration.

Marking the Exit Gate Location

Draw ROI for Exit Gate Area:

Draw an additional ROI for the exit gate area using the polygon or rectangle tool.

Configure Exit Gate Area:

  1. In the popup window, select Restrict to Gate Area of Interest from the Use Case column.

  2. Choose the queue from the Choose Queues dropdown list.

  3. Select the gate area you are configuring from the Choose Gates dropdown list.

  4. Click the Save button to save the configuration.

Save Camera Configuration

  1. Scroll down to find the general camera settings.

  2. Click the Save button to save the overall camera configuration.

Object Detection

  1. It is useful for tracking a Trolly and immediately reporting if its speed is slower than normal.

  2. This feature helps determine whether customers are having difficulty using the trolley and assists them if they are.

    For example, airports, supermarkets, hospitals, etc.

  3. If you want to enable this feature, check the Trolly checkbox.

Asset Tracking

  1. Kloudvision asset tracking involves using cameras to monitor the location and movement of valuable assets such as Duffle Bag, Fire Extinguishers, and other assets.

    Duffle Bag: It helps in the tracking of duffle bags at any place. It detects and reports duffle bags displacement in real time.

    Fire Extinguishers: It helps in the tracking of Fire Extinguishers at any place. It detects and reports Fire Extinguishers displacement in real time.

    Any assets: it helps to track small assets. It detects and reports assets displacement in real time.

  2. Check the checkbox if you want to enable any of these features.

Draw ROI (region of interest) on the camera frame.

  1. ROI in camera frames can help to improve efficiency, accuracy, and reduce storage requirements.

  2. ROI must be added if kiosk mode is enabled. Otherwise, it is optional. If ROI is not added, the model will detect the entire frame.

  3. For face detection, ROI can be drawn in two ways.

    • Using the polygon tool
    • Using the rectangle tool.

Draw ROI using the Polygon tool.

  1. Click on the Polygon tool button from the camera frame.

  2. Then connect the dots and draw the polygon in the space where you want to draw the ROI. It should have more than 2 points.

  3. After drawing, click the Finish button to complete the drawing.

  1. Enter the zone name in the popup window that opens and click the Save button.

  2. New ROI zone added successfully. Face detection will only happen when people enter this zone.

Draw ROI using the rectangle tool.

  1. Click on the Rectangle tool button from the camera frame.

  2. Then draw the rectangle where you want to focus the camera.

  1. Then enter the zone name and select Restrict to selected area of interest option from the dropdown list and click the Save button.

  2. Face detection will only happen when people enter this zone.

Monitor camera view.

  1. Monitor camera view is used to detect changes in camera angle or position. An ROI needs to be determined for that.

  2. To do so, click on the Rectangle tool button from the camera frame.

  3. Then draw the rectangle where you want to draw the ROI.

  1. Then enter the zone name and select the Monitor Camera View option from the dropdown list.

  2. Then, select how often you want to observe the change in focus from the Frequency dropdown list and click the Save button and click the Save button.

  3. Now if the camera moves vertically or horizontally from the focus point, it will detect and show how far it has moved.

Additional features of ‘Face detection’

  1. You can enable the features you want in the additional feature section that follows.

    • Age: The age of the person in front of the camera is determined and forwarded to KloudInsights for analysis.

    • Face fingerprint: It helps in the identification of people detected on the camera using characterisations obtained from the database.

    • Emotion: Understanding a person’s emotions with the help of demographics.

    • Facemask: Detects whether the person in front of the camera is wearing a mask or not and, if not, prompts them to wear one.

    • Gender: Identifying a person’s gender depending on the demographics.

    • Arabic Headgear: To detect if a person is wearing Arabic/Emirati Headgear.

      Note: This feature only works if Kiosk mode is enabled.

    • Ethnicity: To detect the ethnicity of a person.

      Note: This feature only works if Kiosk mode is enabled.

    • Perspective Transform: The coordinates of the person are transformed from a camera perspective to new coordinates based on the perspective ROI and hence used for calculating the actual distance between the person.

    • Pace Monitoring: It helps to assess a person’s speed.

    • People with Infant: It helps to identify those who are traveling with an infant.

    • Flow Monitoring: This helps to detect if someone is breaking the entry/exit flow.

Configuring the Face detection parameters

  1. Next, you have to enter the necessary parameters for face detection to work efficiently. For that fill in the details given below.

  2. Frames per second, Data Frequency in seconds, Face Confidence, Post Request Timeout, and People Confidence, are common in some use cases. Refer General Configuration section to know more about these.

  3. Arabic Headgear confidence: This feature shows the probability of a person wearing an Arabic/Emirati Headgear. It only needs to be configured if the ‘Arabic Head Gear’ option is enabled. The default value of Arabic Head Gear confidence is 0.5.

  4. Cosine factor: the Cosine factor determines the uniqueness of faces detected by the cameras. The default value of cosine factor is .65.

  5. Select Head Model: The head model can be selected based on the resolution, distance, angle, and available light of the camera used.

    Head version 1: Works only on good lighting with any resolution. The maximum distance of the camera can be 15 meters with an angle range of 60°-80°

    Head version 2: Works only on good lighting with a resolution of 640 x 480. The maximum distance of the camera can be 70 meters with an angle range of 80°-90°

    Head version 3: Works on low and good lighting with a resolution starting from 640 X 480 to 4k. The maximum distance of the camera can be 120 meters with an angle range of 60°-90°

    Head version 4: Works on low and good lighting with a resolution starting from 640 X 480 to 4k. The maximum distance of the camera can be 300 meters with an angle only of 90°

  1. Remove side faces: Eliminates the side profile face of an individual for better accuracy in detecting demographics.

Min Yaw Value and Max Yaw Value: If this limit is set to more than -35 or +35, ignore the detection of faces in the left/right direction.

Min Pitch Value and Max Pitch Value: If this limit is set to more than -35 or +35, ignore the detection of faces in the up/down direction.

  1. Finally, click the Save button to save the changes.

Personal protective equipment (PPE) detection Configuration

  1. If you want to configure any of the following use cases on your camera, you can configure it using the PPE detection feature.

    Construction Use Cases

    • Face mask detection
    • Hard hat Helmet
    • Safety vest

    Healthcare Use Cases

    • Face mask detection
    • Glasses detection
    • Gloves detection
    • Gown detection
    • Hair mask detection
  2. Before you begin configuring the use cases, you should first configure the camera’s general configuration. Refer to the General Camera Configuration section for instructions.

  3. Then, follow the steps below to configure PPE detection on your chosen camera.

  4. Select the PPE Detection from the dropdown list.

  5. Then, select the industry you wish to configure.

    • Construction
    • Health Care
  1. Scroll down and choose your preferred use cases. You can choose multiple use cases.

  2. The next step is to plot the ROI on the camera feed. Refer to the Draw ROI (region of interest) on the camera frame section to learn how to add an ROI to the camera feed.

  3. Click the Save button to save the configuration.

Draw ROI (region of interest) on camera frame.

  1. ROI in camera frames can help to improve efficiency, accuracy, and reduce storage requirements.

  2. If ROI is not added, the model will detect the entire frame.

  3. For PPE detection, ROI can be drawn in two ways.

    • Using the polygon tool.
    • Using the rectangle tool.
  4. Refer to Draw ROI using the Polygon tool, Draw ROI using the rectangle tool, and Monitor camera view. Section from the Face Detection for more details.

Additional Features of Construction

  1. Facemask: KloudVision determines whether people visible to the camera are wearing face masks or not. This is useful in COVID 19 use cases where for safety it is recommended to wear masks. The number of people detected wearing a mask and not wearing a mask are sent to KloudInsights.

  2. Safety Vests: KloudVision determines whether people in the camera’s view are wearing safety vests. These analytics are sent to KloudInsights. This is useful in site safety scenarios for construction businesses where it is mandatory to wear these safety vests.

  1. Hard Hat Helmet: KloudVision determines whether people in the camera’s view are wearing hard hat helmets. This is useful in site safety scenarios for construction businesses where it is mandatory to wear these hard hat helmets.

Additional Features of Healthcare

  1. You can check the features you want in the additional feature section that follows.

    • Facemask: KloudVision determines whether the person detected by the camera is wearing a facemask.
    • Gown: This feature determines whether a person detected by the camera is wearing a medical gown.
    • Glasses: KloudVision determines whether a person detected by the camera is wearing safety glasses.
    • Hair Mask: KloudVision determines whether a person detected by the camera has a hair mask on.
    • Gloves: This determines whether a person detected by the camera is wearing hand gloves.

Configuring the PPE detection options

  1. Next, you have to enter the necessary parameters for PPE detection to work efficiently. For that fill in the details given below.

  2. Frames per second, Data Frequency in seconds, Face Confidence, Post Request Timeout, and People Confidence, are common in some use cases. Refer General Configuration section to know more about these.

  3. Click the Save button to save the changes.

Entry/Exit Count Configuration

  1. If you want to configure any of the following use cases on your camera, you can configure it using the Entry/Exit Count feature.

    • Entry/Exit Count
    • Fingerprint detection
    • Face mask detection
    • Gender detection
  2. Follow the steps below to configure the ‘Entry/Exit count’ on your chosen camera.

  3. Before you begin configuring the use cases, you should first configure the camera’s general configuration. Refer to the General Camera Configuration section for instructions.

  4. Select Entry/Exit Count from the dropdown list.

  1. Then choose whether to count Entry or Exit. Then, based on the option you chose, draw a ROI; for instructions, see the Draw ROI (region of interest) on the camera frame section.

  2. Along with the entry/exit count, you can utilize the following functionalities. Check the checkboxes for the features you want to add.

    • Fingerprint: It helps in the identification of people detected on the camera using characterisations obtained from the database.

    • Facemask: KloudVision determines whether people visible to the camera are wearing face masks or not.

    • Age and Gender: The age and gender of the person in front of the camera is determined and forwarded to KloudInsights for analysis.

    • Unique Count: It is useful to assign a unique count to the individual viewed on camera.

  1. Depending on the camera’s location, you can change the subject being tracked. If the camera is positioned above the head, you can choose Tracking Subject as Head. If it is below the head level, you can choose the body.

  2. If you want to track a Tray, select Tray. You can select Head and Trolley and count the number of trolley and humans entering or exiting.

  1. You can edit the default parameters to get more accurate entry/exit count. Refer to the Configuring the entry and exit options section to learn what this is and how to change it.

  2. Click the Save button to save the configuration.

Draw ROI (region of interest) on the camera frame.

  1. ROI in camera frames can help to improve efficiency, accuracy, and reduce storage requirements.

    Note: An entry/exit separator is mandatory to calculate the entry/exit count.

  2. Two drawings are required for the entry/exit count. Here ROI is optional. If ROI is not added, the model will detect the entire frame.

  3. drawings are required for entry/exit count. Here ROI is optional.

    • Entry/Exit Separator
    • ROI
  4. For Entry/Exit count, ROI can be drawn in two ways.

    • Using the polygon tool
    • Using the rectangle tool.
  5. Refer to Draw ROI using the Polygon tool., Draw ROI using the rectangle tool., and Monitor the camera view. Sections from the Configure Face Detection for more details.

Draw an Entry/Exit Separator

  1. An entry/exit separator can be drawn using a polyline. It is mandatory for entry exit counting.

  2. Entry or exit count is taken based on this line. Entry is determined in two ways.

    • Horizontally, top to bottom,
    • Vertically, left to right.
  3. If you want to configure an entry count horizontally, follow the steps below.

    • Select the Entry option from the Entrance direction dropdown list.
    • Then, draw a horizontal line using a polyline tool. This line should have only two points.
    • After drawing click the Finish button.
  • Then enter the zone name in the popup window that opens and click the Save button.

    Note: In this scenario, an entry is recorded if an object crosses the entry/exit separator from top to bottom.

  1. If you want to configure an Exit count horizontally, follow the steps below.

    • Select the Exit option from the Entrance direction dropdown list.
  • Then, draw a horizontal line using a polyline tool. This line should have only two points.
  • After drawing click the Finish button.
  • Then enter the zone name in the popup window that opens and click the Save button.

Note: In this scenario, an Exit is recorded if an object crosses the entry/exit separator from top to bottom.

  1. If you want to configure an entry count vertically, follow the steps below.

    • Select the Entry option from the Entrance direction dropdown list.
    • Then, draw a vertical line using a polyline tool. This line should have only two points.
    • After drawing click the Finish button.
  • Then enter the zone name in the popup window that opens and click the Save button.

    Note: In this scenario, an entry is recorded if an object crosses the entry/exit separator from left to right.

  1. If you want to configure an Exit count vertically, follow the steps below.

    • Select the Exit option from the Entrance direction dropdown list.
    • Then, draw a horizontal line using a polyline tool. This line should have only two points.
    • After drawing click the Finish button.
  • Then enter the zone name in the popup window that opens and click the Save button.

    Note: In this scenario, an Exit is recorded if an object crosses the entry/exit separator from left to right.

Configuring the entry and exit options:

  1. Buffer entry: This is an upside Pixel distance from middle line.

  2. Buffer Exit: This is a downside Pixel distance from the middle line.

  3. Tracking Subject: When tracking the camera, it decides whether to track the body or the head. When body tracking is occluded in crowded areas, head tracking can be used.

    • Boady: Entry/exit count is taken by full body tracking.

    • Head: Entry/exit count is taken by head tracking.

    • Tray: Counting the number of trays using the tracking tray. It can be used in places like Airports.

  4. Tracking Subject Confidence: This value is the probability for the tracking subject chosen.

  5. Select Head Model: The head model can be selected based on the resolution, distance, angle and available light of the camera used.

    • Head version 1: Works only on good lighting with any resolution. The maximum distance of the camera can be 15 meters with an angle range of 60°-80°

    • Head version 2: Works only on good lighting with a resolution of 640 x 480. The maximum distance of the camera can be 70 meters with an angle range of 80°-90°

    • Head version 3: Works on low and good lighting with a resolution starting from 640 X 480 to 4k. The maximum distance of the camera can be 120 meters with an angle range of 60°-90°

    • Head version 4: Works on low and good lighting with a resolution starting from 640 X 480 to 4k. The maximum distance of the camera can be 300 meters with an angle only of 90°

  6. Demographics Subject: Helps to calculate the gender and age of the person entering, using their body and face.

  7. Head to Body Ratio: This value can be used to determine whether the person entering is an adult or a child. If the ratio is greater than 0.16, the person is considered an adult; if it is less than 0.16, the person is considered a child.

  8. Maximum Capacity: It helps determine the maximum number of people a zone can accommodate.

  1. Remove side faces: Eliminates the side profile face of an individual for better accuracy in detecting demographics.
  • Min Yaw Value and Max Yaw Value: If this limit is set to more than -35 or +35, ignore the detection of faces in the left/right direction.
  • Min Pitch Value and Max Pitch Value: If this limit is set to more than -35 or +35, ignore the detection of faces in the up/down direction.
  1. Frames per second, Data Frequency in seconds, Face Confidence, Post Request Timeout, and People Confidence, are common in some use cases. Refer General Configuration section to know more about these.

  2. Click the Save button to save the changes.

Social Distancing Configuration

  1. Social distancing monitoring with KloudVison helps track the movements and distances of individuals and ensure they follow recommended social distancing guidelines.

  2. Follow the steps below to configure ‘Social Distance’ on your chosen camera.

  3. Select the Social Distance Option from the dropdown list.

  4. Before you begin configuring the use cases, you should first configure the camera’s general configuration. Refer to the General Camera Configuration section for instructions.

  1. The next step is to plot the ROI on the camera feed. Refer to the Draw ROI (region of interest) on the camera frame section to learn how to add an ROI to the camera feed.

  2. Click the Save button to save the configuration.

Draw ROI (region of interest) on the camera frame.

  1. ROI in camera frames can help to improve efficiency, accuracy, and reduce storage requirements.

  2. Two drawings are required to track social distancing.

    • Vertical and horizontal distance
    • Social distance ROI nodes
  3. Follow the steps given below to draw Vertical and horizontal distance.

    • Draw a horizontal line using a polyline tool. It will have three points.
    • After drawing, click the Finish button.
  • Then enter the zone name in the popup window that opens and click the Save button.
  • Vertical and horizontal distance lines were added successfully.
  1. Follow the steps given below to draw social distance ROI nodes.

Note: Social distance ROI should be drawn only using the polygon tool.

  1. Refer to Draw ROI using the Polygon tool Section from the Configure face detection for more details.

Note : Polygon ROI should have only 4 points.

Configuring the social distancing Parameters

  1. Frames per second, Data Frequency in seconds, Post Request Timeout, and People Confidence , are common in some use cases. Refer General Configuration section to know more about these.
  2. Click the Save button to save the changes.

Vehicle Detection Configuration

  1. The Vehicle Detection option can be used to configure use cases related to vehicles. Currently, three types of vehicle detection are available.

    • Vehicle entry/exit count: Vehicle Entry/Exit Counting with Kloudvision helps in detecting and tracking vehicles entering and exiting a particular location to provide accurate figures and data for traffic analysis and management purposes.

    • Vehicle tracking: It helps in vehicle tracking by utilizing various vehicle characteristics.

    • Vehicle parking lots: Vehicle parking lot monitoring using KloudVision helps monitor the occupancy of parking lots and detect parking violations.

  2. Follow the steps below to configure ‘Vehicle Detection’ on your chosen camera.

  3. Select the Vehicle Detection from the dropdown list.

  1. The sensor features are the next thing to configure. It includes the following options: Profile, Reachability, and Enable Kloudinsights. Refer to the General Configuration section to know more about this.

  2. Then select detection type and configure other settings.

  3. If you want to configure the following use scenarios, as well as the number of vehicle entries and exits, Select Vehicle entry/exit count type. For instructions on how to configure this, refer to the Setup Vehicle Entry/Exit Configuration section.

    • License plate detection
    • Color detection
    • Biker Helmet detection
    • Tarpaulin detection
  4. If you want to configure only the following use scenarios. Select Vehicle tracking type. For instructions on how to configure this, refer to the Set-up Vehicle tracking Configuration section.

    • Car Fingerprint detection
    • License plate detection
    • Color detection
    • Biker Helmet
    • Tarpaulin
    • Dirt on Vehicle
    • Smoke / Fire
    • Smoking
    • Door Wide Open
    • Boot / Bonnet Open
    • No of People
    • Safety Equipment
    • Pace Monitoring
    • Flow Monitoring
  5. If you want to configure the following use scenarios, as well as to find the parking lot availability, Select Vehicle Parking Lot type. For instructions on how to configure this, refer to the Set up Vehicle Parking Lot Configuration section.

    • License plate detection
    • Color detection

Setup vehicle Entry/Exit Configuration

  1. Select the Vehicle Detection from the dropdown list.
  2. Select Vehicle Entry/Exit from the Type. Then, select the object. There are currently 2 types of objects available. Vehicle, and license plate.

Vehicle: The entry/exit of cars and trucks can be counted. License plate detection, color detection, and Mud on tire detection are also possible.

License Plate: It helps to count entry/exit by tracking the license plate.

  1. If you have selected Vehicle in the tracking object, the features given below can be enabled.
  • License Plate Detection: Helps in detecting the license plate of the vehicle.
  • Mud on tyre: This feature helps detect mud on the vehicle tires which is a safety measure to prevent hazardous driving.
  • Color: the camera will detect the color of the vehicle.
  1. Draw a ROI (region of interest) if you chose a truck or car. To learn how to do this, see the instructions under Draw ROI (region of interest) on camera frame.

  2. If you have selected Licence Plate in the tracking object, you can calculate the entry and exit count by tracking the license plates. If the license plate appears in the camera’s ROI, it is considered an entry/exit.

  1. Some use cases require additional values; there will be a default value. If you wish to change it, you can. Refer to the Configuring the vehicle detection options section to learn what this is and how to change it.

  2. Finally, click the Save button to save the configuration.

Set up Vehicle tracking Configuration.

  1. Select the Vehicle Detection from the dropdown list.

  2. Select Vehicle Tracking from the type. Then select the additional features you want.

Additional features of vehicle tracking

  1. You can enable the features you want in the additional feature section that follows.
  • License Plate Detection : Helps in detecting the license plate of the vehicle.
  • Colour : Information about the colour of the vehicle.
  • Mud on tyre : This feature helps detect mud on the vehicle tires, which is a safety measure to prevent hazardous driving.
  • Dirty Vehicle : With this feature, the camera will identify whether the vehicle is clean or not.
  • Door Wide Open : This feature helps you find the vehicle with the door fully open.
  • Smoke/Fire : Used to detect the presence of smoke or fire.
  • Boot/Bonnet Open : This feature is used to detect bonnet/boot open vehicles.
  • Safety Equipment : This feature allows you to detect the absence of safety equipment in the observed area.
  • Smoking : This feature helps to detect smoking in the observation area.
  • Person coordinates : Helps to get the exact location coordinates of a person seen in the camera frame.
  • Pace Monitoring : Helps in the detection of vehicles traveling at less than normal speed.
  • Flow Monitoring : It Helps to identify vehicles violating entry/exit flow.
  1. After selecting your desired configuration, the next step is to draw the ROI (region of interest) in the camera feed. To learn how to do this, see the steps under Draw ROI (region of interest) on camera frame.

  2. Some use cases require additional values; there will be a default value. If you wish to change it, you can. Refer to the Configuring the vehicle detection options section to learn what this is and how to change it.

  3. Finally, click the Save button to save the configuration.

Set up Vehicle Parking Lot Configuration

  1. This feature helps to know available parking lots in a parking area and detect parking violations. It also helps to identify the license plate and color of the parked vehicle.

  2. Select the Vehicle Parking Lot from the type to enable this feature and select the additional features if you want.

  1. After selecting your desired configuration, the next step is to draw the ROI (region of interest) in the camera feed. To learn how to do this, see the steps under Draw ROI (region of interest) on camera frame.

  2. Some use cases require additional values; there will be a default value. If you wish to change it, you can. Refer to the Configuring the vehicle detection options section to learn what this is and how to change it.

  3. Finally, click the Save button to save the configuration.

Additional features of vehicle tracking

  1. You can enable the features you want in the additional feature section that follows.
  2. License Plate Detection: Helps in detecting the license plate of the vehicle.
  3. Color: Information about the color of the vehicle.

Draw ROI (region of interest) on camera frame.

  1. ROI in camera frames can help to improve efficiency, accuracy, and reduce storage requirements.
  2. Three drawings are required for vehicle detection.
  • License ROI nodes
  • ROI
  • Entry/Exit separator

Note: License ROI nodes are mandatory if license plate tracking is enabled. ROI is optional, If ROI is not added, the model will detect the entire frame. Entry/Exit separator is mandatory if vehicle entry/exit count is enabled.

3. Follow the steps given below to draw License ROI nodes.

  • License ROI nodes are used to detect the license plates of vehicles within that ROI. This must be added while enabling license plate detection.
  • It is drawn using the Rectangle tool. It must be drawn within a restricted ROI.
  • To draw a License ROI node. Click on the Rectangle tool button from the camera frame.
  • Then draw the rectangle where you want to draw the ROI. This should be an area where the license plate of the vehicle can be passed.
  • Then enter the zone name and select the License ROI Nodes option from the dropdown list and click the Save button.
  • License ROI Nodes Added successfully.

4. Follow the steps given below to draw ROI. It can be drawn in two ways.

  • Using the polygon tool
  • Using the rectangle tool.

5. Refer to Draw ROI using the Polygon tool., Draw ROI using the rectangle tool., and Monitor the camera view, Sections from Face Detection for more details.

6. Refer to the ‘Draw an Entry/Exit Separator’ section from the Entry/Exit Count to learn how to add an entry/exit separator.

Configuring the vehicle detection options:

  1. Vehicle Confidence: Threshold for detecting the vehicle.
  2. Number Plate Confidence: Threshold for detecting the number plate on the vehicle.
  3. Select country for license plate: Select which country license plate you want to detect. Currently, license plates of 3 countries can be monitored. India, Saudi Arabia, and Bahrain
  4. Buffer entry and Buffer Exit: This is a threshold. Anyone passing through either of these boundaries and then crossing the configured middle line is said to have entered or exited as per configuration.
  5. Frames per second, Data Frequency in seconds, and Post Request Timeout , are common in some use cases. Refer General Configuration section to know more about these.
  6. Click the Save button to save the changes.

Video Surveillance Configuration

  1. Video surveillance enables you to monitor an event on-site (where the camera is installed) from any location. In addition to kloudVision’s core features, Surveillance comes to you with other security benefits such as,
  • Weapon detection: If someone walks into a camera location with a weapon, the camera detects it and starts recording the event.
  • People detection: If someone passes in front of a camera with camera surveillance activated. The person’s age, gender, and the color of the dress are identified. It records from the time the person comes in front of the camera to the time they disappear from the camera.
  • Vehicle detection: When a vehicle enters the camera surveillance, it detects the type of vehicle, its color, and its license plate number. The footage will be recorded during this event.
  • Helmet detection : If a biker appears in front of the camera without a helmet, the camera will recognize him or her and record the incident.
  1. Its most notable feature is that it only records when the configured event occurs. So, finding video footage is very easy.

  2. Follow the steps below to configure ‘Video surveillance’ on your chosen camera.

  3. Before you begin configuring the Video surveillance, you should first configure the camera’s general configuration. Refer to the General Camera Configuration section for instructions.

  4. Then, select the Video surveillance from the dropdown list and select Additional Features.

  1. Here ROI (region of interest) is not mandatory. You can add ROI if you want. Check out the Draw ROI (region of interest) on the camera frame section to learn how to do that.

  2. Some use cases require additional values; there will be a default value. If you wish to change it, you can. Refer to the Configuring the video surveillance options section to learn what this is and how to change it.

  3. Click the Save button to save the configuration.

Draw ROI (region of interest) on the camera frame.

  1. ROI in camera frames can help to improve efficiency, accuracy, and reduce storage requirements.

  2. ROI is optional. If ROI is not added, the model will detect the entire frame.

  3. For Video Surveillance, ROI can be drawn in two ways.

  • Using the polygon tool
  • Using the rectangle tool.
  1. Refer to Draw ROI using the Polygon tool., Draw ROI using the rectangle tool., and Monitor the camera view. Section from the Face Detection for more details.

Configuring the video surveillance options:

  1. Frames per second, Data Frequency in seconds, and Face Confidence , are common in some use cases. Refer General Configuration for various use cases section to know more about these.

  2. Head confidence: This value is the probability that a detected shape on camera is a head. Higher values may fail to detect faces. Lower values may detect objects that are shaped like faces.

  3. Select a Country for License Plate: Select which country license plate you want to detect. Currently, license plates of 3 countries can be monitored. India, Saudi Arabia, and Bahrain.

  4. Click the Save button to save the changes.

Note: You can disable video surveillance if needed, see the Enable and Setup Video Surveillance section for more information.

Enable and setup Video Surveillance

  1. Surveillance is automatically enabled when surveillance is configured on the camera.

  2. Navigate to VISION CONTROLLERS > Surveillance Configuration.

  3. Uncheck the Enable check box and click the Save button to disable Surveillance.

  4. Also, if you want to change any of the information given below, you can also change it here.

  • Recording resolution: Click on the drop-down and select the resolution.
  • Video length (in secs): Set a minimum video length to record an event.
  • Max Video Length (in secs): Set a max video length to record a video in case need to monitor multiple events occurring at the same time one after the other.
  1. If you want to back up your footages every day, check the Enable KloudBackup check box and fill the following details.
  • KloudBackup Provider : Select the backup provider name from the list.
  • Region: Select the location of the provider.
  • Secret Key and API ID: Enter the Secret key and API ID received from the backup provider here.
  • Bucket Name: Enter the folder name in which you want to save the backups.
  • Upload Frequency: Set your upload Frequency.
  • Upload schedule time from/to: Select when to back up every day.
  1. Click the Save button to save the changes.

Create surveillance rules

Refer to the KloudInsights “Creating Rules " section to learn how to create a rule. Alternatively, you can use the “Action Templates” section if you want to create an action template.

Use “Add Vision Entity Conditions” button to create vision rules.

Face Recognition Configuration

  1. If you want to configure Face Recognition Configuration on your camera, you can do it using this feature.

  2. Before you begin configuring the use cases, you should first configure the camera’s general configuration. Refer to the General Camera Configuration section for instructions.

  3. Then, select the Face Recognition Configuration from the drop-down list.

  1. Scroll down and select the entry type. There are two entry modes available:

    • Single entry at a time: If this type is selected, only one face will be recognized at a time.

    • Simultaneous multiple entry: If this type is selected, it helps to recognize multiple faces at a time.

  2. Specify the Detection Range (in meters). This setting allows you to specify the distance between the camera and the person you want to identify.

  3. Check GetCSV Checkbox if you need CSV report of face recognition.

  1. The next step is to plot the ROI on the camera feed. Refer to the Draw ROI (region of interest) on the camera frame section to learn how to add an ROI to the camera feed.

  2. Click the Save button to save the configuration.

  3. Other settings for face recognition should be set within KloudInsights. Refer to the Face Recognition System (FRS) manual to learn how to do this.

Draw ROI (region of interest) on the camera frame.

  1. ROI in camera frames can help to improve efficiency, accuracy, and reduce storage requirements.

  2. Here, ROI is optional. If ROI is not added, the model will detect the entire frame.

  3. For Face Recognition, ROI can be drawn in two ways.

    • Using the polygon tool
    • Using the rectangle tool.
  4. Refer to Draw ROI using the Polygon tool., Draw ROI using the rectangle tool., and Monitor the camera view. Section from the Face Detection for more details.

Integrating with KloudInsights

  1. Once the camera has been configured, the subsequent step is to integrate KloudVision with the KloudInsights platform.
  2. Integrating KloudVision with the KloudInsights platform provides the capability to analyze the data collected by KloudVision cameras and create a wide range of widgets based on it.
  3. To do so, Refer Integrating with KloudManage section from the Kloudinsights admin guide.

Creating Rules and Notifications

Introduction

Kloudinsights software allows users to set up rules to monitor different events or conditions. These rules are designed to automatically trigger actions or notifications whenever certain conditions are met.

To create a rule in Kloudinsights, the user must define the condition that needs to be monitored. The user can choose from a variety of predefined conditions such as Gender detection, mask detection, helmet detection, medical glows detection, and so on.

After the rule is created, it is automatically triggered whenever the specified condition is met. For example, if the user sets a rule to monitor instances where an individual enters an area without wearing a mask, the rule will trigger a notification if someone enters the location without a mask.

Create rule

Refer to the KloudInsights “Creating Rules " section to learn how to create a rule. Alternatively, you can use the “Action Templates” section if you want to create an action template.

Use “Add Vision Entity Conditions” button to create vision rules.

Generating Widgets and Insights

1. KloudVision is a technology that enables businesses to gather and analyze data about customer behavior in physical spaces such as retail stores, malls, and event venues. With the information obtained from KloudVision, businesses can create various types of widgets that provide valuable insights into their customers’ behavior and demographics.

2. Refer Creating dashboards section to know how to create related widgets with KloudVision. This is possible by connecting KloudVision with KloudInsights. Refer Integrating with KloudInsights section to know how to connect KloudVision with kloudInsights.

3. Refer to the Dashboards section to know which widgets are available in KloudVision.

Video Gallery and Playback

There are two methods to view video surveillance footage (video snippets).

Method 1:

  1. Click on the Camera Surveillance menu. Then select your desired office location in the map view that opens.
  1. Immediately a window containing the footage will open, from which you can search for the footage you want.
  1. Here we are supporting Natural Language Search of videos. For example: If you want to search for a person wearing a black shirt, search for “person with Back shirt” in the search bar and you will get videos of a person wearing a black shirt.

Method 2:

  1. Navigate to Camera Surveillance > Video gallery and select the location from the Select Venue dropdown list.
  2. Immediately a window containing the footage will open, from which you can search for the footage you want.

Queue creation

  1. To configure queue monitoring on a camera, the initial step involves creating a queue. A complete queue configuration should encompass a lane, server, and gate.

  2. The exact copy of the queue you want to configure needs to be created here.

  3. Navigate to the Vision Controller interface.

  4. Go to “Queue configuration” to access the queue management settings.

  5. Click on “Create queue configuration” to initiate the setup process.

  1. In the opening window, enter the name of the queue.

  2. Click the “Create” button to proceed.

  1. In the “Configure Queue System” window, you’ll find the Lane, Server, and Gate buttons on the right-hand side.

Add Lanes:

  1. Double-click on the “Lane” button.

  2. In the popup window, specify the number of lanes.

  3. Click “Add” to add the lanes to the canvas.

  1. Adjust the lane positions according to your requirements by dragging them.

Add Servers:

  1. Double-click on the “Server” button.

  2. In the popup window, select the number of servers.

  3. Click “Add” to add server gates to the canvas.

  1. Adjust the server gate positions as needed.

Add Exit Gates:

  1. Double-click on the “Gate” button to add exit gates.

  2. In the popup window, specify the number of exit gates.

  3. Click “Add” to add exit gates to the canvas.

  1. Adjust the exit gate positions according to your needs.

Draw Association Lines:

  1. Click on the icon representing the association you want to create.

  2. The selected icon’s color will change to yellow.

  1. Click on the associated icon to create an association line between them.

  2. Repeat the process to create associations between other icons.

Save Configuration:

Click the “Save Configuration” button to save the configured queue.

Delete Associations:

  1. To delete an association, click on the “Delete association” button.

  2. Select the association lane to be deleted.

  3. A confirmation window will appear; click “Yes, I do” to confirm the deletion process.

  1. Finally, click on the Save Configuration button to save the changes.

Controller Health and Monitoring

1. From the home page, select the partner’s name you want to check the controller’s health.

2. In the window that opens, click on Vision controllers from the menu bar.

3. In the Controller list that opens, select the controller you want to check the health.

4. In the menu bar that opens, click on the Health option.

5. A window containing information related to the controller’s health will open. The window contains the following information.

  • System Status
  • Service Status
  • Device Status
  • Health metrics

6. System Status contains.

  • RAM status: Provides information on RAM usage.
  • Storage status: Provides information on storage and its usage.
  • GPU Utilization: Provides information on GPU.
  • CPU temperature: Helps to know the CPU temperature.

7. Device Status contains.

  • First seen: This displays the date that the controller was added for the first time.
  • Last seen: This displays the date that the controller was detected for the last time.
  • Running Configuration Version: Displays the configuration version that is currently in use.
  • Current Configuration Version: Displays the most recent configuration version that is currently available.

8. Health metrics.

  • Get the last 7 days’ information on CPU, memory, GPU and Ping

To get health metrics

  1. Select the day from the dropdown menu.
  2. Select the metrics you want to check

Kloud Vision FAQs

  1. What is KloudVision?

    • KloudVision is advanced software that utilizes artificial intelligence and computer vision algorithms to assist businesses in various tasks, including face detection, personal protection equipment (PPE) detection, entry/exit count, vehicle detection, social distancing monitoring, and video surveillance.
  2. How does KloudVision’s face detection feature work?

    • KloudVision’s face detection feature identifies individuals who enter a premises, monitors their movements, and tracks their behavior using AI and computer vision. It’s valuable for enhancing security and managing access in high-security areas.
  3. In which industries are face detection commonly used with KloudVision?

    Retail: KloudVision can assist retail businesses by providing accurate entry/exit counts, analyzing customer behavior, and enhancing security measures within stores.

    Hospitality: In the hospitality sector, KloudVision can help with guest management, security monitoring, and optimizing service efficiency.

    Healthcare: KloudVision’s PPE detection and social distancing features are valuable for healthcare facilities to ensure staff and patient safety.

    Construction: KloudVision can enhance safety on construction sites by detecting compliance with PPE requirements and monitoring worker movements.

    Manufacturing: Manufacturing industries can benefit from KloudVision’s safety compliance monitoring and operational efficiency improvements.

    Transportation and Logistics: KloudVision’s vehicle detection capabilities can optimize traffic flow and parking management in transportation hubs.

    Education: KloudVision can be used in schools and universities to monitor visitor access and ensure adherence to safety guidelines.

    Banking and Finance: Enhance security measures in banks and financial institutions by monitoring access and detecting suspicious behavior.

    Public Safety: Law enforcement agencies can utilize KloudVision for surveillance, crowd management, and security monitoring in public spaces.

    Entertainment and Events: KloudVision can help manage crowd flow and ensure safety at large events, concerts, and venues.

    Energy and Utilities: Improve safety compliance and security in energy and utility facilities with KloudVision’s monitoring capabilities.

    Government and Municipalities: KloudVision can assist in traffic management, public safety, and security in government buildings and urban areas.

    Real Estate: Enhance security and access control in residential and commercial properties using KloudVision. Gaming and Casinos: KloudVision’s surveillance capabilities can help monitor activities in gaming and casino establishments.

    Tourism and Hospitality: Monitor and enhance safety for tourists and visitors in tourist attractions and hospitality venues.

  4. What is Personal Protection Equipment (PPE) detection, and how does KloudVision handle it?

    • PPE detection in KloudVision identifies whether individuals are wearing safety gear such as helmets, goggles, or masks. This ensures compliance with safety regulations, particularly in sectors like construction, factories, and healthcare.
  5. How does KloudVision’s entry/exit count feature benefit businesses?

    • The entry/exit count feature helps businesses monitor foot traffic in and out of their premises. It is especially valuable for retail stores and shopping malls to gauge performance and optimize operations during peak hours.
  6. Can KloudVision help with managing traffic and parking?

    • Yes, KloudVision offers vehicle detection capabilities that allow businesses to monitor traffic flow and efficiently manage parking lots. It’s useful for businesses with large parking facilities or busy urban areas.
  7. How does KloudVision assist with social distancing during the COVID-19 pandemic?

    • KloudVision’s social distancing feature helps businesses monitor the distance between individuals and alerts them when distancing guidelines are violated. This is crucial for workplaces and public spaces to prevent the spread of the virus.
  8. What are the benefits of KloudVision’s video surveillance capabilities?

    • KloudVision’s comprehensive video surveillance uses advanced analytics to detect suspicious behavior and potential security breaches in real time, ensuring constant protection of premises and assets.
  9. Is KloudVision suitable for businesses of all sizes?

    • Yes, KloudVision is designed to cater to businesses of all sizes across various industries, helping them enhance security, operational efficiency, and safety compliance.
  10. Can KloudVision be customized to meet specific business requirements?

    • Yes, KloudVision can be customized to suit the specific needs and preferences of your business, ensuring that you get the most out of its features and functionalities.
  11. What kind of support and maintenance does KloudVision provide?

    • KloudVision offers customer support to assist with any issues or inquiries you may have. Additionally, regular software updates ensure that you have access to the latest features and improvements.
  12. Is KloudVision compliant with data privacy and security regulations?

    • Yes, KloudVision takes data privacy and security seriously. The software is designed to adhere to relevant data protection regulations and offers features to safeguard sensitive information.
  13. How can KloudVision benefit my business’s bottom line?

    • KloudVision can help your business improve security, streamline operations, enhance safety compliance, and make data-driven decisions based on real-time insights, ultimately contributing to increased efficiency and profitability.

Kloudspot Gateway

Brochure User Guide

Enterprises and wireless solution providers need to efficiently manage their networks to improve operational efficiency and reduce downtime. Kloudspot Gateway is a class-leading end-to-end wireless network management product for managing enterprise networks.

Available both as a cloud solution and as an in-premise installation, Kloudspot Gateway supports advanced networks and maximize efficiencies in wireless operations, management and fulfillment of carrier-class services. Kloudspot provides complete visibility of your network, security, device onboarding and management, network analytics and maintenance.

Kloudspot Gateway combines the best of network management, AI-based analytics and security on a single platform. Kloudspot Gateway enables businesses to deliver exceptional digital experiences with ease. This fully configured Wi-Fi engagement solution provides

  • Centralized Network Management
  • Hosted Wi-Fi guest portal
  • User management
  • Ad promotions
  • Firewall
  • Real-time application visibility
  • Remote trouble shooting • Customizable reports

Details:

KS-CAM-VR-DPI Specification:

  • 1 RU Intel Architecture with up to 64 core
  • 16 GB+ RAM
  • Bundled with service VM
  • 10/100/1000 Ethernet ports
  • SFP+ ports
  • Tested ambient temperature -20°C to 60°C

Subsections of Kloudspot Gateway

NMS User Guide

This is a step-by-step procedure for configuring a Gateway device to the Kloudspot Management portal, the NMS.

The Kloudspot Management portal enables comprehensive solution for services to meet smart business demands. It manages network profile, device services, real-time device information and captive portal analytics.

Login

Login with the User credentials (i.e., Username and Password) to the page that appears on entering the URL into the web browser provided by Kloudspot.

Figure 1- NMS Login Page

Default Home Page

After logging in, you will be welcomed by the Kloudspot Management homepage that comprises of information as below. The Partner dashboard with dashlets has the following main areas: Location and Network devices summary, Connected Clients devices information and Assets Display table.

Figure 2-NMS Homepage

  • Venues : Provides the number of venues for that location. Clicking More Details takes you to the Venue window.
  • Access points : Provides the number of network devices discovered on your network that shows the total number of running and offline. Hover over the cursor to () or () icon to display status information about the devices.
  • Clicking More Details takes you to the Access Points window.
  • Similarly, click the Displays , the Gateways , the Vision Controllers , and the Devices to view the respective window.

Figure 3-Viewing the devices & venues in the dashboard.

  • Connected Clients and Visitors: Provides the Line graph that shows information about Connected Clients, Guest, and Probing. Hover your cursor over the graph to display the client’s score for that time range.
  • Top 20 clients: Provides a list of client name, mac address with data usage.
  • Clients Device info : Provides a chart that shows device information using an organizationally unique identifier (OUI). Hover your cursor over a chart to display the client’s score.
  • AP Models: Provides a chart that shows Access points models. Hover your cursor over a chart to display the APs score.
  • Gateway Models: A chart that shows Gateway models. Hover your cursor over a chart to display the Gateways score.

Figure 4-Connected client devices shown in Graph & Chart view

  • Resource Impressions : Shows the total number of resources displayed on the terminal. Hover your cursor over the graph to display the resource score for that time range.
  • Template Impressions : Provides the total number of template impressions that are displayed on the terminal. Hover your cursor over the graph to display the template score for that time range.
  • Top Resources: Provides a chart that shows maximum usage resources. Hover your cursor over a chart to display the score of maximum usage of resources.
  • Top Templates: Provides a chart that shows maximum usage of templates. Hover your cursor over a chart to display the score of maximum usage of templates.
  • Display Assets: Provides the list of template groups, templates, and resources.

Figure 5-View Assets display in charts and graph.

Adding a Gateway Device

This section walks you through steps to add a Network Device to the Kloudspot management portal, in this case it is a Gateway.

Steps

  1. Click on the Network Devices from the left-hand side menu that appears on the home page.

Figure 6-network device homepage

  1. Click on the + Add Network Device tab to add a gateway device. The following window appears as show below.

  2. Click on the Device type tab and select Gateway from the drop-down menu as shown in below.

Figure 7-Add a network device

Fig 7: Add network device window for Device type.

  1. Next Click on the Model tab and select the Model type for the gateway specified by Kloudspot as per partners’ requirement.

  2. Click on the MAC Address tab and enter MAC Address for the respective Gateway that needs to be configured. The MAC address is available at the back of the device itself.

  3. Enter the desired name for the Gateway device in Name tab.

  4. The Account tab already has the Account name of the Partner/Customer.

  5. Click on Venues to add venue for the Gateway device which is configured on the Device already.

  6. Click on Save Changes to save the latest information to add a new network device.

Network Configurations

Once the gateway device is added to the Network Management system, we need to configure the device to perform desired operations.

Following are the procedural steps to configure a Gateway device.

Steps

  1. Click on the ‘Gateway Devices’ tap on the left-hand side of the homepage.
  2. The Gateway device recently added will appear on the list as shown in the figure below. The ‘last seen’ information for the device will be ‘Never’ as this is a newly added device.

Figure 8-list of added network devices

  1. On the left-hand panel under the ‘Gateway Devices’ you will find the ‘Configurations’ option. Click on ‘Configurations’ and you will get a page as shown in figure below.

Create New Configuration

  1. On the ![Logo

GATEWAY DEVICES > CONFIGURATIONS. The Gateway Configuration window appears as shown in figure below.

Figure 9-Configuration page

  1. Click on ‘Create new Configuration’ and fill in the following information.
  • Name ’ will the name you want to give to the configuration.
  • ‘Gateway Model’ will be the model of the device that you have just added. This can be found in the ‘ Network Devices ’ list with the Gateway device information as shown in figure 3.
  • Select the country where the system is been deployed.
  • Operating Mode ’ has two types Standalone and High Availability.
    • Standalone: This configuration has a Single device
    • High Availability: This Configuration has two devices i.e., Active and Passive. So, when Primary (Active) device goes down, all the network traffic is diverted to the Secondary (Passive) device. In this case we just select the ‘Standalone’ operating mode.
  1. Click on ‘ Save ’ to save the configuration.

Figure 10-Add new Gateway Configuration Page

Gateway Configuration

The Gateway Configuration page is a multi-tab page with the following options:

  • Services Tab
  • System Profile Tab
  • Link Aggregation Tab
  • VLAN Profile Tab
  • WAN Profile Tab
  • LAN Profile Tab
  • Load balancing Profile Tab
  • Management Profile Tab
  • Assigned Gateways(0) Tab

Gateway configuration for standalone operating mode

Services Tab

  1. Click on this pencil icon to change/edit the features as required.

Figure 11-Gateway Configurations page

2. Remote Syslogs Support: Allows to save logs in remote system.

3. User Bandwidth: To see the bandwidth usage per user/per connection.

4. System Statistics: If checked, the system performance can be seen.

5. Wan Link Quality: If checked, the link quality and the statistics of jitter, packet loss & latency can be seen for WAN profiles.

6. Reachability: If checked and if the device is not active for certain amount of time, an alert will be generated.

7. Reachability Threshold: Choose the time. An alert will be sent when the device is not active for this much time (default is 10 min).

8. Reboot Schedule: User can schedule a device reboot, daily or weekly.

9. Frequency: Choose the day and time when the device reboot is required.

10. Certificate Renewal Schedule: Check this to renew the ssl certificate for hotspot on the day and time provided in the fields next to it.

System Profile

Figure 12-systems profile page

The configuration system profile tab contains settings for the NTP servers and the DNS server and checkboxes of Management services, Captive portal services, and activate service ports for troubleshooting.

  1. To edit the system profile tab, click the Edit () icon on the right side of the Basic Settings pane.
  2. In the Basic settings section, enter the IP address:
  • An IP address of the NTP server to enter in the NTP Servers textbox. This helps the device synchronizing accurate time with the NTP servers.
  • In the DNS server text box, enter the IP address of the DNS server for resolving hostnames.
  1. In the Management section, enable the following checkboxes:
  • Check the Remote Support option that allows users to remotely access and troubleshoot the device.
  • Check the Update Configuration On Reboot option to upgrade the software image automatically and reboot the device.
  1. In the Captive Portal Services section, do the following:
  • Enable Device WhiteList: Check this if any whitelisting of devices is required when connected from the captive portal.
  • Global Devices Whitelist: Provide the MAC address of those devices as a comma separated values.
  1. In the Service Ports section, do the following:
  • Check the Winbox option and the corresponding Allow From All check box that allows you to remotely access and to troubleshoot the device. Mention the port on which the GUI can have access.
  • Check the SSH option and the corresponding Allow From All check box that allows you to remotely connect SSH on WAN and to troubleshoot the device. Mention the port on which the SSH can run.
  1. Click Save.

Figure 13-Link Aggregation page

  1. Click on to create a new profile.
  2. A New default profile is created. Hover on to the new profile, click on pencil icon to edit the profile. Click on to add a new profile.

Figure 14-Add link aggregation profile

  1. Enable Profile: Click on this to enable the profile.
  2. Name: Give a name to the profile.
  3. Slaves: Select two or more interfaces that needs to be combined.
  4. Mode: Choose the mode from the available list of modes.
  5. For balance-alb, balance-tlb, active-backup Mode , user can choose the primary interface from the list of selected interfaces.
  6. Click on Save.

Figure 15-Configure Link Aggregation

VLAN Profile

Figure 16-VLAN Profile page

  1. Click on to create a new VLAN profile.

Figure 17-Add new VLAN Profile

  1. A New default profile is created. Hover on to the new profile, click on pencil icon to edit the profile. Click on to add a new profile.

3. Enable Profile: Click on this to make the profile enable and available to use.

  1. Name: Give a name to the profile.

  2. VLAN Id: Assign a name for the VLAN Id.

  3. Interface: Select an Interface for the VLAN.

  4. Click on Save to save the configuration.

Figure 18-Configure VLAN Profile

WAN Profile

Adding a WAN Profile. Fill in the following information to add a WAN profile on the network.

  1. To create WAN, click to add various WAN configurations. It’s shows a window named ‘WAN-1’
  2. Click Edit () icon to open the add details to the window.
  3. Select the Enable Profile check box to activate the WAN setup.

Figure 19-Add WAN Profile

Figure 20-Configure WAN Profile

  1. From the WAN Type drop-down list, choose one of the following options as per your requirements:
  • DHCP: If you select this option, do the following:
    • Click on the Connectivity Check check box to verify the WAN connection.
    • Enter the IP address in the Monitor IP field.
  • PPPoE: If you select this option, do the following:
  • Fill in the information which ISP provided: Service Name, Account Name, Username, and Password.
  • Static IP: If you select this option, do the following:
  • If your WAN connection requires a static IP address, enter in the required fields: Static IP, Netmask, and Gateway.
  • LTE: if you select this option, do the following:
  • Enter the APN name in the APN field.
  1. In the NAT Type drop-down list, select an option: NAT Enable or Disable.

  2. From the Interface drop-down list, choose an ethernet port. An Interfaces range from 1 to 5.

  3. Click Save.

  4. To define more WAN profiles, repeat Steps 1 to Step 7.

NOTE: A message will be shown at the top of the page.

LAN Profile

Figure 21-Add LAN Profile

Figure 22-Configure LAN Profile

  1. Select the Enable Profile check box to activate the LAN setup.

  2. In the Name field, enter a unique name for the LAN network interface.

  3. From the Interfaces drop-down list, choose the assigned interfaces (VLAN, Physical Interfaces, or Link Aggregation).

  4. In the Address field, enter the gateway IP address.

  5. From the Netmask drop-down list, choose a netmask depending on your IP pool.

  6. Check the DHCP server check box to update the following options:

  • In the DHCP Start IP field, enter the start of the IP address range that the DHCP server will use.

  • In the DHCP End IP field, enter the end of the IP address range that the DHCP server will use.

  • In the DHCP DNS field, enter the DNS IP addresses. If multiple addresses, separate those addresses with comma.

  • In the DHCP Lease Time field, enter the valid time for which the DHCP server leases IP addresses to the devices.

  1. Guest Access: The Guest Access module configures the custom landing page URL for the Guest portals.

Note: If DHCP is not enabled. Guest Access should be enabled if the device is connecting from captive portal.

Note: Make sure captive portal is configured and available to use Guest Access.

  1. To activate the external guest portal, check the Guest Access check box as shown in the Fig. 13. It enables following options as shown in figure below.

Figure 23-Guest Access Page

  1. Check the MAC Authentication check box to verify the MAC address.

  2. Guest Login : Kloudspot supports internal and external guest portals.

  • Check the Guest Login check box to configure guest access.
  • From the Guest Template drop-down list, select the assigned guest template.
  • Check the External Guest Portal check box to integrate the guest portal.

Figure 24-Guest Access Page

  • Enter or paste the Portal URL that links to the Guest Portals web page as follows.

CAPTIVE PORTALS > GUEST PORTALS. The Kloud Portals page appears.

In the White IP List field, enter the IP addresses that allow you to create lists of trusted IP addresses and domains that permit you to access your domain. If you have multiple IP addresses, you ensure to separate addresses with comma.

  • In the White Domain List field, enter the domain name separated by comma or wildcard subdomains.
  • In the Device White List field, enter the MAC Addresses separated by a comma.
  • In the Secret field, enter the shared key for authentications.
  • Guest Access: The Guest Access module configure Email to authenticate and authorize a link to the Guest portals.
  • Check the Email Authentication check box to verify by way of the email address.
  • In the Access Time (in Minutes) field, specify the access time for a session.
  • Enter or paste the Email Template URL that links to the email page as follows.

Figure 25-Kloud Portal page

  1. From the Kloud Portals page appears.

  2. In the Preview row, click your appropriate email browser, and copy the URL from the web browser’s address bar.

  • In the Email Subject field, enter the line informative for the email verification.

  • Enter or paste the Post Activate URL that links redirects to the welcome page after a successful login as follows.

  1. From the Kloud Portals page appears.

  2. In the Preview row, click your appropriate welcome or welcome-new browser, and copy the URL from the web browser’s address bar.

  3. Check the Email Link Authentication check box to authenticate email configuration.

  4. Multiple sessions : A customer is assigned an IP address and a session ID to connect multiple devices for the usage of the network.

Figure 26-Guest Access cont.

  1. Check the Multiple Sessions check box to configure the network session.
  • From the Total Access Time drop-down list, choose the time or days for the customer.
  • From the Max Expiry Period drop-down list, choose the days. This parameter specifies the expiry timer and will log off customer devices automatically.
  • In the Max BW Per Day (MB) , use the up-arrow key or down to scroll the bandwidth ranges. This parameter specifies the bandwidth when the customer access the internet.
  • In the User Down Rate (mbps) , use the up-arrow key or down to set the internet speed.
  • In the User Up Rate (mbps) , use the up-arrow key or down to set the internet speed.
  • Check the Block Access check box.
  1. If uncheck the Multiple Sessions check box. This assigns a session to connect a device for the limited usage of the network.

Figure 27-Guest Access cont.

  • From the Expiry Time drop-down list, choose the time or days. This parameter specifies the expiry timer and will log off customer devices automatically.
  • Click the Welcome Back Support check box to re-connect the session again for the customer.
  • From the Welcome Back Freq drop-down list, choose an option: time, days, or a year.
  1. Click Save.

Load Balancing Profile

Figure 28-Load balancing page

  1. Enable LoadBalancing: Click on this to make profile enable.
  2. Group Name: Give a name to the profile.
  3. Mode: Choose a required mode. (Load balancing is done based on connecting users or connected gateway device)
  4. LAN Profiles: Select the number of LAN profiles.
  • Add WANs: Choose desired WAN profiles. Assign weights to set the load to each WAN as required (make sure WAN profiles are configured enabled in the WAN Profile section) .
  • Click on +Add New to add more WAN profiles. Click on **![A red circle with a white background

Description automatically generated with medium 5. Click on Save.

Management Profile

Management profile serves different purpose in Standalone Operating Mode and High-Availability Configuration Mode.

Figure 29-Management Profile page

  1. Enable Profile: Click on this to make enable the profile.
  2. Name: Give a name to the profile.
  3. Interface: Choose a desired interface for this profile from the drop-down list.
  4. Address Type: Choose an address type whether Static or Dynamic. If Static, then specify the IP address, Netmask and Gateway.
  5. Click on Save to save the profile added.

Assigned Gateway

Once all the profiles are configured, assign gateway devices that run on this configuration.

![Graphical user interface, text, application, email

Figure 30-Assigned Gateway page

  1. Click on the Assigned Gateways tab from the Gateway Configurations page. Figure 31-Detailed of assigned gateway

  2. Click on ![Icon

selected gateway device.

  1. Name: Name of the assigned gateway.

  2. Mode: Shows Gateway as mode.

  3. Last Deployed Config

  • Last Gateway Configuration: This shows the last deployed configuration once it is synced with the gateway devices.
  • Last Running Version: This shows the configuration version which the device is running on.
  • Last Downloaded Version: This shows the configuration version last downloaded by the device.
  1. Last seen: Click on Details, it opens a popup with runtime and Firmware information.

with the same configuration.

Gateway Configuration for High Availability Mode

Note: Service, System, VLAN, Link Aggregation, WAN, Loadbalancing Profile configurations remains same as in the Standalone mode. Please follow the same steps mentioned for standalone mode to create these profiles.

Only Management Profile and Assigned gateways section changes.

Management profile for High-Availability configuration Mode

HA Configuration provides Master and Slave features. It supports two WAN Modes.

  1. Use same WAN Profile

  2. Use different WAN Profile

HA Configuration with same WAN profile.

Figure 32-Add a gateway device for HA mode

  1. Choose operating mode as High Availability.
  2. Choose WAN mode as Use same WAN Profile.

3. By default, Master Tab will be open. Click on information same as that in the Standalone Profile.

Figure 33-Master profile for Management profile in HA mode

Choose the Interface from the drop-down list. This interface must be the interface created in Master Profile i.e., ether1.

Note: Slave profile can be created only if a Master profile exists.

Figure 34-Slave profile for Management profile in HA mode

  1. Fill in all the information, same as that in the Standalone Profile.

  2. Click on Save.

HA Configuration with different WAN profile.

Note: Service, System, VLAN, Link Aggregation, configurations remain same as in Standalone mode. Please follow the same steps mentioned above for standalone mode to create these profiles.

WAN Profile, Load Balancer Profile, Management Profile and Assigned gateways section changes. They will have Master and Slave Configurations.

  1. Create New Gateway Configuration
  • Operating Mode : Select as High Availability.
  • WAN Mode : Select as Choose Different WAN Profile.

Figure 35- Add new Gateway device for different WAN profile

  1. Create Master WAN

Figure 36-Add Master for Different WAN profile mode

  • Click on WAN Profile tab from the Gateway Configurations page.
  • Click on Master tab and Click on to create a new master profile.

Figure 37-Confiigure master for different WAN profile mode

  • Hover on to the profile, click on edit button.
  • Enter all the input information. This information will be same as explained in the standalone.
  • Click on Save at bottom, to save the master WAN profile.
  1. Create a Slave WAN

Figure 38-Add slave for different WAN profile mode

  • Click on Slave tab and Click on to create a new slave profile.
  • Hover on to the profile, click on edit button.

Figure 39- Configure slave for different WAN profile mode

  • Enter all the input information. This information will be same as explained in the standalone.
  • Slave Interfaces will be same as the master interfaces. (For example: as mentioned above configuration for Master WAN, interface ether1 is assigned as Master, so the slave here can have only ether1 )
  • Click on Save to save the slave WAN profile.
  1. Create Master Load Balancer

Figure 40- add master for Load Balancing

  • Click on Load Balancing Profile tab from the Gateway Configurations page.
  • Click on to create a new Master Profile.
  • By default, master tab will be open. Click on Master tab to configure master profile.

Figure 41-Configure master for load balancing

  • Hover on to the profile, click on edit button.
  • Enter all the input information. This information remains the same as explained in standalone.
  • Master Load Balancing Profile will have Master WANs to set the load balance.
  • Click on Save to save the master Load Balancer profile.
  1. Create Slave Load Balancer

Figure 42-Create Slave for load balancing

  • Click on Slave tab and Click on to create a new Slave Profile.

Figure 43-Configure slave for load balancing

  • Hover on to the profile, click on edit button.
  • Enter all the input information. This information remains the same as explained in standalone.
  • Slave Load Balancing Profile will have Slave WANs to set the load balance.
  • Click on Save to save the slave Load Balancer profile.
  1. Create Master Management Profile & 8. Create Slave Management Profile
  • This is same as configuring the Management profile in HA configuration with same WAN Mode.
  • However, follow the same steps to configure the Management Profile for HA configuration with different WAN Mode.
  1. Assigned Gateways
  • This is same as mentioned in the HA configuration for same wan mode. Please follow the same steps

Assigned Gateways

Note: The process to assign gateways will be same for both HA configuration with same WAN mode and HA configuration with different WAN mode.

A user can choose a gateway to assign to the configuration along with the mode. If the mode is MASTER, the configuration done for master profiles will be applied. If the mode is SLAVE, the configuration done for master profiles will be applied.

For both the modes, the profiles that are same without master and slave feature like Services, systems, link aggregation, vlan will remain same.

Figure 44-Assigned gateways for HA mode

  1. Name: Name of the Master device assigned to the configuration.
  2. Mode: Mode of the device Master or Slave
  • Master: Acts as primary device applying the Master configurations.
  • Slave: Acts as a Secondary device applying the Slave configurations.

Detailed Information of Gateway Device

This section shows the detailed information of a gateway device.

Click on GATEWAY DEVICES from the left-hand side menu of the homepage. From the shown list click on the desired gateway device to see its information. This consists of following options.

  1. Summary
  2. Devices
  3. Realtime Info
  4. Tools

Summary

Click on the Summary on left side menu on the homepage. Following details show up for a gateway device.

Figure 45- Summary of Gateway device

  1. Bandwidth Usage: Total bandwidth utilization can be monitored here. It also shows other data as the bitrate and total bytes. It also shows the statistics for specific time interval and according to the interface.
  2. Bandwidth Usage of ACT: Analysis of bandwidth utilization of each WAN link.

3. Jitter for ACT: This is the information on the time delay in sending the data packet over the network via a WAN link.

  1. Packet loss for ACT: Information of whether any packets lost during the data transfer over a wan link.

  2. Latency for ACT: This is the information on time taken for a packet to get to it’s destination.

Devices

Click on the Devices option from the left-hand side of the homepage. This section gives detailed list of devices connected to the Gateway. The following page opens which has information such as Mac address, IP Address, Last WLAN and Last seen for the connected user.

Figure 46-Devices page

Click on View All Connected Devices Today to see for more details. The following page is displayed.

The list contains following information.

  1. MAC Address: The MAC address of the device connected to the network.

  2. User Detail: Details of the connected user.

  3. First seen: Date and time when the user was first seen by the network.

  4. Last seen: User last seen by the network.

  5. Runtime Info: Shows information such as the bandwidth usage of the connected user.

  6. Actions: Actions to be specified for the user connected to the device. Tags can be assigned for easy identification of the user. History shows the detailed information of the user.

    • Click on History and a page is displayed as below that shows all the activities of the connected user.

Realtime Info

Click on Realtime Info on the left-hand side of the homepage to see the real time information of the devices connected to the network.

Figure 47-Real time info page

The information displayed is as follows.

Interface Details

  1. Name: Name of the interface and MAC address of the device connected.
  2. Type: Type of the interface and MTU (Maximum Transmission Unit).
  3. Running: Displays Yes if the link is up and running. Link Down shows the time if/when the link was down. Last link up shows the latest time when the link was up and running.
  4. Link Bandwidth: Information about the data Transmitted/Received in bytes.
  5. Link Rate: The speed at which the data has been Transmitted/Received.
  6. Actions: Shows a graphical representation of the interface details as shown below.

Note: This data gets automatically refreshed after few seconds and remains static after a while to avoid huge data load.

Active Connections

Active connections show the details of the tcp/udp connections. Source address would be the origin address on the connection and destination address would be the end address of the connection. Origin shows the bytes requested, Replay shows the bytes sent.

Addresses

Shows all the network associated addresses.

ARP Table

This shows the details of Address resolution protocol (ARP), including the MAC address associated with the IP address. LAN details and status.

Captive Portal Active Devices

Captive Portal Active Devices shows the details of the devices that are active and connected via the captive portal.

Captive Portal Devices shows details of all the devices (active and inactive) that are connected via the captive portal.

DHCP Leases

DHCP details of the network.

Route Table

Details of the routing table.

System Resources

This table shows the system information. This includes CPU details such as CPU count, frequency, load percent. Memory details such as total & remaining memory.

Storage Space information. Status shows version and up time indicates how long the system has been up.

Clicking on CPU details gives load percent info as shown in below image.

Tools

Click on Tools from the left-hand side of the homepage options.

Figure 48-Tools page

  1. Reboot: Reboots/Restarts the device
  2. Ping: User can ping any ipaddress to get the details on the terminal. Clicking on Ping button shows the information of the current device.
  3. Trace Route: Click on this option or enter traceroute command to see the path details of the packet.
  4. Sync Config: Click on Sync Config to update the gateway configuration of the device.

On-Boarding Guide

Newly Procured Devices

Skip this section if you procured the device from Kloudspot: It should already be active. Click here if you want to onboard device after reset.

Once you have your brand new Mikrotik Device, we need to first reset the configuration and remove any default configs.

Prerequisites:

Winbox Software – Download

[If you get a Prompt to allow the app through firewall, please select both public and private network from the options]

Connecting to Device for the first time:

Please connect the device to your PC in the following way –

Connect one end of Ethernet to Router port (ether2) and the other end to your PC. Make sure your Ethernet configuration is set to obtain ip address automatically.

Once connected, open winbox software and click on the “Neighbours” tab. You should be able to see a device. Click on the mac address of the device, Enter username as “admin” and click on connect. The password on a new device is usually empty.

  1. Click on “Neighbors” Tab.
  2. You should see the device. Click on the mac address.
  3. Enter the username as “admin” you should be able to see the mac address on the connect to field.
  4. Click connect.

This should log you into the fresh Mikrotik Device. Please proceed to section 1.3 for Onboarding instruction.

Recovery of Existing Device

(We are going to reset the device to factory conditions. This will clean the device and make it ready for installing Kloudspot software on the same.)

Warning

Please SKIP this section if you already have access to the device via winbox.

Follow this section in case your device is not responding, or the device is stuck on an “Updating status” for a long time (more than 15 mins) and Kloudspot Support is not able to access device.

It is recommended to have a Kloudspot Engineer on the call while performing the steps as a link will be provided by the Engineer to activate device and onboard to Kloudspot Platform.

Reset Gateway Device to Factory Condition :

  1. We will now reset the gateway in its factory condition. Please follow the instruction carefully:
  • When router is powered on, press the reset button and hold for 30 seconds. (Use a paper clip or something sharp
  • While holding the reset button pressed, unplug the power of the router and hold the reset button for 30 seconds
  • While still holding the reset button down, turn on the power to the unit again and hold for another 30 seconds.

2. After performing this step, Please go to section 1.1 to see how to get access to device using winbox for the first time.

3. After a reset is performed. The default IP (192.168.88.1) Should be visible on the Winbox “Neighbors” tab and identity of the device should be “Mikrotik”

4. If you see anything else, please try to reset the device once again.

Removing Factory Default Configuration

  1. Once you are logged in through the winbox, please open the terminal window from the left menubar and execute the following command: “system reset-configuration no-default=yes”. It will ask you to confirm whether you are sure to reset. Press ‘y’ and then return/enter the key.

2. The device will now reboot and remove all the default configuration. Once device is booted, please log in back to the device using Winbox software. (Please refer to. Section 1.1 on how to connect to the device via winbox. )

Installing Kloudspot Software on Device

  1. Once the device is rebooted after cleaning and removing all existing configuration, we will now proceed to install the Kloudspot Software for Device management. For this step it is important to have a Kloudspot Support Engineer available so that he can enable the onboarding and help you with registration of the device on the License Server.
  2. Before Proceeding to this step, it is also recommended to add your device on the Kloudspot NMS with the WAN configuration and a basic LAN configuration. Make sure your device is assigned to a Gateway Configuration before you proceed with the next steps. Kloudspot Support Engineer might have already taken care of the configuration.
  3. Before we Proceed, we need to configure internet access on the Mikrotik Device for the first time. Please go through the steps below to configure internet access for the first time depending on the type of connection provided by your ISP.

Setting up WAN for the first time

Please use the correct configuration based on type of WAN provided by ISP:

DHCP

  1. Use the following steps if your WAN connection type is DHCP.
  2. Connect to the device using winbox software. Click on ‘New Terminal’ and type the following command to add a dhcp-client.

3. You can check you have internet connection by typing “ping 8.8.8.8” and see the reply. If you get replies like the following you should have internet connectivity. Press ‘ctrl + c’ to stop the ping command.

4. You can now proceed to 1.4.2 (Installing Kloudspot Software) to start onboarding the device to Kloudspot Platform.

Static IP Address

  1. Use the following steps if your ISP has provided you with a Static IP Address, gateway and subnet-mask to get connectivity.
  2. Connect to the device using winbox software. Click on ‘New Terminal’ and type the following commands to add an address to the interface, set the DNS and have the default gateway configured.

3. You can now proceed to 1.4.2 (Installing Kloudspot Software) to start onboarding the device to Kloudspot Platform.

PPPoE Client

  1. Use the following steps if your ISP has provided you with a Static IP Address, gateway and subnet-mask to get connectivity.
  2. Connect to the device using winbox software. Click on ‘New Terminal’ and type the following commands to add an address to the interface, set the DNS and have the default gateway configured.

3. You can check you have internet connection by typing “ping 8.8.8.8” and see the reply. If you get replies like the following you should have internet connectivity. Press ‘ctrl + c’ to stop the ping command.

4. You can now proceed to 1.4.2 (Installing Kloudspot Software) to start onboarding the device to Kloudspot Platform

Installing Kloudspot Files

  1. Once you have connectivity on your device, you should be able to start installing the Kloudspot Files on the Device. Please Get Activation Command from Kloudspot Support Engineer. We will use the activation command to start the installation.
  2. Open the terminal and enter the activation command on the terminal. It is recommended to Paste the command from Email.

3. It should show nothing on the terminal. To Know the status, you need to open log window from the left Menu Bar. Please refer to image below

4. Please don’t press any Key. Once the files are downloaded, the device will reboot automatically. You can then proceed to the NMS to check the device status. It might take up to 10 Mins for the device to finish onboarding process.

Verifying Onboarding

  1. Once the device reboots, you can go to the NMS and check the status of the added gateway device.

2. Once its green, Device will reboot once more to make sure all the settings are applied correctly. Please wait for some more time.

3. You can go to the device ‘real time‘ information tab to check if the device is back online. Please wait for few seconds and try again in case you get any error.

Gateway Alerting

This document gives detailed information and functionality of the alerts and notifications feature incorporated in the Kloud Gateway.

Alerts: Alerts are tasks that continually monitor active queries to look for and report on specific events or conditions depending on the criteria we set. When the conditions of the alert are met, an alert notification is triggered.

Notifications: Notifications are simple messages generated by the system when certain events have occurred within.

Getting started

Log into the NMS portal with user credentials.

Fig 1: NMS login page

Alerts

Following are the fundamentals to set up alerts. Alerts are generated at constant intervals of time.

  1. Make certain prerequisites to enable alerts in the system.
  2. Define the threshold for the alerts.
  3. Specify contacts to send the alerts.
  4. Send the notification for the alerts.

How to set up alerts?

Note: Considering the Gateway, the device is already configured.

Steps

Referring to the figure below, set up the alerts.

Fig 2: Gateway Configuration page

  1. Click on the Configurations option under Gateway Devices.
  2. Services tab will be open by default.

In Analytics Services, enable the ‘WAN Link Quality’ box to check the quality of the specific WAN link and enter an IP address in the ‘Monitor IP’ box to get alerts for the WAN.

Note: WAN link-related alert options will only be available if the ‘WAN Link Quality’ box is checked.

3. Self-Organized Alerts:

a. Link Capacity Alert: Enable this option to get an alert on the capacity of the link. Select a WAN profile and define the Uplink and Downlink capacity.

Note: If the U/L and D/L link capacity is set to zero in the WAN profile then no capacity alerts will be generated.

Fig 3: WAN profile page

b. Link Jitter Alert: Enable this option to get an alert on the Jitter on a link. Select the WAN profile and define the average jitter in milliseconds.

c. Link Latency Alert: Enable this option to get an alert on the latency of the link. Select a WAN profile and define the average link latency in milliseconds.

d. Link Packet Loss Alert: Enable this option to get an alert for a link in case of packet loss. Select the WAN profile and define the average percentage of packet loss on the link.

e. Reachability: Enable the option to send an alert in case the device is not active for the pre-defined threshold time.

f. Reboot Schedule: Enable this option and set a frequency to send an alert if a reboot on the device is to happen at the pre-defined time and day.

Note: For all the link-related alerts (from a to d), the Gateway device must have internet connectivity and communication with the NMS. However, the reachability feature does not need internet connectivity to generate an alert.

Available platforms to see the alerts

Alerts are available at different levels within the portal.

  1. Audit logs: Alerts can be seen on the left-hand side of the homepage, in the Audit Logs option in Alert logs.

Fig 4: Alerts Logs Page

2. Venues: Alerts are also seen in the VENUES option. To see the alerts, on the left side of the homepage, click on VENUES and select the desired venue (for example: BangaloreLab) and click on the Alerts option below.

Fig 5: Alerts Page in VENUES

3. Gateway Devices: Alerts can also be seen on individual device level. On the left side of the homepage, click on GATEWAY DEVICES, select and click on the desired device and click on the Alerts option below.

Fig 6: Alerts page in GATEWAY DEVICES

Notifications

Notifications are the messages sent out of the NMS to the respective contacts in case of any action takes place within the system.

Set up Alert Notifications:

  1. In the Settings tab, go on to Alert Notifications. Click on +Add notification to add notifications as shown in fig below.

Fig 9: Alerts notifications page

2. In the Alert Notification tab, fill in the required information.

Note: Contacts will be shown in the list only if they are already added. To add a contact refer to How to add Contacts? document.

Fig 10: Adding Alert Notification

a. Active: Enable this option to activate the notifications.

b. Notification type: Select the alert type you want the notification message for.

c. Name: Enter a name for the Notification type.

d. Frequency: Define the time intervals for which the notifications will be sent out.

e. Notification Context: Choose Account option or click on Custom option to choose from multiple venues and floors.

f. Select Contacts: Choose from the contacts added to the system to which the notifications will be sent.

g. Click Save.

3. Added notifications can be edited by clicking on shown in figure below.

Fig 11: Edit/Delete Alert notification

Types of Notifications available:

Notifications can be seen in the Notifications logs on the left-hand side of the Homepage.

The figure below shows,

Alert Notification: Total number of alert notifications generated.

Email: Number of notifications received via email.

SFTP: Number of SFTP notifications received.

Slack: Number of Slack notifications received.

SMS: Number of notifications received via SMS.

Graphs: Graphical representation of the statistics of notifications received.

Fig 12: Notifications Summary

Notification Logs

  1. Alert Notifications: This lists the details of all the alert notifications sent. It covers all the details like the Name of the device for which the alert is sent, the type of alert notification, name assigned to that notification, Last updated time, contact the notification is sent to and status of the notification.

Fig 13: Notifications Logs page

2. Email Audit Logs: This table lists the notifications sent via Email.

Fig 14: Email Notification page

3. Click on open for more details about individual notifications. Details will be shown in the figure below.

Fig 15: Details of email notifications

4. SFTP Notifications: Lists all the SFTP notifications.

Fig 16: SFTP Notifications page

5. Slack Notifications: Lists all the Slack notifications.

Fig 17: Slack Notifications page

6. SMS Notifications: Lists all the notifications sent via SMS.

Fig 18: SMS Notifications page

Case Study - Access in a box

Subsections of Kloud Sensors

Installation

The KloudSensor is very easy to install. There are three connectors:

  • WAN : Use to supply ethernet and, optionally, PoE power to the unit.
  • LAN : Optionally used to connect to other network devices.
  • Power : Optionally used to supply power via a USB connector.

If using a USB power supply, the unit will draw a maximum of 1 Amp.

The sensor can use either PoE or USB power. If you are unsure if the ethernet cable you are using will supply PoE power, plug it in first and see if the green light shows on the sensor. If there are no lights you can attach a USB cable.

Make sure not to connect both PoE and USB power sources to the device. You will damage the device if you do this. There may also be a slight smell of burning.

The sensor can also be used via wireless network. It will still need to be connected to wired network for a bootstrap configuration . So connect as above.

Configuration

All configuration of the unit is done in the Edge Device Management platform .

First plug in and power the device, next check that the device shows up in your Access Point list. Click on ‘Access Points’ and the screen below should be shown.

In order for you to manage the sensor, it will need to be allocated to your account. Please talk to your distributor/reseller if the sensor doesn’t appear in the list shown above.

If the sensor is in the list but showing as Bad status, make sure that it is able to access the network and obtain a DHCP address.

The next stage is to allocate this sensor to an existing or new network group.

The sensor can be used for either wired or wireless operation, different network group configurations are required for both modes of operation.

Prior to creating the network group, set up the account connection to the analytics platform.

Wired Connection.

To create a Network Group for wired operation, follow the following steps:

1 Click on Network Groups

  • Enter a name
  • Select the KS150 sensor in the AP Model drop down.
  • Select the appropriate country.
  • Select ‘Sensor/Monitor Mode’.
  • Click ‘save’

3 The Network Group will be properly configured for operation, we just need to assign the AP to it.

  • Select the Network Group you just created in the dropdown
  • Go to the Assigned APs tab and assign the sensor to this Network Group.

Then ‘Update the network configuration’ for the sensor.

Wireless Connection

The procedure for creating a Network Group for wireless operation is very similar, with just a few more steps.

To create a Network Group for wireless operation, follow the following steps:

  • First follow steps #1 and #2 above to create the group. and then edit the Network Group as follows:
  • Obtain a SSID with a WPA2 secret key. _ Set the following: _ Enter your SSID _ Enable the WLAN _ Set the Security Profile you created earlier. _ Finally go to the Sensor/Repeater Profile tab: _ Set the ‘master SSID’ to the WLAN you edited earlier. * Set the IP Address to an IP address that will not be used ‘upstream’ from the sensor. The sensor requires two IP addresses - since it has two interfaces. One to act as a client and one for its internal network. It obtains one via DHCP, however the other needs to be specified and needs to not clash with any upstream address. Since there will be no connection to the device only one IP is needed for the Netwok Group. If you are unsure what address will work for your situation, try using a ‘private’ IP address such as 192.168.20.10

Proceed with step #3 above for Wireless Operation. Once the sensor has had the configuration properly updated, the sensor can be disconnected from the network. When it is next powered on using USB power, it will connect to the SSID you configured and start sending sensor data.

Analytics Integration

There are a few steps needed to start seeing Kloudspot Sensor data in the Kloudspot Analytics platform.

The sensor will need to have an updated configuration in order to get this setting.

  • Enable the Kloudspot Receiver in the Analytics platform.
  • Add the Sensor to the Location Hierarchy.

Subsections of Kloud Access Point

Configuration

All Access Point configuration is done in the Edge Device Management platform

First plug in and power the AP, next check that it shows up in your Access Point list. Click on ‘Access Points’ and the screen below should be shown.

In order for you to manage the AP, it will need to be allocated to your account. Please talk to your distributor/reseller if the sensor doesn’t appear in the list shown above.

If the AP is in the list but showing Bad status, make sure that it is able to access the network and obtain a DHCP address.

The next stage is to allocate this AP to an existing or new network group.

Actions available from this screen are:

  1. Rename the AP.
  2. Add/set the location for an AP.
  3. Add or edit tags for the AP.
  4. Assign a network group to the AP.

Client and Session details API

Kloudspot API for Client and Session Data

All Kloudspot public data APIs are protected with OAuth Token-based authentication. The OAuth token can be generated using the login API with app id and secret. A token is valid for 10 minutes for multiple API calls. For the Kloudspot management and monitoring system (KloudManage), the app id and secret can be found in the SETTINGS → Third-Party Integration tab → Kloudspot API Key Section.

1. Login API

A. Example Request

    curl -X POST --header 'Content-Type: application/json' --header 'Accept: text/plain' --header 'X-CSRF-TOKEN: ' -d '{ 
    "id": "aac1fa9ec05d47f8aab8828bae22cbc6", 
    "secretKey": "eb1ca9c96dc9461c" 
    }' 'https://stage.kloudspot.com/epsilon/api/public/v1/auth/login'

B. Success Response

    eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJwcmVta3VtYXIuc0B0YXRhY29tbXVuaWNhdGlvbnMuY29tIiwiYXV0aCI6IlJPTEVfQUNDT1VOVF9BRE1JTixST0xFX0FDQ09VTlQsUk9MRV9jZjQ5NmMzNGMzNmI0ZTI2YjM3OTRmOTdhODc2ODgzNCIsImV4cCI6MTY1Mjk0OTU1M30.kRRD5FBMGbHKAcIYjKFm6EGylC24bRTvfnL5CH6s_TAGe9_jXlf2T5E6sPj1ooXiJz1wyJAzFh-garWK1Q2sKQ

C. Invalid Response

You do not have access to the requested resource.

2. Client and Session API

A. Example Request

    curl --location --request GET 'https://stage.kloudspot.com/epsilon/api/public/v1/report/ap/clientSession/1688083200000/518400000' \
    --header 'Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJiYW5nYWxvcmVsYWJAa3Nwb3QuY29tIiwiYXV0aCI6IlJPTEVfY2U5M2YwMDBhOGQyNGRiMTgzN2EwOTJlMWQ4NWNmZWYsUk9MRV9BQ0NPVU5UX0FETUlOLFJPTEVfQUNDT1VOVCIsImV4cCI6MTY4ODY1MzY1Nn0.QKDnWomUat5GDEQIC_o5BYk7iLZWrdz420p2VUXRerkOAZOhtRRh0ow9xjZSTQaB0ndqf9MrL54Ko0oIVYMWag' \
    --header 'Cookie: JSESSIONID=2EBDE01CD4B16D5EFAE36A90BDF92D69' 

B. Request Constraints

URL Pattern:

https://stage.kloudspot.com/epsilon/api/public/v1/report/ap/clientSession/{starttime}/{duration}

  • Start time – This is the start time in milliseconds since the epoch. It should not be less than 90 days ago.
  • Duration – This is the duration for which data is needed to be fetched. The maximum allowed duration is 7 days. It must be in milliseconds.

Above defined constraints must be followed to obtain the data. Sample Success Response

C. Response

Successful Response

    {
     "error": false,
        "errorCode": null,
        "errorMessage": null,
        "data": [
            {
                "First connection date": "2023-06-30T05:31:42 IST",
                "Last connection date": "2023-07-01T05:26:42 IST",
                "Venue ID": "9db00a31f5df4360bbbc8a351e6feb11",
                "Subscription to receive campaigns": "true",
                "Visitor ID": "7e:85:2d:4d:f8:0b",
                "Birth Date" : "2001-08-28",
                "Connection Source": "Form",
                "Number of visits": "1",
                "Venue Name": "IQ Gamma Lab",
                "MAC Address": "7e:85:2d:4d:f8:0b"
            },
            {
                "First connection date": "2023-06-30T17:06:42 IST",
                "Last connection date": "2023-06-30T23:31:42 IST",
                "Venue ID": "9db00a31f5df4360bbbc8a351e6feb11",
                "Subscription to receive campaigns": "false",
                "Visitor ID": "dc:fb:48:70:5b:ac",
                "Connection Source": "Facebook",
                "Number of visits": "2",
                "Venue Name": "IQ Gamma Lab",
                "MAC Address": "dc:fb:48:70:5b:ac"
            },
            {
                "First connection date": "2023-07-03T12:13:07 IST",
                "Last connection date": "2023-07-03T12:49:40 IST",
                "Venue ID": "5a3a9f4d10f04b00086d4d8b",
                "Subscription to receive campaigns": "false",
                "Visitor ID": "ec:63:d7:04:4c:af",
                "Connection Source": "Form",
                "Venue Name": "RTP Lab",
                "Number of visits": "1",
                "MAC Address": "ec:63:d7:04:4c:af"
            }
     ]
    }

The API will include below fields in the response.

Visitor ID: This will be the MAC address of the user. As mac acts as key to uniquely identify among users.

Venue ID: The ID for the Venue

Venue Name: Name of the Venue

Birthdate: The birthdate of the user is entered in the splash page. If the birthdate form field is opted in, then this field will be included in the response.

First connection date: First seen of the user when he/she connected to the SSID.

Last connection date: Last seen of the user when he/she disconnected from the SSID.

MAC Address: The MAC Address of the user’s device.

Number of visits: Total number of sessions for that user.

Connection Source (Form or Social Network): If the user used social login, then the name of the social login platform will be included. Otherwise, the source will be form login.

Subscription to receive campaigns: If the user checked the checkbox on the splash page, then the value will be true. Otherwise, the value will be false.

Network Groups

Network groups define most of the functionality for Access Points (or access point like devices such as Sensors).

To create or modify network groups, click on the ‘Network Groups’ menu item and then click the save button.

When you click ‘Create New’, you will get a definitions screen where you need to enter the following:

  • A name for the group.
  • The Access Point model. All APs in the same group must be the same model.
  • The country of operation. Different countries have different rules for radio operation.
  • The mode of operation. The available choices will will depend on the

The network Groups configuration screen consists of the following tabbed sections:

Table of content:

  • Services : Configuration of the available management services.
  • Kloudshield Profile : Configuration of DNS based content filtering.
  • Ad Profile : Configuration of Guest Portal and advertising.
  • Network Profile : Networking configuration. Each WlAN can make use of a different network configuration.
  • Security Profile : WLAN security profiles.
  • Radio Profile : Access Point Radio configuration (e.g power level)
  • WLAN Profile : WLAN configurations. The Access Points support multiple SSIDs on multiple radios.
  • Assigned APs : Access Point assignments for this Network Group.

Subsections of Network Groups

Management Services

The Services menu enables control over the network control and monitoring features of the access point.

Basic Services:

  • DNS Cache: Enable this to store the DNS resolution for domain names within the AP DNS Server. Enabling this helps improving the performance of the AP
  • AP LED: Enable this to switch ON the LED light on the access point. Disabling this switches OFF the LED light on the access point
  • Remote Syslog: forward syslogs to a remote server.

Analytics Services:

  • User Bandwidth: Helps to view the overall (inward & outward network traffic) bandwidth consumption of all the users of the access point. This service cannot be disabled.
  • Application Visibility: Enable this to view the list of applications/domains visited by the users of the access point
  • System Statistics: Enable this to view system statistics like CPU utilization, memory consumption, ping statistics etc. for the access point

Probing Services:

  • Guest Probing: Enable this to capture information from guests who are in the vicinity of the access point but not connected to it
  • Rogue AP Probing: Enable this to identify & capture information about Rogue Access Points in the vicinity of the access point

Situational Awareness/Proximity Awareness:

  • Guest Proximity/Awareness: This works in conjunction with Kloudspot advanced Analytics platform. Enable this and set the Update Frequency to send data of all the guests to the Analytics platform
  • AP Calibration Mode: Enable this to combine access point data along with GPS coordinates and calibrate the system algorithm to provide better trilateration location/position

Management Services:

  • Remote Support: This is always enabled and is used to remotely troubleshoot the access point from the cloud controller
  • Image/Firmware Upgrade: Enable this for any latest image to be automatically installed from the cloud when the access point reboots

Self Organized Network:

  • Pro-active AP Monitoring: Enable this to automatically monitor the access point from the cloud controller. Alert notifications are sent under any of the following conditions:
    • Reachability: This is enabled and the cloud controller is not able to reach the access point for a duration of Time as defined in the Reachability Threshold
    • Ping Latency: This is enabled and the average of ping latencies of 10 consecutive pings for a defined Domain is more than the duration set in the Latency Threshold
  • Reboot Schedule: Enable this to reboot the access point at specified frequencies
  • Lost Connectivity Action: Enable this for the access point to automatically reboot when it loses connectivity to the cloud controller for a duration greater than the specified duration
  • Allow SSH on WAN: Enable this to allow remote SSH connectivity on WAN

Persistence Services:

  • Guest Probe Data: Enable this to persist the data of guest beacon probes. Settings are available to specify the condition under which the guest probe data shall be persisted.
    • Filter Random MAC Addresses: Enable this to discard random MAC addresses from being persisted
    • Minimum Beacons Threshold: Set the minimum number of beacons to be received by an access point from a guest for its data to be persisted
    • Minimum Power Threshold: Set the minimum power threshold value to be received from the user device by the access point below which the data of a guest beacon probes are not persisted
    • Maximum Power Threshold: Set the maximum power threshold value to be received from the user device by the access point beyond which the data of a guest beacon probes are not persisted
  • Applications/User Data: Enable this to persist users data & the list of domains visited by the users
  • Rogue AP Data: Enable this to persist the data of Rogue Access Points

Kloudshield

KloudShield is a content filtering service to provide fast, secure browsing experience.

KloudShield features include:

  • Controlling guest activity on search engines and social media websites
  • Blocking content based on categories (More than 8.5 million domains categorized in 59 categories and growing)
  • Blacklisting and Whitelisting of Domains
  • Supports day/time-based content blocking, Blacklisting and Whitelisting

Some of the benefits provided by Kloudshield are:

  • Automatically blocking malware and ad servers at the router level thereby protecting all the devices in one go.
  • Reduce data consumption by blocking unwanted content
  • Provide better experience as unwanted content is blocked
  • Multiple content categories can be blocked with a single click in real-time
  • Keeps up-to date with latest/greatest content & network threats

Advertising

This tab allows advertising based monetization offerings to be configured for a network interface.

To set the Ad Profile configurations, follow the below steps:

  1. Click Network Groups
  2. Click Ad Profile menu
  3. Click + icon
  4. Click Edit icon
  5. Enter the name for the Ad Profile
  6. Select the desired Ad Profile configurations

3 distinct advertisement mechanisms are supported Kloudspot Access Points.

  • Overlay Ads: Select this option to overlay advertisements on web pages. Kloudspot supports different types of advertisements like logos, sliders, tickers, modal with Video etc.
  • Ads Replacement: Select this option to replace an exchange ad with another ad of same size.
  • Pause & Play Ads: Select this option to block internet on a device after a predefined interval of Time and redirect the user to an Ad page. User must watch the ads before regaining internet access.

Overlay Ads and Ad Replacement are supported for HTTP connections only. Pause & Play Ads will work on HTTP and HTTPS.

Network Profile

The Network Profile tab provides configuration for the different interfaces of the Access Point. Some of the Network Profile configurations are automatically set based on the Access Point hardware and cannot be changed while others can be configured as desired.

Below is a brief description of various configurations under the Network Profile menu.

  • Name: This is a unique name for the network interface. This is automatically set, disabled and cannot be modified.

  • IP Addr: This is the IP address to be assigned for the network interface. This is pre-populated but can be changed as desired.

  • Netmask: This is the network mask of the network interface. This is defaulted to 255.255.255.0 but can be changed as desired.

  • Gateway: This is the Default Gateway for the network interace. This is defaulted to the IP address of the network interface but can be changed as desired.

  • DCHP Lease: This is the period of Time for which the DHCP Server leases IP addresses to devices. This is defaulted to 12 hours but can be changed to any value available in the dropdown.

  • DHCP Start: This is the offset from the network (IP) address of the underlying interface and detrermines the start range of the IP addresses for the devices. This is defaulted to 100 but can be changed as desired. For example, DHCP Start = 100 will mean that for IP address 192.168.1.x, the starting IP address will be 192.168.1.100

  • DHCP End: This indicates the last IP address that can be assigned to a device connected to this network interface. It also helps to determine the size of the IP address pool. This is defaulted to 250 but can be changed as desired. For example, DHCP End = 250 will mean that for IP address 192.168.1.x, the last IP address will be 192.168.1.250

  • Static Hosts: Devices whose IP addresses should not change (for example network printers) can be assigned static IP addresses so that their IP address is not reset. To assign static IP address for a device, click on + Add New link and then enter the Host Name, MAC address and the desired static IP address.

  • Kloudshield: To enable Kloudshield content filtering service on the network interface, select the Kloudshield check box and choose the desired Kloushield Profile from the dropdown.

  • Guest Access: Enabling Guest Access check box allows to configure the desired settings for this network interface with respect to the advertisements to run and the guest portal behavior.

  • KloudAd: To render advertisements on devices connected to this network interface, select the KloudAd check box and then select the desired advertisment profile from the AdProfile dropdown

  • Guest Login: To render guest captive portal on devices connected to this network interface, select the Guest Login check box. Kloudspot supports both internal & external guest captive portals.

  • To set the internal guest captive portal, follow the below steps:

    • Ensure that the External Guest Portal check box is Not selected
    • Select the desired Guest Template from the Guest Template dropdown
    • Set the desired Expiry Time from the Expiry Time dropdown ( Expiry Time is the Time after which the device will be logged-off automatically. Options for Expiry Time range from from 30 minutes to 7 days. Never option will not logoff the device automatically, but can be invalidated manually from the user list)
    • Max BW (MB): Set the Max BW in Mega Bytes after which the device will be logged off automatically ( Max BW (MB) is the maximum allowed badnwidth in Mega Bytes that a device can utilise before getting logged off automatically. For unlimited bandwidth, set it to 0).
  • Note that when both the Expiry Time and the Max BW(MB) are set, the device gets logged off automatically after any one those 2 conditions are met.

  • Select the Block Access check box if the device needs to be blocked for the rest of the day(till midnight) once the device has exceeded the set Expiry Time or the Maximum Bandwidth allowed. (If the Block Access check box is not selected, then the device is permitted to again access the network after being automatically logged off).

  • To set the external guest captive portal, follow the below steps:

    • Select the External Guest Portal check box
    • Specify the URL of the external guest page in the Portal URL field
    • Specify the comma separated list of IP addresses to be white walled
    • Set the desired Expiry Time from the Expiry Time dropdown ( Expiry Time is the Time after which the device will be logged-off automatically. Options for Expiry Time range from from 30 minutes to 7 days. Never option will not logoff the device automatically, but can be invalidated manually from the user list)
    • Max BW (MB): Set the Max BW in Mega Bytes after which the device will be logged off automatically ( Max BW (MB) is the maximum allowed badnwidth in Mega Bytes that a device can utilise before getting logged off automatically. For unlimited bandwidth, set it to 0).
  • Note that when both the Expiry Time and the Max BW(MB) are set, the device gets logged off automatically after any one those 2 conditions are met.

  • Parental Controls: Selecting the Parental Controls check box provides a set of options that allow/deny network access to devices, block traffic to & from specified IP addresses and block specified ports.

  • White List: Any device that needs to access the network without going through any guest portal restrictions must have its MAC addresses specified in this field. Multiple MAC addresses can be entered by using commas.

  • Black List: Any device that needs to be denied access to the network must have its MAC addresses specified in this field. Multiple MAC addresses can be entered by using commas.

  • Block IP: If traffic to any IP addresses are to be blocked, specify those IP addresses in this field. Multiple IP addresses can be entered by using commas.

  • Block Ports: If outgoing traffic through any ports are to be blocked, specify those ports in this field. Multiple ports can be entered by using commas.

  • QOS: Select this check box to specify upload and download data speeds in Kilobits per Second.

Security Profile

The Security Profile tab defines Security Profiles that can be used by SSID’s on the Access Point.

  • Name: This is a unique name given to a security policy. This name will be listed in the Access Control dropdown of the WLAN Profile menu to associate with the SSID.
  • Type: Kloudspot currently supports 2 types of security policies - Open & WPA2 Personal
  • Open: A SSID with this provide is open and devices connecting to the SSID will not be prompted for a password.
  • WPA2 Personal: A SSID with this profile acts as a secure network and connecting devices will be prompted for the password.

Radio Profile

The Radio Profile tab provides a mechanism to configure the Radio attributes of the Access Point. The number of Radio Profiles for an Access Point depends on the number of Radios that an Access Point has.

  • Name: A unique name for a radio of an Access Point. This is pre-populated and cannot be changed.

  • Type: Specifies the type of the radio. This is pre-populated and cannot be changed.

  • Mode: If a radio of an Access Point is of type 11a, Mode can be either AC or N provided they are supported by the underlying hardware. If a radio of an Access Point is of type b/g/n, then the radio mode is internally defaulted to N and the same is not displayed on the UI.

  • Channel: Indicates the channel on which the Access Point will broadcast SSID’s. Select the desired Channel from the dropdown.

  • HT Mode: Indicates the width of the channel. Higher the width of the channel, greater is the throughput but the downsize is the higher probability of conflicts with adjacent channels.

  • Power: Indicates the power of the Radio. Greater the power, higher is the range of the WiFi(SSID) signal.

WLAN Profile

WLAN Profile menu provides configurations for the SSIDs of the Access Point. Based on the number of SSIDs that an access point supports, WLAN Profile menu automatically creates that many WLAN Profiles with some default settings for each of them.

  • SSID: The name of the SSID to be broadcasted.
  • Radio Type: The Radio on which the SSID is to be broadcasted.
  • Visible: Select Visible check box if the SSID is to be visible to the devices on normal scanning.
  • Enabled: Select Enabled checkbox to enable the SSID. If this check box is not selected, then the SSID is not available.
  • Isolate: Select this check box to isolate the traffic between connected devices to the SSID/interface and to ensure that the devices cannot talk to each other.
  • Max Clients: Indicates the maximum number of devices that can concurrently connections to the SSID.
  • Access Control: Indicates the Security Policy to be applied to the SSID/interface. Select the desired policy from the dropdown. Note that the Security Policy is created using the Security Profile menu.
  • Network Profile: Indicates the Network Policy to be applied to the SSID/interface. Select the desired policy from the dropdown. Note that the Network Policy is created using the Network Profile menu.
  • MAC Filter Action: Provides options to restrict access to the SSID(network) based on MAC Addresses. Available options are Allow, Deny and Disable. By default it is set to Disable.
  • If MAC Filter Action is set to Disable , then all MAC addresses are allowed access to the network through this SSID.
  • If MAC Filter Action is set to Allow , then ONLY those devices whose MAC address is entered in the Allow MAC List will be able to access the network through this SSID . Note that if no MAC address is entered in the Allow MAC List , then NO device can connect to the network through this SSID.
  • If MAC Filter Action is set to Deny , then ALL devices whose MAC address is entered in the Deny MAC List will NOT be able to access the network through this SSID . Note that if no MAC address is entered in the Allow MAC List , then ALL devices can connect to the network through this SSID.

Assigning APs

Assigned APs menu provides options to assign or un-assign Access Points to available Network Groups. It also provides a mechanism to push all the network configurations and the Services menu configurations from the cloud to the Access Point.

Any Access Point that has been already assigned to a Network Group will be displayed under this menu.

  • To un-assign an access point from a Network Group, click on the X icon of the corresponding access point.
  • The Access Points that are not assigned to any Network Group are listed under the Assign this Network Group to: dropdown. To assign a non assigned Access Point to the selected Network Group, select the Access Point from the dropdown and choose the Mode. (Mode can be Master, Repeater or Sensor).

After assigning Access Points to the Network Group, the configurations under the Services menu or of the entire Network Group can be synchronized to all the Access Points by clicking on the Sync All APs dropdown and selecting Services or Network respectively.

  • To update Network Group or Services menu configuration changes to specific Access Points, click on the corresponding icons of the Access Point.

KloudOS Firewall Rules

The following firewall configurations are needed to allow Kloudspot hardware devices to function.

KloudDisplay

Purpose Destination Address Destination Port Protocol Service Direction
Device Management call home _.kloudspot.com 80,443 TCP HTTP/HTTPS Outbound
Ping to determine connectivity with the Internet (Google DNS) 8.8.8.8 ICMP Outbound
Network Time _.ntp.org 123 UDP NNTP Outbound

Access Points and KloudSensors

Purpose Destination Address Destination Port Protocol Service Direction
Device Management call home _.kloudspot.com 80,443 TCP HTTP/HTTPS Outbound
Ping to determine connectivity with the Internet (Google DNS) 8.8.8.8 ICMP Outbound
Network Time Synchronization _.ntp.org 123 UDP NNTP Outbound
Send data to Analytics *.kloudspot.com (or equiv) 48082/48083 TCP HTTPS Outbound