Skip to content
Snippets Groups Projects
usbdevice.h 2.01 KiB
Newer Older
  • Learn to ignore specific revisions
  • /*
     * Abstract base class for USB-attached devices.
     * 
     * Copyright (c) 2013 Micah Elizabeth Scott
     * 
     * 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 "rapidjson/document.h"
    #include "opcsink.h"
    #include <libusb.h>
    #include <string>
    
    
    class USBDevice
    {
    public:
    	typedef rapidjson::Value Value;
    
    	USBDevice(libusb_device *device, bool verbose);
        virtual ~USBDevice();
    
        // Must be opened before any other methods are called.
        virtual int open() = 0;
    
        // Check a configuration. If it describes this device, load it and return true. If not, return false.
        virtual bool matchConfiguration(const Value &config) = 0;
    
     	// Handle an incoming OPC message
        virtual void writeMessage(const OPCSink::Message &msg) = 0;
    
        // Write color LUT from parsed JSON
    	virtual void writeColorCorrection(const Value &color);
    
        virtual std::string getName() = 0;
        libusb_device *getDevice() { return mDevice; };
    
    protected:
        libusb_device *mDevice;
        libusb_device_handle *mHandle;
    	bool mVerbose;
    };