maxcube-window
v1.0.2
Published
eQ-3 Max! Cube interface
Downloads
3
Readme
maxcube
eQ-3 Max! Cube interface library.
For a cli, see maxcube-cli. If you want to integrate your MAX! Cube in node-red, use node-red-node-maxcube.
Example
var MaxCube = require('maxcube-window');
var myMaxCube = new MaxCube('192.168.1.123', 62910);
myMaxCube.on('connected', function () {
console.log('Connected');
myMaxCube.getDeviceStatus().then(function (payload) {
console.log(payload);
myMaxCube.close();
});
});
myMaxCube.on('closed', function () {
console.log('Connection closed');
});
Events
- connected
- closed
API
getConnection()
Returns a promise for an active connection.
myMaxCube.getConnection().then(function () {
..
});
close()
Closes the connection to the Max! Cube immediately (when active).
getCommStatus()
Returns the last known communication status (duty cycle & free memory slots).
getDevices()
Returns devices (from cache).
getDeviceInfo()
Returns device info (from cache).
getRooms()
Returns room info (from cache).
getDeviceStatus([rf_address])
Returns a promise with device status of all or specified devices.
myMaxCube.getDeviceStatus().then(function (devices) {
devices.forEach(function (device) {
var deviceInfo = myMaxCube.getDeviceInfo(device.rf_address);
console.log(deviceInfo.device_name + ', ' + deviceInfo.room_name);
console.log(' temperature: ' + device.temp);
console.log(' setpoint: ' + device.setpoint);
console.log(' valve: ' + device.valve);
console.log(' mode: ' + device.mode);
});
});
setTemperature(rf_address, degrees, (optional) mode, (only for vacation mode) untilDate)
Set setpoint temperature for specified device and returns a promise.
Possible modes are: 'AUTO', 'MANUAL', 'BOOST' and 'VACATION'. If no mode is given, 'MANUAL' is presumed.
Format untilDate as ISO 8601, e.g. 2019-06-20T10:00:00Z.
myMaxCube.setTemperature('0dd6b5', 18).then(function (success) {
if (success) {
console.log('Temperature set');
} else {
console.log('Error setting temperature');
}
});
Related projects
- maxcube-cli: a command-line interface for eQ-3 Max! Cube
- node-red-node-maxcube: a node for interfacing the eQ-3 Max! Cube using node-red