Skip to content

High-level command implementation for Nefit Easy™ clients.

License

Notifications You must be signed in to change notification settings

mvgalen/nefit-easy-commands

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

28 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Nefit Easy™ commands

High-level command implementation for Nefit Easy™.

Please be considerate!

Use 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.

Installation

$ npm i nefit-easy-commands

API

Constructor

const NefitEasyClient = require('nefit-easy-commands');
const client          = NefitEasyClient({
  serialNumber   : NEFIT_SERIAL_NUMBER,
  accessKey      : NEFIT_ACCESS_KEY,
  password       : NEFIT_PASSWORD,
[ requestTimeout : Number ]
});

Current status

client.status() : Promise

Current pressure

client.pressure() : Promise

Known location for device

client.location() : Promise

Program data

client.program() : Promise

User mode

client.userMode() : Promise

Set user mode

client.setUserMode(value : String) : Promise

value should be one of manual/clock.

Set temperature

client.setTemperature(value : [Number|String]) : Promise

value can be prefixed with a specifier to conditionally set the temperature if it doesn't match the specifier.

Valid specifiers:

  • > : only set new temperature if it's larger then the currently set temperature;
  • < : only set new temperature if it's smaller than the currently set temperature;

Example: "Set the thermostat to 21°C, but only if it's not already set higher than that."

client.setTemperature('> 21').then(...)

About

High-level command implementation for Nefit Easy™ clients.

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • JavaScript 100.0%