Editing the nbe.toml File

Updated October 07, 2022 14:30

Debbie Redmond

A backup configuration file is installed on the user terminal when the Nymi Bluetooth Endpoint is installed or updated. This file, nbe.default.toml, contains the default values that control BLE tap behavior with the Nymi Band and BLE adapter. Use the values in the nbe.default.toml file as a template for the nbe.toml file. These files are located in C:\Nymi\Bluetooth_Endpoint\ on Windows, and /usr/bin/nbe.toml on HP Thin Pro.

Note: Nymi Bluetooth Endpoint will only recognize RSSI values in the nbe.toml file. Retain a backup of a useful configuration by copying the nbe.toml file and renaming it.

Table 1. Default configuration settings for Nymi Lock Control and BLE tap intent
nbe.toml Entry	Default Value	Description
agent_url	"ws://127.0.0.1:9120/socket/websocket" (do not change)	Identifies the location of the agent URL. The default value shown in this table is generated if the agent is installed locally. If the agent URL is installed centrally (via remote installation), the hostname of the URL will be different. The agent_url must be present when using an nbe.toml file.
rssi_window_tap	10	This determines the duration the Nymi Band must be within tap-distance of the BLE radio antenna to complete a tap. A larger value increases the duration required to perform and decrease the sensitivity.
rssi_window_long	50	This determines the frequency that Nymi Bluetooth Endpoint checks the distance between the BLE radio antenna and the Nymi Band. Nymi Bluetooth Endpoint tracks trends in these changes to trigger a Nymi Lock Control action, such as keep unlocked when present, lock when away, or unlock when present.
rssi_tap_threshold	0 (must be 0 or negative)	This determines the range at which a tap event will occur. A smaller negative value means a closer distance to the BLE antenna. BLE tap is disabled by default (value = 0). Enter a non-zero, negative number to enable BLE tap. Nymi recommends an RSSI value of -42. If the Nymi Band maintains a minimum distance specified by rssi_tap_threshold, for a duration rssi_window_tap, a BLE tap is performed.
rssi_cutoff_close	-70 (must be 0 or negative)	This determines the outer range of the close distance-threshold (excluding tap distance) for Nymi Lock Control. Enter 0 to bypass the proximity functionality of Nymi Lock Control. If the Nymi Band maintains a close distance to the BLE radio antenna and the RSSI values measured are within the rssi_cutoff_close value, Nymi Lock Control keeps the user terminal unlocked. If the Nymi Band moves away from the BLE radio antenna, and the RSSI values measured are on a decreasing trend and goes from the rssi_cutoff_close value to the rssi_cutoff_far value, Nymi Lock Control locks the user terminal.
rssi_cutoff_far	-75 (must be negative)	This determines the outer range of the far distance-threshold (excluding tap distance) for Nymi Lock Control. If the Nymi Band moves towards the BLE radio antenna, and the RSSI values measured are on an increasing trend and goes from the rssi_cutoff_far value to the rssi_cutoff_close value, Nymi Lock Control unlocks the user terminal.

Make a copy of the C:\Nymi\Bluetooth_Endpoint\nbe.default.toml file (On HP Thin Pro, /usr/bin/nbe.default.toml), and name the file nbe.toml.
Edit the nbe.toml file with a text editor.
Edit the RSSI values in the file. Refer to the descriptions in the table above.
Save the nbe.toml file.
Restart the Nymi Bluetooth Endpoint.
On Windows:
1. Press the Windows key on the keyboard, or click the start button on the toolbar. Enter "Services" in the search bar. The Services application window appears.
2. Search for Nymi Bluetooth Endpoint in the Services application.
3. Right-click Nymi Bluetooth Endpoint and restart it.
On HP Thin Pro:
1. Stop the Nymi Bluetooth Endpoint service by typing killall -9 nbed.
2. Start the Nymi Bluetooth Endpoint by typing /usr/bin/nbedstart.

Once restarted, the Nymi Bluetooth Endpoint application will be updated with the edits made in the nbe.toml file. Updated BLE tap intent and Nymi Lock Control settings will be implemented on the user terminal. If the nbe.toml file is not present, Nymi Bluetooth Endpoint behaves under default settings.

Editing the nbe.toml File

Articles in this section

Get in touch

Comments