ozwinterface.hpp

/*
 * 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 "ozw.hpp"

namespace upm {

  class ozwInterface {
  public:

    ozwInterface(int nodeID);

    virtual ~ozwInterface();

    virtual void setDebug(bool enable);

    virtual void optionsCreate(std::string configPath="/etc/openzwave",
                               std::string userConfigDir="",
                               std::string cmdLine="")
    {
      m_instance->optionsCreate(configPath, userConfigDir, cmdLine);
    }

    virtual void optionAddInt(std::string name, int val)
    {
      m_instance->optionAddInt(name, val);
    }

    virtual void optionAddBool(std::string name, bool val)
    {
      m_instance->optionAddBool(name, val);
    }

    virtual void optionAddString(std::string name, std::string val,
                                 bool append)
    {
      m_instance->optionAddString(name, val, append);
    }

    virtual void optionsLock()
    {
      m_instance->optionsLock();
    }

    virtual void init(std::string devicePath, bool isHID=false);

    virtual void dumpNodes(bool all=false)
    {
      m_instance->dumpNodes(all);
    }

    virtual std::string getValueUnits(int index)
    {
      return m_instance->getValueUnits(m_nodeID, index);
    }

    virtual std::string getValueLabel(int index)
    {
      return m_instance->getValueLabel(m_nodeID, index);
    }

  protected:
    // also enable debugging in ozw
    bool m_debugging;

    // our target Device Node ID
    uint32_t m_nodeID;

    // a copy of the OZW singleton instance pointer.  This is used by
    // drivers to access underlying OZW facilities.
    OZW* m_instance;

    // are we initialized?
    bool m_initialized;

  private:
  };
}