Activating and Editing the BLE Scan Plugin

Activate the plugin to manage Bluetooth Low Energy (BLE) beacons. After activation, all scan data is securely routed to the configured endpoints.

To establish a connection to a partner infrastructure, the administrator must perform the following steps.

  1. From the main menu, select Admin.
  2. Click Plugins.
    The Plugins page is displayed. You can search for a plugin by its name in the Search plugins field to locate it.
  3. Click the Available Plugins tab.
    You will see tiles with plugin names on them. Locate the BLE Scan tile.

    Selecting the BLE Scan Plugin

  4. In the BLE Scan tile, click + Configure to activate the plugin.
    The BLE Scan Configuration sidebar is displayed.

    Activating the BLE Scan Plugin to use HTTP Protocol

  5. Select either the HTTP or MQTT protocol option.
    If the HTTP option is selected, configure the following parameters.
    1. Aggregation Interval: Allows you to set the time interval between the two packets.
    2. Key: Enter the Key.

      The RUCKUS IoT Controller posts the beacon messages using the Key provided. The Vendor application is responsible for authenticating the Keys.

    3. API URL: Enter the API URL.

      The RUCKUS IoT Controller connects to the vendor/connector URL to send the beacon messages. The URL can be a DNS-resolvable, FQDN-based address.

      Note: The plugin supports HTTP and HTTPS modes.

    4. Port: Enter the Port number.

      This is the port number on which the vendor/connector web server is running.

    5. API Endpoint: Enter the API Endpoint.

      This is the API route where the BLE beacon vendor cloud services receive the beacon payload.

    6. UUID Filter: Enter the UUID Filter.
      The filter allows only the BLE ADV packets with the specified UUID to be passed on to the vendor application.
    7. Enable heartbeat: Click the toggle to enable periodic heartbeat messages, which is useful for monitoring connection health. This option is disabled by default.
    If the MQTT option is selected, configure the following parameters.

    Activating the BLE Scan Plugin to use MQTT Protocol

    Activating and Editing BLE Scan Plugin
    1. Aggregation Interval: Allows you to set the time interval between the two packets.
    2. MQTT Broker IP: Enter the IP address or hostname of the broker.
      This is a mandatory field.
    3. MQTT Broker Port: Enter the port number.
      This is a mandatory field.
    4. MQTT Publish Topic: Topic where messages from this device/system will be published.
      This is a mandatory field.
    5. For MQTT Username: Enter the username for authenticating with the MQTT Broker.
    6. For MQTT Password: Enter the password for authenticating with the MQTT Broker.
      Note: By default the password is hidden, click Show to view the password.
    7. For UUID Filter: Enter the required UUID filter.
      The filter allows only the BLE ADV packets with the specified UUID to be passed on to the vendor application.
    8. For Enable heartbeat: Click the toggle to enable periodic heartbeat messages, which is useful for monitoring connection health. This option is disabled by default.
  6. Click Activate to save the changes.
    After saving the changes, the BLE Scan plugin is added to the Active Plugins tab and is removed from the Available Plugins tab. Under the Active Plugins tab, locate the BLE Scan tile. To modify the configurations, click Configure. To delete the plugin, click Delete.
  7. (Optional) Click Configure to edit the existing configuration.
    The BLE Scan Configuration page is displayed. You can view the connection status of the plugin in the Status field. Make the required changes and click Update.
  8. (Optional) Click Delete to delete the plugin.

    Deleting the BLE Scan Plugin

    Deleting the BLE Scan Plugin
Parent topic: Activating and Editing the Plugins