abstract-things/sensors/contact.js

Base for building libraries that interact with physical things, such as IoT-devices

'use strict';

const Thing = require('../thing');
const Sensor = require('./sensor');
const { boolean } = require('../values');

module.exports = Thing.mixin(Parent => class extends Parent.with(Sensor) {
	static get capability() {
		return 'contact';
	}

	static availableAPI(builder) {
		builder.event('contactChanged')
			.type('boolean')
			.description('Change in detected contact')
			.done();

		builder.event('opened')
			.description('Contact sensor is open, contact has been lost')
			.done();

		builder.event('closed')
			.description('Contact sensor is closed, contact has been detected')
			.done();

		builder.action('contact')
			.description('Get if contact is currently detected')
			.getterForState('contact')
			.returns('boolean', 'Current contact status')
			.done();
	}

	get sensorTypes() {
		return [ ...super.sensorTypes, 'contact' ];
	}

	contact() {
		return this.value('contact');
	}

	isOpen() {
		return this.contact()
			.then(v => ! v);
	}

	isClosed() {
		return this.contact();
	}

	updateContact(contact) {
		contact = boolean(contact);
		if(this.updateValue('contact', contact)) {
			if(contact) {
				// Emit the closed event if contact is true
				this.emitEvent('closed');
			} else {
				// Emit the opened event if contact is false
				this.emitEvent('opened');
			}
		}
	}
});