https://github.com/open-weather-vision/vantjs
platform-independent javascript/typescript interface to Davis Vantage Pro, Davis VantagePro 2 and Davis Vantage Vue
https://github.com/open-weather-vision/vantjs
davis-vantage davis-weather interface nodejs serialport typescript vantage vantage-pro vantage-pro2 vantage-vue weather weather-data weather-station
Last synced: 5 months ago
JSON representation
platform-independent javascript/typescript interface to Davis Vantage Pro, Davis VantagePro 2 and Davis Vantage Vue
- Host: GitHub
- URL: https://github.com/open-weather-vision/vantjs
- Owner: open-weather-vision
- Created: 2021-07-02T08:38:00.000Z (almost 5 years ago)
- Default Branch: main
- Last Pushed: 2025-03-19T09:07:07.000Z (over 1 year ago)
- Last Synced: 2025-10-21T21:52:32.092Z (8 months ago)
- Topics: davis-vantage, davis-weather, interface, nodejs, serialport, typescript, vantage, vantage-pro, vantage-pro2, vantage-vue, weather, weather-data, weather-station
- Language: TypeScript
- Homepage: https://open-weather-vision.github.io/vantjs/
- Size: 1.44 MB
- Stars: 8
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# vantjs
vantjs is a platform-independent javascript and typescript interface to the Davis Vantage Pro, Pro 2 and Vue. It works on any linux, windows or osx device!
# Features
- Getting **hourly, daily, monthly** and **yearly highs and lows** (read more [here](https://open-weather-vision.github.io/vantjs/classes/structures.HighsAndLows.html))
```ts
const highsAndLows = await station.getHighsAndLows();
console.log(
`Todays minimum temperature was ${highsAndLows.tempOut.day.low} °F!`
);
// Output: Today's minimum temperature was 25.3 °F!
console.log(
`The maximum rain rate in the current hour was ${highsAndLows.rainRate.hour} in/h!`
);
// Output: The maximum rain rate in the current hour was 0.2 in/h!
```
- Getting **realtime weather data** (read more [here](https://open-weather-vision.github.io/vantjs/classes/structures.DetailedRealtimeData.html))
```ts
const realtime = await station.getDetailedRealtimeData();
console.log(`Currently it's ${realtime.tempOut} °F!`);
// Output: Currently it's 45.2 °F!
console.log(
`The wind blows from ${realtime.windDir} with an average speed of ${realtime.windAvg10m} mph!`
);
// Output: The wind blows from SW with an average speed of 23.12 mph!
```
- **Converting** the weather data automatically to the **desired units**
```ts
const station = await WeatherStation.connect({
units: {
temperature: "°C",
wind: "km/h",
rain: "mm",
...
},
....
});
const realtime = await station.getDetailedRealtimeData();
console.log(`It's ${realtime.tempIn} °C`);
// Output: It's 23.1233 °C
```
- **Stable connection** management: On disconnect vantjs repeatedly tries to reconnect in the background, your application won't crash!
- and more (read the [docs](https://open-weather-vision.github.io/vantjs/index.html)!)
# Installation
```bash
npm install vantjs
```
# Getting Started
Read an introductory guide [here](/guides/1-getting-started.md).
Read a guide about realtime data containers [here](/guides/2-realtime-data-containers.md).
# Documentation
Read the full documentation [here](https://open-weather-vision.github.io/vantjs/).
# Community
This project is updated on demand. If you have discovered a bug or want to suggest a feature🚀, please create an issue [here](https://github.com/open-weather-vision/vantjs/issues/new/choose).