ozw: Rework and add some device specific drivers and examples.

This commit reworks ozw somewhat and adds some device specific drivers
with examples.  All of these drivers are kept in the UPM ozw library.

The OZW class has been reworked to make it a proper singleton, since
the OpenZWave::Manager() it depends on is already a singleton.  This
avoids issues such as opening and initializing OpenZWave multiple
times.

A new, relatively thin base class, ozwInterface is also now present.
This class wraps some basic functionality, and handles initialization
of the OZW base class.  It is intended to be inherited by device
driver classes.  It operates on a node id for a device.  Each OZW
device is referenced by a node id, which does not change unless the
device is removed (and possibly re-added) to a Z-Wave network.

Finally, a series of device specific drivers have been implemented.
These provide basic functionality to monitor and in some cases control
the operation of a Z-Wave device.  They are the following:

ozwdump - This is a fake 'device' driver that initializes an OZW
network and dumps information on all of the nodes (devices) present.
Along with each node, available information on each valueid associated
with that node is also printed.  This fake device and it's examples
replace the original ozw example.

aeotecss6 - Aeotec Smart Switch 6.  This device allows control of the
switch, as well as reporting of information the switch makes
available, such as current consumption, volts, watts, and accumulated
energy use (kWh).

aeotecsdg2 - Aeotec Smart Dimmer Gen 2.  This device is similar to the
Smart Switch 6, but also provides dimming functionality.  It also
provides information on energy use.

aeotecdw2e - Aeotec Door/Window Sensor 2nd Edition.  This device is a
magnetic switch with an embedded tamper switch used to detect the
opening/closing of windows and doors.  This is a battery powered
device.

aeotecdsb09104 - Aeotec Home Energy Monitor.  This device is intended
to be installed at the MAINS or Breaker box.  It reports current and
cumulative energy consumption.

tzemt400 - Trane TZEMT400 Thermostat.  This device is a thermostat
with Z-Wave functionality.  The variant tested was the
TZEMT400BB32MAA.  The driver reports various information on the status
of the thermostat, as well as the current measured temperature.

Signed-off-by: Jon Trulson <jtrulson@ics.com>

src/ozw/aeotecdw2e.hpp

@@ -0,0 +1,126 @@
+/*
+ * Author: Jon Trulson <jtrulson@ics.com>
+ * Copyright (c) 2016 Intel Corporation.
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining
+ * a copy of this software and associated documentation files (the
+ * "Software"), to deal in the Software without restriction, including
+ * without limitation the rights to use, copy, modify, merge, publish,
+ * distribute, sublicense, and/or sell copies of the Software, and to
+ * permit persons to whom the Software is furnished to do so, subject to
+ * the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be
+ * included in all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+ * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+ * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+ * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+ * LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+ * OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+ * WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+ */
+#pragma once
+
+#include <string>
+
+#include "ozwinterface.hpp"
+
+namespace upm {
+
+  /**
+   * @library ozw
+   * @comname UPM API for he Aeotec Door/Window Sensor 2nd Edition
+   * @altname DSB29
+   * @con uart
+   *
+   * @brief UPM API for Aeotec Door/Window Sensor 2nd Edition
+   *
+   * This module allows for monitoring certain elements of an Aeotec
+   * Door/Window Sensor 2nd Edition Z-Wave device.
+   *
+   * NOTE: This is a battery powered device that spends most of it's
+   * time sleeping (sort of like a cat). This means that on initial
+   * startup, there is not enough information known about the device
+   * to reliably query anything.  Use isDeviceAvailable() to test
+   * whether the device has responded to OZW's probe request before
+   * requesting information for it.
+   *
+   * The device information should become known once the device has
+   * awakened, either via it's configuration, or manually via the
+   * include button on the device.  By default the device will never
+   * wake on it's own, so you should use the openzwave control panel
+   * or similar software to configure a periodic wakeup time.
+   */
+
+  class AeotecDW2E : public ozwInterface {
+  public:
+
+    /**
+     * These values correspond to the index values of the given node
+     *
+     */
+    typedef enum : int {
+      INDEX_Alarm                      = 0, // alarm
+      INDEX_AlarmLevel                 = 2, // tamper switch
+      INDEX_BatteryLevel               = 3
+    } INDEX_VALUES_T;
+
+    /**
+     * AeotecDW2E constructor
+     *
+     * @param nodeID The ZWave node number of the device we are
+     * interested in.  Use the ozwdump example to see what nodes you
+     * have available.
+     */
+    AeotecDW2E(int nodeID);
+
+    /**
+     * AeotecDW2E Destructor
+     */
+    ~AeotecDW2E();
+
+    /**
+     * Returns true if the node (device) information has been
+     * received yet, false otherwise.  A sleeping node (like this
+     * device) will not be available for monitoring until all node
+     * info has been received.  This will occur once the device has
+     * been awakened and has responded to OZW's probe request.
+     *
+     * @return true if the node is available, false otherwise.
+     */
+    bool isDeviceAvailable();
+
+    /**
+     * Return the alarm value.  If the device is not available yet
+     * (see isDeviceAvailable()), false will always be returned.
+     *
+     * @return true if in the tripped state, false otherwise.
+     */
+    bool isAlarmTripped();
+
+    /**
+     * Return the alarm's tamper switch valu.  If the device is not
+     * available yet (see isDeviceAvailable()), false will always be
+     * returned.
+     *
+     * @return true if in the tripped state, false otherwise.
+     */
+    bool isTamperTripped();
+
+    /**
+     * Return the current bettery level of the sensor as a percentage.
+     * The number returned will be between 0-100.  If the device is
+     * not available yet (see isDeviceAvailable()), 0 will always be
+     * returned.
+     *
+     * @return The Battery power level.
+     */
+    int getBatteryLevel();
+
+
+  protected:
+  private:
+  };
+}