openhab/src/things.js

JavaScript Library for openHAB Automation

const osgi = require('./osgi');
const utils = require('./utils');

const thingRegistry = osgi.getService('org.openhab.core.thing.ThingRegistry');
const thingMgr = osgi.getService('org.openhab.core.thing.ThingManager');

const ThingUID = Java.type('org.openhab.core.thing.ThingUID');

/**
 * Things namespace.
 * This namespace handles querying and editing openHAB Things.
 *
 * @namespace things
 */

/**
 * Class representing an openHAB Thing
 *
 * @memberof things
 */
class Thing {
  /**
   * Create a Thing, wrapping a native Java openHAB Thing. Don't use this constructor, instead call {@link getThing}.
   * @param {HostThing} rawThing Java Thing from Host
   * @hideconstructor
   */
  constructor (rawThing) {
    if (typeof rawThing === 'undefined') {
      throw Error('Supplied Thing is undefined');
    }
    /**
     * raw Java Thing
     * @type {HostThing}
     */
    this.rawThing = rawThing;
  }

  /**
   * Thing's bridge UID as `string` or `null` if the Thing has no bridge
   * @type {string|null}
   */
  get bridgeUID () {
    try {
      return this.rawThing.getBridgeUID().toString();
    } catch (error) {
      // Thing has no bridge
      return null;
    }
  }

  /**
   * Thing's label
   * @type {string}
   */
  get label () {
    return this.rawThing.getLabel();
  }

  /**
   * Physical location
   * @type {string}
   */
  get location () {
    return this.rawThing.getLocation();
  }

  /**
   * Thing stattus
   * @type {string}
   */
  get status () {
    return this.rawThing.getStatus().toString();
  }

  /**
   * Thing status info (more detailed status text)
   * @type {string}
   */
  get statusInfo () {
    return this.rawThing.getStatusInfo().toString();
  }

  /**
   * Thing type UID
   * @type {string}
   */
  get thingTypeUID () {
    return this.rawThing.getThingTypeUID().toString();
  }

  /**
   * Thing UID
   * @type {string}
   */
  get uid () {
    return this.rawThing.getUID().toString();
  }

  /**
   * Whether the Thing is enabled or not
   * @type {boolean}
   */
  get isEnabled () {
    return this.rawThing.isEnabled();
  }

  /**
   * Set the label.
   * @param {string} label Thing label
   */
  setLabel (label) {
    this.rawThing.setLabel(label);
    thingRegistry.update(this.rawThing);
  }

  /**
   * Sets the physical location.
   * @param {string} location physical location of the Thing
   */
  setLocation (location) {
    this.rawThing.setLocation(location);
    thingRegistry.update(this.rawThing);
  }

  /**
   * Sets the property value for the property identified by the given name.
   * @param {string} name name of the property
   * @param {string} value value for the property
   */
  setProperty (name, value) {
    this.rawThing.setProperty(name, value);
    thingRegistry.update(this.rawThing);
  }

  /**
   * Sets the enabled status of the Thing.
   * @param {boolean} enabled whether the Thing is enabled or not
   */
  setEnabled (enabled) {
    thingMgr.setEnabled(this.rawThing.getUID(), enabled);
  }

  toString () {
    return this.rawThing.toString();
  }
}

/**
 * Gets an openHAB Thing.
 * Returns `null` if no Thing with the given UID exists.
 *
 * @memberof things
 * @param {string} uid UID of the thing
 * @returns {Thing|null} {@link things.Thing}
 */
function getThing (uid) {
  const rawThing = thingRegistry.get(new ThingUID(uid));
  if (rawThing === null) return null;
  return new Thing(rawThing);
}

/**
 * Gets all openHAB Things.
 *
 * @memberof things
 * @returns {Thing[]} {@link things.Thing}[]: all Things
 */
function getThings () {
  return utils.javaSetToJsArray(thingRegistry.getAll()).map(t => new Thing(t));
}

module.exports = {
  Thing,
  getThing,
  getThings
};