Difference between revisions of "Template:Networking rutos manual bluetooth"

From Teltonika Networks Wiki
(Created page with "{{Template:Networking_rutos_manual_fw_disclosure | fw_version = {{{series}}}_R_00.02.05 | series = {{{series}}} }} __TOC__ ==Summary== The Bluetooth page contains informa...")
 
(9 intermediate revisions by 4 users not shown)
Line 1: Line 1:
{{Template:Networking_rutos_manual_fw_disclosure
+
{{Template: Networking_rutos_manual_fw_disclosure
| fw_version = {{{series}}}_R_00.02.05
+
| fw_version = {{{series}}}_R_00.02.06.1
 
| series    = {{{series}}}
 
| series    = {{{series}}}
 
}}
 
}}
Line 6: Line 6:
 
==Summary==
 
==Summary==
  
The Bluetooth page contains information and settings related to the connected BT accessories. This chapter is an overview of the Bluetooth window in {{{name}}} routers.  
+
The Bluetooth page contains information and settings related to the connected BT accessories. This chapter is an overview of the Bluetooth window in {{{name}}} devices working with confirmed accessories and sensors, performance and displayed data may differ using other Bluetooth devices.  
  
 
{{Template:Networking_rutos_manual_basic_advanced_webui_disclaimer
 
{{Template:Networking_rutos_manual_basic_advanced_webui_disclaimer
Line 12: Line 12:
 
}}
 
}}
  
===General===
+
==General Settings==
 +
 
 +
The <b>General Settings</b> section is used to turn {{{name}}}'s Bluetooth device on or off.
 +
 
 +
[[File:Networking_rutos_manual_bluetooth_general_settings.png|border|class=tlt-border]]
 +
 
 +
Before you scan for and pair devices, you must first turn Bluetooth on (it is disabled by default):
 +
 
 +
[[File:Networking_rutos_manual_bluetooth_general_settings_on.png|border|class=tlt-border]]
 +
 
 +
==Available Devices==
 +
 
 +
The <b>Available Devices</b> section displays a list of Bluetooth devices that are within range of the {{{name}}}. In order to see available devices, please make sure that Bluetooth is enabled and click the 'Scan' button.
 +
 
 +
[[File:Networking_rutos_manual_bluetooth_available_devices_scan_button.png|border|class=tlt-border]]
 +
 
 +
In order to pair {{{name}}} with another Bluetooth device, place a checkmark under the 'Pair' column next to that device and click 'Pair'.
 +
 
 +
[[File:Networking_rutos_manual_bluetooth_available_devices_pair_button.png|border|class=tlt-border]]
 +
 
 +
If the pairing was successful, you should see the Bluetooth device appear under [[#Paired_Devices|Paired Devices]].
 +
 
 +
==Paired Devices==
 +
 
 +
The <b>Paired Devices</b> section displays a list of Bluetooth that have been paired with this {{{name}}}.
 +
 
 +
To view the information of a paired Bluetooth device, click the 'Details' button.
 +
 
 +
[[File:Networking_rutos_manual_bluetooth_paired_devices_details_button_2.png|border|class=tlt-border]]
 +
 
 +
The Data page for a device may look similar to this, but the contents depend on the type of the Bluetooth device:
 +
 
 +
[[File:Networking_rutos_manual_bluetooth_paired_devices_device_data.png|border|class=tlt-border]]
 +
----
 +
If you wish to unpair a Bluetooth device, place a checkmark under the 'Unpair' column next to that device and click 'Unpair'. If you have more than one device you should press 'Unpair all' option it works without checking checkmarks.
 +
 
 +
[[File:Networking_rutos_manual_bluetooth_paired_devices_unpair_button_2.png|border|class=tlt-border]]
 +
 
 +
==ubus commands==
 +
 
 +
This section contains instructions on how to use <b>ubus commands</b> in order scan and pair with Bluetooth devices.
 +
 
 +
The <i>ubus</i> [[Command Line Interfaces|command line]] tool provides the possibility to interact with the <i>ubusd</i> server (with all currently registered services). It uses the JSON format for calling procedures with parameters and returning responses.
 +
 
 +
Before you start using ubus commands to control Bluetooth, make sure that Bluetooth is turned on in the [[#General_Settings|General Settings]] section.
 +
----
 +
You must first initialize <i>blesemd</i>. You can do that by executing <b><i>blesemd -D</i></b> command. The output should look similar to this:
 +
 
 +
...
 +
root@Teltonika-{{{name}}}:~# <b>blesemd -D</b>
 +
Initializing blesemd...
 +
Warning: debug messages will be shown!
 +
Preparing bluetooth interface...
 +
Reading config...
 +
Devices loaded: 0
 +
Creating database...
 +
modbus_data table already exists
 +
SENT_ID_TABLE already exists
 +
Create DB done
 +
Initializing uloop...
 +
Connecting to ubus...
 +
Initializing BLE device...
 +
Initializing BLE ubus interface...
 +
Adding ubus object...
 +
...
 
----
 
----
Once you enable the functionality, press Scan button to see all visible nearby Bluetooth devices. To pair with desired device from the list, press Pair button. Then it should appear in '''Paired Devices''' list where you can manage them. Below is an example of '''Bluetooth''' page.
+
Run <b><i>scan.start</b></i> to start Bluetooth scan:
[[File:Networking_rutx_manual_bluetooh_overview_v2.png]]
+
 
 +
...
 +
ubus call blesem <b>scan.start</b>
 +
...
 +
 
 +
To see scan results, use command <b><i>scan.result</b></i>:
 +
 
 +
...
 +
ubus call blesem <b>scan.result</b>
 +
...
 +
----
 +
The scan process takes about 30 seconds. If you see <b><i>"scanning": 1</b></i> in the output it means that scanning is still in progress. Once the scanning has finished, the <i>scan.result</i> output should look similar to this:
 +
 
 +
...
 +
{
 +
      <b>"scanning": 0,</b>
 +
      "devices": [
 +
              {
 +
                      "name": "RT_T",
 +
                      "rssi": -72,
 +
                      "address": "FF:CB:FF:6F:23:FB"
 +
              }
 +
      ]
 +
}
 +
...
 +
 
 +
The list of device parameters will always contain"rssi" and "address", while the existence of "name" will depend on whether the paired Bluetooth supports it or not.
 +
 
 +
...
 +
{
 +
      "scanning": 0,
 +
      "devices": [
 +
              { 
 +
                      "rssi": -42,
 +
                      "address": "2F:2A:0A:0A:7A:AA"
 +
              },
 +
              {
 +
                      "name": "RT_T",
 +
                      "rssi": -77,  
 +
                      "address": "CF:0A:52:5E:35:D7"
 +
              }
 +
      ]
 +
}
 +
...
 +
----
 +
In order to pair devices use the <b><i>pair</b></i> command and specify the device's MAC address:
 +
 
 +
...
 +
ubus call blesem <b>pair</b> '{<b>"address":"FF:CC:FF:6A:23:CB"</b>}'
 +
...
 +
 
 +
If the pairing process was successful you should see an output similar to this:
 +
 
 +
...
 +
{
 +
      "success": "device successfully paired"
 +
}
 +
...
 +
---
 +
To get the statistics from paired devices, use the <b><i>stat</b></i> command and specify the device's MAC address:
 +
 
 +
...
 +
ubus call blesem <b>stat</b> '{<b>"address":"FF:CB:FA:6A:23:CB"</b>}'
 +
...
 +
 
 +
The output should look similar to this:
 +
 
 +
...
 +
{
 +
      "success": "successfully requested status",
 +
      "model": "3901",
 +
      "battery": 98,
 +
      "temperature": "20.34",
 +
      "humidity": 20,
 +
      "firmware": "23",
 +
.
 +
}
 +
...
  
By pressing '''Details''' button you can find more information about the item. Bellow is an example of '''Bluetooth Temperature & Humidity Sensor''' device data.[[File:Networking_rutx_manual_bluetooh_device_info_v2.png]]
 
  
 
[[Category:{{{name}}} Services section]]
 
[[Category:{{{name}}} Services section]]

Revision as of 13:20, 15 February 2021

Template:Networking rutos manual fw disclosure

Summary

The Bluetooth page contains information and settings related to the connected BT accessories. This chapter is an overview of the Bluetooth window in {{{name}}} devices working with confirmed accessories and sensors, performance and displayed data may differ using other Bluetooth devices.

If you're having trouble finding this page or some of the parameters described here on your device's WebUI, you should turn on "Advanced WebUI" mode. You can do that by clicking the "Advanced" button, located at the top of the WebUI.

Networking rutos manual webui basic advanced mode 75.gif

General Settings

The General Settings section is used to turn {{{name}}}'s Bluetooth device on or off.

Networking rutos manual bluetooth general settings.png

Before you scan for and pair devices, you must first turn Bluetooth on (it is disabled by default):

Networking rutos manual bluetooth general settings on.png

Available Devices

The Available Devices section displays a list of Bluetooth devices that are within range of the {{{name}}}. In order to see available devices, please make sure that Bluetooth is enabled and click the 'Scan' button.

Networking rutos manual bluetooth available devices scan button.png

In order to pair {{{name}}} with another Bluetooth device, place a checkmark under the 'Pair' column next to that device and click 'Pair'.

Networking rutos manual bluetooth available devices pair button.png

If the pairing was successful, you should see the Bluetooth device appear under Paired Devices.

Paired Devices

The Paired Devices section displays a list of Bluetooth that have been paired with this {{{name}}}.

To view the information of a paired Bluetooth device, click the 'Details' button.

Networking rutos manual bluetooth paired devices details button 2.png

The Data page for a device may look similar to this, but the contents depend on the type of the Bluetooth device:

Networking rutos manual bluetooth paired devices device data.png


If you wish to unpair a Bluetooth device, place a checkmark under the 'Unpair' column next to that device and click 'Unpair'. If you have more than one device you should press 'Unpair all' option it works without checking checkmarks.

Networking rutos manual bluetooth paired devices unpair button 2.png

ubus commands

This section contains instructions on how to use ubus commands in order scan and pair with Bluetooth devices.

The ubus command line tool provides the possibility to interact with the ubusd server (with all currently registered services). It uses the JSON format for calling procedures with parameters and returning responses.

Before you start using ubus commands to control Bluetooth, make sure that Bluetooth is turned on in the General Settings section.


You must first initialize blesemd. You can do that by executing blesemd -D command. The output should look similar to this:

...
root@Teltonika-{{{name}}}:~# blesemd -D
Initializing blesemd...
Warning: debug messages will be shown!
Preparing bluetooth interface...
Reading config...
Devices loaded: 0
Creating database...
modbus_data table already exists
SENT_ID_TABLE already exists
Create DB done
Initializing uloop...
Connecting to ubus...
Initializing BLE device...
Initializing BLE ubus interface...
Adding ubus object...
...

Run scan.start to start Bluetooth scan:

...
ubus call blesem scan.start
...

To see scan results, use command scan.result:

...
ubus call blesem scan.result
...

The scan process takes about 30 seconds. If you see "scanning": 1 in the output it means that scanning is still in progress. Once the scanning has finished, the scan.result output should look similar to this:

...
{ 
      "scanning": 0, 
      "devices": [ 
              { 
                      "name": "RT_T", 
                      "rssi": -72, 
                      "address": "FF:CB:FF:6F:23:FB" 
              } 
      ] 
}
...

The list of device parameters will always contain"rssi" and "address", while the existence of "name" will depend on whether the paired Bluetooth supports it or not.

...
{ 
      "scanning": 0, 
      "devices": [ 
              {  
                      "rssi": -42, 
                      "address": "2F:2A:0A:0A:7A:AA" 
              },
              { 
                      "name": "RT_T", 
                      "rssi": -77, 
                      "address": "CF:0A:52:5E:35:D7" 
              } 
      ] 
}
...

In order to pair devices use the pair command and specify the device's MAC address:

...
ubus call blesem pair '{"address":"FF:CC:FF:6A:23:CB"}'
...

If the pairing process was successful you should see an output similar to this:

...
{ 
      "success": "device successfully paired" 
}
...

--- To get the statistics from paired devices, use the stat command and specify the device's MAC address:

...
ubus call blesem stat '{"address":"FF:CB:FA:6A:23:CB"}'
...

The output should look similar to this:

...
{ 
      "success": "successfully requested status",
      "model": "3901",
      "battery": 98,
      "temperature": "20.34",
      "humidity": 20,
      "firmware": "23",
.
}
...


[[Category:{{{name}}} Services section]]