Dev_Switch.h

/**
 * @file Dev_Switch.h
 *
 * Switch API of IoTgo (iotgo.iteadstudio.com)
 *
 * @author  Wu Pengfei (email:<pengfei.wu@itead.cc>)
 * @date    2014/11/11
 * @copyright 
 * Copyright (C) 2013-2014 ITEAD Intelligent Systems Co., Ltd. \n
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License as
 * published by the Free Software Foundation; either version 2 of
 * the License, or (at your option) any later version.
 */
 
#ifndef __DEV_SWITCH_H__
#define __DEV_SWITCH_H__

#include "IoTgo.h"

/**
 * @addtogroup Switch
 * @{
 */

/**
 * Indicates the state of switch device. 
 */
enum SwitchState
{
    SWITCH_STATE_OFF   = 0, /**< switch off */
    SWITCH_STATE_ON    = 1, /**< switch on */
};


/**
 * Switch, subclass of IoTgo, provides simple methods to control switch device. 
 * 
 */
class Switch: public IoTgo
{
public: /* public methods */  
    Switch(NetInterface *net, uint16_t sw_pin);
    
    int32_t sync(void);
    int32_t getState(int32_t *state);
    int32_t on(void);
    int32_t off(void); 
    
private: /* private methods */
    int32_t setState(int32_t state);
    
private: /* private static data members */
    static const char *STATE[];
    static const char *VALUE_ON[];
    static const char *VALUE_OFF[];
    
private:
    uint16_t sw_pin;
};

/** @} */

#endif /* #ifndef __DEV_SWITCH_H__ */