{"id":18665333,"url":"https://github.com/robertklep/nefit-easy-commands","last_synced_at":"2025-04-11T22:31:06.893Z","repository":{"id":3340427,"uuid":"49135916","full_name":"robertklep/nefit-easy-commands","owner":"robertklep","description":"High-level command implementation for Nefit Easy™ clients.","archived":false,"fork":false,"pushed_at":"2023-03-04T02:40:04.000Z","size":90,"stargazers_count":13,"open_issues_count":8,"forks_count":4,"subscribers_count":7,"default_branch":"master","last_synced_at":"2025-04-10T01:53:18.368Z","etag":null,"topics":["bosch","home-automation","nefit-easy","node"],"latest_commit_sha":null,"homepage":null,"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/robertklep.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null}},"created_at":"2016-01-06T13:10:43.000Z","updated_at":"2024-11-10T16:56:22.000Z","dependencies_parsed_at":"2023-01-13T12:26:46.793Z","dependency_job_id":null,"html_url":"https://github.com/robertklep/nefit-easy-commands","commit_stats":null,"previous_names":[],"tags_count":28,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/robertklep%2Fnefit-easy-commands","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/robertklep%2Fnefit-easy-commands/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/robertklep%2Fnefit-easy-commands/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/robertklep%2Fnefit-easy-commands/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/robertklep","download_url":"https://codeload.github.com/robertklep/nefit-easy-commands/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248489550,"owners_count":21112600,"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":["bosch","home-automation","nefit-easy","node"],"created_at":"2024-11-07T08:27:13.838Z","updated_at":"2025-04-11T22:31:06.432Z","avatar_url":"https://github.com/robertklep.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Nefit Easy™ commands\n\nHigh-level command implementation for Nefit Easy™.\n\n## Please be considerate!\n\nUse this library in moderation: don't flood the backend with new connections made every X seconds. Instead, if you want to poll the backend for data, create a connection once and reuse it for each command. In the end, it's your own responsibility to not get blocked because of excessive (ab)use.\n\n## Installation\n\n```\n$ npm i nefit-easy-commands\n```\n\n## API\n\n#### Constructor\n\n```\nconst NefitEasyCommands = require('nefit-easy-commands');\nconst client            = NefitEasyCommands({\n  serialNumber   : NEFIT_SERIAL_NUMBER,\n  accessKey      : NEFIT_ACCESS_KEY,\n  password       : NEFIT_PASSWORD,\n[ requestTimeout : Number ]\n});\n```\n\n#### Current status\n\n```\nclient.status([skipOutdoorTemperature]) : Promise\n```\n\nIf `skipOutdoorTemperature` is `true`, the client won't make an extra request to retrieve the current outdoor temperature.\n\n#### Current pressure\n\n```\nclient.pressure() : Promise\n```\n\n#### Hot water supply state\n\n```\nclient.hotWaterSupply() : Promise\n```\n\n#### Known location for device\n\n```\nclient.location() : Promise\n```\n\n#### Program data\n\n```\nclient.program() : Promise\n```\n\n#### User mode\n\n```\nclient.userMode() : Promise\n```\n\n#### Set hot water supply state\n\n```\nclient.setHotWaterSupply(value : String) : Promise\n```\n\n`value` should be one of `on`/`off`.\n\n#### Set user mode\n\n```\nclient.setUserMode(value : String) : Promise\n```\n\n`value` should be one of `manual`/`clock`.\n\n#### Set temperature\n\n```\nclient.setTemperature(value : [Number|String]) : Promise\n```\n\n`value` can be prefixed with a specifier to add a bit of logic to changing the setpoint.\n\nThe specifier can contain a base for relative changes:\n* `setpoint` : this is the current target temperature;\n* `in house temp` : this is the current measured temperature;\n\nValid specifiers:\n* `\u003e VALUE` : only change setpoint to \"VALUE\" if it's larger than the current setpoint;\n* `\u003c VALUE` : only change setpoint to \"VALUE\" if it's smaller than the current setpoint;\n* `setpoint + VALUE` : increase the setpoint by \"VALUE\"\n* `setpoint - VALUE` : decrease the setpoint by \"VALUE\"\n* `in house temp + VALUE` : change the setpoint to in house temperature + \"VALUE\" \n* `in house temp - VALUE` : change the setpoint to in house temperature - \"VALUE\" \n\nExamples:\n* _\"Set the thermostat to 21°C, but only if it's not already set higher than that.\"_\n\n```\nclient.setTemperature('\u003e 21').then(...)\n```\n\n* _\"Increase the setpoint by 2.5°C\"_\n\n```\nclient.setTemperature('setpoint + 2.5').then(...)\n```\n\n* _\"Set the setpoint to the current in house temperature and add 2.5°C\"_\n\n```\nclient.setTemperature('in house temp + 2.5').then(...)\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frobertklep%2Fnefit-easy-commands","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Frobertklep%2Fnefit-easy-commands","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frobertklep%2Fnefit-easy-commands/lists"}