device.h

Go to the documentation of this file.

/***************************************************************************
 *   Copyright (C) 2009 by Rick L. Vinyard, Jr.                            *
 *   rvinyard@cs.nmsu.edu                                                  *
 *                                                                         *
 *   This file is part of the g13 library.                                 *
 *                                                                         *
 *   The g13 library is free software; you can redistribute it and/or      *
 *   modify it under the terms of the GNU General Public License           *
 *   version 3 as published by the Free Software Foundation.               *
 *                                                                         *
 *   The g13 library is distributed in the hope that it will be            *
 *   useful, but WITHOUT ANY WARRANTY; without even the implied warranty   *
 *   of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU   *
 *   General Public License for more details.                              *
 *                                                                         *
 *   You should have received a copy of the GNU General Public License     *
 *   along with this software. If not see <http://www.gnu.org/licenses/>.  *
 ***************************************************************************/
#ifndef G13MM_DEVICE_H
#define G13MM_DEVICE_H

#include <string>
#include <g13/udev.h>
#include <g13/leds.h>
#include <g13mm/pointer.h>

namespace G13 {

    typedef enum LED {
        LED_M1 = G13_LED_M1,
        LED_M2 = G13_LED_M2,
            LED_M3 = G13_LED_M3,
            LED_MR = G13_LED_MR,
    } LED;

    struct Color {
        Color(unsigned red=0, unsigned green=0, unsigned blue=0): r(red), g(green), b(blue) { }
        unsigned r;
        unsigned g;
        unsigned b;
    };
    
    class Device {
        protected:
            Device(g13_device* cobj);
        public:
            typedef G13Pointer<Device> pointer;

            static pointer create(g13_device* cobj);
            static pointer create(g13_list_entry* list_entry);
            static pointer create(const std::string& name);

            ~Device();

            std::string name();

            int set_name(const std::string& name);

            int led(int which);

            int set_led(int which, bool on=true);

            int set_m1(bool enabled=true);

            int set_m2(bool enabled=true);

            int set_m3(bool enabled=true);

            int set_mr(bool enabled=true);

            Color backlight();

            int set_backlight(const Color& color);

            int set_backlight(unsigned r, unsigned g, unsigned b);

            g13_device* cobj();

        protected:
            g13_device* m_cobj;
    };
    
}

#endif