JaRuleConstants.h

/*
 * 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.
 *
 * This program 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 Library General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 *
 * JaRuleConstants.h
 * Constants used with Ja Rule devices.
 * Copyright (C) 2015 Simon Newton
 */

#ifndef LIBS_USB_JARULECONSTANTS_H_
#define LIBS_USB_JARULECONSTANTS_H_

#include <ola/Callback.h>
#include <ola/io/ByteString.h>
#include <ostream>

namespace ola {
namespace usb {

typedef enum {
  FLAGS_CHANGED_FLAG = 0x02,  
  MSG_TRUNCATED_FLAG = 0x04  
} JaRuleStatusFlags;

typedef enum {
  CONTROLLER_MODE,  
  RESPONDER_MODE,  
  SELF_TEST_MODE,  
} JaRulePortMode;

typedef enum {
  COMMAND_RESULT_OK,

  COMMAND_RESULT_MALFORMED,

  COMMAND_RESULT_SEND_ERROR,

  COMMAND_RESULT_QUEUE_FULL,

  COMMAND_RESULT_TIMEOUT,

  COMMAND_RESULT_CLASS_MISMATCH,

  COMMAND_RESULT_CANCELLED,

  COMMAND_RESULT_INVALID_PORT
} USBCommandResult;

typedef enum {
  JARULE_CMD_RESET_DEVICE = 0x00,
  JARULE_CMD_SET_MODE = 0x01,
  JARULE_CMD_GET_HARDWARE_INFO = 0x02,
  JARULE_CMD_RUN_SELF_TEST = 0x03,
  JARULE_CMD_SET_BREAK_TIME = 0x10,
  JARULE_CMD_GET_BREAK_TIME = 0x11,
  JARULE_CMD_SET_MARK_TIME = 0x12,
  JARULE_CMD_GET_MARK_TIME = 0x13,
  JARULE_CMD_SET_RDM_BROADCAST_TIMEOUT = 0x20,
  JARULE_CMD_GET_RDM_BROADCAST_TIMEOUT = 0x21,
  JARULE_CMD_SET_RDM_RESPONSE_TIMEOUT = 0x22,
  JARULE_CMD_GET_RDM_RESPONSE_TIMEOUT = 0x23,
  JARULE_CMD_SET_RDM_DUB_RESPONSE_LIMIT = 0x24,
  JARULE_CMD_GET_RDM_DUB_RESPONSE_LIMIT = 0x25,
  JARULE_CMD_SET_RDM_RESPONDER_DELAY = 0x26,
  JARULE_CMD_GET_RDM_RESPONDER_DELAY = 0x27,
  JARULE_CMD_SET_RDM_RESPONDER_JITTER = 0x28,
  JARULE_CMD_GET_RDM_RESPONDER_JITTER = 0x29,
  JARULE_CMD_TX_DMX = 0x30,
  JARULE_CMD_RDM_DUB_REQUEST = 0x40,
  JARULE_CMD_RDM_REQUEST = 0x41,
  JARULE_CMD_RDM_BROADCAST_REQUEST = 0x42,

  // Experimental / testing
  JARULE_CMD_ECHO = 0xf0,
  JARULE_CMD_GET_FLAGS = 0xf2,
} CommandClass;

typedef enum {
  RC_OK,  
  RC_UNKNOWN,  

  RC_BUFFER_FULL,
  RC_BAD_PARAM,  
  RC_TX_ERROR,  
  RC_RDM_TIMEOUT,  

  RC_RDM_BCAST_RESPONSE,
  RC_RDM_INVALID_RESPONSE,  
  RC_INVALID_MODE,  

  RC_LAST  
} JaRuleReturnCode;

typedef ola::BaseCallback4<void, USBCommandResult, JaRuleReturnCode, uint8_t,
                           const ola::io::ByteString&> CommandCompleteCallback;


std::ostream& operator<<(std::ostream& os, const USBCommandResult &result);
std::ostream& operator<<(std::ostream& os, const CommandClass &command_class);
std::ostream& operator<<(std::ostream& os, const JaRuleReturnCode &rc);

}  // namespace usb
}  // namespace ola

#endif  // LIBS_USB_JARULECONSTANTS_H_