Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
60 changes: 60 additions & 0 deletions bme280.d.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,60 @@
export type options = {
i2cBusNumber?: number,
i2cAddress?: number,
humidityOversampling?: OVERSAMPLE,
pressureOversampling?: OVERSAMPLE,
temperatureOversampling?: OVERSAMPLE,
filterCoefficient?: FILTER,
standby?: STANDBY,
forcedMode?: boolean
}

export type data = {
temperature: number,
pressure: number,
humidity: number
}

export enum OVERSAMPLE {
SKIPPED = 0,
X1 = 1,
X2 = 2,
X4 = 3,
X8 = 4,
X16 = 5
}

export enum FILTER {
OFF = 0,
F2 = 1,
F4 = 2,
F8 = 3,
F16 = 4
}

export enum STANDBY {
MS_0_5 = 0,
MS_62_5 = 1,
MS_125 = 2,
MS_250 = 3,
MS_500 = 4,
MS_1000 = 5,
MS_10 = 6,
MS_20 = 7
}

export function open(options?: options): Promise<Bme280>;

export class Bme280 {
constructor(bme280I2c: any);

public read(): Promise<data>;

public triggerForcedMeasurement(): Promise<void>;

public typicalMeasurementTime(): number;

public maximumMeasurementTime(): number;

public close(): Promise<void>;
}
1 change: 1 addition & 0 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
"version": "2.1.1",
"description": "I2C Driver for the BME280 humidity, pressure and temperature sensor",
"main": "bme280.js",
"typings": "bme280.d.ts",
"scripts": {
"lint": "jshint *.js examples/*.js test/*.js",
"test": "cd test && ./run-tests && cd .."
Expand Down