Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/maxnowack/node-eq3ble
node.js package to control an EQ3 bluetooth thermostat
https://github.com/maxnowack/node-eq3ble
bluetooth eq3-bluetooth-thermostat heating home-automation nodejs temperature thermostat
Last synced: 4 days ago
JSON representation
node.js package to control an EQ3 bluetooth thermostat
- Host: GitHub
- URL: https://github.com/maxnowack/node-eq3ble
- Owner: maxnowack
- License: gpl-3.0
- Created: 2016-11-04T09:50:22.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2022-12-07T01:28:59.000Z (almost 2 years ago)
- Last Synced: 2024-04-14T02:18:15.102Z (7 months ago)
- Topics: bluetooth, eq3-bluetooth-thermostat, heating, home-automation, nodejs, temperature, thermostat
- Language: JavaScript
- Size: 408 KB
- Stars: 22
- Watchers: 7
- Forks: 8
- Open Issues: 12
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# EQ3BLE
node.js package to control an EQ3 bluetooth thermostat
## discovering
See the [noble-device discovering api](https://github.com/sandeepmistry/noble-device/#discovery-api) for more methods
````javascript
import EQ3BLE from 'eq3ble'
EQ3BLE.discover((device) => {
device.connectAndSetup().then(() => {
// ...
})
})
````
## methods
every method returns a promise to indicate the execution progress
### `getInfo()`
reads the device info. Returns an object like this:
````javascript
{
status: {
manual: Boolean, // manual mode activated
holiday: Boolean, // holiday mode activated
boost: Boolean, // boost active
dst: Boolean, // daylight saving time active
openWindow: Boolean, // window is opened
lowBattery: Boolean, // battery is low
},
valvePosition: Number, // 0-100 position of the valve
targetTemperature: Number // temperature visible on the display
}
````
### `setBoost(Boolean)`
activates or deactivates the boost
### `automaticMode()`
switch to automatic mode
### `manualMode()`
switch to manual mode
### `ecoMode()`
switch to eco / holiday mode
### `setLock(Boolean)`
activates or deactivates locking
### `turnOff()`
turns off heating / sets valve position to 0
### `turnOn()`
turns on heating / sets valve position to 100
### `setTemperature(Number)`
sets the temperature (valid values are 4.5 - 30)
### `setTemperatureOffset(Number)`
sets the temperature offset
### `updateOpenWindowConfiguration(temperature: Number, duration: Number)`
updates the window open configuration
### `setDateTime(Date)`
updates the date and time of the thermostat
## License
Licensed under GPLv3 license. Copyright (c) 2015 Max Nowack
## Contributions
Contributions are welcome. Please open issues and/or file Pull Requests.
## Maintainers
- Max Nowack ([maxnowack](https://github.com/maxnowack))