{"id":16782182,"url":"https://github.com/danielbayerlein/vallox-api","last_synced_at":"2025-03-22T00:31:29.818Z","repository":{"id":33973036,"uuid":"163693810","full_name":"danielbayerlein/vallox-api","owner":"danielbayerlein","description":"📚 API for Vallox ventilation units","archived":false,"fork":false,"pushed_at":"2024-03-01T06:37:18.000Z","size":301,"stargazers_count":14,"open_issues_count":4,"forks_count":9,"subscribers_count":9,"default_branch":"master","last_synced_at":"2024-10-14T07:44:46.997Z","etag":null,"topics":["api","iot","modbus","vallox","ventilation"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/danielbayerlein.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2018-12-31T19:46:24.000Z","updated_at":"2024-09-04T18:43:53.000Z","dependencies_parsed_at":"2024-03-01T07:45:21.729Z","dependency_job_id":null,"html_url":"https://github.com/danielbayerlein/vallox-api","commit_stats":{"total_commits":86,"total_committers":7,"mean_commits":"12.285714285714286","dds":0.5930232558139534,"last_synced_commit":"097e4305ef0cec763b342f05f97b79e6805aeb67"},"previous_names":[],"tags_count":5,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/danielbayerlein%2Fvallox-api","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/danielbayerlein%2Fvallox-api/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/danielbayerlein%2Fvallox-api/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/danielbayerlein%2Fvallox-api/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/danielbayerlein","download_url":"https://codeload.github.com/danielbayerlein/vallox-api/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":221820707,"owners_count":16886224,"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","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":["api","iot","modbus","vallox","ventilation"],"created_at":"2024-10-13T07:44:37.871Z","updated_at":"2024-10-28T11:20:35.581Z","avatar_url":"https://github.com/danielbayerlein.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# vallox-api\n\n[![npm version](https://badge.fury.io/js/%40danielbayerlein%2Fvallox-api.svg)](https://badge.fury.io/js/%40danielbayerlein%2Fvallox-api)\n[![Actions Status](https://github.com/danielbayerlein/vallox-api/workflows/CI/badge.svg)](https://github.com/danielbayerlein/vallox-api/actions)\n[![JavaScript Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://standardjs.com)\n[![Dependabot Status](https://api.dependabot.com/badges/status?host=github\u0026repo=danielbayerlein/vallox-api)](https://dependabot.com)\n\nAPI for [Vallox](https://www.vallox.com) ventilation units\n\n## Installation\n\n```bash\n# npm\nnpm install @danielbayerlein/vallox-api --save\n\n# Yarn\nyarn add @danielbayerlein/vallox-api\n```\n\n## Usage\n\n### `new Vallox(object{ip: string, port: int})`\n\nReturns the client instance.\n\n```javascript\nimport Vallox from '@danielbayerlein/vallox-api'\n\nconst client = new Vallox({ ip: '192.168.178.33', port: 80 })\n```\n\n[Example](./examples/getProfile.js)\n\n### `.PROFILES`\n\nReturns an object with the profile mapping.\n\n```javascript\nclient.PROFILES\n```\n\n[Example](./examples/getProfile.js)\n\n### `.getProfile()`\n\nReturns the current profile id.\n\n```javascript\nawait client.getProfile()\n```\n\n[Example](./examples/getProfile.js)\n\n### `.fetchMetric(string)`\n\nReturns the value of the metric key.\n\n```javascript\nawait client.fetchMetric('A_CYC_FAN_SPEED')\n```\n\n[Example](./examples/fetchMetric.js)\n\n### `.fetchMetrics(array[string])`\n\nReturns an array with the values if the metric keys.\n\n```javascript\nawait client.fetchMetrics([\n  'A_CYC_TEMP_EXHAUST_AIR',\n  'A_CYC_TEMP_OUTDOOR_AIR'\n])\n```\n\n[Example](./examples/fetchMetrics.js)\n\n### `.setProfile(int, int)`\n\nSets the profile.\n\n```javascript\n// Permanently AWAY profile\nawait client.setProfile(client.PROFILES.AWAY)\n\n// FIREPLACE mode for configured timeout\nawait client.setProfile(client.PROFILES.FIREPLACE)\n\n// FIREPLACE mode for 30 min\nawait client.setProfile(client.PROFILES.FIREPLACE, 30)\n```\n\n[Example](./examples/setProfile.js)\n\n### `.setValues(object{string: int})`\n\nSets the value for the metric key.\n\n```javascript\nawait client.setValues({\n  'A_CYC_HOME_SPEED_SETTING': 60\n})\n```\n\n[Example](./examples/setValues.js)\n\n## Supported units\n\n* ValloPlus 350 MV\n* ValloPlus 240-E MV\n* _Please add your tested unit_\n\n## Credits\n\n* [yozik04/vallox_websocket_api](https://github.com/yozik04/vallox_websocket_api)\n\n## Contributing\n\n1. Fork it\n2. Create your feature branch (`git checkout -b my-new-feature`)\n3. Commit your changes (`git commit -am 'Add some feature'`)\n4. Push to the branch (`git push origin my-new-feature`)\n5. Create new [Pull Request](../../pull/new/master)\n\n## Copyright\n\nCopyright (c) 2019-present Daniel Bayerlein. See [LICENSE](./LICENSE.md) for details.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdanielbayerlein%2Fvallox-api","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdanielbayerlein%2Fvallox-api","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdanielbayerlein%2Fvallox-api/lists"}