{"id":24009523,"url":"https://github.com/harrydehix/vproweatherjs","last_synced_at":"2025-08-01T01:12:38.286Z","repository":{"id":57393948,"uuid":"380299935","full_name":"harrydehix/vproweatherjs","owner":"harrydehix","description":"javascript interface to the vproweather driver","archived":false,"fork":false,"pushed_at":"2021-07-23T10:47:15.000Z","size":10404,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-06-19T09:51:45.626Z","etag":null,"topics":["davis-vantage","vantage","vantage-pro","weather"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/harrydehix.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2021-06-25T16:45:10.000Z","updated_at":"2021-07-23T10:46:20.000Z","dependencies_parsed_at":"2022-08-27T11:10:20.704Z","dependency_job_id":null,"html_url":"https://github.com/harrydehix/vproweatherjs","commit_stats":null,"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"purl":"pkg:github/harrydehix/vproweatherjs","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/harrydehix%2Fvproweatherjs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/harrydehix%2Fvproweatherjs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/harrydehix%2Fvproweatherjs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/harrydehix%2Fvproweatherjs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/harrydehix","download_url":"https://codeload.github.com/harrydehix/vproweatherjs/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/harrydehix%2Fvproweatherjs/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":268152114,"owners_count":24204044,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-07-31T02:00:08.723Z","response_time":66,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["davis-vantage","vantage","vantage-pro","weather"],"created_at":"2025-01-08T03:59:30.989Z","updated_at":"2025-08-01T01:12:38.255Z","avatar_url":"https://github.com/harrydehix.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"🔴 This package has been deprecated. Use [vantjs](https://github.com/harrydehix/vantjs) instead. 🔴\n\n# vproweatherjs\nJavascript/Typescript interface to any Davis Vantage Pro weather station. Based on the [vproweather](https://github.com/bytesnz/vproweather) driver.\nOnly works on *unix devices.\n\n## Installation\n### 1. Driver ([vproweather](https://github.com/bytesnz/vproweather))\nThis small guide explains how to install and setup the vproweather driver that is a requirement for the `vproweatherjs` package. \n#### Step 1: Downloading the driver's source\n```sh\ngit clone https://github.com/bytesnz/vproweather\n```\n#### Step 2: Compiling the source\n```sh\nsudo apt install gcc make\ncd vproweather\nmake\n```\n#### Step 3: Testing the driver\nMake sure to test the commands the driver offers. No later than now, you should connect your Vantage Pro console to your *unix device serially.\nTo test the connection, you need the url (e.g. `/dev/ttyUSB0`) of your device.\n```sh\n./vproweather --help\n```\n#### Step 4: Installing the driver as globally available program (important!)\u003cbr\u003e\nThis should work for the most *unix devices.\n```sh\nsudo nano ~/.bashrc\n```\nAdd following to the end of the file:\n```sh\nexport PATH=\"/your/path/to/the/cloned/repository:$PATH\"\n```\nNow you should be able to access the vproweather globally via `vproweather`.\n### 2. Package\n```\nnpm install vproweatherjs\n```\n## Basic Usage\nAfter setting up the driver and installing the vproweatherjs package you are ready to connect seamlessly to your weather station in javascript/typescript!\n```javascript\nimport { SimpleVPDriver } from \"vproweatherjs\";\n\nasync function doDriverStuff(){\n  const driver = new SimpleVPDriver({\n      deviceUrl: \"/dev/ttyUSB0\" // replace with the url to your device\n  );\n\n  // access the currently measured weather data\n  const realtimeData = await driver.getRealtimeData();\n  console.log(realtimeData);\n  \n  // access the highs and lows\n  const highsAndLows = await driver.getHighsAndLows();\n  console.log(highsAndLows);\n  \n  // access the weather station's time\n  const weatherStationTime = await driver.getTime();\n  console.log(weatherStationTime);\n  \n  // synchronize the weather station's time to system time\n  await driver.synchronizeTime();\n  \n  // turn the weather station's background light on\n  await driver.setBackgroundLight(true);\n  \n  // access the weather station's model name\n  const modelName = await driver.getModelName();\n  console.log(modelName);\n}\n\ndoDriverStuff();\n```\n## Advanced Usage\nWith vproweatherjs, the weather data can also be refractored into a more readable structure.\nAdded to that there is a unit system that allows you to convert the weather data into any unit you want with minimal effort.\n```javascript\nimport { AdvancedVPDriver, Units, UnitConfig } from \"vproweatherjs\";\n\nasync function doDriverStuff(){\n  const driver = new AdvancedVPDriver({\n      deviceUrl: \"/dev/ttyUSB0\" // replace with the url to your device\n  );\n\n  // access the currently measured weather data in a more structured and unit flexible way\n  const realtimeData = await driver.getFlexibleRealtimeData();\n  realtimeData.applyUnits(new UnitConfig({\n      wind: Units.Wind.kmh,\n      temperature: Units.Temperature.celsius,\n      ...\n  }));\n  console.log(realtimeData.weatherData);\n  \n  // access the highs and lows in a more structured and unit flexible way\n  const highsAndLows = await driver.getFlexibleHighsAndLows();\n  highsAndLows.applyUnits(new UnitConfig({\n      preset: \"eu\",\n  }));\n  console.log(highsAndLows.weatherData);\n  \n  // access the weather station's time\n  const weatherStationTime = await driver.getTime();\n  console.log(weatherStationTime);\n  \n  // synchronize the weather station's time to system time\n  await driver.synchronizeTime();\n  \n  // turn the weather station's background light on\n  await driver.setBackgroundLight(true);\n  \n  // access the weather station's model name\n  const modelName = await driver.getModelName();\n  console.log(modelName);\n}\n\ndoDriverStuff();\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fharrydehix%2Fvproweatherjs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fharrydehix%2Fvproweatherjs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fharrydehix%2Fvproweatherjs/lists"}