Template:Beacons List - Revision history

Robertas.balkunas: /* Beacon List Settings before FW ver. 3.27.07.Rev.00 */

2024-06-28T06:56:27Z

Beacon List Settings before FW ver. 3.27.07.Rev.00

← Older revision		Revision as of 09:56, 28 June 2024
Line 35:		Line 35:

	There is a possibility to detect the devices just by UUID or Namespace (see the 2 and 6 elements in the list).		There is a possibility to detect the devices just by UUID or Namespace (see the 2 and 6 elements in the list).
	Or by the Major/Minor for iBeacons and ~~Namespace~~ for Eddystone. (see the 3 and 7 elements in the list).<br/>		Or by the Major/Minor for iBeacons and Instance ID for Eddystone. (see the 3 and 7 elements in the list).<br/>
	There is also possible to select Beacons Detection as the Configured, in this case, the beacons will only be detected and send if they were added to the Beacons List.		There is also possible to select Beacons Detection as the Configured, in this case, the beacons will only be detected and send if they were added to the Beacons List.
	[[File:Beacon list UUID.jpg]]		[[File:Beacon list UUID.jpg]]

Arnas.Zeb at 08:03, 28 December 2023

2023-12-28T08:03:53Z

← Older revision		Revision as of 11:03, 28 December 2023
Line 1:		Line 1:
	==Beacon List Settings before FW ver. 3.27.07.Rev.00==		==Beacon List Settings before FW ver. 3.27.07.Rev.00==
	This page is dedicated for explanation of ~~Bluetooth~~ settings and also Beacon parameters in [[Teltonika_Configurator_versions#For_FMB_series\|'''FMB device configurator''']]. A more extensive guide can be found [[How to start with FMB devices and Beacons?\|'''How to start with FMB devices and Beacons?''']].<br>		This page is dedicated for explanation of Bluetooth® settings and also Beacon parameters in [[Teltonika_Configurator_versions#For_FMB_series\|'''FMB device configurator''']]. A more extensive guide can be found [[How to start with FMB devices and Beacons?\|'''How to start with FMB devices and Beacons?''']].<br>
	===Beacon Settings===		===Beacon Settings===

Line 9:		Line 9:

	'''Beacon Record'''<br>		'''Beacon Record'''<br>
	* '''''Eventual''''' – Record is sent after scan procedure is completed. This parameter depends from the [[{{{model\|FMB120}}} ~~Bluetooth~~ 4.0 settings\|'''~~Bluetooth~~ 4.0 Scan Settings'''.]]<br>		* '''''Eventual''''' – Record is sent after scan procedure is completed. This parameter depends from the [[{{{model\|FMB120}}} Bluetooth® 4.0 settings\|'''Bluetooth® 4.0 Scan Settings'''.]]<br>
	* '''''Periodic''''' – All beacons are sent to the server. (Record will be saved according to configured period).<br>		* '''''Periodic''''' – All beacons are sent to the server. (Record will be saved according to configured period).<br>

Line 40:		Line 40:

	==Beacon List Settings after FW ver. 3.27.07.Rev.00==		==Beacon List Settings after FW ver. 3.27.07.Rev.00==
	This page is dedicated for explanation of ~~Bluetooth~~ settings and also Beacon parameters in [[Teltonika_Configurator_versions#For_FMB_series\|'''FMB device configurator''']]. A more extensive guide can be found [[How to start with FMB devices and Beacons?\|'''How to start with FMB devices and Beacons?''']].		This page is dedicated for explanation of Bluetooth® settings and also Beacon parameters in [[Teltonika_Configurator_versions#For_FMB_series\|'''FMB device configurator''']]. A more extensive guide can be found [[How to start with FMB devices and Beacons?\|'''How to start with FMB devices and Beacons?''']].
	===Beacon Settings===		===Beacon Settings===
	[[File:NewBeaconSettings.png]]		[[File:NewBeaconSettings.png]]

Vytenis.kibildis: /* EYE Beacon Capturing Configuration */

2023-02-07T08:33:20Z

EYE Beacon Capturing Configuration

← Older revision		Revision as of 11:33, 7 February 2023
Line 107:		Line 107:
	[[File:Protocol_break_down.PNG\|center\|frameless\|1200x800px]]		[[File:Protocol_break_down.PNG\|center\|frameless\|1200x800px]]
	<br></br>		<br></br>
	~~'''~~Parsing additional data for iBeacon and EddyStone:~~'''~~		==== Parsing additional data for iBeacon and EddyStone: ====
	<br></br>		<br></br>

Vladimir.sirotenko: /* Beacon List */

2022-07-15T06:31:39Z

Beacon List

← Older revision		Revision as of 09:31, 15 July 2022
Line 37:		Line 37:
	Or by the Major/Minor for iBeacons and Namespace for Eddystone. (see the 3 and 7 elements in the list).<br/>		Or by the Major/Minor for iBeacons and Namespace for Eddystone. (see the 3 and 7 elements in the list).<br/>
	There is also possible to select Beacons Detection as the Configured, in this case, the beacons will only be detected and send if they were added to the Beacons List.		There is also possible to select Beacons Detection as the Configured, in this case, the beacons will only be detected and send if they were added to the Beacons List.
			[[File:Beacon list UUID.jpg]]

	==Beacon List Settings after FW ver. 3.27.07.Rev.00==		==Beacon List Settings after FW ver. 3.27.07.Rev.00==

Tomas.Gudonis: /* EYE Sensor Capturing Configuration */

2022-03-22T09:06:19Z

EYE Sensor Capturing Configuration

← Older revision		Revision as of 12:06, 22 March 2022
Line 150:		Line 150:
	==== EYE Sensor Capturing Configuration ====		==== EYE Sensor Capturing Configuration ====
	As an example on how to set Beacons Capturing Configuration parameters EYE Sensor can be used. Protocols used can be found [[EYE SENSOR / BTSMP1\|here]].		As an example on how to set Beacons Capturing Configuration parameters EYE Sensor can be used. Protocols used can be found [[EYE SENSOR / BTSMP1\|here]].
	[[File:Beacons Capturing Configuration set.png\|~~thumb~~\|1143x1143px\|Parameter values]]		[[File:Beacons Capturing Configuration set.png\|frameless\|1143x1143px\|Parameter values]]
	[[File:Beacon temp marked.png\|right\|frameless\|545x545px]]		[[File:Beacon temp marked.png\|right\|frameless\|545x545px]]
	Information shown after setting the parameters. Red rectangle indicates configured EYE sensors.		Information shown after setting the parameters. Red rectangle indicates configured EYE sensors.

Tomas.Gudonis: /* EYE Beacon Capturing Configuration */

2022-03-22T09:05:54Z

EYE Beacon Capturing Configuration

← Older revision		Revision as of 12:05, 22 March 2022
Line 86:		Line 86:
	<br></br>		<br></br>
	'''Capturing Flags and Battery voltage example:'''		'''Capturing Flags and Battery voltage example:'''
	[[File:Beacon_config_example_flags_and_battery.png\|~~thumb~~\|1143x1143px\|Parameter		[[File:Beacon_config_example_flags_and_battery.png\|frameless\|1143x1143px\|Parameter
	values]]		values]]
	<br></br>		<br></br>
	'''Capturing Flags example:'''		'''Capturing Flags example:'''
	[[File:IBeacon_EYE_beacon_additional_data_Flag.PNG\|~~thumb~~\|1143x1143px\|Parameter values]]		[[File:IBeacon_EYE_beacon_additional_data_Flag.PNG\|frameless\|1143x1143px\|Parameter values]]
	<br></br>		<br></br>
	'''Capturing Battery voltage example:'''		'''Capturing Battery voltage example:'''
	[[File:IBeacon_EYE_beacon_additional_data_Battery.PNG\|~~thumb~~\|1143x1143px\|Parameter values]]		[[File:IBeacon_EYE_beacon_additional_data_Battery.PNG\|frameless\|1143x1143px\|Parameter values]]
	<br></br>		<br></br>

Line 147:		Line 147:
	Battery > '''<span style="background-color:#1de1d2;">63</span>''' Value needs to be converted to Decimal > '''<span style="background-color:#1de1d2;">99</span>''' to get the actual voltage this formula has to be used '''<span style="background-color:#1de1d2;">99</span> * 10 + 2000 = 2990mV'''		Battery > '''<span style="background-color:#1de1d2;">63</span>''' Value needs to be converted to Decimal > '''<span style="background-color:#1de1d2;">99</span>''' to get the actual voltage this formula has to be used '''<span style="background-color:#1de1d2;">99</span> * 10 + 2000 = 2990mV'''
	<br></br>		<br></br>

	==== EYE Sensor Capturing Configuration ====		==== EYE Sensor Capturing Configuration ====
	As an example on how to set Beacons Capturing Configuration parameters EYE Sensor can be used. Protocols used can be found [[EYE SENSOR / BTSMP1\|here]].		As an example on how to set Beacons Capturing Configuration parameters EYE Sensor can be used. Protocols used can be found [[EYE SENSOR / BTSMP1\|here]].

Tomas.Gudonis: /* Beacon List Settings after FW ver. 3.27.07.Rev.00 */

2022-03-22T08:57:07Z

Beacon List Settings after FW ver. 3.27.07.Rev.00

@@ Line 80: / Line 80: @@
 * '''Beacon ID Source'''- Beacon ID source can be selected. When Beacon ID is used, source is used as configured in Beacon ID offset and Beacon ID size columns. When Beacon MAC address is selected, Beacon ID will be replaced with MAC address. IO structure remains the same, but Beacon ID size will always be reported as 0x06.
 ==== EYE Beacon Capturing Configuration ====
@@ Line 121: / Line 95: @@
 [[File:IBeacon_EYE_beacon_additional_data_Battery.PNG|thumb|1143x1143px|Parameter values]]
 <br></br>
 Information shown after setting the parameters. Red rectangle indicates configured EYE Beacons additional data with Flag and Battery Voltage.
 [[File:EddyStone_EYE_beacon_additional_data.PNG|left|frameless|545x545px]]
@@ Line 183: / Line 146: @@
 Battery > '''<span style="background-color:#1de1d2;">63</span>''' Value needs to be converted to Decimal > '''<span style="background-color:#1de1d2;">99</span>''' to get the actual voltage this formula has to be used '''<span style="background-color:#1de1d2;">99</span> * 10 + 2000 = 2990mV'''
 <br></br>

Tomas.Gudonis: /* EYE Beacon Capturing Configuration */

2022-03-22T08:37:03Z

EYE Beacon Capturing Configuration

← Older revision		Revision as of 11:37, 22 March 2022
Line 156:		Line 156:
	'''Note:''' only bits 6 and 7 can have value 1, on BTSID1		'''Note:''' only bits 6 and 7 can have value 1, on BTSID1

	Bit <span style="background-color:#ff8b00;">6</span> ~~ā€“~~ Low Battery indication. 0 ~~ā€“~~ Means device battery is from 100 to 15 % (When value changes to 1 Battery level is lower than 15 %.		Bit <span style="background-color:#ff8b00;">6</span> – Low Battery indication. 0 – Means device battery is from 100 to 15 % (When value changes to 1 Battery level is lower than 15 %.

	Bit <span style="background-color:#8be509;">7</span> ~~ā€“~~ Battery voltage value presence. 1 Means device is reading and transmitting battery voltage value.		Bit <span style="background-color:#8be509;">7</span> – Battery voltage value presence. 1 Means device is reading and transmitting battery voltage value.
	<br></br>		<br></br>
	How to parse '''Battery Voltage''':		How to parse '''Battery Voltage''':
Line 176:		Line 176:
	'''Note:''' only bits 6 and 7 can have value 1, on BTSID1		'''Note:''' only bits 6 and 7 can have value 1, on BTSID1

	Bit <span style="background-color:#ff8b00;">6</span> ~~ā€“~~ Low Battery indication. 0 ~~ā€“~~ Means device battery is from 100 to 15 % (When value changes to 1 Battery level is lower than 15 %.		Bit <span style="background-color:#ff8b00;">6</span> – Low Battery indication. 0 – Means device battery is from 100 to 15 % (When value changes to 1 Battery level is lower than 15 %.

	Bit <span style="background-color:#8be509;">7</span> ~~ā€“~~ Battery voltage value presence. 1 Means device is reading and transmitting battery voltage value.		Bit <span style="background-color:#8be509;">7</span> – Battery voltage value presence. 1 Means device is reading and transmitting battery voltage value.
	<br></br>		<br></br>
	How to parse '''Battery Voltage''':		How to parse '''Battery Voltage''':

Tomas.Gudonis: /* EYE Sensor Capturing Configuration */

2022-03-22T08:31:02Z

EYE Sensor Capturing Configuration

← Older revision		Revision as of 11:31, 22 March 2022
Line 106:		Line 106:

	'''Note''': Due to differencies in iBeacon and Eddystone advertising packets, number of Additional Data offset is different as well.		'''Note''': Due to differencies in iBeacon and Eddystone advertising packets, number of Additional Data offset is different as well.
			<br></br>
			==== EYE Beacon Capturing Configuration ====

			As an example on how to set Beacons Capturing Configuration parameters EYE Beacon can be used. Protocols used can be found [[EYE BEACON / BTSID1\|here]].
			<br></br>
			'''Capturing Flags and Battery voltage example:'''
			[[File:Beacon_config_example_flags_and_battery.png\|thumb\|1143x1143px\|Parameter
			values]]
			<br></br>
			'''Capturing Flags example:'''
			[[File:IBeacon_EYE_beacon_additional_data_Flag.PNG\|thumb\|1143x1143px\|Parameter values]]
			<br></br>
			'''Capturing Battery voltage example:'''
			[[File:IBeacon_EYE_beacon_additional_data_Battery.PNG\|thumb\|1143x1143px\|Parameter values]]
			<br></br>
			* '''Name''' - particular parameter does not affect Beacon capturing at all. You can name particular beacon capturing line as you wish. Note that if "dot" symbol is placed prior to the name - whole line in the table is disabled and beacons will not be captured;
			* '''Manufacturer ID''' - most crucial and important part of the configuration. Device will look for provided ID and capture beacons if ID matches. Manufacturer ID consists of 4 Bytes (8bits) and it is required to write in the table full ID of 4 Bytes. Of course, in some cases Manufacturer ID of some Beacons may be shorter - in such case shorter ID can be configured but do not forget to add zeroes after the ID inside configuration ā€“ otherwise configuration will not be valid. Actually any numbers could be written because ID size in found Beacon advertising packet can be configured with further parameters;
			'''Note:''' Manufacturer ID can be any set of bytes from the advertisement packet but selected bytes must never change in advertised packet.
			* '''Manufacturer ID Offset''' - when device finds advertising packet from a beacon, device will check for the Manufacturer ID in specific part of the packet. Particular parameter commands device from which byte in the advertised packet to look for the ID;
			* '''Manufacturer ID Size''' - maximum size is 4 Bytes (''same as maximum configurable parameter in Manufacturer ID''). This parameter indicates how many bytes in found advertising packet after offsetting to check. These bytes must match ID configured in Manufacturer ID section. If bytes match - Beacon advertisement packet is captured, if bytes do not match - packet is neglected;
			* '''Beacon ID Offset''' - parameter works the same way as Manufacturer ID Offset but main purpose is to capture e.g. UUID of the beacon because Manufacturer ID never changes on the same provider Beacons;
			* '''Beacon ID Size''' - parameter works the same way as Manufacturer ID Size but purpose is to capture specific part or whole e.g. UUID (major, minor);
			* '''Additional Data Offset''' and '''Additional Data Size''' - allows to capture specific data of the Beacons advertised packet e.g. battery voltage or status. These additional parameters depend on Beacon type and advertisement packet. In order to capture full packet of the Beacon - Offset can be left at 0 and Size matched by actual length of the advertised packet.
			* '''Beacon ID Source'''- Beacon ID source can be selected. When Beacon ID is used, source is used as configured in Beacon ID offset and Beacon ID size columns. When Beacon MAC address is selected, Beacon ID will be replaced with MAC address. IO structure remains the same, but Beacon ID size will always be reported as 0x06.

			'''Note''': Due to differences in iBeacon and Eddystone advertising packets, number of Additional Data offset is different as well.
			<br></br>
			Information shown after setting the parameters. Red rectangle indicates configured EYE Beacons additional data with Flag and Battery Voltage.
			[[File:EddyStone_EYE_beacon_additional_data.PNG\|left\|frameless\|545x545px]]
			[[File:IBeacon_EYE_beacon_additional_data.PNG\|center\|frameless\|552x552px\|Eddystone
			temperature]]
			<br></br>

			In the bellow picture is EddyStone and iBeacon protocol break down, according to Flag and Battery Voltage configuration in additional data. Same logic applies when configuring Flags or Battery Voltage separately

			[[File:Protocol_break_down.PNG\|center\|frameless\|1200x800px]]
			<br></br>
			'''Parsing additional data for iBeacon and EddyStone:'''
			<br></br>

			'''Example 1'''

			Additional Data sent by the EddyStone protocol: '''<span style="background-color:#fff700;">80</span><span style="background-color:#1de1d2;">5F</span>'''
			<br></br>
			How to parse '''Flags''':

			Flag > '''<span style="background-color:#fff700;">80</span>''', Value needs to be converted to Binary > '''<span style="background-color:#8be509;">1</span><span style="background-color:#ff8b00;">0</span>000000'''

			'''Note:''' only bits 6 and 7 can have value 1, on BTSID1

			Bit <span style="background-color:#ff8b00;">6</span> ā€“ Low Battery indication. 0 ā€“ Means device battery is from 100 to 15 % (When value changes to 1 Battery level is lower than 15 %.

			Bit <span style="background-color:#8be509;">7</span> ā€“ Battery voltage value presence. 1 Means device is reading and transmitting battery voltage value.
			<br></br>
			How to parse '''Battery Voltage''':

			Battery > '''<span style="background-color:#1de1d2;">5F</span>''' Value needs to be converted to Decimal > '''<span style="background-color:#1de1d2;">95</span>''' to get the actual voltage this formula has to be used '''<span style="background-color:#1de1d2;">95</span> * 10 + 2000 = 2950 mV'''
			<br></br>

			'''Example 2'''

			Additional Data sent by the iBeacon protocol: '''<span style="background-color:#fff700;">80</span><span style="background-color:#1de1d2;">63</span>'''
			<br></br>
			How to parse '''Flags''':

			Flag > '''<span
			style="background-color:#fff700;">80</span>''', Value needs to be converted to Binary > '''<span style="background-color:#8be509;">1</span><span style="background-color:#ff8b00;">0</span>000000'''

			'''Note:''' only bits 6 and 7 can have value 1, on BTSID1

			Bit <span style="background-color:#ff8b00;">6</span> ā€“ Low Battery indication. 0 ā€“ Means device battery is from 100 to 15 % (When value changes to 1 Battery level is lower than 15 %.

			Bit <span style="background-color:#8be509;">7</span> ā€“ Battery voltage value presence. 1 Means device is reading and transmitting battery voltage value.
			<br></br>
			How to parse '''Battery Voltage''':

			Battery > '''<span style="background-color:#1de1d2;">63</span>''' Value needs to be converted to Decimal > '''<span style="background-color:#1de1d2;">99</span>''' to get the actual voltage this formula has to be used '''<span style="background-color:#1de1d2;">99</span> * 10 + 2000 = 2990mV'''
			<br></br>

	===Beacon List===		===Beacon List===

Deividas.Darulis: /* Configurable parameters in Beacons Capturing Configuration table (Advanced Mode) */

2022-01-03T09:18:41Z

Configurable parameters in Beacons Capturing Configuration table (Advanced Mode)

← Older revision		Revision as of 12:18, 3 January 2022
Line 72:		Line 72:
	* '''Name''' - particular parameter does not affect Beacon capturing at all. You can name particular beacon capturing line as you wish. Note that if "dot" symbol is placed prior to the name - whole line in the table is disabled and beacons will not be captured;		* '''Name''' - particular parameter does not affect Beacon capturing at all. You can name particular beacon capturing line as you wish. Note that if "dot" symbol is placed prior to the name - whole line in the table is disabled and beacons will not be captured;
	* '''Manufacturer ID''' - most crucial and important part of the configuration. Device will look for provided ID and capture beacons if ID matches. Manufacturer ID consists of 4 Bytes (8bits) and it is required to write in the table full ID of 4 Bytes. Of course, in some cases Manufacturer ID of some Beacons may be shorter - in such case shorter ID can be configured but do not forget to add zeroes after the ID inside configuration – otherwise configuration will not be valid. Actually any numbers could be written because ID size in found Beacon advertising packet can be configured with further parameters;		* '''Manufacturer ID''' - most crucial and important part of the configuration. Device will look for provided ID and capture beacons if ID matches. Manufacturer ID consists of 4 Bytes (8bits) and it is required to write in the table full ID of 4 Bytes. Of course, in some cases Manufacturer ID of some Beacons may be shorter - in such case shorter ID can be configured but do not forget to add zeroes after the ID inside configuration – otherwise configuration will not be valid. Actually any numbers could be written because ID size in found Beacon advertising packet can be configured with further parameters;
			'''Note:''' Manufacturer ID can be any set of bytes from the advertisement packet but selected bytes must never change in advertised packet.
	* '''Manufacturer ID Offset''' - when device finds advertising packet from a beacon, device will check for the Manufacturer ID in specific part of the packet. Particular parameter commands device from which byte in the advertised packet to look for the ID;		* '''Manufacturer ID Offset''' - when device finds advertising packet from a beacon, device will check for the Manufacturer ID in specific part of the packet. Particular parameter commands device from which byte in the advertised packet to look for the ID;
	* '''Manufacturer ID Size''' - maximum size is 4 Bytes (''same as maximum configurable parameter in Manufacturer ID''). This parameter indicates how many bytes in found advertising packet after offsetting to check. These bytes must match ID configured in Manufacturer ID section. If bytes match - Beacon advertisement packet is captured, if bytes do not match - packet is neglected;		* '''Manufacturer ID Size''' - maximum size is 4 Bytes (''same as maximum configurable parameter in Manufacturer ID''). This parameter indicates how many bytes in found advertising packet after offsetting to check. These bytes must match ID configured in Manufacturer ID section. If bytes match - Beacon advertisement packet is captured, if bytes do not match - packet is neglected;