Ruuvi sensor module
Description
The "ruuvi" module connects via Bluetooth LE with the sensors of the company Ruuvi Innovations Ltd from Finland. The sensor types "RuuviTag Pro Sensor" and "RuuviTag Sensor" are supported. The following signal values are recorded by the smartCORE module from a sensor:
Name | Unit | Name in measurement data (OSF/MQTT) | Data type |
---|---|---|---|
Temperature | °C | <"name">.temperature | Float |
Humidity | % | <"name">.Humidity | Float |
Air pressure | hPa | <"name">.Pressure | Float |
Reception field strength indicator (RSSI) | dBm | <"name">.RSSI | Integer |
Battery voltage | V | <"name">.BatteryVoltage | Float |
Mac address of the sensor | - | <"name">.MacAddress | String |
Interfaces and protocols used
- Bluetooth LE
JSON configuration example (demo)
The following section shows a demo configuration of the module.
{
"modules": [
{
"config": {
"pollingIntervalMs": 2000,
"sensors": [
{
"mac": "C5:01:03:50:AF:9A",
"name": "Ruuvi.Motor"
},
{
"mac": "CB:9D:CB:4B:EB:A0",
"name": "Ruuvi.ventilation"
}
]
},
"factory": "ruuvi",
"module": "ruuvi"
}
],
"plugins": [
"ruuvi"
],
"timeout": 10000
}
The configuration results in the following signal names for the two sensors:
-
Ruuvi.Motor.Temperature
-
Ruuvi.Motor.Humidity
-
Ruuvi.Motor.RSSI
-
Ruuvi.Motor.Pressure
-
Ruuvi.Motor.MacAddress
-
Ruuvi.Motor.BatteryVoltage
-
Ruuvi.ventilation.temperature
-
Ruuvi.Ventilation.Humidity
-
Ruuvi.Ventilation.RSSI
-
Ruuvi.Ventilation.Pressure
-
Ruuvi.Ventilation.MacAddress
-
Ruuvi.ventilation.BatteryVoltage
Module parameters
Parameter Name | Required | Data Type | Meaningful Value Range | Default | Description |
---|---|---|---|---|---|
pollingIntervalMs | No | INT | 2000 (2 s) | Interval [ms] for the periodic production of the measured values. | |
sensors | yes | Array | List of sensors to be taken into account. Assigned based on the MAC address. |
Configuration "sensors"
Parameter Name | Required | Data Type | Description |
---|---|---|---|
mac | Yes | STRING | The mac address of the sensor. |
name | Yes | STRING | The name/identifier of the sensor, which is used as a prefix for all signal names (MQTT/Osf) of the sensor. |
Remote procedure call (RPC)
The module's RPC interface can be used to query which sensors are currently available or have been found via Bluetooth LE. A JSON structure is returned as the result.
The call has the following structure:
<"module">
:GetSensors
The result is as follows:
{
"result": 0,
"sensors": [
{
"mac": "CB:9D:CB:4B:EB:A0",
"name": "CB-9D-CB-4B-EB-A0",
"rssi": -88
},
{
"mac": "C5:01:03:50:AF:9A",
"name": "C5-01-03-50-AF-9A",
"rssi": -66
}
]
}
Example
Request: ruuvi:GetSensors
Response: <JSON structure>
Module information
Information | Value |
---|---|
Author | optiMEAS Measurement and Automation Systems GmbH |
since smartCORE | 2.6 |
Module type | Producer |
Dependencies | - |