HidController.h

Go to the documentation of this file.

//-----------------------------------------------------------------------------
//
//  HidController.h
//
//  Cross-platform HID port handler
//
//  Copyright (c) 2010 Jason Frazier <frazierjason@gmail.com>
//
//  SOFTWARE NOTICE AND LICENSE
//
//  This file is part of OpenZWave.
//
//  OpenZWave is free software: you can redistribute it and/or modify
//  it under the terms of the GNU Lesser General Public License as published
//  by the Free Software Foundation, either version 3 of the License,
//  or (at your option) any later version.
//
//  OpenZWave 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 Lesser General Public License for more details.
//
//  You should have received a copy of the GNU Lesser General Public License
//  along with OpenZWave.  If not, see <http://www.gnu.org/licenses/>.
//
//-----------------------------------------------------------------------------
 
#ifndef _HidController_H
#define _HidController_H
 
#include <string>
#include "Defs.h"
#include "platform/Controller.h"
 
 
struct hid_device_;
 
typedef struct hid_device_ hid_device;
 
namespace OpenZWave
{
    class Driver;
    class Msg;
    class Thread;
    class Event;
 
    class HidController: public Controller
    {
    public:
        HidController();

        virtual ~HidController();

        bool SetVendorId( uint32 const _vendorId );

        bool SetProductId( uint32 const _productId );

        bool SetSerialNumber( string const& _serialNumber );

        bool Open( string const& _hidControllerName );

        bool Close();

        uint32 Write( uint8* _buffer, uint32 _length );
 
    private:
        bool Init( uint32 const _attempts );
        void Read();
 
        // helpers for internal use only

        int GetFeatureReport( uint32 _length, uint8 _reportId, uint8* _buffer );

        int SendFeatureReport( uint32 _length, const uint8* _data );
 
        static void ThreadEntryPoint( Event* _exitEvent, void* _context );
        void ThreadProc( Event* _exitEvent );
 
        hid_device*     m_hHidController;
        Thread*         m_thread;
        uint32              m_vendorId;
        uint32              m_productId;
        string              m_serialNumber;
        string          m_hidControllerName;
        bool            m_bOpen;
    };
 
} // namespace OpenZWave
 
#endif //_HidController_H