ConsumerControl.h

Go to the documentation of this file.

/*
Copyright (c) 2014-2015 NicoHood
See the readme for credit to other people.

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.
*/

// Include guard
#pragma once

#include <Arduino.h>
#include "PluggableUSB.h"
#include "HID.h"
#include "HID-Settings.h"

typedef union {
  // Every usable Consumer key possible, up to 4 keys presses possible
  uint16_t keys[4];
  struct {
    uint16_t key1;
    uint16_t key2;
    uint16_t key3;
    uint16_t key4;
  };
} HID_ConsumerControlReport_Data_t;


class ConsumerControl_ {
 public:
  ConsumerControl_(void);
  void begin(void);
  void end(void);
  void write(uint16_t m);
  void press(uint16_t m);
  void release(uint16_t m);
  void releaseAll(void);

  // Sending is public in the base class for advanced users.
  void sendReport(void* data, int length);


 protected:
  HID_ConsumerControlReport_Data_t _report;
};
extern ConsumerControl_ ConsumerControl;