Search…
⌃K
Links

index.html

Lifecycle: Beta. Last update 202<1-06-15. GW ESP32 Configuration

User interface

Ruuvi Gateway sets up a WiFi hotspot and a webserver that provides the user interface for configuration over HTTP. The user interface can be accessed in any major browser. To connect to the user interface connect to hotspot "RuuviGatewayXXXX" (it does not require a password). Once connected, open your browser and enter http://10.10.0.1 . After the initial configuration is complete, you will be able to access the gateway from the LAN in the same way.

Greeting window

Internet connection settings

Internet connection A) WiFi

In case if WiFi is hidden, you can enter WiFi SSID manually - this option is available under "Advanced settings":

Internet connection B) Ethernet

By default DHCP is enabled, so you don't need to configure anything else:
But you can always set the network settings manually, if necessary:
In the next step, Ruuvi Gateway will ask you to connect the Ethernet cable (but that's okay if it's already connected):
if the Ethernet cable has not been connected in 30 seconds, an error message will be displayed. In this case, you can go back and try again.

Software update

In this step Ruuvi Gateway check for software updates:
You can also install previous or beta versions of the software by providing the URL containing the required firmware. If you built your custom firmware, you can run HTTP-sever and provide the URL to your firmware binaries.
Here is an example of the software update process:
After the software update is completed, Ruuvi Gateway will be restarted in a few seconds, and the following page will be displayed:

Automatic configuration download

Ruuvi Gateway can automatically download its configuration from a remote server, you can enable this feature on this page:
You need to specify the base URL from where gw_cfg.json with the Gateway settings can be downloaded. After pressing the Download button, a new configuration will be downloaded, which completes the configuration process. After that, Ruuvi Gateway will periodically check for configuration updates and download them. The check period is set in the configuration file gw_cfg.json (Gateway configuration), which is downloaded from the server.
It is also possible to use basic HTTP authentication:
Or Bearer authentication (using a token):

Automatic updates

On this page, you can configure automatic software updates. By default, updates are automatically installed 2 weeks after release.
Under the "Advanced Settings", you can configure a schedule for installing updates - select weekdays and preferred timeslot:
If you would like to participate in beta testing the new releases, then you can choose the following option (in this case new versions will be installed immediately after the release):
Also, you can disable automatic software updating by switching to "Manual updates only" mode:

Access Settings from LAN

On this page, you can set access rules to Ruuvi Gateway from the local network. By default, the access is password protected using the default password (unique device ID which is printed on the bottom of Ruuvi Gateway).
It is also possible to access Ruuvi Gateway from LAN using bearer authentication with an API key (token):

Cloud Options

By default, Ruuvi Gateway sends accumulated messages from Bluetooth sensors (HTTP: Time-stamped data from Bluetooth-sensors) and some statistics (HTTP: Gateway status) to Ruuvi Cloud:
But you can change the cloud options under the "Advanced Settings":

Backend A) HTTP(S)

You can enable or disable sending data via HTTP/HTTPS and specify the address of your own server:

Backend B) MQTT

Also, you can enable relaying data to MQTT server:

Backend C) Statistics

It is also possible to disable sending statistics or changing the server address:

Time Synchronization Options

In case the standard set of NTP servers is not accessible, then you can provide addresses of other NTP servers or use DHCP to get a list of NTP servers automatically. If Ruuvi Gateway does not have access to the Internet and NTP, then you can disable time synchronization, but in this case, relayed messages will not contain timestamps.

Bluetooth Scanning Settings

By default, Ruuvi Gateway scans only for Ruuvi sensors (filtered by BLE SIG member ID 0x0499)
Scan PHY Modulations to scan with. Coded PHY is also known as BLE Long Range. Most of existing devices send only on 1 MBit / s PHY. Modulations are scanned in sequence, so scanning both PHYs leads to at least 50 % packet loss on other PHY.
Scan extended payloads Both coded PHY and 1 MBit / s phy may have a primary advertisement which tells that there is going to be extended data on a secondary channel. If enabled, the secondary payload is scanned. Coded PHY supports only Coded extended payload, 1 Mbit / s PHY supports scanning at 2 Mbit / s and 1 Mbit / s PHY extended payloads.
Scan channel Each enabled BLE channel is scanned in sequence for at least 7000 ms per channel, for a total of 21000 ms if all 3 channels are enabled. At least one channel must be enabled.

Configuration completion