Skip to content

Commit b29110a

Browse files
committed
Publish references to Ruuvi Air
1 parent 7523a4b commit b29110a

File tree

3 files changed

+7
-7
lines changed

3 files changed

+7
-7
lines changed

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ Supports following Ruuvi [Data Formats](https://github.com/ruuvi/ruuvi-sensor-pr
2222
- Data Format 3: "RAW v1" (eg. older RuuviTag firmware)
2323
- Data Format 5: "RAW v2" (eg. current RuuviTag firmware)
2424
- Data Format 6: Bluetooth 4 compatible version of format E1
25-
- Data Format E1: "Extended v1" (eg. <redacted>)
25+
- Data Format E1: "Extended v1" (eg. Ruuvi Air)
2626

2727
Supports following data from the device (depending on hardware revision and firmware):
2828

@@ -37,8 +37,8 @@ Supports following data from the device (depending on hardware revision and firm
3737
- Measurement sequence number (Running counter incremented each time a new measurement is taken on the device)
3838
- PM 1.0/2.5/4.0/10.0 (µg/m³)
3939
- Carbon dioxide (ppm)
40-
- VOX index (unitless)
41-
- NOX index (unitless)
40+
- VOC index (unitless)
41+
- NOx index (unitless)
4242
- Illuminance (lux)
4343
- Sound levels (undocumented and currently not available on commercially available hardware revisions)
4444

config.sample.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ processing:
5656
# example the official Ruuvi Gateway).
5757
disable_formats:
5858
#- "6"
59-
# Flag to include unofficial data in the measurements. This is undocumented data that is included in some measurements sent by certain revisions of <redacted>
59+
# Flag to include unofficial data in the measurements. This is undocumented data that is included in some measurements sent by certain revisions of Ruuvi Air
6060
include_unofficial: false
6161

6262
# Supports both InfluxDB 1.8 and 2.x
@@ -106,7 +106,7 @@ prometheus:
106106
# Port to listen on. Cannot be the same as http listener port if enabled
107107
port: 8081
108108
# Prefix to add to the measurement metrics. Versions prior to v1.0.0 used a hardcoded "ruuvitag" as the prefix
109-
# v1.0.0 changed the default to "ruuvi" when support for <redacted> was added. Change this to "ruuvitag" if you want to retain the old prefix
109+
# v1.0.0 changed the default to "ruuvi" when support for Ruuvi Air was added. Change this to "ruuvitag" if you want to retain the old prefix
110110
measurement_metric_prefix: ruuvi
111111

112112
# Publish the parsed and processed data back to MQTT. Can be the same server or a different one.

parser/measurement.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ type BasicEnvironmentalData struct {
3131
MovementCounter *int64 `json:"movementCounter,omitempty"`
3232
}
3333

34-
// Air quality data, typically on <redacted>
34+
// Air quality data, typically on Ruuvi Air
3535
type AirQualityData struct {
3636
Pm1p0 *float64 `json:"pm1p0,omitempty"`
3737
Pm2p5 *float64 `json:"pm2p5,omitempty"`
@@ -49,7 +49,7 @@ type DiagnosticsData struct {
4949
CalibrationInProgress *bool `json:"calibrationInProgress,omitempty"`
5050
}
5151

52-
// Data not officially documented (eg. on format E1, transmitted by certain revisions of <redacted>)
52+
// Data not officially documented (eg. on format E1, transmitted by certain revisions of Ruuvi Air)
5353
type UnofficialData struct {
5454
SoundInstant *float64 `json:"soundInstant,omitempty"`
5555
SoundAverage *float64 `json:"soundAverage,omitempty"`

0 commit comments

Comments
 (0)