User manual - BlueUp · 2018. 6. 26. · BlueUp S.r.l.s. Loc. Belvedere, Ingresso 2, 53034 Colle di...

28
BlueUp S.r.l.s. Loc. Belvedere, Ingresso 2, 53034 Colle di Val d'Elsa (SI) - ITALY Ph. 347 4123206, Fax 0577 043101 E-mail: [email protected], Web: www.blueupbeacons.com VAT N. IT 01373980521 BlueBeacon Gateway User manual Introduction BlueBeacon Gateway is a BLE-beacon gateway with BLE and LAN/WLAN interfaces that allows to communicate with BLE beacons (new software manages both scanning for generic BLE beacons and connecting to BlueBeacon beacons). BlueBeacon Gateway is offered in two alternative versions: BlueBeacon Gateway D for desktop applications; BlueBeacon Gateway W for wall installations. BlueBeacon Gateway D is provided in a plastic enclosure suitable for desktop applications (optional mounting kit is available). It is available in one version: - D/A00: with integrated omnidirectional BLE antenna. BlueBeacon Gateway W is provided in an elegant plastic enclosure suitable for wall or ceiling installation. It is available in three versions: - W/A00: with integrated omnidirectional BLE antenna; - W/A05: with internal 5dB-directive BLE antenna; - W/SMA: with SMA connector for external BLE antenna. Possible applications with BlueBeacon Gateway are: - remote monitoring and management of beacons; - localization of BLE beacons (tags) for RTLS and access control; - distributed monitoring systems of environmental parameters, using BlueBeacon Sensor (with temperature, humidity and pressure sensors); Before you start using a BlueBeacon Gateway, verify that it is undamaged and carefully read the instructions in this user manual, particularly the indications in the "Safety" section . BlueUp S.r.l.s. disclaims any and all liability if the devices are used in modes and environments incompatible for keeping the product’s intact, safe and in operation. BlueUp S.r.l.s. - 2018 V1.0– 26/06/2018 1/28

Transcript of User manual - BlueUp · 2018. 6. 26. · BlueUp S.r.l.s. Loc. Belvedere, Ingresso 2, 53034 Colle di...

Page 1: User manual - BlueUp · 2018. 6. 26. · BlueUp S.r.l.s. Loc. Belvedere, Ingresso 2, 53034 Colle di Val d'Elsa (SI) - ITALY Ph. 347 4123206, Fax 0577 043101 E-mail: info@blueupbeacons.com,

BlueUp S.r.l.s.Loc. Belvedere, Ingresso 2, 53034 Colle di Val d'Elsa (SI) - ITALY

Ph. 347 4123206, Fax 0577 043101E-mail: [email protected], Web: www.blueupbeacons.com

VAT N. IT 01373980521

BlueBeacon GatewayUser manual

Introduction

BlueBeacon Gateway is a BLE-beacon gateway with BLE and LAN/WLAN interfaces thatallows to communicate with BLE beacons (new software manages both scanning forgeneric BLE beacons and connecting to BlueBeacon beacons).BlueBeacon Gateway is offered in two alternative versions:

• BlueBeacon Gateway D for desktop applications;• BlueBeacon Gateway W for wall installations.

BlueBeacon Gateway D is provided in a plastic enclosure suitable for desktop applications(optional mounting kit is available). It is available in one version:- D/A00: with integrated omnidirectional BLE antenna.

BlueBeacon Gateway W is provided in an elegant plastic enclosure suitable for wall orceiling installation. It is available in three versions:- W/A00: with integrated omnidirectional BLE antenna;- W/A05: with internal 5dB-directive BLE antenna;- W/SMA: with SMA connector for external BLE antenna.

Possible applications with BlueBeacon Gateway are: - remote monitoring and management of beacons; - localization of BLE beacons (tags) for RTLS and access control;- distributed monitoring systems of environmental parameters, using BlueBeacon Sensor(with temperature, humidity and pressure sensors);

Before you start using a BlueBeacon Gateway, verify that it is undamaged and carefullyread the instructions in this user manual, particularly the indications in the "Safety" section.

BlueUp S.r.l.s. disclaims any and all liability if the devices are used in modes andenvironments incompatible for keeping the product’s intact, safe and in operation.

BlueUp S.r.l.s. - 2018 V1.0– 26/06/2018 1/28

Page 2: User manual - BlueUp · 2018. 6. 26. · BlueUp S.r.l.s. Loc. Belvedere, Ingresso 2, 53034 Colle di Val d'Elsa (SI) - ITALY Ph. 347 4123206, Fax 0577 043101 E-mail: info@blueupbeacons.com,

Technical characteristicsHardwarePlatform: Quad Core 1.2GHz Broadcom BCM2837 64bit CPU

Connectivity: Ethernet, WiFi

Radio (Bluetooth)Version: 4.1 Bluetooth Smart (Low Energy)

Frequency: 2.402 to 2.480 GHz

Antenna: D/A00: desktop-version with integrated omnidirectional chip antenna;

W/A00: wall-version with integrated omnidirectional chip antenna;

W/A05: wall-version with internal 5dB-directive antenna;W/SMA: wall-version with SMA connector for external antenna.

Electrical specificationsVoltage: 5VDC (micro-USB)

Current: 1.5A (typ.)

Mechanical and environmental specificationsSize: Ver. D: 100 x 73 x 30 mm

Ver. W: 120 x 120 x 45 mm (excluding flanges)

Mounting kit: Ver. D: none

Ver. W: wall-mounting plastic flange

IP protection: IP40

Operating temperature: -20°C to +60°C

BlueUp S.r.l.s. - 2018 V1.0– 26/06/2018 2/28

Page 3: User manual - BlueUp · 2018. 6. 26. · BlueUp S.r.l.s. Loc. Belvedere, Ingresso 2, 53034 Colle di Val d'Elsa (SI) - ITALY Ph. 347 4123206, Fax 0577 043101 E-mail: info@blueupbeacons.com,

Safety

These information are an integral and essential part of the product (BlueBeacon Gateway )and must be delivered to the user. Read them carefully as they contain importantinformation regarding the installation, use and maintenance.

Warnings

BlueBeacon Gateway W must be intended for use for which it was designed. Any otheruse is considered improper and therefore dangerous.Before you start using BlueBeacon Gateway W, verify that it is undamaged.DO NOT use BlueBeacon Gateway W in potentially explosive atmospheres. The presenceof flammable gas or fumes is a serious safety hazard.Make sure that BlueBeacon Gateway W is always kept in a dry environment.The company BlueUp S.r.l.s. disclaims any liability for damages caused by an inadequateuse of the device and the failure to observe the information provided herein.

Power

The device must be powered via the micro-USB port with a 5VDC power-supply. Use anAC/DC plug-in power adapter with USB output and USB-to-microUSB power cable. Thepower supply must be capable of supplying a current of at least 1.5A. The external poweradapter must comply with applicable standards and regulations in the country of use.Do not power the device with power voltages other than 5VDC. Power supply withvoltages other than 5VDC may irreversibly damage the device, as well as cause potentialsafety hazards.

Waste disposal

In implementing the Directives 2011/65/EU and 2012/19/EC on the restriction of theuse of hazardous substances in electrical and electronic equipment and thedisposal of waste.The crossed bin symbol on the appliance or its packaging indicates that at the end of theproduct’s life, it must be collected separately from other waste. The user must, therefore,take the remote control to an authorized disposal center for collection of electronic andelectrical waste, or return it to the dealer when purchasing a new similar appliance, on aone to one basis. Appropriate separate collection for the subsequent forwarding of theproduct sent for recycling, treatment and environmentally compatible disposal helps toprevent negative environmental and health effects and promotes the reuse and/orrecycling of materials making up the equipment. Illegal dumping of the product by the userentails the application of administrative sanctions in the current provisions of law.For more information about the collection systems, contact your local authorities.

BlueUp S.r.l.s. - 2018 V1.0– 26/06/2018 3/28

Page 4: User manual - BlueUp · 2018. 6. 26. · BlueUp S.r.l.s. Loc. Belvedere, Ingresso 2, 53034 Colle di Val d'Elsa (SI) - ITALY Ph. 347 4123206, Fax 0577 043101 E-mail: info@blueupbeacons.com,

In implementing Directive 2006/66/EC on the reduced use of hazardous substancesin batteries and the disposal of the same.The crossed bin symbol on the appliance or its packaging indicates that the batteries mustnot be disposed of with the rest of the household waste, as they may contain substancesthat are potentially harmful to the environment and health. Remove the old battery from thedevice and turn it in at the appropriate collection points.

Disclaimer

This manual is intended to provide a brief summary of our knowledge and some guidanceregarding the use of the device and its accessories. The information contained herein hasbeen provided by sources that BlueUp S.r.l.s. considers to be dependable and is accurateto the best knowledge of the company. This sheet is not intended to be an inclusivedocument on worldwide hazard communication regulations. The information is provided ingood faith. Each user of this material needs to evaluate the conditions of use and definethe appropriate protective mechanisms to prevent the exposure of persons, propertydamage or release to the environment.BlueUp S.r.l.s. assumes no responsibility for injury to the recipient or third persons,or for any damages resulting from misuse of the device and its parts.

BlueUp S.r.l.s. - 2018 V1.0– 26/06/2018 4/28

Page 5: User manual - BlueUp · 2018. 6. 26. · BlueUp S.r.l.s. Loc. Belvedere, Ingresso 2, 53034 Colle di Val d'Elsa (SI) - ITALY Ph. 347 4123206, Fax 0577 043101 E-mail: info@blueupbeacons.com,

Device connection and setup

BlueBeacon Gateway comes with the following default network configurations:• Ethernet network interface: Enabled with DHCP• Wifi network interface: Disabled

To access the BlueBeacon Gateway administration interface, you need a LAN infrastructure with at least one device offering IP address assignment (DHCP Server). Usually any commercial router integrates a DHCP Server.

Connect BlueBeacon Gateway with an ethernet cable to your LAN network, then power BlueBeacon Gateway via the MicroUSB connector - we recommend using a power supply with the following features:

• Input: 100-240V ~ 50 / 60Hz• Output: 5V 1.5A �

Once powered, BlueBeacon Gateway will begin the boot process of the operating system and the necessary software components. When the green LED will start to flash (heartbeat-blink) BlueBeacon Gateway will be fully operational.

In case of incorrect network configuration or problems such that the BlueBeacon Gateway administration interface is no longer reachable on the network, it is possible to restore the factory settings using the reset button located on the bottom of the device (under the Ethernet connector) . By keeping this button pressed for at least 5 seconds, the green LEDwill remain on and the device will start the reset procedure. At the end of the procedure, BlueBeacon Gateway will automatically reboot and the green LED will flash again indicating the correct execution of the software on board.

BlueUp S.r.l.s. - 2018 V1.0– 26/06/2018 5/28

5VDCETH

ETH

5VDC

Page 6: User manual - BlueUp · 2018. 6. 26. · BlueUp S.r.l.s. Loc. Belvedere, Ingresso 2, 53034 Colle di Val d'Elsa (SI) - ITALY Ph. 347 4123206, Fax 0577 043101 E-mail: info@blueupbeacons.com,

Get into the administration interface

BlueBeacon Gateway has a web interface to manage all its features. The web interface is reachable at the IP address of the device.

BlueBeacon Gateway comes with a pre-configured ethernet interface to use DHCP. So, in order to access the web interface the first time you boot BlueBeacon Gateway, you need a device (usually a commercial router) with DHCP Server functionality enabled. When your router has assigned an IP address to the BlueBeacon Gateway you need to identify the IP address assigned and then point your browser to this IP.

Figure 1 shows an example of identifying the IP address assigned to the BlueBeacon Gateway by a SpeedTouch router.As you can see, BlueBeacon Gateway is identified by itshostname which consists of the string BBGW-CPU_SERIAL_NUMBER.

BlueUp S.r.l.s. - 2018 V1.0– 26/06/2018 6/28

Figure 1: Identifiction of BlueBecion Gctewcy within the cdministrction interfcie ofc SpeedTouih router.

Page 7: User manual - BlueUp · 2018. 6. 26. · BlueUp S.r.l.s. Loc. Belvedere, Ingresso 2, 53034 Colle di Val d'Elsa (SI) - ITALY Ph. 347 4123206, Fax 0577 043101 E-mail: info@blueupbeacons.com,

Administration interface: Login

Once the BlueBeacon Gateway IP address is identified, to access the administration interface, simply point the browser to the BlueBeacon Gateway IP address, as shown in Figure 2.

At this point, the login screen will appear on the browser (Figure 3).

The default password to be used at the first start is blueup.

Once logged in, you will be redirected to the index page of the BlueBeacon Gateway administration interface.

BlueUp S.r.l.s. - 2018 V1.0– 26/06/2018 7/28

Figure 2: Aiiess to the cdministrction interfcie by entering theBlueBecion Gctewcy IP cddress.

Figure 3: Login sireen of the BlueBecionGctewcy cdministrction interfcie.

Page 8: User manual - BlueUp · 2018. 6. 26. · BlueUp S.r.l.s. Loc. Belvedere, Ingresso 2, 53034 Colle di Val d'Elsa (SI) - ITALY Ph. 347 4123206, Fax 0577 043101 E-mail: info@blueupbeacons.com,

Administrative interface: Overview

Figure 4 shows an overview of the BlueBeacon Gateway administration interface.

On the left side you can see the sidebar of the menus, where are the buttons to access thefollowing pages:

• System Info : contains information and system configurations

• Network Settings : allows you to view and edit network configurations

• BlueBeacon Cloud : allows you to register BlueBeacon Gateway at the BlueBeacon Cloud portal and then monitor and manage the beacon remotely

• Beacons : displays information about the beacon currently received by BlueBeacon Gateway

• HTTP Callbacks : allows you to configure HTTP callbacks to automatically send beacon data to a server

• Beacon RSSI : displays a plot of the received signal strength indication (RSSI)

• Docs : documentation related to the REST APIs provided by BlueBeacon Gateway

At the top you can view the topbar, where in the top right menu you have access to the features of:

• Reboot , restart of BlueBeacon Gateway

• Shutdown , shutdown of BlueBeacon Gateway

• Logout from the administration interface

BlueUp S.r.l.s. - 2018 V1.0– 26/06/2018 8/28

Page 9: User manual - BlueUp · 2018. 6. 26. · BlueUp S.r.l.s. Loc. Belvedere, Ingresso 2, 53034 Colle di Val d'Elsa (SI) - ITALY Ph. 347 4123206, Fax 0577 043101 E-mail: info@blueupbeacons.com,

BlueUp S.r.l.s. - 2018 V1.0– 26/06/2018 9/28

Figure 4: BlueBecion Gctewcy homepcge.

Page 10: User manual - BlueUp · 2018. 6. 26. · BlueUp S.r.l.s. Loc. Belvedere, Ingresso 2, 53034 Colle di Val d'Elsa (SI) - ITALY Ph. 347 4123206, Fax 0577 043101 E-mail: info@blueupbeacons.com,

Administrative interface: System Info

The System Info tab displays the main information and system configurations (Figure 5).

System information is grouped into:

• General Info : general information

◦ Firmware version : version of the BlueBeacon Gateway software package

◦ Hostname : system hostname, default BBGW-CPU_SERIAL_NUMBER

◦ System Timezone : system timezone, the default value is Europe / Rome, but it can be changed by selecting the timezone among those available

◦ System Time 11: system date and time, varies according to the chosen timezone

◦ System Uptime : system uptime, indicates how long BlueBeacon Gateway is active

• Device Identifiers : unique serial identifiers of the system

◦ Machine ID : unique id generated when first started

◦ CPU Serial : unique ID of the CPU

◦ uSD Serial : unique ID of the SD-CARD

• Network Interfaces : configuration of active network interfaces

• Login Password : allows you to change the password for accessing the BlueBeacon Gateway administration interface

• Firmware Upgrade : allows you to upgrade the software developed by BlueUp (requires the upload of the software package released by BlueUp)

Administrative interface: Network Settings

The Network Settings tab displays and allows you to configure the BlueBeacon Gateway network interfaces (Ethernet and WiFi) (Figure 6).

For each network interface you can choose whether to use DHCP or static IP, configure the default gateway and the DNS servers to be used.Regarding the wireless network interface, you will also need to specify:WLAN country code: country code to select from those available

1 BlueBeacon Gateway in the basic version, does not have a dedicated RTC but sets and maintains the system time using NTP (Network Time Protocol). The NTP protocol defines a client / server mechanism with which an operating system can keep the system time synchronized using NTP remote servers. Therefore, to be able to maintain the system time, it will be necessary that BlueBeacon Gateway is connected to a LAN that allows BlueBeacon Gateway to reach the remote NTP servers on the web.

BlueUp S.r.l.s. - 2018 V1.0– 26/06/2018 10/28

Page 11: User manual - BlueUp · 2018. 6. 26. · BlueUp S.r.l.s. Loc. Belvedere, Ingresso 2, 53034 Colle di Val d'Elsa (SI) - ITALY Ph. 347 4123206, Fax 0577 043101 E-mail: info@blueupbeacons.com,

WLAN SSID: the name of the wireless network to which BlueBeacon Gateway will have to connectWLAN Password: the access password for the wireless network

Once you have configured the network interfaces, you will need to press the Save button to save the configurations. To apply the new network configurations it is necessary to restart the BlueBeacon Gateway (reboot using the appropriate button on the drop down menu located on the topbar).

At the next restart, you can verify that the new network settings have been correctly applied also through the System Info page, in the Network Interfaces section (Figure 7).

BlueUp S.r.l.s. - 2018 V1.0– 26/06/2018 11/28

Figure 5: System Info

Page 12: User manual - BlueUp · 2018. 6. 26. · BlueUp S.r.l.s. Loc. Belvedere, Ingresso 2, 53034 Colle di Val d'Elsa (SI) - ITALY Ph. 347 4123206, Fax 0577 043101 E-mail: info@blueupbeacons.com,

BlueUp S.r.l.s. - 2018 V1.0– 26/06/2018 12/28

Figure 6: Network Settings, ionfgurction interfcie for the BlueBecion Gctewcy networkinterfcies.

Page 13: User manual - BlueUp · 2018. 6. 26. · BlueUp S.r.l.s. Loc. Belvedere, Ingresso 2, 53034 Colle di Val d'Elsa (SI) - ITALY Ph. 347 4123206, Fax 0577 043101 E-mail: info@blueupbeacons.com,

BlueUp S.r.l.s. - 2018 V1.0– 26/06/2018 13/28

Figure 7: Network Interfcies, displcying the ionfgurction in use for the networkinterfcies.

Page 14: User manual - BlueUp · 2018. 6. 26. · BlueUp S.r.l.s. Loc. Belvedere, Ingresso 2, 53034 Colle di Val d'Elsa (SI) - ITALY Ph. 347 4123206, Fax 0577 043101 E-mail: info@blueupbeacons.com,

Administration interface: BlueBeacon Cloud

The BlueBeacon Cloud tab allows you to manage the BlueBeacon Gateway connection with the BlueUp BlueBeacon Cloud backend system.

If you have an account on the BlueBeacon Cloud system, you can authorize BlueBeacon Gateway to monitor and synchronize your registered beacons on the BlueBeacon Cloud.

Authorizing BlueBeacon Gateway cloud access, the following features will be available:• monitoring and uploading of beacons’ data on BlueBeacon Cloud - this feature

allows you to remotely monitor, through the BlueBeacon Cloud portal, the operating status, the battery level and the beacon signal strength that BlueBeacon Gateway isreceiving

• synchronization of the configuration with BlueBeacon Cloud - this feature allows youto reconfigure the beacons remotely, using the BlueBeacon Cloud portal; BlueBeacon Gateway will periodically check any modified configurations and apply them to the beacons.

In Figure 8, the interface for entering the credentials for accessing the BlueBeacon Cloud portal is shown. The login credentials will be used to establish a pairing between the user account and the BlueBeacon Gateway. Once the pairing is created, BlueBeacon Gateway will be authorized to use the cloud features offered.

In Figure 9, the management interface of the beacon registered on the BlueBeacon Cloud portal is shown. Once access to the BlueBeacon Gateway is allowed, the user can view the beacons registered on his account and the configuration status (synchronized / not synchronized). Through the synchronization configuration interface it is possible to configure the BlueBeacon Gateway to synchronize the configuration of the beacons at intervals of time (every half hour, every hour or once a day at a pre-set time). If configured,the AutoSync mechanism allows you to apply to beacon any changes made to the beacon remotely on the BlueBeacon Cloud portal.

BlueUp S.r.l.s. - 2018 V1.0– 26/06/2018 14/28

Page 15: User manual - BlueUp · 2018. 6. 26. · BlueUp S.r.l.s. Loc. Belvedere, Ingresso 2, 53034 Colle di Val d'Elsa (SI) - ITALY Ph. 347 4123206, Fax 0577 043101 E-mail: info@blueupbeacons.com,

BlueUp S.r.l.s. - 2018 V1.0– 26/06/2018 15/28

Figure 8: User iredenticls input interfcie to login on BlueBecion Cloud bcikend.

Page 16: User manual - BlueUp · 2018. 6. 26. · BlueUp S.r.l.s. Loc. Belvedere, Ingresso 2, 53034 Colle di Val d'Elsa (SI) - ITALY Ph. 347 4123206, Fax 0577 043101 E-mail: info@blueupbeacons.com,

BlueUp S.r.l.s. - 2018 V1.0– 26/06/2018 16/28

Figurc 9: Interfcie to visuclize cnd ionfgure the becion synihronizction system withthe BlueBecion Cloud bcikend.

Page 17: User manual - BlueUp · 2018. 6. 26. · BlueUp S.r.l.s. Loc. Belvedere, Ingresso 2, 53034 Colle di Val d'Elsa (SI) - ITALY Ph. 347 4123206, Fax 0577 043101 E-mail: info@blueupbeacons.com,

Administration interface: BeaconsThe Beacons tab displays information about the beacon currently received by BlueBeacon Gateway.

There are various sub-menus that allow you to filter the beacons according to some criteria:

• BlueUp beacons : shows only the BlueUp beacons

• iBeacon : shows all the beacons that transmit packages in Apple iBeacon format

• Eddystone : shows all the beacons that transmit packages in Google Eddystone format

• Quuppa : shows all the beacons that transmit packets in Quuppa format

• Sensor : shows all the beacons that transmit packets in BlueUp Sensor format

The Settings menu, on the other hand, allows you to configure some values related to the reception of the beacon:

• Beacon Timeout : is the timeout after which a beacon is removed from the list of received beacon

• Frame Timeout : is the timeout after which a specific frame transmitted by a beacon is removed from the list of frames transmitted by the beacon

• Pathloss Exponent : is a parameter used to estimate the distance of the beacon; thisparameter must be calibrated according to the environment in which the beacon and BlueBeacon Gateway are located.

Within the time interval that goes from t1 (when the beacon 01-123460 is no longer received by BlueBeacon Gateway) up to t1 + BeaconTimeout, the beacon 01-123460 will still be included in the list of beacon received (the timestamp for the last received packet will be t0). After BeaconTimeout seconds, the beacon will be removed from the list of received beacons.

BlueUp S.r.l.s. - 2018 V1.0– 26/06/2018 17/28

Page 18: User manual - BlueUp · 2018. 6. 26. · BlueUp S.r.l.s. Loc. Belvedere, Ingresso 2, 53034 Colle di Val d'Elsa (SI) - ITALY Ph. 347 4123206, Fax 0577 043101 E-mail: info@blueupbeacons.com,

Decreasing the BeaconTimeout value will result in a greater reactivity of the system in the detection of the disappearance of the beacon, however in environments with many obstacles this could lead to frequent oscillations (insertions / removals) of the beacon within the list of beacon received.

Suppose the 01-123460 beacon is transmitting two frames, an iBeacon frame and an Eddystone frame. Suppose then that the beacon is reconfigured (eg via smartphone) and the Eddystone frame is disabled. At the instant t1, when the beacon starts to transmit only the iBeacon frame, the Eddystone frame is always present in the list of frames relating to the beacon 01-123460 on BlueBeacon Gateway. Only after FrameTimeout seconds have elapsed, BlueBeacon Gateway, having no longer received the Eddystone frame from the beacon 01-123460, will remove this frame from the list of frames transmitted by the beacon 01-123460.

By decreasing the value of FrameTimeout, you will get a greater reactivity of the system in detecting changes in configuration of the beacon. However, it is also necessary to set this value according to the configuration used for the beacon, because if the value of FrameTimeout is lower than the beacon's advertising interval, there will be continuous oscillations (insertions / removals) of the frames transmitted by the beacon.

BlueUp S.r.l.s. - 2018 V1.0– 26/06/2018 18/28

Page 19: User manual - BlueUp · 2018. 6. 26. · BlueUp S.r.l.s. Loc. Belvedere, Ingresso 2, 53034 Colle di Val d'Elsa (SI) - ITALY Ph. 347 4123206, Fax 0577 043101 E-mail: info@blueupbeacons.com,

Administration interface: HTTP Callbacks

The HTTP Callbacks tab allows the user to schedule HTTP callbacks to send beacon data periodically to a pre-set server.

If HTTP callbacks are configured, BlueBeacon Gateway will periodically make one (or more) HTTP call to the configured address by sending a JSON code containing the beacon data within the body of the HTTP call.

To configure an HTTP callback, the following parameters must be specified:

• Callback Mode : the callback category

◦ Periodic : periodic callback scheduled at regular time intervals▪ Interval : time interval (in seconds) to which the callback is scheduled

◦ Location : scheduled periodic callback every 1 second, only for beacon in iBeacon format, used to set up localization systems, the JSON integrates RSSI data averaged over a time interval of 1s and contains values useful for estimating the beacon's position

• URL : the URL to be called for the HTTP callback

• Filter : any filtering on the frames sent by the beacons

Figure 10 shows the interface for inserting and configuring an HTTP callback.

As of firmware version v4.2, the data sent by BlueBeacon Gateway are accompanied by a signature that allows to perform a further verification of integrity and authentication. The signature is calculated on the JSON relative to the array of beacons using a HMAC-SHA256 algorithm that has as key a one-key based based constituted by SHA256 hash of the concatenation of GatewayID, Gateway password and the timestamp attached to the data sent.

ExampleData sent in HTTP POST from BlueBeacon Gateway:

{ "gateway": "00000000087569a7", "beacons": [ { "bdaddr": "e0:37:a2:3d:bb:08", "timestamp": "2018-04-16 12:19:46.914 GMT+0200 (CEST)", "rssi": -62, "connectable": true, "ibeacon": [ { "rssi": -65, "uuid": "acfd065ec3c011e39bbe1a514932ac01", "major": 0, "minor": 18000, "measuredPower": -62, "timestamp": "2018-04-16 12:19:49.57 GMT+0200 (CEST)"

BlueUp S.r.l.s. - 2018 V1.0– 26/06/2018 19/28

Page 20: User manual - BlueUp · 2018. 6. 26. · BlueUp S.r.l.s. Loc. Belvedere, Ingresso 2, 53034 Colle di Val d'Elsa (SI) - ITALY Ph. 347 4123206, Fax 0577 043101 E-mail: info@blueupbeacons.com,

} ], "model": 4, "serial": 18000, "battery": 83 }, … ], "timestamp": 1523873989372, "signature": "62685d5e3fa064de3d1021ca01f02bd24ff737b4e45c2bcbb941b1287b840bc3"}

The one-time password for the HMAC-SHA256 algorithm is computed as the SHA256 hash of the concatenation of:

otk = SHA256(gateway || password || timestamp)

The signature is calculated as:

signature = HMAC-SHA256(JSON.stringify(beacons), OTK)

BlueUp S.r.l.s. - 2018 V1.0– 26/06/2018 20/28

Figure 10: HTTP icllbcik ionfgurction interfcie.

Page 21: User manual - BlueUp · 2018. 6. 26. · BlueUp S.r.l.s. Loc. Belvedere, Ingresso 2, 53034 Colle di Val d'Elsa (SI) - ITALY Ph. 347 4123206, Fax 0577 043101 E-mail: info@blueupbeacons.com,

Administration interface: Beacon RSSI

The Beacon tab RSSI, allows you to view a real-time plot of the RSSI of one or more beacons received from BlueBeacon Gateway.

The plot can be configured via the interface, setting the following parameters:

• Plot Mode : plot category

• Real-Time : displays a real-time plot of the RSSI of the beacon, the graph is updatedevery time a packet is received by BlueBeacon Gateway (the time scale could be different for each beacon in the event that the beacon transmits at intervals of different time)

• Averaged : displays a averaged plot of the RSSI of the beacon, the graph is updatedevery second with the data of RSSI of the beacon averaged over the time interval of1 second (in this second case, the time scale is the same for all the beacon, why data is processed at regular intervals of 1s)

• Frame : if using Real-Time mode it is also possible to filter the beacons on the frametype (Eddystone, iBeacon, Quuppa ...), in the Averaged mode, only the beacons in iBeacon format will be considered.

In Figure 11 and 12 it is possible to see two examples of Real-Time and Averaged plots, respectively.

BlueUp S.r.l.s. - 2018 V1.0– 26/06/2018 21/28

Page 22: User manual - BlueUp · 2018. 6. 26. · BlueUp S.r.l.s. Loc. Belvedere, Ingresso 2, 53034 Colle di Val d'Elsa (SI) - ITALY Ph. 347 4123206, Fax 0577 043101 E-mail: info@blueupbeacons.com,

BlueUp S.r.l.s. - 2018 V1.0– 26/06/2018 22/28

Figure 10: HTTP icllbcik ionfgurction interfcie.Figure 11: Excmple of Recl-Time plot with fltering on iBecion.

Page 23: User manual - BlueUp · 2018. 6. 26. · BlueUp S.r.l.s. Loc. Belvedere, Ingresso 2, 53034 Colle di Val d'Elsa (SI) - ITALY Ph. 347 4123206, Fax 0577 043101 E-mail: info@blueupbeacons.com,

BlueUp S.r.l.s. - 2018 V1.0– 26/06/2018 23/28

Figure 12: Excmple of Avercged plot with vcrious becions.

Page 24: User manual - BlueUp · 2018. 6. 26. · BlueUp S.r.l.s. Loc. Belvedere, Ingresso 2, 53034 Colle di Val d'Elsa (SI) - ITALY Ph. 347 4123206, Fax 0577 043101 E-mail: info@blueupbeacons.com,

Administration interface: Docs

The Docs tab shows a documentation interface of the REST APIs made available by BlueBeacon Gateway.BlueBeacon Gateway provides a set of REST APIs to request and filter received beacon data. It is also possible to read or write the configuration of a beacon using the REST APIs.The APIs are accessible without authentication at: http://gateway-ip/api

List of APIs provided by the gateway

• GET http://gateway-ip/api /beacons Returns a JSON containing the data related to all the beacons received by BlueBeacon Gateway

• GET http://gateway-ip/api/beacons/ibeaconReturns a JSON containing the data related to all the beacons that transmit packages in iBeacon format

• GET http://gateway-ip/api/beacons/ibeacon/ uuid Returns a JSON containing the data related to all the beacons that transmit packages in iBeacon format with ProximityUUID equal to the one specified

• GET http://gateway-ip/api/beacons/ibeacon/ uuid / major Returns a JSON containing the data related to all the beacons that transmit packages in iBeacon format with ProximityUUID and Major Number equal to those specified

• GET http://gateway-ip/api /beacons /ibeacon/ uuid / major / minor Returns a JSON containing the data related to all the beacons that transmit packages in iBeacon format with ProximityUUID, Major and Minor Number equal to those specified

• GET http://gateway-ip/api/beacons/eddystoneReturns a JSON containing the data related to all the beacons that transmit packages in Eddystone format (any frame)

• GET http://gateway-ip/api/beacons/eddystone/uidReturns a JSON containing data for all beacons that transmit packages in Eddystone-UID format

• GET http://gateway-ip/api/beacons/eddystone/uid/ namespace Returns a JSON containing the data related to all the beacons that transmit packages in Eddystone-UID format with NamespaceId equal to the one specified

• GET http://gateway-ip/api/beacons/eddystone/uid/ namespace / instance Returns a JSON containing the data related to all the beacons that transmit packages in Eddystone-UID format with NamespaceId and InstanceId equal to those specified

BlueUp S.r.l.s. - 2018 V1.0– 26/06/2018 24/28

Page 25: User manual - BlueUp · 2018. 6. 26. · BlueUp S.r.l.s. Loc. Belvedere, Ingresso 2, 53034 Colle di Val d'Elsa (SI) - ITALY Ph. 347 4123206, Fax 0577 043101 E-mail: info@blueupbeacons.com,

• GET http://gateway-ip/api/beacons/eddystone/urlReturns a JSON containing data for all beacons that transmit packages in Eddystone-URL format

• GET http://gateway-ip/api/beacons/eddystone/url/ url Return a JSON containing the data related to all the beacons that transmit packages in Eddystone-URL format with URL equal to the one specified

• GET http://gateway-ip/api/beacons/eddystone/tlmReturns a JSON containing data for all beacons that transmit packages in Eddystone-TLM format

• GET http://gateway-ip/api/beacons/eddystone/eidReturns a JSON containing data for all beacons that transmit packages in Eddystone-EID format

• GET http://gateway-ip/api/beacons/quuppaReturns a JSON containing the data related to all the beacons that transmit packages in Quuppa format

• GET http://gateway-ip/api/beacons/quuppa/ tagid Returns a JSON containing the data related to all the beacons that transmit packetsin Quuppa format with TagId equal to the one specified

• GET http://gateway-ip/api/beacons/sensorReturns a JSON containing data related to all the beacons that transmit packages in BlueUp Sensor format

• GET http://gateway-ip/api/beacons/blueupReturn a JSON containing the data related to all the beacons that transmit packages in BlueUp format

• GET http://gateway-ip/api/beacons/blueup / model Return a JSON containing the data related to all the beacons that transmit packages in BlueUp format with Model Number equal to the one specified

• GET http://gateway-ip/api/beacons/blueup/ model / serial Returns a JSON containing the data related to all the beacons that transmit packages in BlueUp format with Model and Serial Number equal to those specified

• GET http://gateway-ip/api/beacons/blueup/ model / serial /status Returns a JSON containing data relating to the status of any running or already completed tasks on the specified beacon

• GET http://gateway-ip/api/beacons/blueup/ model / serial /info Returns a JSON containing the data related to the device information of the specified beacon (this call returns null, if before the read has not been called on the same beacon)

• GET http://gateway-ip/api/beacons/blueup/ model / serial /configuration Returns a JSON containing the data related to the configuration of the specified

BlueUp S.r.l.s. - 2018 V1.0– 26/06/2018 25/28

Page 26: User manual - BlueUp · 2018. 6. 26. · BlueUp S.r.l.s. Loc. Belvedere, Ingresso 2, 53034 Colle di Val d'Elsa (SI) - ITALY Ph. 347 4123206, Fax 0577 043101 E-mail: info@blueupbeacons.com,

beacon (this call returns null, if before the read has not been called on the same beacon)

• POST http://gateway-ip/api/beacons/blueup/ model / serial /configuration/ read ◦ BODY

{"unlock" : "md5-of your-beacon-password"

}Used for reading the GATT of a BlueUp beacon.

• Returns a JSON containing the data related to the read-task scheduled on the beacon.

• POST http://gateway-ip/api/beacons/blueup/ model / serial /configuration/write ◦ BODY

{"unlock": "md5-of your-beacon-password","configuration": {

"slots" : {

"eddystone": [

{"index": 0,"advertisingInterval": 500,"radioTxPower": 4,"uid": "12345678901234567890123456789012"

},{

"index": 1,"advertisingInterval": 700,"radioTxPower": -8,"url": "https://stackoverflow.com"

},{

"index": 2,"advertisingInterval": 2000,"radioTxPower": 0,"tlm": {}

},{

"index" : 3,"unset" : true

}],"others": [

{"index": 0,"advertisingInterval": 400,"radioTxPower": 4,"ibeacon": {

"uuid": "12345678901234567890123456789012","major": 1,"minor": 1

}},{

BlueUp S.r.l.s. - 2018 V1.0– 26/06/2018 26/28

Page 27: User manual - BlueUp · 2018. 6. 26. · BlueUp S.r.l.s. Loc. Belvedere, Ingresso 2, 53034 Colle di Val d'Elsa (SI) - ITALY Ph. 347 4123206, Fax 0577 043101 E-mail: info@blueupbeacons.com,

"index" : 1,"unset" : true

},{

"index" : 2,"unset" : true

},{

"index" : 3,"unset" : true

}]

}}

}Used for writing the GATT of a BlueUp beacon.Returns a JSON containing the data related to the write-task scheduled on the beacon or an error in case of invalid parameters.

All GET calls can use the string on the RSSI on the query string, specifying the rssimin and rssimax parameters.By specifying rssimin = x on the query string, all beacons with RSSI less than x will be filtered, while specifying rssimax = y, all beacons with RSSI greater than y will be filtered. You can use both the rssimin and rssimax values to filter the beacons within a specific RSSI range, for example: rssimin=-60&rssimax=-55, it will only display the beacons that have RSSI ≥ -60 and RSSI ≤ - 55, ie in the range [-55, -60].

BlueUp S.r.l.s. - 2018 V1.0– 26/06/2018 27/28

Page 28: User manual - BlueUp · 2018. 6. 26. · BlueUp S.r.l.s. Loc. Belvedere, Ingresso 2, 53034 Colle di Val d'Elsa (SI) - ITALY Ph. 347 4123206, Fax 0577 043101 E-mail: info@blueupbeacons.com,

Warranty

The company BlueUp S.r.l.s. guarantees its products for a period of 12 months from dateof purchase. The purchase must be verified with a valid receipt issued by the dealer (ie.sales receipt, invoice). In addition, the defective product must be accompanied by adescription of the type of malfunction. The warranty covers defects of conformity and/ormanufacturing defects.BlueUp S.r.l.s. may, at its sole discretion, replace the defective product or have it repaired.The costs for shipping the product to BlueUp S.r.l.s. shall be borne by the buyer. In case ofan effective detection of defeccts of conformity and / or manufacturing defects the cost ofshipping the product are borne by BlueUp S.r.l.s.. In case of non-detection of defects ofconformity and / or manufacturing defects or if the functional defects complained of by theuser are not detected as such under verification by BlueUp S.r.l.s., all costs, including therepair or replacement of the product and its subsequent delivery, will be borne by thebuyer.This warranty does not cover the following cases:

1. product used or stored improperly;2. damage caused by water or moisture;3. physical and / or electrical related to intentional, negligent or accidental acts;4. damage caused by force majeure (eg. weather, electrical noise, ...);5. a state of neglect of the product;6. damage caused by mechanical, electrical, electronic or software changes made to

the product.Moreover, the warranty does not cover accessories, such as batteries or power supplies.

In no event BlueUp S.r.l.s. be liable for incidental or consequential damages, including anylost profits or other economic damages resulting from the use of its products.

Contacts

BlueUp S.r.l.s.Loc. Belvedere, Ingresso 2IT-53034 Colle di Val d'Elsa (SI) - ITALYE-mail: [email protected]: www.blueupbeacons.com

BlueUp S.r.l.s. - 2018 V1.0– 26/06/2018 28/28