Refactoring to fully promis-based API

climate/adjustable-fan-speed.js

@@ -29,8 +29,12 @@ module.exports = Thing.mixin(Parent => class extends Parent.with(FanSpeed) {
 	setFanSpeed(speed) {
 		speed = percentage(speed, true);
 
-		return this.changeFanSpeed(speed)
-			.then(() => super.fanSpeed());
+		try {
+			return Promise.resolve(this.changeFanSpeed(speed))
+				.then(() => super.fanSpeed());
+		} catch(ex) {
+			return Promise.reject(ex);
+		}
 	}
 
 	changeFanSpeed(speed) {

climate/adjustable-target-humidity.js

@@ -29,8 +29,12 @@ module.exports = Thing.mixin(Parent => class extends Parent.with(TargetHumidity)
 	setTargetHumidity(humidity) {
 		humidity = percentage(humidity, true);
 
-		return this.changeTargetHumidity(humidity)
-			.then(() => super.targetHumidity());
+		try {
+			return Promise.resolve(this.changeTargetHumidity(humidity))
+				.then(() => super.targetHumidity());
+		} catch(ex) {
+			return Promise.reject(ex);
+		}
 	}
 
 	changeTargetHumidity(humidity) {

climate/autonomous-cleaning.js

@@ -21,13 +21,21 @@ module.exports = Thing.mixin(Parent => class extends Parent.with(State, Cleaning
 	}
 
 	clean() {
-		return Promise.resolve(this.activateCleaning())
-			.then(() => null);
+		try {
+			return Promise.resolve(this.activateCleaning())
+				.then(() => null);
+		} catch(ex) {
+			return Promise.reject(ex);
+		}
 	}
 
 	stop() {
-		return Promise.resolve(this.deactivateCleaning())
-			.then(() => null);
+		try {
+			return Promise.resolve(this.deactivateCleaning())
+				.then(() => null);
+		} catch(ex) {
+			return Promise.reject(ex);
+		}
 	}
 
 	activateCleaning() {

climate/cleaning-state.js

@@ -53,8 +53,8 @@ module.exports = Thing.mixin(Parent => class extends Parent.with(ErrorState, Sta
 	/**
 	 * Get if thing is cleaning.
 	 */
-	get cleaning() {
-		return this.getState('cleaning');
+	cleaning() {
+		return Promise.resolve(this.getState('cleaning'));
 	}
 
 	updateCleaning(cleaning) {

climate/fan-speed.js

@@ -23,7 +23,7 @@ module.exports = Thing.mixin(Parent => class extends Parent.with(State) {
 	}
 
 	fanSpeed() {
-		return this.getState('fanSpeed');
+		return Promise.resolve(this.getState('fanSpeed'));
 	}
 
 	updateFanSpeed(fanSpeed) {

climate/spot-cleaning.js

@@ -17,8 +17,12 @@ module.exports = Thing.mixin(Parent => class extends Parent.with(State, Cleaning
 	}
 
 	spotClean() {
-		return Promise.resolve(this.activateSpotClean())
-			.then(() => null);
+		try {
+			return Promise.resolve(this.activateSpotClean())
+				.then(() => null);
+		} catch(ex) {
+			return Promise.reject(ex);
+		}
 	}
 
 	activateSpotClean() {

climate/target-humidity.js

@@ -23,7 +23,7 @@ module.exports = Thing.mixin(Parent => class extends Parent.with(State) {
 	}
 
 	targetHumidity() {
-		return this.getState('targetHumidity');
+		return Promise.resolve(this.getState('targetHumidity'));
 	}
 
 	updateTargetHumidity(target) {

common/autonomous-charging.js

@@ -17,8 +17,12 @@ module.exports = Thing.mixin(Parent => class extends Parent.with(State, Charging
 	}
 
 	charge() {
-		return Promise.resolve(this.activateCharging())
-			.then(() => null);
+		try {
+			return Promise.resolve(this.activateCharging())
+				.then(() => null);
+		} catch(ex) {
+			return Promise.reject(ex);
+		}
 	}
 
 	activateCharging() {

common/battery-level.js

@@ -33,8 +33,8 @@ module.exports = Thing.mixin(Parent => class extends Parent.with(State) {
 		this.updateState('batteryLevel', -1);
 	}
 
-	get batteryLevel() {
-		return this.getState('batteryLevel');
+	batteryLevel() {
+		return Promise.resolve(this.getState('batteryLevel'));
 	}
 
 	updateBatteryLevel(level) {

common/charging-state.js

@@ -45,7 +45,7 @@ module.exports = Thing.mixin(Parent => class extends Parent.with(State) {
 	 * Get if thing is charging.
 	 */
 	get charging() {
-		return this.getState('charging');
+		return Promise.resolve(this.getState('charging'));
 	}
 
 	updateCharging(charging) {

common/children.js

@@ -136,19 +136,8 @@ module.exports = Thing.mixin(Parent => class extends Parent {
 	/**
 	 * Get all of the children that are registered.
 	 */
-	get children() {
+	children() {
 		return this[childrenSymbol].values();
 	}
 
-	/**
-	 * Synchronize the children based on the given definitions. This will remove
-	 * any child that is not in the list of definitions and create new ones
-	 * for new definitions.
-	 *
-	 * @param {Iterable} defs
-	 * @param {Function} func
-	 */
-	syncChildren(defs, func) {
-
-	}
 });

common/error-state.js

@@ -30,11 +30,6 @@ module.exports = Thing.mixin(Parent => class extends Parent.with(State) {
 			.description('Get the current error state')
 			.returns('code', 'The current error state or null if no error')
 			.done();
-
-		builder.action('hasError')
-			.description('Get if the thing is in an error state')
-			.returns('boolean')
-			.done();
 	}
 
 	static get capability() {
@@ -51,7 +46,7 @@ module.exports = Thing.mixin(Parent => class extends Parent.with(State) {
 	 * Get if thing has an error.
 	 */
 	get error() {
-		return this.getState('error');
+		return Promise.resolve(this.getState('error'));
 	}
 
 	updateError(error) {

common/mode.js

@@ -61,13 +61,11 @@ module.exports = Thing.mixin(Parent => class extends Parent.with(State) {
 	/**
 	* Get or switch the mode of the appliance.
 	*
-	* @param {string} mode
-	*   optional mode to switch to
 	* @returns
 	*   string indicating the mode
 	*/
-	mode(mode=undefined) {
-		return this.getState('mode');
+	mode() {
+		return Promise.resolve(this.getState('mode'));
 	}
 
 	/**
@@ -84,8 +82,8 @@ module.exports = Thing.mixin(Parent => class extends Parent.with(State) {
 	/**
 	 * Get the available modes of the device.
 	 */
-	get modes() {
-		return this.getState('modes');
+	modes() {
+		return Promise.resolve(this.getState('modes'));
 	}
 
 	/**

common/power.js

@@ -49,7 +49,7 @@ module.exports = Thing.mixin(Parent => class extends Parent.with(State) {
 	*   boolean indicating the power level
 	*/
 	power() {
-		return this.getState('power');
+		return Promise.resolve(this.getState('power'));
 	}
 
 	/**

common/restorable-state.js

@@ -51,7 +51,7 @@ module.exports = Thing.mixin(Parent => class extends Parent.with(State) {
 		for(const property of this.restorableState) {
 			result[property] = this.state[property];
 		}
-		return result;
+		return Promise.resolve(result);
 	}
 
 	/**
@@ -60,8 +60,12 @@ module.exports = Thing.mixin(Parent => class extends Parent.with(State) {
 	 * @param {object} state
 	 */
 	setState(state) {
-		return Promise.resolve(this.changeState(state))
-			.then(() => this.state);
+		try {
+			return Promise.resolve(this.changeState(state))
+				.then(() => this.state);
+		} catch(ex) {
+			return Promise.reject(ex);
+		}
 	}
 
 	/**

common/state.js

@@ -3,6 +3,8 @@
 const Thing = require('../thing');
 const deepEqual = require('deep-equal');
 
+const state = Symbol('state');
+
 /**
  * State capability for things. Exposes a property named `state` to clients.
  *
@@ -35,7 +37,11 @@ module.exports = Thing.mixin(Parent => class extends Parent {
 	constructor(...args) {
 		super(...args);
 
-		this.state = {};
+		this[state] = {};
+	}
+
+	state() {
+		return Promise.resolve(this[state]);
 	}
 
 	/**
@@ -45,12 +51,12 @@ module.exports = Thing.mixin(Parent => class extends Parent {
 	 * @param {*} value
 	 */
 	updateState(key, value) {
-		if(deepEqual(this.state[key], value)) {
+		if(deepEqual(this[state][key], value)) {
 			// If the value has not changed, skip updating and emitting event
 			return false;
 		} else {
 			// Value has changed, update and queue event emittal
-			this.state[key] = value;
+			this[state][key] = value;
 			const event = {
 				key: key,
 				value: value
@@ -69,8 +75,8 @@ module.exports = Thing.mixin(Parent => class extends Parent {
 	 * @param {string} key
 	 */
 	removeState(key) {
-		const emitEvent = typeof this.state[key] !== 'undefined';
-		delete this.state[key];
+		const emitEvent = typeof this[state][key] !== 'undefined';
+		delete this[state][key];
 
 		if(emitEvent) {
 			const event = {
@@ -90,7 +96,7 @@ module.exports = Thing.mixin(Parent => class extends Parent {
 	 * @param {*} defaultValue
 	 */
 	getState(key, defaultValue=null) {
-		const value = this.state[key];
+		const value = this[state][key];
 		return typeof value === 'undefined' ? defaultValue : value;
 	}
 });

common/switchable-mode.js

@@ -58,11 +58,15 @@ module.exports = Thing.mixin(Parent => class extends Parent.with(Mode) {
 	* @param {string} mode
 	*/
 	setMode(mode) {
-		if(typeof mode === 'undefined') throw new Error('Mode must be specified');
-		mode = String(mode);
+		try {
+			if(typeof mode === 'undefined') throw new Error('Mode must be specified');
+			mode = String(mode);
 
-		return Promise.resolve(this.changeMode(mode))
-			.then(() => this.getState('mode'));
+			return Promise.resolve(this.changeMode(mode))
+				.then(() => this.getState('mode'));
+		} catch(ex) {
+			return Promise.reject(ex);
+		}
 	}
 
 	/**

common/switchable-power.js

@@ -77,10 +77,14 @@ module.exports = Thing.mixin(Parent => class extends Parent.with(Power, Restorab
 	 * @param {boolean} power
 	 */
 	setPower(power) {
-		power = boolean(power);
+		try {
+			power = boolean(power);
 
-		return Promise.resolve(this.changePower(power))
-			.then(() => this.power());
+			return Promise.resolve(this.changePower(power))
+				.then(() => this.power());
+		} catch(ex) {
+			return Promise.reject(ex);
+		}
 	}
 
 	togglePower() {

controllers/actions.js

@@ -58,8 +58,8 @@ module.exports = Thing.mixin(Parent => class extends Parent.with(State) {
 	 * Get the available actions for this controller. All of these actions
 	 * can be emitted.
 	 */
-	get actions() {
-		return this.getState('actions');
+	actions() {
+		return Promise.resolve(this.getState('actions'));
 	}
 
 	/**

docs/common/battery-level.rst

@@ -9,24 +9,28 @@ being charged.
 .. sourcecode:: js
 
 	if(thing.matches('cap:battery-level')) {
-		console.log('Current battery level:', thing.batteryLevel);
+		console.log('Current battery level:', await thing.batteryLevel());
 	}
 
 API
 ---
 
-.. js:attribute:: batteryLevel
+.. js:function:: batteryLevel()
 
 	Get the current battery level as a :doc:`percentage </values/percentage>`
 	between 0 and 100.
 
-	:returns: The battery level in percent.
+	:returns: Promise that resolves to the battery level in percent.
 
 	Example:
 
 	.. sourcecode:: js
 
-		const level = thing.batteryLevel;
+		thing.batteryLevel()
+			.then(level => ...)
+			.catch(...);
+
+		const level = await thing.batteryLevel();
 
 Events
 ------